1.\" Copyright (c) 2000 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/module.9,v 1.5.2.2 2001/08/17 13:08:54 ru Exp $ 28.\" $DragonFly: src/share/man/man9/module.9,v 1.3 2004/06/01 11:36:53 hmp Exp $ 29.\" 30.Dd March 1, 2001 31.Dt MODULE 9 32.Os 33.Sh NAME 34.Nm module 35.Nd structure describing a kernel module 36.Sh DESCRIPTION 37Each module in the kernel is described by a 38.Vt module_t 39structure. 40The structure contains the name of the device, a unique ID number, 41a pointer to an event handler function and to an argument, 42which is given to the event handler, 43as well as some kernel internal data. 44.Pp 45The 46.Xr DECLARE_MODULE 9 47macro 48registers the module with the system. 49When the module is loaded, the event handler function is called with 50the 51.Fa what 52argument set to 53.Dv MOD_LOAD . 54On unload, 55.Fa what 56is set to 57.Dv MOD_UNLOAD . 58When the system is shutting down, 59.Fa what 60contains the value of 61.Dv MOD_SHUTDOWN . 62.Sh EXAMPLES 63.Bd -literal 64#include <sys/param.h> 65#include <sys/kernel.h> 66#include <sys/module.h> 67 68static int foo_handler(module_t mod, int /*modeventtype_t*/ what, 69 void *arg); 70 71static moduledata_t mod_data= { 72 "foo", 73 foo_handler, 74 0 75}; 76 77MODULE_VERSION(foo, 1); 78MODULE_DEPEND(foo, bar, 1, 3, 4); 79 80DECLARE_MODULE(foo, mod_data, SI_SUB_EXEC, SI_ORDER_ANY); 81.Ed 82.Sh SEE ALSO 83.Xr DECLARE_MODULE 9 , 84.Xr DEV_MODULE 9 , 85.Xr DRIVER_MODULE 9 , 86.Xr MODULE_DEPEND 9 , 87.Xr MODULE_VERSION 9 , 88.Xr SYSCALL_MODULE 9 89.Pp 90.Pa /usr/share/examples/kld 91.Sh AUTHORS 92This man page was written by 93.An Alexander Langer Aq alex@FreeBSD.org . 94