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_Addr base_vaddr;
  69     Elf_Addr base_vlimit;
  70     caddr_t base_addr;
  71     Elf_Off data_offset;
  72     Elf_Addr data_vaddr;
  73     Elf_Addr data_vlimit;
  74     caddr_t data_addr;
  75     int data_prot;
  76     int data_flags;
  77     Elf_Addr clear_vaddr;
  78     caddr_t clear_addr;
  79     caddr_t clear_page;
  80     Elf_Addr phdr_vaddr;
  81     size_t nclear, phsize;
  82     Elf_Addr bss_vaddr;
  83     Elf_Addr bss_vlimit;
  84     caddr_t bss_addr;
  85
  86     hdr = get_elf_header(fd, path);
  87     if (hdr == NULL)
  88         return (NULL);
  89
  90     /*
  91      * Scan the program header entries, and save key information.
  92      *
  93      * We expect that the loadable segments are ordered by load address.
  94      */
  95     phdr = (Elf_Phdr *) ((char *)hdr + hdr->e_phoff);
  96     phsize  = hdr->e_phnum * sizeof (phdr[0]);
  97     phlimit = phdr + hdr->e_phnum;
  98     nsegs = -1;
  99     phdyn = phinterp = phtls = NULL;
 100     phdr_vaddr = 0;
 101     segs = alloca(sizeof(segs[0]) * hdr->e_phnum);
 102     while (phdr < phlimit) {
 103         switch (phdr->p_type) {
 104
 105         case PT_INTERP:
 106             phinterp = phdr;
 107             break;
 108
 109         case PT_LOAD:
 110             segs[++nsegs] = phdr;
 111             if ((segs[nsegs]->p_align & (PAGE_SIZE - 1)) != 0) {
 112                 _rtld_error("%s: PT_LOAD segment %d not page-aligned",
 113                     path, nsegs);
 114                 return NULL;
 115             }
 116             break;
 117
 118         case PT_PHDR:
 119             phdr_vaddr = phdr->p_vaddr;
 120             phsize = phdr->p_memsz;
 121             break;
 122
 123         case PT_DYNAMIC:
 124             phdyn = phdr;
 125             break;
 126
 127         case PT_TLS:
 128             phtls = phdr;
 129             break;
 130         }
 131
 132         ++phdr;
 133     }
 134     if (phdyn == NULL) {
 135         _rtld_error("%s: object is not dynamically-linked", path);
 136         return NULL;
 137     }
 138
 139     if (nsegs < 0) {
 140         _rtld_error("%s: too few PT_LOAD segments", path);
 141         return NULL;
 142     }
 143
 144     /*
 145      * Map the entire address space of the object, to stake out our
 146      * contiguous region, and to establish the base address for relocation.
 147      */
 148     base_vaddr = trunc_page(segs[0]->p_vaddr);
 149     base_vlimit = round_page(segs[nsegs]->p_vaddr + segs[nsegs]->p_memsz);
 150     mapsize = base_vlimit - base_vaddr;
 151     base_addr = (caddr_t) base_vaddr;
 152
 153     mapbase = mmap(base_addr, mapsize, PROT_NONE, MAP_ANON | MAP_PRIVATE |
 154       MAP_NOCORE, -1, 0);
 155     if (mapbase == (caddr_t) -1) {
 156         _rtld_error("%s: mmap of entire address space failed: %s",
 157           path, strerror(errno));
 158         return NULL;
 159     }
 160     if (base_addr != NULL && mapbase != base_addr) {
 161         _rtld_error("%s: mmap returned wrong address: wanted %p, got %p",
 162           path, base_addr, mapbase);
 163         munmap(mapbase, mapsize);
 164         return NULL;
 165     }
 166
 167     for (i = 0; i <= nsegs; i++) {
 168         /* Overlay the segment onto the proper region. */
 169         data_offset = trunc_page(segs[i]->p_offset);
 170         data_vaddr = trunc_page(segs[i]->p_vaddr);
 171         data_vlimit = round_page(segs[i]->p_vaddr + segs[i]->p_filesz);
 172         data_addr = mapbase + (data_vaddr - base_vaddr);
 173         data_prot = convert_prot(segs[i]->p_flags);
 174         data_flags = convert_flags(segs[i]->p_flags) | MAP_FIXED;
 175         if (mmap(data_addr, data_vlimit - data_vaddr, data_prot,
 176           data_flags, fd, data_offset) == (caddr_t) -1) {
 177             _rtld_error("%s: mmap of data failed: %s", path, strerror(errno));
 178             return NULL;
 179         }
 180
 181         /* Do BSS setup */
 182         if (segs[i]->p_filesz != segs[i]->p_memsz) {
 183
 184             /* Clear any BSS in the last page of the segment. */
 185             clear_vaddr = segs[i]->p_vaddr + segs[i]->p_filesz;
 186             clear_addr = mapbase + (clear_vaddr - base_vaddr);
 187             clear_page = mapbase + (trunc_page(clear_vaddr) - base_vaddr);
 188
 189             if ((nclear = data_vlimit - clear_vaddr) > 0) {
 190                 /* Make sure the end of the segment is writable */
 191                 if ((data_prot & PROT_WRITE) == 0 && -1 ==
 192                      mprotect(clear_page, PAGE_SIZE, data_prot|PROT_WRITE)) {
 193                         _rtld_error("%s: mprotect failed: %s", path,
 194                             strerror(errno));
 195                         return NULL;
 196                 }
 197
 198                 memset(clear_addr, 0, nclear);
 199
 200                 /* Reset the data protection back */
 201                 if ((data_prot & PROT_WRITE) == 0)
 202                     mprotect(clear_page, PAGE_SIZE, data_prot);
 203             }
 204
 205             /* Overlay the BSS segment onto the proper region. */
 206             bss_vaddr = data_vlimit;
 207             bss_vlimit = round_page(segs[i]->p_vaddr + segs[i]->p_memsz);
 208             bss_addr = mapbase +  (bss_vaddr - base_vaddr);
 209             if (bss_vlimit > bss_vaddr) {       /* There is something to do */
 210                 if (mmap(bss_addr, bss_vlimit - bss_vaddr, data_prot,
 211                     data_flags | MAP_ANON, -1, 0) == (caddr_t)-1) {
 212                     _rtld_error("%s: mmap of bss failed: %s", path,
 213                         strerror(errno));
 214                     return NULL;
 215                 }
 216             }
 217         }
 218
 219         if (phdr_vaddr == 0 && data_offset <= hdr->e_phoff &&
 220           (data_vlimit - data_vaddr + data_offset) >=
 221           (hdr->e_phoff + hdr->e_phnum * sizeof (Elf_Phdr))) {
 222             phdr_vaddr = data_vaddr + hdr->e_phoff - data_offset;
 223         }
 224     }
 225
 226     obj = obj_new();
 227     if (sb != NULL) {
 228         obj->dev = sb->st_dev;
 229         obj->ino = sb->st_ino;
 230     }
 231     obj->mapbase = mapbase;
 232     obj->mapsize = mapsize;
 233     obj->textsize = round_page(segs[0]->p_vaddr + segs[0]->p_memsz) -
 234       base_vaddr;
 235     obj->vaddrbase = base_vaddr;
 236     obj->relocbase = mapbase - base_vaddr;
 237     obj->dynamic = (const Elf_Dyn *) (obj->relocbase + phdyn->p_vaddr);
 238     if (hdr->e_entry != 0)
 239         obj->entry = (caddr_t) (obj->relocbase + hdr->e_entry);
 240     if (phdr_vaddr != 0) {
 241         obj->phdr = (const Elf_Phdr *) (obj->relocbase + phdr_vaddr);
 242     } else {
 243         obj->phdr = malloc(phsize);
 244         if (obj->phdr == NULL) {
 245             obj_free(obj);
 246             _rtld_error("%s: cannot allocate program header", path);
 247              return NULL;
 248         }
 249         memcpy((char *)obj->phdr, (char *)hdr + hdr->e_phoff, phsize);
 250         obj->phdr_alloc = true;
 251     }
 252     obj->phsize = phsize;
 253     if (phinterp != NULL)
 254         obj->interp = (const char *) (obj->relocbase + phinterp->p_vaddr);
 255     if (phtls != NULL) {
 256         tls_dtv_generation++;
 257         obj->tlsindex = ++tls_max_index;
 258         obj->tlssize = phtls->p_memsz;
 259         obj->tlsalign = phtls->p_align;
 260         obj->tlsinitsize = phtls->p_filesz;
 261         obj->tlsinit = mapbase + phtls->p_vaddr;
 262     }
 263     return obj;
 264 }
 265
 266 static Elf_Ehdr *
 267 get_elf_header (int fd, const char *path)
 268 {
 269     static union {
 270         Elf_Ehdr hdr;
 271         char buf[PAGE_SIZE];
 272     } u;
 273     ssize_t nbytes;
 274
 275     if ((nbytes = pread(fd, u.buf, PAGE_SIZE, 0)) == -1) {
 276         _rtld_error("%s: read error: %s", path, strerror(errno));
 277         return NULL;
 278     }
 279
 280     /* Make sure the file is valid */
 281     if (nbytes < (ssize_t)sizeof(Elf_Ehdr) || !IS_ELF(u.hdr)) {
 282         _rtld_error("%s: invalid file format", path);
 283         return NULL;
 284     }
 285     if (u.hdr.e_ident[EI_CLASS] != ELF_TARG_CLASS
 286       || u.hdr.e_ident[EI_DATA] != ELF_TARG_DATA) {
 287         _rtld_error("%s: unsupported file layout", path);
 288         return NULL;
 289     }
 290     if (u.hdr.e_ident[EI_VERSION] != EV_CURRENT
 291       || u.hdr.e_version != EV_CURRENT) {
 292         _rtld_error("%s: unsupported file version", path);
 293         return NULL;
 294     }
 295     if (u.hdr.e_type != ET_EXEC && u.hdr.e_type != ET_DYN) {
 296         _rtld_error("%s: unsupported file type", path);
 297         return NULL;
 298     }
 299     if (u.hdr.e_machine != ELF_TARG_MACH) {
 300         _rtld_error("%s: unsupported machine", path);
 301         return NULL;
 302     }
 303
 304     /*
 305      * We rely on the program header being in the first page.  This is
 306      * not strictly required by the ABI specification, but it seems to
 307      * always true in practice.  And, it simplifies things considerably.
 308      */
 309     if (u.hdr.e_phentsize != sizeof(Elf_Phdr)) {
 310         _rtld_error(
 311           "%s: invalid shared object: e_phentsize != sizeof(Elf_Phdr)", path);
 312         return NULL;
 313     }
 314     if (u.hdr.e_phoff + u.hdr.e_phnum * sizeof(Elf_Phdr) > (size_t)nbytes) {
 315         _rtld_error("%s: program header too large", path);
 316         return NULL;
 317     }
 318
 319     return (&u.hdr);
 320 }
 321
 322 void
 323 obj_free(Obj_Entry *obj)
 324 {
 325     Objlist_Entry *elm;
 326
 327     if (obj->tls_done)
 328         free_tls_offset(obj);
 329     while (obj->needed != NULL) {
 330         Needed_Entry *needed = obj->needed;
 331         obj->needed = needed->next;
 332         free(needed);
 333     }
 334     while (!STAILQ_EMPTY(&obj->names)) {
 335         Name_Entry *entry = STAILQ_FIRST(&obj->names);
 336         STAILQ_REMOVE_HEAD(&obj->names, link);
 337         free(entry);
 338     }
 339     while (!STAILQ_EMPTY(&obj->dldags)) {
 340         elm = STAILQ_FIRST(&obj->dldags);
 341         STAILQ_REMOVE_HEAD(&obj->dldags, link);
 342         free(elm);
 343     }
 344     while (!STAILQ_EMPTY(&obj->dagmembers)) {
 345         elm = STAILQ_FIRST(&obj->dagmembers);
 346         STAILQ_REMOVE_HEAD(&obj->dagmembers, link);
 347         free(elm);
 348     }
 349     if (obj->vertab)
 350         free(obj->vertab);
 351     if (obj->origin_path)
 352         free(obj->origin_path);
 353     if (obj->z_origin)
 354         free(obj->rpath);
 355     if (obj->priv)
 356         free(obj->priv);
 357     if (obj->path)
 358         free(obj->path);
 359     if (obj->phdr_alloc)
 360         free((void *)obj->phdr);
 361     free(obj);
 362 }
 363
 364 Obj_Entry *
 365 obj_new(void)
 366 {
 367     Obj_Entry *obj;
 368
 369     obj = CNEW(Obj_Entry);
 370     STAILQ_INIT(&obj->dldags);
 371     STAILQ_INIT(&obj->dagmembers);
 372     STAILQ_INIT(&obj->names);
 373     return obj;
 374 }
 375
 376 /*
 377  * Given a set of ELF protection flags, return the corresponding protection
 378  * flags for MMAP.
 379  */
 380 static int
 381 convert_prot(int elfflags)
 382 {
 383     int prot = 0;
 384     if (elfflags & PF_R)
 385         prot |= PROT_READ;
 386     if (elfflags & PF_W)
 387         prot |= PROT_WRITE;
 388     if (elfflags & PF_X)
 389         prot |= PROT_EXEC;
 390     return prot;
 391 }
 392
 393 static int
 394 convert_flags(int elfflags)
 395 {
 396     int flags = MAP_PRIVATE; /* All mappings are private */
 397
 398     /*
 399      * Readonly mappings are marked "MAP_NOCORE", because they can be
 400      * reconstructed by a debugger.
 401      */
 402     if (!(elfflags & PF_W))
 403         flags |= MAP_NOCORE;
 404     return flags;
 405 }