sys/sys/module.h

   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$
  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         void            *md_data;       /* specific data */
  93         const char      *md_cval;       /* common string label */
  94 };
  95
  96 #ifdef  _KERNEL
  97
  98 #include <sys/linker_set.h>
  99
 100 #define MODULE_METADATA(uniquifier, type, data, cval)                   \
 101         static struct mod_metadata _mod_metadata##uniquifier = {        \
 102                 MDT_STRUCT_VERSION,                                     \
 103                 type,                                                   \
 104                 data,                                                   \
 105                 cval                                                    \
 106         };                                                              \
 107         DATA_SET(modmetadata_set, _mod_metadata##uniquifier)
 108
 109 #define MODULE_DEPEND(module, mdepend, vmin, vpref, vmax)               \
 110         static struct mod_depend _##module##_depend_on_##mdepend = {    \
 111                 vmin,                                                   \
 112                 vpref,                                                  \
 113                 vmax                                                    \
 114         };                                                              \
 115         MODULE_METADATA(_md_##module##_on_##mdepend, MDT_DEPEND,        \
 116             &_##module##_depend_on_##mdepend, #mdepend)
 117
 118 /*
 119  * Every kernel has a 'kernel' module with the version set to
 120  * __FreeBSD_version.  We embed a MODULE_DEPEND() inside every module
 121  * that depends on the 'kernel' module.  It uses the current value of
 122  * __FreeBSD_version as the minimum and preferred versions.  For the
 123  * maximum version it rounds the version up to the end of its branch
 124  * (i.e. M99999 for M.x).  This allows a module built on M.x to work
 125  * on M.y systems where y >= x, but fail on M.z systems where z < x.
 126  */
 127 #define MODULE_KERNEL_MAXVER    (roundup(__FreeBSD_version, 100000) - 1)
 128
 129 #define DECLARE_MODULE_WITH_MAXVER(name, data, sub, order, maxver)      \
 130         MODULE_DEPEND(name, kernel, __FreeBSD_version,                  \
 131             __FreeBSD_version, maxver);                 \
 132         MODULE_METADATA(_md_##name, MDT_MODULE, &data, #name);          \
 133         SYSINIT(name##module, sub, order, module_register_init, &data); \
 134         struct __hack
 135
 136 #define DECLARE_MODULE(name, data, sub, order)                          \
 137         DECLARE_MODULE_WITH_MAXVER(name, data, sub, order, MODULE_KERNEL_MAXVER)
 138
 139 /*
 140  * The module declared with DECLARE_MODULE_TIED can only be loaded
 141  * into the kernel with exactly the same __FreeBSD_version.
 142  *
 143  * Use it for modules that use kernel interfaces that are not stable
 144  * even on STABLE/X branches.
 145  */
 146 #define DECLARE_MODULE_TIED(name, data, sub, order)                             \
 147         DECLARE_MODULE_WITH_MAXVER(name, data, sub, order, __FreeBSD_version)
 148
 149 #define MODULE_VERSION(module, version)                                 \
 150         static struct mod_version _##module##_version = {               \
 151                 version                                                 \
 152         };                                                              \
 153         MODULE_METADATA(_##module##_version, MDT_VERSION,               \
 154             &_##module##_version, #module)
 155
 156 extern struct sx modules_sx;
 157
 158 #define MOD_XLOCK       sx_xlock(&modules_sx)
 159 #define MOD_SLOCK       sx_slock(&modules_sx)
 160 #define MOD_XUNLOCK     sx_xunlock(&modules_sx)
 161 #define MOD_SUNLOCK     sx_sunlock(&modules_sx)
 162 #define MOD_LOCK_ASSERT sx_assert(&modules_sx, SX_LOCKED)
 163 #define MOD_XLOCK_ASSERT        sx_assert(&modules_sx, SX_XLOCKED)
 164
 165 struct linker_file;
 166
 167 void    module_register_init(const void *);
 168 int     module_register(const struct moduledata *, struct linker_file *);
 169 module_t        module_lookupbyname(const char *);
 170 module_t        module_lookupbyid(int);
 171 int     module_quiesce(module_t);
 172 void    module_reference(module_t);
 173 void    module_release(module_t);
 174 int     module_unload(module_t);
 175 int     module_getid(module_t);
 176 module_t        module_getfnext(module_t);
 177 const char *    module_getname(module_t);
 178 void    module_setspecific(module_t, modspecific_t *);
 179 struct linker_file *module_file(module_t);
 180
 181 #ifdef  MOD_DEBUG
 182 extern int mod_debug;
 183 #define MOD_DEBUG_REFS  1
 184
 185 #define MOD_DPF(cat, args) do {                                         \
 186         if (mod_debug & MOD_DEBUG_##cat)                                \
 187                 printf(args);                                           \
 188 } while (0)
 189
 190 #else   /* !MOD_DEBUG */
 191
 192 #define MOD_DPF(cat, args)
 193 #endif
 194 #endif  /* _KERNEL */
 195
 196 #define MAXMODNAME      32
 197
 198 struct module_stat {
 199         int             version;        /* set to sizeof(struct module_stat) */
 200         char            name[MAXMODNAME];
 201         int             refs;
 202         int             id;
 203         modspecific_t   data;
 204 };
 205
 206 #ifndef _KERNEL
 207
 208 #include <sys/cdefs.h>
 209
 210 __BEGIN_DECLS
 211 int     modnext(int _modid);
 212 int     modfnext(int _modid);
 213 int     modstat(int _modid, struct module_stat *_stat);
 214 int     modfind(const char *_name);
 215 __END_DECLS
 216
 217 #endif
 218
 219 #endif  /* !_SYS_MODULE_H_ */