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
27 #include "opt_compat.h"
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/kernel.h>
34 #include <sys/systm.h>
35 #include <sys/eventhandler.h>
36 #include <sys/malloc.h>
37 #include <sys/sysproto.h>
38 #include <sys/sysent.h>
41 #include <sys/mutex.h>
42 #include <sys/reboot.h>
44 #include <sys/module.h>
45 #include <sys/linker.h>
47 static MALLOC_DEFINE(M_MODULE, "module", "module data structures");
49 typedef TAILQ_HEAD(, module) modulelist_t;
51 TAILQ_ENTRY(module) link; /* chain together all modules */
52 TAILQ_ENTRY(module) flink; /* all modules in a file */
53 struct linker_file *file; /* file which contains this module */
54 int refs; /* reference count */
55 int id; /* unique id number */
56 char *name; /* module name */
57 modeventhand_t handler; /* event handler */
58 void *arg; /* argument for handler */
59 modspecific_t data; /* module specific data */
62 #define MOD_EVENT(mod, type) (mod)->handler((mod), (type), (mod)->arg)
64 static modulelist_t modules;
66 static int nextid = 1;
67 static void module_shutdown(void *, int);
70 modevent_nop(module_t mod, int what, void *arg)
84 module_init(void *arg)
87 sx_init(&modules_sx, "module subsystem sx lock");
89 EVENTHANDLER_REGISTER(shutdown_final, module_shutdown, NULL,
90 SHUTDOWN_PRI_DEFAULT);
93 SYSINIT(module, SI_SUB_KLD, SI_ORDER_FIRST, module_init, 0);
96 module_shutdown(void *arg1, int arg2)
100 if (arg2 & RB_NOSYNC)
104 TAILQ_FOREACH(mod, &modules, link)
105 MOD_EVENT(mod, MOD_SHUTDOWN);
111 module_register_init(const void *arg)
113 const moduledata_t *data = (const moduledata_t *)arg;
119 mod = module_lookupbyname(data->name);
121 panic("module_register_init: module named %s not found\n",
124 error = MOD_EVENT(mod, MOD_LOAD);
126 MOD_EVENT(mod, MOD_UNLOAD);
130 printf("module_register_init: MOD_LOAD (%s, %p, %p) error"
131 " %d\n", data->name, (void *)data->evhand, data->priv,
137 * Once a module is succesfully loaded, move
138 * it to the head of the module list for this
139 * linker file. This resorts the list so that
140 * when the kernel linker iterates over the
141 * modules to unload them, it will unload them
142 * in the reverse order they were loaded.
144 TAILQ_REMOVE(&mod->file->modules, mod, flink);
145 TAILQ_INSERT_HEAD(&mod->file->modules, mod, flink);
153 module_register(const moduledata_t *data, linker_file_t container)
159 newmod = module_lookupbyname(data->name);
160 if (newmod != NULL) {
162 printf("module_register: module %s already exists!\n",
166 namelen = strlen(data->name) + 1;
167 newmod = malloc(sizeof(struct module) + namelen, M_MODULE, M_WAITOK);
168 if (newmod == NULL) {
173 newmod->id = nextid++;
174 newmod->name = (char *)(newmod + 1);
175 strcpy(newmod->name, data->name);
176 newmod->handler = data->evhand ? data->evhand : modevent_nop;
177 newmod->arg = data->priv;
178 bzero(&newmod->data, sizeof(newmod->data));
179 TAILQ_INSERT_TAIL(&modules, newmod, link);
182 TAILQ_INSERT_TAIL(&container->modules, newmod, flink);
183 newmod->file = container;
189 module_reference(module_t mod)
194 MOD_DPF(REFS, ("module_reference: before, refs=%d\n", mod->refs));
199 module_release(module_t mod)
205 panic("module_release: bad reference count");
207 MOD_DPF(REFS, ("module_release: before, refs=%d\n", mod->refs));
210 if (mod->refs == 0) {
211 TAILQ_REMOVE(&modules, mod, link);
213 TAILQ_REMOVE(&mod->file->modules, mod, flink);
219 module_lookupbyname(const char *name)
226 TAILQ_FOREACH(mod, &modules, link) {
227 err = strcmp(mod->name, name);
235 module_lookupbyid(int modid)
241 TAILQ_FOREACH(mod, &modules, link)
242 if (mod->id == modid)
248 module_quiesce(module_t mod)
253 error = MOD_EVENT(mod, MOD_QUIESCE);
255 if (error == EOPNOTSUPP || error == EINVAL)
261 module_unload(module_t mod)
266 error = MOD_EVENT(mod, MOD_UNLOAD);
272 module_getid(module_t mod)
280 module_getfnext(module_t mod)
284 return (TAILQ_NEXT(mod, flink));
288 module_getname(module_t mod)
296 module_setspecific(module_t mod, modspecific_t *datap)
304 module_file(module_t mod)
314 modnext(struct thread *td, struct modnext_args *uap)
319 td->td_retval[0] = -1;
322 if (uap->modid == 0) {
323 mod = TAILQ_FIRST(&modules);
325 td->td_retval[0] = mod->id;
330 mod = module_lookupbyid(uap->modid);
335 if (TAILQ_NEXT(mod, link))
336 td->td_retval[0] = TAILQ_NEXT(mod, link)->id;
338 td->td_retval[0] = 0;
345 modfnext(struct thread *td, struct modfnext_args *uap)
350 td->td_retval[0] = -1;
353 mod = module_lookupbyid(uap->modid);
358 if (TAILQ_NEXT(mod, flink))
359 td->td_retval[0] = TAILQ_NEXT(mod, flink)->id;
361 td->td_retval[0] = 0;
367 struct module_stat_v1 {
368 int version; /* set to sizeof(struct module_stat) */
369 char name[MAXMODNAME];
375 modstat(struct thread *td, struct modstat_args *uap)
380 int id, namelen, refs, version;
381 struct module_stat *stat;
385 mod = module_lookupbyid(uap->modid);
398 * Check the version of the user's structure.
400 if ((error = copyin(&stat->version, &version, sizeof(version))) != 0)
402 if (version != sizeof(struct module_stat_v1)
403 && version != sizeof(struct module_stat))
405 namelen = strlen(mod->name) + 1;
406 if (namelen > MAXMODNAME)
407 namelen = MAXMODNAME;
408 if ((error = copyout(name, &stat->name[0], namelen)) != 0)
411 if ((error = copyout(&refs, &stat->refs, sizeof(int))) != 0)
413 if ((error = copyout(&id, &stat->id, sizeof(int))) != 0)
417 * >v1 stat includes module data.
419 if (version == sizeof(struct module_stat))
420 if ((error = copyout(&data, &stat->data,
423 td->td_retval[0] = 0;
428 modfind(struct thread *td, struct modfind_args *uap)
431 char name[MAXMODNAME];
434 if ((error = copyinstr(uap->name, name, sizeof name, 0)) != 0)
438 mod = module_lookupbyname(name);
442 td->td_retval[0] = module_getid(mod);
447 MODULE_VERSION(kernel, __FreeBSD_version);
449 #ifdef COMPAT_FREEBSD32
450 #include <sys/mount.h>
451 #include <sys/socket.h>
452 #include <compat/freebsd32/freebsd32_util.h>
453 #include <compat/freebsd32/freebsd32.h>
454 #include <compat/freebsd32/freebsd32_proto.h>
456 typedef union modspecific32 {
463 struct module_stat32 {
465 char name[MAXMODNAME];
468 modspecific32_t data;
472 freebsd32_modstat(struct thread *td, struct freebsd32_modstat_args *uap)
475 modspecific32_t data32;
477 int id, namelen, refs, version;
478 struct module_stat32 *stat32;
482 mod = module_lookupbyid(uap->modid);
491 CP(mod->data, data32, intval);
492 CP(mod->data, data32, uintval);
493 CP(mod->data, data32, longval);
494 CP(mod->data, data32, ulongval);
498 if ((error = copyin(&stat32->version, &version, sizeof(version))) != 0)
500 if (version != sizeof(struct module_stat_v1)
501 && version != sizeof(struct module_stat32))
503 namelen = strlen(mod->name) + 1;
504 if (namelen > MAXMODNAME)
505 namelen = MAXMODNAME;
506 if ((error = copyout(name, &stat32->name[0], namelen)) != 0)
509 if ((error = copyout(&refs, &stat32->refs, sizeof(int))) != 0)
511 if ((error = copyout(&id, &stat32->id, sizeof(int))) != 0)
515 * >v1 stat includes module data.
517 if (version == sizeof(struct module_stat32))
518 if ((error = copyout(&data32, &stat32->data,
519 sizeof(data32))) != 0)
521 td->td_retval[0] = 0;