FreeBSD/Linux Kernel Cross Reference
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 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 char *name; /* module name */
48 modeventhand_t evhand; /* event handler */
49 void *priv; /* extra data */
50 void *_file; /* private; used by linker */
51 } moduledata_t;
52
53 /*
54 * A module can use this to report module specific data to
55 * the user via kldstat(2).
56 */
57 typedef union modspecific {
58 int intval;
59 u_int uintval;
60 long longval;
61 u_long ulongval;
62 } modspecific_t;
63
64 #ifdef KERNEL
65
66 #define DECLARE_MODULE(name, data, sub, order) \
67 SYSINIT(name##module, sub, order, module_register_init, &data) \
68 struct __hack
69
70 void module_register_init(void *data);
71 int module_register(const char *name, modeventhand_t callback, void *arg,
72 void *file);
73 module_t module_lookupbyname(const char *name);
74 module_t module_lookupbyid(int modid);
75 void module_reference(module_t mod);
76 void module_release(module_t mod);
77 int module_unload(module_t mod);
78 int module_getid(module_t mod);
79 module_t module_getfnext(module_t mod);
80 void module_setspecific(module_t mod, modspecific_t *datap);
81
82 #ifdef MOD_DEBUG
83
84 extern int mod_debug;
85 #define MOD_DEBUG_REFS 1
86
87 #define MOD_DPF(cat, args) \
88 do { \
89 if (mod_debug & MOD_DEBUG_##cat) printf args; \
90 } while (0)
91
92 #else
93
94 #define MOD_DPF(cat, args)
95
96 #endif
97
98 #endif /* KERNEL */
99
100 #define MAXMODNAME 32
101
102 struct module_stat {
103 int version; /* set to sizeof(struct module_stat) */
104 char name[MAXMODNAME];
105 int refs;
106 int id;
107 modspecific_t data;
108 };
109
110 #ifndef KERNEL
111
112 #include <sys/cdefs.h>
113
114 __BEGIN_DECLS
115 int modnext(int modid);
116 int modfnext(int modid);
117 int modstat(int modid, struct module_stat* stat);
118 int modfind(char *name);
119 __END_DECLS
120
121 #endif
122
123 #endif /* !_SYS_MODULE_H_ */
Cache object: 087a17dc8c6364594452f57b9f8f5ab9
|