2 * Copyright (c) 1997 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifndef _SYS_MODULE_H_
30 #define _SYS_MODULE_H_
33 * Module metadata types
35 #define MDT_DEPEND 1 /* argument is a module name */
36 #define MDT_MODULE 2 /* module declaration */
37 #define MDT_VERSION 3 /* module version(s) */
38 #define MDT_PNP_INFO 4 /* Plug and play hints record */
40 #define MDT_STRUCT_VERSION 1 /* version of metadata structure */
41 #define MDT_SETNAME "modmetadata_set"
43 typedef enum modeventtype {
50 typedef struct module *module_t;
51 typedef int (*modeventhand_t)(module_t, int /* modeventtype_t */, void *);
54 * Struct for registering modules statically via SYSINIT.
56 typedef struct moduledata {
57 const char *name; /* module name */
58 modeventhand_t evhand; /* event handler */
59 void *priv; /* extra data */
63 * A module can use this to report module specific data to the user via
66 typedef union modspecific {
74 * Module dependency declaration
83 * Module version declaration
90 int md_version; /* structure version MDTV_* */
91 int md_type; /* type of entry MDT_* */
92 const void *md_data; /* specific data */
93 const char *md_cval; /* common string label */
96 struct mod_pnp_match_info
98 const char *descr; /* Description of the table */
99 const char *bus; /* Name of the bus for this table */
100 const void *table; /* Pointer to pnp table */
101 int entry_len; /* Length of each entry in the table (may be */
102 /* longer than descr describes). */
103 int num_entry; /* Number of entries in the table */
107 #include <sys/linker_set.h>
109 #define MODULE_METADATA_CONCAT(uniquifier) _mod_metadata##uniquifier
110 #define MODULE_METADATA(uniquifier, type, data, cval) \
111 static struct mod_metadata MODULE_METADATA_CONCAT(uniquifier) = { \
112 MDT_STRUCT_VERSION, \
117 DATA_SET(modmetadata_set, MODULE_METADATA_CONCAT(uniquifier))
119 #define MODULE_DEPEND(module, mdepend, vmin, vpref, vmax) \
120 static struct mod_depend _##module##_depend_on_##mdepend \
121 __section(".data") = { \
126 MODULE_METADATA(_md_##module##_on_##mdepend, MDT_DEPEND, \
127 &_##module##_depend_on_##mdepend, #mdepend)
130 * Every kernel has a 'kernel' module with the version set to
131 * __FreeBSD_version. We embed a MODULE_DEPEND() inside every module
132 * that depends on the 'kernel' module. It uses the current value of
133 * __FreeBSD_version as the minimum and preferred versions. For the
134 * maximum version it rounds the version up to the end of its branch
135 * (i.e. M99999 for M.x). This allows a module built on M.x to work
136 * on M.y systems where y >= x, but fail on M.z systems where z < x.
138 #define MODULE_KERNEL_MAXVER (roundup(__FreeBSD_version, 100000) - 1)
140 #define DECLARE_MODULE_WITH_MAXVER(name, data, sub, order, maxver) \
141 MODULE_DEPEND(name, kernel, __FreeBSD_version, \
142 __FreeBSD_version, maxver); \
143 MODULE_METADATA(_md_##name, MDT_MODULE, &data, __XSTRING(name));\
144 SYSINIT(name##module, sub, order, module_register_init, &data); \
147 #define DECLARE_MODULE(name, data, sub, order) \
148 DECLARE_MODULE_WITH_MAXVER(name, data, sub, order, MODULE_KERNEL_MAXVER)
151 * The module declared with DECLARE_MODULE_TIED can only be loaded
152 * into the kernel with exactly the same __FreeBSD_version.
154 * Use it for modules that use kernel interfaces that are not stable
155 * even on STABLE/X branches.
157 #define DECLARE_MODULE_TIED(name, data, sub, order) \
158 DECLARE_MODULE_WITH_MAXVER(name, data, sub, order, __FreeBSD_version)
160 #define MODULE_VERSION_CONCAT(module, version) _##module##_version
161 #define MODULE_VERSION(module, version) \
162 static struct mod_version MODULE_VERSION_CONCAT(module, version)\
163 __section(".data") = { \
166 MODULE_METADATA(MODULE_VERSION_CONCAT(module, version), MDT_VERSION,\
167 &MODULE_VERSION_CONCAT(module, version), __XSTRING(module))
170 * Generic macros to create pnp info hints that modules may export
171 * to allow external tools to parse their internal device tables
172 * to make an informed guess about what driver(s) to load.
174 #define MODULE_PNP_INFO(d, b, unique, t, l, n) \
175 static const struct mod_pnp_match_info _module_pnp_##b##_##unique = { \
182 MODULE_METADATA(_md_##b##_pnpinfo_##unique, MDT_PNP_INFO, \
183 &_module_pnp_##b##_##unique, #b);
185 * descr is a string that describes each entry in the table. The general
186 * form is (TYPE:pnp_name[/pnp_name];)*
187 * where TYPE is one of the following:
189 * V8 like U8 and 0xff means match any
190 * G16 uint16_t element, any value >= matches
191 * L16 uint16_t element, any value <= matches
192 * M16 uint16_t element, mask of which of the following fields to use.
193 * U16 uint16_t element
194 * V16 like U16 and 0xffff means match any
195 * U32 uint32_t element
196 * V32 like U32 and 0xffffffff means match any
197 * W32 Two 16-bit values with first pnp_name in LSW and second in MSW.
198 * Z pointer to a string to match exactly
199 * D like Z, but is the string passed to device_set_descr()
200 * P A pointer that should be ignored
201 * E EISA PNP Identifier (in binary, but bus publishes string)
202 * K Key for whole table. pnp_name=value. must be last, if present.
204 * The pnp_name "#" is reserved for other fields that should be ignored.
207 extern struct sx modules_sx;
209 #define MOD_XLOCK sx_xlock(&modules_sx)
210 #define MOD_SLOCK sx_slock(&modules_sx)
211 #define MOD_XUNLOCK sx_xunlock(&modules_sx)
212 #define MOD_SUNLOCK sx_sunlock(&modules_sx)
213 #define MOD_LOCK_ASSERT sx_assert(&modules_sx, SX_LOCKED)
214 #define MOD_XLOCK_ASSERT sx_assert(&modules_sx, SX_XLOCKED)
218 void module_register_init(const void *);
219 int module_register(const struct moduledata *, struct linker_file *);
220 module_t module_lookupbyname(const char *);
221 module_t module_lookupbyid(int);
222 int module_quiesce(module_t);
223 void module_reference(module_t);
224 void module_release(module_t);
225 int module_unload(module_t);
226 int module_getid(module_t);
227 module_t module_getfnext(module_t);
228 const char * module_getname(module_t);
229 void module_setspecific(module_t, modspecific_t *);
230 struct linker_file *module_file(module_t);
233 extern int mod_debug;
234 #define MOD_DEBUG_REFS 1
236 #define MOD_DPF(cat, args) do { \
237 if (mod_debug & MOD_DEBUG_##cat) \
241 #else /* !MOD_DEBUG */
243 #define MOD_DPF(cat, args)
247 #define MAXMODNAME 32
250 int version; /* set to sizeof(struct module_stat) */
251 char name[MAXMODNAME];
259 #include <sys/cdefs.h>
262 int modnext(int _modid);
263 int modfnext(int _modid);
264 int modstat(int _modid, struct module_stat *_stat);
265 int modfind(const char *_name);
270 #endif /* !_SYS_MODULE_H_ */