Add declaration for _dl_all_dirs and _dl_all_init_dirs.
[kopensolaris-gnu/glibc.git] / sysdeps / generic / ldsodefs.h
1 /* Run-time dynamic linker data structures for loaded ELF shared objects.
2    Copyright (C) 1995-1999, 2000 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 Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    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    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #ifndef _LDSODEFS_H
21 #define _LDSODEFS_H     1
22
23 #include <features.h>
24
25 #define __need_size_t
26 #define __need_NULL
27 #include <stddef.h>
28 #include <string.h>
29
30 #include <elf.h>
31 #include <dlfcn.h>
32 #include <link.h>
33 #include <dl-lookupcfg.h>
34
35 __BEGIN_DECLS
36
37 /* We use this macro to refer to ELF types independent of the native wordsize.
38    `ElfW(TYPE)' is used in place of `Elf32_TYPE' or `Elf64_TYPE'.  */
39 #define ELFW(type)      _ElfW (ELF, __ELF_NATIVE_CLASS, type)
40
41 /* All references to the value of l_info[DT_PLTGOT],
42   l_info[DT_STRTAB], l_info[DT_SYMTAB], l_info[DT_RELA],
43   l_info[DT_REL], l_info[DT_JMPREL], and l_info[VERSYMIDX (DT_VERSYM)]
44   have to be accessed via the D_PTR macro.  The macro is needed since for
45   most architectures the entry is already relocated - but for some not
46   and we need to relocate at access time.  */
47 #ifdef DL_RO_DYN_SECTION
48 # define D_PTR(map,i) (map->i->d_un.d_ptr + map->l_addr)
49 #else
50 # define D_PTR(map,i) map->i->d_un.d_ptr
51 #endif
52
53 /* On some platforms more information than just the address of the symbol
54    is needed from the lookup functions.  In this case we return the whole
55    link map.  */
56 #ifdef DL_LOOKUP_RETURNS_MAP
57 typedef struct link_map *lookup_t;
58 # define LOOKUP_VALUE(map) map
59 # define LOOKUP_VALUE_ADDRESS(map) (map ? map->l_addr : 0)
60 #else
61 typedef ElfW(Addr) lookup_t;
62 # define LOOKUP_VALUE(map) map->l_addr
63 # define LOOKUP_VALUE_ADDRESS(address) address
64 #endif
65
66 /* on some architectures a pointer to a function is not just a pointer
67    to the actual code of the function but rather an architecture
68    specific descriptor. */
69 #ifndef ELF_FUNCTION_PTR_IS_SPECIAL
70 #define DL_SYMBOL_ADDRESS(map, ref) \
71  (void *) (LOOKUP_VALUE_ADDRESS (map) + ref->st_value)
72 #endif
73
74 /* For the version handling we need an array with only names and their
75    hash values.  */
76 struct r_found_version
77   {
78     const char *name;
79     ElfW(Word) hash;
80
81     int hidden;
82     const char *filename;
83   };
84
85 /* We want to cache information about the searches for shared objects.  */
86
87 enum r_dir_status { unknown, nonexisting, existing };
88
89 struct r_search_path_elem
90   {
91     /* This link is only used in the `all_dirs' member of `r_search_path'.  */
92     struct r_search_path_elem *next;
93
94     /* Strings saying where the definition came from.  */
95     const char *what;
96     const char *where;
97
98     /* Basename for this search path element.  The string must end with
99        a slash character.  */
100     const char *dirname;
101     size_t dirnamelen;
102
103     enum r_dir_status status[0];
104   };
105
106 struct r_strlenpair
107   {
108     const char *str;
109     size_t len;
110   };
111
112
113 /* A data structure for a simple single linked list of strings.  */
114 struct libname_list
115   {
116     const char *name;           /* Name requested (before search).  */
117     struct libname_list *next;  /* Link to next name for this object.  */
118     int dont_free;              /* Flag whether this element should be freed
119                                    if the object is not entirely unloaded.  */
120   };
121
122
123 /* Test whether given NAME matches any of the names of the given object.  */
124 static __inline int
125 __attribute__ ((unused))
126 _dl_name_match_p (const char *__name, struct link_map *__map)
127 {
128   int __found = strcmp (__name, __map->l_name) == 0;
129   struct libname_list *__runp = __map->l_libname;
130
131   while (! __found && __runp != NULL)
132     if (strcmp (__name, __runp->name) == 0)
133       __found = 1;
134     else
135       __runp = __runp->next;
136
137   return __found;
138 }
139
140 /* Function used as argument for `_dl_receive_error' function.  The
141    arguments are the error code, error string, and the objname the
142    error occurred in.  */
143 typedef void (*receiver_fct) (int, const char *, const char *);
144 \f
145 /* Internal functions of the run-time dynamic linker.
146    These can be accessed if you link again the dynamic linker
147    as a shared library, as in `-lld' or `/lib/ld.so' explicitly;
148    but are not normally of interest to user programs.
149
150    The `-ldl' library functions in <dlfcn.h> provide a simple
151    user interface to run-time dynamic linking.  */
152
153
154 /* Parameters passed to the dynamic linker.  */
155 extern char **_dl_argv;
156
157 /* Cached value of `getpagesize ()'.  */
158 extern size_t _dl_pagesize;
159
160 /* File descriptor referring to the zero-fill device.  */
161 extern int _dl_zerofd;
162
163 /* Name of the shared object to be profiled (if any).  */
164 extern const char *_dl_profile;
165 /* Map of shared object to be profiled.  */
166 extern struct link_map *_dl_profile_map;
167 /* Filename of the output file.  */
168 extern const char *_dl_profile_output;
169
170 /* If nonzero the appropriate debug information is printed.  */
171 extern int _dl_debug_libs;
172 extern int _dl_debug_impcalls;
173 extern int _dl_debug_bindings;
174 extern int _dl_debug_symbols;
175 extern int _dl_debug_versions;
176 extern int _dl_debug_reloc;
177 extern int _dl_debug_files;
178
179 /* Expect cache ID.  */
180 extern int _dl_correct_cache_id;
181
182 /* Mask for hardware capabilities that are available.  */
183 extern unsigned long int _dl_hwcap;
184
185 /* Mask for important hardware capabilities we honour. */
186 extern unsigned long int _dl_hwcap_mask;
187
188 /* File descriptor to write debug messages to.  */
189 extern int _dl_debug_fd;
190
191 /* Names of shared object for which the RPATH should be ignored.  */
192 extern const char *_dl_inhibit_rpath;
193
194 /* Nonzero if references should be treated as weak during runtime linking.  */
195 extern int _dl_dynamic_weak;
196
197 /* The array with message we print as a last resort.  */
198 extern const char _dl_out_of_memory[];
199
200 /* Nonzero if runtime lookups should not update the .got/.plt.  */
201 extern int _dl_bind_not;
202
203 /* List of search directories.  */
204 extern struct r_search_path_elem *_dl_all_dirs;
205 extern struct r_search_path_elem *_dl_init_all_dirs;
206
207 /* OS-dependent function to open the zero-fill device.  */
208 extern int _dl_sysdep_open_zero_fill (void); /* dl-sysdep.c */
209
210 /* OS-dependent function to write a message on the specified
211    descriptor FD.  All arguments are `const char *'; args until a null
212    pointer are concatenated to form the message to print.  */
213 extern void _dl_sysdep_output (int fd, const char *string, ...);
214
215 /* OS-dependent function to write a debug message on the specified
216    descriptor for this.  All arguments are `const char *'; args until
217    a null pointer are concatenated to form the message to print.  If
218    NEW_LINE is nonzero it is assumed that the message starts on a new
219    line.  */
220 extern void _dl_debug_message (int new_line, const char *string, ...);
221
222 /* OS-dependent function to write a message on the standard output.
223    All arguments are `const char *'; args until a null pointer
224    are concatenated to form the message to print.  */
225 #define _dl_sysdep_message(string, args...) \
226   _dl_sysdep_output (STDOUT_FILENO, string, ##args)
227
228 /* OS-dependent function to write a message on the standard error.
229    All arguments are `const char *'; args until a null pointer
230    are concatenated to form the message to print.  */
231 #define _dl_sysdep_error(string, args...) \
232   _dl_sysdep_output (STDERR_FILENO, string, ##args)
233
234 /* OS-dependent function to give a fatal error message and exit
235    when the dynamic linker fails before the program is fully linked.
236    All arguments are `const char *'; args until a null pointer
237    are concatenated to form the message to print.  */
238 #define _dl_sysdep_fatal(string, args...) \
239   do                                                                          \
240     {                                                                         \
241       _dl_sysdep_output (STDERR_FILENO, string, ##args);                      \
242       _exit (127);                                                            \
243     }                                                                         \
244   while (1)
245
246 /* Nonzero if the program should be "secure" (i.e. it's setuid or somesuch).
247    This tells the dynamic linker to ignore environment variables.  */
248 extern int _dl_secure;
249
250 /* This function is called by all the internal dynamic linker functions
251    when they encounter an error.  ERRCODE is either an `errno' code or
252    zero; OBJECT is the name of the problematical shared object, or null if
253    it is a general problem; ERRSTRING is a string describing the specific
254    problem.  */
255 extern void _dl_signal_error (int errcode, const char *object,
256                               const char *errstring)
257      internal_function
258      __attribute__ ((__noreturn__));
259
260 /* Like _dl_signal_error, but may return when called in the context of
261    _dl_receive_error.  */
262 extern void _dl_signal_cerror (int errcode,
263                                const char *object,
264                                const char *errstring)
265      internal_function;
266
267 /* Call OPERATE, receiving errors from `dl_signal_cerror'.  Unlike
268    `_dl_catch_error' the operation is resumed after the OPERATE
269    function returns.
270    ARGS is passed as argument to OPERATE.  */
271 extern void _dl_receive_error (receiver_fct fct, void (*operate) (void *),
272                                void *args)
273      internal_function;
274
275
276 /* Open the shared object NAME and map in its segments.
277    LOADER's DT_RPATH is used in searching for NAME.
278    If the object is already opened, returns its existing map.
279    For preloaded shared objects PRELOADED is set to a non-zero
280    value to allow additional security checks.  */
281 extern struct link_map *_dl_map_object (struct link_map *loader,
282                                         const char *name, int preloaded,
283                                         int type, int trace_mode, int mode)
284      internal_function;
285
286 /* Call _dl_map_object on the dependencies of MAP, and set up
287    MAP->l_searchlist.  PRELOADS points to a vector of NPRELOADS previously
288    loaded objects that will be inserted into MAP->l_searchlist after MAP
289    but before its dependencies.  */
290 extern void _dl_map_object_deps (struct link_map *map,
291                                  struct link_map **preloads,
292                                  unsigned int npreloads, int trace_mode)
293      internal_function;
294
295 /* Cache the locations of MAP's hash table.  */
296 extern void _dl_setup_hash (struct link_map *map) internal_function;
297
298
299 /* Search loaded objects' symbol tables for a definition of the symbol
300    referred to by UNDEF.  *SYM is the symbol table entry containing the
301    reference; it is replaced with the defining symbol, and the base load
302    address of the defining object is returned.  SYMBOL_SCOPE is a
303    null-terminated list of object scopes to search; each object's
304    l_searchlist (i.e. the segment of the dependency tree starting at that
305    object) is searched in turn.  REFERENCE_NAME should name the object
306    containing the reference; it is used in error messages.
307    RELOC_TYPE is a machine-dependent reloc type, which is passed to
308    the `elf_machine_lookup_*_p' macros in dl-machine.h to affect which
309    symbols can be chosen.  */
310 extern lookup_t _dl_lookup_symbol (const char *undef,
311                                    struct link_map *undef_map,
312                                    const ElfW(Sym) **sym,
313                                    struct r_scope_elem *symbol_scope[],
314                                    int reloc_type, int explicit)
315      internal_function;
316
317 /* Lookup versioned symbol.  */
318 extern lookup_t _dl_lookup_versioned_symbol (const char *undef,
319                                              struct link_map *undef_map,
320                                              const ElfW(Sym) **sym,
321                                              struct r_scope_elem *symbol_scope[],
322                                              const struct r_found_version *version,
323                                              int reloc_type, int explicit)
324      internal_function;
325
326 /* For handling RTLD_NEXT we must be able to skip shared objects.  */
327 extern lookup_t _dl_lookup_symbol_skip (const char *undef,
328                                         struct link_map *undef_map,
329                                         const ElfW(Sym) **sym,
330                                         struct r_scope_elem *symbol_scope[],
331                                         struct link_map *skip_this)
332      internal_function;
333
334 /* For handling RTLD_NEXT with versioned symbols we must be able to
335    skip shared objects.  */
336 extern lookup_t _dl_lookup_versioned_symbol_skip (const char *undef,
337                                                   struct link_map *undef_map,
338                                                   const ElfW(Sym) **sym,
339                                                   struct r_scope_elem *symbol_scope[],
340                                                   const struct r_found_version *version,
341                                                   struct link_map *skip_this)
342      internal_function;
343
344 /* Look up symbol NAME in MAP's scope and return its run-time address.  */
345 extern ElfW(Addr) _dl_symbol_value (struct link_map *map, const char *name)
346      internal_function;
347
348
349 /* Structure describing the dynamic linker itself.  */
350 extern struct link_map _dl_rtld_map;
351 /* And a pointer to the map for the main map.  */
352 extern struct link_map *_dl_loaded;
353 /* Number of object in the _dl_loaded list.  */
354 extern unsigned int _dl_nloaded;
355 /* Array representing global scope.  */
356 extern struct r_scope_elem *_dl_global_scope[2];
357 /* Direct pointer to the searchlist of the main object.  */
358 extern struct r_scope_elem *_dl_main_searchlist;
359 /* Copy of the content of `_dl_main_searchlist'.  */
360 extern struct r_scope_elem _dl_initial_searchlist;
361 /* This is zero at program start to signal that the global scope map is
362    allocated by rtld.  Later it keeps the size of the map.  It might be
363    reset if in _dl_close if the last global object is removed.  */
364 extern size_t _dl_global_scope_alloc;
365
366 /* Allocate a `struct link_map' for a new object being loaded,
367    and enter it into the _dl_main_map list.  */
368 extern struct link_map *_dl_new_object (char *realname, const char *libname,
369                                         int type, struct link_map *loader)
370      internal_function;
371
372 /* Relocate the given object (if it hasn't already been).
373    SCOPE is passed to _dl_lookup_symbol in symbol lookups.
374    If LAZY is nonzero, don't relocate its PLT.  */
375 extern void _dl_relocate_object (struct link_map *map,
376                                  struct r_scope_elem *scope[],
377                                  int lazy, int consider_profiling);
378
379 /* Call _dl_signal_error with a message about an unhandled reloc type.
380    TYPE is the result of ELFW(R_TYPE) (r_info), i.e. an R_<CPU>_* value.
381    PLT is nonzero if this was a PLT reloc; it just affects the message.  */
382 extern void _dl_reloc_bad_type (struct link_map *map,
383                                 uint_fast8_t type, int plt)
384      internal_function;
385
386 /* Check the version dependencies of all objects available through
387    MAP.  If VERBOSE print some more diagnostics.  */
388 extern int _dl_check_all_versions (struct link_map *map, int verbose,
389                                    int trace_mode)
390      internal_function;
391
392 /* Check the version dependencies for MAP.  If VERBOSE print some more
393    diagnostics.  */
394 extern int _dl_check_map_versions (struct link_map *map, int verbose,
395                                    int trace_mode)
396      internal_function;
397
398 /* Initialize the object in SCOPE by calling the constructors with
399    ARGC, ARGV, and ENV as the parameters.  */
400 extern void _dl_init (struct link_map *main_map, int argc, char **argv,
401                       char **env) internal_function;
402
403 /* Call the finalizer functions of all shared objects whose
404    initializer functions have completed.  */
405 extern void _dl_fini (void) internal_function;
406
407 /* The dynamic linker calls this function before and having changing
408    any shared object mappings.  The `r_state' member of `struct r_debug'
409    says what change is taking place.  This function's address is
410    the value of the `r_brk' member.  */
411 extern void _dl_debug_state (void);
412
413 /* Initialize `struct r_debug' if it has not already been done.  The
414    argument is the run-time load address of the dynamic linker, to be put
415    in the `r_ldbase' member.  Returns the address of the structure.  */
416 extern struct r_debug *_dl_debug_initialize (ElfW(Addr) ldbase)
417      internal_function;
418
419 /* Initialize the basic data structure for the search paths.  */
420 extern void _dl_init_paths (const char *library_path) internal_function;
421
422 /* Gather the information needed to install the profiling tables and start
423    the timers.  */
424 extern void _dl_start_profile (struct link_map *map, const char *output_dir)
425      internal_function;
426
427 /* The actual functions used to keep book on the calls.  */
428 extern void _dl_mcount (ElfW(Addr) frompc, ElfW(Addr) selfpc);
429
430 /* This function is simply a wrapper around the _dl_mcount function
431    which does not require a FROMPC parameter since this is the
432    calling function.  */
433 extern void _dl_mcount_wrapper (void *selfpc);
434
435 /* Show the members of the auxiliary array passed up from the kernel.  */
436 extern void _dl_show_auxv (void) internal_function;
437
438 /* Return all environment variables starting with `LD_', one after the
439    other.  */
440 extern char *_dl_next_ld_env_entry (char ***position) internal_function;
441
442 /* Return an array with the names of the important hardware capabilities.  */
443 extern const struct r_strlenpair *_dl_important_hwcaps (const char *platform,
444                                                         size_t paltform_len,
445                                                         size_t *sz,
446                                                         size_t *max_capstrlen)
447      internal_function;
448
449 __END_DECLS
450
451 #endif /* ldsodefs.h */