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/kernel.h>
38 #include <sys/systm.h>
39 #include <sys/malloc.h>
40 #include <sys/sysproto.h>
41 #include <sys/sysent.h>
45 #include <sys/mutex.h>
47 #include <sys/module.h>
48 #include <sys/mount.h>
49 #include <sys/linker.h>
50 #include <sys/eventhandler.h>
51 #include <sys/fcntl.h>
53 #include <sys/libkern.h>
54 #include <sys/namei.h>
55 #include <sys/vnode.h>
56 #include <sys/syscallsubr.h>
57 #include <sys/sysctl.h>
65 #include <security/mac/mac_framework.h>
67 #include "linker_if.h"
70 #include <sys/pmckern.h>
75 SYSCTL_INT(_debug, OID_AUTO, kld_debug, CTLFLAG_RWTUN,
76 &kld_debug, 0, "Set various levels of KLD debug");
79 /* These variables are used by kernel debuggers to enumerate loaded files. */
80 const int kld_off_address = offsetof(struct linker_file, address);
81 const int kld_off_filename = offsetof(struct linker_file, filename);
82 const int kld_off_pathname = offsetof(struct linker_file, pathname);
83 const int kld_off_next = offsetof(struct linker_file, link.tqe_next);
86 * static char *linker_search_path(const char *name, struct mod_depend
89 static const char *linker_basename(const char *path);
92 * Find a currently loaded file given its filename.
94 static linker_file_t linker_find_file_by_name(const char* _filename);
97 * Find a currently loaded file given its file id.
99 static linker_file_t linker_find_file_by_id(int _fileid);
101 /* Metadata from the static kernel */
102 SET_DECLARE(modmetadata_set, struct mod_metadata);
104 MALLOC_DEFINE(M_LINKER, "linker", "kernel linker");
106 linker_file_t linker_kernel_file;
108 static struct sx kld_sx; /* kernel linker lock */
109 static bool kld_busy;
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_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_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)
1069 error = sx_sleep(&kld_busy, &kld_sx,
1070 (flags & LINKER_UB_PCATCH) != 0 ? PCATCH : 0,
1073 if ((flags & LINKER_UB_UNLOCK) != 0)
1074 sx_xunlock(&kld_sx);
1079 if ((flags & LINKER_UB_UNLOCK) != 0)
1080 sx_xunlock(&kld_sx);
1085 linker_kldload_unbusy(int flags)
1087 MPASS((flags & ~LINKER_UB_LOCKED) == 0);
1088 if ((flags & LINKER_UB_LOCKED) != 0)
1089 sx_assert(&kld_sx, SA_XLOCKED);
1091 if ((flags & LINKER_UB_LOCKED) == 0)
1096 sx_xunlock(&kld_sx);
1103 kern_kldload(struct thread *td, const char *file, int *fileid)
1105 const char *kldname, *modname;
1109 if ((error = securelevel_gt(td->td_ucred, 0)) != 0)
1112 if ((error = priv_check(td, PRIV_KLD_LOAD)) != 0)
1116 * If file does not contain a qualified name or any dot in it
1117 * (kldname.ko, or kldname.ver.ko) treat it as an interface
1120 if (strchr(file, '/') || strchr(file, '.')) {
1128 error = linker_kldload_busy(LINKER_UB_PCATCH);
1130 sx_xunlock(&kld_sx);
1135 * It is possible that kldloaded module will attach a new ifnet,
1136 * so vnet context must be set when this ocurs.
1138 CURVNET_SET(TD_TO_VNET(td));
1140 error = linker_load_module(kldname, modname, NULL, NULL, &lf);
1148 linker_kldload_unbusy(LINKER_UB_LOCKED);
1153 sys_kldload(struct thread *td, struct kldload_args *uap)
1155 char *pathname = NULL;
1158 td->td_retval[0] = -1;
1160 pathname = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1161 error = copyinstr(uap->file, pathname, MAXPATHLEN, NULL);
1163 error = kern_kldload(td, pathname, &fileid);
1165 td->td_retval[0] = fileid;
1167 free(pathname, M_TEMP);
1172 kern_kldunload(struct thread *td, int fileid, int flags)
1177 if ((error = securelevel_gt(td->td_ucred, 0)) != 0)
1180 if ((error = priv_check(td, PRIV_KLD_UNLOAD)) != 0)
1183 error = linker_kldload_busy(LINKER_UB_PCATCH);
1185 sx_xunlock(&kld_sx);
1189 CURVNET_SET(TD_TO_VNET(td));
1190 lf = linker_find_file_by_id(fileid);
1192 KLD_DPF(FILE, ("kldunload: lf->userrefs=%d\n", lf->userrefs));
1194 if (lf->userrefs == 0) {
1196 * XXX: maybe LINKER_UNLOAD_FORCE should override ?
1198 printf("kldunload: attempt to unload file that was"
1199 " loaded by the kernel\n");
1203 error = linker_file_unload(lf, flags);
1210 linker_kldload_unbusy(LINKER_UB_LOCKED);
1215 sys_kldunload(struct thread *td, struct kldunload_args *uap)
1218 return (kern_kldunload(td, uap->fileid, LINKER_UNLOAD_NORMAL));
1222 sys_kldunloadf(struct thread *td, struct kldunloadf_args *uap)
1225 if (uap->flags != LINKER_UNLOAD_NORMAL &&
1226 uap->flags != LINKER_UNLOAD_FORCE)
1228 return (kern_kldunload(td, uap->fileid, uap->flags));
1232 sys_kldfind(struct thread *td, struct kldfind_args *uap)
1235 const char *filename;
1240 error = mac_kld_check_stat(td->td_ucred);
1245 td->td_retval[0] = -1;
1247 pathname = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1248 if ((error = copyinstr(uap->file, pathname, MAXPATHLEN, NULL)) != 0)
1251 filename = linker_basename(pathname);
1253 lf = linker_find_file_by_name(filename);
1255 td->td_retval[0] = lf->id;
1258 sx_xunlock(&kld_sx);
1260 free(pathname, M_TEMP);
1265 sys_kldnext(struct thread *td, struct kldnext_args *uap)
1271 error = mac_kld_check_stat(td->td_ucred);
1277 if (uap->fileid == 0)
1278 lf = TAILQ_FIRST(&linker_files);
1280 lf = linker_find_file_by_id(uap->fileid);
1285 lf = TAILQ_NEXT(lf, link);
1288 /* Skip partially loaded files. */
1289 while (lf != NULL && !(lf->flags & LINKER_FILE_LINKED))
1290 lf = TAILQ_NEXT(lf, link);
1293 td->td_retval[0] = lf->id;
1295 td->td_retval[0] = 0;
1297 sx_xunlock(&kld_sx);
1302 sys_kldstat(struct thread *td, struct kldstat_args *uap)
1304 struct kld_file_stat *stat;
1308 * Check the version of the user's structure.
1310 if ((error = copyin(&uap->stat->version, &version, sizeof(version)))
1313 if (version != sizeof(struct kld_file_stat_1) &&
1314 version != sizeof(struct kld_file_stat))
1317 stat = malloc(sizeof(*stat), M_TEMP, M_WAITOK | M_ZERO);
1318 error = kern_kldstat(td, uap->fileid, stat);
1320 error = copyout(stat, uap->stat, version);
1326 kern_kldstat(struct thread *td, int fileid, struct kld_file_stat *stat)
1333 error = mac_kld_check_stat(td->td_ucred);
1339 lf = linker_find_file_by_id(fileid);
1341 sx_xunlock(&kld_sx);
1345 /* Version 1 fields: */
1346 namelen = strlen(lf->filename) + 1;
1347 if (namelen > sizeof(stat->name))
1348 namelen = sizeof(stat->name);
1349 bcopy(lf->filename, &stat->name[0], namelen);
1350 stat->refs = lf->refs;
1352 stat->address = lf->address;
1353 stat->size = lf->size;
1354 /* Version 2 fields: */
1355 namelen = strlen(lf->pathname) + 1;
1356 if (namelen > sizeof(stat->pathname))
1357 namelen = sizeof(stat->pathname);
1358 bcopy(lf->pathname, &stat->pathname[0], namelen);
1359 sx_xunlock(&kld_sx);
1361 td->td_retval[0] = 0;
1366 DB_COMMAND(kldstat, db_kldstat)
1370 #define POINTER_WIDTH ((int)(sizeof(void *) * 2 + 2))
1371 db_printf("Id Refs Address%*c Size Name\n", POINTER_WIDTH - 7, ' ');
1372 #undef POINTER_WIDTH
1373 TAILQ_FOREACH(lf, &linker_files, link) {
1376 db_printf("%2d %4d %p %-8zx %s\n", lf->id, lf->refs,
1377 lf->address, lf->size, lf->filename);
1383 sys_kldfirstmod(struct thread *td, struct kldfirstmod_args *uap)
1390 error = mac_kld_check_stat(td->td_ucred);
1396 lf = linker_find_file_by_id(uap->fileid);
1399 mp = TAILQ_FIRST(&lf->modules);
1401 td->td_retval[0] = module_getid(mp);
1403 td->td_retval[0] = 0;
1407 sx_xunlock(&kld_sx);
1412 sys_kldsym(struct thread *td, struct kldsym_args *uap)
1414 char *symstr = NULL;
1416 linker_symval_t symval;
1418 struct kld_sym_lookup lookup;
1422 error = mac_kld_check_stat(td->td_ucred);
1427 if ((error = copyin(uap->data, &lookup, sizeof(lookup))) != 0)
1429 if (lookup.version != sizeof(lookup) ||
1430 uap->cmd != KLDSYM_LOOKUP)
1432 symstr = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1433 if ((error = copyinstr(lookup.symname, symstr, MAXPATHLEN, NULL)) != 0)
1436 if (uap->fileid != 0) {
1437 lf = linker_find_file_by_id(uap->fileid);
1440 else if (LINKER_LOOKUP_SYMBOL(lf, symstr, &sym) == 0 &&
1441 LINKER_SYMBOL_VALUES(lf, sym, &symval) == 0) {
1442 lookup.symvalue = (uintptr_t) symval.value;
1443 lookup.symsize = symval.size;
1444 error = copyout(&lookup, uap->data, sizeof(lookup));
1448 TAILQ_FOREACH(lf, &linker_files, link) {
1449 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,
1461 sx_xunlock(&kld_sx);
1463 free(symstr, M_TEMP);
1468 * Preloaded module support
1472 modlist_lookup(const char *name, int ver)
1476 TAILQ_FOREACH(mod, &found_modules, link) {
1477 if (strcmp(mod->name, name) == 0 &&
1478 (ver == 0 || mod->version == ver))
1485 modlist_lookup2(const char *name, const struct mod_depend *verinfo)
1487 modlist_t mod, bestmod;
1490 if (verinfo == NULL)
1491 return (modlist_lookup(name, 0));
1493 TAILQ_FOREACH(mod, &found_modules, link) {
1494 if (strcmp(mod->name, name) != 0)
1497 if (ver == verinfo->md_ver_preferred)
1499 if (ver >= verinfo->md_ver_minimum &&
1500 ver <= verinfo->md_ver_maximum &&
1501 (bestmod == NULL || ver > bestmod->version))
1508 modlist_newmodule(const char *modname, int version, linker_file_t container)
1512 mod = malloc(sizeof(struct modlist), M_LINKER, M_NOWAIT | M_ZERO);
1514 panic("no memory for module list");
1515 mod->container = container;
1516 mod->name = modname;
1517 mod->version = version;
1518 TAILQ_INSERT_TAIL(&found_modules, mod, link);
1523 linker_addmodules(linker_file_t lf, struct mod_metadata **start,
1524 struct mod_metadata **stop, int preload)
1526 struct mod_metadata *mp, **mdp;
1527 const char *modname;
1530 for (mdp = start; mdp < stop; mdp++) {
1532 if (mp->md_type != MDT_VERSION)
1534 modname = mp->md_cval;
1535 ver = ((const struct mod_version *)mp->md_data)->mv_version;
1536 if (modlist_lookup(modname, ver) != NULL) {
1537 printf("module %s already present!\n", modname);
1538 /* XXX what can we do? this is a build error. :-( */
1541 modlist_newmodule(modname, ver, lf);
1546 linker_preload(void *arg)
1549 const char *modname, *nmodname;
1551 linker_file_t lf, nlf;
1554 linker_file_list_t loaded_files;
1555 linker_file_list_t depended_files;
1556 struct mod_metadata *mp, *nmp;
1557 struct mod_metadata **start, **stop, **mdp, **nmdp;
1558 const struct mod_depend *verinfo;
1562 struct sysinit **si_start, **si_stop;
1564 TAILQ_INIT(&loaded_files);
1565 TAILQ_INIT(&depended_files);
1566 TAILQ_INIT(&found_modules);
1571 while ((modptr = preload_search_next_name(modptr)) != NULL) {
1572 modname = (char *)preload_search_info(modptr, MODINFO_NAME);
1573 modtype = (char *)preload_search_info(modptr, MODINFO_TYPE);
1574 if (modname == NULL) {
1575 printf("Preloaded module at %p does not have a"
1576 " name!\n", modptr);
1579 if (modtype == NULL) {
1580 printf("Preloaded module at %p does not have a type!\n",
1585 printf("Preloaded %s \"%s\" at %p.\n", modtype, modname,
1588 TAILQ_FOREACH(lc, &classes, link) {
1589 error = LINKER_LINK_PRELOAD(lc, modname, &lf);
1595 TAILQ_INSERT_TAIL(&loaded_files, lf, loaded);
1599 * First get a list of stuff in the kernel.
1601 if (linker_file_lookup_set(linker_kernel_file, MDT_SETNAME, &start,
1603 linker_addmodules(linker_kernel_file, start, stop, 1);
1606 * This is a once-off kinky bubble sort to resolve relocation
1607 * dependency requirements.
1610 TAILQ_FOREACH(lf, &loaded_files, loaded) {
1611 error = linker_file_lookup_set(lf, MDT_SETNAME, &start,
1614 * First, look to see if we would successfully link with this
1617 resolves = 1; /* unless we know otherwise */
1619 for (mdp = start; mdp < stop; mdp++) {
1621 if (mp->md_type != MDT_DEPEND)
1623 modname = mp->md_cval;
1624 verinfo = mp->md_data;
1625 for (nmdp = start; nmdp < stop; nmdp++) {
1627 if (nmp->md_type != MDT_VERSION)
1629 nmodname = nmp->md_cval;
1630 if (strcmp(modname, nmodname) == 0)
1633 if (nmdp < stop) /* it's a self reference */
1637 * ok, the module isn't here yet, we
1640 if (modlist_lookup2(modname, verinfo) == NULL)
1645 * OK, if we found our modules, we can link. So, "provide"
1646 * the modules inside and add it to the end of the link order
1651 for (mdp = start; mdp < stop; mdp++) {
1653 if (mp->md_type != MDT_VERSION)
1655 modname = mp->md_cval;
1656 nver = ((const struct mod_version *)
1657 mp->md_data)->mv_version;
1658 if (modlist_lookup(modname,
1660 printf("module %s already"
1661 " present!\n", modname);
1662 TAILQ_REMOVE(&loaded_files,
1664 linker_file_unload(lf,
1665 LINKER_UNLOAD_FORCE);
1666 /* we changed tailq next ptr */
1669 modlist_newmodule(modname, nver, lf);
1672 TAILQ_REMOVE(&loaded_files, lf, loaded);
1673 TAILQ_INSERT_TAIL(&depended_files, lf, loaded);
1675 * Since we provided modules, we need to restart the
1676 * sort so that the previous files that depend on us
1677 * have a chance. Also, we've busted the tailq next
1678 * pointer with the REMOVE.
1685 * At this point, we check to see what could not be resolved..
1687 while ((lf = TAILQ_FIRST(&loaded_files)) != NULL) {
1688 TAILQ_REMOVE(&loaded_files, lf, loaded);
1689 printf("KLD file %s is missing dependencies\n", lf->filename);
1690 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1694 * We made it. Finish off the linking in the order we determined.
1696 TAILQ_FOREACH_SAFE(lf, &depended_files, loaded, nlf) {
1697 if (linker_kernel_file) {
1698 linker_kernel_file->refs++;
1699 error = linker_file_add_dependency(lf,
1700 linker_kernel_file);
1702 panic("cannot add dependency");
1704 error = linker_file_lookup_set(lf, MDT_SETNAME, &start,
1707 for (mdp = start; mdp < stop; mdp++) {
1709 if (mp->md_type != MDT_DEPEND)
1711 modname = mp->md_cval;
1712 verinfo = mp->md_data;
1713 mod = modlist_lookup2(modname, verinfo);
1715 printf("KLD file %s - cannot find "
1716 "dependency \"%s\"\n",
1717 lf->filename, modname);
1720 /* Don't count self-dependencies */
1721 if (lf == mod->container)
1723 mod->container->refs++;
1724 error = linker_file_add_dependency(lf,
1727 panic("cannot add dependency");
1731 * Now do relocation etc using the symbol search paths
1732 * established by the dependencies
1734 error = LINKER_LINK_PRELOAD_FINISH(lf);
1736 printf("KLD file %s - could not finalize loading\n",
1740 linker_file_register_modules(lf);
1741 if (!TAILQ_EMPTY(&lf->modules))
1742 lf->flags |= LINKER_FILE_MODULES;
1743 if (linker_file_lookup_set(lf, "sysinit_set", &si_start,
1744 &si_stop, NULL) == 0)
1745 sysinit_add(si_start, si_stop);
1746 linker_file_register_sysctls(lf, true);
1747 lf->flags |= LINKER_FILE_LINKED;
1750 TAILQ_REMOVE(&depended_files, lf, loaded);
1751 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1753 sx_xunlock(&kld_sx);
1754 /* woohoo! we made it! */
1757 SYSINIT(preload, SI_SUB_KLD, SI_ORDER_MIDDLE, linker_preload, NULL);
1760 * Handle preload files that failed to load any modules.
1763 linker_preload_finish(void *arg)
1765 linker_file_t lf, nlf;
1768 TAILQ_FOREACH_SAFE(lf, &linker_files, link, nlf) {
1770 * If all of the modules in this file failed to load, unload
1771 * the file and return an error of ENOEXEC. (Parity with
1772 * linker_load_file.)
1774 if ((lf->flags & LINKER_FILE_MODULES) != 0 &&
1775 TAILQ_EMPTY(&lf->modules)) {
1776 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1780 lf->flags &= ~LINKER_FILE_MODULES;
1781 lf->userrefs++; /* so we can (try to) kldunload it */
1783 sx_xunlock(&kld_sx);
1787 * Attempt to run after all DECLARE_MODULE SYSINITs. Unfortunately they can be
1788 * scheduled at any subsystem and order, so run this as late as possible. init
1789 * becomes runnable in SI_SUB_KTHREAD_INIT, so go slightly before that.
1791 SYSINIT(preload_finish, SI_SUB_KTHREAD_INIT - 100, SI_ORDER_MIDDLE,
1792 linker_preload_finish, NULL);
1795 * Search for a not-loaded module by name.
1797 * Modules may be found in the following locations:
1799 * - preloaded (result is just the module name) - on disk (result is full path
1802 * If the module name is qualified in any way (contains path, etc.) the we
1803 * simply return a copy of it.
1805 * The search path can be manipulated via sysctl. Note that we use the ';'
1806 * character as a separator to be consistent with the bootloader.
1809 static char linker_hintfile[] = "linker.hints";
1810 static char linker_path[MAXPATHLEN] = "/boot/kernel;/boot/modules";
1812 SYSCTL_STRING(_kern, OID_AUTO, module_path, CTLFLAG_RWTUN, linker_path,
1813 sizeof(linker_path), "module load search path");
1815 TUNABLE_STR("module_path", linker_path, sizeof(linker_path));
1817 static const char * const linker_ext_list[] = {
1824 * Check if file actually exists either with or without extension listed in
1825 * the linker_ext_list. (probably should be generic for the rest of the
1829 linker_lookup_file(const char *path, int pathlen, const char *name,
1830 int namelen, struct vattr *vap)
1832 struct nameidata nd;
1833 struct thread *td = curthread; /* XXX */
1834 const char * const *cpp, *sep;
1836 int error, len, extlen, reclen, flags;
1840 for (cpp = linker_ext_list; *cpp; cpp++) {
1845 extlen++; /* trailing '\0' */
1846 sep = (path[pathlen - 1] != '/') ? "/" : "";
1848 reclen = pathlen + strlen(sep) + namelen + extlen + 1;
1849 result = malloc(reclen, M_LINKER, M_WAITOK);
1850 for (cpp = linker_ext_list; *cpp; cpp++) {
1851 snprintf(result, reclen, "%.*s%s%.*s%s", pathlen, path, sep,
1852 namelen, name, *cpp);
1854 * Attempt to open the file, and return the path if
1855 * we succeed and it's a regular file.
1857 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, result);
1859 error = vn_open(&nd, &flags, 0, NULL);
1861 NDFREE(&nd, NDF_ONLY_PNBUF);
1862 type = nd.ni_vp->v_type;
1864 VOP_GETATTR(nd.ni_vp, vap, td->td_ucred);
1865 VOP_UNLOCK(nd.ni_vp);
1866 vn_close(nd.ni_vp, FREAD, td->td_ucred, td);
1871 free(result, M_LINKER);
1875 #define INT_ALIGN(base, ptr) ptr = \
1876 (base) + roundup2((ptr) - (base), sizeof(int))
1879 * Lookup KLD which contains requested module in the "linker.hints" file. If
1880 * version specification is available, then try to find the best KLD.
1881 * Otherwise just find the latest one.
1884 linker_hints_lookup(const char *path, int pathlen, const char *modname,
1885 int modnamelen, const struct mod_depend *verinfo)
1887 struct thread *td = curthread; /* XXX */
1888 struct ucred *cred = td ? td->td_ucred : NULL;
1889 struct nameidata nd;
1890 struct vattr vattr, mattr;
1891 const char *best, *sep;
1892 u_char *hints = NULL;
1893 u_char *cp, *recptr, *bufend, *result, *pathbuf;
1894 int error, ival, bestver, *intp, found, flags, clen, blen;
1898 bestver = found = 0;
1900 sep = (path[pathlen - 1] != '/') ? "/" : "";
1901 reclen = imax(modnamelen, strlen(linker_hintfile)) + pathlen +
1903 pathbuf = malloc(reclen, M_LINKER, M_WAITOK);
1904 snprintf(pathbuf, reclen, "%.*s%s%s", pathlen, path, sep,
1907 NDINIT(&nd, LOOKUP, NOFOLLOW, UIO_SYSSPACE, pathbuf);
1909 error = vn_open(&nd, &flags, 0, NULL);
1912 NDFREE(&nd, NDF_ONLY_PNBUF);
1913 if (nd.ni_vp->v_type != VREG)
1916 error = VOP_GETATTR(nd.ni_vp, &vattr, cred);
1920 * XXX: we need to limit this number to some reasonable value
1922 if (vattr.va_size > LINKER_HINTS_MAX) {
1923 printf("linker.hints file too large %ld\n", (long)vattr.va_size);
1926 hints = malloc(vattr.va_size, M_TEMP, M_WAITOK);
1927 error = vn_rdwr(UIO_READ, nd.ni_vp, (caddr_t)hints, vattr.va_size, 0,
1928 UIO_SYSSPACE, IO_NODELOCKED, cred, NOCRED, &reclen, td);
1931 VOP_UNLOCK(nd.ni_vp);
1932 vn_close(nd.ni_vp, FREAD, cred, td);
1935 printf("can't read %zd\n", reclen);
1938 intp = (int *)hints;
1940 if (ival != LINKER_HINTS_VERSION) {
1941 printf("linker.hints file version mismatch %d\n", ival);
1944 bufend = hints + vattr.va_size;
1945 recptr = (u_char *)intp;
1947 while (recptr < bufend && !found) {
1948 intp = (int *)recptr;
1955 if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
1958 INT_ALIGN(hints, cp);
1962 if (verinfo == NULL ||
1963 ival == verinfo->md_ver_preferred) {
1967 if (ival >= verinfo->md_ver_minimum &&
1968 ival <= verinfo->md_ver_maximum &&
1978 recptr += reclen + sizeof(int);
1981 * Finally check if KLD is in the place
1984 result = linker_lookup_file(path, pathlen, cp, clen, &mattr);
1986 result = linker_lookup_file(path, pathlen, best, blen, &mattr);
1989 * KLD is newer than hints file. What we should do now?
1991 if (result && timespeccmp(&mattr.va_mtime, &vattr.va_mtime, >))
1992 printf("warning: KLD '%s' is newer than the linker.hints"
1995 free(pathbuf, M_LINKER);
1997 free(hints, M_TEMP);
1998 if (nd.ni_vp != NULL) {
1999 VOP_UNLOCK(nd.ni_vp);
2000 vn_close(nd.ni_vp, FREAD, cred, td);
2003 * If nothing found or hints is absent - fallback to the old
2004 * way by using "kldname[.ko]" as module name.
2006 if (!found && !bestver && result == NULL)
2007 result = linker_lookup_file(path, pathlen, modname,
2013 * Lookup KLD which contains requested module in the all directories.
2016 linker_search_module(const char *modname, int modnamelen,
2017 const struct mod_depend *verinfo)
2019 char *cp, *ep, *result;
2022 * traverse the linker path
2024 for (cp = linker_path; *cp; cp = ep + 1) {
2025 /* find the end of this component */
2026 for (ep = cp; (*ep != 0) && (*ep != ';'); ep++);
2027 result = linker_hints_lookup(cp, ep - cp, modname,
2028 modnamelen, verinfo);
2038 * Search for module in all directories listed in the linker_path.
2041 linker_search_kld(const char *name)
2043 char *cp, *ep, *result;
2046 /* qualified at all? */
2047 if (strchr(name, '/'))
2048 return (strdup(name, M_LINKER));
2050 /* traverse the linker path */
2052 for (ep = linker_path; *ep; ep++) {
2054 /* find the end of this component */
2055 for (; *ep != 0 && *ep != ';'; ep++);
2056 result = linker_lookup_file(cp, ep - cp, name, len, NULL);
2064 linker_basename(const char *path)
2066 const char *filename;
2068 filename = strrchr(path, '/');
2069 if (filename == NULL)
2078 * Inform hwpmc about the set of kernel modules currently loaded.
2081 linker_hwpmc_list_objects(void)
2084 struct pmckern_map_in *kobase;
2089 TAILQ_FOREACH(lf, &linker_files, link)
2092 /* Allocate nmappings + 1 entries. */
2093 kobase = malloc((nmappings + 1) * sizeof(struct pmckern_map_in),
2094 M_LINKER, M_WAITOK | M_ZERO);
2096 TAILQ_FOREACH(lf, &linker_files, link) {
2097 /* Save the info for this linker file. */
2098 kobase[i].pm_file = lf->filename;
2099 kobase[i].pm_address = (uintptr_t)lf->address;
2102 sx_sunlock(&kld_sx);
2104 KASSERT(i > 0, ("linker_hpwmc_list_objects: no kernel objects?"));
2106 /* The last entry of the malloced area comprises of all zeros. */
2107 KASSERT(kobase[i].pm_file == NULL,
2108 ("linker_hwpmc_list_objects: last object not NULL"));
2110 return ((void *)kobase);
2114 /* check if root file system is not mounted */
2116 linker_root_mounted(void)
2121 if (rootvnode == NULL)
2124 pwd = pwd_hold(curthread);
2125 ret = pwd->pwd_rdir != NULL;
2131 * Find a file which contains given module and load it, if "parent" is not
2132 * NULL, register a reference to it.
2135 linker_load_module(const char *kldname, const char *modname,
2136 struct linker_file *parent, const struct mod_depend *verinfo,
2137 struct linker_file **lfpp)
2139 linker_file_t lfdep;
2140 const char *filename;
2144 sx_assert(&kld_sx, SA_XLOCKED);
2145 if (modname == NULL) {
2147 * We have to load KLD
2149 KASSERT(verinfo == NULL, ("linker_load_module: verinfo"
2151 if (!linker_root_mounted())
2153 pathname = linker_search_kld(kldname);
2155 if (modlist_lookup2(modname, verinfo) != NULL)
2157 if (!linker_root_mounted())
2159 if (kldname != NULL)
2160 pathname = strdup(kldname, M_LINKER);
2163 * Need to find a KLD with required module
2165 pathname = linker_search_module(modname,
2166 strlen(modname), verinfo);
2168 if (pathname == NULL)
2172 * Can't load more than one file with the same basename XXX:
2173 * Actually it should be possible to have multiple KLDs with
2174 * the same basename but different path because they can
2175 * provide different versions of the same modules.
2177 filename = linker_basename(pathname);
2178 if (linker_find_file_by_name(filename))
2181 error = linker_load_file(pathname, &lfdep);
2184 if (modname && verinfo &&
2185 modlist_lookup2(modname, verinfo) == NULL) {
2186 linker_file_unload(lfdep, LINKER_UNLOAD_FORCE);
2191 error = linker_file_add_dependency(parent, lfdep);
2198 free(pathname, M_LINKER);
2203 * This routine is responsible for finding dependencies of userland initiated
2204 * kldload(2)'s of files.
2207 linker_load_dependencies(linker_file_t lf)
2209 linker_file_t lfdep;
2210 struct mod_metadata **start, **stop, **mdp, **nmdp;
2211 struct mod_metadata *mp, *nmp;
2212 const struct mod_depend *verinfo;
2214 const char *modname, *nmodname;
2218 * All files are dependent on /kernel.
2220 sx_assert(&kld_sx, SA_XLOCKED);
2221 if (linker_kernel_file) {
2222 linker_kernel_file->refs++;
2223 error = linker_file_add_dependency(lf, linker_kernel_file);
2227 if (linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop,
2230 for (mdp = start; mdp < stop; mdp++) {
2232 if (mp->md_type != MDT_VERSION)
2234 modname = mp->md_cval;
2235 ver = ((const struct mod_version *)mp->md_data)->mv_version;
2236 mod = modlist_lookup(modname, ver);
2238 printf("interface %s.%d already present in the KLD"
2239 " '%s'!\n", modname, ver,
2240 mod->container->filename);
2245 for (mdp = start; mdp < stop; mdp++) {
2247 if (mp->md_type != MDT_DEPEND)
2249 modname = mp->md_cval;
2250 verinfo = mp->md_data;
2252 for (nmdp = start; nmdp < stop; nmdp++) {
2254 if (nmp->md_type != MDT_VERSION)
2256 nmodname = nmp->md_cval;
2257 if (strcmp(modname, nmodname) == 0)
2260 if (nmdp < stop)/* early exit, it's a self reference */
2262 mod = modlist_lookup2(modname, verinfo);
2263 if (mod) { /* woohoo, it's loaded already */
2264 lfdep = mod->container;
2266 error = linker_file_add_dependency(lf, lfdep);
2271 error = linker_load_module(NULL, modname, lf, verinfo, NULL);
2273 printf("KLD %s: depends on %s - not available or"
2274 " version mismatch\n", lf->filename, modname);
2281 linker_addmodules(lf, start, stop, 0);
2286 sysctl_kern_function_list_iterate(const char *name, void *opaque)
2288 struct sysctl_req *req;
2291 return (SYSCTL_OUT(req, name, strlen(name) + 1));
2295 * Export a nul-separated, double-nul-terminated list of all function names
2299 sysctl_kern_function_list(SYSCTL_HANDLER_ARGS)
2305 error = mac_kld_check_stat(req->td->td_ucred);
2309 error = sysctl_wire_old_buffer(req, 0);
2313 TAILQ_FOREACH(lf, &linker_files, link) {
2314 error = LINKER_EACH_FUNCTION_NAME(lf,
2315 sysctl_kern_function_list_iterate, req);
2317 sx_xunlock(&kld_sx);
2321 sx_xunlock(&kld_sx);
2322 return (SYSCTL_OUT(req, "", 1));
2325 SYSCTL_PROC(_kern, OID_AUTO, function_list,
2326 CTLTYPE_OPAQUE | CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, 0,
2327 sysctl_kern_function_list, "",
2328 "kernel function list");