1 /* Run-time dynamic linker data structures for loaded ELF shared objects.
2 Copyright (C) 1995-2014 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, see
17 <http://www.gnu.org/licenses/>. */
33 #include <fpu_control.h>
36 #include <dl-lookupcfg.h>
37 #include <dl-sysdep.h>
38 #include <bits/libc-lock.h>
39 #include <hp-timing.h>
44 #define VERSYMIDX(sym) (DT_NUM + DT_THISPROCNUM + DT_VERSIONTAGIDX (sym))
45 #define VALIDX(tag) (DT_NUM + DT_THISPROCNUM + DT_VERSIONTAGNUM \
46 + DT_EXTRANUM + DT_VALTAGIDX (tag))
47 #define ADDRIDX(tag) (DT_NUM + DT_THISPROCNUM + DT_VERSIONTAGNUM \
48 + DT_EXTRANUM + DT_VALNUM + DT_ADDRTAGIDX (tag))
50 /* We use this macro to refer to ELF types independent of the native wordsize.
51 `ElfW(TYPE)' is used in place of `Elf32_TYPE' or `Elf64_TYPE'. */
52 #define ELFW(type) _ElfW (ELF, __ELF_NATIVE_CLASS, type)
54 /* All references to the value of l_info[DT_PLTGOT],
55 l_info[DT_STRTAB], l_info[DT_SYMTAB], l_info[DT_RELA],
56 l_info[DT_REL], l_info[DT_JMPREL], and l_info[VERSYMIDX (DT_VERSYM)]
57 have to be accessed via the D_PTR macro. The macro is needed since for
58 most architectures the entry is already relocated - but for some not
59 and we need to relocate at access time. */
60 #ifdef DL_RO_DYN_SECTION
61 # define D_PTR(map, i) ((map)->i->d_un.d_ptr + (map)->l_addr)
63 # define D_PTR(map, i) (map)->i->d_un.d_ptr
66 /* Result of the lookup functions and how to retrieve the base address. */
67 typedef struct link_map
*lookup_t
;
68 #define LOOKUP_VALUE(map) map
69 #define LOOKUP_VALUE_ADDRESS(map) ((map) ? (map)->l_addr : 0)
71 /* On some architectures a pointer to a function is not just a pointer
72 to the actual code of the function but rather an architecture
73 specific descriptor. */
74 #ifndef ELF_FUNCTION_PTR_IS_SPECIAL
75 # define DL_SYMBOL_ADDRESS(map, ref) \
76 (void *) (LOOKUP_VALUE_ADDRESS (map) + ref->st_value)
77 # define DL_LOOKUP_ADDRESS(addr) ((ElfW(Addr)) (addr))
78 # define DL_CALL_DT_INIT(map, start, argc, argv, env) \
79 ((init_t) (start)) (argc, argv, env)
80 # define DL_CALL_DT_FINI(map, start) ((fini_t) (start)) ()
83 /* On some architectures dladdr can't use st_size of all symbols this way. */
84 #define DL_ADDR_SYM_MATCH(L, SYM, MATCHSYM, ADDR) \
85 ((ADDR) >= (L)->l_addr + (SYM)->st_value \
86 && ((((SYM)->st_shndx == SHN_UNDEF || (SYM)->st_size == 0) \
87 && (ADDR) == (L)->l_addr + (SYM)->st_value) \
88 || (ADDR) < (L)->l_addr + (SYM)->st_value + (SYM)->st_size) \
89 && ((MATCHSYM) == NULL || (MATCHSYM)->st_value < (SYM)->st_value))
91 /* Unmap a loaded object, called by _dl_close (). */
92 #ifndef DL_UNMAP_IS_SPECIAL
93 # define DL_UNMAP(map) _dl_unmap_segments (map)
96 /* By default we do not need special support to initialize DSOs loaded
97 by statically linked binaries. */
98 #ifndef DL_STATIC_INIT
99 # define DL_STATIC_INIT(map)
102 /* Reloc type classes as returned by elf_machine_type_class().
103 ELF_RTYPE_CLASS_PLT means this reloc should not be satisfied by
104 some PLT symbol, ELF_RTYPE_CLASS_COPY means this reloc should not be
105 satisfied by any symbol in the executable. Some architectures do
106 not support copy relocations. In this case we define the macro to
107 zero so that the code for handling them gets automatically optimized
109 #define ELF_RTYPE_CLASS_PLT 1
110 #ifndef DL_NO_COPY_RELOCS
111 # define ELF_RTYPE_CLASS_COPY 2
113 # define ELF_RTYPE_CLASS_COPY 0
116 /* ELF uses the PF_x macros to specify the segment permissions, mmap
117 uses PROT_xxx. In most cases the three macros have the values 1, 2,
118 and 3 but not in a matching order. The following macros allows
119 converting from the PF_x values to PROT_xxx values. */
121 ((PROT_READ << (PF_R * 4)) \
122 | (PROT_WRITE << (PF_W * 4)) \
123 | (PROT_EXEC << (PF_X * 4)) \
124 | ((PROT_READ | PROT_WRITE) << ((PF_R | PF_W) * 4)) \
125 | ((PROT_READ | PROT_EXEC) << ((PF_R | PF_X) * 4)) \
126 | ((PROT_WRITE | PROT_EXEC) << (PF_W | PF_X) * 4) \
127 | ((PROT_READ | PROT_WRITE | PROT_EXEC) << ((PF_R | PF_W | PF_X) * 4)))
129 /* The filename itself, or the main program name, if available. */
130 #define DSO_FILENAME(name) ((name)[0] ? (name) \
131 : (rtld_progname ?: "<main program>"))
133 #define RTLD_PROGNAME (rtld_progname ?: "<program name unknown>")
135 /* For the version handling we need an array with only names and their
137 struct r_found_version
143 const char *filename
;
146 /* We want to cache information about the searches for shared objects. */
148 enum r_dir_status
{ unknown
, nonexisting
, existing
};
150 struct r_search_path_elem
152 /* This link is only used in the `all_dirs' member of `r_search_path'. */
153 struct r_search_path_elem
*next
;
155 /* Strings saying where the definition came from. */
159 /* Basename for this search path element. The string must end with
160 a slash character. */
164 enum r_dir_status status
[0];
174 /* A data structure for a simple single linked list of strings. */
177 const char *name
; /* Name requested (before search). */
178 struct libname_list
*next
; /* Link to next name for this object. */
179 int dont_free
; /* Flag whether this element should be freed
180 if the object is not entirely unloaded. */
184 /* Bit masks for the objects which valid callers can come from to
185 functions with restricted interface. */
190 allow_libpthread
= 4,
197 void (*activity
) (uintptr_t *, unsigned int);
198 char *(*objsearch
) (const char *, uintptr_t *, unsigned int);
199 unsigned int (*objopen
) (struct link_map
*, Lmid_t
, uintptr_t *);
200 void (*preinit
) (uintptr_t *);
203 uintptr_t (*symbind32
) (Elf32_Sym
*, unsigned int, uintptr_t *,
204 uintptr_t *, unsigned int *, const char *);
205 uintptr_t (*symbind64
) (Elf64_Sym
*, unsigned int, uintptr_t *,
206 uintptr_t *, unsigned int *, const char *);
210 #ifdef ARCH_PLTENTER_MEMBERS
211 ARCH_PLTENTER_MEMBERS
;
216 #ifdef ARCH_PLTEXIT_MEMBERS
217 ARCH_PLTEXIT_MEMBERS
;
220 unsigned int (*objclose
) (uintptr_t *);
222 struct audit_ifaces
*next
;
226 /* Test whether given NAME matches any of the names of the given object. */
227 extern int _dl_name_match_p (const char *__name
, const struct link_map
*__map
)
230 /* Compute next higher prime number. */
231 extern unsigned long int _dl_higher_prime_number (unsigned long int n
)
234 /* Function used as argument for `_dl_receive_error' function. The
235 arguments are the error code, error string, and the objname the
236 error occurred in. */
237 typedef void (*receiver_fct
) (int, const char *, const char *);
239 /* Internal functions of the run-time dynamic linker.
240 These can be accessed if you link again the dynamic linker
241 as a shared library, as in `-lld' or `/lib/ld.so' explicitly;
242 but are not normally of interest to user programs.
244 The `-ldl' library functions in <dlfcn.h> provide a simple
245 user interface to run-time dynamic linking. */
249 # define EXTERN extern
250 # define GL(name) _##name
254 # define GL(name) _rtld_local._##name
256 # define GL(name) _rtld_global._##name
261 /* Don't change the order of the following elements. 'dl_loaded'
262 must remain the first element. Forever. */
264 /* Non-shared code has no support for multiple namespaces. */
270 EXTERN
struct link_namespaces
272 /* A pointer to the map for the main map. */
273 struct link_map
*_ns_loaded
;
274 /* Number of object in the _dl_loaded list. */
275 unsigned int _ns_nloaded
;
276 /* Direct pointer to the searchlist of the main object. */
277 struct r_scope_elem
*_ns_main_searchlist
;
278 /* This is zero at program start to signal that the global scope map is
279 allocated by rtld. Later it keeps the size of the map. It might be
280 reset if in _dl_close if the last global object is removed. */
281 size_t _ns_global_scope_alloc
;
282 /* Search table for unique objects. */
283 struct unique_sym_table
285 __rtld_lock_define_recursive (, lock
)
290 const ElfW(Sym
) *sym
;
291 const struct link_map
*map
;
295 void (*free
) (void *);
296 } _ns_unique_sym_table
;
297 /* Keep track of changes to each namespace' list. */
298 struct r_debug _ns_debug
;
300 /* One higher than index of last used namespace. */
301 EXTERN
size_t _dl_nns
;
303 /* During the program run we must not modify the global data of
304 loaded shared object simultanously in two threads. Therefore we
305 protect `_dl_open' and `_dl_close' in dl-close.c.
307 This must be a recursive lock since the initializer function of
308 the loaded object might as well require a call to this function.
309 At this time it is not anymore a problem to modify the tables. */
310 __rtld_lock_define_recursive (EXTERN
, _dl_load_lock
)
311 /* This lock is used to keep __dl_iterate_phdr from inspecting the
312 list of loaded objects while an object is added to or removed
314 __rtld_lock_define_recursive (EXTERN
, _dl_load_write_lock
)
316 /* Incremented whenever something may have been added to dl_loaded. */
317 EXTERN
unsigned long long _dl_load_adds
;
319 /* The object to be initialized first. */
320 EXTERN
struct link_map
*_dl_initfirst
;
322 #if HP_TIMING_AVAIL || HP_SMALL_TIMING_AVAIL
323 /* Start time on CPU clock. */
324 EXTERN hp_timing_t _dl_cpuclock_offset
;
327 /* Map of shared object to be profiled. */
328 EXTERN
struct link_map
*_dl_profile_map
;
330 /* Counters for the number of relocations performed. */
331 EXTERN
unsigned long int _dl_num_relocations
;
332 EXTERN
unsigned long int _dl_num_cache_relocations
;
334 /* List of search directories. */
335 EXTERN
struct r_search_path_elem
*_dl_all_dirs
;
337 #ifdef _LIBC_REENTRANT
338 EXTERN
void **(*_dl_error_catch_tsd
) (void) __attribute__ ((const));
341 /* Structure describing the dynamic linker itself. We need to
342 reserve memory for the data the audit libraries need. */
343 EXTERN
struct link_map _dl_rtld_map
;
345 struct auditstate audit_data
[DL_NNS
];
348 #if defined SHARED && defined _LIBC_REENTRANT \
349 && defined __rtld_lock_default_lock_recursive
350 EXTERN
void (*_dl_rtld_lock_recursive
) (void *);
351 EXTERN
void (*_dl_rtld_unlock_recursive
) (void *);
354 /* If loading a shared object requires that we make the stack executable
355 when it was not, we do it by calling this function.
356 It returns an errno code or zero on success. */
357 EXTERN
int (*_dl_make_stack_executable_hook
) (void **) internal_function
;
359 /* Prevailing state of the stack, PF_X indicating it's executable. */
360 EXTERN
ElfW(Word
) _dl_stack_flags
;
362 /* Flag signalling whether there are gaps in the module ID allocation. */
363 EXTERN
bool _dl_tls_dtv_gaps
;
364 /* Highest dtv index currently needed. */
365 EXTERN
size_t _dl_tls_max_dtv_idx
;
366 /* Information about the dtv slots. */
367 EXTERN
struct dtv_slotinfo_list
370 struct dtv_slotinfo_list
*next
;
374 struct link_map
*map
;
376 } *_dl_tls_dtv_slotinfo_list
;
377 /* Number of modules in the static TLS block. */
378 EXTERN
size_t _dl_tls_static_nelem
;
379 /* Size of the static TLS block. */
380 EXTERN
size_t _dl_tls_static_size
;
381 /* Size actually allocated in the static TLS block. */
382 EXTERN
size_t _dl_tls_static_used
;
383 /* Alignment requirement of the static TLS block. */
384 EXTERN
size_t _dl_tls_static_align
;
386 /* Number of additional entries in the slotinfo array of each slotinfo
387 list element. A large number makes it almost certain take we never
388 have to iterate beyond the first element in the slotinfo list. */
389 #define TLS_SLOTINFO_SURPLUS (62)
391 /* Number of additional slots in the dtv allocated. */
392 #define DTV_SURPLUS (14)
394 /* Initial dtv of the main thread, not allocated with normal malloc. */
395 EXTERN
void *_dl_initial_dtv
;
396 /* Generation counter for the dtv. */
397 EXTERN
size_t _dl_tls_generation
;
399 EXTERN
void (*_dl_init_static_tls
) (struct link_map
*);
401 EXTERN
void (*_dl_wait_lookup_done
) (void);
403 /* Scopes to free after next THREAD_GSCOPE_WAIT (). */
404 EXTERN
struct dl_scope_free_list
408 } *_dl_scope_free_list
;
411 # define __rtld_global_attribute__
413 # ifdef HAVE_SDATA_SECTION
414 # define __rtld_local_attribute__ \
415 __attribute__ ((visibility ("hidden"), section (".sdata")))
416 # undef __rtld_global_attribute__
417 # define __rtld_global_attribute__ __attribute__ ((section (".sdata")))
419 # define __rtld_local_attribute__ __attribute__ ((visibility ("hidden")))
421 extern struct rtld_global _rtld_local __rtld_local_attribute__
;
422 # undef __rtld_local_attribute__
424 extern struct rtld_global _rtld_global __rtld_global_attribute__
;
425 # undef __rtld_global_attribute__
429 # define GLRO(name) _##name
432 # define GLRO(name) _rtld_local_ro._##name
434 # define GLRO(name) _rtld_global_ro._##name
436 struct rtld_global_ro
440 /* If nonzero the appropriate debug information is printed. */
441 EXTERN
int _dl_debug_mask
;
442 #define DL_DEBUG_LIBS (1 << 0)
443 #define DL_DEBUG_IMPCALLS (1 << 1)
444 #define DL_DEBUG_BINDINGS (1 << 2)
445 #define DL_DEBUG_SYMBOLS (1 << 3)
446 #define DL_DEBUG_VERSIONS (1 << 4)
447 #define DL_DEBUG_RELOC (1 << 5)
448 #define DL_DEBUG_FILES (1 << 6)
449 #define DL_DEBUG_STATISTICS (1 << 7)
450 #define DL_DEBUG_UNUSED (1 << 8)
451 #define DL_DEBUG_SCOPES (1 << 9)
452 /* These two are used only internally. */
453 #define DL_DEBUG_HELP (1 << 10)
454 #define DL_DEBUG_PRELINK (1 << 11)
457 EXTERN
unsigned int _dl_osversion
;
459 EXTERN
const char *_dl_platform
;
460 EXTERN
size_t _dl_platformlen
;
462 /* Cached value of `getpagesize ()'. */
463 EXTERN
size_t _dl_pagesize
;
465 /* Do we read from ld.so.cache? */
466 EXTERN
int _dl_inhibit_cache
;
468 /* Copy of the content of `_dl_main_searchlist' at startup time. */
469 EXTERN
struct r_scope_elem _dl_initial_searchlist
;
471 /* CLK_TCK as reported by the kernel. */
472 EXTERN
int _dl_clktck
;
474 /* If nonzero print warnings messages. */
475 EXTERN
int _dl_verbose
;
477 /* File descriptor to write debug messages to. */
478 EXTERN
int _dl_debug_fd
;
480 /* Do we do lazy relocations? */
483 /* Nonzero if runtime lookups should not update the .got/.plt. */
484 EXTERN
int _dl_bind_not
;
486 /* Nonzero if references should be treated as weak during runtime
488 EXTERN
int _dl_dynamic_weak
;
490 /* Default floating-point control word. */
491 EXTERN fpu_control_t _dl_fpu_control
;
493 /* Expected cache ID. */
494 EXTERN
int _dl_correct_cache_id
;
496 /* Mask for hardware capabilities that are available. */
497 EXTERN
uint64_t _dl_hwcap
;
499 /* Mask for important hardware capabilities we honour. */
500 EXTERN
uint64_t _dl_hwcap_mask
;
502 /* Pointer to the auxv list supplied to the program at startup. */
503 EXTERN
ElfW(auxv_t
) *_dl_auxv
;
505 /* Get architecture specific definitions. */
506 #define PROCINFO_DECL
507 #ifndef PROCINFO_CLASS
508 # define PROCINFO_CLASS EXTERN
510 #include <dl-procinfo.c>
512 /* Names of shared object for which the RPATH should be ignored. */
513 EXTERN
const char *_dl_inhibit_rpath
;
515 /* Location of the binary. */
516 EXTERN
const char *_dl_origin_path
;
518 /* -1 if the dynamic linker should honor library load bias,
519 0 if not, -2 use the default (honor biases for normal
520 binaries, don't honor for PIEs). */
521 EXTERN
ElfW(Addr
) _dl_use_load_bias
;
523 /* Name of the shared object to be profiled (if any). */
524 EXTERN
const char *_dl_profile
;
525 /* Filename of the output file. */
526 EXTERN
const char *_dl_profile_output
;
527 /* Name of the object we want to trace the prelinking. */
528 EXTERN
const char *_dl_trace_prelink
;
529 /* Map of shared object to be prelink traced. */
530 EXTERN
struct link_map
*_dl_trace_prelink_map
;
532 /* All search directories defined at startup. */
533 EXTERN
struct r_search_path_elem
*_dl_init_all_dirs
;
535 #if HP_TIMING_AVAIL || HP_SMALL_TIMING_AVAIL
536 /* Overhead of a high-precision timing measurement. */
537 EXTERN hp_timing_t _dl_hp_timing_overhead
;
540 #ifdef NEED_DL_SYSINFO
541 /* Syscall handling improvements. This is very specific to x86. */
542 EXTERN
uintptr_t _dl_sysinfo
;
545 #ifdef NEED_DL_SYSINFO_DSO
546 /* The vsyscall page is a virtual DSO pre-mapped by the kernel.
547 This points to its ELF header. */
548 EXTERN
const ElfW(Ehdr
) *_dl_sysinfo_dso
;
550 /* At startup time we set up the normal DSO data structure for it,
551 and this points to it. */
552 EXTERN
struct link_map
*_dl_sysinfo_map
;
555 /* Mask for more hardware capabilities that are available on some
557 EXTERN
uint64_t _dl_hwcap2
;
560 /* We add a function table to _rtld_global which is then used to
561 call the function instead of going through the PLT. The result
562 is that we can avoid exporting the functions and we do not jump
563 PLT relocations in libc.so. */
564 void (*_dl_debug_printf
) (const char *, ...)
565 __attribute__ ((__format__ (__printf__
, 1, 2)));
566 int (internal_function
*_dl_catch_error
) (const char **, const char **,
567 bool *, void (*) (void *), void *);
568 void (internal_function
*_dl_signal_error
) (int, const char *, const char *,
570 void (*_dl_mcount
) (ElfW(Addr
) frompc
, ElfW(Addr
) selfpc
);
571 lookup_t (internal_function
*_dl_lookup_symbol_x
) (const char *,
574 struct r_scope_elem
*[],
575 const struct r_found_version
*,
578 int (*_dl_check_caller
) (const void *, enum allowmask
);
579 void *(*_dl_open
) (const char *file
, int mode
, const void *caller_dlopen
,
580 Lmid_t nsid
, int argc
, char *argv
[], char *env
[]);
581 void (*_dl_close
) (void *map
);
582 void *(*_dl_tls_get_addr_soft
) (struct link_map
*);
583 #ifdef HAVE_DL_DISCOVER_OSVERSION
584 int (*_dl_discover_osversion
) (void);
587 /* List of auditing interfaces. */
588 struct audit_ifaces
*_dl_audit
;
589 unsigned int _dl_naudit
;
591 /* 0 if internal pointer values should not be guarded, 1 if they should. */
592 EXTERN
int _dl_pointer_guard
;
594 # define __rtld_global_attribute__
596 # define __rtld_local_attribute__ __attribute__ ((visibility ("hidden")))
597 extern struct rtld_global_ro _rtld_local_ro
598 attribute_relro __rtld_local_attribute__
;
599 extern struct rtld_global_ro _rtld_global_ro
600 attribute_relro __rtld_global_attribute__
;
601 # undef __rtld_local_attribute__
603 /* We cheat a bit here. We declare the variable as as const even
604 though it is at startup. */
605 extern const struct rtld_global_ro _rtld_global_ro
606 attribute_relro __rtld_global_attribute__
;
608 # undef __rtld_global_attribute__
613 /* dl-support.c defines these and initializes them early on. */
614 extern const ElfW(Phdr
) *_dl_phdr
;
615 extern size_t _dl_phnum
;
619 /* This is the initial value of GL(dl_error_catch_tsd).
620 A non-TLS libpthread will change it. */
621 extern void **_dl_initial_error_catch_tsd (void) __attribute__ ((const))
625 /* This is the initial value of GL(dl_make_stack_executable_hook).
626 A threads library can change it. */
627 extern int _dl_make_stack_executable (void **stack_endp
) internal_function
;
628 rtld_hidden_proto (_dl_make_stack_executable
)
630 /* Variable pointing to the end of the stack (or close to it). This value
631 must be constant over the runtime of the application. Some programs
632 might use the variable which results in copy relocations on some
633 platforms. But this does not matter, ld.so can always use the local
635 extern void *__libc_stack_end
636 #ifndef LIBC_STACK_END_NOT_RELRO
640 rtld_hidden_proto (__libc_stack_end
)
642 /* Parameters passed to the dynamic linker. */
643 extern int _dl_argc attribute_hidden attribute_relro
;
644 extern char **_dl_argv
645 #ifndef DL_ARGV_NOT_RELRO
650 extern unsigned int _dl_skip_args attribute_hidden
651 # ifndef DL_ARGV_NOT_RELRO
655 extern unsigned int _dl_skip_args_internal attribute_hidden
656 # ifndef DL_ARGV_NOT_RELRO
660 extern char **_dl_argv_internal attribute_hidden
661 # ifndef DL_ARGV_NOT_RELRO
665 # define rtld_progname (INTUSE(_dl_argv)[0])
667 # define rtld_progname _dl_argv[0]
670 /* Flag set at startup and cleared when the last initializer has run. */
671 extern int _dl_starting_up
;
672 weak_extern (_dl_starting_up
)
674 extern int _dl_starting_up_internal attribute_hidden
;
677 /* Random data provided by the kernel. */
678 extern void *_dl_random attribute_hidden attribute_relro
;
680 /* OS-dependent function to open the zero-fill device. */
681 extern int _dl_sysdep_open_zero_fill (void); /* dl-sysdep.c */
684 /* Write message on the debug file descriptor. The parameters are
685 interpreted as for a `printf' call. All the lines start with a
686 tag showing the PID. */
687 extern void _dl_debug_printf (const char *fmt
, ...)
688 __attribute__ ((__format__ (__printf__
, 1, 2))) attribute_hidden
;
690 /* Write message on the debug file descriptor. The parameters are
691 interpreted as for a `printf' call. All the lines buf the first
692 start with a tag showing the PID. */
693 extern void _dl_debug_printf_c (const char *fmt
, ...)
694 __attribute__ ((__format__ (__printf__
, 1, 2)));
697 /* Write a message on the specified descriptor FD. The parameters are
698 interpreted as for a `printf' call. */
699 extern void _dl_dprintf (int fd
, const char *fmt
, ...)
700 __attribute__ ((__format__ (__printf__
, 2, 3)))
703 /* Write a message on the specified descriptor standard output. The
704 parameters are interpreted as for a `printf' call. */
705 #define _dl_printf(fmt, args...) \
706 _dl_dprintf (STDOUT_FILENO, fmt, ##args)
708 /* Write a message on the specified descriptor standard error. The
709 parameters are interpreted as for a `printf' call. */
710 #define _dl_error_printf(fmt, args...) \
711 _dl_dprintf (STDERR_FILENO, fmt, ##args)
713 /* Write a message on the specified descriptor standard error and exit
714 the program. The parameters are interpreted as for a `printf' call. */
715 #define _dl_fatal_printf(fmt, args...) \
718 _dl_dprintf (STDERR_FILENO, fmt, ##args); \
724 /* This function is called by all the internal dynamic linker functions
725 when they encounter an error. ERRCODE is either an `errno' code or
726 zero; OBJECT is the name of the problematical shared object, or null if
727 it is a general problem; ERRSTRING is a string describing the specific
729 extern void _dl_signal_error (int errcode
, const char *object
,
730 const char *occurred
, const char *errstring
)
731 internal_function
__attribute__ ((__noreturn__
)) attribute_hidden
;
733 /* Like _dl_signal_error, but may return when called in the context of
734 _dl_receive_error. */
735 extern void _dl_signal_cerror (int errcode
, const char *object
,
736 const char *occation
, const char *errstring
)
739 /* Call OPERATE, receiving errors from `dl_signal_cerror'. Unlike
740 `_dl_catch_error' the operation is resumed after the OPERATE
742 ARGS is passed as argument to OPERATE. */
743 extern void _dl_receive_error (receiver_fct fct
, void (*operate
) (void *),
748 /* Open the shared object NAME and map in its segments.
749 LOADER's DT_RPATH is used in searching for NAME.
750 If the object is already opened, returns its existing map. */
751 extern struct link_map
*_dl_map_object (struct link_map
*loader
,
753 int type
, int trace_mode
, int mode
,
755 internal_function attribute_hidden
;
757 /* Call _dl_map_object on the dependencies of MAP, and set up
758 MAP->l_searchlist. PRELOADS points to a vector of NPRELOADS previously
759 loaded objects that will be inserted into MAP->l_searchlist after MAP
760 but before its dependencies. */
761 extern void _dl_map_object_deps (struct link_map
*map
,
762 struct link_map
**preloads
,
763 unsigned int npreloads
, int trace_mode
,
765 internal_function attribute_hidden
;
767 /* Cache the locations of MAP's hash table. */
768 extern void _dl_setup_hash (struct link_map
*map
)
769 internal_function attribute_hidden
;
772 /* Collect the directories in the search path for LOADER's dependencies.
773 The data structure is defined in <dlfcn.h>. If COUNTING is true,
774 SI->dls_cnt and SI->dls_size are set; if false, those must be as set
775 by a previous call with COUNTING set, and SI must point to SI->dls_size
776 bytes to be used in filling in the result. */
777 extern void _dl_rtld_di_serinfo (struct link_map
*loader
,
778 Dl_serinfo
*si
, bool counting
)
782 /* Search loaded objects' symbol tables for a definition of the symbol
783 referred to by UNDEF. *SYM is the symbol table entry containing the
784 reference; it is replaced with the defining symbol, and the base load
785 address of the defining object is returned. SYMBOL_SCOPE is a
786 null-terminated list of object scopes to search; each object's
787 l_searchlist (i.e. the segment of the dependency tree starting at that
788 object) is searched in turn. REFERENCE_NAME should name the object
789 containing the reference; it is used in error messages.
790 TYPE_CLASS describes the type of symbol we are looking for. */
793 /* If necessary add dependency between user and provider object. */
794 DL_LOOKUP_ADD_DEPENDENCY
= 1,
795 /* Return most recent version instead of default version for
796 unversioned lookup. */
797 DL_LOOKUP_RETURN_NEWEST
= 2,
798 /* Set if dl_lookup* called with GSCOPE lock held. */
799 DL_LOOKUP_GSCOPE_LOCK
= 4,
802 /* Lookup versioned symbol. */
803 extern lookup_t
_dl_lookup_symbol_x (const char *undef
,
804 struct link_map
*undef_map
,
805 const ElfW(Sym
) **sym
,
806 struct r_scope_elem
*symbol_scope
[],
807 const struct r_found_version
*version
,
808 int type_class
, int flags
,
809 struct link_map
*skip_map
)
810 internal_function attribute_hidden
;
813 /* Look up symbol NAME in MAP's scope and return its run-time address. */
814 extern ElfW(Addr
) _dl_symbol_value (struct link_map
*map
, const char *name
)
817 /* Add the new link_map NEW to the end of the namespace list. */
818 extern void _dl_add_to_namespace_list (struct link_map
*new, Lmid_t nsid
)
819 internal_function attribute_hidden
;
821 /* Allocate a `struct link_map' for a new object being loaded. */
822 extern struct link_map
*_dl_new_object (char *realname
, const char *libname
,
823 int type
, struct link_map
*loader
,
824 int mode
, Lmid_t nsid
)
825 internal_function attribute_hidden
;
827 /* Relocate the given object (if it hasn't already been).
828 SCOPE is passed to _dl_lookup_symbol in symbol lookups.
829 If RTLD_LAZY is set in RELOC-MODE, don't relocate its PLT. */
830 extern void _dl_relocate_object (struct link_map
*map
,
831 struct r_scope_elem
*scope
[],
832 int reloc_mode
, int consider_profiling
)
835 /* Protect PT_GNU_RELRO area. */
836 extern void _dl_protect_relro (struct link_map
*map
)
837 internal_function attribute_hidden
;
839 /* Call _dl_signal_error with a message about an unhandled reloc type.
840 TYPE is the result of ELFW(R_TYPE) (r_info), i.e. an R_<CPU>_* value.
841 PLT is nonzero if this was a PLT reloc; it just affects the message. */
842 extern void _dl_reloc_bad_type (struct link_map
*map
,
843 unsigned int type
, int plt
)
844 internal_function
__attribute__ ((__noreturn__
));
846 /* Resolve conflicts if prelinking. */
847 extern void _dl_resolve_conflicts (struct link_map
*l
,
848 ElfW(Rela
) *conflict
,
849 ElfW(Rela
) *conflictend
);
851 /* Check the version dependencies of all objects available through
852 MAP. If VERBOSE print some more diagnostics. */
853 extern int _dl_check_all_versions (struct link_map
*map
, int verbose
,
857 /* Check the version dependencies for MAP. If VERBOSE print some more
859 extern int _dl_check_map_versions (struct link_map
*map
, int verbose
,
863 /* Initialize the object in SCOPE by calling the constructors with
864 ARGC, ARGV, and ENV as the parameters. */
865 extern void _dl_init (struct link_map
*main_map
, int argc
, char **argv
,
866 char **env
) internal_function attribute_hidden
;
868 /* Call the finalizer functions of all shared objects whose
869 initializer functions have completed. */
870 extern void _dl_fini (void) internal_function
;
872 /* Sort array MAPS according to dependencies of the contained objects. */
873 extern void _dl_sort_fini (struct link_map
**maps
, size_t nmaps
, char *used
,
877 /* The dynamic linker calls this function before and having changing
878 any shared object mappings. The `r_state' member of `struct r_debug'
879 says what change is taking place. This function's address is
880 the value of the `r_brk' member. */
881 extern void _dl_debug_state (void);
882 rtld_hidden_proto (_dl_debug_state
)
884 /* Initialize `struct r_debug' if it has not already been done. The
885 argument is the run-time load address of the dynamic linker, to be put
886 in the `r_ldbase' member. Returns the address of the structure. */
887 extern struct r_debug
*_dl_debug_initialize (ElfW(Addr
) ldbase
, Lmid_t ns
)
890 /* Initialize the basic data structure for the search paths. */
891 extern void _dl_init_paths (const char *library_path
) internal_function
;
893 /* Gather the information needed to install the profiling tables and start
895 extern void _dl_start_profile (void) internal_function attribute_hidden
;
897 /* The actual functions used to keep book on the calls. */
898 extern void _dl_mcount (ElfW(Addr
) frompc
, ElfW(Addr
) selfpc
);
899 extern void _dl_mcount_internal (ElfW(Addr
) frompc
, ElfW(Addr
) selfpc
)
902 /* This function is simply a wrapper around the _dl_mcount function
903 which does not require a FROMPC parameter since this is the
905 extern void _dl_mcount_wrapper (void *selfpc
);
907 /* Show the members of the auxiliary array passed up from the kernel. */
908 extern void _dl_show_auxv (void) internal_function
;
910 /* Return all environment variables starting with `LD_', one after the
912 extern char *_dl_next_ld_env_entry (char ***position
) internal_function
;
914 /* Return an array with the names of the important hardware capabilities. */
915 extern const struct r_strlenpair
*_dl_important_hwcaps (const char *platform
,
918 size_t *max_capstrlen
)
921 /* Look up NAME in ld.so.cache and return the file name stored there,
922 or null if none is found. */
923 extern const char *_dl_load_cache_lookup (const char *name
)
926 /* If the system does not support MAP_COPY we cannot leave the file open
927 all the time since this would create problems when the file is replaced.
928 Therefore we provide this function to close the file and open it again
930 extern void _dl_unload_cache (void) attribute_hidden
;
932 /* System-dependent function to read a file's whole contents in the
933 most convenient manner available. *SIZEP gets the size of the
934 file. On error MAP_FAILED is returned. */
935 extern void *_dl_sysdep_read_whole_file (const char *file
, size_t *sizep
,
937 internal_function attribute_hidden
;
939 /* System-specific function to do initial startup for the dynamic linker.
940 After this, file access calls and getenv must work. This is responsible
941 for setting __libc_enable_secure if we need to be secure (e.g. setuid),
942 and for setting _dl_argc and _dl_argv, and then calling _dl_main. */
943 extern ElfW(Addr
) _dl_sysdep_start (void **start_argptr
,
944 void (*dl_main
) (const ElfW(Phdr
) *phdr
,
946 ElfW(Addr
) *user_entry
,
950 extern void _dl_sysdep_start_cleanup (void)
951 internal_function attribute_hidden
;
954 /* Determine next available module ID. */
955 extern size_t _dl_next_tls_modid (void) internal_function attribute_hidden
;
957 /* Count the modules with TLS segments. */
958 extern size_t _dl_count_modids (void) internal_function attribute_hidden
;
960 /* Calculate offset of the TLS blocks in the static TLS block. */
961 extern void _dl_determine_tlsoffset (void) internal_function attribute_hidden
;
963 /* Set up the data structures for TLS, when they were not set up at startup.
964 Returns nonzero on malloc failure.
965 This is called from _dl_map_object_from_fd or by libpthread. */
966 extern int _dl_tls_setup (void) internal_function
;
967 rtld_hidden_proto (_dl_tls_setup
)
969 /* Allocate memory for static TLS block (unless MEM is nonzero) and dtv. */
970 extern void *_dl_allocate_tls (void *mem
) internal_function
;
971 rtld_hidden_proto (_dl_allocate_tls
)
973 /* Get size and alignment requirements of the static TLS block. */
974 extern void _dl_get_tls_static_info (size_t *sizep
, size_t *alignp
)
977 extern void _dl_allocate_static_tls (struct link_map
*map
)
978 internal_function attribute_hidden
;
980 /* These are internal entry points to the two halves of _dl_allocate_tls,
981 only used within rtld.c itself at startup time. */
982 extern void *_dl_allocate_tls_storage (void)
983 internal_function attribute_hidden
;
984 extern void *_dl_allocate_tls_init (void *) internal_function
;
985 rtld_hidden_proto (_dl_allocate_tls_init
)
987 /* Deallocate memory allocated with _dl_allocate_tls. */
988 extern void _dl_deallocate_tls (void *tcb
, bool dealloc_tcb
) internal_function
;
989 rtld_hidden_proto (_dl_deallocate_tls
)
991 extern void _dl_nothread_init_static_tls (struct link_map
*) attribute_hidden
;
993 /* Find origin of the executable. */
994 extern const char *_dl_get_origin (void) attribute_hidden
;
997 extern size_t _dl_dst_count (const char *name
, int is_path
) attribute_hidden
;
999 /* Substitute DST values. */
1000 extern char *_dl_dst_substitute (struct link_map
*l
, const char *name
,
1001 char *result
, int is_path
) attribute_hidden
;
1003 /* Check validity of the caller. */
1004 extern int _dl_check_caller (const void *caller
, enum allowmask mask
)
1007 /* Open the shared object NAME, relocate it, and run its initializer if it
1008 hasn't already been run. MODE is as for `dlopen' (see <dlfcn.h>). If
1009 the object is already opened, returns its existing map. */
1010 extern void *_dl_open (const char *name
, int mode
, const void *caller
,
1011 Lmid_t nsid
, int argc
, char *argv
[], char *env
[])
1014 /* Free or queue for freeing scope OLD. If other threads might be
1015 in the middle of _dl_fixup, _dl_profile_fixup or dl*sym using the
1016 old scope, OLD can't be freed until no thread is using it. */
1017 extern int _dl_scope_free (void *) attribute_hidden
;
1019 /* Add module to slot information data. */
1020 extern void _dl_add_to_slotinfo (struct link_map
*l
) attribute_hidden
;
1022 /* Update slot information data for at least the generation of the
1023 module with the given index. */
1024 extern struct link_map
*_dl_update_slotinfo (unsigned long int req_modid
);
1026 /* Look up the module's TLS block as for __tls_get_addr,
1027 but never touch anything. Return null if it's not allocated yet. */
1028 extern void *_dl_tls_get_addr_soft (struct link_map
*l
) attribute_hidden
;
1030 extern int _dl_addr_inside_object (struct link_map
*l
, const ElfW(Addr
) addr
)
1031 internal_function attribute_hidden
;
1033 /* Show show of an object. */
1034 extern void _dl_show_scope (struct link_map
*new, int from
);
1036 extern struct link_map
*_dl_find_dso_for_object (const ElfW(Addr
) addr
)
1038 rtld_hidden_proto (_dl_find_dso_for_object
)
1040 /* Initialization which is normally done by the dynamic linker. */
1041 extern void _dl_non_dynamic_init (void) internal_function
;
1043 /* Used by static binaries to check the auxiliary vector. */
1044 extern void _dl_aux_init (ElfW(auxv_t
) *av
) internal_function
;
1049 #endif /* ldsodefs.h */