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  */
  28
  29 #ifndef _SYS_MODULE_H_
  30 #define _SYS_MODULE_H_
  31
  32 typedef enum modeventtype {
  33     MOD_LOAD,
  34     MOD_UNLOAD,
  35     MOD_SHUTDOWN
  36 } modeventtype_t;
  37
  38 typedef struct module *module_t;
  39
  40 typedef int (*modeventhand_t)(module_t mod, int /*modeventtype_t*/ what,
  41                               void *arg);
  42
  43 /*
  44  * Struct for registering modules statically via SYSINIT.
  45  */
  46 typedef struct moduledata {
  47         const char      *name;  /* module name */
  48         modeventhand_t  evhand; /* event handler */
  49         void            *priv;  /* extra data */
  50 } moduledata_t;
  51
  52 /*
  53  * A module can use this to report module specific data to
  54  * the user via kldstat(2).
  55  */
  56 typedef union modspecific {
  57     int         intval;
  58     u_int       uintval;
  59     long        longval;
  60     u_long      ulongval;
  61 } modspecific_t;
  62
  63 #ifdef _KERNEL
  64
  65 #define MODULE_METADATA(uniquifier, type, data, cval)
  66
  67 #define MODULE_DEPEND(mod, dep, min, pref, max)
  68
  69 #define DECLARE_MODULE(name, data, sub, order) \
  70     SYSINIT(name##module, sub, order, module_register_init, &data) \
  71     struct __hack
  72
  73 #define MODULE_VERSION(mod, ver)
  74
  75 void module_register_init(const void *data);
  76 struct linker_file;
  77 int module_register(const struct moduledata *data, struct linker_file *lf);
  78 module_t module_lookupbyname(const char *name);
  79 module_t module_lookupbyid(int modid);
  80 void module_reference(module_t mod);
  81 void module_release(module_t mod);
  82 int module_unload(module_t mod);
  83 int module_getid(module_t mod);
  84 module_t module_getfnext(module_t mod);
  85 void module_setspecific(module_t mod, modspecific_t *datap);
  86
  87 #ifdef MOD_DEBUG
  88
  89 extern int mod_debug;
  90 #define MOD_DEBUG_REFS  1
  91
  92 #define MOD_DPF(cat, args)                                      \
  93         do {                                                    \
  94                 if (mod_debug & MOD_DEBUG_##cat) printf args;   \
  95         } while (0)
  96
  97 #else
  98
  99 #define MOD_DPF(cat, args)
 100
 101 #endif
 102
 103 #endif /* _KERNEL */
 104
 105 #define MAXMODNAME      32
 106
 107 struct module_stat {
 108     int         version;        /* set to sizeof(struct module_stat) */
 109     char        name[MAXMODNAME];
 110     int         refs;
 111     int         id;
 112     modspecific_t data;
 113 };
 114
 115 #ifndef _KERNEL
 116
 117 #include <sys/cdefs.h>
 118
 119 __BEGIN_DECLS
 120 int     modnext(int _modid);
 121 int     modfnext(int _modid);
 122 int     modstat(int _modid, struct module_stat* _stat);
 123 int     modfind(const char *_name);
 124 __END_DECLS
 125
 126 #endif
 127
 128 #endif  /* !_SYS_MODULE_H_ */