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.6 2004/01/17 03:24:48 dillon Exp $ 28 */ 29 30 #ifndef _SYS_MODULE_H_ 31 #define _SYS_MODULE_H_ 32 33 /* 34 * Module metadata types 35 */ 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) */ 39 40 #define MDT_STRUCT_VERSION 1 /* version of metadata structure */ 41 #define MDT_SETNAME "modmetadata_set" 42 43 typedef enum modeventtype { 44 MOD_LOAD, 45 MOD_UNLOAD, 46 MOD_SHUTDOWN 47 } modeventtype_t; 48 49 typedef struct module *module_t; 50 51 typedef int (*modeventhand_t)(module_t, int /*modeventtype_t*/, void *); 52 53 /* 54 * Struct for registering modules statically via SYSINIT. 55 */ 56 typedef struct moduledata { 57 const char *name; /* module name */ 58 modeventhand_t evhand; /* event handler */ 59 void *priv; /* extra data */ 60 } moduledata_t; 61 62 /* 63 * A module can use this to report module specific data to 64 * the user via kldstat(2). 65 */ 66 typedef union modspecific { 67 int intval; 68 u_int uintval; 69 long longval; 70 u_long ulongval; 71 } modspecific_t; 72 73 /* 74 * Module dependency declarartion 75 */ 76 struct mod_depend { 77 int md_ver_minimum; 78 int md_ver_preferred; 79 int md_ver_maximum; 80 }; 81 82 /* 83 * Module version declaration 84 */ 85 struct mod_version { 86 int mv_version; 87 }; 88 89 struct mod_metadata { 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 */ 94 }; 95 96 #ifdef _KERNEL 97 98 #define MODULE_METADATA(uniquifier, type, data, cval) \ 99 static struct mod_metadata _mod_metadata##uniquifier = { \ 100 MDT_STRUCT_VERSION, \ 101 type, \ 102 data, \ 103 cval \ 104 }; \ 105 DATA_SET(modmetadata_set, _mod_metadata##uniquifier) 106 107 #define MODULE_DEPEND(module, mdepend, vmin, vpref, vmax) \ 108 static struct mod_depend _##module##_depend_on_##mdepend = { \ 109 vmin, \ 110 vpref, \ 111 vmax \ 112 }; \ 113 MODULE_METADATA(_md_##module##_on_##mdepend, MDT_DEPEND, \ 114 &_##module##_depend_on_##mdepend, #mdepend) 115 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) \ 119 struct __hack 120 121 /* 122 * This is used to declare a module name that is the same as the KLD 123 * name so the kernel can avoid double-loading modules. It is typically 124 * necessary when a module is made up of several bus drivers each with 125 * its own separate sysinit. 126 */ 127 #define DECLARE_DUMMY_MODULE(name) \ 128 MODULE_METADATA(_md_##name, MDT_MODULE, NULL, #name) 129 130 #define MODULE_VERSION(mod, ver) 131 132 void module_register_init(const void *data); 133 struct linker_file; 134 int module_register(const struct moduledata *data, struct linker_file *lf); 135 module_t module_lookupbyname(const char *name); 136 module_t module_lookupbyid(int modid); 137 void module_reference(module_t mod); 138 int module_release(module_t mod); 139 int module_unload(module_t mod); 140 int module_getid(module_t mod); 141 module_t module_getfnext(module_t mod); 142 void module_setspecific(module_t mod, modspecific_t *datap); 143 144 #ifdef MOD_DEBUG 145 146 extern int mod_debug; 147 #define MOD_DEBUG_REFS 1 148 149 #define MOD_DPF(cat, args) \ 150 do { \ 151 if (mod_debug & MOD_DEBUG_##cat) printf args; \ 152 } while (0) 153 154 #else 155 156 #define MOD_DPF(cat, args) 157 158 #endif 159 160 #endif /* _KERNEL */ 161 162 #define MAXMODNAME 32 163 164 struct module_stat { 165 int version; /* set to sizeof(struct module_stat) */ 166 char name[MAXMODNAME]; 167 int refs; 168 int id; 169 modspecific_t data; 170 }; 171 172 #ifndef _KERNEL 173 174 #include <sys/cdefs.h> 175 176 __BEGIN_DECLS 177 int modnext(int _modid); 178 int modfnext(int _modid); 179 int modstat(int _modid, struct module_stat* _stat); 180 int modfind(const char *_name); 181 __END_DECLS 182 183 #endif 184 185 #endif /* !_SYS_MODULE_H_ */ 186