3 .\" Copyright (c) 2000 Alexander Langer
5 .\" All rights reserved.
7 .\" This program is free software.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
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.
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.
36 .Nd kernel module declaration macro
41 .Fn DECLARE_MODULE "name" "moduledata_t data" "sub" "order"
42 .Fn DECLARE_MODULE_TIED "name" "moduledata_t data" "sub" "order"
46 macro declares a generic kernel module.
47 It is used to register the module with the system, using the
51 is usually used within other macros, such as
55 .Xr SYSCALL_MODULE 9 .
56 Of course, it can also be called directly, for example in
57 order to implement dynamic sysctls.
59 A module declared with
60 .Fn DECLARE_MODULE_TIED
61 will load only if the running kernel version
63 .Dv __FreeBSD_version )
64 is identical to that on which it was built.
65 This declaration should be used by modules which depend on interfaces beyond
66 the stable kernel KBI (such as ABI emulators or hypervisors that rely on
67 internal kernel structures).
70 .Fn DECLARE_MODULE_TIED
71 when compiled with modules built with the kernel. This allows locks and
72 other synchronization primitives to be inlined safely.
75 .Bl -tag -width indent
77 The module name, which will be used in the
79 call to identify the module.
83 structure, which contains two main items, the official name of the
84 module name, which will be used in the
86 structure and a pointer to the event handler function of type
89 An argument directed to the
92 Valid values for this are contained in the
97 and specify the type of system startup interfaces.
100 macro uses a value of
102 here for example, since these modules contain a driver for a device.
103 For kernel modules that are loaded at runtime, a value of
109 It represents the KLDs order of initialization within the subsystem.
110 Valid values are defined in the
111 .Vt sysinit_elem_order
113 .Pq In sys/kernel.h .
117 .Xr DRIVER_MODULE 9 ,
121 .Pa /usr/include/sys/kernel.h ,
122 .Pa /usr/share/examples/kld
125 This manual page was written by
126 .An Alexander Langer Aq Mt alex@FreeBSD.org ,
127 inspired by the KLD Facility Programming Tutorial by
128 .An Andrew Reiter Aq Mt arr@watson.org .