diff options
author | alex <alex@FreeBSD.org> | 2001-04-28 13:18:40 +0000 |
---|---|---|
committer | alex <alex@FreeBSD.org> | 2001-04-28 13:18:40 +0000 |
commit | 2e63ceabbaab3177100e4e6f04eb354f44bd2e57 (patch) | |
tree | 2aae7d55bcc54e44e40451c528259fe70def170f /share/man/man9/SYSCALL_MODULE.9 | |
parent | b5d32120a1f4ef12c56c6beae601c40669398fe0 (diff) | |
download | FreeBSD-src-2e63ceabbaab3177100e4e6f04eb354f44bd2e57.zip FreeBSD-src-2e63ceabbaab3177100e4e6f04eb354f44bd2e57.tar.gz |
Add SYSCALL_MODULE.9, a manpage for the SYSCALL_MODULE wrapper macro
for syscall klds.
Some text of this manpage is based on the comments in the example
syscall module written by Assar Westerlund.
Reviewed by: ru
Diffstat (limited to 'share/man/man9/SYSCALL_MODULE.9')
-rw-r--r-- | share/man/man9/SYSCALL_MODULE.9 | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/share/man/man9/SYSCALL_MODULE.9 b/share/man/man9/SYSCALL_MODULE.9 new file mode 100644 index 0000000..85976ed --- /dev/null +++ b/share/man/man9/SYSCALL_MODULE.9 @@ -0,0 +1,78 @@ +.\" -*- nroff -*- +.\" +.\" Copyright (c) 2001 Alexander Langer +.\" +.\" All rights reserved. +.\" +.\" This program is free software. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd April 27, 2001 +.Dt SYSCALL_MODULE 9 +.Os +.Sh NAME +.Nm SYSCALL_MODULE +.Nd syscall kernel module declaration macro +.Sh SYNOPSIS +.Fd #include <sys/proc.h> +.Fd #include <sys/module.h> +.Fd #include <sys/sysent.h> +.Fn SYSCALL_MODULE name "int *offset" "struct sysent new_sysent" "modeventhand_t evh" "void *arg" +.Sh DESCRIPTION +The +.Fn SYSCALL_MODULE +macro declares a new syscall. +.Fn SYSCALL_MODULE +expands into a kernel module declaration named as +.Fa name . +.Pp +.Fa offset +is a pointer to an +.Vt int +which saves the offset in +.Vt "struct sysent" +where the +syscall is allocated. +.Pp +.Fa new_sysent +specifies the function and the number of arguments this function +needs (see +.Aq Pa sys/sysent.h ) . +.Pp +.Fa evh +is a pointer to the kernel module event handler function with the argument +.Fa arg . +Please refer to +.Xr module 9 +for more information. +.Sh EXAMPLES +A minimal example for a syscall module can be found in +.Pa /usr/share/examples/kld/syscall/module/syscall.c . +.Sh SEE ALSO +.Xr module 9 +.Pp +.Pa /usr/share/examples/kld/syscall/module/syscall.c +.Sh AUTHORS +This manual page was written by +.An Alexander Langer Aq alex@FreeBSD.org . |