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)
103 TAILQ_FOREACH(mod, &modules, link)
104 MOD_EVENT(mod, MOD_SHUTDOWN);
109 module_register_init(const void *arg)
111 const moduledata_t *data = (const moduledata_t *)arg;
116 mod = module_lookupbyname(data->name);
118 panic("module_register_init: module named %s not found\n",
121 error = MOD_EVENT(mod, MOD_LOAD);
123 MOD_EVENT(mod, MOD_UNLOAD);
127 printf("module_register_init: MOD_LOAD (%s, %p, %p) error"
128 " %d\n", data->name, (void *)data->evhand, data->priv,
134 module_register(const moduledata_t *data, linker_file_t container)
140 newmod = module_lookupbyname(data->name);
141 if (newmod != NULL) {
143 printf("module_register: module %s already exists!\n",
148 namelen = strlen(data->name) + 1;
149 newmod = malloc(sizeof(struct module) + namelen, M_MODULE, M_WAITOK);
154 newmod->id = nextid++;
155 newmod->name = (char *)(newmod + 1);
156 strcpy(newmod->name, data->name);
157 newmod->handler = data->evhand ? data->evhand : modevent_nop;
158 newmod->arg = data->priv;
159 bzero(&newmod->data, sizeof(newmod->data));
160 TAILQ_INSERT_TAIL(&modules, newmod, link);
163 TAILQ_INSERT_TAIL(&container->modules, newmod, flink);
164 newmod->file = container;
170 module_reference(module_t mod)
175 MOD_DPF(REFS, ("module_reference: before, refs=%d\n", mod->refs));
180 module_release(module_t mod)
186 panic("module_release: bad reference count");
188 MOD_DPF(REFS, ("module_release: before, refs=%d\n", mod->refs));
191 if (mod->refs == 0) {
192 TAILQ_REMOVE(&modules, mod, link);
194 TAILQ_REMOVE(&mod->file->modules, mod, flink);
202 module_lookupbyname(const char *name)
209 TAILQ_FOREACH(mod, &modules, link) {
210 err = strcmp(mod->name, name);
218 module_lookupbyid(int modid)
224 TAILQ_FOREACH(mod, &modules, link)
225 if (mod->id == modid)
231 module_unload(module_t mod, int flags)
235 error = MOD_EVENT(mod, MOD_QUIESCE);
236 if (error == EOPNOTSUPP || error == EINVAL)
238 if (flags == LINKER_UNLOAD_NORMAL && error != 0)
240 return (MOD_EVENT(mod, MOD_UNLOAD));
244 module_getid(module_t mod)
252 module_getfnext(module_t mod)
256 return (TAILQ_NEXT(mod, flink));
260 module_setspecific(module_t mod, modspecific_t *datap)
274 modnext(struct thread *td, struct modnext_args *uap)
279 td->td_retval[0] = -1;
282 if (uap->modid == 0) {
283 mod = TAILQ_FIRST(&modules);
285 td->td_retval[0] = mod->id;
290 mod = module_lookupbyid(uap->modid);
295 if (TAILQ_NEXT(mod, link))
296 td->td_retval[0] = TAILQ_NEXT(mod, link)->id;
298 td->td_retval[0] = 0;
308 modfnext(struct thread *td, struct modfnext_args *uap)
313 td->td_retval[0] = -1;
316 mod = module_lookupbyid(uap->modid);
321 if (TAILQ_NEXT(mod, flink))
322 td->td_retval[0] = TAILQ_NEXT(mod, flink)->id;
324 td->td_retval[0] = 0;
330 struct module_stat_v1 {
331 int version; /* set to sizeof(struct module_stat) */
332 char name[MAXMODNAME];
341 modstat(struct thread *td, struct modstat_args *uap)
346 int id, namelen, refs, version;
347 struct module_stat *stat;
351 mod = module_lookupbyid(uap->modid);
364 * Check the version of the user's structure.
366 if ((error = copyin(&stat->version, &version, sizeof(version))) != 0)
368 if (version != sizeof(struct module_stat_v1)
369 && version != sizeof(struct module_stat))
371 namelen = strlen(mod->name) + 1;
372 if (namelen > MAXMODNAME)
373 namelen = MAXMODNAME;
374 if ((error = copyout(name, &stat->name[0], namelen)) != 0)
377 if ((error = copyout(&refs, &stat->refs, sizeof(int))) != 0)
379 if ((error = copyout(&id, &stat->id, sizeof(int))) != 0)
383 * >v1 stat includes module data.
385 if (version == sizeof(struct module_stat))
386 if ((error = copyout(&data, &stat->data,
389 td->td_retval[0] = 0;
397 modfind(struct thread *td, struct modfind_args *uap)
400 char name[MAXMODNAME];
403 if ((error = copyinstr(uap->name, name, sizeof name, 0)) != 0)
407 mod = module_lookupbyname(name);
411 td->td_retval[0] = module_getid(mod);
417 #include <sys/mount.h>
418 #include <compat/freebsd32/freebsd32_util.h>
419 #include <compat/freebsd32/freebsd32.h>
420 #include <compat/freebsd32/freebsd32_proto.h>
422 typedef union modspecific32 {
429 struct module_stat32 {
431 char name[MAXMODNAME];
434 modspecific32_t data;
441 freebsd32_modstat(struct thread *td, struct freebsd32_modstat_args *uap)
444 modspecific32_t data32;
446 int id, namelen, refs, version;
447 struct module_stat32 *stat32;
451 mod = module_lookupbyid(uap->modid);
460 CP(mod->data, data32, intval);
461 CP(mod->data, data32, uintval);
462 CP(mod->data, data32, longval);
463 CP(mod->data, data32, ulongval);
467 if ((error = copyin(&stat32->version, &version, sizeof(version))) != 0)
469 if (version != sizeof(struct module_stat_v1)
470 && version != sizeof(struct module_stat32))
472 namelen = strlen(mod->name) + 1;
473 if (namelen > MAXMODNAME)
474 namelen = MAXMODNAME;
475 if ((error = copyout(name, &stat32->name[0], namelen)) != 0)
478 if ((error = copyout(&refs, &stat32->refs, sizeof(int))) != 0)
480 if ((error = copyout(&id, &stat32->id, sizeof(int))) != 0)
484 * >v1 stat includes module data.
486 if (version == sizeof(struct module_stat32))
487 if ((error = copyout(&data32, &stat32->data,
488 sizeof(data32))) != 0)
490 td->td_retval[0] = 0;