sys/sys/module.h

/*-
 * Copyright (c) 1997 Doug Rabson
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      $Id$
 */

#ifndef _SYS_MODULE_H_
#define _SYS_MODULE_H_

#ifdef KERNEL

typedef enum {
    MOD_LOAD,
    MOD_UNLOAD,
    MOD_SHUTDOWN
} modeventtype_t;

struct module;
typedef struct module *module_t;

typedef int (*modeventhand_t)(module_t mod, modeventtype_t what, void *arg);

/*
 * Struct for registering modules statically via SYSINIT.
 */
typedef struct moduledata {
    char*               name;   /* module name */
    modeventhand_t      evhand; /* event handler */
    void*               priv;   /* extra data */
} moduledata_t;

#define DECLARE_MODULE(name, data, sub, order) \
SYSINIT(name##module, sub, order, module_register_static, &data)

void module_register_static(void *data);
int module_register(const char *name, modeventhand_t callback, void *arg);
module_t module_lookupbyname(const char *name);
module_t module_lookupbyid(int modid);
void module_reference(module_t mod);
void module_release(module_t mod);
int module_unload(module_t mod);
int module_getid(module_t mod);
module_t module_getfnext(module_t mod);

#ifdef MOD_DEBUG

extern int mod_debug;
#define MOD_DEBUG_REFS  1

#define MOD_DPF(cat, args)                                      \
        do {                                                    \
                if (mod_debug & MOD_DEBUG_##cat) printf args;   \
        } while (0)

#else

#define MOD_DPF(cat, args)

#endif

#endif /* KERNEL */

#define MAXMODNAME      32

struct module_stat {
    int         version;        /* set to sizeof(struct module_stat) */
    char        name[MAXMODNAME];
    int         refs;
    int         id;
};

#ifndef KERNEL

#include <sys/cdefs.h>

__BEGIN_DECLS
int     modnext(int modid);
int     modfnext(int modid);
int     modstat(int modid, struct module_stat* stat);
int     modfind(char *name);
__END_DECLS

#endif

#endif  /* !_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	* $Id$
27	*/
28
29	#ifndef _SYS_MODULE_H_
30	#define _SYS_MODULE_H_
31
32	#ifdef KERNEL
33
34	typedef enum {
35	MOD_LOAD,
36	MOD_UNLOAD,
37	MOD_SHUTDOWN
38	} modeventtype_t;
39
40	struct module;
41	typedef struct module *module_t;
42
43	typedef int (modeventhand_t)(module_t mod, modeventtype_t what, void arg);
44
45	/*
46	* Struct for registering modules statically via SYSINIT.
47	*/
48	typedef struct moduledata {
49	char* name; /* module name */
50	modeventhand_t evhand; /* event handler */
51	void* priv; /* extra data */
52	} moduledata_t;
53
54	#define DECLARE_MODULE(name, data, sub, order) \
55	SYSINIT(name##module, sub, order, module_register_static, &data)
56
57	void module_register_static(void *data);
58	int module_register(const char name, modeventhand_t callback, void arg);
59	module_t module_lookupbyname(const char *name);
60	module_t module_lookupbyid(int modid);
61	void module_reference(module_t mod);
62	void module_release(module_t mod);
63	int module_unload(module_t mod);
64	int module_getid(module_t mod);
65	module_t module_getfnext(module_t mod);
66
67	#ifdef MOD_DEBUG
68
69	extern int mod_debug;
70	#define MOD_DEBUG_REFS 1
71
72	#define MOD_DPF(cat, args) \
73	do { \
74	if (mod_debug & MOD_DEBUG_##cat) printf args; \
75	} while (0)
76
77	#else
78
79	#define MOD_DPF(cat, args)
80
81	#endif
82
83	#endif /* KERNEL */
84
85	#define MAXMODNAME 32
86
87	struct module_stat {
88	int version; /* set to sizeof(struct module_stat) */
89	char name[MAXMODNAME];
90	int refs;
91	int id;
92	};
93
94	#ifndef KERNEL
95
96	#include <sys/cdefs.h>
97
98	__BEGIN_DECLS
99	int modnext(int modid);
100	int modfnext(int modid);
101	int modstat(int modid, struct module_stat* stat);
102	int modfind(char *name);
103	__END_DECLS
104
105	#endif
106
107	#endif /* !_SYS_MODULE_H_ */