libexec/rtld-elf/map_object.c

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