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: src/sys/sys/module.h,v 1.21 2004/07/13 19:36:59 phk Exp $
   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         MOD_QUIESCE
   47 } modeventtype_t;
   48 
   49 typedef struct module *module_t;
   50 typedef int (*modeventhand_t)(module_t, int /* modeventtype_t */, void *);
   51 
   52 /*
   53  * Struct for registering modules statically via SYSINIT.
   54  */
   55 typedef 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  */
   65 typedef 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  */
   75 struct 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  */
   84 struct mod_version {
   85         int     mv_version;
   86 };
   87 
   88 struct 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 #define DECLARE_MODULE(name, data, sub, order)                          \
  118         MODULE_METADATA(_md_##name, MDT_MODULE, &data, #name);          \
  119         SYSINIT(name##module, sub, order, module_register_init, &data)  \
  120         struct __hack
  121 
  122 #define MODULE_VERSION(module, version)                                 \
  123         static struct mod_version _##module##_version = {               \
  124                 version                                                 \
  125         };                                                              \
  126         MODULE_METADATA(_##module##_version, MDT_VERSION,               \
  127             &_##module##_version, #module)
  128 
  129 extern struct sx modules_sx;
  130 
  131 #define MOD_XLOCK       sx_xlock(&modules_sx)
  132 #define MOD_SLOCK       sx_slock(&modules_sx)
  133 #define MOD_XUNLOCK     sx_xunlock(&modules_sx)
  134 #define MOD_SUNLOCK     sx_sunlock(&modules_sx)
  135 #define MOD_LOCK_ASSERT sx_assert(&modules_sx, SX_LOCKED)
  136 #define MOD_XLOCK_ASSERT        sx_assert(&modules_sx, SX_XLOCKED)
  137 
  138 struct linker_file;
  139 
  140 void    module_register_init(const void *);
  141 int     module_register(const struct moduledata *, struct linker_file *);
  142 module_t        module_lookupbyname(const char *);
  143 module_t        module_lookupbyid(int);
  144 void    module_reference(module_t);
  145 void    module_release(module_t);
  146 int     module_unload(module_t, int flags);
  147 int     module_getid(module_t);
  148 module_t        module_getfnext(module_t);
  149 void    module_setspecific(module_t, modspecific_t *);
  150 
  151 #ifdef  MOD_DEBUG
  152 extern int mod_debug;
  153 #define MOD_DEBUG_REFS  1
  154 
  155 #define MOD_DPF(cat, args) do {                                         \
  156         if (mod_debug & MOD_DEBUG_##cat)                                \
  157                 printf(args);                                           \
  158 } while (0)
  159 
  160 #else   /* !MOD_DEBUG */
  161 
  162 #define MOD_DPF(cat, args)
  163 #endif
  164 #endif  /* _KERNEL */
  165 
  166 #define MAXMODNAME      32
  167 
  168 struct module_stat {
  169         int             version;        /* set to sizeof(struct module_stat) */
  170         char            name[MAXMODNAME];
  171         int             refs;
  172         int             id;
  173         modspecific_t   data;
  174 };
  175 
  176 #ifndef _KERNEL
  177 
  178 #include <sys/cdefs.h>
  179 
  180 __BEGIN_DECLS
  181 int     modnext(int _modid);
  182 int     modfnext(int _modid);
  183 int     modstat(int _modid, struct module_stat *_stat);
  184 int     modfind(const char *_name);
  185 __END_DECLS
  186 
  187 #endif
  188 
  189 #endif  /* !_SYS_MODULE_H_ */

Cache object: d32343bb4e4715bf83a1b5bb2b10c70e


[ 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.