From owner-freebsd-audit Sat Mar 3 7:57: 2 2001 Delivered-To: freebsd-audit@freebsd.org Received: from mailout01.sul.t-online.com (mailout01.sul.t-online.com [194.25.134.80]) by hub.freebsd.org (Postfix) with ESMTP id 81E1137B71B; Sat, 3 Mar 2001 07:56:52 -0800 (PST) (envelope-from alex@big.endian.de) Received: from fwd03.sul.t-online.com by mailout01.sul.t-online.com with smtp id 14ZEOp-0001o4-03; Sat, 03 Mar 2001 16:56:51 +0100 Received: from neutron.cichlids.com (520050424122-0001@[62.158.38.62]) by fmrl03.sul.t-online.com with esmtp id 14ZEOk-0fzX3QC; Sat, 3 Mar 2001 16:56:46 +0100 Received: from cichlids.cichlids.com (cichlids.cichlids.com [192.168.0.10]) by neutron.cichlids.com (Postfix) with ESMTP id 7A830AB44; Sat, 3 Mar 2001 16:57:10 +0100 (CET) Received: by cichlids.cichlids.com (Postfix, from userid 1001) id 6BA4914A66; Sat, 3 Mar 2001 16:56:41 +0100 (CET) Date: Sat, 3 Mar 2001 16:56:40 +0100 To: audit@freebsd.org, dfr@freebsd.org, sheldonh@freebsd.org Subject: two new manpages for review: module.9, DECLARE_MODULE.9 Message-ID: <20010303165640.A8210@cichlids.cichlids.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="yrj/dFKFPuw6o+aM" Content-Disposition: inline User-Agent: Mutt/1.2.5i X-PGP-Fingerprint: 44 28 CA 4C 46 5B D3 A8 A8 E3 BA F3 4E 60 7D 7F X-PGP-at: finger alex@big.endian.de X-Verwirrung: Dieser Header dient der allgemeinen Verwirrung. From: alex@big.endian.de (Alexander Langer) X-Sender: 520050424122-0001@t-dialin.net Sender: owner-freebsd-audit@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.ORG --yrj/dFKFPuw6o+aM Content-Type: text/plain; charset=us-ascii Content-Disposition: inline [followup to audit@freebsd.org, please] Hi! I have written two new manpages and I'd like to hear some comments about them (mdoc stuff, technical errors and enhancements, suggestions[1]). Thanks! Alex [1] ecspecially module.9, which is similar to driver.9, but somehow - uhm - short. I don't know what it could contain, but I think it's a good start... -- cat: /home/alex/.sig: No such file or directory --yrj/dFKFPuw6o+aM Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename="module.9" .\" -*- nroff -*- .\" .\" Copyright (c) 2000 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 March 01, 2001 .Dt MODULE 9 .Os FreeBSD .Sh NAME .Nm driver .Nd structure describing a kernel module .Sh SYNOPSIS .Bd -literal #include #include modeventhand_t foo_handler; static moduledata_t mod_data= { "foo", foo_handler, 0 }; DECLARE_MODULE(foo, mod_data, SI_SUB_EXEC, SI_ORDER_ANY); typedef int (*modeventhand_t)(module_t mod, int /*modeventtype_t*/ what, void *arg); .Ed .Sh DESCRIPTION Each module in the kernel is described by a .Dv module_t structure. The structure contains the name of the device, a unique id number, a pointer to an event handler function and to an argument, which is given to the event handler, as well as some kernel internal data. .Pp The .Dv DECLARE_MODULE macro (see .Xr DECLARE_MODULE 9 ) registers the module with the system. When the module is loaded, the event handler function is called with the .Fa what argument set to .Dv MOD_LOAD . On unload, .Fa what is set to .Dv MOD_UNLOAD . When the system is shutting down, .Fa what contains the value of .Dv MOD_SHUTDOWN .Sh SEE ALSO .Xr DECLARE_MODULE 9 , .Xr CDEV_MODULE 9 , .Xr DRIVER_MODULE 9 , .Xr SYSCALL_MODULE 9 , .Xr MODULE_VERSION 9 , .Xr MODULE_DEPEND 9 , .Xr /usr/share/examples/kld .Sh AUTHORS This man page was written by .An Alexander Langer Ar alex@FreeBSD.org . --yrj/dFKFPuw6o+aM Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename="DECLARE_MODULE.9" .\" -*- nroff -*- .\" .\" Copyright (c) 2000 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 March 03, 2001 .Dt DECLARE_MODULE 9 .Os .Sh NAME .Nm DECLARE_MODULE .Nd kernel module declaration macro .Sh SYNOPSIS .Fd #include .Fn DECLARE_MODULE "name" "moduledata_t data" "sub" "order" .Sh DESCRIPTION The .Fn DECLARE_MODULE macro declares a generic kernel module. It is used to register the module with the system, using the .Fn SYSINIT macro. .Fn DECLARE_MODULE is usually used within other macros, such as .Xr DRIVER_MODULE 9 , .Xr CDEV_MODULE 9 and .Xr SYSCALL_MODULE 9 . However, it can be called directly of course, for example in order to implement dynamic sysctls. .Pp The arguments to .Fn DECLARE_MODULE : .Pp .Fa name is the name of the module, which will be used in the .Fn SYSINIT call to identify the module. .Pp .Fa data is a pointer to the .Dv moduledata_t structure, which contains two main items, the official name of the module name, which will be used in the .Dv module_t structure and a pointer to the event handler function of type .Dv modeventhand_t . .Pp .Fa sub is an argument directed to the .Fn SYSINIT macro. Valid values for this are contained in the .Dv sysstem_sub_id enumeration (see .Pa kernel.h ) and specify the type of system startup interfaces. The .Xr DRIVER_MODULE 9 macro uses a value of .Dv SI_SUB_DRIVERS here for example, since these modules contain a driver for a device. For kernel modules that are loaded at runtime, a value of .Dv SI_SUB_EXEC is common. .Pp The .Fa order value is another argument for .Fn SYSINIT . It represents the KLDs order of initialization within the subsystem. Valid values are defined in the .Dv sysinit_elem_order enumeration .Pa ( kernel.h ) . .Sh SEE ALSO .Xr module 9 , .Xr CDEV_MODULE 9 , .Xr DRIVER_MODULE 9 , .Xr SYSCALL_MODULE 9 , .Pa /usr/include/sys/kernel.h , .Pa /usr/share/examples/kld .Sh AUTHORS This manual page was written by .An Alexander Langer Aq alex@FreeBSD.org , inspired by the KLD Facility Programming Tutorial by .An Andrew Reiter Aq arr@watson.org . --yrj/dFKFPuw6o+aM-- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-audit" in the body of the message