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