sys/boot/common/load_elf_obj.c

   1 /*-
   2  * Copyright (c) 2004 Ian Dowse <iedowse@freebsd.org>
   3  * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
   4  * Copyright (c) 1998 Peter Wemm <peter@freebsd.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  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.
  15  *
  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
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #include <sys/exec.h>
  34 #include <sys/linker.h>
  35 #include <sys/module.h>
  36 #include <inttypes.h>
  37 #include <string.h>
  38 #include <machine/elf.h>
  39 #include <stand.h>
  40 #define FREEBSD_ELF
  41 #include <link.h>
  42
  43 #include "bootstrap.h"
  44
  45 #define COPYOUT(s,d,l)  archsw.arch_copyout((vm_offset_t)(s), d, l)
  46
  47 #if defined(__i386__) && __ELF_WORD_SIZE == 64
  48 #undef ELF_TARG_CLASS
  49 #undef ELF_TARG_MACH
  50 #define ELF_TARG_CLASS  ELFCLASS64
  51 #define ELF_TARG_MACH   EM_X86_64
  52 #endif
  53
  54 typedef struct elf_file {
  55         Elf_Ehdr        hdr;
  56         Elf_Shdr        *e_shdr;
  57
  58         int             symtabindex;    /* Index of symbol table */
  59         int             shstrindex;     /* Index of section name string table */
  60
  61         int             fd;
  62         vm_offset_t     off;
  63 } *elf_file_t;
  64
  65 static int __elfN(obj_loadimage)(struct preloaded_file *mp, elf_file_t ef,
  66     u_int64_t loadaddr);
  67 static int __elfN(obj_lookup_set)(struct preloaded_file *mp, elf_file_t ef,
  68     const char *name, Elf_Addr *startp, Elf_Addr *stopp, int *countp);
  69 static int __elfN(obj_reloc_ptr)(struct preloaded_file *mp, elf_file_t ef,
  70     Elf_Addr p, void *val, size_t len);
  71 static int __elfN(obj_parse_modmetadata)(struct preloaded_file *mp,
  72     elf_file_t ef);
  73 static Elf_Addr __elfN(obj_symaddr)(struct elf_file *ef, Elf_Size symidx);
  74
  75 const char      *__elfN(obj_kerneltype) = "elf kernel";
  76 const char      *__elfN(obj_moduletype) = "elf obj module";
  77
  78 /*
  79  * Attempt to load the file (file) as an ELF module.  It will be stored at
  80  * (dest), and a pointer to a module structure describing the loaded object
  81  * will be saved in (result).
  82  */
  83 int
  84 __elfN(obj_loadfile)(char *filename, u_int64_t dest,
  85     struct preloaded_file **result)
  86 {
  87         struct preloaded_file *fp, *kfp;
  88         struct elf_file ef;
  89         Elf_Ehdr *hdr;
  90         int err;
  91         ssize_t bytes_read;
  92
  93         fp = NULL;
  94         bzero(&ef, sizeof(struct elf_file));
  95
  96         /*
  97          * Open the image, read and validate the ELF header
  98          */
  99         if (filename == NULL)   /* can't handle nameless */
 100                 return(EFTYPE);
 101         if ((ef.fd = open(filename, O_RDONLY)) == -1)
 102                 return(errno);
 103
 104         hdr = &ef.hdr;
 105         bytes_read = read(ef.fd, hdr, sizeof(*hdr));
 106         if (bytes_read != sizeof(*hdr)) {
 107                 err = EFTYPE;   /* could be EIO, but may be small file */
 108                 goto oerr;
 109         }
 110
 111         /* Is it ELF? */
 112         if (!IS_ELF(*hdr)) {
 113                 err = EFTYPE;
 114                 goto oerr;
 115         }
 116         if (hdr->e_ident[EI_CLASS] != ELF_TARG_CLASS || /* Layout ? */
 117             hdr->e_ident[EI_DATA] != ELF_TARG_DATA ||
 118             hdr->e_ident[EI_VERSION] != EV_CURRENT ||   /* Version ? */
 119             hdr->e_version != EV_CURRENT ||
 120             hdr->e_machine != ELF_TARG_MACH ||          /* Machine ? */
 121             hdr->e_type != ET_REL) {
 122                 err = EFTYPE;
 123                 goto oerr;
 124         }
 125
 126         if (hdr->e_shnum * hdr->e_shentsize == 0 || hdr->e_shoff == 0 ||
 127             hdr->e_shentsize != sizeof(Elf_Shdr)) {
 128                 err = EFTYPE;
 129                 goto oerr;
 130         }
 131
 132         kfp = file_findfile(NULL, NULL);
 133         if (kfp == NULL) {
 134                 printf("elf" __XSTRING(__ELF_WORD_SIZE)
 135                     "_obj_loadfile: can't load module before kernel\n");
 136                 err = EPERM;
 137                 goto oerr;
 138         }
 139         if (strcmp(__elfN(obj_kerneltype), kfp->f_type)) {
 140                 printf("elf" __XSTRING(__ELF_WORD_SIZE)
 141                     "_obj_loadfile: can't load module with kernel type '%s'\n",
 142                     kfp->f_type);
 143                 err = EPERM;
 144                 goto oerr;
 145         }
 146
 147         if (archsw.arch_loadaddr != NULL)
 148                 dest = archsw.arch_loadaddr(LOAD_ELF, hdr, dest);
 149         else
 150                 dest = roundup(dest, PAGE_SIZE);
 151
 152         /*
 153          * Ok, we think we should handle this.
 154          */
 155         fp = file_alloc();
 156         if (fp == NULL) {
 157                 printf("elf" __XSTRING(__ELF_WORD_SIZE)
 158                     "_obj_loadfile: cannot allocate module info\n");
 159                 err = EPERM;
 160                 goto out;
 161         }
 162         fp->f_name = strdup(filename);
 163         fp->f_type = strdup(__elfN(obj_moduletype));
 164
 165         printf("%s ", filename);
 166
 167         fp->f_size = __elfN(obj_loadimage)(fp, &ef, dest);
 168         if (fp->f_size == 0 || fp->f_addr == 0)
 169                 goto ioerr;
 170
 171         /* save exec header as metadata */
 172         file_addmetadata(fp, MODINFOMD_ELFHDR, sizeof(*hdr), hdr);
 173
 174         /* Load OK, return module pointer */
 175         *result = (struct preloaded_file *)fp;
 176         err = 0;
 177         goto out;
 178
 179 ioerr:
 180         err = EIO;
 181 oerr:
 182         file_discard(fp);
 183 out:
 184         close(ef.fd);
 185         if (ef.e_shdr != NULL)
 186                 free(ef.e_shdr);
 187
 188         return(err);
 189 }
 190
 191 /*
 192  * With the file (fd) open on the image, and (ehdr) containing
 193  * the Elf header, load the image at (off)
 194  */
 195 static int
 196 __elfN(obj_loadimage)(struct preloaded_file *fp, elf_file_t ef, u_int64_t off)
 197 {
 198         Elf_Ehdr *hdr;
 199         Elf_Shdr *shdr, *cshdr, *lshdr;
 200         vm_offset_t firstaddr, lastaddr;
 201         int i, nsym, res, ret, shdrbytes, symstrindex;
 202
 203         ret = 0;
 204         firstaddr = lastaddr = (vm_offset_t)off;
 205         hdr = &ef->hdr;
 206         ef->off = (vm_offset_t)off;
 207
 208         /* Read in the section headers. */
 209         shdrbytes = hdr->e_shnum * hdr->e_shentsize;
 210         shdr = alloc_pread(ef->fd, (off_t)hdr->e_shoff, shdrbytes);
 211         if (shdr == NULL) {
 212                 printf("\nelf" __XSTRING(__ELF_WORD_SIZE)
 213                     "_obj_loadimage: read section headers failed\n");
 214                 goto out;
 215         }
 216         ef->e_shdr = shdr;
 217
 218         /*
 219          * Decide where to load everything, but don't read it yet.
 220          * We store the load address as a non-zero sh_addr value.
 221          * Start with the code/data and bss.
 222          */
 223         for (i = 0; i < hdr->e_shnum; i++)
 224                 shdr[i].sh_addr = 0;
 225         for (i = 0; i < hdr->e_shnum; i++) {
 226                 if (shdr[i].sh_size == 0)
 227                         continue;
 228                 switch (shdr[i].sh_type) {
 229                 case SHT_PROGBITS:
 230                 case SHT_NOBITS:
 231 #if defined(__i386__) || defined(__amd64__)
 232                 case SHT_AMD64_UNWIND:
 233 #endif
 234                         lastaddr = roundup(lastaddr, shdr[i].sh_addralign);
 235                         shdr[i].sh_addr = (Elf_Addr)lastaddr;
 236                         lastaddr += shdr[i].sh_size;
 237                         break;
 238                 }
 239         }
 240
 241         /* Symbols. */
 242         nsym = 0;
 243         for (i = 0; i < hdr->e_shnum; i++) {
 244                 switch (shdr[i].sh_type) {
 245                 case SHT_SYMTAB:
 246                         nsym++;
 247                         ef->symtabindex = i;
 248                         shdr[i].sh_addr = (Elf_Addr)lastaddr;
 249                         lastaddr += shdr[i].sh_size;
 250                         break;
 251                 }
 252         }
 253         if (nsym != 1) {
 254                 printf("\nelf" __XSTRING(__ELF_WORD_SIZE)
 255                     "_obj_loadimage: file has no valid symbol table\n");
 256                 goto out;
 257         }
 258         lastaddr = roundup(lastaddr, shdr[ef->symtabindex].sh_addralign);
 259         shdr[ef->symtabindex].sh_addr = (Elf_Addr)lastaddr;
 260         lastaddr += shdr[ef->symtabindex].sh_size;
 261
 262         symstrindex = shdr[ef->symtabindex].sh_link;
 263         if (symstrindex < 0 || symstrindex >= hdr->e_shnum ||
 264             shdr[symstrindex].sh_type != SHT_STRTAB) {
 265                 printf("\nelf" __XSTRING(__ELF_WORD_SIZE)
 266                     "_obj_loadimage: file has invalid symbol strings\n");
 267                 goto out;
 268         }
 269         lastaddr = roundup(lastaddr, shdr[symstrindex].sh_addralign);
 270         shdr[symstrindex].sh_addr = (Elf_Addr)lastaddr;
 271         lastaddr += shdr[symstrindex].sh_size;
 272
 273         /* Section names. */
 274         if (hdr->e_shstrndx == 0 || hdr->e_shstrndx >= hdr->e_shnum ||
 275             shdr[hdr->e_shstrndx].sh_type != SHT_STRTAB) {
 276                 printf("\nelf" __XSTRING(__ELF_WORD_SIZE)
 277                     "_obj_loadimage: file has no section names\n");
 278                 goto out;
 279         }
 280         ef->shstrindex = hdr->e_shstrndx;
 281         lastaddr = roundup(lastaddr, shdr[ef->shstrindex].sh_addralign);
 282         shdr[ef->shstrindex].sh_addr = (Elf_Addr)lastaddr;
 283         lastaddr += shdr[ef->shstrindex].sh_size;
 284
 285         /* Relocation tables. */
 286         for (i = 0; i < hdr->e_shnum; i++) {
 287                 switch (shdr[i].sh_type) {
 288                 case SHT_REL:
 289                 case SHT_RELA:
 290                         lastaddr = roundup(lastaddr, shdr[i].sh_addralign);
 291                         shdr[i].sh_addr = (Elf_Addr)lastaddr;
 292                         lastaddr += shdr[i].sh_size;
 293                         break;
 294                 }
 295         }
 296
 297         /* Clear the whole area, including bss regions. */
 298         kern_bzero(firstaddr, lastaddr - firstaddr);
 299
 300         /* Figure section with the lowest file offset we haven't loaded yet. */
 301         for (cshdr = NULL; /* none */; /* none */)
 302         {
 303                 /*
 304                  * Find next section to load. The complexity of this loop is
 305                  * O(n^2), but with  the number of sections being typically
 306                  * small, we do not care.
 307                  */
 308                 lshdr = cshdr;
 309
 310                 for (i = 0; i < hdr->e_shnum; i++) {
 311                         if (shdr[i].sh_addr == 0 ||
 312                             shdr[i].sh_type == SHT_NOBITS)
 313                                 continue;
 314                         /* Skip sections that were loaded already. */
 315                         if (lshdr != NULL &&
 316                             lshdr->sh_offset >= shdr[i].sh_offset)
 317                                 continue;
 318                         /* Find section with smallest offset. */
 319                         if (cshdr == lshdr ||
 320                             cshdr->sh_offset > shdr[i].sh_offset)
 321                                 cshdr = &shdr[i];
 322                 }
 323
 324                 if (cshdr == lshdr)
 325                         break;
 326
 327                 if (kern_pread(ef->fd, (vm_offset_t)cshdr->sh_addr,
 328                     cshdr->sh_size, (off_t)cshdr->sh_offset) != 0) {
 329                         printf("\nelf" __XSTRING(__ELF_WORD_SIZE)
 330                             "_obj_loadimage: read failed\n");
 331                         goto out;
 332                 }
 333         }
 334
 335         file_addmetadata(fp, MODINFOMD_SHDR, shdrbytes, shdr);
 336
 337         res = __elfN(obj_parse_modmetadata)(fp, ef);
 338         if (res != 0)
 339                 goto out;
 340
 341         ret = lastaddr - firstaddr;
 342         fp->f_addr = firstaddr;
 343
 344         printf("size 0x%lx at 0x%lx", (u_long)ret, (u_long)firstaddr);
 345
 346 out:
 347         printf("\n");
 348         return ret;
 349 }
 350
 351 #if defined(__i386__) && __ELF_WORD_SIZE == 64
 352 struct mod_metadata64 {
 353         int             md_version;     /* structure version MDTV_* */
 354         int             md_type;        /* type of entry MDT_* */
 355         u_int64_t       md_data;        /* specific data */
 356         u_int64_t       md_cval;        /* common string label */
 357 };
 358 #endif
 359
 360 int
 361 __elfN(obj_parse_modmetadata)(struct preloaded_file *fp, elf_file_t ef)
 362 {
 363         struct mod_metadata md;
 364 #if defined(__i386__) && __ELF_WORD_SIZE == 64
 365         struct mod_metadata64 md64;
 366 #endif
 367         struct mod_depend *mdepend;
 368         struct mod_version mver;
 369         char *s;
 370         int error, modcnt, minfolen;
 371         Elf_Addr v, p, p_stop;
 372
 373         if (__elfN(obj_lookup_set)(fp, ef, "modmetadata_set", &p, &p_stop,
 374             &modcnt) != 0)
 375                 return 0;
 376
 377         modcnt = 0;
 378         while (p < p_stop) {
 379                 COPYOUT(p, &v, sizeof(v));
 380                 error = __elfN(obj_reloc_ptr)(fp, ef, p, &v, sizeof(v));
 381                 if (error != 0)
 382                         return (error);
 383 #if defined(__i386__) && __ELF_WORD_SIZE == 64
 384                 COPYOUT(v, &md64, sizeof(md64));
 385                 error = __elfN(obj_reloc_ptr)(fp, ef, v, &md64, sizeof(md64));
 386                 if (error != 0)
 387                         return (error);
 388                 md.md_version = md64.md_version;
 389                 md.md_type = md64.md_type;
 390                 md.md_cval = (const char *)(uintptr_t)md64.md_cval;
 391                 md.md_data = (void *)(uintptr_t)md64.md_data;
 392 #else
 393                 COPYOUT(v, &md, sizeof(md));
 394                 error = __elfN(obj_reloc_ptr)(fp, ef, v, &md, sizeof(md));
 395                 if (error != 0)
 396                         return (error);
 397 #endif
 398                 p += sizeof(Elf_Addr);
 399                 switch(md.md_type) {
 400                 case MDT_DEPEND:
 401                         s = strdupout((vm_offset_t)md.md_cval);
 402                         minfolen = sizeof(*mdepend) + strlen(s) + 1;
 403                         mdepend = malloc(minfolen);
 404                         if (mdepend == NULL)
 405                                 return ENOMEM;
 406                         COPYOUT((vm_offset_t)md.md_data, mdepend,
 407                             sizeof(*mdepend));
 408                         strcpy((char*)(mdepend + 1), s);
 409                         free(s);
 410                         file_addmetadata(fp, MODINFOMD_DEPLIST, minfolen,
 411                             mdepend);
 412                         free(mdepend);
 413                         break;
 414                 case MDT_VERSION:
 415                         s = strdupout((vm_offset_t)md.md_cval);
 416                         COPYOUT((vm_offset_t)md.md_data, &mver, sizeof(mver));
 417                         file_addmodule(fp, s, mver.mv_version, NULL);
 418                         free(s);
 419                         modcnt++;
 420                         break;
 421                 case MDT_MODULE:
 422                         break;
 423                 default:
 424                         printf("unknown type %d\n", md.md_type);
 425                         break;
 426                 }
 427         }
 428         return 0;
 429 }
 430
 431 static int
 432 __elfN(obj_lookup_set)(struct preloaded_file *fp, elf_file_t ef,
 433     const char* name, Elf_Addr *startp, Elf_Addr *stopp, int *countp)
 434 {
 435         Elf_Ehdr *hdr;
 436         Elf_Shdr *shdr;
 437         char *p;
 438         vm_offset_t shstrtab;
 439         int i;
 440
 441         hdr = &ef->hdr;
 442         shdr = ef->e_shdr;
 443         shstrtab = shdr[ef->shstrindex].sh_addr;
 444
 445         for (i = 0; i < hdr->e_shnum; i++) {
 446                 if (shdr[i].sh_type != SHT_PROGBITS)
 447                         continue;
 448                 if (shdr[i].sh_name == 0)
 449                         continue;
 450                 p = strdupout(shstrtab + shdr[i].sh_name);
 451                 if (strncmp(p, "set_", 4) == 0 && strcmp(p + 4, name) == 0) {
 452                         *startp = shdr[i].sh_addr;
 453                         *stopp = shdr[i].sh_addr +  shdr[i].sh_size;
 454                         *countp = (*stopp - *startp) / sizeof(Elf_Addr);
 455                         free(p);
 456                         return (0);
 457                 }
 458                 free(p);
 459         }
 460
 461         return (ESRCH);
 462 }
 463
 464 /*
 465  * Apply any intra-module relocations to the value. p is the load address
 466  * of the value and val/len is the value to be modified. This does NOT modify
 467  * the image in-place, because this is done by kern_linker later on.
 468  */
 469 static int
 470 __elfN(obj_reloc_ptr)(struct preloaded_file *mp, elf_file_t ef, Elf_Addr p,
 471     void *val, size_t len)
 472 {
 473         Elf_Ehdr *hdr;
 474         Elf_Shdr *shdr;
 475         Elf_Addr off = p;
 476         Elf_Addr base;
 477         Elf_Rela a, *abase;
 478         Elf_Rel r, *rbase;
 479         int error, i, j, nrel, nrela;
 480
 481         hdr = &ef->hdr;
 482         shdr = ef->e_shdr;
 483
 484         for (i = 0; i < hdr->e_shnum; i++) {
 485                 if (shdr[i].sh_type != SHT_RELA && shdr[i].sh_type != SHT_REL)
 486                         continue;
 487                 base = shdr[shdr[i].sh_info].sh_addr;
 488                 if (base == 0 || shdr[i].sh_addr == 0)
 489                         continue;
 490                 if (off < base || off + len > base +
 491                     shdr[shdr[i].sh_info].sh_size)
 492                         continue;
 493
 494                 switch (shdr[i].sh_type) {
 495                 case SHT_RELA:
 496                         abase = (Elf_Rela *)(intptr_t)shdr[i].sh_addr;
 497
 498                         nrela = shdr[i].sh_size / sizeof(Elf_Rela);
 499                         for (j = 0; j < nrela; j++) {
 500                                 COPYOUT(abase + j, &a, sizeof(a));
 501
 502                                 error = __elfN(reloc)(ef, __elfN(obj_symaddr),
 503                                     &a, ELF_RELOC_RELA, base, off, val, len);
 504                                 if (error != 0)
 505                                         return (error);
 506                         }
 507                         break;
 508                 case SHT_REL:
 509                         rbase = (Elf_Rel *)(intptr_t)shdr[i].sh_addr;
 510
 511                         nrel = shdr[i].sh_size / sizeof(Elf_Rel);
 512                         for (j = 0; j < nrel; j++) {
 513                                 COPYOUT(rbase + j, &r, sizeof(r));
 514
 515                                 error = __elfN(reloc)(ef, __elfN(obj_symaddr),
 516                                     &r, ELF_RELOC_REL, base, off, val, len);
 517                                 if (error != 0)
 518                                         return (error);
 519                         }
 520                         break;
 521                 }
 522         }
 523         return (0);
 524 }
 525
 526 /* Look up the address of a specified symbol. */
 527 static Elf_Addr
 528 __elfN(obj_symaddr)(struct elf_file *ef, Elf_Size symidx)
 529 {
 530         Elf_Sym sym;
 531         Elf_Addr base;
 532         int symcnt;
 533
 534         symcnt = ef->e_shdr[ef->symtabindex].sh_size / sizeof(Elf_Sym);
 535         if (symidx >= symcnt)
 536                 return (0);
 537         COPYOUT(ef->e_shdr[ef->symtabindex].sh_addr + symidx * sizeof(Elf_Sym),
 538             &sym, sizeof(sym));
 539         if (sym.st_shndx == SHN_UNDEF || sym.st_shndx >= ef->hdr.e_shnum)
 540                 return (0);
 541         base = ef->e_shdr[sym.st_shndx].sh_addr;
 542         if (base == 0)
 543                 return (0);
 544         return (base + sym.st_value);
 545 }