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(1, 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 extern int main_argc;
  63 extern char **main_argv;
  64 extern char **environ;
  65
  66 struct stat;
  67 struct Struct_Obj_Entry;
  68
  69 /* Lists of shared objects */
  70 typedef struct Struct_Objlist_Entry {
  71     STAILQ_ENTRY(Struct_Objlist_Entry) link;
  72     struct Struct_Obj_Entry *obj;
  73 } Objlist_Entry;
  74
  75 typedef STAILQ_HEAD(Struct_Objlist, Struct_Objlist_Entry) Objlist;
  76
  77 /* Types of init and fini functions */
  78 typedef void (*InitFunc)(void);
  79 typedef void (*InitArrFunc)(int, char **, char **);
  80
  81 /* Lists of shared object dependencies */
  82 typedef struct Struct_Needed_Entry {
  83     struct Struct_Needed_Entry *next;
  84     struct Struct_Obj_Entry *obj;
  85     unsigned long name;         /* Offset of name in string table */
  86 } Needed_Entry;
  87
  88 typedef struct Struct_Name_Entry {
  89     STAILQ_ENTRY(Struct_Name_Entry) link;
  90     char   name[1];
  91 } Name_Entry;
  92
  93 /* Lock object */
  94 typedef struct Struct_LockInfo {
  95     void *context;              /* Client context for creating locks */
  96     void *thelock;              /* The one big lock */
  97     /* Debugging aids. */
  98     volatile int rcount;        /* Number of readers holding lock */
  99     volatile int wcount;        /* Number of writers holding lock */
 100     /* Methods */
 101     void *(*lock_create)(void *context);
 102     void (*rlock_acquire)(void *lock);
 103     void (*wlock_acquire)(void *lock);
 104     void (*rlock_release)(void *lock);
 105     void (*wlock_release)(void *lock);
 106     void (*lock_destroy)(void *lock);
 107     void (*context_destroy)(void *context);
 108 } LockInfo;
 109
 110 typedef struct Struct_Ver_Entry {
 111         Elf_Word     hash;
 112         unsigned int flags;
 113         const char  *name;
 114         const char  *file;
 115 } Ver_Entry;
 116
 117 typedef struct Struct_Sym_Match_Result {
 118     const Elf_Sym *sym_out;
 119     const Elf_Sym *vsymp;
 120     int vcount;
 121 } Sym_Match_Result;
 122
 123 #define VER_INFO_HIDDEN 0x01
 124
 125 /*
 126  * Shared object descriptor.
 127  *
 128  * Items marked with "(%)" are dynamically allocated, and must be freed
 129  * when the structure is destroyed.
 130  *
 131  * CAUTION: It appears that the JDK port peeks into these structures.
 132  * It looks at "next" and "mapbase" at least.  Don't add new members
 133  * near the front, until this can be straightened out.
 134  */
 135 typedef struct Struct_Obj_Entry {
 136     /*
 137      * These two items have to be set right for compatibility with the
 138      * original ElfKit crt1.o.
 139      */
 140     Elf_Size magic;             /* Magic number (sanity check) */
 141     Elf_Size version;           /* Version number of struct format */
 142
 143     struct Struct_Obj_Entry *next;
 144     char *path;                 /* Pathname of underlying file (%) */
 145     char *origin_path;          /* Directory path of origin file */
 146     int refcount;
 147     int dl_refcount;            /* Number of times loaded by dlopen */
 148
 149     /* These items are computed by map_object() or by digest_phdr(). */
 150     caddr_t mapbase;            /* Base address of mapped region */
 151     size_t mapsize;             /* Size of mapped region in bytes */
 152     size_t textsize;            /* Size of text segment in bytes */
 153     Elf_Addr vaddrbase;         /* Base address in shared object file */
 154     caddr_t relocbase;          /* Relocation constant = mapbase - vaddrbase */
 155     const Elf_Dyn *dynamic;     /* Dynamic section */
 156     caddr_t entry;              /* Entry point */
 157     const Elf_Phdr *phdr;       /* Program header if it is mapped, else NULL */
 158     size_t phsize;              /* Size of program header in bytes */
 159     const char *interp;         /* Pathname of the interpreter, if any */
 160     caddr_t relro_page;         /* Address of first page of read-only data */
 161     size_t relro_size;          /* Size of relro page(s) in bytes */
 162     Elf_Word stack_flags;
 163
 164     /* TLS information */
 165     int tlsindex;               /* Index in DTV for this module */
 166     void *tlsinit;              /* Base address of TLS init block */
 167     size_t tlsinitsize;         /* Size of TLS init block for this module */
 168     size_t tlssize;             /* Size of TLS block for this module */
 169     size_t tlsoffset;           /* Offset of static TLS block for this module */
 170     size_t tlsalign;            /* Alignment of static TLS block */
 171
 172     /* Items from the dynamic section. */
 173     Elf_Addr *pltgot;           /* PLT or GOT, depending on architecture */
 174     const Elf_Rel *rel;         /* Relocation entries */
 175     unsigned long relsize;      /* Size in bytes of relocation info */
 176     const Elf_Rela *rela;       /* Relocation entries with addend */
 177     unsigned long relasize;     /* Size in bytes of addend relocation info */
 178     const Elf_Rel *pltrel;      /* PLT relocation entries */
 179     unsigned long pltrelsize;   /* Size in bytes of PLT relocation info */
 180     const Elf_Rela *pltrela;    /* PLT relocation entries with addend */
 181     unsigned long pltrelasize;  /* Size in bytes of PLT addend reloc info */
 182     const Elf_Sym *symtab;      /* Symbol table */
 183     const char *strtab;         /* String table */
 184     unsigned long strsize;      /* Size in bytes of string table */
 185
 186     const Elf_Verneed *verneed; /* Required versions. */
 187     Elf_Word verneednum;        /* Number of entries in verneed table */
 188     const Elf_Verdef  *verdef;  /* Provided versions. */
 189     Elf_Word verdefnum;         /* Number of entries in verdef table */
 190     const Elf_Versym *versyms;  /* Symbol versions table */
 191
 192     const Elf_Hashelt *buckets; /* Hash table buckets array */
 193     unsigned long nbuckets;     /* Number of buckets */
 194     const Elf_Hashelt *chains;  /* Hash table chain array */
 195     unsigned long nchains;      /* Number of entries in chain array */
 196
 197     Elf32_Word nbuckets_gnu;            /* Number of GNU hash buckets*/
 198     Elf32_Word symndx_gnu;              /* 1st accessible symbol on dynsym table */
 199     Elf32_Word maskwords_bm_gnu;        /* Bloom filter words - 1 (bitmask) */
 200     Elf32_Word shift2_gnu;              /* Bloom filter shift count */
 201     Elf32_Word dynsymcount;             /* Total entries in dynsym table */
 202     Elf_Addr *bloom_gnu;                /* Bloom filter used by GNU hash func */
 203     const Elf_Hashelt *buckets_gnu;     /* GNU hash table bucket array */
 204     const Elf_Hashelt *chain_zero_gnu;  /* GNU hash table value array (Zeroed) */
 205
 206     char *rpath;                /* Search path specified in object */
 207     char *runpath;              /* Search path with different priority */
 208     Needed_Entry *needed;       /* Shared objects needed by this one (%) */
 209     Needed_Entry *needed_filtees;
 210     Needed_Entry *needed_aux_filtees;
 211
 212     STAILQ_HEAD(, Struct_Name_Entry) names; /* List of names for this object we
 213                                                know about. */
 214     Ver_Entry *vertab;          /* Versions required /defined by this object */
 215     int vernum;                 /* Number of entries in vertab */
 216
 217     Elf_Addr init;              /* Initialization function to call */
 218     Elf_Addr fini;              /* Termination function to call */
 219     Elf_Addr preinit_array;     /* Pre-initialization array of functions */
 220     Elf_Addr init_array;        /* Initialization array of functions */
 221     Elf_Addr fini_array;        /* Termination array of functions */
 222     int preinit_array_num;      /* Number of entries in preinit_array */
 223     int init_array_num;         /* Number of entries in init_array */
 224     int fini_array_num;         /* Number of entries in fini_array */
 225
 226     int32_t osrel;              /* OSREL note value */
 227
 228     bool mainprog : 1;          /* True if this is the main program */
 229     bool rtld : 1;              /* True if this is the dynamic linker */
 230     bool relocated : 1;         /* True if processed by relocate_objects() */
 231     bool textrel : 1;           /* True if there are relocations to text seg */
 232     bool symbolic : 1;          /* True if generated with "-Bsymbolic" */
 233     bool bind_now : 1;          /* True if all relocations should be made first */
 234     bool traced : 1;            /* Already printed in ldd trace output */
 235     bool jmpslots_done : 1;     /* Already have relocated the jump slots */
 236     bool init_done : 1;         /* Already have added object to init list */
 237     bool tls_done : 1;          /* Already allocated offset for static TLS */
 238     bool phdr_alloc : 1;        /* Phdr is allocated and needs to be freed. */
 239     bool z_origin : 1;          /* Process rpath and soname tokens */
 240     bool z_nodelete : 1;        /* Do not unload the object and dependencies */
 241     bool z_noopen : 1;          /* Do not load on dlopen */
 242     bool z_loadfltr : 1;        /* Immediately load filtees */
 243     bool z_nodeflib : 1;        /* Don't search default /usr/lib path */
 244     bool ref_nodel : 1;         /* Refcount increased to prevent dlclose */
 245     bool init_scanned: 1;       /* Object is already on init list. */
 246     bool on_fini_list: 1;       /* Object is already on fini list. */
 247     bool dag_inited : 1;        /* Object has its DAG initialized. */
 248     bool filtees_loaded : 1;    /* Filtees loaded */
 249     bool irelative : 1;         /* Object has R_MACHDEP_IRELATIVE relocs */
 250     bool gnu_ifunc : 1;         /* Object has references to STT_GNU_IFUNC */
 251     bool crt_no_init : 1;       /* Object's crt does not call _init/_fini */
 252     bool note_present : 1;      /* True if at least one PT_NOTE header found */
 253     bool valid_hash_sysv : 1;   /* A valid System V hash hash tag is available */
 254     bool valid_hash_gnu : 1;    /* A valid GNU hash tag is available */
 255
 256     struct link_map linkmap;    /* For GDB and dlinfo() */
 257     Objlist dldags;             /* Object belongs to these dlopened DAGs (%) */
 258     Objlist dagmembers;         /* DAG has these members (%) */
 259     dev_t dev;                  /* Object's filesystem's device */
 260     ino_t ino;                  /* Object's inode number */
 261     void *priv;                 /* Platform-dependent */
 262 } Obj_Entry;
 263
 264 #define RTLD_MAGIC      0xd550b87a
 265 #define RTLD_VERSION    1
 266
 267 #define RTLD_FUNCTRACE "_rtld_functrace"
 268
 269 /* Flags to be passed into symlook_ family of functions. */
 270 #define SYMLOOK_IN_PLT  0x01    /* Lookup for PLT symbol */
 271 #define SYMLOOK_DLSYM   0x02    /* Return newest versioned symbol. Used by
 272                                    dlsym. */
 273 #define SYMLOOK_EARLY   0x04    /* Symlook is done during initialization. */
 274
 275 /* Flags for load_object(). */
 276 #define RTLD_LO_NOLOAD  0x01    /* dlopen() specified RTLD_NOLOAD. */
 277 #define RTLD_LO_DLOPEN  0x02    /* Load_object() called from dlopen(). */
 278 #define RTLD_LO_TRACE   0x04    /* Only tracing. */
 279 #define RTLD_LO_NODELETE 0x08   /* Loaded object cannot be closed. */
 280 #define RTLD_LO_FILTEES 0x10    /* Loading filtee. */
 281 #define RTLD_LO_EARLY   0x20    /* Do not call ctors, postpone it to the
 282                                    initialization during the image start. */
 283
 284 /*
 285  * Symbol cache entry used during relocation to avoid multiple lookups
 286  * of the same symbol.
 287  */
 288 typedef struct Struct_SymCache {
 289     const Elf_Sym *sym;         /* Symbol table entry */
 290     const Obj_Entry *obj;       /* Shared object which defines it */
 291 } SymCache;
 292
 293 /*
 294  * This structure provides a reentrant way to keep a list of objects and
 295  * check which ones have already been processed in some way.
 296  */
 297 typedef struct Struct_DoneList {
 298     const Obj_Entry **objs;             /* Array of object pointers */
 299     unsigned int num_alloc;             /* Allocated size of the array */
 300     unsigned int num_used;              /* Number of array slots used */
 301 } DoneList;
 302
 303 struct Struct_RtldLockState {
 304         int lockstate;
 305         sigjmp_buf env;
 306 };
 307
 308 struct fill_search_info_args {
 309         int request;
 310         unsigned int flags;
 311         struct dl_serinfo *serinfo;
 312         struct dl_serpath *serpath;
 313         char *strspace;
 314 };
 315
 316 /*
 317  * The pack of arguments and results for the symbol lookup functions.
 318  */
 319 typedef struct Struct_SymLook {
 320     const char *name;
 321     unsigned long hash;
 322     uint_fast32_t hash_gnu;
 323     const Ver_Entry *ventry;
 324     int flags;
 325     const Obj_Entry *defobj_out;
 326     const Elf_Sym *sym_out;
 327     struct Struct_RtldLockState *lockstate;
 328 } SymLook;
 329
 330 void _rtld_error(const char *, ...) __printflike(1, 2);
 331 const char *rtld_strerror(int);
 332 Obj_Entry *map_object(int, const char *, const struct stat *);
 333 void *xcalloc(size_t, size_t);
 334 void *xmalloc(size_t);
 335 char *xstrdup(const char *);
 336 extern Elf_Addr _GLOBAL_OFFSET_TABLE_[];
 337
 338 void dump_relocations(Obj_Entry *);
 339 void dump_obj_relocations(Obj_Entry *);
 340 void dump_Elf_Rel(Obj_Entry *, const Elf_Rel *, u_long);
 341 void dump_Elf_Rela(Obj_Entry *, const Elf_Rela *, u_long);
 342
 343 /*
 344  * Function declarations.
 345  */
 346 const char *basename(const char *);
 347 unsigned long elf_hash(const char *);
 348 const Elf_Sym *find_symdef(unsigned long, const Obj_Entry *,
 349   const Obj_Entry **, int, SymCache *, struct Struct_RtldLockState *);
 350 void init_pltgot(Obj_Entry *);
 351 void lockdflt_init(void);
 352 void digest_notes(Obj_Entry *, Elf_Addr, Elf_Addr);
 353 void obj_free(Obj_Entry *);
 354 Obj_Entry *obj_new(void);
 355 void _rtld_bind_start(void);
 356 void *rtld_resolve_ifunc(const Obj_Entry *obj, const Elf_Sym *def);
 357 void symlook_init(SymLook *, const char *);
 358 int symlook_obj(SymLook *, const Obj_Entry *);
 359 void *tls_get_addr_common(Elf_Addr** dtvp, int index, size_t offset);
 360 struct tls_tcb  *allocate_tls(Obj_Entry *);
 361 void free_tls(struct tls_tcb *);
 362 void *allocate_module_tls(int index);
 363 bool allocate_tls_offset(Obj_Entry *obj);
 364 void free_tls_offset(Obj_Entry *obj);
 365 const Ver_Entry *fetch_ventry(const Obj_Entry *obj, unsigned long);
 366
 367 /*
 368  * MD function declarations.
 369  */
 370 int do_copy_relocations(Obj_Entry *);
 371 int reloc_non_plt(Obj_Entry *, Obj_Entry *, int flags,
 372     struct Struct_RtldLockState *);
 373 int reloc_plt(Obj_Entry *);
 374 int reloc_jmpslots(Obj_Entry *, int flags, struct Struct_RtldLockState *);
 375 int reloc_iresolve(Obj_Entry *, struct Struct_RtldLockState *);
 376 int reloc_gnu_ifunc(Obj_Entry *, int flags, struct Struct_RtldLockState *);
 377 void allocate_initial_tls(Obj_Entry *);
 378
 379 #endif /* } */