libexec/rtld-elf/map_object.c

   1 /*-
   2  * Copyright 1996-1998 John D. Polstra.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  * $FreeBSD$
  26  */
  27
  28 #include <sys/param.h>
  29 #include <sys/mman.h>
  30 #include <sys/stat.h>
  31
  32 #include <errno.h>
  33 #include <stddef.h>
  34 #include <stdlib.h>
  35 #include <string.h>
  36 #include <unistd.h>
  37
  38 #include "debug.h"
  39 #include "rtld.h"
  40
  41 static Elf_Ehdr *get_elf_header (int, const char *);
  42 static int convert_prot(int);   /* Elf flags -> mmap protection */
  43 static int convert_flags(int); /* Elf flags -> mmap flags */
  44
  45 /*
  46  * Map a shared object into memory.  The "fd" argument is a file descriptor,
  47  * which must be open on the object and positioned at its beginning.
  48  * The "path" argument is a pathname that is used only for error messages.
  49  *
  50  * The return value is a pointer to a newly-allocated Obj_Entry structure
  51  * for the shared object.  Returns NULL on failure.
  52  */
  53 Obj_Entry *
  54 map_object(int fd, const char *path, const struct stat *sb)
  55 {
  56     Obj_Entry *obj;
  57     Elf_Ehdr *hdr;
  58     int i;
  59     Elf_Phdr *phdr;
  60     Elf_Phdr *phlimit;
  61     Elf_Phdr **segs;
  62     int nsegs;
  63     Elf_Phdr *phdyn;
  64     Elf_Phdr *phinterp;
  65     Elf_Phdr *phtls;
  66     caddr_t mapbase;
  67     size_t mapsize;
  68     Elf_Off base_offset;
  69     Elf_Addr base_vaddr;
  70     Elf_Addr base_vlimit;
  71     caddr_t base_addr;
  72     Elf_Off data_offset;
  73     Elf_Addr data_vaddr;
  74     Elf_Addr data_vlimit;
  75     caddr_t data_addr;
  76     int data_prot;
  77     int data_flags;
  78     Elf_Addr clear_vaddr;
  79     caddr_t clear_addr;
  80     caddr_t clear_page;
  81     Elf_Addr phdr_vaddr;
  82     size_t nclear, phsize;
  83     Elf_Addr bss_vaddr;
  84     Elf_Addr bss_vlimit;
  85     caddr_t bss_addr;
  86
  87     hdr = get_elf_header(fd, path);
  88     if (hdr == NULL)
  89         return (NULL);
  90
  91     /*
  92      * Scan the program header entries, and save key information.
  93      *
  94      * We expect that the loadable segments are ordered by load address.
  95      */
  96     phdr = (Elf_Phdr *) ((char *)hdr + hdr->e_phoff);
  97     phsize  = hdr->e_phnum * sizeof (phdr[0]);
  98     phlimit = phdr + hdr->e_phnum;
  99     nsegs = -1;
 100     phdyn = phinterp = phtls = NULL;
 101     phdr_vaddr = 0;
 102     segs = alloca(sizeof(segs[0]) * hdr->e_phnum);
 103     while (phdr < phlimit) {
 104         switch (phdr->p_type) {
 105
 106         case PT_INTERP:
 107             phinterp = phdr;
 108             break;
 109
 110         case PT_LOAD:
 111             segs[++nsegs] = phdr;
 112             if ((segs[nsegs]->p_align & (PAGE_SIZE - 1)) != 0) {
 113                 _rtld_error("%s: PT_LOAD segment %d not page-aligned",
 114                     path, nsegs);
 115                 return NULL;
 116             }
 117             break;
 118
 119         case PT_PHDR:
 120             phdr_vaddr = phdr->p_vaddr;
 121             phsize = phdr->p_memsz;
 122             break;
 123
 124         case PT_DYNAMIC:
 125             phdyn = phdr;
 126             break;
 127
 128         case PT_TLS:
 129             phtls = phdr;
 130             break;
 131         }
 132
 133         ++phdr;
 134     }
 135     if (phdyn == NULL) {
 136         _rtld_error("%s: object is not dynamically-linked", path);
 137         return NULL;
 138     }
 139
 140     if (nsegs < 0) {
 141         _rtld_error("%s: too few PT_LOAD segments", path);
 142         return NULL;
 143     }
 144
 145     /*
 146      * Map the entire address space of the object, to stake out our
 147      * contiguous region, and to establish the base address for relocation.
 148      */
 149     base_offset = trunc_page(segs[0]->p_offset);
 150     base_vaddr = trunc_page(segs[0]->p_vaddr);
 151     base_vlimit = round_page(segs[nsegs]->p_vaddr + segs[nsegs]->p_memsz);
 152     mapsize = base_vlimit - base_vaddr;
 153     base_addr = hdr->e_type == ET_EXEC ? (caddr_t) base_vaddr : NULL;
 154
 155     mapbase = mmap(base_addr, mapsize, PROT_NONE, MAP_ANON | MAP_PRIVATE |
 156       MAP_NOCORE, -1, 0);
 157     if (mapbase == (caddr_t) -1) {
 158         _rtld_error("%s: mmap of entire address space failed: %s",
 159           path, strerror(errno));
 160         return NULL;
 161     }
 162     if (base_addr != NULL && mapbase != base_addr) {
 163         _rtld_error("%s: mmap returned wrong address: wanted %p, got %p",
 164           path, base_addr, mapbase);
 165         munmap(mapbase, mapsize);
 166         return NULL;
 167     }
 168
 169     for (i = 0; i <= nsegs; i++) {
 170         /* Overlay the segment onto the proper region. */
 171         data_offset = trunc_page(segs[i]->p_offset);
 172         data_vaddr = trunc_page(segs[i]->p_vaddr);
 173         data_vlimit = round_page(segs[i]->p_vaddr + segs[i]->p_filesz);
 174         data_addr = mapbase + (data_vaddr - base_vaddr);
 175         data_prot = convert_prot(segs[i]->p_flags);
 176         data_flags = convert_flags(segs[i]->p_flags) | MAP_FIXED;
 177         if (mmap(data_addr, data_vlimit - data_vaddr, data_prot,
 178           data_flags, fd, data_offset) == (caddr_t) -1) {
 179             _rtld_error("%s: mmap of data failed: %s", path, strerror(errno));
 180             return NULL;
 181         }
 182
 183         /* Do BSS setup */
 184         if (segs[i]->p_filesz != segs[i]->p_memsz) {
 185
 186             /* Clear any BSS in the last page of the segment. */
 187             clear_vaddr = segs[i]->p_vaddr + segs[i]->p_filesz;
 188             clear_addr = mapbase + (clear_vaddr - base_vaddr);
 189             clear_page = mapbase + (trunc_page(clear_vaddr) - base_vaddr);
 190
 191             if ((nclear = data_vlimit - clear_vaddr) > 0) {
 192                 /* Make sure the end of the segment is writable */
 193                 if ((data_prot & PROT_WRITE) == 0 && -1 ==
 194                      mprotect(clear_page, PAGE_SIZE, data_prot|PROT_WRITE)) {
 195                         _rtld_error("%s: mprotect failed: %s", path,
 196                             strerror(errno));
 197                         return NULL;
 198                 }
 199
 200                 memset(clear_addr, 0, nclear);
 201
 202                 /* Reset the data protection back */
 203                 if ((data_prot & PROT_WRITE) == 0)
 204                     mprotect(clear_page, PAGE_SIZE, data_prot);
 205             }
 206
 207             /* Overlay the BSS segment onto the proper region. */
 208             bss_vaddr = data_vlimit;
 209             bss_vlimit = round_page(segs[i]->p_vaddr + segs[i]->p_memsz);
 210             bss_addr = mapbase +  (bss_vaddr - base_vaddr);
 211             if (bss_vlimit > bss_vaddr) {       /* There is something to do */
 212                 if (mmap(bss_addr, bss_vlimit - bss_vaddr, data_prot,
 213                     data_flags | MAP_ANON, -1, 0) == (caddr_t)-1) {
 214                     _rtld_error("%s: mmap of bss failed: %s", path,
 215                         strerror(errno));
 216                     return NULL;
 217                 }
 218             }
 219         }
 220
 221         if (phdr_vaddr == 0 && data_offset <= hdr->e_phoff &&
 222           (data_vlimit - data_vaddr + data_offset) >=
 223           (hdr->e_phoff + hdr->e_phnum * sizeof (Elf_Phdr))) {
 224             phdr_vaddr = data_vaddr + hdr->e_phoff - data_offset;
 225         }
 226     }
 227
 228     obj = obj_new();
 229     if (sb != NULL) {
 230         obj->dev = sb->st_dev;
 231         obj->ino = sb->st_ino;
 232     }
 233     obj->mapbase = mapbase;
 234     obj->mapsize = mapsize;
 235     obj->textsize = round_page(segs[0]->p_vaddr + segs[0]->p_memsz) -
 236       base_vaddr;
 237     obj->vaddrbase = base_vaddr;
 238     obj->relocbase = mapbase - base_vaddr;
 239     obj->dynamic = (const Elf_Dyn *) (obj->relocbase + phdyn->p_vaddr);
 240     if (hdr->e_entry != 0)
 241         obj->entry = (caddr_t) (obj->relocbase + hdr->e_entry);
 242     if (phdr_vaddr != 0) {
 243         obj->phdr = (const Elf_Phdr *) (obj->relocbase + phdr_vaddr);
 244     } else {
 245         obj->phdr = malloc(phsize);
 246         if (obj->phdr == NULL) {
 247             obj_free(obj);
 248             _rtld_error("%s: cannot allocate program header", path);
 249              return NULL;
 250         }
 251         memcpy((char *)obj->phdr, (char *)hdr + hdr->e_phoff, phsize);
 252         obj->phdr_alloc = true;
 253     }
 254     obj->phsize = phsize;
 255     if (phinterp != NULL)
 256         obj->interp = (const char *) (obj->relocbase + phinterp->p_vaddr);
 257     if (phtls != NULL) {
 258         tls_dtv_generation++;
 259         obj->tlsindex = ++tls_max_index;
 260         obj->tlssize = phtls->p_memsz;
 261         obj->tlsalign = phtls->p_align;
 262         obj->tlsinitsize = phtls->p_filesz;
 263         obj->tlsinit = mapbase + phtls->p_vaddr;
 264     }
 265     return obj;
 266 }
 267
 268 static Elf_Ehdr *
 269 get_elf_header (int fd, const char *path)
 270 {
 271     static union {
 272         Elf_Ehdr hdr;
 273         char buf[PAGE_SIZE];
 274     } u;
 275     ssize_t nbytes;
 276
 277     if ((nbytes = pread(fd, u.buf, PAGE_SIZE, 0)) == -1) {
 278         _rtld_error("%s: read error: %s", path, strerror(errno));
 279         return NULL;
 280     }
 281
 282     /* Make sure the file is valid */
 283     if (nbytes < (ssize_t)sizeof(Elf_Ehdr) || !IS_ELF(u.hdr)) {
 284         _rtld_error("%s: invalid file format", path);
 285         return NULL;
 286     }
 287     if (u.hdr.e_ident[EI_CLASS] != ELF_TARG_CLASS
 288       || u.hdr.e_ident[EI_DATA] != ELF_TARG_DATA) {
 289         _rtld_error("%s: unsupported file layout", path);
 290         return NULL;
 291     }
 292     if (u.hdr.e_ident[EI_VERSION] != EV_CURRENT
 293       || u.hdr.e_version != EV_CURRENT) {
 294         _rtld_error("%s: unsupported file version", path);
 295         return NULL;
 296     }
 297     if (u.hdr.e_type != ET_EXEC && u.hdr.e_type != ET_DYN) {
 298         _rtld_error("%s: unsupported file type", path);
 299         return NULL;
 300     }
 301     if (u.hdr.e_machine != ELF_TARG_MACH) {
 302         _rtld_error("%s: unsupported machine", path);
 303         return NULL;
 304     }
 305
 306     /*
 307      * We rely on the program header being in the first page.  This is
 308      * not strictly required by the ABI specification, but it seems to
 309      * always true in practice.  And, it simplifies things considerably.
 310      */
 311     if (u.hdr.e_phentsize != sizeof(Elf_Phdr)) {
 312         _rtld_error(
 313           "%s: invalid shared object: e_phentsize != sizeof(Elf_Phdr)", path);
 314         return NULL;
 315     }
 316     if (u.hdr.e_phoff + u.hdr.e_phnum * sizeof(Elf_Phdr) > (size_t)nbytes) {
 317         _rtld_error("%s: program header too large", path);
 318         return NULL;
 319     }
 320
 321     return (&u.hdr);
 322 }
 323
 324 void
 325 obj_free(Obj_Entry *obj)
 326 {
 327     Objlist_Entry *elm;
 328
 329     if (obj->tls_done)
 330         free_tls_offset(obj);
 331     while (obj->needed != NULL) {
 332         Needed_Entry *needed = obj->needed;
 333         obj->needed = needed->next;
 334         free(needed);
 335     }
 336     while (!STAILQ_EMPTY(&obj->names)) {
 337         Name_Entry *entry = STAILQ_FIRST(&obj->names);
 338         STAILQ_REMOVE_HEAD(&obj->names, link);
 339         free(entry);
 340     }
 341     while (!STAILQ_EMPTY(&obj->dldags)) {
 342         elm = STAILQ_FIRST(&obj->dldags);
 343         STAILQ_REMOVE_HEAD(&obj->dldags, link);
 344         free(elm);
 345     }
 346     while (!STAILQ_EMPTY(&obj->dagmembers)) {
 347         elm = STAILQ_FIRST(&obj->dagmembers);
 348         STAILQ_REMOVE_HEAD(&obj->dagmembers, link);
 349         free(elm);
 350     }
 351     if (obj->vertab)
 352         free(obj->vertab);
 353     if (obj->origin_path)
 354         free(obj->origin_path);
 355     if (obj->z_origin)
 356         free(obj->rpath);
 357     if (obj->priv)
 358         free(obj->priv);
 359     if (obj->path)
 360         free(obj->path);
 361     if (obj->phdr_alloc)
 362         free((void *)obj->phdr);
 363     free(obj);
 364 }
 365
 366 Obj_Entry *
 367 obj_new(void)
 368 {
 369     Obj_Entry *obj;
 370
 371     obj = CNEW(Obj_Entry);
 372     STAILQ_INIT(&obj->dldags);
 373     STAILQ_INIT(&obj->dagmembers);
 374     STAILQ_INIT(&obj->names);
 375     return obj;
 376 }
 377
 378 /*
 379  * Given a set of ELF protection flags, return the corresponding protection
 380  * flags for MMAP.
 381  */
 382 static int
 383 convert_prot(int elfflags)
 384 {
 385     int prot = 0;
 386     if (elfflags & PF_R)
 387         prot |= PROT_READ;
 388     if (elfflags & PF_W)
 389         prot |= PROT_WRITE;
 390     if (elfflags & PF_X)
 391         prot |= PROT_EXEC;
 392     return prot;
 393 }
 394
 395 static int
 396 convert_flags(int elfflags)
 397 {
 398     int flags = MAP_PRIVATE; /* All mappings are private */
 399
 400     /*
 401      * Readonly mappings are marked "MAP_NOCORE", because they can be
 402      * reconstructed by a debugger.
 403      */
 404     if (!(elfflags & PF_W))
 405         flags |= MAP_NOCORE;
 406     return flags;
 407 }