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: 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.8 2004/03/18 18:51:56 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 #define MODULE_VERSION(module, version)                                 \
 122         static struct mod_version _##module##_version = {               \
 123                 version                                                 \
 124         };                                                              \
 125         MODULE_METADATA(_##module##_version, MDT_VERSION,               \
 126             &_##module##_version, #module)
 127
 128 /*
 129  * This is used to declare a module name that is the same as the KLD
 130  * name so the kernel can avoid double-loading modules.  It is typically
 131  * necessary when a module is made up of several bus drivers each with
 132  * its own separate sysinit.
 133  */
 134 #define DECLARE_DUMMY_MODULE(name)                                      \
 135     MODULE_METADATA(_md_##name, MDT_MODULE, NULL, #name)
 136
 137 void module_register_init(const void *data);
 138 struct linker_file;
 139 int module_register(const struct moduledata *data, struct linker_file *lf);
 140 module_t module_lookupbyname(const char *name);
 141 module_t module_lookupbyid(int modid);
 142 void module_reference(module_t mod);
 143 int module_release(module_t mod);
 144 int module_unload(module_t mod);
 145 int module_getid(module_t mod);
 146 module_t module_getfnext(module_t mod);
 147 void module_setspecific(module_t mod, modspecific_t *datap);
 148
 149 #ifdef MOD_DEBUG
 150
 151 extern int mod_debug;
 152 #define MOD_DEBUG_REFS  1
 153
 154 #define MOD_DPF(cat, args)                                      \
 155         do {                                                    \
 156                 if (mod_debug & MOD_DEBUG_##cat) printf args;   \
 157         } while (0)
 158
 159 #else
 160
 161 #define MOD_DPF(cat, args)
 162
 163 #endif
 164
 165 #endif /* _KERNEL */
 166
 167 #define MAXMODNAME      32
 168
 169 struct module_stat {
 170     int         version;        /* set to sizeof(struct module_stat) */
 171     char        name[MAXMODNAME];
 172     int         refs;
 173     int         id;
 174     modspecific_t data;
 175 };
 176
 177 #ifndef _KERNEL
 178
 179 #include <sys/cdefs.h>
 180
 181 __BEGIN_DECLS
 182 int     modnext(int);
 183 int     modfnext(int);
 184 int     modstat(int, struct module_stat *);
 185 int     modfind(const char *);
 186 __END_DECLS
 187
 188 #endif
 189
 190 #endif  /* !_SYS_MODULE_H_ */