2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
3 * Copyright (c) 1998 Peter Wemm <peter@freebsd.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * $FreeBSD: src/sys/boot/common/load_elf.c,v 1.39 2008/10/14 10:11:14 raj Exp $
30 #include <sys/param.h>
32 #include <sys/linker.h>
33 #include <sys/module.h>
34 #include <sys/stdint.h>
36 #include <machine/elf.h>
41 #include "bootstrap.h"
43 #define COPYOUT(s,d,l) archsw.arch_copyout((vm_offset_t)(s), d, l)
45 #if defined(__i386__) && __ELF_WORD_SIZE == 64
48 #define ELF_TARG_CLASS ELFCLASS64
49 #define ELF_TARG_MACH EM_X86_64
52 typedef struct elf_file {
74 static int __elfN(loadimage)(struct preloaded_file *mp, elf_file_t ef, u_int64_t loadaddr);
75 static int __elfN(lookup_symbol)(struct preloaded_file *mp, elf_file_t ef, const char* name, Elf_Sym* sym);
76 static int __elfN(reloc_ptr)(struct preloaded_file *mp, elf_file_t ef,
77 Elf_Addr p, void *val, size_t len);
78 static int __elfN(parse_modmetadata)(struct preloaded_file *mp, elf_file_t ef);
79 static symaddr_fn __elfN(symaddr);
80 static char *fake_modname(const char *name);
82 const char *__elfN(kerneltype) = "elf kernel";
83 const char *__elfN(moduletype) = "elf module";
85 u_int64_t __elfN(relocation_offset) = 0;
88 * Attempt to load the file (file) as an ELF module. It will be stored at
89 * (dest), and a pointer to a module structure describing the loaded object
90 * will be saved in (result).
93 __elfN(loadfile)(char *filename, u_int64_t dest, struct preloaded_file **result)
95 struct preloaded_file *fp, *kfp;
104 bzero(&ef, sizeof(struct elf_file));
107 * Open the image, read and validate the ELF header
109 if (filename == NULL) /* can't handle nameless */
111 if ((ef.fd = rel_open(filename, &fullpath, O_RDONLY)) == -1)
113 ef.firstpage = malloc(PAGE_SIZE);
114 if (ef.firstpage == NULL) {
119 bytes_read = read(ef.fd, ef.firstpage, PAGE_SIZE);
120 ef.firstlen = (size_t)bytes_read;
121 if (bytes_read < 0 || ef.firstlen <= sizeof(Elf_Ehdr)) {
122 err = EFTYPE; /* could be EIO, but may be small file */
125 ehdr = ef.ehdr = (Elf_Ehdr *)ef.firstpage;
128 if (!IS_ELF(*ehdr)) {
132 if (ehdr->e_ident[EI_CLASS] != ELF_TARG_CLASS || /* Layout ? */
133 ehdr->e_ident[EI_DATA] != ELF_TARG_DATA ||
134 ehdr->e_ident[EI_VERSION] != EV_CURRENT || /* Version ? */
135 ehdr->e_version != EV_CURRENT ||
136 ehdr->e_machine != ELF_TARG_MACH) { /* Machine ? */
143 * Check to see what sort of module we are.
145 kfp = file_findfile(NULL, NULL);
146 if (ehdr->e_type == ET_DYN) {
147 /* Looks like a kld module */
149 printf("elf" __XSTRING(__ELF_WORD_SIZE) "_loadfile: can't load module before kernel\n");
153 if (strcmp(__elfN(kerneltype), kfp->f_type)) {
154 printf("elf" __XSTRING(__ELF_WORD_SIZE) "_loadfile: can't load module with kernel type '%s'\n", kfp->f_type);
158 /* Looks OK, got ahead */
161 /* Page-align the load address */
162 pad = (u_int)dest & PAGE_MASK;
164 pad = PAGE_SIZE - pad;
167 } else if (ehdr->e_type == ET_EXEC) {
168 /* Looks like a kernel */
170 printf("elf" __XSTRING(__ELF_WORD_SIZE) "_loadfile: kernel already loaded\n");
175 * Calculate destination address based on kernel entrypoint
177 dest = ehdr->e_entry;
179 printf("elf" __XSTRING(__ELF_WORD_SIZE) "_loadfile: not a kernel (maybe static binary?)\n");
191 * Ok, we think we should handle this.
195 printf("elf" __XSTRING(__ELF_WORD_SIZE) "_loadfile: cannot allocate module info\n");
201 * Set the kernel name and module path correctly for the kernel's
202 * consumption. Always prepend a /boot if we don't have one.
207 const char *prefix = "";
209 mptr = malloc(strlen(fullpath) * 2 + 10 + 16);
210 if (strncmp(fullpath, "/boot/", 6) != 0)
212 sprintf(mptr, "%s%s", prefix, fullpath);
213 setenv("kernelname", mptr, 1);
215 fpend = strrchr(mptr, '/');
217 if (strcmp(mptr, "/boot") == 0)
218 sprintf(mptr, "/boot/modules");
219 /* this will be moved to "module_path" on boot */
220 setenv("exported_module_path", mptr, 1);
223 fp->f_name = strdup(filename);
224 fp->f_type = strdup(ef.kernel ? __elfN(kerneltype) : __elfN(moduletype));
228 printf("%s entry at 0x%jx\n", filename, (uintmax_t)dest);
230 printf("%s ", filename);
233 fp->f_size = __elfN(loadimage)(fp, &ef, dest);
234 if (fp->f_size == 0 || fp->f_addr == 0)
237 /* save exec header as metadata */
238 file_addmetadata(fp, MODINFOMD_ELFHDR, sizeof(*ehdr), ehdr);
240 /* Load OK, return module pointer */
241 *result = (struct preloaded_file *)fp;
259 * With the file (fd) open on the image, and (ehdr) containing
260 * the Elf header, load the image at (off)
263 __elfN(loadimage)(struct preloaded_file *fp, elf_file_t ef, u_int64_t off)
268 Elf_Phdr *phdr, *php;
271 vm_offset_t firstaddr;
272 vm_offset_t lastaddr;
287 firstaddr = lastaddr = 0;
291 #if __ELF_WORD_SIZE == 64
292 off = - (off & 0xffffffffff000000ull);/* x86_64 relocates after locore */
294 off = - (off & 0xff000000u); /* i386 relocates after locore */
296 #elif defined(__powerpc__)
298 * On the purely virtual memory machines like e500, the kernel is
299 * linked against its final VA range, which is most often not
300 * available at the loader stage, but only after kernel initializes
301 * and completes its VM settings. In such cases we cannot use p_vaddr
302 * field directly to load ELF segments, but put them at some
303 * 'load-time' locations.
305 if (off & 0xf0000000u) {
306 off = -(off & 0xf0000000u);
308 * XXX the physical load address should not be hardcoded. Note
309 * that the Book-E kernel assumes that it's loaded at a 16MB
310 * boundary for now...
313 ehdr->e_entry += off;
315 printf("Converted entry 0x%08x\n", ehdr->e_entry);
319 #elif defined(__arm__)
320 if (off & 0xf0000000u) {
321 off = -(off & 0xf0000000u);
322 ehdr->e_entry += off;
324 printf("Converted entry 0x%08x\n", ehdr->e_entry);
329 off = 0; /* other archs use direct mapped kernels */
331 __elfN(relocation_offset) = off;
335 if ((ehdr->e_phoff + ehdr->e_phnum * sizeof(*phdr)) > ef->firstlen) {
336 printf("elf" __XSTRING(__ELF_WORD_SIZE) "_loadimage: program header not within first page\n");
339 phdr = (Elf_Phdr *)(ef->firstpage + ehdr->e_phoff);
341 for (i = 0; i < ehdr->e_phnum; i++) {
342 /* We want to load PT_LOAD segments only.. */
343 if (phdr[i].p_type != PT_LOAD)
347 printf("Segment: 0x%lx@0x%lx -> 0x%lx-0x%lx",
348 (long)phdr[i].p_filesz, (long)phdr[i].p_offset,
349 (long)(phdr[i].p_vaddr + off),
350 (long)(phdr[i].p_vaddr + off + phdr[i].p_memsz - 1));
352 if ((phdr[i].p_flags & PF_W) == 0) {
353 printf("text=0x%lx ", (long)phdr[i].p_filesz);
355 printf("data=0x%lx", (long)phdr[i].p_filesz);
356 if (phdr[i].p_filesz < phdr[i].p_memsz)
357 printf("+0x%lx", (long)(phdr[i].p_memsz -phdr[i].p_filesz));
362 if (ef->firstlen > phdr[i].p_offset) {
363 fpcopy = ef->firstlen - phdr[i].p_offset;
364 archsw.arch_copyin(ef->firstpage + phdr[i].p_offset,
365 phdr[i].p_vaddr + off, fpcopy);
367 if (phdr[i].p_filesz > fpcopy) {
368 if (kern_pread(ef->fd, phdr[i].p_vaddr + off + fpcopy,
369 phdr[i].p_filesz - fpcopy, phdr[i].p_offset + fpcopy) != 0) {
370 printf("\nelf" __XSTRING(__ELF_WORD_SIZE)
371 "_loadimage: read failed\n");
375 /* clear space from oversized segments; eg: bss */
376 if (phdr[i].p_filesz < phdr[i].p_memsz) {
378 printf(" (bss: 0x%lx-0x%lx)",
379 (long)(phdr[i].p_vaddr + off + phdr[i].p_filesz),
380 (long)(phdr[i].p_vaddr + off + phdr[i].p_memsz - 1));
383 kern_bzero(phdr[i].p_vaddr + off + phdr[i].p_filesz,
384 phdr[i].p_memsz - phdr[i].p_filesz);
390 if (firstaddr == 0 || firstaddr > (phdr[i].p_vaddr + off))
391 firstaddr = phdr[i].p_vaddr + off;
392 if (lastaddr == 0 || lastaddr < (phdr[i].p_vaddr + off + phdr[i].p_memsz))
393 lastaddr = phdr[i].p_vaddr + off + phdr[i].p_memsz;
395 lastaddr = roundup(lastaddr, sizeof(long));
398 * Now grab the symbol tables. This isn't easy if we're reading a
399 * .gz file. I think the rule is going to have to be that you must
400 * strip a file to remove symbols before gzipping it so that we do not
401 * try to lseek() on it.
403 chunk = ehdr->e_shnum * ehdr->e_shentsize;
404 if (chunk == 0 || ehdr->e_shoff == 0)
406 shdr = alloc_pread(ef->fd, ehdr->e_shoff, chunk);
408 printf("\nelf" __XSTRING(__ELF_WORD_SIZE)
409 "_loadimage: failed to read section headers");
414 for (i = 0; i < ehdr->e_shnum; i++) {
415 if (shdr[i].sh_type != SHT_SYMTAB)
417 for (j = 0; j < ehdr->e_phnum; j++) {
418 if (phdr[j].p_type != PT_LOAD)
420 if (shdr[i].sh_offset >= phdr[j].p_offset &&
421 (shdr[i].sh_offset + shdr[i].sh_size <=
422 phdr[j].p_offset + phdr[j].p_filesz)) {
423 shdr[i].sh_offset = 0;
428 if (shdr[i].sh_offset == 0 || shdr[i].sh_size == 0)
429 continue; /* alread loaded in a PT_LOAD above */
430 /* Save it for loading below */
432 symstrindex = shdr[i].sh_link;
434 if (symtabindex < 0 || symstrindex < 0)
437 /* Ok, committed to a load. */
442 for (i = symtabindex; i >= 0; i = symstrindex) {
446 switch(shdr[i].sh_type) {
447 case SHT_SYMTAB: /* Symbol table */
450 case SHT_STRTAB: /* String table */
459 size = shdr[i].sh_size;
460 archsw.arch_copyin(&size, lastaddr, sizeof(size));
461 lastaddr += sizeof(size);
464 printf("\n%s: 0x%jx@0x%jx -> 0x%jx-0x%jx", secname,
465 (uintmax_t)shdr[i].sh_size, (uintmax_t)shdr[i].sh_offset,
466 (uintmax_t)lastaddr, (uintmax_t)(lastaddr + shdr[i].sh_size));
468 if (i == symstrindex)
470 printf("0x%lx+0x%lx", (long)sizeof(size), (long)size);
473 if (lseek(ef->fd, (off_t)shdr[i].sh_offset, SEEK_SET) == -1) {
474 printf("\nelf" __XSTRING(__ELF_WORD_SIZE) "_loadimage: could not seek for symbols - skipped!");
479 result = archsw.arch_readin(ef->fd, lastaddr, shdr[i].sh_size);
480 if (result < 0 || (size_t)result != shdr[i].sh_size) {
481 printf("\nelf" __XSTRING(__ELF_WORD_SIZE) "_loadimage: could not read symbols - skipped!");
486 /* Reset offsets relative to ssym */
487 lastaddr += shdr[i].sh_size;
488 lastaddr = roundup(lastaddr, sizeof(size));
489 if (i == symtabindex)
491 else if (i == symstrindex)
499 file_addmetadata(fp, MODINFOMD_SSYM, sizeof(ssym), &ssym);
500 file_addmetadata(fp, MODINFOMD_ESYM, sizeof(esym), &esym);
505 ret = lastaddr - firstaddr;
506 fp->f_addr = firstaddr;
509 for (i = 0; i < ehdr->e_phnum; i++) {
510 if (phdr[i].p_type == PT_DYNAMIC) {
513 file_addmetadata(fp, MODINFOMD_DYNAMIC, sizeof(adp), &adp);
518 if (php == NULL) /* this is bad, we cannot get to symbols or _DYNAMIC */
521 ndp = php->p_filesz / sizeof(Elf_Dyn);
524 dp = malloc(php->p_filesz);
527 archsw.arch_copyout(php->p_vaddr + off, dp, php->p_filesz);
530 for (i = 0; i < ndp; i++) {
531 if (dp[i].d_tag == 0)
533 switch (dp[i].d_tag) {
535 ef->hashtab = (Elf_Hashelt*)(uintptr_t)(dp[i].d_un.d_ptr + off);
538 ef->strtab = (char *)(uintptr_t)(dp[i].d_un.d_ptr + off);
541 ef->strsz = dp[i].d_un.d_val;
544 ef->symtab = (Elf_Sym*)(uintptr_t)(dp[i].d_un.d_ptr + off);
547 ef->rel = (Elf_Rel *)(uintptr_t)(dp[i].d_un.d_ptr + off);
550 ef->relsz = dp[i].d_un.d_val;
553 ef->rela = (Elf_Rela *)(uintptr_t)(dp[i].d_un.d_ptr + off);
556 ef->relasz = dp[i].d_un.d_val;
562 if (ef->hashtab == NULL || ef->symtab == NULL ||
563 ef->strtab == NULL || ef->strsz == 0)
565 COPYOUT(ef->hashtab, &ef->nbuckets, sizeof(ef->nbuckets));
566 COPYOUT(ef->hashtab + 1, &ef->nchains, sizeof(ef->nchains));
567 ef->buckets = ef->hashtab + 2;
568 ef->chains = ef->buckets + ef->nbuckets;
569 if (__elfN(parse_modmetadata)(fp, ef) == 0)
572 if (ef->kernel) /* kernel must not depend on anything */
583 static char invalid_name[] = "bad";
586 fake_modname(const char *name)
592 sp = strrchr(name, '/');
597 ep = strrchr(name, '.');
601 ep = invalid_name + sizeof(invalid_name) - 1;
604 ep = name + strlen(name);
606 fp = malloc(len + 1);
614 #if defined(__i386__) && __ELF_WORD_SIZE == 64
615 struct mod_metadata64 {
616 int md_version; /* structure version MDTV_* */
617 int md_type; /* type of entry MDT_* */
618 u_int64_t md_data; /* specific data */
619 u_int64_t md_cval; /* common string label */
624 __elfN(parse_modmetadata)(struct preloaded_file *fp, elf_file_t ef)
626 struct mod_metadata md;
627 #if defined(__i386__) && __ELF_WORD_SIZE == 64
628 struct mod_metadata64 md64;
630 struct mod_depend *mdepend;
631 struct mod_version mver;
634 int error, modcnt, minfolen;
635 Elf_Addr v, p, p_stop;
637 if (__elfN(lookup_symbol)(fp, ef, "__start_set_modmetadata_set", &sym) != 0)
639 p = sym.st_value + ef->off;
640 if (__elfN(lookup_symbol)(fp, ef, "__stop_set_modmetadata_set", &sym) != 0)
642 p_stop = sym.st_value + ef->off;
646 COPYOUT(p, &v, sizeof(v));
647 error = __elfN(reloc_ptr)(fp, ef, p, &v, sizeof(v));
648 if (error == EOPNOTSUPP)
652 #if defined(__i386__) && __ELF_WORD_SIZE == 64
653 COPYOUT(v, &md64, sizeof(md64));
654 error = __elfN(reloc_ptr)(fp, ef, v, &md64, sizeof(md64));
655 if (error == EOPNOTSUPP) {
656 md64.md_cval += ef->off;
657 md64.md_data += ef->off;
658 } else if (error != 0)
660 md.md_version = md64.md_version;
661 md.md_type = md64.md_type;
662 md.md_cval = (const char *)(uintptr_t)md64.md_cval;
663 md.md_data = (void *)(uintptr_t)md64.md_data;
665 COPYOUT(v, &md, sizeof(md));
666 error = __elfN(reloc_ptr)(fp, ef, v, &md, sizeof(md));
667 if (error == EOPNOTSUPP) {
668 md.md_cval += ef->off;
669 md.md_data += ef->off;
670 } else if (error != 0)
673 p += sizeof(Elf_Addr);
676 if (ef->kernel) /* kernel must not depend on anything */
678 s = strdupout((vm_offset_t)md.md_cval);
679 minfolen = sizeof(*mdepend) + strlen(s) + 1;
680 mdepend = malloc(minfolen);
683 COPYOUT((vm_offset_t)md.md_data, mdepend, sizeof(*mdepend));
684 strcpy((char*)(mdepend + 1), s);
686 file_addmetadata(fp, MODINFOMD_DEPLIST, minfolen, mdepend);
690 s = strdupout((vm_offset_t)md.md_cval);
691 COPYOUT((vm_offset_t)md.md_data, &mver, sizeof(mver));
692 file_addmodule(fp, s, mver.mv_version, NULL);
699 s = fake_modname(fp->f_name);
700 file_addmodule(fp, s, 1, NULL);
707 elf_hash(const char *name)
709 const unsigned char *p = (const unsigned char *) name;
715 if ((g = h & 0xf0000000) != 0)
722 static const char __elfN(bad_symtable)[] = "elf" __XSTRING(__ELF_WORD_SIZE) "_lookup_symbol: corrupt symbol table\n";
724 __elfN(lookup_symbol)(struct preloaded_file *fp, elf_file_t ef, const char* name,
732 hash = elf_hash(name);
733 COPYOUT(&ef->buckets[hash % ef->nbuckets], &symnum, sizeof(symnum));
735 while (symnum != STN_UNDEF) {
736 if (symnum >= ef->nchains) {
737 printf(__elfN(bad_symtable));
741 COPYOUT(ef->symtab + symnum, &sym, sizeof(sym));
742 if (sym.st_name == 0) {
743 printf(__elfN(bad_symtable));
747 strp = strdupout((vm_offset_t)(ef->strtab + sym.st_name));
748 if (strcmp(name, strp) == 0) {
750 if (sym.st_shndx != SHN_UNDEF ||
751 (sym.st_value != 0 &&
752 ELF_ST_TYPE(sym.st_info) == STT_FUNC)) {
759 COPYOUT(&ef->chains[symnum], &symnum, sizeof(symnum));
765 * Apply any intra-module relocations to the value. p is the load address
766 * of the value and val/len is the value to be modified. This does NOT modify
767 * the image in-place, because this is done by kern_linker later on.
769 * Returns EOPNOTSUPP if no relocation method is supplied.
772 __elfN(reloc_ptr)(struct preloaded_file *mp, elf_file_t ef,
773 Elf_Addr p, void *val, size_t len)
781 * The kernel is already relocated, but we still want to apply
782 * offset adjustments.
787 for (n = 0; n < ef->relsz / sizeof(r); n++) {
788 COPYOUT(ef->rel + n, &r, sizeof(r));
790 error = __elfN(reloc)(ef, __elfN(symaddr), &r, ELF_RELOC_REL,
791 ef->off, p, val, len);
795 for (n = 0; n < ef->relasz / sizeof(a); n++) {
796 COPYOUT(ef->rela + n, &a, sizeof(a));
798 error = __elfN(reloc)(ef, __elfN(symaddr), &a, ELF_RELOC_RELA,
799 ef->off, p, val, len);
808 __elfN(symaddr)(struct elf_file *ef, Elf_Size symidx)
811 /* Symbol lookup by index not required here. */