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