2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 1997-2000 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
32 #include "opt_hwpmc_hooks.h"
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/boottrace.h>
37 #include <sys/eventhandler.h>
38 #include <sys/fcntl.h>
40 #include <sys/kernel.h>
41 #include <sys/libkern.h>
42 #include <sys/linker.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/mount.h>
47 #include <sys/mutex.h>
48 #include <sys/namei.h>
52 #include <sys/syscallsubr.h>
53 #include <sys/sysctl.h>
54 #include <sys/sysproto.h>
55 #include <sys/vnode.h>
63 #include <security/mac/mac_framework.h>
65 #include "linker_if.h"
68 #include <sys/pmckern.h>
73 SYSCTL_INT(_debug, OID_AUTO, kld_debug, CTLFLAG_RWTUN,
74 &kld_debug, 0, "Set various levels of KLD debug");
77 /* These variables are used by kernel debuggers to enumerate loaded files. */
78 const int kld_off_address = offsetof(struct linker_file, address);
79 const int kld_off_filename = offsetof(struct linker_file, filename);
80 const int kld_off_pathname = offsetof(struct linker_file, pathname);
81 const int kld_off_next = offsetof(struct linker_file, link.tqe_next);
84 * static char *linker_search_path(const char *name, struct mod_depend
87 static const char *linker_basename(const char *path);
90 * Find a currently loaded file given its filename.
92 static linker_file_t linker_find_file_by_name(const char* _filename);
95 * Find a currently loaded file given its file id.
97 static linker_file_t linker_find_file_by_id(int _fileid);
99 /* Metadata from the static kernel */
100 SET_DECLARE(modmetadata_set, struct mod_metadata);
102 MALLOC_DEFINE(M_LINKER, "linker", "kernel linker");
104 linker_file_t linker_kernel_file;
106 static struct sx kld_sx; /* kernel linker lock */
107 static u_int kld_busy;
108 static struct thread *kld_busy_owner;
111 * Load counter used by clients to determine if a linker file has been
112 * re-loaded. This counter is incremented for each file load.
116 static linker_class_list_t classes;
117 static linker_file_list_t linker_files;
118 static int next_file_id = 1;
119 static int linker_no_more_classes = 0;
121 #define LINKER_GET_NEXT_FILE_ID(a) do { \
122 linker_file_t lftmp; \
125 sx_assert(&kld_sx, SA_XLOCKED); \
127 TAILQ_FOREACH(lftmp, &linker_files, link) { \
128 if (next_file_id == lftmp->id) { \
133 (a) = next_file_id; \
136 /* XXX wrong name; we're looking at version provision tags here, not modules */
137 typedef TAILQ_HEAD(, modlist) modlisthead_t;
139 TAILQ_ENTRY(modlist) link; /* chain together all modules */
140 linker_file_t container;
144 typedef struct modlist *modlist_t;
145 static modlisthead_t found_modules;
147 static void linker_file_add_dependency(linker_file_t file,
149 static caddr_t linker_file_lookup_symbol_internal(linker_file_t file,
150 const char* name, int deps);
151 static int linker_load_module(const char *kldname,
152 const char *modname, struct linker_file *parent,
153 const struct mod_depend *verinfo, struct linker_file **lfpp);
154 static modlist_t modlist_lookup2(const char *name, const struct mod_depend *verinfo);
157 linker_init(void *arg)
160 sx_init(&kld_sx, "kernel linker");
161 TAILQ_INIT(&classes);
162 TAILQ_INIT(&linker_files);
165 SYSINIT(linker, SI_SUB_KLD, SI_ORDER_FIRST, linker_init, NULL);
168 linker_stop_class_add(void *arg)
171 linker_no_more_classes = 1;
174 SYSINIT(linker_class, SI_SUB_KLD, SI_ORDER_ANY, linker_stop_class_add, NULL);
177 linker_add_class(linker_class_t lc)
181 * We disallow any class registration past SI_ORDER_ANY
182 * of SI_SUB_KLD. We bump the reference count to keep the
183 * ops from being freed.
185 if (linker_no_more_classes == 1)
187 kobj_class_compile((kobj_class_t) lc);
188 ((kobj_class_t)lc)->refs++; /* XXX: kobj_mtx */
189 TAILQ_INSERT_TAIL(&classes, lc, link);
194 linker_file_sysinit(linker_file_t lf)
196 struct sysinit **start, **stop, **sipp, **xipp, *save;
199 KLD_DPF(FILE, ("linker_file_sysinit: calling SYSINITs for %s\n",
202 sx_assert(&kld_sx, SA_XLOCKED);
204 if (linker_file_lookup_set(lf, "sysinit_set", &start, &stop, NULL) != 0)
207 * Perform a bubble sort of the system initialization objects by
208 * their subsystem (primary key) and order (secondary key).
210 * Since some things care about execution order, this is the operation
211 * which ensures continued function.
213 for (sipp = start; sipp < stop; sipp++) {
214 for (xipp = sipp + 1; xipp < stop; xipp++) {
215 if ((*sipp)->subsystem < (*xipp)->subsystem ||
216 ((*sipp)->subsystem == (*xipp)->subsystem &&
217 (*sipp)->order <= (*xipp)->order))
226 * Traverse the (now) ordered list of system initialization tasks.
227 * Perform each task, and continue on to the next task.
232 for (sipp = start; sipp < stop; sipp++) {
233 if ((*sipp)->subsystem == SI_SUB_DUMMY)
234 continue; /* skip dummy task(s) */
236 if ((*sipp)->subsystem > last)
237 BOOTTRACE("%s: sysinit 0x%7x", lf->filename,
241 (*((*sipp)->func)) ((*sipp)->udata);
242 last = (*sipp)->subsystem;
249 linker_file_sysuninit(linker_file_t lf)
251 struct sysinit **start, **stop, **sipp, **xipp, *save;
254 KLD_DPF(FILE, ("linker_file_sysuninit: calling SYSUNINITs for %s\n",
257 sx_assert(&kld_sx, SA_XLOCKED);
259 if (linker_file_lookup_set(lf, "sysuninit_set", &start, &stop,
264 * Perform a reverse bubble sort of the system initialization objects
265 * by their subsystem (primary key) and order (secondary key).
267 * Since some things care about execution order, this is the operation
268 * which ensures continued function.
270 for (sipp = start; sipp < stop; sipp++) {
271 for (xipp = sipp + 1; xipp < stop; xipp++) {
272 if ((*sipp)->subsystem > (*xipp)->subsystem ||
273 ((*sipp)->subsystem == (*xipp)->subsystem &&
274 (*sipp)->order >= (*xipp)->order))
283 * Traverse the (now) ordered list of system initialization tasks.
284 * Perform each task, and continue on to the next task.
289 for (sipp = start; sipp < stop; sipp++) {
290 if ((*sipp)->subsystem == SI_SUB_DUMMY)
291 continue; /* skip dummy task(s) */
293 if ((*sipp)->subsystem > last)
294 BOOTTRACE("%s: sysuninit 0x%7x", lf->filename,
298 (*((*sipp)->func)) ((*sipp)->udata);
299 last = (*sipp)->subsystem;
306 linker_file_register_sysctls(linker_file_t lf, bool enable)
308 struct sysctl_oid **start, **stop, **oidp;
311 ("linker_file_register_sysctls: registering SYSCTLs for %s\n",
314 sx_assert(&kld_sx, SA_XLOCKED);
316 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
321 for (oidp = start; oidp < stop; oidp++) {
323 sysctl_register_oid(*oidp);
325 sysctl_register_disabled_oid(*oidp);
332 * Invoke the LINKER_CTF_GET implementation for this file. Existing
333 * implementations will load CTF info from the filesystem upon the first call
334 * and cache it in the kernel thereafter.
337 linker_ctf_load_file(linker_file_t file)
342 error = linker_ctf_get(file, &lc);
346 printf("failed to load CTF for %s: %d\n", file->filename,
352 linker_file_enable_sysctls(linker_file_t lf)
354 struct sysctl_oid **start, **stop, **oidp;
357 ("linker_file_enable_sysctls: enable SYSCTLs for %s\n",
360 sx_assert(&kld_sx, SA_XLOCKED);
362 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
367 for (oidp = start; oidp < stop; oidp++)
368 sysctl_enable_oid(*oidp);
374 linker_file_unregister_sysctls(linker_file_t lf)
376 struct sysctl_oid **start, **stop, **oidp;
378 KLD_DPF(FILE, ("linker_file_unregister_sysctls: unregistering SYSCTLs"
379 " for %s\n", lf->filename));
381 sx_assert(&kld_sx, SA_XLOCKED);
383 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
388 for (oidp = start; oidp < stop; oidp++)
389 sysctl_unregister_oid(*oidp);
395 linker_file_register_modules(linker_file_t lf)
397 struct mod_metadata **start, **stop, **mdp;
398 const moduledata_t *moddata;
399 int first_error, error;
401 KLD_DPF(FILE, ("linker_file_register_modules: registering modules"
402 " in %s\n", lf->filename));
404 sx_assert(&kld_sx, SA_XLOCKED);
406 if (linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop, NULL) != 0) {
408 * This fallback should be unnecessary, but if we get booted
409 * from boot2 instead of loader and we are missing our
410 * metadata then we have to try the best we can.
412 if (lf == linker_kernel_file) {
413 start = SET_BEGIN(modmetadata_set);
414 stop = SET_LIMIT(modmetadata_set);
419 for (mdp = start; mdp < stop; mdp++) {
420 if ((*mdp)->md_type != MDT_MODULE)
422 moddata = (*mdp)->md_data;
423 KLD_DPF(FILE, ("Registering module %s in %s\n",
424 moddata->name, lf->filename));
425 error = module_register(moddata, lf);
427 printf("Module %s failed to register: %d\n",
428 moddata->name, error);
429 if (first_error == 0)
433 return (first_error);
437 linker_init_kernel_modules(void)
441 linker_file_register_modules(linker_kernel_file);
445 SYSINIT(linker_kernel, SI_SUB_KLD, SI_ORDER_ANY, linker_init_kernel_modules,
449 linker_load_file(const char *filename, linker_file_t *result)
453 int foundfile, error, modules;
455 /* Refuse to load modules if securelevel raised */
456 if (prison0.pr_securelevel > 0)
459 sx_assert(&kld_sx, SA_XLOCKED);
460 lf = linker_find_file_by_name(filename);
462 KLD_DPF(FILE, ("linker_load_file: file %s is already loaded,"
463 " incrementing refs\n", filename));
472 * We do not need to protect (lock) classes here because there is
473 * no class registration past startup (SI_SUB_KLD, SI_ORDER_ANY)
474 * and there is no class deregistration mechanism at this time.
476 TAILQ_FOREACH(lc, &classes, link) {
477 KLD_DPF(FILE, ("linker_load_file: trying to load %s\n",
479 error = LINKER_LOAD_FILE(lc, filename, &lf);
481 * If we got something other than ENOENT, then it exists but
482 * we cannot load it for some other reason.
484 if (error != ENOENT) {
490 error = linker_file_register_modules(lf);
491 if (error == EEXIST) {
492 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
495 modules = !TAILQ_EMPTY(&lf->modules);
496 linker_file_register_sysctls(lf, false);
498 LINKER_PROPAGATE_VNETS(lf);
500 linker_file_sysinit(lf);
501 lf->flags |= LINKER_FILE_LINKED;
504 * If all of the modules in this file failed
505 * to load, unload the file and return an
508 if (modules && TAILQ_EMPTY(&lf->modules)) {
509 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
512 linker_file_enable_sysctls(lf);
515 * Ask the linker to load CTF data for this file.
517 linker_ctf_load_file(lf);
518 EVENTHANDLER_INVOKE(kld_load, lf);
524 * Less than ideal, but tells the user whether it failed to load or
525 * the module was not found.
529 * If the file type has not been recognized by the last try
530 * printout a message before to fail.
533 printf("%s: %s - unsupported file type\n",
537 * Format not recognized or otherwise unloadable.
538 * When loading a module that is statically built into
539 * the kernel EEXIST percolates back up as the return
540 * value. Preserve this so that apps like sysinstall
541 * can recognize this special case and not post bogus
547 error = ENOENT; /* Nothing found */
552 linker_reference_module(const char *modname, struct mod_depend *verinfo,
553 linker_file_t *result)
559 if ((mod = modlist_lookup2(modname, verinfo)) != NULL) {
560 *result = mod->container;
566 error = linker_load_module(NULL, modname, NULL, verinfo, result);
572 linker_release_module(const char *modname, struct mod_depend *verinfo,
580 KASSERT(modname != NULL,
581 ("linker_release_module: no file or name"));
582 mod = modlist_lookup2(modname, verinfo);
589 KASSERT(modname == NULL && verinfo == NULL,
590 ("linker_release_module: both file and name"));
591 error = linker_file_unload(lf, LINKER_UNLOAD_NORMAL);
597 linker_find_file_by_name(const char *filename)
602 koname = malloc(strlen(filename) + 4, M_LINKER, M_WAITOK);
603 sprintf(koname, "%s.ko", filename);
605 sx_assert(&kld_sx, SA_XLOCKED);
606 TAILQ_FOREACH(lf, &linker_files, link) {
607 if (strcmp(lf->filename, koname) == 0)
609 if (strcmp(lf->filename, filename) == 0)
612 free(koname, M_LINKER);
617 linker_find_file_by_id(int fileid)
621 sx_assert(&kld_sx, SA_XLOCKED);
622 TAILQ_FOREACH(lf, &linker_files, link)
623 if (lf->id == fileid && lf->flags & LINKER_FILE_LINKED)
629 linker_file_foreach(linker_predicate_t *predicate, void *context)
635 TAILQ_FOREACH(lf, &linker_files, link) {
636 retval = predicate(lf, context);
645 linker_make_file(const char *pathname, linker_class_t lc)
648 const char *filename;
651 sx_assert(&kld_sx, SA_XLOCKED);
652 filename = linker_basename(pathname);
654 KLD_DPF(FILE, ("linker_make_file: new file, filename='%s' for pathname='%s'\n", filename, pathname));
655 lf = (linker_file_t)kobj_create((kobj_class_t)lc, M_LINKER, M_WAITOK);
665 lf->filename = strdup(filename, M_LINKER);
666 lf->pathname = strdup(pathname, M_LINKER);
667 LINKER_GET_NEXT_FILE_ID(lf->id);
670 lf->loadcnt = ++loadcnt;
675 STAILQ_INIT(&lf->common);
676 TAILQ_INIT(&lf->modules);
677 TAILQ_INSERT_TAIL(&linker_files, lf, link);
682 linker_file_unload(linker_file_t file, int flags)
685 modlist_t ml, nextml;
686 struct common_symbol *cp;
689 /* Refuse to unload modules if securelevel raised. */
690 if (prison0.pr_securelevel > 0)
693 sx_assert(&kld_sx, SA_XLOCKED);
694 KLD_DPF(FILE, ("linker_file_unload: lf->refs=%d\n", file->refs));
696 /* Easy case of just dropping a reference. */
697 if (file->refs > 1) {
702 /* Give eventhandlers a chance to prevent the unload. */
704 EVENTHANDLER_INVOKE(kld_unload_try, file, &error);
708 KLD_DPF(FILE, ("linker_file_unload: file is unloading,"
709 " informing modules\n"));
712 * Quiesce all the modules to give them a chance to veto the unload.
715 for (mod = TAILQ_FIRST(&file->modules); mod;
716 mod = module_getfnext(mod)) {
717 error = module_quiesce(mod);
718 if (error != 0 && flags != LINKER_UNLOAD_FORCE) {
719 KLD_DPF(FILE, ("linker_file_unload: module %s"
720 " vetoed unload\n", module_getname(mod)));
722 * XXX: Do we need to tell all the quiesced modules
723 * that they can resume work now via a new module
733 * Inform any modules associated with this file that they are
737 for (mod = TAILQ_FIRST(&file->modules); mod; mod = next) {
738 next = module_getfnext(mod);
742 * Give the module a chance to veto the unload.
744 if ((error = module_unload(mod)) != 0) {
747 KLD_DPF(FILE, ("linker_file_unload: module %s"
748 " failed unload\n", module_getname(mod)));
758 TAILQ_FOREACH_SAFE(ml, &found_modules, link, nextml) {
759 if (ml->container == file) {
760 TAILQ_REMOVE(&found_modules, ml, link);
766 * Don't try to run SYSUNINITs if we are unloaded due to a
769 if (file->flags & LINKER_FILE_LINKED) {
770 file->flags &= ~LINKER_FILE_LINKED;
771 linker_file_unregister_sysctls(file);
772 linker_file_sysuninit(file);
774 TAILQ_REMOVE(&linker_files, file, link);
777 for (i = 0; i < file->ndeps; i++)
778 linker_file_unload(file->deps[i], flags);
779 free(file->deps, M_LINKER);
782 while ((cp = STAILQ_FIRST(&file->common)) != NULL) {
783 STAILQ_REMOVE_HEAD(&file->common, link);
789 EVENTHANDLER_INVOKE(kld_unload, file->filename, file->address,
792 if (file->filename) {
793 free(file->filename, M_LINKER);
794 file->filename = NULL;
796 if (file->pathname) {
797 free(file->pathname, M_LINKER);
798 file->pathname = NULL;
800 kobj_delete((kobj_t) file, M_LINKER);
805 linker_ctf_get(linker_file_t file, linker_ctf_t *lc)
807 return (LINKER_CTF_GET(file, lc));
811 linker_ctf_lookup_typename_ddb(linker_ctf_t *lc, const char *typename)
816 TAILQ_FOREACH (lf, &linker_files, link){
817 if (LINKER_CTF_LOOKUP_TYPENAME(lf, lc, typename) == 0)
825 linker_ctf_lookup_sym_ddb(const char *symname, c_linker_sym_t *sym,
831 TAILQ_FOREACH (lf, &linker_files, link){
832 if (LINKER_LOOKUP_DEBUG_SYMBOL_CTF(lf, symname, sym, lc) == 0)
840 linker_file_add_dependency(linker_file_t file, linker_file_t dep)
842 linker_file_t *newdeps;
844 sx_assert(&kld_sx, SA_XLOCKED);
845 file->deps = realloc(file->deps, (file->ndeps + 1) * sizeof(*newdeps),
846 M_LINKER, M_WAITOK | M_ZERO);
847 file->deps[file->ndeps] = dep;
849 KLD_DPF(FILE, ("linker_file_add_dependency:"
850 " adding %s as dependency for %s\n",
851 dep->filename, file->filename));
855 * Locate a linker set and its contents. This is a helper function to avoid
856 * linker_if.h exposure elsewhere. Note: firstp and lastp are really void **.
857 * This function is used in this file so we can avoid having lots of (void **)
861 linker_file_lookup_set(linker_file_t file, const char *name,
862 void *firstp, void *lastp, int *countp)
865 sx_assert(&kld_sx, SA_LOCKED);
866 return (LINKER_LOOKUP_SET(file, name, firstp, lastp, countp));
870 * List all functions in a file.
873 linker_file_function_listall(linker_file_t lf,
874 linker_function_nameval_callback_t callback_func, void *arg)
876 return (LINKER_EACH_FUNCTION_NAMEVAL(lf, callback_func, arg));
880 linker_file_lookup_symbol(linker_file_t file, const char *name, int deps)
885 locked = sx_xlocked(&kld_sx);
888 sym = linker_file_lookup_symbol_internal(file, name, deps);
895 linker_file_lookup_symbol_internal(linker_file_t file, const char *name,
899 linker_symval_t symval;
901 size_t common_size = 0;
904 sx_assert(&kld_sx, SA_XLOCKED);
905 KLD_DPF(SYM, ("linker_file_lookup_symbol: file=%p, name=%s, deps=%d\n",
908 if (LINKER_LOOKUP_SYMBOL(file, name, &sym) == 0) {
909 LINKER_SYMBOL_VALUES(file, sym, &symval);
910 if (symval.value == 0)
912 * For commons, first look them up in the
913 * dependencies and only allocate space if not found
916 common_size = symval.size;
918 KLD_DPF(SYM, ("linker_file_lookup_symbol: symbol"
919 ".value=%p\n", symval.value));
920 return (symval.value);
924 for (i = 0; i < file->ndeps; i++) {
925 address = linker_file_lookup_symbol_internal(
926 file->deps[i], name, 0);
928 KLD_DPF(SYM, ("linker_file_lookup_symbol:"
929 " deps value=%p\n", address));
934 if (common_size > 0) {
936 * This is a common symbol which was not found in the
937 * dependencies. We maintain a simple common symbol table in
940 struct common_symbol *cp;
942 STAILQ_FOREACH(cp, &file->common, link) {
943 if (strcmp(cp->name, name) == 0) {
944 KLD_DPF(SYM, ("linker_file_lookup_symbol:"
945 " old common value=%p\n", cp->address));
946 return (cp->address);
950 * Round the symbol size up to align.
952 common_size = (common_size + sizeof(int) - 1) & -sizeof(int);
953 cp = malloc(sizeof(struct common_symbol)
954 + common_size + strlen(name) + 1, M_LINKER,
956 cp->address = (caddr_t)(cp + 1);
957 cp->name = cp->address + common_size;
958 strcpy(cp->name, name);
959 bzero(cp->address, common_size);
960 STAILQ_INSERT_TAIL(&file->common, cp, link);
962 KLD_DPF(SYM, ("linker_file_lookup_symbol: new common"
963 " value=%p\n", cp->address));
964 return (cp->address);
966 KLD_DPF(SYM, ("linker_file_lookup_symbol: fail\n"));
971 * Both DDB and stack(9) rely on the kernel linker to provide forward and
972 * backward lookup of symbols. However, DDB and sometimes stack(9) need to
973 * do this in a lockfree manner. We provide a set of internal helper
974 * routines to perform these operations without locks, and then wrappers that
977 * linker_debug_lookup() is ifdef DDB as currently it's only used by DDB.
981 linker_debug_lookup(const char *symstr, c_linker_sym_t *sym)
985 TAILQ_FOREACH(lf, &linker_files, link) {
986 if (LINKER_LOOKUP_DEBUG_SYMBOL(lf, symstr, sym) == 0)
994 linker_debug_search_symbol(caddr_t value, c_linker_sym_t *sym, long *diffp)
997 c_linker_sym_t best, es;
998 u_long diff, bestdiff, off;
1001 off = (uintptr_t)value;
1003 TAILQ_FOREACH(lf, &linker_files, link) {
1004 if (LINKER_SEARCH_SYMBOL(lf, value, &es, &diff) != 0)
1006 if (es != 0 && diff < bestdiff) {
1025 linker_debug_symbol_values(c_linker_sym_t sym, linker_symval_t *symval)
1029 TAILQ_FOREACH(lf, &linker_files, link) {
1030 if (LINKER_DEBUG_SYMBOL_VALUES(lf, sym, symval) == 0)
1037 linker_debug_search_symbol_name(caddr_t value, char *buf, u_int buflen,
1040 linker_symval_t symval;
1045 error = linker_debug_search_symbol(value, &sym, offset);
1048 error = linker_debug_symbol_values(sym, &symval);
1051 strlcpy(buf, symval.name, buflen);
1056 * DDB Helpers. DDB has to look across multiple files with their own symbol
1057 * tables and string tables.
1059 * Note that we do not obey list locking protocols here. We really don't need
1060 * DDB to hang because somebody's got the lock held. We'll take the chance
1061 * that the files list is inconsistent instead.
1065 linker_ddb_lookup(const char *symstr, c_linker_sym_t *sym)
1068 return (linker_debug_lookup(symstr, sym));
1073 linker_ddb_search_symbol(caddr_t value, c_linker_sym_t *sym, long *diffp)
1076 return (linker_debug_search_symbol(value, sym, diffp));
1080 linker_ddb_symbol_values(c_linker_sym_t sym, linker_symval_t *symval)
1083 return (linker_debug_symbol_values(sym, symval));
1087 linker_ddb_search_symbol_name(caddr_t value, char *buf, u_int buflen,
1091 return (linker_debug_search_symbol_name(value, buf, buflen, offset));
1095 * stack(9) helper for non-debugging environemnts. Unlike DDB helpers, we do
1096 * obey locking protocols, and offer a significantly less complex interface.
1099 linker_search_symbol_name_flags(caddr_t value, char *buf, u_int buflen,
1100 long *offset, int flags)
1104 KASSERT((flags & (M_NOWAIT | M_WAITOK)) != 0 &&
1105 (flags & (M_NOWAIT | M_WAITOK)) != (M_NOWAIT | M_WAITOK),
1106 ("%s: bad flags: 0x%x", __func__, flags));
1108 if (flags & M_NOWAIT) {
1109 if (!sx_try_slock(&kld_sx))
1110 return (EWOULDBLOCK);
1114 error = linker_debug_search_symbol_name(value, buf, buflen, offset);
1115 sx_sunlock(&kld_sx);
1120 linker_search_symbol_name(caddr_t value, char *buf, u_int buflen,
1124 return (linker_search_symbol_name_flags(value, buf, buflen, offset,
1129 linker_kldload_busy(int flags)
1133 MPASS((flags & ~(LINKER_UB_UNLOCK | LINKER_UB_LOCKED |
1134 LINKER_UB_PCATCH)) == 0);
1135 if ((flags & LINKER_UB_LOCKED) != 0)
1136 sx_assert(&kld_sx, SA_XLOCKED);
1138 if ((flags & LINKER_UB_LOCKED) == 0)
1140 while (kld_busy > 0) {
1141 if (kld_busy_owner == curthread)
1143 error = sx_sleep(&kld_busy, &kld_sx,
1144 (flags & LINKER_UB_PCATCH) != 0 ? PCATCH : 0,
1147 if ((flags & LINKER_UB_UNLOCK) != 0)
1148 sx_xunlock(&kld_sx);
1153 kld_busy_owner = curthread;
1154 if ((flags & LINKER_UB_UNLOCK) != 0)
1155 sx_xunlock(&kld_sx);
1160 linker_kldload_unbusy(int flags)
1162 MPASS((flags & ~LINKER_UB_LOCKED) == 0);
1163 if ((flags & LINKER_UB_LOCKED) != 0)
1164 sx_assert(&kld_sx, SA_XLOCKED);
1166 if ((flags & LINKER_UB_LOCKED) == 0)
1168 MPASS(kld_busy > 0);
1169 if (kld_busy_owner != curthread)
1170 panic("linker_kldload_unbusy done by not owning thread %p",
1173 if (kld_busy == 0) {
1174 kld_busy_owner = NULL;
1177 sx_xunlock(&kld_sx);
1184 kern_kldload(struct thread *td, const char *file, int *fileid)
1186 const char *kldname, *modname;
1190 if ((error = securelevel_gt(td->td_ucred, 0)) != 0)
1193 if ((error = priv_check(td, PRIV_KLD_LOAD)) != 0)
1197 * If file does not contain a qualified name or any dot in it
1198 * (kldname.ko, or kldname.ver.ko) treat it as an interface
1201 if (strchr(file, '/') || strchr(file, '.')) {
1209 error = linker_kldload_busy(LINKER_UB_PCATCH);
1211 sx_xunlock(&kld_sx);
1216 * It is possible that kldloaded module will attach a new ifnet,
1217 * so vnet context must be set when this ocurs.
1219 CURVNET_SET(TD_TO_VNET(td));
1221 error = linker_load_module(kldname, modname, NULL, NULL, &lf);
1229 linker_kldload_unbusy(LINKER_UB_LOCKED);
1234 sys_kldload(struct thread *td, struct kldload_args *uap)
1236 char *pathname = NULL;
1239 td->td_retval[0] = -1;
1241 pathname = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1242 error = copyinstr(uap->file, pathname, MAXPATHLEN, NULL);
1244 error = kern_kldload(td, pathname, &fileid);
1246 td->td_retval[0] = fileid;
1248 free(pathname, M_TEMP);
1253 kern_kldunload(struct thread *td, int fileid, int flags)
1258 if ((error = securelevel_gt(td->td_ucred, 0)) != 0)
1261 if ((error = priv_check(td, PRIV_KLD_UNLOAD)) != 0)
1264 error = linker_kldload_busy(LINKER_UB_PCATCH);
1266 sx_xunlock(&kld_sx);
1270 CURVNET_SET(TD_TO_VNET(td));
1271 lf = linker_find_file_by_id(fileid);
1273 KLD_DPF(FILE, ("kldunload: lf->userrefs=%d\n", lf->userrefs));
1275 if (lf->userrefs == 0) {
1277 * XXX: maybe LINKER_UNLOAD_FORCE should override ?
1279 printf("kldunload: attempt to unload file that was"
1280 " loaded by the kernel\n");
1282 } else if (lf->refs > 1) {
1286 error = linker_file_unload(lf, flags);
1293 linker_kldload_unbusy(LINKER_UB_LOCKED);
1298 sys_kldunload(struct thread *td, struct kldunload_args *uap)
1301 return (kern_kldunload(td, uap->fileid, LINKER_UNLOAD_NORMAL));
1305 sys_kldunloadf(struct thread *td, struct kldunloadf_args *uap)
1308 if (uap->flags != LINKER_UNLOAD_NORMAL &&
1309 uap->flags != LINKER_UNLOAD_FORCE)
1311 return (kern_kldunload(td, uap->fileid, uap->flags));
1315 sys_kldfind(struct thread *td, struct kldfind_args *uap)
1318 const char *filename;
1323 error = mac_kld_check_stat(td->td_ucred);
1328 td->td_retval[0] = -1;
1330 pathname = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1331 if ((error = copyinstr(uap->file, pathname, MAXPATHLEN, NULL)) != 0)
1334 filename = linker_basename(pathname);
1336 lf = linker_find_file_by_name(filename);
1338 td->td_retval[0] = lf->id;
1341 sx_xunlock(&kld_sx);
1343 free(pathname, M_TEMP);
1348 sys_kldnext(struct thread *td, struct kldnext_args *uap)
1354 error = mac_kld_check_stat(td->td_ucred);
1360 if (uap->fileid == 0)
1361 lf = TAILQ_FIRST(&linker_files);
1363 lf = linker_find_file_by_id(uap->fileid);
1368 lf = TAILQ_NEXT(lf, link);
1371 /* Skip partially loaded files. */
1372 while (lf != NULL && !(lf->flags & LINKER_FILE_LINKED))
1373 lf = TAILQ_NEXT(lf, link);
1376 td->td_retval[0] = lf->id;
1378 td->td_retval[0] = 0;
1380 sx_xunlock(&kld_sx);
1385 sys_kldstat(struct thread *td, struct kldstat_args *uap)
1387 struct kld_file_stat *stat;
1391 * Check the version of the user's structure.
1393 if ((error = copyin(&uap->stat->version, &version, sizeof(version)))
1396 if (version != sizeof(struct kld_file_stat_1) &&
1397 version != sizeof(struct kld_file_stat))
1400 stat = malloc(sizeof(*stat), M_TEMP, M_WAITOK | M_ZERO);
1401 error = kern_kldstat(td, uap->fileid, stat);
1403 error = copyout(stat, uap->stat, version);
1409 kern_kldstat(struct thread *td, int fileid, struct kld_file_stat *stat)
1416 error = mac_kld_check_stat(td->td_ucred);
1422 lf = linker_find_file_by_id(fileid);
1424 sx_xunlock(&kld_sx);
1428 /* Version 1 fields: */
1429 namelen = strlen(lf->filename) + 1;
1430 if (namelen > sizeof(stat->name))
1431 namelen = sizeof(stat->name);
1432 bcopy(lf->filename, &stat->name[0], namelen);
1433 stat->refs = lf->refs;
1435 stat->address = lf->address;
1436 stat->size = lf->size;
1437 /* Version 2 fields: */
1438 namelen = strlen(lf->pathname) + 1;
1439 if (namelen > sizeof(stat->pathname))
1440 namelen = sizeof(stat->pathname);
1441 bcopy(lf->pathname, &stat->pathname[0], namelen);
1442 sx_xunlock(&kld_sx);
1444 td->td_retval[0] = 0;
1449 DB_COMMAND_FLAGS(kldstat, db_kldstat, DB_CMD_MEMSAFE)
1453 #define POINTER_WIDTH ((int)(sizeof(void *) * 2 + 2))
1454 db_printf("Id Refs Address%*c Size Name\n", POINTER_WIDTH - 7, ' ');
1455 #undef POINTER_WIDTH
1456 TAILQ_FOREACH(lf, &linker_files, link) {
1459 db_printf("%2d %4d %p %-8zx %s\n", lf->id, lf->refs,
1460 lf->address, lf->size, lf->filename);
1466 sys_kldfirstmod(struct thread *td, struct kldfirstmod_args *uap)
1473 error = mac_kld_check_stat(td->td_ucred);
1479 lf = linker_find_file_by_id(uap->fileid);
1482 mp = TAILQ_FIRST(&lf->modules);
1484 td->td_retval[0] = module_getid(mp);
1486 td->td_retval[0] = 0;
1490 sx_xunlock(&kld_sx);
1495 sys_kldsym(struct thread *td, struct kldsym_args *uap)
1497 char *symstr = NULL;
1499 linker_symval_t symval;
1501 struct kld_sym_lookup lookup;
1505 error = mac_kld_check_stat(td->td_ucred);
1510 if ((error = copyin(uap->data, &lookup, sizeof(lookup))) != 0)
1512 if (lookup.version != sizeof(lookup) ||
1513 uap->cmd != KLDSYM_LOOKUP)
1515 symstr = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1516 if ((error = copyinstr(lookup.symname, symstr, MAXPATHLEN, NULL)) != 0)
1519 if (uap->fileid != 0) {
1520 lf = linker_find_file_by_id(uap->fileid);
1523 else if (LINKER_LOOKUP_SYMBOL(lf, symstr, &sym) == 0 &&
1524 LINKER_SYMBOL_VALUES(lf, sym, &symval) == 0) {
1525 lookup.symvalue = (uintptr_t) symval.value;
1526 lookup.symsize = symval.size;
1527 error = copyout(&lookup, uap->data, sizeof(lookup));
1531 TAILQ_FOREACH(lf, &linker_files, link) {
1532 if (LINKER_LOOKUP_SYMBOL(lf, symstr, &sym) == 0 &&
1533 LINKER_SYMBOL_VALUES(lf, sym, &symval) == 0) {
1534 lookup.symvalue = (uintptr_t)symval.value;
1535 lookup.symsize = symval.size;
1536 error = copyout(&lookup, uap->data,
1544 sx_xunlock(&kld_sx);
1546 free(symstr, M_TEMP);
1551 * Preloaded module support
1555 modlist_lookup(const char *name, int ver)
1559 TAILQ_FOREACH(mod, &found_modules, link) {
1560 if (strcmp(mod->name, name) == 0 &&
1561 (ver == 0 || mod->version == ver))
1568 modlist_lookup2(const char *name, const struct mod_depend *verinfo)
1570 modlist_t mod, bestmod;
1573 if (verinfo == NULL)
1574 return (modlist_lookup(name, 0));
1576 TAILQ_FOREACH(mod, &found_modules, link) {
1577 if (strcmp(mod->name, name) != 0)
1580 if (ver == verinfo->md_ver_preferred)
1582 if (ver >= verinfo->md_ver_minimum &&
1583 ver <= verinfo->md_ver_maximum &&
1584 (bestmod == NULL || ver > bestmod->version))
1591 modlist_newmodule(const char *modname, int version, linker_file_t container)
1595 mod = malloc(sizeof(struct modlist), M_LINKER, M_NOWAIT | M_ZERO);
1597 panic("no memory for module list");
1598 mod->container = container;
1599 mod->name = modname;
1600 mod->version = version;
1601 TAILQ_INSERT_TAIL(&found_modules, mod, link);
1606 linker_addmodules(linker_file_t lf, struct mod_metadata **start,
1607 struct mod_metadata **stop, int preload)
1609 struct mod_metadata *mp, **mdp;
1610 const char *modname;
1613 for (mdp = start; mdp < stop; mdp++) {
1615 if (mp->md_type != MDT_VERSION)
1617 modname = mp->md_cval;
1618 ver = ((const struct mod_version *)mp->md_data)->mv_version;
1619 if (modlist_lookup(modname, ver) != NULL) {
1620 printf("module %s already present!\n", modname);
1621 /* XXX what can we do? this is a build error. :-( */
1624 modlist_newmodule(modname, ver, lf);
1629 linker_preload(void *arg)
1632 const char *modname, *nmodname;
1634 linker_file_t lf, nlf;
1637 linker_file_list_t loaded_files;
1638 linker_file_list_t depended_files;
1639 struct mod_metadata *mp, *nmp;
1640 struct mod_metadata **start, **stop, **mdp, **nmdp;
1641 const struct mod_depend *verinfo;
1645 struct sysinit **si_start, **si_stop;
1647 TAILQ_INIT(&loaded_files);
1648 TAILQ_INIT(&depended_files);
1649 TAILQ_INIT(&found_modules);
1654 while ((modptr = preload_search_next_name(modptr)) != NULL) {
1655 modname = (char *)preload_search_info(modptr, MODINFO_NAME);
1656 modtype = (char *)preload_search_info(modptr, MODINFO_TYPE);
1657 if (modname == NULL) {
1658 printf("Preloaded module at %p does not have a"
1659 " name!\n", modptr);
1662 if (modtype == NULL) {
1663 printf("Preloaded module at %p does not have a type!\n",
1668 printf("Preloaded %s \"%s\" at %p.\n", modtype, modname,
1671 TAILQ_FOREACH(lc, &classes, link) {
1672 error = LINKER_LINK_PRELOAD(lc, modname, &lf);
1678 TAILQ_INSERT_TAIL(&loaded_files, lf, loaded);
1682 * First get a list of stuff in the kernel.
1684 if (linker_file_lookup_set(linker_kernel_file, MDT_SETNAME, &start,
1686 linker_addmodules(linker_kernel_file, start, stop, 1);
1689 * This is a once-off kinky bubble sort to resolve relocation
1690 * dependency requirements.
1693 TAILQ_FOREACH(lf, &loaded_files, loaded) {
1694 error = linker_file_lookup_set(lf, MDT_SETNAME, &start,
1697 * First, look to see if we would successfully link with this
1700 resolves = 1; /* unless we know otherwise */
1702 for (mdp = start; mdp < stop; mdp++) {
1704 if (mp->md_type != MDT_DEPEND)
1706 modname = mp->md_cval;
1707 verinfo = mp->md_data;
1708 for (nmdp = start; nmdp < stop; nmdp++) {
1710 if (nmp->md_type != MDT_VERSION)
1712 nmodname = nmp->md_cval;
1713 if (strcmp(modname, nmodname) == 0)
1716 if (nmdp < stop) /* it's a self reference */
1720 * ok, the module isn't here yet, we
1723 if (modlist_lookup2(modname, verinfo) == NULL)
1728 * OK, if we found our modules, we can link. So, "provide"
1729 * the modules inside and add it to the end of the link order
1734 for (mdp = start; mdp < stop; mdp++) {
1736 if (mp->md_type != MDT_VERSION)
1738 modname = mp->md_cval;
1739 nver = ((const struct mod_version *)
1740 mp->md_data)->mv_version;
1741 if (modlist_lookup(modname,
1743 printf("module %s already"
1744 " present!\n", modname);
1745 TAILQ_REMOVE(&loaded_files,
1747 linker_file_unload(lf,
1748 LINKER_UNLOAD_FORCE);
1749 /* we changed tailq next ptr */
1752 modlist_newmodule(modname, nver, lf);
1755 TAILQ_REMOVE(&loaded_files, lf, loaded);
1756 TAILQ_INSERT_TAIL(&depended_files, lf, loaded);
1758 * Since we provided modules, we need to restart the
1759 * sort so that the previous files that depend on us
1760 * have a chance. Also, we've busted the tailq next
1761 * pointer with the REMOVE.
1768 * At this point, we check to see what could not be resolved..
1770 while ((lf = TAILQ_FIRST(&loaded_files)) != NULL) {
1771 TAILQ_REMOVE(&loaded_files, lf, loaded);
1772 printf("KLD file %s is missing dependencies\n", lf->filename);
1773 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1777 * We made it. Finish off the linking in the order we determined.
1779 TAILQ_FOREACH_SAFE(lf, &depended_files, loaded, nlf) {
1780 if (linker_kernel_file) {
1781 linker_kernel_file->refs++;
1782 linker_file_add_dependency(lf, linker_kernel_file);
1784 error = linker_file_lookup_set(lf, MDT_SETNAME, &start,
1787 for (mdp = start; mdp < stop; mdp++) {
1789 if (mp->md_type != MDT_DEPEND)
1791 modname = mp->md_cval;
1792 verinfo = mp->md_data;
1793 mod = modlist_lookup2(modname, verinfo);
1795 printf("KLD file %s - cannot find "
1796 "dependency \"%s\"\n",
1797 lf->filename, modname);
1800 /* Don't count self-dependencies */
1801 if (lf == mod->container)
1803 mod->container->refs++;
1804 linker_file_add_dependency(lf, mod->container);
1808 * Now do relocation etc using the symbol search paths
1809 * established by the dependencies
1811 error = LINKER_LINK_PRELOAD_FINISH(lf);
1813 printf("KLD file %s - could not finalize loading\n",
1817 linker_file_register_modules(lf);
1818 if (!TAILQ_EMPTY(&lf->modules))
1819 lf->flags |= LINKER_FILE_MODULES;
1820 if (linker_file_lookup_set(lf, "sysinit_set", &si_start,
1821 &si_stop, NULL) == 0)
1822 sysinit_add(si_start, si_stop);
1823 linker_file_register_sysctls(lf, true);
1824 lf->flags |= LINKER_FILE_LINKED;
1827 TAILQ_REMOVE(&depended_files, lf, loaded);
1828 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1830 sx_xunlock(&kld_sx);
1831 /* woohoo! we made it! */
1833 SYSINIT(preload, SI_SUB_KLD, SI_ORDER_MIDDLE, linker_preload, NULL);
1836 linker_mountroot(void *arg __unused)
1841 TAILQ_FOREACH (lf, &linker_files, link) {
1842 linker_ctf_load_file(lf);
1844 sx_xunlock(&kld_sx);
1846 EVENTHANDLER_DEFINE(mountroot, linker_mountroot, NULL, 0);
1849 * Handle preload files that failed to load any modules.
1852 linker_preload_finish(void *arg)
1854 linker_file_t lf, nlf;
1857 TAILQ_FOREACH_SAFE(lf, &linker_files, link, nlf) {
1858 if (lf == linker_kernel_file)
1862 * If all of the modules in this file failed to load, unload
1863 * the file and return an error of ENOEXEC. (Parity with
1864 * linker_load_file.)
1866 if ((lf->flags & LINKER_FILE_MODULES) != 0 &&
1867 TAILQ_EMPTY(&lf->modules)) {
1868 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1872 lf->flags &= ~LINKER_FILE_MODULES;
1873 lf->userrefs++; /* so we can (try to) kldunload it */
1875 sx_xunlock(&kld_sx);
1879 * Attempt to run after all DECLARE_MODULE SYSINITs. Unfortunately they can be
1880 * scheduled at any subsystem and order, so run this as late as possible. init
1881 * becomes runnable in SI_SUB_KTHREAD_INIT, so go slightly before that.
1883 SYSINIT(preload_finish, SI_SUB_KTHREAD_INIT - 100, SI_ORDER_MIDDLE,
1884 linker_preload_finish, NULL);
1887 * Search for a not-loaded module by name.
1889 * Modules may be found in the following locations:
1891 * - preloaded (result is just the module name) - on disk (result is full path
1894 * If the module name is qualified in any way (contains path, etc.) the we
1895 * simply return a copy of it.
1897 * The search path can be manipulated via sysctl. Note that we use the ';'
1898 * character as a separator to be consistent with the bootloader.
1901 static char linker_hintfile[] = "linker.hints";
1902 static char linker_path[MAXPATHLEN] = "/boot/kernel;/boot/modules";
1904 SYSCTL_STRING(_kern, OID_AUTO, module_path, CTLFLAG_RWTUN, linker_path,
1905 sizeof(linker_path), "module load search path");
1907 TUNABLE_STR("module_path", linker_path, sizeof(linker_path));
1909 static const char * const linker_ext_list[] = {
1916 * Check if file actually exists either with or without extension listed in
1917 * the linker_ext_list. (probably should be generic for the rest of the
1921 linker_lookup_file(const char *path, int pathlen, const char *name,
1922 int namelen, struct vattr *vap)
1924 struct nameidata nd;
1925 struct thread *td = curthread; /* XXX */
1926 const char * const *cpp, *sep;
1928 int error, len, extlen, reclen, flags;
1929 __enum_uint8(vtype) type;
1932 for (cpp = linker_ext_list; *cpp; cpp++) {
1937 extlen++; /* trailing '\0' */
1938 sep = (path[pathlen - 1] != '/') ? "/" : "";
1940 reclen = pathlen + strlen(sep) + namelen + extlen + 1;
1941 result = malloc(reclen, M_LINKER, M_WAITOK);
1942 for (cpp = linker_ext_list; *cpp; cpp++) {
1943 snprintf(result, reclen, "%.*s%s%.*s%s", pathlen, path, sep,
1944 namelen, name, *cpp);
1946 * Attempt to open the file, and return the path if
1947 * we succeed and it's a regular file.
1949 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, result);
1951 error = vn_open(&nd, &flags, 0, NULL);
1954 type = nd.ni_vp->v_type;
1956 VOP_GETATTR(nd.ni_vp, vap, td->td_ucred);
1957 VOP_UNLOCK(nd.ni_vp);
1958 vn_close(nd.ni_vp, FREAD, td->td_ucred, td);
1963 free(result, M_LINKER);
1967 #define INT_ALIGN(base, ptr) ptr = \
1968 (base) + roundup2((ptr) - (base), sizeof(int))
1971 * Lookup KLD which contains requested module in the "linker.hints" file. If
1972 * version specification is available, then try to find the best KLD.
1973 * Otherwise just find the latest one.
1976 linker_hints_lookup(const char *path, int pathlen, const char *modname,
1977 int modnamelen, const struct mod_depend *verinfo)
1979 struct thread *td = curthread; /* XXX */
1980 struct ucred *cred = td ? td->td_ucred : NULL;
1981 struct nameidata nd;
1982 struct vattr vattr, mattr;
1983 const char *best, *sep;
1984 u_char *hints = NULL;
1985 u_char *cp, *recptr, *bufend, *result, *pathbuf;
1986 int error, ival, bestver, *intp, found, flags, clen, blen;
1990 bestver = found = 0;
1992 sep = (path[pathlen - 1] != '/') ? "/" : "";
1993 reclen = imax(modnamelen, strlen(linker_hintfile)) + pathlen +
1995 pathbuf = malloc(reclen, M_LINKER, M_WAITOK);
1996 snprintf(pathbuf, reclen, "%.*s%s%s", pathlen, path, sep,
1999 NDINIT(&nd, LOOKUP, NOFOLLOW, UIO_SYSSPACE, pathbuf);
2001 error = vn_open(&nd, &flags, 0, NULL);
2005 if (nd.ni_vp->v_type != VREG)
2008 error = VOP_GETATTR(nd.ni_vp, &vattr, cred);
2012 * XXX: we need to limit this number to some reasonable value
2014 if (vattr.va_size > LINKER_HINTS_MAX) {
2015 printf("linker.hints file too large %ld\n", (long)vattr.va_size);
2018 hints = malloc(vattr.va_size, M_TEMP, M_WAITOK);
2019 error = vn_rdwr(UIO_READ, nd.ni_vp, (caddr_t)hints, vattr.va_size, 0,
2020 UIO_SYSSPACE, IO_NODELOCKED, cred, NOCRED, &reclen, td);
2023 VOP_UNLOCK(nd.ni_vp);
2024 vn_close(nd.ni_vp, FREAD, cred, td);
2027 printf("can't read %zd\n", reclen);
2030 intp = (int *)hints;
2032 if (ival != LINKER_HINTS_VERSION) {
2033 printf("linker.hints file version mismatch %d\n", ival);
2036 bufend = hints + vattr.va_size;
2037 recptr = (u_char *)intp;
2039 while (recptr < bufend && !found) {
2040 intp = (int *)recptr;
2047 if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
2050 INT_ALIGN(hints, cp);
2054 if (verinfo == NULL ||
2055 ival == verinfo->md_ver_preferred) {
2059 if (ival >= verinfo->md_ver_minimum &&
2060 ival <= verinfo->md_ver_maximum &&
2070 recptr += reclen + sizeof(int);
2073 * Finally check if KLD is in the place
2076 result = linker_lookup_file(path, pathlen, cp, clen, &mattr);
2078 result = linker_lookup_file(path, pathlen, best, blen, &mattr);
2081 * KLD is newer than hints file. What we should do now?
2083 if (result && timespeccmp(&mattr.va_mtime, &vattr.va_mtime, >))
2084 printf("warning: KLD '%s' is newer than the linker.hints"
2087 free(pathbuf, M_LINKER);
2089 free(hints, M_TEMP);
2090 if (nd.ni_vp != NULL) {
2091 VOP_UNLOCK(nd.ni_vp);
2092 vn_close(nd.ni_vp, FREAD, cred, td);
2095 * If nothing found or hints is absent - fallback to the old
2096 * way by using "kldname[.ko]" as module name.
2098 if (!found && !bestver && result == NULL)
2099 result = linker_lookup_file(path, pathlen, modname,
2105 * Lookup KLD which contains requested module in the all directories.
2108 linker_search_module(const char *modname, int modnamelen,
2109 const struct mod_depend *verinfo)
2111 char *cp, *ep, *result;
2114 * traverse the linker path
2116 for (cp = linker_path; *cp; cp = ep + 1) {
2117 /* find the end of this component */
2118 for (ep = cp; (*ep != 0) && (*ep != ';'); ep++);
2119 result = linker_hints_lookup(cp, ep - cp, modname,
2120 modnamelen, verinfo);
2130 * Search for module in all directories listed in the linker_path.
2133 linker_search_kld(const char *name)
2135 char *cp, *ep, *result;
2138 /* qualified at all? */
2139 if (strchr(name, '/'))
2140 return (strdup(name, M_LINKER));
2142 /* traverse the linker path */
2144 for (ep = linker_path; *ep; ep++) {
2146 /* find the end of this component */
2147 for (; *ep != 0 && *ep != ';'; ep++);
2148 result = linker_lookup_file(cp, ep - cp, name, len, NULL);
2156 linker_basename(const char *path)
2158 const char *filename;
2160 filename = strrchr(path, '/');
2161 if (filename == NULL)
2170 * Inform hwpmc about the set of kernel modules currently loaded.
2173 linker_hwpmc_list_objects(void)
2176 struct pmckern_map_in *kobase;
2181 TAILQ_FOREACH(lf, &linker_files, link)
2184 /* Allocate nmappings + 1 entries. */
2185 kobase = malloc((nmappings + 1) * sizeof(struct pmckern_map_in),
2186 M_LINKER, M_WAITOK | M_ZERO);
2188 TAILQ_FOREACH(lf, &linker_files, link) {
2189 /* Save the info for this linker file. */
2190 kobase[i].pm_file = lf->pathname;
2191 kobase[i].pm_address = (uintptr_t)lf->address;
2194 sx_sunlock(&kld_sx);
2196 KASSERT(i > 0, ("linker_hpwmc_list_objects: no kernel objects?"));
2198 /* The last entry of the malloced area comprises of all zeros. */
2199 KASSERT(kobase[i].pm_file == NULL,
2200 ("linker_hwpmc_list_objects: last object not NULL"));
2202 return ((void *)kobase);
2206 /* check if root file system is not mounted */
2208 linker_root_mounted(void)
2213 if (rootvnode == NULL)
2216 pwd = pwd_hold(curthread);
2217 ret = pwd->pwd_rdir != NULL;
2223 * Find a file which contains given module and load it, if "parent" is not
2224 * NULL, register a reference to it.
2227 linker_load_module(const char *kldname, const char *modname,
2228 struct linker_file *parent, const struct mod_depend *verinfo,
2229 struct linker_file **lfpp)
2231 linker_file_t lfdep;
2232 const char *filename;
2236 sx_assert(&kld_sx, SA_XLOCKED);
2237 if (modname == NULL) {
2239 * We have to load KLD
2241 KASSERT(verinfo == NULL, ("linker_load_module: verinfo"
2243 if (!linker_root_mounted())
2245 pathname = linker_search_kld(kldname);
2247 if (modlist_lookup2(modname, verinfo) != NULL)
2249 if (!linker_root_mounted())
2251 if (kldname != NULL)
2252 pathname = strdup(kldname, M_LINKER);
2255 * Need to find a KLD with required module
2257 pathname = linker_search_module(modname,
2258 strlen(modname), verinfo);
2260 if (pathname == NULL)
2264 * Can't load more than one file with the same basename XXX:
2265 * Actually it should be possible to have multiple KLDs with
2266 * the same basename but different path because they can
2267 * provide different versions of the same modules.
2269 filename = linker_basename(pathname);
2270 if (linker_find_file_by_name(filename))
2273 error = linker_load_file(pathname, &lfdep);
2276 if (modname && verinfo &&
2277 modlist_lookup2(modname, verinfo) == NULL) {
2278 linker_file_unload(lfdep, LINKER_UNLOAD_FORCE);
2283 linker_file_add_dependency(parent, lfdep);
2287 free(pathname, M_LINKER);
2292 * This routine is responsible for finding dependencies of userland initiated
2293 * kldload(2)'s of files.
2296 linker_load_dependencies(linker_file_t lf)
2298 linker_file_t lfdep;
2299 struct mod_metadata **start, **stop, **mdp, **nmdp;
2300 struct mod_metadata *mp, *nmp;
2301 const struct mod_depend *verinfo;
2303 const char *modname, *nmodname;
2307 * All files are dependent on /kernel.
2309 sx_assert(&kld_sx, SA_XLOCKED);
2310 if (linker_kernel_file) {
2311 linker_kernel_file->refs++;
2312 linker_file_add_dependency(lf, linker_kernel_file);
2314 if (linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop,
2317 for (mdp = start; mdp < stop; mdp++) {
2319 if (mp->md_type != MDT_VERSION)
2321 modname = mp->md_cval;
2322 ver = ((const struct mod_version *)mp->md_data)->mv_version;
2323 mod = modlist_lookup(modname, ver);
2325 printf("interface %s.%d already present in the KLD"
2326 " '%s'!\n", modname, ver,
2327 mod->container->filename);
2332 for (mdp = start; mdp < stop; mdp++) {
2334 if (mp->md_type != MDT_DEPEND)
2336 modname = mp->md_cval;
2337 verinfo = mp->md_data;
2339 for (nmdp = start; nmdp < stop; nmdp++) {
2341 if (nmp->md_type != MDT_VERSION)
2343 nmodname = nmp->md_cval;
2344 if (strcmp(modname, nmodname) == 0)
2347 if (nmdp < stop)/* early exit, it's a self reference */
2349 mod = modlist_lookup2(modname, verinfo);
2350 if (mod) { /* woohoo, it's loaded already */
2351 lfdep = mod->container;
2353 linker_file_add_dependency(lf, lfdep);
2356 error = linker_load_module(NULL, modname, lf, verinfo, NULL);
2358 printf("KLD %s: depends on %s - not available or"
2359 " version mismatch\n", lf->filename, modname);
2366 linker_addmodules(lf, start, stop, 0);
2371 sysctl_kern_function_list_iterate(const char *name, void *opaque)
2373 struct sysctl_req *req;
2376 return (SYSCTL_OUT(req, name, strlen(name) + 1));
2380 * Export a nul-separated, double-nul-terminated list of all function names
2384 sysctl_kern_function_list(SYSCTL_HANDLER_ARGS)
2390 error = mac_kld_check_stat(req->td->td_ucred);
2394 error = sysctl_wire_old_buffer(req, 0);
2398 TAILQ_FOREACH(lf, &linker_files, link) {
2399 error = LINKER_EACH_FUNCTION_NAME(lf,
2400 sysctl_kern_function_list_iterate, req);
2402 sx_xunlock(&kld_sx);
2406 sx_xunlock(&kld_sx);
2407 return (SYSCTL_OUT(req, "", 1));
2410 SYSCTL_PROC(_kern, OID_AUTO, function_list,
2411 CTLTYPE_OPAQUE | CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, 0,
2412 sysctl_kern_function_list, "",
2413 "kernel function list");