share/man/man9/SYSCALL_MODULE.9

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