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, phnum, rtld_argc;
389 int old_auxv_format = 1;
391 bool dir_enable, explicit_fd, search_in_path;
394 * On entry, the dynamic linker itself has not been relocated yet.
395 * Be very careful not to reference any global data until after
396 * init_rtld has returned. It is OK to reference file-scope statics
397 * and string constants, and to call static and global functions.
400 /* Find the auxiliary vector on the stack. */
404 sp += argc + 1; /* Skip over arguments and NULL terminator */
406 while (*sp++ != 0) /* Skip over environment, and NULL terminator */
408 aux = (Elf_Auxinfo *) sp;
410 /* Digest the auxiliary vector. */
411 for (i = 0; i < AT_COUNT; i++)
413 for (auxp = aux; auxp->a_type != AT_NULL; auxp++) {
414 if (auxp->a_type < AT_COUNT)
415 aux_info[auxp->a_type] = auxp;
417 if (auxp->a_type == 23) /* AT_STACKPROT */
423 if (old_auxv_format) {
424 /* Remap from old-style auxv numbers. */
425 aux_info[23] = aux_info[21]; /* AT_STACKPROT */
426 aux_info[21] = aux_info[19]; /* AT_PAGESIZESLEN */
427 aux_info[19] = aux_info[17]; /* AT_NCPUS */
428 aux_info[17] = aux_info[15]; /* AT_CANARYLEN */
429 aux_info[15] = aux_info[13]; /* AT_EXECPATH */
430 aux_info[13] = NULL; /* AT_GID */
432 aux_info[20] = aux_info[18]; /* AT_PAGESIZES */
433 aux_info[18] = aux_info[16]; /* AT_OSRELDATE */
434 aux_info[16] = aux_info[14]; /* AT_CANARY */
435 aux_info[14] = NULL; /* AT_EGID */
439 /* Initialize and relocate ourselves. */
440 assert(aux_info[AT_BASE] != NULL);
441 init_rtld((caddr_t) aux_info[AT_BASE]->a_un.a_ptr, aux_info);
443 __progname = obj_rtld.path;
444 argv0 = argv[0] != NULL ? argv[0] : "(null)";
449 if (aux_info[AT_BSDFLAGS] != NULL &&
450 (aux_info[AT_BSDFLAGS]->a_un.a_val & ELF_BSDF_SIGFASTBLK) != 0)
451 ld_fast_sigblock = true;
453 trust = !issetugid();
455 md_abi_variant_hook(aux_info);
458 if (aux_info[AT_EXECFD] != NULL) {
459 fd = aux_info[AT_EXECFD]->a_un.a_val;
461 assert(aux_info[AT_PHDR] != NULL);
462 phdr = (const Elf_Phdr *)aux_info[AT_PHDR]->a_un.a_ptr;
463 if (phdr == obj_rtld.phdr) {
465 _rtld_error("Tainted process refusing to run binary %s",
469 dbg("opening main program in direct exec mode");
471 rtld_argc = parse_args(argv, argc, &search_in_path, &fd, &argv0);
472 explicit_fd = (fd != -1);
475 fd = open_binary_fd(argv0, search_in_path, &binpath);
476 if (fstat(fd, &st) == -1) {
477 _rtld_error("Failed to fstat FD %d (%s): %s", fd,
478 explicit_fd ? "user-provided descriptor" : argv0,
479 rtld_strerror(errno));
484 * Rough emulation of the permission checks done by
485 * execve(2), only Unix DACs are checked, ACLs are
486 * ignored. Preserve the semantic of disabling owner
487 * to execute if owner x bit is cleared, even if
488 * others x bit is enabled.
489 * mmap(2) does not allow to mmap with PROT_EXEC if
490 * binary' file comes from noexec mount. We cannot
491 * set a text reference on the binary.
494 if (st.st_uid == geteuid()) {
495 if ((st.st_mode & S_IXUSR) != 0)
497 } else if (st.st_gid == getegid()) {
498 if ((st.st_mode & S_IXGRP) != 0)
500 } else if ((st.st_mode & S_IXOTH) != 0) {
504 _rtld_error("No execute permission for binary %s",
510 * For direct exec mode, argv[0] is the interpreter
511 * name, we must remove it and shift arguments left
512 * before invoking binary main. Since stack layout
513 * places environment pointers and aux vectors right
514 * after the terminating NULL, we must shift
515 * environment and aux as well.
517 main_argc = argc - rtld_argc;
518 for (i = 0; i <= main_argc; i++)
519 argv[i] = argv[i + rtld_argc];
521 environ = env = envp = argv + main_argc + 1;
522 dbg("move env from %p to %p", envp + rtld_argc, envp);
524 *envp = *(envp + rtld_argc);
525 } while (*envp++ != NULL);
526 aux = auxp = (Elf_Auxinfo *)envp;
527 auxpf = (Elf_Auxinfo *)(envp + rtld_argc);
528 dbg("move aux from %p to %p", auxpf, aux);
529 /* XXXKIB insert place for AT_EXECPATH if not present */
530 for (;; auxp++, auxpf++) {
532 if (auxp->a_type == AT_NULL)
535 /* Since the auxiliary vector has moved, redigest it. */
536 for (i = 0; i < AT_COUNT; i++)
538 for (auxp = aux; auxp->a_type != AT_NULL; auxp++) {
539 if (auxp->a_type < AT_COUNT)
540 aux_info[auxp->a_type] = auxp;
543 /* Point AT_EXECPATH auxv and aux_info to the binary path. */
544 if (binpath == NULL) {
545 aux_info[AT_EXECPATH] = NULL;
547 if (aux_info[AT_EXECPATH] == NULL) {
548 aux_info[AT_EXECPATH] = xmalloc(sizeof(Elf_Auxinfo));
549 aux_info[AT_EXECPATH]->a_type = AT_EXECPATH;
551 aux_info[AT_EXECPATH]->a_un.a_ptr = __DECONST(void *,
555 _rtld_error("No binary");
561 ld_bind_now = getenv(_LD("BIND_NOW"));
564 * If the process is tainted, then we un-set the dangerous environment
565 * variables. The process will be marked as tainted until setuid(2)
566 * is called. If any child process calls setuid(2) we do not want any
567 * future processes to honor the potentially un-safe variables.
570 if (unsetenv(_LD("PRELOAD")) || unsetenv(_LD("LIBMAP")) ||
571 unsetenv(_LD("LIBRARY_PATH")) || unsetenv(_LD("LIBRARY_PATH_FDS")) ||
572 unsetenv(_LD("LIBMAP_DISABLE")) || unsetenv(_LD("BIND_NOT")) ||
573 unsetenv(_LD("DEBUG")) || unsetenv(_LD("ELF_HINTS_PATH")) ||
574 unsetenv(_LD("LOADFLTR")) || unsetenv(_LD("LIBRARY_PATH_RPATH"))) {
575 _rtld_error("environment corrupt; aborting");
579 ld_debug = getenv(_LD("DEBUG"));
580 if (ld_bind_now == NULL)
581 ld_bind_not = getenv(_LD("BIND_NOT")) != NULL;
582 libmap_disable = getenv(_LD("LIBMAP_DISABLE")) != NULL;
583 libmap_override = getenv(_LD("LIBMAP"));
584 ld_library_path = getenv(_LD("LIBRARY_PATH"));
585 ld_library_dirs = getenv(_LD("LIBRARY_PATH_FDS"));
586 ld_preload = getenv(_LD("PRELOAD"));
587 ld_elf_hints_path = getenv(_LD("ELF_HINTS_PATH"));
588 ld_loadfltr = getenv(_LD("LOADFLTR")) != NULL;
589 library_path_rpath = getenv(_LD("LIBRARY_PATH_RPATH"));
590 if (library_path_rpath != NULL) {
591 if (library_path_rpath[0] == 'y' ||
592 library_path_rpath[0] == 'Y' ||
593 library_path_rpath[0] == '1')
594 ld_library_path_rpath = true;
596 ld_library_path_rpath = false;
598 dangerous_ld_env = libmap_disable || (libmap_override != NULL) ||
599 (ld_library_path != NULL) || (ld_preload != NULL) ||
600 (ld_elf_hints_path != NULL) || ld_loadfltr;
601 ld_tracing = getenv(_LD("TRACE_LOADED_OBJECTS"));
602 ld_utrace = getenv(_LD("UTRACE"));
604 if ((ld_elf_hints_path == NULL) || strlen(ld_elf_hints_path) == 0)
605 ld_elf_hints_path = ld_elf_hints_default;
607 if (ld_debug != NULL && *ld_debug != '\0')
609 dbg("%s is initialized, base address = %p", __progname,
610 (caddr_t) aux_info[AT_BASE]->a_un.a_ptr);
611 dbg("RTLD dynamic = %p", obj_rtld.dynamic);
612 dbg("RTLD pltgot = %p", obj_rtld.pltgot);
614 dbg("initializing thread locks");
618 * Load the main program, or process its program header if it is
621 if (fd != -1) { /* Load the main program. */
622 dbg("loading main program");
623 obj_main = map_object(fd, argv0, NULL);
625 if (obj_main == NULL)
627 max_stack_flags = obj_main->stack_flags;
628 } else { /* Main program already loaded. */
629 dbg("processing main program's program header");
630 assert(aux_info[AT_PHDR] != NULL);
631 phdr = (const Elf_Phdr *) aux_info[AT_PHDR]->a_un.a_ptr;
632 assert(aux_info[AT_PHNUM] != NULL);
633 phnum = aux_info[AT_PHNUM]->a_un.a_val;
634 assert(aux_info[AT_PHENT] != NULL);
635 assert(aux_info[AT_PHENT]->a_un.a_val == sizeof(Elf_Phdr));
636 assert(aux_info[AT_ENTRY] != NULL);
637 imgentry = (caddr_t) aux_info[AT_ENTRY]->a_un.a_ptr;
638 if ((obj_main = digest_phdr(phdr, phnum, imgentry, argv0)) == NULL)
642 if (aux_info[AT_EXECPATH] != NULL && fd == -1) {
643 kexecpath = aux_info[AT_EXECPATH]->a_un.a_ptr;
644 dbg("AT_EXECPATH %p %s", kexecpath, kexecpath);
645 if (kexecpath[0] == '/')
646 obj_main->path = kexecpath;
647 else if (getcwd(buf, sizeof(buf)) == NULL ||
648 strlcat(buf, "/", sizeof(buf)) >= sizeof(buf) ||
649 strlcat(buf, kexecpath, sizeof(buf)) >= sizeof(buf))
650 obj_main->path = xstrdup(argv0);
652 obj_main->path = xstrdup(buf);
654 dbg("No AT_EXECPATH or direct exec");
655 obj_main->path = xstrdup(argv0);
657 dbg("obj_main path %s", obj_main->path);
658 obj_main->mainprog = true;
660 if (aux_info[AT_STACKPROT] != NULL &&
661 aux_info[AT_STACKPROT]->a_un.a_val != 0)
662 stack_prot = aux_info[AT_STACKPROT]->a_un.a_val;
666 * Get the actual dynamic linker pathname from the executable if
667 * possible. (It should always be possible.) That ensures that
668 * gdb will find the right dynamic linker even if a non-standard
671 if (obj_main->interp != NULL &&
672 strcmp(obj_main->interp, obj_rtld.path) != 0) {
674 obj_rtld.path = xstrdup(obj_main->interp);
675 __progname = obj_rtld.path;
679 if (!digest_dynamic(obj_main, 0))
681 dbg("%s valid_hash_sysv %d valid_hash_gnu %d dynsymcount %d",
682 obj_main->path, obj_main->valid_hash_sysv, obj_main->valid_hash_gnu,
683 obj_main->dynsymcount);
685 linkmap_add(obj_main);
686 linkmap_add(&obj_rtld);
688 /* Link the main program into the list of objects. */
689 TAILQ_INSERT_HEAD(&obj_list, obj_main, next);
693 /* Initialize a fake symbol for resolving undefined weak references. */
694 sym_zero.st_info = ELF_ST_INFO(STB_GLOBAL, STT_NOTYPE);
695 sym_zero.st_shndx = SHN_UNDEF;
696 sym_zero.st_value = -(uintptr_t)obj_main->relocbase;
699 libmap_disable = (bool)lm_init(libmap_override);
701 dbg("loading LD_PRELOAD libraries");
702 if (load_preload_objects() == -1)
704 preload_tail = globallist_curr(TAILQ_LAST(&obj_list, obj_entry_q));
706 dbg("loading needed objects");
707 if (load_needed_objects(obj_main, 0) == -1)
710 /* Make a list of all objects loaded at startup. */
711 last_interposer = obj_main;
712 TAILQ_FOREACH(obj, &obj_list, next) {
715 if (obj->z_interpose && obj != obj_main) {
716 objlist_put_after(&list_main, last_interposer, obj);
717 last_interposer = obj;
719 objlist_push_tail(&list_main, obj);
724 dbg("checking for required versions");
725 if (rtld_verify_versions(&list_main) == -1 && !ld_tracing)
728 if (ld_tracing) { /* We're done */
729 trace_loaded_objects(obj_main);
733 if (getenv(_LD("DUMP_REL_PRE")) != NULL) {
734 dump_relocations(obj_main);
739 * Processing tls relocations requires having the tls offsets
740 * initialized. Prepare offsets before starting initial
741 * relocation processing.
743 dbg("initializing initial thread local storage offsets");
744 STAILQ_FOREACH(entry, &list_main, link) {
746 * Allocate all the initial objects out of the static TLS
747 * block even if they didn't ask for it.
749 allocate_tls_offset(entry->obj);
752 if (relocate_objects(obj_main,
753 ld_bind_now != NULL && *ld_bind_now != '\0',
754 &obj_rtld, SYMLOOK_EARLY, NULL) == -1)
757 dbg("doing copy relocations");
758 if (do_copy_relocations(obj_main) == -1)
761 if (getenv(_LD("DUMP_REL_POST")) != NULL) {
762 dump_relocations(obj_main);
769 * Setup TLS for main thread. This must be done after the
770 * relocations are processed, since tls initialization section
771 * might be the subject for relocations.
773 dbg("initializing initial thread local storage");
774 allocate_initial_tls(globallist_curr(TAILQ_FIRST(&obj_list)));
776 dbg("initializing key program variables");
777 set_program_var("__progname", argv[0] != NULL ? basename(argv[0]) : "");
778 set_program_var("environ", env);
779 set_program_var("__elf_aux_vector", aux);
781 /* Make a list of init functions to call. */
782 objlist_init(&initlist);
783 initlist_add_objects(globallist_curr(TAILQ_FIRST(&obj_list)),
784 preload_tail, &initlist);
786 r_debug_state(NULL, &obj_main->linkmap); /* say hello to gdb! */
788 map_stacks_exec(NULL);
790 if (!obj_main->crt_no_init) {
792 * Make sure we don't call the main program's init and fini
793 * functions for binaries linked with old crt1 which calls
796 obj_main->init = obj_main->fini = (Elf_Addr)NULL;
797 obj_main->preinit_array = obj_main->init_array =
798 obj_main->fini_array = (Elf_Addr)NULL;
802 * Execute MD initializers required before we call the objects'
807 wlock_acquire(rtld_bind_lock, &lockstate);
809 dbg("resolving ifuncs");
810 if (initlist_objects_ifunc(&initlist, ld_bind_now != NULL &&
811 *ld_bind_now != '\0', SYMLOOK_EARLY, &lockstate) == -1)
814 rtld_exit_ptr = rtld_exit;
815 if (obj_main->crt_no_init)
817 objlist_call_init(&initlist, &lockstate);
818 _r_debug_postinit(&obj_main->linkmap);
819 objlist_clear(&initlist);
820 dbg("loading filtees");
821 TAILQ_FOREACH(obj, &obj_list, next) {
824 if (ld_loadfltr || obj->z_loadfltr)
825 load_filtees(obj, 0, &lockstate);
828 dbg("enforcing main obj relro");
829 if (obj_enforce_relro(obj_main) == -1)
832 lock_release(rtld_bind_lock, &lockstate);
834 dbg("transferring control to program entry point = %p", obj_main->entry);
836 /* Return the exit procedure and the program entry point. */
837 *exit_proc = rtld_exit_ptr;
839 return (func_ptr_type) obj_main->entry;
843 rtld_resolve_ifunc(const Obj_Entry *obj, const Elf_Sym *def)
848 ptr = (void *)make_function_pointer(def, obj);
849 target = call_ifunc_resolver(ptr);
850 return ((void *)target);
854 * NB: MIPS uses a private version of this function (_mips_rtld_bind).
855 * Changes to this function should be applied there as well.
858 _rtld_bind(Obj_Entry *obj, Elf_Size reloff)
862 const Obj_Entry *defobj;
865 RtldLockState lockstate;
867 rlock_acquire(rtld_bind_lock, &lockstate);
868 if (sigsetjmp(lockstate.env, 0) != 0)
869 lock_upgrade(rtld_bind_lock, &lockstate);
871 rel = (const Elf_Rel *)((const char *)obj->pltrel + reloff);
873 rel = (const Elf_Rel *)((const char *)obj->pltrela + reloff);
875 where = (Elf_Addr *)(obj->relocbase + rel->r_offset);
876 def = find_symdef(ELF_R_SYM(rel->r_info), obj, &defobj, SYMLOOK_IN_PLT,
880 if (ELF_ST_TYPE(def->st_info) == STT_GNU_IFUNC)
881 target = (Elf_Addr)rtld_resolve_ifunc(defobj, def);
883 target = (Elf_Addr)(defobj->relocbase + def->st_value);
885 dbg("\"%s\" in \"%s\" ==> %p in \"%s\"",
886 defobj->strtab + def->st_name, basename(obj->path),
887 (void *)target, basename(defobj->path));
890 * Write the new contents for the jmpslot. Note that depending on
891 * architecture, the value which we need to return back to the
892 * lazy binding trampoline may or may not be the target
893 * address. The value returned from reloc_jmpslot() is the value
894 * that the trampoline needs.
896 target = reloc_jmpslot(where, target, defobj, obj, rel);
897 lock_release(rtld_bind_lock, &lockstate);
902 * Error reporting function. Use it like printf. If formats the message
903 * into a buffer, and sets things up so that the next call to dlerror()
904 * will return the message.
907 _rtld_error(const char *fmt, ...)
909 static char buf[512];
913 rtld_vsnprintf(buf, sizeof buf, fmt, ap);
916 LD_UTRACE(UTRACE_RTLD_ERROR, NULL, NULL, 0, 0, error_message);
920 * Return a dynamically-allocated copy of the current error message, if any.
925 return error_message == NULL ? NULL : xstrdup(error_message);
929 * Restore the current error message from a copy which was previously saved
930 * by errmsg_save(). The copy is freed.
933 errmsg_restore(char *saved_msg)
935 if (saved_msg == NULL)
936 error_message = NULL;
938 _rtld_error("%s", saved_msg);
944 basename(const char *name)
946 const char *p = strrchr(name, '/');
947 return p != NULL ? p + 1 : name;
950 static struct utsname uts;
953 origin_subst_one(Obj_Entry *obj, char *real, const char *kw,
954 const char *subst, bool may_free)
956 char *p, *p1, *res, *resp;
957 int subst_len, kw_len, subst_count, old_len, new_len;
962 * First, count the number of the keyword occurrences, to
963 * preallocate the final string.
965 for (p = real, subst_count = 0;; p = p1 + kw_len, subst_count++) {
972 * If the keyword is not found, just return.
974 * Return non-substituted string if resolution failed. We
975 * cannot do anything more reasonable, the failure mode of the
976 * caller is unresolved library anyway.
978 if (subst_count == 0 || (obj != NULL && !obj_resolve_origin(obj)))
979 return (may_free ? real : xstrdup(real));
981 subst = obj->origin_path;
984 * There is indeed something to substitute. Calculate the
985 * length of the resulting string, and allocate it.
987 subst_len = strlen(subst);
988 old_len = strlen(real);
989 new_len = old_len + (subst_len - kw_len) * subst_count;
990 res = xmalloc(new_len + 1);
993 * Now, execute the substitution loop.
995 for (p = real, resp = res, *resp = '\0';;) {
998 /* Copy the prefix before keyword. */
999 memcpy(resp, p, p1 - p);
1001 /* Keyword replacement. */
1002 memcpy(resp, subst, subst_len);
1010 /* Copy to the end of string and finish. */
1018 origin_subst(Obj_Entry *obj, const char *real)
1020 char *res1, *res2, *res3, *res4;
1022 if (obj == NULL || !trust)
1023 return (xstrdup(real));
1024 if (uts.sysname[0] == '\0') {
1025 if (uname(&uts) != 0) {
1026 _rtld_error("utsname failed: %d", errno);
1030 /* __DECONST is safe here since without may_free real is unchanged */
1031 res1 = origin_subst_one(obj, __DECONST(char *, real), "$ORIGIN", NULL,
1033 res2 = origin_subst_one(NULL, res1, "$OSNAME", uts.sysname, true);
1034 res3 = origin_subst_one(NULL, res2, "$OSREL", uts.release, true);
1035 res4 = origin_subst_one(NULL, res3, "$PLATFORM", uts.machine, true);
1042 const char *msg = dlerror();
1045 msg = "Fatal error";
1046 rtld_fdputstr(STDERR_FILENO, _BASENAME_RTLD ": ");
1047 rtld_fdputstr(STDERR_FILENO, msg);
1048 rtld_fdputchar(STDERR_FILENO, '\n');
1053 * Process a shared object's DYNAMIC section, and save the important
1054 * information in its Obj_Entry structure.
1057 digest_dynamic1(Obj_Entry *obj, int early, const Elf_Dyn **dyn_rpath,
1058 const Elf_Dyn **dyn_soname, const Elf_Dyn **dyn_runpath)
1060 const Elf_Dyn *dynp;
1061 Needed_Entry **needed_tail = &obj->needed;
1062 Needed_Entry **needed_filtees_tail = &obj->needed_filtees;
1063 Needed_Entry **needed_aux_filtees_tail = &obj->needed_aux_filtees;
1064 const Elf_Hashelt *hashtab;
1065 const Elf32_Word *hashval;
1066 Elf32_Word bkt, nmaskwords;
1068 int plttype = DT_REL;
1072 *dyn_runpath = NULL;
1074 obj->bind_now = false;
1075 for (dynp = obj->dynamic; dynp->d_tag != DT_NULL; dynp++) {
1076 switch (dynp->d_tag) {
1079 obj->rel = (const Elf_Rel *)(obj->relocbase + dynp->d_un.d_ptr);
1083 obj->relsize = dynp->d_un.d_val;
1087 assert(dynp->d_un.d_val == sizeof(Elf_Rel));
1091 obj->pltrel = (const Elf_Rel *)
1092 (obj->relocbase + dynp->d_un.d_ptr);
1096 obj->pltrelsize = dynp->d_un.d_val;
1100 obj->rela = (const Elf_Rela *)(obj->relocbase + dynp->d_un.d_ptr);
1104 obj->relasize = dynp->d_un.d_val;
1108 assert(dynp->d_un.d_val == sizeof(Elf_Rela));
1112 plttype = dynp->d_un.d_val;
1113 assert(dynp->d_un.d_val == DT_REL || plttype == DT_RELA);
1117 obj->symtab = (const Elf_Sym *)
1118 (obj->relocbase + dynp->d_un.d_ptr);
1122 assert(dynp->d_un.d_val == sizeof(Elf_Sym));
1126 obj->strtab = (const char *)(obj->relocbase + dynp->d_un.d_ptr);
1130 obj->strsize = dynp->d_un.d_val;
1134 obj->verneed = (const Elf_Verneed *)(obj->relocbase +
1139 obj->verneednum = dynp->d_un.d_val;
1143 obj->verdef = (const Elf_Verdef *)(obj->relocbase +
1148 obj->verdefnum = dynp->d_un.d_val;
1152 obj->versyms = (const Elf_Versym *)(obj->relocbase +
1158 hashtab = (const Elf_Hashelt *)(obj->relocbase +
1160 obj->nbuckets = hashtab[0];
1161 obj->nchains = hashtab[1];
1162 obj->buckets = hashtab + 2;
1163 obj->chains = obj->buckets + obj->nbuckets;
1164 obj->valid_hash_sysv = obj->nbuckets > 0 && obj->nchains > 0 &&
1165 obj->buckets != NULL;
1171 hashtab = (const Elf_Hashelt *)(obj->relocbase +
1173 obj->nbuckets_gnu = hashtab[0];
1174 obj->symndx_gnu = hashtab[1];
1175 nmaskwords = hashtab[2];
1176 bloom_size32 = (__ELF_WORD_SIZE / 32) * nmaskwords;
1177 obj->maskwords_bm_gnu = nmaskwords - 1;
1178 obj->shift2_gnu = hashtab[3];
1179 obj->bloom_gnu = (const Elf_Addr *)(hashtab + 4);
1180 obj->buckets_gnu = hashtab + 4 + bloom_size32;
1181 obj->chain_zero_gnu = obj->buckets_gnu + obj->nbuckets_gnu -
1183 /* Number of bitmask words is required to be power of 2 */
1184 obj->valid_hash_gnu = powerof2(nmaskwords) &&
1185 obj->nbuckets_gnu > 0 && obj->buckets_gnu != NULL;
1191 Needed_Entry *nep = NEW(Needed_Entry);
1192 nep->name = dynp->d_un.d_val;
1197 needed_tail = &nep->next;
1203 Needed_Entry *nep = NEW(Needed_Entry);
1204 nep->name = dynp->d_un.d_val;
1208 *needed_filtees_tail = nep;
1209 needed_filtees_tail = &nep->next;
1211 if (obj->linkmap.l_refname == NULL)
1212 obj->linkmap.l_refname = (char *)dynp->d_un.d_val;
1218 Needed_Entry *nep = NEW(Needed_Entry);
1219 nep->name = dynp->d_un.d_val;
1223 *needed_aux_filtees_tail = nep;
1224 needed_aux_filtees_tail = &nep->next;
1229 obj->pltgot = (Elf_Addr *)(obj->relocbase + dynp->d_un.d_ptr);
1233 obj->textrel = true;
1237 obj->symbolic = true;
1242 * We have to wait until later to process this, because we
1243 * might not have gotten the address of the string table yet.
1253 *dyn_runpath = dynp;
1257 obj->init = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1260 case DT_PREINIT_ARRAY:
1261 obj->preinit_array = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1264 case DT_PREINIT_ARRAYSZ:
1265 obj->preinit_array_num = dynp->d_un.d_val / sizeof(Elf_Addr);
1269 obj->init_array = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1272 case DT_INIT_ARRAYSZ:
1273 obj->init_array_num = dynp->d_un.d_val / sizeof(Elf_Addr);
1277 obj->fini = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1281 obj->fini_array = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1284 case DT_FINI_ARRAYSZ:
1285 obj->fini_array_num = dynp->d_un.d_val / sizeof(Elf_Addr);
1289 * Don't process DT_DEBUG on MIPS as the dynamic section
1290 * is mapped read-only. DT_MIPS_RLD_MAP is used instead.
1296 dbg("Filling in DT_DEBUG entry");
1297 (__DECONST(Elf_Dyn *, dynp))->d_un.d_ptr = (Elf_Addr)&r_debug;
1302 if (dynp->d_un.d_val & DF_ORIGIN)
1303 obj->z_origin = true;
1304 if (dynp->d_un.d_val & DF_SYMBOLIC)
1305 obj->symbolic = true;
1306 if (dynp->d_un.d_val & DF_TEXTREL)
1307 obj->textrel = true;
1308 if (dynp->d_un.d_val & DF_BIND_NOW)
1309 obj->bind_now = true;
1310 if (dynp->d_un.d_val & DF_STATIC_TLS)
1311 obj->static_tls = true;
1314 case DT_MIPS_LOCAL_GOTNO:
1315 obj->local_gotno = dynp->d_un.d_val;
1318 case DT_MIPS_SYMTABNO:
1319 obj->symtabno = dynp->d_un.d_val;
1322 case DT_MIPS_GOTSYM:
1323 obj->gotsym = dynp->d_un.d_val;
1326 case DT_MIPS_RLD_MAP:
1327 *((Elf_Addr *)(dynp->d_un.d_ptr)) = (Elf_Addr) &r_debug;
1330 case DT_MIPS_RLD_MAP_REL:
1331 // The MIPS_RLD_MAP_REL tag stores the offset to the .rld_map
1332 // section relative to the address of the tag itself.
1333 *((Elf_Addr *)(__DECONST(char*, dynp) + dynp->d_un.d_val)) =
1334 (Elf_Addr) &r_debug;
1337 case DT_MIPS_PLTGOT:
1338 obj->mips_pltgot = (Elf_Addr *)(obj->relocbase +
1345 #ifdef __powerpc64__
1346 case DT_PPC64_GLINK:
1347 obj->glink = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1351 obj->gotptr = (Elf_Addr *)(obj->relocbase + dynp->d_un.d_ptr);
1357 if (dynp->d_un.d_val & DF_1_NOOPEN)
1358 obj->z_noopen = true;
1359 if (dynp->d_un.d_val & DF_1_ORIGIN)
1360 obj->z_origin = true;
1361 if (dynp->d_un.d_val & DF_1_GLOBAL)
1362 obj->z_global = true;
1363 if (dynp->d_un.d_val & DF_1_BIND_NOW)
1364 obj->bind_now = true;
1365 if (dynp->d_un.d_val & DF_1_NODELETE)
1366 obj->z_nodelete = true;
1367 if (dynp->d_un.d_val & DF_1_LOADFLTR)
1368 obj->z_loadfltr = true;
1369 if (dynp->d_un.d_val & DF_1_INTERPOSE)
1370 obj->z_interpose = true;
1371 if (dynp->d_un.d_val & DF_1_NODEFLIB)
1372 obj->z_nodeflib = true;
1373 if (dynp->d_un.d_val & DF_1_PIE)
1379 dbg("Ignoring d_tag %ld = %#lx", (long)dynp->d_tag,
1386 obj->traced = false;
1388 if (plttype == DT_RELA) {
1389 obj->pltrela = (const Elf_Rela *) obj->pltrel;
1391 obj->pltrelasize = obj->pltrelsize;
1392 obj->pltrelsize = 0;
1395 /* Determine size of dynsym table (equal to nchains of sysv hash) */
1396 if (obj->valid_hash_sysv)
1397 obj->dynsymcount = obj->nchains;
1398 else if (obj->valid_hash_gnu) {
1399 obj->dynsymcount = 0;
1400 for (bkt = 0; bkt < obj->nbuckets_gnu; bkt++) {
1401 if (obj->buckets_gnu[bkt] == 0)
1403 hashval = &obj->chain_zero_gnu[obj->buckets_gnu[bkt]];
1406 while ((*hashval++ & 1u) == 0);
1408 obj->dynsymcount += obj->symndx_gnu;
1411 if (obj->linkmap.l_refname != NULL)
1412 obj->linkmap.l_refname = obj->strtab + (unsigned long)obj->
1417 obj_resolve_origin(Obj_Entry *obj)
1420 if (obj->origin_path != NULL)
1422 obj->origin_path = xmalloc(PATH_MAX);
1423 return (rtld_dirname_abs(obj->path, obj->origin_path) != -1);
1427 digest_dynamic2(Obj_Entry *obj, const Elf_Dyn *dyn_rpath,
1428 const Elf_Dyn *dyn_soname, const Elf_Dyn *dyn_runpath)
1431 if (obj->z_origin && !obj_resolve_origin(obj))
1434 if (dyn_runpath != NULL) {
1435 obj->runpath = (const char *)obj->strtab + dyn_runpath->d_un.d_val;
1436 obj->runpath = origin_subst(obj, obj->runpath);
1437 } else if (dyn_rpath != NULL) {
1438 obj->rpath = (const char *)obj->strtab + dyn_rpath->d_un.d_val;
1439 obj->rpath = origin_subst(obj, obj->rpath);
1441 if (dyn_soname != NULL)
1442 object_add_name(obj, obj->strtab + dyn_soname->d_un.d_val);
1447 digest_dynamic(Obj_Entry *obj, int early)
1449 const Elf_Dyn *dyn_rpath;
1450 const Elf_Dyn *dyn_soname;
1451 const Elf_Dyn *dyn_runpath;
1453 digest_dynamic1(obj, early, &dyn_rpath, &dyn_soname, &dyn_runpath);
1454 return (digest_dynamic2(obj, dyn_rpath, dyn_soname, dyn_runpath));
1458 * Process a shared object's program header. This is used only for the
1459 * main program, when the kernel has already loaded the main program
1460 * into memory before calling the dynamic linker. It creates and
1461 * returns an Obj_Entry structure.
1464 digest_phdr(const Elf_Phdr *phdr, int phnum, caddr_t entry, const char *path)
1467 const Elf_Phdr *phlimit = phdr + phnum;
1469 Elf_Addr note_start, note_end;
1473 for (ph = phdr; ph < phlimit; ph++) {
1474 if (ph->p_type != PT_PHDR)
1478 obj->phsize = ph->p_memsz;
1479 obj->relocbase = __DECONST(char *, phdr) - ph->p_vaddr;
1483 obj->stack_flags = PF_X | PF_R | PF_W;
1485 for (ph = phdr; ph < phlimit; ph++) {
1486 switch (ph->p_type) {
1489 obj->interp = (const char *)(ph->p_vaddr + obj->relocbase);
1493 if (nsegs == 0) { /* First load segment */
1494 obj->vaddrbase = trunc_page(ph->p_vaddr);
1495 obj->mapbase = obj->vaddrbase + obj->relocbase;
1496 } else { /* Last load segment */
1497 obj->mapsize = round_page(ph->p_vaddr + ph->p_memsz) -
1504 obj->dynamic = (const Elf_Dyn *)(ph->p_vaddr + obj->relocbase);
1509 obj->tlssize = ph->p_memsz;
1510 obj->tlsalign = ph->p_align;
1511 obj->tlsinitsize = ph->p_filesz;
1512 obj->tlsinit = (void*)(ph->p_vaddr + obj->relocbase);
1513 obj->tlspoffset = ph->p_offset;
1517 obj->stack_flags = ph->p_flags;
1521 obj->relro_page = obj->relocbase + trunc_page(ph->p_vaddr);
1522 obj->relro_size = round_page(ph->p_memsz);
1526 note_start = (Elf_Addr)obj->relocbase + ph->p_vaddr;
1527 note_end = note_start + ph->p_filesz;
1528 digest_notes(obj, note_start, note_end);
1533 _rtld_error("%s: too few PT_LOAD segments", path);
1542 digest_notes(Obj_Entry *obj, Elf_Addr note_start, Elf_Addr note_end)
1544 const Elf_Note *note;
1545 const char *note_name;
1548 for (note = (const Elf_Note *)note_start; (Elf_Addr)note < note_end;
1549 note = (const Elf_Note *)((const char *)(note + 1) +
1550 roundup2(note->n_namesz, sizeof(Elf32_Addr)) +
1551 roundup2(note->n_descsz, sizeof(Elf32_Addr)))) {
1552 if (note->n_namesz != sizeof(NOTE_FREEBSD_VENDOR) ||
1553 note->n_descsz != sizeof(int32_t))
1555 if (note->n_type != NT_FREEBSD_ABI_TAG &&
1556 note->n_type != NT_FREEBSD_FEATURE_CTL &&
1557 note->n_type != NT_FREEBSD_NOINIT_TAG)
1559 note_name = (const char *)(note + 1);
1560 if (strncmp(NOTE_FREEBSD_VENDOR, note_name,
1561 sizeof(NOTE_FREEBSD_VENDOR)) != 0)
1563 switch (note->n_type) {
1564 case NT_FREEBSD_ABI_TAG:
1565 /* FreeBSD osrel note */
1566 p = (uintptr_t)(note + 1);
1567 p += roundup2(note->n_namesz, sizeof(Elf32_Addr));
1568 obj->osrel = *(const int32_t *)(p);
1569 dbg("note osrel %d", obj->osrel);
1571 case NT_FREEBSD_FEATURE_CTL:
1572 /* FreeBSD ABI feature control note */
1573 p = (uintptr_t)(note + 1);
1574 p += roundup2(note->n_namesz, sizeof(Elf32_Addr));
1575 obj->fctl0 = *(const uint32_t *)(p);
1576 dbg("note fctl0 %#x", obj->fctl0);
1578 case NT_FREEBSD_NOINIT_TAG:
1579 /* FreeBSD 'crt does not call init' note */
1580 obj->crt_no_init = true;
1581 dbg("note crt_no_init");
1588 dlcheck(void *handle)
1592 TAILQ_FOREACH(obj, &obj_list, next) {
1593 if (obj == (Obj_Entry *) handle)
1597 if (obj == NULL || obj->refcount == 0 || obj->dl_refcount == 0) {
1598 _rtld_error("Invalid shared object handle %p", handle);
1605 * If the given object is already in the donelist, return true. Otherwise
1606 * add the object to the list and return false.
1609 donelist_check(DoneList *dlp, const Obj_Entry *obj)
1613 for (i = 0; i < dlp->num_used; i++)
1614 if (dlp->objs[i] == obj)
1617 * Our donelist allocation should always be sufficient. But if
1618 * our threads locking isn't working properly, more shared objects
1619 * could have been loaded since we allocated the list. That should
1620 * never happen, but we'll handle it properly just in case it does.
1622 if (dlp->num_used < dlp->num_alloc)
1623 dlp->objs[dlp->num_used++] = obj;
1628 * Hash function for symbol table lookup. Don't even think about changing
1629 * this. It is specified by the System V ABI.
1632 elf_hash(const char *name)
1634 const unsigned char *p = (const unsigned char *) name;
1635 unsigned long h = 0;
1638 while (*p != '\0') {
1639 h = (h << 4) + *p++;
1640 if ((g = h & 0xf0000000) != 0)
1648 * The GNU hash function is the Daniel J. Bernstein hash clipped to 32 bits
1649 * unsigned in case it's implemented with a wider type.
1652 gnu_hash(const char *s)
1658 for (c = *s; c != '\0'; c = *++s)
1660 return (h & 0xffffffff);
1665 * Find the library with the given name, and return its full pathname.
1666 * The returned string is dynamically allocated. Generates an error
1667 * message and returns NULL if the library cannot be found.
1669 * If the second argument is non-NULL, then it refers to an already-
1670 * loaded shared object, whose library search path will be searched.
1672 * If a library is successfully located via LD_LIBRARY_PATH_FDS, its
1673 * descriptor (which is close-on-exec) will be passed out via the third
1676 * The search order is:
1677 * DT_RPATH in the referencing file _unless_ DT_RUNPATH is present (1)
1678 * DT_RPATH of the main object if DSO without defined DT_RUNPATH (1)
1680 * DT_RUNPATH in the referencing file
1681 * ldconfig hints (if -z nodefaultlib, filter out default library directories
1683 * /lib:/usr/lib _unless_ the referencing file is linked with -z nodefaultlib
1685 * (1) Handled in digest_dynamic2 - rpath left NULL if runpath defined.
1688 find_library(const char *xname, const Obj_Entry *refobj, int *fdp)
1690 char *pathname, *refobj_path;
1692 bool nodeflib, objgiven;
1694 objgiven = refobj != NULL;
1696 if (libmap_disable || !objgiven ||
1697 (name = lm_find(refobj->path, xname)) == NULL)
1700 if (strchr(name, '/') != NULL) { /* Hard coded pathname */
1701 if (name[0] != '/' && !trust) {
1702 _rtld_error("Absolute pathname required "
1703 "for shared object \"%s\"", name);
1706 return (origin_subst(__DECONST(Obj_Entry *, refobj),
1707 __DECONST(char *, name)));
1710 dbg(" Searching for \"%s\"", name);
1711 refobj_path = objgiven ? refobj->path : NULL;
1714 * If refobj->rpath != NULL, then refobj->runpath is NULL. Fall
1715 * back to pre-conforming behaviour if user requested so with
1716 * LD_LIBRARY_PATH_RPATH environment variable and ignore -z
1719 if (objgiven && refobj->rpath != NULL && ld_library_path_rpath) {
1720 pathname = search_library_path(name, ld_library_path,
1722 if (pathname != NULL)
1724 if (refobj != NULL) {
1725 pathname = search_library_path(name, refobj->rpath,
1727 if (pathname != NULL)
1730 pathname = search_library_pathfds(name, ld_library_dirs, fdp);
1731 if (pathname != NULL)
1733 pathname = search_library_path(name, gethints(false),
1735 if (pathname != NULL)
1737 pathname = search_library_path(name, ld_standard_library_path,
1739 if (pathname != NULL)
1742 nodeflib = objgiven ? refobj->z_nodeflib : false;
1744 pathname = search_library_path(name, refobj->rpath,
1746 if (pathname != NULL)
1749 if (objgiven && refobj->runpath == NULL && refobj != obj_main) {
1750 pathname = search_library_path(name, obj_main->rpath,
1752 if (pathname != NULL)
1755 pathname = search_library_path(name, ld_library_path,
1757 if (pathname != NULL)
1760 pathname = search_library_path(name, refobj->runpath,
1762 if (pathname != NULL)
1765 pathname = search_library_pathfds(name, ld_library_dirs, fdp);
1766 if (pathname != NULL)
1768 pathname = search_library_path(name, gethints(nodeflib),
1770 if (pathname != NULL)
1772 if (objgiven && !nodeflib) {
1773 pathname = search_library_path(name,
1774 ld_standard_library_path, refobj_path, fdp);
1775 if (pathname != NULL)
1780 if (objgiven && refobj->path != NULL) {
1781 _rtld_error("Shared object \"%s\" not found, "
1782 "required by \"%s\"", name, basename(refobj->path));
1784 _rtld_error("Shared object \"%s\" not found", name);
1790 * Given a symbol number in a referencing object, find the corresponding
1791 * definition of the symbol. Returns a pointer to the symbol, or NULL if
1792 * no definition was found. Returns a pointer to the Obj_Entry of the
1793 * defining object via the reference parameter DEFOBJ_OUT.
1796 find_symdef(unsigned long symnum, const Obj_Entry *refobj,
1797 const Obj_Entry **defobj_out, int flags, SymCache *cache,
1798 RtldLockState *lockstate)
1802 const Obj_Entry *defobj;
1803 const Ver_Entry *ve;
1809 * If we have already found this symbol, get the information from
1812 if (symnum >= refobj->dynsymcount)
1813 return NULL; /* Bad object */
1814 if (cache != NULL && cache[symnum].sym != NULL) {
1815 *defobj_out = cache[symnum].obj;
1816 return cache[symnum].sym;
1819 ref = refobj->symtab + symnum;
1820 name = refobj->strtab + ref->st_name;
1826 * We don't have to do a full scale lookup if the symbol is local.
1827 * We know it will bind to the instance in this load module; to
1828 * which we already have a pointer (ie ref). By not doing a lookup,
1829 * we not only improve performance, but it also avoids unresolvable
1830 * symbols when local symbols are not in the hash table. This has
1831 * been seen with the ia64 toolchain.
1833 if (ELF_ST_BIND(ref->st_info) != STB_LOCAL) {
1834 if (ELF_ST_TYPE(ref->st_info) == STT_SECTION) {
1835 _rtld_error("%s: Bogus symbol table entry %lu", refobj->path,
1838 symlook_init(&req, name);
1840 ve = req.ventry = fetch_ventry(refobj, symnum);
1841 req.lockstate = lockstate;
1842 res = symlook_default(&req, refobj);
1845 defobj = req.defobj_out;
1853 * If we found no definition and the reference is weak, treat the
1854 * symbol as having the value zero.
1856 if (def == NULL && ELF_ST_BIND(ref->st_info) == STB_WEAK) {
1862 *defobj_out = defobj;
1863 /* Record the information in the cache to avoid subsequent lookups. */
1864 if (cache != NULL) {
1865 cache[symnum].sym = def;
1866 cache[symnum].obj = defobj;
1869 if (refobj != &obj_rtld)
1870 _rtld_error("%s: Undefined symbol \"%s%s%s\"", refobj->path, name,
1871 ve != NULL ? "@" : "", ve != NULL ? ve->name : "");
1877 * Return the search path from the ldconfig hints file, reading it if
1878 * necessary. If nostdlib is true, then the default search paths are
1879 * not added to result.
1881 * Returns NULL if there are problems with the hints file,
1882 * or if the search path there is empty.
1885 gethints(bool nostdlib)
1887 static char *filtered_path;
1888 static const char *hints;
1889 static struct elfhints_hdr hdr;
1890 struct fill_search_info_args sargs, hargs;
1891 struct dl_serinfo smeta, hmeta, *SLPinfo, *hintinfo;
1892 struct dl_serpath *SLPpath, *hintpath;
1894 struct stat hint_stat;
1895 unsigned int SLPndx, hintndx, fndx, fcount;
1901 /* First call, read the hints file */
1902 if (hints == NULL) {
1903 /* Keep from trying again in case the hints file is bad. */
1906 if ((fd = open(ld_elf_hints_path, O_RDONLY | O_CLOEXEC)) == -1)
1910 * Check of hdr.dirlistlen value against type limit
1911 * intends to pacify static analyzers. Further
1912 * paranoia leads to checks that dirlist is fully
1913 * contained in the file range.
1915 if (read(fd, &hdr, sizeof hdr) != sizeof hdr ||
1916 hdr.magic != ELFHINTS_MAGIC ||
1917 hdr.version != 1 || hdr.dirlistlen > UINT_MAX / 2 ||
1918 fstat(fd, &hint_stat) == -1) {
1925 if (dl + hdr.dirlist < dl)
1928 if (dl + hdr.dirlistlen < dl)
1930 dl += hdr.dirlistlen;
1931 if (dl > hint_stat.st_size)
1933 p = xmalloc(hdr.dirlistlen + 1);
1934 if (pread(fd, p, hdr.dirlistlen + 1,
1935 hdr.strtab + hdr.dirlist) != (ssize_t)hdr.dirlistlen + 1 ||
1936 p[hdr.dirlistlen] != '\0') {
1945 * If caller agreed to receive list which includes the default
1946 * paths, we are done. Otherwise, if we still did not
1947 * calculated filtered result, do it now.
1950 return (hints[0] != '\0' ? hints : NULL);
1951 if (filtered_path != NULL)
1955 * Obtain the list of all configured search paths, and the
1956 * list of the default paths.
1958 * First estimate the size of the results.
1960 smeta.dls_size = __offsetof(struct dl_serinfo, dls_serpath);
1962 hmeta.dls_size = __offsetof(struct dl_serinfo, dls_serpath);
1965 sargs.request = RTLD_DI_SERINFOSIZE;
1966 sargs.serinfo = &smeta;
1967 hargs.request = RTLD_DI_SERINFOSIZE;
1968 hargs.serinfo = &hmeta;
1970 path_enumerate(ld_standard_library_path, fill_search_info, NULL,
1972 path_enumerate(hints, fill_search_info, NULL, &hargs);
1974 SLPinfo = xmalloc(smeta.dls_size);
1975 hintinfo = xmalloc(hmeta.dls_size);
1978 * Next fetch both sets of paths.
1980 sargs.request = RTLD_DI_SERINFO;
1981 sargs.serinfo = SLPinfo;
1982 sargs.serpath = &SLPinfo->dls_serpath[0];
1983 sargs.strspace = (char *)&SLPinfo->dls_serpath[smeta.dls_cnt];
1985 hargs.request = RTLD_DI_SERINFO;
1986 hargs.serinfo = hintinfo;
1987 hargs.serpath = &hintinfo->dls_serpath[0];
1988 hargs.strspace = (char *)&hintinfo->dls_serpath[hmeta.dls_cnt];
1990 path_enumerate(ld_standard_library_path, fill_search_info, NULL,
1992 path_enumerate(hints, fill_search_info, NULL, &hargs);
1995 * Now calculate the difference between two sets, by excluding
1996 * standard paths from the full set.
2000 filtered_path = xmalloc(hdr.dirlistlen + 1);
2001 hintpath = &hintinfo->dls_serpath[0];
2002 for (hintndx = 0; hintndx < hmeta.dls_cnt; hintndx++, hintpath++) {
2004 SLPpath = &SLPinfo->dls_serpath[0];
2006 * Check each standard path against current.
2008 for (SLPndx = 0; SLPndx < smeta.dls_cnt; SLPndx++, SLPpath++) {
2009 /* matched, skip the path */
2010 if (!strcmp(hintpath->dls_name, SLPpath->dls_name)) {
2018 * Not matched against any standard path, add the path
2019 * to result. Separate consequtive paths with ':'.
2022 filtered_path[fndx] = ':';
2026 flen = strlen(hintpath->dls_name);
2027 strncpy((filtered_path + fndx), hintpath->dls_name, flen);
2030 filtered_path[fndx] = '\0';
2036 return (filtered_path[0] != '\0' ? filtered_path : NULL);
2040 init_dag(Obj_Entry *root)
2042 const Needed_Entry *needed;
2043 const Objlist_Entry *elm;
2046 if (root->dag_inited)
2048 donelist_init(&donelist);
2050 /* Root object belongs to own DAG. */
2051 objlist_push_tail(&root->dldags, root);
2052 objlist_push_tail(&root->dagmembers, root);
2053 donelist_check(&donelist, root);
2056 * Add dependencies of root object to DAG in breadth order
2057 * by exploiting the fact that each new object get added
2058 * to the tail of the dagmembers list.
2060 STAILQ_FOREACH(elm, &root->dagmembers, link) {
2061 for (needed = elm->obj->needed; needed != NULL; needed = needed->next) {
2062 if (needed->obj == NULL || donelist_check(&donelist, needed->obj))
2064 objlist_push_tail(&needed->obj->dldags, root);
2065 objlist_push_tail(&root->dagmembers, needed->obj);
2068 root->dag_inited = true;
2072 init_marker(Obj_Entry *marker)
2075 bzero(marker, sizeof(*marker));
2076 marker->marker = true;
2080 globallist_curr(const Obj_Entry *obj)
2087 return (__DECONST(Obj_Entry *, obj));
2088 obj = TAILQ_PREV(obj, obj_entry_q, next);
2093 globallist_next(const Obj_Entry *obj)
2097 obj = TAILQ_NEXT(obj, next);
2101 return (__DECONST(Obj_Entry *, obj));
2105 /* Prevent the object from being unmapped while the bind lock is dropped. */
2107 hold_object(Obj_Entry *obj)
2114 unhold_object(Obj_Entry *obj)
2117 assert(obj->holdcount > 0);
2118 if (--obj->holdcount == 0 && obj->unholdfree)
2119 release_object(obj);
2123 process_z(Obj_Entry *root)
2125 const Objlist_Entry *elm;
2129 * Walk over object DAG and process every dependent object
2130 * that is marked as DF_1_NODELETE or DF_1_GLOBAL. They need
2131 * to grow their own DAG.
2133 * For DF_1_GLOBAL, DAG is required for symbol lookups in
2134 * symlook_global() to work.
2136 * For DF_1_NODELETE, the DAG should have its reference upped.
2138 STAILQ_FOREACH(elm, &root->dagmembers, link) {
2142 if (obj->z_nodelete && !obj->ref_nodel) {
2143 dbg("obj %s -z nodelete", obj->path);
2146 obj->ref_nodel = true;
2148 if (obj->z_global && objlist_find(&list_global, obj) == NULL) {
2149 dbg("obj %s -z global", obj->path);
2150 objlist_push_tail(&list_global, obj);
2156 * Initialize the dynamic linker. The argument is the address at which
2157 * the dynamic linker has been mapped into memory. The primary task of
2158 * this function is to relocate the dynamic linker.
2161 init_rtld(caddr_t mapbase, Elf_Auxinfo **aux_info)
2163 Obj_Entry objtmp; /* Temporary rtld object */
2164 const Elf_Ehdr *ehdr;
2165 const Elf_Dyn *dyn_rpath;
2166 const Elf_Dyn *dyn_soname;
2167 const Elf_Dyn *dyn_runpath;
2169 #ifdef RTLD_INIT_PAGESIZES_EARLY
2170 /* The page size is required by the dynamic memory allocator. */
2171 init_pagesizes(aux_info);
2175 * Conjure up an Obj_Entry structure for the dynamic linker.
2177 * The "path" member can't be initialized yet because string constants
2178 * cannot yet be accessed. Below we will set it correctly.
2180 memset(&objtmp, 0, sizeof(objtmp));
2183 objtmp.mapbase = mapbase;
2185 objtmp.relocbase = mapbase;
2188 objtmp.dynamic = rtld_dynamic(&objtmp);
2189 digest_dynamic1(&objtmp, 1, &dyn_rpath, &dyn_soname, &dyn_runpath);
2190 assert(objtmp.needed == NULL);
2191 #if !defined(__mips__)
2192 /* MIPS has a bogus DT_TEXTREL. */
2193 assert(!objtmp.textrel);
2196 * Temporarily put the dynamic linker entry into the object list, so
2197 * that symbols can be found.
2199 relocate_objects(&objtmp, true, &objtmp, 0, NULL);
2201 ehdr = (Elf_Ehdr *)mapbase;
2202 objtmp.phdr = (Elf_Phdr *)((char *)mapbase + ehdr->e_phoff);
2203 objtmp.phsize = ehdr->e_phnum * sizeof(objtmp.phdr[0]);
2205 /* Initialize the object list. */
2206 TAILQ_INIT(&obj_list);
2208 /* Now that non-local variables can be accesses, copy out obj_rtld. */
2209 memcpy(&obj_rtld, &objtmp, sizeof(obj_rtld));
2211 #ifndef RTLD_INIT_PAGESIZES_EARLY
2212 /* The page size is required by the dynamic memory allocator. */
2213 init_pagesizes(aux_info);
2216 if (aux_info[AT_OSRELDATE] != NULL)
2217 osreldate = aux_info[AT_OSRELDATE]->a_un.a_val;
2219 digest_dynamic2(&obj_rtld, dyn_rpath, dyn_soname, dyn_runpath);
2221 /* Replace the path with a dynamically allocated copy. */
2222 obj_rtld.path = xstrdup(ld_path_rtld);
2224 r_debug.r_brk = r_debug_state;
2225 r_debug.r_state = RT_CONSISTENT;
2229 * Retrieve the array of supported page sizes. The kernel provides the page
2230 * sizes in increasing order.
2233 init_pagesizes(Elf_Auxinfo **aux_info)
2235 static size_t psa[MAXPAGESIZES];
2239 if (aux_info[AT_PAGESIZES] != NULL && aux_info[AT_PAGESIZESLEN] !=
2241 size = aux_info[AT_PAGESIZESLEN]->a_un.a_val;
2242 pagesizes = aux_info[AT_PAGESIZES]->a_un.a_ptr;
2245 if (sysctlnametomib("hw.pagesizes", mib, &len) == 0)
2248 /* As a fallback, retrieve the base page size. */
2249 size = sizeof(psa[0]);
2250 if (aux_info[AT_PAGESZ] != NULL) {
2251 psa[0] = aux_info[AT_PAGESZ]->a_un.a_val;
2255 mib[1] = HW_PAGESIZE;
2259 if (sysctl(mib, len, psa, &size, NULL, 0) == -1) {
2260 _rtld_error("sysctl for hw.pagesize(s) failed");
2266 npagesizes = size / sizeof(pagesizes[0]);
2267 /* Discard any invalid entries at the end of the array. */
2268 while (npagesizes > 0 && pagesizes[npagesizes - 1] == 0)
2273 * Add the init functions from a needed object list (and its recursive
2274 * needed objects) to "list". This is not used directly; it is a helper
2275 * function for initlist_add_objects(). The write lock must be held
2276 * when this function is called.
2279 initlist_add_neededs(Needed_Entry *needed, Objlist *list)
2281 /* Recursively process the successor needed objects. */
2282 if (needed->next != NULL)
2283 initlist_add_neededs(needed->next, list);
2285 /* Process the current needed object. */
2286 if (needed->obj != NULL)
2287 initlist_add_objects(needed->obj, needed->obj, list);
2291 * Scan all of the DAGs rooted in the range of objects from "obj" to
2292 * "tail" and add their init functions to "list". This recurses over
2293 * the DAGs and ensure the proper init ordering such that each object's
2294 * needed libraries are initialized before the object itself. At the
2295 * same time, this function adds the objects to the global finalization
2296 * list "list_fini" in the opposite order. The write lock must be
2297 * held when this function is called.
2300 initlist_add_objects(Obj_Entry *obj, Obj_Entry *tail, Objlist *list)
2304 if (obj->init_scanned || obj->init_done)
2306 obj->init_scanned = true;
2308 /* Recursively process the successor objects. */
2309 nobj = globallist_next(obj);
2310 if (nobj != NULL && obj != tail)
2311 initlist_add_objects(nobj, tail, list);
2313 /* Recursively process the needed objects. */
2314 if (obj->needed != NULL)
2315 initlist_add_neededs(obj->needed, list);
2316 if (obj->needed_filtees != NULL)
2317 initlist_add_neededs(obj->needed_filtees, list);
2318 if (obj->needed_aux_filtees != NULL)
2319 initlist_add_neededs(obj->needed_aux_filtees, list);
2321 /* Add the object to the init list. */
2322 objlist_push_tail(list, obj);
2324 /* Add the object to the global fini list in the reverse order. */
2325 if ((obj->fini != (Elf_Addr)NULL || obj->fini_array != (Elf_Addr)NULL)
2326 && !obj->on_fini_list) {
2327 objlist_push_head(&list_fini, obj);
2328 obj->on_fini_list = true;
2333 #define FPTR_TARGET(f) ((Elf_Addr) (f))
2337 free_needed_filtees(Needed_Entry *n, RtldLockState *lockstate)
2339 Needed_Entry *needed, *needed1;
2341 for (needed = n; needed != NULL; needed = needed->next) {
2342 if (needed->obj != NULL) {
2343 dlclose_locked(needed->obj, lockstate);
2347 for (needed = n; needed != NULL; needed = needed1) {
2348 needed1 = needed->next;
2354 unload_filtees(Obj_Entry *obj, RtldLockState *lockstate)
2357 free_needed_filtees(obj->needed_filtees, lockstate);
2358 obj->needed_filtees = NULL;
2359 free_needed_filtees(obj->needed_aux_filtees, lockstate);
2360 obj->needed_aux_filtees = NULL;
2361 obj->filtees_loaded = false;
2365 load_filtee1(Obj_Entry *obj, Needed_Entry *needed, int flags,
2366 RtldLockState *lockstate)
2369 for (; needed != NULL; needed = needed->next) {
2370 needed->obj = dlopen_object(obj->strtab + needed->name, -1, obj,
2371 flags, ((ld_loadfltr || obj->z_loadfltr) ? RTLD_NOW : RTLD_LAZY) |
2372 RTLD_LOCAL, lockstate);
2377 load_filtees(Obj_Entry *obj, int flags, RtldLockState *lockstate)
2380 lock_restart_for_upgrade(lockstate);
2381 if (!obj->filtees_loaded) {
2382 load_filtee1(obj, obj->needed_filtees, flags, lockstate);
2383 load_filtee1(obj, obj->needed_aux_filtees, flags, lockstate);
2384 obj->filtees_loaded = true;
2389 process_needed(Obj_Entry *obj, Needed_Entry *needed, int flags)
2393 for (; needed != NULL; needed = needed->next) {
2394 obj1 = needed->obj = load_object(obj->strtab + needed->name, -1, obj,
2395 flags & ~RTLD_LO_NOLOAD);
2396 if (obj1 == NULL && !ld_tracing && (flags & RTLD_LO_FILTEES) == 0)
2403 * Given a shared object, traverse its list of needed objects, and load
2404 * each of them. Returns 0 on success. Generates an error message and
2405 * returns -1 on failure.
2408 load_needed_objects(Obj_Entry *first, int flags)
2412 for (obj = first; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
2415 if (process_needed(obj, obj->needed, flags) == -1)
2422 load_preload_objects(void)
2424 char *p = ld_preload;
2426 static const char delim[] = " \t:;";
2431 p += strspn(p, delim);
2432 while (*p != '\0') {
2433 size_t len = strcspn(p, delim);
2438 obj = load_object(p, -1, NULL, 0);
2440 return -1; /* XXX - cleanup */
2441 obj->z_interpose = true;
2444 p += strspn(p, delim);
2446 LD_UTRACE(UTRACE_PRELOAD_FINISHED, NULL, NULL, 0, 0, NULL);
2451 printable_path(const char *path)
2454 return (path == NULL ? "<unknown>" : path);
2458 * Load a shared object into memory, if it is not already loaded. The
2459 * object may be specified by name or by user-supplied file descriptor
2460 * fd_u. In the later case, the fd_u descriptor is not closed, but its
2463 * Returns a pointer to the Obj_Entry for the object. Returns NULL
2467 load_object(const char *name, int fd_u, const Obj_Entry *refobj, int flags)
2476 TAILQ_FOREACH(obj, &obj_list, next) {
2477 if (obj->marker || obj->doomed)
2479 if (object_match_name(obj, name))
2483 path = find_library(name, refobj, &fd);
2491 * search_library_pathfds() opens a fresh file descriptor for the
2492 * library, so there is no need to dup().
2494 } else if (fd_u == -1) {
2496 * If we didn't find a match by pathname, or the name is not
2497 * supplied, open the file and check again by device and inode.
2498 * This avoids false mismatches caused by multiple links or ".."
2501 * To avoid a race, we open the file and use fstat() rather than
2504 if ((fd = open(path, O_RDONLY | O_CLOEXEC | O_VERIFY)) == -1) {
2505 _rtld_error("Cannot open \"%s\"", path);
2510 fd = fcntl(fd_u, F_DUPFD_CLOEXEC, 0);
2512 _rtld_error("Cannot dup fd");
2517 if (fstat(fd, &sb) == -1) {
2518 _rtld_error("Cannot fstat \"%s\"", printable_path(path));
2523 TAILQ_FOREACH(obj, &obj_list, next) {
2524 if (obj->marker || obj->doomed)
2526 if (obj->ino == sb.st_ino && obj->dev == sb.st_dev)
2529 if (obj != NULL && name != NULL) {
2530 object_add_name(obj, name);
2535 if (flags & RTLD_LO_NOLOAD) {
2541 /* First use of this object, so we must map it in */
2542 obj = do_load_object(fd, name, path, &sb, flags);
2551 do_load_object(int fd, const char *name, char *path, struct stat *sbp,
2558 * but first, make sure that environment variables haven't been
2559 * used to circumvent the noexec flag on a filesystem.
2561 if (dangerous_ld_env) {
2562 if (fstatfs(fd, &fs) != 0) {
2563 _rtld_error("Cannot fstatfs \"%s\"", printable_path(path));
2566 if (fs.f_flags & MNT_NOEXEC) {
2567 _rtld_error("Cannot execute objects on %s", fs.f_mntonname);
2571 dbg("loading \"%s\"", printable_path(path));
2572 obj = map_object(fd, printable_path(path), sbp);
2577 * If DT_SONAME is present in the object, digest_dynamic2 already
2578 * added it to the object names.
2581 object_add_name(obj, name);
2583 if (!digest_dynamic(obj, 0))
2586 _rtld_error("Cannot load PIE binary %s as DSO", obj->path);
2589 dbg("%s valid_hash_sysv %d valid_hash_gnu %d dynsymcount %d", obj->path,
2590 obj->valid_hash_sysv, obj->valid_hash_gnu, obj->dynsymcount);
2591 if (obj->z_noopen && (flags & (RTLD_LO_DLOPEN | RTLD_LO_TRACE)) ==
2593 dbg("refusing to load non-loadable \"%s\"", obj->path);
2594 _rtld_error("Cannot dlopen non-loadable %s", obj->path);
2598 obj->dlopened = (flags & RTLD_LO_DLOPEN) != 0;
2599 TAILQ_INSERT_TAIL(&obj_list, obj, next);
2602 linkmap_add(obj); /* for GDB & dlinfo() */
2603 max_stack_flags |= obj->stack_flags;
2605 dbg(" %p .. %p: %s", obj->mapbase,
2606 obj->mapbase + obj->mapsize - 1, obj->path);
2608 dbg(" WARNING: %s has impure text", obj->path);
2609 LD_UTRACE(UTRACE_LOAD_OBJECT, obj, obj->mapbase, obj->mapsize, 0,
2615 munmap(obj->mapbase, obj->mapsize);
2621 obj_from_addr(const void *addr)
2625 TAILQ_FOREACH(obj, &obj_list, next) {
2628 if (addr < (void *) obj->mapbase)
2630 if (addr < (void *)(obj->mapbase + obj->mapsize))
2639 Elf_Addr *preinit_addr;
2642 preinit_addr = (Elf_Addr *)obj_main->preinit_array;
2643 if (preinit_addr == NULL)
2646 for (index = 0; index < obj_main->preinit_array_num; index++) {
2647 if (preinit_addr[index] != 0 && preinit_addr[index] != 1) {
2648 dbg("calling preinit function for %s at %p", obj_main->path,
2649 (void *)preinit_addr[index]);
2650 LD_UTRACE(UTRACE_INIT_CALL, obj_main, (void *)preinit_addr[index],
2651 0, 0, obj_main->path);
2652 call_init_pointer(obj_main, preinit_addr[index]);
2658 * Call the finalization functions for each of the objects in "list"
2659 * belonging to the DAG of "root" and referenced once. If NULL "root"
2660 * is specified, every finalization function will be called regardless
2661 * of the reference count and the list elements won't be freed. All of
2662 * the objects are expected to have non-NULL fini functions.
2665 objlist_call_fini(Objlist *list, Obj_Entry *root, RtldLockState *lockstate)
2669 Elf_Addr *fini_addr;
2672 assert(root == NULL || root->refcount == 1);
2675 root->doomed = true;
2678 * Preserve the current error message since a fini function might
2679 * call into the dynamic linker and overwrite it.
2681 saved_msg = errmsg_save();
2683 STAILQ_FOREACH(elm, list, link) {
2684 if (root != NULL && (elm->obj->refcount != 1 ||
2685 objlist_find(&root->dagmembers, elm->obj) == NULL))
2687 /* Remove object from fini list to prevent recursive invocation. */
2688 STAILQ_REMOVE(list, elm, Struct_Objlist_Entry, link);
2689 /* Ensure that new references cannot be acquired. */
2690 elm->obj->doomed = true;
2692 hold_object(elm->obj);
2693 lock_release(rtld_bind_lock, lockstate);
2695 * It is legal to have both DT_FINI and DT_FINI_ARRAY defined.
2696 * When this happens, DT_FINI_ARRAY is processed first.
2698 fini_addr = (Elf_Addr *)elm->obj->fini_array;
2699 if (fini_addr != NULL && elm->obj->fini_array_num > 0) {
2700 for (index = elm->obj->fini_array_num - 1; index >= 0;
2702 if (fini_addr[index] != 0 && fini_addr[index] != 1) {
2703 dbg("calling fini function for %s at %p",
2704 elm->obj->path, (void *)fini_addr[index]);
2705 LD_UTRACE(UTRACE_FINI_CALL, elm->obj,
2706 (void *)fini_addr[index], 0, 0, elm->obj->path);
2707 call_initfini_pointer(elm->obj, fini_addr[index]);
2711 if (elm->obj->fini != (Elf_Addr)NULL) {
2712 dbg("calling fini function for %s at %p", elm->obj->path,
2713 (void *)elm->obj->fini);
2714 LD_UTRACE(UTRACE_FINI_CALL, elm->obj, (void *)elm->obj->fini,
2715 0, 0, elm->obj->path);
2716 call_initfini_pointer(elm->obj, elm->obj->fini);
2718 wlock_acquire(rtld_bind_lock, lockstate);
2719 unhold_object(elm->obj);
2720 /* No need to free anything if process is going down. */
2724 * We must restart the list traversal after every fini call
2725 * because a dlclose() call from the fini function or from
2726 * another thread might have modified the reference counts.
2730 } while (elm != NULL);
2731 errmsg_restore(saved_msg);
2735 * Call the initialization functions for each of the objects in
2736 * "list". All of the objects are expected to have non-NULL init
2740 objlist_call_init(Objlist *list, RtldLockState *lockstate)
2745 Elf_Addr *init_addr;
2746 void (*reg)(void (*)(void));
2750 * Clean init_scanned flag so that objects can be rechecked and
2751 * possibly initialized earlier if any of vectors called below
2752 * cause the change by using dlopen.
2754 TAILQ_FOREACH(obj, &obj_list, next) {
2757 obj->init_scanned = false;
2761 * Preserve the current error message since an init function might
2762 * call into the dynamic linker and overwrite it.
2764 saved_msg = errmsg_save();
2765 STAILQ_FOREACH(elm, list, link) {
2766 if (elm->obj->init_done) /* Initialized early. */
2769 * Race: other thread might try to use this object before current
2770 * one completes the initialization. Not much can be done here
2771 * without better locking.
2773 elm->obj->init_done = true;
2774 hold_object(elm->obj);
2776 if (elm->obj == obj_main && obj_main->crt_no_init) {
2777 reg = (void (*)(void (*)(void)))get_program_var_addr(
2778 "__libc_atexit", lockstate);
2780 lock_release(rtld_bind_lock, lockstate);
2783 rtld_exit_ptr = rtld_nop_exit;
2787 * It is legal to have both DT_INIT and DT_INIT_ARRAY defined.
2788 * When this happens, DT_INIT is processed first.
2790 if (elm->obj->init != (Elf_Addr)NULL) {
2791 dbg("calling init function for %s at %p", elm->obj->path,
2792 (void *)elm->obj->init);
2793 LD_UTRACE(UTRACE_INIT_CALL, elm->obj, (void *)elm->obj->init,
2794 0, 0, elm->obj->path);
2795 call_initfini_pointer(elm->obj, elm->obj->init);
2797 init_addr = (Elf_Addr *)elm->obj->init_array;
2798 if (init_addr != NULL) {
2799 for (index = 0; index < elm->obj->init_array_num; index++) {
2800 if (init_addr[index] != 0 && init_addr[index] != 1) {
2801 dbg("calling init function for %s at %p", elm->obj->path,
2802 (void *)init_addr[index]);
2803 LD_UTRACE(UTRACE_INIT_CALL, elm->obj,
2804 (void *)init_addr[index], 0, 0, elm->obj->path);
2805 call_init_pointer(elm->obj, init_addr[index]);
2809 wlock_acquire(rtld_bind_lock, lockstate);
2810 unhold_object(elm->obj);
2812 errmsg_restore(saved_msg);
2816 objlist_clear(Objlist *list)
2820 while (!STAILQ_EMPTY(list)) {
2821 elm = STAILQ_FIRST(list);
2822 STAILQ_REMOVE_HEAD(list, link);
2827 static Objlist_Entry *
2828 objlist_find(Objlist *list, const Obj_Entry *obj)
2832 STAILQ_FOREACH(elm, list, link)
2833 if (elm->obj == obj)
2839 objlist_init(Objlist *list)
2845 objlist_push_head(Objlist *list, Obj_Entry *obj)
2849 elm = NEW(Objlist_Entry);
2851 STAILQ_INSERT_HEAD(list, elm, link);
2855 objlist_push_tail(Objlist *list, Obj_Entry *obj)
2859 elm = NEW(Objlist_Entry);
2861 STAILQ_INSERT_TAIL(list, elm, link);
2865 objlist_put_after(Objlist *list, Obj_Entry *listobj, Obj_Entry *obj)
2867 Objlist_Entry *elm, *listelm;
2869 STAILQ_FOREACH(listelm, list, link) {
2870 if (listelm->obj == listobj)
2873 elm = NEW(Objlist_Entry);
2875 if (listelm != NULL)
2876 STAILQ_INSERT_AFTER(list, listelm, elm, link);
2878 STAILQ_INSERT_TAIL(list, elm, link);
2882 objlist_remove(Objlist *list, Obj_Entry *obj)
2886 if ((elm = objlist_find(list, obj)) != NULL) {
2887 STAILQ_REMOVE(list, elm, Struct_Objlist_Entry, link);
2893 * Relocate dag rooted in the specified object.
2894 * Returns 0 on success, or -1 on failure.
2898 relocate_object_dag(Obj_Entry *root, bool bind_now, Obj_Entry *rtldobj,
2899 int flags, RtldLockState *lockstate)
2905 STAILQ_FOREACH(elm, &root->dagmembers, link) {
2906 error = relocate_object(elm->obj, bind_now, rtldobj, flags,
2915 * Prepare for, or clean after, relocating an object marked with
2916 * DT_TEXTREL or DF_TEXTREL. Before relocating, all read-only
2917 * segments are remapped read-write. After relocations are done, the
2918 * segment's permissions are returned back to the modes specified in
2919 * the phdrs. If any relocation happened, or always for wired
2920 * program, COW is triggered.
2923 reloc_textrel_prot(Obj_Entry *obj, bool before)
2930 for (l = obj->phsize / sizeof(*ph), ph = obj->phdr; l > 0;
2932 if (ph->p_type != PT_LOAD || (ph->p_flags & PF_W) != 0)
2934 base = obj->relocbase + trunc_page(ph->p_vaddr);
2935 sz = round_page(ph->p_vaddr + ph->p_filesz) -
2936 trunc_page(ph->p_vaddr);
2937 prot = convert_prot(ph->p_flags) | (before ? PROT_WRITE : 0);
2938 if (mprotect(base, sz, prot) == -1) {
2939 _rtld_error("%s: Cannot write-%sable text segment: %s",
2940 obj->path, before ? "en" : "dis",
2941 rtld_strerror(errno));
2949 * Relocate single object.
2950 * Returns 0 on success, or -1 on failure.
2953 relocate_object(Obj_Entry *obj, bool bind_now, Obj_Entry *rtldobj,
2954 int flags, RtldLockState *lockstate)
2959 obj->relocated = true;
2961 dbg("relocating \"%s\"", obj->path);
2963 if (obj->symtab == NULL || obj->strtab == NULL ||
2964 !(obj->valid_hash_sysv || obj->valid_hash_gnu)) {
2965 _rtld_error("%s: Shared object has no run-time symbol table",
2970 /* There are relocations to the write-protected text segment. */
2971 if (obj->textrel && reloc_textrel_prot(obj, true) != 0)
2974 /* Process the non-PLT non-IFUNC relocations. */
2975 if (reloc_non_plt(obj, rtldobj, flags, lockstate))
2978 /* Re-protected the text segment. */
2979 if (obj->textrel && reloc_textrel_prot(obj, false) != 0)
2982 /* Set the special PLT or GOT entries. */
2985 /* Process the PLT relocations. */
2986 if (reloc_plt(obj, flags, lockstate) == -1)
2988 /* Relocate the jump slots if we are doing immediate binding. */
2989 if ((obj->bind_now || bind_now) && reloc_jmpslots(obj, flags,
2993 if (!obj->mainprog && obj_enforce_relro(obj) == -1)
2997 * Set up the magic number and version in the Obj_Entry. These
2998 * were checked in the crt1.o from the original ElfKit, so we
2999 * set them for backward compatibility.
3001 obj->magic = RTLD_MAGIC;
3002 obj->version = RTLD_VERSION;
3008 * Relocate newly-loaded shared objects. The argument is a pointer to
3009 * the Obj_Entry for the first such object. All objects from the first
3010 * to the end of the list of objects are relocated. Returns 0 on success,
3014 relocate_objects(Obj_Entry *first, bool bind_now, Obj_Entry *rtldobj,
3015 int flags, RtldLockState *lockstate)
3020 for (error = 0, obj = first; obj != NULL;
3021 obj = TAILQ_NEXT(obj, next)) {
3024 error = relocate_object(obj, bind_now, rtldobj, flags,
3033 * The handling of R_MACHINE_IRELATIVE relocations and jumpslots
3034 * referencing STT_GNU_IFUNC symbols is postponed till the other
3035 * relocations are done. The indirect functions specified as
3036 * ifunc are allowed to call other symbols, so we need to have
3037 * objects relocated before asking for resolution from indirects.
3039 * The R_MACHINE_IRELATIVE slots are resolved in greedy fashion,
3040 * instead of the usual lazy handling of PLT slots. It is
3041 * consistent with how GNU does it.
3044 resolve_object_ifunc(Obj_Entry *obj, bool bind_now, int flags,
3045 RtldLockState *lockstate)
3048 if (obj->ifuncs_resolved)
3050 obj->ifuncs_resolved = true;
3051 if (!obj->irelative && !obj->irelative_nonplt &&
3052 !((obj->bind_now || bind_now) && obj->gnu_ifunc))
3054 if (obj_disable_relro(obj) == -1 ||
3055 (obj->irelative && reloc_iresolve(obj, lockstate) == -1) ||
3056 (obj->irelative_nonplt && reloc_iresolve_nonplt(obj,
3057 lockstate) == -1) ||
3058 ((obj->bind_now || bind_now) && obj->gnu_ifunc &&
3059 reloc_gnu_ifunc(obj, flags, lockstate) == -1) ||
3060 obj_enforce_relro(obj) == -1)
3066 initlist_objects_ifunc(Objlist *list, bool bind_now, int flags,
3067 RtldLockState *lockstate)
3072 STAILQ_FOREACH(elm, list, link) {
3076 if (resolve_object_ifunc(obj, bind_now, flags,
3084 * Cleanup procedure. It will be called (by the atexit mechanism) just
3085 * before the process exits.
3090 RtldLockState lockstate;
3092 wlock_acquire(rtld_bind_lock, &lockstate);
3094 objlist_call_fini(&list_fini, NULL, &lockstate);
3095 /* No need to remove the items from the list, since we are exiting. */
3096 if (!libmap_disable)
3098 lock_release(rtld_bind_lock, &lockstate);
3107 * Iterate over a search path, translate each element, and invoke the
3108 * callback on the result.
3111 path_enumerate(const char *path, path_enum_proc callback,
3112 const char *refobj_path, void *arg)
3118 path += strspn(path, ":;");
3119 while (*path != '\0') {
3123 len = strcspn(path, ":;");
3124 trans = lm_findn(refobj_path, path, len);
3126 res = callback(trans, strlen(trans), arg);
3128 res = callback(path, len, arg);
3134 path += strspn(path, ":;");
3140 struct try_library_args {
3149 try_library_path(const char *dir, size_t dirlen, void *param)
3151 struct try_library_args *arg;
3155 if (*dir == '/' || trust) {
3158 if (dirlen + 1 + arg->namelen + 1 > arg->buflen)
3161 pathname = arg->buffer;
3162 strncpy(pathname, dir, dirlen);
3163 pathname[dirlen] = '/';
3164 strcpy(pathname + dirlen + 1, arg->name);
3166 dbg(" Trying \"%s\"", pathname);
3167 fd = open(pathname, O_RDONLY | O_CLOEXEC | O_VERIFY);
3169 dbg(" Opened \"%s\", fd %d", pathname, fd);
3170 pathname = xmalloc(dirlen + 1 + arg->namelen + 1);
3171 strcpy(pathname, arg->buffer);
3175 dbg(" Failed to open \"%s\": %s",
3176 pathname, rtld_strerror(errno));
3183 search_library_path(const char *name, const char *path,
3184 const char *refobj_path, int *fdp)
3187 struct try_library_args arg;
3193 arg.namelen = strlen(name);
3194 arg.buffer = xmalloc(PATH_MAX);
3195 arg.buflen = PATH_MAX;
3198 p = path_enumerate(path, try_library_path, refobj_path, &arg);
3208 * Finds the library with the given name using the directory descriptors
3209 * listed in the LD_LIBRARY_PATH_FDS environment variable.
3211 * Returns a freshly-opened close-on-exec file descriptor for the library,
3212 * or -1 if the library cannot be found.
3215 search_library_pathfds(const char *name, const char *path, int *fdp)
3217 char *envcopy, *fdstr, *found, *last_token;
3221 dbg("%s('%s', '%s', fdp)", __func__, name, path);
3223 /* Don't load from user-specified libdirs into setuid binaries. */
3227 /* We can't do anything if LD_LIBRARY_PATH_FDS isn't set. */
3231 /* LD_LIBRARY_PATH_FDS only works with relative paths. */
3232 if (name[0] == '/') {
3233 dbg("Absolute path (%s) passed to %s", name, __func__);
3238 * Use strtok_r() to walk the FD:FD:FD list. This requires a local
3239 * copy of the path, as strtok_r rewrites separator tokens
3243 envcopy = xstrdup(path);
3244 for (fdstr = strtok_r(envcopy, ":", &last_token); fdstr != NULL;
3245 fdstr = strtok_r(NULL, ":", &last_token)) {
3246 dirfd = parse_integer(fdstr);
3248 _rtld_error("failed to parse directory FD: '%s'",
3252 fd = __sys_openat(dirfd, name, O_RDONLY | O_CLOEXEC | O_VERIFY);
3255 len = strlen(fdstr) + strlen(name) + 3;
3256 found = xmalloc(len);
3257 if (rtld_snprintf(found, len, "#%d/%s", dirfd, name) < 0) {
3258 _rtld_error("error generating '%d/%s'",
3262 dbg("open('%s') => %d", found, fd);
3273 dlclose(void *handle)
3275 RtldLockState lockstate;
3278 wlock_acquire(rtld_bind_lock, &lockstate);
3279 error = dlclose_locked(handle, &lockstate);
3280 lock_release(rtld_bind_lock, &lockstate);
3285 dlclose_locked(void *handle, RtldLockState *lockstate)
3289 root = dlcheck(handle);
3292 LD_UTRACE(UTRACE_DLCLOSE_START, handle, NULL, 0, root->dl_refcount,
3295 /* Unreference the object and its dependencies. */
3296 root->dl_refcount--;
3298 if (root->refcount == 1) {
3300 * The object will be no longer referenced, so we must unload it.
3301 * First, call the fini functions.
3303 objlist_call_fini(&list_fini, root, lockstate);
3307 /* Finish cleaning up the newly-unreferenced objects. */
3308 GDB_STATE(RT_DELETE,&root->linkmap);
3309 unload_object(root, lockstate);
3310 GDB_STATE(RT_CONSISTENT,NULL);
3314 LD_UTRACE(UTRACE_DLCLOSE_STOP, handle, NULL, 0, 0, NULL);
3321 char *msg = error_message;
3322 error_message = NULL;
3327 * This function is deprecated and has no effect.
3330 dllockinit(void *context,
3331 void *(*_lock_create)(void *context) __unused,
3332 void (*_rlock_acquire)(void *lock) __unused,
3333 void (*_wlock_acquire)(void *lock) __unused,
3334 void (*_lock_release)(void *lock) __unused,
3335 void (*_lock_destroy)(void *lock) __unused,
3336 void (*context_destroy)(void *context))
3338 static void *cur_context;
3339 static void (*cur_context_destroy)(void *);
3341 /* Just destroy the context from the previous call, if necessary. */
3342 if (cur_context_destroy != NULL)
3343 cur_context_destroy(cur_context);
3344 cur_context = context;
3345 cur_context_destroy = context_destroy;
3349 dlopen(const char *name, int mode)
3352 return (rtld_dlopen(name, -1, mode));
3356 fdlopen(int fd, int mode)
3359 return (rtld_dlopen(NULL, fd, mode));
3363 rtld_dlopen(const char *name, int fd, int mode)
3365 RtldLockState lockstate;
3368 LD_UTRACE(UTRACE_DLOPEN_START, NULL, NULL, 0, mode, name);
3369 ld_tracing = (mode & RTLD_TRACE) == 0 ? NULL : "1";
3370 if (ld_tracing != NULL) {
3371 rlock_acquire(rtld_bind_lock, &lockstate);
3372 if (sigsetjmp(lockstate.env, 0) != 0)
3373 lock_upgrade(rtld_bind_lock, &lockstate);
3374 environ = __DECONST(char **, *get_program_var_addr("environ", &lockstate));
3375 lock_release(rtld_bind_lock, &lockstate);
3377 lo_flags = RTLD_LO_DLOPEN;
3378 if (mode & RTLD_NODELETE)
3379 lo_flags |= RTLD_LO_NODELETE;
3380 if (mode & RTLD_NOLOAD)
3381 lo_flags |= RTLD_LO_NOLOAD;
3382 if (mode & RTLD_DEEPBIND)
3383 lo_flags |= RTLD_LO_DEEPBIND;
3384 if (ld_tracing != NULL)
3385 lo_flags |= RTLD_LO_TRACE | RTLD_LO_IGNSTLS;
3387 return (dlopen_object(name, fd, obj_main, lo_flags,
3388 mode & (RTLD_MODEMASK | RTLD_GLOBAL), NULL));
3392 dlopen_cleanup(Obj_Entry *obj, RtldLockState *lockstate)
3397 if (obj->refcount == 0)
3398 unload_object(obj, lockstate);
3402 dlopen_object(const char *name, int fd, Obj_Entry *refobj, int lo_flags,
3403 int mode, RtldLockState *lockstate)
3405 Obj_Entry *old_obj_tail;
3408 RtldLockState mlockstate;
3411 objlist_init(&initlist);
3413 if (lockstate == NULL && !(lo_flags & RTLD_LO_EARLY)) {
3414 wlock_acquire(rtld_bind_lock, &mlockstate);
3415 lockstate = &mlockstate;
3417 GDB_STATE(RT_ADD,NULL);
3419 old_obj_tail = globallist_curr(TAILQ_LAST(&obj_list, obj_entry_q));
3421 if (name == NULL && fd == -1) {
3425 obj = load_object(name, fd, refobj, lo_flags);
3430 if (mode & RTLD_GLOBAL && objlist_find(&list_global, obj) == NULL)
3431 objlist_push_tail(&list_global, obj);
3432 if (globallist_next(old_obj_tail) != NULL) {
3433 /* We loaded something new. */
3434 assert(globallist_next(old_obj_tail) == obj);
3435 if ((lo_flags & RTLD_LO_DEEPBIND) != 0)
3436 obj->symbolic = true;
3438 if ((lo_flags & (RTLD_LO_EARLY | RTLD_LO_IGNSTLS)) == 0 &&
3439 obj->static_tls && !allocate_tls_offset(obj)) {
3440 _rtld_error("%s: No space available "
3441 "for static Thread Local Storage", obj->path);
3445 result = load_needed_objects(obj, lo_flags & (RTLD_LO_DLOPEN |
3446 RTLD_LO_EARLY | RTLD_LO_IGNSTLS));
3450 result = rtld_verify_versions(&obj->dagmembers);
3451 if (result != -1 && ld_tracing)
3453 if (result == -1 || relocate_object_dag(obj,
3454 (mode & RTLD_MODEMASK) == RTLD_NOW, &obj_rtld,
3455 (lo_flags & RTLD_LO_EARLY) ? SYMLOOK_EARLY : 0,
3457 dlopen_cleanup(obj, lockstate);
3459 } else if (lo_flags & RTLD_LO_EARLY) {
3461 * Do not call the init functions for early loaded
3462 * filtees. The image is still not initialized enough
3465 * Our object is found by the global object list and
3466 * will be ordered among all init calls done right
3467 * before transferring control to main.
3470 /* Make list of init functions to call. */
3471 initlist_add_objects(obj, obj, &initlist);
3474 * Process all no_delete or global objects here, given
3475 * them own DAGs to prevent their dependencies from being
3476 * unloaded. This has to be done after we have loaded all
3477 * of the dependencies, so that we do not miss any.
3483 * Bump the reference counts for objects on this DAG. If
3484 * this is the first dlopen() call for the object that was
3485 * already loaded as a dependency, initialize the dag
3491 if ((lo_flags & RTLD_LO_TRACE) != 0)
3494 if (obj != NULL && ((lo_flags & RTLD_LO_NODELETE) != 0 ||
3495 obj->z_nodelete) && !obj->ref_nodel) {
3496 dbg("obj %s nodelete", obj->path);
3498 obj->z_nodelete = obj->ref_nodel = true;
3502 LD_UTRACE(UTRACE_DLOPEN_STOP, obj, NULL, 0, obj ? obj->dl_refcount : 0,
3504 GDB_STATE(RT_CONSISTENT,obj ? &obj->linkmap : NULL);
3506 if ((lo_flags & RTLD_LO_EARLY) == 0) {
3507 map_stacks_exec(lockstate);
3509 distribute_static_tls(&initlist, lockstate);
3512 if (initlist_objects_ifunc(&initlist, (mode & RTLD_MODEMASK) == RTLD_NOW,
3513 (lo_flags & RTLD_LO_EARLY) ? SYMLOOK_EARLY : 0,
3515 objlist_clear(&initlist);
3516 dlopen_cleanup(obj, lockstate);
3517 if (lockstate == &mlockstate)
3518 lock_release(rtld_bind_lock, lockstate);
3522 if (!(lo_flags & RTLD_LO_EARLY)) {
3523 /* Call the init functions. */
3524 objlist_call_init(&initlist, lockstate);
3526 objlist_clear(&initlist);
3527 if (lockstate == &mlockstate)
3528 lock_release(rtld_bind_lock, lockstate);
3531 trace_loaded_objects(obj);
3532 if (lockstate == &mlockstate)
3533 lock_release(rtld_bind_lock, lockstate);
3538 do_dlsym(void *handle, const char *name, void *retaddr, const Ver_Entry *ve,
3542 const Obj_Entry *obj, *defobj;
3545 RtldLockState lockstate;
3552 symlook_init(&req, name);
3554 req.flags = flags | SYMLOOK_IN_PLT;
3555 req.lockstate = &lockstate;
3557 LD_UTRACE(UTRACE_DLSYM_START, handle, NULL, 0, 0, name);
3558 rlock_acquire(rtld_bind_lock, &lockstate);
3559 if (sigsetjmp(lockstate.env, 0) != 0)
3560 lock_upgrade(rtld_bind_lock, &lockstate);
3561 if (handle == NULL || handle == RTLD_NEXT ||
3562 handle == RTLD_DEFAULT || handle == RTLD_SELF) {
3564 if ((obj = obj_from_addr(retaddr)) == NULL) {
3565 _rtld_error("Cannot determine caller's shared object");
3566 lock_release(rtld_bind_lock, &lockstate);
3567 LD_UTRACE(UTRACE_DLSYM_STOP, handle, NULL, 0, 0, name);
3570 if (handle == NULL) { /* Just the caller's shared object. */
3571 res = symlook_obj(&req, obj);
3574 defobj = req.defobj_out;
3576 } else if (handle == RTLD_NEXT || /* Objects after caller's */
3577 handle == RTLD_SELF) { /* ... caller included */
3578 if (handle == RTLD_NEXT)
3579 obj = globallist_next(obj);
3580 for (; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
3583 res = symlook_obj(&req, obj);
3586 ELF_ST_BIND(req.sym_out->st_info) != STB_WEAK) {
3588 defobj = req.defobj_out;
3589 if (ELF_ST_BIND(def->st_info) != STB_WEAK)
3595 * Search the dynamic linker itself, and possibly resolve the
3596 * symbol from there. This is how the application links to
3597 * dynamic linker services such as dlopen.
3599 if (def == NULL || ELF_ST_BIND(def->st_info) == STB_WEAK) {
3600 res = symlook_obj(&req, &obj_rtld);
3603 defobj = req.defobj_out;
3607 assert(handle == RTLD_DEFAULT);
3608 res = symlook_default(&req, obj);
3610 defobj = req.defobj_out;
3615 if ((obj = dlcheck(handle)) == NULL) {
3616 lock_release(rtld_bind_lock, &lockstate);
3617 LD_UTRACE(UTRACE_DLSYM_STOP, handle, NULL, 0, 0, name);
3621 donelist_init(&donelist);
3622 if (obj->mainprog) {
3623 /* Handle obtained by dlopen(NULL, ...) implies global scope. */
3624 res = symlook_global(&req, &donelist);
3627 defobj = req.defobj_out;
3630 * Search the dynamic linker itself, and possibly resolve the
3631 * symbol from there. This is how the application links to
3632 * dynamic linker services such as dlopen.
3634 if (def == NULL || ELF_ST_BIND(def->st_info) == STB_WEAK) {
3635 res = symlook_obj(&req, &obj_rtld);
3638 defobj = req.defobj_out;
3643 /* Search the whole DAG rooted at the given object. */
3644 res = symlook_list(&req, &obj->dagmembers, &donelist);
3647 defobj = req.defobj_out;
3653 lock_release(rtld_bind_lock, &lockstate);
3656 * The value required by the caller is derived from the value
3657 * of the symbol. this is simply the relocated value of the
3660 if (ELF_ST_TYPE(def->st_info) == STT_FUNC)
3661 sym = make_function_pointer(def, defobj);
3662 else if (ELF_ST_TYPE(def->st_info) == STT_GNU_IFUNC)
3663 sym = rtld_resolve_ifunc(defobj, def);
3664 else if (ELF_ST_TYPE(def->st_info) == STT_TLS) {
3665 ti.ti_module = defobj->tlsindex;
3666 ti.ti_offset = def->st_value;
3667 sym = __tls_get_addr(&ti);
3669 sym = defobj->relocbase + def->st_value;
3670 LD_UTRACE(UTRACE_DLSYM_STOP, handle, sym, 0, 0, name);
3674 _rtld_error("Undefined symbol \"%s%s%s\"", name, ve != NULL ? "@" : "",
3675 ve != NULL ? ve->name : "");
3676 lock_release(rtld_bind_lock, &lockstate);
3677 LD_UTRACE(UTRACE_DLSYM_STOP, handle, NULL, 0, 0, name);
3682 dlsym(void *handle, const char *name)
3684 return do_dlsym(handle, name, __builtin_return_address(0), NULL,
3689 dlfunc(void *handle, const char *name)
3696 rv.d = do_dlsym(handle, name, __builtin_return_address(0), NULL,
3702 dlvsym(void *handle, const char *name, const char *version)
3706 ventry.name = version;
3708 ventry.hash = elf_hash(version);
3710 return do_dlsym(handle, name, __builtin_return_address(0), &ventry,
3715 _rtld_addr_phdr(const void *addr, struct dl_phdr_info *phdr_info)
3717 const Obj_Entry *obj;
3718 RtldLockState lockstate;
3720 rlock_acquire(rtld_bind_lock, &lockstate);
3721 obj = obj_from_addr(addr);
3723 _rtld_error("No shared object contains address");
3724 lock_release(rtld_bind_lock, &lockstate);
3727 rtld_fill_dl_phdr_info(obj, phdr_info);
3728 lock_release(rtld_bind_lock, &lockstate);
3733 dladdr(const void *addr, Dl_info *info)
3735 const Obj_Entry *obj;
3738 unsigned long symoffset;
3739 RtldLockState lockstate;
3741 rlock_acquire(rtld_bind_lock, &lockstate);
3742 obj = obj_from_addr(addr);
3744 _rtld_error("No shared object contains address");
3745 lock_release(rtld_bind_lock, &lockstate);
3748 info->dli_fname = obj->path;
3749 info->dli_fbase = obj->mapbase;
3750 info->dli_saddr = (void *)0;
3751 info->dli_sname = NULL;
3754 * Walk the symbol list looking for the symbol whose address is
3755 * closest to the address sent in.
3757 for (symoffset = 0; symoffset < obj->dynsymcount; symoffset++) {
3758 def = obj->symtab + symoffset;
3761 * For skip the symbol if st_shndx is either SHN_UNDEF or
3764 if (def->st_shndx == SHN_UNDEF || def->st_shndx == SHN_COMMON)
3768 * If the symbol is greater than the specified address, or if it
3769 * is further away from addr than the current nearest symbol,
3772 symbol_addr = obj->relocbase + def->st_value;
3773 if (symbol_addr > addr || symbol_addr < info->dli_saddr)
3776 /* Update our idea of the nearest symbol. */
3777 info->dli_sname = obj->strtab + def->st_name;
3778 info->dli_saddr = symbol_addr;
3781 if (info->dli_saddr == addr)
3784 lock_release(rtld_bind_lock, &lockstate);
3789 dlinfo(void *handle, int request, void *p)
3791 const Obj_Entry *obj;
3792 RtldLockState lockstate;
3795 rlock_acquire(rtld_bind_lock, &lockstate);
3797 if (handle == NULL || handle == RTLD_SELF) {
3800 retaddr = __builtin_return_address(0); /* __GNUC__ only */
3801 if ((obj = obj_from_addr(retaddr)) == NULL)
3802 _rtld_error("Cannot determine caller's shared object");
3804 obj = dlcheck(handle);
3807 lock_release(rtld_bind_lock, &lockstate);
3813 case RTLD_DI_LINKMAP:
3814 *((struct link_map const **)p) = &obj->linkmap;
3816 case RTLD_DI_ORIGIN:
3817 error = rtld_dirname(obj->path, p);
3820 case RTLD_DI_SERINFOSIZE:
3821 case RTLD_DI_SERINFO:
3822 error = do_search_info(obj, request, (struct dl_serinfo *)p);
3826 _rtld_error("Invalid request %d passed to dlinfo()", request);
3830 lock_release(rtld_bind_lock, &lockstate);
3836 rtld_fill_dl_phdr_info(const Obj_Entry *obj, struct dl_phdr_info *phdr_info)
3839 phdr_info->dlpi_addr = (Elf_Addr)obj->relocbase;
3840 phdr_info->dlpi_name = obj->path;
3841 phdr_info->dlpi_phdr = obj->phdr;
3842 phdr_info->dlpi_phnum = obj->phsize / sizeof(obj->phdr[0]);
3843 phdr_info->dlpi_tls_modid = obj->tlsindex;
3844 phdr_info->dlpi_tls_data = obj->tlsinit;
3845 phdr_info->dlpi_adds = obj_loads;
3846 phdr_info->dlpi_subs = obj_loads - obj_count;
3850 dl_iterate_phdr(__dl_iterate_hdr_callback callback, void *param)
3852 struct dl_phdr_info phdr_info;
3853 Obj_Entry *obj, marker;
3854 RtldLockState bind_lockstate, phdr_lockstate;
3857 init_marker(&marker);
3860 wlock_acquire(rtld_phdr_lock, &phdr_lockstate);
3861 wlock_acquire(rtld_bind_lock, &bind_lockstate);
3862 for (obj = globallist_curr(TAILQ_FIRST(&obj_list)); obj != NULL;) {
3863 TAILQ_INSERT_AFTER(&obj_list, obj, &marker, next);
3864 rtld_fill_dl_phdr_info(obj, &phdr_info);
3866 lock_release(rtld_bind_lock, &bind_lockstate);
3868 error = callback(&phdr_info, sizeof phdr_info, param);
3870 wlock_acquire(rtld_bind_lock, &bind_lockstate);
3872 obj = globallist_next(&marker);
3873 TAILQ_REMOVE(&obj_list, &marker, next);
3875 lock_release(rtld_bind_lock, &bind_lockstate);
3876 lock_release(rtld_phdr_lock, &phdr_lockstate);
3882 rtld_fill_dl_phdr_info(&obj_rtld, &phdr_info);
3883 lock_release(rtld_bind_lock, &bind_lockstate);
3884 error = callback(&phdr_info, sizeof(phdr_info), param);
3886 lock_release(rtld_phdr_lock, &phdr_lockstate);
3891 fill_search_info(const char *dir, size_t dirlen, void *param)
3893 struct fill_search_info_args *arg;
3897 if (arg->request == RTLD_DI_SERINFOSIZE) {
3898 arg->serinfo->dls_cnt ++;
3899 arg->serinfo->dls_size += sizeof(struct dl_serpath) + dirlen + 1;
3901 struct dl_serpath *s_entry;
3903 s_entry = arg->serpath;
3904 s_entry->dls_name = arg->strspace;
3905 s_entry->dls_flags = arg->flags;
3907 strncpy(arg->strspace, dir, dirlen);
3908 arg->strspace[dirlen] = '\0';
3910 arg->strspace += dirlen + 1;
3918 do_search_info(const Obj_Entry *obj, int request, struct dl_serinfo *info)
3920 struct dl_serinfo _info;
3921 struct fill_search_info_args args;
3923 args.request = RTLD_DI_SERINFOSIZE;
3924 args.serinfo = &_info;
3926 _info.dls_size = __offsetof(struct dl_serinfo, dls_serpath);
3929 path_enumerate(obj->rpath, fill_search_info, NULL, &args);
3930 path_enumerate(ld_library_path, fill_search_info, NULL, &args);
3931 path_enumerate(obj->runpath, fill_search_info, NULL, &args);
3932 path_enumerate(gethints(obj->z_nodeflib), fill_search_info, NULL, &args);
3933 if (!obj->z_nodeflib)
3934 path_enumerate(ld_standard_library_path, fill_search_info, NULL, &args);
3937 if (request == RTLD_DI_SERINFOSIZE) {
3938 info->dls_size = _info.dls_size;
3939 info->dls_cnt = _info.dls_cnt;
3943 if (info->dls_cnt != _info.dls_cnt || info->dls_size != _info.dls_size) {
3944 _rtld_error("Uninitialized Dl_serinfo struct passed to dlinfo()");
3948 args.request = RTLD_DI_SERINFO;
3949 args.serinfo = info;
3950 args.serpath = &info->dls_serpath[0];
3951 args.strspace = (char *)&info->dls_serpath[_info.dls_cnt];
3953 args.flags = LA_SER_RUNPATH;
3954 if (path_enumerate(obj->rpath, fill_search_info, NULL, &args) != NULL)
3957 args.flags = LA_SER_LIBPATH;
3958 if (path_enumerate(ld_library_path, fill_search_info, NULL, &args) != NULL)
3961 args.flags = LA_SER_RUNPATH;
3962 if (path_enumerate(obj->runpath, fill_search_info, NULL, &args) != NULL)
3965 args.flags = LA_SER_CONFIG;
3966 if (path_enumerate(gethints(obj->z_nodeflib), fill_search_info, NULL, &args)
3970 args.flags = LA_SER_DEFAULT;
3971 if (!obj->z_nodeflib && path_enumerate(ld_standard_library_path,
3972 fill_search_info, NULL, &args) != NULL)
3978 rtld_dirname(const char *path, char *bname)
3982 /* Empty or NULL string gets treated as "." */
3983 if (path == NULL || *path == '\0') {
3989 /* Strip trailing slashes */
3990 endp = path + strlen(path) - 1;
3991 while (endp > path && *endp == '/')
3994 /* Find the start of the dir */
3995 while (endp > path && *endp != '/')
3998 /* Either the dir is "/" or there are no slashes */
4000 bname[0] = *endp == '/' ? '/' : '.';
4006 } while (endp > path && *endp == '/');
4009 if (endp - path + 2 > PATH_MAX)
4011 _rtld_error("Filename is too long: %s", path);
4015 strncpy(bname, path, endp - path + 1);
4016 bname[endp - path + 1] = '\0';
4021 rtld_dirname_abs(const char *path, char *base)
4025 if (realpath(path, base) == NULL) {
4026 _rtld_error("realpath \"%s\" failed (%s)", path,
4027 rtld_strerror(errno));
4030 dbg("%s -> %s", path, base);
4031 last = strrchr(base, '/');
4033 _rtld_error("non-abs result from realpath \"%s\"", path);
4042 linkmap_add(Obj_Entry *obj)
4044 struct link_map *l, *prev;
4047 l->l_name = obj->path;
4048 l->l_base = obj->mapbase;
4049 l->l_ld = obj->dynamic;
4050 l->l_addr = obj->relocbase;
4052 if (r_debug.r_map == NULL) {
4058 * Scan to the end of the list, but not past the entry for the
4059 * dynamic linker, which we want to keep at the very end.
4061 for (prev = r_debug.r_map;
4062 prev->l_next != NULL && prev->l_next != &obj_rtld.linkmap;
4063 prev = prev->l_next)
4066 /* Link in the new entry. */
4068 l->l_next = prev->l_next;
4069 if (l->l_next != NULL)
4070 l->l_next->l_prev = l;
4075 linkmap_delete(Obj_Entry *obj)
4080 if (l->l_prev == NULL) {
4081 if ((r_debug.r_map = l->l_next) != NULL)
4082 l->l_next->l_prev = NULL;
4086 if ((l->l_prev->l_next = l->l_next) != NULL)
4087 l->l_next->l_prev = l->l_prev;
4091 * Function for the debugger to set a breakpoint on to gain control.
4093 * The two parameters allow the debugger to easily find and determine
4094 * what the runtime loader is doing and to whom it is doing it.
4096 * When the loadhook trap is hit (r_debug_state, set at program
4097 * initialization), the arguments can be found on the stack:
4099 * +8 struct link_map *m
4100 * +4 struct r_debug *rd
4104 r_debug_state(struct r_debug* rd __unused, struct link_map *m __unused)
4107 * The following is a hack to force the compiler to emit calls to
4108 * this function, even when optimizing. If the function is empty,
4109 * the compiler is not obliged to emit any code for calls to it,
4110 * even when marked __noinline. However, gdb depends on those
4113 __compiler_membar();
4117 * A function called after init routines have completed. This can be used to
4118 * break before a program's entry routine is called, and can be used when
4119 * main is not available in the symbol table.
4122 _r_debug_postinit(struct link_map *m __unused)
4125 /* See r_debug_state(). */
4126 __compiler_membar();
4130 release_object(Obj_Entry *obj)
4133 if (obj->holdcount > 0) {
4134 obj->unholdfree = true;
4137 munmap(obj->mapbase, obj->mapsize);
4138 linkmap_delete(obj);
4143 * Get address of the pointer variable in the main program.
4144 * Prefer non-weak symbol over the weak one.
4146 static const void **
4147 get_program_var_addr(const char *name, RtldLockState *lockstate)
4152 symlook_init(&req, name);
4153 req.lockstate = lockstate;
4154 donelist_init(&donelist);
4155 if (symlook_global(&req, &donelist) != 0)
4157 if (ELF_ST_TYPE(req.sym_out->st_info) == STT_FUNC)
4158 return ((const void **)make_function_pointer(req.sym_out,
4160 else if (ELF_ST_TYPE(req.sym_out->st_info) == STT_GNU_IFUNC)
4161 return ((const void **)rtld_resolve_ifunc(req.defobj_out, req.sym_out));
4163 return ((const void **)(req.defobj_out->relocbase +
4164 req.sym_out->st_value));
4168 * Set a pointer variable in the main program to the given value. This
4169 * is used to set key variables such as "environ" before any of the
4170 * init functions are called.
4173 set_program_var(const char *name, const void *value)
4177 if ((addr = get_program_var_addr(name, NULL)) != NULL) {
4178 dbg("\"%s\": *%p <-- %p", name, addr, value);
4184 * Search the global objects, including dependencies and main object,
4185 * for the given symbol.
4188 symlook_global(SymLook *req, DoneList *donelist)
4191 const Objlist_Entry *elm;
4194 symlook_init_from_req(&req1, req);
4196 /* Search all objects loaded at program start up. */
4197 if (req->defobj_out == NULL ||
4198 ELF_ST_BIND(req->sym_out->st_info) == STB_WEAK) {
4199 res = symlook_list(&req1, &list_main, donelist);
4200 if (res == 0 && (req->defobj_out == NULL ||
4201 ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK)) {
4202 req->sym_out = req1.sym_out;
4203 req->defobj_out = req1.defobj_out;
4204 assert(req->defobj_out != NULL);
4208 /* Search all DAGs whose roots are RTLD_GLOBAL objects. */
4209 STAILQ_FOREACH(elm, &list_global, link) {
4210 if (req->defobj_out != NULL &&
4211 ELF_ST_BIND(req->sym_out->st_info) != STB_WEAK)
4213 res = symlook_list(&req1, &elm->obj->dagmembers, donelist);
4214 if (res == 0 && (req->defobj_out == NULL ||
4215 ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK)) {
4216 req->sym_out = req1.sym_out;
4217 req->defobj_out = req1.defobj_out;
4218 assert(req->defobj_out != NULL);
4222 return (req->sym_out != NULL ? 0 : ESRCH);
4226 * Given a symbol name in a referencing object, find the corresponding
4227 * definition of the symbol. Returns a pointer to the symbol, or NULL if
4228 * no definition was found. Returns a pointer to the Obj_Entry of the
4229 * defining object via the reference parameter DEFOBJ_OUT.
4232 symlook_default(SymLook *req, const Obj_Entry *refobj)
4235 const Objlist_Entry *elm;
4239 donelist_init(&donelist);
4240 symlook_init_from_req(&req1, req);
4243 * Look first in the referencing object if linked symbolically,
4244 * and similarly handle protected symbols.
4246 res = symlook_obj(&req1, refobj);
4247 if (res == 0 && (refobj->symbolic ||
4248 ELF_ST_VISIBILITY(req1.sym_out->st_other) == STV_PROTECTED)) {
4249 req->sym_out = req1.sym_out;
4250 req->defobj_out = req1.defobj_out;
4251 assert(req->defobj_out != NULL);
4253 if (refobj->symbolic || req->defobj_out != NULL)
4254 donelist_check(&donelist, refobj);
4256 symlook_global(req, &donelist);
4258 /* Search all dlopened DAGs containing the referencing object. */
4259 STAILQ_FOREACH(elm, &refobj->dldags, link) {
4260 if (req->sym_out != NULL &&
4261 ELF_ST_BIND(req->sym_out->st_info) != STB_WEAK)
4263 res = symlook_list(&req1, &elm->obj->dagmembers, &donelist);
4264 if (res == 0 && (req->sym_out == NULL ||
4265 ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK)) {
4266 req->sym_out = req1.sym_out;
4267 req->defobj_out = req1.defobj_out;
4268 assert(req->defobj_out != NULL);
4273 * Search the dynamic linker itself, and possibly resolve the
4274 * symbol from there. This is how the application links to
4275 * dynamic linker services such as dlopen.
4277 if (req->sym_out == NULL ||
4278 ELF_ST_BIND(req->sym_out->st_info) == STB_WEAK) {
4279 res = symlook_obj(&req1, &obj_rtld);
4281 req->sym_out = req1.sym_out;
4282 req->defobj_out = req1.defobj_out;
4283 assert(req->defobj_out != NULL);
4287 return (req->sym_out != NULL ? 0 : ESRCH);
4291 symlook_list(SymLook *req, const Objlist *objlist, DoneList *dlp)
4294 const Obj_Entry *defobj;
4295 const Objlist_Entry *elm;
4301 STAILQ_FOREACH(elm, objlist, link) {
4302 if (donelist_check(dlp, elm->obj))
4304 symlook_init_from_req(&req1, req);
4305 if ((res = symlook_obj(&req1, elm->obj)) == 0) {
4306 if (def == NULL || ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK) {
4308 defobj = req1.defobj_out;
4309 if (ELF_ST_BIND(def->st_info) != STB_WEAK)
4316 req->defobj_out = defobj;
4323 * Search the chain of DAGS cointed to by the given Needed_Entry
4324 * for a symbol of the given name. Each DAG is scanned completely
4325 * before advancing to the next one. Returns a pointer to the symbol,
4326 * or NULL if no definition was found.
4329 symlook_needed(SymLook *req, const Needed_Entry *needed, DoneList *dlp)
4332 const Needed_Entry *n;
4333 const Obj_Entry *defobj;
4339 symlook_init_from_req(&req1, req);
4340 for (n = needed; n != NULL; n = n->next) {
4341 if (n->obj == NULL ||
4342 (res = symlook_list(&req1, &n->obj->dagmembers, dlp)) != 0)
4344 if (def == NULL || ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK) {
4346 defobj = req1.defobj_out;
4347 if (ELF_ST_BIND(def->st_info) != STB_WEAK)
4353 req->defobj_out = defobj;
4360 * Search the symbol table of a single shared object for a symbol of
4361 * the given name and version, if requested. Returns a pointer to the
4362 * symbol, or NULL if no definition was found. If the object is
4363 * filter, return filtered symbol from filtee.
4365 * The symbol's hash value is passed in for efficiency reasons; that
4366 * eliminates many recomputations of the hash value.
4369 symlook_obj(SymLook *req, const Obj_Entry *obj)
4373 int flags, res, mres;
4376 * If there is at least one valid hash at this point, we prefer to
4377 * use the faster GNU version if available.
4379 if (obj->valid_hash_gnu)
4380 mres = symlook_obj1_gnu(req, obj);
4381 else if (obj->valid_hash_sysv)
4382 mres = symlook_obj1_sysv(req, obj);
4387 if (obj->needed_filtees != NULL) {
4388 flags = (req->flags & SYMLOOK_EARLY) ? RTLD_LO_EARLY : 0;
4389 load_filtees(__DECONST(Obj_Entry *, obj), flags, req->lockstate);
4390 donelist_init(&donelist);
4391 symlook_init_from_req(&req1, req);
4392 res = symlook_needed(&req1, obj->needed_filtees, &donelist);
4394 req->sym_out = req1.sym_out;
4395 req->defobj_out = req1.defobj_out;
4399 if (obj->needed_aux_filtees != NULL) {
4400 flags = (req->flags & SYMLOOK_EARLY) ? RTLD_LO_EARLY : 0;
4401 load_filtees(__DECONST(Obj_Entry *, obj), flags, req->lockstate);
4402 donelist_init(&donelist);
4403 symlook_init_from_req(&req1, req);
4404 res = symlook_needed(&req1, obj->needed_aux_filtees, &donelist);
4406 req->sym_out = req1.sym_out;
4407 req->defobj_out = req1.defobj_out;
4415 /* Symbol match routine common to both hash functions */
4417 matched_symbol(SymLook *req, const Obj_Entry *obj, Sym_Match_Result *result,
4418 const unsigned long symnum)
4421 const Elf_Sym *symp;
4424 symp = obj->symtab + symnum;
4425 strp = obj->strtab + symp->st_name;
4427 switch (ELF_ST_TYPE(symp->st_info)) {
4433 if (symp->st_value == 0)
4437 if (symp->st_shndx != SHN_UNDEF)
4440 else if (((req->flags & SYMLOOK_IN_PLT) == 0) &&
4441 (ELF_ST_TYPE(symp->st_info) == STT_FUNC))
4448 if (req->name[0] != strp[0] || strcmp(req->name, strp) != 0)
4451 if (req->ventry == NULL) {
4452 if (obj->versyms != NULL) {
4453 verndx = VER_NDX(obj->versyms[symnum]);
4454 if (verndx > obj->vernum) {
4456 "%s: symbol %s references wrong version %d",
4457 obj->path, obj->strtab + symnum, verndx);
4461 * If we are not called from dlsym (i.e. this
4462 * is a normal relocation from unversioned
4463 * binary), accept the symbol immediately if
4464 * it happens to have first version after this
4465 * shared object became versioned. Otherwise,
4466 * if symbol is versioned and not hidden,
4467 * remember it. If it is the only symbol with
4468 * this name exported by the shared object, it
4469 * will be returned as a match by the calling
4470 * function. If symbol is global (verndx < 2)
4471 * accept it unconditionally.
4473 if ((req->flags & SYMLOOK_DLSYM) == 0 &&
4474 verndx == VER_NDX_GIVEN) {
4475 result->sym_out = symp;
4478 else if (verndx >= VER_NDX_GIVEN) {
4479 if ((obj->versyms[symnum] & VER_NDX_HIDDEN)
4481 if (result->vsymp == NULL)
4482 result->vsymp = symp;
4488 result->sym_out = symp;
4491 if (obj->versyms == NULL) {
4492 if (object_match_name(obj, req->ventry->name)) {
4493 _rtld_error("%s: object %s should provide version %s "
4494 "for symbol %s", obj_rtld.path, obj->path,
4495 req->ventry->name, obj->strtab + symnum);
4499 verndx = VER_NDX(obj->versyms[symnum]);
4500 if (verndx > obj->vernum) {
4501 _rtld_error("%s: symbol %s references wrong version %d",
4502 obj->path, obj->strtab + symnum, verndx);
4505 if (obj->vertab[verndx].hash != req->ventry->hash ||
4506 strcmp(obj->vertab[verndx].name, req->ventry->name)) {
4508 * Version does not match. Look if this is a
4509 * global symbol and if it is not hidden. If
4510 * global symbol (verndx < 2) is available,
4511 * use it. Do not return symbol if we are
4512 * called by dlvsym, because dlvsym looks for
4513 * a specific version and default one is not
4514 * what dlvsym wants.
4516 if ((req->flags & SYMLOOK_DLSYM) ||
4517 (verndx >= VER_NDX_GIVEN) ||
4518 (obj->versyms[symnum] & VER_NDX_HIDDEN))
4522 result->sym_out = symp;
4527 * Search for symbol using SysV hash function.
4528 * obj->buckets is known not to be NULL at this point; the test for this was
4529 * performed with the obj->valid_hash_sysv assignment.
4532 symlook_obj1_sysv(SymLook *req, const Obj_Entry *obj)
4534 unsigned long symnum;
4535 Sym_Match_Result matchres;
4537 matchres.sym_out = NULL;
4538 matchres.vsymp = NULL;
4539 matchres.vcount = 0;
4541 for (symnum = obj->buckets[req->hash % obj->nbuckets];
4542 symnum != STN_UNDEF; symnum = obj->chains[symnum]) {
4543 if (symnum >= obj->nchains)
4544 return (ESRCH); /* Bad object */
4546 if (matched_symbol(req, obj, &matchres, symnum)) {
4547 req->sym_out = matchres.sym_out;
4548 req->defobj_out = obj;
4552 if (matchres.vcount == 1) {
4553 req->sym_out = matchres.vsymp;
4554 req->defobj_out = obj;
4560 /* Search for symbol using GNU hash function */
4562 symlook_obj1_gnu(SymLook *req, const Obj_Entry *obj)
4564 Elf_Addr bloom_word;
4565 const Elf32_Word *hashval;
4567 Sym_Match_Result matchres;
4568 unsigned int h1, h2;
4569 unsigned long symnum;
4571 matchres.sym_out = NULL;
4572 matchres.vsymp = NULL;
4573 matchres.vcount = 0;
4575 /* Pick right bitmask word from Bloom filter array */
4576 bloom_word = obj->bloom_gnu[(req->hash_gnu / __ELF_WORD_SIZE) &
4577 obj->maskwords_bm_gnu];
4579 /* Calculate modulus word size of gnu hash and its derivative */
4580 h1 = req->hash_gnu & (__ELF_WORD_SIZE - 1);
4581 h2 = ((req->hash_gnu >> obj->shift2_gnu) & (__ELF_WORD_SIZE - 1));
4583 /* Filter out the "definitely not in set" queries */
4584 if (((bloom_word >> h1) & (bloom_word >> h2) & 1) == 0)
4587 /* Locate hash chain and corresponding value element*/
4588 bucket = obj->buckets_gnu[req->hash_gnu % obj->nbuckets_gnu];
4591 hashval = &obj->chain_zero_gnu[bucket];
4593 if (((*hashval ^ req->hash_gnu) >> 1) == 0) {
4594 symnum = hashval - obj->chain_zero_gnu;
4595 if (matched_symbol(req, obj, &matchres, symnum)) {
4596 req->sym_out = matchres.sym_out;
4597 req->defobj_out = obj;
4601 } while ((*hashval++ & 1) == 0);
4602 if (matchres.vcount == 1) {
4603 req->sym_out = matchres.vsymp;
4604 req->defobj_out = obj;
4611 trace_loaded_objects(Obj_Entry *obj)
4613 const char *fmt1, *fmt2, *fmt, *main_local, *list_containers;
4616 if ((main_local = getenv(_LD("TRACE_LOADED_OBJECTS_PROGNAME"))) == NULL)
4619 if ((fmt1 = getenv(_LD("TRACE_LOADED_OBJECTS_FMT1"))) == NULL)
4620 fmt1 = "\t%o => %p (%x)\n";
4622 if ((fmt2 = getenv(_LD("TRACE_LOADED_OBJECTS_FMT2"))) == NULL)
4623 fmt2 = "\t%o (%x)\n";
4625 list_containers = getenv(_LD("TRACE_LOADED_OBJECTS_ALL"));
4627 for (; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
4628 Needed_Entry *needed;
4629 const char *name, *path;
4634 if (list_containers && obj->needed != NULL)
4635 rtld_printf("%s:\n", obj->path);
4636 for (needed = obj->needed; needed; needed = needed->next) {
4637 if (needed->obj != NULL) {
4638 if (needed->obj->traced && !list_containers)
4640 needed->obj->traced = true;
4641 path = needed->obj->path;
4645 name = obj->strtab + needed->name;
4646 is_lib = strncmp(name, "lib", 3) == 0; /* XXX - bogus */
4648 fmt = is_lib ? fmt1 : fmt2;
4649 while ((c = *fmt++) != '\0') {
4675 rtld_putstr(main_local);
4678 rtld_putstr(obj_main->path);
4685 rtld_printf("%d", sodp->sod_major);
4688 rtld_printf("%d", sodp->sod_minor);
4695 rtld_printf("%p", needed->obj ? needed->obj->mapbase :
4708 * Unload a dlopened object and its dependencies from memory and from
4709 * our data structures. It is assumed that the DAG rooted in the
4710 * object has already been unreferenced, and that the object has a
4711 * reference count of 0.
4714 unload_object(Obj_Entry *root, RtldLockState *lockstate)
4716 Obj_Entry marker, *obj, *next;
4718 assert(root->refcount == 0);
4721 * Pass over the DAG removing unreferenced objects from
4722 * appropriate lists.
4724 unlink_object(root);
4726 /* Unmap all objects that are no longer referenced. */
4727 for (obj = TAILQ_FIRST(&obj_list); obj != NULL; obj = next) {
4728 next = TAILQ_NEXT(obj, next);
4729 if (obj->marker || obj->refcount != 0)
4731 LD_UTRACE(UTRACE_UNLOAD_OBJECT, obj, obj->mapbase,
4732 obj->mapsize, 0, obj->path);
4733 dbg("unloading \"%s\"", obj->path);
4735 * Unlink the object now to prevent new references from
4736 * being acquired while the bind lock is dropped in
4737 * recursive dlclose() invocations.
4739 TAILQ_REMOVE(&obj_list, obj, next);
4742 if (obj->filtees_loaded) {
4744 init_marker(&marker);
4745 TAILQ_INSERT_BEFORE(next, &marker, next);
4746 unload_filtees(obj, lockstate);
4747 next = TAILQ_NEXT(&marker, next);
4748 TAILQ_REMOVE(&obj_list, &marker, next);
4750 unload_filtees(obj, lockstate);
4752 release_object(obj);
4757 unlink_object(Obj_Entry *root)
4761 if (root->refcount == 0) {
4762 /* Remove the object from the RTLD_GLOBAL list. */
4763 objlist_remove(&list_global, root);
4765 /* Remove the object from all objects' DAG lists. */
4766 STAILQ_FOREACH(elm, &root->dagmembers, link) {
4767 objlist_remove(&elm->obj->dldags, root);
4768 if (elm->obj != root)
4769 unlink_object(elm->obj);
4775 ref_dag(Obj_Entry *root)
4779 assert(root->dag_inited);
4780 STAILQ_FOREACH(elm, &root->dagmembers, link)
4781 elm->obj->refcount++;
4785 unref_dag(Obj_Entry *root)
4789 assert(root->dag_inited);
4790 STAILQ_FOREACH(elm, &root->dagmembers, link)
4791 elm->obj->refcount--;
4795 * Common code for MD __tls_get_addr().
4797 static void *tls_get_addr_slow(Elf_Addr **, int, size_t) __noinline;
4799 tls_get_addr_slow(Elf_Addr **dtvp, int index, size_t offset)
4801 Elf_Addr *newdtv, *dtv;
4802 RtldLockState lockstate;
4806 /* Check dtv generation in case new modules have arrived */
4807 if (dtv[0] != tls_dtv_generation) {
4808 wlock_acquire(rtld_bind_lock, &lockstate);
4809 newdtv = xcalloc(tls_max_index + 2, sizeof(Elf_Addr));
4811 if (to_copy > tls_max_index)
4812 to_copy = tls_max_index;
4813 memcpy(&newdtv[2], &dtv[2], to_copy * sizeof(Elf_Addr));
4814 newdtv[0] = tls_dtv_generation;
4815 newdtv[1] = tls_max_index;
4817 lock_release(rtld_bind_lock, &lockstate);
4818 dtv = *dtvp = newdtv;
4821 /* Dynamically allocate module TLS if necessary */
4822 if (dtv[index + 1] == 0) {
4823 /* Signal safe, wlock will block out signals. */
4824 wlock_acquire(rtld_bind_lock, &lockstate);
4825 if (!dtv[index + 1])
4826 dtv[index + 1] = (Elf_Addr)allocate_module_tls(index);
4827 lock_release(rtld_bind_lock, &lockstate);
4829 return ((void *)(dtv[index + 1] + offset));
4833 tls_get_addr_common(Elf_Addr **dtvp, int index, size_t offset)
4838 /* Check dtv generation in case new modules have arrived */
4839 if (__predict_true(dtv[0] == tls_dtv_generation &&
4840 dtv[index + 1] != 0))
4841 return ((void *)(dtv[index + 1] + offset));
4842 return (tls_get_addr_slow(dtvp, index, offset));
4845 #if defined(__aarch64__) || defined(__arm__) || defined(__mips__) || \
4846 defined(__powerpc__) || defined(__riscv)
4849 * Return pointer to allocated TLS block
4852 get_tls_block_ptr(void *tcb, size_t tcbsize)
4854 size_t extra_size, post_size, pre_size, tls_block_size;
4855 size_t tls_init_align;
4857 tls_init_align = MAX(obj_main->tlsalign, 1);
4859 /* Compute fragments sizes. */
4860 extra_size = tcbsize - TLS_TCB_SIZE;
4861 post_size = calculate_tls_post_size(tls_init_align);
4862 tls_block_size = tcbsize + post_size;
4863 pre_size = roundup2(tls_block_size, tls_init_align) - tls_block_size;
4865 return ((char *)tcb - pre_size - extra_size);
4869 * Allocate Static TLS using the Variant I method.
4871 * For details on the layout, see lib/libc/gen/tls.c.
4873 * NB: rtld's tls_static_space variable includes TLS_TCB_SIZE and post_size as
4874 * it is based on tls_last_offset, and TLS offsets here are really TCB
4875 * offsets, whereas libc's tls_static_space is just the executable's static
4879 allocate_tls(Obj_Entry *objs, void *oldtcb, size_t tcbsize, size_t tcbalign)
4883 Elf_Addr *dtv, **tcb;
4886 size_t extra_size, maxalign, post_size, pre_size, tls_block_size;
4887 size_t tls_init_align, tls_init_offset;
4889 if (oldtcb != NULL && tcbsize == TLS_TCB_SIZE)
4892 assert(tcbsize >= TLS_TCB_SIZE);
4893 maxalign = MAX(tcbalign, tls_static_max_align);
4894 tls_init_align = MAX(obj_main->tlsalign, 1);
4896 /* Compute fragmets sizes. */
4897 extra_size = tcbsize - TLS_TCB_SIZE;
4898 post_size = calculate_tls_post_size(tls_init_align);
4899 tls_block_size = tcbsize + post_size;
4900 pre_size = roundup2(tls_block_size, tls_init_align) - tls_block_size;
4901 tls_block_size += pre_size + tls_static_space - TLS_TCB_SIZE - post_size;
4903 /* Allocate whole TLS block */
4904 tls_block = malloc_aligned(tls_block_size, maxalign, 0);
4905 tcb = (Elf_Addr **)(tls_block + pre_size + extra_size);
4907 if (oldtcb != NULL) {
4908 memcpy(tls_block, get_tls_block_ptr(oldtcb, tcbsize),
4910 free_aligned(get_tls_block_ptr(oldtcb, tcbsize));
4912 /* Adjust the DTV. */
4914 for (i = 0; i < dtv[1]; i++) {
4915 if (dtv[i+2] >= (Elf_Addr)oldtcb &&
4916 dtv[i+2] < (Elf_Addr)oldtcb + tls_static_space) {
4917 dtv[i+2] = dtv[i+2] - (Elf_Addr)oldtcb + (Elf_Addr)tcb;
4921 dtv = xcalloc(tls_max_index + 2, sizeof(Elf_Addr));
4923 dtv[0] = tls_dtv_generation;
4924 dtv[1] = tls_max_index;
4926 for (obj = globallist_curr(objs); obj != NULL;
4927 obj = globallist_next(obj)) {
4928 if (obj->tlsoffset == 0)
4930 tls_init_offset = obj->tlspoffset & (obj->tlsalign - 1);
4931 addr = (Elf_Addr)tcb + obj->tlsoffset;
4932 if (tls_init_offset > 0)
4933 memset((void *)addr, 0, tls_init_offset);
4934 if (obj->tlsinitsize > 0) {
4935 memcpy((void *)(addr + tls_init_offset), obj->tlsinit,
4938 if (obj->tlssize > obj->tlsinitsize) {
4939 memset((void *)(addr + tls_init_offset + obj->tlsinitsize),
4940 0, obj->tlssize - obj->tlsinitsize - tls_init_offset);
4942 dtv[obj->tlsindex + 1] = addr;
4950 free_tls(void *tcb, size_t tcbsize, size_t tcbalign __unused)
4953 Elf_Addr tlsstart, tlsend;
4955 size_t dtvsize, i, tls_init_align;
4957 assert(tcbsize >= TLS_TCB_SIZE);
4958 tls_init_align = MAX(obj_main->tlsalign, 1);
4960 /* Compute fragments sizes. */
4961 post_size = calculate_tls_post_size(tls_init_align);
4963 tlsstart = (Elf_Addr)tcb + TLS_TCB_SIZE + post_size;
4964 tlsend = (Elf_Addr)tcb + tls_static_space;
4966 dtv = *(Elf_Addr **)tcb;
4968 for (i = 0; i < dtvsize; i++) {
4969 if (dtv[i+2] && (dtv[i+2] < tlsstart || dtv[i+2] >= tlsend)) {
4970 free((void*)dtv[i+2]);
4974 free_aligned(get_tls_block_ptr(tcb, tcbsize));
4979 #if defined(__i386__) || defined(__amd64__)
4982 * Allocate Static TLS using the Variant II method.
4985 allocate_tls(Obj_Entry *objs, void *oldtls, size_t tcbsize, size_t tcbalign)
4988 size_t size, ralign;
4990 Elf_Addr *dtv, *olddtv;
4991 Elf_Addr segbase, oldsegbase, addr;
4995 if (tls_static_max_align > ralign)
4996 ralign = tls_static_max_align;
4997 size = roundup(tls_static_space, ralign) + roundup(tcbsize, ralign);
4999 assert(tcbsize >= 2*sizeof(Elf_Addr));
5000 tls = malloc_aligned(size, ralign, 0 /* XXX */);
5001 dtv = xcalloc(tls_max_index + 2, sizeof(Elf_Addr));
5003 segbase = (Elf_Addr)(tls + roundup(tls_static_space, ralign));
5004 ((Elf_Addr*)segbase)[0] = segbase;
5005 ((Elf_Addr*)segbase)[1] = (Elf_Addr) dtv;
5007 dtv[0] = tls_dtv_generation;
5008 dtv[1] = tls_max_index;
5012 * Copy the static TLS block over whole.
5014 oldsegbase = (Elf_Addr) oldtls;
5015 memcpy((void *)(segbase - tls_static_space),
5016 (const void *)(oldsegbase - tls_static_space),
5020 * If any dynamic TLS blocks have been created tls_get_addr(),
5023 olddtv = ((Elf_Addr**)oldsegbase)[1];
5024 for (i = 0; i < olddtv[1]; i++) {
5025 if (olddtv[i+2] < oldsegbase - size || olddtv[i+2] > oldsegbase) {
5026 dtv[i+2] = olddtv[i+2];
5032 * We assume that this block was the one we created with
5033 * allocate_initial_tls().
5035 free_tls(oldtls, 2*sizeof(Elf_Addr), sizeof(Elf_Addr));
5037 for (obj = objs; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
5038 if (obj->marker || obj->tlsoffset == 0)
5040 addr = segbase - obj->tlsoffset;
5041 memset((void*)(addr + obj->tlsinitsize),
5042 0, obj->tlssize - obj->tlsinitsize);
5044 memcpy((void*) addr, obj->tlsinit, obj->tlsinitsize);
5045 obj->static_tls_copied = true;
5047 dtv[obj->tlsindex + 1] = addr;
5051 return (void*) segbase;
5055 free_tls(void *tls, size_t tcbsize __unused, size_t tcbalign)
5058 size_t size, ralign;
5060 Elf_Addr tlsstart, tlsend;
5063 * Figure out the size of the initial TLS block so that we can
5064 * find stuff which ___tls_get_addr() allocated dynamically.
5067 if (tls_static_max_align > ralign)
5068 ralign = tls_static_max_align;
5069 size = roundup(tls_static_space, ralign);
5071 dtv = ((Elf_Addr**)tls)[1];
5073 tlsend = (Elf_Addr) tls;
5074 tlsstart = tlsend - size;
5075 for (i = 0; i < dtvsize; i++) {
5076 if (dtv[i + 2] != 0 && (dtv[i + 2] < tlsstart || dtv[i + 2] > tlsend)) {
5077 free_aligned((void *)dtv[i + 2]);
5081 free_aligned((void *)tlsstart);
5088 * Allocate TLS block for module with given index.
5091 allocate_module_tls(int index)
5096 TAILQ_FOREACH(obj, &obj_list, next) {
5099 if (obj->tlsindex == index)
5103 _rtld_error("Can't find module with TLS index %d", index);
5107 p = malloc_aligned(obj->tlssize, obj->tlsalign, obj->tlspoffset);
5108 memcpy(p, obj->tlsinit, obj->tlsinitsize);
5109 memset(p + obj->tlsinitsize, 0, obj->tlssize - obj->tlsinitsize);
5114 allocate_tls_offset(Obj_Entry *obj)
5121 if (obj->tlssize == 0) {
5122 obj->tls_done = true;
5126 if (tls_last_offset == 0)
5127 off = calculate_first_tls_offset(obj->tlssize, obj->tlsalign,
5130 off = calculate_tls_offset(tls_last_offset, tls_last_size,
5131 obj->tlssize, obj->tlsalign, obj->tlspoffset);
5134 * If we have already fixed the size of the static TLS block, we
5135 * must stay within that size. When allocating the static TLS, we
5136 * leave a small amount of space spare to be used for dynamically
5137 * loading modules which use static TLS.
5139 if (tls_static_space != 0) {
5140 if (calculate_tls_end(off, obj->tlssize) > tls_static_space)
5142 } else if (obj->tlsalign > tls_static_max_align) {
5143 tls_static_max_align = obj->tlsalign;
5146 tls_last_offset = obj->tlsoffset = off;
5147 tls_last_size = obj->tlssize;
5148 obj->tls_done = true;
5154 free_tls_offset(Obj_Entry *obj)
5158 * If we were the last thing to allocate out of the static TLS
5159 * block, we give our space back to the 'allocator'. This is a
5160 * simplistic workaround to allow libGL.so.1 to be loaded and
5161 * unloaded multiple times.
5163 if (calculate_tls_end(obj->tlsoffset, obj->tlssize)
5164 == calculate_tls_end(tls_last_offset, tls_last_size)) {
5165 tls_last_offset -= obj->tlssize;
5171 _rtld_allocate_tls(void *oldtls, size_t tcbsize, size_t tcbalign)
5174 RtldLockState lockstate;
5176 wlock_acquire(rtld_bind_lock, &lockstate);
5177 ret = allocate_tls(globallist_curr(TAILQ_FIRST(&obj_list)), oldtls,
5179 lock_release(rtld_bind_lock, &lockstate);
5184 _rtld_free_tls(void *tcb, size_t tcbsize, size_t tcbalign)
5186 RtldLockState lockstate;
5188 wlock_acquire(rtld_bind_lock, &lockstate);
5189 free_tls(tcb, tcbsize, tcbalign);
5190 lock_release(rtld_bind_lock, &lockstate);
5194 object_add_name(Obj_Entry *obj, const char *name)
5200 entry = malloc(sizeof(Name_Entry) + len);
5202 if (entry != NULL) {
5203 strcpy(entry->name, name);
5204 STAILQ_INSERT_TAIL(&obj->names, entry, link);
5209 object_match_name(const Obj_Entry *obj, const char *name)
5213 STAILQ_FOREACH(entry, &obj->names, link) {
5214 if (strcmp(name, entry->name) == 0)
5221 locate_dependency(const Obj_Entry *obj, const char *name)
5223 const Objlist_Entry *entry;
5224 const Needed_Entry *needed;
5226 STAILQ_FOREACH(entry, &list_main, link) {
5227 if (object_match_name(entry->obj, name))
5231 for (needed = obj->needed; needed != NULL; needed = needed->next) {
5232 if (strcmp(obj->strtab + needed->name, name) == 0 ||
5233 (needed->obj != NULL && object_match_name(needed->obj, name))) {
5235 * If there is DT_NEEDED for the name we are looking for,
5236 * we are all set. Note that object might not be found if
5237 * dependency was not loaded yet, so the function can
5238 * return NULL here. This is expected and handled
5239 * properly by the caller.
5241 return (needed->obj);
5244 _rtld_error("%s: Unexpected inconsistency: dependency %s not found",
5250 check_object_provided_version(Obj_Entry *refobj, const Obj_Entry *depobj,
5251 const Elf_Vernaux *vna)
5253 const Elf_Verdef *vd;
5254 const char *vername;
5256 vername = refobj->strtab + vna->vna_name;
5257 vd = depobj->verdef;
5259 _rtld_error("%s: version %s required by %s not defined",
5260 depobj->path, vername, refobj->path);
5264 if (vd->vd_version != VER_DEF_CURRENT) {
5265 _rtld_error("%s: Unsupported version %d of Elf_Verdef entry",
5266 depobj->path, vd->vd_version);
5269 if (vna->vna_hash == vd->vd_hash) {
5270 const Elf_Verdaux *aux = (const Elf_Verdaux *)
5271 ((const char *)vd + vd->vd_aux);
5272 if (strcmp(vername, depobj->strtab + aux->vda_name) == 0)
5275 if (vd->vd_next == 0)
5277 vd = (const Elf_Verdef *)((const char *)vd + vd->vd_next);
5279 if (vna->vna_flags & VER_FLG_WEAK)
5281 _rtld_error("%s: version %s required by %s not found",
5282 depobj->path, vername, refobj->path);
5287 rtld_verify_object_versions(Obj_Entry *obj)
5289 const Elf_Verneed *vn;
5290 const Elf_Verdef *vd;
5291 const Elf_Verdaux *vda;
5292 const Elf_Vernaux *vna;
5293 const Obj_Entry *depobj;
5294 int maxvernum, vernum;
5296 if (obj->ver_checked)
5298 obj->ver_checked = true;
5302 * Walk over defined and required version records and figure out
5303 * max index used by any of them. Do very basic sanity checking
5307 while (vn != NULL) {
5308 if (vn->vn_version != VER_NEED_CURRENT) {
5309 _rtld_error("%s: Unsupported version %d of Elf_Verneed entry",
5310 obj->path, vn->vn_version);
5313 vna = (const Elf_Vernaux *)((const char *)vn + vn->vn_aux);
5315 vernum = VER_NEED_IDX(vna->vna_other);
5316 if (vernum > maxvernum)
5318 if (vna->vna_next == 0)
5320 vna = (const Elf_Vernaux *)((const char *)vna + vna->vna_next);
5322 if (vn->vn_next == 0)
5324 vn = (const Elf_Verneed *)((const char *)vn + vn->vn_next);
5328 while (vd != NULL) {
5329 if (vd->vd_version != VER_DEF_CURRENT) {
5330 _rtld_error("%s: Unsupported version %d of Elf_Verdef entry",
5331 obj->path, vd->vd_version);
5334 vernum = VER_DEF_IDX(vd->vd_ndx);
5335 if (vernum > maxvernum)
5337 if (vd->vd_next == 0)
5339 vd = (const Elf_Verdef *)((const char *)vd + vd->vd_next);
5346 * Store version information in array indexable by version index.
5347 * Verify that object version requirements are satisfied along the
5350 obj->vernum = maxvernum + 1;
5351 obj->vertab = xcalloc(obj->vernum, sizeof(Ver_Entry));
5354 while (vd != NULL) {
5355 if ((vd->vd_flags & VER_FLG_BASE) == 0) {
5356 vernum = VER_DEF_IDX(vd->vd_ndx);
5357 assert(vernum <= maxvernum);
5358 vda = (const Elf_Verdaux *)((const char *)vd + vd->vd_aux);
5359 obj->vertab[vernum].hash = vd->vd_hash;
5360 obj->vertab[vernum].name = obj->strtab + vda->vda_name;
5361 obj->vertab[vernum].file = NULL;
5362 obj->vertab[vernum].flags = 0;
5364 if (vd->vd_next == 0)
5366 vd = (const Elf_Verdef *)((const char *)vd + vd->vd_next);
5370 while (vn != NULL) {
5371 depobj = locate_dependency(obj, obj->strtab + vn->vn_file);
5374 vna = (const Elf_Vernaux *)((const char *)vn + vn->vn_aux);
5376 if (check_object_provided_version(obj, depobj, vna))
5378 vernum = VER_NEED_IDX(vna->vna_other);
5379 assert(vernum <= maxvernum);
5380 obj->vertab[vernum].hash = vna->vna_hash;
5381 obj->vertab[vernum].name = obj->strtab + vna->vna_name;
5382 obj->vertab[vernum].file = obj->strtab + vn->vn_file;
5383 obj->vertab[vernum].flags = (vna->vna_other & VER_NEED_HIDDEN) ?
5384 VER_INFO_HIDDEN : 0;
5385 if (vna->vna_next == 0)
5387 vna = (const Elf_Vernaux *)((const char *)vna + vna->vna_next);
5389 if (vn->vn_next == 0)
5391 vn = (const Elf_Verneed *)((const char *)vn + vn->vn_next);
5397 rtld_verify_versions(const Objlist *objlist)
5399 Objlist_Entry *entry;
5403 STAILQ_FOREACH(entry, objlist, link) {
5405 * Skip dummy objects or objects that have their version requirements
5408 if (entry->obj->strtab == NULL || entry->obj->vertab != NULL)
5410 if (rtld_verify_object_versions(entry->obj) == -1) {
5412 if (ld_tracing == NULL)
5416 if (rc == 0 || ld_tracing != NULL)
5417 rc = rtld_verify_object_versions(&obj_rtld);
5422 fetch_ventry(const Obj_Entry *obj, unsigned long symnum)
5427 vernum = VER_NDX(obj->versyms[symnum]);
5428 if (vernum >= obj->vernum) {
5429 _rtld_error("%s: symbol %s has wrong verneed value %d",
5430 obj->path, obj->strtab + symnum, vernum);
5431 } else if (obj->vertab[vernum].hash != 0) {
5432 return &obj->vertab[vernum];
5439 _rtld_get_stack_prot(void)
5442 return (stack_prot);
5446 _rtld_is_dlopened(void *arg)
5449 RtldLockState lockstate;
5452 rlock_acquire(rtld_bind_lock, &lockstate);
5455 obj = obj_from_addr(arg);
5457 _rtld_error("No shared object contains address");
5458 lock_release(rtld_bind_lock, &lockstate);
5461 res = obj->dlopened ? 1 : 0;
5462 lock_release(rtld_bind_lock, &lockstate);
5467 obj_remap_relro(Obj_Entry *obj, int prot)
5470 if (obj->relro_size > 0 && mprotect(obj->relro_page, obj->relro_size,
5472 _rtld_error("%s: Cannot set relro protection to %#x: %s",
5473 obj->path, prot, rtld_strerror(errno));
5480 obj_disable_relro(Obj_Entry *obj)
5483 return (obj_remap_relro(obj, PROT_READ | PROT_WRITE));
5487 obj_enforce_relro(Obj_Entry *obj)
5490 return (obj_remap_relro(obj, PROT_READ));
5494 map_stacks_exec(RtldLockState *lockstate)
5496 void (*thr_map_stacks_exec)(void);
5498 if ((max_stack_flags & PF_X) == 0 || (stack_prot & PROT_EXEC) != 0)
5500 thr_map_stacks_exec = (void (*)(void))(uintptr_t)
5501 get_program_var_addr("__pthread_map_stacks_exec", lockstate);
5502 if (thr_map_stacks_exec != NULL) {
5503 stack_prot |= PROT_EXEC;
5504 thr_map_stacks_exec();
5509 distribute_static_tls(Objlist *list, RtldLockState *lockstate)
5513 void (*distrib)(size_t, void *, size_t, size_t);
5515 distrib = (void (*)(size_t, void *, size_t, size_t))(uintptr_t)
5516 get_program_var_addr("__pthread_distribute_static_tls", lockstate);
5517 if (distrib == NULL)
5519 STAILQ_FOREACH(elm, list, link) {
5521 if (obj->marker || !obj->tls_done || obj->static_tls_copied)
5523 distrib(obj->tlsoffset, obj->tlsinit, obj->tlsinitsize,
5525 obj->static_tls_copied = true;
5530 symlook_init(SymLook *dst, const char *name)
5533 bzero(dst, sizeof(*dst));
5535 dst->hash = elf_hash(name);
5536 dst->hash_gnu = gnu_hash(name);
5540 symlook_init_from_req(SymLook *dst, const SymLook *src)
5543 dst->name = src->name;
5544 dst->hash = src->hash;
5545 dst->hash_gnu = src->hash_gnu;
5546 dst->ventry = src->ventry;
5547 dst->flags = src->flags;
5548 dst->defobj_out = NULL;
5549 dst->sym_out = NULL;
5550 dst->lockstate = src->lockstate;
5554 open_binary_fd(const char *argv0, bool search_in_path,
5555 const char **binpath_res)
5557 char *binpath, *pathenv, *pe, *res1;
5563 if (search_in_path && strchr(argv0, '/') == NULL) {
5564 binpath = xmalloc(PATH_MAX);
5565 pathenv = getenv("PATH");
5566 if (pathenv == NULL) {
5567 _rtld_error("-p and no PATH environment variable");
5570 pathenv = strdup(pathenv);
5571 if (pathenv == NULL) {
5572 _rtld_error("Cannot allocate memory");
5577 while ((pe = strsep(&pathenv, ":")) != NULL) {
5578 if (strlcpy(binpath, pe, PATH_MAX) >= PATH_MAX)
5580 if (binpath[0] != '\0' &&
5581 strlcat(binpath, "/", PATH_MAX) >= PATH_MAX)
5583 if (strlcat(binpath, argv0, PATH_MAX) >= PATH_MAX)
5585 fd = open(binpath, O_RDONLY | O_CLOEXEC | O_VERIFY);
5586 if (fd != -1 || errno != ENOENT) {
5593 fd = open(argv0, O_RDONLY | O_CLOEXEC | O_VERIFY);
5598 _rtld_error("Cannot open %s: %s", argv0, rtld_strerror(errno));
5601 if (res != NULL && res[0] != '/') {
5602 res1 = xmalloc(PATH_MAX);
5603 if (realpath(res, res1) != NULL) {
5605 free(__DECONST(char *, res));
5616 * Parse a set of command-line arguments.
5619 parse_args(char* argv[], int argc, bool *use_pathp, int *fdp,
5625 int arglen, fd, i, j, mib[2];
5627 bool seen_b, seen_f;
5629 dbg("Parsing command-line arguments");
5632 seen_b = seen_f = false;
5634 for (i = 1; i < argc; i++ ) {
5636 dbg("argv[%d]: '%s'", i, arg);
5639 * rtld arguments end with an explicit "--" or with the first
5640 * non-prefixed argument.
5642 if (strcmp(arg, "--") == 0) {
5650 * All other arguments are single-character options that can
5651 * be combined, so we need to search through `arg` for them.
5653 arglen = strlen(arg);
5654 for (j = 1; j < arglen; j++) {
5657 print_usage(argv[0]);
5659 } else if (opt == 'b') {
5661 _rtld_error("Both -b and -f specified");
5668 } else if (opt == 'f') {
5670 _rtld_error("Both -b and -f specified");
5675 * -f XX can be used to specify a
5676 * descriptor for the binary named at
5677 * the command line (i.e., the later
5678 * argument will specify the process
5679 * name but the descriptor is what
5680 * will actually be executed).
5682 * -f must be the last option in, e.g., -abcf.
5684 if (j != arglen - 1) {
5685 _rtld_error("Invalid options: %s", arg);
5689 fd = parse_integer(argv[i]);
5692 "Invalid file descriptor: '%s'",
5699 } else if (opt == 'p') {
5701 } else if (opt == 'v') {
5704 mib[1] = HW_MACHINE;
5705 sz = sizeof(machine);
5706 sysctl(mib, nitems(mib), machine, &sz, NULL, 0);
5708 "FreeBSD ld-elf.so.1 %s\n"
5709 "FreeBSD_version %d\n"
5710 "Default lib path %s\n"
5715 __FreeBSD_version, ld_standard_library_path,
5716 ld_env_prefix, ld_elf_hints_default,
5717 ld_path_libmap_conf);
5720 _rtld_error("Invalid argument: '%s'", arg);
5721 print_usage(argv[0]);
5733 * Parse a file descriptor number without pulling in more of libc (e.g. atoi).
5736 parse_integer(const char *str)
5738 static const int RADIX = 10; /* XXXJA: possibly support hex? */
5745 for (c = *str; c != '\0'; c = *++str) {
5746 if (c < '0' || c > '9')
5753 /* Make sure we actually parsed something. */
5760 print_usage(const char *argv0)
5764 "Usage: %s [-h] [-b <exe>] [-f <FD>] [-p] [--] <binary> [<args>]\n"
5767 " -h Display this help message\n"
5768 " -b <exe> Execute <exe> instead of <binary>, arg0 is <binary>\n"
5769 " -f <FD> Execute <FD> instead of searching for <binary>\n"
5770 " -p Search in PATH for named binary\n"
5771 " -v Display identification information\n"
5772 " -- End of RTLD options\n"
5773 " <binary> Name of process to execute\n"
5774 " <args> Arguments to the executed process\n", argv0);
5778 * Overrides for libc_pic-provided functions.
5782 __getosreldate(void)
5792 oid[1] = KERN_OSRELDATE;
5794 len = sizeof(osrel);
5795 error = sysctl(oid, 2, &osrel, &len, NULL, 0);
5796 if (error == 0 && osrel > 0 && len == sizeof(osrel))
5801 rtld_strerror(int errnum)
5804 if (errnum < 0 || errnum >= sys_nerr)
5805 return ("Unknown error");
5806 return (sys_errlist[errnum]);
5811 malloc(size_t nbytes)
5814 return (__crt_malloc(nbytes));
5818 calloc(size_t num, size_t size)
5821 return (__crt_calloc(num, size));
5832 realloc(void *cp, size_t nbytes)
5835 return (__crt_realloc(cp, nbytes));
5838 extern int _rtld_version__FreeBSD_version __exported;
5839 int _rtld_version__FreeBSD_version = __FreeBSD_version;
5841 extern char _rtld_version_laddr_offset __exported;
5842 char _rtld_version_laddr_offset;