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