include/link.h

   1 /* Data structure for communication from the run-time dynamic linker for
   2    loaded ELF shared objects.
   3    Copyright (C) 1995-2002, 2003, 2004 Free Software Foundation, Inc.
   4    This file is part of the GNU C Library.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    The GNU C Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with the GNU C Library; if not, write to the Free
  18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19    02111-1307 USA.  */
  20
  21 #ifndef _LINK_H
  22 #define _LINK_H 1
  23
  24 #include <elf.h>
  25 #include <dlfcn.h>
  26 #include <stddef.h>
  27 #include <sys/types.h>
  28
  29 /* We use this macro to refer to ELF types independent of the native wordsize.
  30    `ElfW(TYPE)' is used in place of `Elf32_TYPE' or `Elf64_TYPE'.  */
  31 #define ElfW(type)      _ElfW (Elf, __ELF_NATIVE_CLASS, type)
  32 #define _ElfW(e,w,t)    _ElfW_1 (e, w, _##t)
  33 #define _ElfW_1(e,w,t)  e##w##t
  34
  35 #include <bits/elfclass.h>              /* Defines __ELF_NATIVE_CLASS.  */
  36 #include <bits/link.h>
  37 #include <dl-lookupcfg.h>
  38 #include <tls.h>                /* Defines USE_TLS.  */
  39
  40 /* Rendezvous structure used by the run-time dynamic linker to communicate
  41    details of shared object loading to the debugger.  If the executable's
  42    dynamic section has a DT_DEBUG element, the run-time linker sets that
  43    element's value to the address where this structure can be found.  */
  44
  45 struct r_debug
  46   {
  47     int r_version;              /* Version number for this protocol.  */
  48
  49     struct link_map *r_map;     /* Head of the chain of loaded objects.  */
  50
  51     /* This is the address of a function internal to the run-time linker,
  52        that will always be called when the linker begins to map in a
  53        library or unmap it, and again when the mapping change is complete.
  54        The debugger can set a breakpoint at this address if it wants to
  55        notice shared object mapping changes.  */
  56     ElfW(Addr) r_brk;
  57     enum
  58       {
  59         /* This state value describes the mapping change taking place when
  60            the `r_brk' address is called.  */
  61         RT_CONSISTENT,          /* Mapping change is complete.  */
  62         RT_ADD,                 /* Beginning to add a new object.  */
  63         RT_DELETE               /* Beginning to remove an object mapping.  */
  64       } r_state;
  65
  66     ElfW(Addr) r_ldbase;        /* Base address the linker is loaded at.  */
  67   };
  68
  69 /* This is the instance of that structure used by the dynamic linker.  */
  70 extern struct r_debug _r_debug;
  71
  72 /* This symbol refers to the "dynamic structure" in the `.dynamic' section
  73    of whatever module refers to `_DYNAMIC'.  So, to find its own
  74    `struct r_debug', a program could do:
  75      for (dyn = _DYNAMIC; dyn->d_tag != DT_NULL; ++dyn)
  76        if (dyn->d_tag == DT_DEBUG)
  77          r_debug = (struct r_debug *) dyn->d_un.d_ptr;
  78    */
  79 extern ElfW(Dyn) _DYNAMIC[];
  80
  81
  82 /* Some internal data structures of the dynamic linker used in the
  83    linker map.  We only provide forward declarations.  */
  84 struct libname_list;
  85 struct r_found_version;
  86 struct r_search_path_elem;
  87
  88 /* Forward declaration.  */
  89 struct link_map;
  90
  91 /* Structure to describe a single list of scope elements.  The lookup
  92    functions get passed an array of pointers to such structures.  */
  93 struct r_scope_elem
  94 {
  95   /* Array of maps for the scope.  */
  96   struct link_map **r_list;
  97   /* Number of entries in the scope.  */
  98   unsigned int r_nlist;
  99 };
 100
 101
 102 /* Structure to record search path and allocation mechanism.  */
 103 struct r_search_path_struct
 104   {
 105     struct r_search_path_elem **dirs;
 106     int malloced;
 107   };
 108
 109
 110 /* Structure describing a loaded shared object.  The `l_next' and `l_prev'
 111    members form a chain of all the shared objects loaded at startup.
 112
 113    These data structures exist in space used by the run-time dynamic linker;
 114    modifying them may have disastrous results.
 115
 116    This data structure might change in future, if necessary.  User-level
 117    programs must avoid defining objects of this type.  */
 118
 119 struct link_map
 120   {
 121     /* These first few members are part of the protocol with the debugger.
 122        This is the same format used in SVR4.  */
 123
 124     ElfW(Addr) l_addr;          /* Base address shared object is loaded at.  */
 125     char *l_name;               /* Absolute file name object was found in.  */
 126     ElfW(Dyn) *l_ld;            /* Dynamic section of the shared object.  */
 127     struct link_map *l_next, *l_prev; /* Chain of loaded objects.  */
 128
 129     /* All following members are internal to the dynamic linker.
 130        They may change without notice.  */
 131
 132     /* This is an element which is only ever different from a pointer to
 133        the very same copy of this type for ld.so when it is used in more
 134        than one namespace.  */
 135     struct link_map *l_real;
 136
 137     /* Number of the namespace this link map belongs to.  */
 138     Lmid_t l_ns;
 139
 140     struct libname_list *l_libname;
 141     /* Indexed pointers to dynamic section.
 142        [0,DT_NUM) are indexed by the processor-independent tags.
 143        [DT_NUM,DT_NUM+DT_THISPROCNUM) are indexed by the tag minus DT_LOPROC.
 144        [DT_NUM+DT_THISPROCNUM,DT_NUM+DT_THISPROCNUM+DT_VERSIONTAGNUM) are
 145        indexed by DT_VERSIONTAGIDX(tagvalue).
 146        [DT_NUM+DT_THISPROCNUM+DT_VERSIONTAGNUM,
 147         DT_NUM+DT_THISPROCNUM+DT_VERSIONTAGNUM+DT_EXTRANUM) are indexed by
 148        DT_EXTRATAGIDX(tagvalue).
 149        [DT_NUM+DT_THISPROCNUM+DT_VERSIONTAGNUM+DT_EXTRANUM,
 150         DT_NUM+DT_THISPROCNUM+DT_VERSIONTAGNUM+DT_EXTRANUM+DT_VALNUM) are
 151        indexed by DT_VALTAGIDX(tagvalue) and
 152        [DT_NUM+DT_THISPROCNUM+DT_VERSIONTAGNUM+DT_EXTRANUM+DT_VALNUM,
 153         DT_NUM+DT_THISPROCNUM+DT_VERSIONTAGNUM+DT_EXTRANUM+DT_VALNUM+DT_ADDRNUM)
 154        are indexed by DT_ADDRTAGIDX(tagvalue), see <elf.h>.  */
 155
 156     ElfW(Dyn) *l_info[DT_NUM + DT_THISPROCNUM + DT_VERSIONTAGNUM
 157                      + DT_EXTRANUM + DT_VALNUM + DT_ADDRNUM];
 158     const ElfW(Phdr) *l_phdr;   /* Pointer to program header table in core.  */
 159     ElfW(Addr) l_entry;         /* Entry point location.  */
 160     ElfW(Half) l_phnum;         /* Number of program header entries.  */
 161     ElfW(Half) l_ldnum; /* Number of dynamic segment entries.  */
 162
 163     /* Array of DT_NEEDED dependencies and their dependencies, in
 164        dependency order for symbol lookup (with and without
 165        duplicates).  There is no entry before the dependencies have
 166        been loaded.  */
 167     struct r_scope_elem l_searchlist;
 168
 169     /* We need a special searchlist to process objects marked with
 170        DT_SYMBOLIC.  */
 171     struct r_scope_elem l_symbolic_searchlist;
 172
 173     /* Dependent object that first caused this object to be loaded.  */
 174     struct link_map *l_loader;
 175
 176     /* Symbol hash table.  */
 177     Elf_Symndx l_nbuckets;
 178     const Elf_Symndx *l_buckets, *l_chain;
 179
 180     unsigned int l_opencount;   /* Counter for direct and indirect usage.  */
 181     unsigned int l_direct_opencount; /* Reference count for dlopen/dlclose.  */
 182     enum                        /* Where this object came from.  */
 183       {
 184         lt_executable,          /* The main executable program.  */
 185         lt_library,             /* Library needed by main executable.  */
 186         lt_loaded               /* Extra run-time loaded shared object.  */
 187       } l_type:2;
 188     unsigned int l_relocated:1; /* Nonzero if object's relocations done.  */
 189     unsigned int l_init_called:1; /* Nonzero if DT_INIT function called.  */
 190     unsigned int l_global:1;    /* Nonzero if object in _dl_global_scope.  */
 191     unsigned int l_reserved:2;  /* Reserved for internal use.  */
 192     unsigned int l_phdr_allocated:1; /* Nonzero if the data structure pointed
 193                                         to by `l_phdr' is allocated.  */
 194     unsigned int l_soname_added:1; /* Nonzero if the SONAME is for sure in
 195                                       the l_libname list.  */
 196     unsigned int l_faked:1;     /* Nonzero if this is a faked descriptor
 197                                    without associated file.  */
 198     unsigned int l_need_tls_init:1; /* Nonzero if GL(dl_init_static_tls)
 199                                        should be called on this link map
 200                                        when relocation finishes.  */
 201     unsigned int l_used:1;      /* Nonzero if the DSO is used.  */
 202     /* Array with version names.  */
 203     unsigned int l_nversions;
 204     struct r_found_version *l_versions;
 205
 206     /* Collected information about own RPATH directories.  */
 207     struct r_search_path_struct l_rpath_dirs;
 208
 209     /* Collected results of relocation while profiling.  */
 210     ElfW(Addr) *l_reloc_result;
 211
 212     /* Pointer to the version information if available.  */
 213     ElfW(Versym) *l_versyms;
 214
 215     /* String specifying the path where this object was found.  */
 216     const char *l_origin;
 217
 218     /* Start and finish of memory map for this object.  l_map_start
 219        need not be the same as l_addr.  */
 220     ElfW(Addr) l_map_start, l_map_end;
 221     /* End of the executable part of the mapping.  */
 222     ElfW(Addr) l_text_end;
 223
 224     /* Default array for 'l_scope'.  */
 225     struct r_scope_elem *l_scope_mem[4];
 226     /* Size of array allocated for 'l_scope'.  */
 227     size_t l_scope_max;
 228     /* This is an array defining the lookup scope for this link map.
 229        There are at most three different scope lists.  */
 230     struct r_scope_elem **l_scope;
 231
 232     /* A similar array, this time only with the local scope.  This is
 233        used occasionally.  */
 234     struct r_scope_elem *l_local_scope[2];
 235
 236     /* This information is kept to check for sure whether a shared
 237        object is the same as one already loaded.  */
 238     dev_t l_dev;
 239     ino64_t l_ino;
 240
 241     /* Collected information about own RUNPATH directories.  */
 242     struct r_search_path_struct l_runpath_dirs;
 243
 244     /* List of object in order of the init and fini calls.  */
 245     struct link_map **l_initfini;
 246
 247     /* List of the dependencies introduced through symbol binding.  */
 248     unsigned int l_reldepsmax;
 249     unsigned int l_reldepsact;
 250     struct link_map **l_reldeps;
 251
 252     /* Various flag words.  */
 253     ElfW(Word) l_feature_1;
 254     ElfW(Word) l_flags_1;
 255     ElfW(Word) l_flags;
 256
 257     /* Temporarily used in `dl_close'.  */
 258     unsigned int l_idx;
 259
 260     struct link_map_machine l_mach;
 261
 262     struct
 263     {
 264       const ElfW(Sym) *sym;
 265       int type_class;
 266 #ifdef DL_LOOKUP_RETURNS_MAP
 267       struct link_map *value;
 268 #else
 269       ElfW(Addr) value;
 270 #endif
 271       const ElfW(Sym) *ret;
 272     } l_lookup_cache;
 273
 274 #ifdef USE_TLS
 275     /* Thread-local storage related info.  */
 276
 277     /* Start of the initialization image.  */
 278     void *l_tls_initimage;
 279     /* Size of the initialization image.  */
 280     size_t l_tls_initimage_size;
 281     /* Size of the TLS block.  */
 282     size_t l_tls_blocksize;
 283     /* Alignment requirement of the TLS block.  */
 284     size_t l_tls_align;
 285     /* Offset of first byte module alignment.  */
 286     size_t l_tls_firstbyte_offset;
 287 # ifndef NO_TLS_OFFSET
 288 #  define NO_TLS_OFFSET 0
 289 # endif
 290     /* For objects present at startup time: offset in the static TLS block.  */
 291     ptrdiff_t l_tls_offset;
 292     /* Index of the module in the dtv array.  */
 293     size_t l_tls_modid;
 294 #endif
 295
 296     /* Information used to change permission after the relocations are
 297        done.  */
 298     ElfW(Addr) l_relro_addr;
 299     size_t l_relro_size;
 300   };
 301
 302 struct dl_phdr_info
 303   {
 304     ElfW(Addr) dlpi_addr;
 305     const char *dlpi_name;
 306     const ElfW(Phdr) *dlpi_phdr;
 307     ElfW(Half) dlpi_phnum;
 308
 309     unsigned long long int dlpi_adds;
 310     unsigned long long int dlpi_subs;
 311   };
 312
 313 extern int dl_iterate_phdr (int (*callback) (struct dl_phdr_info *info,
 314                                              size_t size, void *data),
 315                             void *data);
 316 extern int __dl_iterate_phdr (int (*callback) (struct dl_phdr_info *info,
 317                                                size_t size, void *data),
 318                               void *data);
 319
 320 #endif /* link.h */