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: src/share/man/man9/SYSCALL_MODULE.9,v 1.2.2.2 2001/12/17 11:30:18 ru Exp $
  30 .\" $DragonFly: src/share/man/man9/SYSCALL_MODULE.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
  31 .\"
  32 .Dd April 27, 2001
  33 .Dt SYSCALL_MODULE 9
  34 .Os
  35 .Sh NAME
  36 .Nm SYSCALL_MODULE
  37 .Nd syscall kernel module declaration macro
  38 .Sh SYNOPSIS
  39 .In sys/proc.h
  40 .In sys/module.h
  41 .In sys/sysent.h
  42 .Fn SYSCALL_MODULE name "int *offset" "struct sysent new_sysent" "modeventhand_t evh" "void *arg"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn SYSCALL_MODULE
  46 macro declares a new syscall.
  47 .Fn SYSCALL_MODULE
  48 expands into a kernel module declaration named as
  49 .Fa name .
  50 .Pp
  51 .Fa offset
  52 is a pointer to an
  53 .Vt int
  54 which saves the offset in
  55 .Vt "struct sysent"
  56 where the
  57 syscall is allocated.
  58 .Pp
  59 .Fa new_sysent
  60 specifies the function implementing the syscall and the number of
  61 arguments this function needs (see
  62 .Aq Pa sys/sysent.h ) .
  63 .Pp
  64 .Fa evh
  65 is 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 .Sh EXAMPLES
  71 A minimal example for a syscall module can be found in
  72 .Pa /usr/share/examples/kld/syscall/module/syscall.c .
  73 .Sh SEE ALSO
  74 .Xr module 9
  75 .Pp
  76 .Pa /usr/share/examples/kld/syscall/module/syscall.c
  77 .Sh AUTHORS
  78 This manual page was written by
  79 .An Alexander Langer Aq alex@FreeBSD.org .