2 * Copyright (c) 1997 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
26 * $FreeBSD: src/sys/kern/kern_module.c,v 1.21 1999/11/08 06:53:30 peter Exp $
29 #include <sys/param.h>
30 #include <sys/kernel.h>
31 #include <sys/systm.h>
32 #include <sys/eventhandler.h>
33 #include <sys/malloc.h>
34 #include <sys/sysproto.h>
35 #include <sys/sysent.h>
36 #include <sys/module.h>
37 #include <sys/linker.h>
40 #include <sys/mplock2.h>
42 MALLOC_DEFINE(M_MODULE, "module", "module data structures");
44 typedef TAILQ_HEAD(, module) modulelist_t;
46 TAILQ_ENTRY(module) link; /* chain together all modules */
47 TAILQ_ENTRY(module) flink; /* all modules in a file */
48 struct linker_file* file; /* file which contains this module */
49 int refs; /* reference count */
50 int id; /* unique id number */
51 char *name; /* module name */
52 modeventhand_t handler; /* event handler */
53 void *arg; /* argument for handler */
54 modspecific_t data; /* module specific data */
57 #define MOD_EVENT(mod, type) (mod)->handler((mod), (type), (mod)->arg)
59 static modulelist_t modules = TAILQ_HEAD_INITIALIZER(modules);
60 static int nextid = 1;
62 static void module_shutdown(void*, int);
65 modevent_nop(module_t mod, int what, void* arg)
72 module_init(void* arg)
75 EVENTHANDLER_REGISTER(shutdown_post_sync, module_shutdown, NULL,
76 SHUTDOWN_PRI_DEFAULT);
79 SYSINIT(module, SI_BOOT2_KLD, SI_ORDER_FIRST, module_init, 0);
82 module_shutdown(void* arg1, int arg2)
86 for (mod = TAILQ_FIRST(&modules); mod; mod = TAILQ_NEXT(mod, link))
87 MOD_EVENT(mod, MOD_SHUTDOWN);
91 module_register_init(const void *arg)
93 const moduledata_t* data = (const moduledata_t*) arg;
97 mod = module_lookupbyname(data->name);
100 panic("module_register_init: module named %s not found", data->name);
102 /* temporary kludge until kernel `file' attachment registers modules */
103 error = module_register(data, linker_kernel_file);
105 panic("module_register_init: register of module failed! %d", error);
106 mod = module_lookupbyname(data->name);
108 panic("module_register_init: module STILL not found!");
111 error = MOD_EVENT(mod, MOD_LOAD);
113 module_unload(mod); /* ignore error */
115 kprintf("module_register_init: MOD_LOAD (%s, %lx, %p) error %d\n",
116 data->name, (u_long)(uintfptr_t)data->evhand, data->priv, error);
121 module_register(const moduledata_t *data, linker_file_t container)
126 newmod = module_lookupbyname(data->name);
127 if (newmod != NULL) {
128 kprintf("module_register: module %s already exists!\n", data->name);
131 namelen = strlen(data->name) + 1;
132 newmod = (module_t) kmalloc(sizeof(struct module) + namelen,
136 newmod->id = nextid++;
137 newmod->name = (char *) (newmod + 1);
138 strcpy(newmod->name, data->name);
139 newmod->handler = data->evhand ? data->evhand : modevent_nop;
140 newmod->arg = data->priv;
141 bzero(&newmod->data, sizeof(newmod->data));
142 TAILQ_INSERT_TAIL(&modules, newmod, link);
144 if (container == NULL)
145 container = linker_current_file;
147 TAILQ_INSERT_TAIL(&container->modules, newmod, flink);
148 newmod->file = container;
154 module_reference(module_t mod)
156 MOD_DPF(REFS, ("module_reference: before, refs=%d\n", mod->refs));
164 * Release ref on the module and return the new reference count. If 0
165 * is returned, the module has been removed from its list and freed.
168 module_release(module_t mod)
173 panic("module_release: bad reference count");
175 MOD_DPF(REFS, ("module_release: before, refs=%d\n", mod->refs));
179 TAILQ_REMOVE(&modules, mod, link);
181 TAILQ_REMOVE(&mod->file->modules, mod, flink);
183 kfree(mod, M_MODULE);
189 module_lookupbyname(const char* name)
193 for (mod = TAILQ_FIRST(&modules); mod; mod = TAILQ_NEXT(mod, link)) {
194 if (!strcmp(mod->name, name))
202 module_lookupbyid(int modid)
206 for (mod = TAILQ_FIRST(&modules); mod; mod = TAILQ_NEXT(mod, link)) {
207 if (mod->id == modid)
215 module_unload(module_t mod)
219 error = MOD_EVENT(mod, MOD_UNLOAD);
225 module_getid(module_t mod)
231 module_getfnext(module_t mod)
233 return TAILQ_NEXT(mod, flink);
237 module_setspecific(module_t mod, modspecific_t *datap)
248 sys_modnext(struct modnext_args *uap)
255 uap->sysmsg_result = -1;
256 if (uap->modid == 0) {
257 mod = TAILQ_FIRST(&modules);
259 uap->sysmsg_result = mod->id;
265 mod = module_lookupbyid(uap->modid);
271 if (TAILQ_NEXT(mod, link))
272 uap->sysmsg_result = TAILQ_NEXT(mod, link)->id;
274 uap->sysmsg_result = 0;
284 sys_modfnext(struct modfnext_args *uap)
290 uap->sysmsg_result = -1;
292 mod = module_lookupbyid(uap->modid);
298 if (TAILQ_NEXT(mod, flink))
299 uap->sysmsg_result = TAILQ_NEXT(mod, flink)->id;
301 uap->sysmsg_result = 0;
308 struct module_stat_v1 {
309 int version; /* set to sizeof(struct module_stat) */
310 char name[MAXMODNAME];
319 sys_modstat(struct modstat_args *uap)
325 struct module_stat* stat;
328 mod = module_lookupbyid(uap->modid);
337 * Check the version of the user's structure.
339 if ((error = copyin(&stat->version, &version, sizeof(version))) != 0)
341 if (version != sizeof(struct module_stat_v1)
342 && version != sizeof(struct module_stat)) {
347 namelen = strlen(mod->name) + 1;
348 if (namelen > MAXMODNAME)
349 namelen = MAXMODNAME;
350 if ((error = copyout(mod->name, &stat->name[0], namelen)) != 0)
353 if ((error = copyout(&mod->refs, &stat->refs, sizeof(int))) != 0)
355 if ((error = copyout(&mod->id, &stat->id, sizeof(int))) != 0)
359 * >v1 stat includes module data.
361 if (version == sizeof(struct module_stat)) {
362 if ((error = copyout(&mod->data, &stat->data, sizeof(mod->data))) != 0)
366 uap->sysmsg_result = 0;
377 sys_modfind(struct modfind_args *uap)
380 char name[MAXMODNAME];
384 if ((error = copyinstr(uap->name, name, sizeof name, 0)) != 0)
387 mod = module_lookupbyname(name);
391 uap->sysmsg_result = mod->id;