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