1 /*- 2 * Copyright (c) 1997 Doug Rabson 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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 24 * SUCH DAMAGE. 25 * 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.11 2006/12/23 00:27:03 swildner Exp $ 28 */ 29 30 #ifndef _SYS_MODULE_H_ 31 #define _SYS_MODULE_H_ 32 33 #ifndef _SYS_TYPES_H_ 34 #include <sys/types.h> 35 #endif 36 #include <sys/linker_set.h> 37 38 /* 39 * Module metadata types 40 */ 41 #define MDT_DEPEND 1 /* argument is a module name */ 42 #define MDT_MODULE 2 /* module declaration */ 43 #define MDT_VERSION 3 /* module version(s) */ 44 45 #define MDT_STRUCT_VERSION 1 /* version of metadata structure */ 46 #define MDT_SETNAME "modmetadata_set" 47 48 typedef enum modeventtype { 49 MOD_LOAD, 50 MOD_UNLOAD, 51 MOD_SHUTDOWN 52 } modeventtype_t; 53 54 typedef struct module *module_t; 55 56 typedef int (*modeventhand_t)(module_t, int /*modeventtype_t*/, void *); 57 58 /* 59 * Struct for registering modules statically via SYSINIT. 60 */ 61 typedef struct moduledata { 62 const char *name; /* module name */ 63 modeventhand_t evhand; /* event handler */ 64 void *priv; /* extra data */ 65 } moduledata_t; 66 67 /* 68 * A module can use this to report module specific data to 69 * the user via kldstat(2). 70 */ 71 typedef union modspecific { 72 int intval; 73 u_int uintval; 74 long longval; 75 u_long ulongval; 76 } modspecific_t; 77 78 /* 79 * Module dependency declaration 80 */ 81 struct mod_depend { 82 int md_ver_minimum; 83 int md_ver_preferred; 84 int md_ver_maximum; 85 }; 86 87 /* 88 * Module version declaration 89 */ 90 struct mod_version { 91 int mv_version; 92 }; 93 94 struct mod_metadata { 95 int md_version; /* structure version MDTV_* */ 96 int md_type; /* type of entry MDT_* */ 97 void *md_data; /* specific data */ 98 const char *md_cval; /* common string label */ 99 }; 100 101 #ifdef _KERNEL 102 103 #define MODULE_METADATA(uniquifier, type, data, cval) \ 104 static struct mod_metadata _mod_metadata##uniquifier = { \ 105 MDT_STRUCT_VERSION, \ 106 type, \ 107 data, \ 108 cval \ 109 }; \ 110 DATA_SET(modmetadata_set, _mod_metadata##uniquifier) 111 112 #define MODULE_DEPEND(module, mdepend, vmin, vpref, vmax) \ 113 static struct mod_depend _##module##_depend_on_##mdepend = { \ 114 vmin, \ 115 vpref, \ 116 vmax \ 117 }; \ 118 MODULE_METADATA(_md_##module##_on_##mdepend, MDT_DEPEND, \ 119 &_##module##_depend_on_##mdepend, #mdepend) 120 121 #define DECLARE_MODULE(name, data, sub, order) \ 122 MODULE_METADATA(_md_##name, MDT_MODULE, &data, #name); \ 123 SYSINIT(name##module, sub, order, module_register_init, &data) \ 124 struct __hack 125 126 #define MODULE_VERSION(module, version) \ 127 static struct mod_version _##module##_version = { \ 128 version \ 129 }; \ 130 MODULE_METADATA(_##module##_version, MDT_VERSION, \ 131 &_##module##_version, #module) 132 133 /* 134 * This is used to declare a module name that is the same as the KLD 135 * name so the kernel can avoid double-loading modules. It is typically 136 * necessary when a module is made up of several bus drivers each with 137 * its own separate sysinit. 138 */ 139 #if 0 140 #define DECLARE_DUMMY_MODULE(name) \ 141 MODULE_METADATA(_md_##name, MDT_MODULE, NULL, #name) 142 #else 143 #define DECLARE_DUMMY_MODULE(name) struct __hack 144 #endif 145 146 void module_register_init(const void *data); 147 struct linker_file; 148 int module_register(const struct moduledata *data, struct linker_file *lf); 149 module_t module_lookupbyname(const char *name); 150 module_t module_lookupbyid(int modid); 151 void module_reference(module_t mod); 152 int module_release(module_t mod); 153 int module_unload(module_t mod); 154 int module_getid(module_t mod); 155 module_t module_getfnext(module_t mod); 156 void module_setspecific(module_t mod, modspecific_t *datap); 157 158 #ifdef MOD_DEBUG 159 160 extern int mod_debug; 161 #define MOD_DEBUG_REFS 1 162 163 #define MOD_DPF(cat, args) \ 164 do { \ 165 if (mod_debug & MOD_DEBUG_##cat) kprintf args; \ 166 } while (0) 167 168 #else 169 170 #define MOD_DPF(cat, args) 171 172 #endif 173 174 #endif /* _KERNEL */ 175 176 #define MAXMODNAME 32 177 178 struct module_stat { 179 int version; /* set to sizeof(struct module_stat) */ 180 char name[MAXMODNAME]; 181 int refs; 182 int id; 183 modspecific_t data; 184 }; 185 186 #ifndef _KERNEL 187 188 #include <sys/cdefs.h> 189 190 __BEGIN_DECLS 191 int modnext(int); 192 int modfnext(int); 193 int modstat(int, struct module_stat *); 194 int modfind(const char *); 195 __END_DECLS 196 197 #endif 198 199 #endif /* !_SYS_MODULE_H_ */ 200