module.h revision 50477 
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: head/sys/sys/module.h 50477 1999-08-28 01:08:13Z peter $
27 */
28
29#ifndef _SYS_MODULE_H_
30#define _SYS_MODULE_H_
31
32typedef enum modeventtype {
33    MOD_LOAD,
34    MOD_UNLOAD,
35    MOD_SHUTDOWN
36} modeventtype_t;
37
38typedef	struct module *module_t;
39
40typedef	int (*modeventhand_t)(module_t mod, int /*modeventtype_t*/ what,
41			      void *arg);
42
43/*
44 * Struct for registering modules statically via SYSINIT.
45 */
46typedef struct moduledata {
47	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 */
56typedef 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 DECLARE_MODULE(name, data, sub, order) \
66    SYSINIT(name##module, sub, order, module_register_init, &data) \
67    struct __hack
68
69void module_register_init(const void *data);
70struct linker_file;
71int module_register(const struct moduledata *data, struct linker_file *lf);
72module_t module_lookupbyname(const char *name);
73module_t module_lookupbyid(int modid);
74void module_reference(module_t mod);
75void module_release(module_t mod);
76int module_unload(module_t mod);
77int module_getid(module_t mod);
78module_t module_getfnext(module_t mod);
79void module_setspecific(module_t mod, modspecific_t *datap);
80
81#ifdef MOD_DEBUG
82
83extern int mod_debug;
84#define MOD_DEBUG_REFS	1
85
86#define MOD_DPF(cat, args)					\
87	do {							\
88		if (mod_debug & MOD_DEBUG_##cat) printf args;	\
89	} while (0)
90
91#else
92
93#define MOD_DPF(cat, args)
94
95#endif
96
97#endif /* KERNEL */
98
99#define MAXMODNAME	32
100
101struct module_stat {
102    int		version;	/* set to sizeof(struct module_stat) */
103    char	name[MAXMODNAME];
104    int		refs;
105    int		id;
106    modspecific_t data;
107};
108
109#ifndef KERNEL
110
111#include <sys/cdefs.h>
112
113__BEGIN_DECLS
114int	modnext(int modid);
115int	modfnext(int modid);
116int	modstat(int modid, struct module_stat* stat);
117int	modfind(char *name);
118__END_DECLS
119
120#endif
121
122#endif	/* !_SYS_MODULE_H_ */
123