xref: /dragonfly/share/man/man9/module.9 (revision 1d1731fa) 
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2000 Alexander Langer
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" $FreeBSD: src/share/man/man9/module.9,v 1.5.2.2 2001/08/17 13:08:54 ru Exp $
30.\" $DragonFly: src/share/man/man9/module.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
31.\"
32.Dd March 1, 2001
33.Dt MODULE 9
34.Os
35.Sh NAME
36.Nm module
37.Nd structure describing a kernel module
38.Sh DESCRIPTION
39Each module in the kernel is described by a
40.Vt module_t
41structure.
42The structure contains the name of the device, a unique ID number,
43a pointer to an event handler function and to an argument,
44which is given to the event handler,
45as well as some kernel internal data.
46.Pp
47The
48.Xr DECLARE_MODULE 9
49macro
50registers the module with the system.
51When the module is loaded, the event handler function is called with
52the
53.Fa what
54argument set to
55.Dv MOD_LOAD .
56On unload,
57.Fa what
58is set to
59.Dv MOD_UNLOAD .
60When the system is shutting down,
61.Fa what
62contains the value of
63.Dv MOD_SHUTDOWN .
64.Sh EXAMPLES
65.Bd -literal
66#include <sys/param.h>
67#include <sys/kernel.h>
68#include <sys/module.h>
69
70static int foo_handler(module_t mod, int /*modeventtype_t*/ what,
71                       void *arg);
72
73static moduledata_t mod_data= {
74        "foo",
75        foo_handler,
76        0
77};
78
79MODULE_VERSION(foo, 1);
80MODULE_DEPEND(foo, bar, 1, 3, 4);
81
82DECLARE_MODULE(foo, mod_data, SI_SUB_EXEC, SI_ORDER_ANY);
83.Ed
84.Sh SEE ALSO
85.Xr DECLARE_MODULE 9 ,
86.Xr DEV_MODULE 9 ,
87.Xr DRIVER_MODULE 9 ,
88.Xr MODULE_DEPEND 9 ,
89.Xr MODULE_VERSION 9 ,
90.Xr SYSCALL_MODULE 9
91.Pp
92.Pa /usr/share/examples/kld
93.Sh AUTHORS
94This man page was written by
95.An Alexander Langer Aq alex@FreeBSD.org .
96