2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
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");
50 TAILQ_ENTRY(module) link; /* chain together all modules */
51 TAILQ_ENTRY(module) flink; /* all modules in a file */
52 struct linker_file *file; /* file which contains this module */
53 int refs; /* reference count */
54 int id; /* unique id number */
55 char *name; /* module name */
56 modeventhand_t handler; /* event handler */
57 void *arg; /* argument for handler */
58 modspecific_t data; /* module specific data */
61 #define MOD_EVENT(mod, type) (mod)->handler((mod), (type), (mod)->arg)
63 static TAILQ_HEAD(modulelist, module) modules;
65 static int nextid = 1;
66 static void module_shutdown(void *, int);
69 modevent_nop(module_t mod, int what, void *arg)
83 module_init(void *arg)
86 sx_init(&modules_sx, "module subsystem sx lock");
88 EVENTHANDLER_REGISTER(shutdown_final, module_shutdown, NULL,
89 SHUTDOWN_PRI_DEFAULT);
92 SYSINIT(module, SI_SUB_KLD, SI_ORDER_FIRST, module_init, NULL);
95 module_shutdown(void *arg1, int arg2)
103 TAILQ_FOREACH_REVERSE(mod, &modules, modulelist, link)
104 MOD_EVENT(mod, MOD_SHUTDOWN);
110 module_register_init(const void *arg)
112 const moduledata_t *data = (const moduledata_t *)arg;
118 mod = module_lookupbyname(data->name);
120 panic("module_register_init: module named %s not found\n",
123 error = MOD_EVENT(mod, MOD_LOAD);
125 MOD_EVENT(mod, MOD_UNLOAD);
129 printf("module_register_init: MOD_LOAD (%s, %p, %p) error"
130 " %d\n", data->name, (void *)data->evhand, data->priv,
136 * Once a module is successfully loaded, move
137 * it to the head of the module list for this
138 * linker file. This resorts the list so that
139 * when the kernel linker iterates over the
140 * modules to unload them, it will unload them
141 * in the reverse order they were loaded.
143 TAILQ_REMOVE(&mod->file->modules, mod, flink);
144 TAILQ_INSERT_HEAD(&mod->file->modules, mod, flink);
152 module_register(const moduledata_t *data, linker_file_t container)
158 newmod = module_lookupbyname(data->name);
159 if (newmod != NULL) {
161 printf("%s: cannot register %s from %s; already loaded from %s\n",
162 __func__, data->name, container->filename, newmod->file->filename);
165 namelen = strlen(data->name) + 1;
166 newmod = malloc(sizeof(struct module) + namelen, M_MODULE, M_WAITOK);
168 newmod->id = nextid++;
169 newmod->name = (char *)(newmod + 1);
170 strcpy(newmod->name, data->name);
171 newmod->handler = data->evhand ? data->evhand : modevent_nop;
172 newmod->arg = data->priv;
173 bzero(&newmod->data, sizeof(newmod->data));
174 TAILQ_INSERT_TAIL(&modules, newmod, link);
177 TAILQ_INSERT_TAIL(&container->modules, newmod, flink);
178 newmod->file = container;
184 module_reference(module_t mod)
189 MOD_DPF(REFS, ("module_reference: before, refs=%d\n", mod->refs));
194 module_release(module_t mod)
200 panic("module_release: bad reference count");
202 MOD_DPF(REFS, ("module_release: before, refs=%d\n", mod->refs));
205 if (mod->refs == 0) {
206 TAILQ_REMOVE(&modules, mod, link);
208 TAILQ_REMOVE(&mod->file->modules, mod, flink);
214 module_lookupbyname(const char *name)
221 TAILQ_FOREACH(mod, &modules, link) {
222 err = strcmp(mod->name, name);
230 module_lookupbyid(int modid)
236 TAILQ_FOREACH(mod, &modules, link)
237 if (mod->id == modid)
243 module_quiesce(module_t mod)
248 error = MOD_EVENT(mod, MOD_QUIESCE);
250 if (error == EOPNOTSUPP || error == EINVAL)
256 module_unload(module_t mod)
261 error = MOD_EVENT(mod, MOD_UNLOAD);
267 module_getid(module_t mod)
275 module_getfnext(module_t mod)
279 return (TAILQ_NEXT(mod, flink));
283 module_getname(module_t mod)
291 module_setspecific(module_t mod, modspecific_t *datap)
299 module_file(module_t mod)
309 sys_modnext(struct thread *td, struct modnext_args *uap)
314 td->td_retval[0] = -1;
317 if (uap->modid == 0) {
318 mod = TAILQ_FIRST(&modules);
320 td->td_retval[0] = mod->id;
325 mod = module_lookupbyid(uap->modid);
330 if (TAILQ_NEXT(mod, link))
331 td->td_retval[0] = TAILQ_NEXT(mod, link)->id;
333 td->td_retval[0] = 0;
340 sys_modfnext(struct thread *td, struct modfnext_args *uap)
345 td->td_retval[0] = -1;
348 mod = module_lookupbyid(uap->modid);
353 if (TAILQ_NEXT(mod, flink))
354 td->td_retval[0] = TAILQ_NEXT(mod, flink)->id;
356 td->td_retval[0] = 0;
362 struct module_stat_v1 {
363 int version; /* set to sizeof(struct module_stat) */
364 char name[MAXMODNAME];
370 sys_modstat(struct thread *td, struct modstat_args *uap)
375 int id, namelen, refs, version;
376 struct module_stat *stat;
380 mod = module_lookupbyid(uap->modid);
393 * Check the version of the user's structure.
395 if ((error = copyin(&stat->version, &version, sizeof(version))) != 0)
397 if (version != sizeof(struct module_stat_v1)
398 && version != sizeof(struct module_stat))
400 namelen = strlen(mod->name) + 1;
401 if (namelen > MAXMODNAME)
402 namelen = MAXMODNAME;
403 if ((error = copyout(name, &stat->name[0], namelen)) != 0)
406 if ((error = copyout(&refs, &stat->refs, sizeof(int))) != 0)
408 if ((error = copyout(&id, &stat->id, sizeof(int))) != 0)
412 * >v1 stat includes module data.
414 if (version == sizeof(struct module_stat))
415 if ((error = copyout(&data, &stat->data,
418 td->td_retval[0] = 0;
423 sys_modfind(struct thread *td, struct modfind_args *uap)
426 char name[MAXMODNAME];
429 if ((error = copyinstr(uap->name, name, sizeof name, 0)) != 0)
433 mod = module_lookupbyname(name);
437 td->td_retval[0] = module_getid(mod);
442 MODULE_VERSION(kernel, __FreeBSD_version);
444 #ifdef COMPAT_FREEBSD32
445 #include <sys/mount.h>
446 #include <sys/socket.h>
447 #include <compat/freebsd32/freebsd32_util.h>
448 #include <compat/freebsd32/freebsd32.h>
449 #include <compat/freebsd32/freebsd32_proto.h>
451 typedef union modspecific32 {
458 struct module_stat32 {
460 char name[MAXMODNAME];
463 modspecific32_t data;
467 freebsd32_modstat(struct thread *td, struct freebsd32_modstat_args *uap)
470 modspecific32_t data32;
472 int id, namelen, refs, version;
473 struct module_stat32 *stat32;
477 mod = module_lookupbyid(uap->modid);
486 CP(mod->data, data32, intval);
487 CP(mod->data, data32, uintval);
488 CP(mod->data, data32, longval);
489 CP(mod->data, data32, ulongval);
493 if ((error = copyin(&stat32->version, &version, sizeof(version))) != 0)
495 if (version != sizeof(struct module_stat_v1)
496 && version != sizeof(struct module_stat32))
498 namelen = strlen(mod->name) + 1;
499 if (namelen > MAXMODNAME)
500 namelen = MAXMODNAME;
501 if ((error = copyout(name, &stat32->name[0], namelen)) != 0)
504 if ((error = copyout(&refs, &stat32->refs, sizeof(int))) != 0)
506 if ((error = copyout(&id, &stat32->id, sizeof(int))) != 0)
510 * >v1 stat includes module data.
512 if (version == sizeof(struct module_stat32))
513 if ((error = copyout(&data32, &stat32->data,
514 sizeof(data32))) != 0)
516 td->td_retval[0] = 0;