2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 1997-2000 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
32 #include "opt_hwpmc_hooks.h"
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/boottrace.h>
37 #include <sys/eventhandler.h>
38 #include <sys/fcntl.h>
40 #include <sys/kernel.h>
41 #include <sys/libkern.h>
42 #include <sys/linker.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/mount.h>
47 #include <sys/mutex.h>
48 #include <sys/namei.h>
52 #include <sys/syscallsubr.h>
53 #include <sys/sysctl.h>
54 #include <sys/sysproto.h>
55 #include <sys/vnode.h>
63 #include <security/mac/mac_framework.h>
65 #include "linker_if.h"
68 #include <sys/pmckern.h>
73 SYSCTL_INT(_debug, OID_AUTO, kld_debug, CTLFLAG_RWTUN,
74 &kld_debug, 0, "Set various levels of KLD debug");
77 /* These variables are used by kernel debuggers to enumerate loaded files. */
78 const int kld_off_address = offsetof(struct linker_file, address);
79 const int kld_off_filename = offsetof(struct linker_file, filename);
80 const int kld_off_pathname = offsetof(struct linker_file, pathname);
81 const int kld_off_next = offsetof(struct linker_file, link.tqe_next);
84 * static char *linker_search_path(const char *name, struct mod_depend
87 static const char *linker_basename(const char *path);
90 * Find a currently loaded file given its filename.
92 static linker_file_t linker_find_file_by_name(const char* _filename);
95 * Find a currently loaded file given its file id.
97 static linker_file_t linker_find_file_by_id(int _fileid);
99 /* Metadata from the static kernel */
100 SET_DECLARE(modmetadata_set, struct mod_metadata);
102 MALLOC_DEFINE(M_LINKER, "linker", "kernel linker");
104 linker_file_t linker_kernel_file;
106 static struct sx kld_sx; /* kernel linker lock */
107 static u_int kld_busy;
108 static struct thread *kld_busy_owner;
111 * Load counter used by clients to determine if a linker file has been
112 * re-loaded. This counter is incremented for each file load.
116 static linker_class_list_t classes;
117 static linker_file_list_t linker_files;
118 static int next_file_id = 1;
119 static int linker_no_more_classes = 0;
121 #define LINKER_GET_NEXT_FILE_ID(a) do { \
122 linker_file_t lftmp; \
125 sx_assert(&kld_sx, SA_XLOCKED); \
127 TAILQ_FOREACH(lftmp, &linker_files, link) { \
128 if (next_file_id == lftmp->id) { \
133 (a) = next_file_id; \
136 /* XXX wrong name; we're looking at version provision tags here, not modules */
137 typedef TAILQ_HEAD(, modlist) modlisthead_t;
139 TAILQ_ENTRY(modlist) link; /* chain together all modules */
140 linker_file_t container;
144 typedef struct modlist *modlist_t;
145 static modlisthead_t found_modules;
147 static int linker_file_add_dependency(linker_file_t file,
149 static caddr_t linker_file_lookup_symbol_internal(linker_file_t file,
150 const char* name, int deps);
151 static int linker_load_module(const char *kldname,
152 const char *modname, struct linker_file *parent,
153 const struct mod_depend *verinfo, struct linker_file **lfpp);
154 static modlist_t modlist_lookup2(const char *name, const struct mod_depend *verinfo);
157 linker_init(void *arg)
160 sx_init(&kld_sx, "kernel linker");
161 TAILQ_INIT(&classes);
162 TAILQ_INIT(&linker_files);
165 SYSINIT(linker, SI_SUB_KLD, SI_ORDER_FIRST, linker_init, NULL);
168 linker_stop_class_add(void *arg)
171 linker_no_more_classes = 1;
174 SYSINIT(linker_class, SI_SUB_KLD, SI_ORDER_ANY, linker_stop_class_add, NULL);
177 linker_add_class(linker_class_t lc)
181 * We disallow any class registration past SI_ORDER_ANY
182 * of SI_SUB_KLD. We bump the reference count to keep the
183 * ops from being freed.
185 if (linker_no_more_classes == 1)
187 kobj_class_compile((kobj_class_t) lc);
188 ((kobj_class_t)lc)->refs++; /* XXX: kobj_mtx */
189 TAILQ_INSERT_TAIL(&classes, lc, link);
194 linker_file_sysinit(linker_file_t lf)
196 struct sysinit **start, **stop, **sipp, **xipp, *save;
199 KLD_DPF(FILE, ("linker_file_sysinit: calling SYSINITs for %s\n",
202 sx_assert(&kld_sx, SA_XLOCKED);
204 if (linker_file_lookup_set(lf, "sysinit_set", &start, &stop, NULL) != 0)
207 * Perform a bubble sort of the system initialization objects by
208 * their subsystem (primary key) and order (secondary key).
210 * Since some things care about execution order, this is the operation
211 * which ensures continued function.
213 for (sipp = start; sipp < stop; sipp++) {
214 for (xipp = sipp + 1; xipp < stop; xipp++) {
215 if ((*sipp)->subsystem < (*xipp)->subsystem ||
216 ((*sipp)->subsystem == (*xipp)->subsystem &&
217 (*sipp)->order <= (*xipp)->order))
226 * Traverse the (now) ordered list of system initialization tasks.
227 * Perform each task, and continue on to the next task.
232 for (sipp = start; sipp < stop; sipp++) {
233 if ((*sipp)->subsystem == SI_SUB_DUMMY)
234 continue; /* skip dummy task(s) */
236 if ((*sipp)->subsystem > last)
237 BOOTTRACE("%s: sysinit 0x%7x", lf->filename,
241 (*((*sipp)->func)) ((*sipp)->udata);
242 last = (*sipp)->subsystem;
249 linker_file_sysuninit(linker_file_t lf)
251 struct sysinit **start, **stop, **sipp, **xipp, *save;
254 KLD_DPF(FILE, ("linker_file_sysuninit: calling SYSUNINITs for %s\n",
257 sx_assert(&kld_sx, SA_XLOCKED);
259 if (linker_file_lookup_set(lf, "sysuninit_set", &start, &stop,
264 * Perform a reverse bubble sort of the system initialization objects
265 * by their subsystem (primary key) and order (secondary key).
267 * Since some things care about execution order, this is the operation
268 * which ensures continued function.
270 for (sipp = start; sipp < stop; sipp++) {
271 for (xipp = sipp + 1; xipp < stop; xipp++) {
272 if ((*sipp)->subsystem > (*xipp)->subsystem ||
273 ((*sipp)->subsystem == (*xipp)->subsystem &&
274 (*sipp)->order >= (*xipp)->order))
283 * Traverse the (now) ordered list of system initialization tasks.
284 * Perform each task, and continue on to the next task.
289 for (sipp = start; sipp < stop; sipp++) {
290 if ((*sipp)->subsystem == SI_SUB_DUMMY)
291 continue; /* skip dummy task(s) */
293 if ((*sipp)->subsystem > last)
294 BOOTTRACE("%s: sysuninit 0x%7x", lf->filename,
298 (*((*sipp)->func)) ((*sipp)->udata);
299 last = (*sipp)->subsystem;
306 linker_file_register_sysctls(linker_file_t lf, bool enable)
308 struct sysctl_oid **start, **stop, **oidp;
311 ("linker_file_register_sysctls: registering SYSCTLs for %s\n",
314 sx_assert(&kld_sx, SA_XLOCKED);
316 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
321 for (oidp = start; oidp < stop; oidp++) {
323 sysctl_register_oid(*oidp);
325 sysctl_register_disabled_oid(*oidp);
332 linker_file_enable_sysctls(linker_file_t lf)
334 struct sysctl_oid **start, **stop, **oidp;
337 ("linker_file_enable_sysctls: enable SYSCTLs for %s\n",
340 sx_assert(&kld_sx, SA_XLOCKED);
342 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
347 for (oidp = start; oidp < stop; oidp++)
348 sysctl_enable_oid(*oidp);
354 linker_file_unregister_sysctls(linker_file_t lf)
356 struct sysctl_oid **start, **stop, **oidp;
358 KLD_DPF(FILE, ("linker_file_unregister_sysctls: unregistering SYSCTLs"
359 " for %s\n", lf->filename));
361 sx_assert(&kld_sx, SA_XLOCKED);
363 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
368 for (oidp = start; oidp < stop; oidp++)
369 sysctl_unregister_oid(*oidp);
375 linker_file_register_modules(linker_file_t lf)
377 struct mod_metadata **start, **stop, **mdp;
378 const moduledata_t *moddata;
379 int first_error, error;
381 KLD_DPF(FILE, ("linker_file_register_modules: registering modules"
382 " in %s\n", lf->filename));
384 sx_assert(&kld_sx, SA_XLOCKED);
386 if (linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop, NULL) != 0) {
388 * This fallback should be unnecessary, but if we get booted
389 * from boot2 instead of loader and we are missing our
390 * metadata then we have to try the best we can.
392 if (lf == linker_kernel_file) {
393 start = SET_BEGIN(modmetadata_set);
394 stop = SET_LIMIT(modmetadata_set);
399 for (mdp = start; mdp < stop; mdp++) {
400 if ((*mdp)->md_type != MDT_MODULE)
402 moddata = (*mdp)->md_data;
403 KLD_DPF(FILE, ("Registering module %s in %s\n",
404 moddata->name, lf->filename));
405 error = module_register(moddata, lf);
407 printf("Module %s failed to register: %d\n",
408 moddata->name, error);
409 if (first_error == 0)
413 return (first_error);
417 linker_init_kernel_modules(void)
421 linker_file_register_modules(linker_kernel_file);
425 SYSINIT(linker_kernel, SI_SUB_KLD, SI_ORDER_ANY, linker_init_kernel_modules,
429 linker_load_file(const char *filename, linker_file_t *result)
433 int foundfile, error, modules;
435 /* Refuse to load modules if securelevel raised */
436 if (prison0.pr_securelevel > 0)
439 sx_assert(&kld_sx, SA_XLOCKED);
440 lf = linker_find_file_by_name(filename);
442 KLD_DPF(FILE, ("linker_load_file: file %s is already loaded,"
443 " incrementing refs\n", filename));
452 * We do not need to protect (lock) classes here because there is
453 * no class registration past startup (SI_SUB_KLD, SI_ORDER_ANY)
454 * and there is no class deregistration mechanism at this time.
456 TAILQ_FOREACH(lc, &classes, link) {
457 KLD_DPF(FILE, ("linker_load_file: trying to load %s\n",
459 error = LINKER_LOAD_FILE(lc, filename, &lf);
461 * If we got something other than ENOENT, then it exists but
462 * we cannot load it for some other reason.
467 error = linker_file_register_modules(lf);
468 if (error == EEXIST) {
469 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
472 modules = !TAILQ_EMPTY(&lf->modules);
473 linker_file_register_sysctls(lf, false);
474 linker_file_sysinit(lf);
475 lf->flags |= LINKER_FILE_LINKED;
478 * If all of the modules in this file failed
479 * to load, unload the file and return an
482 if (modules && TAILQ_EMPTY(&lf->modules)) {
483 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
486 linker_file_enable_sysctls(lf);
487 EVENTHANDLER_INVOKE(kld_load, lf);
493 * Less than ideal, but tells the user whether it failed to load or
494 * the module was not found.
498 * If the file type has not been recognized by the last try
499 * printout a message before to fail.
502 printf("%s: %s - unsupported file type\n",
506 * Format not recognized or otherwise unloadable.
507 * When loading a module that is statically built into
508 * the kernel EEXIST percolates back up as the return
509 * value. Preserve this so that apps like sysinstall
510 * can recognize this special case and not post bogus
516 error = ENOENT; /* Nothing found */
521 linker_reference_module(const char *modname, struct mod_depend *verinfo,
522 linker_file_t *result)
528 if ((mod = modlist_lookup2(modname, verinfo)) != NULL) {
529 *result = mod->container;
535 error = linker_load_module(NULL, modname, NULL, verinfo, result);
541 linker_release_module(const char *modname, struct mod_depend *verinfo,
549 KASSERT(modname != NULL,
550 ("linker_release_module: no file or name"));
551 mod = modlist_lookup2(modname, verinfo);
558 KASSERT(modname == NULL && verinfo == NULL,
559 ("linker_release_module: both file and name"));
560 error = linker_file_unload(lf, LINKER_UNLOAD_NORMAL);
566 linker_find_file_by_name(const char *filename)
571 koname = malloc(strlen(filename) + 4, M_LINKER, M_WAITOK);
572 sprintf(koname, "%s.ko", filename);
574 sx_assert(&kld_sx, SA_XLOCKED);
575 TAILQ_FOREACH(lf, &linker_files, link) {
576 if (strcmp(lf->filename, koname) == 0)
578 if (strcmp(lf->filename, filename) == 0)
581 free(koname, M_LINKER);
586 linker_find_file_by_id(int fileid)
590 sx_assert(&kld_sx, SA_XLOCKED);
591 TAILQ_FOREACH(lf, &linker_files, link)
592 if (lf->id == fileid && lf->flags & LINKER_FILE_LINKED)
598 linker_file_foreach(linker_predicate_t *predicate, void *context)
604 TAILQ_FOREACH(lf, &linker_files, link) {
605 retval = predicate(lf, context);
614 linker_make_file(const char *pathname, linker_class_t lc)
617 const char *filename;
620 sx_assert(&kld_sx, SA_XLOCKED);
621 filename = linker_basename(pathname);
623 KLD_DPF(FILE, ("linker_make_file: new file, filename='%s' for pathname='%s'\n", filename, pathname));
624 lf = (linker_file_t)kobj_create((kobj_class_t)lc, M_LINKER, M_WAITOK);
634 lf->filename = strdup(filename, M_LINKER);
635 lf->pathname = strdup(pathname, M_LINKER);
636 LINKER_GET_NEXT_FILE_ID(lf->id);
639 lf->loadcnt = ++loadcnt;
644 STAILQ_INIT(&lf->common);
645 TAILQ_INIT(&lf->modules);
646 TAILQ_INSERT_TAIL(&linker_files, lf, link);
651 linker_file_unload(linker_file_t file, int flags)
654 modlist_t ml, nextml;
655 struct common_symbol *cp;
658 /* Refuse to unload modules if securelevel raised. */
659 if (prison0.pr_securelevel > 0)
662 sx_assert(&kld_sx, SA_XLOCKED);
663 KLD_DPF(FILE, ("linker_file_unload: lf->refs=%d\n", file->refs));
665 /* Easy case of just dropping a reference. */
666 if (file->refs > 1) {
671 /* Give eventhandlers a chance to prevent the unload. */
673 EVENTHANDLER_INVOKE(kld_unload_try, file, &error);
677 KLD_DPF(FILE, ("linker_file_unload: file is unloading,"
678 " informing modules\n"));
681 * Quiesce all the modules to give them a chance to veto the unload.
684 for (mod = TAILQ_FIRST(&file->modules); mod;
685 mod = module_getfnext(mod)) {
686 error = module_quiesce(mod);
687 if (error != 0 && flags != LINKER_UNLOAD_FORCE) {
688 KLD_DPF(FILE, ("linker_file_unload: module %s"
689 " vetoed unload\n", module_getname(mod)));
691 * XXX: Do we need to tell all the quiesced modules
692 * that they can resume work now via a new module
702 * Inform any modules associated with this file that they are
706 for (mod = TAILQ_FIRST(&file->modules); mod; mod = next) {
707 next = module_getfnext(mod);
711 * Give the module a chance to veto the unload.
713 if ((error = module_unload(mod)) != 0) {
716 KLD_DPF(FILE, ("linker_file_unload: module %s"
717 " failed unload\n", module_getname(mod)));
727 TAILQ_FOREACH_SAFE(ml, &found_modules, link, nextml) {
728 if (ml->container == file) {
729 TAILQ_REMOVE(&found_modules, ml, link);
735 * Don't try to run SYSUNINITs if we are unloaded due to a
738 if (file->flags & LINKER_FILE_LINKED) {
739 file->flags &= ~LINKER_FILE_LINKED;
740 linker_file_unregister_sysctls(file);
741 linker_file_sysuninit(file);
743 TAILQ_REMOVE(&linker_files, file, link);
746 for (i = 0; i < file->ndeps; i++)
747 linker_file_unload(file->deps[i], flags);
748 free(file->deps, M_LINKER);
751 while ((cp = STAILQ_FIRST(&file->common)) != NULL) {
752 STAILQ_REMOVE_HEAD(&file->common, link);
758 EVENTHANDLER_INVOKE(kld_unload, file->filename, file->address,
761 if (file->filename) {
762 free(file->filename, M_LINKER);
763 file->filename = NULL;
765 if (file->pathname) {
766 free(file->pathname, M_LINKER);
767 file->pathname = NULL;
769 kobj_delete((kobj_t) file, M_LINKER);
774 linker_ctf_get(linker_file_t file, linker_ctf_t *lc)
776 return (LINKER_CTF_GET(file, lc));
780 linker_file_add_dependency(linker_file_t file, linker_file_t dep)
782 linker_file_t *newdeps;
784 sx_assert(&kld_sx, SA_XLOCKED);
785 file->deps = realloc(file->deps, (file->ndeps + 1) * sizeof(*newdeps),
786 M_LINKER, M_WAITOK | M_ZERO);
787 file->deps[file->ndeps] = dep;
789 KLD_DPF(FILE, ("linker_file_add_dependency:"
790 " adding %s as dependency for %s\n",
791 dep->filename, file->filename));
796 * Locate a linker set and its contents. This is a helper function to avoid
797 * linker_if.h exposure elsewhere. Note: firstp and lastp are really void **.
798 * This function is used in this file so we can avoid having lots of (void **)
802 linker_file_lookup_set(linker_file_t file, const char *name,
803 void *firstp, void *lastp, int *countp)
806 sx_assert(&kld_sx, SA_LOCKED);
807 return (LINKER_LOOKUP_SET(file, name, firstp, lastp, countp));
811 * List all functions in a file.
814 linker_file_function_listall(linker_file_t lf,
815 linker_function_nameval_callback_t callback_func, void *arg)
817 return (LINKER_EACH_FUNCTION_NAMEVAL(lf, callback_func, arg));
821 linker_file_lookup_symbol(linker_file_t file, const char *name, int deps)
826 locked = sx_xlocked(&kld_sx);
829 sym = linker_file_lookup_symbol_internal(file, name, deps);
836 linker_file_lookup_symbol_internal(linker_file_t file, const char *name,
840 linker_symval_t symval;
842 size_t common_size = 0;
845 sx_assert(&kld_sx, SA_XLOCKED);
846 KLD_DPF(SYM, ("linker_file_lookup_symbol: file=%p, name=%s, deps=%d\n",
849 if (LINKER_LOOKUP_SYMBOL(file, name, &sym) == 0) {
850 LINKER_SYMBOL_VALUES(file, sym, &symval);
851 if (symval.value == 0)
853 * For commons, first look them up in the
854 * dependencies and only allocate space if not found
857 common_size = symval.size;
859 KLD_DPF(SYM, ("linker_file_lookup_symbol: symbol"
860 ".value=%p\n", symval.value));
861 return (symval.value);
865 for (i = 0; i < file->ndeps; i++) {
866 address = linker_file_lookup_symbol_internal(
867 file->deps[i], name, 0);
869 KLD_DPF(SYM, ("linker_file_lookup_symbol:"
870 " deps value=%p\n", address));
875 if (common_size > 0) {
877 * This is a common symbol which was not found in the
878 * dependencies. We maintain a simple common symbol table in
881 struct common_symbol *cp;
883 STAILQ_FOREACH(cp, &file->common, link) {
884 if (strcmp(cp->name, name) == 0) {
885 KLD_DPF(SYM, ("linker_file_lookup_symbol:"
886 " old common value=%p\n", cp->address));
887 return (cp->address);
891 * Round the symbol size up to align.
893 common_size = (common_size + sizeof(int) - 1) & -sizeof(int);
894 cp = malloc(sizeof(struct common_symbol)
895 + common_size + strlen(name) + 1, M_LINKER,
897 cp->address = (caddr_t)(cp + 1);
898 cp->name = cp->address + common_size;
899 strcpy(cp->name, name);
900 bzero(cp->address, common_size);
901 STAILQ_INSERT_TAIL(&file->common, cp, link);
903 KLD_DPF(SYM, ("linker_file_lookup_symbol: new common"
904 " value=%p\n", cp->address));
905 return (cp->address);
907 KLD_DPF(SYM, ("linker_file_lookup_symbol: fail\n"));
912 * Both DDB and stack(9) rely on the kernel linker to provide forward and
913 * backward lookup of symbols. However, DDB and sometimes stack(9) need to
914 * do this in a lockfree manner. We provide a set of internal helper
915 * routines to perform these operations without locks, and then wrappers that
918 * linker_debug_lookup() is ifdef DDB as currently it's only used by DDB.
922 linker_debug_lookup(const char *symstr, c_linker_sym_t *sym)
926 TAILQ_FOREACH(lf, &linker_files, link) {
927 if (LINKER_LOOKUP_DEBUG_SYMBOL(lf, symstr, sym) == 0)
935 linker_debug_search_symbol(caddr_t value, c_linker_sym_t *sym, long *diffp)
938 c_linker_sym_t best, es;
939 u_long diff, bestdiff, off;
942 off = (uintptr_t)value;
944 TAILQ_FOREACH(lf, &linker_files, link) {
945 if (LINKER_SEARCH_SYMBOL(lf, value, &es, &diff) != 0)
947 if (es != 0 && diff < bestdiff) {
966 linker_debug_symbol_values(c_linker_sym_t sym, linker_symval_t *symval)
970 TAILQ_FOREACH(lf, &linker_files, link) {
971 if (LINKER_DEBUG_SYMBOL_VALUES(lf, sym, symval) == 0)
978 linker_debug_search_symbol_name(caddr_t value, char *buf, u_int buflen,
981 linker_symval_t symval;
986 error = linker_debug_search_symbol(value, &sym, offset);
989 error = linker_debug_symbol_values(sym, &symval);
992 strlcpy(buf, symval.name, buflen);
997 * DDB Helpers. DDB has to look across multiple files with their own symbol
998 * tables and string tables.
1000 * Note that we do not obey list locking protocols here. We really don't need
1001 * DDB to hang because somebody's got the lock held. We'll take the chance
1002 * that the files list is inconsistent instead.
1006 linker_ddb_lookup(const char *symstr, c_linker_sym_t *sym)
1009 return (linker_debug_lookup(symstr, sym));
1014 linker_ddb_search_symbol(caddr_t value, c_linker_sym_t *sym, long *diffp)
1017 return (linker_debug_search_symbol(value, sym, diffp));
1021 linker_ddb_symbol_values(c_linker_sym_t sym, linker_symval_t *symval)
1024 return (linker_debug_symbol_values(sym, symval));
1028 linker_ddb_search_symbol_name(caddr_t value, char *buf, u_int buflen,
1032 return (linker_debug_search_symbol_name(value, buf, buflen, offset));
1036 * stack(9) helper for non-debugging environemnts. Unlike DDB helpers, we do
1037 * obey locking protocols, and offer a significantly less complex interface.
1040 linker_search_symbol_name_flags(caddr_t value, char *buf, u_int buflen,
1041 long *offset, int flags)
1045 KASSERT((flags & (M_NOWAIT | M_WAITOK)) != 0 &&
1046 (flags & (M_NOWAIT | M_WAITOK)) != (M_NOWAIT | M_WAITOK),
1047 ("%s: bad flags: 0x%x", __func__, flags));
1049 if (flags & M_NOWAIT) {
1050 if (!sx_try_slock(&kld_sx))
1051 return (EWOULDBLOCK);
1055 error = linker_debug_search_symbol_name(value, buf, buflen, offset);
1056 sx_sunlock(&kld_sx);
1061 linker_search_symbol_name(caddr_t value, char *buf, u_int buflen,
1065 return (linker_search_symbol_name_flags(value, buf, buflen, offset,
1070 linker_kldload_busy(int flags)
1074 MPASS((flags & ~(LINKER_UB_UNLOCK | LINKER_UB_LOCKED |
1075 LINKER_UB_PCATCH)) == 0);
1076 if ((flags & LINKER_UB_LOCKED) != 0)
1077 sx_assert(&kld_sx, SA_XLOCKED);
1079 if ((flags & LINKER_UB_LOCKED) == 0)
1081 while (kld_busy > 0) {
1082 if (kld_busy_owner == curthread)
1084 error = sx_sleep(&kld_busy, &kld_sx,
1085 (flags & LINKER_UB_PCATCH) != 0 ? PCATCH : 0,
1088 if ((flags & LINKER_UB_UNLOCK) != 0)
1089 sx_xunlock(&kld_sx);
1094 kld_busy_owner = curthread;
1095 if ((flags & LINKER_UB_UNLOCK) != 0)
1096 sx_xunlock(&kld_sx);
1101 linker_kldload_unbusy(int flags)
1103 MPASS((flags & ~LINKER_UB_LOCKED) == 0);
1104 if ((flags & LINKER_UB_LOCKED) != 0)
1105 sx_assert(&kld_sx, SA_XLOCKED);
1107 if ((flags & LINKER_UB_LOCKED) == 0)
1109 MPASS(kld_busy > 0);
1110 if (kld_busy_owner != curthread)
1111 panic("linker_kldload_unbusy done by not owning thread %p",
1114 if (kld_busy == 0) {
1115 kld_busy_owner = NULL;
1118 sx_xunlock(&kld_sx);
1125 kern_kldload(struct thread *td, const char *file, int *fileid)
1127 const char *kldname, *modname;
1131 if ((error = securelevel_gt(td->td_ucred, 0)) != 0)
1134 if ((error = priv_check(td, PRIV_KLD_LOAD)) != 0)
1138 * If file does not contain a qualified name or any dot in it
1139 * (kldname.ko, or kldname.ver.ko) treat it as an interface
1142 if (strchr(file, '/') || strchr(file, '.')) {
1150 error = linker_kldload_busy(LINKER_UB_PCATCH);
1152 sx_xunlock(&kld_sx);
1157 * It is possible that kldloaded module will attach a new ifnet,
1158 * so vnet context must be set when this ocurs.
1160 CURVNET_SET(TD_TO_VNET(td));
1162 error = linker_load_module(kldname, modname, NULL, NULL, &lf);
1170 linker_kldload_unbusy(LINKER_UB_LOCKED);
1175 sys_kldload(struct thread *td, struct kldload_args *uap)
1177 char *pathname = NULL;
1180 td->td_retval[0] = -1;
1182 pathname = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1183 error = copyinstr(uap->file, pathname, MAXPATHLEN, NULL);
1185 error = kern_kldload(td, pathname, &fileid);
1187 td->td_retval[0] = fileid;
1189 free(pathname, M_TEMP);
1194 kern_kldunload(struct thread *td, int fileid, int flags)
1199 if ((error = securelevel_gt(td->td_ucred, 0)) != 0)
1202 if ((error = priv_check(td, PRIV_KLD_UNLOAD)) != 0)
1205 error = linker_kldload_busy(LINKER_UB_PCATCH);
1207 sx_xunlock(&kld_sx);
1211 CURVNET_SET(TD_TO_VNET(td));
1212 lf = linker_find_file_by_id(fileid);
1214 KLD_DPF(FILE, ("kldunload: lf->userrefs=%d\n", lf->userrefs));
1216 if (lf->userrefs == 0) {
1218 * XXX: maybe LINKER_UNLOAD_FORCE should override ?
1220 printf("kldunload: attempt to unload file that was"
1221 " loaded by the kernel\n");
1225 error = linker_file_unload(lf, flags);
1232 linker_kldload_unbusy(LINKER_UB_LOCKED);
1237 sys_kldunload(struct thread *td, struct kldunload_args *uap)
1240 return (kern_kldunload(td, uap->fileid, LINKER_UNLOAD_NORMAL));
1244 sys_kldunloadf(struct thread *td, struct kldunloadf_args *uap)
1247 if (uap->flags != LINKER_UNLOAD_NORMAL &&
1248 uap->flags != LINKER_UNLOAD_FORCE)
1250 return (kern_kldunload(td, uap->fileid, uap->flags));
1254 sys_kldfind(struct thread *td, struct kldfind_args *uap)
1257 const char *filename;
1262 error = mac_kld_check_stat(td->td_ucred);
1267 td->td_retval[0] = -1;
1269 pathname = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1270 if ((error = copyinstr(uap->file, pathname, MAXPATHLEN, NULL)) != 0)
1273 filename = linker_basename(pathname);
1275 lf = linker_find_file_by_name(filename);
1277 td->td_retval[0] = lf->id;
1280 sx_xunlock(&kld_sx);
1282 free(pathname, M_TEMP);
1287 sys_kldnext(struct thread *td, struct kldnext_args *uap)
1293 error = mac_kld_check_stat(td->td_ucred);
1299 if (uap->fileid == 0)
1300 lf = TAILQ_FIRST(&linker_files);
1302 lf = linker_find_file_by_id(uap->fileid);
1307 lf = TAILQ_NEXT(lf, link);
1310 /* Skip partially loaded files. */
1311 while (lf != NULL && !(lf->flags & LINKER_FILE_LINKED))
1312 lf = TAILQ_NEXT(lf, link);
1315 td->td_retval[0] = lf->id;
1317 td->td_retval[0] = 0;
1319 sx_xunlock(&kld_sx);
1324 sys_kldstat(struct thread *td, struct kldstat_args *uap)
1326 struct kld_file_stat *stat;
1330 * Check the version of the user's structure.
1332 if ((error = copyin(&uap->stat->version, &version, sizeof(version)))
1335 if (version != sizeof(struct kld_file_stat_1) &&
1336 version != sizeof(struct kld_file_stat))
1339 stat = malloc(sizeof(*stat), M_TEMP, M_WAITOK | M_ZERO);
1340 error = kern_kldstat(td, uap->fileid, stat);
1342 error = copyout(stat, uap->stat, version);
1348 kern_kldstat(struct thread *td, int fileid, struct kld_file_stat *stat)
1355 error = mac_kld_check_stat(td->td_ucred);
1361 lf = linker_find_file_by_id(fileid);
1363 sx_xunlock(&kld_sx);
1367 /* Version 1 fields: */
1368 namelen = strlen(lf->filename) + 1;
1369 if (namelen > sizeof(stat->name))
1370 namelen = sizeof(stat->name);
1371 bcopy(lf->filename, &stat->name[0], namelen);
1372 stat->refs = lf->refs;
1374 stat->address = lf->address;
1375 stat->size = lf->size;
1376 /* Version 2 fields: */
1377 namelen = strlen(lf->pathname) + 1;
1378 if (namelen > sizeof(stat->pathname))
1379 namelen = sizeof(stat->pathname);
1380 bcopy(lf->pathname, &stat->pathname[0], namelen);
1381 sx_xunlock(&kld_sx);
1383 td->td_retval[0] = 0;
1388 DB_COMMAND_FLAGS(kldstat, db_kldstat, DB_CMD_MEMSAFE)
1392 #define POINTER_WIDTH ((int)(sizeof(void *) * 2 + 2))
1393 db_printf("Id Refs Address%*c Size Name\n", POINTER_WIDTH - 7, ' ');
1394 #undef POINTER_WIDTH
1395 TAILQ_FOREACH(lf, &linker_files, link) {
1398 db_printf("%2d %4d %p %-8zx %s\n", lf->id, lf->refs,
1399 lf->address, lf->size, lf->filename);
1405 sys_kldfirstmod(struct thread *td, struct kldfirstmod_args *uap)
1412 error = mac_kld_check_stat(td->td_ucred);
1418 lf = linker_find_file_by_id(uap->fileid);
1421 mp = TAILQ_FIRST(&lf->modules);
1423 td->td_retval[0] = module_getid(mp);
1425 td->td_retval[0] = 0;
1429 sx_xunlock(&kld_sx);
1434 sys_kldsym(struct thread *td, struct kldsym_args *uap)
1436 char *symstr = NULL;
1438 linker_symval_t symval;
1440 struct kld_sym_lookup lookup;
1444 error = mac_kld_check_stat(td->td_ucred);
1449 if ((error = copyin(uap->data, &lookup, sizeof(lookup))) != 0)
1451 if (lookup.version != sizeof(lookup) ||
1452 uap->cmd != KLDSYM_LOOKUP)
1454 symstr = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1455 if ((error = copyinstr(lookup.symname, symstr, MAXPATHLEN, NULL)) != 0)
1458 if (uap->fileid != 0) {
1459 lf = linker_find_file_by_id(uap->fileid);
1462 else if (LINKER_LOOKUP_SYMBOL(lf, symstr, &sym) == 0 &&
1463 LINKER_SYMBOL_VALUES(lf, sym, &symval) == 0) {
1464 lookup.symvalue = (uintptr_t) symval.value;
1465 lookup.symsize = symval.size;
1466 error = copyout(&lookup, uap->data, sizeof(lookup));
1470 TAILQ_FOREACH(lf, &linker_files, link) {
1471 if (LINKER_LOOKUP_SYMBOL(lf, symstr, &sym) == 0 &&
1472 LINKER_SYMBOL_VALUES(lf, sym, &symval) == 0) {
1473 lookup.symvalue = (uintptr_t)symval.value;
1474 lookup.symsize = symval.size;
1475 error = copyout(&lookup, uap->data,
1483 sx_xunlock(&kld_sx);
1485 free(symstr, M_TEMP);
1490 * Preloaded module support
1494 modlist_lookup(const char *name, int ver)
1498 TAILQ_FOREACH(mod, &found_modules, link) {
1499 if (strcmp(mod->name, name) == 0 &&
1500 (ver == 0 || mod->version == ver))
1507 modlist_lookup2(const char *name, const struct mod_depend *verinfo)
1509 modlist_t mod, bestmod;
1512 if (verinfo == NULL)
1513 return (modlist_lookup(name, 0));
1515 TAILQ_FOREACH(mod, &found_modules, link) {
1516 if (strcmp(mod->name, name) != 0)
1519 if (ver == verinfo->md_ver_preferred)
1521 if (ver >= verinfo->md_ver_minimum &&
1522 ver <= verinfo->md_ver_maximum &&
1523 (bestmod == NULL || ver > bestmod->version))
1530 modlist_newmodule(const char *modname, int version, linker_file_t container)
1534 mod = malloc(sizeof(struct modlist), M_LINKER, M_NOWAIT | M_ZERO);
1536 panic("no memory for module list");
1537 mod->container = container;
1538 mod->name = modname;
1539 mod->version = version;
1540 TAILQ_INSERT_TAIL(&found_modules, mod, link);
1545 linker_addmodules(linker_file_t lf, struct mod_metadata **start,
1546 struct mod_metadata **stop, int preload)
1548 struct mod_metadata *mp, **mdp;
1549 const char *modname;
1552 for (mdp = start; mdp < stop; mdp++) {
1554 if (mp->md_type != MDT_VERSION)
1556 modname = mp->md_cval;
1557 ver = ((const struct mod_version *)mp->md_data)->mv_version;
1558 if (modlist_lookup(modname, ver) != NULL) {
1559 printf("module %s already present!\n", modname);
1560 /* XXX what can we do? this is a build error. :-( */
1563 modlist_newmodule(modname, ver, lf);
1568 linker_preload(void *arg)
1571 const char *modname, *nmodname;
1573 linker_file_t lf, nlf;
1576 linker_file_list_t loaded_files;
1577 linker_file_list_t depended_files;
1578 struct mod_metadata *mp, *nmp;
1579 struct mod_metadata **start, **stop, **mdp, **nmdp;
1580 const struct mod_depend *verinfo;
1584 struct sysinit **si_start, **si_stop;
1586 TAILQ_INIT(&loaded_files);
1587 TAILQ_INIT(&depended_files);
1588 TAILQ_INIT(&found_modules);
1593 while ((modptr = preload_search_next_name(modptr)) != NULL) {
1594 modname = (char *)preload_search_info(modptr, MODINFO_NAME);
1595 modtype = (char *)preload_search_info(modptr, MODINFO_TYPE);
1596 if (modname == NULL) {
1597 printf("Preloaded module at %p does not have a"
1598 " name!\n", modptr);
1601 if (modtype == NULL) {
1602 printf("Preloaded module at %p does not have a type!\n",
1607 printf("Preloaded %s \"%s\" at %p.\n", modtype, modname,
1610 TAILQ_FOREACH(lc, &classes, link) {
1611 error = LINKER_LINK_PRELOAD(lc, modname, &lf);
1617 TAILQ_INSERT_TAIL(&loaded_files, lf, loaded);
1621 * First get a list of stuff in the kernel.
1623 if (linker_file_lookup_set(linker_kernel_file, MDT_SETNAME, &start,
1625 linker_addmodules(linker_kernel_file, start, stop, 1);
1628 * This is a once-off kinky bubble sort to resolve relocation
1629 * dependency requirements.
1632 TAILQ_FOREACH(lf, &loaded_files, loaded) {
1633 error = linker_file_lookup_set(lf, MDT_SETNAME, &start,
1636 * First, look to see if we would successfully link with this
1639 resolves = 1; /* unless we know otherwise */
1641 for (mdp = start; mdp < stop; mdp++) {
1643 if (mp->md_type != MDT_DEPEND)
1645 modname = mp->md_cval;
1646 verinfo = mp->md_data;
1647 for (nmdp = start; nmdp < stop; nmdp++) {
1649 if (nmp->md_type != MDT_VERSION)
1651 nmodname = nmp->md_cval;
1652 if (strcmp(modname, nmodname) == 0)
1655 if (nmdp < stop) /* it's a self reference */
1659 * ok, the module isn't here yet, we
1662 if (modlist_lookup2(modname, verinfo) == NULL)
1667 * OK, if we found our modules, we can link. So, "provide"
1668 * the modules inside and add it to the end of the link order
1673 for (mdp = start; mdp < stop; mdp++) {
1675 if (mp->md_type != MDT_VERSION)
1677 modname = mp->md_cval;
1678 nver = ((const struct mod_version *)
1679 mp->md_data)->mv_version;
1680 if (modlist_lookup(modname,
1682 printf("module %s already"
1683 " present!\n", modname);
1684 TAILQ_REMOVE(&loaded_files,
1686 linker_file_unload(lf,
1687 LINKER_UNLOAD_FORCE);
1688 /* we changed tailq next ptr */
1691 modlist_newmodule(modname, nver, lf);
1694 TAILQ_REMOVE(&loaded_files, lf, loaded);
1695 TAILQ_INSERT_TAIL(&depended_files, lf, loaded);
1697 * Since we provided modules, we need to restart the
1698 * sort so that the previous files that depend on us
1699 * have a chance. Also, we've busted the tailq next
1700 * pointer with the REMOVE.
1707 * At this point, we check to see what could not be resolved..
1709 while ((lf = TAILQ_FIRST(&loaded_files)) != NULL) {
1710 TAILQ_REMOVE(&loaded_files, lf, loaded);
1711 printf("KLD file %s is missing dependencies\n", lf->filename);
1712 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1716 * We made it. Finish off the linking in the order we determined.
1718 TAILQ_FOREACH_SAFE(lf, &depended_files, loaded, nlf) {
1719 if (linker_kernel_file) {
1720 linker_kernel_file->refs++;
1721 error = linker_file_add_dependency(lf,
1722 linker_kernel_file);
1724 panic("cannot add dependency");
1726 error = linker_file_lookup_set(lf, MDT_SETNAME, &start,
1729 for (mdp = start; mdp < stop; mdp++) {
1731 if (mp->md_type != MDT_DEPEND)
1733 modname = mp->md_cval;
1734 verinfo = mp->md_data;
1735 mod = modlist_lookup2(modname, verinfo);
1737 printf("KLD file %s - cannot find "
1738 "dependency \"%s\"\n",
1739 lf->filename, modname);
1742 /* Don't count self-dependencies */
1743 if (lf == mod->container)
1745 mod->container->refs++;
1746 error = linker_file_add_dependency(lf,
1749 panic("cannot add dependency");
1753 * Now do relocation etc using the symbol search paths
1754 * established by the dependencies
1756 error = LINKER_LINK_PRELOAD_FINISH(lf);
1758 printf("KLD file %s - could not finalize loading\n",
1762 linker_file_register_modules(lf);
1763 if (!TAILQ_EMPTY(&lf->modules))
1764 lf->flags |= LINKER_FILE_MODULES;
1765 if (linker_file_lookup_set(lf, "sysinit_set", &si_start,
1766 &si_stop, NULL) == 0)
1767 sysinit_add(si_start, si_stop);
1768 linker_file_register_sysctls(lf, true);
1769 lf->flags |= LINKER_FILE_LINKED;
1772 TAILQ_REMOVE(&depended_files, lf, loaded);
1773 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1775 sx_xunlock(&kld_sx);
1776 /* woohoo! we made it! */
1779 SYSINIT(preload, SI_SUB_KLD, SI_ORDER_MIDDLE, linker_preload, NULL);
1782 * Handle preload files that failed to load any modules.
1785 linker_preload_finish(void *arg)
1787 linker_file_t lf, nlf;
1790 TAILQ_FOREACH_SAFE(lf, &linker_files, link, nlf) {
1792 * If all of the modules in this file failed to load, unload
1793 * the file and return an error of ENOEXEC. (Parity with
1794 * linker_load_file.)
1796 if ((lf->flags & LINKER_FILE_MODULES) != 0 &&
1797 TAILQ_EMPTY(&lf->modules)) {
1798 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1802 lf->flags &= ~LINKER_FILE_MODULES;
1803 lf->userrefs++; /* so we can (try to) kldunload it */
1805 sx_xunlock(&kld_sx);
1809 * Attempt to run after all DECLARE_MODULE SYSINITs. Unfortunately they can be
1810 * scheduled at any subsystem and order, so run this as late as possible. init
1811 * becomes runnable in SI_SUB_KTHREAD_INIT, so go slightly before that.
1813 SYSINIT(preload_finish, SI_SUB_KTHREAD_INIT - 100, SI_ORDER_MIDDLE,
1814 linker_preload_finish, NULL);
1817 * Search for a not-loaded module by name.
1819 * Modules may be found in the following locations:
1821 * - preloaded (result is just the module name) - on disk (result is full path
1824 * If the module name is qualified in any way (contains path, etc.) the we
1825 * simply return a copy of it.
1827 * The search path can be manipulated via sysctl. Note that we use the ';'
1828 * character as a separator to be consistent with the bootloader.
1831 static char linker_hintfile[] = "linker.hints";
1832 static char linker_path[MAXPATHLEN] = "/boot/kernel;/boot/modules";
1834 SYSCTL_STRING(_kern, OID_AUTO, module_path, CTLFLAG_RWTUN, linker_path,
1835 sizeof(linker_path), "module load search path");
1837 TUNABLE_STR("module_path", linker_path, sizeof(linker_path));
1839 static const char * const linker_ext_list[] = {
1846 * Check if file actually exists either with or without extension listed in
1847 * the linker_ext_list. (probably should be generic for the rest of the
1851 linker_lookup_file(const char *path, int pathlen, const char *name,
1852 int namelen, struct vattr *vap)
1854 struct nameidata nd;
1855 struct thread *td = curthread; /* XXX */
1856 const char * const *cpp, *sep;
1858 int error, len, extlen, reclen, flags;
1859 __enum_uint8(vtype) type;
1862 for (cpp = linker_ext_list; *cpp; cpp++) {
1867 extlen++; /* trailing '\0' */
1868 sep = (path[pathlen - 1] != '/') ? "/" : "";
1870 reclen = pathlen + strlen(sep) + namelen + extlen + 1;
1871 result = malloc(reclen, M_LINKER, M_WAITOK);
1872 for (cpp = linker_ext_list; *cpp; cpp++) {
1873 snprintf(result, reclen, "%.*s%s%.*s%s", pathlen, path, sep,
1874 namelen, name, *cpp);
1876 * Attempt to open the file, and return the path if
1877 * we succeed and it's a regular file.
1879 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, result);
1881 error = vn_open(&nd, &flags, 0, NULL);
1884 type = nd.ni_vp->v_type;
1886 VOP_GETATTR(nd.ni_vp, vap, td->td_ucred);
1887 VOP_UNLOCK(nd.ni_vp);
1888 vn_close(nd.ni_vp, FREAD, td->td_ucred, td);
1893 free(result, M_LINKER);
1897 #define INT_ALIGN(base, ptr) ptr = \
1898 (base) + roundup2((ptr) - (base), sizeof(int))
1901 * Lookup KLD which contains requested module in the "linker.hints" file. If
1902 * version specification is available, then try to find the best KLD.
1903 * Otherwise just find the latest one.
1906 linker_hints_lookup(const char *path, int pathlen, const char *modname,
1907 int modnamelen, const struct mod_depend *verinfo)
1909 struct thread *td = curthread; /* XXX */
1910 struct ucred *cred = td ? td->td_ucred : NULL;
1911 struct nameidata nd;
1912 struct vattr vattr, mattr;
1913 const char *best, *sep;
1914 u_char *hints = NULL;
1915 u_char *cp, *recptr, *bufend, *result, *pathbuf;
1916 int error, ival, bestver, *intp, found, flags, clen, blen;
1920 bestver = found = 0;
1922 sep = (path[pathlen - 1] != '/') ? "/" : "";
1923 reclen = imax(modnamelen, strlen(linker_hintfile)) + pathlen +
1925 pathbuf = malloc(reclen, M_LINKER, M_WAITOK);
1926 snprintf(pathbuf, reclen, "%.*s%s%s", pathlen, path, sep,
1929 NDINIT(&nd, LOOKUP, NOFOLLOW, UIO_SYSSPACE, pathbuf);
1931 error = vn_open(&nd, &flags, 0, NULL);
1935 if (nd.ni_vp->v_type != VREG)
1938 error = VOP_GETATTR(nd.ni_vp, &vattr, cred);
1942 * XXX: we need to limit this number to some reasonable value
1944 if (vattr.va_size > LINKER_HINTS_MAX) {
1945 printf("linker.hints file too large %ld\n", (long)vattr.va_size);
1948 hints = malloc(vattr.va_size, M_TEMP, M_WAITOK);
1949 error = vn_rdwr(UIO_READ, nd.ni_vp, (caddr_t)hints, vattr.va_size, 0,
1950 UIO_SYSSPACE, IO_NODELOCKED, cred, NOCRED, &reclen, td);
1953 VOP_UNLOCK(nd.ni_vp);
1954 vn_close(nd.ni_vp, FREAD, cred, td);
1957 printf("can't read %zd\n", reclen);
1960 intp = (int *)hints;
1962 if (ival != LINKER_HINTS_VERSION) {
1963 printf("linker.hints file version mismatch %d\n", ival);
1966 bufend = hints + vattr.va_size;
1967 recptr = (u_char *)intp;
1969 while (recptr < bufend && !found) {
1970 intp = (int *)recptr;
1977 if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
1980 INT_ALIGN(hints, cp);
1984 if (verinfo == NULL ||
1985 ival == verinfo->md_ver_preferred) {
1989 if (ival >= verinfo->md_ver_minimum &&
1990 ival <= verinfo->md_ver_maximum &&
2000 recptr += reclen + sizeof(int);
2003 * Finally check if KLD is in the place
2006 result = linker_lookup_file(path, pathlen, cp, clen, &mattr);
2008 result = linker_lookup_file(path, pathlen, best, blen, &mattr);
2011 * KLD is newer than hints file. What we should do now?
2013 if (result && timespeccmp(&mattr.va_mtime, &vattr.va_mtime, >))
2014 printf("warning: KLD '%s' is newer than the linker.hints"
2017 free(pathbuf, M_LINKER);
2019 free(hints, M_TEMP);
2020 if (nd.ni_vp != NULL) {
2021 VOP_UNLOCK(nd.ni_vp);
2022 vn_close(nd.ni_vp, FREAD, cred, td);
2025 * If nothing found or hints is absent - fallback to the old
2026 * way by using "kldname[.ko]" as module name.
2028 if (!found && !bestver && result == NULL)
2029 result = linker_lookup_file(path, pathlen, modname,
2035 * Lookup KLD which contains requested module in the all directories.
2038 linker_search_module(const char *modname, int modnamelen,
2039 const struct mod_depend *verinfo)
2041 char *cp, *ep, *result;
2044 * traverse the linker path
2046 for (cp = linker_path; *cp; cp = ep + 1) {
2047 /* find the end of this component */
2048 for (ep = cp; (*ep != 0) && (*ep != ';'); ep++);
2049 result = linker_hints_lookup(cp, ep - cp, modname,
2050 modnamelen, verinfo);
2060 * Search for module in all directories listed in the linker_path.
2063 linker_search_kld(const char *name)
2065 char *cp, *ep, *result;
2068 /* qualified at all? */
2069 if (strchr(name, '/'))
2070 return (strdup(name, M_LINKER));
2072 /* traverse the linker path */
2074 for (ep = linker_path; *ep; ep++) {
2076 /* find the end of this component */
2077 for (; *ep != 0 && *ep != ';'; ep++);
2078 result = linker_lookup_file(cp, ep - cp, name, len, NULL);
2086 linker_basename(const char *path)
2088 const char *filename;
2090 filename = strrchr(path, '/');
2091 if (filename == NULL)
2100 * Inform hwpmc about the set of kernel modules currently loaded.
2103 linker_hwpmc_list_objects(void)
2106 struct pmckern_map_in *kobase;
2111 TAILQ_FOREACH(lf, &linker_files, link)
2114 /* Allocate nmappings + 1 entries. */
2115 kobase = malloc((nmappings + 1) * sizeof(struct pmckern_map_in),
2116 M_LINKER, M_WAITOK | M_ZERO);
2118 TAILQ_FOREACH(lf, &linker_files, link) {
2119 /* Save the info for this linker file. */
2120 kobase[i].pm_file = lf->pathname;
2121 kobase[i].pm_address = (uintptr_t)lf->address;
2124 sx_sunlock(&kld_sx);
2126 KASSERT(i > 0, ("linker_hpwmc_list_objects: no kernel objects?"));
2128 /* The last entry of the malloced area comprises of all zeros. */
2129 KASSERT(kobase[i].pm_file == NULL,
2130 ("linker_hwpmc_list_objects: last object not NULL"));
2132 return ((void *)kobase);
2136 /* check if root file system is not mounted */
2138 linker_root_mounted(void)
2143 if (rootvnode == NULL)
2146 pwd = pwd_hold(curthread);
2147 ret = pwd->pwd_rdir != NULL;
2153 * Find a file which contains given module and load it, if "parent" is not
2154 * NULL, register a reference to it.
2157 linker_load_module(const char *kldname, const char *modname,
2158 struct linker_file *parent, const struct mod_depend *verinfo,
2159 struct linker_file **lfpp)
2161 linker_file_t lfdep;
2162 const char *filename;
2166 sx_assert(&kld_sx, SA_XLOCKED);
2167 if (modname == NULL) {
2169 * We have to load KLD
2171 KASSERT(verinfo == NULL, ("linker_load_module: verinfo"
2173 if (!linker_root_mounted())
2175 pathname = linker_search_kld(kldname);
2177 if (modlist_lookup2(modname, verinfo) != NULL)
2179 if (!linker_root_mounted())
2181 if (kldname != NULL)
2182 pathname = strdup(kldname, M_LINKER);
2185 * Need to find a KLD with required module
2187 pathname = linker_search_module(modname,
2188 strlen(modname), verinfo);
2190 if (pathname == NULL)
2194 * Can't load more than one file with the same basename XXX:
2195 * Actually it should be possible to have multiple KLDs with
2196 * the same basename but different path because they can
2197 * provide different versions of the same modules.
2199 filename = linker_basename(pathname);
2200 if (linker_find_file_by_name(filename))
2203 error = linker_load_file(pathname, &lfdep);
2206 if (modname && verinfo &&
2207 modlist_lookup2(modname, verinfo) == NULL) {
2208 linker_file_unload(lfdep, LINKER_UNLOAD_FORCE);
2213 error = linker_file_add_dependency(parent, lfdep);
2220 free(pathname, M_LINKER);
2225 * This routine is responsible for finding dependencies of userland initiated
2226 * kldload(2)'s of files.
2229 linker_load_dependencies(linker_file_t lf)
2231 linker_file_t lfdep;
2232 struct mod_metadata **start, **stop, **mdp, **nmdp;
2233 struct mod_metadata *mp, *nmp;
2234 const struct mod_depend *verinfo;
2236 const char *modname, *nmodname;
2240 * All files are dependent on /kernel.
2242 sx_assert(&kld_sx, SA_XLOCKED);
2243 if (linker_kernel_file) {
2244 linker_kernel_file->refs++;
2245 error = linker_file_add_dependency(lf, linker_kernel_file);
2249 if (linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop,
2252 for (mdp = start; mdp < stop; mdp++) {
2254 if (mp->md_type != MDT_VERSION)
2256 modname = mp->md_cval;
2257 ver = ((const struct mod_version *)mp->md_data)->mv_version;
2258 mod = modlist_lookup(modname, ver);
2260 printf("interface %s.%d already present in the KLD"
2261 " '%s'!\n", modname, ver,
2262 mod->container->filename);
2267 for (mdp = start; mdp < stop; mdp++) {
2269 if (mp->md_type != MDT_DEPEND)
2271 modname = mp->md_cval;
2272 verinfo = mp->md_data;
2274 for (nmdp = start; nmdp < stop; nmdp++) {
2276 if (nmp->md_type != MDT_VERSION)
2278 nmodname = nmp->md_cval;
2279 if (strcmp(modname, nmodname) == 0)
2282 if (nmdp < stop)/* early exit, it's a self reference */
2284 mod = modlist_lookup2(modname, verinfo);
2285 if (mod) { /* woohoo, it's loaded already */
2286 lfdep = mod->container;
2288 error = linker_file_add_dependency(lf, lfdep);
2293 error = linker_load_module(NULL, modname, lf, verinfo, NULL);
2295 printf("KLD %s: depends on %s - not available or"
2296 " version mismatch\n", lf->filename, modname);
2303 linker_addmodules(lf, start, stop, 0);
2308 sysctl_kern_function_list_iterate(const char *name, void *opaque)
2310 struct sysctl_req *req;
2313 return (SYSCTL_OUT(req, name, strlen(name) + 1));
2317 * Export a nul-separated, double-nul-terminated list of all function names
2321 sysctl_kern_function_list(SYSCTL_HANDLER_ARGS)
2327 error = mac_kld_check_stat(req->td->td_ucred);
2331 error = sysctl_wire_old_buffer(req, 0);
2335 TAILQ_FOREACH(lf, &linker_files, link) {
2336 error = LINKER_EACH_FUNCTION_NAME(lf,
2337 sysctl_kern_function_list_iterate, req);
2339 sx_xunlock(&kld_sx);
2343 sx_xunlock(&kld_sx);
2344 return (SYSCTL_OUT(req, "", 1));
2347 SYSCTL_PROC(_kern, OID_AUTO, function_list,
2348 CTLTYPE_OPAQUE | CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, 0,
2349 sysctl_kern_function_list, "",
2350 "kernel function list");