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