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 */
372 linker_find_file_by_name(const char* filename
)
374 linker_file_t lf
= 0;
378 for (i
= strlen(filename
); i
> 0 && filename
[i
-1] != '/'; --i
)
382 koname
= kmalloc(strlen(filename
) + 4, M_LINKER
, M_WAITOK
);
383 ksprintf(koname
, "%s.ko", filename
);
385 lockmgr(&lock
, LK_SHARED
);
386 TAILQ_FOREACH(lf
, &linker_files
, link
) {
387 if (!strcmp(lf
->filename
, koname
))
389 if (!strcmp(lf
->filename
, filename
))
392 lockmgr(&lock
, LK_RELEASE
);
395 kfree(koname
, M_LINKER
);
400 linker_find_file_by_id(int fileid
)
402 linker_file_t lf
= 0;
404 lockmgr(&lock
, LK_SHARED
);
405 TAILQ_FOREACH(lf
, &linker_files
, link
)
406 if (lf
->id
== fileid
)
408 lockmgr(&lock
, LK_RELEASE
);
414 linker_make_file(const char* pathname
, void* priv
, struct linker_file_ops
* ops
)
416 linker_file_t lf
= 0;
417 const char *filename
;
419 filename
= rindex(pathname
, '/');
420 if (filename
&& filename
[1])
425 KLD_DPF(FILE, ("linker_make_file: new file, filename=%s\n", filename
));
426 lockmgr(&lock
, LK_EXCLUSIVE
);
427 lf
= kmalloc(sizeof(struct linker_file
), M_LINKER
, M_WAITOK
);
428 bzero(lf
, sizeof(*lf
));
433 lf
->filename
= linker_strdup(filename
);
434 lf
->id
= next_file_id
++;
437 STAILQ_INIT(&lf
->common
);
438 TAILQ_INIT(&lf
->modules
);
442 TAILQ_INSERT_TAIL(&linker_files
, lf
, link
);
444 lockmgr(&lock
, LK_RELEASE
);
449 linker_file_unload(linker_file_t file
)
452 modlist_t ml
, nextml
;
453 struct common_symbol
* cp
;
457 /* Refuse to unload modules if securelevel raised */
458 if (securelevel
> 0 || kernel_mem_readonly
)
461 KLD_DPF(FILE, ("linker_file_unload: lf->refs=%d\n", file
->refs
));
463 lockmgr(&lock
, LK_EXCLUSIVE
);
465 /* Easy case of just dropping a reference. */
466 if (file
->refs
> 1) {
468 lockmgr(&lock
, LK_RELEASE
);
472 KLD_DPF(FILE, ("linker_file_unload: file is unloading, informing modules\n"));
475 * Inform any modules associated with this file.
477 mod
= TAILQ_FIRST(&file
->modules
);
478 for (mod
= TAILQ_FIRST(&file
->modules
); mod
; mod
= next
) {
479 next
= module_getfnext(mod
);
482 * Give the module a chance to veto the unload. Note that the
483 * act of unloading the module may cause other modules in the
484 * same file list to be unloaded recursively.
486 if ((error
= module_unload(mod
)) != 0) {
487 KLD_DPF(FILE, ("linker_file_unload: module %p vetoes unload\n",
489 lockmgr(&lock
, LK_RELEASE
);
496 TAILQ_FOREACH_MUTABLE(ml
, &found_modules
, link
, nextml
) {
497 if (ml
->container
== file
) {
498 TAILQ_REMOVE(&found_modules
, ml
, link
);
503 /* Don't try to run SYSUNINITs if we are unloaded due to a link error */
504 if (file
->flags
& LINKER_FILE_LINKED
) {
505 file
->flags
&= ~LINKER_FILE_LINKED
;
506 lockmgr(&lock
, LK_RELEASE
);
507 linker_file_sysuninit(file
);
508 linker_file_unregister_sysctls(file
);
509 lockmgr(&lock
, LK_EXCLUSIVE
);
512 TAILQ_REMOVE(&linker_files
, file
, link
);
515 lockmgr(&lock
, LK_RELEASE
);
516 for (i
= 0; i
< file
->ndeps
; i
++)
517 linker_file_unload(file
->deps
[i
]);
518 lockmgr(&lock
, LK_EXCLUSIVE
);
519 kfree(file
->deps
, M_LINKER
);
523 while ((cp
= STAILQ_FIRST(&file
->common
)) != NULL
) {
524 STAILQ_REMOVE_HEAD(&file
->common
, link
);
528 file
->ops
->unload(file
);
530 if (file
->filename
) {
531 kfree(file
->filename
, M_LINKER
);
532 file
->filename
= NULL
;
535 kfree(file
, M_LINKER
);
537 lockmgr(&lock
, LK_RELEASE
);
544 linker_file_add_dependancy(linker_file_t file
, linker_file_t dep
)
546 linker_file_t
* newdeps
;
548 newdeps
= kmalloc((file
->ndeps
+ 1) * sizeof(linker_file_t
*),
549 M_LINKER
, M_WAITOK
| M_ZERO
);
552 bcopy(file
->deps
, newdeps
, file
->ndeps
* sizeof(linker_file_t
*));
553 kfree(file
->deps
, M_LINKER
);
555 file
->deps
= newdeps
;
556 file
->deps
[file
->ndeps
] = dep
;
561 * Locate a linker set and its contents.
562 * This is a helper function to avoid linker_if.h exposure elsewhere.
563 * Note: firstp and lastp are really void ***
566 linker_file_lookup_set(linker_file_t file
, const char *name
,
567 void *firstp
, void *lastp
, int *countp
)
569 return file
->ops
->lookup_set(file
, name
, firstp
, lastp
, countp
);
573 linker_file_lookup_symbol(linker_file_t file
, const char* name
, int deps
, caddr_t
*raddr
)
576 linker_symval_t symval
;
578 size_t common_size
= 0;
581 KLD_DPF(SYM
, ("linker_file_lookup_symbol: file=%p, name=%s, deps=%d\n",
584 if (file
->ops
->lookup_symbol(file
, name
, &sym
) == 0) {
585 file
->ops
->symbol_values(file
, sym
, &symval
);
588 * XXX Assume a common symbol if its value is 0 and it has a non-zero
589 * size, otherwise it could be an absolute symbol with a value of 0.
591 if (symval
.value
== 0 && symval
.size
!= 0) {
593 * For commons, first look them up in the dependancies and
594 * only allocate space if not found there.
596 common_size
= symval
.size
;
598 KLD_DPF(SYM
, ("linker_file_lookup_symbol: symbol.value=%p\n", symval
.value
));
599 *raddr
= symval
.value
;
604 for (i
= 0; i
< file
->ndeps
; i
++) {
605 if (linker_file_lookup_symbol(file
->deps
[i
], name
, 0, raddr
) == 0) {
606 KLD_DPF(SYM
, ("linker_file_lookup_symbol: deps value=%p\n", *raddr
));
611 /* If we have not found it in the dependencies, search globally */
612 TAILQ_FOREACH(lf
, &linker_files
, link
) {
613 /* But skip the current file if it's on the list */
616 /* And skip the files we searched above */
617 for (i
= 0; i
< file
->ndeps
; i
++)
618 if (lf
== file
->deps
[i
])
622 if (linker_file_lookup_symbol(lf
, name
, 0, raddr
) == 0) {
623 KLD_DPF(SYM
, ("linker_file_lookup_symbol: global value=%p\n", *raddr
));
629 if (common_size
> 0) {
631 * This is a common symbol which was not found in the
632 * dependancies. We maintain a simple common symbol table in
635 struct common_symbol
* cp
;
637 STAILQ_FOREACH(cp
, &file
->common
, link
)
638 if (!strcmp(cp
->name
, name
)) {
639 KLD_DPF(SYM
, ("linker_file_lookup_symbol: old common value=%p\n", cp
->address
));
640 *raddr
= cp
->address
;
645 * Round the symbol size up to align.
647 common_size
= (common_size
+ sizeof(int) - 1) & -sizeof(int);
648 cp
= kmalloc(sizeof(struct common_symbol
)
651 M_LINKER
, M_WAITOK
| M_ZERO
);
653 cp
->address
= (caddr_t
) (cp
+ 1);
654 cp
->name
= cp
->address
+ common_size
;
655 strcpy(cp
->name
, name
);
656 bzero(cp
->address
, common_size
);
657 STAILQ_INSERT_TAIL(&file
->common
, cp
, link
);
659 KLD_DPF(SYM
, ("linker_file_lookup_symbol: new common value=%p\n", cp
->address
));
660 *raddr
= cp
->address
;
664 #ifdef _KERNEL_VIRTUAL
665 *raddr
= dlsym(RTLD_NEXT
, name
);
666 if (*raddr
!= NULL
) {
667 KLD_DPF(SYM
, ("linker_file_lookup_symbol: found dlsym=%x\n", *raddr
));
672 KLD_DPF(SYM
, ("linker_file_lookup_symbol: fail\n"));
678 * DDB Helpers. DDB has to look across multiple files with their own
679 * symbol tables and string tables.
681 * Note that we do not obey list locking protocols here. We really don't
682 * need DDB to hang because somebody's got the lock held. We'll take the
683 * chance that the files list is inconsistant instead.
687 linker_ddb_lookup(const char *symstr
, c_linker_sym_t
*sym
)
691 TAILQ_FOREACH(lf
, &linker_files
, link
) {
692 if (lf
->ops
->lookup_symbol(lf
, symstr
, sym
) == 0)
699 linker_ddb_search_symbol(caddr_t value
, c_linker_sym_t
*sym
, long *diffp
)
702 u_long off
= (uintptr_t)value
;
703 u_long diff
, bestdiff
;
709 TAILQ_FOREACH(lf
, &linker_files
, link
) {
710 if (lf
->ops
->search_symbol(lf
, value
, &es
, &diff
) != 0)
712 if (es
!= 0 && diff
< bestdiff
) {
731 linker_ddb_symbol_values(c_linker_sym_t sym
, linker_symval_t
*symval
)
735 TAILQ_FOREACH(lf
, &linker_files
, link
) {
736 if (lf
->ops
->symbol_values(lf
, sym
, symval
) == 0)
750 sys_kldload(struct kldload_args
*uap
)
752 struct thread
*td
= curthread
;
754 char *kldname
, *modname
;
758 uap
->sysmsg_result
= -1;
760 if (securelevel
> 0 || kernel_mem_readonly
) /* redundant, but that's OK */
763 if ((error
= priv_check(td
, PRIV_KLD_LOAD
)) != 0)
766 file
= kmalloc(MAXPATHLEN
, M_TEMP
, M_WAITOK
);
767 if ((error
= copyinstr(uap
->file
, file
, MAXPATHLEN
, NULL
)) != 0)
771 * If file does not contain a qualified name or any dot in it
772 * (kldname.ko, or kldname.ver.ko) treat it as an interface
775 if (index(file
, '/') || index(file
, '.')) {
784 error
= linker_load_module(kldname
, modname
, NULL
, NULL
, &lf
);
790 uap
->sysmsg_result
= lf
->id
;
802 sys_kldunload(struct kldunload_args
*uap
)
804 struct thread
*td
= curthread
;
808 if (securelevel
> 0 || kernel_mem_readonly
) /* redundant, but that's OK */
811 if ((error
= priv_check(td
, PRIV_KLD_UNLOAD
)) != 0)
815 lf
= linker_find_file_by_id(uap
->fileid
);
817 KLD_DPF(FILE, ("kldunload: lf->userrefs=%d\n", lf
->userrefs
));
818 if (lf
->userrefs
== 0) {
819 kprintf("linkerunload: attempt to unload file that was loaded by the kernel\n");
824 error
= linker_file_unload(lf
);
839 sys_kldfind(struct kldfind_args
*uap
)
841 char *filename
= NULL
, *modulename
;
845 uap
->sysmsg_result
= -1;
847 filename
= kmalloc(MAXPATHLEN
, M_TEMP
, M_WAITOK
);
848 if ((error
= copyinstr(uap
->file
, filename
, MAXPATHLEN
, NULL
)) != 0)
851 modulename
= rindex(filename
, '/');
852 if (modulename
== NULL
)
853 modulename
= filename
;
856 lf
= linker_find_file_by_name(modulename
);
858 uap
->sysmsg_result
= lf
->id
;
865 kfree(filename
, M_TEMP
);
873 sys_kldnext(struct kldnext_args
*uap
)
879 if (uap
->fileid
== 0) {
880 lf
= TAILQ_FIRST(&linker_files
);
882 lf
= linker_find_file_by_id(uap
->fileid
);
887 lf
= TAILQ_NEXT(lf
, link
);
890 /* Skip partially loaded files. */
891 while (lf
!= NULL
&& !(lf
->flags
& LINKER_FILE_LINKED
)) {
892 lf
= TAILQ_NEXT(lf
, link
);
896 uap
->sysmsg_result
= lf
->id
;
898 uap
->sysmsg_result
= 0;
909 sys_kldstat(struct kldstat_args
*uap
)
914 struct kld_file_stat
* stat
;
918 lf
= linker_find_file_by_id(uap
->fileid
);
927 * Check the version of the user's structure.
929 if ((error
= copyin(&stat
->version
, &version
, sizeof(version
))) != 0)
931 if (version
!= sizeof(struct kld_file_stat
)) {
936 namelen
= strlen(lf
->filename
) + 1;
937 if (namelen
> MAXPATHLEN
)
938 namelen
= MAXPATHLEN
;
939 if ((error
= copyout(lf
->filename
, &stat
->name
[0], namelen
)) != 0)
941 if ((error
= copyout(&lf
->refs
, &stat
->refs
, sizeof(int))) != 0)
943 if ((error
= copyout(&lf
->id
, &stat
->id
, sizeof(int))) != 0)
945 if ((error
= copyout(&lf
->address
, &stat
->address
, sizeof(caddr_t
))) != 0)
947 if ((error
= copyout(&lf
->size
, &stat
->size
, sizeof(size_t))) != 0)
950 uap
->sysmsg_result
= 0;
961 sys_kldfirstmod(struct kldfirstmod_args
*uap
)
967 lf
= linker_find_file_by_id(uap
->fileid
);
969 if (TAILQ_FIRST(&lf
->modules
))
970 uap
->sysmsg_result
= module_getid(TAILQ_FIRST(&lf
->modules
));
972 uap
->sysmsg_result
= 0;
985 sys_kldsym(struct kldsym_args
*uap
)
989 linker_symval_t symval
;
991 struct kld_sym_lookup lookup
;
995 if ((error
= copyin(uap
->data
, &lookup
, sizeof(lookup
))) != 0)
997 if (lookup
.version
!= sizeof(lookup
) || uap
->cmd
!= KLDSYM_LOOKUP
) {
1002 symstr
= kmalloc(MAXPATHLEN
, M_TEMP
, M_WAITOK
);
1003 if ((error
= copyinstr(lookup
.symname
, symstr
, MAXPATHLEN
, NULL
)) != 0)
1006 if (uap
->fileid
!= 0) {
1007 lf
= linker_find_file_by_id(uap
->fileid
);
1012 if (lf
->ops
->lookup_symbol(lf
, symstr
, &sym
) == 0 &&
1013 lf
->ops
->symbol_values(lf
, sym
, &symval
) == 0) {
1014 lookup
.symvalue
= (uintptr_t)symval
.value
;
1015 lookup
.symsize
= symval
.size
;
1016 error
= copyout(&lookup
, uap
->data
, sizeof(lookup
));
1020 TAILQ_FOREACH(lf
, &linker_files
, link
) {
1021 if (lf
->ops
->lookup_symbol(lf
, symstr
, &sym
) == 0 &&
1022 lf
->ops
->symbol_values(lf
, sym
, &symval
) == 0) {
1023 lookup
.symvalue
= (uintptr_t)symval
.value
;
1024 lookup
.symsize
= symval
.size
;
1025 error
= copyout(&lookup
, uap
->data
, sizeof(lookup
));
1035 kfree(symstr
, M_TEMP
);
1040 * Preloaded module support
1044 modlist_lookup(const char *name
, int ver
)
1048 TAILQ_FOREACH(mod
, &found_modules
, link
) {
1049 if (strcmp(mod
->name
, name
) == 0 && (ver
== 0 || mod
->version
== ver
))
1056 modlist_lookup2(const char *name
, struct mod_depend
*verinfo
)
1058 modlist_t mod
, bestmod
;
1061 if (verinfo
== NULL
)
1062 return (modlist_lookup(name
, 0));
1064 TAILQ_FOREACH(mod
, &found_modules
, link
) {
1065 if (strcmp(mod
->name
, name
) != 0)
1068 if (ver
== verinfo
->md_ver_preferred
)
1070 if (ver
>= verinfo
->md_ver_minimum
&&
1071 ver
<= verinfo
->md_ver_maximum
&&
1072 (bestmod
== NULL
|| ver
> bestmod
->version
))
1079 modlist_newmodule(const char *modname
, int version
, linker_file_t container
)
1083 mod
= kmalloc(sizeof(struct modlist
), M_LINKER
, M_NOWAIT
| M_ZERO
);
1085 panic("no memory for module list");
1086 mod
->container
= container
;
1087 mod
->name
= modname
;
1088 mod
->version
= version
;
1089 TAILQ_INSERT_TAIL(&found_modules
, mod
, link
);
1094 linker_addmodules(linker_file_t lf
, struct mod_metadata
**start
,
1095 struct mod_metadata
**stop
, int preload
)
1097 struct mod_metadata
*mp
, **mdp
;
1098 const char *modname
;
1101 for (mdp
= start
; mdp
< stop
; mdp
++) {
1103 if (mp
->md_type
!= MDT_VERSION
)
1105 modname
= mp
->md_cval
;
1106 ver
= ((struct mod_version
*)mp
->md_data
)->mv_version
;
1107 if (modlist_lookup(modname
, ver
) != NULL
) {
1108 kprintf("module %s already present!\n", modname
);
1109 /* XXX what can we do? this is a build error. :-( */
1112 modlist_newmodule(modname
, ver
, lf
);
1117 linker_preload(void* arg
)
1120 const char *modname
, *nmodname
;
1122 linker_file_t lf
, nlf
;
1125 linker_file_list_t loaded_files
;
1126 linker_file_list_t depended_files
;
1127 struct mod_metadata
*mp
, *nmp
;
1128 struct mod_metadata
**start
, **stop
, **mdp
, **nmdp
;
1129 struct mod_depend
*verinfo
;
1133 struct sysinit
**si_start
, **si_stop
;
1135 TAILQ_INIT(&loaded_files
);
1136 TAILQ_INIT(&depended_files
);
1137 TAILQ_INIT(&found_modules
);
1140 while ((modptr
= preload_search_next_name(modptr
)) != NULL
) {
1141 modname
= (char *)preload_search_info(modptr
, MODINFO_NAME
);
1142 modtype
= (char *)preload_search_info(modptr
, MODINFO_TYPE
);
1143 if (modname
== NULL
) {
1144 kprintf("Preloaded module at %p does not have a name!\n", modptr
);
1147 if (modtype
== NULL
) {
1148 kprintf("Preloaded module at %p does not have a type!\n", modptr
);
1153 kprintf("Preloaded %s \"%s\" at %p.\n", modtype
, modname
, modptr
);
1155 TAILQ_FOREACH(lc
, &classes
, link
) {
1156 error
= lc
->ops
->preload_file(modname
, &lf
);
1162 TAILQ_INSERT_TAIL(&loaded_files
, lf
, loaded
);
1166 * First get a list of stuff in the kernel.
1168 if (linker_file_lookup_set(linker_kernel_file
, MDT_SETNAME
, &start
,
1170 linker_addmodules(linker_kernel_file
, start
, stop
, 1);
1173 * This is a once-off kinky bubble sort to resolve relocation
1174 * dependency requirements.
1177 TAILQ_FOREACH(lf
, &loaded_files
, loaded
) {
1178 error
= linker_file_lookup_set(lf
, MDT_SETNAME
, &start
, &stop
, NULL
);
1180 * First, look to see if we would successfully link with this
1183 resolves
= 1; /* unless we know otherwise */
1185 for (mdp
= start
; mdp
< stop
; mdp
++) {
1187 if (mp
->md_type
!= MDT_DEPEND
)
1189 modname
= mp
->md_cval
;
1190 verinfo
= mp
->md_data
;
1191 for (nmdp
= start
; nmdp
< stop
; nmdp
++) {
1193 if (nmp
->md_type
!= MDT_VERSION
)
1195 nmodname
= nmp
->md_cval
;
1196 if (strcmp(modname
, nmodname
) == 0)
1199 if (nmdp
< stop
)/* it's a self reference */
1203 * ok, the module isn't here yet, we
1206 if (modlist_lookup2(modname
, verinfo
) == NULL
)
1211 * OK, if we found our modules, we can link. So, "provide"
1212 * the modules inside and add it to the end of the link order
1217 for (mdp
= start
; mdp
< stop
; mdp
++) {
1219 if (mp
->md_type
!= MDT_VERSION
)
1221 modname
= mp
->md_cval
;
1222 nver
= ((struct mod_version
*)mp
->md_data
)->mv_version
;
1223 if (modlist_lookup(modname
, nver
) != NULL
) {
1224 kprintf("module %s already present!\n", modname
);
1225 TAILQ_REMOVE(&loaded_files
, lf
, loaded
);
1226 linker_file_unload(lf
/* , LINKER_UNLOAD_FORCE */ );
1227 /* we changed tailq next ptr */
1230 modlist_newmodule(modname
, nver
, lf
);
1233 TAILQ_REMOVE(&loaded_files
, lf
, loaded
);
1234 TAILQ_INSERT_TAIL(&depended_files
, lf
, loaded
);
1236 * Since we provided modules, we need to restart the
1237 * sort so that the previous files that depend on us
1238 * have a chance. Also, we've busted the tailq next
1239 * pointer with the REMOVE.
1246 * At this point, we check to see what could not be resolved..
1248 while ((lf
= TAILQ_FIRST(&loaded_files
)) != NULL
) {
1249 TAILQ_REMOVE(&loaded_files
, lf
, loaded
);
1250 kprintf("KLD file %s is missing dependencies\n", lf
->filename
);
1251 linker_file_unload(lf
/* , LINKER_UNLOAD_FORCE */ );
1255 * We made it. Finish off the linking in the order we determined.
1257 TAILQ_FOREACH_MUTABLE(lf
, &depended_files
, loaded
, nlf
) {
1258 if (linker_kernel_file
) {
1259 linker_kernel_file
->refs
++;
1260 linker_file_add_dependancy(lf
, linker_kernel_file
);
1264 error
= linker_file_lookup_set(lf
, MDT_SETNAME
, &start
, &stop
, NULL
);
1266 for (mdp
= start
; mdp
< stop
; mdp
++) {
1268 if (mp
->md_type
!= MDT_DEPEND
)
1270 modname
= mp
->md_cval
;
1271 verinfo
= mp
->md_data
;
1272 mod
= modlist_lookup2(modname
, verinfo
);
1273 /* Don't count self-dependencies */
1274 if (lf
== mod
->container
)
1276 mod
->container
->refs
++;
1277 linker_file_add_dependancy(lf
, mod
->container
);
1281 * Now do relocation etc using the symbol search paths
1282 * established by the dependencies
1284 error
= lf
->ops
->preload_finish(lf
);
1286 TAILQ_REMOVE(&depended_files
, lf
, loaded
);
1287 kprintf("KLD file %s - could not finalize loading\n",
1289 linker_file_unload(lf
/* , LINKER_UNLOAD_FORCE */);
1292 linker_file_register_modules(lf
);
1293 if (linker_file_lookup_set(lf
, "sysinit_set", &si_start
, &si_stop
, NULL
) == 0)
1294 sysinit_add(si_start
, si_stop
);
1295 linker_file_register_sysctls(lf
);
1296 lf
->flags
|= LINKER_FILE_LINKED
;
1298 /* woohoo! we made it! */
1301 SYSINIT(preload
, SI_BOOT2_KLD
, SI_ORDER_MIDDLE
, linker_preload
, 0);
1304 * Search for a not-loaded module by name.
1306 * Modules may be found in the following locations:
1308 * - preloaded (result is just the module name)
1309 * - on disk (result is full path to module)
1311 * If the module name is qualified in any way (contains path, etc.)
1312 * the we simply return a copy of it.
1314 * The search path can be manipulated via sysctl. Note that we use the ';'
1315 * character as a separator to be consistent with the bootloader.
1318 static char linker_path
[MAXPATHLEN
] = "/boot;/boot/modules;/;/modules";
1320 SYSCTL_STRING(_kern
, OID_AUTO
, module_path
, CTLFLAG_RW
, linker_path
,
1321 sizeof(linker_path
), "module load search path");
1322 TUNABLE_STR("module_path", linker_path
, sizeof(linker_path
));
1325 linker_search_path(const char *name
)
1327 struct nlookupdata nd
;
1328 char *cp
, *ep
, *result
;
1329 size_t name_len
, prefix_len
;
1334 const char *exts
[] = { "", ".ko", NULL
};
1337 /* qualified at all? */
1338 if (index(name
, '/'))
1339 return(linker_strdup(name
));
1341 /* traverse the linker path */
1343 name_len
= strlen(name
);
1346 /* find the end of this component */
1347 for (ep
= cp
; (*ep
!= 0) && (*ep
!= ';'); ep
++)
1349 prefix_len
= ep
- cp
;
1350 /* if this component doesn't end with a slash, add one */
1351 if (ep
== cp
|| *(ep
- 1) != '/')
1357 * +2+3 : possible separator, plus terminator + possible extension.
1359 result
= kmalloc(prefix_len
+ name_len
+ 2+3, M_LINKER
, M_WAITOK
);
1361 strncpy(result
, cp
, prefix_len
);
1363 result
[prefix_len
++] = '/';
1364 strcpy(result
+ prefix_len
, name
);
1366 result_len
= strlen(result
);
1367 for (ext
= exts
; *ext
!= NULL
; ext
++) {
1368 strcpy(result
+ result_len
, *ext
);
1371 * Attempt to open the file, and return the path if we succeed and it's
1374 error
= nlookup_init(&nd
, result
, UIO_SYSSPACE
, NLC_FOLLOW
|NLC_LOCKVP
);
1376 error
= vn_open(&nd
, NULL
, FREAD
, 0);
1378 type
= nd
.nl_open_vp
->v_type
;
1387 kfree(result
, M_LINKER
);
1397 * Find a file which contains given module and load it, if "parent" is not
1398 * NULL, register a reference to it.
1401 linker_load_module(const char *kldname
, const char *modname
,
1402 struct linker_file
*parent
, struct mod_depend
*verinfo
,
1403 struct linker_file
**lfpp
)
1405 linker_file_t lfdep
;
1406 const char *filename
;
1410 if (modname
== NULL
) {
1412 * We have to load KLD
1414 KASSERT(verinfo
== NULL
, ("linker_load_module: verinfo is not NULL"));
1415 pathname
= linker_search_path(kldname
);
1417 if (modlist_lookup2(modname
, verinfo
) != NULL
)
1419 if (kldname
!= NULL
)
1420 pathname
= linker_strdup(kldname
);
1421 else if (rootvnode
== NULL
)
1424 pathname
= linker_search_path(modname
);
1427 * Need to find a KLD with required module
1429 pathname
= linker_search_module(modname
,
1430 strlen(modname
), verinfo
);
1433 if (pathname
== NULL
)
1437 * Can't load more than one file with the same basename XXX:
1438 * Actually it should be possible to have multiple KLDs with
1439 * the same basename but different path because they can
1440 * provide different versions of the same modules.
1442 filename
= rindex(pathname
, '/');
1443 if (filename
== NULL
)
1444 filename
= filename
;
1447 if (linker_find_file_by_name(filename
))
1451 error
= linker_load_file(pathname
, &lfdep
);
1454 if (modname
&& verinfo
&& modlist_lookup2(modname
, verinfo
) == NULL
) {
1455 linker_file_unload(lfdep
/* , LINKER_UNLOAD_FORCE */ );
1460 linker_file_add_dependancy(parent
, lfdep
);
1465 kfree(pathname
, M_LINKER
);
1470 * This routine is responsible for finding dependencies of userland initiated
1471 * kldload(2)'s of files.
1474 linker_load_dependencies(linker_file_t lf
)
1476 linker_file_t lfdep
;
1477 struct mod_metadata
**start
, **stop
, **mdp
, **nmdp
;
1478 struct mod_metadata
*mp
, *nmp
;
1479 struct mod_depend
*verinfo
;
1481 const char *modname
, *nmodname
;
1482 int ver
, error
= 0, count
;
1485 * All files are dependant on /kernel.
1487 if (linker_kernel_file
) {
1488 linker_kernel_file
->refs
++;
1489 linker_file_add_dependancy(lf
, linker_kernel_file
);
1491 if (linker_file_lookup_set(lf
, MDT_SETNAME
, &start
, &stop
, &count
) != 0)
1493 for (mdp
= start
; mdp
< stop
; mdp
++) {
1495 if (mp
->md_type
!= MDT_VERSION
)
1497 modname
= mp
->md_cval
;
1498 ver
= ((struct mod_version
*)mp
->md_data
)->mv_version
;
1499 mod
= modlist_lookup(modname
, ver
);
1501 kprintf("interface %s.%d already present in the KLD '%s'!\n",
1502 modname
, ver
, mod
->container
->filename
);
1507 for (mdp
= start
; mdp
< stop
; mdp
++) {
1509 if (mp
->md_type
!= MDT_DEPEND
)
1511 modname
= mp
->md_cval
;
1512 verinfo
= mp
->md_data
;
1514 for (nmdp
= start
; nmdp
< stop
; nmdp
++) {
1516 if (nmp
->md_type
!= MDT_VERSION
)
1518 nmodname
= nmp
->md_cval
;
1519 if (strcmp(modname
, nmodname
) == 0)
1522 if (nmdp
< stop
) /* early exit, it's a self reference */
1524 mod
= modlist_lookup2(modname
, verinfo
);
1525 if (mod
) { /* woohoo, it's loaded already */
1526 lfdep
= mod
->container
;
1528 linker_file_add_dependancy(lf
, lfdep
);
1531 error
= linker_load_module(NULL
, modname
, lf
, verinfo
, NULL
);
1533 kprintf("KLD %s: depends on %s - not available or version mismatch\n",
1534 lf
->filename
, modname
);
1541 linker_addmodules(lf
, start
, stop
, 0);