module.h revision 177253
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: head/sys/sys/module.h 177253 2008-03-16 10:58:09Z rwatson $ 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 39#define MDT_STRUCT_VERSION 1 /* version of metadata structure */ 40#define MDT_SETNAME "modmetadata_set" 41 42typedef enum modeventtype { 43 MOD_LOAD, 44 MOD_UNLOAD, 45 MOD_SHUTDOWN, 46 MOD_QUIESCE 47} modeventtype_t; 48 49typedef struct module *module_t; 50typedef int (*modeventhand_t)(module_t, int /* modeventtype_t */, void *); 51 52/* 53 * Struct for registering modules statically via SYSINIT. 54 */ 55typedef struct moduledata { 56 const char *name; /* module name */ 57 modeventhand_t evhand; /* event handler */ 58 void *priv; /* extra data */ 59} moduledata_t; 60 61/* 62 * A module can use this to report module specific data to the user via 63 * kldstat(2). 64 */ 65typedef union modspecific { 66 int intval; 67 u_int uintval; 68 long longval; 69 u_long ulongval; 70} modspecific_t; 71 72/* 73 * Module dependency declarartion 74 */ 75struct mod_depend { 76 int md_ver_minimum; 77 int md_ver_preferred; 78 int md_ver_maximum; 79}; 80 81/* 82 * Module version declaration 83 */ 84struct mod_version { 85 int mv_version; 86}; 87 88struct mod_metadata { 89 int md_version; /* structure version MDTV_* */ 90 int md_type; /* type of entry MDT_* */ 91 void *md_data; /* specific data */ 92 const char *md_cval; /* common string label */ 93}; 94 95#ifdef _KERNEL 96 97#include <sys/linker_set.h> 98 99#define MODULE_METADATA(uniquifier, type, data, cval) \ 100 static struct mod_metadata _mod_metadata##uniquifier = { \ 101 MDT_STRUCT_VERSION, \ 102 type, \ 103 data, \ 104 cval \ 105 }; \ 106 DATA_SET(modmetadata_set, _mod_metadata##uniquifier) 107 108#define MODULE_DEPEND(module, mdepend, vmin, vpref, vmax) \ 109 static struct mod_depend _##module##_depend_on_##mdepend = { \ 110 vmin, \ 111 vpref, \ 112 vmax \ 113 }; \ 114 MODULE_METADATA(_md_##module##_on_##mdepend, MDT_DEPEND, \ 115 &_##module##_depend_on_##mdepend, #mdepend) 116 117/* 118 * Every kernel has a 'kernel' module with the version set to 119 * __FreeBSD_version. We embed a MODULE_DEPEND() inside every module 120 * that depends on the 'kernel' module. It uses the current value of 121 * __FreeBSD_version as the minimum and preferred versions. For the 122 * maximum version it rounds the version up to the end of its branch 123 * (i.e. M99999 for M.x). This allows a module built on M.x to work 124 * on M.y systems where y >= x, but fail on M.z systems where z < x. 125 */ 126#define MODULE_KERNEL_MAXVER (roundup(__FreeBSD_version, 100000) - 1) 127 128#define DECLARE_MODULE(name, data, sub, order) \ 129 MODULE_DEPEND(name, kernel, __FreeBSD_version, \ 130 __FreeBSD_version, MODULE_KERNEL_MAXVER); \ 131 MODULE_METADATA(_md_##name, MDT_MODULE, &data, #name); \ 132 SYSINIT(name##module, sub, order, module_register_init, &data); \ 133 struct __hack 134 135#define MODULE_VERSION(module, version) \ 136 static struct mod_version _##module##_version = { \ 137 version \ 138 }; \ 139 MODULE_METADATA(_##module##_version, MDT_VERSION, \ 140 &_##module##_version, #module) 141 142extern struct sx modules_sx; 143 144#define MOD_XLOCK sx_xlock(&modules_sx) 145#define MOD_SLOCK sx_slock(&modules_sx) 146#define MOD_XUNLOCK sx_xunlock(&modules_sx) 147#define MOD_SUNLOCK sx_sunlock(&modules_sx) 148#define MOD_LOCK_ASSERT sx_assert(&modules_sx, SX_LOCKED) 149#define MOD_XLOCK_ASSERT sx_assert(&modules_sx, SX_XLOCKED) 150 151struct linker_file; 152 153void module_register_init(const void *); 154int module_register(const struct moduledata *, struct linker_file *); 155module_t module_lookupbyname(const char *); 156module_t module_lookupbyid(int); 157void module_reference(module_t); 158void module_release(module_t); 159int module_unload(module_t, int flags); 160int module_getid(module_t); 161module_t module_getfnext(module_t); 162void module_setspecific(module_t, modspecific_t *); 163struct linker_file *module_file(module_t); 164 165#ifdef MOD_DEBUG 166extern int mod_debug; 167#define MOD_DEBUG_REFS 1 168 169#define MOD_DPF(cat, args) do { \ 170 if (mod_debug & MOD_DEBUG_##cat) \ 171 printf(args); \ 172} while (0) 173 174#else /* !MOD_DEBUG */ 175 176#define MOD_DPF(cat, args) 177#endif 178#endif /* _KERNEL */ 179 180#define MAXMODNAME 32 181 182struct module_stat { 183 int version; /* set to sizeof(struct module_stat) */ 184 char name[MAXMODNAME]; 185 int refs; 186 int id; 187 modspecific_t data; 188}; 189 190#ifndef _KERNEL 191 192#include <sys/cdefs.h> 193 194__BEGIN_DECLS 195int modnext(int _modid); 196int modfnext(int _modid); 197int modstat(int _modid, struct module_stat *_stat); 198int modfind(const char *_name); 199__END_DECLS 200 201#endif 202 203#endif /* !_SYS_MODULE_H_ */ 204