2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright 1996, 1997, 1998, 1999, 2000 John D. Polstra.
5 * Copyright 2003 Alexander Kabaev <kan@FreeBSD.ORG>.
6 * Copyright 2009-2013 Konstantin Belousov <kib@FreeBSD.ORG>.
7 * Copyright 2012 John Marino <draco@marino.st>.
8 * Copyright 2014-2017 The FreeBSD Foundation
11 * Portions of this software were developed by Konstantin Belousov
12 * under sponsorship from the FreeBSD Foundation.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 * Dynamic linker for ELF.
38 * John Polstra <jdp@polstra.com>.
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
44 #include <sys/param.h>
45 #include <sys/mount.h>
48 #include <sys/sysctl.h>
50 #include <sys/utsname.h>
51 #include <sys/ktrace.h>
68 #include "rtld_printf.h"
69 #include "rtld_malloc.h"
70 #include "rtld_utrace.h"
72 #include "rtld_libc.h"
75 typedef void (*func_ptr_type)(void);
76 typedef void * (*path_enum_proc) (const char *path, size_t len, void *arg);
79 /* Variables that cannot be static: */
80 extern struct r_debug r_debug; /* For GDB */
81 extern int _thread_autoinit_dummy_decl;
82 extern void (*__cleanup)(void);
86 * Function declarations.
88 static const char *basename(const char *);
89 static void digest_dynamic1(Obj_Entry *, int, const Elf_Dyn **,
90 const Elf_Dyn **, const Elf_Dyn **);
91 static bool digest_dynamic2(Obj_Entry *, const Elf_Dyn *, const Elf_Dyn *,
93 static bool digest_dynamic(Obj_Entry *, int);
94 static Obj_Entry *digest_phdr(const Elf_Phdr *, int, caddr_t, const char *);
95 static void distribute_static_tls(Objlist *, RtldLockState *);
96 static Obj_Entry *dlcheck(void *);
97 static int dlclose_locked(void *, RtldLockState *);
98 static Obj_Entry *dlopen_object(const char *name, int fd, Obj_Entry *refobj,
99 int lo_flags, int mode, RtldLockState *lockstate);
100 static Obj_Entry *do_load_object(int, const char *, char *, struct stat *, int);
101 static int do_search_info(const Obj_Entry *obj, int, struct dl_serinfo *);
102 static bool donelist_check(DoneList *, const Obj_Entry *);
103 static void errmsg_restore(char *);
104 static char *errmsg_save(void);
105 static void *fill_search_info(const char *, size_t, void *);
106 static char *find_library(const char *, const Obj_Entry *, int *);
107 static const char *gethints(bool);
108 static void hold_object(Obj_Entry *);
109 static void unhold_object(Obj_Entry *);
110 static void init_dag(Obj_Entry *);
111 static void init_marker(Obj_Entry *);
112 static void init_pagesizes(Elf_Auxinfo **aux_info);
113 static void init_rtld(caddr_t, Elf_Auxinfo **);
114 static void initlist_add_neededs(Needed_Entry *, Objlist *);
115 static void initlist_add_objects(Obj_Entry *, Obj_Entry *, Objlist *);
116 static int initlist_objects_ifunc(Objlist *, bool, int, RtldLockState *);
117 static void linkmap_add(Obj_Entry *);
118 static void linkmap_delete(Obj_Entry *);
119 static void load_filtees(Obj_Entry *, int flags, RtldLockState *);
120 static void unload_filtees(Obj_Entry *, RtldLockState *);
121 static int load_needed_objects(Obj_Entry *, int);
122 static int load_preload_objects(void);
123 static Obj_Entry *load_object(const char *, int fd, const Obj_Entry *, int);
124 static void map_stacks_exec(RtldLockState *);
125 static int obj_disable_relro(Obj_Entry *);
126 static int obj_enforce_relro(Obj_Entry *);
127 static Obj_Entry *obj_from_addr(const void *);
128 static void objlist_call_fini(Objlist *, Obj_Entry *, RtldLockState *);
129 static void objlist_call_init(Objlist *, RtldLockState *);
130 static void objlist_clear(Objlist *);
131 static Objlist_Entry *objlist_find(Objlist *, const Obj_Entry *);
132 static void objlist_init(Objlist *);
133 static void objlist_push_head(Objlist *, Obj_Entry *);
134 static void objlist_push_tail(Objlist *, Obj_Entry *);
135 static void objlist_put_after(Objlist *, Obj_Entry *, Obj_Entry *);
136 static void objlist_remove(Objlist *, Obj_Entry *);
137 static int open_binary_fd(const char *argv0, bool search_in_path,
138 const char **binpath_res);
139 static int parse_args(char* argv[], int argc, bool *use_pathp, int *fdp,
141 static int parse_integer(const char *);
142 static void *path_enumerate(const char *, path_enum_proc, const char *, void *);
143 static void print_usage(const char *argv0);
144 static void release_object(Obj_Entry *);
145 static int relocate_object_dag(Obj_Entry *root, bool bind_now,
146 Obj_Entry *rtldobj, int flags, RtldLockState *lockstate);
147 static int relocate_object(Obj_Entry *obj, bool bind_now, Obj_Entry *rtldobj,
148 int flags, RtldLockState *lockstate);
149 static int relocate_objects(Obj_Entry *, bool, Obj_Entry *, int,
151 static int resolve_object_ifunc(Obj_Entry *, bool, int, RtldLockState *);
152 static int rtld_dirname(const char *, char *);
153 static int rtld_dirname_abs(const char *, char *);
154 static void *rtld_dlopen(const char *name, int fd, int mode);
155 static void rtld_exit(void);
156 static void rtld_nop_exit(void);
157 static char *search_library_path(const char *, const char *, const char *,
159 static char *search_library_pathfds(const char *, const char *, int *);
160 static const void **get_program_var_addr(const char *, RtldLockState *);
161 static void set_program_var(const char *, const void *);
162 static int symlook_default(SymLook *, const Obj_Entry *refobj);
163 static int symlook_global(SymLook *, DoneList *);
164 static void symlook_init_from_req(SymLook *, const SymLook *);
165 static int symlook_list(SymLook *, const Objlist *, DoneList *);
166 static int symlook_needed(SymLook *, const Needed_Entry *, DoneList *);
167 static int symlook_obj1_sysv(SymLook *, const Obj_Entry *);
168 static int symlook_obj1_gnu(SymLook *, const Obj_Entry *);
169 static void trace_loaded_objects(Obj_Entry *);
170 static void unlink_object(Obj_Entry *);
171 static void unload_object(Obj_Entry *, RtldLockState *lockstate);
172 static void unref_dag(Obj_Entry *);
173 static void ref_dag(Obj_Entry *);
174 static char *origin_subst_one(Obj_Entry *, char *, const char *,
176 static char *origin_subst(Obj_Entry *, const char *);
177 static bool obj_resolve_origin(Obj_Entry *obj);
178 static void preinit_main(void);
179 static int rtld_verify_versions(const Objlist *);
180 static int rtld_verify_object_versions(Obj_Entry *);
181 static void object_add_name(Obj_Entry *, const char *);
182 static int object_match_name(const Obj_Entry *, const char *);
183 static void ld_utrace_log(int, void *, void *, size_t, int, const char *);
184 static void rtld_fill_dl_phdr_info(const Obj_Entry *obj,
185 struct dl_phdr_info *phdr_info);
186 static uint32_t gnu_hash(const char *);
187 static bool matched_symbol(SymLook *, const Obj_Entry *, Sym_Match_Result *,
188 const unsigned long);
190 void r_debug_state(struct r_debug *, struct link_map *) __noinline __exported;
191 void _r_debug_postinit(struct link_map *) __noinline __exported;
193 int __sys_openat(int, const char *, int, ...);
198 static char *error_message; /* Message for dlerror(), or NULL */
199 struct r_debug r_debug __exported; /* for GDB; */
200 static bool libmap_disable; /* Disable libmap */
201 static bool ld_loadfltr; /* Immediate filters processing */
202 static char *libmap_override; /* Maps to use in addition to libmap.conf */
203 static bool trust; /* False for setuid and setgid programs */
204 static bool dangerous_ld_env; /* True if environment variables have been
205 used to affect the libraries loaded */
206 bool ld_bind_not; /* Disable PLT update */
207 static char *ld_bind_now; /* Environment variable for immediate binding */
208 static char *ld_debug; /* Environment variable for debugging */
209 static char *ld_library_path; /* Environment variable for search path */
210 static char *ld_library_dirs; /* Environment variable for library descriptors */
211 static char *ld_preload; /* Environment variable for libraries to
213 static const char *ld_elf_hints_path; /* Environment variable for alternative hints path */
214 static const char *ld_tracing; /* Called from ldd to print libs */
215 static char *ld_utrace; /* Use utrace() to log events. */
216 static struct obj_entry_q obj_list; /* Queue of all loaded objects */
217 static Obj_Entry *obj_main; /* The main program shared object */
218 static Obj_Entry obj_rtld; /* The dynamic linker shared object */
219 static unsigned int obj_count; /* Number of objects in obj_list */
220 static unsigned int obj_loads; /* Number of loads of objects (gen count) */
222 static Objlist list_global = /* Objects dlopened with RTLD_GLOBAL */
223 STAILQ_HEAD_INITIALIZER(list_global);
224 static Objlist list_main = /* Objects loaded at program startup */
225 STAILQ_HEAD_INITIALIZER(list_main);
226 static Objlist list_fini = /* Objects needing fini() calls */
227 STAILQ_HEAD_INITIALIZER(list_fini);
229 Elf_Sym sym_zero; /* For resolving undefined weak refs. */
231 #define GDB_STATE(s,m) r_debug.r_state = s; r_debug_state(&r_debug,m);
233 extern Elf_Dyn _DYNAMIC;
234 #pragma weak _DYNAMIC
236 int dlclose(void *) __exported;
237 char *dlerror(void) __exported;
238 void *dlopen(const char *, int) __exported;
239 void *fdlopen(int, int) __exported;
240 void *dlsym(void *, const char *) __exported;
241 dlfunc_t dlfunc(void *, const char *) __exported;
242 void *dlvsym(void *, const char *, const char *) __exported;
243 int dladdr(const void *, Dl_info *) __exported;
244 void dllockinit(void *, void *(*)(void *), void (*)(void *), void (*)(void *),
245 void (*)(void *), void (*)(void *), void (*)(void *)) __exported;
246 int dlinfo(void *, int , void *) __exported;
247 int dl_iterate_phdr(__dl_iterate_hdr_callback, void *) __exported;
248 int _rtld_addr_phdr(const void *, struct dl_phdr_info *) __exported;
249 int _rtld_get_stack_prot(void) __exported;
250 int _rtld_is_dlopened(void *) __exported;
251 void _rtld_error(const char *, ...) __exported;
253 /* Only here to fix -Wmissing-prototypes warnings */
254 int __getosreldate(void);
255 func_ptr_type _rtld(Elf_Addr *sp, func_ptr_type *exit_proc, Obj_Entry **objp);
256 Elf_Addr _rtld_bind(Obj_Entry *obj, Elf_Size reloff);
260 static int osreldate;
263 static int stack_prot = PROT_READ | PROT_WRITE | RTLD_DEFAULT_STACK_EXEC;
264 static int max_stack_flags;
267 * Global declarations normally provided by crt1. The dynamic linker is
268 * not built with crt1, so we have to provide them ourselves.
274 * Used to pass argc, argv to init functions.
280 * Globals to control TLS allocation.
282 size_t tls_last_offset; /* Static TLS offset of last module */
283 size_t tls_last_size; /* Static TLS size of last module */
284 size_t tls_static_space; /* Static TLS space allocated */
285 static size_t tls_static_max_align;
286 Elf_Addr tls_dtv_generation = 1; /* Used to detect when dtv size changes */
287 int tls_max_index = 1; /* Largest module index allocated */
289 static bool ld_library_path_rpath = false;
290 bool ld_fast_sigblock = false;
293 * Globals for path names, and such
295 const char *ld_elf_hints_default = _PATH_ELF_HINTS;
296 const char *ld_path_libmap_conf = _PATH_LIBMAP_CONF;
297 const char *ld_path_rtld = _PATH_RTLD;
298 const char *ld_standard_library_path = STANDARD_LIBRARY_PATH;
299 const char *ld_env_prefix = LD_;
301 static void (*rtld_exit_ptr)(void);
304 * Fill in a DoneList with an allocation large enough to hold all of
305 * the currently-loaded objects. Keep this as a macro since it calls
306 * alloca and we want that to occur within the scope of the caller.
308 #define donelist_init(dlp) \
309 ((dlp)->objs = alloca(obj_count * sizeof (dlp)->objs[0]), \
310 assert((dlp)->objs != NULL), \
311 (dlp)->num_alloc = obj_count, \
314 #define LD_UTRACE(e, h, mb, ms, r, n) do { \
315 if (ld_utrace != NULL) \
316 ld_utrace_log(e, h, mb, ms, r, n); \
320 ld_utrace_log(int event, void *handle, void *mapbase, size_t mapsize,
321 int refcnt, const char *name)
323 struct utrace_rtld ut;
324 static const char rtld_utrace_sig[RTLD_UTRACE_SIG_SZ] = RTLD_UTRACE_SIG;
326 memcpy(ut.sig, rtld_utrace_sig, sizeof(ut.sig));
329 ut.mapbase = mapbase;
330 ut.mapsize = mapsize;
332 bzero(ut.name, sizeof(ut.name));
334 strlcpy(ut.name, name, sizeof(ut.name));
335 utrace(&ut, sizeof(ut));
338 #ifdef RTLD_VARIANT_ENV_NAMES
340 * construct the env variable based on the type of binary that's
343 static inline const char *
346 static char buffer[128];
348 strlcpy(buffer, ld_env_prefix, sizeof(buffer));
349 strlcat(buffer, var, sizeof(buffer));
357 * Main entry point for dynamic linking. The first argument is the
358 * stack pointer. The stack is expected to be laid out as described
359 * in the SVR4 ABI specification, Intel 386 Processor Supplement.
360 * Specifically, the stack pointer points to a word containing
361 * ARGC. Following that in the stack is a null-terminated sequence
362 * of pointers to argument strings. Then comes a null-terminated
363 * sequence of pointers to environment strings. Finally, there is a
364 * sequence of "auxiliary vector" entries.
366 * The second argument points to a place to store the dynamic linker's
367 * exit procedure pointer and the third to a place to store the main
370 * The return value is the main program's entry point.
373 _rtld(Elf_Addr *sp, func_ptr_type *exit_proc, Obj_Entry **objp)
375 Elf_Auxinfo *aux, *auxp, *auxpf, *aux_info[AT_COUNT];
376 Objlist_Entry *entry;
377 Obj_Entry *last_interposer, *obj, *preload_tail;
378 const Elf_Phdr *phdr;
380 RtldLockState lockstate;
383 char **argv, **env, **envp, *kexecpath, *library_path_rpath;
384 const char *argv0, *binpath;
386 char buf[MAXPATHLEN];
387 int argc, fd, i, mib[4], old_osrel, osrel, phnum, rtld_argc;
390 int old_auxv_format = 1;
392 bool dir_enable, direct_exec, explicit_fd, search_in_path;
395 * On entry, the dynamic linker itself has not been relocated yet.
396 * Be very careful not to reference any global data until after
397 * init_rtld has returned. It is OK to reference file-scope statics
398 * and string constants, and to call static and global functions.
401 /* Find the auxiliary vector on the stack. */
405 sp += argc + 1; /* Skip over arguments and NULL terminator */
407 while (*sp++ != 0) /* Skip over environment, and NULL terminator */
409 aux = (Elf_Auxinfo *) sp;
411 /* Digest the auxiliary vector. */
412 for (i = 0; i < AT_COUNT; i++)
414 for (auxp = aux; auxp->a_type != AT_NULL; auxp++) {
415 if (auxp->a_type < AT_COUNT)
416 aux_info[auxp->a_type] = auxp;
418 if (auxp->a_type == 23) /* AT_STACKPROT */
424 if (old_auxv_format) {
425 /* Remap from old-style auxv numbers. */
426 aux_info[23] = aux_info[21]; /* AT_STACKPROT */
427 aux_info[21] = aux_info[19]; /* AT_PAGESIZESLEN */
428 aux_info[19] = aux_info[17]; /* AT_NCPUS */
429 aux_info[17] = aux_info[15]; /* AT_CANARYLEN */
430 aux_info[15] = aux_info[13]; /* AT_EXECPATH */
431 aux_info[13] = NULL; /* AT_GID */
433 aux_info[20] = aux_info[18]; /* AT_PAGESIZES */
434 aux_info[18] = aux_info[16]; /* AT_OSRELDATE */
435 aux_info[16] = aux_info[14]; /* AT_CANARY */
436 aux_info[14] = NULL; /* AT_EGID */
440 /* Initialize and relocate ourselves. */
441 assert(aux_info[AT_BASE] != NULL);
442 init_rtld((caddr_t) aux_info[AT_BASE]->a_un.a_ptr, aux_info);
444 __progname = obj_rtld.path;
445 argv0 = argv[0] != NULL ? argv[0] : "(null)";
450 if (aux_info[AT_BSDFLAGS] != NULL &&
451 (aux_info[AT_BSDFLAGS]->a_un.a_val & ELF_BSDF_SIGFASTBLK) != 0)
452 ld_fast_sigblock = true;
454 trust = !issetugid();
457 md_abi_variant_hook(aux_info);
460 if (aux_info[AT_EXECFD] != NULL) {
461 fd = aux_info[AT_EXECFD]->a_un.a_val;
463 assert(aux_info[AT_PHDR] != NULL);
464 phdr = (const Elf_Phdr *)aux_info[AT_PHDR]->a_un.a_ptr;
465 if (phdr == obj_rtld.phdr) {
467 _rtld_error("Tainted process refusing to run binary %s",
474 * Set osrel for us, it is later reset to the binary'
475 * value before first instruction of code from the binary
480 mib[2] = KERN_PROC_OSREL;
482 osrel = __FreeBSD_version;
483 sz = sizeof(old_osrel);
484 (void)sysctl(mib, 4, &old_osrel, &sz, &osrel, sizeof(osrel));
486 dbg("opening main program in direct exec mode");
488 rtld_argc = parse_args(argv, argc, &search_in_path, &fd, &argv0);
489 explicit_fd = (fd != -1);
492 fd = open_binary_fd(argv0, search_in_path, &binpath);
493 if (fstat(fd, &st) == -1) {
494 _rtld_error("Failed to fstat FD %d (%s): %s", fd,
495 explicit_fd ? "user-provided descriptor" : argv0,
496 rtld_strerror(errno));
501 * Rough emulation of the permission checks done by
502 * execve(2), only Unix DACs are checked, ACLs are
503 * ignored. Preserve the semantic of disabling owner
504 * to execute if owner x bit is cleared, even if
505 * others x bit is enabled.
506 * mmap(2) does not allow to mmap with PROT_EXEC if
507 * binary' file comes from noexec mount. We cannot
508 * set a text reference on the binary.
511 if (st.st_uid == geteuid()) {
512 if ((st.st_mode & S_IXUSR) != 0)
514 } else if (st.st_gid == getegid()) {
515 if ((st.st_mode & S_IXGRP) != 0)
517 } else if ((st.st_mode & S_IXOTH) != 0) {
521 _rtld_error("No execute permission for binary %s",
527 * For direct exec mode, argv[0] is the interpreter
528 * name, we must remove it and shift arguments left
529 * before invoking binary main. Since stack layout
530 * places environment pointers and aux vectors right
531 * after the terminating NULL, we must shift
532 * environment and aux as well.
534 main_argc = argc - rtld_argc;
535 for (i = 0; i <= main_argc; i++)
536 argv[i] = argv[i + rtld_argc];
538 environ = env = envp = argv + main_argc + 1;
539 dbg("move env from %p to %p", envp + rtld_argc, envp);
541 *envp = *(envp + rtld_argc);
542 } while (*envp++ != NULL);
543 aux = auxp = (Elf_Auxinfo *)envp;
544 auxpf = (Elf_Auxinfo *)(envp + rtld_argc);
545 dbg("move aux from %p to %p", auxpf, aux);
546 /* XXXKIB insert place for AT_EXECPATH if not present */
547 for (;; auxp++, auxpf++) {
549 if (auxp->a_type == AT_NULL)
552 /* Since the auxiliary vector has moved, redigest it. */
553 for (i = 0; i < AT_COUNT; i++)
555 for (auxp = aux; auxp->a_type != AT_NULL; auxp++) {
556 if (auxp->a_type < AT_COUNT)
557 aux_info[auxp->a_type] = auxp;
560 /* Point AT_EXECPATH auxv and aux_info to the binary path. */
561 if (binpath == NULL) {
562 aux_info[AT_EXECPATH] = NULL;
564 if (aux_info[AT_EXECPATH] == NULL) {
565 aux_info[AT_EXECPATH] = xmalloc(sizeof(Elf_Auxinfo));
566 aux_info[AT_EXECPATH]->a_type = AT_EXECPATH;
568 aux_info[AT_EXECPATH]->a_un.a_ptr = __DECONST(void *,
572 _rtld_error("No binary");
578 ld_bind_now = getenv(_LD("BIND_NOW"));
581 * If the process is tainted, then we un-set the dangerous environment
582 * variables. The process will be marked as tainted until setuid(2)
583 * is called. If any child process calls setuid(2) we do not want any
584 * future processes to honor the potentially un-safe variables.
587 if (unsetenv(_LD("PRELOAD")) || unsetenv(_LD("LIBMAP")) ||
588 unsetenv(_LD("LIBRARY_PATH")) || unsetenv(_LD("LIBRARY_PATH_FDS")) ||
589 unsetenv(_LD("LIBMAP_DISABLE")) || unsetenv(_LD("BIND_NOT")) ||
590 unsetenv(_LD("DEBUG")) || unsetenv(_LD("ELF_HINTS_PATH")) ||
591 unsetenv(_LD("LOADFLTR")) || unsetenv(_LD("LIBRARY_PATH_RPATH"))) {
592 _rtld_error("environment corrupt; aborting");
596 ld_debug = getenv(_LD("DEBUG"));
597 if (ld_bind_now == NULL)
598 ld_bind_not = getenv(_LD("BIND_NOT")) != NULL;
599 libmap_disable = getenv(_LD("LIBMAP_DISABLE")) != NULL;
600 libmap_override = getenv(_LD("LIBMAP"));
601 ld_library_path = getenv(_LD("LIBRARY_PATH"));
602 ld_library_dirs = getenv(_LD("LIBRARY_PATH_FDS"));
603 ld_preload = getenv(_LD("PRELOAD"));
604 ld_elf_hints_path = getenv(_LD("ELF_HINTS_PATH"));
605 ld_loadfltr = getenv(_LD("LOADFLTR")) != NULL;
606 library_path_rpath = getenv(_LD("LIBRARY_PATH_RPATH"));
607 if (library_path_rpath != NULL) {
608 if (library_path_rpath[0] == 'y' ||
609 library_path_rpath[0] == 'Y' ||
610 library_path_rpath[0] == '1')
611 ld_library_path_rpath = true;
613 ld_library_path_rpath = false;
615 dangerous_ld_env = libmap_disable || (libmap_override != NULL) ||
616 (ld_library_path != NULL) || (ld_preload != NULL) ||
617 (ld_elf_hints_path != NULL) || ld_loadfltr;
618 ld_tracing = getenv(_LD("TRACE_LOADED_OBJECTS"));
619 ld_utrace = getenv(_LD("UTRACE"));
621 if ((ld_elf_hints_path == NULL) || strlen(ld_elf_hints_path) == 0)
622 ld_elf_hints_path = ld_elf_hints_default;
624 if (ld_debug != NULL && *ld_debug != '\0')
626 dbg("%s is initialized, base address = %p", __progname,
627 (caddr_t) aux_info[AT_BASE]->a_un.a_ptr);
628 dbg("RTLD dynamic = %p", obj_rtld.dynamic);
629 dbg("RTLD pltgot = %p", obj_rtld.pltgot);
631 dbg("initializing thread locks");
635 * Load the main program, or process its program header if it is
638 if (fd != -1) { /* Load the main program. */
639 dbg("loading main program");
640 obj_main = map_object(fd, argv0, NULL);
642 if (obj_main == NULL)
644 max_stack_flags = obj_main->stack_flags;
645 } else { /* Main program already loaded. */
646 dbg("processing main program's program header");
647 assert(aux_info[AT_PHDR] != NULL);
648 phdr = (const Elf_Phdr *) aux_info[AT_PHDR]->a_un.a_ptr;
649 assert(aux_info[AT_PHNUM] != NULL);
650 phnum = aux_info[AT_PHNUM]->a_un.a_val;
651 assert(aux_info[AT_PHENT] != NULL);
652 assert(aux_info[AT_PHENT]->a_un.a_val == sizeof(Elf_Phdr));
653 assert(aux_info[AT_ENTRY] != NULL);
654 imgentry = (caddr_t) aux_info[AT_ENTRY]->a_un.a_ptr;
655 if ((obj_main = digest_phdr(phdr, phnum, imgentry, argv0)) == NULL)
659 if (aux_info[AT_EXECPATH] != NULL && fd == -1) {
660 kexecpath = aux_info[AT_EXECPATH]->a_un.a_ptr;
661 dbg("AT_EXECPATH %p %s", kexecpath, kexecpath);
662 if (kexecpath[0] == '/')
663 obj_main->path = kexecpath;
664 else if (getcwd(buf, sizeof(buf)) == NULL ||
665 strlcat(buf, "/", sizeof(buf)) >= sizeof(buf) ||
666 strlcat(buf, kexecpath, sizeof(buf)) >= sizeof(buf))
667 obj_main->path = xstrdup(argv0);
669 obj_main->path = xstrdup(buf);
671 dbg("No AT_EXECPATH or direct exec");
672 obj_main->path = xstrdup(argv0);
674 dbg("obj_main path %s", obj_main->path);
675 obj_main->mainprog = true;
677 if (aux_info[AT_STACKPROT] != NULL &&
678 aux_info[AT_STACKPROT]->a_un.a_val != 0)
679 stack_prot = aux_info[AT_STACKPROT]->a_un.a_val;
683 * Get the actual dynamic linker pathname from the executable if
684 * possible. (It should always be possible.) That ensures that
685 * gdb will find the right dynamic linker even if a non-standard
688 if (obj_main->interp != NULL &&
689 strcmp(obj_main->interp, obj_rtld.path) != 0) {
691 obj_rtld.path = xstrdup(obj_main->interp);
692 __progname = obj_rtld.path;
696 if (!digest_dynamic(obj_main, 0))
698 dbg("%s valid_hash_sysv %d valid_hash_gnu %d dynsymcount %d",
699 obj_main->path, obj_main->valid_hash_sysv, obj_main->valid_hash_gnu,
700 obj_main->dynsymcount);
702 linkmap_add(obj_main);
703 linkmap_add(&obj_rtld);
705 /* Link the main program into the list of objects. */
706 TAILQ_INSERT_HEAD(&obj_list, obj_main, next);
710 /* Initialize a fake symbol for resolving undefined weak references. */
711 sym_zero.st_info = ELF_ST_INFO(STB_GLOBAL, STT_NOTYPE);
712 sym_zero.st_shndx = SHN_UNDEF;
713 sym_zero.st_value = -(uintptr_t)obj_main->relocbase;
716 libmap_disable = (bool)lm_init(libmap_override);
718 dbg("loading LD_PRELOAD libraries");
719 if (load_preload_objects() == -1)
721 preload_tail = globallist_curr(TAILQ_LAST(&obj_list, obj_entry_q));
723 dbg("loading needed objects");
724 if (load_needed_objects(obj_main, ld_tracing != NULL ? RTLD_LO_TRACE :
728 /* Make a list of all objects loaded at startup. */
729 last_interposer = obj_main;
730 TAILQ_FOREACH(obj, &obj_list, next) {
733 if (obj->z_interpose && obj != obj_main) {
734 objlist_put_after(&list_main, last_interposer, obj);
735 last_interposer = obj;
737 objlist_push_tail(&list_main, obj);
742 dbg("checking for required versions");
743 if (rtld_verify_versions(&list_main) == -1 && !ld_tracing)
746 if (ld_tracing) { /* We're done */
747 trace_loaded_objects(obj_main);
751 if (getenv(_LD("DUMP_REL_PRE")) != NULL) {
752 dump_relocations(obj_main);
757 * Processing tls relocations requires having the tls offsets
758 * initialized. Prepare offsets before starting initial
759 * relocation processing.
761 dbg("initializing initial thread local storage offsets");
762 STAILQ_FOREACH(entry, &list_main, link) {
764 * Allocate all the initial objects out of the static TLS
765 * block even if they didn't ask for it.
767 allocate_tls_offset(entry->obj);
770 if (relocate_objects(obj_main,
771 ld_bind_now != NULL && *ld_bind_now != '\0',
772 &obj_rtld, SYMLOOK_EARLY, NULL) == -1)
775 dbg("doing copy relocations");
776 if (do_copy_relocations(obj_main) == -1)
779 if (getenv(_LD("DUMP_REL_POST")) != NULL) {
780 dump_relocations(obj_main);
787 * Setup TLS for main thread. This must be done after the
788 * relocations are processed, since tls initialization section
789 * might be the subject for relocations.
791 dbg("initializing initial thread local storage");
792 allocate_initial_tls(globallist_curr(TAILQ_FIRST(&obj_list)));
794 dbg("initializing key program variables");
795 set_program_var("__progname", argv[0] != NULL ? basename(argv[0]) : "");
796 set_program_var("environ", env);
797 set_program_var("__elf_aux_vector", aux);
799 /* Make a list of init functions to call. */
800 objlist_init(&initlist);
801 initlist_add_objects(globallist_curr(TAILQ_FIRST(&obj_list)),
802 preload_tail, &initlist);
804 r_debug_state(NULL, &obj_main->linkmap); /* say hello to gdb! */
806 map_stacks_exec(NULL);
808 if (!obj_main->crt_no_init) {
810 * Make sure we don't call the main program's init and fini
811 * functions for binaries linked with old crt1 which calls
814 obj_main->init = obj_main->fini = (Elf_Addr)NULL;
815 obj_main->preinit_array = obj_main->init_array =
816 obj_main->fini_array = (Elf_Addr)NULL;
820 * Execute MD initializers required before we call the objects'
826 /* Set osrel for direct-execed binary */
829 mib[2] = KERN_PROC_OSREL;
831 osrel = obj_main->osrel;
832 sz = sizeof(old_osrel);
833 dbg("setting osrel to %d", osrel);
834 (void)sysctl(mib, 4, &old_osrel, &sz, &osrel, sizeof(osrel));
837 wlock_acquire(rtld_bind_lock, &lockstate);
839 dbg("resolving ifuncs");
840 if (initlist_objects_ifunc(&initlist, ld_bind_now != NULL &&
841 *ld_bind_now != '\0', SYMLOOK_EARLY, &lockstate) == -1)
844 rtld_exit_ptr = rtld_exit;
845 if (obj_main->crt_no_init)
847 objlist_call_init(&initlist, &lockstate);
848 _r_debug_postinit(&obj_main->linkmap);
849 objlist_clear(&initlist);
850 dbg("loading filtees");
851 TAILQ_FOREACH(obj, &obj_list, next) {
854 if (ld_loadfltr || obj->z_loadfltr)
855 load_filtees(obj, 0, &lockstate);
858 dbg("enforcing main obj relro");
859 if (obj_enforce_relro(obj_main) == -1)
862 lock_release(rtld_bind_lock, &lockstate);
864 dbg("transferring control to program entry point = %p", obj_main->entry);
866 /* Return the exit procedure and the program entry point. */
867 *exit_proc = rtld_exit_ptr;
869 return (func_ptr_type) obj_main->entry;
873 rtld_resolve_ifunc(const Obj_Entry *obj, const Elf_Sym *def)
878 ptr = (void *)make_function_pointer(def, obj);
879 target = call_ifunc_resolver(ptr);
880 return ((void *)target);
884 * NB: MIPS uses a private version of this function (_mips_rtld_bind).
885 * Changes to this function should be applied there as well.
888 _rtld_bind(Obj_Entry *obj, Elf_Size reloff)
892 const Obj_Entry *defobj;
895 RtldLockState lockstate;
897 rlock_acquire(rtld_bind_lock, &lockstate);
898 if (sigsetjmp(lockstate.env, 0) != 0)
899 lock_upgrade(rtld_bind_lock, &lockstate);
901 rel = (const Elf_Rel *)((const char *)obj->pltrel + reloff);
903 rel = (const Elf_Rel *)((const char *)obj->pltrela + reloff);
905 where = (Elf_Addr *)(obj->relocbase + rel->r_offset);
906 def = find_symdef(ELF_R_SYM(rel->r_info), obj, &defobj, SYMLOOK_IN_PLT,
910 if (ELF_ST_TYPE(def->st_info) == STT_GNU_IFUNC)
911 target = (Elf_Addr)rtld_resolve_ifunc(defobj, def);
913 target = (Elf_Addr)(defobj->relocbase + def->st_value);
915 dbg("\"%s\" in \"%s\" ==> %p in \"%s\"",
916 defobj->strtab + def->st_name, basename(obj->path),
917 (void *)target, basename(defobj->path));
920 * Write the new contents for the jmpslot. Note that depending on
921 * architecture, the value which we need to return back to the
922 * lazy binding trampoline may or may not be the target
923 * address. The value returned from reloc_jmpslot() is the value
924 * that the trampoline needs.
926 target = reloc_jmpslot(where, target, defobj, obj, rel);
927 lock_release(rtld_bind_lock, &lockstate);
932 * Error reporting function. Use it like printf. If formats the message
933 * into a buffer, and sets things up so that the next call to dlerror()
934 * will return the message.
937 _rtld_error(const char *fmt, ...)
939 static char buf[512];
943 rtld_vsnprintf(buf, sizeof buf, fmt, ap);
946 LD_UTRACE(UTRACE_RTLD_ERROR, NULL, NULL, 0, 0, error_message);
950 * Return a dynamically-allocated copy of the current error message, if any.
955 return error_message == NULL ? NULL : xstrdup(error_message);
959 * Restore the current error message from a copy which was previously saved
960 * by errmsg_save(). The copy is freed.
963 errmsg_restore(char *saved_msg)
965 if (saved_msg == NULL)
966 error_message = NULL;
968 _rtld_error("%s", saved_msg);
974 basename(const char *name)
976 const char *p = strrchr(name, '/');
977 return p != NULL ? p + 1 : name;
980 static struct utsname uts;
983 origin_subst_one(Obj_Entry *obj, char *real, const char *kw,
984 const char *subst, bool may_free)
986 char *p, *p1, *res, *resp;
987 int subst_len, kw_len, subst_count, old_len, new_len;
992 * First, count the number of the keyword occurrences, to
993 * preallocate the final string.
995 for (p = real, subst_count = 0;; p = p1 + kw_len, subst_count++) {
1002 * If the keyword is not found, just return.
1004 * Return non-substituted string if resolution failed. We
1005 * cannot do anything more reasonable, the failure mode of the
1006 * caller is unresolved library anyway.
1008 if (subst_count == 0 || (obj != NULL && !obj_resolve_origin(obj)))
1009 return (may_free ? real : xstrdup(real));
1011 subst = obj->origin_path;
1014 * There is indeed something to substitute. Calculate the
1015 * length of the resulting string, and allocate it.
1017 subst_len = strlen(subst);
1018 old_len = strlen(real);
1019 new_len = old_len + (subst_len - kw_len) * subst_count;
1020 res = xmalloc(new_len + 1);
1023 * Now, execute the substitution loop.
1025 for (p = real, resp = res, *resp = '\0';;) {
1028 /* Copy the prefix before keyword. */
1029 memcpy(resp, p, p1 - p);
1031 /* Keyword replacement. */
1032 memcpy(resp, subst, subst_len);
1040 /* Copy to the end of string and finish. */
1048 origin_subst(Obj_Entry *obj, const char *real)
1050 char *res1, *res2, *res3, *res4;
1052 if (obj == NULL || !trust)
1053 return (xstrdup(real));
1054 if (uts.sysname[0] == '\0') {
1055 if (uname(&uts) != 0) {
1056 _rtld_error("utsname failed: %d", errno);
1060 /* __DECONST is safe here since without may_free real is unchanged */
1061 res1 = origin_subst_one(obj, __DECONST(char *, real), "$ORIGIN", NULL,
1063 res2 = origin_subst_one(NULL, res1, "$OSNAME", uts.sysname, true);
1064 res3 = origin_subst_one(NULL, res2, "$OSREL", uts.release, true);
1065 res4 = origin_subst_one(NULL, res3, "$PLATFORM", uts.machine, true);
1072 const char *msg = dlerror();
1075 msg = "Fatal error";
1076 rtld_fdputstr(STDERR_FILENO, _BASENAME_RTLD ": ");
1077 rtld_fdputstr(STDERR_FILENO, msg);
1078 rtld_fdputchar(STDERR_FILENO, '\n');
1083 * Process a shared object's DYNAMIC section, and save the important
1084 * information in its Obj_Entry structure.
1087 digest_dynamic1(Obj_Entry *obj, int early, const Elf_Dyn **dyn_rpath,
1088 const Elf_Dyn **dyn_soname, const Elf_Dyn **dyn_runpath)
1090 const Elf_Dyn *dynp;
1091 Needed_Entry **needed_tail = &obj->needed;
1092 Needed_Entry **needed_filtees_tail = &obj->needed_filtees;
1093 Needed_Entry **needed_aux_filtees_tail = &obj->needed_aux_filtees;
1094 const Elf_Hashelt *hashtab;
1095 const Elf32_Word *hashval;
1096 Elf32_Word bkt, nmaskwords;
1098 int plttype = DT_REL;
1102 *dyn_runpath = NULL;
1104 obj->bind_now = false;
1105 for (dynp = obj->dynamic; dynp->d_tag != DT_NULL; dynp++) {
1106 switch (dynp->d_tag) {
1109 obj->rel = (const Elf_Rel *)(obj->relocbase + dynp->d_un.d_ptr);
1113 obj->relsize = dynp->d_un.d_val;
1117 assert(dynp->d_un.d_val == sizeof(Elf_Rel));
1121 obj->pltrel = (const Elf_Rel *)
1122 (obj->relocbase + dynp->d_un.d_ptr);
1126 obj->pltrelsize = dynp->d_un.d_val;
1130 obj->rela = (const Elf_Rela *)(obj->relocbase + dynp->d_un.d_ptr);
1134 obj->relasize = dynp->d_un.d_val;
1138 assert(dynp->d_un.d_val == sizeof(Elf_Rela));
1142 plttype = dynp->d_un.d_val;
1143 assert(dynp->d_un.d_val == DT_REL || plttype == DT_RELA);
1147 obj->symtab = (const Elf_Sym *)
1148 (obj->relocbase + dynp->d_un.d_ptr);
1152 assert(dynp->d_un.d_val == sizeof(Elf_Sym));
1156 obj->strtab = (const char *)(obj->relocbase + dynp->d_un.d_ptr);
1160 obj->strsize = dynp->d_un.d_val;
1164 obj->verneed = (const Elf_Verneed *)(obj->relocbase +
1169 obj->verneednum = dynp->d_un.d_val;
1173 obj->verdef = (const Elf_Verdef *)(obj->relocbase +
1178 obj->verdefnum = dynp->d_un.d_val;
1182 obj->versyms = (const Elf_Versym *)(obj->relocbase +
1188 hashtab = (const Elf_Hashelt *)(obj->relocbase +
1190 obj->nbuckets = hashtab[0];
1191 obj->nchains = hashtab[1];
1192 obj->buckets = hashtab + 2;
1193 obj->chains = obj->buckets + obj->nbuckets;
1194 obj->valid_hash_sysv = obj->nbuckets > 0 && obj->nchains > 0 &&
1195 obj->buckets != NULL;
1201 hashtab = (const Elf_Hashelt *)(obj->relocbase +
1203 obj->nbuckets_gnu = hashtab[0];
1204 obj->symndx_gnu = hashtab[1];
1205 nmaskwords = hashtab[2];
1206 bloom_size32 = (__ELF_WORD_SIZE / 32) * nmaskwords;
1207 obj->maskwords_bm_gnu = nmaskwords - 1;
1208 obj->shift2_gnu = hashtab[3];
1209 obj->bloom_gnu = (const Elf_Addr *)(hashtab + 4);
1210 obj->buckets_gnu = hashtab + 4 + bloom_size32;
1211 obj->chain_zero_gnu = obj->buckets_gnu + obj->nbuckets_gnu -
1213 /* Number of bitmask words is required to be power of 2 */
1214 obj->valid_hash_gnu = powerof2(nmaskwords) &&
1215 obj->nbuckets_gnu > 0 && obj->buckets_gnu != NULL;
1221 Needed_Entry *nep = NEW(Needed_Entry);
1222 nep->name = dynp->d_un.d_val;
1227 needed_tail = &nep->next;
1233 Needed_Entry *nep = NEW(Needed_Entry);
1234 nep->name = dynp->d_un.d_val;
1238 *needed_filtees_tail = nep;
1239 needed_filtees_tail = &nep->next;
1241 if (obj->linkmap.l_refname == NULL)
1242 obj->linkmap.l_refname = (char *)dynp->d_un.d_val;
1248 Needed_Entry *nep = NEW(Needed_Entry);
1249 nep->name = dynp->d_un.d_val;
1253 *needed_aux_filtees_tail = nep;
1254 needed_aux_filtees_tail = &nep->next;
1259 obj->pltgot = (Elf_Addr *)(obj->relocbase + dynp->d_un.d_ptr);
1263 obj->textrel = true;
1267 obj->symbolic = true;
1272 * We have to wait until later to process this, because we
1273 * might not have gotten the address of the string table yet.
1283 *dyn_runpath = dynp;
1287 obj->init = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1290 case DT_PREINIT_ARRAY:
1291 obj->preinit_array = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1294 case DT_PREINIT_ARRAYSZ:
1295 obj->preinit_array_num = dynp->d_un.d_val / sizeof(Elf_Addr);
1299 obj->init_array = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1302 case DT_INIT_ARRAYSZ:
1303 obj->init_array_num = dynp->d_un.d_val / sizeof(Elf_Addr);
1307 obj->fini = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1311 obj->fini_array = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1314 case DT_FINI_ARRAYSZ:
1315 obj->fini_array_num = dynp->d_un.d_val / sizeof(Elf_Addr);
1319 * Don't process DT_DEBUG on MIPS as the dynamic section
1320 * is mapped read-only. DT_MIPS_RLD_MAP is used instead.
1326 dbg("Filling in DT_DEBUG entry");
1327 (__DECONST(Elf_Dyn *, dynp))->d_un.d_ptr = (Elf_Addr)&r_debug;
1332 if (dynp->d_un.d_val & DF_ORIGIN)
1333 obj->z_origin = true;
1334 if (dynp->d_un.d_val & DF_SYMBOLIC)
1335 obj->symbolic = true;
1336 if (dynp->d_un.d_val & DF_TEXTREL)
1337 obj->textrel = true;
1338 if (dynp->d_un.d_val & DF_BIND_NOW)
1339 obj->bind_now = true;
1340 if (dynp->d_un.d_val & DF_STATIC_TLS)
1341 obj->static_tls = true;
1344 case DT_MIPS_LOCAL_GOTNO:
1345 obj->local_gotno = dynp->d_un.d_val;
1348 case DT_MIPS_SYMTABNO:
1349 obj->symtabno = dynp->d_un.d_val;
1352 case DT_MIPS_GOTSYM:
1353 obj->gotsym = dynp->d_un.d_val;
1356 case DT_MIPS_RLD_MAP:
1357 *((Elf_Addr *)(dynp->d_un.d_ptr)) = (Elf_Addr) &r_debug;
1360 case DT_MIPS_RLD_MAP_REL:
1361 // The MIPS_RLD_MAP_REL tag stores the offset to the .rld_map
1362 // section relative to the address of the tag itself.
1363 *((Elf_Addr *)(__DECONST(char*, dynp) + dynp->d_un.d_val)) =
1364 (Elf_Addr) &r_debug;
1367 case DT_MIPS_PLTGOT:
1368 obj->mips_pltgot = (Elf_Addr *)(obj->relocbase +
1375 #ifdef __powerpc64__
1376 case DT_PPC64_GLINK:
1377 obj->glink = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1381 obj->gotptr = (Elf_Addr *)(obj->relocbase + dynp->d_un.d_ptr);
1387 if (dynp->d_un.d_val & DF_1_NOOPEN)
1388 obj->z_noopen = true;
1389 if (dynp->d_un.d_val & DF_1_ORIGIN)
1390 obj->z_origin = true;
1391 if (dynp->d_un.d_val & DF_1_GLOBAL)
1392 obj->z_global = true;
1393 if (dynp->d_un.d_val & DF_1_BIND_NOW)
1394 obj->bind_now = true;
1395 if (dynp->d_un.d_val & DF_1_NODELETE)
1396 obj->z_nodelete = true;
1397 if (dynp->d_un.d_val & DF_1_LOADFLTR)
1398 obj->z_loadfltr = true;
1399 if (dynp->d_un.d_val & DF_1_INTERPOSE)
1400 obj->z_interpose = true;
1401 if (dynp->d_un.d_val & DF_1_NODEFLIB)
1402 obj->z_nodeflib = true;
1403 if (dynp->d_un.d_val & DF_1_PIE)
1409 dbg("Ignoring d_tag %ld = %#lx", (long)dynp->d_tag,
1416 obj->traced = false;
1418 if (plttype == DT_RELA) {
1419 obj->pltrela = (const Elf_Rela *) obj->pltrel;
1421 obj->pltrelasize = obj->pltrelsize;
1422 obj->pltrelsize = 0;
1425 /* Determine size of dynsym table (equal to nchains of sysv hash) */
1426 if (obj->valid_hash_sysv)
1427 obj->dynsymcount = obj->nchains;
1428 else if (obj->valid_hash_gnu) {
1429 obj->dynsymcount = 0;
1430 for (bkt = 0; bkt < obj->nbuckets_gnu; bkt++) {
1431 if (obj->buckets_gnu[bkt] == 0)
1433 hashval = &obj->chain_zero_gnu[obj->buckets_gnu[bkt]];
1436 while ((*hashval++ & 1u) == 0);
1438 obj->dynsymcount += obj->symndx_gnu;
1441 if (obj->linkmap.l_refname != NULL)
1442 obj->linkmap.l_refname = obj->strtab + (unsigned long)obj->
1447 obj_resolve_origin(Obj_Entry *obj)
1450 if (obj->origin_path != NULL)
1452 obj->origin_path = xmalloc(PATH_MAX);
1453 return (rtld_dirname_abs(obj->path, obj->origin_path) != -1);
1457 digest_dynamic2(Obj_Entry *obj, const Elf_Dyn *dyn_rpath,
1458 const Elf_Dyn *dyn_soname, const Elf_Dyn *dyn_runpath)
1461 if (obj->z_origin && !obj_resolve_origin(obj))
1464 if (dyn_runpath != NULL) {
1465 obj->runpath = (const char *)obj->strtab + dyn_runpath->d_un.d_val;
1466 obj->runpath = origin_subst(obj, obj->runpath);
1467 } else if (dyn_rpath != NULL) {
1468 obj->rpath = (const char *)obj->strtab + dyn_rpath->d_un.d_val;
1469 obj->rpath = origin_subst(obj, obj->rpath);
1471 if (dyn_soname != NULL)
1472 object_add_name(obj, obj->strtab + dyn_soname->d_un.d_val);
1477 digest_dynamic(Obj_Entry *obj, int early)
1479 const Elf_Dyn *dyn_rpath;
1480 const Elf_Dyn *dyn_soname;
1481 const Elf_Dyn *dyn_runpath;
1483 digest_dynamic1(obj, early, &dyn_rpath, &dyn_soname, &dyn_runpath);
1484 return (digest_dynamic2(obj, dyn_rpath, dyn_soname, dyn_runpath));
1488 * Process a shared object's program header. This is used only for the
1489 * main program, when the kernel has already loaded the main program
1490 * into memory before calling the dynamic linker. It creates and
1491 * returns an Obj_Entry structure.
1494 digest_phdr(const Elf_Phdr *phdr, int phnum, caddr_t entry, const char *path)
1497 const Elf_Phdr *phlimit = phdr + phnum;
1499 Elf_Addr note_start, note_end;
1503 for (ph = phdr; ph < phlimit; ph++) {
1504 if (ph->p_type != PT_PHDR)
1508 obj->phsize = ph->p_memsz;
1509 obj->relocbase = __DECONST(char *, phdr) - ph->p_vaddr;
1513 obj->stack_flags = PF_X | PF_R | PF_W;
1515 for (ph = phdr; ph < phlimit; ph++) {
1516 switch (ph->p_type) {
1519 obj->interp = (const char *)(ph->p_vaddr + obj->relocbase);
1523 if (nsegs == 0) { /* First load segment */
1524 obj->vaddrbase = trunc_page(ph->p_vaddr);
1525 obj->mapbase = obj->vaddrbase + obj->relocbase;
1526 } else { /* Last load segment */
1527 obj->mapsize = round_page(ph->p_vaddr + ph->p_memsz) -
1534 obj->dynamic = (const Elf_Dyn *)(ph->p_vaddr + obj->relocbase);
1539 obj->tlssize = ph->p_memsz;
1540 obj->tlsalign = ph->p_align;
1541 obj->tlsinitsize = ph->p_filesz;
1542 obj->tlsinit = (void*)(ph->p_vaddr + obj->relocbase);
1543 obj->tlspoffset = ph->p_offset;
1547 obj->stack_flags = ph->p_flags;
1551 obj->relro_page = obj->relocbase + trunc_page(ph->p_vaddr);
1552 obj->relro_size = round_page(ph->p_memsz);
1556 note_start = (Elf_Addr)obj->relocbase + ph->p_vaddr;
1557 note_end = note_start + ph->p_filesz;
1558 digest_notes(obj, note_start, note_end);
1563 _rtld_error("%s: too few PT_LOAD segments", path);
1572 digest_notes(Obj_Entry *obj, Elf_Addr note_start, Elf_Addr note_end)
1574 const Elf_Note *note;
1575 const char *note_name;
1578 for (note = (const Elf_Note *)note_start; (Elf_Addr)note < note_end;
1579 note = (const Elf_Note *)((const char *)(note + 1) +
1580 roundup2(note->n_namesz, sizeof(Elf32_Addr)) +
1581 roundup2(note->n_descsz, sizeof(Elf32_Addr)))) {
1582 if (note->n_namesz != sizeof(NOTE_FREEBSD_VENDOR) ||
1583 note->n_descsz != sizeof(int32_t))
1585 if (note->n_type != NT_FREEBSD_ABI_TAG &&
1586 note->n_type != NT_FREEBSD_FEATURE_CTL &&
1587 note->n_type != NT_FREEBSD_NOINIT_TAG)
1589 note_name = (const char *)(note + 1);
1590 if (strncmp(NOTE_FREEBSD_VENDOR, note_name,
1591 sizeof(NOTE_FREEBSD_VENDOR)) != 0)
1593 switch (note->n_type) {
1594 case NT_FREEBSD_ABI_TAG:
1595 /* FreeBSD osrel note */
1596 p = (uintptr_t)(note + 1);
1597 p += roundup2(note->n_namesz, sizeof(Elf32_Addr));
1598 obj->osrel = *(const int32_t *)(p);
1599 dbg("note osrel %d", obj->osrel);
1601 case NT_FREEBSD_FEATURE_CTL:
1602 /* FreeBSD ABI feature control note */
1603 p = (uintptr_t)(note + 1);
1604 p += roundup2(note->n_namesz, sizeof(Elf32_Addr));
1605 obj->fctl0 = *(const uint32_t *)(p);
1606 dbg("note fctl0 %#x", obj->fctl0);
1608 case NT_FREEBSD_NOINIT_TAG:
1609 /* FreeBSD 'crt does not call init' note */
1610 obj->crt_no_init = true;
1611 dbg("note crt_no_init");
1618 dlcheck(void *handle)
1622 TAILQ_FOREACH(obj, &obj_list, next) {
1623 if (obj == (Obj_Entry *) handle)
1627 if (obj == NULL || obj->refcount == 0 || obj->dl_refcount == 0) {
1628 _rtld_error("Invalid shared object handle %p", handle);
1635 * If the given object is already in the donelist, return true. Otherwise
1636 * add the object to the list and return false.
1639 donelist_check(DoneList *dlp, const Obj_Entry *obj)
1643 for (i = 0; i < dlp->num_used; i++)
1644 if (dlp->objs[i] == obj)
1647 * Our donelist allocation should always be sufficient. But if
1648 * our threads locking isn't working properly, more shared objects
1649 * could have been loaded since we allocated the list. That should
1650 * never happen, but we'll handle it properly just in case it does.
1652 if (dlp->num_used < dlp->num_alloc)
1653 dlp->objs[dlp->num_used++] = obj;
1658 * Hash function for symbol table lookup. Don't even think about changing
1659 * this. It is specified by the System V ABI.
1662 elf_hash(const char *name)
1664 const unsigned char *p = (const unsigned char *) name;
1665 unsigned long h = 0;
1668 while (*p != '\0') {
1669 h = (h << 4) + *p++;
1670 if ((g = h & 0xf0000000) != 0)
1678 * The GNU hash function is the Daniel J. Bernstein hash clipped to 32 bits
1679 * unsigned in case it's implemented with a wider type.
1682 gnu_hash(const char *s)
1688 for (c = *s; c != '\0'; c = *++s)
1690 return (h & 0xffffffff);
1695 * Find the library with the given name, and return its full pathname.
1696 * The returned string is dynamically allocated. Generates an error
1697 * message and returns NULL if the library cannot be found.
1699 * If the second argument is non-NULL, then it refers to an already-
1700 * loaded shared object, whose library search path will be searched.
1702 * If a library is successfully located via LD_LIBRARY_PATH_FDS, its
1703 * descriptor (which is close-on-exec) will be passed out via the third
1706 * The search order is:
1707 * DT_RPATH in the referencing file _unless_ DT_RUNPATH is present (1)
1708 * DT_RPATH of the main object if DSO without defined DT_RUNPATH (1)
1710 * DT_RUNPATH in the referencing file
1711 * ldconfig hints (if -z nodefaultlib, filter out default library directories
1713 * /lib:/usr/lib _unless_ the referencing file is linked with -z nodefaultlib
1715 * (1) Handled in digest_dynamic2 - rpath left NULL if runpath defined.
1718 find_library(const char *xname, const Obj_Entry *refobj, int *fdp)
1720 char *pathname, *refobj_path;
1722 bool nodeflib, objgiven;
1724 objgiven = refobj != NULL;
1726 if (libmap_disable || !objgiven ||
1727 (name = lm_find(refobj->path, xname)) == NULL)
1730 if (strchr(name, '/') != NULL) { /* Hard coded pathname */
1731 if (name[0] != '/' && !trust) {
1732 _rtld_error("Absolute pathname required "
1733 "for shared object \"%s\"", name);
1736 return (origin_subst(__DECONST(Obj_Entry *, refobj),
1737 __DECONST(char *, name)));
1740 dbg(" Searching for \"%s\"", name);
1741 refobj_path = objgiven ? refobj->path : NULL;
1744 * If refobj->rpath != NULL, then refobj->runpath is NULL. Fall
1745 * back to pre-conforming behaviour if user requested so with
1746 * LD_LIBRARY_PATH_RPATH environment variable and ignore -z
1749 if (objgiven && refobj->rpath != NULL && ld_library_path_rpath) {
1750 pathname = search_library_path(name, ld_library_path,
1752 if (pathname != NULL)
1754 if (refobj != NULL) {
1755 pathname = search_library_path(name, refobj->rpath,
1757 if (pathname != NULL)
1760 pathname = search_library_pathfds(name, ld_library_dirs, fdp);
1761 if (pathname != NULL)
1763 pathname = search_library_path(name, gethints(false),
1765 if (pathname != NULL)
1767 pathname = search_library_path(name, ld_standard_library_path,
1769 if (pathname != NULL)
1772 nodeflib = objgiven ? refobj->z_nodeflib : false;
1774 pathname = search_library_path(name, refobj->rpath,
1776 if (pathname != NULL)
1779 if (objgiven && refobj->runpath == NULL && refobj != obj_main) {
1780 pathname = search_library_path(name, obj_main->rpath,
1782 if (pathname != NULL)
1785 pathname = search_library_path(name, ld_library_path,
1787 if (pathname != NULL)
1790 pathname = search_library_path(name, refobj->runpath,
1792 if (pathname != NULL)
1795 pathname = search_library_pathfds(name, ld_library_dirs, fdp);
1796 if (pathname != NULL)
1798 pathname = search_library_path(name, gethints(nodeflib),
1800 if (pathname != NULL)
1802 if (objgiven && !nodeflib) {
1803 pathname = search_library_path(name,
1804 ld_standard_library_path, refobj_path, fdp);
1805 if (pathname != NULL)
1810 if (objgiven && refobj->path != NULL) {
1811 _rtld_error("Shared object \"%s\" not found, "
1812 "required by \"%s\"", name, basename(refobj->path));
1814 _rtld_error("Shared object \"%s\" not found", name);
1820 * Given a symbol number in a referencing object, find the corresponding
1821 * definition of the symbol. Returns a pointer to the symbol, or NULL if
1822 * no definition was found. Returns a pointer to the Obj_Entry of the
1823 * defining object via the reference parameter DEFOBJ_OUT.
1826 find_symdef(unsigned long symnum, const Obj_Entry *refobj,
1827 const Obj_Entry **defobj_out, int flags, SymCache *cache,
1828 RtldLockState *lockstate)
1832 const Obj_Entry *defobj;
1833 const Ver_Entry *ve;
1839 * If we have already found this symbol, get the information from
1842 if (symnum >= refobj->dynsymcount)
1843 return NULL; /* Bad object */
1844 if (cache != NULL && cache[symnum].sym != NULL) {
1845 *defobj_out = cache[symnum].obj;
1846 return cache[symnum].sym;
1849 ref = refobj->symtab + symnum;
1850 name = refobj->strtab + ref->st_name;
1856 * We don't have to do a full scale lookup if the symbol is local.
1857 * We know it will bind to the instance in this load module; to
1858 * which we already have a pointer (ie ref). By not doing a lookup,
1859 * we not only improve performance, but it also avoids unresolvable
1860 * symbols when local symbols are not in the hash table. This has
1861 * been seen with the ia64 toolchain.
1863 if (ELF_ST_BIND(ref->st_info) != STB_LOCAL) {
1864 if (ELF_ST_TYPE(ref->st_info) == STT_SECTION) {
1865 _rtld_error("%s: Bogus symbol table entry %lu", refobj->path,
1868 symlook_init(&req, name);
1870 ve = req.ventry = fetch_ventry(refobj, symnum);
1871 req.lockstate = lockstate;
1872 res = symlook_default(&req, refobj);
1875 defobj = req.defobj_out;
1883 * If we found no definition and the reference is weak, treat the
1884 * symbol as having the value zero.
1886 if (def == NULL && ELF_ST_BIND(ref->st_info) == STB_WEAK) {
1892 *defobj_out = defobj;
1893 /* Record the information in the cache to avoid subsequent lookups. */
1894 if (cache != NULL) {
1895 cache[symnum].sym = def;
1896 cache[symnum].obj = defobj;
1899 if (refobj != &obj_rtld)
1900 _rtld_error("%s: Undefined symbol \"%s%s%s\"", refobj->path, name,
1901 ve != NULL ? "@" : "", ve != NULL ? ve->name : "");
1907 * Return the search path from the ldconfig hints file, reading it if
1908 * necessary. If nostdlib is true, then the default search paths are
1909 * not added to result.
1911 * Returns NULL if there are problems with the hints file,
1912 * or if the search path there is empty.
1915 gethints(bool nostdlib)
1917 static char *filtered_path;
1918 static const char *hints;
1919 static struct elfhints_hdr hdr;
1920 struct fill_search_info_args sargs, hargs;
1921 struct dl_serinfo smeta, hmeta, *SLPinfo, *hintinfo;
1922 struct dl_serpath *SLPpath, *hintpath;
1924 struct stat hint_stat;
1925 unsigned int SLPndx, hintndx, fndx, fcount;
1931 /* First call, read the hints file */
1932 if (hints == NULL) {
1933 /* Keep from trying again in case the hints file is bad. */
1936 if ((fd = open(ld_elf_hints_path, O_RDONLY | O_CLOEXEC)) == -1)
1940 * Check of hdr.dirlistlen value against type limit
1941 * intends to pacify static analyzers. Further
1942 * paranoia leads to checks that dirlist is fully
1943 * contained in the file range.
1945 if (read(fd, &hdr, sizeof hdr) != sizeof hdr ||
1946 hdr.magic != ELFHINTS_MAGIC ||
1947 hdr.version != 1 || hdr.dirlistlen > UINT_MAX / 2 ||
1948 fstat(fd, &hint_stat) == -1) {
1955 if (dl + hdr.dirlist < dl)
1958 if (dl + hdr.dirlistlen < dl)
1960 dl += hdr.dirlistlen;
1961 if (dl > hint_stat.st_size)
1963 p = xmalloc(hdr.dirlistlen + 1);
1964 if (pread(fd, p, hdr.dirlistlen + 1,
1965 hdr.strtab + hdr.dirlist) != (ssize_t)hdr.dirlistlen + 1 ||
1966 p[hdr.dirlistlen] != '\0') {
1975 * If caller agreed to receive list which includes the default
1976 * paths, we are done. Otherwise, if we still did not
1977 * calculated filtered result, do it now.
1980 return (hints[0] != '\0' ? hints : NULL);
1981 if (filtered_path != NULL)
1985 * Obtain the list of all configured search paths, and the
1986 * list of the default paths.
1988 * First estimate the size of the results.
1990 smeta.dls_size = __offsetof(struct dl_serinfo, dls_serpath);
1992 hmeta.dls_size = __offsetof(struct dl_serinfo, dls_serpath);
1995 sargs.request = RTLD_DI_SERINFOSIZE;
1996 sargs.serinfo = &smeta;
1997 hargs.request = RTLD_DI_SERINFOSIZE;
1998 hargs.serinfo = &hmeta;
2000 path_enumerate(ld_standard_library_path, fill_search_info, NULL,
2002 path_enumerate(hints, fill_search_info, NULL, &hargs);
2004 SLPinfo = xmalloc(smeta.dls_size);
2005 hintinfo = xmalloc(hmeta.dls_size);
2008 * Next fetch both sets of paths.
2010 sargs.request = RTLD_DI_SERINFO;
2011 sargs.serinfo = SLPinfo;
2012 sargs.serpath = &SLPinfo->dls_serpath[0];
2013 sargs.strspace = (char *)&SLPinfo->dls_serpath[smeta.dls_cnt];
2015 hargs.request = RTLD_DI_SERINFO;
2016 hargs.serinfo = hintinfo;
2017 hargs.serpath = &hintinfo->dls_serpath[0];
2018 hargs.strspace = (char *)&hintinfo->dls_serpath[hmeta.dls_cnt];
2020 path_enumerate(ld_standard_library_path, fill_search_info, NULL,
2022 path_enumerate(hints, fill_search_info, NULL, &hargs);
2025 * Now calculate the difference between two sets, by excluding
2026 * standard paths from the full set.
2030 filtered_path = xmalloc(hdr.dirlistlen + 1);
2031 hintpath = &hintinfo->dls_serpath[0];
2032 for (hintndx = 0; hintndx < hmeta.dls_cnt; hintndx++, hintpath++) {
2034 SLPpath = &SLPinfo->dls_serpath[0];
2036 * Check each standard path against current.
2038 for (SLPndx = 0; SLPndx < smeta.dls_cnt; SLPndx++, SLPpath++) {
2039 /* matched, skip the path */
2040 if (!strcmp(hintpath->dls_name, SLPpath->dls_name)) {
2048 * Not matched against any standard path, add the path
2049 * to result. Separate consequtive paths with ':'.
2052 filtered_path[fndx] = ':';
2056 flen = strlen(hintpath->dls_name);
2057 strncpy((filtered_path + fndx), hintpath->dls_name, flen);
2060 filtered_path[fndx] = '\0';
2066 return (filtered_path[0] != '\0' ? filtered_path : NULL);
2070 init_dag(Obj_Entry *root)
2072 const Needed_Entry *needed;
2073 const Objlist_Entry *elm;
2076 if (root->dag_inited)
2078 donelist_init(&donelist);
2080 /* Root object belongs to own DAG. */
2081 objlist_push_tail(&root->dldags, root);
2082 objlist_push_tail(&root->dagmembers, root);
2083 donelist_check(&donelist, root);
2086 * Add dependencies of root object to DAG in breadth order
2087 * by exploiting the fact that each new object get added
2088 * to the tail of the dagmembers list.
2090 STAILQ_FOREACH(elm, &root->dagmembers, link) {
2091 for (needed = elm->obj->needed; needed != NULL; needed = needed->next) {
2092 if (needed->obj == NULL || donelist_check(&donelist, needed->obj))
2094 objlist_push_tail(&needed->obj->dldags, root);
2095 objlist_push_tail(&root->dagmembers, needed->obj);
2098 root->dag_inited = true;
2102 init_marker(Obj_Entry *marker)
2105 bzero(marker, sizeof(*marker));
2106 marker->marker = true;
2110 globallist_curr(const Obj_Entry *obj)
2117 return (__DECONST(Obj_Entry *, obj));
2118 obj = TAILQ_PREV(obj, obj_entry_q, next);
2123 globallist_next(const Obj_Entry *obj)
2127 obj = TAILQ_NEXT(obj, next);
2131 return (__DECONST(Obj_Entry *, obj));
2135 /* Prevent the object from being unmapped while the bind lock is dropped. */
2137 hold_object(Obj_Entry *obj)
2144 unhold_object(Obj_Entry *obj)
2147 assert(obj->holdcount > 0);
2148 if (--obj->holdcount == 0 && obj->unholdfree)
2149 release_object(obj);
2153 process_z(Obj_Entry *root)
2155 const Objlist_Entry *elm;
2159 * Walk over object DAG and process every dependent object
2160 * that is marked as DF_1_NODELETE or DF_1_GLOBAL. They need
2161 * to grow their own DAG.
2163 * For DF_1_GLOBAL, DAG is required for symbol lookups in
2164 * symlook_global() to work.
2166 * For DF_1_NODELETE, the DAG should have its reference upped.
2168 STAILQ_FOREACH(elm, &root->dagmembers, link) {
2172 if (obj->z_nodelete && !obj->ref_nodel) {
2173 dbg("obj %s -z nodelete", obj->path);
2176 obj->ref_nodel = true;
2178 if (obj->z_global && objlist_find(&list_global, obj) == NULL) {
2179 dbg("obj %s -z global", obj->path);
2180 objlist_push_tail(&list_global, obj);
2186 * Initialize the dynamic linker. The argument is the address at which
2187 * the dynamic linker has been mapped into memory. The primary task of
2188 * this function is to relocate the dynamic linker.
2191 init_rtld(caddr_t mapbase, Elf_Auxinfo **aux_info)
2193 Obj_Entry objtmp; /* Temporary rtld object */
2194 const Elf_Ehdr *ehdr;
2195 const Elf_Dyn *dyn_rpath;
2196 const Elf_Dyn *dyn_soname;
2197 const Elf_Dyn *dyn_runpath;
2199 #ifdef RTLD_INIT_PAGESIZES_EARLY
2200 /* The page size is required by the dynamic memory allocator. */
2201 init_pagesizes(aux_info);
2205 * Conjure up an Obj_Entry structure for the dynamic linker.
2207 * The "path" member can't be initialized yet because string constants
2208 * cannot yet be accessed. Below we will set it correctly.
2210 memset(&objtmp, 0, sizeof(objtmp));
2213 objtmp.mapbase = mapbase;
2215 objtmp.relocbase = mapbase;
2218 objtmp.dynamic = rtld_dynamic(&objtmp);
2219 digest_dynamic1(&objtmp, 1, &dyn_rpath, &dyn_soname, &dyn_runpath);
2220 assert(objtmp.needed == NULL);
2221 #if !defined(__mips__)
2222 /* MIPS has a bogus DT_TEXTREL. */
2223 assert(!objtmp.textrel);
2226 * Temporarily put the dynamic linker entry into the object list, so
2227 * that symbols can be found.
2229 relocate_objects(&objtmp, true, &objtmp, 0, NULL);
2231 ehdr = (Elf_Ehdr *)mapbase;
2232 objtmp.phdr = (Elf_Phdr *)((char *)mapbase + ehdr->e_phoff);
2233 objtmp.phsize = ehdr->e_phnum * sizeof(objtmp.phdr[0]);
2235 /* Initialize the object list. */
2236 TAILQ_INIT(&obj_list);
2238 /* Now that non-local variables can be accesses, copy out obj_rtld. */
2239 memcpy(&obj_rtld, &objtmp, sizeof(obj_rtld));
2241 #ifndef RTLD_INIT_PAGESIZES_EARLY
2242 /* The page size is required by the dynamic memory allocator. */
2243 init_pagesizes(aux_info);
2246 if (aux_info[AT_OSRELDATE] != NULL)
2247 osreldate = aux_info[AT_OSRELDATE]->a_un.a_val;
2249 digest_dynamic2(&obj_rtld, dyn_rpath, dyn_soname, dyn_runpath);
2251 /* Replace the path with a dynamically allocated copy. */
2252 obj_rtld.path = xstrdup(ld_path_rtld);
2254 r_debug.r_brk = r_debug_state;
2255 r_debug.r_state = RT_CONSISTENT;
2259 * Retrieve the array of supported page sizes. The kernel provides the page
2260 * sizes in increasing order.
2263 init_pagesizes(Elf_Auxinfo **aux_info)
2265 static size_t psa[MAXPAGESIZES];
2269 if (aux_info[AT_PAGESIZES] != NULL && aux_info[AT_PAGESIZESLEN] !=
2271 size = aux_info[AT_PAGESIZESLEN]->a_un.a_val;
2272 pagesizes = aux_info[AT_PAGESIZES]->a_un.a_ptr;
2275 if (sysctlnametomib("hw.pagesizes", mib, &len) == 0)
2278 /* As a fallback, retrieve the base page size. */
2279 size = sizeof(psa[0]);
2280 if (aux_info[AT_PAGESZ] != NULL) {
2281 psa[0] = aux_info[AT_PAGESZ]->a_un.a_val;
2285 mib[1] = HW_PAGESIZE;
2289 if (sysctl(mib, len, psa, &size, NULL, 0) == -1) {
2290 _rtld_error("sysctl for hw.pagesize(s) failed");
2296 npagesizes = size / sizeof(pagesizes[0]);
2297 /* Discard any invalid entries at the end of the array. */
2298 while (npagesizes > 0 && pagesizes[npagesizes - 1] == 0)
2303 * Add the init functions from a needed object list (and its recursive
2304 * needed objects) to "list". This is not used directly; it is a helper
2305 * function for initlist_add_objects(). The write lock must be held
2306 * when this function is called.
2309 initlist_add_neededs(Needed_Entry *needed, Objlist *list)
2311 /* Recursively process the successor needed objects. */
2312 if (needed->next != NULL)
2313 initlist_add_neededs(needed->next, list);
2315 /* Process the current needed object. */
2316 if (needed->obj != NULL)
2317 initlist_add_objects(needed->obj, needed->obj, list);
2321 * Scan all of the DAGs rooted in the range of objects from "obj" to
2322 * "tail" and add their init functions to "list". This recurses over
2323 * the DAGs and ensure the proper init ordering such that each object's
2324 * needed libraries are initialized before the object itself. At the
2325 * same time, this function adds the objects to the global finalization
2326 * list "list_fini" in the opposite order. The write lock must be
2327 * held when this function is called.
2330 initlist_add_objects(Obj_Entry *obj, Obj_Entry *tail, Objlist *list)
2334 if (obj->init_scanned || obj->init_done)
2336 obj->init_scanned = true;
2338 /* Recursively process the successor objects. */
2339 nobj = globallist_next(obj);
2340 if (nobj != NULL && obj != tail)
2341 initlist_add_objects(nobj, tail, list);
2343 /* Recursively process the needed objects. */
2344 if (obj->needed != NULL)
2345 initlist_add_neededs(obj->needed, list);
2346 if (obj->needed_filtees != NULL)
2347 initlist_add_neededs(obj->needed_filtees, list);
2348 if (obj->needed_aux_filtees != NULL)
2349 initlist_add_neededs(obj->needed_aux_filtees, list);
2351 /* Add the object to the init list. */
2352 objlist_push_tail(list, obj);
2354 /* Add the object to the global fini list in the reverse order. */
2355 if ((obj->fini != (Elf_Addr)NULL || obj->fini_array != (Elf_Addr)NULL)
2356 && !obj->on_fini_list) {
2357 objlist_push_head(&list_fini, obj);
2358 obj->on_fini_list = true;
2363 #define FPTR_TARGET(f) ((Elf_Addr) (f))
2367 free_needed_filtees(Needed_Entry *n, RtldLockState *lockstate)
2369 Needed_Entry *needed, *needed1;
2371 for (needed = n; needed != NULL; needed = needed->next) {
2372 if (needed->obj != NULL) {
2373 dlclose_locked(needed->obj, lockstate);
2377 for (needed = n; needed != NULL; needed = needed1) {
2378 needed1 = needed->next;
2384 unload_filtees(Obj_Entry *obj, RtldLockState *lockstate)
2387 free_needed_filtees(obj->needed_filtees, lockstate);
2388 obj->needed_filtees = NULL;
2389 free_needed_filtees(obj->needed_aux_filtees, lockstate);
2390 obj->needed_aux_filtees = NULL;
2391 obj->filtees_loaded = false;
2395 load_filtee1(Obj_Entry *obj, Needed_Entry *needed, int flags,
2396 RtldLockState *lockstate)
2399 for (; needed != NULL; needed = needed->next) {
2400 needed->obj = dlopen_object(obj->strtab + needed->name, -1, obj,
2401 flags, ((ld_loadfltr || obj->z_loadfltr) ? RTLD_NOW : RTLD_LAZY) |
2402 RTLD_LOCAL, lockstate);
2407 load_filtees(Obj_Entry *obj, int flags, RtldLockState *lockstate)
2410 lock_restart_for_upgrade(lockstate);
2411 if (!obj->filtees_loaded) {
2412 load_filtee1(obj, obj->needed_filtees, flags, lockstate);
2413 load_filtee1(obj, obj->needed_aux_filtees, flags, lockstate);
2414 obj->filtees_loaded = true;
2419 process_needed(Obj_Entry *obj, Needed_Entry *needed, int flags)
2423 for (; needed != NULL; needed = needed->next) {
2424 obj1 = needed->obj = load_object(obj->strtab + needed->name, -1, obj,
2425 flags & ~RTLD_LO_NOLOAD);
2426 if (obj1 == NULL && !ld_tracing && (flags & RTLD_LO_FILTEES) == 0)
2433 * Given a shared object, traverse its list of needed objects, and load
2434 * each of them. Returns 0 on success. Generates an error message and
2435 * returns -1 on failure.
2438 load_needed_objects(Obj_Entry *first, int flags)
2442 for (obj = first; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
2445 if (process_needed(obj, obj->needed, flags) == -1)
2452 load_preload_objects(void)
2454 char *p = ld_preload;
2456 static const char delim[] = " \t:;";
2461 p += strspn(p, delim);
2462 while (*p != '\0') {
2463 size_t len = strcspn(p, delim);
2468 obj = load_object(p, -1, NULL, 0);
2470 return -1; /* XXX - cleanup */
2471 obj->z_interpose = true;
2474 p += strspn(p, delim);
2476 LD_UTRACE(UTRACE_PRELOAD_FINISHED, NULL, NULL, 0, 0, NULL);
2481 printable_path(const char *path)
2484 return (path == NULL ? "<unknown>" : path);
2488 * Load a shared object into memory, if it is not already loaded. The
2489 * object may be specified by name or by user-supplied file descriptor
2490 * fd_u. In the later case, the fd_u descriptor is not closed, but its
2493 * Returns a pointer to the Obj_Entry for the object. Returns NULL
2497 load_object(const char *name, int fd_u, const Obj_Entry *refobj, int flags)
2506 TAILQ_FOREACH(obj, &obj_list, next) {
2507 if (obj->marker || obj->doomed)
2509 if (object_match_name(obj, name))
2513 path = find_library(name, refobj, &fd);
2521 * search_library_pathfds() opens a fresh file descriptor for the
2522 * library, so there is no need to dup().
2524 } else if (fd_u == -1) {
2526 * If we didn't find a match by pathname, or the name is not
2527 * supplied, open the file and check again by device and inode.
2528 * This avoids false mismatches caused by multiple links or ".."
2531 * To avoid a race, we open the file and use fstat() rather than
2534 if ((fd = open(path, O_RDONLY | O_CLOEXEC | O_VERIFY)) == -1) {
2535 _rtld_error("Cannot open \"%s\"", path);
2540 fd = fcntl(fd_u, F_DUPFD_CLOEXEC, 0);
2542 _rtld_error("Cannot dup fd");
2547 if (fstat(fd, &sb) == -1) {
2548 _rtld_error("Cannot fstat \"%s\"", printable_path(path));
2553 TAILQ_FOREACH(obj, &obj_list, next) {
2554 if (obj->marker || obj->doomed)
2556 if (obj->ino == sb.st_ino && obj->dev == sb.st_dev)
2559 if (obj != NULL && name != NULL) {
2560 object_add_name(obj, name);
2565 if (flags & RTLD_LO_NOLOAD) {
2571 /* First use of this object, so we must map it in */
2572 obj = do_load_object(fd, name, path, &sb, flags);
2581 do_load_object(int fd, const char *name, char *path, struct stat *sbp,
2588 * but first, make sure that environment variables haven't been
2589 * used to circumvent the noexec flag on a filesystem.
2591 if (dangerous_ld_env) {
2592 if (fstatfs(fd, &fs) != 0) {
2593 _rtld_error("Cannot fstatfs \"%s\"", printable_path(path));
2596 if (fs.f_flags & MNT_NOEXEC) {
2597 _rtld_error("Cannot execute objects on %s", fs.f_mntonname);
2601 dbg("loading \"%s\"", printable_path(path));
2602 obj = map_object(fd, printable_path(path), sbp);
2607 * If DT_SONAME is present in the object, digest_dynamic2 already
2608 * added it to the object names.
2611 object_add_name(obj, name);
2613 if (!digest_dynamic(obj, 0))
2616 _rtld_error("Cannot load PIE binary %s as DSO", obj->path);
2619 dbg("%s valid_hash_sysv %d valid_hash_gnu %d dynsymcount %d", obj->path,
2620 obj->valid_hash_sysv, obj->valid_hash_gnu, obj->dynsymcount);
2621 if (obj->z_noopen && (flags & (RTLD_LO_DLOPEN | RTLD_LO_TRACE)) ==
2623 dbg("refusing to load non-loadable \"%s\"", obj->path);
2624 _rtld_error("Cannot dlopen non-loadable %s", obj->path);
2628 obj->dlopened = (flags & RTLD_LO_DLOPEN) != 0;
2629 TAILQ_INSERT_TAIL(&obj_list, obj, next);
2632 linkmap_add(obj); /* for GDB & dlinfo() */
2633 max_stack_flags |= obj->stack_flags;
2635 dbg(" %p .. %p: %s", obj->mapbase,
2636 obj->mapbase + obj->mapsize - 1, obj->path);
2638 dbg(" WARNING: %s has impure text", obj->path);
2639 LD_UTRACE(UTRACE_LOAD_OBJECT, obj, obj->mapbase, obj->mapsize, 0,
2645 munmap(obj->mapbase, obj->mapsize);
2651 obj_from_addr(const void *addr)
2655 TAILQ_FOREACH(obj, &obj_list, next) {
2658 if (addr < (void *) obj->mapbase)
2660 if (addr < (void *)(obj->mapbase + obj->mapsize))
2669 Elf_Addr *preinit_addr;
2672 preinit_addr = (Elf_Addr *)obj_main->preinit_array;
2673 if (preinit_addr == NULL)
2676 for (index = 0; index < obj_main->preinit_array_num; index++) {
2677 if (preinit_addr[index] != 0 && preinit_addr[index] != 1) {
2678 dbg("calling preinit function for %s at %p", obj_main->path,
2679 (void *)preinit_addr[index]);
2680 LD_UTRACE(UTRACE_INIT_CALL, obj_main, (void *)preinit_addr[index],
2681 0, 0, obj_main->path);
2682 call_init_pointer(obj_main, preinit_addr[index]);
2688 * Call the finalization functions for each of the objects in "list"
2689 * belonging to the DAG of "root" and referenced once. If NULL "root"
2690 * is specified, every finalization function will be called regardless
2691 * of the reference count and the list elements won't be freed. All of
2692 * the objects are expected to have non-NULL fini functions.
2695 objlist_call_fini(Objlist *list, Obj_Entry *root, RtldLockState *lockstate)
2699 Elf_Addr *fini_addr;
2702 assert(root == NULL || root->refcount == 1);
2705 root->doomed = true;
2708 * Preserve the current error message since a fini function might
2709 * call into the dynamic linker and overwrite it.
2711 saved_msg = errmsg_save();
2713 STAILQ_FOREACH(elm, list, link) {
2714 if (root != NULL && (elm->obj->refcount != 1 ||
2715 objlist_find(&root->dagmembers, elm->obj) == NULL))
2717 /* Remove object from fini list to prevent recursive invocation. */
2718 STAILQ_REMOVE(list, elm, Struct_Objlist_Entry, link);
2719 /* Ensure that new references cannot be acquired. */
2720 elm->obj->doomed = true;
2722 hold_object(elm->obj);
2723 lock_release(rtld_bind_lock, lockstate);
2725 * It is legal to have both DT_FINI and DT_FINI_ARRAY defined.
2726 * When this happens, DT_FINI_ARRAY is processed first.
2728 fini_addr = (Elf_Addr *)elm->obj->fini_array;
2729 if (fini_addr != NULL && elm->obj->fini_array_num > 0) {
2730 for (index = elm->obj->fini_array_num - 1; index >= 0;
2732 if (fini_addr[index] != 0 && fini_addr[index] != 1) {
2733 dbg("calling fini function for %s at %p",
2734 elm->obj->path, (void *)fini_addr[index]);
2735 LD_UTRACE(UTRACE_FINI_CALL, elm->obj,
2736 (void *)fini_addr[index], 0, 0, elm->obj->path);
2737 call_initfini_pointer(elm->obj, fini_addr[index]);
2741 if (elm->obj->fini != (Elf_Addr)NULL) {
2742 dbg("calling fini function for %s at %p", elm->obj->path,
2743 (void *)elm->obj->fini);
2744 LD_UTRACE(UTRACE_FINI_CALL, elm->obj, (void *)elm->obj->fini,
2745 0, 0, elm->obj->path);
2746 call_initfini_pointer(elm->obj, elm->obj->fini);
2748 wlock_acquire(rtld_bind_lock, lockstate);
2749 unhold_object(elm->obj);
2750 /* No need to free anything if process is going down. */
2754 * We must restart the list traversal after every fini call
2755 * because a dlclose() call from the fini function or from
2756 * another thread might have modified the reference counts.
2760 } while (elm != NULL);
2761 errmsg_restore(saved_msg);
2765 * Call the initialization functions for each of the objects in
2766 * "list". All of the objects are expected to have non-NULL init
2770 objlist_call_init(Objlist *list, RtldLockState *lockstate)
2775 Elf_Addr *init_addr;
2776 void (*reg)(void (*)(void));
2780 * Clean init_scanned flag so that objects can be rechecked and
2781 * possibly initialized earlier if any of vectors called below
2782 * cause the change by using dlopen.
2784 TAILQ_FOREACH(obj, &obj_list, next) {
2787 obj->init_scanned = false;
2791 * Preserve the current error message since an init function might
2792 * call into the dynamic linker and overwrite it.
2794 saved_msg = errmsg_save();
2795 STAILQ_FOREACH(elm, list, link) {
2796 if (elm->obj->init_done) /* Initialized early. */
2799 * Race: other thread might try to use this object before current
2800 * one completes the initialization. Not much can be done here
2801 * without better locking.
2803 elm->obj->init_done = true;
2804 hold_object(elm->obj);
2806 if (elm->obj == obj_main && obj_main->crt_no_init) {
2807 reg = (void (*)(void (*)(void)))get_program_var_addr(
2808 "__libc_atexit", lockstate);
2810 lock_release(rtld_bind_lock, lockstate);
2813 rtld_exit_ptr = rtld_nop_exit;
2817 * It is legal to have both DT_INIT and DT_INIT_ARRAY defined.
2818 * When this happens, DT_INIT is processed first.
2820 if (elm->obj->init != (Elf_Addr)NULL) {
2821 dbg("calling init function for %s at %p", elm->obj->path,
2822 (void *)elm->obj->init);
2823 LD_UTRACE(UTRACE_INIT_CALL, elm->obj, (void *)elm->obj->init,
2824 0, 0, elm->obj->path);
2825 call_initfini_pointer(elm->obj, elm->obj->init);
2827 init_addr = (Elf_Addr *)elm->obj->init_array;
2828 if (init_addr != NULL) {
2829 for (index = 0; index < elm->obj->init_array_num; index++) {
2830 if (init_addr[index] != 0 && init_addr[index] != 1) {
2831 dbg("calling init function for %s at %p", elm->obj->path,
2832 (void *)init_addr[index]);
2833 LD_UTRACE(UTRACE_INIT_CALL, elm->obj,
2834 (void *)init_addr[index], 0, 0, elm->obj->path);
2835 call_init_pointer(elm->obj, init_addr[index]);
2839 wlock_acquire(rtld_bind_lock, lockstate);
2840 unhold_object(elm->obj);
2842 errmsg_restore(saved_msg);
2846 objlist_clear(Objlist *list)
2850 while (!STAILQ_EMPTY(list)) {
2851 elm = STAILQ_FIRST(list);
2852 STAILQ_REMOVE_HEAD(list, link);
2857 static Objlist_Entry *
2858 objlist_find(Objlist *list, const Obj_Entry *obj)
2862 STAILQ_FOREACH(elm, list, link)
2863 if (elm->obj == obj)
2869 objlist_init(Objlist *list)
2875 objlist_push_head(Objlist *list, Obj_Entry *obj)
2879 elm = NEW(Objlist_Entry);
2881 STAILQ_INSERT_HEAD(list, elm, link);
2885 objlist_push_tail(Objlist *list, Obj_Entry *obj)
2889 elm = NEW(Objlist_Entry);
2891 STAILQ_INSERT_TAIL(list, elm, link);
2895 objlist_put_after(Objlist *list, Obj_Entry *listobj, Obj_Entry *obj)
2897 Objlist_Entry *elm, *listelm;
2899 STAILQ_FOREACH(listelm, list, link) {
2900 if (listelm->obj == listobj)
2903 elm = NEW(Objlist_Entry);
2905 if (listelm != NULL)
2906 STAILQ_INSERT_AFTER(list, listelm, elm, link);
2908 STAILQ_INSERT_TAIL(list, elm, link);
2912 objlist_remove(Objlist *list, Obj_Entry *obj)
2916 if ((elm = objlist_find(list, obj)) != NULL) {
2917 STAILQ_REMOVE(list, elm, Struct_Objlist_Entry, link);
2923 * Relocate dag rooted in the specified object.
2924 * Returns 0 on success, or -1 on failure.
2928 relocate_object_dag(Obj_Entry *root, bool bind_now, Obj_Entry *rtldobj,
2929 int flags, RtldLockState *lockstate)
2935 STAILQ_FOREACH(elm, &root->dagmembers, link) {
2936 error = relocate_object(elm->obj, bind_now, rtldobj, flags,
2945 * Prepare for, or clean after, relocating an object marked with
2946 * DT_TEXTREL or DF_TEXTREL. Before relocating, all read-only
2947 * segments are remapped read-write. After relocations are done, the
2948 * segment's permissions are returned back to the modes specified in
2949 * the phdrs. If any relocation happened, or always for wired
2950 * program, COW is triggered.
2953 reloc_textrel_prot(Obj_Entry *obj, bool before)
2960 for (l = obj->phsize / sizeof(*ph), ph = obj->phdr; l > 0;
2962 if (ph->p_type != PT_LOAD || (ph->p_flags & PF_W) != 0)
2964 base = obj->relocbase + trunc_page(ph->p_vaddr);
2965 sz = round_page(ph->p_vaddr + ph->p_filesz) -
2966 trunc_page(ph->p_vaddr);
2967 prot = convert_prot(ph->p_flags) | (before ? PROT_WRITE : 0);
2968 if (mprotect(base, sz, prot) == -1) {
2969 _rtld_error("%s: Cannot write-%sable text segment: %s",
2970 obj->path, before ? "en" : "dis",
2971 rtld_strerror(errno));
2979 * Relocate single object.
2980 * Returns 0 on success, or -1 on failure.
2983 relocate_object(Obj_Entry *obj, bool bind_now, Obj_Entry *rtldobj,
2984 int flags, RtldLockState *lockstate)
2989 obj->relocated = true;
2991 dbg("relocating \"%s\"", obj->path);
2993 if (obj->symtab == NULL || obj->strtab == NULL ||
2994 !(obj->valid_hash_sysv || obj->valid_hash_gnu)) {
2995 _rtld_error("%s: Shared object has no run-time symbol table",
3000 /* There are relocations to the write-protected text segment. */
3001 if (obj->textrel && reloc_textrel_prot(obj, true) != 0)
3004 /* Process the non-PLT non-IFUNC relocations. */
3005 if (reloc_non_plt(obj, rtldobj, flags, lockstate))
3008 /* Re-protected the text segment. */
3009 if (obj->textrel && reloc_textrel_prot(obj, false) != 0)
3012 /* Set the special PLT or GOT entries. */
3015 /* Process the PLT relocations. */
3016 if (reloc_plt(obj, flags, lockstate) == -1)
3018 /* Relocate the jump slots if we are doing immediate binding. */
3019 if ((obj->bind_now || bind_now) && reloc_jmpslots(obj, flags,
3023 if (!obj->mainprog && obj_enforce_relro(obj) == -1)
3027 * Set up the magic number and version in the Obj_Entry. These
3028 * were checked in the crt1.o from the original ElfKit, so we
3029 * set them for backward compatibility.
3031 obj->magic = RTLD_MAGIC;
3032 obj->version = RTLD_VERSION;
3038 * Relocate newly-loaded shared objects. The argument is a pointer to
3039 * the Obj_Entry for the first such object. All objects from the first
3040 * to the end of the list of objects are relocated. Returns 0 on success,
3044 relocate_objects(Obj_Entry *first, bool bind_now, Obj_Entry *rtldobj,
3045 int flags, RtldLockState *lockstate)
3050 for (error = 0, obj = first; obj != NULL;
3051 obj = TAILQ_NEXT(obj, next)) {
3054 error = relocate_object(obj, bind_now, rtldobj, flags,
3063 * The handling of R_MACHINE_IRELATIVE relocations and jumpslots
3064 * referencing STT_GNU_IFUNC symbols is postponed till the other
3065 * relocations are done. The indirect functions specified as
3066 * ifunc are allowed to call other symbols, so we need to have
3067 * objects relocated before asking for resolution from indirects.
3069 * The R_MACHINE_IRELATIVE slots are resolved in greedy fashion,
3070 * instead of the usual lazy handling of PLT slots. It is
3071 * consistent with how GNU does it.
3074 resolve_object_ifunc(Obj_Entry *obj, bool bind_now, int flags,
3075 RtldLockState *lockstate)
3078 if (obj->ifuncs_resolved)
3080 obj->ifuncs_resolved = true;
3081 if (!obj->irelative && !obj->irelative_nonplt &&
3082 !((obj->bind_now || bind_now) && obj->gnu_ifunc))
3084 if (obj_disable_relro(obj) == -1 ||
3085 (obj->irelative && reloc_iresolve(obj, lockstate) == -1) ||
3086 (obj->irelative_nonplt && reloc_iresolve_nonplt(obj,
3087 lockstate) == -1) ||
3088 ((obj->bind_now || bind_now) && obj->gnu_ifunc &&
3089 reloc_gnu_ifunc(obj, flags, lockstate) == -1) ||
3090 obj_enforce_relro(obj) == -1)
3096 initlist_objects_ifunc(Objlist *list, bool bind_now, int flags,
3097 RtldLockState *lockstate)
3102 STAILQ_FOREACH(elm, list, link) {
3106 if (resolve_object_ifunc(obj, bind_now, flags,
3114 * Cleanup procedure. It will be called (by the atexit mechanism) just
3115 * before the process exits.
3120 RtldLockState lockstate;
3122 wlock_acquire(rtld_bind_lock, &lockstate);
3124 objlist_call_fini(&list_fini, NULL, &lockstate);
3125 /* No need to remove the items from the list, since we are exiting. */
3126 if (!libmap_disable)
3128 lock_release(rtld_bind_lock, &lockstate);
3137 * Iterate over a search path, translate each element, and invoke the
3138 * callback on the result.
3141 path_enumerate(const char *path, path_enum_proc callback,
3142 const char *refobj_path, void *arg)
3148 path += strspn(path, ":;");
3149 while (*path != '\0') {
3153 len = strcspn(path, ":;");
3154 trans = lm_findn(refobj_path, path, len);
3156 res = callback(trans, strlen(trans), arg);
3158 res = callback(path, len, arg);
3164 path += strspn(path, ":;");
3170 struct try_library_args {
3179 try_library_path(const char *dir, size_t dirlen, void *param)
3181 struct try_library_args *arg;
3185 if (*dir == '/' || trust) {
3188 if (dirlen + 1 + arg->namelen + 1 > arg->buflen)
3191 pathname = arg->buffer;
3192 strncpy(pathname, dir, dirlen);
3193 pathname[dirlen] = '/';
3194 strcpy(pathname + dirlen + 1, arg->name);
3196 dbg(" Trying \"%s\"", pathname);
3197 fd = open(pathname, O_RDONLY | O_CLOEXEC | O_VERIFY);
3199 dbg(" Opened \"%s\", fd %d", pathname, fd);
3200 pathname = xmalloc(dirlen + 1 + arg->namelen + 1);
3201 strcpy(pathname, arg->buffer);
3205 dbg(" Failed to open \"%s\": %s",
3206 pathname, rtld_strerror(errno));
3213 search_library_path(const char *name, const char *path,
3214 const char *refobj_path, int *fdp)
3217 struct try_library_args arg;
3223 arg.namelen = strlen(name);
3224 arg.buffer = xmalloc(PATH_MAX);
3225 arg.buflen = PATH_MAX;
3228 p = path_enumerate(path, try_library_path, refobj_path, &arg);
3238 * Finds the library with the given name using the directory descriptors
3239 * listed in the LD_LIBRARY_PATH_FDS environment variable.
3241 * Returns a freshly-opened close-on-exec file descriptor for the library,
3242 * or -1 if the library cannot be found.
3245 search_library_pathfds(const char *name, const char *path, int *fdp)
3247 char *envcopy, *fdstr, *found, *last_token;
3251 dbg("%s('%s', '%s', fdp)", __func__, name, path);
3253 /* Don't load from user-specified libdirs into setuid binaries. */
3257 /* We can't do anything if LD_LIBRARY_PATH_FDS isn't set. */
3261 /* LD_LIBRARY_PATH_FDS only works with relative paths. */
3262 if (name[0] == '/') {
3263 dbg("Absolute path (%s) passed to %s", name, __func__);
3268 * Use strtok_r() to walk the FD:FD:FD list. This requires a local
3269 * copy of the path, as strtok_r rewrites separator tokens
3273 envcopy = xstrdup(path);
3274 for (fdstr = strtok_r(envcopy, ":", &last_token); fdstr != NULL;
3275 fdstr = strtok_r(NULL, ":", &last_token)) {
3276 dirfd = parse_integer(fdstr);
3278 _rtld_error("failed to parse directory FD: '%s'",
3282 fd = __sys_openat(dirfd, name, O_RDONLY | O_CLOEXEC | O_VERIFY);
3285 len = strlen(fdstr) + strlen(name) + 3;
3286 found = xmalloc(len);
3287 if (rtld_snprintf(found, len, "#%d/%s", dirfd, name) < 0) {
3288 _rtld_error("error generating '%d/%s'",
3292 dbg("open('%s') => %d", found, fd);
3303 dlclose(void *handle)
3305 RtldLockState lockstate;
3308 wlock_acquire(rtld_bind_lock, &lockstate);
3309 error = dlclose_locked(handle, &lockstate);
3310 lock_release(rtld_bind_lock, &lockstate);
3315 dlclose_locked(void *handle, RtldLockState *lockstate)
3319 root = dlcheck(handle);
3322 LD_UTRACE(UTRACE_DLCLOSE_START, handle, NULL, 0, root->dl_refcount,
3325 /* Unreference the object and its dependencies. */
3326 root->dl_refcount--;
3328 if (root->refcount == 1) {
3330 * The object will be no longer referenced, so we must unload it.
3331 * First, call the fini functions.
3333 objlist_call_fini(&list_fini, root, lockstate);
3337 /* Finish cleaning up the newly-unreferenced objects. */
3338 GDB_STATE(RT_DELETE,&root->linkmap);
3339 unload_object(root, lockstate);
3340 GDB_STATE(RT_CONSISTENT,NULL);
3344 LD_UTRACE(UTRACE_DLCLOSE_STOP, handle, NULL, 0, 0, NULL);
3351 char *msg = error_message;
3352 error_message = NULL;
3357 * This function is deprecated and has no effect.
3360 dllockinit(void *context,
3361 void *(*_lock_create)(void *context) __unused,
3362 void (*_rlock_acquire)(void *lock) __unused,
3363 void (*_wlock_acquire)(void *lock) __unused,
3364 void (*_lock_release)(void *lock) __unused,
3365 void (*_lock_destroy)(void *lock) __unused,
3366 void (*context_destroy)(void *context))
3368 static void *cur_context;
3369 static void (*cur_context_destroy)(void *);
3371 /* Just destroy the context from the previous call, if necessary. */
3372 if (cur_context_destroy != NULL)
3373 cur_context_destroy(cur_context);
3374 cur_context = context;
3375 cur_context_destroy = context_destroy;
3379 dlopen(const char *name, int mode)
3382 return (rtld_dlopen(name, -1, mode));
3386 fdlopen(int fd, int mode)
3389 return (rtld_dlopen(NULL, fd, mode));
3393 rtld_dlopen(const char *name, int fd, int mode)
3395 RtldLockState lockstate;
3398 LD_UTRACE(UTRACE_DLOPEN_START, NULL, NULL, 0, mode, name);
3399 ld_tracing = (mode & RTLD_TRACE) == 0 ? NULL : "1";
3400 if (ld_tracing != NULL) {
3401 rlock_acquire(rtld_bind_lock, &lockstate);
3402 if (sigsetjmp(lockstate.env, 0) != 0)
3403 lock_upgrade(rtld_bind_lock, &lockstate);
3404 environ = __DECONST(char **, *get_program_var_addr("environ", &lockstate));
3405 lock_release(rtld_bind_lock, &lockstate);
3407 lo_flags = RTLD_LO_DLOPEN;
3408 if (mode & RTLD_NODELETE)
3409 lo_flags |= RTLD_LO_NODELETE;
3410 if (mode & RTLD_NOLOAD)
3411 lo_flags |= RTLD_LO_NOLOAD;
3412 if (mode & RTLD_DEEPBIND)
3413 lo_flags |= RTLD_LO_DEEPBIND;
3414 if (ld_tracing != NULL)
3415 lo_flags |= RTLD_LO_TRACE | RTLD_LO_IGNSTLS;
3417 return (dlopen_object(name, fd, obj_main, lo_flags,
3418 mode & (RTLD_MODEMASK | RTLD_GLOBAL), NULL));
3422 dlopen_cleanup(Obj_Entry *obj, RtldLockState *lockstate)
3427 if (obj->refcount == 0)
3428 unload_object(obj, lockstate);
3432 dlopen_object(const char *name, int fd, Obj_Entry *refobj, int lo_flags,
3433 int mode, RtldLockState *lockstate)
3435 Obj_Entry *old_obj_tail;
3438 RtldLockState mlockstate;
3441 objlist_init(&initlist);
3443 if (lockstate == NULL && !(lo_flags & RTLD_LO_EARLY)) {
3444 wlock_acquire(rtld_bind_lock, &mlockstate);
3445 lockstate = &mlockstate;
3447 GDB_STATE(RT_ADD,NULL);
3449 old_obj_tail = globallist_curr(TAILQ_LAST(&obj_list, obj_entry_q));
3451 if (name == NULL && fd == -1) {
3455 obj = load_object(name, fd, refobj, lo_flags);
3460 if (mode & RTLD_GLOBAL && objlist_find(&list_global, obj) == NULL)
3461 objlist_push_tail(&list_global, obj);
3462 if (globallist_next(old_obj_tail) != NULL) {
3463 /* We loaded something new. */
3464 assert(globallist_next(old_obj_tail) == obj);
3465 if ((lo_flags & RTLD_LO_DEEPBIND) != 0)
3466 obj->symbolic = true;
3468 if ((lo_flags & (RTLD_LO_EARLY | RTLD_LO_IGNSTLS)) == 0 &&
3469 obj->static_tls && !allocate_tls_offset(obj)) {
3470 _rtld_error("%s: No space available "
3471 "for static Thread Local Storage", obj->path);
3475 result = load_needed_objects(obj, lo_flags & (RTLD_LO_DLOPEN |
3476 RTLD_LO_EARLY | RTLD_LO_IGNSTLS | RTLD_LO_TRACE));
3480 result = rtld_verify_versions(&obj->dagmembers);
3481 if (result != -1 && ld_tracing)
3483 if (result == -1 || relocate_object_dag(obj,
3484 (mode & RTLD_MODEMASK) == RTLD_NOW, &obj_rtld,
3485 (lo_flags & RTLD_LO_EARLY) ? SYMLOOK_EARLY : 0,
3487 dlopen_cleanup(obj, lockstate);
3489 } else if (lo_flags & RTLD_LO_EARLY) {
3491 * Do not call the init functions for early loaded
3492 * filtees. The image is still not initialized enough
3495 * Our object is found by the global object list and
3496 * will be ordered among all init calls done right
3497 * before transferring control to main.
3500 /* Make list of init functions to call. */
3501 initlist_add_objects(obj, obj, &initlist);
3504 * Process all no_delete or global objects here, given
3505 * them own DAGs to prevent their dependencies from being
3506 * unloaded. This has to be done after we have loaded all
3507 * of the dependencies, so that we do not miss any.
3513 * Bump the reference counts for objects on this DAG. If
3514 * this is the first dlopen() call for the object that was
3515 * already loaded as a dependency, initialize the dag
3521 if ((lo_flags & RTLD_LO_TRACE) != 0)
3524 if (obj != NULL && ((lo_flags & RTLD_LO_NODELETE) != 0 ||
3525 obj->z_nodelete) && !obj->ref_nodel) {
3526 dbg("obj %s nodelete", obj->path);
3528 obj->z_nodelete = obj->ref_nodel = true;
3532 LD_UTRACE(UTRACE_DLOPEN_STOP, obj, NULL, 0, obj ? obj->dl_refcount : 0,
3534 GDB_STATE(RT_CONSISTENT,obj ? &obj->linkmap : NULL);
3536 if ((lo_flags & RTLD_LO_EARLY) == 0) {
3537 map_stacks_exec(lockstate);
3539 distribute_static_tls(&initlist, lockstate);
3542 if (initlist_objects_ifunc(&initlist, (mode & RTLD_MODEMASK) == RTLD_NOW,
3543 (lo_flags & RTLD_LO_EARLY) ? SYMLOOK_EARLY : 0,
3545 objlist_clear(&initlist);
3546 dlopen_cleanup(obj, lockstate);
3547 if (lockstate == &mlockstate)
3548 lock_release(rtld_bind_lock, lockstate);
3552 if (!(lo_flags & RTLD_LO_EARLY)) {
3553 /* Call the init functions. */
3554 objlist_call_init(&initlist, lockstate);
3556 objlist_clear(&initlist);
3557 if (lockstate == &mlockstate)
3558 lock_release(rtld_bind_lock, lockstate);
3561 trace_loaded_objects(obj);
3562 if (lockstate == &mlockstate)
3563 lock_release(rtld_bind_lock, lockstate);
3568 do_dlsym(void *handle, const char *name, void *retaddr, const Ver_Entry *ve,
3572 const Obj_Entry *obj, *defobj;
3575 RtldLockState lockstate;
3582 symlook_init(&req, name);
3584 req.flags = flags | SYMLOOK_IN_PLT;
3585 req.lockstate = &lockstate;
3587 LD_UTRACE(UTRACE_DLSYM_START, handle, NULL, 0, 0, name);
3588 rlock_acquire(rtld_bind_lock, &lockstate);
3589 if (sigsetjmp(lockstate.env, 0) != 0)
3590 lock_upgrade(rtld_bind_lock, &lockstate);
3591 if (handle == NULL || handle == RTLD_NEXT ||
3592 handle == RTLD_DEFAULT || handle == RTLD_SELF) {
3594 if ((obj = obj_from_addr(retaddr)) == NULL) {
3595 _rtld_error("Cannot determine caller's shared object");
3596 lock_release(rtld_bind_lock, &lockstate);
3597 LD_UTRACE(UTRACE_DLSYM_STOP, handle, NULL, 0, 0, name);
3600 if (handle == NULL) { /* Just the caller's shared object. */
3601 res = symlook_obj(&req, obj);
3604 defobj = req.defobj_out;
3606 } else if (handle == RTLD_NEXT || /* Objects after caller's */
3607 handle == RTLD_SELF) { /* ... caller included */
3608 if (handle == RTLD_NEXT)
3609 obj = globallist_next(obj);
3610 for (; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
3613 res = symlook_obj(&req, obj);
3616 ELF_ST_BIND(req.sym_out->st_info) != STB_WEAK) {
3618 defobj = req.defobj_out;
3619 if (ELF_ST_BIND(def->st_info) != STB_WEAK)
3625 * Search the dynamic linker itself, and possibly resolve the
3626 * symbol from there. This is how the application links to
3627 * dynamic linker services such as dlopen.
3629 if (def == NULL || ELF_ST_BIND(def->st_info) == STB_WEAK) {
3630 res = symlook_obj(&req, &obj_rtld);
3633 defobj = req.defobj_out;
3637 assert(handle == RTLD_DEFAULT);
3638 res = symlook_default(&req, obj);
3640 defobj = req.defobj_out;
3645 if ((obj = dlcheck(handle)) == NULL) {
3646 lock_release(rtld_bind_lock, &lockstate);
3647 LD_UTRACE(UTRACE_DLSYM_STOP, handle, NULL, 0, 0, name);
3651 donelist_init(&donelist);
3652 if (obj->mainprog) {
3653 /* Handle obtained by dlopen(NULL, ...) implies global scope. */
3654 res = symlook_global(&req, &donelist);
3657 defobj = req.defobj_out;
3660 * Search the dynamic linker itself, and possibly resolve the
3661 * symbol from there. This is how the application links to
3662 * dynamic linker services such as dlopen.
3664 if (def == NULL || ELF_ST_BIND(def->st_info) == STB_WEAK) {
3665 res = symlook_obj(&req, &obj_rtld);
3668 defobj = req.defobj_out;
3673 /* Search the whole DAG rooted at the given object. */
3674 res = symlook_list(&req, &obj->dagmembers, &donelist);
3677 defobj = req.defobj_out;
3683 lock_release(rtld_bind_lock, &lockstate);
3686 * The value required by the caller is derived from the value
3687 * of the symbol. this is simply the relocated value of the
3690 if (ELF_ST_TYPE(def->st_info) == STT_FUNC)
3691 sym = make_function_pointer(def, defobj);
3692 else if (ELF_ST_TYPE(def->st_info) == STT_GNU_IFUNC)
3693 sym = rtld_resolve_ifunc(defobj, def);
3694 else if (ELF_ST_TYPE(def->st_info) == STT_TLS) {
3695 ti.ti_module = defobj->tlsindex;
3696 ti.ti_offset = def->st_value;
3697 sym = __tls_get_addr(&ti);
3699 sym = defobj->relocbase + def->st_value;
3700 LD_UTRACE(UTRACE_DLSYM_STOP, handle, sym, 0, 0, name);
3704 _rtld_error("Undefined symbol \"%s%s%s\"", name, ve != NULL ? "@" : "",
3705 ve != NULL ? ve->name : "");
3706 lock_release(rtld_bind_lock, &lockstate);
3707 LD_UTRACE(UTRACE_DLSYM_STOP, handle, NULL, 0, 0, name);
3712 dlsym(void *handle, const char *name)
3714 return do_dlsym(handle, name, __builtin_return_address(0), NULL,
3719 dlfunc(void *handle, const char *name)
3726 rv.d = do_dlsym(handle, name, __builtin_return_address(0), NULL,
3732 dlvsym(void *handle, const char *name, const char *version)
3736 ventry.name = version;
3738 ventry.hash = elf_hash(version);
3740 return do_dlsym(handle, name, __builtin_return_address(0), &ventry,
3745 _rtld_addr_phdr(const void *addr, struct dl_phdr_info *phdr_info)
3747 const Obj_Entry *obj;
3748 RtldLockState lockstate;
3750 rlock_acquire(rtld_bind_lock, &lockstate);
3751 obj = obj_from_addr(addr);
3753 _rtld_error("No shared object contains address");
3754 lock_release(rtld_bind_lock, &lockstate);
3757 rtld_fill_dl_phdr_info(obj, phdr_info);
3758 lock_release(rtld_bind_lock, &lockstate);
3763 dladdr(const void *addr, Dl_info *info)
3765 const Obj_Entry *obj;
3768 unsigned long symoffset;
3769 RtldLockState lockstate;
3771 rlock_acquire(rtld_bind_lock, &lockstate);
3772 obj = obj_from_addr(addr);
3774 _rtld_error("No shared object contains address");
3775 lock_release(rtld_bind_lock, &lockstate);
3778 info->dli_fname = obj->path;
3779 info->dli_fbase = obj->mapbase;
3780 info->dli_saddr = (void *)0;
3781 info->dli_sname = NULL;
3784 * Walk the symbol list looking for the symbol whose address is
3785 * closest to the address sent in.
3787 for (symoffset = 0; symoffset < obj->dynsymcount; symoffset++) {
3788 def = obj->symtab + symoffset;
3791 * For skip the symbol if st_shndx is either SHN_UNDEF or
3794 if (def->st_shndx == SHN_UNDEF || def->st_shndx == SHN_COMMON)
3798 * If the symbol is greater than the specified address, or if it
3799 * is further away from addr than the current nearest symbol,
3802 symbol_addr = obj->relocbase + def->st_value;
3803 if (symbol_addr > addr || symbol_addr < info->dli_saddr)
3806 /* Update our idea of the nearest symbol. */
3807 info->dli_sname = obj->strtab + def->st_name;
3808 info->dli_saddr = symbol_addr;
3811 if (info->dli_saddr == addr)
3814 lock_release(rtld_bind_lock, &lockstate);
3819 dlinfo(void *handle, int request, void *p)
3821 const Obj_Entry *obj;
3822 RtldLockState lockstate;
3825 rlock_acquire(rtld_bind_lock, &lockstate);
3827 if (handle == NULL || handle == RTLD_SELF) {
3830 retaddr = __builtin_return_address(0); /* __GNUC__ only */
3831 if ((obj = obj_from_addr(retaddr)) == NULL)
3832 _rtld_error("Cannot determine caller's shared object");
3834 obj = dlcheck(handle);
3837 lock_release(rtld_bind_lock, &lockstate);
3843 case RTLD_DI_LINKMAP:
3844 *((struct link_map const **)p) = &obj->linkmap;
3846 case RTLD_DI_ORIGIN:
3847 error = rtld_dirname(obj->path, p);
3850 case RTLD_DI_SERINFOSIZE:
3851 case RTLD_DI_SERINFO:
3852 error = do_search_info(obj, request, (struct dl_serinfo *)p);
3856 _rtld_error("Invalid request %d passed to dlinfo()", request);
3860 lock_release(rtld_bind_lock, &lockstate);
3866 rtld_fill_dl_phdr_info(const Obj_Entry *obj, struct dl_phdr_info *phdr_info)
3869 phdr_info->dlpi_addr = (Elf_Addr)obj->relocbase;
3870 phdr_info->dlpi_name = obj->path;
3871 phdr_info->dlpi_phdr = obj->phdr;
3872 phdr_info->dlpi_phnum = obj->phsize / sizeof(obj->phdr[0]);
3873 phdr_info->dlpi_tls_modid = obj->tlsindex;
3874 phdr_info->dlpi_tls_data = obj->tlsinit;
3875 phdr_info->dlpi_adds = obj_loads;
3876 phdr_info->dlpi_subs = obj_loads - obj_count;
3880 dl_iterate_phdr(__dl_iterate_hdr_callback callback, void *param)
3882 struct dl_phdr_info phdr_info;
3883 Obj_Entry *obj, marker;
3884 RtldLockState bind_lockstate, phdr_lockstate;
3887 init_marker(&marker);
3890 wlock_acquire(rtld_phdr_lock, &phdr_lockstate);
3891 wlock_acquire(rtld_bind_lock, &bind_lockstate);
3892 for (obj = globallist_curr(TAILQ_FIRST(&obj_list)); obj != NULL;) {
3893 TAILQ_INSERT_AFTER(&obj_list, obj, &marker, next);
3894 rtld_fill_dl_phdr_info(obj, &phdr_info);
3896 lock_release(rtld_bind_lock, &bind_lockstate);
3898 error = callback(&phdr_info, sizeof phdr_info, param);
3900 wlock_acquire(rtld_bind_lock, &bind_lockstate);
3902 obj = globallist_next(&marker);
3903 TAILQ_REMOVE(&obj_list, &marker, next);
3905 lock_release(rtld_bind_lock, &bind_lockstate);
3906 lock_release(rtld_phdr_lock, &phdr_lockstate);
3912 rtld_fill_dl_phdr_info(&obj_rtld, &phdr_info);
3913 lock_release(rtld_bind_lock, &bind_lockstate);
3914 error = callback(&phdr_info, sizeof(phdr_info), param);
3916 lock_release(rtld_phdr_lock, &phdr_lockstate);
3921 fill_search_info(const char *dir, size_t dirlen, void *param)
3923 struct fill_search_info_args *arg;
3927 if (arg->request == RTLD_DI_SERINFOSIZE) {
3928 arg->serinfo->dls_cnt ++;
3929 arg->serinfo->dls_size += sizeof(struct dl_serpath) + dirlen + 1;
3931 struct dl_serpath *s_entry;
3933 s_entry = arg->serpath;
3934 s_entry->dls_name = arg->strspace;
3935 s_entry->dls_flags = arg->flags;
3937 strncpy(arg->strspace, dir, dirlen);
3938 arg->strspace[dirlen] = '\0';
3940 arg->strspace += dirlen + 1;
3948 do_search_info(const Obj_Entry *obj, int request, struct dl_serinfo *info)
3950 struct dl_serinfo _info;
3951 struct fill_search_info_args args;
3953 args.request = RTLD_DI_SERINFOSIZE;
3954 args.serinfo = &_info;
3956 _info.dls_size = __offsetof(struct dl_serinfo, dls_serpath);
3959 path_enumerate(obj->rpath, fill_search_info, NULL, &args);
3960 path_enumerate(ld_library_path, fill_search_info, NULL, &args);
3961 path_enumerate(obj->runpath, fill_search_info, NULL, &args);
3962 path_enumerate(gethints(obj->z_nodeflib), fill_search_info, NULL, &args);
3963 if (!obj->z_nodeflib)
3964 path_enumerate(ld_standard_library_path, fill_search_info, NULL, &args);
3967 if (request == RTLD_DI_SERINFOSIZE) {
3968 info->dls_size = _info.dls_size;
3969 info->dls_cnt = _info.dls_cnt;
3973 if (info->dls_cnt != _info.dls_cnt || info->dls_size != _info.dls_size) {
3974 _rtld_error("Uninitialized Dl_serinfo struct passed to dlinfo()");
3978 args.request = RTLD_DI_SERINFO;
3979 args.serinfo = info;
3980 args.serpath = &info->dls_serpath[0];
3981 args.strspace = (char *)&info->dls_serpath[_info.dls_cnt];
3983 args.flags = LA_SER_RUNPATH;
3984 if (path_enumerate(obj->rpath, fill_search_info, NULL, &args) != NULL)
3987 args.flags = LA_SER_LIBPATH;
3988 if (path_enumerate(ld_library_path, fill_search_info, NULL, &args) != NULL)
3991 args.flags = LA_SER_RUNPATH;
3992 if (path_enumerate(obj->runpath, fill_search_info, NULL, &args) != NULL)
3995 args.flags = LA_SER_CONFIG;
3996 if (path_enumerate(gethints(obj->z_nodeflib), fill_search_info, NULL, &args)
4000 args.flags = LA_SER_DEFAULT;
4001 if (!obj->z_nodeflib && path_enumerate(ld_standard_library_path,
4002 fill_search_info, NULL, &args) != NULL)
4008 rtld_dirname(const char *path, char *bname)
4012 /* Empty or NULL string gets treated as "." */
4013 if (path == NULL || *path == '\0') {
4019 /* Strip trailing slashes */
4020 endp = path + strlen(path) - 1;
4021 while (endp > path && *endp == '/')
4024 /* Find the start of the dir */
4025 while (endp > path && *endp != '/')
4028 /* Either the dir is "/" or there are no slashes */
4030 bname[0] = *endp == '/' ? '/' : '.';
4036 } while (endp > path && *endp == '/');
4039 if (endp - path + 2 > PATH_MAX)
4041 _rtld_error("Filename is too long: %s", path);
4045 strncpy(bname, path, endp - path + 1);
4046 bname[endp - path + 1] = '\0';
4051 rtld_dirname_abs(const char *path, char *base)
4055 if (realpath(path, base) == NULL) {
4056 _rtld_error("realpath \"%s\" failed (%s)", path,
4057 rtld_strerror(errno));
4060 dbg("%s -> %s", path, base);
4061 last = strrchr(base, '/');
4063 _rtld_error("non-abs result from realpath \"%s\"", path);
4072 linkmap_add(Obj_Entry *obj)
4074 struct link_map *l, *prev;
4077 l->l_name = obj->path;
4078 l->l_base = obj->mapbase;
4079 l->l_ld = obj->dynamic;
4080 l->l_addr = obj->relocbase;
4082 if (r_debug.r_map == NULL) {
4088 * Scan to the end of the list, but not past the entry for the
4089 * dynamic linker, which we want to keep at the very end.
4091 for (prev = r_debug.r_map;
4092 prev->l_next != NULL && prev->l_next != &obj_rtld.linkmap;
4093 prev = prev->l_next)
4096 /* Link in the new entry. */
4098 l->l_next = prev->l_next;
4099 if (l->l_next != NULL)
4100 l->l_next->l_prev = l;
4105 linkmap_delete(Obj_Entry *obj)
4110 if (l->l_prev == NULL) {
4111 if ((r_debug.r_map = l->l_next) != NULL)
4112 l->l_next->l_prev = NULL;
4116 if ((l->l_prev->l_next = l->l_next) != NULL)
4117 l->l_next->l_prev = l->l_prev;
4121 * Function for the debugger to set a breakpoint on to gain control.
4123 * The two parameters allow the debugger to easily find and determine
4124 * what the runtime loader is doing and to whom it is doing it.
4126 * When the loadhook trap is hit (r_debug_state, set at program
4127 * initialization), the arguments can be found on the stack:
4129 * +8 struct link_map *m
4130 * +4 struct r_debug *rd
4134 r_debug_state(struct r_debug* rd __unused, struct link_map *m __unused)
4137 * The following is a hack to force the compiler to emit calls to
4138 * this function, even when optimizing. If the function is empty,
4139 * the compiler is not obliged to emit any code for calls to it,
4140 * even when marked __noinline. However, gdb depends on those
4143 __compiler_membar();
4147 * A function called after init routines have completed. This can be used to
4148 * break before a program's entry routine is called, and can be used when
4149 * main is not available in the symbol table.
4152 _r_debug_postinit(struct link_map *m __unused)
4155 /* See r_debug_state(). */
4156 __compiler_membar();
4160 release_object(Obj_Entry *obj)
4163 if (obj->holdcount > 0) {
4164 obj->unholdfree = true;
4167 munmap(obj->mapbase, obj->mapsize);
4168 linkmap_delete(obj);
4173 * Get address of the pointer variable in the main program.
4174 * Prefer non-weak symbol over the weak one.
4176 static const void **
4177 get_program_var_addr(const char *name, RtldLockState *lockstate)
4182 symlook_init(&req, name);
4183 req.lockstate = lockstate;
4184 donelist_init(&donelist);
4185 if (symlook_global(&req, &donelist) != 0)
4187 if (ELF_ST_TYPE(req.sym_out->st_info) == STT_FUNC)
4188 return ((const void **)make_function_pointer(req.sym_out,
4190 else if (ELF_ST_TYPE(req.sym_out->st_info) == STT_GNU_IFUNC)
4191 return ((const void **)rtld_resolve_ifunc(req.defobj_out, req.sym_out));
4193 return ((const void **)(req.defobj_out->relocbase +
4194 req.sym_out->st_value));
4198 * Set a pointer variable in the main program to the given value. This
4199 * is used to set key variables such as "environ" before any of the
4200 * init functions are called.
4203 set_program_var(const char *name, const void *value)
4207 if ((addr = get_program_var_addr(name, NULL)) != NULL) {
4208 dbg("\"%s\": *%p <-- %p", name, addr, value);
4214 * Search the global objects, including dependencies and main object,
4215 * for the given symbol.
4218 symlook_global(SymLook *req, DoneList *donelist)
4221 const Objlist_Entry *elm;
4224 symlook_init_from_req(&req1, req);
4226 /* Search all objects loaded at program start up. */
4227 if (req->defobj_out == NULL ||
4228 ELF_ST_BIND(req->sym_out->st_info) == STB_WEAK) {
4229 res = symlook_list(&req1, &list_main, donelist);
4230 if (res == 0 && (req->defobj_out == NULL ||
4231 ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK)) {
4232 req->sym_out = req1.sym_out;
4233 req->defobj_out = req1.defobj_out;
4234 assert(req->defobj_out != NULL);
4238 /* Search all DAGs whose roots are RTLD_GLOBAL objects. */
4239 STAILQ_FOREACH(elm, &list_global, link) {
4240 if (req->defobj_out != NULL &&
4241 ELF_ST_BIND(req->sym_out->st_info) != STB_WEAK)
4243 res = symlook_list(&req1, &elm->obj->dagmembers, donelist);
4244 if (res == 0 && (req->defobj_out == NULL ||
4245 ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK)) {
4246 req->sym_out = req1.sym_out;
4247 req->defobj_out = req1.defobj_out;
4248 assert(req->defobj_out != NULL);
4252 return (req->sym_out != NULL ? 0 : ESRCH);
4256 * Given a symbol name in a referencing object, find the corresponding
4257 * definition of the symbol. Returns a pointer to the symbol, or NULL if
4258 * no definition was found. Returns a pointer to the Obj_Entry of the
4259 * defining object via the reference parameter DEFOBJ_OUT.
4262 symlook_default(SymLook *req, const Obj_Entry *refobj)
4265 const Objlist_Entry *elm;
4269 donelist_init(&donelist);
4270 symlook_init_from_req(&req1, req);
4273 * Look first in the referencing object if linked symbolically,
4274 * and similarly handle protected symbols.
4276 res = symlook_obj(&req1, refobj);
4277 if (res == 0 && (refobj->symbolic ||
4278 ELF_ST_VISIBILITY(req1.sym_out->st_other) == STV_PROTECTED)) {
4279 req->sym_out = req1.sym_out;
4280 req->defobj_out = req1.defobj_out;
4281 assert(req->defobj_out != NULL);
4283 if (refobj->symbolic || req->defobj_out != NULL)
4284 donelist_check(&donelist, refobj);
4286 symlook_global(req, &donelist);
4288 /* Search all dlopened DAGs containing the referencing object. */
4289 STAILQ_FOREACH(elm, &refobj->dldags, link) {
4290 if (req->sym_out != NULL &&
4291 ELF_ST_BIND(req->sym_out->st_info) != STB_WEAK)
4293 res = symlook_list(&req1, &elm->obj->dagmembers, &donelist);
4294 if (res == 0 && (req->sym_out == NULL ||
4295 ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK)) {
4296 req->sym_out = req1.sym_out;
4297 req->defobj_out = req1.defobj_out;
4298 assert(req->defobj_out != NULL);
4303 * Search the dynamic linker itself, and possibly resolve the
4304 * symbol from there. This is how the application links to
4305 * dynamic linker services such as dlopen.
4307 if (req->sym_out == NULL ||
4308 ELF_ST_BIND(req->sym_out->st_info) == STB_WEAK) {
4309 res = symlook_obj(&req1, &obj_rtld);
4311 req->sym_out = req1.sym_out;
4312 req->defobj_out = req1.defobj_out;
4313 assert(req->defobj_out != NULL);
4317 return (req->sym_out != NULL ? 0 : ESRCH);
4321 symlook_list(SymLook *req, const Objlist *objlist, DoneList *dlp)
4324 const Obj_Entry *defobj;
4325 const Objlist_Entry *elm;
4331 STAILQ_FOREACH(elm, objlist, link) {
4332 if (donelist_check(dlp, elm->obj))
4334 symlook_init_from_req(&req1, req);
4335 if ((res = symlook_obj(&req1, elm->obj)) == 0) {
4336 if (def == NULL || ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK) {
4338 defobj = req1.defobj_out;
4339 if (ELF_ST_BIND(def->st_info) != STB_WEAK)
4346 req->defobj_out = defobj;
4353 * Search the chain of DAGS cointed to by the given Needed_Entry
4354 * for a symbol of the given name. Each DAG is scanned completely
4355 * before advancing to the next one. Returns a pointer to the symbol,
4356 * or NULL if no definition was found.
4359 symlook_needed(SymLook *req, const Needed_Entry *needed, DoneList *dlp)
4362 const Needed_Entry *n;
4363 const Obj_Entry *defobj;
4369 symlook_init_from_req(&req1, req);
4370 for (n = needed; n != NULL; n = n->next) {
4371 if (n->obj == NULL ||
4372 (res = symlook_list(&req1, &n->obj->dagmembers, dlp)) != 0)
4374 if (def == NULL || ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK) {
4376 defobj = req1.defobj_out;
4377 if (ELF_ST_BIND(def->st_info) != STB_WEAK)
4383 req->defobj_out = defobj;
4390 * Search the symbol table of a single shared object for a symbol of
4391 * the given name and version, if requested. Returns a pointer to the
4392 * symbol, or NULL if no definition was found. If the object is
4393 * filter, return filtered symbol from filtee.
4395 * The symbol's hash value is passed in for efficiency reasons; that
4396 * eliminates many recomputations of the hash value.
4399 symlook_obj(SymLook *req, const Obj_Entry *obj)
4403 int flags, res, mres;
4406 * If there is at least one valid hash at this point, we prefer to
4407 * use the faster GNU version if available.
4409 if (obj->valid_hash_gnu)
4410 mres = symlook_obj1_gnu(req, obj);
4411 else if (obj->valid_hash_sysv)
4412 mres = symlook_obj1_sysv(req, obj);
4417 if (obj->needed_filtees != NULL) {
4418 flags = (req->flags & SYMLOOK_EARLY) ? RTLD_LO_EARLY : 0;
4419 load_filtees(__DECONST(Obj_Entry *, obj), flags, req->lockstate);
4420 donelist_init(&donelist);
4421 symlook_init_from_req(&req1, req);
4422 res = symlook_needed(&req1, obj->needed_filtees, &donelist);
4424 req->sym_out = req1.sym_out;
4425 req->defobj_out = req1.defobj_out;
4429 if (obj->needed_aux_filtees != NULL) {
4430 flags = (req->flags & SYMLOOK_EARLY) ? RTLD_LO_EARLY : 0;
4431 load_filtees(__DECONST(Obj_Entry *, obj), flags, req->lockstate);
4432 donelist_init(&donelist);
4433 symlook_init_from_req(&req1, req);
4434 res = symlook_needed(&req1, obj->needed_aux_filtees, &donelist);
4436 req->sym_out = req1.sym_out;
4437 req->defobj_out = req1.defobj_out;
4445 /* Symbol match routine common to both hash functions */
4447 matched_symbol(SymLook *req, const Obj_Entry *obj, Sym_Match_Result *result,
4448 const unsigned long symnum)
4451 const Elf_Sym *symp;
4454 symp = obj->symtab + symnum;
4455 strp = obj->strtab + symp->st_name;
4457 switch (ELF_ST_TYPE(symp->st_info)) {
4463 if (symp->st_value == 0)
4467 if (symp->st_shndx != SHN_UNDEF)
4470 else if (((req->flags & SYMLOOK_IN_PLT) == 0) &&
4471 (ELF_ST_TYPE(symp->st_info) == STT_FUNC))
4478 if (req->name[0] != strp[0] || strcmp(req->name, strp) != 0)
4481 if (req->ventry == NULL) {
4482 if (obj->versyms != NULL) {
4483 verndx = VER_NDX(obj->versyms[symnum]);
4484 if (verndx > obj->vernum) {
4486 "%s: symbol %s references wrong version %d",
4487 obj->path, obj->strtab + symnum, verndx);
4491 * If we are not called from dlsym (i.e. this
4492 * is a normal relocation from unversioned
4493 * binary), accept the symbol immediately if
4494 * it happens to have first version after this
4495 * shared object became versioned. Otherwise,
4496 * if symbol is versioned and not hidden,
4497 * remember it. If it is the only symbol with
4498 * this name exported by the shared object, it
4499 * will be returned as a match by the calling
4500 * function. If symbol is global (verndx < 2)
4501 * accept it unconditionally.
4503 if ((req->flags & SYMLOOK_DLSYM) == 0 &&
4504 verndx == VER_NDX_GIVEN) {
4505 result->sym_out = symp;
4508 else if (verndx >= VER_NDX_GIVEN) {
4509 if ((obj->versyms[symnum] & VER_NDX_HIDDEN)
4511 if (result->vsymp == NULL)
4512 result->vsymp = symp;
4518 result->sym_out = symp;
4521 if (obj->versyms == NULL) {
4522 if (object_match_name(obj, req->ventry->name)) {
4523 _rtld_error("%s: object %s should provide version %s "
4524 "for symbol %s", obj_rtld.path, obj->path,
4525 req->ventry->name, obj->strtab + symnum);
4529 verndx = VER_NDX(obj->versyms[symnum]);
4530 if (verndx > obj->vernum) {
4531 _rtld_error("%s: symbol %s references wrong version %d",
4532 obj->path, obj->strtab + symnum, verndx);
4535 if (obj->vertab[verndx].hash != req->ventry->hash ||
4536 strcmp(obj->vertab[verndx].name, req->ventry->name)) {
4538 * Version does not match. Look if this is a
4539 * global symbol and if it is not hidden. If
4540 * global symbol (verndx < 2) is available,
4541 * use it. Do not return symbol if we are
4542 * called by dlvsym, because dlvsym looks for
4543 * a specific version and default one is not
4544 * what dlvsym wants.
4546 if ((req->flags & SYMLOOK_DLSYM) ||
4547 (verndx >= VER_NDX_GIVEN) ||
4548 (obj->versyms[symnum] & VER_NDX_HIDDEN))
4552 result->sym_out = symp;
4557 * Search for symbol using SysV hash function.
4558 * obj->buckets is known not to be NULL at this point; the test for this was
4559 * performed with the obj->valid_hash_sysv assignment.
4562 symlook_obj1_sysv(SymLook *req, const Obj_Entry *obj)
4564 unsigned long symnum;
4565 Sym_Match_Result matchres;
4567 matchres.sym_out = NULL;
4568 matchres.vsymp = NULL;
4569 matchres.vcount = 0;
4571 for (symnum = obj->buckets[req->hash % obj->nbuckets];
4572 symnum != STN_UNDEF; symnum = obj->chains[symnum]) {
4573 if (symnum >= obj->nchains)
4574 return (ESRCH); /* Bad object */
4576 if (matched_symbol(req, obj, &matchres, symnum)) {
4577 req->sym_out = matchres.sym_out;
4578 req->defobj_out = obj;
4582 if (matchres.vcount == 1) {
4583 req->sym_out = matchres.vsymp;
4584 req->defobj_out = obj;
4590 /* Search for symbol using GNU hash function */
4592 symlook_obj1_gnu(SymLook *req, const Obj_Entry *obj)
4594 Elf_Addr bloom_word;
4595 const Elf32_Word *hashval;
4597 Sym_Match_Result matchres;
4598 unsigned int h1, h2;
4599 unsigned long symnum;
4601 matchres.sym_out = NULL;
4602 matchres.vsymp = NULL;
4603 matchres.vcount = 0;
4605 /* Pick right bitmask word from Bloom filter array */
4606 bloom_word = obj->bloom_gnu[(req->hash_gnu / __ELF_WORD_SIZE) &
4607 obj->maskwords_bm_gnu];
4609 /* Calculate modulus word size of gnu hash and its derivative */
4610 h1 = req->hash_gnu & (__ELF_WORD_SIZE - 1);
4611 h2 = ((req->hash_gnu >> obj->shift2_gnu) & (__ELF_WORD_SIZE - 1));
4613 /* Filter out the "definitely not in set" queries */
4614 if (((bloom_word >> h1) & (bloom_word >> h2) & 1) == 0)
4617 /* Locate hash chain and corresponding value element*/
4618 bucket = obj->buckets_gnu[req->hash_gnu % obj->nbuckets_gnu];
4621 hashval = &obj->chain_zero_gnu[bucket];
4623 if (((*hashval ^ req->hash_gnu) >> 1) == 0) {
4624 symnum = hashval - obj->chain_zero_gnu;
4625 if (matched_symbol(req, obj, &matchres, symnum)) {
4626 req->sym_out = matchres.sym_out;
4627 req->defobj_out = obj;
4631 } while ((*hashval++ & 1) == 0);
4632 if (matchres.vcount == 1) {
4633 req->sym_out = matchres.vsymp;
4634 req->defobj_out = obj;
4641 trace_loaded_objects(Obj_Entry *obj)
4643 const char *fmt1, *fmt2, *fmt, *main_local, *list_containers;
4646 if ((main_local = getenv(_LD("TRACE_LOADED_OBJECTS_PROGNAME"))) == NULL)
4649 if ((fmt1 = getenv(_LD("TRACE_LOADED_OBJECTS_FMT1"))) == NULL)
4650 fmt1 = "\t%o => %p (%x)\n";
4652 if ((fmt2 = getenv(_LD("TRACE_LOADED_OBJECTS_FMT2"))) == NULL)
4653 fmt2 = "\t%o (%x)\n";
4655 list_containers = getenv(_LD("TRACE_LOADED_OBJECTS_ALL"));
4657 for (; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
4658 Needed_Entry *needed;
4659 const char *name, *path;
4664 if (list_containers && obj->needed != NULL)
4665 rtld_printf("%s:\n", obj->path);
4666 for (needed = obj->needed; needed; needed = needed->next) {
4667 if (needed->obj != NULL) {
4668 if (needed->obj->traced && !list_containers)
4670 needed->obj->traced = true;
4671 path = needed->obj->path;
4675 name = obj->strtab + needed->name;
4676 is_lib = strncmp(name, "lib", 3) == 0; /* XXX - bogus */
4678 fmt = is_lib ? fmt1 : fmt2;
4679 while ((c = *fmt++) != '\0') {
4705 rtld_putstr(main_local);
4708 rtld_putstr(obj_main->path);
4715 rtld_printf("%d", sodp->sod_major);
4718 rtld_printf("%d", sodp->sod_minor);
4725 rtld_printf("%p", needed->obj ? needed->obj->mapbase :
4738 * Unload a dlopened object and its dependencies from memory and from
4739 * our data structures. It is assumed that the DAG rooted in the
4740 * object has already been unreferenced, and that the object has a
4741 * reference count of 0.
4744 unload_object(Obj_Entry *root, RtldLockState *lockstate)
4746 Obj_Entry marker, *obj, *next;
4748 assert(root->refcount == 0);
4751 * Pass over the DAG removing unreferenced objects from
4752 * appropriate lists.
4754 unlink_object(root);
4756 /* Unmap all objects that are no longer referenced. */
4757 for (obj = TAILQ_FIRST(&obj_list); obj != NULL; obj = next) {
4758 next = TAILQ_NEXT(obj, next);
4759 if (obj->marker || obj->refcount != 0)
4761 LD_UTRACE(UTRACE_UNLOAD_OBJECT, obj, obj->mapbase,
4762 obj->mapsize, 0, obj->path);
4763 dbg("unloading \"%s\"", obj->path);
4765 * Unlink the object now to prevent new references from
4766 * being acquired while the bind lock is dropped in
4767 * recursive dlclose() invocations.
4769 TAILQ_REMOVE(&obj_list, obj, next);
4772 if (obj->filtees_loaded) {
4774 init_marker(&marker);
4775 TAILQ_INSERT_BEFORE(next, &marker, next);
4776 unload_filtees(obj, lockstate);
4777 next = TAILQ_NEXT(&marker, next);
4778 TAILQ_REMOVE(&obj_list, &marker, next);
4780 unload_filtees(obj, lockstate);
4782 release_object(obj);
4787 unlink_object(Obj_Entry *root)
4791 if (root->refcount == 0) {
4792 /* Remove the object from the RTLD_GLOBAL list. */
4793 objlist_remove(&list_global, root);
4795 /* Remove the object from all objects' DAG lists. */
4796 STAILQ_FOREACH(elm, &root->dagmembers, link) {
4797 objlist_remove(&elm->obj->dldags, root);
4798 if (elm->obj != root)
4799 unlink_object(elm->obj);
4805 ref_dag(Obj_Entry *root)
4809 assert(root->dag_inited);
4810 STAILQ_FOREACH(elm, &root->dagmembers, link)
4811 elm->obj->refcount++;
4815 unref_dag(Obj_Entry *root)
4819 assert(root->dag_inited);
4820 STAILQ_FOREACH(elm, &root->dagmembers, link)
4821 elm->obj->refcount--;
4825 * Common code for MD __tls_get_addr().
4827 static void *tls_get_addr_slow(Elf_Addr **, int, size_t) __noinline;
4829 tls_get_addr_slow(Elf_Addr **dtvp, int index, size_t offset)
4831 Elf_Addr *newdtv, *dtv;
4832 RtldLockState lockstate;
4836 /* Check dtv generation in case new modules have arrived */
4837 if (dtv[0] != tls_dtv_generation) {
4838 wlock_acquire(rtld_bind_lock, &lockstate);
4839 newdtv = xcalloc(tls_max_index + 2, sizeof(Elf_Addr));
4841 if (to_copy > tls_max_index)
4842 to_copy = tls_max_index;
4843 memcpy(&newdtv[2], &dtv[2], to_copy * sizeof(Elf_Addr));
4844 newdtv[0] = tls_dtv_generation;
4845 newdtv[1] = tls_max_index;
4847 lock_release(rtld_bind_lock, &lockstate);
4848 dtv = *dtvp = newdtv;
4851 /* Dynamically allocate module TLS if necessary */
4852 if (dtv[index + 1] == 0) {
4853 /* Signal safe, wlock will block out signals. */
4854 wlock_acquire(rtld_bind_lock, &lockstate);
4855 if (!dtv[index + 1])
4856 dtv[index + 1] = (Elf_Addr)allocate_module_tls(index);
4857 lock_release(rtld_bind_lock, &lockstate);
4859 return ((void *)(dtv[index + 1] + offset));
4863 tls_get_addr_common(Elf_Addr **dtvp, int index, size_t offset)
4868 /* Check dtv generation in case new modules have arrived */
4869 if (__predict_true(dtv[0] == tls_dtv_generation &&
4870 dtv[index + 1] != 0))
4871 return ((void *)(dtv[index + 1] + offset));
4872 return (tls_get_addr_slow(dtvp, index, offset));
4875 #if defined(__aarch64__) || defined(__arm__) || defined(__mips__) || \
4876 defined(__powerpc__) || defined(__riscv)
4879 * Return pointer to allocated TLS block
4882 get_tls_block_ptr(void *tcb, size_t tcbsize)
4884 size_t extra_size, post_size, pre_size, tls_block_size;
4885 size_t tls_init_align;
4887 tls_init_align = MAX(obj_main->tlsalign, 1);
4889 /* Compute fragments sizes. */
4890 extra_size = tcbsize - TLS_TCB_SIZE;
4891 post_size = calculate_tls_post_size(tls_init_align);
4892 tls_block_size = tcbsize + post_size;
4893 pre_size = roundup2(tls_block_size, tls_init_align) - tls_block_size;
4895 return ((char *)tcb - pre_size - extra_size);
4899 * Allocate Static TLS using the Variant I method.
4901 * For details on the layout, see lib/libc/gen/tls.c.
4903 * NB: rtld's tls_static_space variable includes TLS_TCB_SIZE and post_size as
4904 * it is based on tls_last_offset, and TLS offsets here are really TCB
4905 * offsets, whereas libc's tls_static_space is just the executable's static
4909 allocate_tls(Obj_Entry *objs, void *oldtcb, size_t tcbsize, size_t tcbalign)
4913 Elf_Addr *dtv, **tcb;
4916 size_t extra_size, maxalign, post_size, pre_size, tls_block_size;
4917 size_t tls_init_align, tls_init_offset;
4919 if (oldtcb != NULL && tcbsize == TLS_TCB_SIZE)
4922 assert(tcbsize >= TLS_TCB_SIZE);
4923 maxalign = MAX(tcbalign, tls_static_max_align);
4924 tls_init_align = MAX(obj_main->tlsalign, 1);
4926 /* Compute fragmets sizes. */
4927 extra_size = tcbsize - TLS_TCB_SIZE;
4928 post_size = calculate_tls_post_size(tls_init_align);
4929 tls_block_size = tcbsize + post_size;
4930 pre_size = roundup2(tls_block_size, tls_init_align) - tls_block_size;
4931 tls_block_size += pre_size + tls_static_space - TLS_TCB_SIZE - post_size;
4933 /* Allocate whole TLS block */
4934 tls_block = malloc_aligned(tls_block_size, maxalign, 0);
4935 tcb = (Elf_Addr **)(tls_block + pre_size + extra_size);
4937 if (oldtcb != NULL) {
4938 memcpy(tls_block, get_tls_block_ptr(oldtcb, tcbsize),
4940 free_aligned(get_tls_block_ptr(oldtcb, tcbsize));
4942 /* Adjust the DTV. */
4944 for (i = 0; i < dtv[1]; i++) {
4945 if (dtv[i+2] >= (Elf_Addr)oldtcb &&
4946 dtv[i+2] < (Elf_Addr)oldtcb + tls_static_space) {
4947 dtv[i+2] = dtv[i+2] - (Elf_Addr)oldtcb + (Elf_Addr)tcb;
4951 dtv = xcalloc(tls_max_index + 2, sizeof(Elf_Addr));
4953 dtv[0] = tls_dtv_generation;
4954 dtv[1] = tls_max_index;
4956 for (obj = globallist_curr(objs); obj != NULL;
4957 obj = globallist_next(obj)) {
4958 if (obj->tlsoffset == 0)
4960 tls_init_offset = obj->tlspoffset & (obj->tlsalign - 1);
4961 addr = (Elf_Addr)tcb + obj->tlsoffset;
4962 if (tls_init_offset > 0)
4963 memset((void *)addr, 0, tls_init_offset);
4964 if (obj->tlsinitsize > 0) {
4965 memcpy((void *)(addr + tls_init_offset), obj->tlsinit,
4968 if (obj->tlssize > obj->tlsinitsize) {
4969 memset((void *)(addr + tls_init_offset + obj->tlsinitsize),
4970 0, obj->tlssize - obj->tlsinitsize - tls_init_offset);
4972 dtv[obj->tlsindex + 1] = addr;
4980 free_tls(void *tcb, size_t tcbsize, size_t tcbalign __unused)
4983 Elf_Addr tlsstart, tlsend;
4985 size_t dtvsize, i, tls_init_align;
4987 assert(tcbsize >= TLS_TCB_SIZE);
4988 tls_init_align = MAX(obj_main->tlsalign, 1);
4990 /* Compute fragments sizes. */
4991 post_size = calculate_tls_post_size(tls_init_align);
4993 tlsstart = (Elf_Addr)tcb + TLS_TCB_SIZE + post_size;
4994 tlsend = (Elf_Addr)tcb + tls_static_space;
4996 dtv = *(Elf_Addr **)tcb;
4998 for (i = 0; i < dtvsize; i++) {
4999 if (dtv[i+2] && (dtv[i+2] < tlsstart || dtv[i+2] >= tlsend)) {
5000 free((void*)dtv[i+2]);
5004 free_aligned(get_tls_block_ptr(tcb, tcbsize));
5009 #if defined(__i386__) || defined(__amd64__)
5012 * Allocate Static TLS using the Variant II method.
5015 allocate_tls(Obj_Entry *objs, void *oldtls, size_t tcbsize, size_t tcbalign)
5018 size_t size, ralign;
5020 Elf_Addr *dtv, *olddtv;
5021 Elf_Addr segbase, oldsegbase, addr;
5025 if (tls_static_max_align > ralign)
5026 ralign = tls_static_max_align;
5027 size = roundup(tls_static_space, ralign) + roundup(tcbsize, ralign);
5029 assert(tcbsize >= 2*sizeof(Elf_Addr));
5030 tls = malloc_aligned(size, ralign, 0 /* XXX */);
5031 dtv = xcalloc(tls_max_index + 2, sizeof(Elf_Addr));
5033 segbase = (Elf_Addr)(tls + roundup(tls_static_space, ralign));
5034 ((Elf_Addr*)segbase)[0] = segbase;
5035 ((Elf_Addr*)segbase)[1] = (Elf_Addr) dtv;
5037 dtv[0] = tls_dtv_generation;
5038 dtv[1] = tls_max_index;
5042 * Copy the static TLS block over whole.
5044 oldsegbase = (Elf_Addr) oldtls;
5045 memcpy((void *)(segbase - tls_static_space),
5046 (const void *)(oldsegbase - tls_static_space),
5050 * If any dynamic TLS blocks have been created tls_get_addr(),
5053 olddtv = ((Elf_Addr**)oldsegbase)[1];
5054 for (i = 0; i < olddtv[1]; i++) {
5055 if (olddtv[i+2] < oldsegbase - size || olddtv[i+2] > oldsegbase) {
5056 dtv[i+2] = olddtv[i+2];
5062 * We assume that this block was the one we created with
5063 * allocate_initial_tls().
5065 free_tls(oldtls, 2*sizeof(Elf_Addr), sizeof(Elf_Addr));
5067 for (obj = objs; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
5068 if (obj->marker || obj->tlsoffset == 0)
5070 addr = segbase - obj->tlsoffset;
5071 memset((void*)(addr + obj->tlsinitsize),
5072 0, obj->tlssize - obj->tlsinitsize);
5074 memcpy((void*) addr, obj->tlsinit, obj->tlsinitsize);
5075 obj->static_tls_copied = true;
5077 dtv[obj->tlsindex + 1] = addr;
5081 return (void*) segbase;
5085 free_tls(void *tls, size_t tcbsize __unused, size_t tcbalign)
5088 size_t size, ralign;
5090 Elf_Addr tlsstart, tlsend;
5093 * Figure out the size of the initial TLS block so that we can
5094 * find stuff which ___tls_get_addr() allocated dynamically.
5097 if (tls_static_max_align > ralign)
5098 ralign = tls_static_max_align;
5099 size = roundup(tls_static_space, ralign);
5101 dtv = ((Elf_Addr**)tls)[1];
5103 tlsend = (Elf_Addr) tls;
5104 tlsstart = tlsend - size;
5105 for (i = 0; i < dtvsize; i++) {
5106 if (dtv[i + 2] != 0 && (dtv[i + 2] < tlsstart || dtv[i + 2] > tlsend)) {
5107 free_aligned((void *)dtv[i + 2]);
5111 free_aligned((void *)tlsstart);
5118 * Allocate TLS block for module with given index.
5121 allocate_module_tls(int index)
5126 TAILQ_FOREACH(obj, &obj_list, next) {
5129 if (obj->tlsindex == index)
5133 _rtld_error("Can't find module with TLS index %d", index);
5137 p = malloc_aligned(obj->tlssize, obj->tlsalign, obj->tlspoffset);
5138 memcpy(p, obj->tlsinit, obj->tlsinitsize);
5139 memset(p + obj->tlsinitsize, 0, obj->tlssize - obj->tlsinitsize);
5144 allocate_tls_offset(Obj_Entry *obj)
5151 if (obj->tlssize == 0) {
5152 obj->tls_done = true;
5156 if (tls_last_offset == 0)
5157 off = calculate_first_tls_offset(obj->tlssize, obj->tlsalign,
5160 off = calculate_tls_offset(tls_last_offset, tls_last_size,
5161 obj->tlssize, obj->tlsalign, obj->tlspoffset);
5164 * If we have already fixed the size of the static TLS block, we
5165 * must stay within that size. When allocating the static TLS, we
5166 * leave a small amount of space spare to be used for dynamically
5167 * loading modules which use static TLS.
5169 if (tls_static_space != 0) {
5170 if (calculate_tls_end(off, obj->tlssize) > tls_static_space)
5172 } else if (obj->tlsalign > tls_static_max_align) {
5173 tls_static_max_align = obj->tlsalign;
5176 tls_last_offset = obj->tlsoffset = off;
5177 tls_last_size = obj->tlssize;
5178 obj->tls_done = true;
5184 free_tls_offset(Obj_Entry *obj)
5188 * If we were the last thing to allocate out of the static TLS
5189 * block, we give our space back to the 'allocator'. This is a
5190 * simplistic workaround to allow libGL.so.1 to be loaded and
5191 * unloaded multiple times.
5193 if (calculate_tls_end(obj->tlsoffset, obj->tlssize)
5194 == calculate_tls_end(tls_last_offset, tls_last_size)) {
5195 tls_last_offset -= obj->tlssize;
5201 _rtld_allocate_tls(void *oldtls, size_t tcbsize, size_t tcbalign)
5204 RtldLockState lockstate;
5206 wlock_acquire(rtld_bind_lock, &lockstate);
5207 ret = allocate_tls(globallist_curr(TAILQ_FIRST(&obj_list)), oldtls,
5209 lock_release(rtld_bind_lock, &lockstate);
5214 _rtld_free_tls(void *tcb, size_t tcbsize, size_t tcbalign)
5216 RtldLockState lockstate;
5218 wlock_acquire(rtld_bind_lock, &lockstate);
5219 free_tls(tcb, tcbsize, tcbalign);
5220 lock_release(rtld_bind_lock, &lockstate);
5224 object_add_name(Obj_Entry *obj, const char *name)
5230 entry = malloc(sizeof(Name_Entry) + len);
5232 if (entry != NULL) {
5233 strcpy(entry->name, name);
5234 STAILQ_INSERT_TAIL(&obj->names, entry, link);
5239 object_match_name(const Obj_Entry *obj, const char *name)
5243 STAILQ_FOREACH(entry, &obj->names, link) {
5244 if (strcmp(name, entry->name) == 0)
5251 locate_dependency(const Obj_Entry *obj, const char *name)
5253 const Objlist_Entry *entry;
5254 const Needed_Entry *needed;
5256 STAILQ_FOREACH(entry, &list_main, link) {
5257 if (object_match_name(entry->obj, name))
5261 for (needed = obj->needed; needed != NULL; needed = needed->next) {
5262 if (strcmp(obj->strtab + needed->name, name) == 0 ||
5263 (needed->obj != NULL && object_match_name(needed->obj, name))) {
5265 * If there is DT_NEEDED for the name we are looking for,
5266 * we are all set. Note that object might not be found if
5267 * dependency was not loaded yet, so the function can
5268 * return NULL here. This is expected and handled
5269 * properly by the caller.
5271 return (needed->obj);
5274 _rtld_error("%s: Unexpected inconsistency: dependency %s not found",
5280 check_object_provided_version(Obj_Entry *refobj, const Obj_Entry *depobj,
5281 const Elf_Vernaux *vna)
5283 const Elf_Verdef *vd;
5284 const char *vername;
5286 vername = refobj->strtab + vna->vna_name;
5287 vd = depobj->verdef;
5289 _rtld_error("%s: version %s required by %s not defined",
5290 depobj->path, vername, refobj->path);
5294 if (vd->vd_version != VER_DEF_CURRENT) {
5295 _rtld_error("%s: Unsupported version %d of Elf_Verdef entry",
5296 depobj->path, vd->vd_version);
5299 if (vna->vna_hash == vd->vd_hash) {
5300 const Elf_Verdaux *aux = (const Elf_Verdaux *)
5301 ((const char *)vd + vd->vd_aux);
5302 if (strcmp(vername, depobj->strtab + aux->vda_name) == 0)
5305 if (vd->vd_next == 0)
5307 vd = (const Elf_Verdef *)((const char *)vd + vd->vd_next);
5309 if (vna->vna_flags & VER_FLG_WEAK)
5311 _rtld_error("%s: version %s required by %s not found",
5312 depobj->path, vername, refobj->path);
5317 rtld_verify_object_versions(Obj_Entry *obj)
5319 const Elf_Verneed *vn;
5320 const Elf_Verdef *vd;
5321 const Elf_Verdaux *vda;
5322 const Elf_Vernaux *vna;
5323 const Obj_Entry *depobj;
5324 int maxvernum, vernum;
5326 if (obj->ver_checked)
5328 obj->ver_checked = true;
5332 * Walk over defined and required version records and figure out
5333 * max index used by any of them. Do very basic sanity checking
5337 while (vn != NULL) {
5338 if (vn->vn_version != VER_NEED_CURRENT) {
5339 _rtld_error("%s: Unsupported version %d of Elf_Verneed entry",
5340 obj->path, vn->vn_version);
5343 vna = (const Elf_Vernaux *)((const char *)vn + vn->vn_aux);
5345 vernum = VER_NEED_IDX(vna->vna_other);
5346 if (vernum > maxvernum)
5348 if (vna->vna_next == 0)
5350 vna = (const Elf_Vernaux *)((const char *)vna + vna->vna_next);
5352 if (vn->vn_next == 0)
5354 vn = (const Elf_Verneed *)((const char *)vn + vn->vn_next);
5358 while (vd != NULL) {
5359 if (vd->vd_version != VER_DEF_CURRENT) {
5360 _rtld_error("%s: Unsupported version %d of Elf_Verdef entry",
5361 obj->path, vd->vd_version);
5364 vernum = VER_DEF_IDX(vd->vd_ndx);
5365 if (vernum > maxvernum)
5367 if (vd->vd_next == 0)
5369 vd = (const Elf_Verdef *)((const char *)vd + vd->vd_next);
5376 * Store version information in array indexable by version index.
5377 * Verify that object version requirements are satisfied along the
5380 obj->vernum = maxvernum + 1;
5381 obj->vertab = xcalloc(obj->vernum, sizeof(Ver_Entry));
5384 while (vd != NULL) {
5385 if ((vd->vd_flags & VER_FLG_BASE) == 0) {
5386 vernum = VER_DEF_IDX(vd->vd_ndx);
5387 assert(vernum <= maxvernum);
5388 vda = (const Elf_Verdaux *)((const char *)vd + vd->vd_aux);
5389 obj->vertab[vernum].hash = vd->vd_hash;
5390 obj->vertab[vernum].name = obj->strtab + vda->vda_name;
5391 obj->vertab[vernum].file = NULL;
5392 obj->vertab[vernum].flags = 0;
5394 if (vd->vd_next == 0)
5396 vd = (const Elf_Verdef *)((const char *)vd + vd->vd_next);
5400 while (vn != NULL) {
5401 depobj = locate_dependency(obj, obj->strtab + vn->vn_file);
5404 vna = (const Elf_Vernaux *)((const char *)vn + vn->vn_aux);
5406 if (check_object_provided_version(obj, depobj, vna))
5408 vernum = VER_NEED_IDX(vna->vna_other);
5409 assert(vernum <= maxvernum);
5410 obj->vertab[vernum].hash = vna->vna_hash;
5411 obj->vertab[vernum].name = obj->strtab + vna->vna_name;
5412 obj->vertab[vernum].file = obj->strtab + vn->vn_file;
5413 obj->vertab[vernum].flags = (vna->vna_other & VER_NEED_HIDDEN) ?
5414 VER_INFO_HIDDEN : 0;
5415 if (vna->vna_next == 0)
5417 vna = (const Elf_Vernaux *)((const char *)vna + vna->vna_next);
5419 if (vn->vn_next == 0)
5421 vn = (const Elf_Verneed *)((const char *)vn + vn->vn_next);
5427 rtld_verify_versions(const Objlist *objlist)
5429 Objlist_Entry *entry;
5433 STAILQ_FOREACH(entry, objlist, link) {
5435 * Skip dummy objects or objects that have their version requirements
5438 if (entry->obj->strtab == NULL || entry->obj->vertab != NULL)
5440 if (rtld_verify_object_versions(entry->obj) == -1) {
5442 if (ld_tracing == NULL)
5446 if (rc == 0 || ld_tracing != NULL)
5447 rc = rtld_verify_object_versions(&obj_rtld);
5452 fetch_ventry(const Obj_Entry *obj, unsigned long symnum)
5457 vernum = VER_NDX(obj->versyms[symnum]);
5458 if (vernum >= obj->vernum) {
5459 _rtld_error("%s: symbol %s has wrong verneed value %d",
5460 obj->path, obj->strtab + symnum, vernum);
5461 } else if (obj->vertab[vernum].hash != 0) {
5462 return &obj->vertab[vernum];
5469 _rtld_get_stack_prot(void)
5472 return (stack_prot);
5476 _rtld_is_dlopened(void *arg)
5479 RtldLockState lockstate;
5482 rlock_acquire(rtld_bind_lock, &lockstate);
5485 obj = obj_from_addr(arg);
5487 _rtld_error("No shared object contains address");
5488 lock_release(rtld_bind_lock, &lockstate);
5491 res = obj->dlopened ? 1 : 0;
5492 lock_release(rtld_bind_lock, &lockstate);
5497 obj_remap_relro(Obj_Entry *obj, int prot)
5500 if (obj->relro_size > 0 && mprotect(obj->relro_page, obj->relro_size,
5502 _rtld_error("%s: Cannot set relro protection to %#x: %s",
5503 obj->path, prot, rtld_strerror(errno));
5510 obj_disable_relro(Obj_Entry *obj)
5513 return (obj_remap_relro(obj, PROT_READ | PROT_WRITE));
5517 obj_enforce_relro(Obj_Entry *obj)
5520 return (obj_remap_relro(obj, PROT_READ));
5524 map_stacks_exec(RtldLockState *lockstate)
5526 void (*thr_map_stacks_exec)(void);
5528 if ((max_stack_flags & PF_X) == 0 || (stack_prot & PROT_EXEC) != 0)
5530 thr_map_stacks_exec = (void (*)(void))(uintptr_t)
5531 get_program_var_addr("__pthread_map_stacks_exec", lockstate);
5532 if (thr_map_stacks_exec != NULL) {
5533 stack_prot |= PROT_EXEC;
5534 thr_map_stacks_exec();
5539 distribute_static_tls(Objlist *list, RtldLockState *lockstate)
5543 void (*distrib)(size_t, void *, size_t, size_t);
5545 distrib = (void (*)(size_t, void *, size_t, size_t))(uintptr_t)
5546 get_program_var_addr("__pthread_distribute_static_tls", lockstate);
5547 if (distrib == NULL)
5549 STAILQ_FOREACH(elm, list, link) {
5551 if (obj->marker || !obj->tls_done || obj->static_tls_copied)
5553 distrib(obj->tlsoffset, obj->tlsinit, obj->tlsinitsize,
5555 obj->static_tls_copied = true;
5560 symlook_init(SymLook *dst, const char *name)
5563 bzero(dst, sizeof(*dst));
5565 dst->hash = elf_hash(name);
5566 dst->hash_gnu = gnu_hash(name);
5570 symlook_init_from_req(SymLook *dst, const SymLook *src)
5573 dst->name = src->name;
5574 dst->hash = src->hash;
5575 dst->hash_gnu = src->hash_gnu;
5576 dst->ventry = src->ventry;
5577 dst->flags = src->flags;
5578 dst->defobj_out = NULL;
5579 dst->sym_out = NULL;
5580 dst->lockstate = src->lockstate;
5584 open_binary_fd(const char *argv0, bool search_in_path,
5585 const char **binpath_res)
5587 char *binpath, *pathenv, *pe, *res1;
5593 if (search_in_path && strchr(argv0, '/') == NULL) {
5594 binpath = xmalloc(PATH_MAX);
5595 pathenv = getenv("PATH");
5596 if (pathenv == NULL) {
5597 _rtld_error("-p and no PATH environment variable");
5600 pathenv = strdup(pathenv);
5601 if (pathenv == NULL) {
5602 _rtld_error("Cannot allocate memory");
5607 while ((pe = strsep(&pathenv, ":")) != NULL) {
5608 if (strlcpy(binpath, pe, PATH_MAX) >= PATH_MAX)
5610 if (binpath[0] != '\0' &&
5611 strlcat(binpath, "/", PATH_MAX) >= PATH_MAX)
5613 if (strlcat(binpath, argv0, PATH_MAX) >= PATH_MAX)
5615 fd = open(binpath, O_RDONLY | O_CLOEXEC | O_VERIFY);
5616 if (fd != -1 || errno != ENOENT) {
5623 fd = open(argv0, O_RDONLY | O_CLOEXEC | O_VERIFY);
5628 _rtld_error("Cannot open %s: %s", argv0, rtld_strerror(errno));
5631 if (res != NULL && res[0] != '/') {
5632 res1 = xmalloc(PATH_MAX);
5633 if (realpath(res, res1) != NULL) {
5635 free(__DECONST(char *, res));
5646 * Parse a set of command-line arguments.
5649 parse_args(char* argv[], int argc, bool *use_pathp, int *fdp,
5655 int arglen, fd, i, j, mib[2];
5657 bool seen_b, seen_f;
5659 dbg("Parsing command-line arguments");
5662 seen_b = seen_f = false;
5664 for (i = 1; i < argc; i++ ) {
5666 dbg("argv[%d]: '%s'", i, arg);
5669 * rtld arguments end with an explicit "--" or with the first
5670 * non-prefixed argument.
5672 if (strcmp(arg, "--") == 0) {
5680 * All other arguments are single-character options that can
5681 * be combined, so we need to search through `arg` for them.
5683 arglen = strlen(arg);
5684 for (j = 1; j < arglen; j++) {
5687 print_usage(argv[0]);
5689 } else if (opt == 'b') {
5691 _rtld_error("Both -b and -f specified");
5698 } else if (opt == 'f') {
5700 _rtld_error("Both -b and -f specified");
5705 * -f XX can be used to specify a
5706 * descriptor for the binary named at
5707 * the command line (i.e., the later
5708 * argument will specify the process
5709 * name but the descriptor is what
5710 * will actually be executed).
5712 * -f must be the last option in, e.g., -abcf.
5714 if (j != arglen - 1) {
5715 _rtld_error("Invalid options: %s", arg);
5719 fd = parse_integer(argv[i]);
5722 "Invalid file descriptor: '%s'",
5729 } else if (opt == 'p') {
5731 } else if (opt == 'v') {
5734 mib[1] = HW_MACHINE;
5735 sz = sizeof(machine);
5736 sysctl(mib, nitems(mib), machine, &sz, NULL, 0);
5738 "FreeBSD ld-elf.so.1 %s\n"
5739 "FreeBSD_version %d\n"
5740 "Default lib path %s\n"
5745 __FreeBSD_version, ld_standard_library_path,
5746 ld_env_prefix, ld_elf_hints_default,
5747 ld_path_libmap_conf);
5750 _rtld_error("Invalid argument: '%s'", arg);
5751 print_usage(argv[0]);
5763 * Parse a file descriptor number without pulling in more of libc (e.g. atoi).
5766 parse_integer(const char *str)
5768 static const int RADIX = 10; /* XXXJA: possibly support hex? */
5775 for (c = *str; c != '\0'; c = *++str) {
5776 if (c < '0' || c > '9')
5783 /* Make sure we actually parsed something. */
5790 print_usage(const char *argv0)
5794 "Usage: %s [-h] [-b <exe>] [-f <FD>] [-p] [--] <binary> [<args>]\n"
5797 " -h Display this help message\n"
5798 " -b <exe> Execute <exe> instead of <binary>, arg0 is <binary>\n"
5799 " -f <FD> Execute <FD> instead of searching for <binary>\n"
5800 " -p Search in PATH for named binary\n"
5801 " -v Display identification information\n"
5802 " -- End of RTLD options\n"
5803 " <binary> Name of process to execute\n"
5804 " <args> Arguments to the executed process\n", argv0);
5808 * Overrides for libc_pic-provided functions.
5812 __getosreldate(void)
5822 oid[1] = KERN_OSRELDATE;
5824 len = sizeof(osrel);
5825 error = sysctl(oid, 2, &osrel, &len, NULL, 0);
5826 if (error == 0 && osrel > 0 && len == sizeof(osrel))
5831 rtld_strerror(int errnum)
5834 if (errnum < 0 || errnum >= sys_nerr)
5835 return ("Unknown error");
5836 return (sys_errlist[errnum]);
5841 malloc(size_t nbytes)
5844 return (__crt_malloc(nbytes));
5848 calloc(size_t num, size_t size)
5851 return (__crt_calloc(num, size));
5862 realloc(void *cp, size_t nbytes)
5865 return (__crt_realloc(cp, nbytes));
5868 extern int _rtld_version__FreeBSD_version __exported;
5869 int _rtld_version__FreeBSD_version = __FreeBSD_version;
5871 extern char _rtld_version_laddr_offset __exported;
5872 char _rtld_version_laddr_offset;