1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 1997 Doug Rabson 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #ifndef _SYS_MODULE_H_ 30 #define _SYS_MODULE_H_ 31 32 /* 33 * Module metadata types 34 */ 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) */ 38 #define MDT_PNP_INFO 4 /* Plug and play hints record */ 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 MOD_QUIESCE 48 } modeventtype_t; 49 50 typedef struct module *module_t; 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 the user via 64 * 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 declaration 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 const void *md_data; /* specific data */ 93 const char *md_cval; /* common string label */ 94 }; 95 96 struct mod_pnp_match_info 97 { 98 const char *descr; /* Description of the table */ 99 const char *bus; /* Name of the bus for this table */ 100 const void *table; /* Pointer to pnp table */ 101 int entry_len; /* Length of each entry in the table (may be */ 102 /* longer than descr describes). */ 103 int num_entry; /* Number of entries in the table */ 104 }; 105 #ifdef _KERNEL 106 107 #include <sys/linker_set.h> 108 109 #define MODULE_METADATA_CONCAT(uniquifier) _mod_metadata##uniquifier 110 #define MODULE_METADATA(uniquifier, type, data, cval) \ 111 static struct mod_metadata MODULE_METADATA_CONCAT(uniquifier) = { \ 112 MDT_STRUCT_VERSION, \ 113 type, \ 114 data, \ 115 cval \ 116 }; \ 117 DATA_SET(modmetadata_set, MODULE_METADATA_CONCAT(uniquifier)) 118 119 #define MODULE_DEPEND(module, mdepend, vmin, vpref, vmax) \ 120 static struct mod_depend _##module##_depend_on_##mdepend \ 121 __section(".data") = { \ 122 vmin, \ 123 vpref, \ 124 vmax \ 125 }; \ 126 MODULE_METADATA(_md_##module##_on_##mdepend, MDT_DEPEND, \ 127 &_##module##_depend_on_##mdepend, #mdepend) 128 129 /* 130 * Every kernel has a 'kernel' module with the version set to 131 * __FreeBSD_version. We embed a MODULE_DEPEND() inside every module 132 * that depends on the 'kernel' module. It uses the current value of 133 * __FreeBSD_version as the minimum and preferred versions. For the 134 * maximum version it rounds the version up to the end of its branch 135 * (i.e. M99999 for M.x). This allows a module built on M.x to work 136 * on M.y systems where y >= x, but fail on M.z systems where z < x. 137 */ 138 #define MODULE_KERNEL_MAXVER (roundup(__FreeBSD_version, 100000) - 1) 139 140 #define DECLARE_MODULE_WITH_MAXVER(name, data, sub, order, maxver) \ 141 MODULE_DEPEND(name, kernel, __FreeBSD_version, \ 142 __FreeBSD_version, maxver); \ 143 MODULE_METADATA(_md_##name, MDT_MODULE, &data, __XSTRING(name));\ 144 SYSINIT(name##module, sub, order, module_register_init, &data); \ 145 struct __hack 146 147 #ifdef KLD_TIED 148 #define DECLARE_MODULE(name, data, sub, order) \ 149 DECLARE_MODULE_WITH_MAXVER(name, data, sub, order, __FreeBSD_version) 150 #else 151 #define DECLARE_MODULE(name, data, sub, order) \ 152 DECLARE_MODULE_WITH_MAXVER(name, data, sub, order, MODULE_KERNEL_MAXVER) 153 #endif 154 155 /* 156 * The module declared with DECLARE_MODULE_TIED can only be loaded 157 * into the kernel with exactly the same __FreeBSD_version. 158 * 159 * Use it for modules that use kernel interfaces that are not stable 160 * even on STABLE/X branches. 161 */ 162 #define DECLARE_MODULE_TIED(name, data, sub, order) \ 163 DECLARE_MODULE_WITH_MAXVER(name, data, sub, order, __FreeBSD_version) 164 165 #define MODULE_VERSION_CONCAT(module, version) _##module##_version 166 #define MODULE_VERSION(module, version) \ 167 static struct mod_version MODULE_VERSION_CONCAT(module, version)\ 168 __section(".data") = { \ 169 version \ 170 }; \ 171 MODULE_METADATA(MODULE_VERSION_CONCAT(module, version), MDT_VERSION,\ 172 &MODULE_VERSION_CONCAT(module, version), __XSTRING(module)) 173 174 /** 175 * Generic macros to create pnp info hints that modules may export 176 * to allow external tools to parse their internal device tables 177 * to make an informed guess about what driver(s) to load. 178 */ 179 #define MODULE_PNP_INFO(d, b, unique, t, n) \ 180 static const struct mod_pnp_match_info _module_pnp_##b##_##unique = { \ 181 .descr = d, \ 182 .bus = #b, \ 183 .table = t, \ 184 .entry_len = sizeof((t)[0]), \ 185 .num_entry = n \ 186 }; \ 187 MODULE_METADATA(_md_##b##_pnpinfo_##unique, MDT_PNP_INFO, \ 188 &_module_pnp_##b##_##unique, #b); 189 /** 190 * descr is a string that describes each entry in the table. The general 191 * form is the grammar (TYPE:pnp_name[/pnp_name];)* 192 * where TYPE is one of the following: 193 * U8 uint8_t element 194 * V8 like U8 and 0xff means match any 195 * G16 uint16_t element, any value >= matches 196 * L16 uint16_t element, any value <= matches 197 * M16 uint16_t element, mask of which of the following fields to use. 198 * U16 uint16_t element 199 * V16 like U16 and 0xffff means match any 200 * U32 uint32_t element 201 * V32 like U32 and 0xffffffff means match any 202 * W32 Two 16-bit values with first pnp_name in LSW and second in MSW. 203 * Z pointer to a string to match exactly 204 * D pointer to a string to human readable description for device 205 * P A pointer that should be ignored 206 * E EISA PNP Identifier (in binary, but bus publishes string) 207 * T Key for whole table. pnp_name=value. must be last, if present. 208 * 209 * The pnp_name "#" is reserved for other fields that should be ignored. 210 * Otherwise pnp_name must match the name from the parent device's pnpinfo 211 * output. The second pnp_name is used for the W32 type. 212 */ 213 214 extern struct sx modules_sx; 215 216 #define MOD_XLOCK sx_xlock(&modules_sx) 217 #define MOD_SLOCK sx_slock(&modules_sx) 218 #define MOD_XUNLOCK sx_xunlock(&modules_sx) 219 #define MOD_SUNLOCK sx_sunlock(&modules_sx) 220 #define MOD_LOCK_ASSERT sx_assert(&modules_sx, SX_LOCKED) 221 #define MOD_XLOCK_ASSERT sx_assert(&modules_sx, SX_XLOCKED) 222 223 struct linker_file; 224 225 void module_register_init(const void *); 226 int module_register(const struct moduledata *, struct linker_file *); 227 module_t module_lookupbyname(const char *); 228 module_t module_lookupbyid(int); 229 int module_quiesce(module_t); 230 void module_reference(module_t); 231 void module_release(module_t); 232 int module_unload(module_t); 233 int module_getid(module_t); 234 module_t module_getfnext(module_t); 235 const char * module_getname(module_t); 236 void module_setspecific(module_t, modspecific_t *); 237 struct linker_file *module_file(module_t); 238 239 #ifdef MOD_DEBUG 240 extern int mod_debug; 241 #define MOD_DEBUG_REFS 1 242 243 #define MOD_DPF(cat, args) do { \ 244 if (mod_debug & MOD_DEBUG_##cat) \ 245 printf args; \ 246 } while (0) 247 248 #else /* !MOD_DEBUG */ 249 250 #define MOD_DPF(cat, args) 251 #endif 252 #endif /* _KERNEL */ 253 254 #define MAXMODNAMEV1V2 32 255 #define MAXMODNAMEV3 MAXPATHLEN 256 #define MAXMODNAME MAXMODNAMEV3 257 258 struct module_stat { 259 int version; /* set to sizeof(struct module_stat) */ 260 char name[MAXMODNAME]; 261 int refs; 262 int id; 263 modspecific_t data; 264 }; 265 266 #ifndef _KERNEL 267 268 #include <sys/cdefs.h> 269 270 __BEGIN_DECLS 271 int modnext(int _modid); 272 int modfnext(int _modid); 273 int modstat(int _modid, struct module_stat *_stat); 274 int modfind(const char *_name); 275 __END_DECLS 276 277 #endif 278 279 #endif /* !_SYS_MODULE_H_ */ 280