ldso/include/dl-defs.h

   1 /*
   2  * Copyright (C) 2000-2006 by Erik Andersen <andersen@codepoet.org>
   3  *
   4  * GNU Lesser General Public License version 2.1 or later.
   5  */
   6
   7 #ifndef _DL_DEFS_H
   8 #define _DL_DEFS_H
   9
  10 #define FLAG_ANY             -1
  11 #define FLAG_TYPE_MASK       0x00ff
  12 #define FLAG_LIBC4           0x0000
  13 #define FLAG_ELF             0x0001
  14 #define FLAG_ELF_LIBC5       0x0002
  15 #define FLAG_ELF_LIBC6       0x0003
  16 #define FLAG_ELF_UCLIBC      0x0004
  17 #define FLAG_REQUIRED_MASK   0xff00
  18 #define FLAG_SPARC_LIB64     0x0100
  19 #define FLAG_IA64_LIB64      0x0200
  20 #define FLAG_X8664_LIB64     0x0300
  21 #define FLAG_S390_LIB64      0x0400
  22 #define FLAG_POWERPC_LIB64   0x0500
  23 #define FLAG_MIPS64_LIBN32   0x0600
  24 #define FLAG_MIPS64_LIBN64   0x0700
  25
  26 #define LIB_ANY      -1
  27 #define LIB_DLL       0
  28 #define LIB_ELF       1
  29 #define LIB_ELF64     0x80
  30 #define LIB_ELF_LIBC5 2
  31 #define LIB_ELF_LIBC6 3
  32 #define LIB_ELF_LIBC0 4
  33
  34 #if defined(__LDSO_PRELOAD_FILE_SUPPORT__) || defined(__LDSO_CACHE_SUPPORT__)
  35 #ifndef __LDSO_BASE_FILENAME__
  36 #define __LDSO_BASE_FILENAME__ "ld.so"
  37 #endif
  38 #define LDSO_BASE_PATH UCLIBC_RUNTIME_PREFIX "etc/" __LDSO_BASE_FILENAME__
  39
  40 #ifdef __LDSO_PRELOAD_FILE_SUPPORT__
  41 #define LDSO_PRELOAD LDSO_BASE_PATH ".preload"
  42 #endif
  43
  44 #ifdef __LDSO_CACHE_SUPPORT__
  45 #define LDSO_CONF    LDSO_BASE_PATH ".conf"
  46 #define LDSO_CACHE   LDSO_BASE_PATH ".cache"
  47
  48 #define LDSO_CACHE_MAGIC "ld.so-"
  49 #define LDSO_CACHE_MAGIC_LEN (sizeof LDSO_CACHE_MAGIC -1)
  50 #define LDSO_CACHE_VER "1.7.0"
  51 #define LDSO_CACHE_VER_LEN (sizeof LDSO_CACHE_VER -1)
  52
  53 typedef struct {
  54         char magic   [LDSO_CACHE_MAGIC_LEN];
  55         char version [LDSO_CACHE_VER_LEN];
  56         int nlibs;
  57 } header_t;
  58
  59 typedef struct {
  60         int flags;
  61         int sooffset;
  62         int liboffset;
  63 } libentry_t;
  64
  65 #ifdef __ARCH_USE_MMU__
  66 #define LDSO_CACHE_MMAP_FLAGS (MAP_SHARED)
  67 #else
  68 #define LDSO_CACHE_MMAP_FLAGS (MAP_PRIVATE)
  69 #endif
  70 #endif  /* __LDSO_CACHE_SUPPORT__ */
  71
  72 #endif
  73
  74 #ifdef _LIBC
  75 #ifndef __ARCH_HAS_NO_SHARED__
  76 /* arch specific defines */
  77 #include <dl-sysdep.h>
  78 #endif
  79 #endif
  80
  81 /* Provide a means for a port to pass additional arguments to the _dl_start
  82    function.  */
  83 #ifndef DL_START
  84 # define DL_START(X) static void * __attribute_used__ _dl_start(X)
  85 #endif
  86
  87 /* Machines in which different sections may be relocated by different
  88  * amounts should define this and LD_RELOC_ADDR.  If you change this,
  89  * make sure you change struct link_map in include/link.h accordingly
  90  * such that it matches a prefix of struct elf_resolve.
  91  */
  92 #ifndef DL_LOADADDR_TYPE
  93 # define DL_LOADADDR_TYPE ElfW(Addr)
  94 #endif
  95
  96 /* When DL_LOADADDR_TYPE is not a scalar value, or some different
  97  * computation is needed to relocate an address, define this.
  98  */
  99 #ifndef DL_RELOC_ADDR
 100 # define DL_RELOC_ADDR(LOADADDR, ADDR) \
 101         ((LOADADDR) + (ADDR))
 102 #endif
 103
 104 /* Initialize the location of the dynamic addr.  This is only called
 105  * from DL_START, so additional arguments passed to it may be referenced.  */
 106 #ifndef DL_BOOT_COMPUTE_DYN
 107 #define DL_BOOT_COMPUTE_DYN(DPNT, GOT, LOAD_ADDR) \
 108     ((DPNT) = ((ElfW(Dyn) *) DL_RELOC_ADDR(LOAD_ADDR, GOT)))
 109 #endif
 110
 111 /* Initialize the location of the global offset table.  This is only called
 112  * from DL_START, so additional arguments passed to it may be referenced.  */
 113 #ifndef DL_BOOT_COMPUTE_GOT
 114 #define DL_BOOT_COMPUTE_GOT(GOT) \
 115     ((GOT) = elf_machine_dynamic())
 116 #endif
 117
 118 /* Initialize a LOADADDR representing the loader itself.  It's only
 119  * called from DL_START, so additional arguments passed to it may be
 120  * referenced.
 121  */
 122 #ifndef DL_INIT_LOADADDR_BOOT
 123 # define DL_INIT_LOADADDR_BOOT(LOADADDR, BASEADDR) \
 124         ((LOADADDR) = (BASEADDR))
 125 #endif
 126
 127 /* Define if any declarations/definitions of local variables are
 128  * needed in a function that calls DT_INIT_LOADADDR or
 129  * DL_INIT_LOADADDR_HDR.  Declarations must be properly terminated
 130  * with a semicolon, and non-declaration statements are forbidden.
 131  */
 132 #ifndef DL_INIT_LOADADDR_EXTRA_DECLS
 133 # define DL_INIT_LOADADDR_EXTRA_DECLS /* int i; */
 134 #endif
 135
 136 /* Prepare a DL_LOADADDR_TYPE data structure for incremental
 137  * initialization with DL_INIT_LOADADDR_HDR, given pointers to a base
 138  * load address and to program headers.
 139  */
 140 #ifndef DL_INIT_LOADADDR
 141 # define DL_INIT_LOADADDR(LOADADDR, BASEADDR, PHDR, PHDRCNT) \
 142         ((LOADADDR) = (BASEADDR))
 143 #endif
 144
 145 /* Initialize a LOADADDR representing the program.  It's called from
 146  * DL_BOOT only.
 147  */
 148 #ifndef DL_INIT_LOADADDR_PROG
 149 # define DL_INIT_LOADADDR_PROG(LOADADDR, BASEADDR) \
 150         ((LOADADDR) = (DL_LOADADDR_TYPE)(BASEADDR))
 151 #endif
 152
 153 /* Update LOADADDR with information about PHDR, just mapped to the
 154    given ADDR.  */
 155 #ifndef DL_INIT_LOADADDR_HDR
 156 # define DL_INIT_LOADADDR_HDR(LOADADDR, ADDR, PHDR) /* Do nothing.  */
 157 #endif
 158
 159 /* Convert a DL_LOADADDR_TYPE to an identifying pointer.  Used mostly
 160  * for debugging.
 161  */
 162 #ifndef DL_LOADADDR_BASE
 163 # define DL_LOADADDR_BASE(LOADADDR) (LOADADDR)
 164 #endif
 165
 166 /* Test whether a given ADDR is more likely to be within the memory
 167  * region mapped to TPNT (a struct elf_resolve *) than to TFROM.
 168  * Everywhere that this is used, TFROM is initially NULL, and whenever
 169  * a potential match is found, it's updated.  One might want to walk
 170  * the chain of elf_resolve to locate the best match and return false
 171  * whenever TFROM is non-NULL, or use an exact-matching algorithm
 172  * using additional information encoded in DL_LOADADDR_TYPE to test
 173  * for exact containment.
 174  */
 175 #ifndef DL_ADDR_IN_LOADADDR
 176 # define DL_ADDR_IN_LOADADDR(ADDR, TPNT, TFROM) \
 177         ((void*)(TPNT)->mapaddr < (void*)(ADDR) \
 178          && (!(TFROM) || (TFROM)->mapaddr < (TPNT)->mapaddr))
 179 #endif
 180
 181 /* This is called from dladdr() to give targets that use function descriptors
 182  * a chance to map a function descriptor's address to the function's entry
 183  * point before trying to find in which library it's defined.  */
 184 #ifndef DL_LOOKUP_ADDRESS
 185 #define DL_LOOKUP_ADDRESS(ADDRESS) (ADDRESS)
 186 #endif
 187
 188 /* On some architectures dladdr can't use st_size of all symbols this way.  */
 189 #define DL_ADDR_SYM_MATCH(SYM_ADDR, SYM, MATCHSYM, ADDR)                                \
 190   ((ADDR) >= (SYM_ADDR)                                                                                                 \
 191    && ((((SYM)->st_shndx == SHN_UNDEF || (SYM)->st_size == 0)                   \
 192         && (ADDR) == (SYM_ADDR))                                                                                \
 193        || (ADDR) < (SYM_ADDR) + (SYM)->st_size)                                                 \
 194    && (!(MATCHSYM) || MATCHSYM < (SYM_ADDR)))
 195
 196 /* Use this macro to convert a pointer to a function's entry point to
 197  * a pointer to function.  The pointer is assumed to have already been
 198  * relocated.  LOADADDR is passed because it may contain additional
 199  * information needed to compute the pointer to function.
 200  */
 201 #ifndef DL_ADDR_TO_FUNC_PTR
 202 # define DL_ADDR_TO_FUNC_PTR(ADDR, LOADADDR) ((void(*)(void))(ADDR))
 203 #endif
 204
 205 /* On some platforms, computing a pointer to function is more
 206    expensive than calling a function at a given address, so this
 207    alternative is provided.  The function signature must be given
 208    within parentheses, as in a type cast.  */
 209 #ifndef DL_CALL_FUNC_AT_ADDR
 210 # define DL_CALL_FUNC_AT_ADDR(ADDR, LOADADDR, SIGNATURE, ...) \
 211   ((*SIGNATURE DL_ADDR_TO_FUNC_PTR ((ADDR), (LOADADDR)))(__VA_ARGS__))
 212 #endif
 213
 214 /* An alignment value for a memory block returned by _dl_malloc. */
 215 #ifndef DL_MALLOC_ALIGN
 216 # define DL_MALLOC_ALIGN (__WORDSIZE / 8)
 217 #endif
 218
 219 #ifdef __UCLIBC_UNDERSCORES__
 220 # define __C_SYMBOL_PREFIX__ "_"
 221 #else
 222 # define __C_SYMBOL_PREFIX__ ""
 223 #endif
 224
 225 /* Define this if you want to modify the VALUE returned by
 226    _dl_find_hash for this reloc TYPE.  TPNT is the module in which the
 227    matching SYM was found.  */
 228 #ifndef DL_FIND_HASH_VALUE
 229 # define DL_FIND_HASH_VALUE(TPNT, TYPE, SYM) (DL_RELOC_ADDR ((TPNT)->loadaddr, (SYM)->st_value))
 230 #endif
 231
 232 /* Unmap all previously-mapped segments accumulated in LOADADDR.
 233    Generally used when an error occurs during loading.  */
 234 #ifndef DL_LOADADDR_UNMAP
 235 # define DL_LOADADDR_UNMAP(LOADADDR, LEN) \
 236   _dl_munmap((char *) (LOADADDR), (LEN))
 237 #endif
 238
 239 /* Similar to DL_LOADADDR_UNMAP, but used for libraries that have been
 240    dlopen()ed successfully, when they're dlclose()d.  */
 241 #ifndef DL_LIB_UNMAP
 242 # define DL_LIB_UNMAP(LIB, LEN) (DL_LOADADDR_UNMAP ((LIB)->mapaddr, (LEN)))
 243 #endif
 244
 245 /* Define this to verify that a library named LIBNAME, whose ELF
 246    headers are pointed to by EPNT, is suitable for dynamic linking.
 247    If it is not, print an error message (optional) and return NULL.
 248    If the library can have its segments relocated independently,
 249    arrange for PICLIB to be set to 2.  If all segments have to be
 250    relocated by the same amount, set it to 1.  If it has to be loaded
 251    at physical addresses as specified in the program headers, set it
 252    to 0.  A reasonable (?) guess for PICLIB will already be in place,
 253    so it is safe to do nothing here.  */
 254 #ifndef DL_CHECK_LIB_TYPE
 255 # define DL_CHECK_LIB_TYPE(EPNT, PICLIB, PROGNAME, LIBNAME) (void)0
 256 #endif
 257
 258 /* Define this if you have special segment.  */
 259 #ifndef DL_IS_SPECIAL_SEGMENT
 260 # define DL_IS_SPECIAL_SEGMENT(EPNT, PPNT) 0
 261 #endif
 262
 263 /* Define this if you want to use special method to map the segment.  */
 264 #ifndef DL_MAP_SEGMENT
 265 # define DL_MAP_SEGMENT(EPNT, PPNT, INFILE, FLAGS) 0
 266 #endif
 267
 268 /* Define this to declare the library offset. */
 269 #ifndef DL_DEF_LIB_OFFSET
 270 # define DL_DEF_LIB_OFFSET static unsigned long _dl_library_offset
 271 #endif
 272
 273 /* Define this to get the library offset. */
 274 #ifndef DL_GET_LIB_OFFSET
 275 # define DL_GET_LIB_OFFSET() _dl_library_offset
 276 #endif
 277
 278 /* Define this to set the library offset  as difference beetwen the mapped
 279    library address and the smallest virtual address of the first PT_LOAD
 280    segment. */
 281 #ifndef DL_SET_LIB_OFFSET
 282 # define DL_SET_LIB_OFFSET(offset) (_dl_library_offset = (offset))
 283 #endif
 284
 285 /* Define this to get the real object's runtime address. */
 286 #ifndef DL_GET_RUN_ADDR
 287 # define DL_GET_RUN_ADDR(loadaddr, mapaddr) (mapaddr)
 288 #endif
 289
 290 #endif  /* _DL_DEFS_H */