The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/module.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    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: releng/5.2/sys/sys/module.h 92547 2002-03-18 07:45:30Z arr $
   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 
   42 typedef enum modeventtype {
   43         MOD_LOAD,
   44         MOD_UNLOAD,
   45         MOD_SHUTDOWN
   46 } modeventtype_t;
   47 
   48 typedef struct module *module_t;
   49 typedef int (*modeventhand_t)(module_t, int /* modeventtype_t */, void *);
   50 
   51 /*
   52  * Struct for registering modules statically via SYSINIT.
   53  */
   54 typedef struct moduledata {
   55         const char      *name;          /* module name */
   56         modeventhand_t  evhand;         /* event handler */
   57         void            *priv;          /* extra data */
   58 } moduledata_t;
   59 
   60 /*
   61  * A module can use this to report module specific data to the user via
   62  * kldstat(2).
   63  */
   64 typedef union modspecific {
   65         int     intval;
   66         u_int   uintval;
   67         long    longval;
   68         u_long  ulongval;
   69 } modspecific_t;
   70 
   71 /*
   72  * Module dependency declarartion
   73  */
   74 struct mod_depend {
   75         int     md_ver_minimum;
   76         int     md_ver_preferred;
   77         int     md_ver_maximum;
   78 };
   79 
   80 /*
   81  * Module version declaration
   82  */
   83 struct mod_version {
   84         int     mv_version;
   85 };
   86 
   87 struct mod_metadata {
   88         int             md_version;     /* structure version MDTV_* */
   89         int             md_type;        /* type of entry MDT_* */
   90         void            *md_data;       /* specific data */
   91         const char      *md_cval;       /* common string label */
   92 };
   93 
   94 #ifdef  _KERNEL
   95 
   96 #include <sys/linker_set.h>
   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 extern struct sx modules_sx;
  129 
  130 #define MOD_XLOCK       sx_xlock(&modules_sx)
  131 #define MOD_SLOCK       sx_slock(&modules_sx)
  132 #define MOD_XUNLOCK     sx_xunlock(&modules_sx)
  133 #define MOD_SUNLOCK     sx_sunlock(&modules_sx)
  134 #define MOD_LOCK_ASSERT sx_assert(&modules_sx, SX_LOCKED)
  135 #define MOD_XLOCK_ASSERT        sx_assert(&modules_sx, SX_XLOCKED)
  136 
  137 struct linker_file;
  138 
  139 void    module_register_init(const void *);
  140 int     module_register(const struct moduledata *, struct linker_file *);
  141 module_t        module_lookupbyname(const char *);
  142 module_t        module_lookupbyid(int);
  143 void    module_reference(module_t);
  144 void    module_release(module_t);
  145 int     module_unload(module_t);
  146 int     module_getid(module_t);
  147 module_t        module_getfnext(module_t);
  148 void    module_setspecific(module_t, modspecific_t *);
  149 
  150 #ifdef  MOD_DEBUG
  151 extern int mod_debug;
  152 #define MOD_DEBUG_REFS  1
  153 
  154 #define MOD_DPF(cat, args) do {                                         \
  155         if (mod_debug & MOD_DEBUG_##cat)                                \
  156                 printf(args);                                           \
  157 } while (0)
  158 
  159 #else   /* !MOD_DEBUG */
  160 
  161 #define MOD_DPF(cat, args)
  162 #endif
  163 #endif  /* _KERNEL */
  164 
  165 #define MAXMODNAME      32
  166 
  167 struct module_stat {
  168         int             version;        /* set to sizeof(struct module_stat) */
  169         char            name[MAXMODNAME];
  170         int             refs;
  171         int             id;
  172         modspecific_t   data;
  173 };
  174 
  175 #ifndef _KERNEL
  176 
  177 #include <sys/cdefs.h>
  178 
  179 __BEGIN_DECLS
  180 int     modnext(int _modid);
  181 int     modfnext(int _modid);
  182 int     modstat(int _modid, struct module_stat *_stat);
  183 int     modfind(const char *_name);
  184 __END_DECLS
  185 
  186 #endif
  187 
  188 #endif  /* !_SYS_MODULE_H_ */

Cache object: 2aa7de33308157b0902f527a1bcb08a3


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.