kern_module.c revision 1.137 1 1.137 pgoyette /* $NetBSD: kern_module.c,v 1.137 2019/08/07 00:38:02 pgoyette 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.137 pgoyette __KERNEL_RCSID(0, "$NetBSD: kern_module.c,v 1.137 2019/08/07 00:38:02 pgoyette Exp $");
38 1.54 pooka
39 1.54 pooka #define _MODULE_INTERNAL
40 1.30 ad
41 1.30 ad #ifdef _KERNEL_OPT
42 1.30 ad #include "opt_ddb.h"
43 1.42 apb #include "opt_modular.h"
44 1.30 ad #endif
45 1.1 ad
46 1.1 ad #include <sys/param.h>
47 1.1 ad #include <sys/systm.h>
48 1.26 ad #include <sys/kernel.h>
49 1.1 ad #include <sys/proc.h>
50 1.1 ad #include <sys/kauth.h>
51 1.1 ad #include <sys/kobj.h>
52 1.1 ad #include <sys/kmem.h>
53 1.1 ad #include <sys/module.h>
54 1.26 ad #include <sys/kthread.h>
55 1.34 ad #include <sys/sysctl.h>
56 1.46 jnemeth #include <sys/lock.h>
57 1.1 ad
58 1.1 ad #include <uvm/uvm_extern.h>
59 1.1 ad
60 1.25 ad struct vm_map *module_map;
61 1.106 matt const char *module_machine;
62 1.54 pooka char module_base[MODULE_BASE_SIZE];
63 1.2 ad
64 1.59 pooka struct modlist module_list = TAILQ_HEAD_INITIALIZER(module_list);
65 1.59 pooka struct modlist module_builtins = TAILQ_HEAD_INITIALIZER(module_builtins);
66 1.59 pooka static struct modlist module_bootlist = TAILQ_HEAD_INITIALIZER(module_bootlist);
67 1.59 pooka
68 1.131 chs struct module_callbacks {
69 1.131 chs TAILQ_ENTRY(module_callbacks) modcb_list;
70 1.131 chs void (*modcb_load)(struct module *);
71 1.131 chs void (*modcb_unload)(struct module *);
72 1.131 chs };
73 1.131 chs TAILQ_HEAD(modcblist, module_callbacks);
74 1.131 chs static struct modcblist modcblist;
75 1.131 chs
76 1.131 chs static module_t *module_netbsd;
77 1.131 chs static const modinfo_t module_netbsd_modinfo = {
78 1.131 chs .mi_version = __NetBSD_Version__,
79 1.131 chs .mi_class = MODULE_CLASS_MISC,
80 1.131 chs .mi_name = "netbsd"
81 1.131 chs };
82 1.131 chs
83 1.12 ad static module_t *module_active;
84 1.114 pgoyette bool module_verbose_on;
85 1.99 nonaka #ifdef MODULAR_DEFAULT_AUTOLOAD
86 1.114 pgoyette bool module_autoload_on = true;
87 1.98 jnemeth #else
88 1.114 pgoyette bool module_autoload_on = false;
89 1.98 jnemeth #endif
90 1.1 ad u_int module_count;
91 1.59 pooka u_int module_builtinlist;
92 1.26 ad u_int module_autotime = 10;
93 1.26 ad u_int module_gen = 1;
94 1.26 ad static kcondvar_t module_thread_cv;
95 1.26 ad static kmutex_t module_thread_lock;
96 1.26 ad static int module_thread_ticks;
97 1.68 pgoyette int (*module_load_vfs_vec)(const char *, int, bool, module_t *,
98 1.115 msaitoh prop_dictionary_t *) = (void *)eopnotsupp;
99 1.1 ad
100 1.51 elad static kauth_listener_t module_listener;
101 1.51 elad
102 1.131 chs static specificdata_domain_t module_specificdata_domain;
103 1.131 chs
104 1.1 ad /* Ensure that the kernel's link set isn't empty. */
105 1.1 ad static modinfo_t module_dummy;
106 1.1 ad __link_set_add_rodata(modules, module_dummy);
107 1.1 ad
108 1.70 pgoyette static module_t *module_newmodule(modsrc_t);
109 1.131 chs static void module_free(module_t *);
110 1.70 pgoyette static void module_require_force(module_t *);
111 1.9 jmmv static int module_do_load(const char *, bool, int, prop_dictionary_t,
112 1.100 matt module_t **, modclass_t modclass, bool);
113 1.70 pgoyette static int module_do_unload(const char *, bool);
114 1.116 christos static int module_do_builtin(const module_t *, const char *, module_t **,
115 1.116 christos prop_dictionary_t);
116 1.11 ad static int module_fetch_info(module_t *);
117 1.26 ad static void module_thread(void *);
118 1.54 pooka
119 1.60 pooka static module_t *module_lookup(const char *);
120 1.60 pooka static void module_enqueue(module_t *);
121 1.60 pooka
122 1.47 jnemeth static bool module_merge_dicts(prop_dictionary_t, const prop_dictionary_t);
123 1.1 ad
124 1.69 pooka static void sysctl_module_setup(void);
125 1.94 pgoyette static int sysctl_module_autotime(SYSCTLFN_PROTO);
126 1.94 pgoyette
127 1.131 chs static void module_callback_load(struct module *);
128 1.131 chs static void module_callback_unload(struct module *);
129 1.131 chs
130 1.100 matt #define MODULE_CLASS_MATCH(mi, modclass) \
131 1.100 matt ((modclass) == MODULE_CLASS_ANY || (modclass) == (mi)->mi_class)
132 1.88 christos
133 1.88 christos static void
134 1.100 matt module_incompat(const modinfo_t *mi, int modclass)
135 1.88 christos {
136 1.88 christos module_error("incompatible module class for `%s' (%d != %d)",
137 1.100 matt mi->mi_name, modclass, mi->mi_class);
138 1.88 christos }
139 1.69 pooka
140 1.131 chs struct module *
141 1.131 chs module_kernel(void)
142 1.131 chs {
143 1.131 chs
144 1.131 chs return module_netbsd;
145 1.131 chs }
146 1.131 chs
147 1.1 ad /*
148 1.1 ad * module_error:
149 1.1 ad *
150 1.1 ad * Utility function: log an error.
151 1.1 ad */
152 1.54 pooka void
153 1.1 ad module_error(const char *fmt, ...)
154 1.1 ad {
155 1.1 ad va_list ap;
156 1.1 ad
157 1.1 ad va_start(ap, fmt);
158 1.1 ad printf("WARNING: module error: ");
159 1.1 ad vprintf(fmt, ap);
160 1.1 ad printf("\n");
161 1.1 ad va_end(ap);
162 1.1 ad }
163 1.1 ad
164 1.1 ad /*
165 1.34 ad * module_print:
166 1.34 ad *
167 1.34 ad * Utility function: log verbose output.
168 1.34 ad */
169 1.54 pooka void
170 1.34 ad module_print(const char *fmt, ...)
171 1.34 ad {
172 1.34 ad va_list ap;
173 1.34 ad
174 1.34 ad if (module_verbose_on) {
175 1.34 ad va_start(ap, fmt);
176 1.34 ad printf("DEBUG: module: ");
177 1.34 ad vprintf(fmt, ap);
178 1.34 ad printf("\n");
179 1.34 ad va_end(ap);
180 1.34 ad }
181 1.34 ad }
182 1.34 ad
183 1.131 chs /*
184 1.131 chs * module_name:
185 1.131 chs *
186 1.131 chs * Utility function: return the module's name.
187 1.131 chs */
188 1.131 chs const char *
189 1.131 chs module_name(struct module *mod)
190 1.131 chs {
191 1.131 chs
192 1.131 chs return mod->mod_info->mi_name;
193 1.131 chs }
194 1.131 chs
195 1.131 chs /*
196 1.131 chs * module_source:
197 1.131 chs *
198 1.131 chs * Utility function: return the module's source.
199 1.131 chs */
200 1.131 chs modsrc_t
201 1.131 chs module_source(struct module *mod)
202 1.131 chs {
203 1.131 chs
204 1.131 chs return mod->mod_source;
205 1.131 chs }
206 1.131 chs
207 1.55 elad static int
208 1.55 elad module_listener_cb(kauth_cred_t cred, kauth_action_t action, void *cookie,
209 1.55 elad void *arg0, void *arg1, void *arg2, void *arg3)
210 1.55 elad {
211 1.55 elad int result;
212 1.55 elad
213 1.55 elad result = KAUTH_RESULT_DEFER;
214 1.55 elad
215 1.55 elad if (action != KAUTH_SYSTEM_MODULE)
216 1.55 elad return result;
217 1.55 elad
218 1.55 elad if ((uintptr_t)arg2 != 0) /* autoload */
219 1.55 elad result = KAUTH_RESULT_ALLOW;
220 1.55 elad
221 1.55 elad return result;
222 1.55 elad }
223 1.55 elad
224 1.34 ad /*
225 1.70 pgoyette * Allocate a new module_t
226 1.70 pgoyette */
227 1.70 pgoyette static module_t *
228 1.70 pgoyette module_newmodule(modsrc_t source)
229 1.70 pgoyette {
230 1.70 pgoyette module_t *mod;
231 1.70 pgoyette
232 1.70 pgoyette mod = kmem_zalloc(sizeof(*mod), KM_SLEEP);
233 1.125 chs mod->mod_source = source;
234 1.131 chs specificdata_init(module_specificdata_domain, &mod->mod_sdref);
235 1.70 pgoyette return mod;
236 1.70 pgoyette }
237 1.70 pgoyette
238 1.70 pgoyette /*
239 1.131 chs * Free a module_t
240 1.131 chs */
241 1.131 chs static void
242 1.131 chs module_free(module_t *mod)
243 1.131 chs {
244 1.131 chs
245 1.131 chs specificdata_fini(module_specificdata_domain, &mod->mod_sdref);
246 1.133 pgoyette if (mod->mod_required)
247 1.133 pgoyette kmem_free(mod->mod_required, mod->mod_arequired *
248 1.133 pgoyette sizeof(module_t *));
249 1.131 chs kmem_free(mod, sizeof(*mod));
250 1.131 chs }
251 1.131 chs
252 1.131 chs /*
253 1.70 pgoyette * Require the -f (force) flag to load a module
254 1.70 pgoyette */
255 1.70 pgoyette static void
256 1.70 pgoyette module_require_force(struct module *mod)
257 1.70 pgoyette {
258 1.133 pgoyette SET(mod->mod_flags, MODFLG_MUST_FORCE);
259 1.70 pgoyette }
260 1.70 pgoyette
261 1.70 pgoyette /*
262 1.59 pooka * Add modules to the builtin list. This can done at boottime or
263 1.59 pooka * at runtime if the module is linked into the kernel with an
264 1.59 pooka * external linker. All or none of the input will be handled.
265 1.59 pooka * Optionally, the modules can be initialized. If they are not
266 1.59 pooka * initialized, module_init_class() or module_load() can be used
267 1.59 pooka * later, but these are not guaranteed to give atomic results.
268 1.59 pooka */
269 1.59 pooka int
270 1.59 pooka module_builtin_add(modinfo_t *const *mip, size_t nmodinfo, bool init)
271 1.59 pooka {
272 1.59 pooka struct module **modp = NULL, *mod_iter;
273 1.59 pooka int rv = 0, i, mipskip;
274 1.59 pooka
275 1.59 pooka if (init) {
276 1.59 pooka rv = kauth_authorize_system(kauth_cred_get(),
277 1.59 pooka KAUTH_SYSTEM_MODULE, 0, (void *)(uintptr_t)MODCTL_LOAD,
278 1.59 pooka (void *)(uintptr_t)1, NULL);
279 1.59 pooka if (rv) {
280 1.59 pooka return rv;
281 1.59 pooka }
282 1.59 pooka }
283 1.59 pooka
284 1.59 pooka for (i = 0, mipskip = 0; i < nmodinfo; i++) {
285 1.59 pooka if (mip[i] == &module_dummy) {
286 1.59 pooka KASSERT(nmodinfo > 0);
287 1.59 pooka nmodinfo--;
288 1.59 pooka }
289 1.59 pooka }
290 1.59 pooka if (nmodinfo == 0)
291 1.59 pooka return 0;
292 1.59 pooka
293 1.59 pooka modp = kmem_zalloc(sizeof(*modp) * nmodinfo, KM_SLEEP);
294 1.59 pooka for (i = 0, mipskip = 0; i < nmodinfo; i++) {
295 1.59 pooka if (mip[i+mipskip] == &module_dummy) {
296 1.59 pooka mipskip++;
297 1.59 pooka continue;
298 1.59 pooka }
299 1.70 pgoyette modp[i] = module_newmodule(MODULE_SOURCE_KERNEL);
300 1.59 pooka modp[i]->mod_info = mip[i+mipskip];
301 1.59 pooka }
302 1.72 pgoyette kernconfig_lock();
303 1.59 pooka
304 1.59 pooka /* do this in three stages for error recovery and atomicity */
305 1.59 pooka
306 1.59 pooka /* first check for presence */
307 1.59 pooka for (i = 0; i < nmodinfo; i++) {
308 1.59 pooka TAILQ_FOREACH(mod_iter, &module_builtins, mod_chain) {
309 1.59 pooka if (strcmp(mod_iter->mod_info->mi_name,
310 1.59 pooka modp[i]->mod_info->mi_name) == 0)
311 1.59 pooka break;
312 1.59 pooka }
313 1.59 pooka if (mod_iter) {
314 1.59 pooka rv = EEXIST;
315 1.59 pooka goto out;
316 1.59 pooka }
317 1.59 pooka
318 1.59 pooka if (module_lookup(modp[i]->mod_info->mi_name) != NULL) {
319 1.59 pooka rv = EEXIST;
320 1.59 pooka goto out;
321 1.59 pooka }
322 1.59 pooka }
323 1.59 pooka
324 1.59 pooka /* then add to list */
325 1.59 pooka for (i = 0; i < nmodinfo; i++) {
326 1.59 pooka TAILQ_INSERT_TAIL(&module_builtins, modp[i], mod_chain);
327 1.59 pooka module_builtinlist++;
328 1.59 pooka }
329 1.59 pooka
330 1.59 pooka /* finally, init (if required) */
331 1.59 pooka if (init) {
332 1.59 pooka for (i = 0; i < nmodinfo; i++) {
333 1.116 christos rv = module_do_builtin(modp[i],
334 1.116 christos modp[i]->mod_info->mi_name, NULL, NULL);
335 1.59 pooka /* throw in the towel, recovery hard & not worth it */
336 1.59 pooka if (rv)
337 1.117 christos panic("%s: builtin module \"%s\" init failed:"
338 1.117 christos " %d", __func__,
339 1.59 pooka modp[i]->mod_info->mi_name, rv);
340 1.59 pooka }
341 1.59 pooka }
342 1.59 pooka
343 1.59 pooka out:
344 1.72 pgoyette kernconfig_unlock();
345 1.59 pooka if (rv != 0) {
346 1.59 pooka for (i = 0; i < nmodinfo; i++) {
347 1.59 pooka if (modp[i])
348 1.131 chs module_free(modp[i]);
349 1.59 pooka }
350 1.59 pooka }
351 1.59 pooka kmem_free(modp, sizeof(*modp) * nmodinfo);
352 1.59 pooka return rv;
353 1.59 pooka }
354 1.59 pooka
355 1.59 pooka /*
356 1.59 pooka * Optionally fini and remove builtin module from the kernel.
357 1.59 pooka * Note: the module will now be unreachable except via mi && builtin_add.
358 1.59 pooka */
359 1.59 pooka int
360 1.59 pooka module_builtin_remove(modinfo_t *mi, bool fini)
361 1.59 pooka {
362 1.59 pooka struct module *mod;
363 1.59 pooka int rv = 0;
364 1.59 pooka
365 1.59 pooka if (fini) {
366 1.59 pooka rv = kauth_authorize_system(kauth_cred_get(),
367 1.59 pooka KAUTH_SYSTEM_MODULE, 0, (void *)(uintptr_t)MODCTL_UNLOAD,
368 1.59 pooka NULL, NULL);
369 1.59 pooka if (rv)
370 1.59 pooka return rv;
371 1.59 pooka
372 1.72 pgoyette kernconfig_lock();
373 1.70 pgoyette rv = module_do_unload(mi->mi_name, true);
374 1.59 pooka if (rv) {
375 1.59 pooka goto out;
376 1.59 pooka }
377 1.59 pooka } else {
378 1.72 pgoyette kernconfig_lock();
379 1.59 pooka }
380 1.59 pooka TAILQ_FOREACH(mod, &module_builtins, mod_chain) {
381 1.59 pooka if (strcmp(mod->mod_info->mi_name, mi->mi_name) == 0)
382 1.59 pooka break;
383 1.59 pooka }
384 1.59 pooka if (mod) {
385 1.59 pooka TAILQ_REMOVE(&module_builtins, mod, mod_chain);
386 1.59 pooka module_builtinlist--;
387 1.59 pooka } else {
388 1.59 pooka KASSERT(fini == false);
389 1.59 pooka rv = ENOENT;
390 1.59 pooka }
391 1.59 pooka
392 1.59 pooka out:
393 1.72 pgoyette kernconfig_unlock();
394 1.59 pooka return rv;
395 1.59 pooka }
396 1.59 pooka
397 1.59 pooka /*
398 1.1 ad * module_init:
399 1.1 ad *
400 1.1 ad * Initialize the module subsystem.
401 1.1 ad */
402 1.1 ad void
403 1.1 ad module_init(void)
404 1.1 ad {
405 1.59 pooka __link_set_decl(modules, modinfo_t);
406 1.25 ad extern struct vm_map *module_map;
407 1.59 pooka modinfo_t *const *mip;
408 1.59 pooka int rv;
409 1.1 ad
410 1.25 ad if (module_map == NULL) {
411 1.25 ad module_map = kernel_map;
412 1.25 ad }
413 1.71 pgoyette cv_init(&module_thread_cv, "mod_unld");
414 1.26 ad mutex_init(&module_thread_lock, MUTEX_DEFAULT, IPL_NONE);
415 1.131 chs TAILQ_INIT(&modcblist);
416 1.66 pgoyette
417 1.13 ad #ifdef MODULAR /* XXX */
418 1.11 ad module_init_md();
419 1.12 ad #endif
420 1.16 ad
421 1.78 mrg if (!module_machine)
422 1.78 mrg module_machine = machine;
423 1.16 ad #if __NetBSD_Version__ / 1000000 % 100 == 99 /* -current */
424 1.41 rmind snprintf(module_base, sizeof(module_base), "/stand/%s/%s/modules",
425 1.78 mrg module_machine, osrelease);
426 1.16 ad #else /* release */
427 1.41 rmind snprintf(module_base, sizeof(module_base), "/stand/%s/%d.%d/modules",
428 1.78 mrg module_machine, __NetBSD_Version__ / 100000000,
429 1.16 ad __NetBSD_Version__ / 1000000 % 100);
430 1.16 ad #endif
431 1.50 elad
432 1.55 elad module_listener = kauth_listen_scope(KAUTH_SCOPE_SYSTEM,
433 1.55 elad module_listener_cb, NULL);
434 1.59 pooka
435 1.59 pooka __link_set_foreach(mip, modules) {
436 1.77 mbalmer if ((rv = module_builtin_add(mip, 1, false)) != 0)
437 1.59 pooka module_error("builtin %s failed: %d\n",
438 1.59 pooka (*mip)->mi_name, rv);
439 1.59 pooka }
440 1.69 pooka
441 1.69 pooka sysctl_module_setup();
442 1.131 chs module_specificdata_domain = specificdata_domain_create();
443 1.131 chs
444 1.131 chs module_netbsd = module_newmodule(MODULE_SOURCE_KERNEL);
445 1.131 chs module_netbsd->mod_refcnt = 1;
446 1.131 chs module_netbsd->mod_info = &module_netbsd_modinfo;
447 1.51 elad }
448 1.51 elad
449 1.50 elad /*
450 1.70 pgoyette * module_start_unload_thread:
451 1.50 elad *
452 1.50 elad * Start the auto unload kthread.
453 1.50 elad */
454 1.50 elad void
455 1.70 pgoyette module_start_unload_thread(void)
456 1.50 elad {
457 1.50 elad int error;
458 1.26 ad
459 1.26 ad error = kthread_create(PRI_VM, KTHREAD_MPSAFE, NULL, module_thread,
460 1.26 ad NULL, NULL, "modunload");
461 1.26 ad if (error != 0)
462 1.117 christos panic("%s: %d", __func__, error);
463 1.1 ad }
464 1.1 ad
465 1.70 pgoyette /*
466 1.70 pgoyette * module_builtin_require_force
467 1.70 pgoyette *
468 1.70 pgoyette * Require MODCTL_MUST_FORCE to load any built-in modules that have
469 1.70 pgoyette * not yet been initialized
470 1.70 pgoyette */
471 1.70 pgoyette void
472 1.70 pgoyette module_builtin_require_force(void)
473 1.70 pgoyette {
474 1.70 pgoyette module_t *mod;
475 1.70 pgoyette
476 1.72 pgoyette kernconfig_lock();
477 1.70 pgoyette TAILQ_FOREACH(mod, &module_builtins, mod_chain) {
478 1.70 pgoyette module_require_force(mod);
479 1.70 pgoyette }
480 1.72 pgoyette kernconfig_unlock();
481 1.70 pgoyette }
482 1.70 pgoyette
483 1.69 pooka static struct sysctllog *module_sysctllog;
484 1.69 pooka
485 1.94 pgoyette static int
486 1.94 pgoyette sysctl_module_autotime(SYSCTLFN_ARGS)
487 1.94 pgoyette {
488 1.94 pgoyette struct sysctlnode node;
489 1.94 pgoyette int t, error;
490 1.94 pgoyette
491 1.94 pgoyette t = *(int *)rnode->sysctl_data;
492 1.94 pgoyette
493 1.94 pgoyette node = *rnode;
494 1.94 pgoyette node.sysctl_data = &t;
495 1.94 pgoyette error = sysctl_lookup(SYSCTLFN_CALL(&node));
496 1.94 pgoyette if (error || newp == NULL)
497 1.94 pgoyette return (error);
498 1.94 pgoyette
499 1.94 pgoyette if (t < 0)
500 1.94 pgoyette return (EINVAL);
501 1.94 pgoyette
502 1.94 pgoyette *(int *)rnode->sysctl_data = t;
503 1.94 pgoyette return (0);
504 1.94 pgoyette }
505 1.94 pgoyette
506 1.69 pooka static void
507 1.69 pooka sysctl_module_setup(void)
508 1.34 ad {
509 1.34 ad const struct sysctlnode *node = NULL;
510 1.34 ad
511 1.69 pooka sysctl_createv(&module_sysctllog, 0, NULL, &node,
512 1.34 ad CTLFLAG_PERMANENT,
513 1.34 ad CTLTYPE_NODE, "module",
514 1.34 ad SYSCTL_DESCR("Module options"),
515 1.34 ad NULL, 0, NULL, 0,
516 1.34 ad CTL_KERN, CTL_CREATE, CTL_EOL);
517 1.34 ad
518 1.34 ad if (node == NULL)
519 1.34 ad return;
520 1.34 ad
521 1.69 pooka sysctl_createv(&module_sysctllog, 0, &node, NULL,
522 1.34 ad CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
523 1.64 jruoho CTLTYPE_BOOL, "autoload",
524 1.34 ad SYSCTL_DESCR("Enable automatic load of modules"),
525 1.34 ad NULL, 0, &module_autoload_on, 0,
526 1.34 ad CTL_CREATE, CTL_EOL);
527 1.69 pooka sysctl_createv(&module_sysctllog, 0, &node, NULL,
528 1.34 ad CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
529 1.64 jruoho CTLTYPE_BOOL, "verbose",
530 1.34 ad SYSCTL_DESCR("Enable verbose output"),
531 1.34 ad NULL, 0, &module_verbose_on, 0,
532 1.34 ad CTL_CREATE, CTL_EOL);
533 1.94 pgoyette sysctl_createv(&module_sysctllog, 0, &node, NULL,
534 1.97 jnemeth CTLFLAG_PERMANENT | CTLFLAG_READONLY,
535 1.97 jnemeth CTLTYPE_STRING, "path",
536 1.97 jnemeth SYSCTL_DESCR("Default module load path"),
537 1.97 jnemeth NULL, 0, module_base, 0,
538 1.97 jnemeth CTL_CREATE, CTL_EOL);
539 1.97 jnemeth sysctl_createv(&module_sysctllog, 0, &node, NULL,
540 1.94 pgoyette CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
541 1.94 pgoyette CTLTYPE_INT, "autotime",
542 1.94 pgoyette SYSCTL_DESCR("Auto-unload delay"),
543 1.94 pgoyette sysctl_module_autotime, 0, &module_autotime, 0,
544 1.94 pgoyette CTL_CREATE, CTL_EOL);
545 1.34 ad }
546 1.34 ad
547 1.1 ad /*
548 1.1 ad * module_init_class:
549 1.1 ad *
550 1.1 ad * Initialize all built-in and pre-loaded modules of the
551 1.1 ad * specified class.
552 1.1 ad */
553 1.1 ad void
554 1.100 matt module_init_class(modclass_t modclass)
555 1.1 ad {
556 1.63 pooka TAILQ_HEAD(, module) bi_fail = TAILQ_HEAD_INITIALIZER(bi_fail);
557 1.59 pooka module_t *mod;
558 1.59 pooka modinfo_t *mi;
559 1.1 ad
560 1.72 pgoyette kernconfig_lock();
561 1.1 ad /*
562 1.59 pooka * Builtins first. These will not depend on pre-loaded modules
563 1.59 pooka * (because the kernel would not link).
564 1.1 ad */
565 1.59 pooka do {
566 1.59 pooka TAILQ_FOREACH(mod, &module_builtins, mod_chain) {
567 1.59 pooka mi = mod->mod_info;
568 1.100 matt if (!MODULE_CLASS_MATCH(mi, modclass))
569 1.59 pooka continue;
570 1.63 pooka /*
571 1.63 pooka * If initializing a builtin module fails, don't try
572 1.63 pooka * to load it again. But keep it around and queue it
573 1.70 pgoyette * on the builtins list after we're done with module
574 1.70 pgoyette * init. Don't set it to MODFLG_MUST_FORCE in case a
575 1.70 pgoyette * future attempt to initialize can be successful.
576 1.70 pgoyette * (If the module has previously been set to
577 1.70 pgoyette * MODFLG_MUST_FORCE, don't try to override that!)
578 1.63 pooka */
579 1.133 pgoyette if (ISSET(mod->mod_flags, MODFLG_MUST_FORCE) ||
580 1.116 christos module_do_builtin(mod, mi->mi_name, NULL,
581 1.116 christos NULL) != 0) {
582 1.63 pooka TAILQ_REMOVE(&module_builtins, mod, mod_chain);
583 1.63 pooka TAILQ_INSERT_TAIL(&bi_fail, mod, mod_chain);
584 1.63 pooka }
585 1.59 pooka break;
586 1.1 ad }
587 1.59 pooka } while (mod != NULL);
588 1.59 pooka
589 1.1 ad /*
590 1.1 ad * Now preloaded modules. These will be pulled off the
591 1.1 ad * list as we call module_do_load();
592 1.1 ad */
593 1.11 ad do {
594 1.59 pooka TAILQ_FOREACH(mod, &module_bootlist, mod_chain) {
595 1.11 ad mi = mod->mod_info;
596 1.100 matt if (!MODULE_CLASS_MATCH(mi, modclass))
597 1.11 ad continue;
598 1.18 ad module_do_load(mi->mi_name, false, 0, NULL, NULL,
599 1.100 matt modclass, false);
600 1.11 ad break;
601 1.11 ad }
602 1.11 ad } while (mod != NULL);
603 1.63 pooka
604 1.70 pgoyette /* return failed builtin modules to builtin list */
605 1.63 pooka while ((mod = TAILQ_FIRST(&bi_fail)) != NULL) {
606 1.63 pooka TAILQ_REMOVE(&bi_fail, mod, mod_chain);
607 1.63 pooka TAILQ_INSERT_TAIL(&module_builtins, mod, mod_chain);
608 1.63 pooka }
609 1.63 pooka
610 1.72 pgoyette kernconfig_unlock();
611 1.1 ad }
612 1.1 ad
613 1.1 ad /*
614 1.21 ad * module_compatible:
615 1.1 ad *
616 1.21 ad * Return true if the two supplied kernel versions are said to
617 1.21 ad * have the same binary interface for kernel code. The entire
618 1.21 ad * version is signficant for the development tree (-current),
619 1.21 ad * major and minor versions are significant for official
620 1.21 ad * releases of the system.
621 1.1 ad */
622 1.22 pooka bool
623 1.21 ad module_compatible(int v1, int v2)
624 1.1 ad {
625 1.1 ad
626 1.21 ad #if __NetBSD_Version__ / 1000000 % 100 == 99 /* -current */
627 1.21 ad return v1 == v2;
628 1.21 ad #else /* release */
629 1.21 ad return abs(v1 - v2) < 10000;
630 1.21 ad #endif
631 1.1 ad }
632 1.1 ad
633 1.1 ad /*
634 1.1 ad * module_load:
635 1.1 ad *
636 1.9 jmmv * Load a single module from the file system.
637 1.1 ad */
638 1.1 ad int
639 1.18 ad module_load(const char *filename, int flags, prop_dictionary_t props,
640 1.100 matt modclass_t modclass)
641 1.1 ad {
642 1.120 maya module_t *mod;
643 1.1 ad int error;
644 1.1 ad
645 1.120 maya /* Test if we already have the module loaded before
646 1.120 maya * authorizing so we have the opportunity to return EEXIST. */
647 1.120 maya kernconfig_lock();
648 1.120 maya mod = module_lookup(filename);
649 1.120 maya if (mod != NULL) {
650 1.120 maya module_print("%s module `%s' already loaded",
651 1.120 maya "requested", filename);
652 1.120 maya error = EEXIST;
653 1.120 maya goto out;
654 1.120 maya }
655 1.120 maya
656 1.18 ad /* Authorize. */
657 1.18 ad error = kauth_authorize_system(kauth_cred_get(), KAUTH_SYSTEM_MODULE,
658 1.18 ad 0, (void *)(uintptr_t)MODCTL_LOAD, NULL, NULL);
659 1.120 maya if (error != 0)
660 1.120 maya goto out;
661 1.18 ad
662 1.100 matt error = module_do_load(filename, false, flags, props, NULL, modclass,
663 1.23 ad false);
664 1.120 maya
665 1.120 maya out:
666 1.119 maya kernconfig_unlock();
667 1.1 ad return error;
668 1.1 ad }
669 1.1 ad
670 1.1 ad /*
671 1.23 ad * module_autoload:
672 1.23 ad *
673 1.23 ad * Load a single module from the file system, system initiated.
674 1.23 ad */
675 1.23 ad int
676 1.100 matt module_autoload(const char *filename, modclass_t modclass)
677 1.23 ad {
678 1.23 ad int error;
679 1.23 ad
680 1.72 pgoyette kernconfig_lock();
681 1.23 ad
682 1.34 ad /* Nothing if the user has disabled it. */
683 1.34 ad if (!module_autoload_on) {
684 1.72 pgoyette kernconfig_unlock();
685 1.34 ad return EPERM;
686 1.34 ad }
687 1.34 ad
688 1.56 dholland /* Disallow path separators and magic symlinks. */
689 1.29 ad if (strchr(filename, '/') != NULL || strchr(filename, '@') != NULL ||
690 1.29 ad strchr(filename, '.') != NULL) {
691 1.72 pgoyette kernconfig_unlock();
692 1.29 ad return EPERM;
693 1.29 ad }
694 1.29 ad
695 1.23 ad /* Authorize. */
696 1.23 ad error = kauth_authorize_system(kauth_cred_get(), KAUTH_SYSTEM_MODULE,
697 1.23 ad 0, (void *)(uintptr_t)MODCTL_LOAD, (void *)(uintptr_t)1, NULL);
698 1.23 ad
699 1.72 pgoyette if (error == 0)
700 1.100 matt error = module_do_load(filename, false, 0, NULL, NULL, modclass,
701 1.72 pgoyette true);
702 1.72 pgoyette
703 1.72 pgoyette kernconfig_unlock();
704 1.72 pgoyette return error;
705 1.23 ad }
706 1.23 ad
707 1.23 ad /*
708 1.1 ad * module_unload:
709 1.1 ad *
710 1.1 ad * Find and unload a module by name.
711 1.1 ad */
712 1.1 ad int
713 1.1 ad module_unload(const char *name)
714 1.1 ad {
715 1.1 ad int error;
716 1.1 ad
717 1.18 ad /* Authorize. */
718 1.18 ad error = kauth_authorize_system(kauth_cred_get(), KAUTH_SYSTEM_MODULE,
719 1.18 ad 0, (void *)(uintptr_t)MODCTL_UNLOAD, NULL, NULL);
720 1.18 ad if (error != 0) {
721 1.18 ad return error;
722 1.18 ad }
723 1.18 ad
724 1.72 pgoyette kernconfig_lock();
725 1.70 pgoyette error = module_do_unload(name, true);
726 1.72 pgoyette kernconfig_unlock();
727 1.1 ad
728 1.1 ad return error;
729 1.1 ad }
730 1.1 ad
731 1.1 ad /*
732 1.1 ad * module_lookup:
733 1.1 ad *
734 1.1 ad * Look up a module by name.
735 1.1 ad */
736 1.1 ad module_t *
737 1.1 ad module_lookup(const char *name)
738 1.1 ad {
739 1.1 ad module_t *mod;
740 1.1 ad
741 1.72 pgoyette KASSERT(kernconfig_is_held());
742 1.1 ad
743 1.1 ad TAILQ_FOREACH(mod, &module_list, mod_chain) {
744 1.133 pgoyette if (strcmp(mod->mod_info->mi_name, name) == 0)
745 1.1 ad break;
746 1.1 ad }
747 1.1 ad
748 1.1 ad return mod;
749 1.1 ad }
750 1.1 ad
751 1.1 ad /*
752 1.1 ad * module_hold:
753 1.1 ad *
754 1.1 ad * Add a single reference to a module. It's the caller's
755 1.1 ad * responsibility to ensure that the reference is dropped
756 1.1 ad * later.
757 1.1 ad */
758 1.131 chs void
759 1.131 chs module_hold(module_t *mod)
760 1.1 ad {
761 1.1 ad
762 1.72 pgoyette kernconfig_lock();
763 1.1 ad mod->mod_refcnt++;
764 1.72 pgoyette kernconfig_unlock();
765 1.1 ad }
766 1.1 ad
767 1.1 ad /*
768 1.1 ad * module_rele:
769 1.1 ad *
770 1.1 ad * Release a reference acquired with module_hold().
771 1.1 ad */
772 1.1 ad void
773 1.131 chs module_rele(module_t *mod)
774 1.1 ad {
775 1.1 ad
776 1.72 pgoyette kernconfig_lock();
777 1.131 chs KASSERT(mod->mod_refcnt > 0);
778 1.1 ad mod->mod_refcnt--;
779 1.72 pgoyette kernconfig_unlock();
780 1.1 ad }
781 1.1 ad
782 1.1 ad /*
783 1.27 ad * module_enqueue:
784 1.27 ad *
785 1.27 ad * Put a module onto the global list and update counters.
786 1.27 ad */
787 1.53 pooka void
788 1.27 ad module_enqueue(module_t *mod)
789 1.27 ad {
790 1.27 ad int i;
791 1.27 ad
792 1.72 pgoyette KASSERT(kernconfig_is_held());
793 1.53 pooka
794 1.27 ad /*
795 1.113 pgoyette * Put new entry at the head of the queue so autounload can unload
796 1.113 pgoyette * requisite modules with only one pass through the queue.
797 1.27 ad */
798 1.113 pgoyette TAILQ_INSERT_HEAD(&module_list, mod, mod_chain);
799 1.27 ad if (mod->mod_nrequired) {
800 1.27 ad
801 1.27 ad /* Add references to the requisite modules. */
802 1.27 ad for (i = 0; i < mod->mod_nrequired; i++) {
803 1.133 pgoyette KASSERT((*mod->mod_required)[i] != NULL);
804 1.133 pgoyette (*mod->mod_required)[i]->mod_refcnt++;
805 1.27 ad }
806 1.27 ad }
807 1.27 ad module_count++;
808 1.27 ad module_gen++;
809 1.27 ad }
810 1.27 ad
811 1.27 ad /*
812 1.133 pgoyette * Our array of required module pointers starts with zero entries. If we
813 1.133 pgoyette * need to add a new entry, and the list is already full, we reallocate a
814 1.133 pgoyette * larger array, adding MAXMODDEPS entries.
815 1.133 pgoyette */
816 1.133 pgoyette static void
817 1.133 pgoyette alloc_required(module_t *mod)
818 1.133 pgoyette {
819 1.133 pgoyette module_t *(*new)[], *(*old)[];
820 1.133 pgoyette int areq;
821 1.133 pgoyette int i;
822 1.133 pgoyette
823 1.133 pgoyette if (mod->mod_nrequired >= mod->mod_arequired) {
824 1.133 pgoyette areq = mod->mod_arequired + MAXMODDEPS;
825 1.133 pgoyette old = mod->mod_required;
826 1.133 pgoyette new = kmem_zalloc(areq * sizeof(module_t *), KM_SLEEP);
827 1.133 pgoyette for (i = 0; i < mod->mod_arequired; i++)
828 1.133 pgoyette (*new)[i] = (*old)[i];
829 1.133 pgoyette mod->mod_required = new;
830 1.133 pgoyette if (old)
831 1.133 pgoyette kmem_free(old, mod->mod_arequired * sizeof(module_t *));
832 1.133 pgoyette mod->mod_arequired = areq;
833 1.133 pgoyette }
834 1.133 pgoyette }
835 1.133 pgoyette
836 1.133 pgoyette /*
837 1.1 ad * module_do_builtin:
838 1.1 ad *
839 1.59 pooka * Initialize a module from the list of modules that are
840 1.59 pooka * already linked into the kernel.
841 1.1 ad */
842 1.1 ad static int
843 1.116 christos module_do_builtin(const module_t *pmod, const char *name, module_t **modp,
844 1.116 christos prop_dictionary_t props)
845 1.1 ad {
846 1.1 ad const char *p, *s;
847 1.1 ad char buf[MAXMODNAME];
848 1.59 pooka modinfo_t *mi = NULL;
849 1.72 pgoyette module_t *mod, *mod2, *mod_loaded, *prev_active;
850 1.1 ad size_t len;
851 1.27 ad int error;
852 1.1 ad
853 1.72 pgoyette KASSERT(kernconfig_is_held());
854 1.1 ad
855 1.1 ad /*
856 1.59 pooka * Search the list to see if we have a module by this name.
857 1.1 ad */
858 1.59 pooka TAILQ_FOREACH(mod, &module_builtins, mod_chain) {
859 1.59 pooka if (strcmp(mod->mod_info->mi_name, name) == 0) {
860 1.59 pooka mi = mod->mod_info;
861 1.59 pooka break;
862 1.1 ad }
863 1.1 ad }
864 1.1 ad
865 1.1 ad /*
866 1.59 pooka * Check to see if already loaded. This might happen if we
867 1.59 pooka * were already loaded as a dependency.
868 1.1 ad */
869 1.59 pooka if ((mod_loaded = module_lookup(name)) != NULL) {
870 1.59 pooka KASSERT(mod == NULL);
871 1.59 pooka if (modp)
872 1.59 pooka *modp = mod_loaded;
873 1.59 pooka return 0;
874 1.1 ad }
875 1.59 pooka
876 1.59 pooka /* Note! This is from TAILQ, not immediate above */
877 1.65 pooka if (mi == NULL) {
878 1.65 pooka /*
879 1.65 pooka * XXX: We'd like to panic here, but currently in some
880 1.65 pooka * cases (such as nfsserver + nfs), the dependee can be
881 1.65 pooka * succesfully linked without the dependencies.
882 1.65 pooka */
883 1.133 pgoyette module_error("built-in module %s can't find builtin "
884 1.133 pgoyette "dependency `%s'", pmod->mod_info->mi_name, name);
885 1.65 pooka return ENOENT;
886 1.65 pooka }
887 1.1 ad
888 1.1 ad /*
889 1.1 ad * Initialize pre-requisites.
890 1.1 ad */
891 1.133 pgoyette KASSERT(mod->mod_required == NULL);
892 1.133 pgoyette KASSERT(mod->mod_arequired == 0);
893 1.133 pgoyette KASSERT(mod->mod_nrequired == 0);
894 1.1 ad if (mi->mi_required != NULL) {
895 1.1 ad for (s = mi->mi_required; *s != '\0'; s = p) {
896 1.1 ad if (*s == ',')
897 1.1 ad s++;
898 1.1 ad p = s;
899 1.1 ad while (*p != '\0' && *p != ',')
900 1.1 ad p++;
901 1.132 riastrad len = uimin(p - s + 1, sizeof(buf));
902 1.1 ad strlcpy(buf, s, len);
903 1.1 ad if (buf[0] == '\0')
904 1.1 ad break;
905 1.133 pgoyette alloc_required(mod);
906 1.116 christos error = module_do_builtin(mod, buf, &mod2, NULL);
907 1.1 ad if (error != 0) {
908 1.133 pgoyette module_error("built-in module %s prerequisite "
909 1.133 pgoyette "%s failed, error %d", name, buf, error);
910 1.133 pgoyette goto fail;
911 1.1 ad }
912 1.133 pgoyette (*mod->mod_required)[mod->mod_nrequired++] = mod2;
913 1.1 ad }
914 1.1 ad }
915 1.1 ad
916 1.1 ad /*
917 1.1 ad * Try to initialize the module.
918 1.1 ad */
919 1.72 pgoyette prev_active = module_active;
920 1.12 ad module_active = mod;
921 1.74 pooka error = (*mi->mi_modcmd)(MODULE_CMD_INIT, props);
922 1.72 pgoyette module_active = prev_active;
923 1.1 ad if (error != 0) {
924 1.133 pgoyette module_error("built-in module %s failed its MODULE_CMD_INIT, "
925 1.133 pgoyette "error %d", mi->mi_name, error);
926 1.133 pgoyette goto fail;
927 1.1 ad }
928 1.59 pooka
929 1.59 pooka /* load always succeeds after this point */
930 1.59 pooka
931 1.59 pooka TAILQ_REMOVE(&module_builtins, mod, mod_chain);
932 1.59 pooka module_builtinlist--;
933 1.59 pooka if (modp != NULL) {
934 1.59 pooka *modp = mod;
935 1.59 pooka }
936 1.27 ad module_enqueue(mod);
937 1.1 ad return 0;
938 1.133 pgoyette
939 1.133 pgoyette fail:
940 1.133 pgoyette if (mod->mod_required)
941 1.133 pgoyette kmem_free(mod->mod_required, mod->mod_arequired *
942 1.133 pgoyette sizeof(module_t *));
943 1.133 pgoyette mod->mod_arequired = 0;
944 1.133 pgoyette mod->mod_nrequired = 0;
945 1.133 pgoyette mod->mod_required = NULL;
946 1.133 pgoyette return error;
947 1.1 ad }
948 1.1 ad
949 1.1 ad /*
950 1.137 pgoyette * module_load_sysctl
951 1.137 pgoyette *
952 1.137 pgoyette * Check to see if the module has any SYSCTL_SETUP() routine(s)
953 1.137 pgoyette * registered. If so, call it (them).
954 1.137 pgoyette */
955 1.137 pgoyette
956 1.137 pgoyette static void
957 1.137 pgoyette module_load_sysctl(module_t *mod)
958 1.137 pgoyette {
959 1.137 pgoyette void (**ls_funcp)(struct sysctllog **);
960 1.137 pgoyette void *ls_start;
961 1.137 pgoyette size_t ls_size, count;
962 1.137 pgoyette int error;
963 1.137 pgoyette
964 1.137 pgoyette error = kobj_find_section(mod->mod_kobj, "link_set_sysctl_funcs",
965 1.137 pgoyette &ls_start, &ls_size);
966 1.137 pgoyette if (error == 0) {
967 1.137 pgoyette count = ls_size / sizeof(ls_start);
968 1.137 pgoyette ls_funcp = ls_start;
969 1.137 pgoyette while (count--) {
970 1.137 pgoyette (**ls_funcp)(&mod->mod_sysctllog);
971 1.137 pgoyette ls_funcp++;
972 1.137 pgoyette }
973 1.137 pgoyette }
974 1.137 pgoyette else
975 1.137 pgoyette error = 0; /* no setup funcs registered */
976 1.137 pgoyette }
977 1.137 pgoyette
978 1.137 pgoyette /*
979 1.1 ad * module_do_load:
980 1.1 ad *
981 1.1 ad * Helper routine: load a module from the file system, or one
982 1.1 ad * pushed by the boot loader.
983 1.1 ad */
984 1.1 ad static int
985 1.27 ad module_do_load(const char *name, bool isdep, int flags,
986 1.100 matt prop_dictionary_t props, module_t **modp, modclass_t modclass,
987 1.20 ad bool autoload)
988 1.1 ad {
989 1.133 pgoyette /* The pending list for this level of recursion */
990 1.72 pgoyette TAILQ_HEAD(pending_t, module);
991 1.72 pgoyette struct pending_t *pending;
992 1.72 pgoyette struct pending_t new_pending = TAILQ_HEAD_INITIALIZER(new_pending);
993 1.133 pgoyette
994 1.133 pgoyette /* The stack of pending lists */
995 1.133 pgoyette static SLIST_HEAD(pend_head, pend_entry) pend_stack =
996 1.133 pgoyette SLIST_HEAD_INITIALIZER(pend_stack);
997 1.133 pgoyette struct pend_entry {
998 1.133 pgoyette SLIST_ENTRY(pend_entry) pe_entry;
999 1.133 pgoyette struct pending_t *pe_pending;
1000 1.133 pgoyette } my_pend_entry;
1001 1.133 pgoyette
1002 1.1 ad modinfo_t *mi;
1003 1.72 pgoyette module_t *mod, *mod2, *prev_active;
1004 1.46 jnemeth prop_dictionary_t filedict;
1005 1.54 pooka char buf[MAXMODNAME];
1006 1.1 ad const char *s, *p;
1007 1.1 ad int error;
1008 1.54 pooka size_t len;
1009 1.1 ad
1010 1.72 pgoyette KASSERT(kernconfig_is_held());
1011 1.1 ad
1012 1.46 jnemeth filedict = NULL;
1013 1.1 ad error = 0;
1014 1.1 ad
1015 1.1 ad /*
1016 1.133 pgoyette * Set up the pending list for this entry. If this is an
1017 1.133 pgoyette * internal entry (for a dependency), then use the same list
1018 1.133 pgoyette * as for the outer call; otherwise, it's an external entry
1019 1.133 pgoyette * (possibly recursive, ie a module's xxx_modcmd(init, ...)
1020 1.133 pgoyette * routine called us), so use the locally allocated list. In
1021 1.133 pgoyette * either case, add it to our stack.
1022 1.72 pgoyette */
1023 1.72 pgoyette if (isdep) {
1024 1.133 pgoyette KASSERT(SLIST_FIRST(&pend_stack) != NULL);
1025 1.133 pgoyette pending = SLIST_FIRST(&pend_stack)->pe_pending;
1026 1.72 pgoyette } else
1027 1.72 pgoyette pending = &new_pending;
1028 1.133 pgoyette my_pend_entry.pe_pending = pending;
1029 1.133 pgoyette SLIST_INSERT_HEAD(&pend_stack, &my_pend_entry, pe_entry);
1030 1.72 pgoyette
1031 1.72 pgoyette /*
1032 1.59 pooka * Search the list of disabled builtins first.
1033 1.59 pooka */
1034 1.59 pooka TAILQ_FOREACH(mod, &module_builtins, mod_chain) {
1035 1.59 pooka if (strcmp(mod->mod_info->mi_name, name) == 0) {
1036 1.59 pooka break;
1037 1.59 pooka }
1038 1.59 pooka }
1039 1.59 pooka if (mod) {
1040 1.133 pgoyette if (ISSET(mod->mod_flags, MODFLG_MUST_FORCE) &&
1041 1.133 pgoyette !ISSET(flags, MODCTL_LOAD_FORCE)) {
1042 1.62 pooka if (!autoload) {
1043 1.62 pooka module_error("use -f to reinstate "
1044 1.90 christos "builtin module `%s'", name);
1045 1.62 pooka }
1046 1.133 pgoyette SLIST_REMOVE_HEAD(&pend_stack, pe_entry);
1047 1.59 pooka return EPERM;
1048 1.59 pooka } else {
1049 1.133 pgoyette SLIST_REMOVE_HEAD(&pend_stack, pe_entry);
1050 1.116 christos error = module_do_builtin(mod, name, modp, props);
1051 1.59 pooka return error;
1052 1.59 pooka }
1053 1.59 pooka }
1054 1.59 pooka
1055 1.59 pooka /*
1056 1.1 ad * Load the module and link. Before going to the file system,
1057 1.57 pooka * scan the list of modules loaded by the boot loader.
1058 1.1 ad */
1059 1.1 ad TAILQ_FOREACH(mod, &module_bootlist, mod_chain) {
1060 1.27 ad if (strcmp(mod->mod_info->mi_name, name) == 0) {
1061 1.1 ad TAILQ_REMOVE(&module_bootlist, mod, mod_chain);
1062 1.1 ad break;
1063 1.1 ad }
1064 1.1 ad }
1065 1.14 rumble if (mod != NULL) {
1066 1.72 pgoyette TAILQ_INSERT_TAIL(pending, mod, mod_chain);
1067 1.14 rumble } else {
1068 1.27 ad /*
1069 1.110 pgoyette * Check to see if module is already present.
1070 1.27 ad */
1071 1.110 pgoyette mod = module_lookup(name);
1072 1.110 pgoyette if (mod != NULL) {
1073 1.110 pgoyette if (modp != NULL) {
1074 1.110 pgoyette *modp = mod;
1075 1.27 ad }
1076 1.110 pgoyette module_print("%s module `%s' already loaded",
1077 1.110 pgoyette isdep ? "dependent" : "requested", name);
1078 1.133 pgoyette SLIST_REMOVE_HEAD(&pend_stack, pe_entry);
1079 1.110 pgoyette return EEXIST;
1080 1.109 maxv }
1081 1.110 pgoyette
1082 1.70 pgoyette mod = module_newmodule(MODULE_SOURCE_FILESYS);
1083 1.1 ad if (mod == NULL) {
1084 1.38 christos module_error("out of memory for `%s'", name);
1085 1.133 pgoyette SLIST_REMOVE_HEAD(&pend_stack, pe_entry);
1086 1.1 ad return ENOMEM;
1087 1.1 ad }
1088 1.54 pooka
1089 1.67 pgoyette error = module_load_vfs_vec(name, flags, autoload, mod,
1090 1.67 pgoyette &filedict);
1091 1.1 ad if (error != 0) {
1092 1.91 christos #ifdef DEBUG
1093 1.92 christos /*
1094 1.92 christos * The exec class of modules contains a list of
1095 1.92 christos * modules that is the union of all the modules
1096 1.92 christos * available for each architecture, so we don't
1097 1.92 christos * print an error if they are missing.
1098 1.92 christos */
1099 1.104 christos if ((modclass != MODULE_CLASS_EXEC || error != ENOENT)
1100 1.105 christos && root_device != NULL)
1101 1.92 christos module_error("vfs load failed for `%s', "
1102 1.92 christos "error %d", name, error);
1103 1.91 christos #endif
1104 1.133 pgoyette SLIST_REMOVE_HEAD(&pend_stack, pe_entry);
1105 1.131 chs module_free(mod);
1106 1.8 rumble return error;
1107 1.7 rumble }
1108 1.72 pgoyette TAILQ_INSERT_TAIL(pending, mod, mod_chain);
1109 1.54 pooka
1110 1.11 ad error = module_fetch_info(mod);
1111 1.11 ad if (error != 0) {
1112 1.90 christos module_error("cannot fetch info for `%s', error %d",
1113 1.90 christos name, error);
1114 1.11 ad goto fail;
1115 1.11 ad }
1116 1.1 ad }
1117 1.1 ad
1118 1.1 ad /*
1119 1.11 ad * Check compatibility.
1120 1.1 ad */
1121 1.1 ad mi = mod->mod_info;
1122 1.134 pgoyette if (strnlen(mi->mi_name, MAXMODNAME) >= MAXMODNAME) {
1123 1.3 rumble error = EINVAL;
1124 1.90 christos module_error("module name `%s' longer than %d", mi->mi_name,
1125 1.90 christos MAXMODNAME);
1126 1.3 rumble goto fail;
1127 1.3 rumble }
1128 1.134 pgoyette if (mi->mi_class <= MODULE_CLASS_ANY ||
1129 1.134 pgoyette mi->mi_class >= MODULE_CLASS_MAX) {
1130 1.134 pgoyette error = EINVAL;
1131 1.134 pgoyette module_error("module `%s' has invalid class %d",
1132 1.134 pgoyette mi->mi_name, mi->mi_class);
1133 1.134 pgoyette goto fail;
1134 1.134 pgoyette }
1135 1.21 ad if (!module_compatible(mi->mi_version, __NetBSD_Version__)) {
1136 1.87 christos module_error("module `%s' built for `%d', system `%d'",
1137 1.87 christos mi->mi_name, mi->mi_version, __NetBSD_Version__);
1138 1.133 pgoyette if (ISSET(flags, MODCTL_LOAD_FORCE)) {
1139 1.24 ad module_error("forced load, system may be unstable");
1140 1.24 ad } else {
1141 1.24 ad error = EPROGMISMATCH;
1142 1.24 ad goto fail;
1143 1.24 ad }
1144 1.21 ad }
1145 1.3 rumble
1146 1.1 ad /*
1147 1.18 ad * If a specific kind of module was requested, ensure that we have
1148 1.18 ad * a match.
1149 1.18 ad */
1150 1.100 matt if (!MODULE_CLASS_MATCH(mi, modclass)) {
1151 1.100 matt module_incompat(mi, modclass);
1152 1.18 ad error = ENOENT;
1153 1.18 ad goto fail;
1154 1.18 ad }
1155 1.18 ad
1156 1.18 ad /*
1157 1.27 ad * If loading a dependency, `name' is a plain module name.
1158 1.1 ad * The name must match.
1159 1.1 ad */
1160 1.27 ad if (isdep && strcmp(mi->mi_name, name) != 0) {
1161 1.32 christos module_error("dependency name mismatch (`%s' != `%s')",
1162 1.32 christos name, mi->mi_name);
1163 1.1 ad error = ENOENT;
1164 1.1 ad goto fail;
1165 1.1 ad }
1166 1.1 ad
1167 1.1 ad /*
1168 1.126 pgoyette * If we loaded a module from the filesystem, check the actual
1169 1.126 pgoyette * module name (from the modinfo_t) to ensure another module
1170 1.126 pgoyette * with the same name doesn't already exist. (There's no
1171 1.126 pgoyette * guarantee the filename will match the module name, and the
1172 1.126 pgoyette * dup-symbols check may not be sufficient.)
1173 1.126 pgoyette */
1174 1.126 pgoyette if (mod->mod_source == MODULE_SOURCE_FILESYS) {
1175 1.126 pgoyette mod2 = module_lookup(mod->mod_info->mi_name);
1176 1.130 pgoyette if ( mod2 && mod2 != mod) {
1177 1.126 pgoyette module_error("module with name `%s' already loaded",
1178 1.126 pgoyette mod2->mod_info->mi_name);
1179 1.126 pgoyette error = EEXIST;
1180 1.133 pgoyette if (modp != NULL)
1181 1.133 pgoyette *modp = mod2;
1182 1.126 pgoyette goto fail;
1183 1.126 pgoyette }
1184 1.126 pgoyette }
1185 1.126 pgoyette
1186 1.126 pgoyette /*
1187 1.3 rumble * Block circular dependencies.
1188 1.3 rumble */
1189 1.72 pgoyette TAILQ_FOREACH(mod2, pending, mod_chain) {
1190 1.1 ad if (mod == mod2) {
1191 1.1 ad continue;
1192 1.1 ad }
1193 1.1 ad if (strcmp(mod2->mod_info->mi_name, mi->mi_name) == 0) {
1194 1.109 maxv error = EDEADLK;
1195 1.32 christos module_error("circular dependency detected for `%s'",
1196 1.32 christos mi->mi_name);
1197 1.109 maxv goto fail;
1198 1.1 ad }
1199 1.1 ad }
1200 1.1 ad
1201 1.1 ad /*
1202 1.1 ad * Now try to load any requisite modules.
1203 1.1 ad */
1204 1.1 ad if (mi->mi_required != NULL) {
1205 1.133 pgoyette mod->mod_arequired = 0;
1206 1.1 ad for (s = mi->mi_required; *s != '\0'; s = p) {
1207 1.1 ad if (*s == ',')
1208 1.1 ad s++;
1209 1.1 ad p = s;
1210 1.1 ad while (*p != '\0' && *p != ',')
1211 1.1 ad p++;
1212 1.3 rumble len = p - s + 1;
1213 1.3 rumble if (len >= MAXMODNAME) {
1214 1.3 rumble error = EINVAL;
1215 1.90 christos module_error("required module name `%s' "
1216 1.90 christos "longer than %d", mi->mi_required,
1217 1.90 christos MAXMODNAME);
1218 1.3 rumble goto fail;
1219 1.3 rumble }
1220 1.1 ad strlcpy(buf, s, len);
1221 1.1 ad if (buf[0] == '\0')
1222 1.1 ad break;
1223 1.133 pgoyette alloc_required(mod);
1224 1.6 rumble if (strcmp(buf, mi->mi_name) == 0) {
1225 1.6 rumble error = EDEADLK;
1226 1.32 christos module_error("self-dependency detected for "
1227 1.32 christos "`%s'", mi->mi_name);
1228 1.6 rumble goto fail;
1229 1.6 rumble }
1230 1.9 jmmv error = module_do_load(buf, true, flags, NULL,
1231 1.81 christos &mod2, MODULE_CLASS_ANY, true);
1232 1.110 pgoyette if (error != 0 && error != EEXIST) {
1233 1.96 maxv module_error("recursive load failed for `%s' "
1234 1.96 maxv "(`%s' required), error %d", mi->mi_name,
1235 1.96 maxv buf, error);
1236 1.1 ad goto fail;
1237 1.88 christos }
1238 1.133 pgoyette (*mod->mod_required)[mod->mod_nrequired++] = mod2;
1239 1.1 ad }
1240 1.1 ad }
1241 1.1 ad
1242 1.1 ad /*
1243 1.15 ad * We loaded all needed modules successfully: perform global
1244 1.15 ad * relocations and initialize.
1245 1.1 ad */
1246 1.136 pgoyette {
1247 1.136 pgoyette char xname[MAXMODNAME];
1248 1.136 pgoyette
1249 1.136 pgoyette /*
1250 1.136 pgoyette * In case of error the entire module is gone, so we
1251 1.136 pgoyette * need to save its name for possible error report.
1252 1.136 pgoyette */
1253 1.136 pgoyette
1254 1.136 pgoyette strlcpy(xname, mi->mi_name, MAXMODNAME);
1255 1.136 pgoyette error = kobj_affix(mod->mod_kobj, mi->mi_name);
1256 1.136 pgoyette if (error != 0) {
1257 1.136 pgoyette module_error("unable to affix module `%s', error %d",
1258 1.136 pgoyette xname, error);
1259 1.136 pgoyette goto fail2;
1260 1.136 pgoyette }
1261 1.15 ad }
1262 1.15 ad
1263 1.54 pooka if (filedict) {
1264 1.54 pooka if (!module_merge_dicts(filedict, props)) {
1265 1.90 christos module_error("module properties failed for %s", name);
1266 1.54 pooka error = EINVAL;
1267 1.46 jnemeth goto fail;
1268 1.46 jnemeth }
1269 1.46 jnemeth }
1270 1.133 pgoyette
1271 1.72 pgoyette prev_active = module_active;
1272 1.12 ad module_active = mod;
1273 1.54 pooka error = (*mi->mi_modcmd)(MODULE_CMD_INIT, filedict ? filedict : props);
1274 1.72 pgoyette module_active = prev_active;
1275 1.54 pooka if (filedict) {
1276 1.46 jnemeth prop_object_release(filedict);
1277 1.54 pooka filedict = NULL;
1278 1.46 jnemeth }
1279 1.1 ad if (error != 0) {
1280 1.135 pgoyette module_error("modcmd(CMD_INIT) failed for `%s', error %d",
1281 1.90 christos mi->mi_name, error);
1282 1.1 ad goto fail;
1283 1.1 ad }
1284 1.54 pooka
1285 1.1 ad /*
1286 1.130 pgoyette * If a recursive load already added a module with the same
1287 1.130 pgoyette * name, abort.
1288 1.130 pgoyette */
1289 1.130 pgoyette mod2 = module_lookup(mi->mi_name);
1290 1.130 pgoyette if (mod2 && mod2 != mod) {
1291 1.130 pgoyette module_error("recursive load causes duplicate module `%s'",
1292 1.130 pgoyette mi->mi_name);
1293 1.130 pgoyette error = EEXIST;
1294 1.130 pgoyette goto fail1;
1295 1.130 pgoyette }
1296 1.130 pgoyette
1297 1.137 pgoyette module_load_sysctl(mod); /* Set-up module's sysctl if any */
1298 1.137 pgoyette
1299 1.130 pgoyette /*
1300 1.1 ad * Good, the module loaded successfully. Put it onto the
1301 1.1 ad * list and add references to its requisite modules.
1302 1.1 ad */
1303 1.72 pgoyette TAILQ_REMOVE(pending, mod, mod_chain);
1304 1.27 ad module_enqueue(mod);
1305 1.1 ad if (modp != NULL) {
1306 1.1 ad *modp = mod;
1307 1.1 ad }
1308 1.94 pgoyette if (autoload && module_autotime > 0) {
1309 1.26 ad /*
1310 1.26 ad * Arrange to try unloading the module after
1311 1.94 pgoyette * a short delay unless auto-unload is disabled.
1312 1.26 ad */
1313 1.26 ad mod->mod_autotime = time_second + module_autotime;
1314 1.133 pgoyette SET(mod->mod_flags, MODFLG_AUTO_LOADED);
1315 1.26 ad module_thread_kick();
1316 1.26 ad }
1317 1.133 pgoyette SLIST_REMOVE_HEAD(&pend_stack, pe_entry);
1318 1.107 pgoyette module_print("module `%s' loaded successfully", mi->mi_name);
1319 1.131 chs module_callback_load(mod);
1320 1.1 ad return 0;
1321 1.7 rumble
1322 1.130 pgoyette fail1:
1323 1.130 pgoyette (*mi->mi_modcmd)(MODULE_CMD_FINI, NULL);
1324 1.1 ad fail:
1325 1.15 ad kobj_unload(mod->mod_kobj);
1326 1.15 ad fail2:
1327 1.54 pooka if (filedict != NULL) {
1328 1.54 pooka prop_object_release(filedict);
1329 1.54 pooka filedict = NULL;
1330 1.54 pooka }
1331 1.72 pgoyette TAILQ_REMOVE(pending, mod, mod_chain);
1332 1.133 pgoyette SLIST_REMOVE_HEAD(&pend_stack, pe_entry);
1333 1.131 chs module_free(mod);
1334 1.1 ad return error;
1335 1.1 ad }
1336 1.1 ad
1337 1.1 ad /*
1338 1.1 ad * module_do_unload:
1339 1.1 ad *
1340 1.1 ad * Helper routine: do the dirty work of unloading a module.
1341 1.1 ad */
1342 1.1 ad static int
1343 1.70 pgoyette module_do_unload(const char *name, bool load_requires_force)
1344 1.1 ad {
1345 1.72 pgoyette module_t *mod, *prev_active;
1346 1.1 ad int error;
1347 1.1 ad u_int i;
1348 1.1 ad
1349 1.72 pgoyette KASSERT(kernconfig_is_held());
1350 1.85 jnemeth KASSERT(name != NULL);
1351 1.1 ad
1352 1.107 pgoyette module_print("unload requested for '%s' (%s)", name,
1353 1.117 christos load_requires_force ? "TRUE" : "FALSE");
1354 1.1 ad mod = module_lookup(name);
1355 1.1 ad if (mod == NULL) {
1356 1.32 christos module_error("module `%s' not found", name);
1357 1.1 ad return ENOENT;
1358 1.1 ad }
1359 1.59 pooka if (mod->mod_refcnt != 0) {
1360 1.107 pgoyette module_print("module `%s' busy (%d refs)", name,
1361 1.108 pgoyette mod->mod_refcnt);
1362 1.1 ad return EBUSY;
1363 1.1 ad }
1364 1.76 pooka
1365 1.76 pooka /*
1366 1.76 pooka * Builtin secmodels are there to stay.
1367 1.76 pooka */
1368 1.76 pooka if (mod->mod_source == MODULE_SOURCE_KERNEL &&
1369 1.76 pooka mod->mod_info->mi_class == MODULE_CLASS_SECMODEL) {
1370 1.107 pgoyette module_print("cannot unload built-in secmodel module `%s'",
1371 1.107 pgoyette name);
1372 1.76 pooka return EPERM;
1373 1.76 pooka }
1374 1.76 pooka
1375 1.72 pgoyette prev_active = module_active;
1376 1.12 ad module_active = mod;
1377 1.131 chs module_callback_unload(mod);
1378 1.137 pgoyette
1379 1.137 pgoyette /*
1380 1.137 pgoyette * If there were any registered SYSCTL_SETUP funcs, make sure
1381 1.137 pgoyette * we release the sysctl entries
1382 1.137 pgoyette */
1383 1.137 pgoyette if (mod->mod_sysctllog) {
1384 1.137 pgoyette sysctl_teardown(&mod->mod_sysctllog);
1385 1.137 pgoyette }
1386 1.1 ad error = (*mod->mod_info->mi_modcmd)(MODULE_CMD_FINI, NULL);
1387 1.72 pgoyette module_active = prev_active;
1388 1.1 ad if (error != 0) {
1389 1.137 pgoyette module_load_sysctl(mod); /* re-enable sysctl stuff */
1390 1.34 ad module_print("cannot unload module `%s' error=%d", name,
1391 1.33 ad error);
1392 1.1 ad return error;
1393 1.1 ad }
1394 1.1 ad module_count--;
1395 1.1 ad TAILQ_REMOVE(&module_list, mod, mod_chain);
1396 1.1 ad for (i = 0; i < mod->mod_nrequired; i++) {
1397 1.133 pgoyette (*mod->mod_required)[i]->mod_refcnt--;
1398 1.1 ad }
1399 1.85 jnemeth module_print("unloaded module `%s'", name);
1400 1.1 ad if (mod->mod_kobj != NULL) {
1401 1.1 ad kobj_unload(mod->mod_kobj);
1402 1.1 ad }
1403 1.59 pooka if (mod->mod_source == MODULE_SOURCE_KERNEL) {
1404 1.133 pgoyette if (mod->mod_required != NULL) {
1405 1.133 pgoyette /*
1406 1.133 pgoyette * release "required" resources - will be re-parsed
1407 1.133 pgoyette * if the module is re-enabled
1408 1.133 pgoyette */
1409 1.133 pgoyette kmem_free(mod->mod_required,
1410 1.133 pgoyette mod->mod_arequired * sizeof(module_t *));
1411 1.133 pgoyette mod->mod_nrequired = 0;
1412 1.133 pgoyette mod->mod_arequired = 0;
1413 1.133 pgoyette mod->mod_required = NULL;
1414 1.133 pgoyette }
1415 1.70 pgoyette if (load_requires_force)
1416 1.70 pgoyette module_require_force(mod);
1417 1.59 pooka TAILQ_INSERT_TAIL(&module_builtins, mod, mod_chain);
1418 1.59 pooka module_builtinlist++;
1419 1.59 pooka } else {
1420 1.131 chs module_free(mod);
1421 1.59 pooka }
1422 1.26 ad module_gen++;
1423 1.1 ad
1424 1.1 ad return 0;
1425 1.1 ad }
1426 1.1 ad
1427 1.1 ad /*
1428 1.1 ad * module_prime:
1429 1.1 ad *
1430 1.1 ad * Push a module loaded by the bootloader onto our internal
1431 1.1 ad * list.
1432 1.1 ad */
1433 1.1 ad int
1434 1.80 christos module_prime(const char *name, void *base, size_t size)
1435 1.1 ad {
1436 1.111 pgoyette __link_set_decl(modules, modinfo_t);
1437 1.111 pgoyette modinfo_t *const *mip;
1438 1.1 ad module_t *mod;
1439 1.1 ad int error;
1440 1.1 ad
1441 1.112 pgoyette /* Check for module name same as a built-in module */
1442 1.111 pgoyette
1443 1.111 pgoyette __link_set_foreach(mip, modules) {
1444 1.111 pgoyette if (*mip == &module_dummy)
1445 1.111 pgoyette continue;
1446 1.111 pgoyette if (strcmp((*mip)->mi_name, name) == 0) {
1447 1.111 pgoyette module_error("module `%s' pushed by boot loader "
1448 1.111 pgoyette "already exists", name);
1449 1.111 pgoyette return EEXIST;
1450 1.111 pgoyette }
1451 1.111 pgoyette }
1452 1.112 pgoyette
1453 1.112 pgoyette /* Also eliminate duplicate boolist entries */
1454 1.112 pgoyette
1455 1.112 pgoyette TAILQ_FOREACH(mod, &module_bootlist, mod_chain) {
1456 1.112 pgoyette if (strcmp(mod->mod_info->mi_name, name) == 0) {
1457 1.112 pgoyette module_error("duplicate bootlist entry for module "
1458 1.112 pgoyette "`%s'", name);
1459 1.112 pgoyette return EEXIST;
1460 1.112 pgoyette }
1461 1.112 pgoyette }
1462 1.112 pgoyette
1463 1.112 pgoyette mod = module_newmodule(MODULE_SOURCE_BOOT);
1464 1.112 pgoyette if (mod == NULL) {
1465 1.112 pgoyette return ENOMEM;
1466 1.112 pgoyette }
1467 1.112 pgoyette
1468 1.80 christos error = kobj_load_mem(&mod->mod_kobj, name, base, size);
1469 1.1 ad if (error != 0) {
1470 1.131 chs module_free(mod);
1471 1.90 christos module_error("unable to load `%s' pushed by boot loader, "
1472 1.90 christos "error %d", name, error);
1473 1.11 ad return error;
1474 1.11 ad }
1475 1.11 ad error = module_fetch_info(mod);
1476 1.11 ad if (error != 0) {
1477 1.11 ad kobj_unload(mod->mod_kobj);
1478 1.131 chs module_free(mod);
1479 1.111 pgoyette module_error("unable to fetch_info for `%s' pushed by boot "
1480 1.111 pgoyette "loader, error %d", name, error);
1481 1.1 ad return error;
1482 1.1 ad }
1483 1.11 ad
1484 1.1 ad TAILQ_INSERT_TAIL(&module_bootlist, mod, mod_chain);
1485 1.1 ad
1486 1.1 ad return 0;
1487 1.1 ad }
1488 1.11 ad
1489 1.11 ad /*
1490 1.11 ad * module_fetch_into:
1491 1.11 ad *
1492 1.11 ad * Fetch modinfo record from a loaded module.
1493 1.11 ad */
1494 1.11 ad static int
1495 1.11 ad module_fetch_info(module_t *mod)
1496 1.11 ad {
1497 1.11 ad int error;
1498 1.11 ad void *addr;
1499 1.11 ad size_t size;
1500 1.11 ad
1501 1.11 ad /*
1502 1.11 ad * Find module info record and check compatibility.
1503 1.11 ad */
1504 1.11 ad error = kobj_find_section(mod->mod_kobj, "link_set_modules",
1505 1.11 ad &addr, &size);
1506 1.11 ad if (error != 0) {
1507 1.90 christos module_error("`link_set_modules' section not present, "
1508 1.90 christos "error %d", error);
1509 1.11 ad return error;
1510 1.11 ad }
1511 1.11 ad if (size != sizeof(modinfo_t **)) {
1512 1.133 pgoyette module_error("`link_set_modules' section wrong size "
1513 1.133 pgoyette "(got %zu, wanted %zu)", size, sizeof(modinfo_t **));
1514 1.84 tron return ENOEXEC;
1515 1.11 ad }
1516 1.11 ad mod->mod_info = *(modinfo_t **)addr;
1517 1.11 ad
1518 1.11 ad return 0;
1519 1.11 ad }
1520 1.12 ad
1521 1.12 ad /*
1522 1.12 ad * module_find_section:
1523 1.12 ad *
1524 1.12 ad * Allows a module that is being initialized to look up a section
1525 1.12 ad * within its ELF object.
1526 1.12 ad */
1527 1.12 ad int
1528 1.12 ad module_find_section(const char *name, void **addr, size_t *size)
1529 1.12 ad {
1530 1.12 ad
1531 1.72 pgoyette KASSERT(kernconfig_is_held());
1532 1.12 ad KASSERT(module_active != NULL);
1533 1.12 ad
1534 1.12 ad return kobj_find_section(module_active->mod_kobj, name, addr, size);
1535 1.12 ad }
1536 1.26 ad
1537 1.26 ad /*
1538 1.26 ad * module_thread:
1539 1.26 ad *
1540 1.26 ad * Automatically unload modules. We try once to unload autoloaded
1541 1.26 ad * modules after module_autotime seconds. If the system is under
1542 1.94 pgoyette * severe memory pressure, we'll try unloading all modules, else if
1543 1.94 pgoyette * module_autotime is zero, we don't try to unload, even if the
1544 1.94 pgoyette * module was previously scheduled for unload.
1545 1.26 ad */
1546 1.26 ad static void
1547 1.26 ad module_thread(void *cookie)
1548 1.26 ad {
1549 1.26 ad module_t *mod, *next;
1550 1.28 ad modinfo_t *mi;
1551 1.28 ad int error;
1552 1.26 ad
1553 1.26 ad for (;;) {
1554 1.72 pgoyette kernconfig_lock();
1555 1.26 ad for (mod = TAILQ_FIRST(&module_list); mod != NULL; mod = next) {
1556 1.26 ad next = TAILQ_NEXT(mod, mod_chain);
1557 1.83 jmcneill
1558 1.83 jmcneill /* skip built-in modules */
1559 1.61 pooka if (mod->mod_source == MODULE_SOURCE_KERNEL)
1560 1.61 pooka continue;
1561 1.83 jmcneill /* skip modules that weren't auto-loaded */
1562 1.133 pgoyette if (!ISSET(mod->mod_flags, MODFLG_AUTO_LOADED))
1563 1.83 jmcneill continue;
1564 1.83 jmcneill
1565 1.37 ad if (uvmexp.free < uvmexp.freemin) {
1566 1.26 ad module_thread_ticks = hz;
1567 1.94 pgoyette } else if (module_autotime == 0 ||
1568 1.94 pgoyette mod->mod_autotime == 0) {
1569 1.26 ad continue;
1570 1.26 ad } else if (time_second < mod->mod_autotime) {
1571 1.26 ad module_thread_ticks = hz;
1572 1.26 ad continue;
1573 1.37 ad } else {
1574 1.26 ad mod->mod_autotime = 0;
1575 1.37 ad }
1576 1.83 jmcneill
1577 1.28 ad /*
1578 1.28 ad * If this module wants to avoid autounload then
1579 1.28 ad * skip it. Some modules can ping-pong in and out
1580 1.28 ad * because their use is transient but often.
1581 1.28 ad * Example: exec_script.
1582 1.28 ad */
1583 1.28 ad mi = mod->mod_info;
1584 1.28 ad error = (*mi->mi_modcmd)(MODULE_CMD_AUTOUNLOAD, NULL);
1585 1.28 ad if (error == 0 || error == ENOTTY) {
1586 1.70 pgoyette (void)module_do_unload(mi->mi_name, false);
1587 1.107 pgoyette } else
1588 1.107 pgoyette module_print("module `%s' declined to be "
1589 1.107 pgoyette "auto-unloaded error=%d", mi->mi_name,
1590 1.107 pgoyette error);
1591 1.26 ad }
1592 1.72 pgoyette kernconfig_unlock();
1593 1.26 ad
1594 1.26 ad mutex_enter(&module_thread_lock);
1595 1.26 ad (void)cv_timedwait(&module_thread_cv, &module_thread_lock,
1596 1.26 ad module_thread_ticks);
1597 1.26 ad module_thread_ticks = 0;
1598 1.26 ad mutex_exit(&module_thread_lock);
1599 1.26 ad }
1600 1.26 ad }
1601 1.26 ad
1602 1.26 ad /*
1603 1.26 ad * module_thread:
1604 1.26 ad *
1605 1.26 ad * Kick the module thread into action, perhaps because the
1606 1.26 ad * system is low on memory.
1607 1.26 ad */
1608 1.26 ad void
1609 1.26 ad module_thread_kick(void)
1610 1.26 ad {
1611 1.26 ad
1612 1.26 ad mutex_enter(&module_thread_lock);
1613 1.26 ad module_thread_ticks = hz;
1614 1.26 ad cv_broadcast(&module_thread_cv);
1615 1.26 ad mutex_exit(&module_thread_lock);
1616 1.26 ad }
1617 1.30 ad
1618 1.30 ad #ifdef DDB
1619 1.30 ad /*
1620 1.30 ad * module_whatis:
1621 1.30 ad *
1622 1.30 ad * Helper routine for DDB.
1623 1.30 ad */
1624 1.30 ad void
1625 1.30 ad module_whatis(uintptr_t addr, void (*pr)(const char *, ...))
1626 1.30 ad {
1627 1.30 ad module_t *mod;
1628 1.30 ad size_t msize;
1629 1.30 ad vaddr_t maddr;
1630 1.30 ad
1631 1.30 ad TAILQ_FOREACH(mod, &module_list, mod_chain) {
1632 1.43 ad if (mod->mod_kobj == NULL) {
1633 1.43 ad continue;
1634 1.43 ad }
1635 1.49 dyoung if (kobj_stat(mod->mod_kobj, &maddr, &msize) != 0)
1636 1.49 dyoung continue;
1637 1.30 ad if (addr < maddr || addr >= maddr + msize) {
1638 1.30 ad continue;
1639 1.30 ad }
1640 1.30 ad (*pr)("%p is %p+%zu, in kernel module `%s'\n",
1641 1.30 ad (void *)addr, (void *)maddr,
1642 1.30 ad (size_t)(addr - maddr), mod->mod_info->mi_name);
1643 1.30 ad }
1644 1.30 ad }
1645 1.30 ad
1646 1.30 ad /*
1647 1.30 ad * module_print_list:
1648 1.30 ad *
1649 1.30 ad * Helper routine for DDB.
1650 1.30 ad */
1651 1.30 ad void
1652 1.30 ad module_print_list(void (*pr)(const char *, ...))
1653 1.30 ad {
1654 1.30 ad const char *src;
1655 1.30 ad module_t *mod;
1656 1.30 ad size_t msize;
1657 1.30 ad vaddr_t maddr;
1658 1.30 ad
1659 1.30 ad (*pr)("%16s %16s %8s %8s\n", "NAME", "TEXT/DATA", "SIZE", "SOURCE");
1660 1.30 ad
1661 1.30 ad TAILQ_FOREACH(mod, &module_list, mod_chain) {
1662 1.30 ad switch (mod->mod_source) {
1663 1.30 ad case MODULE_SOURCE_KERNEL:
1664 1.30 ad src = "builtin";
1665 1.30 ad break;
1666 1.30 ad case MODULE_SOURCE_FILESYS:
1667 1.30 ad src = "filesys";
1668 1.30 ad break;
1669 1.30 ad case MODULE_SOURCE_BOOT:
1670 1.30 ad src = "boot";
1671 1.30 ad break;
1672 1.30 ad default:
1673 1.30 ad src = "unknown";
1674 1.30 ad break;
1675 1.30 ad }
1676 1.49 dyoung if (mod->mod_kobj == NULL) {
1677 1.43 ad maddr = 0;
1678 1.43 ad msize = 0;
1679 1.49 dyoung } else if (kobj_stat(mod->mod_kobj, &maddr, &msize) != 0)
1680 1.49 dyoung continue;
1681 1.31 ad (*pr)("%16s %16lx %8ld %8s\n", mod->mod_info->mi_name,
1682 1.30 ad (long)maddr, (long)msize, src);
1683 1.30 ad }
1684 1.30 ad }
1685 1.30 ad #endif /* DDB */
1686 1.46 jnemeth
1687 1.47 jnemeth static bool
1688 1.47 jnemeth module_merge_dicts(prop_dictionary_t existing_dict,
1689 1.47 jnemeth const prop_dictionary_t new_dict)
1690 1.47 jnemeth {
1691 1.47 jnemeth prop_dictionary_keysym_t props_keysym;
1692 1.47 jnemeth prop_object_iterator_t props_iter;
1693 1.47 jnemeth prop_object_t props_obj;
1694 1.47 jnemeth const char *props_key;
1695 1.47 jnemeth bool error;
1696 1.47 jnemeth
1697 1.52 jnemeth if (new_dict == NULL) { /* nothing to merge */
1698 1.52 jnemeth return true;
1699 1.52 jnemeth }
1700 1.52 jnemeth
1701 1.47 jnemeth error = false;
1702 1.47 jnemeth props_iter = prop_dictionary_iterator(new_dict);
1703 1.47 jnemeth if (props_iter == NULL) {
1704 1.47 jnemeth return false;
1705 1.47 jnemeth }
1706 1.47 jnemeth
1707 1.47 jnemeth while ((props_obj = prop_object_iterator_next(props_iter)) != NULL) {
1708 1.47 jnemeth props_keysym = (prop_dictionary_keysym_t)props_obj;
1709 1.47 jnemeth props_key = prop_dictionary_keysym_cstring_nocopy(props_keysym);
1710 1.47 jnemeth props_obj = prop_dictionary_get_keysym(new_dict, props_keysym);
1711 1.47 jnemeth if ((props_obj == NULL) || !prop_dictionary_set(existing_dict,
1712 1.47 jnemeth props_key, props_obj)) {
1713 1.47 jnemeth error = true;
1714 1.47 jnemeth goto out;
1715 1.47 jnemeth }
1716 1.47 jnemeth }
1717 1.47 jnemeth error = false;
1718 1.47 jnemeth
1719 1.47 jnemeth out:
1720 1.47 jnemeth prop_object_iterator_release(props_iter);
1721 1.47 jnemeth
1722 1.47 jnemeth return !error;
1723 1.47 jnemeth }
1724 1.131 chs
1725 1.131 chs /*
1726 1.131 chs * module_specific_key_create:
1727 1.131 chs *
1728 1.131 chs * Create a key for subsystem module-specific data.
1729 1.131 chs */
1730 1.131 chs specificdata_key_t
1731 1.131 chs module_specific_key_create(specificdata_key_t *keyp, specificdata_dtor_t dtor)
1732 1.131 chs {
1733 1.131 chs
1734 1.131 chs return specificdata_key_create(module_specificdata_domain, keyp, dtor);
1735 1.131 chs }
1736 1.131 chs
1737 1.131 chs /*
1738 1.131 chs * module_specific_key_delete:
1739 1.131 chs *
1740 1.131 chs * Delete a key for subsystem module-specific data.
1741 1.131 chs */
1742 1.131 chs void
1743 1.131 chs module_specific_key_delete(specificdata_key_t key)
1744 1.131 chs {
1745 1.131 chs
1746 1.131 chs return specificdata_key_delete(module_specificdata_domain, key);
1747 1.131 chs }
1748 1.131 chs
1749 1.131 chs /*
1750 1.131 chs * module_getspecific:
1751 1.131 chs *
1752 1.131 chs * Return module-specific data corresponding to the specified key.
1753 1.131 chs */
1754 1.131 chs void *
1755 1.131 chs module_getspecific(module_t *mod, specificdata_key_t key)
1756 1.131 chs {
1757 1.131 chs
1758 1.131 chs return specificdata_getspecific(module_specificdata_domain,
1759 1.131 chs &mod->mod_sdref, key);
1760 1.131 chs }
1761 1.131 chs
1762 1.131 chs /*
1763 1.131 chs * module_setspecific:
1764 1.131 chs *
1765 1.131 chs * Set module-specific data corresponding to the specified key.
1766 1.131 chs */
1767 1.131 chs void
1768 1.131 chs module_setspecific(module_t *mod, specificdata_key_t key, void *data)
1769 1.131 chs {
1770 1.131 chs
1771 1.131 chs specificdata_setspecific(module_specificdata_domain,
1772 1.131 chs &mod->mod_sdref, key, data);
1773 1.131 chs }
1774 1.131 chs
1775 1.131 chs /*
1776 1.131 chs * module_register_callbacks:
1777 1.131 chs *
1778 1.131 chs * Register a new set of callbacks to be called on module load/unload.
1779 1.131 chs * Call the load callback on each existing module.
1780 1.131 chs * Return an opaque handle for unregistering these later.
1781 1.131 chs */
1782 1.131 chs void *
1783 1.131 chs module_register_callbacks(void (*load)(struct module *),
1784 1.131 chs void (*unload)(struct module *))
1785 1.131 chs {
1786 1.131 chs struct module_callbacks *modcb;
1787 1.131 chs struct module *mod;
1788 1.131 chs
1789 1.131 chs modcb = kmem_alloc(sizeof(*modcb), KM_SLEEP);
1790 1.131 chs modcb->modcb_load = load;
1791 1.131 chs modcb->modcb_unload = unload;
1792 1.131 chs
1793 1.131 chs kernconfig_lock();
1794 1.131 chs TAILQ_INSERT_TAIL(&modcblist, modcb, modcb_list);
1795 1.131 chs TAILQ_FOREACH(mod, &module_list, mod_chain)
1796 1.131 chs load(mod);
1797 1.131 chs kernconfig_unlock();
1798 1.131 chs
1799 1.131 chs return modcb;
1800 1.131 chs }
1801 1.131 chs
1802 1.131 chs /*
1803 1.131 chs * module_unregister_callbacks:
1804 1.131 chs *
1805 1.131 chs * Unregister a previously-registered set of module load/unload callbacks.
1806 1.131 chs * Call the unload callback on each existing module.
1807 1.131 chs */
1808 1.131 chs void
1809 1.131 chs module_unregister_callbacks(void *opaque)
1810 1.131 chs {
1811 1.131 chs struct module_callbacks *modcb;
1812 1.131 chs struct module *mod;
1813 1.131 chs
1814 1.131 chs modcb = opaque;
1815 1.131 chs kernconfig_lock();
1816 1.131 chs TAILQ_FOREACH(mod, &module_list, mod_chain)
1817 1.131 chs modcb->modcb_unload(mod);
1818 1.131 chs TAILQ_REMOVE(&modcblist, modcb, modcb_list);
1819 1.131 chs kernconfig_unlock();
1820 1.131 chs kmem_free(modcb, sizeof(*modcb));
1821 1.131 chs }
1822 1.131 chs
1823 1.131 chs /*
1824 1.131 chs * module_callback_load:
1825 1.131 chs *
1826 1.131 chs * Helper routine: call all load callbacks on a module being loaded.
1827 1.131 chs */
1828 1.131 chs static void
1829 1.131 chs module_callback_load(struct module *mod)
1830 1.131 chs {
1831 1.131 chs struct module_callbacks *modcb;
1832 1.131 chs
1833 1.131 chs TAILQ_FOREACH(modcb, &modcblist, modcb_list) {
1834 1.131 chs modcb->modcb_load(mod);
1835 1.131 chs }
1836 1.131 chs }
1837 1.131 chs
1838 1.131 chs /*
1839 1.131 chs * module_callback_unload:
1840 1.131 chs *
1841 1.131 chs * Helper routine: call all unload callbacks on a module being unloaded.
1842 1.131 chs */
1843 1.131 chs static void
1844 1.131 chs module_callback_unload(struct module *mod)
1845 1.131 chs {
1846 1.131 chs struct module_callbacks *modcb;
1847 1.131 chs
1848 1.131 chs TAILQ_FOREACH(modcb, &modcblist, modcb_list) {
1849 1.131 chs modcb->modcb_unload(mod);
1850 1.131 chs }
1851 1.131 chs }
1852