2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1998-2000 Doug Rabson
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/systm.h>
40 #include <sys/kernel.h>
42 #include <sys/malloc.h>
43 #include <sys/mutex.h>
44 #include <sys/mount.h>
47 #include <sys/namei.h>
48 #include <sys/fcntl.h>
49 #include <sys/vnode.h>
50 #include <sys/linker.h>
52 #include <machine/elf.h>
56 #include <security/mac/mac_framework.h>
59 #include <vm/vm_param.h>
61 #include <vm/vm_object.h>
62 #include <vm/vm_kern.h>
63 #include <vm/vm_extern.h>
66 #include <vm/vm_map.h>
68 #include <sys/link_elf.h>
74 #include "linker_if.h"
78 typedef struct elf_file {
79 struct linker_file lf; /* Common fields */
80 int preloaded; /* Was file pre-loaded */
81 caddr_t address; /* Relocation address */
83 vm_object_t object; /* VM object to hold file pages */
85 Elf_Dyn *dynamic; /* Symbol table etc. */
86 Elf_Hashelt nbuckets; /* DT_HASH info */
88 const Elf_Hashelt *buckets;
89 const Elf_Hashelt *chains;
91 caddr_t strtab; /* DT_STRTAB */
92 int strsz; /* DT_STRSZ */
93 const Elf_Sym *symtab; /* DT_SYMTAB */
94 Elf_Addr *got; /* DT_PLTGOT */
95 const Elf_Rel *pltrel; /* DT_JMPREL */
96 int pltrelsize; /* DT_PLTRELSZ */
97 const Elf_Rela *pltrela; /* DT_JMPREL */
98 int pltrelasize; /* DT_PLTRELSZ */
99 const Elf_Rel *rel; /* DT_REL */
100 int relsize; /* DT_RELSZ */
101 const Elf_Rela *rela; /* DT_RELA */
102 int relasize; /* DT_RELASZ */
104 const Elf_Sym *ddbsymtab; /* The symbol table we are using */
105 long ddbsymcnt; /* Number of symbols */
106 caddr_t ddbstrtab; /* String table */
107 long ddbstrcnt; /* number of bytes in string table */
108 caddr_t symbase; /* malloc'ed symbold base */
109 caddr_t strbase; /* malloc'ed string base */
110 caddr_t ctftab; /* CTF table */
111 long ctfcnt; /* number of bytes in CTF table */
112 caddr_t ctfoff; /* CTF offset table */
113 caddr_t typoff; /* Type offset table */
114 long typlen; /* Number of type entries. */
115 Elf_Addr pcpu_start; /* Pre-relocation pcpu set start. */
116 Elf_Addr pcpu_stop; /* Pre-relocation pcpu set stop. */
117 Elf_Addr pcpu_base; /* Relocated pcpu set address. */
119 Elf_Addr vnet_start; /* Pre-relocation vnet set start. */
120 Elf_Addr vnet_stop; /* Pre-relocation vnet set stop. */
121 Elf_Addr vnet_base; /* Relocated vnet set address. */
124 struct link_map gdb; /* hooks for gdb */
132 TAILQ_ENTRY(elf_set) es_link;
135 TAILQ_HEAD(elf_set_head, elf_set);
137 #include <kern/kern_ctf.c>
139 static int link_elf_link_common_finish(linker_file_t);
140 static int link_elf_link_preload(linker_class_t cls,
141 const char *, linker_file_t *);
142 static int link_elf_link_preload_finish(linker_file_t);
143 static int link_elf_load_file(linker_class_t, const char *,
145 static int link_elf_lookup_symbol(linker_file_t, const char *,
147 static int link_elf_symbol_values(linker_file_t, c_linker_sym_t,
149 static int link_elf_search_symbol(linker_file_t, caddr_t,
150 c_linker_sym_t *, long *);
152 static void link_elf_unload_file(linker_file_t);
153 static void link_elf_unload_preload(linker_file_t);
154 static int link_elf_lookup_set(linker_file_t, const char *,
155 void ***, void ***, int *);
156 static int link_elf_each_function_name(linker_file_t,
157 int (*)(const char *, void *), void *);
158 static int link_elf_each_function_nameval(linker_file_t,
159 linker_function_nameval_callback_t, void *);
160 static void link_elf_reloc_local(linker_file_t);
161 static long link_elf_symtab_get(linker_file_t, const Elf_Sym **);
162 static long link_elf_strtab_get(linker_file_t, caddr_t *);
163 static int elf_lookup(linker_file_t, Elf_Size, int, Elf_Addr *);
165 static kobj_method_t link_elf_methods[] = {
166 KOBJMETHOD(linker_lookup_symbol, link_elf_lookup_symbol),
167 KOBJMETHOD(linker_symbol_values, link_elf_symbol_values),
168 KOBJMETHOD(linker_search_symbol, link_elf_search_symbol),
169 KOBJMETHOD(linker_unload, link_elf_unload_file),
170 KOBJMETHOD(linker_load_file, link_elf_load_file),
171 KOBJMETHOD(linker_link_preload, link_elf_link_preload),
172 KOBJMETHOD(linker_link_preload_finish, link_elf_link_preload_finish),
173 KOBJMETHOD(linker_lookup_set, link_elf_lookup_set),
174 KOBJMETHOD(linker_each_function_name, link_elf_each_function_name),
175 KOBJMETHOD(linker_each_function_nameval, link_elf_each_function_nameval),
176 KOBJMETHOD(linker_ctf_get, link_elf_ctf_get),
177 KOBJMETHOD(linker_symtab_get, link_elf_symtab_get),
178 KOBJMETHOD(linker_strtab_get, link_elf_strtab_get),
182 static struct linker_class link_elf_class = {
183 #if ELF_TARG_CLASS == ELFCLASS32
188 link_elf_methods, sizeof(struct elf_file)
191 typedef int (*elf_reloc_fn)(linker_file_t lf, Elf_Addr relocbase,
192 const void *data, int type, elf_lookup_fn lookup);
194 static int parse_dynamic(elf_file_t);
195 static int relocate_file(elf_file_t);
196 static int relocate_file1(elf_file_t ef, elf_lookup_fn lookup,
197 elf_reloc_fn reloc, bool ifuncs);
198 static int link_elf_preload_parse_symbols(elf_file_t);
200 static struct elf_set_head set_pcpu_list;
202 static struct elf_set_head set_vnet_list;
206 elf_set_add(struct elf_set_head *list, Elf_Addr start, Elf_Addr stop, Elf_Addr base)
208 struct elf_set *set, *iter;
210 set = malloc(sizeof(*set), M_LINKER, M_WAITOK);
211 set->es_start = start;
215 TAILQ_FOREACH(iter, list, es_link) {
217 KASSERT((set->es_start < iter->es_start && set->es_stop < iter->es_stop) ||
218 (set->es_start > iter->es_start && set->es_stop > iter->es_stop),
219 ("linker sets intersection: to insert: 0x%jx-0x%jx; inserted: 0x%jx-0x%jx",
220 (uintmax_t)set->es_start, (uintmax_t)set->es_stop,
221 (uintmax_t)iter->es_start, (uintmax_t)iter->es_stop));
223 if (iter->es_start > set->es_start) {
224 TAILQ_INSERT_BEFORE(iter, set, es_link);
230 TAILQ_INSERT_TAIL(list, set, es_link);
234 elf_set_find(struct elf_set_head *list, Elf_Addr addr, Elf_Addr *start, Elf_Addr *base)
238 TAILQ_FOREACH(set, list, es_link) {
239 if (addr < set->es_start)
241 if (addr < set->es_stop) {
242 *start = set->es_start;
243 *base = set->es_base;
252 elf_set_delete(struct elf_set_head *list, Elf_Addr start)
256 TAILQ_FOREACH(set, list, es_link) {
257 if (start < set->es_start)
259 if (start == set->es_start) {
260 TAILQ_REMOVE(list, set, es_link);
265 KASSERT(0, ("deleting unknown linker set (start = 0x%jx)",
270 static void r_debug_state(struct r_debug *, struct link_map *);
273 * A list of loaded modules for GDB to use for loading symbols.
275 struct r_debug r_debug;
277 #define GDB_STATE(s) do { \
278 r_debug.r_state = s; r_debug_state(NULL, NULL); \
282 * Function for the debugger to set a breakpoint on to gain control.
285 r_debug_state(struct r_debug *dummy_one __unused,
286 struct link_map *dummy_two __unused)
291 link_elf_add_gdb(struct link_map *l)
293 struct link_map *prev;
297 if (r_debug.r_map == NULL) {
302 /* Append to list. */
303 for (prev = r_debug.r_map;
304 prev->l_next != NULL;
313 link_elf_delete_gdb(struct link_map *l)
315 if (l->l_prev == NULL) {
317 if ((r_debug.r_map = l->l_next) != NULL)
318 l->l_next->l_prev = NULL;
320 /* Remove any but first. */
321 if ((l->l_prev->l_next = l->l_next) != NULL)
322 l->l_next->l_prev = l->l_prev;
328 * The kernel symbol table starts here.
330 extern struct _dynamic _DYNAMIC;
333 link_elf_error(const char *filename, const char *s)
335 if (filename == NULL)
336 printf("kldload: %s\n", s);
338 printf("kldload: %s: %s\n", filename, s);
342 link_elf_invoke_ctors(caddr_t addr, size_t size)
347 if (addr == NULL || size == 0)
349 cnt = size / sizeof(*ctor);
351 for (i = 0; i < cnt; i++) {
358 * Actions performed after linking/loading both the preloaded kernel and any
359 * modules; whether preloaded or dynamicly loaded.
362 link_elf_link_common_finish(linker_file_t lf)
365 elf_file_t ef = (elf_file_t)lf;
370 /* Notify MD code that a module is being loaded. */
371 error = elf_cpu_load_file(lf);
377 ef->gdb.l_addr = lf->address;
378 newfilename = malloc(strlen(lf->filename) + 1, M_LINKER, M_WAITOK);
379 strcpy(newfilename, lf->filename);
380 ef->gdb.l_name = newfilename;
381 ef->gdb.l_ld = ef->dynamic;
382 link_elf_add_gdb(&ef->gdb);
383 GDB_STATE(RT_CONSISTENT);
387 link_elf_invoke_ctors(lf->ctors_addr, lf->ctors_size);
391 extern vm_offset_t __startkernel, __endkernel;
394 link_elf_init(void* arg)
397 Elf_Addr *ctors_addrp;
398 Elf_Size *ctors_sizep;
399 caddr_t modptr, baseptr, sizeptr;
403 linker_add_class(&link_elf_class);
405 dp = (Elf_Dyn *)&_DYNAMIC;
407 modptr = preload_search_by_type("elf" __XSTRING(__ELF_WORD_SIZE) " kernel");
409 modptr = preload_search_by_type("elf kernel");
410 modname = (char *)preload_search_info(modptr, MODINFO_NAME);
413 linker_kernel_file = linker_make_file(modname, &link_elf_class);
414 if (linker_kernel_file == NULL)
415 panic("%s: Can't create linker structures for kernel",
418 ef = (elf_file_t) linker_kernel_file;
421 ef->address = (caddr_t) (__startkernel - KERNBASE);
425 #ifdef SPARSE_MAPPING
433 linker_kernel_file->address = (caddr_t)__startkernel;
434 linker_kernel_file->size = (intptr_t)(__endkernel - __startkernel);
436 linker_kernel_file->address += KERNBASE;
437 linker_kernel_file->size = -(intptr_t)linker_kernel_file->address;
440 if (modptr != NULL) {
442 baseptr = preload_search_info(modptr, MODINFO_ADDR);
444 linker_kernel_file->address = *(caddr_t *)baseptr;
445 sizeptr = preload_search_info(modptr, MODINFO_SIZE);
447 linker_kernel_file->size = *(size_t *)sizeptr;
448 ctors_addrp = (Elf_Addr *)preload_search_info(modptr,
449 MODINFO_METADATA | MODINFOMD_CTORS_ADDR);
450 ctors_sizep = (Elf_Size *)preload_search_info(modptr,
451 MODINFO_METADATA | MODINFOMD_CTORS_SIZE);
452 if (ctors_addrp != NULL && ctors_sizep != NULL) {
453 linker_kernel_file->ctors_addr = ef->address +
455 linker_kernel_file->ctors_size = *ctors_sizep;
458 (void)link_elf_preload_parse_symbols(ef);
461 r_debug.r_map = NULL;
462 r_debug.r_brk = r_debug_state;
463 r_debug.r_state = RT_CONSISTENT;
466 (void)link_elf_link_common_finish(linker_kernel_file);
467 linker_kernel_file->flags |= LINKER_FILE_LINKED;
468 TAILQ_INIT(&set_pcpu_list);
470 TAILQ_INIT(&set_vnet_list);
474 SYSINIT(link_elf, SI_SUB_KLD, SI_ORDER_THIRD, link_elf_init, NULL);
477 link_elf_preload_parse_symbols(elf_file_t ef)
480 caddr_t ssym, esym, base;
486 if (ef->modptr == NULL)
488 pointer = preload_search_info(ef->modptr,
489 MODINFO_METADATA | MODINFOMD_SSYM);
492 ssym = *(caddr_t *)pointer;
493 pointer = preload_search_info(ef->modptr,
494 MODINFO_METADATA | MODINFOMD_ESYM);
497 esym = *(caddr_t *)pointer;
501 symcnt = *(long *)base;
502 base += sizeof(long);
503 symtab = (Elf_Sym *)base;
504 base += roundup(symcnt, sizeof(long));
506 if (base > esym || base < ssym) {
507 printf("Symbols are corrupt!\n");
511 strcnt = *(long *)base;
512 base += sizeof(long);
514 base += roundup(strcnt, sizeof(long));
516 if (base > esym || base < ssym) {
517 printf("Symbols are corrupt!\n");
521 ef->ddbsymtab = symtab;
522 ef->ddbsymcnt = symcnt / sizeof(Elf_Sym);
523 ef->ddbstrtab = strtab;
524 ef->ddbstrcnt = strcnt;
530 parse_dynamic(elf_file_t ef)
533 int plttype = DT_REL;
535 for (dp = ef->dynamic; dp->d_tag != DT_NULL; dp++) {
539 /* From src/libexec/rtld-elf/rtld.c */
540 const Elf_Hashelt *hashtab = (const Elf_Hashelt *)
541 (ef->address + dp->d_un.d_ptr);
542 ef->nbuckets = hashtab[0];
543 ef->nchains = hashtab[1];
544 ef->buckets = hashtab + 2;
545 ef->chains = ef->buckets + ef->nbuckets;
549 ef->strtab = (caddr_t) (ef->address + dp->d_un.d_ptr);
552 ef->strsz = dp->d_un.d_val;
555 ef->symtab = (Elf_Sym*) (ef->address + dp->d_un.d_ptr);
558 if (dp->d_un.d_val != sizeof(Elf_Sym))
562 ef->got = (Elf_Addr *) (ef->address + dp->d_un.d_ptr);
565 ef->rel = (const Elf_Rel *) (ef->address + dp->d_un.d_ptr);
568 ef->relsize = dp->d_un.d_val;
571 if (dp->d_un.d_val != sizeof(Elf_Rel))
575 ef->pltrel = (const Elf_Rel *) (ef->address + dp->d_un.d_ptr);
578 ef->pltrelsize = dp->d_un.d_val;
581 ef->rela = (const Elf_Rela *) (ef->address + dp->d_un.d_ptr);
584 ef->relasize = dp->d_un.d_val;
587 if (dp->d_un.d_val != sizeof(Elf_Rela))
591 plttype = dp->d_un.d_val;
592 if (plttype != DT_REL && plttype != DT_RELA)
597 dp->d_un.d_ptr = (Elf_Addr)&r_debug;
603 if (plttype == DT_RELA) {
604 ef->pltrela = (const Elf_Rela *)ef->pltrel;
606 ef->pltrelasize = ef->pltrelsize;
610 ef->ddbsymtab = ef->symtab;
611 ef->ddbsymcnt = ef->nchains;
612 ef->ddbstrtab = ef->strtab;
613 ef->ddbstrcnt = ef->strsz;
619 parse_dpcpu(elf_file_t ef)
625 error = link_elf_lookup_set(&ef->lf, "pcpu", (void ***)&ef->pcpu_start,
626 (void ***)&ef->pcpu_stop, NULL);
627 /* Error just means there is no pcpu set to relocate. */
630 size = (uintptr_t)ef->pcpu_stop - (uintptr_t)ef->pcpu_start;
635 * Allocate space in the primary pcpu area. Copy in our
636 * initialization from the data section and then initialize
637 * all per-cpu storage from that.
639 ef->pcpu_base = (Elf_Addr)(uintptr_t)dpcpu_alloc(size);
640 if (ef->pcpu_base == 0) {
641 printf("%s: pcpu module space is out of space; "
642 "cannot allocate %d for %s\n",
643 __func__, size, ef->lf.pathname);
646 memcpy((void *)ef->pcpu_base, (void *)ef->pcpu_start, size);
647 dpcpu_copy((void *)ef->pcpu_base, size);
648 elf_set_add(&set_pcpu_list, ef->pcpu_start, ef->pcpu_stop,
656 parse_vnet(elf_file_t ef)
662 error = link_elf_lookup_set(&ef->lf, "vnet", (void ***)&ef->vnet_start,
663 (void ***)&ef->vnet_stop, NULL);
664 /* Error just means there is no vnet data set to relocate. */
667 size = (uintptr_t)ef->vnet_stop - (uintptr_t)ef->vnet_start;
672 * Allocate space in the primary vnet area. Copy in our
673 * initialization from the data section and then initialize
674 * all per-vnet storage from that.
676 ef->vnet_base = (Elf_Addr)(uintptr_t)vnet_data_alloc(size);
677 if (ef->vnet_base == 0) {
678 printf("%s: vnet module space is out of space; "
679 "cannot allocate %d for %s\n",
680 __func__, size, ef->lf.pathname);
683 memcpy((void *)ef->vnet_base, (void *)ef->vnet_start, size);
684 vnet_data_copy((void *)ef->vnet_base, size);
685 elf_set_add(&set_vnet_list, ef->vnet_start, ef->vnet_stop,
693 link_elf_link_preload(linker_class_t cls,
694 const char* filename, linker_file_t *result)
696 Elf_Addr *ctors_addrp;
697 Elf_Size *ctors_sizep;
698 caddr_t modptr, baseptr, sizeptr, dynptr;
705 /* Look to see if we have the file preloaded */
706 modptr = preload_search_by_name(filename);
710 type = (char *)preload_search_info(modptr, MODINFO_TYPE);
711 baseptr = preload_search_info(modptr, MODINFO_ADDR);
712 sizeptr = preload_search_info(modptr, MODINFO_SIZE);
713 dynptr = preload_search_info(modptr,
714 MODINFO_METADATA | MODINFOMD_DYNAMIC);
716 (strcmp(type, "elf" __XSTRING(__ELF_WORD_SIZE) " module") != 0 &&
717 strcmp(type, "elf module") != 0))
719 if (baseptr == NULL || sizeptr == NULL || dynptr == NULL)
722 lf = linker_make_file(filename, &link_elf_class);
726 ef = (elf_file_t) lf;
729 ef->address = *(caddr_t *)baseptr;
730 #ifdef SPARSE_MAPPING
733 dp = (vm_offset_t)ef->address + *(vm_offset_t *)dynptr;
734 ef->dynamic = (Elf_Dyn *)dp;
735 lf->address = ef->address;
736 lf->size = *(size_t *)sizeptr;
738 ctors_addrp = (Elf_Addr *)preload_search_info(modptr,
739 MODINFO_METADATA | MODINFOMD_CTORS_ADDR);
740 ctors_sizep = (Elf_Size *)preload_search_info(modptr,
741 MODINFO_METADATA | MODINFOMD_CTORS_SIZE);
742 if (ctors_addrp != NULL && ctors_sizep != NULL) {
743 lf->ctors_addr = ef->address + *ctors_addrp;
744 lf->ctors_size = *ctors_sizep;
747 error = parse_dynamic(ef);
749 error = parse_dpcpu(ef);
752 error = parse_vnet(ef);
755 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
758 link_elf_reloc_local(lf);
764 link_elf_link_preload_finish(linker_file_t lf)
769 ef = (elf_file_t) lf;
770 error = relocate_file(ef);
773 (void)link_elf_preload_parse_symbols(ef);
775 return (link_elf_link_common_finish(lf));
779 link_elf_load_file(linker_class_t cls, const char* filename,
780 linker_file_t* result)
783 struct thread* td = curthread; /* XXX */
789 Elf_Phdr *segs[MAXSEGS];
795 Elf_Addr base_vlimit;
813 NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, filename, td);
815 error = vn_open(&nd, &flags, 0, NULL);
818 NDFREE(&nd, NDF_ONLY_PNBUF);
819 if (nd.ni_vp->v_type != VREG) {
825 error = mac_kld_check_load(curthread->td_ucred, nd.ni_vp);
833 * Read the elf header from the file.
835 firstpage = malloc(PAGE_SIZE, M_LINKER, M_WAITOK);
836 hdr = (Elf_Ehdr *)firstpage;
837 error = vn_rdwr(UIO_READ, nd.ni_vp, firstpage, PAGE_SIZE, 0,
838 UIO_SYSSPACE, IO_NODELOCKED, td->td_ucred, NOCRED,
840 nbytes = PAGE_SIZE - resid;
849 if (hdr->e_ident[EI_CLASS] != ELF_TARG_CLASS ||
850 hdr->e_ident[EI_DATA] != ELF_TARG_DATA) {
851 link_elf_error(filename, "Unsupported file layout");
855 if (hdr->e_ident[EI_VERSION] != EV_CURRENT ||
856 hdr->e_version != EV_CURRENT) {
857 link_elf_error(filename, "Unsupported file version");
861 if (hdr->e_type != ET_EXEC && hdr->e_type != ET_DYN) {
865 if (hdr->e_machine != ELF_TARG_MACH) {
866 link_elf_error(filename, "Unsupported machine");
872 * We rely on the program header being in the first page.
873 * This is not strictly required by the ABI specification, but
874 * it seems to always true in practice. And, it simplifies
875 * things considerably.
877 if (!((hdr->e_phentsize == sizeof(Elf_Phdr)) &&
878 (hdr->e_phoff + hdr->e_phnum*sizeof(Elf_Phdr) <= PAGE_SIZE) &&
879 (hdr->e_phoff + hdr->e_phnum*sizeof(Elf_Phdr) <= nbytes)))
880 link_elf_error(filename, "Unreadable program headers");
883 * Scan the program header entries, and save key information.
885 * We rely on there being exactly two load segments, text and data,
888 phdr = (Elf_Phdr *) (firstpage + hdr->e_phoff);
889 phlimit = phdr + hdr->e_phnum;
892 while (phdr < phlimit) {
893 switch (phdr->p_type) {
895 if (nsegs == MAXSEGS) {
896 link_elf_error(filename, "Too many sections");
901 * XXX: We just trust they come in right order ??
919 link_elf_error(filename, "Object is not dynamically-linked");
924 link_elf_error(filename, "No sections");
930 * Allocate the entire address space of the object, to stake
931 * out our contiguous region, and to establish the base
932 * address for relocation.
934 base_vaddr = trunc_page(segs[0]->p_vaddr);
935 base_vlimit = round_page(segs[nsegs - 1]->p_vaddr +
936 segs[nsegs - 1]->p_memsz);
937 mapsize = base_vlimit - base_vaddr;
939 lf = linker_make_file(filename, &link_elf_class);
945 ef = (elf_file_t) lf;
946 #ifdef SPARSE_MAPPING
947 ef->object = vm_object_allocate(OBJT_DEFAULT, mapsize >> PAGE_SHIFT);
948 if (ef->object == NULL) {
952 ef->address = (caddr_t) vm_map_min(kernel_map);
953 error = vm_map_find(kernel_map, ef->object, 0,
954 (vm_offset_t *) &ef->address, mapsize, 0, VMFS_OPTIMAL_SPACE,
955 VM_PROT_ALL, VM_PROT_ALL, 0);
957 vm_object_deallocate(ef->object);
962 ef->address = malloc(mapsize, M_LINKER, M_EXEC | M_WAITOK);
964 mapbase = ef->address;
967 * Read the text and data sections and zero the bss.
969 for (i = 0; i < nsegs; i++) {
970 caddr_t segbase = mapbase + segs[i]->p_vaddr - base_vaddr;
971 error = vn_rdwr(UIO_READ, nd.ni_vp,
972 segbase, segs[i]->p_filesz, segs[i]->p_offset,
973 UIO_SYSSPACE, IO_NODELOCKED, td->td_ucred, NOCRED,
977 bzero(segbase + segs[i]->p_filesz,
978 segs[i]->p_memsz - segs[i]->p_filesz);
980 #ifdef SPARSE_MAPPING
982 * Wire down the pages
984 error = vm_map_wire(kernel_map,
985 (vm_offset_t) segbase,
986 (vm_offset_t) segbase + segs[i]->p_memsz,
987 VM_MAP_WIRE_SYSTEM|VM_MAP_WIRE_NOHOLES);
988 if (error != KERN_SUCCESS) {
996 /* Update profiling information with the new text segment. */
998 kmupetext((uintfptr_t)(mapbase + segs[0]->p_vaddr - base_vaddr +
1003 ef->dynamic = (Elf_Dyn *) (mapbase + phdyn->p_vaddr - base_vaddr);
1005 lf->address = ef->address;
1008 error = parse_dynamic(ef);
1011 error = parse_dpcpu(ef);
1015 error = parse_vnet(ef);
1019 link_elf_reloc_local(lf);
1021 VOP_UNLOCK(nd.ni_vp, 0);
1022 error = linker_load_dependencies(lf);
1023 vn_lock(nd.ni_vp, LK_EXCLUSIVE | LK_RETRY);
1026 error = relocate_file(ef);
1031 * Try and load the symbol table if it's present. (you can
1034 nbytes = hdr->e_shnum * hdr->e_shentsize;
1035 if (nbytes == 0 || hdr->e_shoff == 0)
1037 shdr = malloc(nbytes, M_LINKER, M_WAITOK | M_ZERO);
1038 error = vn_rdwr(UIO_READ, nd.ni_vp,
1039 (caddr_t)shdr, nbytes, hdr->e_shoff,
1040 UIO_SYSSPACE, IO_NODELOCKED, td->td_ucred, NOCRED,
1045 /* Read section string table */
1046 shstrindex = hdr->e_shstrndx;
1047 if (shstrindex != 0 && shdr[shstrindex].sh_type == SHT_STRTAB &&
1048 shdr[shstrindex].sh_size != 0) {
1049 nbytes = shdr[shstrindex].sh_size;
1050 shstrs = malloc(nbytes, M_LINKER, M_WAITOK | M_ZERO);
1051 error = vn_rdwr(UIO_READ, nd.ni_vp, (caddr_t)shstrs, nbytes,
1052 shdr[shstrindex].sh_offset, UIO_SYSSPACE, IO_NODELOCKED,
1053 td->td_ucred, NOCRED, &resid, td);
1060 for (i = 0; i < hdr->e_shnum; i++) {
1061 if (shdr[i].sh_type == SHT_SYMTAB) {
1063 symstrindex = shdr[i].sh_link;
1064 } else if (shstrs != NULL && shdr[i].sh_name != 0 &&
1065 strcmp(shstrs + shdr[i].sh_name, ".ctors") == 0) {
1066 /* Record relocated address and size of .ctors. */
1067 lf->ctors_addr = mapbase + shdr[i].sh_addr - base_vaddr;
1068 lf->ctors_size = shdr[i].sh_size;
1071 if (symtabindex < 0 || symstrindex < 0)
1074 symcnt = shdr[symtabindex].sh_size;
1075 ef->symbase = malloc(symcnt, M_LINKER, M_WAITOK);
1076 strcnt = shdr[symstrindex].sh_size;
1077 ef->strbase = malloc(strcnt, M_LINKER, M_WAITOK);
1079 error = vn_rdwr(UIO_READ, nd.ni_vp,
1080 ef->symbase, symcnt, shdr[symtabindex].sh_offset,
1081 UIO_SYSSPACE, IO_NODELOCKED, td->td_ucred, NOCRED,
1085 error = vn_rdwr(UIO_READ, nd.ni_vp,
1086 ef->strbase, strcnt, shdr[symstrindex].sh_offset,
1087 UIO_SYSSPACE, IO_NODELOCKED, td->td_ucred, NOCRED,
1092 ef->ddbsymcnt = symcnt / sizeof(Elf_Sym);
1093 ef->ddbsymtab = (const Elf_Sym *)ef->symbase;
1094 ef->ddbstrcnt = strcnt;
1095 ef->ddbstrtab = ef->strbase;
1098 error = link_elf_link_common_finish(lf);
1105 VOP_UNLOCK(nd.ni_vp, 0);
1106 vn_close(nd.ni_vp, FREAD, td->td_ucred, td);
1107 if (error != 0 && lf != NULL)
1108 linker_file_unload(lf, LINKER_UNLOAD_FORCE);
1109 free(shdr, M_LINKER);
1110 free(firstpage, M_LINKER);
1111 free(shstrs, M_LINKER);
1117 elf_relocaddr(linker_file_t lf, Elf_Addr x)
1121 ef = (elf_file_t)lf;
1122 if (x >= ef->pcpu_start && x < ef->pcpu_stop)
1123 return ((x - ef->pcpu_start) + ef->pcpu_base);
1125 if (x >= ef->vnet_start && x < ef->vnet_stop)
1126 return ((x - ef->vnet_start) + ef->vnet_base);
1133 link_elf_unload_file(linker_file_t file)
1135 elf_file_t ef = (elf_file_t) file;
1137 if (ef->pcpu_base != 0) {
1138 dpcpu_free((void *)ef->pcpu_base,
1139 ef->pcpu_stop - ef->pcpu_start);
1140 elf_set_delete(&set_pcpu_list, ef->pcpu_start);
1143 if (ef->vnet_base != 0) {
1144 vnet_data_free((void *)ef->vnet_base,
1145 ef->vnet_stop - ef->vnet_start);
1146 elf_set_delete(&set_vnet_list, ef->vnet_start);
1150 if (ef->gdb.l_ld != NULL) {
1151 GDB_STATE(RT_DELETE);
1152 free((void *)(uintptr_t)ef->gdb.l_name, M_LINKER);
1153 link_elf_delete_gdb(&ef->gdb);
1154 GDB_STATE(RT_CONSISTENT);
1158 /* Notify MD code that a module is being unloaded. */
1159 elf_cpu_unload_file(file);
1161 if (ef->preloaded) {
1162 link_elf_unload_preload(file);
1166 #ifdef SPARSE_MAPPING
1167 if (ef->object != NULL) {
1168 vm_map_remove(kernel_map, (vm_offset_t) ef->address,
1169 (vm_offset_t) ef->address
1170 + (ef->object->size << PAGE_SHIFT));
1173 free(ef->address, M_LINKER);
1175 free(ef->symbase, M_LINKER);
1176 free(ef->strbase, M_LINKER);
1177 free(ef->ctftab, M_LINKER);
1178 free(ef->ctfoff, M_LINKER);
1179 free(ef->typoff, M_LINKER);
1183 link_elf_unload_preload(linker_file_t file)
1185 if (file->pathname != NULL)
1186 preload_delete_name(file->pathname);
1190 symbol_name(elf_file_t ef, Elf_Size r_info)
1194 if (ELF_R_SYM(r_info)) {
1195 ref = ef->symtab + ELF_R_SYM(r_info);
1196 return (ef->strtab + ref->st_name);
1202 symbol_type(elf_file_t ef, Elf_Size r_info)
1206 if (ELF_R_SYM(r_info)) {
1207 ref = ef->symtab + ELF_R_SYM(r_info);
1208 return (ELF_ST_TYPE(ref->st_info));
1210 return (STT_NOTYPE);
1214 relocate_file1(elf_file_t ef, elf_lookup_fn lookup, elf_reloc_fn reloc,
1218 const Elf_Rela *rela;
1219 const char *symname;
1221 #define APPLY_RELOCS(iter, tbl, tblsize, type) do { \
1222 for ((iter) = (tbl); (iter) != NULL && \
1223 (iter) < (tbl) + (tblsize) / sizeof(*(iter)); (iter)++) { \
1224 if ((symbol_type(ef, (iter)->r_info) == \
1226 elf_is_ifunc_reloc((iter)->r_info)) != ifuncs) \
1228 if (reloc(&ef->lf, (Elf_Addr)ef->address, \
1229 (iter), (type), lookup)) { \
1230 symname = symbol_name(ef, (iter)->r_info); \
1231 printf("link_elf: symbol %s undefined\n", \
1238 APPLY_RELOCS(rel, ef->rel, ef->relsize, ELF_RELOC_REL);
1239 APPLY_RELOCS(rela, ef->rela, ef->relasize, ELF_RELOC_RELA);
1240 APPLY_RELOCS(rel, ef->pltrel, ef->pltrelsize, ELF_RELOC_REL);
1241 APPLY_RELOCS(rela, ef->pltrela, ef->pltrelasize, ELF_RELOC_RELA);
1249 relocate_file(elf_file_t ef)
1253 error = relocate_file1(ef, elf_lookup, elf_reloc, false);
1255 error = relocate_file1(ef, elf_lookup, elf_reloc, true);
1260 * Hash function for symbol table lookup. Don't even think about changing
1261 * this. It is specified by the System V ABI.
1263 static unsigned long
1264 elf_hash(const char *name)
1266 const unsigned char *p = (const unsigned char *) name;
1267 unsigned long h = 0;
1270 while (*p != '\0') {
1271 h = (h << 4) + *p++;
1272 if ((g = h & 0xf0000000) != 0)
1280 link_elf_lookup_symbol(linker_file_t lf, const char *name, c_linker_sym_t *sym)
1282 elf_file_t ef = (elf_file_t) lf;
1283 unsigned long symnum;
1284 const Elf_Sym* symp;
1289 /* If we don't have a hash, bail. */
1290 if (ef->buckets == NULL || ef->nbuckets == 0) {
1291 printf("link_elf_lookup_symbol: missing symbol hash table\n");
1295 /* First, search hashed global symbols */
1296 hash = elf_hash(name);
1297 symnum = ef->buckets[hash % ef->nbuckets];
1299 while (symnum != STN_UNDEF) {
1300 if (symnum >= ef->nchains) {
1301 printf("%s: corrupt symbol table\n", __func__);
1305 symp = ef->symtab + symnum;
1306 if (symp->st_name == 0) {
1307 printf("%s: corrupt symbol table\n", __func__);
1311 strp = ef->strtab + symp->st_name;
1313 if (strcmp(name, strp) == 0) {
1314 if (symp->st_shndx != SHN_UNDEF ||
1315 (symp->st_value != 0 &&
1316 (ELF_ST_TYPE(symp->st_info) == STT_FUNC ||
1317 ELF_ST_TYPE(symp->st_info) == STT_GNU_IFUNC))) {
1318 *sym = (c_linker_sym_t) symp;
1324 symnum = ef->chains[symnum];
1327 /* If we have not found it, look at the full table (if loaded) */
1328 if (ef->symtab == ef->ddbsymtab)
1331 /* Exhaustive search */
1332 for (i = 0, symp = ef->ddbsymtab; i < ef->ddbsymcnt; i++, symp++) {
1333 strp = ef->ddbstrtab + symp->st_name;
1334 if (strcmp(name, strp) == 0) {
1335 if (symp->st_shndx != SHN_UNDEF ||
1336 (symp->st_value != 0 &&
1337 (ELF_ST_TYPE(symp->st_info) == STT_FUNC ||
1338 ELF_ST_TYPE(symp->st_info) == STT_GNU_IFUNC))) {
1339 *sym = (c_linker_sym_t) symp;
1350 link_elf_symbol_values(linker_file_t lf, c_linker_sym_t sym,
1351 linker_symval_t *symval)
1357 ef = (elf_file_t)lf;
1358 es = (const Elf_Sym *)sym;
1359 if (es >= ef->symtab && es < (ef->symtab + ef->nchains)) {
1360 symval->name = ef->strtab + es->st_name;
1361 val = (caddr_t)ef->address + es->st_value;
1362 if (ELF_ST_TYPE(es->st_info) == STT_GNU_IFUNC)
1363 val = ((caddr_t (*)(void))val)();
1364 symval->value = val;
1365 symval->size = es->st_size;
1368 if (ef->symtab == ef->ddbsymtab)
1370 if (es >= ef->ddbsymtab && es < (ef->ddbsymtab + ef->ddbsymcnt)) {
1371 symval->name = ef->ddbstrtab + es->st_name;
1372 val = (caddr_t)ef->address + es->st_value;
1373 if (ELF_ST_TYPE(es->st_info) == STT_GNU_IFUNC)
1374 val = ((caddr_t (*)(void))val)();
1375 symval->value = val;
1376 symval->size = es->st_size;
1383 link_elf_search_symbol(linker_file_t lf, caddr_t value,
1384 c_linker_sym_t *sym, long *diffp)
1386 elf_file_t ef = (elf_file_t) lf;
1387 u_long off = (uintptr_t) (void *) value;
1391 const Elf_Sym* best = NULL;
1394 for (i = 0, es = ef->ddbsymtab; i < ef->ddbsymcnt; i++, es++) {
1395 if (es->st_name == 0)
1397 st_value = es->st_value + (uintptr_t) (void *) ef->address;
1398 if (off >= st_value) {
1399 if (off - st_value < diff) {
1400 diff = off - st_value;
1404 } else if (off - st_value == diff) {
1413 *sym = (c_linker_sym_t) best;
1419 * Look up a linker set on an ELF system.
1422 link_elf_lookup_set(linker_file_t lf, const char *name,
1423 void ***startp, void ***stopp, int *countp)
1426 linker_symval_t symval;
1428 void **start, **stop;
1429 int len, error = 0, count;
1431 len = strlen(name) + sizeof("__start_set_"); /* sizeof includes \0 */
1432 setsym = malloc(len, M_LINKER, M_WAITOK);
1434 /* get address of first entry */
1435 snprintf(setsym, len, "%s%s", "__start_set_", name);
1436 error = link_elf_lookup_symbol(lf, setsym, &sym);
1439 link_elf_symbol_values(lf, sym, &symval);
1440 if (symval.value == 0) {
1444 start = (void **)symval.value;
1446 /* get address of last entry */
1447 snprintf(setsym, len, "%s%s", "__stop_set_", name);
1448 error = link_elf_lookup_symbol(lf, setsym, &sym);
1451 link_elf_symbol_values(lf, sym, &symval);
1452 if (symval.value == 0) {
1456 stop = (void **)symval.value;
1458 /* and the number of entries */
1459 count = stop - start;
1470 free(setsym, M_LINKER);
1475 link_elf_each_function_name(linker_file_t file,
1476 int (*callback)(const char *, void *), void *opaque)
1478 elf_file_t ef = (elf_file_t)file;
1479 const Elf_Sym *symp;
1482 /* Exhaustive search */
1483 for (i = 0, symp = ef->ddbsymtab; i < ef->ddbsymcnt; i++, symp++) {
1484 if (symp->st_value != 0 &&
1485 (ELF_ST_TYPE(symp->st_info) == STT_FUNC ||
1486 ELF_ST_TYPE(symp->st_info) == STT_GNU_IFUNC)) {
1487 error = callback(ef->ddbstrtab + symp->st_name, opaque);
1496 link_elf_each_function_nameval(linker_file_t file,
1497 linker_function_nameval_callback_t callback, void *opaque)
1499 linker_symval_t symval;
1500 elf_file_t ef = (elf_file_t)file;
1501 const Elf_Sym* symp;
1504 /* Exhaustive search */
1505 for (i = 0, symp = ef->ddbsymtab; i < ef->ddbsymcnt; i++, symp++) {
1506 if (symp->st_value != 0 &&
1507 (ELF_ST_TYPE(symp->st_info) == STT_FUNC ||
1508 ELF_ST_TYPE(symp->st_info) == STT_GNU_IFUNC)) {
1509 error = link_elf_symbol_values(file,
1510 (c_linker_sym_t) symp, &symval);
1513 error = callback(file, i, &symval, opaque);
1522 elf_get_sym(linker_file_t lf, Elf_Size symidx)
1524 elf_file_t ef = (elf_file_t)lf;
1526 if (symidx >= ef->nchains)
1528 return (ef->symtab + symidx);
1532 elf_get_symname(linker_file_t lf, Elf_Size symidx)
1534 elf_file_t ef = (elf_file_t)lf;
1537 if (symidx >= ef->nchains)
1539 sym = ef->symtab + symidx;
1540 return (ef->strtab + sym->st_name);
1544 * Symbol lookup function that can be used when the symbol index is known (ie
1545 * in relocations). It uses the symbol index instead of doing a fully fledged
1546 * hash table based lookup when such is valid. For example for local symbols.
1547 * This is not only more efficient, it's also more correct. It's not always
1548 * the case that the symbol can be found through the hash table.
1551 elf_lookup(linker_file_t lf, Elf_Size symidx, int deps, Elf_Addr *res)
1553 elf_file_t ef = (elf_file_t)lf;
1556 Elf_Addr addr, start, base;
1558 /* Don't even try to lookup the symbol if the index is bogus. */
1559 if (symidx >= ef->nchains) {
1564 sym = ef->symtab + symidx;
1567 * Don't do a full lookup when the symbol is local. It may even
1568 * fail because it may not be found through the hash table.
1570 if (ELF_ST_BIND(sym->st_info) == STB_LOCAL) {
1571 /* Force lookup failure when we have an insanity. */
1572 if (sym->st_shndx == SHN_UNDEF || sym->st_value == 0) {
1576 *res = ((Elf_Addr)ef->address + sym->st_value);
1581 * XXX we can avoid doing a hash table based lookup for global
1582 * symbols as well. This however is not always valid, so we'll
1583 * just do it the hard way for now. Performance tweaks can
1587 symbol = ef->strtab + sym->st_name;
1589 /* Force a lookup failure if the symbol name is bogus. */
1595 addr = ((Elf_Addr)linker_file_lookup_symbol(lf, symbol, deps));
1596 if (addr == 0 && ELF_ST_BIND(sym->st_info) != STB_WEAK) {
1601 if (elf_set_find(&set_pcpu_list, addr, &start, &base))
1602 addr = addr - start + base;
1604 else if (elf_set_find(&set_vnet_list, addr, &start, &base))
1605 addr = addr - start + base;
1612 link_elf_reloc_local(linker_file_t lf)
1614 const Elf_Rel *rellim;
1616 const Elf_Rela *relalim;
1617 const Elf_Rela *rela;
1618 elf_file_t ef = (elf_file_t)lf;
1620 /* Perform relocations without addend if there are any: */
1621 if ((rel = ef->rel) != NULL) {
1622 rellim = (const Elf_Rel *)((const char *)ef->rel + ef->relsize);
1623 while (rel < rellim) {
1624 elf_reloc_local(lf, (Elf_Addr)ef->address, rel,
1625 ELF_RELOC_REL, elf_lookup);
1630 /* Perform relocations with addend if there are any: */
1631 if ((rela = ef->rela) != NULL) {
1632 relalim = (const Elf_Rela *)
1633 ((const char *)ef->rela + ef->relasize);
1634 while (rela < relalim) {
1635 elf_reloc_local(lf, (Elf_Addr)ef->address, rela,
1636 ELF_RELOC_RELA, elf_lookup);
1643 link_elf_symtab_get(linker_file_t lf, const Elf_Sym **symtab)
1645 elf_file_t ef = (elf_file_t)lf;
1647 *symtab = ef->ddbsymtab;
1649 if (*symtab == NULL)
1652 return (ef->ddbsymcnt);
1656 link_elf_strtab_get(linker_file_t lf, caddr_t *strtab)
1658 elf_file_t ef = (elf_file_t)lf;
1660 *strtab = ef->ddbstrtab;
1662 if (*strtab == NULL)
1665 return (ef->ddbstrcnt);
1668 #if defined(__i386__) || defined(__amd64__) || defined(__aarch64__)
1670 * Use this lookup routine when performing relocations early during boot.
1671 * The generic lookup routine depends on kobj, which is not initialized
1675 elf_lookup_ifunc(linker_file_t lf, Elf_Size symidx, int deps __unused,
1679 const Elf_Sym *symp;
1682 ef = (elf_file_t)lf;
1683 symp = ef->symtab + symidx;
1684 if (ELF_ST_TYPE(symp->st_info) == STT_GNU_IFUNC) {
1685 val = (caddr_t)ef->address + symp->st_value;
1686 *res = ((Elf_Addr (*)(void))val)();
1693 link_elf_ireloc(caddr_t kmdp)
1695 struct elf_file eff;
1700 bzero_early(ef, sizeof(*ef));
1703 ef->dynamic = (Elf_Dyn *)&_DYNAMIC;
1706 link_elf_preload_parse_symbols(ef);
1707 relocate_file1(ef, elf_lookup_ifunc, elf_reloc, true);