2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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>
30 __FBSDID("$FreeBSD$");
34 #include "opt_hwpmc_hooks.h"
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/eventhandler.h>
39 #include <sys/fcntl.h>
41 #include <sys/kernel.h>
42 #include <sys/libkern.h>
43 #include <sys/linker.h>
45 #include <sys/malloc.h>
46 #include <sys/module.h>
47 #include <sys/mount.h>
48 #include <sys/mutex.h>
49 #include <sys/namei.h>
53 #include <sys/syscallsubr.h>
54 #include <sys/sysctl.h>
55 #include <sys/sysproto.h>
56 #include <sys/vnode.h>
64 #include <security/mac/mac_framework.h>
66 #include "linker_if.h"
69 #include <sys/pmckern.h>
74 SYSCTL_INT(_debug, OID_AUTO, kld_debug, CTLFLAG_RWTUN,
75 &kld_debug, 0, "Set various levels of KLD debug");
78 /* These variables are used by kernel debuggers to enumerate loaded files. */
79 const int kld_off_address = offsetof(struct linker_file, address);
80 const int kld_off_filename = offsetof(struct linker_file, filename);
81 const int kld_off_pathname = offsetof(struct linker_file, pathname);
82 const int kld_off_next = offsetof(struct linker_file, link.tqe_next);
85 * static char *linker_search_path(const char *name, struct mod_depend
88 static const char *linker_basename(const char *path);
91 * Find a currently loaded file given its filename.
93 static linker_file_t linker_find_file_by_name(const char* _filename);
96 * Find a currently loaded file given its file id.
98 static linker_file_t linker_find_file_by_id(int _fileid);
100 /* Metadata from the static kernel */
101 SET_DECLARE(modmetadata_set, struct mod_metadata);
103 MALLOC_DEFINE(M_LINKER, "linker", "kernel linker");
105 linker_file_t linker_kernel_file;
107 static struct sx kld_sx; /* kernel linker lock */
108 static u_int kld_busy;
109 static struct thread *kld_busy_owner;
112 * Load counter used by clients to determine if a linker file has been
113 * re-loaded. This counter is incremented for each file load.
117 static linker_class_list_t classes;
118 static linker_file_list_t linker_files;
119 static int next_file_id = 1;
120 static int linker_no_more_classes = 0;
122 #define LINKER_GET_NEXT_FILE_ID(a) do { \
123 linker_file_t lftmp; \
126 sx_assert(&kld_sx, SA_XLOCKED); \
128 TAILQ_FOREACH(lftmp, &linker_files, link) { \
129 if (next_file_id == lftmp->id) { \
134 (a) = next_file_id; \
137 /* XXX wrong name; we're looking at version provision tags here, not modules */
138 typedef TAILQ_HEAD(, modlist) modlisthead_t;
140 TAILQ_ENTRY(modlist) link; /* chain together all modules */
141 linker_file_t container;
145 typedef struct modlist *modlist_t;
146 static modlisthead_t found_modules;
148 static int linker_file_add_dependency(linker_file_t file,
150 static caddr_t linker_file_lookup_symbol_internal(linker_file_t file,
151 const char* name, int deps);
152 static int linker_load_module(const char *kldname,
153 const char *modname, struct linker_file *parent,
154 const struct mod_depend *verinfo, struct linker_file **lfpp);
155 static modlist_t modlist_lookup2(const char *name, const struct mod_depend *verinfo);
158 linker_init(void *arg)
161 sx_init(&kld_sx, "kernel linker");
162 TAILQ_INIT(&classes);
163 TAILQ_INIT(&linker_files);
166 SYSINIT(linker, SI_SUB_KLD, SI_ORDER_FIRST, linker_init, NULL);
169 linker_stop_class_add(void *arg)
172 linker_no_more_classes = 1;
175 SYSINIT(linker_class, SI_SUB_KLD, SI_ORDER_ANY, linker_stop_class_add, NULL);
178 linker_add_class(linker_class_t lc)
182 * We disallow any class registration past SI_ORDER_ANY
183 * of SI_SUB_KLD. We bump the reference count to keep the
184 * ops from being freed.
186 if (linker_no_more_classes == 1)
188 kobj_class_compile((kobj_class_t) lc);
189 ((kobj_class_t)lc)->refs++; /* XXX: kobj_mtx */
190 TAILQ_INSERT_TAIL(&classes, lc, link);
195 linker_file_sysinit(linker_file_t lf)
197 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.
231 for (sipp = start; sipp < stop; sipp++) {
232 if ((*sipp)->subsystem == SI_SUB_DUMMY)
233 continue; /* skip dummy task(s) */
236 (*((*sipp)->func)) ((*sipp)->udata);
243 linker_file_sysuninit(linker_file_t lf)
245 struct sysinit **start, **stop, **sipp, **xipp, *save;
247 KLD_DPF(FILE, ("linker_file_sysuninit: calling SYSUNINITs for %s\n",
250 sx_assert(&kld_sx, SA_XLOCKED);
252 if (linker_file_lookup_set(lf, "sysuninit_set", &start, &stop,
257 * Perform a reverse bubble sort of the system initialization objects
258 * by their subsystem (primary key) and order (secondary key).
260 * Since some things care about execution order, this is the operation
261 * which ensures continued function.
263 for (sipp = start; sipp < stop; sipp++) {
264 for (xipp = sipp + 1; xipp < stop; xipp++) {
265 if ((*sipp)->subsystem > (*xipp)->subsystem ||
266 ((*sipp)->subsystem == (*xipp)->subsystem &&
267 (*sipp)->order >= (*xipp)->order))
276 * Traverse the (now) ordered list of system initialization tasks.
277 * Perform each task, and continue on to the next task.
281 for (sipp = start; sipp < stop; sipp++) {
282 if ((*sipp)->subsystem == SI_SUB_DUMMY)
283 continue; /* skip dummy task(s) */
286 (*((*sipp)->func)) ((*sipp)->udata);
293 linker_file_register_sysctls(linker_file_t lf, bool enable)
295 struct sysctl_oid **start, **stop, **oidp;
298 ("linker_file_register_sysctls: registering SYSCTLs for %s\n",
301 sx_assert(&kld_sx, SA_XLOCKED);
303 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
308 for (oidp = start; oidp < stop; oidp++) {
310 sysctl_register_oid(*oidp);
312 sysctl_register_disabled_oid(*oidp);
319 linker_file_enable_sysctls(linker_file_t lf)
321 struct sysctl_oid **start, **stop, **oidp;
324 ("linker_file_enable_sysctls: enable SYSCTLs for %s\n",
327 sx_assert(&kld_sx, SA_XLOCKED);
329 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
334 for (oidp = start; oidp < stop; oidp++)
335 sysctl_enable_oid(*oidp);
341 linker_file_unregister_sysctls(linker_file_t lf)
343 struct sysctl_oid **start, **stop, **oidp;
345 KLD_DPF(FILE, ("linker_file_unregister_sysctls: unregistering SYSCTLs"
346 " for %s\n", lf->filename));
348 sx_assert(&kld_sx, SA_XLOCKED);
350 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
355 for (oidp = start; oidp < stop; oidp++)
356 sysctl_unregister_oid(*oidp);
362 linker_file_register_modules(linker_file_t lf)
364 struct mod_metadata **start, **stop, **mdp;
365 const moduledata_t *moddata;
366 int first_error, error;
368 KLD_DPF(FILE, ("linker_file_register_modules: registering modules"
369 " in %s\n", lf->filename));
371 sx_assert(&kld_sx, SA_XLOCKED);
373 if (linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop, NULL) != 0) {
375 * This fallback should be unnecessary, but if we get booted
376 * from boot2 instead of loader and we are missing our
377 * metadata then we have to try the best we can.
379 if (lf == linker_kernel_file) {
380 start = SET_BEGIN(modmetadata_set);
381 stop = SET_LIMIT(modmetadata_set);
386 for (mdp = start; mdp < stop; mdp++) {
387 if ((*mdp)->md_type != MDT_MODULE)
389 moddata = (*mdp)->md_data;
390 KLD_DPF(FILE, ("Registering module %s in %s\n",
391 moddata->name, lf->filename));
392 error = module_register(moddata, lf);
394 printf("Module %s failed to register: %d\n",
395 moddata->name, error);
396 if (first_error == 0)
400 return (first_error);
404 linker_init_kernel_modules(void)
408 linker_file_register_modules(linker_kernel_file);
412 SYSINIT(linker_kernel, SI_SUB_KLD, SI_ORDER_ANY, linker_init_kernel_modules,
416 linker_load_file(const char *filename, linker_file_t *result)
420 int foundfile, error, modules;
422 /* Refuse to load modules if securelevel raised */
423 if (prison0.pr_securelevel > 0)
426 sx_assert(&kld_sx, SA_XLOCKED);
427 lf = linker_find_file_by_name(filename);
429 KLD_DPF(FILE, ("linker_load_file: file %s is already loaded,"
430 " incrementing refs\n", filename));
439 * We do not need to protect (lock) classes here because there is
440 * no class registration past startup (SI_SUB_KLD, SI_ORDER_ANY)
441 * and there is no class deregistration mechanism at this time.
443 TAILQ_FOREACH(lc, &classes, link) {
444 KLD_DPF(FILE, ("linker_load_file: trying to load %s\n",
446 error = LINKER_LOAD_FILE(lc, filename, &lf);
448 * If we got something other than ENOENT, then it exists but
449 * we cannot load it for some other reason.
454 error = linker_file_register_modules(lf);
455 if (error == EEXIST) {
456 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
459 modules = !TAILQ_EMPTY(&lf->modules);
460 linker_file_register_sysctls(lf, false);
461 linker_file_sysinit(lf);
462 lf->flags |= LINKER_FILE_LINKED;
465 * If all of the modules in this file failed
466 * to load, unload the file and return an
469 if (modules && TAILQ_EMPTY(&lf->modules)) {
470 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
473 linker_file_enable_sysctls(lf);
474 EVENTHANDLER_INVOKE(kld_load, lf);
480 * Less than ideal, but tells the user whether it failed to load or
481 * the module was not found.
485 * If the file type has not been recognized by the last try
486 * printout a message before to fail.
489 printf("%s: %s - unsupported file type\n",
493 * Format not recognized or otherwise unloadable.
494 * When loading a module that is statically built into
495 * the kernel EEXIST percolates back up as the return
496 * value. Preserve this so that apps like sysinstall
497 * can recognize this special case and not post bogus
503 error = ENOENT; /* Nothing found */
508 linker_reference_module(const char *modname, struct mod_depend *verinfo,
509 linker_file_t *result)
515 if ((mod = modlist_lookup2(modname, verinfo)) != NULL) {
516 *result = mod->container;
522 error = linker_load_module(NULL, modname, NULL, verinfo, result);
528 linker_release_module(const char *modname, struct mod_depend *verinfo,
536 KASSERT(modname != NULL,
537 ("linker_release_module: no file or name"));
538 mod = modlist_lookup2(modname, verinfo);
545 KASSERT(modname == NULL && verinfo == NULL,
546 ("linker_release_module: both file and name"));
547 error = linker_file_unload(lf, LINKER_UNLOAD_NORMAL);
553 linker_find_file_by_name(const char *filename)
558 koname = malloc(strlen(filename) + 4, M_LINKER, M_WAITOK);
559 sprintf(koname, "%s.ko", filename);
561 sx_assert(&kld_sx, SA_XLOCKED);
562 TAILQ_FOREACH(lf, &linker_files, link) {
563 if (strcmp(lf->filename, koname) == 0)
565 if (strcmp(lf->filename, filename) == 0)
568 free(koname, M_LINKER);
573 linker_find_file_by_id(int fileid)
577 sx_assert(&kld_sx, SA_XLOCKED);
578 TAILQ_FOREACH(lf, &linker_files, link)
579 if (lf->id == fileid && lf->flags & LINKER_FILE_LINKED)
585 linker_file_foreach(linker_predicate_t *predicate, void *context)
591 TAILQ_FOREACH(lf, &linker_files, link) {
592 retval = predicate(lf, context);
601 linker_make_file(const char *pathname, linker_class_t lc)
604 const char *filename;
607 sx_assert(&kld_sx, SA_XLOCKED);
608 filename = linker_basename(pathname);
610 KLD_DPF(FILE, ("linker_make_file: new file, filename='%s' for pathname='%s'\n", filename, pathname));
611 lf = (linker_file_t)kobj_create((kobj_class_t)lc, M_LINKER, M_WAITOK);
621 lf->filename = strdup(filename, M_LINKER);
622 lf->pathname = strdup(pathname, M_LINKER);
623 LINKER_GET_NEXT_FILE_ID(lf->id);
626 lf->loadcnt = ++loadcnt;
631 STAILQ_INIT(&lf->common);
632 TAILQ_INIT(&lf->modules);
633 TAILQ_INSERT_TAIL(&linker_files, lf, link);
638 linker_file_unload(linker_file_t file, int flags)
641 modlist_t ml, nextml;
642 struct common_symbol *cp;
645 /* Refuse to unload modules if securelevel raised. */
646 if (prison0.pr_securelevel > 0)
649 sx_assert(&kld_sx, SA_XLOCKED);
650 KLD_DPF(FILE, ("linker_file_unload: lf->refs=%d\n", file->refs));
652 /* Easy case of just dropping a reference. */
653 if (file->refs > 1) {
658 /* Give eventhandlers a chance to prevent the unload. */
660 EVENTHANDLER_INVOKE(kld_unload_try, file, &error);
664 KLD_DPF(FILE, ("linker_file_unload: file is unloading,"
665 " informing modules\n"));
668 * Quiesce all the modules to give them a chance to veto the unload.
671 for (mod = TAILQ_FIRST(&file->modules); mod;
672 mod = module_getfnext(mod)) {
673 error = module_quiesce(mod);
674 if (error != 0 && flags != LINKER_UNLOAD_FORCE) {
675 KLD_DPF(FILE, ("linker_file_unload: module %s"
676 " vetoed unload\n", module_getname(mod)));
678 * XXX: Do we need to tell all the quiesced modules
679 * that they can resume work now via a new module
689 * Inform any modules associated with this file that they are
693 for (mod = TAILQ_FIRST(&file->modules); mod; mod = next) {
694 next = module_getfnext(mod);
698 * Give the module a chance to veto the unload.
700 if ((error = module_unload(mod)) != 0) {
703 KLD_DPF(FILE, ("linker_file_unload: module %s"
704 " failed unload\n", module_getname(mod)));
714 TAILQ_FOREACH_SAFE(ml, &found_modules, link, nextml) {
715 if (ml->container == file) {
716 TAILQ_REMOVE(&found_modules, ml, link);
722 * Don't try to run SYSUNINITs if we are unloaded due to a
725 if (file->flags & LINKER_FILE_LINKED) {
726 file->flags &= ~LINKER_FILE_LINKED;
727 linker_file_unregister_sysctls(file);
728 linker_file_sysuninit(file);
730 TAILQ_REMOVE(&linker_files, file, link);
733 for (i = 0; i < file->ndeps; i++)
734 linker_file_unload(file->deps[i], flags);
735 free(file->deps, M_LINKER);
738 while ((cp = STAILQ_FIRST(&file->common)) != NULL) {
739 STAILQ_REMOVE_HEAD(&file->common, link);
745 EVENTHANDLER_INVOKE(kld_unload, file->filename, file->address,
748 if (file->filename) {
749 free(file->filename, M_LINKER);
750 file->filename = NULL;
752 if (file->pathname) {
753 free(file->pathname, M_LINKER);
754 file->pathname = NULL;
756 kobj_delete((kobj_t) file, M_LINKER);
761 linker_ctf_get(linker_file_t file, linker_ctf_t *lc)
763 return (LINKER_CTF_GET(file, lc));
767 linker_file_add_dependency(linker_file_t file, linker_file_t dep)
769 linker_file_t *newdeps;
771 sx_assert(&kld_sx, SA_XLOCKED);
772 file->deps = realloc(file->deps, (file->ndeps + 1) * sizeof(*newdeps),
773 M_LINKER, M_WAITOK | M_ZERO);
774 file->deps[file->ndeps] = dep;
776 KLD_DPF(FILE, ("linker_file_add_dependency:"
777 " adding %s as dependency for %s\n",
778 dep->filename, file->filename));
783 * Locate a linker set and its contents. This is a helper function to avoid
784 * linker_if.h exposure elsewhere. Note: firstp and lastp are really void **.
785 * This function is used in this file so we can avoid having lots of (void **)
789 linker_file_lookup_set(linker_file_t file, const char *name,
790 void *firstp, void *lastp, int *countp)
793 sx_assert(&kld_sx, SA_LOCKED);
794 return (LINKER_LOOKUP_SET(file, name, firstp, lastp, countp));
798 * List all functions in a file.
801 linker_file_function_listall(linker_file_t lf,
802 linker_function_nameval_callback_t callback_func, void *arg)
804 return (LINKER_EACH_FUNCTION_NAMEVAL(lf, callback_func, arg));
808 linker_file_lookup_symbol(linker_file_t file, const char *name, int deps)
813 locked = sx_xlocked(&kld_sx);
816 sym = linker_file_lookup_symbol_internal(file, name, deps);
823 linker_file_lookup_symbol_internal(linker_file_t file, const char *name,
827 linker_symval_t symval;
829 size_t common_size = 0;
832 sx_assert(&kld_sx, SA_XLOCKED);
833 KLD_DPF(SYM, ("linker_file_lookup_symbol: file=%p, name=%s, deps=%d\n",
836 if (LINKER_LOOKUP_SYMBOL(file, name, &sym) == 0) {
837 LINKER_SYMBOL_VALUES(file, sym, &symval);
838 if (symval.value == 0)
840 * For commons, first look them up in the
841 * dependencies and only allocate space if not found
844 common_size = symval.size;
846 KLD_DPF(SYM, ("linker_file_lookup_symbol: symbol"
847 ".value=%p\n", symval.value));
848 return (symval.value);
852 for (i = 0; i < file->ndeps; i++) {
853 address = linker_file_lookup_symbol_internal(
854 file->deps[i], name, 0);
856 KLD_DPF(SYM, ("linker_file_lookup_symbol:"
857 " deps value=%p\n", address));
862 if (common_size > 0) {
864 * This is a common symbol which was not found in the
865 * dependencies. We maintain a simple common symbol table in
868 struct common_symbol *cp;
870 STAILQ_FOREACH(cp, &file->common, link) {
871 if (strcmp(cp->name, name) == 0) {
872 KLD_DPF(SYM, ("linker_file_lookup_symbol:"
873 " old common value=%p\n", cp->address));
874 return (cp->address);
878 * Round the symbol size up to align.
880 common_size = (common_size + sizeof(int) - 1) & -sizeof(int);
881 cp = malloc(sizeof(struct common_symbol)
882 + common_size + strlen(name) + 1, M_LINKER,
884 cp->address = (caddr_t)(cp + 1);
885 cp->name = cp->address + common_size;
886 strcpy(cp->name, name);
887 bzero(cp->address, common_size);
888 STAILQ_INSERT_TAIL(&file->common, cp, link);
890 KLD_DPF(SYM, ("linker_file_lookup_symbol: new common"
891 " value=%p\n", cp->address));
892 return (cp->address);
894 KLD_DPF(SYM, ("linker_file_lookup_symbol: fail\n"));
899 * Both DDB and stack(9) rely on the kernel linker to provide forward and
900 * backward lookup of symbols. However, DDB and sometimes stack(9) need to
901 * do this in a lockfree manner. We provide a set of internal helper
902 * routines to perform these operations without locks, and then wrappers that
905 * linker_debug_lookup() is ifdef DDB as currently it's only used by DDB.
909 linker_debug_lookup(const char *symstr, c_linker_sym_t *sym)
913 TAILQ_FOREACH(lf, &linker_files, link) {
914 if (LINKER_LOOKUP_DEBUG_SYMBOL(lf, symstr, sym) == 0)
922 linker_debug_search_symbol(caddr_t value, c_linker_sym_t *sym, long *diffp)
925 c_linker_sym_t best, es;
926 u_long diff, bestdiff, off;
929 off = (uintptr_t)value;
931 TAILQ_FOREACH(lf, &linker_files, link) {
932 if (LINKER_SEARCH_SYMBOL(lf, value, &es, &diff) != 0)
934 if (es != 0 && diff < bestdiff) {
953 linker_debug_symbol_values(c_linker_sym_t sym, linker_symval_t *symval)
957 TAILQ_FOREACH(lf, &linker_files, link) {
958 if (LINKER_DEBUG_SYMBOL_VALUES(lf, sym, symval) == 0)
965 linker_debug_search_symbol_name(caddr_t value, char *buf, u_int buflen,
968 linker_symval_t symval;
973 error = linker_debug_search_symbol(value, &sym, offset);
976 error = linker_debug_symbol_values(sym, &symval);
979 strlcpy(buf, symval.name, buflen);
984 * DDB Helpers. DDB has to look across multiple files with their own symbol
985 * tables and string tables.
987 * Note that we do not obey list locking protocols here. We really don't need
988 * DDB to hang because somebody's got the lock held. We'll take the chance
989 * that the files list is inconsistent instead.
993 linker_ddb_lookup(const char *symstr, c_linker_sym_t *sym)
996 return (linker_debug_lookup(symstr, sym));
1001 linker_ddb_search_symbol(caddr_t value, c_linker_sym_t *sym, long *diffp)
1004 return (linker_debug_search_symbol(value, sym, diffp));
1008 linker_ddb_symbol_values(c_linker_sym_t sym, linker_symval_t *symval)
1011 return (linker_debug_symbol_values(sym, symval));
1015 linker_ddb_search_symbol_name(caddr_t value, char *buf, u_int buflen,
1019 return (linker_debug_search_symbol_name(value, buf, buflen, offset));
1023 * stack(9) helper for non-debugging environemnts. Unlike DDB helpers, we do
1024 * obey locking protocols, and offer a significantly less complex interface.
1027 linker_search_symbol_name_flags(caddr_t value, char *buf, u_int buflen,
1028 long *offset, int flags)
1032 KASSERT((flags & (M_NOWAIT | M_WAITOK)) != 0 &&
1033 (flags & (M_NOWAIT | M_WAITOK)) != (M_NOWAIT | M_WAITOK),
1034 ("%s: bad flags: 0x%x", __func__, flags));
1036 if (flags & M_NOWAIT) {
1037 if (!sx_try_slock(&kld_sx))
1038 return (EWOULDBLOCK);
1042 error = linker_debug_search_symbol_name(value, buf, buflen, offset);
1043 sx_sunlock(&kld_sx);
1048 linker_search_symbol_name(caddr_t value, char *buf, u_int buflen,
1052 return (linker_search_symbol_name_flags(value, buf, buflen, offset,
1057 linker_kldload_busy(int flags)
1061 MPASS((flags & ~(LINKER_UB_UNLOCK | LINKER_UB_LOCKED |
1062 LINKER_UB_PCATCH)) == 0);
1063 if ((flags & LINKER_UB_LOCKED) != 0)
1064 sx_assert(&kld_sx, SA_XLOCKED);
1066 if ((flags & LINKER_UB_LOCKED) == 0)
1068 while (kld_busy > 0) {
1069 if (kld_busy_owner == curthread)
1071 error = sx_sleep(&kld_busy, &kld_sx,
1072 (flags & LINKER_UB_PCATCH) != 0 ? PCATCH : 0,
1075 if ((flags & LINKER_UB_UNLOCK) != 0)
1076 sx_xunlock(&kld_sx);
1081 kld_busy_owner = curthread;
1082 if ((flags & LINKER_UB_UNLOCK) != 0)
1083 sx_xunlock(&kld_sx);
1088 linker_kldload_unbusy(int flags)
1090 MPASS((flags & ~LINKER_UB_LOCKED) == 0);
1091 if ((flags & LINKER_UB_LOCKED) != 0)
1092 sx_assert(&kld_sx, SA_XLOCKED);
1094 if ((flags & LINKER_UB_LOCKED) == 0)
1096 MPASS(kld_busy > 0);
1097 if (kld_busy_owner != curthread)
1098 panic("linker_kldload_unbusy done by not owning thread %p",
1101 if (kld_busy == 0) {
1102 kld_busy_owner = NULL;
1105 sx_xunlock(&kld_sx);
1112 kern_kldload(struct thread *td, const char *file, int *fileid)
1114 const char *kldname, *modname;
1118 if ((error = securelevel_gt(td->td_ucred, 0)) != 0)
1121 if ((error = priv_check(td, PRIV_KLD_LOAD)) != 0)
1125 * If file does not contain a qualified name or any dot in it
1126 * (kldname.ko, or kldname.ver.ko) treat it as an interface
1129 if (strchr(file, '/') || strchr(file, '.')) {
1137 error = linker_kldload_busy(LINKER_UB_PCATCH);
1139 sx_xunlock(&kld_sx);
1144 * It is possible that kldloaded module will attach a new ifnet,
1145 * so vnet context must be set when this ocurs.
1147 CURVNET_SET(TD_TO_VNET(td));
1149 error = linker_load_module(kldname, modname, NULL, NULL, &lf);
1157 linker_kldload_unbusy(LINKER_UB_LOCKED);
1162 sys_kldload(struct thread *td, struct kldload_args *uap)
1164 char *pathname = NULL;
1167 td->td_retval[0] = -1;
1169 pathname = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1170 error = copyinstr(uap->file, pathname, MAXPATHLEN, NULL);
1172 error = kern_kldload(td, pathname, &fileid);
1174 td->td_retval[0] = fileid;
1176 free(pathname, M_TEMP);
1181 kern_kldunload(struct thread *td, int fileid, int flags)
1186 if ((error = securelevel_gt(td->td_ucred, 0)) != 0)
1189 if ((error = priv_check(td, PRIV_KLD_UNLOAD)) != 0)
1192 error = linker_kldload_busy(LINKER_UB_PCATCH);
1194 sx_xunlock(&kld_sx);
1198 CURVNET_SET(TD_TO_VNET(td));
1199 lf = linker_find_file_by_id(fileid);
1201 KLD_DPF(FILE, ("kldunload: lf->userrefs=%d\n", lf->userrefs));
1203 if (lf->userrefs == 0) {
1205 * XXX: maybe LINKER_UNLOAD_FORCE should override ?
1207 printf("kldunload: attempt to unload file that was"
1208 " loaded by the kernel\n");
1212 error = linker_file_unload(lf, flags);
1219 linker_kldload_unbusy(LINKER_UB_LOCKED);
1224 sys_kldunload(struct thread *td, struct kldunload_args *uap)
1227 return (kern_kldunload(td, uap->fileid, LINKER_UNLOAD_NORMAL));
1231 sys_kldunloadf(struct thread *td, struct kldunloadf_args *uap)
1234 if (uap->flags != LINKER_UNLOAD_NORMAL &&
1235 uap->flags != LINKER_UNLOAD_FORCE)
1237 return (kern_kldunload(td, uap->fileid, uap->flags));
1241 sys_kldfind(struct thread *td, struct kldfind_args *uap)
1244 const char *filename;
1249 error = mac_kld_check_stat(td->td_ucred);
1254 td->td_retval[0] = -1;
1256 pathname = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1257 if ((error = copyinstr(uap->file, pathname, MAXPATHLEN, NULL)) != 0)
1260 filename = linker_basename(pathname);
1262 lf = linker_find_file_by_name(filename);
1264 td->td_retval[0] = lf->id;
1267 sx_xunlock(&kld_sx);
1269 free(pathname, M_TEMP);
1274 sys_kldnext(struct thread *td, struct kldnext_args *uap)
1280 error = mac_kld_check_stat(td->td_ucred);
1286 if (uap->fileid == 0)
1287 lf = TAILQ_FIRST(&linker_files);
1289 lf = linker_find_file_by_id(uap->fileid);
1294 lf = TAILQ_NEXT(lf, link);
1297 /* Skip partially loaded files. */
1298 while (lf != NULL && !(lf->flags & LINKER_FILE_LINKED))
1299 lf = TAILQ_NEXT(lf, link);
1302 td->td_retval[0] = lf->id;
1304 td->td_retval[0] = 0;
1306 sx_xunlock(&kld_sx);
1311 sys_kldstat(struct thread *td, struct kldstat_args *uap)
1313 struct kld_file_stat *stat;
1317 * Check the version of the user's structure.
1319 if ((error = copyin(&uap->stat->version, &version, sizeof(version)))
1322 if (version != sizeof(struct kld_file_stat_1) &&
1323 version != sizeof(struct kld_file_stat))
1326 stat = malloc(sizeof(*stat), M_TEMP, M_WAITOK | M_ZERO);
1327 error = kern_kldstat(td, uap->fileid, stat);
1329 error = copyout(stat, uap->stat, version);
1335 kern_kldstat(struct thread *td, int fileid, struct kld_file_stat *stat)
1342 error = mac_kld_check_stat(td->td_ucred);
1348 lf = linker_find_file_by_id(fileid);
1350 sx_xunlock(&kld_sx);
1354 /* Version 1 fields: */
1355 namelen = strlen(lf->filename) + 1;
1356 if (namelen > sizeof(stat->name))
1357 namelen = sizeof(stat->name);
1358 bcopy(lf->filename, &stat->name[0], namelen);
1359 stat->refs = lf->refs;
1361 stat->address = lf->address;
1362 stat->size = lf->size;
1363 /* Version 2 fields: */
1364 namelen = strlen(lf->pathname) + 1;
1365 if (namelen > sizeof(stat->pathname))
1366 namelen = sizeof(stat->pathname);
1367 bcopy(lf->pathname, &stat->pathname[0], namelen);
1368 sx_xunlock(&kld_sx);
1370 td->td_retval[0] = 0;
1375 DB_COMMAND(kldstat, db_kldstat)
1379 #define POINTER_WIDTH ((int)(sizeof(void *) * 2 + 2))
1380 db_printf("Id Refs Address%*c Size Name\n", POINTER_WIDTH - 7, ' ');
1381 #undef POINTER_WIDTH
1382 TAILQ_FOREACH(lf, &linker_files, link) {
1385 db_printf("%2d %4d %p %-8zx %s\n", lf->id, lf->refs,
1386 lf->address, lf->size, lf->filename);
1392 sys_kldfirstmod(struct thread *td, struct kldfirstmod_args *uap)
1399 error = mac_kld_check_stat(td->td_ucred);
1405 lf = linker_find_file_by_id(uap->fileid);
1408 mp = TAILQ_FIRST(&lf->modules);
1410 td->td_retval[0] = module_getid(mp);
1412 td->td_retval[0] = 0;
1416 sx_xunlock(&kld_sx);
1421 sys_kldsym(struct thread *td, struct kldsym_args *uap)
1423 char *symstr = NULL;
1425 linker_symval_t symval;
1427 struct kld_sym_lookup lookup;
1431 error = mac_kld_check_stat(td->td_ucred);
1436 if ((error = copyin(uap->data, &lookup, sizeof(lookup))) != 0)
1438 if (lookup.version != sizeof(lookup) ||
1439 uap->cmd != KLDSYM_LOOKUP)
1441 symstr = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1442 if ((error = copyinstr(lookup.symname, symstr, MAXPATHLEN, NULL)) != 0)
1445 if (uap->fileid != 0) {
1446 lf = linker_find_file_by_id(uap->fileid);
1449 else if (LINKER_LOOKUP_SYMBOL(lf, symstr, &sym) == 0 &&
1450 LINKER_SYMBOL_VALUES(lf, sym, &symval) == 0) {
1451 lookup.symvalue = (uintptr_t) symval.value;
1452 lookup.symsize = symval.size;
1453 error = copyout(&lookup, uap->data, sizeof(lookup));
1457 TAILQ_FOREACH(lf, &linker_files, link) {
1458 if (LINKER_LOOKUP_SYMBOL(lf, symstr, &sym) == 0 &&
1459 LINKER_SYMBOL_VALUES(lf, sym, &symval) == 0) {
1460 lookup.symvalue = (uintptr_t)symval.value;
1461 lookup.symsize = symval.size;
1462 error = copyout(&lookup, uap->data,
1470 sx_xunlock(&kld_sx);
1472 free(symstr, M_TEMP);
1477 * Preloaded module support
1481 modlist_lookup(const char *name, int ver)
1485 TAILQ_FOREACH(mod, &found_modules, link) {
1486 if (strcmp(mod->name, name) == 0 &&
1487 (ver == 0 || mod->version == ver))
1494 modlist_lookup2(const char *name, const struct mod_depend *verinfo)
1496 modlist_t mod, bestmod;
1499 if (verinfo == NULL)
1500 return (modlist_lookup(name, 0));
1502 TAILQ_FOREACH(mod, &found_modules, link) {
1503 if (strcmp(mod->name, name) != 0)
1506 if (ver == verinfo->md_ver_preferred)
1508 if (ver >= verinfo->md_ver_minimum &&
1509 ver <= verinfo->md_ver_maximum &&
1510 (bestmod == NULL || ver > bestmod->version))
1517 modlist_newmodule(const char *modname, int version, linker_file_t container)
1521 mod = malloc(sizeof(struct modlist), M_LINKER, M_NOWAIT | M_ZERO);
1523 panic("no memory for module list");
1524 mod->container = container;
1525 mod->name = modname;
1526 mod->version = version;
1527 TAILQ_INSERT_TAIL(&found_modules, mod, link);
1532 linker_addmodules(linker_file_t lf, struct mod_metadata **start,
1533 struct mod_metadata **stop, int preload)
1535 struct mod_metadata *mp, **mdp;
1536 const char *modname;
1539 for (mdp = start; mdp < stop; mdp++) {
1541 if (mp->md_type != MDT_VERSION)
1543 modname = mp->md_cval;
1544 ver = ((const struct mod_version *)mp->md_data)->mv_version;
1545 if (modlist_lookup(modname, ver) != NULL) {
1546 printf("module %s already present!\n", modname);
1547 /* XXX what can we do? this is a build error. :-( */
1550 modlist_newmodule(modname, ver, lf);
1555 linker_preload(void *arg)
1558 const char *modname, *nmodname;
1560 linker_file_t lf, nlf;
1563 linker_file_list_t loaded_files;
1564 linker_file_list_t depended_files;
1565 struct mod_metadata *mp, *nmp;
1566 struct mod_metadata **start, **stop, **mdp, **nmdp;
1567 const struct mod_depend *verinfo;
1571 struct sysinit **si_start, **si_stop;
1573 TAILQ_INIT(&loaded_files);
1574 TAILQ_INIT(&depended_files);
1575 TAILQ_INIT(&found_modules);
1580 while ((modptr = preload_search_next_name(modptr)) != NULL) {
1581 modname = (char *)preload_search_info(modptr, MODINFO_NAME);
1582 modtype = (char *)preload_search_info(modptr, MODINFO_TYPE);
1583 if (modname == NULL) {
1584 printf("Preloaded module at %p does not have a"
1585 " name!\n", modptr);
1588 if (modtype == NULL) {
1589 printf("Preloaded module at %p does not have a type!\n",
1594 printf("Preloaded %s \"%s\" at %p.\n", modtype, modname,
1597 TAILQ_FOREACH(lc, &classes, link) {
1598 error = LINKER_LINK_PRELOAD(lc, modname, &lf);
1604 TAILQ_INSERT_TAIL(&loaded_files, lf, loaded);
1608 * First get a list of stuff in the kernel.
1610 if (linker_file_lookup_set(linker_kernel_file, MDT_SETNAME, &start,
1612 linker_addmodules(linker_kernel_file, start, stop, 1);
1615 * This is a once-off kinky bubble sort to resolve relocation
1616 * dependency requirements.
1619 TAILQ_FOREACH(lf, &loaded_files, loaded) {
1620 error = linker_file_lookup_set(lf, MDT_SETNAME, &start,
1623 * First, look to see if we would successfully link with this
1626 resolves = 1; /* unless we know otherwise */
1628 for (mdp = start; mdp < stop; mdp++) {
1630 if (mp->md_type != MDT_DEPEND)
1632 modname = mp->md_cval;
1633 verinfo = mp->md_data;
1634 for (nmdp = start; nmdp < stop; nmdp++) {
1636 if (nmp->md_type != MDT_VERSION)
1638 nmodname = nmp->md_cval;
1639 if (strcmp(modname, nmodname) == 0)
1642 if (nmdp < stop) /* it's a self reference */
1646 * ok, the module isn't here yet, we
1649 if (modlist_lookup2(modname, verinfo) == NULL)
1654 * OK, if we found our modules, we can link. So, "provide"
1655 * the modules inside and add it to the end of the link order
1660 for (mdp = start; mdp < stop; mdp++) {
1662 if (mp->md_type != MDT_VERSION)
1664 modname = mp->md_cval;
1665 nver = ((const struct mod_version *)
1666 mp->md_data)->mv_version;
1667 if (modlist_lookup(modname,
1669 printf("module %s already"
1670 " present!\n", modname);
1671 TAILQ_REMOVE(&loaded_files,
1673 linker_file_unload(lf,
1674 LINKER_UNLOAD_FORCE);
1675 /* we changed tailq next ptr */
1678 modlist_newmodule(modname, nver, lf);
1681 TAILQ_REMOVE(&loaded_files, lf, loaded);
1682 TAILQ_INSERT_TAIL(&depended_files, lf, loaded);
1684 * Since we provided modules, we need to restart the
1685 * sort so that the previous files that depend on us
1686 * have a chance. Also, we've busted the tailq next
1687 * pointer with the REMOVE.
1694 * At this point, we check to see what could not be resolved..
1696 while ((lf = TAILQ_FIRST(&loaded_files)) != NULL) {
1697 TAILQ_REMOVE(&loaded_files, lf, loaded);
1698 printf("KLD file %s is missing dependencies\n", lf->filename);
1699 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1703 * We made it. Finish off the linking in the order we determined.
1705 TAILQ_FOREACH_SAFE(lf, &depended_files, loaded, nlf) {
1706 if (linker_kernel_file) {
1707 linker_kernel_file->refs++;
1708 error = linker_file_add_dependency(lf,
1709 linker_kernel_file);
1711 panic("cannot add dependency");
1713 error = linker_file_lookup_set(lf, MDT_SETNAME, &start,
1716 for (mdp = start; mdp < stop; mdp++) {
1718 if (mp->md_type != MDT_DEPEND)
1720 modname = mp->md_cval;
1721 verinfo = mp->md_data;
1722 mod = modlist_lookup2(modname, verinfo);
1724 printf("KLD file %s - cannot find "
1725 "dependency \"%s\"\n",
1726 lf->filename, modname);
1729 /* Don't count self-dependencies */
1730 if (lf == mod->container)
1732 mod->container->refs++;
1733 error = linker_file_add_dependency(lf,
1736 panic("cannot add dependency");
1740 * Now do relocation etc using the symbol search paths
1741 * established by the dependencies
1743 error = LINKER_LINK_PRELOAD_FINISH(lf);
1745 printf("KLD file %s - could not finalize loading\n",
1749 linker_file_register_modules(lf);
1750 if (!TAILQ_EMPTY(&lf->modules))
1751 lf->flags |= LINKER_FILE_MODULES;
1752 if (linker_file_lookup_set(lf, "sysinit_set", &si_start,
1753 &si_stop, NULL) == 0)
1754 sysinit_add(si_start, si_stop);
1755 linker_file_register_sysctls(lf, true);
1756 lf->flags |= LINKER_FILE_LINKED;
1759 TAILQ_REMOVE(&depended_files, lf, loaded);
1760 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1762 sx_xunlock(&kld_sx);
1763 /* woohoo! we made it! */
1766 SYSINIT(preload, SI_SUB_KLD, SI_ORDER_MIDDLE, linker_preload, NULL);
1769 * Handle preload files that failed to load any modules.
1772 linker_preload_finish(void *arg)
1774 linker_file_t lf, nlf;
1777 TAILQ_FOREACH_SAFE(lf, &linker_files, link, nlf) {
1779 * If all of the modules in this file failed to load, unload
1780 * the file and return an error of ENOEXEC. (Parity with
1781 * linker_load_file.)
1783 if ((lf->flags & LINKER_FILE_MODULES) != 0 &&
1784 TAILQ_EMPTY(&lf->modules)) {
1785 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1789 lf->flags &= ~LINKER_FILE_MODULES;
1790 lf->userrefs++; /* so we can (try to) kldunload it */
1792 sx_xunlock(&kld_sx);
1796 * Attempt to run after all DECLARE_MODULE SYSINITs. Unfortunately they can be
1797 * scheduled at any subsystem and order, so run this as late as possible. init
1798 * becomes runnable in SI_SUB_KTHREAD_INIT, so go slightly before that.
1800 SYSINIT(preload_finish, SI_SUB_KTHREAD_INIT - 100, SI_ORDER_MIDDLE,
1801 linker_preload_finish, NULL);
1804 * Search for a not-loaded module by name.
1806 * Modules may be found in the following locations:
1808 * - preloaded (result is just the module name) - on disk (result is full path
1811 * If the module name is qualified in any way (contains path, etc.) the we
1812 * simply return a copy of it.
1814 * The search path can be manipulated via sysctl. Note that we use the ';'
1815 * character as a separator to be consistent with the bootloader.
1818 static char linker_hintfile[] = "linker.hints";
1819 static char linker_path[MAXPATHLEN] = "/boot/kernel;/boot/modules";
1821 SYSCTL_STRING(_kern, OID_AUTO, module_path, CTLFLAG_RWTUN, linker_path,
1822 sizeof(linker_path), "module load search path");
1824 TUNABLE_STR("module_path", linker_path, sizeof(linker_path));
1826 static const char * const linker_ext_list[] = {
1833 * Check if file actually exists either with or without extension listed in
1834 * the linker_ext_list. (probably should be generic for the rest of the
1838 linker_lookup_file(const char *path, int pathlen, const char *name,
1839 int namelen, struct vattr *vap)
1841 struct nameidata nd;
1842 struct thread *td = curthread; /* XXX */
1843 const char * const *cpp, *sep;
1845 int error, len, extlen, reclen, flags;
1849 for (cpp = linker_ext_list; *cpp; cpp++) {
1854 extlen++; /* trailing '\0' */
1855 sep = (path[pathlen - 1] != '/') ? "/" : "";
1857 reclen = pathlen + strlen(sep) + namelen + extlen + 1;
1858 result = malloc(reclen, M_LINKER, M_WAITOK);
1859 for (cpp = linker_ext_list; *cpp; cpp++) {
1860 snprintf(result, reclen, "%.*s%s%.*s%s", pathlen, path, sep,
1861 namelen, name, *cpp);
1863 * Attempt to open the file, and return the path if
1864 * we succeed and it's a regular file.
1866 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, result, td);
1868 error = vn_open(&nd, &flags, 0, NULL);
1870 NDFREE(&nd, NDF_ONLY_PNBUF);
1871 type = nd.ni_vp->v_type;
1873 VOP_GETATTR(nd.ni_vp, vap, td->td_ucred);
1874 VOP_UNLOCK(nd.ni_vp);
1875 vn_close(nd.ni_vp, FREAD, td->td_ucred, td);
1880 free(result, M_LINKER);
1884 #define INT_ALIGN(base, ptr) ptr = \
1885 (base) + roundup2((ptr) - (base), sizeof(int))
1888 * Lookup KLD which contains requested module in the "linker.hints" file. If
1889 * version specification is available, then try to find the best KLD.
1890 * Otherwise just find the latest one.
1893 linker_hints_lookup(const char *path, int pathlen, const char *modname,
1894 int modnamelen, const struct mod_depend *verinfo)
1896 struct thread *td = curthread; /* XXX */
1897 struct ucred *cred = td ? td->td_ucred : NULL;
1898 struct nameidata nd;
1899 struct vattr vattr, mattr;
1900 const char *best, *sep;
1901 u_char *hints = NULL;
1902 u_char *cp, *recptr, *bufend, *result, *pathbuf;
1903 int error, ival, bestver, *intp, found, flags, clen, blen;
1907 bestver = found = 0;
1909 sep = (path[pathlen - 1] != '/') ? "/" : "";
1910 reclen = imax(modnamelen, strlen(linker_hintfile)) + pathlen +
1912 pathbuf = malloc(reclen, M_LINKER, M_WAITOK);
1913 snprintf(pathbuf, reclen, "%.*s%s%s", pathlen, path, sep,
1916 NDINIT(&nd, LOOKUP, NOFOLLOW, UIO_SYSSPACE, pathbuf, td);
1918 error = vn_open(&nd, &flags, 0, NULL);
1921 NDFREE(&nd, NDF_ONLY_PNBUF);
1922 if (nd.ni_vp->v_type != VREG)
1925 error = VOP_GETATTR(nd.ni_vp, &vattr, cred);
1929 * XXX: we need to limit this number to some reasonable value
1931 if (vattr.va_size > LINKER_HINTS_MAX) {
1932 printf("linker.hints file too large %ld\n", (long)vattr.va_size);
1935 hints = malloc(vattr.va_size, M_TEMP, M_WAITOK);
1936 error = vn_rdwr(UIO_READ, nd.ni_vp, (caddr_t)hints, vattr.va_size, 0,
1937 UIO_SYSSPACE, IO_NODELOCKED, cred, NOCRED, &reclen, td);
1940 VOP_UNLOCK(nd.ni_vp);
1941 vn_close(nd.ni_vp, FREAD, cred, td);
1944 printf("can't read %zd\n", reclen);
1947 intp = (int *)hints;
1949 if (ival != LINKER_HINTS_VERSION) {
1950 printf("linker.hints file version mismatch %d\n", ival);
1953 bufend = hints + vattr.va_size;
1954 recptr = (u_char *)intp;
1956 while (recptr < bufend && !found) {
1957 intp = (int *)recptr;
1964 if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
1967 INT_ALIGN(hints, cp);
1971 if (verinfo == NULL ||
1972 ival == verinfo->md_ver_preferred) {
1976 if (ival >= verinfo->md_ver_minimum &&
1977 ival <= verinfo->md_ver_maximum &&
1987 recptr += reclen + sizeof(int);
1990 * Finally check if KLD is in the place
1993 result = linker_lookup_file(path, pathlen, cp, clen, &mattr);
1995 result = linker_lookup_file(path, pathlen, best, blen, &mattr);
1998 * KLD is newer than hints file. What we should do now?
2000 if (result && timespeccmp(&mattr.va_mtime, &vattr.va_mtime, >))
2001 printf("warning: KLD '%s' is newer than the linker.hints"
2004 free(pathbuf, M_LINKER);
2006 free(hints, M_TEMP);
2007 if (nd.ni_vp != NULL) {
2008 VOP_UNLOCK(nd.ni_vp);
2009 vn_close(nd.ni_vp, FREAD, cred, td);
2012 * If nothing found or hints is absent - fallback to the old
2013 * way by using "kldname[.ko]" as module name.
2015 if (!found && !bestver && result == NULL)
2016 result = linker_lookup_file(path, pathlen, modname,
2022 * Lookup KLD which contains requested module in the all directories.
2025 linker_search_module(const char *modname, int modnamelen,
2026 const struct mod_depend *verinfo)
2028 char *cp, *ep, *result;
2031 * traverse the linker path
2033 for (cp = linker_path; *cp; cp = ep + 1) {
2034 /* find the end of this component */
2035 for (ep = cp; (*ep != 0) && (*ep != ';'); ep++);
2036 result = linker_hints_lookup(cp, ep - cp, modname,
2037 modnamelen, verinfo);
2047 * Search for module in all directories listed in the linker_path.
2050 linker_search_kld(const char *name)
2052 char *cp, *ep, *result;
2055 /* qualified at all? */
2056 if (strchr(name, '/'))
2057 return (strdup(name, M_LINKER));
2059 /* traverse the linker path */
2061 for (ep = linker_path; *ep; ep++) {
2063 /* find the end of this component */
2064 for (; *ep != 0 && *ep != ';'; ep++);
2065 result = linker_lookup_file(cp, ep - cp, name, len, NULL);
2073 linker_basename(const char *path)
2075 const char *filename;
2077 filename = strrchr(path, '/');
2078 if (filename == NULL)
2087 * Inform hwpmc about the set of kernel modules currently loaded.
2090 linker_hwpmc_list_objects(void)
2093 struct pmckern_map_in *kobase;
2098 TAILQ_FOREACH(lf, &linker_files, link)
2101 /* Allocate nmappings + 1 entries. */
2102 kobase = malloc((nmappings + 1) * sizeof(struct pmckern_map_in),
2103 M_LINKER, M_WAITOK | M_ZERO);
2105 TAILQ_FOREACH(lf, &linker_files, link) {
2106 /* Save the info for this linker file. */
2107 kobase[i].pm_file = lf->filename;
2108 kobase[i].pm_address = (uintptr_t)lf->address;
2111 sx_sunlock(&kld_sx);
2113 KASSERT(i > 0, ("linker_hpwmc_list_objects: no kernel objects?"));
2115 /* The last entry of the malloced area comprises of all zeros. */
2116 KASSERT(kobase[i].pm_file == NULL,
2117 ("linker_hwpmc_list_objects: last object not NULL"));
2119 return ((void *)kobase);
2123 /* check if root file system is not mounted */
2125 linker_root_mounted(void)
2130 if (rootvnode == NULL)
2133 pwd = pwd_hold(curthread);
2134 ret = pwd->pwd_rdir != NULL;
2140 * Find a file which contains given module and load it, if "parent" is not
2141 * NULL, register a reference to it.
2144 linker_load_module(const char *kldname, const char *modname,
2145 struct linker_file *parent, const struct mod_depend *verinfo,
2146 struct linker_file **lfpp)
2148 linker_file_t lfdep;
2149 const char *filename;
2153 sx_assert(&kld_sx, SA_XLOCKED);
2154 if (modname == NULL) {
2156 * We have to load KLD
2158 KASSERT(verinfo == NULL, ("linker_load_module: verinfo"
2160 if (!linker_root_mounted())
2162 pathname = linker_search_kld(kldname);
2164 if (modlist_lookup2(modname, verinfo) != NULL)
2166 if (!linker_root_mounted())
2168 if (kldname != NULL)
2169 pathname = strdup(kldname, M_LINKER);
2172 * Need to find a KLD with required module
2174 pathname = linker_search_module(modname,
2175 strlen(modname), verinfo);
2177 if (pathname == NULL)
2181 * Can't load more than one file with the same basename XXX:
2182 * Actually it should be possible to have multiple KLDs with
2183 * the same basename but different path because they can
2184 * provide different versions of the same modules.
2186 filename = linker_basename(pathname);
2187 if (linker_find_file_by_name(filename))
2190 error = linker_load_file(pathname, &lfdep);
2193 if (modname && verinfo &&
2194 modlist_lookup2(modname, verinfo) == NULL) {
2195 linker_file_unload(lfdep, LINKER_UNLOAD_FORCE);
2200 error = linker_file_add_dependency(parent, lfdep);
2207 free(pathname, M_LINKER);
2212 * This routine is responsible for finding dependencies of userland initiated
2213 * kldload(2)'s of files.
2216 linker_load_dependencies(linker_file_t lf)
2218 linker_file_t lfdep;
2219 struct mod_metadata **start, **stop, **mdp, **nmdp;
2220 struct mod_metadata *mp, *nmp;
2221 const struct mod_depend *verinfo;
2223 const char *modname, *nmodname;
2227 * All files are dependent on /kernel.
2229 sx_assert(&kld_sx, SA_XLOCKED);
2230 if (linker_kernel_file) {
2231 linker_kernel_file->refs++;
2232 error = linker_file_add_dependency(lf, linker_kernel_file);
2236 if (linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop,
2239 for (mdp = start; mdp < stop; mdp++) {
2241 if (mp->md_type != MDT_VERSION)
2243 modname = mp->md_cval;
2244 ver = ((const struct mod_version *)mp->md_data)->mv_version;
2245 mod = modlist_lookup(modname, ver);
2247 printf("interface %s.%d already present in the KLD"
2248 " '%s'!\n", modname, ver,
2249 mod->container->filename);
2254 for (mdp = start; mdp < stop; mdp++) {
2256 if (mp->md_type != MDT_DEPEND)
2258 modname = mp->md_cval;
2259 verinfo = mp->md_data;
2261 for (nmdp = start; nmdp < stop; nmdp++) {
2263 if (nmp->md_type != MDT_VERSION)
2265 nmodname = nmp->md_cval;
2266 if (strcmp(modname, nmodname) == 0)
2269 if (nmdp < stop)/* early exit, it's a self reference */
2271 mod = modlist_lookup2(modname, verinfo);
2272 if (mod) { /* woohoo, it's loaded already */
2273 lfdep = mod->container;
2275 error = linker_file_add_dependency(lf, lfdep);
2280 error = linker_load_module(NULL, modname, lf, verinfo, NULL);
2282 printf("KLD %s: depends on %s - not available or"
2283 " version mismatch\n", lf->filename, modname);
2290 linker_addmodules(lf, start, stop, 0);
2295 sysctl_kern_function_list_iterate(const char *name, void *opaque)
2297 struct sysctl_req *req;
2300 return (SYSCTL_OUT(req, name, strlen(name) + 1));
2304 * Export a nul-separated, double-nul-terminated list of all function names
2308 sysctl_kern_function_list(SYSCTL_HANDLER_ARGS)
2314 error = mac_kld_check_stat(req->td->td_ucred);
2318 error = sysctl_wire_old_buffer(req, 0);
2322 TAILQ_FOREACH(lf, &linker_files, link) {
2323 error = LINKER_EACH_FUNCTION_NAME(lf,
2324 sysctl_kern_function_list_iterate, req);
2326 sx_xunlock(&kld_sx);
2330 sx_xunlock(&kld_sx);
2331 return (SYSCTL_OUT(req, "", 1));
2334 SYSCTL_PROC(_kern, OID_AUTO, function_list,
2335 CTLTYPE_OPAQUE | CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, 0,
2336 sysctl_kern_function_list, "",
2337 "kernel function list");