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
26 * $FreeBSD: src/sys/sys/module.h,v 1.14.2.3 2002/03/17 11:07:45 alfred Exp $
27 * $DragonFly: src/sys/sys/module.h,v 1.4 2003/11/14 00:37:23 dillon Exp $
30 #ifndef _SYS_MODULE_H_
31 #define _SYS_MODULE_H_
34 * Module metadata types
36 #define MDT_DEPEND 1 /* argument is a module name */
37 #define MDT_MODULE 2 /* module declaration */
38 #define MDT_VERSION 3 /* module version(s) */
40 #define MDT_STRUCT_VERSION 1 /* version of metadata structure */
41 #define MDT_SETNAME "modmetadata_set"
43 typedef enum modeventtype {
49 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
64 * the user via kldstat(2).
66 typedef union modspecific {
74 * Module dependency declarartion
83 * Module version declaration
90 int md_version; /* structure version MDTV_* */
91 int md_type; /* type of entry MDT_* */
92 void *md_data; /* specific data */
93 const char *md_cval; /* common string label */
98 #define MODULE_METADATA(uniquifier, type, data, cval) \
99 static struct mod_metadata _mod_metadata##uniquifier = { \
100 MDT_STRUCT_VERSION, \
105 DATA_SET(modmetadata_set, _mod_metadata##uniquifier)
107 #define MODULE_DEPEND(module, mdepend, vmin, vpref, vmax) \
108 static struct mod_depend _##module##_depend_on_##mdepend = { \
113 MODULE_METADATA(_md_##module##_on_##mdepend, MDT_DEPEND, \
114 &_##module##_depend_on_##mdepend, #mdepend)
116 #define DECLARE_MODULE(name, data, sub, order) \
117 MODULE_METADATA(_md_##name, MDT_MODULE, &data, #name); \
118 SYSINIT(name##module, sub, order, module_register_init, &data) \
121 #define MODULE_VERSION(mod, ver)
123 void module_register_init(const void *data);
125 int module_register(const struct moduledata *data, struct linker_file *lf);
126 module_t module_lookupbyname(const char *name);
127 module_t module_lookupbyid(int modid);
128 void module_reference(module_t mod);
129 void module_release(module_t mod);
130 int module_unload(module_t mod);
131 int module_getid(module_t mod);
132 module_t module_getfnext(module_t mod);
133 void module_setspecific(module_t mod, modspecific_t *datap);
137 extern int mod_debug;
138 #define MOD_DEBUG_REFS 1
140 #define MOD_DPF(cat, args) \
142 if (mod_debug & MOD_DEBUG_##cat) printf args; \
147 #define MOD_DPF(cat, args)
153 #define MAXMODNAME 32
156 int version; /* set to sizeof(struct module_stat) */
157 char name[MAXMODNAME];
165 #include <sys/cdefs.h>
168 int modnext(int _modid);
169 int modfnext(int _modid);
170 int modstat(int _modid, struct module_stat* _stat);
171 int modfind(const char *_name);
176 #endif /* !_SYS_MODULE_H_ */