libexec/rtld-elf/rtld.h

   1 /*-
   2  * Copyright 1996, 1997, 1998, 1999, 2000 John D. Polstra.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  * $FreeBSD$
  26  */
  27
  28 #ifndef RTLD_H /* { */
  29 #define RTLD_H 1
  30
  31 #include <machine/elf.h>
  32 #include <sys/types.h>
  33 #include <sys/queue.h>
  34
  35 #include <elf-hints.h>
  36 #include <link.h>
  37 #include <stdarg.h>
  38 #include <setjmp.h>
  39 #include <stddef.h>
  40
  41 #include "rtld_lock.h"
  42 #include "rtld_machdep.h"
  43
  44 #ifndef STANDARD_LIBRARY_PATH
  45 #define STANDARD_LIBRARY_PATH   "/usr/lib"
  46 #endif
  47
  48 #define NEW(type)       ((type *) xmalloc(sizeof(type)))
  49 #define CNEW(type)      ((type *) xcalloc(sizeof(type)))
  50
  51 /* We might as well do booleans like C++. */
  52 typedef unsigned char bool;
  53 #define false   0
  54 #define true    1
  55
  56 extern size_t tls_last_offset;
  57 extern size_t tls_last_size;
  58 extern size_t tls_static_space;
  59 extern int tls_dtv_generation;
  60 extern int tls_max_index;
  61
  62 struct stat;
  63 struct Struct_Obj_Entry;
  64
  65 /* Lists of shared objects */
  66 typedef struct Struct_Objlist_Entry {
  67     STAILQ_ENTRY(Struct_Objlist_Entry) link;
  68     struct Struct_Obj_Entry *obj;
  69 } Objlist_Entry;
  70
  71 typedef STAILQ_HEAD(Struct_Objlist, Struct_Objlist_Entry) Objlist;
  72
  73 /* Types of init and fini functions */
  74 typedef void (*InitFunc)(void);
  75 typedef void (*InitArrayFunc)(int, char **, char **);
  76
  77 /* Lists of shared object dependencies */
  78 typedef struct Struct_Needed_Entry {
  79     struct Struct_Needed_Entry *next;
  80     struct Struct_Obj_Entry *obj;
  81     unsigned long name;         /* Offset of name in string table */
  82 } Needed_Entry;
  83
  84 typedef struct Struct_Name_Entry {
  85     STAILQ_ENTRY(Struct_Name_Entry) link;
  86     char   name[1];
  87 } Name_Entry;
  88
  89 /* Lock object */
  90 typedef struct Struct_LockInfo {
  91     void *context;              /* Client context for creating locks */
  92     void *thelock;              /* The one big lock */
  93     /* Debugging aids. */
  94     volatile int rcount;        /* Number of readers holding lock */
  95     volatile int wcount;        /* Number of writers holding lock */
  96     /* Methods */
  97     void *(*lock_create)(void *context);
  98     void (*rlock_acquire)(void *lock);
  99     void (*wlock_acquire)(void *lock);
 100     void (*rlock_release)(void *lock);
 101     void (*wlock_release)(void *lock);
 102     void (*lock_destroy)(void *lock);
 103     void (*context_destroy)(void *context);
 104 } LockInfo;
 105
 106 typedef struct Struct_Ver_Entry {
 107         Elf_Word     hash;
 108         unsigned int flags;
 109         const char  *name;
 110         const char  *file;
 111 } Ver_Entry;
 112
 113 typedef struct Struct_Sym_Match_Result {
 114     const Elf_Sym *sym_out;
 115     const Elf_Sym *vsymp;
 116     int vcount;
 117 } Sym_Match_Result;
 118
 119 #define VER_INFO_HIDDEN 0x01
 120
 121 /*
 122  * Shared object descriptor.
 123  *
 124  * Items marked with "(%)" are dynamically allocated, and must be freed
 125  * when the structure is destroyed.
 126  *
 127  * CAUTION: It appears that the JDK port peeks into these structures.
 128  * It looks at "next" and "mapbase" at least.  Don't add new members
 129  * near the front, until this can be straightened out.
 130  */
 131 typedef struct Struct_Obj_Entry {
 132     /*
 133      * These two items have to be set right for compatibility with the
 134      * original ElfKit crt1.o.
 135      */
 136     Elf_Size magic;             /* Magic number (sanity check) */
 137     Elf_Size version;           /* Version number of struct format */
 138
 139     struct Struct_Obj_Entry *next;
 140     char *path;                 /* Pathname of underlying file (%) */
 141     char *origin_path;          /* Directory path of origin file */
 142     int refcount;
 143     int dl_refcount;            /* Number of times loaded by dlopen */
 144
 145     /* These items are computed by map_object() or by digest_phdr(). */
 146     caddr_t mapbase;            /* Base address of mapped region */
 147     size_t mapsize;             /* Size of mapped region in bytes */
 148     size_t textsize;            /* Size of text segment in bytes */
 149     Elf_Addr vaddrbase;         /* Base address in shared object file */
 150     caddr_t relocbase;          /* Relocation constant = mapbase - vaddrbase */
 151     const Elf_Dyn *dynamic;     /* Dynamic section */
 152     caddr_t entry;              /* Entry point */
 153     const Elf_Phdr *phdr;       /* Program header if it is mapped, else NULL */
 154     size_t phsize;              /* Size of program header in bytes */
 155     const char *interp;         /* Pathname of the interpreter, if any */
 156     caddr_t relro_page;         /* Address of first page of read-only data */
 157     size_t relro_size;          /* Size of relro page(s) in bytes */
 158     Elf_Word stack_flags;
 159
 160     /* TLS information */
 161     int tlsindex;               /* Index in DTV for this module */
 162     void *tlsinit;              /* Base address of TLS init block */
 163     size_t tlsinitsize;         /* Size of TLS init block for this module */
 164     size_t tlssize;             /* Size of TLS block for this module */
 165     size_t tlsoffset;           /* Offset of static TLS block for this module */
 166     size_t tlsalign;            /* Alignment of static TLS block */
 167
 168     /* Items from the dynamic section. */
 169     Elf_Addr *pltgot;           /* PLT or GOT, depending on architecture */
 170     const Elf_Rel *rel;         /* Relocation entries */
 171     unsigned long relsize;      /* Size in bytes of relocation info */
 172     const Elf_Rela *rela;       /* Relocation entries with addend */
 173     unsigned long relasize;     /* Size in bytes of addend relocation info */
 174     const Elf_Rel *pltrel;      /* PLT relocation entries */
 175     unsigned long pltrelsize;   /* Size in bytes of PLT relocation info */
 176     const Elf_Rela *pltrela;    /* PLT relocation entries with addend */
 177     unsigned long pltrelasize;  /* Size in bytes of PLT addend reloc info */
 178     const Elf_Sym *symtab;      /* Symbol table */
 179     const char *strtab;         /* String table */
 180     unsigned long strsize;      /* Size in bytes of string table */
 181
 182     const Elf_Verneed *verneed; /* Required versions. */
 183     Elf_Word verneednum;        /* Number of entries in verneed table */
 184     const Elf_Verdef  *verdef;  /* Provided versions. */
 185     Elf_Word verdefnum;         /* Number of entries in verdef table */
 186     const Elf_Versym *versyms;  /* Symbol versions table */
 187
 188     const Elf_Hashelt *buckets; /* Hash table buckets array */
 189     unsigned long nbuckets;     /* Number of buckets */
 190     const Elf_Hashelt *chains;  /* Hash table chain array */
 191     unsigned long nchains;      /* Number of entries in chain array */
 192
 193     Elf32_Word nbuckets_gnu;            /* Number of GNU hash buckets*/
 194     Elf32_Word symndx_gnu;              /* 1st accessible symbol on dynsym table */
 195     Elf32_Word maskwords_bm_gnu;        /* Bloom filter words - 1 (bitmask) */
 196     Elf32_Word shift2_gnu;              /* Bloom filter shift count */
 197     Elf32_Word dynsymcount;             /* Total entries in dynsym table */
 198     Elf_Addr *bloom_gnu;                /* Bloom filter used by GNU hash func */
 199     const Elf_Hashelt *buckets_gnu;     /* GNU hash table bucket array */
 200     const Elf_Hashelt *chain_zero_gnu;  /* GNU hash table value array (Zeroed) */
 201
 202     char *rpath;                /* Search path specified in object */
 203     Needed_Entry *needed;       /* Shared objects needed by this one (%) */
 204     Needed_Entry *needed_filtees;
 205     Needed_Entry *needed_aux_filtees;
 206
 207     STAILQ_HEAD(, Struct_Name_Entry) names; /* List of names for this object we
 208                                                know about. */
 209     Ver_Entry *vertab;          /* Versions required /defined by this object */
 210     int vernum;                 /* Number of entries in vertab */
 211
 212     Elf_Addr init;              /* Initialization function to call */
 213     Elf_Addr fini;              /* Termination function to call */
 214     Elf_Addr preinit_array;     /* Pre-initialization array of functions */
 215     Elf_Addr init_array;        /* Initialization array of functions */
 216     Elf_Addr fini_array;        /* Termination array of functions */
 217     int preinit_array_num;      /* Number of entries in preinit_array */
 218     int init_array_num;         /* Number of entries in init_array */
 219     int fini_array_num;         /* Number of entries in fini_array */
 220
 221     bool mainprog : 1;          /* True if this is the main program */
 222     bool rtld : 1;              /* True if this is the dynamic linker */
 223     bool textrel : 1;           /* True if there are relocations to text seg */
 224     bool symbolic : 1;          /* True if generated with "-Bsymbolic" */
 225     bool bind_now : 1;          /* True if all relocations should be made first */
 226     bool traced : 1;            /* Already printed in ldd trace output */
 227     bool jmpslots_done : 1;     /* Already have relocated the jump slots */
 228     bool init_done : 1;         /* Already have added object to init list */
 229     bool tls_done : 1;          /* Already allocated offset for static TLS */
 230     bool phdr_alloc : 1;        /* Phdr is allocated and needs to be freed. */
 231     bool z_origin : 1;          /* Process rpath and soname tokens */
 232     bool z_nodelete : 1;        /* Do not unload the object and dependencies */
 233     bool z_noopen : 1;          /* Do not load on dlopen */
 234     bool z_loadfltr : 1;        /* Immediately load filtees */
 235     bool ref_nodel : 1;         /* Refcount increased to prevent dlclose */
 236     bool init_scanned: 1;       /* Object is already on init list. */
 237     bool on_fini_list: 1;       /* Object is already on fini list. */
 238     bool dag_inited : 1;        /* Object has its DAG initialized. */
 239     bool filtees_loaded : 1;    /* Filtees loaded */
 240     bool irelative : 1;         /* Object has R_MACHDEP_IRELATIVE relocs */
 241     bool gnu_ifunc : 1;         /* Object has references to STT_GNU_IFUNC */
 242     bool valid_hash_sysv : 1;   /* A valid System V hash hash tag is available */
 243     bool valid_hash_gnu : 1;    /* A valid GNU hash tag is available */
 244
 245     struct link_map linkmap;    /* For GDB and dlinfo() */
 246     Objlist dldags;             /* Object belongs to these dlopened DAGs (%) */
 247     Objlist dagmembers;         /* DAG has these members (%) */
 248     dev_t dev;                  /* Object's filesystem's device */
 249     ino_t ino;                  /* Object's inode number */
 250     void *priv;                 /* Platform-dependent */
 251 } Obj_Entry;
 252
 253 #define RTLD_MAGIC      0xd550b87a
 254 #define RTLD_VERSION    1
 255
 256 #define RTLD_FUNCTRACE "_rtld_functrace"
 257
 258 /* Flags to be passed into symlook_ family of functions. */
 259 #define SYMLOOK_IN_PLT  0x01    /* Lookup for PLT symbol */
 260 #define SYMLOOK_DLSYM   0x02    /* Return newest versioned symbol. Used by
 261                                    dlsym. */
 262
 263 /* Flags for load_object(). */
 264 #define RTLD_LO_NOLOAD  0x01    /* dlopen() specified RTLD_NOLOAD. */
 265 #define RTLD_LO_DLOPEN  0x02    /* Load_object() called from dlopen(). */
 266 #define RTLD_LO_TRACE   0x04    /* Only tracing. */
 267 #define RTLD_LO_NODELETE 0x08   /* Loaded object cannot be closed. */
 268 #define RTLD_LO_FILTEES 0x10    /* Loading filtee. */
 269
 270 /*
 271  * Symbol cache entry used during relocation to avoid multiple lookups
 272  * of the same symbol.
 273  */
 274 typedef struct Struct_SymCache {
 275     const Elf_Sym *sym;         /* Symbol table entry */
 276     const Obj_Entry *obj;       /* Shared object which defines it */
 277 } SymCache;
 278
 279 /*
 280  * This structure provides a reentrant way to keep a list of objects and
 281  * check which ones have already been processed in some way.
 282  */
 283 typedef struct Struct_DoneList {
 284     const Obj_Entry **objs;             /* Array of object pointers */
 285     unsigned int num_alloc;             /* Allocated size of the array */
 286     unsigned int num_used;              /* Number of array slots used */
 287 } DoneList;
 288
 289 struct Struct_RtldLockState {
 290         int lockstate;
 291         sigjmp_buf env;
 292 };
 293
 294 /*
 295  * The pack of arguments and results for the symbol lookup functions.
 296  */
 297 typedef struct Struct_SymLook {
 298     const char *name;
 299     unsigned long hash;
 300     uint_fast32_t hash_gnu;
 301     const Ver_Entry *ventry;
 302     int flags;
 303     const Obj_Entry *defobj_out;
 304     const Elf_Sym *sym_out;
 305     struct Struct_RtldLockState *lockstate;
 306 } SymLook;
 307
 308 void _rtld_error(const char *, ...) __printflike(1, 2);
 309 const char *rtld_strerror(int);
 310 Obj_Entry *map_object(int, const char *, const struct stat *);
 311 void *xcalloc(size_t);
 312 void *xmalloc(size_t);
 313 char *xstrdup(const char *);
 314 extern Elf_Addr _GLOBAL_OFFSET_TABLE_[];
 315
 316 void dump_relocations(Obj_Entry *);
 317 void dump_obj_relocations(Obj_Entry *);
 318 void dump_Elf_Rel(Obj_Entry *, const Elf_Rel *, u_long);
 319 void dump_Elf_Rela(Obj_Entry *, const Elf_Rela *, u_long);
 320
 321 /*
 322  * Function declarations.
 323  */
 324 const char *basename(const char *);
 325 unsigned long elf_hash(const char *);
 326 const Elf_Sym *find_symdef(unsigned long, const Obj_Entry *,
 327   const Obj_Entry **, int, SymCache *, struct Struct_RtldLockState *);
 328 void init_pltgot(Obj_Entry *);
 329 void lockdflt_init(void);
 330 void obj_free(Obj_Entry *);
 331 Obj_Entry *obj_new(void);
 332 void _rtld_bind_start(void);
 333 void *rtld_resolve_ifunc(const Obj_Entry *obj, const Elf_Sym *def);
 334 void symlook_init(SymLook *, const char *);
 335 int symlook_obj(SymLook *, const Obj_Entry *);
 336 void *tls_get_addr_common(Elf_Addr** dtvp, int index, size_t offset);
 337 struct tls_tcb  *allocate_tls(Obj_Entry *);
 338 void free_tls(struct tls_tcb *);
 339 void *allocate_module_tls(int index);
 340 bool allocate_tls_offset(Obj_Entry *obj);
 341 void free_tls_offset(Obj_Entry *obj);
 342 const Ver_Entry *fetch_ventry(const Obj_Entry *obj, unsigned long);
 343
 344 /*
 345  * MD function declarations.
 346  */
 347 int do_copy_relocations(Obj_Entry *);
 348 int reloc_non_plt(Obj_Entry *, Obj_Entry *, struct Struct_RtldLockState *);
 349 int reloc_plt(Obj_Entry *);
 350 int reloc_jmpslots(Obj_Entry *, struct Struct_RtldLockState *);
 351 int reloc_iresolve(Obj_Entry *, struct Struct_RtldLockState *);
 352 int reloc_gnu_ifunc(Obj_Entry *, struct Struct_RtldLockState *);
 353 void allocate_initial_tls(Obj_Entry *);
 354
 355 #endif /* } */