(struct r_search_path_elem): Change for rewrite.
[kopensolaris-gnu/glibc.git] / elf / ldsodefs.h
1 /* Run-time dynamic linker data structures for loaded ELF shared objects.
2    Copyright (C) 1995, 1996, 1997, 1998 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
29 #include <elf.h>
30 #include <dlfcn.h>
31 #include <link.h>
32
33 __BEGIN_DECLS
34
35 /* We use this macro to refer to ELF types independent of the native wordsize.
36    `ElfW(TYPE)' is used in place of `Elf32_TYPE' or `Elf64_TYPE'.  */
37 #define ELFW(type)      _ElfW (ELF, __ELF_NATIVE_CLASS, type)
38
39 /* For the version handling we need an array with only names and their
40    hash values.  */
41 struct r_found_version
42   {
43     const char *name;
44     ElfW(Word) hash;
45
46     int hidden;
47     const char *filename;
48   };
49
50 /* We want to cache information about the searches for shared objects.  */
51
52 enum r_dir_status { unknown, nonexisting, existing };
53
54 struct r_search_path_elem
55   {
56     /* This link is only used in the `all_dirs' member of `r_search_path'.  */
57     struct r_search_path_elem *next;
58
59     /* Strings saying where the definition came from.  */
60     const char *what;
61     const char *where;
62
63     /* Basename for this search path element.  The string must end with
64        a slash character.  */
65     const char *dirname;
66     size_t dirnamelen;
67
68     enum r_dir_status status[0];
69   };
70
71 struct r_strlenpair
72   {
73     const char *str;
74     size_t len;
75   };
76
77
78 /* A data structure for a simple single linked list of strings.  */
79 struct libname_list
80   {
81     const char *name;           /* Name requested (before search).  */
82     struct libname_list *next;  /* Link to next name for this object.  */
83   };
84
85
86 /* Test whether given NAME matches any of the names of the given object.  */
87 static __inline int
88 __attribute__ ((unused))
89 _dl_name_match_p (const char *__name, struct link_map *__map)
90 {
91   int __found = strcmp (__name, __map->l_name) == 0;
92   struct libname_list *__runp = __map->l_libname;
93
94   while (! __found && __runp != NULL)
95     if (strcmp (__name, __runp->name) == 0)
96       __found = 1;
97     else
98       __runp = __runp->next;
99
100   return __found;
101 }
102
103 /* Function used as argument for `_dl_receive_error' function.  The
104    arguments are the error code, error string, and the objname the
105    error occurred in.  */
106 typedef void (*receiver_fct) (int, const char *, const char *);
107 \f
108 /* Internal functions of the run-time dynamic linker.
109    These can be accessed if you link again the dynamic linker
110    as a shared library, as in `-lld' or `/lib/ld.so' explicitly;
111    but are not normally of interest to user programs.
112
113    The `-ldl' library functions in <dlfcn.h> provide a simple
114    user interface to run-time dynamic linking.  */
115
116
117 /* Parameters passed to the dynamic linker.  */
118 extern char **_dl_argv;
119
120 /* Cached value of `getpagesize ()'.  */
121 extern size_t _dl_pagesize;
122
123 /* File descriptor referring to the zero-fill device.  */
124 extern int _dl_zerofd;
125
126 /* Name of the shared object to be profiled (if any).  */
127 extern const char *_dl_profile;
128 /* Map of shared object to be profiled.  */
129 extern struct link_map *_dl_profile_map;
130
131 /* If nonzero the appropriate debug information is printed.  */
132 extern int _dl_debug_libs;
133 extern int _dl_debug_impcalls;
134 extern int _dl_debug_bindings;
135 extern int _dl_debug_symbols;
136 extern int _dl_debug_versions;
137 extern int _dl_debug_reloc;
138 extern int _dl_debug_files;
139
140 /* Expect cache ID.  */
141 extern int _dl_correct_cache_id;
142
143 /* Mask for important hardware capabilities we honour. */
144 extern unsigned long int _dl_hwcap_mask;
145
146 /* File deccriptor to write debug messages to.  */
147 extern int _dl_debug_fd;
148
149 /* OS-dependent function to open the zero-fill device.  */
150 extern int _dl_sysdep_open_zero_fill (void); /* dl-sysdep.c */
151
152 /* OS-dependent function to write a message on the specified
153    descriptor FD.  All arguments are `const char *'; args until a null
154    pointer are concatenated to form the message to print.  */
155 extern void _dl_sysdep_output (int fd, const char *string, ...);
156
157 /* OS-dependent function to write a debug message on the specified
158    descriptor for this.  All arguments are `const char *'; args until
159    a null pointer are concatenated to form the message to print.  If
160    NEW_LINE is nonzero it is assumed that the message starts on a new
161    line.*/
162 extern void _dl_debug_message (int new_line, const char *string, ...);
163
164 /* OS-dependent function to write a message on the standard output.
165    All arguments are `const char *'; args until a null pointer
166    are concatenated to form the message to print.  */
167 #define _dl_sysdep_message(string, args...) \
168   _dl_sysdep_output (STDOUT_FILENO, string, ##args)
169
170 /* OS-dependent function to write a message on the standard error.
171    All arguments are `const char *'; args until a null pointer
172    are concatenated to form the message to print.  */
173 #define _dl_sysdep_error(string, args...) \
174   _dl_sysdep_output (STDERR_FILENO, string, ##args)
175
176 /* OS-dependent function to give a fatal error message and exit
177    when the dynamic linker fails before the program is fully linked.
178    All arguments are `const char *'; args until a null pointer
179    are concatenated to form the message to print.  */
180 #define _dl_sysdep_fatal(string, args...) \
181   do                                                                          \
182     {                                                                         \
183       _dl_sysdep_output (STDERR_FILENO, string, ##args);                      \
184       _exit (127);                                                            \
185     }                                                                         \
186   while (1)
187
188 /* Nonzero if the program should be "secure" (i.e. it's setuid or somesuch).
189    This tells the dynamic linker to ignore environment variables.  */
190 extern int _dl_secure;
191
192 /* This function is called by all the internal dynamic linker functions
193    when they encounter an error.  ERRCODE is either an `errno' code or
194    zero; OBJECT is the name of the problematical shared object, or null if
195    it is a general problem; ERRSTRING is a string describing the specific
196    problem.  */
197 extern void _dl_signal_error (int errcode,
198                               const char *object,
199                               const char *errstring);
200
201 /* Call OPERATE, catching errors from `dl_signal_error'.  If there is no
202    error, *ERRSTRING is set to null.  If there is an error, *ERRSTRING is
203    set to a string constructed from the strings passed to _dl_signal_error,
204    and the error code passed is the return value.  ERRSTRING if nonzero
205    points to a malloc'ed string which the caller has to free after use.
206    ARGS is passed as argument to OPERATE.  */
207 extern int _dl_catch_error (char **errstring,
208                             void (*operate) (void *),
209                             void *args);
210
211 /* Call OPERATE, receiving errors from `dl_signal_error'.  Unlike
212    `_dl_catch_error' the operation is resumed after the OPERATE
213    function returns.
214    ARGS is passed as argument to OPERATE.  */
215 extern void _dl_receive_error (receiver_fct fct, void (*operate) (void *),
216                                void *args);
217
218
219 /* Helper function for <dlfcn.h> functions.  Runs the OPERATE function via
220    _dl_catch_error.  Returns zero for success, nonzero for failure; and
221    arranges for `dlerror' to return the error details.
222    ARGS is passed as argument to OPERATE.  */
223 extern int _dlerror_run (void (*operate) (void *), void *args);
224
225
226 /* Open the shared object NAME and map in its segments.
227    LOADER's DT_RPATH is used in searching for NAME.
228    If the object is already opened, returns its existing map.
229    For preloaded shared objects PRELOADED is set to a non-zero
230    value to allow additional security checks.  */
231 extern struct link_map *_dl_map_object (struct link_map *loader,
232                                         const char *name, int preloaded,
233                                         int type, int trace_mode);
234
235 /* Call _dl_map_object on the dependencies of MAP, and set up
236    MAP->l_searchlist.  PRELOADS points to a vector of NPRELOADS previously
237    loaded objects that will be inserted into MAP->l_searchlist after MAP
238    but before its dependencies.  */
239 extern void _dl_map_object_deps (struct link_map *map,
240                                  struct link_map **preloads,
241                                  unsigned int npreloads, int trace_mode);
242
243 /* Cache the locations of MAP's hash table.  */
244 extern void _dl_setup_hash (struct link_map *map);
245
246
247 /* Open the shared object NAME, relocate it, and run its initializer if it
248    hasn't already been run.  MODE is as for `dlopen' (see <dlfcn.h>).  If
249    the object is already opened, returns its existing map.  */
250 extern struct link_map *_dl_open (const char *name, int mode);
251
252 /* Close an object previously opened by _dl_open.  */
253 extern void _dl_close (struct link_map *map);
254
255
256 /* Search loaded objects' symbol tables for a definition of the symbol
257    referred to by UNDEF.  *SYM is the symbol table entry containing the
258    reference; it is replaced with the defining symbol, and the base load
259    address of the defining object is returned.  SYMBOL_SCOPE is a
260    null-terminated list of object scopes to search; each object's
261    l_searchlist (i.e. the segment of the dependency tree starting at that
262    object) is searched in turn.  REFERENCE_NAME should name the object
263    containing the reference; it is used in error messages.
264    RELOC_TYPE is a machine-dependent reloc type, which is passed to
265    the `elf_machine_lookup_*_p' macros in dl-machine.h to affect which
266    symbols can be chosen.  */
267 extern ElfW(Addr) _dl_lookup_symbol (const char *undef,
268                                      const ElfW(Sym) **sym,
269                                      struct link_map *symbol_scope[],
270                                      const char *reference_name,
271                                      int reloc_type);
272
273 /* Lookup versioned symbol.  */
274 extern ElfW(Addr) _dl_lookup_versioned_symbol (const char *undef,
275                                                const ElfW(Sym) **sym,
276                                                struct link_map *symbol_scope[],
277                                                const char *reference_name,
278                                                const struct r_found_version *version,
279                                                int reloc_type);
280
281 /* For handling RTLD_NEXT we must be able to skip shared objects.  */
282 extern ElfW(Addr) _dl_lookup_symbol_skip (const char *undef,
283                                           const ElfW(Sym) **sym,
284                                           struct link_map *symbol_scope[],
285                                           const char *reference_name,
286                                           struct link_map *skip_this);
287
288 /* For handling RTLD_NEXT with versioned symbols we must be able to
289    skip shared objects.  */
290 extern ElfW(Addr) _dl_lookup_versioned_symbol_skip (const char *undef,
291                                                     const ElfW(Sym) **sym,
292                                                     struct link_map *symbol_scope[],
293                                                     const char *reference_name,
294                                                     const struct r_found_version *version,
295                                                     struct link_map *skip_this);
296
297 /* Locate shared object containing the given address.  */
298 extern int _dl_addr (const void *address, Dl_info *info);
299
300 /* Look up symbol NAME in MAP's scope and return its run-time address.  */
301 extern ElfW(Addr) _dl_symbol_value (struct link_map *map, const char *name);
302
303
304 /* Structure describing the dynamic linker itself.  */
305 extern struct link_map _dl_rtld_map;
306
307 /* The list of objects currently loaded is the third element of the
308    `_dl_default_scope' array, and the fourth element is always null.
309    This leaves two slots before it that are used when resolving
310    DT_SYMBOLIC objects' references one after it for normal references
311    (see below).  */
312 #define _dl_loaded      (_dl_default_scope[2])
313 extern struct link_map *_dl_default_scope[5];
314
315 /* Null-terminated list of objects in the dynamic `global scope'.  The
316    list starts at [2]; i.e. &_dl_global_scope[2] is the argument
317    passed to _dl_lookup_symbol to search the global scope.  To search
318    a specific object and its dependencies in preference to the global
319    scope, fill in the [1] slot and pass its address; for two specific
320    object scopes, fill [0] and [1].  The list is double-terminated; to
321    search the global scope and then a specific object and its
322    dependencies, set *_dl_global_scope_end.  This variable initially
323    points to _dl_default_scope, and _dl_loaded is always kept in [2]
324    of this list.  A new list is malloc'd when new objects are loaded
325    with RTLD_GLOBAL.  */
326 extern struct link_map **_dl_global_scope, **_dl_global_scope_end;
327 extern size_t _dl_global_scope_alloc; /* Number of slots malloc'd.  */
328
329 /* Hack _dl_global_scope[0] and [1] as necessary, and return a pointer into
330    _dl_global_scope that should be passed to _dl_lookup_symbol for symbol
331    references made in the object MAP's relocations.  */
332 extern struct link_map **_dl_object_relocation_scope (struct link_map *map);
333
334
335 /* Allocate a `struct link_map' for a new object being loaded,
336    and enter it into the _dl_loaded list.  */
337 extern struct link_map *_dl_new_object (char *realname, const char *libname,
338                                         int type);
339
340 /* Relocate the given object (if it hasn't already been).
341    SCOPE is passed to _dl_lookup_symbol in symbol lookups.
342    If LAZY is nonzero, don't relocate its PLT.  */
343 extern void _dl_relocate_object (struct link_map *map,
344                                  struct link_map *scope[],
345                                  int lazy);
346
347 /* Check the version dependencies of all objects available through
348    MAP.  If VERBOSE print some more diagnostics.  */
349 extern int _dl_check_all_versions (struct link_map *map, int verbose);
350
351 /* Check the version dependencies for MAP.  If VERBOSE print some more
352    diagnostics.  */
353 extern int _dl_check_map_versions (struct link_map *map, int verbose);
354
355 /* Return the address of the next initializer function for MAP or one of
356    its dependencies that has not yet been run.  When there are no more
357    initializers to be run, this returns zero.  The functions are returned
358    in the order they should be called.  */
359 extern ElfW(Addr) _dl_init_next (struct link_map *map);
360
361 /* Call the finalizer functions of all shared objects whose
362    initializer functions have completed.  */
363 extern void _dl_fini (void);
364
365 /* The dynamic linker calls this function before and having changing
366    any shared object mappings.  The `r_state' member of `struct r_debug'
367    says what change is taking place.  This function's address is
368    the value of the `r_brk' member.  */
369 extern void _dl_debug_state (void);
370
371 /* Initialize `struct r_debug' if it has not already been done.  The
372    argument is the run-time load address of the dynamic linker, to be put
373    in the `r_ldbase' member.  Returns the address of the structure.  */
374 extern struct r_debug *_dl_debug_initialize (ElfW(Addr) ldbase);
375
376 /* Initialize the basic data structure for the search paths.  */
377 extern void _dl_init_paths (const char *library_path);
378
379 /* Gather the information needed to install the profiling tables and start
380    the timers.  */
381 extern void _dl_start_profile (struct link_map *map, const char *output_dir);
382
383 /* The actual functions used to keep book on the calls.  */
384 extern void _dl_mcount (ElfW(Addr) frompc, ElfW(Addr) selfpc);
385
386
387 /* Show the members of the auxiliary array passed up from the kernel.  */
388 extern void _dl_show_auxv (void);
389
390 /* Return all environment variables starting with `LD_', one after the
391    other.  */
392 extern char *_dl_next_ld_env_entry (char ***position);
393
394 /* Return an array with the names of the important hardware capabilities.  */
395 extern const struct r_strlenpair *_dl_important_hwcaps (const char *platform,
396                                                         size_t paltform_len,
397                                                         size_t *sz,
398                                                         size_t *max_capstrlen);
399
400 __END_DECLS
401
402 #endif /* ldsodefs.h */