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) */
39 #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 mod, int /*modeventtype_t*/ what,
55 * Struct for registering modules statically via SYSINIT.
57 typedef struct moduledata {
58 const char *name; /* module name */
59 modeventhand_t evhand; /* event handler */
60 void *priv; /* extra data */
64 * A module can use this to report module specific data to
65 * the user via kldstat(2).
67 typedef union modspecific {
75 * Module dependency declarartion
84 * Module version declaration
91 int md_version; /* structure version MDTV_* */
92 int md_type; /* type of entry MDT_* */
93 void *md_data; /* specific data */
94 const char *md_cval; /* common string label */
99 #include <sys/linker_set.h>
101 #define MODULE_METADATA(uniquifier, type, data, cval) \
102 static struct mod_metadata _mod_metadata ## uniquifier = { \
103 MDT_STRUCT_VERSION, \
108 DATA_SET(modmetadata_set, _mod_metadata ## uniquifier)
110 #define MODULE_DEPEND(module, mdepend, vmin, vpref, vmax) \
111 static struct mod_depend _ ##module ## _depend_on_ ## mdepend = { \
116 MODULE_METADATA(_md_ ##module ## _on_ ##mdepend, MDT_DEPEND, \
117 &_ ##module ## _depend_on_ ##mdepend, #mdepend)
119 #define DECLARE_MODULE(name, data, sub, order) \
120 MODULE_METADATA(_md_ ##name, MDT_MODULE, &data, #name); \
121 SYSINIT(name##module, sub, order, module_register_init, &data) \
124 #define MODULE_VERSION(module, version) \
125 static struct mod_version _ ## module ## _version = { \
128 MODULE_METADATA(_ ## module ## _version, MDT_VERSION, \
129 & _ ## module ## _version, #module)
131 void module_register_init(const void *data);
133 int module_register(const struct moduledata *data, struct linker_file *lf);
134 module_t module_lookupbyname(const char *name);
135 module_t module_lookupbyid(int modid);
136 void module_reference(module_t mod);
137 void module_release(module_t mod);
138 int module_unload(module_t mod);
139 int module_getid(module_t mod);
140 module_t module_getfnext(module_t mod);
141 void module_setspecific(module_t mod, modspecific_t *datap);
145 extern int mod_debug;
146 #define MOD_DEBUG_REFS 1
148 #define MOD_DPF(cat, args) \
150 if (mod_debug & MOD_DEBUG_##cat) printf args; \
155 #define MOD_DPF(cat, args)
161 #define MAXMODNAME 32
164 int version; /* set to sizeof(struct module_stat) */
165 char name[MAXMODNAME];
173 #include <sys/cdefs.h>
176 int modnext(int modid);
177 int modfnext(int modid);
178 int modstat(int modid, struct module_stat* stat);
179 int modfind(const char *name);
184 #endif /* !_SYS_MODULE_H_ */