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