sysdeps/generic/ldsodefs.h

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