2 * Copyright (c) 1997 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/kern/kern_linker.c,v 1.41.2.3 2001/11/21 17:50:35 luigi Exp $
27 * $DragonFly: src/sys/kern/kern_linker.c,v 1.44 2008/09/01 19:39:44 dillon Exp $
32 #include <sys/param.h>
33 #include <sys/kernel.h>
34 #include <sys/systm.h>
35 #include <sys/malloc.h>
36 #include <sys/sysproto.h>
37 #include <sys/sysent.h>
41 #include <sys/module.h>
42 #include <sys/queue.h>
43 #include <sys/linker.h>
44 #include <sys/fcntl.h>
45 #include <sys/libkern.h>
46 #include <sys/nlookup.h>
47 #include <sys/vnode.h>
48 #include <sys/sysctl.h>
50 #include <vm/vm_zone.h>
52 #include <sys/mplock2.h>
54 #ifdef _KERNEL_VIRTUAL
62 /* Metadata from the static kernel */
63 SET_DECLARE(modmetadata_set, struct mod_metadata);
64 MALLOC_DEFINE(M_LINKER, "kld", "kernel linker");
66 linker_file_t linker_current_file;
67 linker_file_t linker_kernel_file;
69 static struct lock lock; /* lock for the file list */
70 static linker_class_list_t classes;
71 static linker_file_list_t linker_files;
72 static int next_file_id = 1;
74 /* XXX wrong name; we're looking at version provision tags here, not modules */
75 typedef TAILQ_HEAD(, modlist) modlisthead_t;
77 TAILQ_ENTRY(modlist) link; /* chain together all modules */
78 linker_file_t container;
82 typedef struct modlist *modlist_t;
83 static modlisthead_t found_modules;
86 static int linker_load_module(const char *kldname, const char *modname,
87 struct linker_file *parent, struct mod_depend *verinfo,
88 struct linker_file **lfpp);
91 linker_strdup(const char *str)
95 result = kmalloc(strlen(str) + 1, M_LINKER, M_WAITOK);
101 linker_init(void* arg)
103 lockinit(&lock, "klink", 0, 0);
104 TAILQ_INIT(&classes);
105 TAILQ_INIT(&linker_files);
108 SYSINIT(linker, SI_BOOT2_KLD, SI_ORDER_FIRST, linker_init, 0);
111 linker_add_class(const char* desc, void* priv,
112 struct linker_class_ops* ops)
116 lc = kmalloc(sizeof(struct linker_class), M_LINKER, M_NOWAIT | M_ZERO);
123 TAILQ_INSERT_HEAD(&classes, lc, link);
129 linker_file_sysinit(linker_file_t lf)
131 struct sysinit** start, ** stop;
132 struct sysinit** sipp;
133 struct sysinit** xipp;
134 struct sysinit* save;
136 KLD_DPF(FILE, ("linker_file_sysinit: calling SYSINITs for %s\n",
139 if (linker_file_lookup_set(lf, "sysinit_set", &start, &stop, NULL) != 0)
143 * Perform a bubble sort of the system initialization objects by
144 * their subsystem (primary key) and order (secondary key).
146 * Since some things care about execution order, this is the
147 * operation which ensures continued function.
149 for (sipp = start; sipp < stop; sipp++) {
150 for (xipp = sipp + 1; xipp < stop; xipp++) {
151 if ((*sipp)->subsystem < (*xipp)->subsystem ||
152 ((*sipp)->subsystem == (*xipp)->subsystem &&
153 (*sipp)->order <= (*xipp)->order))
163 * Traverse the (now) ordered list of system initialization tasks.
164 * Perform each task, and continue on to the next task.
166 for (sipp = start; sipp < stop; sipp++) {
167 if ((*sipp)->subsystem == SI_SPECIAL_DUMMY)
168 continue; /* skip dummy task(s)*/
171 (*((*sipp)->func))((*sipp)->udata);
176 linker_file_sysuninit(linker_file_t lf)
178 struct sysinit** start, ** stop;
179 struct sysinit** sipp;
180 struct sysinit** xipp;
181 struct sysinit* save;
183 KLD_DPF(FILE, ("linker_file_sysuninit: calling SYSUNINITs for %s\n",
186 if (linker_file_lookup_set(lf, "sysuninit_set", &start, &stop, NULL) != 0)
190 * Perform a reverse bubble sort of the system initialization objects
191 * by their subsystem (primary key) and order (secondary key).
193 * Since some things care about execution order, this is the
194 * operation which ensures continued function.
196 for (sipp = start; sipp < stop; sipp++) {
197 for (xipp = sipp + 1; xipp < stop; xipp++) {
198 if ((*sipp)->subsystem > (*xipp)->subsystem ||
199 ((*sipp)->subsystem == (*xipp)->subsystem &&
200 (*sipp)->order >= (*xipp)->order))
210 * Traverse the (now) ordered list of system initialization tasks.
211 * Perform each task, and continue on to the next task.
213 for (sipp = start; sipp < stop; sipp++) {
214 if ((*sipp)->subsystem == SI_SPECIAL_DUMMY)
215 continue; /* skip dummy task(s)*/
218 (*((*sipp)->func))((*sipp)->udata);
223 linker_file_register_sysctls(linker_file_t lf)
225 struct sysctl_oid **start, **stop, **oidp;
227 KLD_DPF(FILE, ("linker_file_register_sysctls: registering SYSCTLs for %s\n",
230 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
232 for (oidp = start; oidp < stop; oidp++)
233 sysctl_register_oid(*oidp);
237 linker_file_unregister_sysctls(linker_file_t lf)
239 struct sysctl_oid **start, **stop, **oidp;
241 KLD_DPF(FILE, ("linker_file_unregister_sysctls: registering SYSCTLs for %s\n",
244 if (linker_file_lookup_set(lf, "sysctl_set", &start, &stop, NULL) != 0)
246 for (oidp = start; oidp < stop; oidp++)
247 sysctl_unregister_oid(*oidp);
251 linker_file_register_modules(linker_file_t lf)
253 struct mod_metadata **start, **stop, **mdp;
254 const moduledata_t *moddata;
255 int first_error, error;
257 KLD_DPF(FILE, ("linker_file_register_modules: registering modules in %s\n",
260 if (linker_file_lookup_set(lf, "modmetadata_set", &start, &stop, NULL) != 0) {
262 * This fallback should be unnecessary, but if we get booted
263 * from boot2 instead of loader and we are missing our
264 * metadata then we have to try the best we can.
266 if (lf == linker_kernel_file) {
267 start = SET_BEGIN(modmetadata_set);
268 stop = SET_LIMIT(modmetadata_set);
273 for (mdp = start; mdp < stop; mdp++) {
274 if ((*mdp)->md_type != MDT_MODULE)
276 moddata = (*mdp)->md_data;
277 KLD_DPF(FILE, ("Registering module %s in %s\n", moddata->name, lf->filename));
278 error = module_register(moddata, lf);
280 kprintf("Module %s failed to register: %d\n", moddata->name, error);
281 if (first_error == 0)
285 return (first_error);
289 linker_init_kernel_modules(void)
292 linker_file_register_modules(linker_kernel_file);
295 SYSINIT(linker_kernel, SI_BOOT2_KLD, SI_ORDER_ANY, linker_init_kernel_modules, 0);
298 linker_load_file(const char *filename, linker_file_t *result)
302 int foundfile, error = 0;
304 /* Refuse to load modules if securelevel raised */
305 if (securelevel > 0 || kernel_mem_readonly)
308 lf = linker_find_file_by_name(filename);
310 KLD_DPF(FILE, ("linker_load_file: file %s is already loaded, incrementing refs\n", filename));
318 TAILQ_FOREACH(lc, &classes, link) {
319 KLD_DPF(FILE, ("linker_load_file: trying to load %s as %s\n",
320 filename, lc->desc));
322 error = lc->ops->load_file(filename, &lf);
324 * If we got something other than ENOENT, then it exists but we cannot
325 * load it for some other reason.
330 error = linker_file_register_modules(lf);
331 if (error == EEXIST) {
332 linker_file_unload(lf /* , LINKER_UNLOAD_FORCE */);
335 linker_file_register_sysctls(lf);
336 linker_file_sysinit(lf);
337 lf->flags |= LINKER_FILE_LINKED;
343 * Less than ideal, but tells the user whether it failed to load or
344 * the module was not found.
348 * If the file type has not been recognized by the last try
349 * printout a message before to fail.
352 kprintf("linker_load_file: Unsupported file type\n");
355 * Format not recognized or otherwise unloadable.
356 * When loading a module that is statically built into
357 * the kernel EEXIST percolates back up as the return
358 * value. Preserve this so that apps can recognize this
364 error = ENOENT; /* Nothing found */
373 linker_find_file_by_name(const char* filename)
375 linker_file_t lf = 0;
379 for (i = strlen(filename); i > 0 && filename[i-1] != '/'; --i)
383 koname = kmalloc(strlen(filename) + 4, M_LINKER, M_WAITOK);
384 ksprintf(koname, "%s.ko", filename);
386 lockmgr(&lock, LK_SHARED);
387 TAILQ_FOREACH(lf, &linker_files, link) {
388 if (!strcmp(lf->filename, koname))
390 if (!strcmp(lf->filename, filename))
393 lockmgr(&lock, LK_RELEASE);
396 kfree(koname, M_LINKER);
401 linker_find_file_by_id(int fileid)
403 linker_file_t lf = 0;
405 lockmgr(&lock, LK_SHARED);
406 TAILQ_FOREACH(lf, &linker_files, link)
407 if (lf->id == fileid)
409 lockmgr(&lock, LK_RELEASE);
415 linker_make_file(const char* pathname, void* priv, struct linker_file_ops* ops)
417 linker_file_t lf = 0;
418 const char *filename;
420 filename = rindex(pathname, '/');
421 if (filename && filename[1])
426 KLD_DPF(FILE, ("linker_make_file: new file, filename=%s\n", filename));
427 lockmgr(&lock, LK_EXCLUSIVE);
428 lf = kmalloc(sizeof(struct linker_file), M_LINKER, M_WAITOK);
429 bzero(lf, sizeof(*lf));
434 lf->filename = linker_strdup(filename);
435 lf->id = next_file_id++;
438 STAILQ_INIT(&lf->common);
439 TAILQ_INIT(&lf->modules);
443 TAILQ_INSERT_TAIL(&linker_files, lf, link);
445 lockmgr(&lock, LK_RELEASE);
450 linker_file_unload(linker_file_t file)
453 modlist_t ml, nextml;
454 struct common_symbol* cp;
458 /* Refuse to unload modules if securelevel raised */
459 if (securelevel > 0 || kernel_mem_readonly)
462 KLD_DPF(FILE, ("linker_file_unload: lf->refs=%d\n", file->refs));
464 lockmgr(&lock, LK_EXCLUSIVE);
466 /* Easy case of just dropping a reference. */
467 if (file->refs > 1) {
469 lockmgr(&lock, LK_RELEASE);
473 KLD_DPF(FILE, ("linker_file_unload: file is unloading, informing modules\n"));
476 * Inform any modules associated with this file.
478 mod = TAILQ_FIRST(&file->modules);
479 for (mod = TAILQ_FIRST(&file->modules); mod; mod = next) {
480 next = module_getfnext(mod);
483 * Give the module a chance to veto the unload. Note that the
484 * act of unloading the module may cause other modules in the
485 * same file list to be unloaded recursively.
487 if ((error = module_unload(mod)) != 0) {
488 KLD_DPF(FILE, ("linker_file_unload: module %p vetoes unload\n",
490 lockmgr(&lock, LK_RELEASE);
497 TAILQ_FOREACH_MUTABLE(ml, &found_modules, link, nextml) {
498 if (ml->container == file) {
499 TAILQ_REMOVE(&found_modules, ml, link);
504 /* Don't try to run SYSUNINITs if we are unloaded due to a link error */
505 if (file->flags & LINKER_FILE_LINKED) {
506 file->flags &= ~LINKER_FILE_LINKED;
507 lockmgr(&lock, LK_RELEASE);
508 linker_file_sysuninit(file);
509 linker_file_unregister_sysctls(file);
510 lockmgr(&lock, LK_EXCLUSIVE);
513 TAILQ_REMOVE(&linker_files, file, link);
516 lockmgr(&lock, LK_RELEASE);
517 for (i = 0; i < file->ndeps; i++)
518 linker_file_unload(file->deps[i]);
519 lockmgr(&lock, LK_EXCLUSIVE);
520 kfree(file->deps, M_LINKER);
524 while ((cp = STAILQ_FIRST(&file->common)) != NULL) {
525 STAILQ_REMOVE_HEAD(&file->common, link);
529 file->ops->unload(file);
531 if (file->filename) {
532 kfree(file->filename, M_LINKER);
533 file->filename = NULL;
536 kfree(file, M_LINKER);
538 lockmgr(&lock, LK_RELEASE);
545 linker_file_add_dependancy(linker_file_t file, linker_file_t dep)
547 linker_file_t* newdeps;
549 newdeps = kmalloc((file->ndeps + 1) * sizeof(linker_file_t*),
550 M_LINKER, M_WAITOK | M_ZERO);
553 bcopy(file->deps, newdeps, file->ndeps * sizeof(linker_file_t*));
554 kfree(file->deps, M_LINKER);
556 file->deps = newdeps;
557 file->deps[file->ndeps] = dep;
562 * Locate a linker set and its contents.
563 * This is a helper function to avoid linker_if.h exposure elsewhere.
564 * Note: firstp and lastp are really void ***
567 linker_file_lookup_set(linker_file_t file, const char *name,
568 void *firstp, void *lastp, int *countp)
570 return file->ops->lookup_set(file, name, firstp, lastp, countp);
574 linker_file_lookup_symbol(linker_file_t file, const char* name, int deps, caddr_t *raddr)
577 linker_symval_t symval;
579 size_t common_size = 0;
582 KLD_DPF(SYM, ("linker_file_lookup_symbol: file=%p, name=%s, deps=%d\n",
585 if (file->ops->lookup_symbol(file, name, &sym) == 0) {
586 file->ops->symbol_values(file, sym, &symval);
589 * XXX Assume a common symbol if its value is 0 and it has a non-zero
590 * size, otherwise it could be an absolute symbol with a value of 0.
592 if (symval.value == 0 && symval.size != 0) {
594 * For commons, first look them up in the dependancies and
595 * only allocate space if not found there.
597 common_size = symval.size;
599 KLD_DPF(SYM, ("linker_file_lookup_symbol: symbol.value=%p\n", symval.value));
600 *raddr = symval.value;
605 for (i = 0; i < file->ndeps; i++) {
606 if (linker_file_lookup_symbol(file->deps[i], name, 0, raddr) == 0) {
607 KLD_DPF(SYM, ("linker_file_lookup_symbol: deps value=%p\n", *raddr));
612 /* If we have not found it in the dependencies, search globally */
613 TAILQ_FOREACH(lf, &linker_files, link) {
614 /* But skip the current file if it's on the list */
617 /* And skip the files we searched above */
618 for (i = 0; i < file->ndeps; i++)
619 if (lf == file->deps[i])
623 if (linker_file_lookup_symbol(lf, name, 0, raddr) == 0) {
624 KLD_DPF(SYM, ("linker_file_lookup_symbol: global value=%p\n", *raddr));
630 if (common_size > 0) {
632 * This is a common symbol which was not found in the
633 * dependancies. We maintain a simple common symbol table in
636 struct common_symbol* cp;
638 STAILQ_FOREACH(cp, &file->common, link)
639 if (!strcmp(cp->name, name)) {
640 KLD_DPF(SYM, ("linker_file_lookup_symbol: old common value=%p\n", cp->address));
641 *raddr = cp->address;
646 * Round the symbol size up to align.
648 common_size = (common_size + sizeof(int) - 1) & -sizeof(int);
649 cp = kmalloc(sizeof(struct common_symbol)
652 M_LINKER, M_WAITOK | M_ZERO);
654 cp->address = (caddr_t) (cp + 1);
655 cp->name = cp->address + common_size;
656 strcpy(cp->name, name);
657 bzero(cp->address, common_size);
658 STAILQ_INSERT_TAIL(&file->common, cp, link);
660 KLD_DPF(SYM, ("linker_file_lookup_symbol: new common value=%p\n", cp->address));
661 *raddr = cp->address;
665 #ifdef _KERNEL_VIRTUAL
666 *raddr = dlsym(RTLD_NEXT, name);
667 if (*raddr != NULL) {
668 KLD_DPF(SYM, ("linker_file_lookup_symbol: found dlsym=%p\n", *raddr));
673 KLD_DPF(SYM, ("linker_file_lookup_symbol: fail\n"));
679 * DDB Helpers. DDB has to look across multiple files with their own
680 * symbol tables and string tables.
682 * Note that we do not obey list locking protocols here. We really don't
683 * need DDB to hang because somebody's got the lock held. We'll take the
684 * chance that the files list is inconsistant instead.
688 linker_ddb_lookup(const char *symstr, c_linker_sym_t *sym)
692 TAILQ_FOREACH(lf, &linker_files, link) {
693 if (lf->ops->lookup_symbol(lf, symstr, sym) == 0)
700 linker_ddb_search_symbol(caddr_t value, c_linker_sym_t *sym, long *diffp)
703 u_long off = (uintptr_t)value;
704 u_long diff, bestdiff;
710 TAILQ_FOREACH(lf, &linker_files, link) {
711 if (lf->ops->search_symbol(lf, value, &es, &diff) != 0)
713 if (es != 0 && diff < bestdiff) {
732 linker_ddb_symbol_values(c_linker_sym_t sym, linker_symval_t *symval)
736 TAILQ_FOREACH(lf, &linker_files, link) {
737 if (lf->ops->symbol_values(lf, sym, symval) == 0)
751 sys_kldload(struct kldload_args *uap)
753 struct thread *td = curthread;
755 char *kldname, *modname;
759 uap->sysmsg_result = -1;
761 if (securelevel > 0 || kernel_mem_readonly) /* redundant, but that's OK */
764 if ((error = priv_check(td, PRIV_KLD_LOAD)) != 0)
767 file = kmalloc(MAXPATHLEN, M_TEMP, M_WAITOK);
768 if ((error = copyinstr(uap->file, file, MAXPATHLEN, NULL)) != 0)
772 * If file does not contain a qualified name or any dot in it
773 * (kldname.ko, or kldname.ver.ko) treat it as an interface
776 if (index(file, '/') || index(file, '.')) {
785 error = linker_load_module(kldname, modname, NULL, NULL, &lf);
791 uap->sysmsg_result = lf->id;
803 sys_kldunload(struct kldunload_args *uap)
805 struct thread *td = curthread;
809 if (securelevel > 0 || kernel_mem_readonly) /* redundant, but that's OK */
812 if ((error = priv_check(td, PRIV_KLD_UNLOAD)) != 0)
816 lf = linker_find_file_by_id(uap->fileid);
818 KLD_DPF(FILE, ("kldunload: lf->userrefs=%d\n", lf->userrefs));
819 if (lf->userrefs == 0) {
820 kprintf("linkerunload: attempt to unload file that was loaded by the kernel\n");
825 error = linker_file_unload(lf);
840 sys_kldfind(struct kldfind_args *uap)
842 char *filename = NULL, *modulename;
846 uap->sysmsg_result = -1;
848 filename = kmalloc(MAXPATHLEN, M_TEMP, M_WAITOK);
849 if ((error = copyinstr(uap->file, filename, MAXPATHLEN, NULL)) != 0)
852 modulename = rindex(filename, '/');
853 if (modulename == NULL)
854 modulename = filename;
857 lf = linker_find_file_by_name(modulename);
859 uap->sysmsg_result = lf->id;
866 kfree(filename, M_TEMP);
874 sys_kldnext(struct kldnext_args *uap)
880 if (uap->fileid == 0) {
881 lf = TAILQ_FIRST(&linker_files);
883 lf = linker_find_file_by_id(uap->fileid);
888 lf = TAILQ_NEXT(lf, link);
891 /* Skip partially loaded files. */
892 while (lf != NULL && !(lf->flags & LINKER_FILE_LINKED)) {
893 lf = TAILQ_NEXT(lf, link);
897 uap->sysmsg_result = lf->id;
899 uap->sysmsg_result = 0;
910 sys_kldstat(struct kldstat_args *uap)
915 struct kld_file_stat* stat;
919 lf = linker_find_file_by_id(uap->fileid);
928 * Check the version of the user's structure.
930 if ((error = copyin(&stat->version, &version, sizeof(version))) != 0)
932 if (version != sizeof(struct kld_file_stat)) {
937 namelen = strlen(lf->filename) + 1;
938 if (namelen > MAXPATHLEN)
939 namelen = MAXPATHLEN;
940 if ((error = copyout(lf->filename, &stat->name[0], namelen)) != 0)
942 if ((error = copyout(&lf->refs, &stat->refs, sizeof(int))) != 0)
944 if ((error = copyout(&lf->id, &stat->id, sizeof(int))) != 0)
946 if ((error = copyout(&lf->address, &stat->address, sizeof(caddr_t))) != 0)
948 if ((error = copyout(&lf->size, &stat->size, sizeof(size_t))) != 0)
951 uap->sysmsg_result = 0;
962 sys_kldfirstmod(struct kldfirstmod_args *uap)
968 lf = linker_find_file_by_id(uap->fileid);
970 if (TAILQ_FIRST(&lf->modules))
971 uap->sysmsg_result = module_getid(TAILQ_FIRST(&lf->modules));
973 uap->sysmsg_result = 0;
986 sys_kldsym(struct kldsym_args *uap)
990 linker_symval_t symval;
992 struct kld_sym_lookup lookup;
996 if ((error = copyin(uap->data, &lookup, sizeof(lookup))) != 0)
998 if (lookup.version != sizeof(lookup) || uap->cmd != KLDSYM_LOOKUP) {
1003 symstr = kmalloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1004 if ((error = copyinstr(lookup.symname, symstr, MAXPATHLEN, NULL)) != 0)
1007 if (uap->fileid != 0) {
1008 lf = linker_find_file_by_id(uap->fileid);
1013 if (lf->ops->lookup_symbol(lf, symstr, &sym) == 0 &&
1014 lf->ops->symbol_values(lf, sym, &symval) == 0) {
1015 lookup.symvalue = (uintptr_t)symval.value;
1016 lookup.symsize = symval.size;
1017 error = copyout(&lookup, uap->data, sizeof(lookup));
1021 TAILQ_FOREACH(lf, &linker_files, link) {
1022 if (lf->ops->lookup_symbol(lf, symstr, &sym) == 0 &&
1023 lf->ops->symbol_values(lf, sym, &symval) == 0) {
1024 lookup.symvalue = (uintptr_t)symval.value;
1025 lookup.symsize = symval.size;
1026 error = copyout(&lookup, uap->data, sizeof(lookup));
1036 kfree(symstr, M_TEMP);
1041 * Preloaded module support
1045 modlist_lookup(const char *name, int ver)
1049 TAILQ_FOREACH(mod, &found_modules, link) {
1050 if (strcmp(mod->name, name) == 0 && (ver == 0 || mod->version == ver))
1057 modlist_lookup2(const char *name, struct mod_depend *verinfo)
1059 modlist_t mod, bestmod;
1062 if (verinfo == NULL)
1063 return (modlist_lookup(name, 0));
1065 TAILQ_FOREACH(mod, &found_modules, link) {
1066 if (strcmp(mod->name, name) != 0)
1069 if (ver == verinfo->md_ver_preferred)
1071 if (ver >= verinfo->md_ver_minimum &&
1072 ver <= verinfo->md_ver_maximum &&
1073 (bestmod == NULL || ver > bestmod->version))
1080 linker_reference_module(const char *modname, struct mod_depend *verinfo,
1081 linker_file_t *result)
1086 lockmgr(&lock, LK_SHARED);
1087 if ((mod = modlist_lookup2(modname, verinfo)) != NULL) {
1088 *result = mod->container;
1090 lockmgr(&lock, LK_RELEASE);
1094 lockmgr(&lock, LK_RELEASE);
1096 error = linker_load_module(NULL, modname, NULL, verinfo, result);
1102 linker_release_module(const char *modname, struct mod_depend *verinfo,
1108 lockmgr(&lock, LK_SHARED);
1110 KASSERT(modname != NULL,
1111 ("linker_release_module: no file or name"));
1112 mod = modlist_lookup2(modname, verinfo);
1114 lockmgr(&lock, LK_RELEASE);
1117 lf = mod->container;
1119 KASSERT(modname == NULL && verinfo == NULL,
1120 ("linker_release_module: both file and name"));
1121 lockmgr(&lock, LK_RELEASE);
1123 error = linker_file_unload(lf);
1129 modlist_newmodule(const char *modname, int version, linker_file_t container)
1133 mod = kmalloc(sizeof(struct modlist), M_LINKER, M_NOWAIT | M_ZERO);
1135 panic("no memory for module list");
1136 mod->container = container;
1137 mod->name = modname;
1138 mod->version = version;
1139 TAILQ_INSERT_TAIL(&found_modules, mod, link);
1144 linker_addmodules(linker_file_t lf, struct mod_metadata **start,
1145 struct mod_metadata **stop, int preload)
1147 struct mod_metadata *mp, **mdp;
1148 const char *modname;
1151 for (mdp = start; mdp < stop; mdp++) {
1153 if (mp->md_type != MDT_VERSION)
1155 modname = mp->md_cval;
1156 ver = ((struct mod_version *)mp->md_data)->mv_version;
1157 if (modlist_lookup(modname, ver) != NULL) {
1158 kprintf("module %s already present!\n", modname);
1159 /* XXX what can we do? this is a build error. :-( */
1162 modlist_newmodule(modname, ver, lf);
1167 linker_preload(void* arg)
1170 const char *modname, *nmodname;
1172 linker_file_t lf, nlf;
1175 linker_file_list_t loaded_files;
1176 linker_file_list_t depended_files;
1177 struct mod_metadata *mp, *nmp;
1178 struct mod_metadata **start, **stop, **mdp, **nmdp;
1179 struct mod_depend *verinfo;
1183 struct sysinit **si_start, **si_stop;
1185 TAILQ_INIT(&loaded_files);
1186 TAILQ_INIT(&depended_files);
1187 TAILQ_INIT(&found_modules);
1190 while ((modptr = preload_search_next_name(modptr)) != NULL) {
1191 modname = (char *)preload_search_info(modptr, MODINFO_NAME);
1192 modtype = (char *)preload_search_info(modptr, MODINFO_TYPE);
1193 if (modname == NULL) {
1194 kprintf("Preloaded module at %p does not have a name!\n", modptr);
1197 if (modtype == NULL) {
1198 kprintf("Preloaded module at %p does not have a type!\n", modptr);
1203 kprintf("Preloaded %s \"%s\" at %p.\n", modtype, modname, modptr);
1205 TAILQ_FOREACH(lc, &classes, link) {
1206 error = lc->ops->preload_file(modname, &lf);
1212 TAILQ_INSERT_TAIL(&loaded_files, lf, loaded);
1216 * First get a list of stuff in the kernel.
1218 if (linker_file_lookup_set(linker_kernel_file, MDT_SETNAME, &start,
1220 linker_addmodules(linker_kernel_file, start, stop, 1);
1223 * This is a once-off kinky bubble sort to resolve relocation
1224 * dependency requirements.
1227 TAILQ_FOREACH(lf, &loaded_files, loaded) {
1228 error = linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop, NULL);
1230 * First, look to see if we would successfully link with this
1233 resolves = 1; /* unless we know otherwise */
1235 for (mdp = start; mdp < stop; mdp++) {
1237 if (mp->md_type != MDT_DEPEND)
1239 modname = mp->md_cval;
1240 verinfo = mp->md_data;
1241 for (nmdp = start; nmdp < stop; nmdp++) {
1243 if (nmp->md_type != MDT_VERSION)
1245 nmodname = nmp->md_cval;
1246 if (strcmp(modname, nmodname) == 0)
1249 if (nmdp < stop)/* it's a self reference */
1253 * ok, the module isn't here yet, we
1256 if (modlist_lookup2(modname, verinfo) == NULL)
1261 * OK, if we found our modules, we can link. So, "provide"
1262 * the modules inside and add it to the end of the link order
1267 for (mdp = start; mdp < stop; mdp++) {
1269 if (mp->md_type != MDT_VERSION)
1271 modname = mp->md_cval;
1272 nver = ((struct mod_version *)mp->md_data)->mv_version;
1273 if (modlist_lookup(modname, nver) != NULL) {
1274 kprintf("module %s already present!\n", modname);
1275 TAILQ_REMOVE(&loaded_files, lf, loaded);
1276 linker_file_unload(lf /* , LINKER_UNLOAD_FORCE */ );
1277 /* we changed tailq next ptr */
1280 modlist_newmodule(modname, nver, lf);
1283 TAILQ_REMOVE(&loaded_files, lf, loaded);
1284 TAILQ_INSERT_TAIL(&depended_files, lf, loaded);
1286 * Since we provided modules, we need to restart the
1287 * sort so that the previous files that depend on us
1288 * have a chance. Also, we've busted the tailq next
1289 * pointer with the REMOVE.
1296 * At this point, we check to see what could not be resolved..
1298 while ((lf = TAILQ_FIRST(&loaded_files)) != NULL) {
1299 TAILQ_REMOVE(&loaded_files, lf, loaded);
1300 kprintf("KLD file %s is missing dependencies\n", lf->filename);
1301 linker_file_unload(lf /* , LINKER_UNLOAD_FORCE */ );
1305 * We made it. Finish off the linking in the order we determined.
1307 TAILQ_FOREACH_MUTABLE(lf, &depended_files, loaded, nlf) {
1308 if (linker_kernel_file) {
1309 linker_kernel_file->refs++;
1310 linker_file_add_dependancy(lf, linker_kernel_file);
1314 error = linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop, NULL);
1316 for (mdp = start; mdp < stop; mdp++) {
1318 if (mp->md_type != MDT_DEPEND)
1320 modname = mp->md_cval;
1321 verinfo = mp->md_data;
1322 mod = modlist_lookup2(modname, verinfo);
1323 /* Don't count self-dependencies */
1324 if (lf == mod->container)
1326 mod->container->refs++;
1327 linker_file_add_dependancy(lf, mod->container);
1331 * Now do relocation etc using the symbol search paths
1332 * established by the dependencies
1334 error = lf->ops->preload_finish(lf);
1336 TAILQ_REMOVE(&depended_files, lf, loaded);
1337 kprintf("KLD file %s - could not finalize loading\n",
1339 linker_file_unload(lf /* , LINKER_UNLOAD_FORCE */);
1342 linker_file_register_modules(lf);
1343 if (linker_file_lookup_set(lf, "sysinit_set", &si_start, &si_stop, NULL) == 0)
1344 sysinit_add(si_start, si_stop);
1345 linker_file_register_sysctls(lf);
1346 lf->flags |= LINKER_FILE_LINKED;
1348 /* woohoo! we made it! */
1351 SYSINIT(preload, SI_BOOT2_KLD, SI_ORDER_MIDDLE, linker_preload, 0);
1354 * Search for a not-loaded module by name.
1356 * Modules may be found in the following locations:
1358 * - preloaded (result is just the module name)
1359 * - on disk (result is full path to module)
1361 * If the module name is qualified in any way (contains path, etc.)
1362 * the we simply return a copy of it.
1364 * The search path can be manipulated via sysctl. Note that we use the ';'
1365 * character as a separator to be consistent with the bootloader.
1368 static char linker_path[MAXPATHLEN] = "/boot;/boot/modules;/;/modules";
1370 SYSCTL_STRING(_kern, OID_AUTO, module_path, CTLFLAG_RW, linker_path,
1371 sizeof(linker_path), "module load search path");
1372 TUNABLE_STR("module_path", linker_path, sizeof(linker_path));
1375 linker_search_path(const char *name)
1377 struct nlookupdata nd;
1378 char *cp, *ep, *result;
1379 size_t name_len, prefix_len;
1384 const char *exts[] = { "", ".ko", NULL };
1387 /* qualified at all? */
1388 if (index(name, '/'))
1389 return(linker_strdup(name));
1391 /* traverse the linker path */
1393 name_len = strlen(name);
1396 /* find the end of this component */
1397 for (ep = cp; (*ep != 0) && (*ep != ';'); ep++)
1399 prefix_len = ep - cp;
1400 /* if this component doesn't end with a slash, add one */
1401 if (ep == cp || *(ep - 1) != '/')
1407 * +2+3 : possible separator, plus terminator + possible extension.
1409 result = kmalloc(prefix_len + name_len + 2+3, M_LINKER, M_WAITOK);
1411 strncpy(result, cp, prefix_len);
1413 result[prefix_len++] = '/';
1414 strcpy(result + prefix_len, name);
1416 result_len = strlen(result);
1417 for (ext = exts; *ext != NULL; ext++) {
1418 strcpy(result + result_len, *ext);
1421 * Attempt to open the file, and return the path if we succeed and it's
1424 error = nlookup_init(&nd, result, UIO_SYSSPACE, NLC_FOLLOW|NLC_LOCKVP);
1426 error = vn_open(&nd, NULL, FREAD, 0);
1428 type = nd.nl_open_vp->v_type;
1437 kfree(result, M_LINKER);
1447 * Find a file which contains given module and load it, if "parent" is not
1448 * NULL, register a reference to it.
1451 linker_load_module(const char *kldname, const char *modname,
1452 struct linker_file *parent, struct mod_depend *verinfo,
1453 struct linker_file **lfpp)
1455 linker_file_t lfdep;
1456 const char *filename;
1460 if (modname == NULL) {
1462 * We have to load KLD
1464 KASSERT(verinfo == NULL, ("linker_load_module: verinfo is not NULL"));
1465 pathname = linker_search_path(kldname);
1467 if (modlist_lookup2(modname, verinfo) != NULL)
1469 if (kldname != NULL)
1471 pathname = linker_strdup(kldname);
1473 else if (rootvnode == NULL)
1477 pathname = linker_search_path(modname);
1481 * Need to find a KLD with required module
1483 pathname = linker_search_module(modname,
1484 strlen(modname), verinfo);
1487 if (pathname == NULL)
1491 * Can't load more than one file with the same basename XXX:
1492 * Actually it should be possible to have multiple KLDs with
1493 * the same basename but different path because they can
1494 * provide different versions of the same modules.
1496 filename = rindex(pathname, '/');
1497 if (filename == NULL)
1498 filename = filename;
1501 if (linker_find_file_by_name(filename))
1505 error = linker_load_file(pathname, &lfdep);
1508 if (modname && verinfo && modlist_lookup2(modname, verinfo) == NULL) {
1509 linker_file_unload(lfdep /* , LINKER_UNLOAD_FORCE */ );
1514 linker_file_add_dependancy(parent, lfdep);
1519 kfree(pathname, M_LINKER);
1524 * This routine is responsible for finding dependencies of userland initiated
1525 * kldload(2)'s of files.
1528 linker_load_dependencies(linker_file_t lf)
1530 linker_file_t lfdep;
1531 struct mod_metadata **start, **stop, **mdp, **nmdp;
1532 struct mod_metadata *mp, *nmp;
1533 struct mod_depend *verinfo;
1535 const char *modname, *nmodname;
1536 int ver, error = 0, count;
1539 * All files are dependant on /kernel.
1541 if (linker_kernel_file) {
1542 linker_kernel_file->refs++;
1543 linker_file_add_dependancy(lf, linker_kernel_file);
1545 if (linker_file_lookup_set(lf, MDT_SETNAME, &start, &stop, &count) != 0)
1547 for (mdp = start; mdp < stop; mdp++) {
1549 if (mp->md_type != MDT_VERSION)
1551 modname = mp->md_cval;
1552 ver = ((struct mod_version *)mp->md_data)->mv_version;
1553 mod = modlist_lookup(modname, ver);
1555 kprintf("interface %s.%d already present in the KLD '%s'!\n",
1556 modname, ver, mod->container->filename);
1561 for (mdp = start; mdp < stop; mdp++) {
1563 if (mp->md_type != MDT_DEPEND)
1565 modname = mp->md_cval;
1566 verinfo = mp->md_data;
1568 for (nmdp = start; nmdp < stop; nmdp++) {
1570 if (nmp->md_type != MDT_VERSION)
1572 nmodname = nmp->md_cval;
1573 if (strcmp(modname, nmodname) == 0)
1576 if (nmdp < stop) /* early exit, it's a self reference */
1578 mod = modlist_lookup2(modname, verinfo);
1579 if (mod) { /* woohoo, it's loaded already */
1580 lfdep = mod->container;
1582 linker_file_add_dependancy(lf, lfdep);
1585 error = linker_load_module(NULL, modname, lf, verinfo, NULL);
1587 kprintf("KLD %s: depends on %s - not available or version mismatch\n",
1588 lf->filename, modname);
1595 linker_addmodules(lf, start, stop, 0);