libexec/rtld-elf/rtld.c

   1 /*-
   2  * Copyright 1996, 1997, 1998, 1999, 2000 John D. Polstra.
   3  * Copyright 2003 Alexander Kabaev <kan@FreeBSD.ORG>.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   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.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/libexec/rtld-elf/rtld.c,v 1.43.2.15 2003/02/20 20:42:46 kan Exp $
  27  * $DragonFly: src/libexec/rtld-elf/rtld.c,v 1.25 2007/01/15 04:45:40 corecode Exp $
  28  */
  29
  30 /*
  31  * Dynamic linker for ELF.
  32  *
  33  * John Polstra <jdp@polstra.com>.
  34  */
  35
  36 #ifndef __GNUC__
  37 #error "GCC is needed to compile this file"
  38 #endif
  39
  40 #include <sys/param.h>
  41 #include <sys/mman.h>
  42 #include <sys/stat.h>
  43 #include <sys/resident.h>
  44 #include <sys/tls.h>
  45
  46 #include <machine/tls.h>
  47
  48 #include <dlfcn.h>
  49 #include <err.h>
  50 #include <errno.h>
  51 #include <fcntl.h>
  52 #include <stdarg.h>
  53 #include <stdio.h>
  54 #include <stdlib.h>
  55 #include <string.h>
  56 #include <unistd.h>
  57
  58 #include "debug.h"
  59 #include "rtld.h"
  60
  61 #define PATH_RTLD       "/usr/libexec/ld-elf.so.2"
  62 #define LD_ARY_CACHE    16
  63
  64 /* Types. */
  65 typedef void (*func_ptr_type)();
  66 typedef void * (*path_enum_proc) (const char *path, size_t len, void *arg);
  67
  68 /*
  69  * This structure provides a reentrant way to keep a list of objects and
  70  * check which ones have already been processed in some way.
  71  */
  72 typedef struct Struct_DoneList {
  73     const Obj_Entry **objs;             /* Array of object pointers */
  74     unsigned int num_alloc;             /* Allocated size of the array */
  75     unsigned int num_used;              /* Number of array slots used */
  76 } DoneList;
  77
  78 /*
  79  * Function declarations.
  80  */
  81 static void die(void);
  82 static void digest_dynamic(Obj_Entry *, int);
  83 static const char *_getenv_ld(const char *id);
  84 static Obj_Entry *digest_phdr(const Elf_Phdr *, int, caddr_t, const char *);
  85 static Obj_Entry *dlcheck(void *);
  86 static int do_search_info(const Obj_Entry *obj, int, struct dl_serinfo *);
  87 static bool donelist_check(DoneList *, const Obj_Entry *);
  88 static void errmsg_restore(char *);
  89 static char *errmsg_save(void);
  90 static void *fill_search_info(const char *, size_t, void *);
  91 static char *find_library(const char *, const Obj_Entry *);
  92 static Obj_Entry *find_object(const char *);
  93 static Obj_Entry *find_object2(const char *, int *, struct stat *);
  94 static const char *gethints(void);
  95 static void init_dag(Obj_Entry *);
  96 static void init_dag1(Obj_Entry *root, Obj_Entry *obj, DoneList *);
  97 static void init_rtld(caddr_t);
  98 static void initlist_add_neededs(Needed_Entry *needed, Objlist *list);
  99 static void initlist_add_objects(Obj_Entry *obj, Obj_Entry **tail,
 100   Objlist *list);
 101 static bool is_exported(const Elf_Sym *);
 102 static void linkmap_add(Obj_Entry *);
 103 static void linkmap_delete(Obj_Entry *);
 104 static int load_needed_objects(Obj_Entry *);
 105 static int load_preload_objects(void);
 106 static Obj_Entry *load_object(char *);
 107 static void lock_check(void);
 108 static Obj_Entry *obj_from_addr(const void *);
 109 static void objlist_call_fini(Objlist *);
 110 static void objlist_call_init(Objlist *);
 111 static void objlist_clear(Objlist *);
 112 static Objlist_Entry *objlist_find(Objlist *, const Obj_Entry *);
 113 static void objlist_init(Objlist *);
 114 static void objlist_push_head(Objlist *, Obj_Entry *);
 115 static void objlist_push_tail(Objlist *, Obj_Entry *);
 116 static void objlist_remove(Objlist *, Obj_Entry *);
 117 static void objlist_remove_unref(Objlist *);
 118 static void *path_enumerate(const char *, path_enum_proc, void *);
 119 static int relocate_objects(Obj_Entry *, bool, Obj_Entry *);
 120 static int rtld_dirname(const char *, char *);
 121 static void rtld_exit(void);
 122 static char *search_library_path(const char *, const char *);
 123 static const void **get_program_var_addr(const char *name);
 124 static void set_program_var(const char *, const void *);
 125 static const Elf_Sym *symlook_default(const char *, unsigned long hash,
 126   const Obj_Entry *refobj, const Obj_Entry **defobj_out, bool in_plt);
 127 static const Elf_Sym *symlook_list(const char *, unsigned long,
 128   const Objlist *, const Obj_Entry **, bool in_plt, DoneList *);
 129 static void trace_loaded_objects(Obj_Entry *obj);
 130 static void unlink_object(Obj_Entry *);
 131 static void unload_object(Obj_Entry *);
 132 static void unref_dag(Obj_Entry *);
 133
 134 void r_debug_state(struct r_debug*, struct link_map*);
 135
 136 /*
 137  * Data declarations.
 138  */
 139 static char *error_message;     /* Message for dlerror(), or NULL */
 140 struct r_debug r_debug;         /* for GDB; */
 141 static bool trust;              /* False for setuid and setgid programs */
 142 static const char *ld_bind_now; /* Environment variable for immediate binding */
 143 static const char *ld_debug;    /* Environment variable for debugging */
 144 static const char *ld_library_path; /* Environment variable for search path */
 145 static char *ld_preload;        /* Environment variable for libraries to
 146                                    load first */
 147 static const char *ld_tracing;  /* Called from ldd(1) to print libs */
 148 static Obj_Entry *obj_list;     /* Head of linked list of shared objects */
 149 static Obj_Entry **obj_tail;    /* Link field of last object in list */
 150 static Obj_Entry **preload_tail;
 151 static Obj_Entry *obj_main;     /* The main program shared object */
 152 static Obj_Entry obj_rtld;      /* The dynamic linker shared object */
 153 static unsigned int obj_count;  /* Number of objects in obj_list */
 154 static int      ld_resident;    /* Non-zero if resident */
 155 static const char *ld_ary[LD_ARY_CACHE];
 156 static int      ld_index;
 157 static Objlist initlist;
 158
 159 static Objlist list_global =    /* Objects dlopened with RTLD_GLOBAL */
 160   STAILQ_HEAD_INITIALIZER(list_global);
 161 static Objlist list_main =      /* Objects loaded at program startup */
 162   STAILQ_HEAD_INITIALIZER(list_main);
 163 static Objlist list_fini =      /* Objects needing fini() calls */
 164   STAILQ_HEAD_INITIALIZER(list_fini);
 165
 166 static LockInfo lockinfo;
 167
 168 static Elf_Sym sym_zero;        /* For resolving undefined weak refs. */
 169
 170 #define GDB_STATE(s,m)  r_debug.r_state = s; r_debug_state(&r_debug,m);
 171
 172 extern Elf_Dyn _DYNAMIC;
 173 #pragma weak _DYNAMIC
 174
 175 /*
 176  * These are the functions the dynamic linker exports to application
 177  * programs.  They are the only symbols the dynamic linker is willing
 178  * to export from itself.
 179  */
 180 static func_ptr_type exports[] = {
 181     (func_ptr_type) &_rtld_error,
 182     (func_ptr_type) &dlclose,
 183     (func_ptr_type) &dlerror,
 184     (func_ptr_type) &dlopen,
 185     (func_ptr_type) &dlsym,
 186     (func_ptr_type) &dladdr,
 187     (func_ptr_type) &dlinfo,
 188 #ifdef __i386__
 189     (func_ptr_type) &___tls_get_addr,
 190 #endif
 191     (func_ptr_type) &__tls_get_addr,
 192     (func_ptr_type) &__tls_get_addr_tcb,
 193     (func_ptr_type) &_rtld_allocate_tls,
 194     (func_ptr_type) &_rtld_free_tls,
 195     (func_ptr_type) &_rtld_call_init,
 196     NULL
 197 };
 198
 199 /*
 200  * Global declarations normally provided by crt1.  The dynamic linker is
 201  * not built with crt1, so we have to provide them ourselves.
 202  */
 203 char *__progname;
 204 char **environ;
 205
 206 /*
 207  * Globals to control TLS allocation.
 208  */
 209 size_t tls_last_offset;         /* Static TLS offset of last module */
 210 size_t tls_last_size;           /* Static TLS size of last module */
 211 size_t tls_static_space;        /* Static TLS space allocated */
 212 int tls_dtv_generation = 1;     /* Used to detect when dtv size changes  */
 213 int tls_max_index = 1;          /* Largest module index allocated */
 214
 215 /*
 216  * Fill in a DoneList with an allocation large enough to hold all of
 217  * the currently-loaded objects.  Keep this as a macro since it calls
 218  * alloca and we want that to occur within the scope of the caller.
 219  */
 220 #define donelist_init(dlp)                                      \
 221     ((dlp)->objs = alloca(obj_count * sizeof (dlp)->objs[0]),   \
 222     assert((dlp)->objs != NULL),                                \
 223     (dlp)->num_alloc = obj_count,                               \
 224     (dlp)->num_used = 0)
 225
 226 static __inline void
 227 rlock_acquire(void)
 228 {
 229     lockinfo.rlock_acquire(lockinfo.thelock);
 230     atomic_incr_int(&lockinfo.rcount);
 231     lock_check();
 232 }
 233
 234 static __inline void
 235 wlock_acquire(void)
 236 {
 237     lockinfo.wlock_acquire(lockinfo.thelock);
 238     atomic_incr_int(&lockinfo.wcount);
 239     lock_check();
 240 }
 241
 242 static __inline void
 243 rlock_release(void)
 244 {
 245     atomic_decr_int(&lockinfo.rcount);
 246     lockinfo.rlock_release(lockinfo.thelock);
 247 }
 248
 249 static __inline void
 250 wlock_release(void)
 251 {
 252     atomic_decr_int(&lockinfo.wcount);
 253     lockinfo.wlock_release(lockinfo.thelock);
 254 }
 255
 256 /*
 257  * Main entry point for dynamic linking.  The first argument is the
 258  * stack pointer.  The stack is expected to be laid out as described
 259  * in the SVR4 ABI specification, Intel 386 Processor Supplement.
 260  * Specifically, the stack pointer points to a word containing
 261  * ARGC.  Following that in the stack is a null-terminated sequence
 262  * of pointers to argument strings.  Then comes a null-terminated
 263  * sequence of pointers to environment strings.  Finally, there is a
 264  * sequence of "auxiliary vector" entries.
 265  *
 266  * The second argument points to a place to store the dynamic linker's
 267  * exit procedure pointer and the third to a place to store the main
 268  * program's object.
 269  *
 270  * The return value is the main program's entry point.
 271  */
 272
 273 func_ptr_type
 274 _rtld(Elf_Addr *sp, func_ptr_type *exit_proc, Obj_Entry **objp)
 275 {
 276     Elf_Auxinfo *aux_info[AT_COUNT];
 277     int i;
 278     int argc;
 279     char **argv;
 280     char **env;
 281     Elf_Auxinfo *aux;
 282     Elf_Auxinfo *auxp;
 283     const char *argv0;
 284     Objlist_Entry *entry;
 285     Obj_Entry *obj;
 286
 287     ld_index = 0;       /* don't use old env cache in case we are resident */
 288
 289     /*
 290      * On entry, the dynamic linker itself has not been relocated yet.
 291      * Be very careful not to reference any global data until after
 292      * init_rtld has returned.  It is OK to reference file-scope statics
 293      * and string constants, and to call static and global functions.
 294      */
 295
 296     /* Find the auxiliary vector on the stack. */
 297     argc = *sp++;
 298     argv = (char **) sp;
 299     sp += argc + 1;     /* Skip over arguments and NULL terminator */
 300     env = (char **) sp;
 301
 302     /*
 303      * If we aren't already resident we have to dig out some more info.
 304      * Note that auxinfo does not exist when we are resident.
 305      */
 306     if (ld_resident == 0) {
 307         while (*sp++ != 0)      /* Skip over environment, and NULL terminator */
 308             ;
 309         aux = (Elf_Auxinfo *) sp;
 310
 311         /* Digest the auxiliary vector. */
 312         for (i = 0;  i < AT_COUNT;  i++)
 313             aux_info[i] = NULL;
 314         for (auxp = aux;  auxp->a_type != AT_NULL;  auxp++) {
 315             if (auxp->a_type < AT_COUNT)
 316                 aux_info[auxp->a_type] = auxp;
 317         }
 318
 319         /* Initialize and relocate ourselves. */
 320         assert(aux_info[AT_BASE] != NULL);
 321         init_rtld((caddr_t) aux_info[AT_BASE]->a_un.a_ptr);
 322     }
 323
 324     __progname = obj_rtld.path;
 325     argv0 = argv[0] != NULL ? argv[0] : "(null)";
 326     environ = env;
 327
 328     trust = (geteuid() == getuid()) && (getegid() == getgid());
 329
 330     ld_bind_now = _getenv_ld("LD_BIND_NOW");
 331     if (trust) {
 332         ld_debug = _getenv_ld("LD_DEBUG");
 333         ld_library_path = _getenv_ld("LD_LIBRARY_PATH");
 334         ld_preload = (char *)_getenv_ld("LD_PRELOAD");
 335     }
 336     ld_tracing = _getenv_ld("LD_TRACE_LOADED_OBJECTS");
 337
 338     if (ld_debug != NULL && *ld_debug != '\0')
 339         debug = 1;
 340     dbg("%s is initialized, base address = %p", __progname,
 341         (caddr_t) aux_info[AT_BASE]->a_un.a_ptr);
 342     dbg("RTLD dynamic = %p", obj_rtld.dynamic);
 343     dbg("RTLD pltgot  = %p", obj_rtld.pltgot);
 344
 345     /*
 346      * If we are resident we can skip work that we have already done.
 347      * Note that the stack is reset and there is no Elf_Auxinfo
 348      * when running from a resident image, and the static globals setup
 349      * between here and resident_skip will have already been setup.
 350      */
 351     if (ld_resident)
 352         goto resident_skip1;
 353
 354     /*
 355      * Load the main program, or process its program header if it is
 356      * already loaded.
 357      */
 358     if (aux_info[AT_EXECFD] != NULL) {  /* Load the main program. */
 359         int fd = aux_info[AT_EXECFD]->a_un.a_val;
 360         dbg("loading main program");
 361         obj_main = map_object(fd, argv0, NULL);
 362         close(fd);
 363         if (obj_main == NULL)
 364             die();
 365     } else {                            /* Main program already loaded. */
 366         const Elf_Phdr *phdr;
 367         int phnum;
 368         caddr_t entry;
 369
 370         dbg("processing main program's program header");
 371         assert(aux_info[AT_PHDR] != NULL);
 372         phdr = (const Elf_Phdr *) aux_info[AT_PHDR]->a_un.a_ptr;
 373         assert(aux_info[AT_PHNUM] != NULL);
 374         phnum = aux_info[AT_PHNUM]->a_un.a_val;
 375         assert(aux_info[AT_PHENT] != NULL);
 376         assert(aux_info[AT_PHENT]->a_un.a_val == sizeof(Elf_Phdr));
 377         assert(aux_info[AT_ENTRY] != NULL);
 378         entry = (caddr_t) aux_info[AT_ENTRY]->a_un.a_ptr;
 379         if ((obj_main = digest_phdr(phdr, phnum, entry, argv0)) == NULL)
 380             die();
 381     }
 382
 383     obj_main->path = xstrdup(argv0);
 384     obj_main->mainprog = true;
 385
 386     /*
 387      * Get the actual dynamic linker pathname from the executable if
 388      * possible.  (It should always be possible.)  That ensures that
 389      * gdb will find the right dynamic linker even if a non-standard
 390      * one is being used.
 391      */
 392     if (obj_main->interp != NULL &&
 393       strcmp(obj_main->interp, obj_rtld.path) != 0) {
 394         free(obj_rtld.path);
 395         obj_rtld.path = xstrdup(obj_main->interp);
 396         __progname = obj_rtld.path;
 397     }
 398
 399     digest_dynamic(obj_main, 0);
 400
 401     linkmap_add(obj_main);
 402     linkmap_add(&obj_rtld);
 403
 404     /* Link the main program into the list of objects. */
 405     *obj_tail = obj_main;
 406     obj_tail = &obj_main->next;
 407     obj_count++;
 408     obj_main->refcount++;
 409     /* Make sure we don't call the main program's init and fini functions. */
 410     obj_main->init = obj_main->fini = NULL;
 411
 412     /* Initialize a fake symbol for resolving undefined weak references. */
 413     sym_zero.st_info = ELF_ST_INFO(STB_GLOBAL, STT_NOTYPE);
 414     sym_zero.st_shndx = SHN_ABS;
 415
 416     dbg("loading LD_PRELOAD libraries");
 417     if (load_preload_objects() == -1)
 418         die();
 419     preload_tail = obj_tail;
 420
 421     dbg("loading needed objects");
 422     if (load_needed_objects(obj_main) == -1)
 423         die();
 424
 425     /* Make a list of all objects loaded at startup. */
 426     for (obj = obj_list;  obj != NULL;  obj = obj->next)
 427         objlist_push_tail(&list_main, obj);
 428
 429 resident_skip1:
 430
 431     if (ld_tracing) {           /* We're done */
 432         trace_loaded_objects(obj_main);
 433         exit(0);
 434     }
 435
 436     if (ld_resident)            /* XXX clean this up! */
 437         goto resident_skip2;
 438
 439     if (getenv("LD_DUMP_REL_PRE") != NULL) {
 440        dump_relocations(obj_main);
 441        exit (0);
 442     }
 443
 444     /* setup TLS for main thread */
 445     dbg("initializing initial thread local storage");
 446     STAILQ_FOREACH(entry, &list_main, link) {
 447         /*
 448          * Allocate all the initial objects out of the static TLS
 449          * block even if they didn't ask for it.
 450          */
 451         allocate_tls_offset(entry->obj);
 452     }
 453
 454     tls_static_space = tls_last_offset + RTLD_STATIC_TLS_EXTRA;
 455
 456     /*
 457      * Do not try to allocate the TLS here, let libc do it itself.
 458      * (crt1 for the program will call _init_tls())
 459      */
 460
 461     if (relocate_objects(obj_main,
 462         ld_bind_now != NULL && *ld_bind_now != '\0', &obj_rtld) == -1)
 463         die();
 464
 465     dbg("doing copy relocations");
 466     if (do_copy_relocations(obj_main) == -1)
 467         die();
 468
 469 resident_skip2:
 470
 471     if (_getenv_ld("LD_RESIDENT_UNREGISTER_NOW")) {
 472         if (exec_sys_unregister(-1) < 0) {
 473             dbg("exec_sys_unregister failed %d\n", errno);
 474             exit(errno);
 475         }
 476         dbg("exec_sys_unregister success\n");
 477         exit(0);
 478     }
 479
 480     if (getenv("LD_DUMP_REL_POST") != NULL) {
 481        dump_relocations(obj_main);
 482        exit (0);
 483     }
 484
 485     dbg("initializing key program variables");
 486     set_program_var("__progname", argv[0] != NULL ? basename(argv[0]) : "");
 487     set_program_var("environ", env);
 488
 489     if (_getenv_ld("LD_RESIDENT_REGISTER_NOW")) {
 490         extern void resident_start(void);
 491         ld_resident = 1;
 492         if (exec_sys_register(resident_start) < 0) {
 493             dbg("exec_sys_register failed %d\n", errno);
 494             exit(errno);
 495         }
 496         dbg("exec_sys_register success\n");
 497         exit(0);
 498     }
 499
 500     dbg("initializing thread locks");
 501     lockdflt_init(&lockinfo);
 502     lockinfo.thelock = lockinfo.lock_create(lockinfo.context);
 503
 504     /* Make a list of init functions to call. */
 505     objlist_init(&initlist);
 506     initlist_add_objects(obj_list, preload_tail, &initlist);
 507
 508     r_debug_state(NULL, &obj_main->linkmap); /* say hello to gdb! */
 509
 510     /*
 511      * Do NOT call the initlist here, give libc a chance to set up
 512      * the initial TLS segment.  crt1 will then call _rtld_call_init().
 513      */
 514
 515     dbg("transferring control to program entry point = %p", obj_main->entry);
 516
 517     /* Return the exit procedure and the program entry point. */
 518     *exit_proc = rtld_exit;
 519     *objp = obj_main;
 520     return (func_ptr_type) obj_main->entry;
 521 }
 522
 523 /*
 524  * Call the initialization list for dynamically loaded libraries.
 525  * (called from crt1.c).
 526  */
 527 void
 528 _rtld_call_init(void)
 529 {
 530     objlist_call_init(&initlist);
 531     wlock_acquire();
 532     objlist_clear(&initlist);
 533     wlock_release();
 534 }
 535
 536 Elf_Addr
 537 _rtld_bind(Obj_Entry *obj, Elf_Word reloff)
 538 {
 539     const Elf_Rel *rel;
 540     const Elf_Sym *def;
 541     const Obj_Entry *defobj;
 542     Elf_Addr *where;
 543     Elf_Addr target;
 544
 545     rlock_acquire();
 546     if (obj->pltrel)
 547         rel = (const Elf_Rel *) ((caddr_t) obj->pltrel + reloff);
 548     else
 549         rel = (const Elf_Rel *) ((caddr_t) obj->pltrela + reloff);
 550
 551     where = (Elf_Addr *) (obj->relocbase + rel->r_offset);
 552     def = find_symdef(ELF_R_SYM(rel->r_info), obj, &defobj, true, NULL);
 553     if (def == NULL)
 554         die();
 555
 556     target = (Elf_Addr)(defobj->relocbase + def->st_value);
 557
 558     dbg("\"%s\" in \"%s\" ==> %p in \"%s\"",
 559       defobj->strtab + def->st_name, basename(obj->path),
 560       (void *)target, basename(defobj->path));
 561
 562     reloc_jmpslot(where, target);
 563     rlock_release();
 564     return target;
 565 }
 566
 567 /*
 568  * Error reporting function.  Use it like printf.  If formats the message
 569  * into a buffer, and sets things up so that the next call to dlerror()
 570  * will return the message.
 571  */
 572 void
 573 _rtld_error(const char *fmt, ...)
 574 {
 575     static char buf[512];
 576     va_list ap;
 577
 578     va_start(ap, fmt);
 579     vsnprintf(buf, sizeof buf, fmt, ap);
 580     error_message = buf;
 581     va_end(ap);
 582 }
 583
 584 /*
 585  * Return a dynamically-allocated copy of the current error message, if any.
 586  */
 587 static char *
 588 errmsg_save(void)
 589 {
 590     return error_message == NULL ? NULL : xstrdup(error_message);
 591 }
 592
 593 /*
 594  * Restore the current error message from a copy which was previously saved
 595  * by errmsg_save().  The copy is freed.
 596  */
 597 static void
 598 errmsg_restore(char *saved_msg)
 599 {
 600     if (saved_msg == NULL)
 601         error_message = NULL;
 602     else {
 603         _rtld_error("%s", saved_msg);
 604         free(saved_msg);
 605     }
 606 }
 607
 608 const char *
 609 basename(const char *name)
 610 {
 611     const char *p = strrchr(name, '/');
 612     return p != NULL ? p + 1 : name;
 613 }
 614
 615 static void
 616 die(void)
 617 {
 618     const char *msg = dlerror();
 619
 620     if (msg == NULL)
 621         msg = "Fatal error";
 622     errx(1, "%s", msg);
 623 }
 624
 625 /*
 626  * Process a shared object's DYNAMIC section, and save the important
 627  * information in its Obj_Entry structure.
 628  */
 629 static void
 630 digest_dynamic(Obj_Entry *obj, int early)
 631 {
 632     const Elf_Dyn *dynp;
 633     Needed_Entry **needed_tail = &obj->needed;
 634     const Elf_Dyn *dyn_rpath = NULL;
 635     int plttype = DT_REL;
 636
 637     for (dynp = obj->dynamic;  dynp->d_tag != DT_NULL;  dynp++) {
 638         switch (dynp->d_tag) {
 639
 640         case DT_REL:
 641             obj->rel = (const Elf_Rel *) (obj->relocbase + dynp->d_un.d_ptr);
 642             break;
 643
 644         case DT_RELSZ:
 645             obj->relsize = dynp->d_un.d_val;
 646             break;
 647
 648         case DT_RELENT:
 649             assert(dynp->d_un.d_val == sizeof(Elf_Rel));
 650             break;
 651
 652         case DT_JMPREL:
 653             obj->pltrel = (const Elf_Rel *)
 654               (obj->relocbase + dynp->d_un.d_ptr);
 655             break;
 656
 657         case DT_PLTRELSZ:
 658             obj->pltrelsize = dynp->d_un.d_val;
 659             break;
 660
 661         case DT_RELA:
 662             obj->rela = (const Elf_Rela *) (obj->relocbase + dynp->d_un.d_ptr);
 663             break;
 664
 665         case DT_RELASZ:
 666             obj->relasize = dynp->d_un.d_val;
 667             break;
 668
 669         case DT_RELAENT:
 670             assert(dynp->d_un.d_val == sizeof(Elf_Rela));
 671             break;
 672
 673         case DT_PLTREL:
 674             plttype = dynp->d_un.d_val;
 675             assert(dynp->d_un.d_val == DT_REL || plttype == DT_RELA);
 676             break;
 677
 678         case DT_SYMTAB:
 679             obj->symtab = (const Elf_Sym *)
 680               (obj->relocbase + dynp->d_un.d_ptr);
 681             break;
 682
 683         case DT_SYMENT:
 684             assert(dynp->d_un.d_val == sizeof(Elf_Sym));
 685             break;
 686
 687         case DT_STRTAB:
 688             obj->strtab = (const char *) (obj->relocbase + dynp->d_un.d_ptr);
 689             break;
 690
 691         case DT_STRSZ:
 692             obj->strsize = dynp->d_un.d_val;
 693             break;
 694
 695         case DT_HASH:
 696             {
 697                 const Elf_Addr *hashtab = (const Elf_Addr *)
 698                   (obj->relocbase + dynp->d_un.d_ptr);
 699                 obj->nbuckets = hashtab[0];
 700                 obj->nchains = hashtab[1];
 701                 obj->buckets = hashtab + 2;
 702                 obj->chains = obj->buckets + obj->nbuckets;
 703             }
 704             break;
 705
 706         case DT_NEEDED:
 707             if (!obj->rtld) {
 708                 Needed_Entry *nep = NEW(Needed_Entry);
 709                 nep->name = dynp->d_un.d_val;
 710                 nep->obj = NULL;
 711                 nep->next = NULL;
 712
 713                 *needed_tail = nep;
 714                 needed_tail = &nep->next;
 715             }
 716             break;
 717
 718         case DT_PLTGOT:
 719             obj->pltgot = (Elf_Addr *) (obj->relocbase + dynp->d_un.d_ptr);
 720             break;
 721
 722         case DT_TEXTREL:
 723             obj->textrel = true;
 724             break;
 725
 726         case DT_SYMBOLIC:
 727             obj->symbolic = true;
 728             break;
 729
 730         case DT_RPATH:
 731         case DT_RUNPATH:        /* XXX: process separately */
 732             /*
 733              * We have to wait until later to process this, because we
 734              * might not have gotten the address of the string table yet.
 735              */
 736             dyn_rpath = dynp;
 737             break;
 738
 739         case DT_SONAME:
 740             /* Not used by the dynamic linker. */
 741             break;
 742
 743         case DT_INIT:
 744             obj->init = (InitFunc) (obj->relocbase + dynp->d_un.d_ptr);
 745             break;
 746
 747         case DT_FINI:
 748             obj->fini = (InitFunc) (obj->relocbase + dynp->d_un.d_ptr);
 749             break;
 750
 751         case DT_DEBUG:
 752             /* XXX - not implemented yet */
 753             if (!early)
 754                 dbg("Filling in DT_DEBUG entry");
 755             ((Elf_Dyn*)dynp)->d_un.d_ptr = (Elf_Addr) &r_debug;
 756             break;
 757
 758         case DT_FLAGS:
 759                 if (dynp->d_un.d_val & DF_ORIGIN) {
 760                     obj->origin_path = xmalloc(PATH_MAX);
 761                     if (rtld_dirname(obj->path, obj->origin_path) == -1)
 762                         die();
 763                 }
 764                 if (dynp->d_un.d_val & DF_SYMBOLIC)
 765                     obj->symbolic = true;
 766                 if (dynp->d_un.d_val & DF_TEXTREL)
 767                     obj->textrel = true;
 768                 if (dynp->d_un.d_val & DF_BIND_NOW)
 769                     obj->bind_now = true;
 770                 if (dynp->d_un.d_val & DF_STATIC_TLS)
 771                     ;
 772             break;
 773
 774         default:
 775             if (!early)
 776                 dbg("Ignoring d_tag %d = %#x", dynp->d_tag, dynp->d_tag);
 777             break;
 778         }
 779     }
 780
 781     obj->traced = false;
 782
 783     if (plttype == DT_RELA) {
 784         obj->pltrela = (const Elf_Rela *) obj->pltrel;
 785         obj->pltrel = NULL;
 786         obj->pltrelasize = obj->pltrelsize;
 787         obj->pltrelsize = 0;
 788     }
 789
 790     if (dyn_rpath != NULL)
 791         obj->rpath = obj->strtab + dyn_rpath->d_un.d_val;
 792 }
 793
 794 /*
 795  * Process a shared object's program header.  This is used only for the
 796  * main program, when the kernel has already loaded the main program
 797  * into memory before calling the dynamic linker.  It creates and
 798  * returns an Obj_Entry structure.
 799  */
 800 static Obj_Entry *
 801 digest_phdr(const Elf_Phdr *phdr, int phnum, caddr_t entry, const char *path)
 802 {
 803     Obj_Entry *obj;
 804     const Elf_Phdr *phlimit = phdr + phnum;
 805     const Elf_Phdr *ph;
 806     int nsegs = 0;
 807
 808     obj = obj_new();
 809     for (ph = phdr;  ph < phlimit;  ph++) {
 810         switch (ph->p_type) {
 811
 812         case PT_PHDR:
 813             if ((const Elf_Phdr *)ph->p_vaddr != phdr) {
 814                 _rtld_error("%s: invalid PT_PHDR", path);
 815                 return NULL;
 816             }
 817             obj->phdr = (const Elf_Phdr *) ph->p_vaddr;
 818             obj->phsize = ph->p_memsz;
 819             break;
 820
 821         case PT_INTERP:
 822             obj->interp = (const char *) ph->p_vaddr;
 823             break;
 824
 825         case PT_LOAD:
 826             if (nsegs == 0) {   /* First load segment */
 827                 obj->vaddrbase = trunc_page(ph->p_vaddr);
 828                 obj->mapbase = (caddr_t) obj->vaddrbase;
 829                 obj->relocbase = obj->mapbase - obj->vaddrbase;
 830                 obj->textsize = round_page(ph->p_vaddr + ph->p_memsz) -
 831                   obj->vaddrbase;
 832             } else {            /* Last load segment */
 833                 obj->mapsize = round_page(ph->p_vaddr + ph->p_memsz) -
 834                   obj->vaddrbase;
 835             }
 836             nsegs++;
 837             break;
 838
 839         case PT_DYNAMIC:
 840             obj->dynamic = (const Elf_Dyn *) ph->p_vaddr;
 841             break;
 842
 843         case PT_TLS:
 844             obj->tlsindex = 1;
 845             obj->tlssize = ph->p_memsz;
 846             obj->tlsalign = ph->p_align;
 847             obj->tlsinitsize = ph->p_filesz;
 848             obj->tlsinit = (void*) ph->p_vaddr;
 849             break;
 850         }
 851     }
 852     if (nsegs < 1) {
 853         _rtld_error("%s: too few PT_LOAD segments", path);
 854         return NULL;
 855     }
 856
 857     obj->entry = entry;
 858     return obj;
 859 }
 860
 861 static Obj_Entry *
 862 dlcheck(void *handle)
 863 {
 864     Obj_Entry *obj;
 865
 866     for (obj = obj_list;  obj != NULL;  obj = obj->next)
 867         if (obj == (Obj_Entry *) handle)
 868             break;
 869
 870     if (obj == NULL || obj->refcount == 0 || obj->dl_refcount == 0) {
 871         _rtld_error("Invalid shared object handle %p", handle);
 872         return NULL;
 873     }
 874     return obj;
 875 }
 876
 877 /*
 878  * If the given object is already in the donelist, return true.  Otherwise
 879  * add the object to the list and return false.
 880  */
 881 static bool
 882 donelist_check(DoneList *dlp, const Obj_Entry *obj)
 883 {
 884     unsigned int i;
 885
 886     for (i = 0;  i < dlp->num_used;  i++)
 887         if (dlp->objs[i] == obj)
 888             return true;
 889     /*
 890      * Our donelist allocation should always be sufficient.  But if
 891      * our threads locking isn't working properly, more shared objects
 892      * could have been loaded since we allocated the list.  That should
 893      * never happen, but we'll handle it properly just in case it does.
 894      */
 895     if (dlp->num_used < dlp->num_alloc)
 896         dlp->objs[dlp->num_used++] = obj;
 897     return false;
 898 }
 899
 900 /*
 901  * Hash function for symbol table lookup.  Don't even think about changing
 902  * this.  It is specified by the System V ABI.
 903  */
 904 unsigned long
 905 elf_hash(const char *name)
 906 {
 907     const unsigned char *p = (const unsigned char *) name;
 908     unsigned long h = 0;
 909     unsigned long g;
 910
 911     while (*p != '\0') {
 912         h = (h << 4) + *p++;
 913         if ((g = h & 0xf0000000) != 0)
 914             h ^= g >> 24;
 915         h &= ~g;
 916     }
 917     return h;
 918 }
 919
 920 /*
 921  * Find the library with the given name, and return its full pathname.
 922  * The returned string is dynamically allocated.  Generates an error
 923  * message and returns NULL if the library cannot be found.
 924  *
 925  * If the second argument is non-NULL, then it refers to an already-
 926  * loaded shared object, whose library search path will be searched.
 927  *
 928  * The search order is:
 929  *   LD_LIBRARY_PATH
 930  *   rpath in the referencing file
 931  *   ldconfig hints
 932  *   /usr/lib
 933  */
 934 static char *
 935 find_library(const char *name, const Obj_Entry *refobj)
 936 {
 937     char *pathname;
 938
 939     if (strchr(name, '/') != NULL) {    /* Hard coded pathname */
 940         if (name[0] != '/' && !trust) {
 941             _rtld_error("Absolute pathname required for shared object \"%s\"",
 942               name);
 943             return NULL;
 944         }
 945         return xstrdup(name);
 946     }
 947
 948     dbg(" Searching for \"%s\"", name);
 949
 950     if ((pathname = search_library_path(name, ld_library_path)) != NULL ||
 951       (refobj != NULL &&
 952       (pathname = search_library_path(name, refobj->rpath)) != NULL) ||
 953       (pathname = search_library_path(name, gethints())) != NULL ||
 954       (pathname = search_library_path(name, STANDARD_LIBRARY_PATH)) != NULL)
 955         return pathname;
 956
 957     if(refobj != NULL && refobj->path != NULL) {
 958         _rtld_error("Shared object \"%s\" not found, required by \"%s\"",
 959           name, basename(refobj->path));
 960     } else {
 961         _rtld_error("Shared object \"%s\" not found", name);
 962     }
 963     return NULL;
 964 }
 965
 966 /*
 967  * Given a symbol number in a referencing object, find the corresponding
 968  * definition of the symbol.  Returns a pointer to the symbol, or NULL if
 969  * no definition was found.  Returns a pointer to the Obj_Entry of the
 970  * defining object via the reference parameter DEFOBJ_OUT.
 971  */
 972 const Elf_Sym *
 973 find_symdef(unsigned long symnum, const Obj_Entry *refobj,
 974     const Obj_Entry **defobj_out, bool in_plt, SymCache *cache)
 975 {
 976     const Elf_Sym *ref;
 977     const Elf_Sym *def;
 978     const Obj_Entry *defobj;
 979     const char *name;
 980     unsigned long hash;
 981
 982     /*
 983      * If we have already found this symbol, get the information from
 984      * the cache.
 985      */
 986     if (symnum >= refobj->nchains)
 987         return NULL;    /* Bad object */
 988     if (cache != NULL && cache[symnum].sym != NULL) {
 989         *defobj_out = cache[symnum].obj;
 990         return cache[symnum].sym;
 991     }
 992
 993     ref = refobj->symtab + symnum;
 994     name = refobj->strtab + ref->st_name;
 995     hash = elf_hash(name);
 996     defobj = NULL;
 997
 998     /* Handle STT_SECTION specially. */
 999     if (ELF_ST_TYPE(ref->st_info) == STT_SECTION) {
1000         if (ELF_ST_BIND(ref->st_info) != STB_LOCAL ||
1001             ref->st_shndx != symnum) {
1002             _rtld_error("%s: Bogus symbol table entry %lu", refobj->path,
1003                 symnum);
1004         }
1005         def = ref;
1006         defobj = refobj;
1007     } else
1008         def = symlook_default(name, hash, refobj, &defobj, in_plt);
1009
1010     /*
1011      * If we found no definition and the reference is weak, treat the
1012      * symbol as having the value zero.
1013      */
1014     if (def == NULL && ELF_ST_BIND(ref->st_info) == STB_WEAK) {
1015         def = &sym_zero;
1016         defobj = obj_main;
1017     }
1018
1019     if (def != NULL) {
1020         *defobj_out = defobj;
1021         /* Record the information in the cache to avoid subsequent lookups. */
1022         if (cache != NULL) {
1023             cache[symnum].sym = def;
1024             cache[symnum].obj = defobj;
1025         }
1026     } else
1027         _rtld_error("%s: Undefined symbol \"%s\"", refobj->path, name);
1028     return def;
1029 }
1030
1031 /*
1032  * Return the search path from the ldconfig hints file, reading it if
1033  * necessary.  Returns NULL if there are problems with the hints file,
1034  * or if the search path there is empty.
1035  */
1036 static const char *
1037 gethints(void)
1038 {
1039     static char *hints;
1040
1041     if (hints == NULL) {
1042         int fd;
1043         struct elfhints_hdr hdr;
1044         char *p;
1045
1046         /* Keep from trying again in case the hints file is bad. */
1047         hints = "";
1048
1049         if ((fd = open(_PATH_ELF_HINTS, O_RDONLY)) == -1)
1050             return NULL;
1051         if (read(fd, &hdr, sizeof hdr) != sizeof hdr ||
1052           hdr.magic != ELFHINTS_MAGIC ||
1053           hdr.version != 1) {
1054             close(fd);
1055             return NULL;
1056         }
1057         p = xmalloc(hdr.dirlistlen + 1);
1058         if (lseek(fd, hdr.strtab + hdr.dirlist, SEEK_SET) == -1 ||
1059           read(fd, p, hdr.dirlistlen + 1) != hdr.dirlistlen + 1) {
1060             free(p);
1061             close(fd);
1062             return NULL;
1063         }
1064         hints = p;
1065         close(fd);
1066     }
1067     return hints[0] != '\0' ? hints : NULL;
1068 }
1069
1070 static void
1071 init_dag(Obj_Entry *root)
1072 {
1073     DoneList donelist;
1074
1075     donelist_init(&donelist);
1076     init_dag1(root, root, &donelist);
1077 }
1078
1079 static void
1080 init_dag1(Obj_Entry *root, Obj_Entry *obj, DoneList *dlp)
1081 {
1082     const Needed_Entry *needed;
1083
1084     if (donelist_check(dlp, obj))
1085         return;
1086     objlist_push_tail(&obj->dldags, root);
1087     objlist_push_tail(&root->dagmembers, obj);
1088     for (needed = obj->needed;  needed != NULL;  needed = needed->next)
1089         if (needed->obj != NULL)
1090             init_dag1(root, needed->obj, dlp);
1091 }
1092
1093 /*
1094  * Initialize the dynamic linker.  The argument is the address at which
1095  * the dynamic linker has been mapped into memory.  The primary task of
1096  * this function is to relocate the dynamic linker.
1097  */
1098 static void
1099 init_rtld(caddr_t mapbase)
1100 {
1101     Obj_Entry objtmp;   /* Temporary rtld object */
1102
1103     /*
1104      * Conjure up an Obj_Entry structure for the dynamic linker.
1105      *
1106      * The "path" member can't be initialized yet because string constatns
1107      * cannot yet be acessed. Below we will set it correctly.
1108      */
1109     objtmp.path = NULL;
1110     objtmp.rtld = true;
1111     objtmp.mapbase = mapbase;
1112 #ifdef PIC
1113     objtmp.relocbase = mapbase;
1114 #endif
1115     if (&_DYNAMIC != 0) {
1116         objtmp.dynamic = rtld_dynamic(&objtmp);
1117         digest_dynamic(&objtmp, 1);
1118         assert(objtmp.needed == NULL);
1119         assert(!objtmp.textrel);
1120
1121         /*
1122          * Temporarily put the dynamic linker entry into the object list, so
1123          * that symbols can be found.
1124          */
1125
1126         relocate_objects(&objtmp, true, &objtmp);
1127     }
1128
1129     /* Initialize the object list. */
1130     obj_tail = &obj_list;
1131
1132     /* Now that non-local variables can be accesses, copy out obj_rtld. */
1133     memcpy(&obj_rtld, &objtmp, sizeof(obj_rtld));
1134
1135     /* Replace the path with a dynamically allocated copy. */
1136     obj_rtld.path = xstrdup(PATH_RTLD);
1137
1138     r_debug.r_brk = r_debug_state;
1139     r_debug.r_state = RT_CONSISTENT;
1140 }
1141
1142 /*
1143  * Add the init functions from a needed object list (and its recursive
1144  * needed objects) to "list".  This is not used directly; it is a helper
1145  * function for initlist_add_objects().  The write lock must be held
1146  * when this function is called.
1147  */
1148 static void
1149 initlist_add_neededs(Needed_Entry *needed, Objlist *list)
1150 {
1151     /* Recursively process the successor needed objects. */
1152     if (needed->next != NULL)
1153         initlist_add_neededs(needed->next, list);
1154
1155     /* Process the current needed object. */
1156     if (needed->obj != NULL)
1157         initlist_add_objects(needed->obj, &needed->obj->next, list);
1158 }
1159
1160 /*
1161  * Scan all of the DAGs rooted in the range of objects from "obj" to
1162  * "tail" and add their init functions to "list".  This recurses over
1163  * the DAGs and ensure the proper init ordering such that each object's
1164  * needed libraries are initialized before the object itself.  At the
1165  * same time, this function adds the objects to the global finalization
1166  * list "list_fini" in the opposite order.  The write lock must be
1167  * held when this function is called.
1168  */
1169 static void
1170 initlist_add_objects(Obj_Entry *obj, Obj_Entry **tail, Objlist *list)
1171 {
1172     if (obj->init_done)
1173         return;
1174     obj->init_done = true;
1175
1176     /* Recursively process the successor objects. */
1177     if (&obj->next != tail)
1178         initlist_add_objects(obj->next, tail, list);
1179
1180     /* Recursively process the needed objects. */
1181     if (obj->needed != NULL)
1182         initlist_add_neededs(obj->needed, list);
1183
1184     /* Add the object to the init list. */
1185     if (obj->init != NULL)
1186         objlist_push_tail(list, obj);
1187
1188     /* Add the object to the global fini list in the reverse order. */
1189     if (obj->fini != NULL)
1190         objlist_push_head(&list_fini, obj);
1191 }
1192
1193 static bool
1194 is_exported(const Elf_Sym *def)
1195 {
1196     func_ptr_type value;
1197     const func_ptr_type *p;
1198
1199     value = (func_ptr_type)(obj_rtld.relocbase + def->st_value);
1200     for (p = exports;  *p != NULL;  p++)
1201         if (*p == value)
1202             return true;
1203     return false;
1204 }
1205
1206 /*
1207  * Given a shared object, traverse its list of needed objects, and load
1208  * each of them.  Returns 0 on success.  Generates an error message and
1209  * returns -1 on failure.
1210  */
1211 static int
1212 load_needed_objects(Obj_Entry *first)
1213 {
1214     Obj_Entry *obj;
1215
1216     for (obj = first;  obj != NULL;  obj = obj->next) {
1217         Needed_Entry *needed;
1218
1219         for (needed = obj->needed;  needed != NULL;  needed = needed->next) {
1220             const char *name = obj->strtab + needed->name;
1221             char *path = find_library(name, obj);
1222
1223             needed->obj = NULL;
1224             if (path == NULL && !ld_tracing)
1225                 return -1;
1226
1227             if (path) {
1228                 needed->obj = load_object(path);
1229                 if (needed->obj == NULL && !ld_tracing)
1230                     return -1;          /* XXX - cleanup */
1231             }
1232         }
1233     }
1234
1235     return 0;
1236 }
1237
1238 static int
1239 load_preload_objects(void)
1240 {
1241     char *p = ld_preload;
1242     static const char delim[] = " \t:;";
1243
1244     if (p == NULL)
1245         return NULL;
1246
1247     p += strspn(p, delim);
1248     while (*p != '\0') {
1249         size_t len = strcspn(p, delim);
1250         char *path;
1251         char savech;
1252
1253         savech = p[len];
1254         p[len] = '\0';
1255         if ((path = find_library(p, NULL)) == NULL)
1256             return -1;
1257         if (load_object(path) == NULL)
1258             return -1;  /* XXX - cleanup */
1259         p[len] = savech;
1260         p += len;
1261         p += strspn(p, delim);
1262     }
1263     return 0;
1264 }
1265
1266 /*
1267  * Returns a pointer to the Obj_Entry for the object with the given path.
1268  * Returns NULL if no matching object was found.
1269  */
1270 static Obj_Entry *
1271 find_object(const char *path)
1272 {
1273     Obj_Entry *obj;
1274
1275     for (obj = obj_list->next;  obj != NULL;  obj = obj->next) {
1276         if (strcmp(obj->path, path) == 0)
1277             return(obj);
1278     }
1279     return(NULL);
1280 }
1281
1282 /*
1283  * Returns a pointer to the Obj_Entry for the object matching device and
1284  * inode of the given path. If no matching object was found, the descriptor
1285  * is returned in fd.
1286  * Returns with obj == NULL && fd == -1 on error.
1287  */
1288 static Obj_Entry *
1289 find_object2(const char *path, int *fd, struct stat *sb)
1290 {
1291     Obj_Entry *obj;
1292
1293     if ((*fd = open(path, O_RDONLY)) == -1) {
1294         _rtld_error("Cannot open \"%s\"", path);
1295         return(NULL);
1296     }
1297
1298     if (fstat(*fd, sb) == -1) {
1299         _rtld_error("Cannot fstat \"%s\"", path);
1300         close(*fd);
1301         *fd = -1;
1302         return NULL;
1303     }
1304
1305     for (obj = obj_list->next;  obj != NULL;  obj = obj->next) {
1306         if (obj->ino == sb->st_ino && obj->dev == sb->st_dev) {
1307             close(*fd);
1308             break;
1309         }
1310     }
1311
1312     return(obj);
1313 }
1314
1315 /*
1316  * Load a shared object into memory, if it is not already loaded.  The
1317  * argument must be a string allocated on the heap.  This function assumes
1318  * responsibility for freeing it when necessary.
1319  *
1320  * Returns a pointer to the Obj_Entry for the object.  Returns NULL
1321  * on failure.
1322  */
1323 static Obj_Entry *
1324 load_object(char *path)
1325 {
1326     Obj_Entry *obj;
1327     int fd = -1;
1328     struct stat sb;
1329
1330     obj = find_object(path);
1331     if (obj != NULL) {
1332         obj->refcount++;
1333         free(path);
1334         return(obj);
1335     }
1336
1337     obj = find_object2(path, &fd, &sb);
1338     if (obj != NULL) {
1339         obj->refcount++;
1340         free(path);
1341         return(obj);
1342     } else if (fd == -1) {
1343         free(path);
1344         return(NULL);
1345     }
1346
1347     dbg("loading \"%s\"", path);
1348     obj = map_object(fd, path, &sb);
1349     close(fd);
1350     if (obj == NULL) {
1351         free(path);
1352         return NULL;
1353     }
1354
1355     obj->path = path;
1356     digest_dynamic(obj, 0);
1357
1358     *obj_tail = obj;
1359     obj_tail = &obj->next;
1360     obj_count++;
1361     linkmap_add(obj);   /* for GDB & dlinfo() */
1362
1363     dbg("  %p .. %p: %s", obj->mapbase, obj->mapbase + obj->mapsize - 1,
1364         obj->path);
1365     if (obj->textrel)
1366         dbg("  WARNING: %s has impure text", obj->path);
1367
1368     obj->refcount++;
1369     return obj;
1370 }
1371
1372 /*
1373  * Check for locking violations and die if one is found.
1374  */
1375 static void
1376 lock_check(void)
1377 {
1378     int rcount, wcount;
1379
1380     rcount = lockinfo.rcount;
1381     wcount = lockinfo.wcount;
1382     assert(rcount >= 0);
1383     assert(wcount >= 0);
1384     if (wcount > 1 || (wcount != 0 && rcount != 0)) {
1385         _rtld_error("Application locking error: %d readers and %d writers"
1386           " in dynamic linker.  See DLLOCKINIT(3) in manual pages.",
1387           rcount, wcount);
1388         die();
1389     }
1390 }
1391
1392 static Obj_Entry *
1393 obj_from_addr(const void *addr)
1394 {
1395     Obj_Entry *obj;
1396
1397     for (obj = obj_list;  obj != NULL;  obj = obj->next) {
1398         if (addr < (void *) obj->mapbase)
1399             continue;
1400         if (addr < (void *) (obj->mapbase + obj->mapsize))
1401             return obj;
1402     }
1403     return NULL;
1404 }
1405
1406 /*
1407  * Call the finalization functions for each of the objects in "list"
1408  * which are unreferenced.  All of the objects are expected to have
1409  * non-NULL fini functions.
1410  */
1411 static void
1412 objlist_call_fini(Objlist *list)
1413 {
1414     Objlist_Entry *elm;
1415     char *saved_msg;
1416
1417     /*
1418      * Preserve the current error message since a fini function might
1419      * call into the dynamic linker and overwrite it.
1420      */
1421     saved_msg = errmsg_save();
1422     STAILQ_FOREACH(elm, list, link) {
1423         if (elm->obj->refcount == 0) {
1424             dbg("calling fini function for %s", elm->obj->path);
1425             (*elm->obj->fini)();
1426         }
1427     }
1428     errmsg_restore(saved_msg);
1429 }
1430
1431 /*
1432  * Call the initialization functions for each of the objects in
1433  * "list".  All of the objects are expected to have non-NULL init
1434  * functions.
1435  */
1436 static void
1437 objlist_call_init(Objlist *list)
1438 {
1439     Objlist_Entry *elm;
1440     char *saved_msg;
1441
1442     /*
1443      * Preserve the current error message since an init function might
1444      * call into the dynamic linker and overwrite it.
1445      */
1446     saved_msg = errmsg_save();
1447     STAILQ_FOREACH(elm, list, link) {
1448         dbg("calling init function for %s", elm->obj->path);
1449         (*elm->obj->init)();
1450     }
1451     errmsg_restore(saved_msg);
1452 }
1453
1454 static void
1455 objlist_clear(Objlist *list)
1456 {
1457     Objlist_Entry *elm;
1458
1459     while (!STAILQ_EMPTY(list)) {
1460         elm = STAILQ_FIRST(list);
1461         STAILQ_REMOVE_HEAD(list, link);
1462         free(elm);
1463     }
1464 }
1465
1466 static Objlist_Entry *
1467 objlist_find(Objlist *list, const Obj_Entry *obj)
1468 {
1469     Objlist_Entry *elm;
1470
1471     STAILQ_FOREACH(elm, list, link)
1472         if (elm->obj == obj)
1473             return elm;
1474     return NULL;
1475 }
1476
1477 static void
1478 objlist_init(Objlist *list)
1479 {
1480     STAILQ_INIT(list);
1481 }
1482
1483 static void
1484 objlist_push_head(Objlist *list, Obj_Entry *obj)
1485 {
1486     Objlist_Entry *elm;
1487
1488     elm = NEW(Objlist_Entry);
1489     elm->obj = obj;
1490     STAILQ_INSERT_HEAD(list, elm, link);
1491 }
1492
1493 static void
1494 objlist_push_tail(Objlist *list, Obj_Entry *obj)
1495 {
1496     Objlist_Entry *elm;
1497
1498     elm = NEW(Objlist_Entry);
1499     elm->obj = obj;
1500     STAILQ_INSERT_TAIL(list, elm, link);
1501 }
1502
1503 static void
1504 objlist_remove(Objlist *list, Obj_Entry *obj)
1505 {
1506     Objlist_Entry *elm;
1507
1508     if ((elm = objlist_find(list, obj)) != NULL) {
1509         STAILQ_REMOVE(list, elm, Struct_Objlist_Entry, link);
1510         free(elm);
1511     }
1512 }
1513
1514 /*
1515  * Remove all of the unreferenced objects from "list".
1516  */
1517 static void
1518 objlist_remove_unref(Objlist *list)
1519 {
1520     Objlist newlist;
1521     Objlist_Entry *elm;
1522
1523     STAILQ_INIT(&newlist);
1524     while (!STAILQ_EMPTY(list)) {
1525         elm = STAILQ_FIRST(list);
1526         STAILQ_REMOVE_HEAD(list, link);
1527         if (elm->obj->refcount == 0)
1528             free(elm);
1529         else
1530             STAILQ_INSERT_TAIL(&newlist, elm, link);
1531     }
1532     *list = newlist;
1533 }
1534
1535 /*
1536  * Relocate newly-loaded shared objects.  The argument is a pointer to
1537  * the Obj_Entry for the first such object.  All objects from the first
1538  * to the end of the list of objects are relocated.  Returns 0 on success,
1539  * or -1 on failure.
1540  */
1541 static int
1542 relocate_objects(Obj_Entry *first, bool bind_now, Obj_Entry *rtldobj)
1543 {
1544     Obj_Entry *obj;
1545
1546     for (obj = first;  obj != NULL;  obj = obj->next) {
1547         if (obj != rtldobj)
1548             dbg("relocating \"%s\"", obj->path);
1549         if (obj->nbuckets == 0 || obj->nchains == 0 || obj->buckets == NULL ||
1550             obj->symtab == NULL || obj->strtab == NULL) {
1551             _rtld_error("%s: Shared object has no run-time symbol table",
1552               obj->path);
1553             return -1;
1554         }
1555
1556         if (obj->textrel) {
1557             /* There are relocations to the write-protected text segment. */
1558             if (mprotect(obj->mapbase, obj->textsize,
1559               PROT_READ|PROT_WRITE|PROT_EXEC) == -1) {
1560                 _rtld_error("%s: Cannot write-enable text segment: %s",
1561                   obj->path, strerror(errno));
1562                 return -1;
1563             }
1564         }
1565
1566         /* Process the non-PLT relocations. */
1567         if (reloc_non_plt(obj, rtldobj))
1568                 return -1;
1569
1570         /*
1571          * Reprotect the text segment.  Make sure it is included in the
1572          * core dump since we modified it.  This unfortunately causes the
1573          * entire text segment to core-out but we don't have much of a
1574          * choice.  We could try to only reenable core dumps on pages
1575          * in which relocations occured but that is likely most of the text
1576          * pages anyway, and even that would not work because the rest of
1577          * the text pages would wind up as a read-only OBJT_DEFAULT object
1578          * (created due to our modifications) backed by the original OBJT_VNODE
1579          * object, and the ELF coredump code is currently only able to dump
1580          * vnode records for pure vnode-backed mappings, not vnode backings
1581          * to memory objects.
1582          */
1583         if (obj->textrel) {
1584             madvise(obj->mapbase, obj->textsize, MADV_CORE);
1585             if (mprotect(obj->mapbase, obj->textsize,
1586               PROT_READ|PROT_EXEC) == -1) {
1587                 _rtld_error("%s: Cannot write-protect text segment: %s",
1588                   obj->path, strerror(errno));
1589                 return -1;
1590             }
1591         }
1592
1593         /* Process the PLT relocations. */
1594         if (reloc_plt(obj) == -1)
1595             return -1;
1596         /* Relocate the jump slots if we are doing immediate binding. */
1597         if (obj->bind_now || bind_now)
1598             if (reloc_jmpslots(obj) == -1)
1599                 return -1;
1600
1601
1602         /*
1603          * Set up the magic number and version in the Obj_Entry.  These
1604          * were checked in the crt1.o from the original ElfKit, so we
1605          * set them for backward compatibility.
1606          */
1607         obj->magic = RTLD_MAGIC;
1608         obj->version = RTLD_VERSION;
1609
1610         /* Set the special PLT or GOT entries. */
1611         init_pltgot(obj);
1612     }
1613
1614     return 0;
1615 }
1616
1617 /*
1618  * Cleanup procedure.  It will be called (by the atexit mechanism) just
1619  * before the process exits.
1620  */
1621 static void
1622 rtld_exit(void)
1623 {
1624     Obj_Entry *obj;
1625
1626     dbg("rtld_exit()");
1627     /* Clear all the reference counts so the fini functions will be called. */
1628     for (obj = obj_list;  obj != NULL;  obj = obj->next)
1629         obj->refcount = 0;
1630     objlist_call_fini(&list_fini);
1631     /* No need to remove the items from the list, since we are exiting. */
1632 }
1633
1634 static void *
1635 path_enumerate(const char *path, path_enum_proc callback, void *arg)
1636 {
1637     if (path == NULL)
1638         return (NULL);
1639
1640     path += strspn(path, ":;");
1641     while (*path != '\0') {
1642         size_t len;
1643         char  *res;
1644
1645         len = strcspn(path, ":;");
1646         res = callback(path, len, arg);
1647
1648         if (res != NULL)
1649             return (res);
1650
1651         path += len;
1652         path += strspn(path, ":;");
1653     }
1654
1655     return (NULL);
1656 }
1657
1658 struct try_library_args {
1659     const char  *name;
1660     size_t       namelen;
1661     char        *buffer;
1662     size_t       buflen;
1663 };
1664
1665 static void *
1666 try_library_path(const char *dir, size_t dirlen, void *param)
1667 {
1668     struct try_library_args *arg;
1669
1670     arg = param;
1671     if (*dir == '/' || trust) {
1672         char *pathname;
1673
1674         if (dirlen + 1 + arg->namelen + 1 > arg->buflen)
1675                 return (NULL);
1676
1677         pathname = arg->buffer;
1678         strncpy(pathname, dir, dirlen);
1679         pathname[dirlen] = '/';
1680         strcpy(pathname + dirlen + 1, arg->name);
1681
1682         dbg("  Trying \"%s\"", pathname);
1683         if (access(pathname, F_OK) == 0) {              /* We found it */
1684             pathname = xmalloc(dirlen + 1 + arg->namelen + 1);
1685             strcpy(pathname, arg->buffer);
1686             return (pathname);
1687         }
1688     }
1689     return (NULL);
1690 }
1691
1692 static char *
1693 search_library_path(const char *name, const char *path)
1694 {
1695     char *p;
1696     struct try_library_args arg;
1697
1698     if (path == NULL)
1699         return NULL;
1700
1701     arg.name = name;
1702     arg.namelen = strlen(name);
1703     arg.buffer = xmalloc(PATH_MAX);
1704     arg.buflen = PATH_MAX;
1705
1706     p = path_enumerate(path, try_library_path, &arg);
1707
1708     free(arg.buffer);
1709
1710     return (p);
1711 }
1712
1713 int
1714 dlclose(void *handle)
1715 {
1716     Obj_Entry *root;
1717
1718     wlock_acquire();
1719     root = dlcheck(handle);
1720     if (root == NULL) {
1721         wlock_release();
1722         return -1;
1723     }
1724
1725     /* Unreference the object and its dependencies. */
1726     root->dl_refcount--;
1727     unref_dag(root);
1728
1729     if (root->refcount == 0) {
1730         /*
1731          * The object is no longer referenced, so we must unload it.
1732          * First, call the fini functions with no locks held.
1733          */
1734         wlock_release();
1735         objlist_call_fini(&list_fini);
1736         wlock_acquire();
1737         objlist_remove_unref(&list_fini);
1738
1739         /* Finish cleaning up the newly-unreferenced objects. */
1740         GDB_STATE(RT_DELETE,&root->linkmap);
1741         unload_object(root);
1742         GDB_STATE(RT_CONSISTENT,NULL);
1743     }
1744     wlock_release();
1745     return 0;
1746 }
1747
1748 const char *
1749 dlerror(void)
1750 {
1751     char *msg = error_message;
1752     error_message = NULL;
1753     return msg;
1754 }
1755
1756 void *
1757 dlopen(const char *name, int mode)
1758 {
1759     Obj_Entry **old_obj_tail;
1760     Obj_Entry *obj;
1761     Objlist initlist;
1762     int result;
1763
1764     ld_tracing = (mode & RTLD_TRACE) == 0 ? NULL : "1";
1765     if (ld_tracing != NULL)
1766         environ = (char **)*get_program_var_addr("environ");
1767
1768     objlist_init(&initlist);
1769
1770     wlock_acquire();
1771     GDB_STATE(RT_ADD,NULL);
1772
1773     old_obj_tail = obj_tail;
1774     obj = NULL;
1775     if (name == NULL) {
1776         obj = obj_main;
1777         obj->refcount++;
1778     } else {
1779         char *path = find_library(name, obj_main);
1780         if (path != NULL)
1781             obj = load_object(path);
1782     }
1783
1784     if (obj) {
1785         obj->dl_refcount++;
1786         if ((mode & RTLD_GLOBAL) && objlist_find(&list_global, obj) == NULL)
1787             objlist_push_tail(&list_global, obj);
1788         mode &= RTLD_MODEMASK;
1789         if (*old_obj_tail != NULL) {            /* We loaded something new. */
1790             assert(*old_obj_tail == obj);
1791
1792             result = load_needed_objects(obj);
1793             if (result != -1 && ld_tracing)
1794                 goto trace;
1795
1796             if (result == -1 ||
1797               (init_dag(obj), relocate_objects(obj, mode == RTLD_NOW,
1798                &obj_rtld)) == -1) {
1799                 obj->dl_refcount--;
1800                 unref_dag(obj);
1801                 if (obj->refcount == 0)
1802                     unload_object(obj);
1803                 obj = NULL;
1804             } else {
1805                 /* Make list of init functions to call. */
1806                 initlist_add_objects(obj, &obj->next, &initlist);
1807             }
1808         } else if (ld_tracing)
1809             goto trace;
1810     }
1811
1812     GDB_STATE(RT_CONSISTENT,obj ? &obj->linkmap : NULL);
1813
1814     /* Call the init functions with no locks held. */
1815     wlock_release();
1816     objlist_call_init(&initlist);
1817     wlock_acquire();
1818     objlist_clear(&initlist);
1819     wlock_release();
1820     return obj;
1821 trace:
1822     trace_loaded_objects(obj);
1823     wlock_release();
1824     exit(0);
1825 }
1826
1827 void *
1828 dlsym(void *handle, const char *name)
1829 {
1830     const Obj_Entry *obj;
1831     unsigned long hash;
1832     const Elf_Sym *def;
1833     const Obj_Entry *defobj;
1834
1835     hash = elf_hash(name);
1836     def = NULL;
1837     defobj = NULL;
1838
1839     rlock_acquire();
1840     if (handle == NULL || handle == RTLD_NEXT ||
1841         handle == RTLD_DEFAULT || handle == RTLD_SELF) {
1842         void *retaddr;
1843
1844         retaddr = __builtin_return_address(0);  /* __GNUC__ only */
1845         if ((obj = obj_from_addr(retaddr)) == NULL) {
1846             _rtld_error("Cannot determine caller's shared object");
1847             rlock_release();
1848             return NULL;
1849         }
1850         if (handle == NULL) {   /* Just the caller's shared object. */
1851             def = symlook_obj(name, hash, obj, true);
1852             defobj = obj;
1853         } else if (handle == RTLD_NEXT || /* Objects after caller's */
1854                    handle == RTLD_SELF) { /* ... caller included */
1855             if (handle == RTLD_NEXT)
1856                 obj = obj->next;
1857             for (; obj != NULL; obj = obj->next) {
1858                 if ((def = symlook_obj(name, hash, obj, true)) != NULL) {
1859                     defobj = obj;
1860                     break;
1861                 }
1862             }
1863         } else {
1864             assert(handle == RTLD_DEFAULT);
1865             def = symlook_default(name, hash, obj, &defobj, true);
1866         }
1867     } else {
1868         DoneList donelist;
1869
1870         if ((obj = dlcheck(handle)) == NULL) {
1871             rlock_release();
1872             return NULL;
1873         }
1874
1875         donelist_init(&donelist);
1876         if (obj->mainprog) {
1877             /* Search main program and all libraries loaded by it. */
1878             def = symlook_list(name, hash, &list_main, &defobj, true,
1879               &donelist);
1880         } else {
1881             def = symlook_list(name, hash, &(obj->dagmembers), &defobj, true,
1882               &donelist);
1883         }
1884     }
1885
1886     if (def != NULL) {
1887         rlock_release();
1888         return defobj->relocbase + def->st_value;
1889     }
1890
1891     _rtld_error("Undefined symbol \"%s\"", name);
1892     rlock_release();
1893     return NULL;
1894 }
1895
1896 int
1897 dladdr(const void *addr, Dl_info *info)
1898 {
1899     const Obj_Entry *obj;
1900     const Elf_Sym *def;
1901     void *symbol_addr;
1902     unsigned long symoffset;
1903
1904     rlock_acquire();
1905     obj = obj_from_addr(addr);
1906     if (obj == NULL) {
1907         _rtld_error("No shared object contains address");
1908         rlock_release();
1909         return 0;
1910     }
1911     info->dli_fname = obj->path;
1912     info->dli_fbase = obj->mapbase;
1913     info->dli_saddr = (void *)0;
1914     info->dli_sname = NULL;
1915
1916     /*
1917      * Walk the symbol list looking for the symbol whose address is
1918      * closest to the address sent in.
1919      */
1920     for (symoffset = 0; symoffset < obj->nchains; symoffset++) {
1921         def = obj->symtab + symoffset;
1922
1923         /*
1924          * For skip the symbol if st_shndx is either SHN_UNDEF or
1925          * SHN_COMMON.
1926          */
1927         if (def->st_shndx == SHN_UNDEF || def->st_shndx == SHN_COMMON)
1928             continue;
1929
1930         /*
1931          * If the symbol is greater than the specified address, or if it
1932          * is further away from addr than the current nearest symbol,
1933          * then reject it.
1934          */
1935         symbol_addr = obj->relocbase + def->st_value;
1936         if (symbol_addr > addr || symbol_addr < info->dli_saddr)
1937             continue;
1938
1939         /* Update our idea of the nearest symbol. */
1940         info->dli_sname = obj->strtab + def->st_name;
1941         info->dli_saddr = symbol_addr;
1942
1943         /* Exact match? */
1944         if (info->dli_saddr == addr)
1945             break;
1946     }
1947     rlock_release();
1948     return 1;
1949 }
1950
1951 int
1952 dlinfo(void *handle, int request, void *p)
1953 {
1954     const Obj_Entry *obj;
1955     int error;
1956
1957     rlock_acquire();
1958
1959     if (handle == NULL || handle == RTLD_SELF) {
1960         void *retaddr;
1961
1962         retaddr = __builtin_return_address(0);  /* __GNUC__ only */
1963         if ((obj = obj_from_addr(retaddr)) == NULL)
1964             _rtld_error("Cannot determine caller's shared object");
1965     } else
1966         obj = dlcheck(handle);
1967
1968     if (obj == NULL) {
1969         rlock_release();
1970         return (-1);
1971     }
1972
1973     error = 0;
1974     switch (request) {
1975     case RTLD_DI_LINKMAP:
1976         *((struct link_map const **)p) = &obj->linkmap;
1977         break;
1978     case RTLD_DI_ORIGIN:
1979         error = rtld_dirname(obj->path, p);
1980         break;
1981
1982     case RTLD_DI_SERINFOSIZE:
1983     case RTLD_DI_SERINFO:
1984         error = do_search_info(obj, request, (struct dl_serinfo *)p);
1985         break;
1986
1987     default:
1988         _rtld_error("Invalid request %d passed to dlinfo()", request);
1989         error = -1;
1990     }
1991
1992     rlock_release();
1993
1994     return (error);
1995 }
1996
1997 struct fill_search_info_args {
1998     int          request;
1999     unsigned int flags;
2000     Dl_serinfo  *serinfo;
2001     Dl_serpath  *serpath;
2002     char        *strspace;
2003 };
2004
2005 static void *
2006 fill_search_info(const char *dir, size_t dirlen, void *param)
2007 {
2008     struct fill_search_info_args *arg;
2009
2010     arg = param;
2011
2012     if (arg->request == RTLD_DI_SERINFOSIZE) {
2013         arg->serinfo->dls_cnt ++;
2014         arg->serinfo->dls_size += dirlen + 1;
2015     } else {
2016         struct dl_serpath *s_entry;
2017
2018         s_entry = arg->serpath;
2019         s_entry->dls_name  = arg->strspace;
2020         s_entry->dls_flags = arg->flags;
2021
2022         strncpy(arg->strspace, dir, dirlen);
2023         arg->strspace[dirlen] = '\0';
2024
2025         arg->strspace += dirlen + 1;
2026         arg->serpath++;
2027     }
2028
2029     return (NULL);
2030 }
2031
2032 static int
2033 do_search_info(const Obj_Entry *obj, int request, struct dl_serinfo *info)
2034 {
2035     struct dl_serinfo _info;
2036     struct fill_search_info_args args;
2037
2038     args.request = RTLD_DI_SERINFOSIZE;
2039     args.serinfo = &_info;
2040
2041     _info.dls_size = __offsetof(struct dl_serinfo, dls_serpath);
2042     _info.dls_cnt  = 0;
2043
2044     path_enumerate(ld_library_path, fill_search_info, &args);
2045     path_enumerate(obj->rpath, fill_search_info, &args);
2046     path_enumerate(gethints(), fill_search_info, &args);
2047     path_enumerate(STANDARD_LIBRARY_PATH, fill_search_info, &args);
2048
2049
2050     if (request == RTLD_DI_SERINFOSIZE) {
2051         info->dls_size = _info.dls_size;
2052         info->dls_cnt = _info.dls_cnt;
2053         return (0);
2054     }
2055
2056     if (info->dls_cnt != _info.dls_cnt || info->dls_size != _info.dls_size) {
2057         _rtld_error("Uninitialized Dl_serinfo struct passed to dlinfo()");
2058         return (-1);
2059     }
2060
2061     args.request  = RTLD_DI_SERINFO;
2062     args.serinfo  = info;
2063     args.serpath  = &info->dls_serpath[0];
2064     args.strspace = (char *)&info->dls_serpath[_info.dls_cnt];
2065
2066     args.flags = LA_SER_LIBPATH;
2067     if (path_enumerate(ld_library_path, fill_search_info, &args) != NULL)
2068         return (-1);
2069
2070     args.flags = LA_SER_RUNPATH;
2071     if (path_enumerate(obj->rpath, fill_search_info, &args) != NULL)
2072         return (-1);
2073
2074     args.flags = LA_SER_CONFIG;
2075     if (path_enumerate(gethints(), fill_search_info, &args) != NULL)
2076         return (-1);
2077
2078     args.flags = LA_SER_DEFAULT;
2079     if (path_enumerate(STANDARD_LIBRARY_PATH, fill_search_info, &args) != NULL)
2080         return (-1);
2081     return (0);
2082 }
2083
2084 static int
2085 rtld_dirname(const char *path, char *bname)
2086 {
2087     const char *endp;
2088
2089     /* Empty or NULL string gets treated as "." */
2090     if (path == NULL || *path == '\0') {
2091         bname[0] = '.';
2092         bname[1] = '\0';
2093         return (0);
2094     }
2095
2096     /* Strip trailing slashes */
2097     endp = path + strlen(path) - 1;
2098     while (endp > path && *endp == '/')
2099         endp--;
2100
2101     /* Find the start of the dir */
2102     while (endp > path && *endp != '/')
2103         endp--;
2104
2105     /* Either the dir is "/" or there are no slashes */
2106     if (endp == path) {
2107         bname[0] = *endp == '/' ? '/' : '.';
2108         bname[1] = '\0';
2109         return (0);
2110     } else {
2111         do {
2112             endp--;
2113         } while (endp > path && *endp == '/');
2114     }
2115
2116     if (endp - path + 2 > PATH_MAX)
2117     {
2118         _rtld_error("Filename is too long: %s", path);
2119         return(-1);
2120     }
2121
2122     strncpy(bname, path, endp - path + 1);
2123     bname[endp - path + 1] = '\0';
2124     return (0);
2125 }
2126
2127 static void
2128 linkmap_add(Obj_Entry *obj)
2129 {
2130     struct link_map *l = &obj->linkmap;
2131     struct link_map *prev;
2132
2133     obj->linkmap.l_name = obj->path;
2134     obj->linkmap.l_addr = obj->mapbase;
2135     obj->linkmap.l_ld = obj->dynamic;
2136 #ifdef __mips__
2137     /* GDB needs load offset on MIPS to use the symbols */
2138     obj->linkmap.l_offs = obj->relocbase;
2139 #endif
2140
2141     if (r_debug.r_map == NULL) {
2142         r_debug.r_map = l;
2143         return;
2144     }
2145
2146     /*
2147      * Scan to the end of the list, but not past the entry for the
2148      * dynamic linker, which we want to keep at the very end.
2149      */
2150     for (prev = r_debug.r_map;
2151       prev->l_next != NULL && prev->l_next != &obj_rtld.linkmap;
2152       prev = prev->l_next)
2153         ;
2154
2155     /* Link in the new entry. */
2156     l->l_prev = prev;
2157     l->l_next = prev->l_next;
2158     if (l->l_next != NULL)
2159         l->l_next->l_prev = l;
2160     prev->l_next = l;
2161 }
2162
2163 static void
2164 linkmap_delete(Obj_Entry *obj)
2165 {
2166     struct link_map *l = &obj->linkmap;
2167
2168     if (l->l_prev == NULL) {
2169         if ((r_debug.r_map = l->l_next) != NULL)
2170             l->l_next->l_prev = NULL;
2171         return;
2172     }
2173
2174     if ((l->l_prev->l_next = l->l_next) != NULL)
2175         l->l_next->l_prev = l->l_prev;
2176 }
2177
2178 /*
2179  * Function for the debugger to set a breakpoint on to gain control.
2180  *
2181  * The two parameters allow the debugger to easily find and determine
2182  * what the runtime loader is doing and to whom it is doing it.
2183  *
2184  * When the loadhook trap is hit (r_debug_state, set at program
2185  * initialization), the arguments can be found on the stack:
2186  *
2187  *  +8   struct link_map *m
2188  *  +4   struct r_debug  *rd
2189  *  +0   RetAddr
2190  */
2191 void
2192 r_debug_state(struct r_debug* rd, struct link_map *m)
2193 {
2194 }
2195
2196 /*
2197  * Get address of the pointer variable in the main program.
2198  */
2199 static const void **
2200 get_program_var_addr(const char *name)
2201 {
2202     const Obj_Entry *obj;
2203     unsigned long hash;
2204
2205     hash = elf_hash(name);
2206     for (obj = obj_main;  obj != NULL;  obj = obj->next) {
2207         const Elf_Sym *def;
2208
2209         if ((def = symlook_obj(name, hash, obj, false)) != NULL) {
2210             const void **addr;
2211
2212             addr = (const void **)(obj->relocbase + def->st_value);
2213             return addr;
2214         }
2215     }
2216     return NULL;
2217 }
2218
2219 /*
2220  * Set a pointer variable in the main program to the given value.  This
2221  * is used to set key variables such as "environ" before any of the
2222  * init functions are called.
2223  */
2224 static void
2225 set_program_var(const char *name, const void *value)
2226 {
2227     const void **addr;
2228
2229     if ((addr = get_program_var_addr(name)) != NULL) {
2230         dbg("\"%s\": *%p <-- %p", name, addr, value);
2231         *addr = value;
2232     }
2233 }
2234
2235 /*
2236  * This is a special version of getenv which is far more efficient
2237  * at finding LD_ environment vars.
2238  */
2239 static
2240 const char *
2241 _getenv_ld(const char *id)
2242 {
2243     const char *envp;
2244     int i, j;
2245     int idlen = strlen(id);
2246
2247     if (ld_index == LD_ARY_CACHE)
2248         return(getenv(id));
2249     if (ld_index == 0) {
2250         for (i = j = 0; (envp = environ[i]) != NULL && j < LD_ARY_CACHE; ++i) {
2251             if (envp[0] == 'L' && envp[1] == 'D' && envp[2] == '_')
2252                 ld_ary[j++] = envp;
2253         }
2254         if (j == 0)
2255                 ld_ary[j++] = "";
2256         ld_index = j;
2257     }
2258     for (i = ld_index - 1; i >= 0; --i) {
2259         if (strncmp(ld_ary[i], id, idlen) == 0 && ld_ary[i][idlen] == '=')
2260             return(ld_ary[i] + idlen + 1);
2261     }
2262     return(NULL);
2263 }
2264
2265 /*
2266  * Given a symbol name in a referencing object, find the corresponding
2267  * definition of the symbol.  Returns a pointer to the symbol, or NULL if
2268  * no definition was found.  Returns a pointer to the Obj_Entry of the
2269  * defining object via the reference parameter DEFOBJ_OUT.
2270  */
2271 static const Elf_Sym *
2272 symlook_default(const char *name, unsigned long hash,
2273     const Obj_Entry *refobj, const Obj_Entry **defobj_out, bool in_plt)
2274 {
2275     DoneList donelist;
2276     const Elf_Sym *def;
2277     const Elf_Sym *symp;
2278     const Obj_Entry *obj;
2279     const Obj_Entry *defobj;
2280     const Objlist_Entry *elm;
2281     def = NULL;
2282     defobj = NULL;
2283     donelist_init(&donelist);
2284
2285     /* Look first in the referencing object if linked symbolically. */
2286     if (refobj->symbolic && !donelist_check(&donelist, refobj)) {
2287         symp = symlook_obj(name, hash, refobj, in_plt);
2288         if (symp != NULL) {
2289             def = symp;
2290             defobj = refobj;
2291         }
2292     }
2293
2294     /* Search all objects loaded at program start up. */
2295     if (def == NULL || ELF_ST_BIND(def->st_info) == STB_WEAK) {
2296         symp = symlook_list(name, hash, &list_main, &obj, in_plt, &donelist);
2297         if (symp != NULL &&
2298           (def == NULL || ELF_ST_BIND(symp->st_info) != STB_WEAK)) {
2299             def = symp;
2300             defobj = obj;
2301         }
2302     }
2303
2304     /* Search all DAGs whose roots are RTLD_GLOBAL objects. */
2305     STAILQ_FOREACH(elm, &list_global, link) {
2306        if (def != NULL && ELF_ST_BIND(def->st_info) != STB_WEAK)
2307            break;
2308        symp = symlook_list(name, hash, &elm->obj->dagmembers, &obj, in_plt,
2309          &donelist);
2310         if (symp != NULL &&
2311           (def == NULL || ELF_ST_BIND(symp->st_info) != STB_WEAK)) {
2312             def = symp;
2313             defobj = obj;
2314         }
2315     }
2316
2317     /* Search all dlopened DAGs containing the referencing object. */
2318     STAILQ_FOREACH(elm, &refobj->dldags, link) {
2319         if (def != NULL && ELF_ST_BIND(def->st_info) != STB_WEAK)
2320             break;
2321         symp = symlook_list(name, hash, &elm->obj->dagmembers, &obj, in_plt,
2322           &donelist);
2323         if (symp != NULL &&
2324           (def == NULL || ELF_ST_BIND(symp->st_info) != STB_WEAK)) {
2325             def = symp;
2326             defobj = obj;
2327         }
2328     }
2329
2330     /*
2331      * Search the dynamic linker itself, and possibly resolve the
2332      * symbol from there.  This is how the application links to
2333      * dynamic linker services such as dlopen.  Only the values listed
2334      * in the "exports" array can be resolved from the dynamic linker.
2335      */
2336     if (def == NULL || ELF_ST_BIND(def->st_info) == STB_WEAK) {
2337         symp = symlook_obj(name, hash, &obj_rtld, in_plt);
2338         if (symp != NULL && is_exported(symp)) {
2339             def = symp;
2340             defobj = &obj_rtld;
2341         }
2342     }
2343
2344     if (def != NULL)
2345         *defobj_out = defobj;
2346     return def;
2347 }
2348
2349 static const Elf_Sym *
2350 symlook_list(const char *name, unsigned long hash, const Objlist *objlist,
2351   const Obj_Entry **defobj_out, bool in_plt, DoneList *dlp)
2352 {
2353     const Elf_Sym *symp;
2354     const Elf_Sym *def;
2355     const Obj_Entry *defobj;
2356     const Objlist_Entry *elm;
2357
2358     def = NULL;
2359     defobj = NULL;
2360     STAILQ_FOREACH(elm, objlist, link) {
2361         if (donelist_check(dlp, elm->obj))
2362             continue;
2363         if ((symp = symlook_obj(name, hash, elm->obj, in_plt)) != NULL) {
2364             if (def == NULL || ELF_ST_BIND(symp->st_info) != STB_WEAK) {
2365                 def = symp;
2366                 defobj = elm->obj;
2367                 if (ELF_ST_BIND(def->st_info) != STB_WEAK)
2368                     break;
2369             }
2370         }
2371     }
2372     if (def != NULL)
2373         *defobj_out = defobj;
2374     return def;
2375 }
2376
2377 /*
2378  * Search the symbol table of a single shared object for a symbol of
2379  * the given name.  Returns a pointer to the symbol, or NULL if no
2380  * definition was found.
2381  *
2382  * The symbol's hash value is passed in for efficiency reasons; that
2383  * eliminates many recomputations of the hash value.
2384  */
2385 const Elf_Sym *
2386 symlook_obj(const char *name, unsigned long hash, const Obj_Entry *obj,
2387   bool in_plt)
2388 {
2389     if (obj->buckets != NULL) {
2390         unsigned long symnum = obj->buckets[hash % obj->nbuckets];
2391
2392         while (symnum != STN_UNDEF) {
2393             const Elf_Sym *symp;
2394             const char *strp;
2395
2396             if (symnum >= obj->nchains)
2397                 return NULL;    /* Bad object */
2398             symp = obj->symtab + symnum;
2399             strp = obj->strtab + symp->st_name;
2400
2401             if (name[0] == strp[0] && strcmp(name, strp) == 0)
2402                 return symp->st_shndx != SHN_UNDEF ||
2403                   (!in_plt && symp->st_value != 0 &&
2404                   ELF_ST_TYPE(symp->st_info) == STT_FUNC) ? symp : NULL;
2405
2406             symnum = obj->chains[symnum];
2407         }
2408     }
2409     return NULL;
2410 }
2411
2412 static void
2413 trace_loaded_objects(Obj_Entry *obj)
2414 {
2415     const char *fmt1, *fmt2, *fmt, *main_local;
2416     int         c;
2417
2418     if ((main_local = _getenv_ld("LD_TRACE_LOADED_OBJECTS_PROGNAME")) == NULL)
2419         main_local = "";
2420
2421     if ((fmt1 = _getenv_ld("LD_TRACE_LOADED_OBJECTS_FMT1")) == NULL)
2422         fmt1 = "\t%o => %p (%x)\n";
2423
2424     if ((fmt2 = _getenv_ld("LD_TRACE_LOADED_OBJECTS_FMT2")) == NULL)
2425         fmt2 = "\t%o (%x)\n";
2426
2427     for (; obj; obj = obj->next) {
2428         Needed_Entry            *needed;
2429         char                    *name, *path;
2430         bool                    is_lib;
2431
2432         for (needed = obj->needed; needed; needed = needed->next) {
2433             if (needed->obj != NULL) {
2434                 if (needed->obj->traced)
2435                     continue;
2436                 needed->obj->traced = true;
2437                 path = needed->obj->path;
2438             } else
2439                 path = "not found";
2440
2441             name = (char *)obj->strtab + needed->name;
2442             is_lib = strncmp(name, "lib", 3) == 0;      /* XXX - bogus */
2443
2444             fmt = is_lib ? fmt1 : fmt2;
2445             while ((c = *fmt++) != '\0') {
2446                 switch (c) {
2447                 default:
2448                     putchar(c);
2449                     continue;
2450                 case '\\':
2451                     switch (c = *fmt) {
2452                     case '\0':
2453                         continue;
2454                     case 'n':
2455                         putchar('\n');
2456                         break;
2457                     case 't':
2458                         putchar('\t');
2459                         break;
2460                     }
2461                     break;
2462                 case '%':
2463                     switch (c = *fmt) {
2464                     case '\0':
2465                         continue;
2466                     case '%':
2467                     default:
2468                         putchar(c);
2469                         break;
2470                     case 'A':
2471                         printf("%s", main_local);
2472                         break;
2473                     case 'a':
2474                         printf("%s", obj_main->path);
2475                         break;
2476                     case 'o':
2477                         printf("%s", name);
2478                         break;
2479 #if 0
2480                     case 'm':
2481                         printf("%d", sodp->sod_major);
2482                         break;
2483                     case 'n':
2484                         printf("%d", sodp->sod_minor);
2485                         break;
2486 #endif
2487                     case 'p':
2488                         printf("%s", path);
2489                         break;
2490                     case 'x':
2491                         printf("%p", needed->obj ? needed->obj->mapbase : 0);
2492                         break;
2493                     }
2494                     break;
2495                 }
2496                 ++fmt;
2497             }
2498         }
2499     }
2500 }
2501
2502 /*
2503  * Unload a dlopened object and its dependencies from memory and from
2504  * our data structures.  It is assumed that the DAG rooted in the
2505  * object has already been unreferenced, and that the object has a
2506  * reference count of 0.
2507  */
2508 static void
2509 unload_object(Obj_Entry *root)
2510 {
2511     Obj_Entry *obj;
2512     Obj_Entry **linkp;
2513
2514     assert(root->refcount == 0);
2515
2516     /*
2517      * Pass over the DAG removing unreferenced objects from
2518      * appropriate lists.
2519      */
2520     unlink_object(root);
2521
2522     /* Unmap all objects that are no longer referenced. */
2523     linkp = &obj_list->next;
2524     while ((obj = *linkp) != NULL) {
2525         if (obj->refcount == 0) {
2526             dbg("unloading \"%s\"", obj->path);
2527             munmap(obj->mapbase, obj->mapsize);
2528             linkmap_delete(obj);
2529             *linkp = obj->next;
2530             obj_count--;
2531             obj_free(obj);
2532         } else
2533             linkp = &obj->next;
2534     }
2535     obj_tail = linkp;
2536 }
2537
2538 static void
2539 unlink_object(Obj_Entry *root)
2540 {
2541     const Needed_Entry *needed;
2542     Objlist_Entry *elm;
2543
2544     if (root->refcount == 0) {
2545         /* Remove the object from the RTLD_GLOBAL list. */
2546         objlist_remove(&list_global, root);
2547
2548         /* Remove the object from all objects' DAG lists. */
2549         STAILQ_FOREACH(elm, &root->dagmembers , link)
2550             objlist_remove(&elm->obj->dldags, root);
2551     }
2552
2553     for (needed = root->needed;  needed != NULL;  needed = needed->next)
2554         if (needed->obj != NULL)
2555             unlink_object(needed->obj);
2556 }
2557
2558 static void
2559 unref_dag(Obj_Entry *root)
2560 {
2561     const Needed_Entry *needed;
2562
2563     if (root->refcount == 0)
2564         return;
2565     root->refcount--;
2566     if (root->refcount == 0)
2567         for (needed = root->needed;  needed != NULL;  needed = needed->next)
2568             if (needed->obj != NULL)
2569                 unref_dag(needed->obj);
2570 }
2571
2572 /*
2573  * Common code for MD __tls_get_addr().
2574  */
2575 void *
2576 tls_get_addr_common(void **dtvp, int index, size_t offset)
2577 {
2578     Elf_Addr* dtv = *dtvp;
2579
2580     /* Check dtv generation in case new modules have arrived */
2581     if (dtv[0] != tls_dtv_generation) {
2582         Elf_Addr* newdtv;
2583         int to_copy;
2584
2585         wlock_acquire();
2586
2587         newdtv = calloc(1, (tls_max_index + 2) * sizeof(Elf_Addr));
2588         to_copy = dtv[1];
2589         if (to_copy > tls_max_index)
2590             to_copy = tls_max_index;
2591         memcpy(&newdtv[2], &dtv[2], to_copy * sizeof(Elf_Addr));
2592         newdtv[0] = tls_dtv_generation;
2593         newdtv[1] = tls_max_index;
2594         free(dtv);
2595         *dtvp = newdtv;
2596
2597         wlock_release();
2598     }
2599
2600     /* Dynamically allocate module TLS if necessary */
2601     if (!dtv[index + 1]) {
2602         /* XXX
2603          * here we should avoid to be re-entered by signal handler
2604          * code, I assume wlock_acquire will masked all signals,
2605          * otherwise there is race and dead lock thread itself.
2606          */
2607         wlock_acquire();
2608         if (!dtv[index + 1])
2609             dtv[index + 1] = (Elf_Addr)allocate_module_tls(index);
2610         wlock_release();
2611     }
2612
2613     return (void*) (dtv[index + 1] + offset);
2614 }
2615
2616 #if defined(RTLD_STATIC_TLS_VARIANT_II)
2617
2618 /*
2619  * Allocate the static TLS area.  Return a pointer to the TCB.  The
2620  * static area is based on negative offsets relative to the tcb.
2621  *
2622  * The TCB contains an errno pointer for the system call layer, but because
2623  * we are the RTLD we really have no idea how the caller was compiled so
2624  * the information has to be passed in.  errno can either be:
2625  *
2626  *      type 0  errno is a simple non-TLS global pointer.
2627  *              (special case for e.g. libc_rtld)
2628  *      type 1  errno accessed by GOT entry     (dynamically linked programs)
2629  *      type 2  errno accessed by %gs:OFFSET    (statically linked programs)
2630  */
2631 struct tls_tcb *
2632 allocate_tls(Obj_Entry *objs)
2633 {
2634     Obj_Entry *obj;
2635     size_t data_size;
2636     size_t dtv_size;
2637     struct tls_tcb *tcb;
2638     Elf_Addr *dtv;
2639     Elf_Addr addr;
2640
2641     /*
2642      * Allocate the new TCB.  static TLS storage is placed just before the
2643      * TCB to support the %gs:OFFSET (negative offset) model.
2644      */
2645     data_size = (tls_static_space + RTLD_STATIC_TLS_ALIGN_MASK) &
2646                 ~RTLD_STATIC_TLS_ALIGN_MASK;
2647     tcb = malloc(data_size + sizeof(*tcb));
2648     tcb = (void *)((char *)tcb + data_size);    /* actual tcb location */
2649
2650     dtv_size = (tls_max_index + 2) * sizeof(Elf_Addr);
2651     dtv = malloc(dtv_size);
2652     bzero(dtv, dtv_size);
2653
2654 #ifdef RTLD_TCB_HAS_SELF_POINTER
2655     tcb->tcb_self = tcb;
2656 #endif
2657     tcb->tcb_dtv = dtv;
2658     tcb->tcb_pthread = NULL;
2659
2660     dtv[0] = tls_dtv_generation;
2661     dtv[1] = tls_max_index;
2662
2663     for (obj = objs; obj; obj = obj->next) {
2664         if (obj->tlsoffset) {
2665             addr = (Elf_Addr)tcb - obj->tlsoffset;
2666             memset((void *)(addr + obj->tlsinitsize),
2667                    0, obj->tlssize - obj->tlsinitsize);
2668             if (obj->tlsinit)
2669                 memcpy((void*) addr, obj->tlsinit, obj->tlsinitsize);
2670             dtv[obj->tlsindex + 1] = addr;
2671         }
2672     }
2673     return(tcb);
2674 }
2675
2676 void
2677 free_tls(struct tls_tcb *tcb)
2678 {
2679     Elf_Addr *dtv;
2680     int dtv_size, i;
2681     Elf_Addr tls_start, tls_end;
2682     size_t data_size;
2683
2684     data_size = (tls_static_space + RTLD_STATIC_TLS_ALIGN_MASK) &
2685                 ~RTLD_STATIC_TLS_ALIGN_MASK;
2686     dtv = tcb->tcb_dtv;
2687     dtv_size = dtv[1];
2688     tls_end = (Elf_Addr)tcb;
2689     tls_start = (Elf_Addr)tcb - data_size;
2690     for (i = 0; i < dtv_size; i++) {
2691         if (dtv[i+2] != NULL && (dtv[i+2] < tls_start || dtv[i+2] > tls_end)) {
2692             free((void *)dtv[i+2]);
2693         }
2694     }
2695     free((void *)tls_start);
2696 }
2697
2698 #else
2699 #error "Unsupported TLS layout"
2700 #endif
2701
2702 /*
2703  * Allocate TLS block for module with given index.
2704  */
2705 void *
2706 allocate_module_tls(int index)
2707 {
2708     Obj_Entry* obj;
2709     char* p;
2710
2711     for (obj = obj_list; obj; obj = obj->next) {
2712         if (obj->tlsindex == index)
2713             break;
2714     }
2715     if (!obj) {
2716         _rtld_error("Can't find module with TLS index %d", index);
2717         die();
2718     }
2719
2720     p = malloc(obj->tlssize);
2721     memcpy(p, obj->tlsinit, obj->tlsinitsize);
2722     memset(p + obj->tlsinitsize, 0, obj->tlssize - obj->tlsinitsize);
2723
2724     return p;
2725 }
2726
2727 bool
2728 allocate_tls_offset(Obj_Entry *obj)
2729 {
2730     size_t off;
2731
2732     if (obj->tls_done)
2733         return true;
2734
2735     if (obj->tlssize == 0) {
2736         obj->tls_done = true;
2737         return true;
2738     }
2739
2740     if (obj->tlsindex == 1)
2741         off = calculate_first_tls_offset(obj->tlssize, obj->tlsalign);
2742     else
2743         off = calculate_tls_offset(tls_last_offset, tls_last_size,
2744                                    obj->tlssize, obj->tlsalign);
2745
2746     /*
2747      * If we have already fixed the size of the static TLS block, we
2748      * must stay within that size. When allocating the static TLS, we
2749      * leave a small amount of space spare to be used for dynamically
2750      * loading modules which use static TLS.
2751      */
2752     if (tls_static_space) {
2753         if (calculate_tls_end(off, obj->tlssize) > tls_static_space)
2754             return false;
2755     }
2756
2757     tls_last_offset = obj->tlsoffset = off;
2758     tls_last_size = obj->tlssize;
2759     obj->tls_done = true;
2760
2761     return true;
2762 }
2763
2764 void
2765 free_tls_offset(Obj_Entry *obj)
2766 {
2767 #ifdef RTLD_STATIC_TLS_VARIANT_II
2768     /*
2769      * If we were the last thing to allocate out of the static TLS
2770      * block, we give our space back to the 'allocator'. This is a
2771      * simplistic workaround to allow libGL.so.1 to be loaded and
2772      * unloaded multiple times. We only handle the Variant II
2773      * mechanism for now - this really needs a proper allocator.
2774      */
2775     if (calculate_tls_end(obj->tlsoffset, obj->tlssize)
2776         == calculate_tls_end(tls_last_offset, tls_last_size)) {
2777         tls_last_offset -= obj->tlssize;
2778         tls_last_size = 0;
2779     }
2780 #endif
2781 }
2782
2783 struct tls_tcb *
2784 _rtld_allocate_tls(void)
2785 {
2786     struct tls_tcb *new_tcb;
2787
2788     wlock_acquire();
2789     new_tcb = allocate_tls(obj_list);
2790     wlock_release();
2791
2792     return (new_tcb);
2793 }
2794
2795 void
2796 _rtld_free_tls(struct tls_tcb *tcb)
2797 {
2798     wlock_acquire();
2799     free_tls(tcb);
2800     wlock_release();
2801 }
2802