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);
90 * Function declarations.
92 static const char *basename(const char *);
93 static void digest_dynamic1(Obj_Entry *, int, const Elf_Dyn **,
94 const Elf_Dyn **, const Elf_Dyn **);
95 static bool digest_dynamic2(Obj_Entry *, const Elf_Dyn *, const Elf_Dyn *,
97 static bool digest_dynamic(Obj_Entry *, int);
98 static Obj_Entry *digest_phdr(const Elf_Phdr *, int, caddr_t, const char *);
99 static void distribute_static_tls(Objlist *, RtldLockState *);
100 static Obj_Entry *dlcheck(void *);
101 static int dlclose_locked(void *, RtldLockState *);
102 static Obj_Entry *dlopen_object(const char *name, int fd, Obj_Entry *refobj,
103 int lo_flags, int mode, RtldLockState *lockstate);
104 static Obj_Entry *do_load_object(int, const char *, char *, struct stat *, int);
105 static int do_search_info(const Obj_Entry *obj, int, struct dl_serinfo *);
106 static bool donelist_check(DoneList *, const Obj_Entry *);
107 static void errmsg_restore(struct dlerror_save *);
108 static struct dlerror_save *errmsg_save(void);
109 static void *fill_search_info(const char *, size_t, void *);
110 static char *find_library(const char *, const Obj_Entry *, int *);
111 static const char *gethints(bool);
112 static void hold_object(Obj_Entry *);
113 static void unhold_object(Obj_Entry *);
114 static void init_dag(Obj_Entry *);
115 static void init_marker(Obj_Entry *);
116 static void init_pagesizes(Elf_Auxinfo **aux_info);
117 static void init_rtld(caddr_t, Elf_Auxinfo **);
118 static void initlist_add_neededs(Needed_Entry *, Objlist *);
119 static void initlist_add_objects(Obj_Entry *, Obj_Entry *, Objlist *);
120 static int initlist_objects_ifunc(Objlist *, bool, int, RtldLockState *);
121 static void linkmap_add(Obj_Entry *);
122 static void linkmap_delete(Obj_Entry *);
123 static void load_filtees(Obj_Entry *, int flags, RtldLockState *);
124 static void unload_filtees(Obj_Entry *, RtldLockState *);
125 static int load_needed_objects(Obj_Entry *, int);
126 static int load_preload_objects(char *, bool);
127 static Obj_Entry *load_object(const char *, int fd, const Obj_Entry *, int);
128 static void map_stacks_exec(RtldLockState *);
129 static int obj_disable_relro(Obj_Entry *);
130 static int obj_enforce_relro(Obj_Entry *);
131 static void objlist_call_fini(Objlist *, Obj_Entry *, RtldLockState *);
132 static void objlist_call_init(Objlist *, RtldLockState *);
133 static void objlist_clear(Objlist *);
134 static Objlist_Entry *objlist_find(Objlist *, const Obj_Entry *);
135 static void objlist_init(Objlist *);
136 static void objlist_push_head(Objlist *, Obj_Entry *);
137 static void objlist_push_tail(Objlist *, Obj_Entry *);
138 static void objlist_put_after(Objlist *, Obj_Entry *, Obj_Entry *);
139 static void objlist_remove(Objlist *, Obj_Entry *);
140 static int open_binary_fd(const char *argv0, bool search_in_path,
141 const char **binpath_res);
142 static int parse_args(char* argv[], int argc, bool *use_pathp, int *fdp,
144 static int parse_integer(const char *);
145 static void *path_enumerate(const char *, path_enum_proc, const char *, void *);
146 static void print_usage(const char *argv0);
147 static void release_object(Obj_Entry *);
148 static int relocate_object_dag(Obj_Entry *root, bool bind_now,
149 Obj_Entry *rtldobj, int flags, RtldLockState *lockstate);
150 static int relocate_object(Obj_Entry *obj, bool bind_now, Obj_Entry *rtldobj,
151 int flags, RtldLockState *lockstate);
152 static int relocate_objects(Obj_Entry *, bool, Obj_Entry *, int,
154 static int resolve_object_ifunc(Obj_Entry *, bool, int, RtldLockState *);
155 static int rtld_dirname(const char *, char *);
156 static int rtld_dirname_abs(const char *, char *);
157 static void *rtld_dlopen(const char *name, int fd, int mode);
158 static void rtld_exit(void);
159 static void rtld_nop_exit(void);
160 static char *search_library_path(const char *, const char *, const char *,
162 static char *search_library_pathfds(const char *, const char *, int *);
163 static const void **get_program_var_addr(const char *, RtldLockState *);
164 static void set_program_var(const char *, const void *);
165 static int symlook_default(SymLook *, const Obj_Entry *refobj);
166 static int symlook_global(SymLook *, DoneList *);
167 static void symlook_init_from_req(SymLook *, const SymLook *);
168 static int symlook_list(SymLook *, const Objlist *, DoneList *);
169 static int symlook_needed(SymLook *, const Needed_Entry *, DoneList *);
170 static int symlook_obj1_sysv(SymLook *, const Obj_Entry *);
171 static int symlook_obj1_gnu(SymLook *, const Obj_Entry *);
172 static void *tls_get_addr_slow(Elf_Addr **, int, size_t, bool) __noinline;
173 static void trace_loaded_objects(Obj_Entry *);
174 static void unlink_object(Obj_Entry *);
175 static void unload_object(Obj_Entry *, RtldLockState *lockstate);
176 static void unref_dag(Obj_Entry *);
177 static void ref_dag(Obj_Entry *);
178 static char *origin_subst_one(Obj_Entry *, char *, const char *,
180 static char *origin_subst(Obj_Entry *, const char *);
181 static bool obj_resolve_origin(Obj_Entry *obj);
182 static void preinit_main(void);
183 static int rtld_verify_versions(const Objlist *);
184 static int rtld_verify_object_versions(Obj_Entry *);
185 static void object_add_name(Obj_Entry *, const char *);
186 static int object_match_name(const Obj_Entry *, const char *);
187 static void ld_utrace_log(int, void *, void *, size_t, int, const char *);
188 static void rtld_fill_dl_phdr_info(const Obj_Entry *obj,
189 struct dl_phdr_info *phdr_info);
190 static uint32_t gnu_hash(const char *);
191 static bool matched_symbol(SymLook *, const Obj_Entry *, Sym_Match_Result *,
192 const unsigned long);
194 void r_debug_state(struct r_debug *, struct link_map *) __noinline __exported;
195 void _r_debug_postinit(struct link_map *) __noinline __exported;
197 int __sys_openat(int, const char *, int, ...);
202 struct r_debug r_debug __exported; /* for GDB; */
203 static bool libmap_disable; /* Disable libmap */
204 static bool ld_loadfltr; /* Immediate filters processing */
205 static char *libmap_override; /* Maps to use in addition to libmap.conf */
206 static bool trust; /* False for setuid and setgid programs */
207 static bool dangerous_ld_env; /* True if environment variables have been
208 used to affect the libraries loaded */
209 bool ld_bind_not; /* Disable PLT update */
210 static char *ld_bind_now; /* Environment variable for immediate binding */
211 static char *ld_debug; /* Environment variable for debugging */
212 static char *ld_library_path; /* Environment variable for search path */
213 static char *ld_library_dirs; /* Environment variable for library descriptors */
214 static char *ld_preload; /* Environment variable for libraries to
216 static char *ld_preload_fds; /* Environment variable for libraries represented by
218 static const char *ld_elf_hints_path; /* Environment variable for alternative hints path */
219 static const char *ld_tracing; /* Called from ldd to print libs */
220 static char *ld_utrace; /* Use utrace() to log events. */
221 static struct obj_entry_q obj_list; /* Queue of all loaded objects */
222 static Obj_Entry *obj_main; /* The main program shared object */
223 static Obj_Entry obj_rtld; /* The dynamic linker shared object */
224 static unsigned int obj_count; /* Number of objects in obj_list */
225 static unsigned int obj_loads; /* Number of loads of objects (gen count) */
227 static Objlist list_global = /* Objects dlopened with RTLD_GLOBAL */
228 STAILQ_HEAD_INITIALIZER(list_global);
229 static Objlist list_main = /* Objects loaded at program startup */
230 STAILQ_HEAD_INITIALIZER(list_main);
231 static Objlist list_fini = /* Objects needing fini() calls */
232 STAILQ_HEAD_INITIALIZER(list_fini);
234 Elf_Sym sym_zero; /* For resolving undefined weak refs. */
236 #define GDB_STATE(s,m) r_debug.r_state = s; r_debug_state(&r_debug,m);
238 extern Elf_Dyn _DYNAMIC;
239 #pragma weak _DYNAMIC
241 int dlclose(void *) __exported;
242 char *dlerror(void) __exported;
243 void *dlopen(const char *, int) __exported;
244 void *fdlopen(int, int) __exported;
245 void *dlsym(void *, const char *) __exported;
246 dlfunc_t dlfunc(void *, const char *) __exported;
247 void *dlvsym(void *, const char *, const char *) __exported;
248 int dladdr(const void *, Dl_info *) __exported;
249 void dllockinit(void *, void *(*)(void *), void (*)(void *), void (*)(void *),
250 void (*)(void *), void (*)(void *), void (*)(void *)) __exported;
251 int dlinfo(void *, int , void *) __exported;
252 int dl_iterate_phdr(__dl_iterate_hdr_callback, void *) __exported;
253 int _rtld_addr_phdr(const void *, struct dl_phdr_info *) __exported;
254 int _rtld_get_stack_prot(void) __exported;
255 int _rtld_is_dlopened(void *) __exported;
256 void _rtld_error(const char *, ...) __exported;
258 /* Only here to fix -Wmissing-prototypes warnings */
259 int __getosreldate(void);
260 func_ptr_type _rtld(Elf_Addr *sp, func_ptr_type *exit_proc, Obj_Entry **objp);
261 Elf_Addr _rtld_bind(Obj_Entry *obj, Elf_Size reloff);
265 static int osreldate;
268 static int stack_prot = PROT_READ | PROT_WRITE | RTLD_DEFAULT_STACK_EXEC;
269 static int max_stack_flags;
272 * Global declarations normally provided by crt1. The dynamic linker is
273 * not built with crt1, so we have to provide them ourselves.
279 * Used to pass argc, argv to init functions.
285 * Globals to control TLS allocation.
287 size_t tls_last_offset; /* Static TLS offset of last module */
288 size_t tls_last_size; /* Static TLS size of last module */
289 size_t tls_static_space; /* Static TLS space allocated */
290 static size_t tls_static_max_align;
291 Elf_Addr tls_dtv_generation = 1; /* Used to detect when dtv size changes */
292 int tls_max_index = 1; /* Largest module index allocated */
294 static bool ld_library_path_rpath = false;
295 bool ld_fast_sigblock = false;
298 * Globals for path names, and such
300 const char *ld_elf_hints_default = _PATH_ELF_HINTS;
301 const char *ld_path_libmap_conf = _PATH_LIBMAP_CONF;
302 const char *ld_path_rtld = _PATH_RTLD;
303 const char *ld_standard_library_path = STANDARD_LIBRARY_PATH;
304 const char *ld_env_prefix = LD_;
306 static void (*rtld_exit_ptr)(void);
309 * Fill in a DoneList with an allocation large enough to hold all of
310 * the currently-loaded objects. Keep this as a macro since it calls
311 * alloca and we want that to occur within the scope of the caller.
313 #define donelist_init(dlp) \
314 ((dlp)->objs = alloca(obj_count * sizeof (dlp)->objs[0]), \
315 assert((dlp)->objs != NULL), \
316 (dlp)->num_alloc = obj_count, \
319 #define LD_UTRACE(e, h, mb, ms, r, n) do { \
320 if (ld_utrace != NULL) \
321 ld_utrace_log(e, h, mb, ms, r, n); \
325 ld_utrace_log(int event, void *handle, void *mapbase, size_t mapsize,
326 int refcnt, const char *name)
328 struct utrace_rtld ut;
329 static const char rtld_utrace_sig[RTLD_UTRACE_SIG_SZ] = RTLD_UTRACE_SIG;
331 memcpy(ut.sig, rtld_utrace_sig, sizeof(ut.sig));
334 ut.mapbase = mapbase;
335 ut.mapsize = mapsize;
337 bzero(ut.name, sizeof(ut.name));
339 strlcpy(ut.name, name, sizeof(ut.name));
340 utrace(&ut, sizeof(ut));
343 #ifdef RTLD_VARIANT_ENV_NAMES
345 * construct the env variable based on the type of binary that's
348 static inline const char *
351 static char buffer[128];
353 strlcpy(buffer, ld_env_prefix, sizeof(buffer));
354 strlcat(buffer, var, sizeof(buffer));
362 * Main entry point for dynamic linking. The first argument is the
363 * stack pointer. The stack is expected to be laid out as described
364 * in the SVR4 ABI specification, Intel 386 Processor Supplement.
365 * Specifically, the stack pointer points to a word containing
366 * ARGC. Following that in the stack is a null-terminated sequence
367 * of pointers to argument strings. Then comes a null-terminated
368 * sequence of pointers to environment strings. Finally, there is a
369 * sequence of "auxiliary vector" entries.
371 * The second argument points to a place to store the dynamic linker's
372 * exit procedure pointer and the third to a place to store the main
375 * The return value is the main program's entry point.
378 _rtld(Elf_Addr *sp, func_ptr_type *exit_proc, Obj_Entry **objp)
380 Elf_Auxinfo *aux, *auxp, *auxpf, *aux_info[AT_COUNT];
381 Objlist_Entry *entry;
382 Obj_Entry *last_interposer, *obj, *preload_tail;
383 const Elf_Phdr *phdr;
385 RtldLockState lockstate;
388 char **argv, **env, **envp, *kexecpath, *library_path_rpath;
389 const char *argv0, *binpath;
391 char buf[MAXPATHLEN];
392 int argc, fd, i, mib[4], old_osrel, osrel, phnum, rtld_argc;
395 int old_auxv_format = 1;
397 bool dir_enable, direct_exec, explicit_fd, search_in_path;
400 * On entry, the dynamic linker itself has not been relocated yet.
401 * Be very careful not to reference any global data until after
402 * init_rtld has returned. It is OK to reference file-scope statics
403 * and string constants, and to call static and global functions.
406 /* Find the auxiliary vector on the stack. */
410 sp += argc + 1; /* Skip over arguments and NULL terminator */
412 while (*sp++ != 0) /* Skip over environment, and NULL terminator */
414 aux = (Elf_Auxinfo *) sp;
416 /* Digest the auxiliary vector. */
417 for (i = 0; i < AT_COUNT; i++)
419 for (auxp = aux; auxp->a_type != AT_NULL; auxp++) {
420 if (auxp->a_type < AT_COUNT)
421 aux_info[auxp->a_type] = auxp;
423 if (auxp->a_type == 23) /* AT_STACKPROT */
429 if (old_auxv_format) {
430 /* Remap from old-style auxv numbers. */
431 aux_info[23] = aux_info[21]; /* AT_STACKPROT */
432 aux_info[21] = aux_info[19]; /* AT_PAGESIZESLEN */
433 aux_info[19] = aux_info[17]; /* AT_NCPUS */
434 aux_info[17] = aux_info[15]; /* AT_CANARYLEN */
435 aux_info[15] = aux_info[13]; /* AT_EXECPATH */
436 aux_info[13] = NULL; /* AT_GID */
438 aux_info[20] = aux_info[18]; /* AT_PAGESIZES */
439 aux_info[18] = aux_info[16]; /* AT_OSRELDATE */
440 aux_info[16] = aux_info[14]; /* AT_CANARY */
441 aux_info[14] = NULL; /* AT_EGID */
445 /* Initialize and relocate ourselves. */
446 assert(aux_info[AT_BASE] != NULL);
447 init_rtld((caddr_t) aux_info[AT_BASE]->a_un.a_ptr, aux_info);
451 __progname = obj_rtld.path;
452 argv0 = argv[0] != NULL ? argv[0] : "(null)";
457 if (aux_info[AT_BSDFLAGS] != NULL &&
458 (aux_info[AT_BSDFLAGS]->a_un.a_val & ELF_BSDF_SIGFASTBLK) != 0)
459 ld_fast_sigblock = true;
461 trust = !issetugid();
464 md_abi_variant_hook(aux_info);
467 if (aux_info[AT_EXECFD] != NULL) {
468 fd = aux_info[AT_EXECFD]->a_un.a_val;
470 assert(aux_info[AT_PHDR] != NULL);
471 phdr = (const Elf_Phdr *)aux_info[AT_PHDR]->a_un.a_ptr;
472 if (phdr == obj_rtld.phdr) {
474 _rtld_error("Tainted process refusing to run binary %s",
480 dbg("opening main program in direct exec mode");
482 rtld_argc = parse_args(argv, argc, &search_in_path, &fd, &argv0);
483 explicit_fd = (fd != -1);
486 fd = open_binary_fd(argv0, search_in_path, &binpath);
487 if (fstat(fd, &st) == -1) {
488 _rtld_error("Failed to fstat FD %d (%s): %s", fd,
489 explicit_fd ? "user-provided descriptor" : argv0,
490 rtld_strerror(errno));
495 * Rough emulation of the permission checks done by
496 * execve(2), only Unix DACs are checked, ACLs are
497 * ignored. Preserve the semantic of disabling owner
498 * to execute if owner x bit is cleared, even if
499 * others x bit is enabled.
500 * mmap(2) does not allow to mmap with PROT_EXEC if
501 * binary' file comes from noexec mount. We cannot
502 * set a text reference on the binary.
505 if (st.st_uid == geteuid()) {
506 if ((st.st_mode & S_IXUSR) != 0)
508 } else if (st.st_gid == getegid()) {
509 if ((st.st_mode & S_IXGRP) != 0)
511 } else if ((st.st_mode & S_IXOTH) != 0) {
515 _rtld_error("No execute permission for binary %s",
521 * For direct exec mode, argv[0] is the interpreter
522 * name, we must remove it and shift arguments left
523 * before invoking binary main. Since stack layout
524 * places environment pointers and aux vectors right
525 * after the terminating NULL, we must shift
526 * environment and aux as well.
528 main_argc = argc - rtld_argc;
529 for (i = 0; i <= main_argc; i++)
530 argv[i] = argv[i + rtld_argc];
532 environ = env = envp = argv + main_argc + 1;
533 dbg("move env from %p to %p", envp + rtld_argc, envp);
535 *envp = *(envp + rtld_argc);
536 } while (*envp++ != NULL);
537 aux = auxp = (Elf_Auxinfo *)envp;
538 auxpf = (Elf_Auxinfo *)(envp + rtld_argc);
539 dbg("move aux from %p to %p", auxpf, aux);
540 /* XXXKIB insert place for AT_EXECPATH if not present */
541 for (;; auxp++, auxpf++) {
543 if (auxp->a_type == AT_NULL)
546 /* Since the auxiliary vector has moved, redigest it. */
547 for (i = 0; i < AT_COUNT; i++)
549 for (auxp = aux; auxp->a_type != AT_NULL; auxp++) {
550 if (auxp->a_type < AT_COUNT)
551 aux_info[auxp->a_type] = auxp;
554 /* Point AT_EXECPATH auxv and aux_info to the binary path. */
555 if (binpath == NULL) {
556 aux_info[AT_EXECPATH] = NULL;
558 if (aux_info[AT_EXECPATH] == NULL) {
559 aux_info[AT_EXECPATH] = xmalloc(sizeof(Elf_Auxinfo));
560 aux_info[AT_EXECPATH]->a_type = AT_EXECPATH;
562 aux_info[AT_EXECPATH]->a_un.a_ptr = __DECONST(void *,
566 _rtld_error("No binary");
572 ld_bind_now = getenv(_LD("BIND_NOW"));
575 * If the process is tainted, then we un-set the dangerous environment
576 * variables. The process will be marked as tainted until setuid(2)
577 * is called. If any child process calls setuid(2) we do not want any
578 * future processes to honor the potentially un-safe variables.
581 if (unsetenv(_LD("PRELOAD")) || unsetenv(_LD("LIBMAP")) ||
582 unsetenv(_LD("LIBRARY_PATH")) || unsetenv(_LD("LIBRARY_PATH_FDS")) ||
583 unsetenv(_LD("LIBMAP_DISABLE")) || unsetenv(_LD("BIND_NOT")) ||
584 unsetenv(_LD("DEBUG")) || unsetenv(_LD("ELF_HINTS_PATH")) ||
585 unsetenv(_LD("LOADFLTR")) || unsetenv(_LD("LIBRARY_PATH_RPATH")) ||
586 unsetenv(_LD("PRELOAD_FDS"))) {
587 _rtld_error("environment corrupt; aborting");
591 ld_debug = getenv(_LD("DEBUG"));
592 if (ld_bind_now == NULL)
593 ld_bind_not = getenv(_LD("BIND_NOT")) != NULL;
594 libmap_disable = getenv(_LD("LIBMAP_DISABLE")) != NULL;
595 libmap_override = getenv(_LD("LIBMAP"));
596 ld_library_path = getenv(_LD("LIBRARY_PATH"));
597 ld_library_dirs = getenv(_LD("LIBRARY_PATH_FDS"));
598 ld_preload = getenv(_LD("PRELOAD"));
599 ld_preload_fds = getenv(_LD("PRELOAD_FDS"));
600 ld_elf_hints_path = getenv(_LD("ELF_HINTS_PATH"));
601 ld_loadfltr = getenv(_LD("LOADFLTR")) != NULL;
602 library_path_rpath = getenv(_LD("LIBRARY_PATH_RPATH"));
603 if (library_path_rpath != NULL) {
604 if (library_path_rpath[0] == 'y' ||
605 library_path_rpath[0] == 'Y' ||
606 library_path_rpath[0] == '1')
607 ld_library_path_rpath = true;
609 ld_library_path_rpath = false;
611 dangerous_ld_env = libmap_disable || (libmap_override != NULL) ||
612 (ld_library_path != NULL) || (ld_preload != NULL) ||
613 (ld_elf_hints_path != NULL) || ld_loadfltr;
614 ld_tracing = getenv(_LD("TRACE_LOADED_OBJECTS"));
615 ld_utrace = getenv(_LD("UTRACE"));
617 if ((ld_elf_hints_path == NULL) || strlen(ld_elf_hints_path) == 0)
618 ld_elf_hints_path = ld_elf_hints_default;
620 if (ld_debug != NULL && *ld_debug != '\0')
622 dbg("%s is initialized, base address = %p", __progname,
623 (caddr_t) aux_info[AT_BASE]->a_un.a_ptr);
624 dbg("RTLD dynamic = %p", obj_rtld.dynamic);
625 dbg("RTLD pltgot = %p", obj_rtld.pltgot);
627 dbg("initializing thread locks");
631 * Load the main program, or process its program header if it is
634 if (fd != -1) { /* Load the main program. */
635 dbg("loading main program");
636 obj_main = map_object(fd, argv0, NULL);
638 if (obj_main == NULL)
640 max_stack_flags = obj_main->stack_flags;
641 } else { /* Main program already loaded. */
642 dbg("processing main program's program header");
643 assert(aux_info[AT_PHDR] != NULL);
644 phdr = (const Elf_Phdr *) aux_info[AT_PHDR]->a_un.a_ptr;
645 assert(aux_info[AT_PHNUM] != NULL);
646 phnum = aux_info[AT_PHNUM]->a_un.a_val;
647 assert(aux_info[AT_PHENT] != NULL);
648 assert(aux_info[AT_PHENT]->a_un.a_val == sizeof(Elf_Phdr));
649 assert(aux_info[AT_ENTRY] != NULL);
650 imgentry = (caddr_t) aux_info[AT_ENTRY]->a_un.a_ptr;
651 if ((obj_main = digest_phdr(phdr, phnum, imgentry, argv0)) == NULL)
655 if (aux_info[AT_EXECPATH] != NULL && fd == -1) {
656 kexecpath = aux_info[AT_EXECPATH]->a_un.a_ptr;
657 dbg("AT_EXECPATH %p %s", kexecpath, kexecpath);
658 if (kexecpath[0] == '/')
659 obj_main->path = kexecpath;
660 else if (getcwd(buf, sizeof(buf)) == NULL ||
661 strlcat(buf, "/", sizeof(buf)) >= sizeof(buf) ||
662 strlcat(buf, kexecpath, sizeof(buf)) >= sizeof(buf))
663 obj_main->path = xstrdup(argv0);
665 obj_main->path = xstrdup(buf);
667 dbg("No AT_EXECPATH or direct exec");
668 obj_main->path = xstrdup(argv0);
670 dbg("obj_main path %s", obj_main->path);
671 obj_main->mainprog = true;
673 if (aux_info[AT_STACKPROT] != NULL &&
674 aux_info[AT_STACKPROT]->a_un.a_val != 0)
675 stack_prot = aux_info[AT_STACKPROT]->a_un.a_val;
679 * Get the actual dynamic linker pathname from the executable if
680 * possible. (It should always be possible.) That ensures that
681 * gdb will find the right dynamic linker even if a non-standard
684 if (obj_main->interp != NULL &&
685 strcmp(obj_main->interp, obj_rtld.path) != 0) {
687 obj_rtld.path = xstrdup(obj_main->interp);
688 __progname = obj_rtld.path;
692 if (!digest_dynamic(obj_main, 0))
694 dbg("%s valid_hash_sysv %d valid_hash_gnu %d dynsymcount %d",
695 obj_main->path, obj_main->valid_hash_sysv, obj_main->valid_hash_gnu,
696 obj_main->dynsymcount);
698 linkmap_add(obj_main);
699 linkmap_add(&obj_rtld);
701 /* Link the main program into the list of objects. */
702 TAILQ_INSERT_HEAD(&obj_list, obj_main, next);
706 /* Initialize a fake symbol for resolving undefined weak references. */
707 sym_zero.st_info = ELF_ST_INFO(STB_GLOBAL, STT_NOTYPE);
708 sym_zero.st_shndx = SHN_UNDEF;
709 sym_zero.st_value = -(uintptr_t)obj_main->relocbase;
712 libmap_disable = (bool)lm_init(libmap_override);
714 dbg("loading LD_PRELOAD_FDS libraries");
715 if (load_preload_objects(ld_preload_fds, true) == -1)
718 dbg("loading LD_PRELOAD libraries");
719 if (load_preload_objects(ld_preload, false) == -1)
721 preload_tail = globallist_curr(TAILQ_LAST(&obj_list, obj_entry_q));
723 dbg("loading needed objects");
724 if (load_needed_objects(obj_main, ld_tracing != NULL ? RTLD_LO_TRACE :
728 /* Make a list of all objects loaded at startup. */
729 last_interposer = obj_main;
730 TAILQ_FOREACH(obj, &obj_list, next) {
733 if (obj->z_interpose && obj != obj_main) {
734 objlist_put_after(&list_main, last_interposer, obj);
735 last_interposer = obj;
737 objlist_push_tail(&list_main, obj);
742 dbg("checking for required versions");
743 if (rtld_verify_versions(&list_main) == -1 && !ld_tracing)
746 if (ld_tracing) { /* We're done */
747 trace_loaded_objects(obj_main);
751 if (getenv(_LD("DUMP_REL_PRE")) != NULL) {
752 dump_relocations(obj_main);
757 * Processing tls relocations requires having the tls offsets
758 * initialized. Prepare offsets before starting initial
759 * relocation processing.
761 dbg("initializing initial thread local storage offsets");
762 STAILQ_FOREACH(entry, &list_main, link) {
764 * Allocate all the initial objects out of the static TLS
765 * block even if they didn't ask for it.
767 allocate_tls_offset(entry->obj);
770 if (relocate_objects(obj_main,
771 ld_bind_now != NULL && *ld_bind_now != '\0',
772 &obj_rtld, SYMLOOK_EARLY, NULL) == -1)
775 dbg("doing copy relocations");
776 if (do_copy_relocations(obj_main) == -1)
779 if (getenv(_LD("DUMP_REL_POST")) != NULL) {
780 dump_relocations(obj_main);
787 * Setup TLS for main thread. This must be done after the
788 * relocations are processed, since tls initialization section
789 * might be the subject for relocations.
791 dbg("initializing initial thread local storage");
792 allocate_initial_tls(globallist_curr(TAILQ_FIRST(&obj_list)));
794 dbg("initializing key program variables");
795 set_program_var("__progname", argv[0] != NULL ? basename(argv[0]) : "");
796 set_program_var("environ", env);
797 set_program_var("__elf_aux_vector", aux);
799 /* Make a list of init functions to call. */
800 objlist_init(&initlist);
801 initlist_add_objects(globallist_curr(TAILQ_FIRST(&obj_list)),
802 preload_tail, &initlist);
804 r_debug_state(NULL, &obj_main->linkmap); /* say hello to gdb! */
806 map_stacks_exec(NULL);
808 if (!obj_main->crt_no_init) {
810 * Make sure we don't call the main program's init and fini
811 * functions for binaries linked with old crt1 which calls
814 obj_main->init = obj_main->fini = (Elf_Addr)NULL;
815 obj_main->preinit_array = obj_main->init_array =
816 obj_main->fini_array = (Elf_Addr)NULL;
820 /* Set osrel for direct-execed binary */
823 mib[2] = KERN_PROC_OSREL;
825 osrel = obj_main->osrel;
826 sz = sizeof(old_osrel);
827 dbg("setting osrel to %d", osrel);
828 (void)sysctl(mib, 4, &old_osrel, &sz, &osrel, sizeof(osrel));
831 wlock_acquire(rtld_bind_lock, &lockstate);
833 dbg("resolving ifuncs");
834 if (initlist_objects_ifunc(&initlist, ld_bind_now != NULL &&
835 *ld_bind_now != '\0', SYMLOOK_EARLY, &lockstate) == -1)
838 rtld_exit_ptr = rtld_exit;
839 if (obj_main->crt_no_init)
841 objlist_call_init(&initlist, &lockstate);
842 _r_debug_postinit(&obj_main->linkmap);
843 objlist_clear(&initlist);
844 dbg("loading filtees");
845 TAILQ_FOREACH(obj, &obj_list, next) {
848 if (ld_loadfltr || obj->z_loadfltr)
849 load_filtees(obj, 0, &lockstate);
852 dbg("enforcing main obj relro");
853 if (obj_enforce_relro(obj_main) == -1)
856 lock_release(rtld_bind_lock, &lockstate);
858 dbg("transferring control to program entry point = %p", obj_main->entry);
860 /* Return the exit procedure and the program entry point. */
861 *exit_proc = rtld_exit_ptr;
863 return (func_ptr_type) obj_main->entry;
867 rtld_resolve_ifunc(const Obj_Entry *obj, const Elf_Sym *def)
872 ptr = (void *)make_function_pointer(def, obj);
873 target = call_ifunc_resolver(ptr);
874 return ((void *)target);
878 * NB: MIPS uses a private version of this function (_mips_rtld_bind).
879 * Changes to this function should be applied there as well.
882 _rtld_bind(Obj_Entry *obj, Elf_Size reloff)
886 const Obj_Entry *defobj;
889 RtldLockState lockstate;
891 rlock_acquire(rtld_bind_lock, &lockstate);
892 if (sigsetjmp(lockstate.env, 0) != 0)
893 lock_upgrade(rtld_bind_lock, &lockstate);
895 rel = (const Elf_Rel *)((const char *)obj->pltrel + reloff);
897 rel = (const Elf_Rel *)((const char *)obj->pltrela + reloff);
899 where = (Elf_Addr *)(obj->relocbase + rel->r_offset);
900 def = find_symdef(ELF_R_SYM(rel->r_info), obj, &defobj, SYMLOOK_IN_PLT,
904 if (ELF_ST_TYPE(def->st_info) == STT_GNU_IFUNC)
905 target = (Elf_Addr)rtld_resolve_ifunc(defobj, def);
907 target = (Elf_Addr)(defobj->relocbase + def->st_value);
909 dbg("\"%s\" in \"%s\" ==> %p in \"%s\"",
910 defobj->strtab + def->st_name,
911 obj->path == NULL ? NULL : basename(obj->path),
913 defobj->path == NULL ? NULL : basename(defobj->path));
916 * Write the new contents for the jmpslot. Note that depending on
917 * architecture, the value which we need to return back to the
918 * lazy binding trampoline may or may not be the target
919 * address. The value returned from reloc_jmpslot() is the value
920 * that the trampoline needs.
922 target = reloc_jmpslot(where, target, defobj, obj, rel);
923 lock_release(rtld_bind_lock, &lockstate);
928 * Error reporting function. Use it like printf. If formats the message
929 * into a buffer, and sets things up so that the next call to dlerror()
930 * will return the message.
933 _rtld_error(const char *fmt, ...)
938 rtld_vsnprintf(lockinfo.dlerror_loc(), lockinfo.dlerror_loc_sz,
941 *lockinfo.dlerror_seen() = 0;
942 LD_UTRACE(UTRACE_RTLD_ERROR, NULL, NULL, 0, 0, lockinfo.dlerror_loc());
946 * Return a dynamically-allocated copy of the current error message, if any.
948 static struct dlerror_save *
951 struct dlerror_save *res;
953 res = xmalloc(sizeof(*res));
954 res->seen = *lockinfo.dlerror_seen();
956 res->msg = xstrdup(lockinfo.dlerror_loc());
961 * Restore the current error message from a copy which was previously saved
962 * by errmsg_save(). The copy is freed.
965 errmsg_restore(struct dlerror_save *saved_msg)
967 if (saved_msg == NULL || saved_msg->seen == 1) {
968 *lockinfo.dlerror_seen() = 1;
970 *lockinfo.dlerror_seen() = 0;
971 strlcpy(lockinfo.dlerror_loc(), saved_msg->msg,
972 lockinfo.dlerror_loc_sz);
973 free(saved_msg->msg);
979 basename(const char *name)
981 const char *p = strrchr(name, '/');
982 return p != NULL ? p + 1 : name;
985 static struct utsname uts;
988 origin_subst_one(Obj_Entry *obj, char *real, const char *kw,
989 const char *subst, bool may_free)
991 char *p, *p1, *res, *resp;
992 int subst_len, kw_len, subst_count, old_len, new_len;
997 * First, count the number of the keyword occurrences, to
998 * preallocate the final string.
1000 for (p = real, subst_count = 0;; p = p1 + kw_len, subst_count++) {
1007 * If the keyword is not found, just return.
1009 * Return non-substituted string if resolution failed. We
1010 * cannot do anything more reasonable, the failure mode of the
1011 * caller is unresolved library anyway.
1013 if (subst_count == 0 || (obj != NULL && !obj_resolve_origin(obj)))
1014 return (may_free ? real : xstrdup(real));
1016 subst = obj->origin_path;
1019 * There is indeed something to substitute. Calculate the
1020 * length of the resulting string, and allocate it.
1022 subst_len = strlen(subst);
1023 old_len = strlen(real);
1024 new_len = old_len + (subst_len - kw_len) * subst_count;
1025 res = xmalloc(new_len + 1);
1028 * Now, execute the substitution loop.
1030 for (p = real, resp = res, *resp = '\0';;) {
1033 /* Copy the prefix before keyword. */
1034 memcpy(resp, p, p1 - p);
1036 /* Keyword replacement. */
1037 memcpy(resp, subst, subst_len);
1045 /* Copy to the end of string and finish. */
1053 origin_subst(Obj_Entry *obj, const char *real)
1055 char *res1, *res2, *res3, *res4;
1057 if (obj == NULL || !trust)
1058 return (xstrdup(real));
1059 if (uts.sysname[0] == '\0') {
1060 if (uname(&uts) != 0) {
1061 _rtld_error("utsname failed: %d", errno);
1065 /* __DECONST is safe here since without may_free real is unchanged */
1066 res1 = origin_subst_one(obj, __DECONST(char *, real), "$ORIGIN", NULL,
1068 res2 = origin_subst_one(NULL, res1, "$OSNAME", uts.sysname, true);
1069 res3 = origin_subst_one(NULL, res2, "$OSREL", uts.release, true);
1070 res4 = origin_subst_one(NULL, res3, "$PLATFORM", uts.machine, true);
1077 const char *msg = dlerror();
1080 msg = "Fatal error";
1081 rtld_fdputstr(STDERR_FILENO, _BASENAME_RTLD ": ");
1082 rtld_fdputstr(STDERR_FILENO, msg);
1083 rtld_fdputchar(STDERR_FILENO, '\n');
1088 * Process a shared object's DYNAMIC section, and save the important
1089 * information in its Obj_Entry structure.
1092 digest_dynamic1(Obj_Entry *obj, int early, const Elf_Dyn **dyn_rpath,
1093 const Elf_Dyn **dyn_soname, const Elf_Dyn **dyn_runpath)
1095 const Elf_Dyn *dynp;
1096 Needed_Entry **needed_tail = &obj->needed;
1097 Needed_Entry **needed_filtees_tail = &obj->needed_filtees;
1098 Needed_Entry **needed_aux_filtees_tail = &obj->needed_aux_filtees;
1099 const Elf_Hashelt *hashtab;
1100 const Elf32_Word *hashval;
1101 Elf32_Word bkt, nmaskwords;
1103 int plttype = DT_REL;
1107 *dyn_runpath = NULL;
1109 obj->bind_now = false;
1110 dynp = obj->dynamic;
1113 for (; dynp->d_tag != DT_NULL; dynp++) {
1114 switch (dynp->d_tag) {
1117 obj->rel = (const Elf_Rel *)(obj->relocbase + dynp->d_un.d_ptr);
1121 obj->relsize = dynp->d_un.d_val;
1125 assert(dynp->d_un.d_val == sizeof(Elf_Rel));
1129 obj->pltrel = (const Elf_Rel *)
1130 (obj->relocbase + dynp->d_un.d_ptr);
1134 obj->pltrelsize = dynp->d_un.d_val;
1138 obj->rela = (const Elf_Rela *)(obj->relocbase + dynp->d_un.d_ptr);
1142 obj->relasize = dynp->d_un.d_val;
1146 assert(dynp->d_un.d_val == sizeof(Elf_Rela));
1150 plttype = dynp->d_un.d_val;
1151 assert(dynp->d_un.d_val == DT_REL || plttype == DT_RELA);
1155 obj->symtab = (const Elf_Sym *)
1156 (obj->relocbase + dynp->d_un.d_ptr);
1160 assert(dynp->d_un.d_val == sizeof(Elf_Sym));
1164 obj->strtab = (const char *)(obj->relocbase + dynp->d_un.d_ptr);
1168 obj->strsize = dynp->d_un.d_val;
1172 obj->verneed = (const Elf_Verneed *)(obj->relocbase +
1177 obj->verneednum = dynp->d_un.d_val;
1181 obj->verdef = (const Elf_Verdef *)(obj->relocbase +
1186 obj->verdefnum = dynp->d_un.d_val;
1190 obj->versyms = (const Elf_Versym *)(obj->relocbase +
1196 hashtab = (const Elf_Hashelt *)(obj->relocbase +
1198 obj->nbuckets = hashtab[0];
1199 obj->nchains = hashtab[1];
1200 obj->buckets = hashtab + 2;
1201 obj->chains = obj->buckets + obj->nbuckets;
1202 obj->valid_hash_sysv = obj->nbuckets > 0 && obj->nchains > 0 &&
1203 obj->buckets != NULL;
1209 hashtab = (const Elf_Hashelt *)(obj->relocbase +
1211 obj->nbuckets_gnu = hashtab[0];
1212 obj->symndx_gnu = hashtab[1];
1213 nmaskwords = hashtab[2];
1214 bloom_size32 = (__ELF_WORD_SIZE / 32) * nmaskwords;
1215 obj->maskwords_bm_gnu = nmaskwords - 1;
1216 obj->shift2_gnu = hashtab[3];
1217 obj->bloom_gnu = (const Elf_Addr *)(hashtab + 4);
1218 obj->buckets_gnu = hashtab + 4 + bloom_size32;
1219 obj->chain_zero_gnu = obj->buckets_gnu + obj->nbuckets_gnu -
1221 /* Number of bitmask words is required to be power of 2 */
1222 obj->valid_hash_gnu = powerof2(nmaskwords) &&
1223 obj->nbuckets_gnu > 0 && obj->buckets_gnu != NULL;
1229 Needed_Entry *nep = NEW(Needed_Entry);
1230 nep->name = dynp->d_un.d_val;
1235 needed_tail = &nep->next;
1241 Needed_Entry *nep = NEW(Needed_Entry);
1242 nep->name = dynp->d_un.d_val;
1246 *needed_filtees_tail = nep;
1247 needed_filtees_tail = &nep->next;
1249 if (obj->linkmap.l_refname == NULL)
1250 obj->linkmap.l_refname = (char *)dynp->d_un.d_val;
1256 Needed_Entry *nep = NEW(Needed_Entry);
1257 nep->name = dynp->d_un.d_val;
1261 *needed_aux_filtees_tail = nep;
1262 needed_aux_filtees_tail = &nep->next;
1267 obj->pltgot = (Elf_Addr *)(obj->relocbase + dynp->d_un.d_ptr);
1271 obj->textrel = true;
1275 obj->symbolic = true;
1280 * We have to wait until later to process this, because we
1281 * might not have gotten the address of the string table yet.
1291 *dyn_runpath = dynp;
1295 obj->init = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1298 case DT_PREINIT_ARRAY:
1299 obj->preinit_array = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1302 case DT_PREINIT_ARRAYSZ:
1303 obj->preinit_array_num = dynp->d_un.d_val / sizeof(Elf_Addr);
1307 obj->init_array = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1310 case DT_INIT_ARRAYSZ:
1311 obj->init_array_num = dynp->d_un.d_val / sizeof(Elf_Addr);
1315 obj->fini = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1319 obj->fini_array = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1322 case DT_FINI_ARRAYSZ:
1323 obj->fini_array_num = dynp->d_un.d_val / sizeof(Elf_Addr);
1327 * Don't process DT_DEBUG on MIPS as the dynamic section
1328 * is mapped read-only. DT_MIPS_RLD_MAP is used instead.
1334 dbg("Filling in DT_DEBUG entry");
1335 (__DECONST(Elf_Dyn *, dynp))->d_un.d_ptr = (Elf_Addr)&r_debug;
1340 if (dynp->d_un.d_val & DF_ORIGIN)
1341 obj->z_origin = true;
1342 if (dynp->d_un.d_val & DF_SYMBOLIC)
1343 obj->symbolic = true;
1344 if (dynp->d_un.d_val & DF_TEXTREL)
1345 obj->textrel = true;
1346 if (dynp->d_un.d_val & DF_BIND_NOW)
1347 obj->bind_now = true;
1348 if (dynp->d_un.d_val & DF_STATIC_TLS)
1349 obj->static_tls = true;
1352 case DT_MIPS_LOCAL_GOTNO:
1353 obj->local_gotno = dynp->d_un.d_val;
1356 case DT_MIPS_SYMTABNO:
1357 obj->symtabno = dynp->d_un.d_val;
1360 case DT_MIPS_GOTSYM:
1361 obj->gotsym = dynp->d_un.d_val;
1364 case DT_MIPS_RLD_MAP:
1365 *((Elf_Addr *)(dynp->d_un.d_ptr)) = (Elf_Addr) &r_debug;
1368 case DT_MIPS_RLD_MAP_REL:
1369 // The MIPS_RLD_MAP_REL tag stores the offset to the .rld_map
1370 // section relative to the address of the tag itself.
1371 *((Elf_Addr *)(__DECONST(char*, dynp) + dynp->d_un.d_val)) =
1372 (Elf_Addr) &r_debug;
1375 case DT_MIPS_PLTGOT:
1376 obj->mips_pltgot = (Elf_Addr *)(obj->relocbase +
1383 #ifdef __powerpc64__
1384 case DT_PPC64_GLINK:
1385 obj->glink = (Elf_Addr)(obj->relocbase + dynp->d_un.d_ptr);
1389 obj->gotptr = (Elf_Addr *)(obj->relocbase + dynp->d_un.d_ptr);
1395 if (dynp->d_un.d_val & DF_1_NOOPEN)
1396 obj->z_noopen = true;
1397 if (dynp->d_un.d_val & DF_1_ORIGIN)
1398 obj->z_origin = true;
1399 if (dynp->d_un.d_val & DF_1_GLOBAL)
1400 obj->z_global = true;
1401 if (dynp->d_un.d_val & DF_1_BIND_NOW)
1402 obj->bind_now = true;
1403 if (dynp->d_un.d_val & DF_1_NODELETE)
1404 obj->z_nodelete = true;
1405 if (dynp->d_un.d_val & DF_1_LOADFLTR)
1406 obj->z_loadfltr = true;
1407 if (dynp->d_un.d_val & DF_1_INTERPOSE)
1408 obj->z_interpose = true;
1409 if (dynp->d_un.d_val & DF_1_NODEFLIB)
1410 obj->z_nodeflib = true;
1411 if (dynp->d_un.d_val & DF_1_PIE)
1417 dbg("Ignoring d_tag %ld = %#lx", (long)dynp->d_tag,
1424 obj->traced = false;
1426 if (plttype == DT_RELA) {
1427 obj->pltrela = (const Elf_Rela *) obj->pltrel;
1429 obj->pltrelasize = obj->pltrelsize;
1430 obj->pltrelsize = 0;
1433 /* Determine size of dynsym table (equal to nchains of sysv hash) */
1434 if (obj->valid_hash_sysv)
1435 obj->dynsymcount = obj->nchains;
1436 else if (obj->valid_hash_gnu) {
1437 obj->dynsymcount = 0;
1438 for (bkt = 0; bkt < obj->nbuckets_gnu; bkt++) {
1439 if (obj->buckets_gnu[bkt] == 0)
1441 hashval = &obj->chain_zero_gnu[obj->buckets_gnu[bkt]];
1444 while ((*hashval++ & 1u) == 0);
1446 obj->dynsymcount += obj->symndx_gnu;
1449 if (obj->linkmap.l_refname != NULL)
1450 obj->linkmap.l_refname = obj->strtab + (unsigned long)obj->
1455 obj_resolve_origin(Obj_Entry *obj)
1458 if (obj->origin_path != NULL)
1460 obj->origin_path = xmalloc(PATH_MAX);
1461 return (rtld_dirname_abs(obj->path, obj->origin_path) != -1);
1465 digest_dynamic2(Obj_Entry *obj, const Elf_Dyn *dyn_rpath,
1466 const Elf_Dyn *dyn_soname, const Elf_Dyn *dyn_runpath)
1469 if (obj->z_origin && !obj_resolve_origin(obj))
1472 if (dyn_runpath != NULL) {
1473 obj->runpath = (const char *)obj->strtab + dyn_runpath->d_un.d_val;
1474 obj->runpath = origin_subst(obj, obj->runpath);
1475 } else if (dyn_rpath != NULL) {
1476 obj->rpath = (const char *)obj->strtab + dyn_rpath->d_un.d_val;
1477 obj->rpath = origin_subst(obj, obj->rpath);
1479 if (dyn_soname != NULL)
1480 object_add_name(obj, obj->strtab + dyn_soname->d_un.d_val);
1485 digest_dynamic(Obj_Entry *obj, int early)
1487 const Elf_Dyn *dyn_rpath;
1488 const Elf_Dyn *dyn_soname;
1489 const Elf_Dyn *dyn_runpath;
1491 digest_dynamic1(obj, early, &dyn_rpath, &dyn_soname, &dyn_runpath);
1492 return (digest_dynamic2(obj, dyn_rpath, dyn_soname, dyn_runpath));
1496 * Process a shared object's program header. This is used only for the
1497 * main program, when the kernel has already loaded the main program
1498 * into memory before calling the dynamic linker. It creates and
1499 * returns an Obj_Entry structure.
1502 digest_phdr(const Elf_Phdr *phdr, int phnum, caddr_t entry, const char *path)
1505 const Elf_Phdr *phlimit = phdr + phnum;
1507 Elf_Addr note_start, note_end;
1511 for (ph = phdr; ph < phlimit; ph++) {
1512 if (ph->p_type != PT_PHDR)
1516 obj->phsize = ph->p_memsz;
1517 obj->relocbase = __DECONST(char *, phdr) - ph->p_vaddr;
1521 obj->stack_flags = PF_X | PF_R | PF_W;
1523 for (ph = phdr; ph < phlimit; ph++) {
1524 switch (ph->p_type) {
1527 obj->interp = (const char *)(ph->p_vaddr + obj->relocbase);
1531 if (nsegs == 0) { /* First load segment */
1532 obj->vaddrbase = trunc_page(ph->p_vaddr);
1533 obj->mapbase = obj->vaddrbase + obj->relocbase;
1534 } else { /* Last load segment */
1535 obj->mapsize = round_page(ph->p_vaddr + ph->p_memsz) -
1542 obj->dynamic = (const Elf_Dyn *)(ph->p_vaddr + obj->relocbase);
1547 obj->tlssize = ph->p_memsz;
1548 obj->tlsalign = ph->p_align;
1549 obj->tlsinitsize = ph->p_filesz;
1550 obj->tlsinit = (void*)(ph->p_vaddr + obj->relocbase);
1551 obj->tlspoffset = ph->p_offset;
1555 obj->stack_flags = ph->p_flags;
1559 obj->relro_page = obj->relocbase + trunc_page(ph->p_vaddr);
1560 obj->relro_size = round_page(ph->p_memsz);
1564 note_start = (Elf_Addr)obj->relocbase + ph->p_vaddr;
1565 note_end = note_start + ph->p_filesz;
1566 digest_notes(obj, note_start, note_end);
1571 _rtld_error("%s: too few PT_LOAD segments", path);
1580 digest_notes(Obj_Entry *obj, Elf_Addr note_start, Elf_Addr note_end)
1582 const Elf_Note *note;
1583 const char *note_name;
1586 for (note = (const Elf_Note *)note_start; (Elf_Addr)note < note_end;
1587 note = (const Elf_Note *)((const char *)(note + 1) +
1588 roundup2(note->n_namesz, sizeof(Elf32_Addr)) +
1589 roundup2(note->n_descsz, sizeof(Elf32_Addr)))) {
1590 if (note->n_namesz != sizeof(NOTE_FREEBSD_VENDOR) ||
1591 note->n_descsz != sizeof(int32_t))
1593 if (note->n_type != NT_FREEBSD_ABI_TAG &&
1594 note->n_type != NT_FREEBSD_FEATURE_CTL &&
1595 note->n_type != NT_FREEBSD_NOINIT_TAG)
1597 note_name = (const char *)(note + 1);
1598 if (strncmp(NOTE_FREEBSD_VENDOR, note_name,
1599 sizeof(NOTE_FREEBSD_VENDOR)) != 0)
1601 switch (note->n_type) {
1602 case NT_FREEBSD_ABI_TAG:
1603 /* FreeBSD osrel note */
1604 p = (uintptr_t)(note + 1);
1605 p += roundup2(note->n_namesz, sizeof(Elf32_Addr));
1606 obj->osrel = *(const int32_t *)(p);
1607 dbg("note osrel %d", obj->osrel);
1609 case NT_FREEBSD_FEATURE_CTL:
1610 /* FreeBSD ABI feature control note */
1611 p = (uintptr_t)(note + 1);
1612 p += roundup2(note->n_namesz, sizeof(Elf32_Addr));
1613 obj->fctl0 = *(const uint32_t *)(p);
1614 dbg("note fctl0 %#x", obj->fctl0);
1616 case NT_FREEBSD_NOINIT_TAG:
1617 /* FreeBSD 'crt does not call init' note */
1618 obj->crt_no_init = true;
1619 dbg("note crt_no_init");
1626 dlcheck(void *handle)
1630 TAILQ_FOREACH(obj, &obj_list, next) {
1631 if (obj == (Obj_Entry *) handle)
1635 if (obj == NULL || obj->refcount == 0 || obj->dl_refcount == 0) {
1636 _rtld_error("Invalid shared object handle %p", handle);
1643 * If the given object is already in the donelist, return true. Otherwise
1644 * add the object to the list and return false.
1647 donelist_check(DoneList *dlp, const Obj_Entry *obj)
1651 for (i = 0; i < dlp->num_used; i++)
1652 if (dlp->objs[i] == obj)
1655 * Our donelist allocation should always be sufficient. But if
1656 * our threads locking isn't working properly, more shared objects
1657 * could have been loaded since we allocated the list. That should
1658 * never happen, but we'll handle it properly just in case it does.
1660 if (dlp->num_used < dlp->num_alloc)
1661 dlp->objs[dlp->num_used++] = obj;
1666 * Hash function for symbol table lookup. Don't even think about changing
1667 * this. It is specified by the System V ABI.
1670 elf_hash(const char *name)
1672 const unsigned char *p = (const unsigned char *) name;
1673 unsigned long h = 0;
1676 while (*p != '\0') {
1677 h = (h << 4) + *p++;
1678 if ((g = h & 0xf0000000) != 0)
1686 * The GNU hash function is the Daniel J. Bernstein hash clipped to 32 bits
1687 * unsigned in case it's implemented with a wider type.
1690 gnu_hash(const char *s)
1696 for (c = *s; c != '\0'; c = *++s)
1698 return (h & 0xffffffff);
1703 * Find the library with the given name, and return its full pathname.
1704 * The returned string is dynamically allocated. Generates an error
1705 * message and returns NULL if the library cannot be found.
1707 * If the second argument is non-NULL, then it refers to an already-
1708 * loaded shared object, whose library search path will be searched.
1710 * If a library is successfully located via LD_LIBRARY_PATH_FDS, its
1711 * descriptor (which is close-on-exec) will be passed out via the third
1714 * The search order is:
1715 * DT_RPATH in the referencing file _unless_ DT_RUNPATH is present (1)
1716 * DT_RPATH of the main object if DSO without defined DT_RUNPATH (1)
1718 * DT_RUNPATH in the referencing file
1719 * ldconfig hints (if -z nodefaultlib, filter out default library directories
1721 * /lib:/usr/lib _unless_ the referencing file is linked with -z nodefaultlib
1723 * (1) Handled in digest_dynamic2 - rpath left NULL if runpath defined.
1726 find_library(const char *xname, const Obj_Entry *refobj, int *fdp)
1728 char *pathname, *refobj_path;
1730 bool nodeflib, objgiven;
1732 objgiven = refobj != NULL;
1734 if (libmap_disable || !objgiven ||
1735 (name = lm_find(refobj->path, xname)) == NULL)
1738 if (strchr(name, '/') != NULL) { /* Hard coded pathname */
1739 if (name[0] != '/' && !trust) {
1740 _rtld_error("Absolute pathname required "
1741 "for shared object \"%s\"", name);
1744 return (origin_subst(__DECONST(Obj_Entry *, refobj),
1745 __DECONST(char *, name)));
1748 dbg(" Searching for \"%s\"", name);
1749 refobj_path = objgiven ? refobj->path : NULL;
1752 * If refobj->rpath != NULL, then refobj->runpath is NULL. Fall
1753 * back to pre-conforming behaviour if user requested so with
1754 * LD_LIBRARY_PATH_RPATH environment variable and ignore -z
1757 if (objgiven && refobj->rpath != NULL && ld_library_path_rpath) {
1758 pathname = search_library_path(name, ld_library_path,
1760 if (pathname != NULL)
1762 if (refobj != NULL) {
1763 pathname = search_library_path(name, refobj->rpath,
1765 if (pathname != NULL)
1768 pathname = search_library_pathfds(name, ld_library_dirs, fdp);
1769 if (pathname != NULL)
1771 pathname = search_library_path(name, gethints(false),
1773 if (pathname != NULL)
1775 pathname = search_library_path(name, ld_standard_library_path,
1777 if (pathname != NULL)
1780 nodeflib = objgiven ? refobj->z_nodeflib : false;
1782 pathname = search_library_path(name, refobj->rpath,
1784 if (pathname != NULL)
1787 if (objgiven && refobj->runpath == NULL && refobj != obj_main) {
1788 pathname = search_library_path(name, obj_main->rpath,
1790 if (pathname != NULL)
1793 pathname = search_library_path(name, ld_library_path,
1795 if (pathname != NULL)
1798 pathname = search_library_path(name, refobj->runpath,
1800 if (pathname != NULL)
1803 pathname = search_library_pathfds(name, ld_library_dirs, fdp);
1804 if (pathname != NULL)
1806 pathname = search_library_path(name, gethints(nodeflib),
1808 if (pathname != NULL)
1810 if (objgiven && !nodeflib) {
1811 pathname = search_library_path(name,
1812 ld_standard_library_path, refobj_path, fdp);
1813 if (pathname != NULL)
1818 if (objgiven && refobj->path != NULL) {
1819 _rtld_error("Shared object \"%s\" not found, "
1820 "required by \"%s\"", name, basename(refobj->path));
1822 _rtld_error("Shared object \"%s\" not found", name);
1828 * Given a symbol number in a referencing object, find the corresponding
1829 * definition of the symbol. Returns a pointer to the symbol, or NULL if
1830 * no definition was found. Returns a pointer to the Obj_Entry of the
1831 * defining object via the reference parameter DEFOBJ_OUT.
1834 find_symdef(unsigned long symnum, const Obj_Entry *refobj,
1835 const Obj_Entry **defobj_out, int flags, SymCache *cache,
1836 RtldLockState *lockstate)
1840 const Obj_Entry *defobj;
1841 const Ver_Entry *ve;
1847 * If we have already found this symbol, get the information from
1850 if (symnum >= refobj->dynsymcount)
1851 return NULL; /* Bad object */
1852 if (cache != NULL && cache[symnum].sym != NULL) {
1853 *defobj_out = cache[symnum].obj;
1854 return cache[symnum].sym;
1857 ref = refobj->symtab + symnum;
1858 name = refobj->strtab + ref->st_name;
1864 * We don't have to do a full scale lookup if the symbol is local.
1865 * We know it will bind to the instance in this load module; to
1866 * which we already have a pointer (ie ref). By not doing a lookup,
1867 * we not only improve performance, but it also avoids unresolvable
1868 * symbols when local symbols are not in the hash table. This has
1869 * been seen with the ia64 toolchain.
1871 if (ELF_ST_BIND(ref->st_info) != STB_LOCAL) {
1872 if (ELF_ST_TYPE(ref->st_info) == STT_SECTION) {
1873 _rtld_error("%s: Bogus symbol table entry %lu", refobj->path,
1876 symlook_init(&req, name);
1878 ve = req.ventry = fetch_ventry(refobj, symnum);
1879 req.lockstate = lockstate;
1880 res = symlook_default(&req, refobj);
1883 defobj = req.defobj_out;
1891 * If we found no definition and the reference is weak, treat the
1892 * symbol as having the value zero.
1894 if (def == NULL && ELF_ST_BIND(ref->st_info) == STB_WEAK) {
1900 *defobj_out = defobj;
1901 /* Record the information in the cache to avoid subsequent lookups. */
1902 if (cache != NULL) {
1903 cache[symnum].sym = def;
1904 cache[symnum].obj = defobj;
1907 if (refobj != &obj_rtld)
1908 _rtld_error("%s: Undefined symbol \"%s%s%s\"", refobj->path, name,
1909 ve != NULL ? "@" : "", ve != NULL ? ve->name : "");
1915 * Return the search path from the ldconfig hints file, reading it if
1916 * necessary. If nostdlib is true, then the default search paths are
1917 * not added to result.
1919 * Returns NULL if there are problems with the hints file,
1920 * or if the search path there is empty.
1923 gethints(bool nostdlib)
1925 static char *filtered_path;
1926 static const char *hints;
1927 static struct elfhints_hdr hdr;
1928 struct fill_search_info_args sargs, hargs;
1929 struct dl_serinfo smeta, hmeta, *SLPinfo, *hintinfo;
1930 struct dl_serpath *SLPpath, *hintpath;
1932 struct stat hint_stat;
1933 unsigned int SLPndx, hintndx, fndx, fcount;
1939 /* First call, read the hints file */
1940 if (hints == NULL) {
1941 /* Keep from trying again in case the hints file is bad. */
1944 if ((fd = open(ld_elf_hints_path, O_RDONLY | O_CLOEXEC)) == -1)
1948 * Check of hdr.dirlistlen value against type limit
1949 * intends to pacify static analyzers. Further
1950 * paranoia leads to checks that dirlist is fully
1951 * contained in the file range.
1953 if (read(fd, &hdr, sizeof hdr) != sizeof hdr ||
1954 hdr.magic != ELFHINTS_MAGIC ||
1955 hdr.version != 1 || hdr.dirlistlen > UINT_MAX / 2 ||
1956 fstat(fd, &hint_stat) == -1) {
1963 if (dl + hdr.dirlist < dl)
1966 if (dl + hdr.dirlistlen < dl)
1968 dl += hdr.dirlistlen;
1969 if (dl > hint_stat.st_size)
1971 p = xmalloc(hdr.dirlistlen + 1);
1972 if (pread(fd, p, hdr.dirlistlen + 1,
1973 hdr.strtab + hdr.dirlist) != (ssize_t)hdr.dirlistlen + 1 ||
1974 p[hdr.dirlistlen] != '\0') {
1983 * If caller agreed to receive list which includes the default
1984 * paths, we are done. Otherwise, if we still did not
1985 * calculated filtered result, do it now.
1988 return (hints[0] != '\0' ? hints : NULL);
1989 if (filtered_path != NULL)
1993 * Obtain the list of all configured search paths, and the
1994 * list of the default paths.
1996 * First estimate the size of the results.
1998 smeta.dls_size = __offsetof(struct dl_serinfo, dls_serpath);
2000 hmeta.dls_size = __offsetof(struct dl_serinfo, dls_serpath);
2003 sargs.request = RTLD_DI_SERINFOSIZE;
2004 sargs.serinfo = &smeta;
2005 hargs.request = RTLD_DI_SERINFOSIZE;
2006 hargs.serinfo = &hmeta;
2008 path_enumerate(ld_standard_library_path, fill_search_info, NULL,
2010 path_enumerate(hints, fill_search_info, NULL, &hargs);
2012 SLPinfo = xmalloc(smeta.dls_size);
2013 hintinfo = xmalloc(hmeta.dls_size);
2016 * Next fetch both sets of paths.
2018 sargs.request = RTLD_DI_SERINFO;
2019 sargs.serinfo = SLPinfo;
2020 sargs.serpath = &SLPinfo->dls_serpath[0];
2021 sargs.strspace = (char *)&SLPinfo->dls_serpath[smeta.dls_cnt];
2023 hargs.request = RTLD_DI_SERINFO;
2024 hargs.serinfo = hintinfo;
2025 hargs.serpath = &hintinfo->dls_serpath[0];
2026 hargs.strspace = (char *)&hintinfo->dls_serpath[hmeta.dls_cnt];
2028 path_enumerate(ld_standard_library_path, fill_search_info, NULL,
2030 path_enumerate(hints, fill_search_info, NULL, &hargs);
2033 * Now calculate the difference between two sets, by excluding
2034 * standard paths from the full set.
2038 filtered_path = xmalloc(hdr.dirlistlen + 1);
2039 hintpath = &hintinfo->dls_serpath[0];
2040 for (hintndx = 0; hintndx < hmeta.dls_cnt; hintndx++, hintpath++) {
2042 SLPpath = &SLPinfo->dls_serpath[0];
2044 * Check each standard path against current.
2046 for (SLPndx = 0; SLPndx < smeta.dls_cnt; SLPndx++, SLPpath++) {
2047 /* matched, skip the path */
2048 if (!strcmp(hintpath->dls_name, SLPpath->dls_name)) {
2056 * Not matched against any standard path, add the path
2057 * to result. Separate consequtive paths with ':'.
2060 filtered_path[fndx] = ':';
2064 flen = strlen(hintpath->dls_name);
2065 strncpy((filtered_path + fndx), hintpath->dls_name, flen);
2068 filtered_path[fndx] = '\0';
2074 return (filtered_path[0] != '\0' ? filtered_path : NULL);
2078 init_dag(Obj_Entry *root)
2080 const Needed_Entry *needed;
2081 const Objlist_Entry *elm;
2084 if (root->dag_inited)
2086 donelist_init(&donelist);
2088 /* Root object belongs to own DAG. */
2089 objlist_push_tail(&root->dldags, root);
2090 objlist_push_tail(&root->dagmembers, root);
2091 donelist_check(&donelist, root);
2094 * Add dependencies of root object to DAG in breadth order
2095 * by exploiting the fact that each new object get added
2096 * to the tail of the dagmembers list.
2098 STAILQ_FOREACH(elm, &root->dagmembers, link) {
2099 for (needed = elm->obj->needed; needed != NULL; needed = needed->next) {
2100 if (needed->obj == NULL || donelist_check(&donelist, needed->obj))
2102 objlist_push_tail(&needed->obj->dldags, root);
2103 objlist_push_tail(&root->dagmembers, needed->obj);
2106 root->dag_inited = true;
2110 init_marker(Obj_Entry *marker)
2113 bzero(marker, sizeof(*marker));
2114 marker->marker = true;
2118 globallist_curr(const Obj_Entry *obj)
2125 return (__DECONST(Obj_Entry *, obj));
2126 obj = TAILQ_PREV(obj, obj_entry_q, next);
2131 globallist_next(const Obj_Entry *obj)
2135 obj = TAILQ_NEXT(obj, next);
2139 return (__DECONST(Obj_Entry *, obj));
2143 /* Prevent the object from being unmapped while the bind lock is dropped. */
2145 hold_object(Obj_Entry *obj)
2152 unhold_object(Obj_Entry *obj)
2155 assert(obj->holdcount > 0);
2156 if (--obj->holdcount == 0 && obj->unholdfree)
2157 release_object(obj);
2161 process_z(Obj_Entry *root)
2163 const Objlist_Entry *elm;
2167 * Walk over object DAG and process every dependent object
2168 * that is marked as DF_1_NODELETE or DF_1_GLOBAL. They need
2169 * to grow their own DAG.
2171 * For DF_1_GLOBAL, DAG is required for symbol lookups in
2172 * symlook_global() to work.
2174 * For DF_1_NODELETE, the DAG should have its reference upped.
2176 STAILQ_FOREACH(elm, &root->dagmembers, link) {
2180 if (obj->z_nodelete && !obj->ref_nodel) {
2181 dbg("obj %s -z nodelete", obj->path);
2184 obj->ref_nodel = true;
2186 if (obj->z_global && objlist_find(&list_global, obj) == NULL) {
2187 dbg("obj %s -z global", obj->path);
2188 objlist_push_tail(&list_global, obj);
2195 parse_rtld_phdr(Obj_Entry *obj)
2198 Elf_Addr note_start, note_end;
2200 obj->stack_flags = PF_X | PF_R | PF_W;
2201 for (ph = obj->phdr; (const char *)ph < (const char *)obj->phdr +
2202 obj->phsize; ph++) {
2203 switch (ph->p_type) {
2205 obj->stack_flags = ph->p_flags;
2208 obj->relro_page = obj->relocbase +
2209 trunc_page(ph->p_vaddr);
2210 obj->relro_size = round_page(ph->p_memsz);
2213 note_start = (Elf_Addr)obj->relocbase + ph->p_vaddr;
2214 note_end = note_start + ph->p_filesz;
2215 digest_notes(obj, note_start, note_end);
2222 * Initialize the dynamic linker. The argument is the address at which
2223 * the dynamic linker has been mapped into memory. The primary task of
2224 * this function is to relocate the dynamic linker.
2227 init_rtld(caddr_t mapbase, Elf_Auxinfo **aux_info)
2229 Obj_Entry objtmp; /* Temporary rtld object */
2230 const Elf_Ehdr *ehdr;
2231 const Elf_Dyn *dyn_rpath;
2232 const Elf_Dyn *dyn_soname;
2233 const Elf_Dyn *dyn_runpath;
2235 #ifdef RTLD_INIT_PAGESIZES_EARLY
2236 /* The page size is required by the dynamic memory allocator. */
2237 init_pagesizes(aux_info);
2241 * Conjure up an Obj_Entry structure for the dynamic linker.
2243 * The "path" member can't be initialized yet because string constants
2244 * cannot yet be accessed. Below we will set it correctly.
2246 memset(&objtmp, 0, sizeof(objtmp));
2249 objtmp.mapbase = mapbase;
2251 objtmp.relocbase = mapbase;
2254 objtmp.dynamic = rtld_dynamic(&objtmp);
2255 digest_dynamic1(&objtmp, 1, &dyn_rpath, &dyn_soname, &dyn_runpath);
2256 assert(objtmp.needed == NULL);
2257 #if !defined(__mips__)
2258 /* MIPS has a bogus DT_TEXTREL. */
2259 assert(!objtmp.textrel);
2262 * Temporarily put the dynamic linker entry into the object list, so
2263 * that symbols can be found.
2265 relocate_objects(&objtmp, true, &objtmp, 0, NULL);
2267 ehdr = (Elf_Ehdr *)mapbase;
2268 objtmp.phdr = (Elf_Phdr *)((char *)mapbase + ehdr->e_phoff);
2269 objtmp.phsize = ehdr->e_phnum * sizeof(objtmp.phdr[0]);
2271 /* Initialize the object list. */
2272 TAILQ_INIT(&obj_list);
2274 /* Now that non-local variables can be accesses, copy out obj_rtld. */
2275 memcpy(&obj_rtld, &objtmp, sizeof(obj_rtld));
2277 #ifndef RTLD_INIT_PAGESIZES_EARLY
2278 /* The page size is required by the dynamic memory allocator. */
2279 init_pagesizes(aux_info);
2282 if (aux_info[AT_OSRELDATE] != NULL)
2283 osreldate = aux_info[AT_OSRELDATE]->a_un.a_val;
2285 digest_dynamic2(&obj_rtld, dyn_rpath, dyn_soname, dyn_runpath);
2287 /* Replace the path with a dynamically allocated copy. */
2288 obj_rtld.path = xstrdup(ld_path_rtld);
2290 parse_rtld_phdr(&obj_rtld);
2291 if (obj_enforce_relro(&obj_rtld) == -1)
2294 r_debug.r_version = R_DEBUG_VERSION;
2295 r_debug.r_brk = r_debug_state;
2296 r_debug.r_state = RT_CONSISTENT;
2297 r_debug.r_ldbase = obj_rtld.relocbase;
2301 * Retrieve the array of supported page sizes. The kernel provides the page
2302 * sizes in increasing order.
2305 init_pagesizes(Elf_Auxinfo **aux_info)
2307 static size_t psa[MAXPAGESIZES];
2311 if (aux_info[AT_PAGESIZES] != NULL && aux_info[AT_PAGESIZESLEN] !=
2313 size = aux_info[AT_PAGESIZESLEN]->a_un.a_val;
2314 pagesizes = aux_info[AT_PAGESIZES]->a_un.a_ptr;
2317 if (sysctlnametomib("hw.pagesizes", mib, &len) == 0)
2320 /* As a fallback, retrieve the base page size. */
2321 size = sizeof(psa[0]);
2322 if (aux_info[AT_PAGESZ] != NULL) {
2323 psa[0] = aux_info[AT_PAGESZ]->a_un.a_val;
2327 mib[1] = HW_PAGESIZE;
2331 if (sysctl(mib, len, psa, &size, NULL, 0) == -1) {
2332 _rtld_error("sysctl for hw.pagesize(s) failed");
2338 npagesizes = size / sizeof(pagesizes[0]);
2339 /* Discard any invalid entries at the end of the array. */
2340 while (npagesizes > 0 && pagesizes[npagesizes - 1] == 0)
2345 * Add the init functions from a needed object list (and its recursive
2346 * needed objects) to "list". This is not used directly; it is a helper
2347 * function for initlist_add_objects(). The write lock must be held
2348 * when this function is called.
2351 initlist_add_neededs(Needed_Entry *needed, Objlist *list)
2353 /* Recursively process the successor needed objects. */
2354 if (needed->next != NULL)
2355 initlist_add_neededs(needed->next, list);
2357 /* Process the current needed object. */
2358 if (needed->obj != NULL)
2359 initlist_add_objects(needed->obj, needed->obj, list);
2363 * Scan all of the DAGs rooted in the range of objects from "obj" to
2364 * "tail" and add their init functions to "list". This recurses over
2365 * the DAGs and ensure the proper init ordering such that each object's
2366 * needed libraries are initialized before the object itself. At the
2367 * same time, this function adds the objects to the global finalization
2368 * list "list_fini" in the opposite order. The write lock must be
2369 * held when this function is called.
2372 initlist_add_objects(Obj_Entry *obj, Obj_Entry *tail, Objlist *list)
2376 if (obj->init_scanned || obj->init_done)
2378 obj->init_scanned = true;
2380 /* Recursively process the successor objects. */
2381 nobj = globallist_next(obj);
2382 if (nobj != NULL && obj != tail)
2383 initlist_add_objects(nobj, tail, list);
2385 /* Recursively process the needed objects. */
2386 if (obj->needed != NULL)
2387 initlist_add_neededs(obj->needed, list);
2388 if (obj->needed_filtees != NULL)
2389 initlist_add_neededs(obj->needed_filtees, list);
2390 if (obj->needed_aux_filtees != NULL)
2391 initlist_add_neededs(obj->needed_aux_filtees, list);
2393 /* Add the object to the init list. */
2394 objlist_push_tail(list, obj);
2396 /* Add the object to the global fini list in the reverse order. */
2397 if ((obj->fini != (Elf_Addr)NULL || obj->fini_array != (Elf_Addr)NULL)
2398 && !obj->on_fini_list) {
2399 objlist_push_head(&list_fini, obj);
2400 obj->on_fini_list = true;
2405 #define FPTR_TARGET(f) ((Elf_Addr) (f))
2409 free_needed_filtees(Needed_Entry *n, RtldLockState *lockstate)
2411 Needed_Entry *needed, *needed1;
2413 for (needed = n; needed != NULL; needed = needed->next) {
2414 if (needed->obj != NULL) {
2415 dlclose_locked(needed->obj, lockstate);
2419 for (needed = n; needed != NULL; needed = needed1) {
2420 needed1 = needed->next;
2426 unload_filtees(Obj_Entry *obj, RtldLockState *lockstate)
2429 free_needed_filtees(obj->needed_filtees, lockstate);
2430 obj->needed_filtees = NULL;
2431 free_needed_filtees(obj->needed_aux_filtees, lockstate);
2432 obj->needed_aux_filtees = NULL;
2433 obj->filtees_loaded = false;
2437 load_filtee1(Obj_Entry *obj, Needed_Entry *needed, int flags,
2438 RtldLockState *lockstate)
2441 for (; needed != NULL; needed = needed->next) {
2442 needed->obj = dlopen_object(obj->strtab + needed->name, -1, obj,
2443 flags, ((ld_loadfltr || obj->z_loadfltr) ? RTLD_NOW : RTLD_LAZY) |
2444 RTLD_LOCAL, lockstate);
2449 load_filtees(Obj_Entry *obj, int flags, RtldLockState *lockstate)
2452 lock_restart_for_upgrade(lockstate);
2453 if (!obj->filtees_loaded) {
2454 load_filtee1(obj, obj->needed_filtees, flags, lockstate);
2455 load_filtee1(obj, obj->needed_aux_filtees, flags, lockstate);
2456 obj->filtees_loaded = true;
2461 process_needed(Obj_Entry *obj, Needed_Entry *needed, int flags)
2465 for (; needed != NULL; needed = needed->next) {
2466 obj1 = needed->obj = load_object(obj->strtab + needed->name, -1, obj,
2467 flags & ~RTLD_LO_NOLOAD);
2468 if (obj1 == NULL && !ld_tracing && (flags & RTLD_LO_FILTEES) == 0)
2475 * Given a shared object, traverse its list of needed objects, and load
2476 * each of them. Returns 0 on success. Generates an error message and
2477 * returns -1 on failure.
2480 load_needed_objects(Obj_Entry *first, int flags)
2484 for (obj = first; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
2487 if (process_needed(obj, obj->needed, flags) == -1)
2494 load_preload_objects(char *p, bool isfd)
2497 static const char delim[] = " \t:;";
2502 p += strspn(p, delim);
2503 while (*p != '\0') {
2505 size_t len = strcspn(p, delim);
2513 fd = parse_integer(p);
2521 obj = load_object(name, fd, NULL, 0);
2523 return (-1); /* XXX - cleanup */
2524 obj->z_interpose = true;
2527 p += strspn(p, delim);
2529 LD_UTRACE(UTRACE_PRELOAD_FINISHED, NULL, NULL, 0, 0, NULL);
2535 printable_path(const char *path)
2538 return (path == NULL ? "<unknown>" : path);
2542 * Load a shared object into memory, if it is not already loaded. The
2543 * object may be specified by name or by user-supplied file descriptor
2544 * fd_u. In the later case, the fd_u descriptor is not closed, but its
2547 * Returns a pointer to the Obj_Entry for the object. Returns NULL
2551 load_object(const char *name, int fd_u, const Obj_Entry *refobj, int flags)
2560 TAILQ_FOREACH(obj, &obj_list, next) {
2561 if (obj->marker || obj->doomed)
2563 if (object_match_name(obj, name))
2567 path = find_library(name, refobj, &fd);
2575 * search_library_pathfds() opens a fresh file descriptor for the
2576 * library, so there is no need to dup().
2578 } else if (fd_u == -1) {
2580 * If we didn't find a match by pathname, or the name is not
2581 * supplied, open the file and check again by device and inode.
2582 * This avoids false mismatches caused by multiple links or ".."
2585 * To avoid a race, we open the file and use fstat() rather than
2588 if ((fd = open(path, O_RDONLY | O_CLOEXEC | O_VERIFY)) == -1) {
2589 _rtld_error("Cannot open \"%s\"", path);
2594 fd = fcntl(fd_u, F_DUPFD_CLOEXEC, 0);
2596 _rtld_error("Cannot dup fd");
2601 if (fstat(fd, &sb) == -1) {
2602 _rtld_error("Cannot fstat \"%s\"", printable_path(path));
2607 TAILQ_FOREACH(obj, &obj_list, next) {
2608 if (obj->marker || obj->doomed)
2610 if (obj->ino == sb.st_ino && obj->dev == sb.st_dev)
2613 if (obj != NULL && name != NULL) {
2614 object_add_name(obj, name);
2619 if (flags & RTLD_LO_NOLOAD) {
2625 /* First use of this object, so we must map it in */
2626 obj = do_load_object(fd, name, path, &sb, flags);
2635 do_load_object(int fd, const char *name, char *path, struct stat *sbp,
2642 * but first, make sure that environment variables haven't been
2643 * used to circumvent the noexec flag on a filesystem.
2645 if (dangerous_ld_env) {
2646 if (fstatfs(fd, &fs) != 0) {
2647 _rtld_error("Cannot fstatfs \"%s\"", printable_path(path));
2650 if (fs.f_flags & MNT_NOEXEC) {
2651 _rtld_error("Cannot execute objects on %s", fs.f_mntonname);
2655 dbg("loading \"%s\"", printable_path(path));
2656 obj = map_object(fd, printable_path(path), sbp);
2661 * If DT_SONAME is present in the object, digest_dynamic2 already
2662 * added it to the object names.
2665 object_add_name(obj, name);
2667 if (!digest_dynamic(obj, 0))
2669 dbg("%s valid_hash_sysv %d valid_hash_gnu %d dynsymcount %d", obj->path,
2670 obj->valid_hash_sysv, obj->valid_hash_gnu, obj->dynsymcount);
2671 if (obj->z_pie && (flags & RTLD_LO_TRACE) == 0) {
2672 dbg("refusing to load PIE executable \"%s\"", obj->path);
2673 _rtld_error("Cannot load PIE binary %s as DSO", obj->path);
2676 if (obj->z_noopen && (flags & (RTLD_LO_DLOPEN | RTLD_LO_TRACE)) ==
2678 dbg("refusing to load non-loadable \"%s\"", obj->path);
2679 _rtld_error("Cannot dlopen non-loadable %s", obj->path);
2683 obj->dlopened = (flags & RTLD_LO_DLOPEN) != 0;
2684 TAILQ_INSERT_TAIL(&obj_list, obj, next);
2687 linkmap_add(obj); /* for GDB & dlinfo() */
2688 max_stack_flags |= obj->stack_flags;
2690 dbg(" %p .. %p: %s", obj->mapbase,
2691 obj->mapbase + obj->mapsize - 1, obj->path);
2693 dbg(" WARNING: %s has impure text", obj->path);
2694 LD_UTRACE(UTRACE_LOAD_OBJECT, obj, obj->mapbase, obj->mapsize, 0,
2700 munmap(obj->mapbase, obj->mapsize);
2706 obj_from_addr(const void *addr)
2710 TAILQ_FOREACH(obj, &obj_list, next) {
2713 if (addr < (void *) obj->mapbase)
2715 if (addr < (void *)(obj->mapbase + obj->mapsize))
2724 Elf_Addr *preinit_addr;
2727 preinit_addr = (Elf_Addr *)obj_main->preinit_array;
2728 if (preinit_addr == NULL)
2731 for (index = 0; index < obj_main->preinit_array_num; index++) {
2732 if (preinit_addr[index] != 0 && preinit_addr[index] != 1) {
2733 dbg("calling preinit function for %s at %p", obj_main->path,
2734 (void *)preinit_addr[index]);
2735 LD_UTRACE(UTRACE_INIT_CALL, obj_main, (void *)preinit_addr[index],
2736 0, 0, obj_main->path);
2737 call_init_pointer(obj_main, preinit_addr[index]);
2743 * Call the finalization functions for each of the objects in "list"
2744 * belonging to the DAG of "root" and referenced once. If NULL "root"
2745 * is specified, every finalization function will be called regardless
2746 * of the reference count and the list elements won't be freed. All of
2747 * the objects are expected to have non-NULL fini functions.
2750 objlist_call_fini(Objlist *list, Obj_Entry *root, RtldLockState *lockstate)
2753 struct dlerror_save *saved_msg;
2754 Elf_Addr *fini_addr;
2757 assert(root == NULL || root->refcount == 1);
2760 root->doomed = true;
2763 * Preserve the current error message since a fini function might
2764 * call into the dynamic linker and overwrite it.
2766 saved_msg = errmsg_save();
2768 STAILQ_FOREACH(elm, list, link) {
2769 if (root != NULL && (elm->obj->refcount != 1 ||
2770 objlist_find(&root->dagmembers, elm->obj) == NULL))
2772 /* Remove object from fini list to prevent recursive invocation. */
2773 STAILQ_REMOVE(list, elm, Struct_Objlist_Entry, link);
2774 /* Ensure that new references cannot be acquired. */
2775 elm->obj->doomed = true;
2777 hold_object(elm->obj);
2778 lock_release(rtld_bind_lock, lockstate);
2780 * It is legal to have both DT_FINI and DT_FINI_ARRAY defined.
2781 * When this happens, DT_FINI_ARRAY is processed first.
2783 fini_addr = (Elf_Addr *)elm->obj->fini_array;
2784 if (fini_addr != NULL && elm->obj->fini_array_num > 0) {
2785 for (index = elm->obj->fini_array_num - 1; index >= 0;
2787 if (fini_addr[index] != 0 && fini_addr[index] != 1) {
2788 dbg("calling fini function for %s at %p",
2789 elm->obj->path, (void *)fini_addr[index]);
2790 LD_UTRACE(UTRACE_FINI_CALL, elm->obj,
2791 (void *)fini_addr[index], 0, 0, elm->obj->path);
2792 call_initfini_pointer(elm->obj, fini_addr[index]);
2796 if (elm->obj->fini != (Elf_Addr)NULL) {
2797 dbg("calling fini function for %s at %p", elm->obj->path,
2798 (void *)elm->obj->fini);
2799 LD_UTRACE(UTRACE_FINI_CALL, elm->obj, (void *)elm->obj->fini,
2800 0, 0, elm->obj->path);
2801 call_initfini_pointer(elm->obj, elm->obj->fini);
2803 wlock_acquire(rtld_bind_lock, lockstate);
2804 unhold_object(elm->obj);
2805 /* No need to free anything if process is going down. */
2809 * We must restart the list traversal after every fini call
2810 * because a dlclose() call from the fini function or from
2811 * another thread might have modified the reference counts.
2815 } while (elm != NULL);
2816 errmsg_restore(saved_msg);
2820 * Call the initialization functions for each of the objects in
2821 * "list". All of the objects are expected to have non-NULL init
2825 objlist_call_init(Objlist *list, RtldLockState *lockstate)
2829 struct dlerror_save *saved_msg;
2830 Elf_Addr *init_addr;
2831 void (*reg)(void (*)(void));
2835 * Clean init_scanned flag so that objects can be rechecked and
2836 * possibly initialized earlier if any of vectors called below
2837 * cause the change by using dlopen.
2839 TAILQ_FOREACH(obj, &obj_list, next) {
2842 obj->init_scanned = false;
2846 * Preserve the current error message since an init function might
2847 * call into the dynamic linker and overwrite it.
2849 saved_msg = errmsg_save();
2850 STAILQ_FOREACH(elm, list, link) {
2851 if (elm->obj->init_done) /* Initialized early. */
2854 * Race: other thread might try to use this object before current
2855 * one completes the initialization. Not much can be done here
2856 * without better locking.
2858 elm->obj->init_done = true;
2859 hold_object(elm->obj);
2861 if (elm->obj == obj_main && obj_main->crt_no_init) {
2862 reg = (void (*)(void (*)(void)))get_program_var_addr(
2863 "__libc_atexit", lockstate);
2865 lock_release(rtld_bind_lock, lockstate);
2868 rtld_exit_ptr = rtld_nop_exit;
2872 * It is legal to have both DT_INIT and DT_INIT_ARRAY defined.
2873 * When this happens, DT_INIT is processed first.
2875 if (elm->obj->init != (Elf_Addr)NULL) {
2876 dbg("calling init function for %s at %p", elm->obj->path,
2877 (void *)elm->obj->init);
2878 LD_UTRACE(UTRACE_INIT_CALL, elm->obj, (void *)elm->obj->init,
2879 0, 0, elm->obj->path);
2880 call_init_pointer(elm->obj, elm->obj->init);
2882 init_addr = (Elf_Addr *)elm->obj->init_array;
2883 if (init_addr != NULL) {
2884 for (index = 0; index < elm->obj->init_array_num; index++) {
2885 if (init_addr[index] != 0 && init_addr[index] != 1) {
2886 dbg("calling init function for %s at %p", elm->obj->path,
2887 (void *)init_addr[index]);
2888 LD_UTRACE(UTRACE_INIT_CALL, elm->obj,
2889 (void *)init_addr[index], 0, 0, elm->obj->path);
2890 call_init_pointer(elm->obj, init_addr[index]);
2894 wlock_acquire(rtld_bind_lock, lockstate);
2895 unhold_object(elm->obj);
2897 errmsg_restore(saved_msg);
2901 objlist_clear(Objlist *list)
2905 while (!STAILQ_EMPTY(list)) {
2906 elm = STAILQ_FIRST(list);
2907 STAILQ_REMOVE_HEAD(list, link);
2912 static Objlist_Entry *
2913 objlist_find(Objlist *list, const Obj_Entry *obj)
2917 STAILQ_FOREACH(elm, list, link)
2918 if (elm->obj == obj)
2924 objlist_init(Objlist *list)
2930 objlist_push_head(Objlist *list, Obj_Entry *obj)
2934 elm = NEW(Objlist_Entry);
2936 STAILQ_INSERT_HEAD(list, elm, link);
2940 objlist_push_tail(Objlist *list, Obj_Entry *obj)
2944 elm = NEW(Objlist_Entry);
2946 STAILQ_INSERT_TAIL(list, elm, link);
2950 objlist_put_after(Objlist *list, Obj_Entry *listobj, Obj_Entry *obj)
2952 Objlist_Entry *elm, *listelm;
2954 STAILQ_FOREACH(listelm, list, link) {
2955 if (listelm->obj == listobj)
2958 elm = NEW(Objlist_Entry);
2960 if (listelm != NULL)
2961 STAILQ_INSERT_AFTER(list, listelm, elm, link);
2963 STAILQ_INSERT_TAIL(list, elm, link);
2967 objlist_remove(Objlist *list, Obj_Entry *obj)
2971 if ((elm = objlist_find(list, obj)) != NULL) {
2972 STAILQ_REMOVE(list, elm, Struct_Objlist_Entry, link);
2978 * Relocate dag rooted in the specified object.
2979 * Returns 0 on success, or -1 on failure.
2983 relocate_object_dag(Obj_Entry *root, bool bind_now, Obj_Entry *rtldobj,
2984 int flags, RtldLockState *lockstate)
2990 STAILQ_FOREACH(elm, &root->dagmembers, link) {
2991 error = relocate_object(elm->obj, bind_now, rtldobj, flags,
3000 * Prepare for, or clean after, relocating an object marked with
3001 * DT_TEXTREL or DF_TEXTREL. Before relocating, all read-only
3002 * segments are remapped read-write. After relocations are done, the
3003 * segment's permissions are returned back to the modes specified in
3004 * the phdrs. If any relocation happened, or always for wired
3005 * program, COW is triggered.
3008 reloc_textrel_prot(Obj_Entry *obj, bool before)
3015 for (l = obj->phsize / sizeof(*ph), ph = obj->phdr; l > 0;
3017 if (ph->p_type != PT_LOAD || (ph->p_flags & PF_W) != 0)
3019 base = obj->relocbase + trunc_page(ph->p_vaddr);
3020 sz = round_page(ph->p_vaddr + ph->p_filesz) -
3021 trunc_page(ph->p_vaddr);
3022 prot = before ? (PROT_READ | PROT_WRITE) :
3023 convert_prot(ph->p_flags);
3024 if (mprotect(base, sz, prot) == -1) {
3025 _rtld_error("%s: Cannot write-%sable text segment: %s",
3026 obj->path, before ? "en" : "dis",
3027 rtld_strerror(errno));
3035 * Relocate single object.
3036 * Returns 0 on success, or -1 on failure.
3039 relocate_object(Obj_Entry *obj, bool bind_now, Obj_Entry *rtldobj,
3040 int flags, RtldLockState *lockstate)
3045 obj->relocated = true;
3047 dbg("relocating \"%s\"", obj->path);
3049 if (obj->symtab == NULL || obj->strtab == NULL ||
3050 !(obj->valid_hash_sysv || obj->valid_hash_gnu))
3051 dbg("object %s has no run-time symbol table", obj->path);
3053 /* There are relocations to the write-protected text segment. */
3054 if (obj->textrel && reloc_textrel_prot(obj, true) != 0)
3057 /* Process the non-PLT non-IFUNC relocations. */
3058 if (reloc_non_plt(obj, rtldobj, flags, lockstate))
3061 /* Re-protected the text segment. */
3062 if (obj->textrel && reloc_textrel_prot(obj, false) != 0)
3065 /* Set the special PLT or GOT entries. */
3068 /* Process the PLT relocations. */
3069 if (reloc_plt(obj, flags, lockstate) == -1)
3071 /* Relocate the jump slots if we are doing immediate binding. */
3072 if ((obj->bind_now || bind_now) && reloc_jmpslots(obj, flags,
3076 if (!obj->mainprog && obj_enforce_relro(obj) == -1)
3080 * Set up the magic number and version in the Obj_Entry. These
3081 * were checked in the crt1.o from the original ElfKit, so we
3082 * set them for backward compatibility.
3084 obj->magic = RTLD_MAGIC;
3085 obj->version = RTLD_VERSION;
3091 * Relocate newly-loaded shared objects. The argument is a pointer to
3092 * the Obj_Entry for the first such object. All objects from the first
3093 * to the end of the list of objects are relocated. Returns 0 on success,
3097 relocate_objects(Obj_Entry *first, bool bind_now, Obj_Entry *rtldobj,
3098 int flags, RtldLockState *lockstate)
3103 for (error = 0, obj = first; obj != NULL;
3104 obj = TAILQ_NEXT(obj, next)) {
3107 error = relocate_object(obj, bind_now, rtldobj, flags,
3116 * The handling of R_MACHINE_IRELATIVE relocations and jumpslots
3117 * referencing STT_GNU_IFUNC symbols is postponed till the other
3118 * relocations are done. The indirect functions specified as
3119 * ifunc are allowed to call other symbols, so we need to have
3120 * objects relocated before asking for resolution from indirects.
3122 * The R_MACHINE_IRELATIVE slots are resolved in greedy fashion,
3123 * instead of the usual lazy handling of PLT slots. It is
3124 * consistent with how GNU does it.
3127 resolve_object_ifunc(Obj_Entry *obj, bool bind_now, int flags,
3128 RtldLockState *lockstate)
3131 if (obj->ifuncs_resolved)
3133 obj->ifuncs_resolved = true;
3134 if (!obj->irelative && !obj->irelative_nonplt &&
3135 !((obj->bind_now || bind_now) && obj->gnu_ifunc) &&
3136 !obj->non_plt_gnu_ifunc)
3138 if (obj_disable_relro(obj) == -1 ||
3139 (obj->irelative && reloc_iresolve(obj, lockstate) == -1) ||
3140 (obj->irelative_nonplt && reloc_iresolve_nonplt(obj,
3141 lockstate) == -1) ||
3142 ((obj->bind_now || bind_now) && obj->gnu_ifunc &&
3143 reloc_gnu_ifunc(obj, flags, lockstate) == -1) ||
3144 (obj->non_plt_gnu_ifunc && reloc_non_plt(obj, &obj_rtld,
3145 flags | SYMLOOK_IFUNC, lockstate) == -1) ||
3146 obj_enforce_relro(obj) == -1)
3152 initlist_objects_ifunc(Objlist *list, bool bind_now, int flags,
3153 RtldLockState *lockstate)
3158 STAILQ_FOREACH(elm, list, link) {
3162 if (resolve_object_ifunc(obj, bind_now, flags,
3170 * Cleanup procedure. It will be called (by the atexit mechanism) just
3171 * before the process exits.
3176 RtldLockState lockstate;
3178 wlock_acquire(rtld_bind_lock, &lockstate);
3180 objlist_call_fini(&list_fini, NULL, &lockstate);
3181 /* No need to remove the items from the list, since we are exiting. */
3182 if (!libmap_disable)
3184 lock_release(rtld_bind_lock, &lockstate);
3193 * Iterate over a search path, translate each element, and invoke the
3194 * callback on the result.
3197 path_enumerate(const char *path, path_enum_proc callback,
3198 const char *refobj_path, void *arg)
3204 path += strspn(path, ":;");
3205 while (*path != '\0') {
3209 len = strcspn(path, ":;");
3210 trans = lm_findn(refobj_path, path, len);
3212 res = callback(trans, strlen(trans), arg);
3214 res = callback(path, len, arg);
3220 path += strspn(path, ":;");
3226 struct try_library_args {
3235 try_library_path(const char *dir, size_t dirlen, void *param)
3237 struct try_library_args *arg;
3241 if (*dir == '/' || trust) {
3244 if (dirlen + 1 + arg->namelen + 1 > arg->buflen)
3247 pathname = arg->buffer;
3248 strncpy(pathname, dir, dirlen);
3249 pathname[dirlen] = '/';
3250 strcpy(pathname + dirlen + 1, arg->name);
3252 dbg(" Trying \"%s\"", pathname);
3253 fd = open(pathname, O_RDONLY | O_CLOEXEC | O_VERIFY);
3255 dbg(" Opened \"%s\", fd %d", pathname, fd);
3256 pathname = xmalloc(dirlen + 1 + arg->namelen + 1);
3257 strcpy(pathname, arg->buffer);
3261 dbg(" Failed to open \"%s\": %s",
3262 pathname, rtld_strerror(errno));
3269 search_library_path(const char *name, const char *path,
3270 const char *refobj_path, int *fdp)
3273 struct try_library_args arg;
3279 arg.namelen = strlen(name);
3280 arg.buffer = xmalloc(PATH_MAX);
3281 arg.buflen = PATH_MAX;
3284 p = path_enumerate(path, try_library_path, refobj_path, &arg);
3294 * Finds the library with the given name using the directory descriptors
3295 * listed in the LD_LIBRARY_PATH_FDS environment variable.
3297 * Returns a freshly-opened close-on-exec file descriptor for the library,
3298 * or -1 if the library cannot be found.
3301 search_library_pathfds(const char *name, const char *path, int *fdp)
3303 char *envcopy, *fdstr, *found, *last_token;
3307 dbg("%s('%s', '%s', fdp)", __func__, name, path);
3309 /* Don't load from user-specified libdirs into setuid binaries. */
3313 /* We can't do anything if LD_LIBRARY_PATH_FDS isn't set. */
3317 /* LD_LIBRARY_PATH_FDS only works with relative paths. */
3318 if (name[0] == '/') {
3319 dbg("Absolute path (%s) passed to %s", name, __func__);
3324 * Use strtok_r() to walk the FD:FD:FD list. This requires a local
3325 * copy of the path, as strtok_r rewrites separator tokens
3329 envcopy = xstrdup(path);
3330 for (fdstr = strtok_r(envcopy, ":", &last_token); fdstr != NULL;
3331 fdstr = strtok_r(NULL, ":", &last_token)) {
3332 dirfd = parse_integer(fdstr);
3334 _rtld_error("failed to parse directory FD: '%s'",
3338 fd = __sys_openat(dirfd, name, O_RDONLY | O_CLOEXEC | O_VERIFY);
3341 len = strlen(fdstr) + strlen(name) + 3;
3342 found = xmalloc(len);
3343 if (rtld_snprintf(found, len, "#%d/%s", dirfd, name) < 0) {
3344 _rtld_error("error generating '%d/%s'",
3348 dbg("open('%s') => %d", found, fd);
3359 dlclose(void *handle)
3361 RtldLockState lockstate;
3364 wlock_acquire(rtld_bind_lock, &lockstate);
3365 error = dlclose_locked(handle, &lockstate);
3366 lock_release(rtld_bind_lock, &lockstate);
3371 dlclose_locked(void *handle, RtldLockState *lockstate)
3375 root = dlcheck(handle);
3378 LD_UTRACE(UTRACE_DLCLOSE_START, handle, NULL, 0, root->dl_refcount,
3381 /* Unreference the object and its dependencies. */
3382 root->dl_refcount--;
3384 if (root->refcount == 1) {
3386 * The object will be no longer referenced, so we must unload it.
3387 * First, call the fini functions.
3389 objlist_call_fini(&list_fini, root, lockstate);
3393 /* Finish cleaning up the newly-unreferenced objects. */
3394 GDB_STATE(RT_DELETE,&root->linkmap);
3395 unload_object(root, lockstate);
3396 GDB_STATE(RT_CONSISTENT,NULL);
3400 LD_UTRACE(UTRACE_DLCLOSE_STOP, handle, NULL, 0, 0, NULL);
3407 if (*(lockinfo.dlerror_seen()) != 0)
3409 *lockinfo.dlerror_seen() = 1;
3410 return (lockinfo.dlerror_loc());
3414 * This function is deprecated and has no effect.
3417 dllockinit(void *context,
3418 void *(*_lock_create)(void *context) __unused,
3419 void (*_rlock_acquire)(void *lock) __unused,
3420 void (*_wlock_acquire)(void *lock) __unused,
3421 void (*_lock_release)(void *lock) __unused,
3422 void (*_lock_destroy)(void *lock) __unused,
3423 void (*context_destroy)(void *context))
3425 static void *cur_context;
3426 static void (*cur_context_destroy)(void *);
3428 /* Just destroy the context from the previous call, if necessary. */
3429 if (cur_context_destroy != NULL)
3430 cur_context_destroy(cur_context);
3431 cur_context = context;
3432 cur_context_destroy = context_destroy;
3436 dlopen(const char *name, int mode)
3439 return (rtld_dlopen(name, -1, mode));
3443 fdlopen(int fd, int mode)
3446 return (rtld_dlopen(NULL, fd, mode));
3450 rtld_dlopen(const char *name, int fd, int mode)
3452 RtldLockState lockstate;
3455 LD_UTRACE(UTRACE_DLOPEN_START, NULL, NULL, 0, mode, name);
3456 ld_tracing = (mode & RTLD_TRACE) == 0 ? NULL : "1";
3457 if (ld_tracing != NULL) {
3458 rlock_acquire(rtld_bind_lock, &lockstate);
3459 if (sigsetjmp(lockstate.env, 0) != 0)
3460 lock_upgrade(rtld_bind_lock, &lockstate);
3461 environ = __DECONST(char **, *get_program_var_addr("environ", &lockstate));
3462 lock_release(rtld_bind_lock, &lockstate);
3464 lo_flags = RTLD_LO_DLOPEN;
3465 if (mode & RTLD_NODELETE)
3466 lo_flags |= RTLD_LO_NODELETE;
3467 if (mode & RTLD_NOLOAD)
3468 lo_flags |= RTLD_LO_NOLOAD;
3469 if (mode & RTLD_DEEPBIND)
3470 lo_flags |= RTLD_LO_DEEPBIND;
3471 if (ld_tracing != NULL)
3472 lo_flags |= RTLD_LO_TRACE | RTLD_LO_IGNSTLS;
3474 return (dlopen_object(name, fd, obj_main, lo_flags,
3475 mode & (RTLD_MODEMASK | RTLD_GLOBAL), NULL));
3479 dlopen_cleanup(Obj_Entry *obj, RtldLockState *lockstate)
3484 if (obj->refcount == 0)
3485 unload_object(obj, lockstate);
3489 dlopen_object(const char *name, int fd, Obj_Entry *refobj, int lo_flags,
3490 int mode, RtldLockState *lockstate)
3492 Obj_Entry *old_obj_tail;
3495 RtldLockState mlockstate;
3498 dbg("dlopen_object name \"%s\" fd %d refobj \"%s\" lo_flags %#x mode %#x",
3499 name != NULL ? name : "<null>", fd, refobj == NULL ? "<null>" :
3500 refobj->path, lo_flags, mode);
3501 objlist_init(&initlist);
3503 if (lockstate == NULL && !(lo_flags & RTLD_LO_EARLY)) {
3504 wlock_acquire(rtld_bind_lock, &mlockstate);
3505 lockstate = &mlockstate;
3507 GDB_STATE(RT_ADD,NULL);
3509 old_obj_tail = globallist_curr(TAILQ_LAST(&obj_list, obj_entry_q));
3511 if (name == NULL && fd == -1) {
3515 obj = load_object(name, fd, refobj, lo_flags);
3520 if (mode & RTLD_GLOBAL && objlist_find(&list_global, obj) == NULL)
3521 objlist_push_tail(&list_global, obj);
3522 if (globallist_next(old_obj_tail) != NULL) {
3523 /* We loaded something new. */
3524 assert(globallist_next(old_obj_tail) == obj);
3525 if ((lo_flags & RTLD_LO_DEEPBIND) != 0)
3526 obj->symbolic = true;
3528 if ((lo_flags & (RTLD_LO_EARLY | RTLD_LO_IGNSTLS)) == 0 &&
3529 obj->static_tls && !allocate_tls_offset(obj)) {
3530 _rtld_error("%s: No space available "
3531 "for static Thread Local Storage", obj->path);
3535 result = load_needed_objects(obj, lo_flags & (RTLD_LO_DLOPEN |
3536 RTLD_LO_EARLY | RTLD_LO_IGNSTLS | RTLD_LO_TRACE));
3540 result = rtld_verify_versions(&obj->dagmembers);
3541 if (result != -1 && ld_tracing)
3543 if (result == -1 || relocate_object_dag(obj,
3544 (mode & RTLD_MODEMASK) == RTLD_NOW, &obj_rtld,
3545 (lo_flags & RTLD_LO_EARLY) ? SYMLOOK_EARLY : 0,
3547 dlopen_cleanup(obj, lockstate);
3549 } else if (lo_flags & RTLD_LO_EARLY) {
3551 * Do not call the init functions for early loaded
3552 * filtees. The image is still not initialized enough
3555 * Our object is found by the global object list and
3556 * will be ordered among all init calls done right
3557 * before transferring control to main.
3560 /* Make list of init functions to call. */
3561 initlist_add_objects(obj, obj, &initlist);
3564 * Process all no_delete or global objects here, given
3565 * them own DAGs to prevent their dependencies from being
3566 * unloaded. This has to be done after we have loaded all
3567 * of the dependencies, so that we do not miss any.
3573 * Bump the reference counts for objects on this DAG. If
3574 * this is the first dlopen() call for the object that was
3575 * already loaded as a dependency, initialize the dag
3581 if ((lo_flags & RTLD_LO_TRACE) != 0)
3584 if (obj != NULL && ((lo_flags & RTLD_LO_NODELETE) != 0 ||
3585 obj->z_nodelete) && !obj->ref_nodel) {
3586 dbg("obj %s nodelete", obj->path);
3588 obj->z_nodelete = obj->ref_nodel = true;
3592 LD_UTRACE(UTRACE_DLOPEN_STOP, obj, NULL, 0, obj ? obj->dl_refcount : 0,
3594 GDB_STATE(RT_CONSISTENT,obj ? &obj->linkmap : NULL);
3596 if ((lo_flags & RTLD_LO_EARLY) == 0) {
3597 map_stacks_exec(lockstate);
3599 distribute_static_tls(&initlist, lockstate);
3602 if (initlist_objects_ifunc(&initlist, (mode & RTLD_MODEMASK) == RTLD_NOW,
3603 (lo_flags & RTLD_LO_EARLY) ? SYMLOOK_EARLY : 0,
3605 objlist_clear(&initlist);
3606 dlopen_cleanup(obj, lockstate);
3607 if (lockstate == &mlockstate)
3608 lock_release(rtld_bind_lock, lockstate);
3612 if (!(lo_flags & RTLD_LO_EARLY)) {
3613 /* Call the init functions. */
3614 objlist_call_init(&initlist, lockstate);
3616 objlist_clear(&initlist);
3617 if (lockstate == &mlockstate)
3618 lock_release(rtld_bind_lock, lockstate);
3621 trace_loaded_objects(obj);
3622 if (lockstate == &mlockstate)
3623 lock_release(rtld_bind_lock, lockstate);
3628 do_dlsym(void *handle, const char *name, void *retaddr, const Ver_Entry *ve,
3632 const Obj_Entry *obj, *defobj;
3635 RtldLockState lockstate;
3642 symlook_init(&req, name);
3644 req.flags = flags | SYMLOOK_IN_PLT;
3645 req.lockstate = &lockstate;
3647 LD_UTRACE(UTRACE_DLSYM_START, handle, NULL, 0, 0, name);
3648 rlock_acquire(rtld_bind_lock, &lockstate);
3649 if (sigsetjmp(lockstate.env, 0) != 0)
3650 lock_upgrade(rtld_bind_lock, &lockstate);
3651 if (handle == NULL || handle == RTLD_NEXT ||
3652 handle == RTLD_DEFAULT || handle == RTLD_SELF) {
3654 if ((obj = obj_from_addr(retaddr)) == NULL) {
3655 _rtld_error("Cannot determine caller's shared object");
3656 lock_release(rtld_bind_lock, &lockstate);
3657 LD_UTRACE(UTRACE_DLSYM_STOP, handle, NULL, 0, 0, name);
3660 if (handle == NULL) { /* Just the caller's shared object. */
3661 res = symlook_obj(&req, obj);
3664 defobj = req.defobj_out;
3666 } else if (handle == RTLD_NEXT || /* Objects after caller's */
3667 handle == RTLD_SELF) { /* ... caller included */
3668 if (handle == RTLD_NEXT)
3669 obj = globallist_next(obj);
3670 for (; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
3673 res = symlook_obj(&req, obj);
3676 ELF_ST_BIND(req.sym_out->st_info) != STB_WEAK) {
3678 defobj = req.defobj_out;
3679 if (ELF_ST_BIND(def->st_info) != STB_WEAK)
3685 * Search the dynamic linker itself, and possibly resolve the
3686 * symbol from there. This is how the application links to
3687 * dynamic linker services such as dlopen.
3689 if (def == NULL || ELF_ST_BIND(def->st_info) == STB_WEAK) {
3690 res = symlook_obj(&req, &obj_rtld);
3693 defobj = req.defobj_out;
3697 assert(handle == RTLD_DEFAULT);
3698 res = symlook_default(&req, obj);
3700 defobj = req.defobj_out;
3705 if ((obj = dlcheck(handle)) == NULL) {
3706 lock_release(rtld_bind_lock, &lockstate);
3707 LD_UTRACE(UTRACE_DLSYM_STOP, handle, NULL, 0, 0, name);
3711 donelist_init(&donelist);
3712 if (obj->mainprog) {
3713 /* Handle obtained by dlopen(NULL, ...) implies global scope. */
3714 res = symlook_global(&req, &donelist);
3717 defobj = req.defobj_out;
3720 * Search the dynamic linker itself, and possibly resolve the
3721 * symbol from there. This is how the application links to
3722 * dynamic linker services such as dlopen.
3724 if (def == NULL || ELF_ST_BIND(def->st_info) == STB_WEAK) {
3725 res = symlook_obj(&req, &obj_rtld);
3728 defobj = req.defobj_out;
3733 /* Search the whole DAG rooted at the given object. */
3734 res = symlook_list(&req, &obj->dagmembers, &donelist);
3737 defobj = req.defobj_out;
3743 lock_release(rtld_bind_lock, &lockstate);
3746 * The value required by the caller is derived from the value
3747 * of the symbol. this is simply the relocated value of the
3750 if (ELF_ST_TYPE(def->st_info) == STT_FUNC)
3751 sym = make_function_pointer(def, defobj);
3752 else if (ELF_ST_TYPE(def->st_info) == STT_GNU_IFUNC)
3753 sym = rtld_resolve_ifunc(defobj, def);
3754 else if (ELF_ST_TYPE(def->st_info) == STT_TLS) {
3755 ti.ti_module = defobj->tlsindex;
3756 ti.ti_offset = def->st_value;
3757 sym = __tls_get_addr(&ti);
3759 sym = defobj->relocbase + def->st_value;
3760 LD_UTRACE(UTRACE_DLSYM_STOP, handle, sym, 0, 0, name);
3764 _rtld_error("Undefined symbol \"%s%s%s\"", name, ve != NULL ? "@" : "",
3765 ve != NULL ? ve->name : "");
3766 lock_release(rtld_bind_lock, &lockstate);
3767 LD_UTRACE(UTRACE_DLSYM_STOP, handle, NULL, 0, 0, name);
3772 dlsym(void *handle, const char *name)
3774 return do_dlsym(handle, name, __builtin_return_address(0), NULL,
3779 dlfunc(void *handle, const char *name)
3786 rv.d = do_dlsym(handle, name, __builtin_return_address(0), NULL,
3792 dlvsym(void *handle, const char *name, const char *version)
3796 ventry.name = version;
3798 ventry.hash = elf_hash(version);
3800 return do_dlsym(handle, name, __builtin_return_address(0), &ventry,
3805 _rtld_addr_phdr(const void *addr, struct dl_phdr_info *phdr_info)
3807 const Obj_Entry *obj;
3808 RtldLockState lockstate;
3810 rlock_acquire(rtld_bind_lock, &lockstate);
3811 obj = obj_from_addr(addr);
3813 _rtld_error("No shared object contains address");
3814 lock_release(rtld_bind_lock, &lockstate);
3817 rtld_fill_dl_phdr_info(obj, phdr_info);
3818 lock_release(rtld_bind_lock, &lockstate);
3823 dladdr(const void *addr, Dl_info *info)
3825 const Obj_Entry *obj;
3828 unsigned long symoffset;
3829 RtldLockState lockstate;
3831 rlock_acquire(rtld_bind_lock, &lockstate);
3832 obj = obj_from_addr(addr);
3834 _rtld_error("No shared object contains address");
3835 lock_release(rtld_bind_lock, &lockstate);
3838 info->dli_fname = obj->path;
3839 info->dli_fbase = obj->mapbase;
3840 info->dli_saddr = (void *)0;
3841 info->dli_sname = NULL;
3844 * Walk the symbol list looking for the symbol whose address is
3845 * closest to the address sent in.
3847 for (symoffset = 0; symoffset < obj->dynsymcount; symoffset++) {
3848 def = obj->symtab + symoffset;
3851 * For skip the symbol if st_shndx is either SHN_UNDEF or
3854 if (def->st_shndx == SHN_UNDEF || def->st_shndx == SHN_COMMON)
3858 * If the symbol is greater than the specified address, or if it
3859 * is further away from addr than the current nearest symbol,
3862 symbol_addr = obj->relocbase + def->st_value;
3863 if (symbol_addr > addr || symbol_addr < info->dli_saddr)
3866 /* Update our idea of the nearest symbol. */
3867 info->dli_sname = obj->strtab + def->st_name;
3868 info->dli_saddr = symbol_addr;
3871 if (info->dli_saddr == addr)
3874 lock_release(rtld_bind_lock, &lockstate);
3879 dlinfo(void *handle, int request, void *p)
3881 const Obj_Entry *obj;
3882 RtldLockState lockstate;
3885 rlock_acquire(rtld_bind_lock, &lockstate);
3887 if (handle == NULL || handle == RTLD_SELF) {
3890 retaddr = __builtin_return_address(0); /* __GNUC__ only */
3891 if ((obj = obj_from_addr(retaddr)) == NULL)
3892 _rtld_error("Cannot determine caller's shared object");
3894 obj = dlcheck(handle);
3897 lock_release(rtld_bind_lock, &lockstate);
3903 case RTLD_DI_LINKMAP:
3904 *((struct link_map const **)p) = &obj->linkmap;
3906 case RTLD_DI_ORIGIN:
3907 error = rtld_dirname(obj->path, p);
3910 case RTLD_DI_SERINFOSIZE:
3911 case RTLD_DI_SERINFO:
3912 error = do_search_info(obj, request, (struct dl_serinfo *)p);
3916 _rtld_error("Invalid request %d passed to dlinfo()", request);
3920 lock_release(rtld_bind_lock, &lockstate);
3926 rtld_fill_dl_phdr_info(const Obj_Entry *obj, struct dl_phdr_info *phdr_info)
3930 phdr_info->dlpi_addr = (Elf_Addr)obj->relocbase;
3931 phdr_info->dlpi_name = obj->path;
3932 phdr_info->dlpi_phdr = obj->phdr;
3933 phdr_info->dlpi_phnum = obj->phsize / sizeof(obj->phdr[0]);
3934 phdr_info->dlpi_tls_modid = obj->tlsindex;
3936 phdr_info->dlpi_tls_data = (char *)tls_get_addr_slow(dtvp,
3937 obj->tlsindex, 0, true) + TLS_DTV_OFFSET;
3938 phdr_info->dlpi_adds = obj_loads;
3939 phdr_info->dlpi_subs = obj_loads - obj_count;
3943 dl_iterate_phdr(__dl_iterate_hdr_callback callback, void *param)
3945 struct dl_phdr_info phdr_info;
3946 Obj_Entry *obj, marker;
3947 RtldLockState bind_lockstate, phdr_lockstate;
3950 init_marker(&marker);
3953 wlock_acquire(rtld_phdr_lock, &phdr_lockstate);
3954 wlock_acquire(rtld_bind_lock, &bind_lockstate);
3955 for (obj = globallist_curr(TAILQ_FIRST(&obj_list)); obj != NULL;) {
3956 TAILQ_INSERT_AFTER(&obj_list, obj, &marker, next);
3957 rtld_fill_dl_phdr_info(obj, &phdr_info);
3959 lock_release(rtld_bind_lock, &bind_lockstate);
3961 error = callback(&phdr_info, sizeof phdr_info, param);
3963 wlock_acquire(rtld_bind_lock, &bind_lockstate);
3965 obj = globallist_next(&marker);
3966 TAILQ_REMOVE(&obj_list, &marker, next);
3968 lock_release(rtld_bind_lock, &bind_lockstate);
3969 lock_release(rtld_phdr_lock, &phdr_lockstate);
3975 rtld_fill_dl_phdr_info(&obj_rtld, &phdr_info);
3976 lock_release(rtld_bind_lock, &bind_lockstate);
3977 error = callback(&phdr_info, sizeof(phdr_info), param);
3979 lock_release(rtld_phdr_lock, &phdr_lockstate);
3984 fill_search_info(const char *dir, size_t dirlen, void *param)
3986 struct fill_search_info_args *arg;
3990 if (arg->request == RTLD_DI_SERINFOSIZE) {
3991 arg->serinfo->dls_cnt ++;
3992 arg->serinfo->dls_size += sizeof(struct dl_serpath) + dirlen + 1;
3994 struct dl_serpath *s_entry;
3996 s_entry = arg->serpath;
3997 s_entry->dls_name = arg->strspace;
3998 s_entry->dls_flags = arg->flags;
4000 strncpy(arg->strspace, dir, dirlen);
4001 arg->strspace[dirlen] = '\0';
4003 arg->strspace += dirlen + 1;
4011 do_search_info(const Obj_Entry *obj, int request, struct dl_serinfo *info)
4013 struct dl_serinfo _info;
4014 struct fill_search_info_args args;
4016 args.request = RTLD_DI_SERINFOSIZE;
4017 args.serinfo = &_info;
4019 _info.dls_size = __offsetof(struct dl_serinfo, dls_serpath);
4022 path_enumerate(obj->rpath, fill_search_info, NULL, &args);
4023 path_enumerate(ld_library_path, fill_search_info, NULL, &args);
4024 path_enumerate(obj->runpath, fill_search_info, NULL, &args);
4025 path_enumerate(gethints(obj->z_nodeflib), fill_search_info, NULL, &args);
4026 if (!obj->z_nodeflib)
4027 path_enumerate(ld_standard_library_path, fill_search_info, NULL, &args);
4030 if (request == RTLD_DI_SERINFOSIZE) {
4031 info->dls_size = _info.dls_size;
4032 info->dls_cnt = _info.dls_cnt;
4036 if (info->dls_cnt != _info.dls_cnt || info->dls_size != _info.dls_size) {
4037 _rtld_error("Uninitialized Dl_serinfo struct passed to dlinfo()");
4041 args.request = RTLD_DI_SERINFO;
4042 args.serinfo = info;
4043 args.serpath = &info->dls_serpath[0];
4044 args.strspace = (char *)&info->dls_serpath[_info.dls_cnt];
4046 args.flags = LA_SER_RUNPATH;
4047 if (path_enumerate(obj->rpath, fill_search_info, NULL, &args) != NULL)
4050 args.flags = LA_SER_LIBPATH;
4051 if (path_enumerate(ld_library_path, fill_search_info, NULL, &args) != NULL)
4054 args.flags = LA_SER_RUNPATH;
4055 if (path_enumerate(obj->runpath, fill_search_info, NULL, &args) != NULL)
4058 args.flags = LA_SER_CONFIG;
4059 if (path_enumerate(gethints(obj->z_nodeflib), fill_search_info, NULL, &args)
4063 args.flags = LA_SER_DEFAULT;
4064 if (!obj->z_nodeflib && path_enumerate(ld_standard_library_path,
4065 fill_search_info, NULL, &args) != NULL)
4071 rtld_dirname(const char *path, char *bname)
4075 /* Empty or NULL string gets treated as "." */
4076 if (path == NULL || *path == '\0') {
4082 /* Strip trailing slashes */
4083 endp = path + strlen(path) - 1;
4084 while (endp > path && *endp == '/')
4087 /* Find the start of the dir */
4088 while (endp > path && *endp != '/')
4091 /* Either the dir is "/" or there are no slashes */
4093 bname[0] = *endp == '/' ? '/' : '.';
4099 } while (endp > path && *endp == '/');
4102 if (endp - path + 2 > PATH_MAX)
4104 _rtld_error("Filename is too long: %s", path);
4108 strncpy(bname, path, endp - path + 1);
4109 bname[endp - path + 1] = '\0';
4114 rtld_dirname_abs(const char *path, char *base)
4118 if (realpath(path, base) == NULL) {
4119 _rtld_error("realpath \"%s\" failed (%s)", path,
4120 rtld_strerror(errno));
4123 dbg("%s -> %s", path, base);
4124 last = strrchr(base, '/');
4126 _rtld_error("non-abs result from realpath \"%s\"", path);
4135 linkmap_add(Obj_Entry *obj)
4137 struct link_map *l, *prev;
4140 l->l_name = obj->path;
4141 l->l_base = obj->mapbase;
4142 l->l_ld = obj->dynamic;
4143 l->l_addr = obj->relocbase;
4145 if (r_debug.r_map == NULL) {
4151 * Scan to the end of the list, but not past the entry for the
4152 * dynamic linker, which we want to keep at the very end.
4154 for (prev = r_debug.r_map;
4155 prev->l_next != NULL && prev->l_next != &obj_rtld.linkmap;
4156 prev = prev->l_next)
4159 /* Link in the new entry. */
4161 l->l_next = prev->l_next;
4162 if (l->l_next != NULL)
4163 l->l_next->l_prev = l;
4168 linkmap_delete(Obj_Entry *obj)
4173 if (l->l_prev == NULL) {
4174 if ((r_debug.r_map = l->l_next) != NULL)
4175 l->l_next->l_prev = NULL;
4179 if ((l->l_prev->l_next = l->l_next) != NULL)
4180 l->l_next->l_prev = l->l_prev;
4184 * Function for the debugger to set a breakpoint on to gain control.
4186 * The two parameters allow the debugger to easily find and determine
4187 * what the runtime loader is doing and to whom it is doing it.
4189 * When the loadhook trap is hit (r_debug_state, set at program
4190 * initialization), the arguments can be found on the stack:
4192 * +8 struct link_map *m
4193 * +4 struct r_debug *rd
4197 r_debug_state(struct r_debug* rd __unused, struct link_map *m __unused)
4200 * The following is a hack to force the compiler to emit calls to
4201 * this function, even when optimizing. If the function is empty,
4202 * the compiler is not obliged to emit any code for calls to it,
4203 * even when marked __noinline. However, gdb depends on those
4206 __compiler_membar();
4210 * A function called after init routines have completed. This can be used to
4211 * break before a program's entry routine is called, and can be used when
4212 * main is not available in the symbol table.
4215 _r_debug_postinit(struct link_map *m __unused)
4218 /* See r_debug_state(). */
4219 __compiler_membar();
4223 release_object(Obj_Entry *obj)
4226 if (obj->holdcount > 0) {
4227 obj->unholdfree = true;
4230 munmap(obj->mapbase, obj->mapsize);
4231 linkmap_delete(obj);
4236 * Get address of the pointer variable in the main program.
4237 * Prefer non-weak symbol over the weak one.
4239 static const void **
4240 get_program_var_addr(const char *name, RtldLockState *lockstate)
4245 symlook_init(&req, name);
4246 req.lockstate = lockstate;
4247 donelist_init(&donelist);
4248 if (symlook_global(&req, &donelist) != 0)
4250 if (ELF_ST_TYPE(req.sym_out->st_info) == STT_FUNC)
4251 return ((const void **)make_function_pointer(req.sym_out,
4253 else if (ELF_ST_TYPE(req.sym_out->st_info) == STT_GNU_IFUNC)
4254 return ((const void **)rtld_resolve_ifunc(req.defobj_out, req.sym_out));
4256 return ((const void **)(req.defobj_out->relocbase +
4257 req.sym_out->st_value));
4261 * Set a pointer variable in the main program to the given value. This
4262 * is used to set key variables such as "environ" before any of the
4263 * init functions are called.
4266 set_program_var(const char *name, const void *value)
4270 if ((addr = get_program_var_addr(name, NULL)) != NULL) {
4271 dbg("\"%s\": *%p <-- %p", name, addr, value);
4277 * Search the global objects, including dependencies and main object,
4278 * for the given symbol.
4281 symlook_global(SymLook *req, DoneList *donelist)
4284 const Objlist_Entry *elm;
4287 symlook_init_from_req(&req1, req);
4289 /* Search all objects loaded at program start up. */
4290 if (req->defobj_out == NULL ||
4291 ELF_ST_BIND(req->sym_out->st_info) == STB_WEAK) {
4292 res = symlook_list(&req1, &list_main, donelist);
4293 if (res == 0 && (req->defobj_out == NULL ||
4294 ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK)) {
4295 req->sym_out = req1.sym_out;
4296 req->defobj_out = req1.defobj_out;
4297 assert(req->defobj_out != NULL);
4301 /* Search all DAGs whose roots are RTLD_GLOBAL objects. */
4302 STAILQ_FOREACH(elm, &list_global, link) {
4303 if (req->defobj_out != NULL &&
4304 ELF_ST_BIND(req->sym_out->st_info) != STB_WEAK)
4306 res = symlook_list(&req1, &elm->obj->dagmembers, donelist);
4307 if (res == 0 && (req->defobj_out == NULL ||
4308 ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK)) {
4309 req->sym_out = req1.sym_out;
4310 req->defobj_out = req1.defobj_out;
4311 assert(req->defobj_out != NULL);
4315 return (req->sym_out != NULL ? 0 : ESRCH);
4319 * Given a symbol name in a referencing object, find the corresponding
4320 * definition of the symbol. Returns a pointer to the symbol, or NULL if
4321 * no definition was found. Returns a pointer to the Obj_Entry of the
4322 * defining object via the reference parameter DEFOBJ_OUT.
4325 symlook_default(SymLook *req, const Obj_Entry *refobj)
4328 const Objlist_Entry *elm;
4332 donelist_init(&donelist);
4333 symlook_init_from_req(&req1, req);
4336 * Look first in the referencing object if linked symbolically,
4337 * and similarly handle protected symbols.
4339 res = symlook_obj(&req1, refobj);
4340 if (res == 0 && (refobj->symbolic ||
4341 ELF_ST_VISIBILITY(req1.sym_out->st_other) == STV_PROTECTED)) {
4342 req->sym_out = req1.sym_out;
4343 req->defobj_out = req1.defobj_out;
4344 assert(req->defobj_out != NULL);
4346 if (refobj->symbolic || req->defobj_out != NULL)
4347 donelist_check(&donelist, refobj);
4349 symlook_global(req, &donelist);
4351 /* Search all dlopened DAGs containing the referencing object. */
4352 STAILQ_FOREACH(elm, &refobj->dldags, link) {
4353 if (req->sym_out != NULL &&
4354 ELF_ST_BIND(req->sym_out->st_info) != STB_WEAK)
4356 res = symlook_list(&req1, &elm->obj->dagmembers, &donelist);
4357 if (res == 0 && (req->sym_out == NULL ||
4358 ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK)) {
4359 req->sym_out = req1.sym_out;
4360 req->defobj_out = req1.defobj_out;
4361 assert(req->defobj_out != NULL);
4366 * Search the dynamic linker itself, and possibly resolve the
4367 * symbol from there. This is how the application links to
4368 * dynamic linker services such as dlopen.
4370 if (req->sym_out == NULL ||
4371 ELF_ST_BIND(req->sym_out->st_info) == STB_WEAK) {
4372 res = symlook_obj(&req1, &obj_rtld);
4374 req->sym_out = req1.sym_out;
4375 req->defobj_out = req1.defobj_out;
4376 assert(req->defobj_out != NULL);
4380 return (req->sym_out != NULL ? 0 : ESRCH);
4384 symlook_list(SymLook *req, const Objlist *objlist, DoneList *dlp)
4387 const Obj_Entry *defobj;
4388 const Objlist_Entry *elm;
4394 STAILQ_FOREACH(elm, objlist, link) {
4395 if (donelist_check(dlp, elm->obj))
4397 symlook_init_from_req(&req1, req);
4398 if ((res = symlook_obj(&req1, elm->obj)) == 0) {
4399 if (def == NULL || ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK) {
4401 defobj = req1.defobj_out;
4402 if (ELF_ST_BIND(def->st_info) != STB_WEAK)
4409 req->defobj_out = defobj;
4416 * Search the chain of DAGS cointed to by the given Needed_Entry
4417 * for a symbol of the given name. Each DAG is scanned completely
4418 * before advancing to the next one. Returns a pointer to the symbol,
4419 * or NULL if no definition was found.
4422 symlook_needed(SymLook *req, const Needed_Entry *needed, DoneList *dlp)
4425 const Needed_Entry *n;
4426 const Obj_Entry *defobj;
4432 symlook_init_from_req(&req1, req);
4433 for (n = needed; n != NULL; n = n->next) {
4434 if (n->obj == NULL ||
4435 (res = symlook_list(&req1, &n->obj->dagmembers, dlp)) != 0)
4437 if (def == NULL || ELF_ST_BIND(req1.sym_out->st_info) != STB_WEAK) {
4439 defobj = req1.defobj_out;
4440 if (ELF_ST_BIND(def->st_info) != STB_WEAK)
4446 req->defobj_out = defobj;
4453 * Search the symbol table of a single shared object for a symbol of
4454 * the given name and version, if requested. Returns a pointer to the
4455 * symbol, or NULL if no definition was found. If the object is
4456 * filter, return filtered symbol from filtee.
4458 * The symbol's hash value is passed in for efficiency reasons; that
4459 * eliminates many recomputations of the hash value.
4462 symlook_obj(SymLook *req, const Obj_Entry *obj)
4466 int flags, res, mres;
4469 * If there is at least one valid hash at this point, we prefer to
4470 * use the faster GNU version if available.
4472 if (obj->valid_hash_gnu)
4473 mres = symlook_obj1_gnu(req, obj);
4474 else if (obj->valid_hash_sysv)
4475 mres = symlook_obj1_sysv(req, obj);
4480 if (obj->needed_filtees != NULL) {
4481 flags = (req->flags & SYMLOOK_EARLY) ? RTLD_LO_EARLY : 0;
4482 load_filtees(__DECONST(Obj_Entry *, obj), flags, req->lockstate);
4483 donelist_init(&donelist);
4484 symlook_init_from_req(&req1, req);
4485 res = symlook_needed(&req1, obj->needed_filtees, &donelist);
4487 req->sym_out = req1.sym_out;
4488 req->defobj_out = req1.defobj_out;
4492 if (obj->needed_aux_filtees != NULL) {
4493 flags = (req->flags & SYMLOOK_EARLY) ? RTLD_LO_EARLY : 0;
4494 load_filtees(__DECONST(Obj_Entry *, obj), flags, req->lockstate);
4495 donelist_init(&donelist);
4496 symlook_init_from_req(&req1, req);
4497 res = symlook_needed(&req1, obj->needed_aux_filtees, &donelist);
4499 req->sym_out = req1.sym_out;
4500 req->defobj_out = req1.defobj_out;
4508 /* Symbol match routine common to both hash functions */
4510 matched_symbol(SymLook *req, const Obj_Entry *obj, Sym_Match_Result *result,
4511 const unsigned long symnum)
4514 const Elf_Sym *symp;
4517 symp = obj->symtab + symnum;
4518 strp = obj->strtab + symp->st_name;
4520 switch (ELF_ST_TYPE(symp->st_info)) {
4526 if (symp->st_value == 0)
4530 if (symp->st_shndx != SHN_UNDEF)
4533 else if (((req->flags & SYMLOOK_IN_PLT) == 0) &&
4534 (ELF_ST_TYPE(symp->st_info) == STT_FUNC))
4541 if (req->name[0] != strp[0] || strcmp(req->name, strp) != 0)
4544 if (req->ventry == NULL) {
4545 if (obj->versyms != NULL) {
4546 verndx = VER_NDX(obj->versyms[symnum]);
4547 if (verndx > obj->vernum) {
4549 "%s: symbol %s references wrong version %d",
4550 obj->path, obj->strtab + symnum, verndx);
4554 * If we are not called from dlsym (i.e. this
4555 * is a normal relocation from unversioned
4556 * binary), accept the symbol immediately if
4557 * it happens to have first version after this
4558 * shared object became versioned. Otherwise,
4559 * if symbol is versioned and not hidden,
4560 * remember it. If it is the only symbol with
4561 * this name exported by the shared object, it
4562 * will be returned as a match by the calling
4563 * function. If symbol is global (verndx < 2)
4564 * accept it unconditionally.
4566 if ((req->flags & SYMLOOK_DLSYM) == 0 &&
4567 verndx == VER_NDX_GIVEN) {
4568 result->sym_out = symp;
4571 else if (verndx >= VER_NDX_GIVEN) {
4572 if ((obj->versyms[symnum] & VER_NDX_HIDDEN)
4574 if (result->vsymp == NULL)
4575 result->vsymp = symp;
4581 result->sym_out = symp;
4584 if (obj->versyms == NULL) {
4585 if (object_match_name(obj, req->ventry->name)) {
4586 _rtld_error("%s: object %s should provide version %s "
4587 "for symbol %s", obj_rtld.path, obj->path,
4588 req->ventry->name, obj->strtab + symnum);
4592 verndx = VER_NDX(obj->versyms[symnum]);
4593 if (verndx > obj->vernum) {
4594 _rtld_error("%s: symbol %s references wrong version %d",
4595 obj->path, obj->strtab + symnum, verndx);
4598 if (obj->vertab[verndx].hash != req->ventry->hash ||
4599 strcmp(obj->vertab[verndx].name, req->ventry->name)) {
4601 * Version does not match. Look if this is a
4602 * global symbol and if it is not hidden. If
4603 * global symbol (verndx < 2) is available,
4604 * use it. Do not return symbol if we are
4605 * called by dlvsym, because dlvsym looks for
4606 * a specific version and default one is not
4607 * what dlvsym wants.
4609 if ((req->flags & SYMLOOK_DLSYM) ||
4610 (verndx >= VER_NDX_GIVEN) ||
4611 (obj->versyms[symnum] & VER_NDX_HIDDEN))
4615 result->sym_out = symp;
4620 * Search for symbol using SysV hash function.
4621 * obj->buckets is known not to be NULL at this point; the test for this was
4622 * performed with the obj->valid_hash_sysv assignment.
4625 symlook_obj1_sysv(SymLook *req, const Obj_Entry *obj)
4627 unsigned long symnum;
4628 Sym_Match_Result matchres;
4630 matchres.sym_out = NULL;
4631 matchres.vsymp = NULL;
4632 matchres.vcount = 0;
4634 for (symnum = obj->buckets[req->hash % obj->nbuckets];
4635 symnum != STN_UNDEF; symnum = obj->chains[symnum]) {
4636 if (symnum >= obj->nchains)
4637 return (ESRCH); /* Bad object */
4639 if (matched_symbol(req, obj, &matchres, symnum)) {
4640 req->sym_out = matchres.sym_out;
4641 req->defobj_out = obj;
4645 if (matchres.vcount == 1) {
4646 req->sym_out = matchres.vsymp;
4647 req->defobj_out = obj;
4653 /* Search for symbol using GNU hash function */
4655 symlook_obj1_gnu(SymLook *req, const Obj_Entry *obj)
4657 Elf_Addr bloom_word;
4658 const Elf32_Word *hashval;
4660 Sym_Match_Result matchres;
4661 unsigned int h1, h2;
4662 unsigned long symnum;
4664 matchres.sym_out = NULL;
4665 matchres.vsymp = NULL;
4666 matchres.vcount = 0;
4668 /* Pick right bitmask word from Bloom filter array */
4669 bloom_word = obj->bloom_gnu[(req->hash_gnu / __ELF_WORD_SIZE) &
4670 obj->maskwords_bm_gnu];
4672 /* Calculate modulus word size of gnu hash and its derivative */
4673 h1 = req->hash_gnu & (__ELF_WORD_SIZE - 1);
4674 h2 = ((req->hash_gnu >> obj->shift2_gnu) & (__ELF_WORD_SIZE - 1));
4676 /* Filter out the "definitely not in set" queries */
4677 if (((bloom_word >> h1) & (bloom_word >> h2) & 1) == 0)
4680 /* Locate hash chain and corresponding value element*/
4681 bucket = obj->buckets_gnu[req->hash_gnu % obj->nbuckets_gnu];
4684 hashval = &obj->chain_zero_gnu[bucket];
4686 if (((*hashval ^ req->hash_gnu) >> 1) == 0) {
4687 symnum = hashval - obj->chain_zero_gnu;
4688 if (matched_symbol(req, obj, &matchres, symnum)) {
4689 req->sym_out = matchres.sym_out;
4690 req->defobj_out = obj;
4694 } while ((*hashval++ & 1) == 0);
4695 if (matchres.vcount == 1) {
4696 req->sym_out = matchres.vsymp;
4697 req->defobj_out = obj;
4704 trace_loaded_objects(Obj_Entry *obj)
4706 const char *fmt1, *fmt2, *fmt, *main_local, *list_containers;
4709 if ((main_local = getenv(_LD("TRACE_LOADED_OBJECTS_PROGNAME"))) == NULL)
4712 if ((fmt1 = getenv(_LD("TRACE_LOADED_OBJECTS_FMT1"))) == NULL)
4713 fmt1 = "\t%o => %p (%x)\n";
4715 if ((fmt2 = getenv(_LD("TRACE_LOADED_OBJECTS_FMT2"))) == NULL)
4716 fmt2 = "\t%o (%x)\n";
4718 list_containers = getenv(_LD("TRACE_LOADED_OBJECTS_ALL"));
4720 for (; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
4721 Needed_Entry *needed;
4722 const char *name, *path;
4727 if (list_containers && obj->needed != NULL)
4728 rtld_printf("%s:\n", obj->path);
4729 for (needed = obj->needed; needed; needed = needed->next) {
4730 if (needed->obj != NULL) {
4731 if (needed->obj->traced && !list_containers)
4733 needed->obj->traced = true;
4734 path = needed->obj->path;
4738 name = obj->strtab + needed->name;
4739 is_lib = strncmp(name, "lib", 3) == 0; /* XXX - bogus */
4741 fmt = is_lib ? fmt1 : fmt2;
4742 while ((c = *fmt++) != '\0') {
4768 rtld_putstr(main_local);
4771 rtld_putstr(obj_main->path);
4778 rtld_printf("%d", sodp->sod_major);
4781 rtld_printf("%d", sodp->sod_minor);
4788 rtld_printf("%p", needed->obj ? needed->obj->mapbase :
4801 * Unload a dlopened object and its dependencies from memory and from
4802 * our data structures. It is assumed that the DAG rooted in the
4803 * object has already been unreferenced, and that the object has a
4804 * reference count of 0.
4807 unload_object(Obj_Entry *root, RtldLockState *lockstate)
4809 Obj_Entry marker, *obj, *next;
4811 assert(root->refcount == 0);
4814 * Pass over the DAG removing unreferenced objects from
4815 * appropriate lists.
4817 unlink_object(root);
4819 /* Unmap all objects that are no longer referenced. */
4820 for (obj = TAILQ_FIRST(&obj_list); obj != NULL; obj = next) {
4821 next = TAILQ_NEXT(obj, next);
4822 if (obj->marker || obj->refcount != 0)
4824 LD_UTRACE(UTRACE_UNLOAD_OBJECT, obj, obj->mapbase,
4825 obj->mapsize, 0, obj->path);
4826 dbg("unloading \"%s\"", obj->path);
4828 * Unlink the object now to prevent new references from
4829 * being acquired while the bind lock is dropped in
4830 * recursive dlclose() invocations.
4832 TAILQ_REMOVE(&obj_list, obj, next);
4835 if (obj->filtees_loaded) {
4837 init_marker(&marker);
4838 TAILQ_INSERT_BEFORE(next, &marker, next);
4839 unload_filtees(obj, lockstate);
4840 next = TAILQ_NEXT(&marker, next);
4841 TAILQ_REMOVE(&obj_list, &marker, next);
4843 unload_filtees(obj, lockstate);
4845 release_object(obj);
4850 unlink_object(Obj_Entry *root)
4854 if (root->refcount == 0) {
4855 /* Remove the object from the RTLD_GLOBAL list. */
4856 objlist_remove(&list_global, root);
4858 /* Remove the object from all objects' DAG lists. */
4859 STAILQ_FOREACH(elm, &root->dagmembers, link) {
4860 objlist_remove(&elm->obj->dldags, root);
4861 if (elm->obj != root)
4862 unlink_object(elm->obj);
4868 ref_dag(Obj_Entry *root)
4872 assert(root->dag_inited);
4873 STAILQ_FOREACH(elm, &root->dagmembers, link)
4874 elm->obj->refcount++;
4878 unref_dag(Obj_Entry *root)
4882 assert(root->dag_inited);
4883 STAILQ_FOREACH(elm, &root->dagmembers, link)
4884 elm->obj->refcount--;
4888 * Common code for MD __tls_get_addr().
4891 tls_get_addr_slow(Elf_Addr **dtvp, int index, size_t offset, bool locked)
4893 Elf_Addr *newdtv, *dtv;
4894 RtldLockState lockstate;
4898 /* Check dtv generation in case new modules have arrived */
4899 if (dtv[0] != tls_dtv_generation) {
4901 wlock_acquire(rtld_bind_lock, &lockstate);
4902 newdtv = xcalloc(tls_max_index + 2, sizeof(Elf_Addr));
4904 if (to_copy > tls_max_index)
4905 to_copy = tls_max_index;
4906 memcpy(&newdtv[2], &dtv[2], to_copy * sizeof(Elf_Addr));
4907 newdtv[0] = tls_dtv_generation;
4908 newdtv[1] = tls_max_index;
4911 lock_release(rtld_bind_lock, &lockstate);
4912 dtv = *dtvp = newdtv;
4915 /* Dynamically allocate module TLS if necessary */
4916 if (dtv[index + 1] == 0) {
4917 /* Signal safe, wlock will block out signals. */
4919 wlock_acquire(rtld_bind_lock, &lockstate);
4920 if (!dtv[index + 1])
4921 dtv[index + 1] = (Elf_Addr)allocate_module_tls(index);
4923 lock_release(rtld_bind_lock, &lockstate);
4925 return ((void *)(dtv[index + 1] + offset));
4929 tls_get_addr_common(Elf_Addr **dtvp, int index, size_t offset)
4934 /* Check dtv generation in case new modules have arrived */
4935 if (__predict_true(dtv[0] == tls_dtv_generation &&
4936 dtv[index + 1] != 0))
4937 return ((void *)(dtv[index + 1] + offset));
4938 return (tls_get_addr_slow(dtvp, index, offset, false));
4941 #if defined(__aarch64__) || defined(__arm__) || defined(__mips__) || \
4942 defined(__powerpc__) || defined(__riscv)
4945 * Return pointer to allocated TLS block
4948 get_tls_block_ptr(void *tcb, size_t tcbsize)
4950 size_t extra_size, post_size, pre_size, tls_block_size;
4951 size_t tls_init_align;
4953 tls_init_align = MAX(obj_main->tlsalign, 1);
4955 /* Compute fragments sizes. */
4956 extra_size = tcbsize - TLS_TCB_SIZE;
4957 post_size = calculate_tls_post_size(tls_init_align);
4958 tls_block_size = tcbsize + post_size;
4959 pre_size = roundup2(tls_block_size, tls_init_align) - tls_block_size;
4961 return ((char *)tcb - pre_size - extra_size);
4965 * Allocate Static TLS using the Variant I method.
4967 * For details on the layout, see lib/libc/gen/tls.c.
4969 * NB: rtld's tls_static_space variable includes TLS_TCB_SIZE and post_size as
4970 * it is based on tls_last_offset, and TLS offsets here are really TCB
4971 * offsets, whereas libc's tls_static_space is just the executable's static
4975 allocate_tls(Obj_Entry *objs, void *oldtcb, size_t tcbsize, size_t tcbalign)
4979 Elf_Addr *dtv, **tcb;
4982 size_t extra_size, maxalign, post_size, pre_size, tls_block_size;
4983 size_t tls_init_align, tls_init_offset;
4985 if (oldtcb != NULL && tcbsize == TLS_TCB_SIZE)
4988 assert(tcbsize >= TLS_TCB_SIZE);
4989 maxalign = MAX(tcbalign, tls_static_max_align);
4990 tls_init_align = MAX(obj_main->tlsalign, 1);
4992 /* Compute fragmets sizes. */
4993 extra_size = tcbsize - TLS_TCB_SIZE;
4994 post_size = calculate_tls_post_size(tls_init_align);
4995 tls_block_size = tcbsize + post_size;
4996 pre_size = roundup2(tls_block_size, tls_init_align) - tls_block_size;
4997 tls_block_size += pre_size + tls_static_space - TLS_TCB_SIZE - post_size;
4999 /* Allocate whole TLS block */
5000 tls_block = malloc_aligned(tls_block_size, maxalign, 0);
5001 tcb = (Elf_Addr **)(tls_block + pre_size + extra_size);
5003 if (oldtcb != NULL) {
5004 memcpy(tls_block, get_tls_block_ptr(oldtcb, tcbsize),
5006 free_aligned(get_tls_block_ptr(oldtcb, tcbsize));
5008 /* Adjust the DTV. */
5010 for (i = 0; i < dtv[1]; i++) {
5011 if (dtv[i+2] >= (Elf_Addr)oldtcb &&
5012 dtv[i+2] < (Elf_Addr)oldtcb + tls_static_space) {
5013 dtv[i+2] = dtv[i+2] - (Elf_Addr)oldtcb + (Elf_Addr)tcb;
5017 dtv = xcalloc(tls_max_index + 2, sizeof(Elf_Addr));
5019 dtv[0] = tls_dtv_generation;
5020 dtv[1] = tls_max_index;
5022 for (obj = globallist_curr(objs); obj != NULL;
5023 obj = globallist_next(obj)) {
5024 if (obj->tlsoffset == 0)
5026 tls_init_offset = obj->tlspoffset & (obj->tlsalign - 1);
5027 addr = (Elf_Addr)tcb + obj->tlsoffset;
5028 if (tls_init_offset > 0)
5029 memset((void *)addr, 0, tls_init_offset);
5030 if (obj->tlsinitsize > 0) {
5031 memcpy((void *)(addr + tls_init_offset), obj->tlsinit,
5034 if (obj->tlssize > obj->tlsinitsize) {
5035 memset((void *)(addr + tls_init_offset + obj->tlsinitsize),
5036 0, obj->tlssize - obj->tlsinitsize - tls_init_offset);
5038 dtv[obj->tlsindex + 1] = addr;
5046 free_tls(void *tcb, size_t tcbsize, size_t tcbalign __unused)
5049 Elf_Addr tlsstart, tlsend;
5051 size_t dtvsize, i, tls_init_align;
5053 assert(tcbsize >= TLS_TCB_SIZE);
5054 tls_init_align = MAX(obj_main->tlsalign, 1);
5056 /* Compute fragments sizes. */
5057 post_size = calculate_tls_post_size(tls_init_align);
5059 tlsstart = (Elf_Addr)tcb + TLS_TCB_SIZE + post_size;
5060 tlsend = (Elf_Addr)tcb + tls_static_space;
5062 dtv = *(Elf_Addr **)tcb;
5064 for (i = 0; i < dtvsize; i++) {
5065 if (dtv[i+2] && (dtv[i+2] < tlsstart || dtv[i+2] >= tlsend)) {
5066 free((void*)dtv[i+2]);
5070 free_aligned(get_tls_block_ptr(tcb, tcbsize));
5075 #if defined(__i386__) || defined(__amd64__)
5078 * Allocate Static TLS using the Variant II method.
5081 allocate_tls(Obj_Entry *objs, void *oldtls, size_t tcbsize, size_t tcbalign)
5084 size_t size, ralign;
5086 Elf_Addr *dtv, *olddtv;
5087 Elf_Addr segbase, oldsegbase, addr;
5091 if (tls_static_max_align > ralign)
5092 ralign = tls_static_max_align;
5093 size = roundup(tls_static_space, ralign) + roundup(tcbsize, ralign);
5095 assert(tcbsize >= 2*sizeof(Elf_Addr));
5096 tls = malloc_aligned(size, ralign, 0 /* XXX */);
5097 dtv = xcalloc(tls_max_index + 2, sizeof(Elf_Addr));
5099 segbase = (Elf_Addr)(tls + roundup(tls_static_space, ralign));
5100 ((Elf_Addr*)segbase)[0] = segbase;
5101 ((Elf_Addr*)segbase)[1] = (Elf_Addr) dtv;
5103 dtv[0] = tls_dtv_generation;
5104 dtv[1] = tls_max_index;
5108 * Copy the static TLS block over whole.
5110 oldsegbase = (Elf_Addr) oldtls;
5111 memcpy((void *)(segbase - tls_static_space),
5112 (const void *)(oldsegbase - tls_static_space),
5116 * If any dynamic TLS blocks have been created tls_get_addr(),
5119 olddtv = ((Elf_Addr**)oldsegbase)[1];
5120 for (i = 0; i < olddtv[1]; i++) {
5121 if (olddtv[i+2] < oldsegbase - size || olddtv[i+2] > oldsegbase) {
5122 dtv[i+2] = olddtv[i+2];
5128 * We assume that this block was the one we created with
5129 * allocate_initial_tls().
5131 free_tls(oldtls, 2*sizeof(Elf_Addr), sizeof(Elf_Addr));
5133 for (obj = objs; obj != NULL; obj = TAILQ_NEXT(obj, next)) {
5134 if (obj->marker || obj->tlsoffset == 0)
5136 addr = segbase - obj->tlsoffset;
5137 memset((void*)(addr + obj->tlsinitsize),
5138 0, obj->tlssize - obj->tlsinitsize);
5140 memcpy((void*) addr, obj->tlsinit, obj->tlsinitsize);
5141 obj->static_tls_copied = true;
5143 dtv[obj->tlsindex + 1] = addr;
5147 return (void*) segbase;
5151 free_tls(void *tls, size_t tcbsize __unused, size_t tcbalign)
5154 size_t size, ralign;
5156 Elf_Addr tlsstart, tlsend;
5159 * Figure out the size of the initial TLS block so that we can
5160 * find stuff which ___tls_get_addr() allocated dynamically.
5163 if (tls_static_max_align > ralign)
5164 ralign = tls_static_max_align;
5165 size = roundup(tls_static_space, ralign);
5167 dtv = ((Elf_Addr**)tls)[1];
5169 tlsend = (Elf_Addr) tls;
5170 tlsstart = tlsend - size;
5171 for (i = 0; i < dtvsize; i++) {
5172 if (dtv[i + 2] != 0 && (dtv[i + 2] < tlsstart || dtv[i + 2] > tlsend)) {
5173 free_aligned((void *)dtv[i + 2]);
5177 free_aligned((void *)tlsstart);
5184 * Allocate TLS block for module with given index.
5187 allocate_module_tls(int index)
5192 TAILQ_FOREACH(obj, &obj_list, next) {
5195 if (obj->tlsindex == index)
5199 _rtld_error("Can't find module with TLS index %d", index);
5203 p = malloc_aligned(obj->tlssize, obj->tlsalign, obj->tlspoffset);
5204 memcpy(p, obj->tlsinit, obj->tlsinitsize);
5205 memset(p + obj->tlsinitsize, 0, obj->tlssize - obj->tlsinitsize);
5210 allocate_tls_offset(Obj_Entry *obj)
5217 if (obj->tlssize == 0) {
5218 obj->tls_done = true;
5222 if (tls_last_offset == 0)
5223 off = calculate_first_tls_offset(obj->tlssize, obj->tlsalign,
5226 off = calculate_tls_offset(tls_last_offset, tls_last_size,
5227 obj->tlssize, obj->tlsalign, obj->tlspoffset);
5230 * If we have already fixed the size of the static TLS block, we
5231 * must stay within that size. When allocating the static TLS, we
5232 * leave a small amount of space spare to be used for dynamically
5233 * loading modules which use static TLS.
5235 if (tls_static_space != 0) {
5236 if (calculate_tls_end(off, obj->tlssize) > tls_static_space)
5238 } else if (obj->tlsalign > tls_static_max_align) {
5239 tls_static_max_align = obj->tlsalign;
5242 tls_last_offset = obj->tlsoffset = off;
5243 tls_last_size = obj->tlssize;
5244 obj->tls_done = true;
5250 free_tls_offset(Obj_Entry *obj)
5254 * If we were the last thing to allocate out of the static TLS
5255 * block, we give our space back to the 'allocator'. This is a
5256 * simplistic workaround to allow libGL.so.1 to be loaded and
5257 * unloaded multiple times.
5259 if (calculate_tls_end(obj->tlsoffset, obj->tlssize)
5260 == calculate_tls_end(tls_last_offset, tls_last_size)) {
5261 tls_last_offset -= obj->tlssize;
5267 _rtld_allocate_tls(void *oldtls, size_t tcbsize, size_t tcbalign)
5270 RtldLockState lockstate;
5272 wlock_acquire(rtld_bind_lock, &lockstate);
5273 ret = allocate_tls(globallist_curr(TAILQ_FIRST(&obj_list)), oldtls,
5275 lock_release(rtld_bind_lock, &lockstate);
5280 _rtld_free_tls(void *tcb, size_t tcbsize, size_t tcbalign)
5282 RtldLockState lockstate;
5284 wlock_acquire(rtld_bind_lock, &lockstate);
5285 free_tls(tcb, tcbsize, tcbalign);
5286 lock_release(rtld_bind_lock, &lockstate);
5290 object_add_name(Obj_Entry *obj, const char *name)
5296 entry = malloc(sizeof(Name_Entry) + len);
5298 if (entry != NULL) {
5299 strcpy(entry->name, name);
5300 STAILQ_INSERT_TAIL(&obj->names, entry, link);
5305 object_match_name(const Obj_Entry *obj, const char *name)
5309 STAILQ_FOREACH(entry, &obj->names, link) {
5310 if (strcmp(name, entry->name) == 0)
5317 locate_dependency(const Obj_Entry *obj, const char *name)
5319 const Objlist_Entry *entry;
5320 const Needed_Entry *needed;
5322 STAILQ_FOREACH(entry, &list_main, link) {
5323 if (object_match_name(entry->obj, name))
5327 for (needed = obj->needed; needed != NULL; needed = needed->next) {
5328 if (strcmp(obj->strtab + needed->name, name) == 0 ||
5329 (needed->obj != NULL && object_match_name(needed->obj, name))) {
5331 * If there is DT_NEEDED for the name we are looking for,
5332 * we are all set. Note that object might not be found if
5333 * dependency was not loaded yet, so the function can
5334 * return NULL here. This is expected and handled
5335 * properly by the caller.
5337 return (needed->obj);
5340 _rtld_error("%s: Unexpected inconsistency: dependency %s not found",
5346 check_object_provided_version(Obj_Entry *refobj, const Obj_Entry *depobj,
5347 const Elf_Vernaux *vna)
5349 const Elf_Verdef *vd;
5350 const char *vername;
5352 vername = refobj->strtab + vna->vna_name;
5353 vd = depobj->verdef;
5355 _rtld_error("%s: version %s required by %s not defined",
5356 depobj->path, vername, refobj->path);
5360 if (vd->vd_version != VER_DEF_CURRENT) {
5361 _rtld_error("%s: Unsupported version %d of Elf_Verdef entry",
5362 depobj->path, vd->vd_version);
5365 if (vna->vna_hash == vd->vd_hash) {
5366 const Elf_Verdaux *aux = (const Elf_Verdaux *)
5367 ((const char *)vd + vd->vd_aux);
5368 if (strcmp(vername, depobj->strtab + aux->vda_name) == 0)
5371 if (vd->vd_next == 0)
5373 vd = (const Elf_Verdef *)((const char *)vd + vd->vd_next);
5375 if (vna->vna_flags & VER_FLG_WEAK)
5377 _rtld_error("%s: version %s required by %s not found",
5378 depobj->path, vername, refobj->path);
5383 rtld_verify_object_versions(Obj_Entry *obj)
5385 const Elf_Verneed *vn;
5386 const Elf_Verdef *vd;
5387 const Elf_Verdaux *vda;
5388 const Elf_Vernaux *vna;
5389 const Obj_Entry *depobj;
5390 int maxvernum, vernum;
5392 if (obj->ver_checked)
5394 obj->ver_checked = true;
5398 * Walk over defined and required version records and figure out
5399 * max index used by any of them. Do very basic sanity checking
5403 while (vn != NULL) {
5404 if (vn->vn_version != VER_NEED_CURRENT) {
5405 _rtld_error("%s: Unsupported version %d of Elf_Verneed entry",
5406 obj->path, vn->vn_version);
5409 vna = (const Elf_Vernaux *)((const char *)vn + vn->vn_aux);
5411 vernum = VER_NEED_IDX(vna->vna_other);
5412 if (vernum > maxvernum)
5414 if (vna->vna_next == 0)
5416 vna = (const Elf_Vernaux *)((const char *)vna + vna->vna_next);
5418 if (vn->vn_next == 0)
5420 vn = (const Elf_Verneed *)((const char *)vn + vn->vn_next);
5424 while (vd != NULL) {
5425 if (vd->vd_version != VER_DEF_CURRENT) {
5426 _rtld_error("%s: Unsupported version %d of Elf_Verdef entry",
5427 obj->path, vd->vd_version);
5430 vernum = VER_DEF_IDX(vd->vd_ndx);
5431 if (vernum > maxvernum)
5433 if (vd->vd_next == 0)
5435 vd = (const Elf_Verdef *)((const char *)vd + vd->vd_next);
5442 * Store version information in array indexable by version index.
5443 * Verify that object version requirements are satisfied along the
5446 obj->vernum = maxvernum + 1;
5447 obj->vertab = xcalloc(obj->vernum, sizeof(Ver_Entry));
5450 while (vd != NULL) {
5451 if ((vd->vd_flags & VER_FLG_BASE) == 0) {
5452 vernum = VER_DEF_IDX(vd->vd_ndx);
5453 assert(vernum <= maxvernum);
5454 vda = (const Elf_Verdaux *)((const char *)vd + vd->vd_aux);
5455 obj->vertab[vernum].hash = vd->vd_hash;
5456 obj->vertab[vernum].name = obj->strtab + vda->vda_name;
5457 obj->vertab[vernum].file = NULL;
5458 obj->vertab[vernum].flags = 0;
5460 if (vd->vd_next == 0)
5462 vd = (const Elf_Verdef *)((const char *)vd + vd->vd_next);
5466 while (vn != NULL) {
5467 depobj = locate_dependency(obj, obj->strtab + vn->vn_file);
5470 vna = (const Elf_Vernaux *)((const char *)vn + vn->vn_aux);
5472 if (check_object_provided_version(obj, depobj, vna))
5474 vernum = VER_NEED_IDX(vna->vna_other);
5475 assert(vernum <= maxvernum);
5476 obj->vertab[vernum].hash = vna->vna_hash;
5477 obj->vertab[vernum].name = obj->strtab + vna->vna_name;
5478 obj->vertab[vernum].file = obj->strtab + vn->vn_file;
5479 obj->vertab[vernum].flags = (vna->vna_other & VER_NEED_HIDDEN) ?
5480 VER_INFO_HIDDEN : 0;
5481 if (vna->vna_next == 0)
5483 vna = (const Elf_Vernaux *)((const char *)vna + vna->vna_next);
5485 if (vn->vn_next == 0)
5487 vn = (const Elf_Verneed *)((const char *)vn + vn->vn_next);
5493 rtld_verify_versions(const Objlist *objlist)
5495 Objlist_Entry *entry;
5499 STAILQ_FOREACH(entry, objlist, link) {
5501 * Skip dummy objects or objects that have their version requirements
5504 if (entry->obj->strtab == NULL || entry->obj->vertab != NULL)
5506 if (rtld_verify_object_versions(entry->obj) == -1) {
5508 if (ld_tracing == NULL)
5512 if (rc == 0 || ld_tracing != NULL)
5513 rc = rtld_verify_object_versions(&obj_rtld);
5518 fetch_ventry(const Obj_Entry *obj, unsigned long symnum)
5523 vernum = VER_NDX(obj->versyms[symnum]);
5524 if (vernum >= obj->vernum) {
5525 _rtld_error("%s: symbol %s has wrong verneed value %d",
5526 obj->path, obj->strtab + symnum, vernum);
5527 } else if (obj->vertab[vernum].hash != 0) {
5528 return &obj->vertab[vernum];
5535 _rtld_get_stack_prot(void)
5538 return (stack_prot);
5542 _rtld_is_dlopened(void *arg)
5545 RtldLockState lockstate;
5548 rlock_acquire(rtld_bind_lock, &lockstate);
5551 obj = obj_from_addr(arg);
5553 _rtld_error("No shared object contains address");
5554 lock_release(rtld_bind_lock, &lockstate);
5557 res = obj->dlopened ? 1 : 0;
5558 lock_release(rtld_bind_lock, &lockstate);
5563 obj_remap_relro(Obj_Entry *obj, int prot)
5566 if (obj->relro_size > 0 && mprotect(obj->relro_page, obj->relro_size,
5568 _rtld_error("%s: Cannot set relro protection to %#x: %s",
5569 obj->path, prot, rtld_strerror(errno));
5576 obj_disable_relro(Obj_Entry *obj)
5579 return (obj_remap_relro(obj, PROT_READ | PROT_WRITE));
5583 obj_enforce_relro(Obj_Entry *obj)
5586 return (obj_remap_relro(obj, PROT_READ));
5590 map_stacks_exec(RtldLockState *lockstate)
5592 void (*thr_map_stacks_exec)(void);
5594 if ((max_stack_flags & PF_X) == 0 || (stack_prot & PROT_EXEC) != 0)
5596 thr_map_stacks_exec = (void (*)(void))(uintptr_t)
5597 get_program_var_addr("__pthread_map_stacks_exec", lockstate);
5598 if (thr_map_stacks_exec != NULL) {
5599 stack_prot |= PROT_EXEC;
5600 thr_map_stacks_exec();
5605 distribute_static_tls(Objlist *list, RtldLockState *lockstate)
5609 void (*distrib)(size_t, void *, size_t, size_t);
5611 distrib = (void (*)(size_t, void *, size_t, size_t))(uintptr_t)
5612 get_program_var_addr("__pthread_distribute_static_tls", lockstate);
5613 if (distrib == NULL)
5615 STAILQ_FOREACH(elm, list, link) {
5617 if (obj->marker || !obj->tls_done || obj->static_tls_copied)
5619 distrib(obj->tlsoffset, obj->tlsinit, obj->tlsinitsize,
5621 obj->static_tls_copied = true;
5626 symlook_init(SymLook *dst, const char *name)
5629 bzero(dst, sizeof(*dst));
5631 dst->hash = elf_hash(name);
5632 dst->hash_gnu = gnu_hash(name);
5636 symlook_init_from_req(SymLook *dst, const SymLook *src)
5639 dst->name = src->name;
5640 dst->hash = src->hash;
5641 dst->hash_gnu = src->hash_gnu;
5642 dst->ventry = src->ventry;
5643 dst->flags = src->flags;
5644 dst->defobj_out = NULL;
5645 dst->sym_out = NULL;
5646 dst->lockstate = src->lockstate;
5650 open_binary_fd(const char *argv0, bool search_in_path,
5651 const char **binpath_res)
5653 char *binpath, *pathenv, *pe, *res1;
5659 if (search_in_path && strchr(argv0, '/') == NULL) {
5660 binpath = xmalloc(PATH_MAX);
5661 pathenv = getenv("PATH");
5662 if (pathenv == NULL) {
5663 _rtld_error("-p and no PATH environment variable");
5666 pathenv = strdup(pathenv);
5667 if (pathenv == NULL) {
5668 _rtld_error("Cannot allocate memory");
5673 while ((pe = strsep(&pathenv, ":")) != NULL) {
5674 if (strlcpy(binpath, pe, PATH_MAX) >= PATH_MAX)
5676 if (binpath[0] != '\0' &&
5677 strlcat(binpath, "/", PATH_MAX) >= PATH_MAX)
5679 if (strlcat(binpath, argv0, PATH_MAX) >= PATH_MAX)
5681 fd = open(binpath, O_RDONLY | O_CLOEXEC | O_VERIFY);
5682 if (fd != -1 || errno != ENOENT) {
5689 fd = open(argv0, O_RDONLY | O_CLOEXEC | O_VERIFY);
5694 _rtld_error("Cannot open %s: %s", argv0, rtld_strerror(errno));
5697 if (res != NULL && res[0] != '/') {
5698 res1 = xmalloc(PATH_MAX);
5699 if (realpath(res, res1) != NULL) {
5701 free(__DECONST(char *, res));
5712 * Parse a set of command-line arguments.
5715 parse_args(char* argv[], int argc, bool *use_pathp, int *fdp,
5721 int arglen, fd, i, j, mib[2];
5723 bool seen_b, seen_f;
5725 dbg("Parsing command-line arguments");
5728 seen_b = seen_f = false;
5730 for (i = 1; i < argc; i++ ) {
5732 dbg("argv[%d]: '%s'", i, arg);
5735 * rtld arguments end with an explicit "--" or with the first
5736 * non-prefixed argument.
5738 if (strcmp(arg, "--") == 0) {
5746 * All other arguments are single-character options that can
5747 * be combined, so we need to search through `arg` for them.
5749 arglen = strlen(arg);
5750 for (j = 1; j < arglen; j++) {
5753 print_usage(argv[0]);
5755 } else if (opt == 'b') {
5757 _rtld_error("Both -b and -f specified");
5764 } else if (opt == 'f') {
5766 _rtld_error("Both -b and -f specified");
5771 * -f XX can be used to specify a
5772 * descriptor for the binary named at
5773 * the command line (i.e., the later
5774 * argument will specify the process
5775 * name but the descriptor is what
5776 * will actually be executed).
5778 * -f must be the last option in, e.g., -abcf.
5780 if (j != arglen - 1) {
5781 _rtld_error("Invalid options: %s", arg);
5785 fd = parse_integer(argv[i]);
5788 "Invalid file descriptor: '%s'",
5795 } else if (opt == 'p') {
5797 } else if (opt == 'u') {
5799 } else if (opt == 'v') {
5802 mib[1] = HW_MACHINE;
5803 sz = sizeof(machine);
5804 sysctl(mib, nitems(mib), machine, &sz, NULL, 0);
5806 "FreeBSD ld-elf.so.1 %s\n"
5807 "FreeBSD_version %d\n"
5808 "Default lib path %s\n"
5813 __FreeBSD_version, ld_standard_library_path,
5814 ld_env_prefix, ld_elf_hints_default,
5815 ld_path_libmap_conf);
5818 _rtld_error("Invalid argument: '%s'", arg);
5819 print_usage(argv[0]);
5831 * Parse a file descriptor number without pulling in more of libc (e.g. atoi).
5834 parse_integer(const char *str)
5836 static const int RADIX = 10; /* XXXJA: possibly support hex? */
5843 for (c = *str; c != '\0'; c = *++str) {
5844 if (c < '0' || c > '9')
5851 /* Make sure we actually parsed something. */
5858 print_usage(const char *argv0)
5862 "Usage: %s [-h] [-b <exe>] [-f <FD>] [-p] [--] <binary> [<args>]\n"
5865 " -h Display this help message\n"
5866 " -b <exe> Execute <exe> instead of <binary>, arg0 is <binary>\n"
5867 " -f <FD> Execute <FD> instead of searching for <binary>\n"
5868 " -p Search in PATH for named binary\n"
5869 " -u Ignore LD_ environment variables\n"
5870 " -v Display identification information\n"
5871 " -- End of RTLD options\n"
5872 " <binary> Name of process to execute\n"
5873 " <args> Arguments to the executed process\n", argv0);
5877 * Overrides for libc_pic-provided functions.
5881 __getosreldate(void)
5891 oid[1] = KERN_OSRELDATE;
5893 len = sizeof(osrel);
5894 error = sysctl(oid, 2, &osrel, &len, NULL, 0);
5895 if (error == 0 && osrel > 0 && len == sizeof(osrel))
5900 rtld_strerror(int errnum)
5903 if (errnum < 0 || errnum >= sys_nerr)
5904 return ("Unknown error");
5905 return (sys_errlist[errnum]);
5910 malloc(size_t nbytes)
5913 return (__crt_malloc(nbytes));
5917 calloc(size_t num, size_t size)
5920 return (__crt_calloc(num, size));
5931 realloc(void *cp, size_t nbytes)
5934 return (__crt_realloc(cp, nbytes));
5937 extern int _rtld_version__FreeBSD_version __exported;
5938 int _rtld_version__FreeBSD_version = __FreeBSD_version;
5940 extern char _rtld_version_laddr_offset __exported;
5941 char _rtld_version_laddr_offset;
5943 extern char _rtld_version_dlpi_tls_data __exported;
5944 char _rtld_version_dlpi_tls_data;