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