ldbl-128 fmal compile fix
[glibc.git] / sysdeps / generic / ldsodefs.h
blobd0405903c177bbf11de985545814af1b23c1d878
1 /* Run-time dynamic linker data structures for loaded ELF shared objects.
2 Copyright (C) 1995-2009, 2010 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, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18 02111-1307 USA. */
20 #ifndef _LDSODEFS_H
21 #define _LDSODEFS_H 1
23 #include <features.h>
25 #include <stdbool.h>
26 #define __need_size_t
27 #define __need_NULL
28 #include <stddef.h>
29 #include <string.h>
31 #include <elf.h>
32 #include <dlfcn.h>
33 #include <fpu_control.h>
34 #include <sys/mman.h>
35 #include <link.h>
36 #include <dl-lookupcfg.h>
37 #include <dl-sysdep.h>
38 #include <bits/libc-lock.h>
39 #include <hp-timing.h>
40 #include <tls.h>
41 #include <kernel-features.h>
43 __BEGIN_DECLS
45 /* We use this macro to refer to ELF types independent of the native wordsize.
46 `ElfW(TYPE)' is used in place of `Elf32_TYPE' or `Elf64_TYPE'. */
47 #define ELFW(type) _ElfW (ELF, __ELF_NATIVE_CLASS, type)
49 /* All references to the value of l_info[DT_PLTGOT],
50 l_info[DT_STRTAB], l_info[DT_SYMTAB], l_info[DT_RELA],
51 l_info[DT_REL], l_info[DT_JMPREL], and l_info[VERSYMIDX (DT_VERSYM)]
52 have to be accessed via the D_PTR macro. The macro is needed since for
53 most architectures the entry is already relocated - but for some not
54 and we need to relocate at access time. */
55 #ifdef DL_RO_DYN_SECTION
56 # define D_PTR(map, i) ((map)->i->d_un.d_ptr + (map)->l_addr)
57 #else
58 # define D_PTR(map, i) (map)->i->d_un.d_ptr
59 #endif
61 /* Result of the lookup functions and how to retrieve the base address. */
62 typedef struct link_map *lookup_t;
63 #define LOOKUP_VALUE(map) map
64 #define LOOKUP_VALUE_ADDRESS(map) ((map) ? (map)->l_addr : 0)
66 /* On some architectures a pointer to a function is not just a pointer
67 to the actual code of the function but rather an architecture
68 specific descriptor. */
69 #ifndef ELF_FUNCTION_PTR_IS_SPECIAL
70 # define DL_SYMBOL_ADDRESS(map, ref) \
71 (void *) (LOOKUP_VALUE_ADDRESS (map) + ref->st_value)
72 # define DL_LOOKUP_ADDRESS(addr) ((ElfW(Addr)) (addr))
73 # define DL_DT_INIT_ADDRESS(map, start) (start)
74 # define DL_DT_FINI_ADDRESS(map, start) (start)
75 #endif
77 /* On some architectures dladdr can't use st_size of all symbols this way. */
78 #define DL_ADDR_SYM_MATCH(L, SYM, MATCHSYM, ADDR) \
79 ((ADDR) >= (L)->l_addr + (SYM)->st_value \
80 && ((((SYM)->st_shndx == SHN_UNDEF || (SYM)->st_size == 0) \
81 && (ADDR) == (L)->l_addr + (SYM)->st_value) \
82 || (ADDR) < (L)->l_addr + (SYM)->st_value + (SYM)->st_size) \
83 && ((MATCHSYM) == NULL || (MATCHSYM)->st_value < (SYM)->st_value))
85 /* Unmap a loaded object, called by _dl_close (). */
86 #ifndef DL_UNMAP_IS_SPECIAL
87 # define DL_UNMAP(map) \
88 __munmap ((void *) (map)->l_map_start, \
89 (map)->l_map_end - (map)->l_map_start)
90 #endif
92 /* By default we do not need special support to initialize DSOs loaded
93 by statically linked binaries. */
94 #ifndef DL_STATIC_INIT
95 # define DL_STATIC_INIT(map)
96 #endif
98 /* Reloc type classes as returned by elf_machine_type_class().
99 ELF_RTYPE_CLASS_PLT means this reloc should not be satisfied by
100 some PLT symbol, ELF_RTYPE_CLASS_COPY means this reloc should not be
101 satisfied by any symbol in the executable. Some architectures do
102 not support copy relocations. In this case we define the macro to
103 zero so that the code for handling them gets automatically optimized
104 out. */
105 #define ELF_RTYPE_CLASS_PLT 1
106 #ifndef DL_NO_COPY_RELOCS
107 # define ELF_RTYPE_CLASS_COPY 2
108 #else
109 # define ELF_RTYPE_CLASS_COPY 0
110 #endif
112 /* ELF uses the PF_x macros to specify the segment permissions, mmap
113 uses PROT_xxx. In most cases the three macros have the values 1, 2,
114 and 3 but not in a matching order. The following macros allows
115 converting from the PF_x values to PROT_xxx values. */
116 #define PF_TO_PROT \
117 ((PROT_READ << (PF_R * 4)) \
118 | (PROT_WRITE << (PF_W * 4)) \
119 | (PROT_EXEC << (PF_X * 4)) \
120 | ((PROT_READ | PROT_WRITE) << ((PF_R | PF_W) * 4)) \
121 | ((PROT_READ | PROT_EXEC) << ((PF_R | PF_X) * 4)) \
122 | ((PROT_WRITE | PROT_EXEC) << (PF_W | PF_X) * 4) \
123 | ((PROT_READ | PROT_WRITE | PROT_EXEC) << ((PF_R | PF_W | PF_X) * 4)))
126 /* For the version handling we need an array with only names and their
127 hash values. */
128 struct r_found_version
130 const char *name;
131 ElfW(Word) hash;
133 int hidden;
134 const char *filename;
137 /* We want to cache information about the searches for shared objects. */
139 enum r_dir_status { unknown, nonexisting, existing };
141 struct r_search_path_elem
143 /* This link is only used in the `all_dirs' member of `r_search_path'. */
144 struct r_search_path_elem *next;
146 /* Strings saying where the definition came from. */
147 const char *what;
148 const char *where;
150 /* Basename for this search path element. The string must end with
151 a slash character. */
152 const char *dirname;
153 size_t dirnamelen;
155 enum r_dir_status status[0];
158 struct r_strlenpair
160 const char *str;
161 size_t len;
165 /* A data structure for a simple single linked list of strings. */
166 struct libname_list
168 const char *name; /* Name requested (before search). */
169 struct libname_list *next; /* Link to next name for this object. */
170 int dont_free; /* Flag whether this element should be freed
171 if the object is not entirely unloaded. */
175 /* Bit masks for the objects which valid callers can come from to
176 functions with restricted interface. */
177 enum allowmask
179 allow_libc = 1,
180 allow_libdl = 2,
181 allow_libpthread = 4,
182 allow_ldso = 8
186 /* Type for list of auditing interfaces. */
187 struct La_i86_regs;
188 struct La_i86_retval;
189 struct La_x86_64_regs;
190 struct La_x86_64_retval;
191 struct La_ppc32_regs;
192 struct La_ppc32_retval;
193 struct La_ppc64_regs;
194 struct La_ppc64_retval;
195 struct La_sh_regs;
196 struct La_sh_retval;
197 struct La_alpha_regs;
198 struct La_alpha_retval;
199 struct La_s390_32_regs;
200 struct La_s390_32_retval;
201 struct La_s390_64_regs;
202 struct La_s390_64_retval;
203 struct La_ia64_regs;
204 struct La_ia64_retval;
205 struct La_sparc32_regs;
206 struct La_sparc32_retval;
207 struct La_sparc64_regs;
208 struct La_sparc64_retval;
210 struct audit_ifaces
212 void (*activity) (uintptr_t *, unsigned int);
213 char *(*objsearch) (const char *, uintptr_t *, unsigned int);
214 unsigned int (*objopen) (struct link_map *, Lmid_t, uintptr_t *);
215 void (*preinit) (uintptr_t *);
216 union
218 uintptr_t (*symbind32) (Elf32_Sym *, unsigned int, uintptr_t *,
219 uintptr_t *, unsigned int *, const char *);
220 uintptr_t (*symbind64) (Elf64_Sym *, unsigned int, uintptr_t *,
221 uintptr_t *, unsigned int *, const char *);
223 union
225 Elf32_Addr (*i86_gnu_pltenter) (Elf32_Sym *, unsigned int, uintptr_t *,
226 uintptr_t *, struct La_i86_regs *,
227 unsigned int *, const char *name,
228 long int *framesizep);
229 Elf64_Addr (*x86_64_gnu_pltenter) (Elf64_Sym *, unsigned int, uintptr_t *,
230 uintptr_t *, struct La_x86_64_regs *,
231 unsigned int *, const char *name,
232 long int *framesizep);
233 Elf32_Addr (*ppc32_gnu_pltenter) (Elf32_Sym *, unsigned int, uintptr_t *,
234 uintptr_t *, struct La_ppc32_regs *,
235 unsigned int *, const char *name,
236 long int *framesizep);
237 Elf64_Addr (*ppc64_gnu_pltenter) (Elf64_Sym *, unsigned int, uintptr_t *,
238 uintptr_t *, struct La_ppc64_regs *,
239 unsigned int *, const char *name,
240 long int *framesizep);
241 uintptr_t (*sh_gnu_pltenter) (Elf32_Sym *, unsigned int, uintptr_t *,
242 uintptr_t *, const struct La_sh_regs *,
243 unsigned int *, const char *name,
244 long int *framesizep);
245 Elf64_Addr (*alpha_gnu_pltenter) (Elf64_Sym *, unsigned int, uintptr_t *,
246 uintptr_t *, struct La_alpha_regs *,
247 unsigned int *, const char *name,
248 long int *framesizep);
249 Elf32_Addr (*s390_32_gnu_pltenter) (Elf32_Sym *, unsigned int, uintptr_t *,
250 uintptr_t *, struct La_s390_32_regs *,
251 unsigned int *, const char *name,
252 long int *framesizep);
253 Elf64_Addr (*s390_64_gnu_pltenter) (Elf64_Sym *, unsigned int, uintptr_t *,
254 uintptr_t *, struct La_s390_64_regs *,
255 unsigned int *, const char *name,
256 long int *framesizep);
257 Elf64_Addr (*ia64_gnu_pltenter) (Elf64_Sym *, unsigned int, uintptr_t *,
258 uintptr_t *, struct La_ia64_regs *,
259 unsigned int *, const char *name,
260 long int *framesizep);
261 Elf32_Addr (*sparc32_gnu_pltenter) (Elf32_Sym *, unsigned int,
262 uintptr_t *, uintptr_t *,
263 const struct La_sparc32_regs *,
264 unsigned int *, const char *name,
265 long int *framesizep);
266 Elf64_Addr (*sparc64_gnu_pltenter) (Elf64_Sym *, unsigned int,
267 uintptr_t *, uintptr_t *,
268 const struct La_sparc64_regs *,
269 unsigned int *, const char *name,
270 long int *framesizep);
271 #ifdef ARCH_PLTENTER_MEMBERS
272 ARCH_PLTENTER_MEMBERS;
273 #endif
275 union
277 unsigned int (*i86_gnu_pltexit) (Elf32_Sym *, unsigned int, uintptr_t *,
278 uintptr_t *, const struct La_i86_regs *,
279 struct La_i86_retval *, const char *);
280 unsigned int (*x86_64_gnu_pltexit) (Elf64_Sym *, unsigned int, uintptr_t *,
281 uintptr_t *,
282 const struct La_x86_64_regs *,
283 struct La_x86_64_retval *,
284 const char *);
285 unsigned int (*ppc32_gnu_pltexit) (Elf32_Sym *, unsigned int, uintptr_t *,
286 uintptr_t *,
287 const struct La_ppc32_regs *,
288 struct La_ppc32_retval *, const char *);
289 unsigned int (*ppc64_gnu_pltexit) (Elf64_Sym *, unsigned int, uintptr_t *,
290 uintptr_t *,
291 const struct La_ppc64_regs *,
292 struct La_ppc64_retval *, const char *);
293 unsigned int (*sh_gnu_pltexit) (Elf32_Sym *, unsigned int, uintptr_t *,
294 uintptr_t *, const struct La_sh_regs *,
295 struct La_sh_retval *, const char *);
296 unsigned int (*alpha_gnu_pltexit) (Elf64_Sym *, unsigned int, uintptr_t *,
297 uintptr_t *,
298 const struct La_alpha_regs *,
299 struct La_alpha_retval *, const char *);
300 unsigned int (*s390_32_gnu_pltexit) (Elf32_Sym *, unsigned int,
301 uintptr_t *, uintptr_t *,
302 const struct La_s390_32_regs *,
303 struct La_s390_32_retval *,
304 const char *);
305 unsigned int (*s390_64_gnu_pltexit) (Elf64_Sym *, unsigned int,
306 uintptr_t *, uintptr_t *,
307 const struct La_s390_64_regs *,
308 struct La_s390_64_retval *,
309 const char *);
310 unsigned int (*ia64_gnu_pltexit) (Elf64_Sym *, unsigned int, uintptr_t *,
311 uintptr_t *,
312 const struct La_ia64_regs *,
313 struct La_ia64_retval *, const char *);
314 unsigned int (*sparc32_gnu_pltexit) (Elf32_Sym *, unsigned int,
315 uintptr_t *, uintptr_t *,
316 const struct La_sparc32_regs *,
317 struct La_sparc32_retval *,
318 const char *);
319 unsigned int (*sparc64_gnu_pltexit) (Elf64_Sym *, unsigned int,
320 uintptr_t *, uintptr_t *,
321 const struct La_sparc32_regs *,
322 struct La_sparc32_retval *,
323 const char *);
324 #ifdef ARCH_PLTEXIT_MEMBERS
325 ARCH_PLTEXIT_MEMBERS;
326 #endif
328 unsigned int (*objclose) (uintptr_t *);
330 struct audit_ifaces *next;
334 /* Test whether given NAME matches any of the names of the given object. */
335 extern int _dl_name_match_p (const char *__name, const struct link_map *__map)
336 internal_function;
338 /* Compute next higher prime number. */
339 extern unsigned long int _dl_higher_prime_number (unsigned long int n)
340 internal_function;
342 /* Function used as argument for `_dl_receive_error' function. The
343 arguments are the error code, error string, and the objname the
344 error occurred in. */
345 typedef void (*receiver_fct) (int, const char *, const char *);
347 /* Internal functions of the run-time dynamic linker.
348 These can be accessed if you link again the dynamic linker
349 as a shared library, as in `-lld' or `/lib/ld.so' explicitly;
350 but are not normally of interest to user programs.
352 The `-ldl' library functions in <dlfcn.h> provide a simple
353 user interface to run-time dynamic linking. */
356 #ifndef SHARED
357 # define EXTERN extern
358 # define GL(name) _##name
359 #else
360 # define EXTERN
361 # ifdef IS_IN_rtld
362 # define GL(name) _rtld_local._##name
363 # else
364 # define GL(name) _rtld_global._##name
365 # endif
366 struct rtld_global
368 #endif
369 /* Don't change the order of the following elements. 'dl_loaded'
370 must remain the first element. Forever. */
372 /* Non-shared code has no support for multiple namespaces. */
373 #ifdef SHARED
374 # define DL_NNS 16
375 #else
376 # define DL_NNS 1
377 #endif
378 EXTERN struct link_namespaces
380 /* A pointer to the map for the main map. */
381 struct link_map *_ns_loaded;
382 /* Number of object in the _dl_loaded list. */
383 unsigned int _ns_nloaded;
384 /* Direct pointer to the searchlist of the main object. */
385 struct r_scope_elem *_ns_main_searchlist;
386 /* This is zero at program start to signal that the global scope map is
387 allocated by rtld. Later it keeps the size of the map. It might be
388 reset if in _dl_close if the last global object is removed. */
389 size_t _ns_global_scope_alloc;
390 /* Search table for unique objects. */
391 struct unique_sym_table
393 __rtld_lock_recursive_t lock;
394 struct unique_sym
396 uint32_t hashval;
397 const char *name;
398 const ElfW(Sym) *sym;
399 struct link_map *map;
400 } *entries;
401 size_t size;
402 size_t n_elements;
403 void (*free) (void *);
404 } _ns_unique_sym_table;
405 /* Keep track of changes to each namespace' list. */
406 struct r_debug _ns_debug;
407 } _dl_ns[DL_NNS];
408 /* One higher than index of last used namespace. */
409 EXTERN size_t _dl_nns;
411 /* During the program run we must not modify the global data of
412 loaded shared object simultanously in two threads. Therefore we
413 protect `_dl_open' and `_dl_close' in dl-close.c.
415 This must be a recursive lock since the initializer function of
416 the loaded object might as well require a call to this function.
417 At this time it is not anymore a problem to modify the tables. */
418 __rtld_lock_define_recursive (EXTERN, _dl_load_lock)
419 /* This lock is used to keep __dl_iterate_phdr from inspecting the
420 list of loaded objects while an object is added to or removed
421 from that list. */
422 __rtld_lock_define_recursive (EXTERN, _dl_load_write_lock)
424 /* Incremented whenever something may have been added to dl_loaded. */
425 EXTERN unsigned long long _dl_load_adds;
427 /* The object to be initialized first. */
428 EXTERN struct link_map *_dl_initfirst;
430 #if HP_TIMING_AVAIL || HP_SMALL_TIMING_AVAIL
431 /* Start time on CPU clock. */
432 EXTERN hp_timing_t _dl_cpuclock_offset;
433 #endif
435 /* Map of shared object to be profiled. */
436 EXTERN struct link_map *_dl_profile_map;
438 /* Counters for the number of relocations performed. */
439 EXTERN unsigned long int _dl_num_relocations;
440 EXTERN unsigned long int _dl_num_cache_relocations;
442 /* List of search directories. */
443 EXTERN struct r_search_path_elem *_dl_all_dirs;
445 #ifdef _LIBC_REENTRANT
446 EXTERN void **(*_dl_error_catch_tsd) (void) __attribute__ ((const));
447 #endif
449 /* Structure describing the dynamic linker itself. We need to
450 reserve memory for the data the audit libraries need. */
451 EXTERN struct link_map _dl_rtld_map;
452 #ifdef SHARED
453 struct auditstate audit_data[DL_NNS];
454 #endif
456 #if defined SHARED && defined _LIBC_REENTRANT \
457 && defined __rtld_lock_default_lock_recursive
458 EXTERN void (*_dl_rtld_lock_recursive) (void *);
459 EXTERN void (*_dl_rtld_unlock_recursive) (void *);
460 #endif
462 /* If loading a shared object requires that we make the stack executable
463 when it was not, we do it by calling this function.
464 It returns an errno code or zero on success. */
465 EXTERN int (*_dl_make_stack_executable_hook) (void **) internal_function;
467 /* Prevailing state of the stack, PF_X indicating it's executable. */
468 EXTERN ElfW(Word) _dl_stack_flags;
470 /* Flag signalling whether there are gaps in the module ID allocation. */
471 EXTERN bool _dl_tls_dtv_gaps;
472 /* Highest dtv index currently needed. */
473 EXTERN size_t _dl_tls_max_dtv_idx;
474 /* Information about the dtv slots. */
475 EXTERN struct dtv_slotinfo_list
477 size_t len;
478 struct dtv_slotinfo_list *next;
479 struct dtv_slotinfo
481 size_t gen;
482 struct link_map *map;
483 } slotinfo[0];
484 } *_dl_tls_dtv_slotinfo_list;
485 /* Number of modules in the static TLS block. */
486 EXTERN size_t _dl_tls_static_nelem;
487 /* Size of the static TLS block. */
488 EXTERN size_t _dl_tls_static_size;
489 /* Size actually allocated in the static TLS block. */
490 EXTERN size_t _dl_tls_static_used;
491 /* Alignment requirement of the static TLS block. */
492 EXTERN size_t _dl_tls_static_align;
494 /* Number of additional entries in the slotinfo array of each slotinfo
495 list element. A large number makes it almost certain take we never
496 have to iterate beyond the first element in the slotinfo list. */
497 #define TLS_SLOTINFO_SURPLUS (62)
499 /* Number of additional slots in the dtv allocated. */
500 #define DTV_SURPLUS (14)
502 /* Initial dtv of the main thread, not allocated with normal malloc. */
503 EXTERN void *_dl_initial_dtv;
504 /* Generation counter for the dtv. */
505 EXTERN size_t _dl_tls_generation;
507 EXTERN void (*_dl_init_static_tls) (struct link_map *);
509 EXTERN void (*_dl_wait_lookup_done) (void);
511 /* Scopes to free after next THREAD_GSCOPE_WAIT (). */
512 EXTERN struct dl_scope_free_list
514 size_t count;
515 void *list[50];
516 } *_dl_scope_free_list;
517 #ifdef SHARED
519 # define __rtld_global_attribute__
520 # ifdef IS_IN_rtld
521 # ifdef HAVE_SDATA_SECTION
522 # define __rtld_local_attribute__ \
523 __attribute__ ((visibility ("hidden"), section (".sdata")))
524 # undef __rtld_global_attribute__
525 # define __rtld_global_attribute__ __attribute__ ((section (".sdata")))
526 # else
527 # define __rtld_local_attribute__ __attribute__ ((visibility ("hidden")))
528 # endif
529 extern struct rtld_global _rtld_local __rtld_local_attribute__;
530 # undef __rtld_local_attribute__
531 # endif
532 extern struct rtld_global _rtld_global __rtld_global_attribute__;
533 # undef __rtld_global_attribute__
534 #endif
536 #ifndef SHARED
537 # define GLRO(name) _##name
538 #else
539 # ifdef IS_IN_rtld
540 # define GLRO(name) _rtld_local_ro._##name
541 # else
542 # define GLRO(name) _rtld_global_ro._##name
543 # endif
544 struct rtld_global_ro
546 #endif
548 /* If nonzero the appropriate debug information is printed. */
549 EXTERN int _dl_debug_mask;
550 #define DL_DEBUG_LIBS (1 << 0)
551 #define DL_DEBUG_IMPCALLS (1 << 1)
552 #define DL_DEBUG_BINDINGS (1 << 2)
553 #define DL_DEBUG_SYMBOLS (1 << 3)
554 #define DL_DEBUG_VERSIONS (1 << 4)
555 #define DL_DEBUG_RELOC (1 << 5)
556 #define DL_DEBUG_FILES (1 << 6)
557 #define DL_DEBUG_STATISTICS (1 << 7)
558 #define DL_DEBUG_UNUSED (1 << 8)
559 /* These two are used only internally. */
560 #define DL_DEBUG_HELP (1 << 9)
561 #define DL_DEBUG_PRELINK (1 << 10)
563 /* OS version. */
564 EXTERN unsigned int _dl_osversion;
565 /* Platform name. */
566 EXTERN const char *_dl_platform;
567 EXTERN size_t _dl_platformlen;
569 /* Cached value of `getpagesize ()'. */
570 EXTERN size_t _dl_pagesize;
572 /* Copy of the content of `_dl_main_searchlist' at startup time. */
573 EXTERN struct r_scope_elem _dl_initial_searchlist;
575 /* CLK_TCK as reported by the kernel. */
576 EXTERN int _dl_clktck;
578 /* If nonzero print warnings messages. */
579 EXTERN int _dl_verbose;
581 /* File descriptor to write debug messages to. */
582 EXTERN int _dl_debug_fd;
584 /* Do we do lazy relocations? */
585 EXTERN int _dl_lazy;
587 /* Nonzero if runtime lookups should not update the .got/.plt. */
588 EXTERN int _dl_bind_not;
590 /* Nonzero if references should be treated as weak during runtime
591 linking. */
592 EXTERN int _dl_dynamic_weak;
594 /* Default floating-point control word. */
595 EXTERN fpu_control_t _dl_fpu_control;
597 /* Expected cache ID. */
598 EXTERN int _dl_correct_cache_id;
600 /* Mask for hardware capabilities that are available. */
601 EXTERN uint64_t _dl_hwcap;
603 /* Mask for important hardware capabilities we honour. */
604 EXTERN uint64_t _dl_hwcap_mask;
606 /* Get architecture specific definitions. */
607 #define PROCINFO_DECL
608 #ifndef PROCINFO_CLASS
609 # define PROCINFO_CLASS EXTERN
610 #endif
611 #include <dl-procinfo.c>
613 /* Names of shared object for which the RPATH should be ignored. */
614 EXTERN const char *_dl_inhibit_rpath;
616 /* Location of the binary. */
617 EXTERN const char *_dl_origin_path;
619 /* -1 if the dynamic linker should honor library load bias,
620 0 if not, -2 use the default (honor biases for normal
621 binaries, don't honor for PIEs). */
622 EXTERN ElfW(Addr) _dl_use_load_bias;
624 /* Name of the shared object to be profiled (if any). */
625 EXTERN const char *_dl_profile;
626 /* Filename of the output file. */
627 EXTERN const char *_dl_profile_output;
628 /* Name of the object we want to trace the prelinking. */
629 EXTERN const char *_dl_trace_prelink;
630 /* Map of shared object to be prelink traced. */
631 EXTERN struct link_map *_dl_trace_prelink_map;
633 /* All search directories defined at startup. */
634 EXTERN struct r_search_path_elem *_dl_init_all_dirs;
636 #if HP_TIMING_AVAIL || HP_SMALL_TIMING_AVAIL
637 /* Overhead of a high-precision timing measurement. */
638 EXTERN hp_timing_t _dl_hp_timing_overhead;
639 #endif
641 #ifdef NEED_DL_SYSINFO
642 /* Syscall handling improvements. This is very specific to x86. */
643 EXTERN uintptr_t _dl_sysinfo;
644 #endif
646 #if defined NEED_DL_SYSINFO || defined NEED_DL_SYSINFO_DSO
647 /* The vsyscall page is a virtual DSO pre-mapped by the kernel.
648 This points to its ELF header. */
649 EXTERN const ElfW(Ehdr) *_dl_sysinfo_dso;
651 /* At startup time we set up the normal DSO data structure for it,
652 and this points to it. */
653 EXTERN struct link_map *_dl_sysinfo_map;
654 #endif
656 #ifdef SHARED
657 /* We add a function table to _rtld_global which is then used to
658 call the function instead of going through the PLT. The result
659 is that we can avoid exporting the functions and we do not jump
660 PLT relocations in libc.so. */
661 void (*_dl_debug_printf) (const char *, ...)
662 __attribute__ ((__format__ (__printf__, 1, 2)));
663 int (internal_function *_dl_catch_error) (const char **, const char **,
664 bool *, void (*) (void *), void *);
665 void (internal_function *_dl_signal_error) (int, const char *, const char *,
666 const char *);
667 void (*_dl_mcount) (ElfW(Addr) frompc, ElfW(Addr) selfpc);
668 lookup_t (internal_function *_dl_lookup_symbol_x) (const char *,
669 struct link_map *,
670 const ElfW(Sym) **,
671 struct r_scope_elem *[],
672 const struct r_found_version *,
673 int, int,
674 struct link_map *);
675 int (*_dl_check_caller) (const void *, enum allowmask);
676 void *(*_dl_open) (const char *file, int mode, const void *caller_dlopen,
677 Lmid_t nsid, int argc, char *argv[], char *env[]);
678 void (*_dl_close) (void *map);
679 void *(*_dl_tls_get_addr_soft) (struct link_map *);
680 #ifdef HAVE_DL_DISCOVER_OSVERSION
681 int (*_dl_discover_osversion) (void);
682 #endif
684 /* List of auditing interfaces. */
685 struct audit_ifaces *_dl_audit;
686 unsigned int _dl_naudit;
688 /* 0 if internal pointer values should not be guarded, 1 if they should. */
689 EXTERN int _dl_pointer_guard;
691 # define __rtld_global_attribute__
692 # ifdef IS_IN_rtld
693 # define __rtld_local_attribute__ __attribute__ ((visibility ("hidden")))
694 extern struct rtld_global_ro _rtld_local_ro
695 attribute_relro __rtld_local_attribute__;
696 extern struct rtld_global_ro _rtld_global_ro
697 attribute_relro __rtld_global_attribute__;
698 # undef __rtld_local_attribute__
699 # else
700 /* We cheat a bit here. We declare the variable as as const even
701 though it is at startup. */
702 extern const struct rtld_global_ro _rtld_global_ro
703 attribute_relro __rtld_global_attribute__;
704 # endif
705 # undef __rtld_global_attribute__
706 #endif
707 #undef EXTERN
709 #ifdef IS_IN_rtld
710 /* This is the initial value of GL(dl_error_catch_tsd).
711 A non-TLS libpthread will change it. */
712 extern void **_dl_initial_error_catch_tsd (void) __attribute__ ((const))
713 attribute_hidden;
714 #endif
716 /* This is the initial value of GL(dl_make_stack_executable_hook).
717 A threads library can change it. */
718 extern int _dl_make_stack_executable (void **stack_endp) internal_function;
719 rtld_hidden_proto (_dl_make_stack_executable)
721 /* Variable pointing to the end of the stack (or close to it). This value
722 must be constant over the runtime of the application. Some programs
723 might use the variable which results in copy relocations on some
724 platforms. But this does not matter, ld.so can always use the local
725 copy. */
726 extern void *__libc_stack_end attribute_relro;
727 rtld_hidden_proto (__libc_stack_end)
729 /* Parameters passed to the dynamic linker. */
730 extern int _dl_argc attribute_hidden attribute_relro;
731 extern char **_dl_argv
732 #ifndef DL_ARGV_NOT_RELRO
733 attribute_relro
734 #endif
736 #ifdef IS_IN_rtld
737 extern char **_dl_argv_internal attribute_hidden
738 # ifndef DL_ARGV_NOT_RELRO
739 attribute_relro
740 # endif
742 # define rtld_progname (INTUSE(_dl_argv)[0])
743 #else
744 # define rtld_progname _dl_argv[0]
745 #endif
747 /* Flag set at startup and cleared when the last initializer has run. */
748 extern int _dl_starting_up;
749 weak_extern (_dl_starting_up)
750 #ifdef IS_IN_rtld
751 extern int _dl_starting_up_internal attribute_hidden;
752 #endif
754 /* Random data provided by the kernel. */
755 extern void *_dl_random attribute_hidden attribute_relro;
757 /* OS-dependent function to open the zero-fill device. */
758 extern int _dl_sysdep_open_zero_fill (void); /* dl-sysdep.c */
761 /* Write message on the debug file descriptor. The parameters are
762 interpreted as for a `printf' call. All the lines start with a
763 tag showing the PID. */
764 extern void _dl_debug_printf (const char *fmt, ...)
765 __attribute__ ((__format__ (__printf__, 1, 2))) attribute_hidden;
767 /* Write message on the debug file descriptor. The parameters are
768 interpreted as for a `printf' call. All the lines buf the first
769 start with a tag showing the PID. */
770 extern void _dl_debug_printf_c (const char *fmt, ...)
771 __attribute__ ((__format__ (__printf__, 1, 2)));
774 /* Write a message on the specified descriptor FD. The parameters are
775 interpreted as for a `printf' call. */
776 extern void _dl_dprintf (int fd, const char *fmt, ...)
777 __attribute__ ((__format__ (__printf__, 2, 3)))
778 attribute_hidden;
780 /* Write a message on the specified descriptor standard output. The
781 parameters are interpreted as for a `printf' call. */
782 #define _dl_printf(fmt, args...) \
783 _dl_dprintf (STDOUT_FILENO, fmt, ##args)
785 /* Write a message on the specified descriptor standard error. The
786 parameters are interpreted as for a `printf' call. */
787 #define _dl_error_printf(fmt, args...) \
788 _dl_dprintf (STDERR_FILENO, fmt, ##args)
790 /* Write a message on the specified descriptor standard error and exit
791 the program. The parameters are interpreted as for a `printf' call. */
792 #define _dl_fatal_printf(fmt, args...) \
793 do \
795 _dl_dprintf (STDERR_FILENO, fmt, ##args); \
796 _exit (127); \
798 while (1)
801 /* This function is called by all the internal dynamic linker functions
802 when they encounter an error. ERRCODE is either an `errno' code or
803 zero; OBJECT is the name of the problematical shared object, or null if
804 it is a general problem; ERRSTRING is a string describing the specific
805 problem. */
806 extern void _dl_signal_error (int errcode, const char *object,
807 const char *occurred, const char *errstring)
808 internal_function __attribute__ ((__noreturn__)) attribute_hidden;
810 /* Like _dl_signal_error, but may return when called in the context of
811 _dl_receive_error. */
812 extern void _dl_signal_cerror (int errcode, const char *object,
813 const char *occation, const char *errstring)
814 internal_function;
816 /* Call OPERATE, receiving errors from `dl_signal_cerror'. Unlike
817 `_dl_catch_error' the operation is resumed after the OPERATE
818 function returns.
819 ARGS is passed as argument to OPERATE. */
820 extern void _dl_receive_error (receiver_fct fct, void (*operate) (void *),
821 void *args)
822 internal_function;
825 /* Open the shared object NAME and map in its segments.
826 LOADER's DT_RPATH is used in searching for NAME.
827 If the object is already opened, returns its existing map. */
828 extern struct link_map *_dl_map_object (struct link_map *loader,
829 const char *name,
830 int type, int trace_mode, int mode,
831 Lmid_t nsid)
832 internal_function attribute_hidden;
834 /* Call _dl_map_object on the dependencies of MAP, and set up
835 MAP->l_searchlist. PRELOADS points to a vector of NPRELOADS previously
836 loaded objects that will be inserted into MAP->l_searchlist after MAP
837 but before its dependencies. */
838 extern void _dl_map_object_deps (struct link_map *map,
839 struct link_map **preloads,
840 unsigned int npreloads, int trace_mode,
841 int open_mode)
842 internal_function attribute_hidden;
844 /* Cache the locations of MAP's hash table. */
845 extern void _dl_setup_hash (struct link_map *map)
846 internal_function attribute_hidden;
849 /* Collect the directories in the search path for LOADER's dependencies.
850 The data structure is defined in <dlfcn.h>. If COUNTING is true,
851 SI->dls_cnt and SI->dls_size are set; if false, those must be as set
852 by a previous call with COUNTING set, and SI must point to SI->dls_size
853 bytes to be used in filling in the result. */
854 extern void _dl_rtld_di_serinfo (struct link_map *loader,
855 Dl_serinfo *si, bool counting)
856 internal_function;
859 /* Search loaded objects' symbol tables for a definition of the symbol
860 referred to by UNDEF. *SYM is the symbol table entry containing the
861 reference; it is replaced with the defining symbol, and the base load
862 address of the defining object is returned. SYMBOL_SCOPE is a
863 null-terminated list of object scopes to search; each object's
864 l_searchlist (i.e. the segment of the dependency tree starting at that
865 object) is searched in turn. REFERENCE_NAME should name the object
866 containing the reference; it is used in error messages.
867 TYPE_CLASS describes the type of symbol we are looking for. */
868 enum
870 /* If necessary add dependency between user and provider object. */
871 DL_LOOKUP_ADD_DEPENDENCY = 1,
872 /* Return most recent version instead of default version for
873 unversioned lookup. */
874 DL_LOOKUP_RETURN_NEWEST = 2,
875 /* Set if dl_lookup* called with GSCOPE lock held. */
876 DL_LOOKUP_GSCOPE_LOCK = 4,
879 /* Lookup versioned symbol. */
880 extern lookup_t _dl_lookup_symbol_x (const char *undef,
881 struct link_map *undef_map,
882 const ElfW(Sym) **sym,
883 struct r_scope_elem *symbol_scope[],
884 const struct r_found_version *version,
885 int type_class, int flags,
886 struct link_map *skip_map)
887 internal_function attribute_hidden;
890 /* Look up symbol NAME in MAP's scope and return its run-time address. */
891 extern ElfW(Addr) _dl_symbol_value (struct link_map *map, const char *name)
892 internal_function;
894 /* Add the new link_map NEW to the end of the namespace list. */
895 extern void _dl_add_to_namespace_list (struct link_map *new, Lmid_t nsid)
896 internal_function attribute_hidden;
898 /* Allocate a `struct link_map' for a new object being loaded. */
899 extern struct link_map *_dl_new_object (char *realname, const char *libname,
900 int type, struct link_map *loader,
901 int mode, Lmid_t nsid)
902 internal_function attribute_hidden;
904 /* Relocate the given object (if it hasn't already been).
905 SCOPE is passed to _dl_lookup_symbol in symbol lookups.
906 If RTLD_LAZY is set in RELOC-MODE, don't relocate its PLT. */
907 extern void _dl_relocate_object (struct link_map *map,
908 struct r_scope_elem *scope[],
909 int reloc_mode, int consider_profiling)
910 attribute_hidden;
912 /* Protect PT_GNU_RELRO area. */
913 extern void _dl_protect_relro (struct link_map *map)
914 internal_function attribute_hidden;
916 /* Call _dl_signal_error with a message about an unhandled reloc type.
917 TYPE is the result of ELFW(R_TYPE) (r_info), i.e. an R_<CPU>_* value.
918 PLT is nonzero if this was a PLT reloc; it just affects the message. */
919 extern void _dl_reloc_bad_type (struct link_map *map,
920 unsigned int type, int plt)
921 internal_function __attribute__ ((__noreturn__));
923 /* Resolve conflicts if prelinking. */
924 extern void _dl_resolve_conflicts (struct link_map *l,
925 ElfW(Rela) *conflict,
926 ElfW(Rela) *conflictend);
928 /* Check the version dependencies of all objects available through
929 MAP. If VERBOSE print some more diagnostics. */
930 extern int _dl_check_all_versions (struct link_map *map, int verbose,
931 int trace_mode)
932 internal_function;
934 /* Check the version dependencies for MAP. If VERBOSE print some more
935 diagnostics. */
936 extern int _dl_check_map_versions (struct link_map *map, int verbose,
937 int trace_mode)
938 internal_function;
940 /* Initialize the object in SCOPE by calling the constructors with
941 ARGC, ARGV, and ENV as the parameters. */
942 extern void _dl_init (struct link_map *main_map, int argc, char **argv,
943 char **env) internal_function attribute_hidden;
945 /* Call the finalizer functions of all shared objects whose
946 initializer functions have completed. */
947 extern void _dl_fini (void) internal_function;
949 /* Sort array MAPS according to dependencies of the contained objects. */
950 extern void _dl_sort_fini (struct link_map *l, struct link_map **maps,
951 size_t nmaps, char *used, Lmid_t ns)
952 internal_function;
954 /* The dynamic linker calls this function before and having changing
955 any shared object mappings. The `r_state' member of `struct r_debug'
956 says what change is taking place. This function's address is
957 the value of the `r_brk' member. */
958 extern void _dl_debug_state (void);
959 rtld_hidden_proto (_dl_debug_state)
961 /* Initialize `struct r_debug' if it has not already been done. The
962 argument is the run-time load address of the dynamic linker, to be put
963 in the `r_ldbase' member. Returns the address of the structure. */
964 extern struct r_debug *_dl_debug_initialize (ElfW(Addr) ldbase, Lmid_t ns)
965 internal_function;
967 /* Initialize the basic data structure for the search paths. */
968 extern void _dl_init_paths (const char *library_path) internal_function;
970 /* Gather the information needed to install the profiling tables and start
971 the timers. */
972 extern void _dl_start_profile (void) internal_function attribute_hidden;
974 /* The actual functions used to keep book on the calls. */
975 extern void _dl_mcount (ElfW(Addr) frompc, ElfW(Addr) selfpc);
976 extern void _dl_mcount_internal (ElfW(Addr) frompc, ElfW(Addr) selfpc)
977 attribute_hidden;
979 /* This function is simply a wrapper around the _dl_mcount function
980 which does not require a FROMPC parameter since this is the
981 calling function. */
982 extern void _dl_mcount_wrapper (void *selfpc);
984 /* Show the members of the auxiliary array passed up from the kernel. */
985 extern void _dl_show_auxv (void) internal_function;
987 /* Return all environment variables starting with `LD_', one after the
988 other. */
989 extern char *_dl_next_ld_env_entry (char ***position) internal_function;
991 /* Return an array with the names of the important hardware capabilities. */
992 extern const struct r_strlenpair *_dl_important_hwcaps (const char *platform,
993 size_t paltform_len,
994 size_t *sz,
995 size_t *max_capstrlen)
996 internal_function;
998 /* Look up NAME in ld.so.cache and return the file name stored there,
999 or null if none is found. */
1000 extern const char *_dl_load_cache_lookup (const char *name)
1001 internal_function;
1003 /* If the system does not support MAP_COPY we cannot leave the file open
1004 all the time since this would create problems when the file is replaced.
1005 Therefore we provide this function to close the file and open it again
1006 once needed. */
1007 extern void _dl_unload_cache (void) attribute_hidden;
1009 /* System-dependent function to read a file's whole contents in the
1010 most convenient manner available. *SIZEP gets the size of the
1011 file. On error MAP_FAILED is returned. */
1012 extern void *_dl_sysdep_read_whole_file (const char *file, size_t *sizep,
1013 int prot)
1014 internal_function attribute_hidden;
1016 /* System-specific function to do initial startup for the dynamic linker.
1017 After this, file access calls and getenv must work. This is responsible
1018 for setting __libc_enable_secure if we need to be secure (e.g. setuid),
1019 and for setting _dl_argc and _dl_argv, and then calling _dl_main. */
1020 extern ElfW(Addr) _dl_sysdep_start (void **start_argptr,
1021 void (*dl_main) (const ElfW(Phdr) *phdr,
1022 ElfW(Word) phnum,
1023 ElfW(Addr) *user_entry,
1024 ElfW(auxv_t) *auxv))
1025 attribute_hidden;
1027 extern void _dl_sysdep_start_cleanup (void)
1028 internal_function attribute_hidden;
1031 /* Determine next available module ID. */
1032 extern size_t _dl_next_tls_modid (void) internal_function attribute_hidden;
1034 /* Calculate offset of the TLS blocks in the static TLS block. */
1035 extern void _dl_determine_tlsoffset (void) internal_function attribute_hidden;
1037 /* Set up the data structures for TLS, when they were not set up at startup.
1038 Returns nonzero on malloc failure.
1039 This is called from _dl_map_object_from_fd or by libpthread. */
1040 extern int _dl_tls_setup (void) internal_function;
1041 rtld_hidden_proto (_dl_tls_setup)
1043 /* Allocate memory for static TLS block (unless MEM is nonzero) and dtv. */
1044 extern void *_dl_allocate_tls (void *mem) internal_function;
1045 rtld_hidden_proto (_dl_allocate_tls)
1047 /* Get size and alignment requirements of the static TLS block. */
1048 extern void _dl_get_tls_static_info (size_t *sizep, size_t *alignp)
1049 internal_function;
1051 extern void _dl_allocate_static_tls (struct link_map *map)
1052 internal_function attribute_hidden;
1054 /* These are internal entry points to the two halves of _dl_allocate_tls,
1055 only used within rtld.c itself at startup time. */
1056 extern void *_dl_allocate_tls_storage (void)
1057 internal_function attribute_hidden;
1058 extern void *_dl_allocate_tls_init (void *) internal_function;
1059 rtld_hidden_proto (_dl_allocate_tls_init)
1061 /* Deallocate memory allocated with _dl_allocate_tls. */
1062 extern void _dl_deallocate_tls (void *tcb, bool dealloc_tcb) internal_function;
1063 rtld_hidden_proto (_dl_deallocate_tls)
1065 extern void _dl_nothread_init_static_tls (struct link_map *) attribute_hidden;
1067 /* Find origin of the executable. */
1068 extern const char *_dl_get_origin (void) attribute_hidden;
1070 /* Count DSTs. */
1071 extern size_t _dl_dst_count (const char *name, int is_path) attribute_hidden;
1073 /* Substitute DST values. */
1074 extern char *_dl_dst_substitute (struct link_map *l, const char *name,
1075 char *result, int is_path) attribute_hidden;
1077 /* Check validity of the caller. */
1078 extern int _dl_check_caller (const void *caller, enum allowmask mask)
1079 attribute_hidden;
1081 /* Open the shared object NAME, relocate it, and run its initializer if it
1082 hasn't already been run. MODE is as for `dlopen' (see <dlfcn.h>). If
1083 the object is already opened, returns its existing map. */
1084 extern void *_dl_open (const char *name, int mode, const void *caller,
1085 Lmid_t nsid, int argc, char *argv[], char *env[])
1086 attribute_hidden;
1088 /* Free or queue for freeing scope OLD. If other threads might be
1089 in the middle of _dl_fixup, _dl_profile_fixup or dl*sym using the
1090 old scope, OLD can't be freed until no thread is using it. */
1091 extern int _dl_scope_free (void *) attribute_hidden;
1093 /* Add module to slot information data. */
1094 extern void _dl_add_to_slotinfo (struct link_map *l) attribute_hidden;
1096 /* Update slot information data for at least the generation of the
1097 module with the given index. */
1098 extern struct link_map *_dl_update_slotinfo (unsigned long int req_modid);
1100 /* Look up the module's TLS block as for __tls_get_addr,
1101 but never touch anything. Return null if it's not allocated yet. */
1102 extern void *_dl_tls_get_addr_soft (struct link_map *l) attribute_hidden;
1104 extern int _dl_addr_inside_object (struct link_map *l, const ElfW(Addr) addr)
1105 internal_function attribute_hidden;
1107 __END_DECLS
1109 #endif /* ldsodefs.h */