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