share/man/man9/SYSCALL_MODULE.9

   1 .\" Copyright (c) 2001 Alexander Langer
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/SYSCALL_MODULE.9,v 1.2.2.2 2001/12/17 11:30:18 ru Exp $
  28 .\" $DragonFly: src/share/man/man9/SYSCALL_MODULE.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
  29 .\"
  30 .Dd April 27, 2001
  31 .Dt SYSCALL_MODULE 9
  32 .Os
  33 .Sh NAME
  34 .Nm SYSCALL_MODULE
  35 .Nd syscall kernel module declaration macro
  36 .Sh SYNOPSIS
  37 .In sys/proc.h
  38 .In sys/module.h
  39 .In sys/sysent.h
  40 .Fn SYSCALL_MODULE name "int *offset" "struct sysent new_sysent" "modeventhand_t evh" "void *arg"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn SYSCALL_MODULE
  44 macro declares a new syscall.
  45 .Fn SYSCALL_MODULE
  46 expands into a kernel module declaration named as
  47 .Fa name .
  48 .Pp
  49 .Fa offset
  50 is a pointer to an
  51 .Vt int
  52 which saves the offset in
  53 .Vt "struct sysent"
  54 where the
  55 syscall is allocated.
  56 .Pp
  57 .Fa new_sysent
  58 specifies the function implementing the syscall and the number of
  59 arguments this function needs (see
  60 .Aq Pa sys/sysent.h ) .
  61 .Pp
  62 .Fa evh
  63 is a pointer to the kernel module event handler function with the argument
  64 .Fa arg .
  65 Please refer to
  66 .Xr module 9
  67 for more information.
  68 .Sh EXAMPLES
  69 A minimal example for a syscall module can be found in
  70 .Pa /usr/share/examples/kld/syscall/module/syscall.c .
  71 .Sh SEE ALSO
  72 .Xr module 9
  73 .Pp
  74 .Pa /usr/share/examples/kld/syscall/module/syscall.c
  75 .Sh AUTHORS
  76 This manual page was written by
  77 .An Alexander Langer Aq alex@FreeBSD.org .