kern_module.c revision 1.32 1 1.32 christos /* $NetBSD: kern_module.c,v 1.32 2008/11/27 21:36:51 christos Exp $ */
2 1.1 ad
3 1.1 ad /*-
4 1.1 ad * Copyright (c) 2008 The NetBSD Foundation, Inc.
5 1.1 ad * All rights reserved.
6 1.1 ad *
7 1.25 ad * This code is derived from software developed for The NetBSD Foundation
8 1.25 ad * by Andrew Doran.
9 1.25 ad *
10 1.1 ad * Redistribution and use in source and binary forms, with or without
11 1.1 ad * modification, are permitted provided that the following conditions
12 1.1 ad * are met:
13 1.1 ad * 1. Redistributions of source code must retain the above copyright
14 1.1 ad * notice, this list of conditions and the following disclaimer.
15 1.1 ad * 2. Redistributions in binary form must reproduce the above copyright
16 1.1 ad * notice, this list of conditions and the following disclaimer in the
17 1.1 ad * documentation and/or other materials provided with the distribution.
18 1.1 ad *
19 1.1 ad * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.1 ad * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.1 ad * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.1 ad * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.1 ad * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.1 ad * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.1 ad * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.1 ad * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.1 ad * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.1 ad * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.1 ad * POSSIBILITY OF SUCH DAMAGE.
30 1.1 ad */
31 1.1 ad
32 1.1 ad /*
33 1.2 ad * Kernel module support.
34 1.1 ad */
35 1.1 ad
36 1.1 ad #include <sys/cdefs.h>
37 1.32 christos __KERNEL_RCSID(0, "$NetBSD: kern_module.c,v 1.32 2008/11/27 21:36:51 christos Exp $");
38 1.30 ad
39 1.30 ad #ifdef _KERNEL_OPT
40 1.30 ad #include "opt_ddb.h"
41 1.30 ad #endif
42 1.1 ad
43 1.1 ad #include <sys/param.h>
44 1.1 ad #include <sys/systm.h>
45 1.26 ad #include <sys/kernel.h>
46 1.1 ad #include <sys/fcntl.h>
47 1.1 ad #include <sys/proc.h>
48 1.1 ad #include <sys/kauth.h>
49 1.1 ad #include <sys/kobj.h>
50 1.1 ad #include <sys/kmem.h>
51 1.1 ad #include <sys/module.h>
52 1.18 ad #include <sys/kauth.h>
53 1.26 ad #include <sys/kthread.h>
54 1.1 ad
55 1.1 ad #include <uvm/uvm_extern.h>
56 1.1 ad
57 1.1 ad #include <machine/stdarg.h>
58 1.1 ad
59 1.25 ad struct vm_map *module_map;
60 1.2 ad
61 1.1 ad struct modlist module_list = TAILQ_HEAD_INITIALIZER(module_list);
62 1.1 ad struct modlist module_bootlist = TAILQ_HEAD_INITIALIZER(module_bootlist);
63 1.12 ad static module_t *module_active;
64 1.16 ad static char module_base[64];
65 1.1 ad u_int module_count;
66 1.1 ad kmutex_t module_lock;
67 1.26 ad u_int module_autotime = 10;
68 1.26 ad u_int module_gen = 1;
69 1.26 ad static kcondvar_t module_thread_cv;
70 1.26 ad static kmutex_t module_thread_lock;
71 1.26 ad static int module_thread_ticks;
72 1.1 ad
73 1.1 ad /* Ensure that the kernel's link set isn't empty. */
74 1.1 ad static modinfo_t module_dummy;
75 1.1 ad __link_set_add_rodata(modules, module_dummy);
76 1.1 ad
77 1.1 ad static module_t *module_lookup(const char *);
78 1.9 jmmv static int module_do_load(const char *, bool, int, prop_dictionary_t,
79 1.20 ad module_t **, modclass_t class, bool);
80 1.1 ad static int module_do_unload(const char *);
81 1.1 ad static void module_error(const char *, ...);
82 1.1 ad static int module_do_builtin(const char *, module_t **);
83 1.11 ad static int module_fetch_info(module_t *);
84 1.26 ad static void module_thread(void *);
85 1.1 ad
86 1.1 ad /*
87 1.1 ad * module_error:
88 1.1 ad *
89 1.1 ad * Utility function: log an error.
90 1.1 ad */
91 1.1 ad static void
92 1.1 ad module_error(const char *fmt, ...)
93 1.1 ad {
94 1.1 ad va_list ap;
95 1.1 ad
96 1.1 ad va_start(ap, fmt);
97 1.1 ad printf("WARNING: module error: ");
98 1.1 ad vprintf(fmt, ap);
99 1.1 ad printf("\n");
100 1.1 ad va_end(ap);
101 1.1 ad }
102 1.1 ad
103 1.1 ad /*
104 1.1 ad * module_init:
105 1.1 ad *
106 1.1 ad * Initialize the module subsystem.
107 1.1 ad */
108 1.1 ad void
109 1.1 ad module_init(void)
110 1.1 ad {
111 1.25 ad extern struct vm_map *module_map;
112 1.26 ad int error;
113 1.1 ad
114 1.25 ad if (module_map == NULL) {
115 1.25 ad module_map = kernel_map;
116 1.25 ad }
117 1.1 ad mutex_init(&module_lock, MUTEX_DEFAULT, IPL_NONE);
118 1.26 ad cv_init(&module_thread_cv, "modunload");
119 1.26 ad mutex_init(&module_thread_lock, MUTEX_DEFAULT, IPL_NONE);
120 1.13 ad #ifdef MODULAR /* XXX */
121 1.11 ad module_init_md();
122 1.12 ad #endif
123 1.16 ad
124 1.16 ad #if __NetBSD_Version__ / 1000000 % 100 == 99 /* -current */
125 1.17 ad snprintf(module_base, sizeof(module_base), "/stand/%s/%s/modules",
126 1.17 ad machine, osrelease);
127 1.16 ad #else /* release */
128 1.17 ad snprintf(module_base, sizeof(module_base), "/stand/%s/%d.%d/modules",
129 1.17 ad machine, __NetBSD_Version__ / 100000000,
130 1.16 ad __NetBSD_Version__ / 1000000 % 100);
131 1.16 ad #endif
132 1.26 ad
133 1.26 ad error = kthread_create(PRI_VM, KTHREAD_MPSAFE, NULL, module_thread,
134 1.26 ad NULL, NULL, "modunload");
135 1.26 ad if (error != 0)
136 1.26 ad panic("module_init: %d", error);
137 1.1 ad }
138 1.1 ad
139 1.1 ad /*
140 1.1 ad * module_init_class:
141 1.1 ad *
142 1.1 ad * Initialize all built-in and pre-loaded modules of the
143 1.1 ad * specified class.
144 1.1 ad */
145 1.1 ad void
146 1.1 ad module_init_class(modclass_t class)
147 1.1 ad {
148 1.1 ad __link_set_decl(modules, modinfo_t);
149 1.1 ad modinfo_t *const *mip, *mi;
150 1.1 ad module_t *mod;
151 1.1 ad
152 1.1 ad mutex_enter(&module_lock);
153 1.1 ad /*
154 1.1 ad * Builtins first. These can't depend on pre-loaded modules.
155 1.1 ad */
156 1.1 ad __link_set_foreach(mip, modules) {
157 1.1 ad mi = *mip;
158 1.1 ad if (mi == &module_dummy) {
159 1.1 ad continue;
160 1.1 ad }
161 1.1 ad if (class != MODULE_CLASS_ANY && class != mi->mi_class) {
162 1.1 ad continue;
163 1.1 ad }
164 1.1 ad (void)module_do_builtin(mi->mi_name, NULL);
165 1.1 ad }
166 1.1 ad /*
167 1.1 ad * Now preloaded modules. These will be pulled off the
168 1.1 ad * list as we call module_do_load();
169 1.1 ad */
170 1.11 ad do {
171 1.11 ad TAILQ_FOREACH(mod, &module_bootlist, mod_chain) {
172 1.11 ad mi = mod->mod_info;
173 1.11 ad if (class != MODULE_CLASS_ANY &&
174 1.11 ad class != mi->mi_class)
175 1.11 ad continue;
176 1.18 ad module_do_load(mi->mi_name, false, 0, NULL, NULL,
177 1.20 ad class, true);
178 1.11 ad break;
179 1.11 ad }
180 1.11 ad } while (mod != NULL);
181 1.1 ad mutex_exit(&module_lock);
182 1.1 ad }
183 1.1 ad
184 1.1 ad /*
185 1.21 ad * module_compatible:
186 1.1 ad *
187 1.21 ad * Return true if the two supplied kernel versions are said to
188 1.21 ad * have the same binary interface for kernel code. The entire
189 1.21 ad * version is signficant for the development tree (-current),
190 1.21 ad * major and minor versions are significant for official
191 1.21 ad * releases of the system.
192 1.1 ad */
193 1.22 pooka bool
194 1.21 ad module_compatible(int v1, int v2)
195 1.1 ad {
196 1.1 ad
197 1.21 ad #if __NetBSD_Version__ / 1000000 % 100 == 99 /* -current */
198 1.21 ad return v1 == v2;
199 1.21 ad #else /* release */
200 1.21 ad return abs(v1 - v2) < 10000;
201 1.21 ad #endif
202 1.1 ad }
203 1.1 ad
204 1.1 ad /*
205 1.1 ad * module_load:
206 1.1 ad *
207 1.9 jmmv * Load a single module from the file system.
208 1.1 ad */
209 1.1 ad int
210 1.18 ad module_load(const char *filename, int flags, prop_dictionary_t props,
211 1.23 ad modclass_t class)
212 1.1 ad {
213 1.1 ad int error;
214 1.1 ad
215 1.18 ad /* Authorize. */
216 1.18 ad error = kauth_authorize_system(kauth_cred_get(), KAUTH_SYSTEM_MODULE,
217 1.18 ad 0, (void *)(uintptr_t)MODCTL_LOAD, NULL, NULL);
218 1.18 ad if (error != 0) {
219 1.18 ad return error;
220 1.18 ad }
221 1.18 ad
222 1.1 ad mutex_enter(&module_lock);
223 1.20 ad error = module_do_load(filename, false, flags, props, NULL, class,
224 1.23 ad false);
225 1.1 ad mutex_exit(&module_lock);
226 1.1 ad
227 1.1 ad return error;
228 1.1 ad }
229 1.1 ad
230 1.1 ad /*
231 1.23 ad * module_autoload:
232 1.23 ad *
233 1.23 ad * Load a single module from the file system, system initiated.
234 1.23 ad */
235 1.23 ad int
236 1.23 ad module_autoload(const char *filename, modclass_t class)
237 1.23 ad {
238 1.23 ad int error;
239 1.23 ad
240 1.23 ad KASSERT(mutex_owned(&module_lock));
241 1.23 ad
242 1.29 ad /* Disallow path seperators and magic symlinks. */
243 1.29 ad if (strchr(filename, '/') != NULL || strchr(filename, '@') != NULL ||
244 1.29 ad strchr(filename, '.') != NULL) {
245 1.29 ad return EPERM;
246 1.29 ad }
247 1.29 ad
248 1.23 ad /* Authorize. */
249 1.23 ad error = kauth_authorize_system(kauth_cred_get(), KAUTH_SYSTEM_MODULE,
250 1.23 ad 0, (void *)(uintptr_t)MODCTL_LOAD, (void *)(uintptr_t)1, NULL);
251 1.23 ad if (error != 0) {
252 1.23 ad return error;
253 1.23 ad }
254 1.23 ad
255 1.23 ad return module_do_load(filename, false, 0, NULL, NULL, class, true);
256 1.23 ad }
257 1.23 ad
258 1.23 ad /*
259 1.1 ad * module_unload:
260 1.1 ad *
261 1.1 ad * Find and unload a module by name.
262 1.1 ad */
263 1.1 ad int
264 1.1 ad module_unload(const char *name)
265 1.1 ad {
266 1.1 ad int error;
267 1.1 ad
268 1.18 ad /* Authorize. */
269 1.18 ad error = kauth_authorize_system(kauth_cred_get(), KAUTH_SYSTEM_MODULE,
270 1.18 ad 0, (void *)(uintptr_t)MODCTL_UNLOAD, NULL, NULL);
271 1.18 ad if (error != 0) {
272 1.18 ad return error;
273 1.18 ad }
274 1.18 ad
275 1.1 ad mutex_enter(&module_lock);
276 1.1 ad error = module_do_unload(name);
277 1.1 ad mutex_exit(&module_lock);
278 1.1 ad
279 1.1 ad return error;
280 1.1 ad }
281 1.1 ad
282 1.1 ad /*
283 1.1 ad * module_lookup:
284 1.1 ad *
285 1.1 ad * Look up a module by name.
286 1.1 ad */
287 1.1 ad module_t *
288 1.1 ad module_lookup(const char *name)
289 1.1 ad {
290 1.1 ad module_t *mod;
291 1.1 ad
292 1.1 ad KASSERT(mutex_owned(&module_lock));
293 1.1 ad
294 1.1 ad TAILQ_FOREACH(mod, &module_list, mod_chain) {
295 1.1 ad if (strcmp(mod->mod_info->mi_name, name) == 0) {
296 1.1 ad break;
297 1.1 ad }
298 1.1 ad }
299 1.1 ad
300 1.1 ad return mod;
301 1.1 ad }
302 1.1 ad
303 1.1 ad /*
304 1.1 ad * module_hold:
305 1.1 ad *
306 1.1 ad * Add a single reference to a module. It's the caller's
307 1.1 ad * responsibility to ensure that the reference is dropped
308 1.1 ad * later.
309 1.1 ad */
310 1.1 ad int
311 1.1 ad module_hold(const char *name)
312 1.1 ad {
313 1.1 ad module_t *mod;
314 1.1 ad
315 1.1 ad mutex_enter(&module_lock);
316 1.1 ad mod = module_lookup(name);
317 1.1 ad if (mod == NULL) {
318 1.1 ad mutex_exit(&module_lock);
319 1.1 ad return ENOENT;
320 1.1 ad }
321 1.1 ad mod->mod_refcnt++;
322 1.1 ad mutex_exit(&module_lock);
323 1.1 ad
324 1.1 ad return 0;
325 1.1 ad }
326 1.1 ad
327 1.1 ad /*
328 1.1 ad * module_rele:
329 1.1 ad *
330 1.1 ad * Release a reference acquired with module_hold().
331 1.1 ad */
332 1.1 ad void
333 1.1 ad module_rele(const char *name)
334 1.1 ad {
335 1.1 ad module_t *mod;
336 1.1 ad
337 1.1 ad mutex_enter(&module_lock);
338 1.1 ad mod = module_lookup(name);
339 1.1 ad if (mod == NULL) {
340 1.1 ad mutex_exit(&module_lock);
341 1.1 ad panic("module_rele: gone");
342 1.1 ad }
343 1.1 ad mod->mod_refcnt--;
344 1.1 ad mutex_exit(&module_lock);
345 1.1 ad }
346 1.1 ad
347 1.1 ad /*
348 1.27 ad * module_enqueue:
349 1.27 ad *
350 1.27 ad * Put a module onto the global list and update counters.
351 1.27 ad */
352 1.27 ad static void
353 1.27 ad module_enqueue(module_t *mod)
354 1.27 ad {
355 1.27 ad int i;
356 1.27 ad
357 1.27 ad /*
358 1.27 ad * If there are requisite modules, put at the head of the queue.
359 1.27 ad * This is so that autounload can unload requisite modules with
360 1.27 ad * only one pass through the queue.
361 1.27 ad */
362 1.27 ad if (mod->mod_nrequired) {
363 1.27 ad TAILQ_INSERT_HEAD(&module_list, mod, mod_chain);
364 1.27 ad
365 1.27 ad /* Add references to the requisite modules. */
366 1.27 ad for (i = 0; i < mod->mod_nrequired; i++) {
367 1.27 ad KASSERT(mod->mod_required[i] != NULL);
368 1.27 ad mod->mod_required[i]->mod_refcnt++;
369 1.27 ad }
370 1.27 ad } else {
371 1.27 ad TAILQ_INSERT_TAIL(&module_list, mod, mod_chain);
372 1.27 ad }
373 1.27 ad module_count++;
374 1.27 ad module_gen++;
375 1.27 ad }
376 1.27 ad
377 1.27 ad /*
378 1.1 ad * module_do_builtin:
379 1.1 ad *
380 1.1 ad * Initialize a single module from the list of modules that are
381 1.1 ad * built into the kernel (linked into the kernel image).
382 1.1 ad */
383 1.1 ad static int
384 1.1 ad module_do_builtin(const char *name, module_t **modp)
385 1.1 ad {
386 1.1 ad __link_set_decl(modules, modinfo_t);
387 1.1 ad modinfo_t *const *mip;
388 1.1 ad const char *p, *s;
389 1.1 ad char buf[MAXMODNAME];
390 1.1 ad modinfo_t *mi;
391 1.1 ad module_t *mod, *mod2;
392 1.1 ad size_t len;
393 1.27 ad int error;
394 1.1 ad
395 1.1 ad KASSERT(mutex_owned(&module_lock));
396 1.1 ad
397 1.1 ad /*
398 1.1 ad * Check to see if already loaded.
399 1.1 ad */
400 1.1 ad if ((mod = module_lookup(name)) != NULL) {
401 1.1 ad if (modp != NULL) {
402 1.1 ad *modp = mod;
403 1.1 ad }
404 1.1 ad return 0;
405 1.1 ad }
406 1.1 ad
407 1.1 ad /*
408 1.1 ad * Search the list to see if we have a module by this name.
409 1.1 ad */
410 1.1 ad error = ENOENT;
411 1.1 ad __link_set_foreach(mip, modules) {
412 1.1 ad mi = *mip;
413 1.1 ad if (mi == &module_dummy) {
414 1.1 ad continue;
415 1.1 ad }
416 1.1 ad if (strcmp(mi->mi_name, name) == 0) {
417 1.1 ad error = 0;
418 1.1 ad break;
419 1.1 ad }
420 1.1 ad }
421 1.1 ad if (error != 0) {
422 1.1 ad return error;
423 1.1 ad }
424 1.1 ad
425 1.1 ad /*
426 1.1 ad * Initialize pre-requisites.
427 1.1 ad */
428 1.1 ad mod = kmem_zalloc(sizeof(*mod), KM_SLEEP);
429 1.1 ad if (mod == NULL) {
430 1.1 ad return ENOMEM;
431 1.1 ad }
432 1.1 ad if (modp != NULL) {
433 1.1 ad *modp = mod;
434 1.1 ad }
435 1.1 ad if (mi->mi_required != NULL) {
436 1.1 ad for (s = mi->mi_required; *s != '\0'; s = p) {
437 1.1 ad if (*s == ',')
438 1.1 ad s++;
439 1.1 ad p = s;
440 1.1 ad while (*p != '\0' && *p != ',')
441 1.1 ad p++;
442 1.1 ad len = min(p - s + 1, sizeof(buf));
443 1.1 ad strlcpy(buf, s, len);
444 1.1 ad if (buf[0] == '\0')
445 1.1 ad break;
446 1.1 ad if (mod->mod_nrequired == MAXMODDEPS - 1) {
447 1.1 ad module_error("too many required modules");
448 1.1 ad kmem_free(mod, sizeof(*mod));
449 1.1 ad return EINVAL;
450 1.1 ad }
451 1.1 ad error = module_do_builtin(buf, &mod2);
452 1.1 ad if (error != 0) {
453 1.1 ad kmem_free(mod, sizeof(*mod));
454 1.1 ad return error;
455 1.1 ad }
456 1.1 ad mod->mod_required[mod->mod_nrequired++] = mod2;
457 1.1 ad }
458 1.1 ad }
459 1.1 ad
460 1.1 ad /*
461 1.1 ad * Try to initialize the module.
462 1.1 ad */
463 1.12 ad KASSERT(module_active == NULL);
464 1.12 ad module_active = mod;
465 1.1 ad error = (*mi->mi_modcmd)(MODULE_CMD_INIT, NULL);
466 1.12 ad module_active = NULL;
467 1.1 ad if (error != 0) {
468 1.1 ad module_error("builtin module `%s' "
469 1.1 ad "failed to init", mi->mi_name);
470 1.1 ad kmem_free(mod, sizeof(*mod));
471 1.1 ad return error;
472 1.1 ad }
473 1.1 ad mod->mod_info = mi;
474 1.1 ad mod->mod_source = MODULE_SOURCE_KERNEL;
475 1.27 ad module_enqueue(mod);
476 1.1 ad return 0;
477 1.1 ad }
478 1.1 ad
479 1.1 ad /*
480 1.1 ad * module_do_load:
481 1.1 ad *
482 1.1 ad * Helper routine: load a module from the file system, or one
483 1.1 ad * pushed by the boot loader.
484 1.1 ad */
485 1.1 ad static int
486 1.27 ad module_do_load(const char *name, bool isdep, int flags,
487 1.20 ad prop_dictionary_t props, module_t **modp, modclass_t class,
488 1.20 ad bool autoload)
489 1.1 ad {
490 1.1 ad static TAILQ_HEAD(,module) pending = TAILQ_HEAD_INITIALIZER(pending);
491 1.1 ad static int depth;
492 1.1 ad const int maxdepth = 6;
493 1.1 ad modinfo_t *mi;
494 1.1 ad module_t *mod, *mod2;
495 1.1 ad char buf[MAXMODNAME];
496 1.1 ad const char *s, *p;
497 1.1 ad int error;
498 1.1 ad size_t len;
499 1.1 ad
500 1.1 ad KASSERT(mutex_owned(&module_lock));
501 1.1 ad
502 1.1 ad error = 0;
503 1.1 ad
504 1.1 ad /*
505 1.1 ad * Avoid recursing too far.
506 1.1 ad */
507 1.1 ad if (++depth > maxdepth) {
508 1.1 ad module_error("too many required modules");
509 1.1 ad depth--;
510 1.1 ad return EMLINK;
511 1.1 ad }
512 1.1 ad
513 1.1 ad /*
514 1.1 ad * Load the module and link. Before going to the file system,
515 1.1 ad * scan the list of modules loaded by the boot loader. Just
516 1.1 ad * before init is started the list of modules loaded at boot
517 1.1 ad * will be purged. Before init is started we can assume that
518 1.27 ad * `name' is a module name and not a path name.
519 1.1 ad */
520 1.1 ad TAILQ_FOREACH(mod, &module_bootlist, mod_chain) {
521 1.27 ad if (strcmp(mod->mod_info->mi_name, name) == 0) {
522 1.1 ad TAILQ_REMOVE(&module_bootlist, mod, mod_chain);
523 1.1 ad break;
524 1.1 ad }
525 1.1 ad }
526 1.14 rumble if (mod != NULL) {
527 1.14 rumble TAILQ_INSERT_TAIL(&pending, mod, mod_chain);
528 1.14 rumble } else {
529 1.27 ad /*
530 1.27 ad * If a requisite module, check to see if it is
531 1.27 ad * already present.
532 1.27 ad */
533 1.27 ad if (isdep) {
534 1.27 ad TAILQ_FOREACH(mod, &module_list, mod_chain) {
535 1.27 ad if (strcmp(mod->mod_info->mi_name, name) == 0) {
536 1.27 ad break;
537 1.27 ad }
538 1.27 ad }
539 1.27 ad if (mod != NULL) {
540 1.27 ad if (modp != NULL) {
541 1.27 ad *modp = mod;
542 1.27 ad }
543 1.27 ad depth--;
544 1.27 ad return 0;
545 1.27 ad }
546 1.27 ad }
547 1.1 ad mod = kmem_zalloc(sizeof(*mod), KM_SLEEP);
548 1.1 ad if (mod == NULL) {
549 1.1 ad depth--;
550 1.1 ad return ENOMEM;
551 1.1 ad }
552 1.27 ad error = kobj_load_file(&mod->mod_kobj, name, module_base,
553 1.20 ad autoload);
554 1.1 ad if (error != 0) {
555 1.1 ad kmem_free(mod, sizeof(*mod));
556 1.1 ad depth--;
557 1.32 christos #ifndef DIAGNOSTIC
558 1.32 christos if (!autoload)
559 1.32 christos #endif
560 1.32 christos module_error("Cannot load kernel object `%s'"
561 1.32 christos " error=%d", name), error;
562 1.8 rumble return error;
563 1.7 rumble }
564 1.14 rumble TAILQ_INSERT_TAIL(&pending, mod, mod_chain);
565 1.1 ad mod->mod_source = MODULE_SOURCE_FILESYS;
566 1.11 ad error = module_fetch_info(mod);
567 1.11 ad if (error != 0) {
568 1.32 christos module_error("cannot fetch module info for `%s'", name);
569 1.11 ad goto fail;
570 1.11 ad }
571 1.1 ad }
572 1.1 ad
573 1.1 ad /*
574 1.11 ad * Check compatibility.
575 1.1 ad */
576 1.1 ad mi = mod->mod_info;
577 1.3 rumble if (strlen(mi->mi_name) >= MAXMODNAME) {
578 1.3 rumble error = EINVAL;
579 1.32 christos module_error("module name `%s' too long", mi->mi_name);
580 1.3 rumble goto fail;
581 1.3 rumble }
582 1.21 ad if (!module_compatible(mi->mi_version, __NetBSD_Version__)) {
583 1.32 christos module_error("module built for `%s', system `%s'",
584 1.32 christos mi->mi_version, __NetBSD_Version__);
585 1.24 ad if ((flags & MODCTL_LOAD_FORCE) != 0) {
586 1.24 ad module_error("forced load, system may be unstable");
587 1.24 ad } else {
588 1.24 ad error = EPROGMISMATCH;
589 1.24 ad goto fail;
590 1.24 ad }
591 1.21 ad }
592 1.3 rumble
593 1.1 ad /*
594 1.18 ad * If a specific kind of module was requested, ensure that we have
595 1.18 ad * a match.
596 1.18 ad */
597 1.18 ad if (class != MODULE_CLASS_ANY && class != mi->mi_class) {
598 1.32 christos #ifdef DIAGNOSTIC
599 1.32 christos module_error("incompatible module class for `%s' (%d != %d)",
600 1.32 christos name, class, mi->mi_class);
601 1.32 christos #endif
602 1.18 ad error = ENOENT;
603 1.18 ad goto fail;
604 1.18 ad }
605 1.18 ad
606 1.18 ad /*
607 1.27 ad * If loading a dependency, `name' is a plain module name.
608 1.1 ad * The name must match.
609 1.1 ad */
610 1.27 ad if (isdep && strcmp(mi->mi_name, name) != 0) {
611 1.32 christos #ifdef DIAGNOSTIC
612 1.32 christos module_error("dependency name mismatch (`%s' != `%s')",
613 1.32 christos name, mi->mi_name);
614 1.32 christos #endif
615 1.1 ad error = ENOENT;
616 1.1 ad goto fail;
617 1.1 ad }
618 1.1 ad
619 1.1 ad /*
620 1.3 rumble * Check to see if the module is already loaded. If so, we may
621 1.3 rumble * have been recursively called to handle a dependency, so be sure
622 1.3 rumble * to set modp.
623 1.1 ad */
624 1.3 rumble if ((mod2 = module_lookup(mi->mi_name)) != NULL) {
625 1.5 rumble if (modp != NULL)
626 1.5 rumble *modp = mod2;
627 1.32 christos #ifdef DIAGNOSTIC
628 1.32 christos module_error("module `%s' already loaded", mi->mi_name);
629 1.32 christos #endif
630 1.1 ad error = EEXIST;
631 1.1 ad goto fail;
632 1.1 ad }
633 1.3 rumble
634 1.3 rumble /*
635 1.3 rumble * Block circular dependencies.
636 1.3 rumble */
637 1.1 ad TAILQ_FOREACH(mod2, &pending, mod_chain) {
638 1.1 ad if (mod == mod2) {
639 1.1 ad continue;
640 1.1 ad }
641 1.1 ad if (strcmp(mod2->mod_info->mi_name, mi->mi_name) == 0) {
642 1.1 ad error = EDEADLK;
643 1.32 christos module_error("circular dependency detected for `%s'",
644 1.32 christos mi->mi_name);
645 1.1 ad goto fail;
646 1.1 ad }
647 1.1 ad }
648 1.1 ad
649 1.1 ad /*
650 1.1 ad * Now try to load any requisite modules.
651 1.1 ad */
652 1.1 ad if (mi->mi_required != NULL) {
653 1.1 ad for (s = mi->mi_required; *s != '\0'; s = p) {
654 1.1 ad if (*s == ',')
655 1.1 ad s++;
656 1.1 ad p = s;
657 1.1 ad while (*p != '\0' && *p != ',')
658 1.1 ad p++;
659 1.3 rumble len = p - s + 1;
660 1.3 rumble if (len >= MAXMODNAME) {
661 1.3 rumble error = EINVAL;
662 1.32 christos module_error("required module name `%s'"
663 1.32 christos " too long", mi->mi_required);
664 1.3 rumble goto fail;
665 1.3 rumble }
666 1.1 ad strlcpy(buf, s, len);
667 1.1 ad if (buf[0] == '\0')
668 1.1 ad break;
669 1.1 ad if (mod->mod_nrequired == MAXMODDEPS - 1) {
670 1.1 ad error = EINVAL;
671 1.32 christos module_error("too many required modules (%d)",
672 1.32 christos mod->mod_nrequired);
673 1.1 ad goto fail;
674 1.1 ad }
675 1.6 rumble if (strcmp(buf, mi->mi_name) == 0) {
676 1.6 rumble error = EDEADLK;
677 1.32 christos module_error("self-dependency detected for "
678 1.32 christos "`%s'", mi->mi_name);
679 1.6 rumble goto fail;
680 1.6 rumble }
681 1.9 jmmv error = module_do_load(buf, true, flags, NULL,
682 1.18 ad &mod->mod_required[mod->mod_nrequired++],
683 1.20 ad MODULE_CLASS_ANY, true);
684 1.27 ad if (error != 0)
685 1.1 ad goto fail;
686 1.1 ad }
687 1.1 ad }
688 1.1 ad
689 1.1 ad /*
690 1.15 ad * We loaded all needed modules successfully: perform global
691 1.15 ad * relocations and initialize.
692 1.1 ad */
693 1.15 ad error = kobj_affix(mod->mod_kobj, mi->mi_name);
694 1.15 ad if (error != 0) {
695 1.32 christos module_error("unable to affix module `%s'", mi->mi_name);
696 1.15 ad goto fail2;
697 1.15 ad }
698 1.15 ad
699 1.12 ad KASSERT(module_active == NULL);
700 1.12 ad module_active = mod;
701 1.9 jmmv error = (*mi->mi_modcmd)(MODULE_CMD_INIT, props);
702 1.12 ad module_active = NULL;
703 1.1 ad if (error != 0) {
704 1.32 christos module_error("modcmd function returned error %d for `%s'",
705 1.32 christos error, mi->mi_name);
706 1.1 ad goto fail;
707 1.1 ad }
708 1.1 ad
709 1.1 ad /*
710 1.1 ad * Good, the module loaded successfully. Put it onto the
711 1.1 ad * list and add references to its requisite modules.
712 1.1 ad */
713 1.1 ad TAILQ_REMOVE(&pending, mod, mod_chain);
714 1.27 ad module_enqueue(mod);
715 1.1 ad if (modp != NULL) {
716 1.1 ad *modp = mod;
717 1.1 ad }
718 1.26 ad if (autoload) {
719 1.26 ad /*
720 1.26 ad * Arrange to try unloading the module after
721 1.26 ad * a short delay.
722 1.26 ad */
723 1.26 ad mod->mod_autotime = time_second + module_autotime;
724 1.26 ad module_thread_kick();
725 1.26 ad }
726 1.1 ad depth--;
727 1.1 ad return 0;
728 1.7 rumble
729 1.1 ad fail:
730 1.15 ad kobj_unload(mod->mod_kobj);
731 1.15 ad fail2:
732 1.1 ad TAILQ_REMOVE(&pending, mod, mod_chain);
733 1.1 ad kmem_free(mod, sizeof(*mod));
734 1.1 ad depth--;
735 1.1 ad return error;
736 1.1 ad }
737 1.1 ad
738 1.1 ad /*
739 1.1 ad * module_do_unload:
740 1.1 ad *
741 1.1 ad * Helper routine: do the dirty work of unloading a module.
742 1.1 ad */
743 1.1 ad static int
744 1.1 ad module_do_unload(const char *name)
745 1.1 ad {
746 1.1 ad module_t *mod;
747 1.1 ad int error;
748 1.1 ad u_int i;
749 1.1 ad
750 1.1 ad KASSERT(mutex_owned(&module_lock));
751 1.1 ad
752 1.1 ad mod = module_lookup(name);
753 1.1 ad if (mod == NULL) {
754 1.32 christos #ifdef DIAGNOSTIC
755 1.32 christos module_error("module `%s' not found", name);
756 1.32 christos #endif
757 1.1 ad return ENOENT;
758 1.1 ad }
759 1.1 ad if (mod->mod_refcnt != 0 || mod->mod_source == MODULE_SOURCE_KERNEL) {
760 1.32 christos #ifdef DIAGNOSTIC
761 1.32 christos module_error("module `%s' busy", name);
762 1.32 christos #endif
763 1.1 ad return EBUSY;
764 1.1 ad }
765 1.12 ad KASSERT(module_active == NULL);
766 1.12 ad module_active = mod;
767 1.1 ad error = (*mod->mod_info->mi_modcmd)(MODULE_CMD_FINI, NULL);
768 1.12 ad module_active = NULL;
769 1.1 ad if (error != 0) {
770 1.32 christos #ifdef DIAGNOSTIC
771 1.32 christos module_error("cannot unload module `%s' error=%d", name, error);
772 1.32 christos #endif
773 1.1 ad return error;
774 1.1 ad }
775 1.1 ad module_count--;
776 1.1 ad TAILQ_REMOVE(&module_list, mod, mod_chain);
777 1.1 ad for (i = 0; i < mod->mod_nrequired; i++) {
778 1.1 ad mod->mod_required[i]->mod_refcnt--;
779 1.1 ad }
780 1.1 ad if (mod->mod_kobj != NULL) {
781 1.1 ad kobj_unload(mod->mod_kobj);
782 1.1 ad }
783 1.1 ad kmem_free(mod, sizeof(*mod));
784 1.26 ad module_gen++;
785 1.1 ad
786 1.1 ad return 0;
787 1.1 ad }
788 1.1 ad
789 1.1 ad /*
790 1.1 ad * module_prime:
791 1.1 ad *
792 1.1 ad * Push a module loaded by the bootloader onto our internal
793 1.1 ad * list.
794 1.1 ad */
795 1.1 ad int
796 1.1 ad module_prime(void *base, size_t size)
797 1.1 ad {
798 1.1 ad module_t *mod;
799 1.1 ad int error;
800 1.1 ad
801 1.1 ad mod = kmem_zalloc(sizeof(*mod), KM_SLEEP);
802 1.1 ad if (mod == NULL) {
803 1.1 ad return ENOMEM;
804 1.1 ad }
805 1.1 ad mod->mod_source = MODULE_SOURCE_BOOT;
806 1.1 ad
807 1.15 ad error = kobj_load_mem(&mod->mod_kobj, base, size);
808 1.1 ad if (error != 0) {
809 1.11 ad kmem_free(mod, sizeof(*mod));
810 1.11 ad module_error("unable to load object pushed by boot loader");
811 1.11 ad return error;
812 1.11 ad }
813 1.11 ad error = module_fetch_info(mod);
814 1.11 ad if (error != 0) {
815 1.11 ad kobj_unload(mod->mod_kobj);
816 1.1 ad kmem_free(mod, sizeof(*mod));
817 1.11 ad module_error("unable to load object pushed by boot loader");
818 1.1 ad return error;
819 1.1 ad }
820 1.11 ad
821 1.1 ad TAILQ_INSERT_TAIL(&module_bootlist, mod, mod_chain);
822 1.1 ad
823 1.1 ad return 0;
824 1.1 ad }
825 1.11 ad
826 1.11 ad /*
827 1.11 ad * module_fetch_into:
828 1.11 ad *
829 1.11 ad * Fetch modinfo record from a loaded module.
830 1.11 ad */
831 1.11 ad static int
832 1.11 ad module_fetch_info(module_t *mod)
833 1.11 ad {
834 1.11 ad int error;
835 1.11 ad void *addr;
836 1.11 ad size_t size;
837 1.11 ad
838 1.11 ad /*
839 1.11 ad * Find module info record and check compatibility.
840 1.11 ad */
841 1.11 ad error = kobj_find_section(mod->mod_kobj, "link_set_modules",
842 1.11 ad &addr, &size);
843 1.11 ad if (error != 0) {
844 1.11 ad module_error("`link_set_modules' section not present");
845 1.11 ad return error;
846 1.11 ad }
847 1.11 ad if (size != sizeof(modinfo_t **)) {
848 1.11 ad module_error("`link_set_modules' section wrong size");
849 1.11 ad return error;
850 1.11 ad }
851 1.11 ad mod->mod_info = *(modinfo_t **)addr;
852 1.11 ad
853 1.11 ad return 0;
854 1.11 ad }
855 1.12 ad
856 1.12 ad /*
857 1.12 ad * module_find_section:
858 1.12 ad *
859 1.12 ad * Allows a module that is being initialized to look up a section
860 1.12 ad * within its ELF object.
861 1.12 ad */
862 1.12 ad int
863 1.12 ad module_find_section(const char *name, void **addr, size_t *size)
864 1.12 ad {
865 1.12 ad
866 1.12 ad KASSERT(mutex_owned(&module_lock));
867 1.12 ad KASSERT(module_active != NULL);
868 1.12 ad
869 1.12 ad return kobj_find_section(module_active->mod_kobj, name, addr, size);
870 1.12 ad }
871 1.26 ad
872 1.26 ad /*
873 1.26 ad * module_thread:
874 1.26 ad *
875 1.26 ad * Automatically unload modules. We try once to unload autoloaded
876 1.26 ad * modules after module_autotime seconds. If the system is under
877 1.26 ad * severe memory pressure, we'll try unloading all modules.
878 1.26 ad */
879 1.26 ad static void
880 1.26 ad module_thread(void *cookie)
881 1.26 ad {
882 1.26 ad module_t *mod, *next;
883 1.28 ad modinfo_t *mi;
884 1.28 ad int error;
885 1.26 ad
886 1.26 ad for (;;) {
887 1.26 ad mutex_enter(&module_lock);
888 1.26 ad for (mod = TAILQ_FIRST(&module_list); mod != NULL; mod = next) {
889 1.26 ad next = TAILQ_NEXT(mod, mod_chain);
890 1.26 ad if (uvmexp.free < uvmexp.freemin) {
891 1.26 ad module_thread_ticks = hz;
892 1.26 ad } else if (mod->mod_autotime == 0) {
893 1.26 ad continue;
894 1.26 ad } else if (time_second < mod->mod_autotime) {
895 1.26 ad module_thread_ticks = hz;
896 1.26 ad continue;
897 1.26 ad } else {
898 1.26 ad mod->mod_autotime = 0;
899 1.26 ad }
900 1.28 ad /*
901 1.28 ad * If this module wants to avoid autounload then
902 1.28 ad * skip it. Some modules can ping-pong in and out
903 1.28 ad * because their use is transient but often.
904 1.28 ad * Example: exec_script.
905 1.28 ad */
906 1.28 ad mi = mod->mod_info;
907 1.28 ad error = (*mi->mi_modcmd)(MODULE_CMD_AUTOUNLOAD, NULL);
908 1.28 ad if (error == 0 || error == ENOTTY) {
909 1.28 ad (void)module_do_unload(mi->mi_name);
910 1.28 ad }
911 1.26 ad }
912 1.26 ad mutex_exit(&module_lock);
913 1.26 ad
914 1.26 ad mutex_enter(&module_thread_lock);
915 1.26 ad (void)cv_timedwait(&module_thread_cv, &module_thread_lock,
916 1.26 ad module_thread_ticks);
917 1.26 ad module_thread_ticks = 0;
918 1.26 ad mutex_exit(&module_thread_lock);
919 1.26 ad }
920 1.26 ad }
921 1.26 ad
922 1.26 ad /*
923 1.26 ad * module_thread:
924 1.26 ad *
925 1.26 ad * Kick the module thread into action, perhaps because the
926 1.26 ad * system is low on memory.
927 1.26 ad */
928 1.26 ad void
929 1.26 ad module_thread_kick(void)
930 1.26 ad {
931 1.26 ad
932 1.26 ad mutex_enter(&module_thread_lock);
933 1.26 ad module_thread_ticks = hz;
934 1.26 ad cv_broadcast(&module_thread_cv);
935 1.26 ad mutex_exit(&module_thread_lock);
936 1.26 ad }
937 1.30 ad
938 1.30 ad #ifdef DDB
939 1.30 ad /*
940 1.30 ad * module_whatis:
941 1.30 ad *
942 1.30 ad * Helper routine for DDB.
943 1.30 ad */
944 1.30 ad void
945 1.30 ad module_whatis(uintptr_t addr, void (*pr)(const char *, ...))
946 1.30 ad {
947 1.30 ad module_t *mod;
948 1.30 ad size_t msize;
949 1.30 ad vaddr_t maddr;
950 1.30 ad
951 1.30 ad TAILQ_FOREACH(mod, &module_list, mod_chain) {
952 1.30 ad kobj_stat(mod->mod_kobj, &maddr, &msize);
953 1.30 ad if (addr < maddr || addr >= maddr + msize) {
954 1.30 ad continue;
955 1.30 ad }
956 1.30 ad (*pr)("%p is %p+%zu, in kernel module `%s'\n",
957 1.30 ad (void *)addr, (void *)maddr,
958 1.30 ad (size_t)(addr - maddr), mod->mod_info->mi_name);
959 1.30 ad }
960 1.30 ad }
961 1.30 ad
962 1.30 ad /*
963 1.30 ad * module_print_list:
964 1.30 ad *
965 1.30 ad * Helper routine for DDB.
966 1.30 ad */
967 1.30 ad void
968 1.30 ad module_print_list(void (*pr)(const char *, ...))
969 1.30 ad {
970 1.30 ad const char *src;
971 1.30 ad module_t *mod;
972 1.30 ad size_t msize;
973 1.30 ad vaddr_t maddr;
974 1.30 ad
975 1.30 ad (*pr)("%16s %16s %8s %8s\n", "NAME", "TEXT/DATA", "SIZE", "SOURCE");
976 1.30 ad
977 1.30 ad TAILQ_FOREACH(mod, &module_list, mod_chain) {
978 1.30 ad switch (mod->mod_source) {
979 1.30 ad case MODULE_SOURCE_KERNEL:
980 1.30 ad src = "builtin";
981 1.30 ad break;
982 1.30 ad case MODULE_SOURCE_FILESYS:
983 1.30 ad src = "filesys";
984 1.30 ad break;
985 1.30 ad case MODULE_SOURCE_BOOT:
986 1.30 ad src = "boot";
987 1.30 ad break;
988 1.30 ad default:
989 1.30 ad src = "unknown";
990 1.30 ad break;
991 1.30 ad }
992 1.30 ad kobj_stat(mod->mod_kobj, &maddr, &msize);
993 1.31 ad (*pr)("%16s %16lx %8ld %8s\n", mod->mod_info->mi_name,
994 1.30 ad (long)maddr, (long)msize, src);
995 1.30 ad }
996 1.30 ad }
997 1.30 ad #endif /* DDB */
998