(rtld_global_ro): Add _dl_pointer_guard.
[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       struct link_map *map;
512     } slotinfo[0];
513   } *_dl_tls_dtv_slotinfo_list;
514   /* Number of modules in the static TLS block.  */
515   EXTERN size_t _dl_tls_static_nelem;
516   /* Size of the static TLS block.  */
517   EXTERN size_t _dl_tls_static_size;
518   /* Size actually allocated in the static TLS block.  */
519   EXTERN size_t _dl_tls_static_used;
520   /* Alignment requirement of the static TLS block.  */
521   EXTERN size_t _dl_tls_static_align;
522
523 /* Number of additional entries in the slotinfo array of each slotinfo
524    list element.  A large number makes it almost certain take we never
525    have to iterate beyond the first element in the slotinfo list.  */
526 # define TLS_SLOTINFO_SURPLUS (62)
527
528 /* Number of additional slots in the dtv allocated.  */
529 # define DTV_SURPLUS    (14)
530
531   /* Initial dtv of the main thread, not allocated with normal malloc.  */
532   EXTERN void *_dl_initial_dtv;
533   /* Generation counter for the dtv.  */
534   EXTERN size_t _dl_tls_generation;
535
536   EXTERN void (*_dl_init_static_tls) (struct link_map *);
537 #endif
538
539 #ifdef SHARED
540 };
541 # define __rtld_global_attribute__
542 # ifdef IS_IN_rtld
543 #  ifdef HAVE_VISIBILITY_ATTRIBUTE
544 #   ifdef HAVE_SDATA_SECTION
545 #    define __rtld_local_attribute__ \
546             __attribute__ ((visibility ("hidden"), section (".sdata")))
547 #    undef __rtld_global_attribute__
548 #    define __rtld_global_attribute__ __attribute__ ((section (".sdata")))
549 #   else
550 #    define __rtld_local_attribute__ __attribute__ ((visibility ("hidden")))
551 #   endif
552 #  else
553 #   define __rtld_local_attribute__
554 #  endif
555 extern struct rtld_global _rtld_local __rtld_local_attribute__;
556 #  undef __rtld_local_attribute__
557 # endif
558 extern struct rtld_global _rtld_global __rtld_global_attribute__;
559 # undef __rtld_global_attribute__
560 #endif
561
562 #ifndef SHARED
563 # define GLRO(name) _##name
564 #else
565 # ifdef IS_IN_rtld
566 #  define GLRO(name) _rtld_local_ro._##name
567 # else
568 #  define GLRO(name) _rtld_global_ro._##name
569 # endif
570 struct rtld_global_ro
571 {
572 #endif
573
574   /* If nonzero the appropriate debug information is printed.  */
575   EXTERN int _dl_debug_mask;
576 #define DL_DEBUG_LIBS       (1 << 0)
577 #define DL_DEBUG_IMPCALLS   (1 << 1)
578 #define DL_DEBUG_BINDINGS   (1 << 2)
579 #define DL_DEBUG_SYMBOLS    (1 << 3)
580 #define DL_DEBUG_VERSIONS   (1 << 4)
581 #define DL_DEBUG_RELOC      (1 << 5)
582 #define DL_DEBUG_FILES      (1 << 6)
583 #define DL_DEBUG_STATISTICS (1 << 7)
584 #define DL_DEBUG_UNUSED     (1 << 8)
585 /* These two are used only internally.  */
586 #define DL_DEBUG_HELP       (1 << 9)
587 #define DL_DEBUG_PRELINK    (1 << 10)
588
589   /* Cached value of `getpagesize ()'.  */
590   EXTERN size_t _dl_pagesize;
591
592   /* OS version.  */
593   EXTERN unsigned int _dl_osversion;
594   /* Platform name.  */
595   EXTERN const char *_dl_platform;
596   EXTERN size_t _dl_platformlen;
597
598   /* Copy of the content of `_dl_main_searchlist' at startup time.  */
599   EXTERN struct r_scope_elem _dl_initial_searchlist;
600
601   /* CLK_TCK as reported by the kernel.  */
602   EXTERN int _dl_clktck;
603
604   /* If nonzero print warnings messages.  */
605   EXTERN int _dl_verbose;
606
607   /* File descriptor to write debug messages to.  */
608   EXTERN int _dl_debug_fd;
609
610   /* Do we do lazy relocations?  */
611   EXTERN int _dl_lazy;
612
613   /* Nonzero if runtime lookups should not update the .got/.plt.  */
614   EXTERN int _dl_bind_not;
615
616   /* Nonzero if references should be treated as weak during runtime
617      linking.  */
618   EXTERN int _dl_dynamic_weak;
619
620   /* Default floating-point control word.  */
621   EXTERN fpu_control_t _dl_fpu_control;
622
623   /* Expected cache ID.  */
624   EXTERN int _dl_correct_cache_id;
625
626   /* 0 if internal pointer values should not be guarded, 1 if they should.  */
627   EXTERN int _dl_pointer_guard;
628
629   /* Mask for hardware capabilities that are available.  */
630   EXTERN uint64_t _dl_hwcap;
631
632   /* Mask for important hardware capabilities we honour. */
633   EXTERN uint64_t _dl_hwcap_mask;
634
635   /* Get architecture specific definitions.  */
636 #define PROCINFO_DECL
637 #ifndef PROCINFO_CLASS
638 # define PROCINFO_CLASS EXTERN
639 #endif
640 #include <dl-procinfo.c>
641
642   /* Names of shared object for which the RPATH should be ignored.  */
643   EXTERN const char *_dl_inhibit_rpath;
644
645   /* Location of the binary.  */
646   EXTERN const char *_dl_origin_path;
647
648   /* -1 if the dynamic linker should honor library load bias,
649      0 if not, -2 use the default (honor biases for normal
650      binaries, don't honor for PIEs).  */
651   EXTERN ElfW(Addr) _dl_use_load_bias;
652
653   /* Name of the shared object to be profiled (if any).  */
654   EXTERN const char *_dl_profile;
655   /* Filename of the output file.  */
656   EXTERN const char *_dl_profile_output;
657   /* Name of the object we want to trace the prelinking.  */
658   EXTERN const char *_dl_trace_prelink;
659   /* Map of shared object to be prelink traced.  */
660   EXTERN struct link_map *_dl_trace_prelink_map;
661
662   /* All search directories defined at startup.  */
663   EXTERN struct r_search_path_elem *_dl_init_all_dirs;
664
665 #if HP_TIMING_AVAIL || HP_SMALL_TIMING_AVAIL
666   /* Overhead of a high-precision timing measurement.  */
667   EXTERN hp_timing_t _dl_hp_timing_overhead;
668 #endif
669
670 #ifdef NEED_DL_SYSINFO
671   /* Syscall handling improvements.  This is very specific to x86.  */
672   EXTERN uintptr_t _dl_sysinfo;
673 #endif
674
675 #if defined NEED_DL_SYSINFO || defined NEED_DL_SYSINFO_DSO
676   /* The vsyscall page is a virtual DSO pre-mapped by the kernel.
677      This points to its ELF header.  */
678   EXTERN const ElfW(Ehdr) *_dl_sysinfo_dso;
679
680   /* At startup time we set up the normal DSO data structure for it,
681      and this points to it.  */
682   EXTERN struct link_map *_dl_sysinfo_map;
683 #endif
684
685 #ifdef SHARED
686   /* We add a function table to _rtld_global which is then used to
687      call the function instead of going through the PLT.  The result
688      is that we can avoid exporting the functions and we do not jump
689      PLT relocations in libc.so.  */
690   void (*_dl_debug_printf) (const char *, ...)
691        __attribute__ ((__format__ (__printf__, 1, 2)));
692   int (internal_function *_dl_catch_error) (const char **, const char **,
693                                             bool *, void (*) (void *), void *);
694   void (internal_function *_dl_signal_error) (int, const char *, const char *,
695                                               const char *);
696   void (*_dl_mcount) (ElfW(Addr) frompc, ElfW(Addr) selfpc);
697   lookup_t (internal_function *_dl_lookup_symbol_x) (const char *,
698                                                      struct link_map *,
699                                                      const ElfW(Sym) **,
700                                                      struct r_scope_elem *[],
701                                                      const struct r_found_version *,
702                                                      int, int,
703                                                      struct link_map *);
704   int (*_dl_check_caller) (const void *, enum allowmask);
705   void *(*_dl_open) (const char *file, int mode, const void *caller_dlopen,
706                      Lmid_t nsid, int argc, char *argv[], char *env[]);
707   void (*_dl_close) (void *map);
708
709   /* List of auditing interfaces.  */
710   struct audit_ifaces *_dl_audit;
711   unsigned int _dl_naudit;
712 };
713 # define __rtld_global_attribute__
714 # ifdef IS_IN_rtld
715 #  ifdef HAVE_VISIBILITY_ATTRIBUTE
716 #   define __rtld_local_attribute__ __attribute__ ((visibility ("hidden")))
717 #  else
718 #   define __rtld_local_attribute__
719 #  endif
720 extern struct rtld_global_ro _rtld_local_ro
721     attribute_relro __rtld_local_attribute__;
722 extern struct rtld_global_ro _rtld_global_ro
723     attribute_relro __rtld_global_attribute__;
724 #  undef __rtld_local_attribute__
725 # else
726 /* We cheat a bit here.  We declare the variable as as const even
727    though it is at startup.  */
728 extern const struct rtld_global_ro _rtld_global_ro
729     attribute_relro __rtld_global_attribute__;
730 # endif
731 # undef __rtld_global_attribute__
732 #endif
733 #undef EXTERN
734
735 #ifdef IS_IN_rtld
736 /* This is the initial value of GL(dl_error_catch_tsd).
737    A non-TLS libpthread will change it.  */
738 extern void **_dl_initial_error_catch_tsd (void) __attribute__ ((const))
739      attribute_hidden;
740 #endif
741
742 /* This is the initial value of GL(dl_make_stack_executable_hook).
743    A threads library can change it.  */
744 extern int _dl_make_stack_executable (void **stack_endp) internal_function;
745 rtld_hidden_proto (_dl_make_stack_executable)
746
747 /* Variable pointing to the end of the stack (or close to it).  This value
748    must be constant over the runtime of the application.  Some programs
749    might use the variable which results in copy relocations on some
750    platforms.  But this does not matter, ld.so can always use the local
751    copy.  */
752 extern void *__libc_stack_end attribute_relro;
753 rtld_hidden_proto (__libc_stack_end)
754
755 /* Parameters passed to the dynamic linker.  */
756 extern int _dl_argc attribute_hidden attribute_relro;
757 extern char **_dl_argv
758 #ifndef DL_ARGV_NOT_RELRO
759      attribute_relro
760 #endif
761      ;
762 #ifdef IS_IN_rtld
763 extern char **_dl_argv_internal attribute_hidden
764 # ifndef DL_ARGV_NOT_RELRO
765      attribute_relro
766 # endif
767      ;
768 # define rtld_progname (INTUSE(_dl_argv)[0])
769 #else
770 # define rtld_progname _dl_argv[0]
771 #endif
772
773 /* Flag set at startup and cleared when the last initializer has run.  */
774 extern int _dl_starting_up;
775 weak_extern (_dl_starting_up)
776 #ifdef IS_IN_rtld
777 extern int _dl_starting_up_internal attribute_hidden;
778 #endif
779
780 /* OS-dependent function to open the zero-fill device.  */
781 extern int _dl_sysdep_open_zero_fill (void); /* dl-sysdep.c */
782
783
784 /* Write message on the debug file descriptor.  The parameters are
785    interpreted as for a `printf' call.  All the lines start with a
786    tag showing the PID.  */
787 extern void _dl_debug_printf (const char *fmt, ...)
788      __attribute__ ((__format__ (__printf__, 1, 2))) attribute_hidden;
789
790 /* Write message on the debug file descriptor.  The parameters are
791    interpreted as for a `printf' call.  All the lines buf the first
792    start with a tag showing the PID.  */
793 extern void _dl_debug_printf_c (const char *fmt, ...)
794      __attribute__ ((__format__ (__printf__, 1, 2)));
795
796
797 /* Write a message on the specified descriptor FD.  The parameters are
798    interpreted as for a `printf' call.  */
799 extern void _dl_dprintf (int fd, const char *fmt, ...)
800      __attribute__ ((__format__ (__printf__, 2, 3)))
801      attribute_hidden;
802
803 /* Write a message on the specified descriptor standard output.  The
804    parameters are interpreted as for a `printf' call.  */
805 #define _dl_printf(fmt, args...) \
806   _dl_dprintf (STDOUT_FILENO, fmt, ##args)
807
808 /* Write a message on the specified descriptor standard error.  The
809    parameters are interpreted as for a `printf' call.  */
810 #define _dl_error_printf(fmt, args...) \
811   _dl_dprintf (STDERR_FILENO, fmt, ##args)
812
813 /* Write a message on the specified descriptor standard error and exit
814    the program.  The parameters are interpreted as for a `printf' call.  */
815 #define _dl_fatal_printf(fmt, args...) \
816   do                                                                          \
817     {                                                                         \
818       _dl_dprintf (STDERR_FILENO, fmt, ##args);                               \
819       _exit (127);                                                            \
820     }                                                                         \
821   while (1)
822
823
824 /* This function is called by all the internal dynamic linker functions
825    when they encounter an error.  ERRCODE is either an `errno' code or
826    zero; OBJECT is the name of the problematical shared object, or null if
827    it is a general problem; ERRSTRING is a string describing the specific
828    problem.  */
829 extern void _dl_signal_error (int errcode, const char *object,
830                               const char *occurred, const char *errstring)
831      internal_function __attribute__ ((__noreturn__)) attribute_hidden;
832
833 /* Like _dl_signal_error, but may return when called in the context of
834    _dl_receive_error.  */
835 extern void _dl_signal_cerror (int errcode, const char *object,
836                                const char *occation, const char *errstring)
837      internal_function;
838
839 /* Call OPERATE, receiving errors from `dl_signal_cerror'.  Unlike
840    `_dl_catch_error' the operation is resumed after the OPERATE
841    function returns.
842    ARGS is passed as argument to OPERATE.  */
843 extern void _dl_receive_error (receiver_fct fct, void (*operate) (void *),
844                                void *args)
845      internal_function;
846
847
848 /* Open the shared object NAME and map in its segments.
849    LOADER's DT_RPATH is used in searching for NAME.
850    If the object is already opened, returns its existing map.
851    For preloaded shared objects PRELOADED is set to a non-zero
852    value to allow additional security checks.  */
853 extern struct link_map *_dl_map_object (struct link_map *loader,
854                                         const char *name, int preloaded,
855                                         int type, int trace_mode, int mode,
856                                         Lmid_t nsid)
857      internal_function attribute_hidden;
858
859 /* Call _dl_map_object on the dependencies of MAP, and set up
860    MAP->l_searchlist.  PRELOADS points to a vector of NPRELOADS previously
861    loaded objects that will be inserted into MAP->l_searchlist after MAP
862    but before its dependencies.  */
863 extern void _dl_map_object_deps (struct link_map *map,
864                                  struct link_map **preloads,
865                                  unsigned int npreloads, int trace_mode,
866                                  int open_mode)
867      internal_function attribute_hidden;
868
869 /* Cache the locations of MAP's hash table.  */
870 extern void _dl_setup_hash (struct link_map *map)
871      internal_function attribute_hidden;
872
873
874 /* Collect the directories in the search path for LOADER's dependencies.
875    The data structure is defined in <dlfcn.h>.  If COUNTING is true,
876    SI->dls_cnt and SI->dls_size are set; if false, those must be as set
877    by a previous call with COUNTING set, and SI must point to SI->dls_size
878    bytes to be used in filling in the result.  */
879 extern void _dl_rtld_di_serinfo (struct link_map *loader,
880                                  Dl_serinfo *si, bool counting)
881      internal_function;
882
883
884 /* Search loaded objects' symbol tables for a definition of the symbol
885    referred to by UNDEF.  *SYM is the symbol table entry containing the
886    reference; it is replaced with the defining symbol, and the base load
887    address of the defining object is returned.  SYMBOL_SCOPE is a
888    null-terminated list of object scopes to search; each object's
889    l_searchlist (i.e. the segment of the dependency tree starting at that
890    object) is searched in turn.  REFERENCE_NAME should name the object
891    containing the reference; it is used in error messages.
892    TYPE_CLASS describes the type of symbol we are looking for.  */
893 enum
894   {
895     /* If necessary add dependency between user and provider object.  */
896     DL_LOOKUP_ADD_DEPENDENCY = 1,
897     /* Return most recent version instead of default version for
898        unversioned lookup.  */
899     DL_LOOKUP_RETURN_NEWEST = 2
900   };
901
902 /* Lookup versioned symbol.  */
903 extern lookup_t _dl_lookup_symbol_x (const char *undef,
904                                      struct link_map *undef_map,
905                                      const ElfW(Sym) **sym,
906                                      struct r_scope_elem *symbol_scope[],
907                                      const struct r_found_version *version,
908                                      int type_class, int explicit,
909                                      struct link_map *skip_map)
910      internal_function attribute_hidden;
911
912
913 /* Look up symbol NAME in MAP's scope and return its run-time address.  */
914 extern ElfW(Addr) _dl_symbol_value (struct link_map *map, const char *name)
915      internal_function;
916
917 /* Allocate a `struct link_map' for a new object being loaded,
918    and enter it into the _dl_main_map list.  */
919 extern struct link_map *_dl_new_object (char *realname, const char *libname,
920                                         int type, struct link_map *loader,
921                                         int mode, Lmid_t nsid)
922      internal_function attribute_hidden;
923
924 /* Relocate the given object (if it hasn't already been).
925    SCOPE is passed to _dl_lookup_symbol in symbol lookups.
926    If LAZY is nonzero, don't relocate its PLT.  */
927 extern void _dl_relocate_object (struct link_map *map,
928                                  struct r_scope_elem *scope[],
929                                  int lazy, int consider_profiling)
930      attribute_hidden;
931
932 /* Protect PT_GNU_RELRO area.  */
933 extern void _dl_protect_relro (struct link_map *map)
934      internal_function attribute_hidden;
935
936 /* Call _dl_signal_error with a message about an unhandled reloc type.
937    TYPE is the result of ELFW(R_TYPE) (r_info), i.e. an R_<CPU>_* value.
938    PLT is nonzero if this was a PLT reloc; it just affects the message.  */
939 extern void _dl_reloc_bad_type (struct link_map *map,
940                                 unsigned int type, int plt)
941      internal_function __attribute__ ((__noreturn__));
942
943 /* Resolve conflicts if prelinking.  */
944 extern void _dl_resolve_conflicts (struct link_map *l,
945                                    ElfW(Rela) *conflict,
946                                    ElfW(Rela) *conflictend);
947
948 /* Check the version dependencies of all objects available through
949    MAP.  If VERBOSE print some more diagnostics.  */
950 extern int _dl_check_all_versions (struct link_map *map, int verbose,
951                                    int trace_mode)
952      internal_function;
953
954 /* Check the version dependencies for MAP.  If VERBOSE print some more
955    diagnostics.  */
956 extern int _dl_check_map_versions (struct link_map *map, int verbose,
957                                    int trace_mode)
958      internal_function;
959
960 /* Initialize the object in SCOPE by calling the constructors with
961    ARGC, ARGV, and ENV as the parameters.  */
962 extern void _dl_init (struct link_map *main_map, int argc, char **argv,
963                       char **env) internal_function attribute_hidden;
964
965 /* Call the finalizer functions of all shared objects whose
966    initializer functions have completed.  */
967 extern void _dl_fini (void) internal_function;
968
969 /* Sort array MAPS according to dependencies of the contained objects.  */
970 extern void _dl_sort_fini (struct link_map *l, struct link_map **maps,
971                            size_t nmaps, char *used, Lmid_t ns)
972      internal_function;
973
974 /* The dynamic linker calls this function before and having changing
975    any shared object mappings.  The `r_state' member of `struct r_debug'
976    says what change is taking place.  This function's address is
977    the value of the `r_brk' member.  */
978 extern void _dl_debug_state (void);
979 rtld_hidden_proto (_dl_debug_state)
980
981 /* Initialize `struct r_debug' if it has not already been done.  The
982    argument is the run-time load address of the dynamic linker, to be put
983    in the `r_ldbase' member.  Returns the address of the structure.  */
984 extern struct r_debug *_dl_debug_initialize (ElfW(Addr) ldbase, Lmid_t ns)
985      internal_function;
986
987 /* Initialize the basic data structure for the search paths.  */
988 extern void _dl_init_paths (const char *library_path) internal_function;
989
990 /* Gather the information needed to install the profiling tables and start
991    the timers.  */
992 extern void _dl_start_profile (void) internal_function attribute_hidden;
993
994 /* The actual functions used to keep book on the calls.  */
995 extern void _dl_mcount (ElfW(Addr) frompc, ElfW(Addr) selfpc);
996 extern void _dl_mcount_internal (ElfW(Addr) frompc, ElfW(Addr) selfpc)
997      attribute_hidden;
998
999 /* This function is simply a wrapper around the _dl_mcount function
1000    which does not require a FROMPC parameter since this is the
1001    calling function.  */
1002 extern void _dl_mcount_wrapper (void *selfpc);
1003
1004 /* Show the members of the auxiliary array passed up from the kernel.  */
1005 extern void _dl_show_auxv (void) internal_function;
1006
1007 /* Return all environment variables starting with `LD_', one after the
1008    other.  */
1009 extern char *_dl_next_ld_env_entry (char ***position) internal_function;
1010
1011 /* Return an array with the names of the important hardware capabilities.  */
1012 extern const struct r_strlenpair *_dl_important_hwcaps (const char *platform,
1013                                                         size_t paltform_len,
1014                                                         size_t *sz,
1015                                                         size_t *max_capstrlen)
1016      internal_function;
1017
1018 /* Look up NAME in ld.so.cache and return the file name stored there,
1019    or null if none is found.  */
1020 extern const char *_dl_load_cache_lookup (const char *name)
1021      internal_function;
1022
1023 /* If the system does not support MAP_COPY we cannot leave the file open
1024    all the time since this would create problems when the file is replaced.
1025    Therefore we provide this function to close the file and open it again
1026    once needed.  */
1027 extern void _dl_unload_cache (void) attribute_hidden;
1028
1029 /* System-dependent function to read a file's whole contents in the
1030    most convenient manner available.  *SIZEP gets the size of the
1031    file.  On error MAP_FAILED is returned.  */
1032 extern void *_dl_sysdep_read_whole_file (const char *file, size_t *sizep,
1033                                          int prot)
1034      internal_function attribute_hidden;
1035
1036 /* System-specific function to do initial startup for the dynamic linker.
1037    After this, file access calls and getenv must work.  This is responsible
1038    for setting __libc_enable_secure if we need to be secure (e.g. setuid),
1039    and for setting _dl_argc and _dl_argv, and then calling _dl_main.  */
1040 extern ElfW(Addr) _dl_sysdep_start (void **start_argptr,
1041                                     void (*dl_main) (const ElfW(Phdr) *phdr,
1042                                                      ElfW(Word) phnum,
1043                                                      ElfW(Addr) *user_entry))
1044      attribute_hidden;
1045
1046 extern void _dl_sysdep_start_cleanup (void)
1047      internal_function attribute_hidden;
1048
1049
1050 /* Determine next available module ID.  */
1051 extern size_t _dl_next_tls_modid (void) internal_function attribute_hidden;
1052
1053 /* Calculate offset of the TLS blocks in the static TLS block.  */
1054 extern void _dl_determine_tlsoffset (void) internal_function attribute_hidden;
1055
1056 /* Set up the data structures for TLS, when they were not set up at startup.
1057    Returns nonzero on malloc failure.
1058    This is called from _dl_map_object_from_fd or by libpthread.  */
1059 extern int _dl_tls_setup (void) internal_function;
1060 rtld_hidden_proto (_dl_tls_setup)
1061
1062 /* Allocate memory for static TLS block (unless MEM is nonzero) and dtv.  */
1063 extern void *_dl_allocate_tls (void *mem) internal_function;
1064 rtld_hidden_proto (_dl_allocate_tls)
1065
1066 /* Get size and alignment requirements of the static TLS block.  */
1067 extern void _dl_get_tls_static_info (size_t *sizep, size_t *alignp)
1068      internal_function;
1069
1070 extern void _dl_allocate_static_tls (struct link_map *map)
1071      internal_function attribute_hidden;
1072
1073 /* These are internal entry points to the two halves of _dl_allocate_tls,
1074    only used within rtld.c itself at startup time.  */
1075 extern void *_dl_allocate_tls_storage (void)
1076      internal_function attribute_hidden;
1077 extern void *_dl_allocate_tls_init (void *) internal_function;
1078 rtld_hidden_proto (_dl_allocate_tls_init)
1079
1080 /* Deallocate memory allocated with _dl_allocate_tls.  */
1081 extern void _dl_deallocate_tls (void *tcb, bool dealloc_tcb) internal_function;
1082 rtld_hidden_proto (_dl_deallocate_tls)
1083
1084 #if defined USE_TLS
1085 extern void _dl_nothread_init_static_tls (struct link_map *) attribute_hidden;
1086 #endif
1087
1088 /* Find origin of the executable.  */
1089 extern const char *_dl_get_origin (void) attribute_hidden;
1090
1091 /* Count DSTs.  */
1092 extern size_t _dl_dst_count (const char *name, int is_path) attribute_hidden;
1093
1094 /* Substitute DST values.  */
1095 extern char *_dl_dst_substitute (struct link_map *l, const char *name,
1096                                  char *result, int is_path) attribute_hidden;
1097
1098 /* Check validity of the caller.  */
1099 extern int _dl_check_caller (const void *caller, enum allowmask mask)
1100      attribute_hidden;
1101
1102 /* Open the shared object NAME, relocate it, and run its initializer if it
1103    hasn't already been run.  MODE is as for `dlopen' (see <dlfcn.h>).  If
1104    the object is already opened, returns its existing map.  */
1105 extern void *_dl_open (const char *name, int mode, const void *caller,
1106                        Lmid_t nsid, int argc, char *argv[], char *env[])
1107      attribute_hidden;
1108
1109 /* Add module to slot information data.  */
1110 extern void _dl_add_to_slotinfo (struct link_map  *l) attribute_hidden;
1111
1112 /* Update slot information data for at least the generation of the
1113    module with the given index.  */
1114 extern struct link_map *_dl_update_slotinfo (unsigned long int req_modid);
1115
1116 __END_DECLS
1117
1118 #endif /* ldsodefs.h */