1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright 1996, 1997, 1998, 1999, 2000 John D. Polstra. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 * 27 * $FreeBSD$ 28 */ 29 30 #ifndef RTLD_H /* { */ 31 #define RTLD_H 1 32 33 #include <machine/elf.h> 34 #include <sys/types.h> 35 #include <sys/queue.h> 36 37 #include <elf-hints.h> 38 #include <link.h> 39 #include <stdarg.h> 40 #include <stdbool.h> 41 #include <setjmp.h> 42 #include <stddef.h> 43 44 #include "rtld_lock.h" 45 #include "rtld_machdep.h" 46 47 #define NEW(type) ((type *) xmalloc(sizeof(type))) 48 #define CNEW(type) ((type *) xcalloc(1, sizeof(type))) 49 50 extern size_t tls_last_offset; 51 extern size_t tls_last_size; 52 extern size_t tls_static_space; 53 extern Elf_Addr tls_dtv_generation; 54 extern int tls_max_index; 55 56 extern int npagesizes; 57 extern size_t *pagesizes; 58 extern size_t page_size; 59 60 extern int main_argc; 61 extern char **main_argv; 62 extern char **environ; 63 64 struct stat; 65 struct Struct_Obj_Entry; 66 67 /* Lists of shared objects */ 68 typedef struct Struct_Objlist_Entry { 69 STAILQ_ENTRY(Struct_Objlist_Entry) link; 70 struct Struct_Obj_Entry *obj; 71 } Objlist_Entry; 72 73 typedef STAILQ_HEAD(Struct_Objlist, Struct_Objlist_Entry) Objlist; 74 75 /* Types of init and fini functions */ 76 typedef void (*InitFunc)(void); 77 typedef void (*InitArrFunc)(int, char **, char **); 78 79 /* Lists of shared object dependencies */ 80 typedef struct Struct_Needed_Entry { 81 struct Struct_Needed_Entry *next; 82 struct Struct_Obj_Entry *obj; 83 unsigned long name; /* Offset of name in string table */ 84 } Needed_Entry; 85 86 typedef struct Struct_Name_Entry { 87 STAILQ_ENTRY(Struct_Name_Entry) link; 88 char name[1]; 89 } Name_Entry; 90 91 /* Lock object */ 92 typedef struct Struct_LockInfo { 93 void *context; /* Client context for creating locks */ 94 void *thelock; /* The one big lock */ 95 /* Debugging aids. */ 96 volatile int rcount; /* Number of readers holding lock */ 97 volatile int wcount; /* Number of writers holding lock */ 98 /* Methods */ 99 void *(*lock_create)(void *context); 100 void (*rlock_acquire)(void *lock); 101 void (*wlock_acquire)(void *lock); 102 void (*rlock_release)(void *lock); 103 void (*wlock_release)(void *lock); 104 void (*lock_destroy)(void *lock); 105 void (*context_destroy)(void *context); 106 } LockInfo; 107 108 typedef struct Struct_Ver_Entry { 109 Elf_Word hash; 110 unsigned int flags; 111 const char *name; 112 const char *file; 113 } Ver_Entry; 114 115 typedef struct Struct_Sym_Match_Result { 116 const Elf_Sym *sym_out; 117 const Elf_Sym *vsymp; 118 int vcount; 119 } Sym_Match_Result; 120 121 #define VER_INFO_HIDDEN 0x01 122 123 /* 124 * Shared object descriptor. 125 * 126 * Items marked with "(%)" are dynamically allocated, and must be freed 127 * when the structure is destroyed. 128 * 129 * CAUTION: It appears that the JDK port peeks into these structures. 130 * It looks at "next" and "mapbase" at least. Don't add new members 131 * near the front, until this can be straightened out. 132 */ 133 typedef struct Struct_Obj_Entry { 134 /* 135 * These two items have to be set right for compatibility with the 136 * original ElfKit crt1.o. 137 */ 138 Elf_Size magic; /* Magic number (sanity check) */ 139 Elf_Size version; /* Version number of struct format */ 140 141 TAILQ_ENTRY(Struct_Obj_Entry) next; 142 char *path; /* Pathname of underlying file (%) */ 143 char *origin_path; /* Directory path of origin file */ 144 int refcount; /* DAG references */ 145 int holdcount; /* Count of transient references */ 146 int dl_refcount; /* Number of times loaded by dlopen */ 147 148 /* These items are computed by map_object() or by digest_phdr(). */ 149 caddr_t mapbase; /* Base address of mapped region */ 150 size_t mapsize; /* Size of mapped region in bytes */ 151 Elf_Addr vaddrbase; /* Base address in shared object file */ 152 caddr_t relocbase; /* Relocation constant = mapbase - vaddrbase */ 153 const Elf_Dyn *dynamic; /* Dynamic section */ 154 caddr_t entry; /* Entry point */ 155 const Elf_Phdr *phdr; /* Program header if it is mapped, else NULL */ 156 size_t phsize; /* Size of program header in bytes */ 157 const char *interp; /* Pathname of the interpreter, if any */ 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 size_t tlspoffset; /* p_offset of the static TLS block */ 168 169 caddr_t relro_page; 170 size_t relro_size; 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_Relr *relr; /* RELR relocation entries */ 179 unsigned long relrsize; /* Size in bytes of RELR relocations */ 180 const Elf_Rel *pltrel; /* PLT relocation entries */ 181 unsigned long pltrelsize; /* Size in bytes of PLT relocation info */ 182 const Elf_Rela *pltrela; /* PLT relocation entries with addend */ 183 unsigned long pltrelasize; /* Size in bytes of PLT addend reloc info */ 184 const Elf_Sym *symtab; /* Symbol table */ 185 const char *strtab; /* String table */ 186 unsigned long strsize; /* Size in bytes of string table */ 187 #ifdef __powerpc__ 188 #ifdef __powerpc64__ 189 Elf_Addr glink; /* GLINK PLT call stub section */ 190 #else 191 Elf_Addr *gotptr; /* GOT pointer (secure-plt only) */ 192 #endif 193 #endif 194 195 const Elf_Verneed *verneed; /* Required versions. */ 196 Elf_Word verneednum; /* Number of entries in verneed table */ 197 const Elf_Verdef *verdef; /* Provided versions. */ 198 Elf_Word verdefnum; /* Number of entries in verdef table */ 199 const Elf_Versym *versyms; /* Symbol versions table */ 200 201 const Elf_Hashelt *buckets; /* Hash table buckets array */ 202 unsigned long nbuckets; /* Number of buckets */ 203 const Elf_Hashelt *chains; /* Hash table chain array */ 204 unsigned long nchains; /* Number of entries in chain array */ 205 206 Elf32_Word nbuckets_gnu; /* Number of GNU hash buckets*/ 207 Elf32_Word symndx_gnu; /* 1st accessible symbol on dynsym table */ 208 Elf32_Word maskwords_bm_gnu; /* Bloom filter words - 1 (bitmask) */ 209 Elf32_Word shift2_gnu; /* Bloom filter shift count */ 210 Elf32_Word dynsymcount; /* Total entries in dynsym table */ 211 const Elf_Addr *bloom_gnu; /* Bloom filter used by GNU hash func */ 212 const Elf_Hashelt *buckets_gnu; /* GNU hash table bucket array */ 213 const Elf_Hashelt *chain_zero_gnu; /* GNU hash table value array (Zeroed) */ 214 215 const char *rpath; /* Search path specified in object */ 216 const char *runpath; /* Search path with different priority */ 217 Needed_Entry *needed; /* Shared objects needed by this one (%) */ 218 Needed_Entry *needed_filtees; 219 Needed_Entry *needed_aux_filtees; 220 221 STAILQ_HEAD(, Struct_Name_Entry) names; /* List of names for this object we 222 know about. */ 223 Ver_Entry *vertab; /* Versions required /defined by this object */ 224 int vernum; /* Number of entries in vertab */ 225 226 Elf_Addr init; /* Initialization function to call */ 227 Elf_Addr fini; /* Termination function to call */ 228 Elf_Addr preinit_array; /* Pre-initialization array of functions */ 229 Elf_Addr init_array; /* Initialization array of functions */ 230 Elf_Addr fini_array; /* Termination array of functions */ 231 int preinit_array_num; /* Number of entries in preinit_array */ 232 int init_array_num; /* Number of entries in init_array */ 233 int fini_array_num; /* Number of entries in fini_array */ 234 235 int32_t osrel; /* OSREL note value */ 236 uint32_t fctl0; /* FEATURE_CONTROL note desc[0] value */ 237 238 bool mainprog : 1; /* True if this is the main program */ 239 bool rtld : 1; /* True if this is the dynamic linker */ 240 bool relocated : 1; /* True if processed by relocate_objects() */ 241 bool ver_checked : 1; /* True if processed by rtld_verify_object_versions */ 242 bool textrel : 1; /* True if there are relocations to text seg */ 243 bool symbolic : 1; /* True if generated with "-Bsymbolic" */ 244 bool bind_now : 1; /* True if all relocations should be made first */ 245 bool traced : 1; /* Already printed in ldd trace output */ 246 bool jmpslots_done : 1; /* Already have relocated the jump slots */ 247 bool init_done : 1; /* Already have added object to init list */ 248 bool tls_done : 1; /* Already allocated offset for static TLS */ 249 bool phdr_alloc : 1; /* Phdr is allocated and needs to be freed. */ 250 bool z_origin : 1; /* Process rpath and soname tokens */ 251 bool z_nodelete : 1; /* Do not unload the object and dependencies */ 252 bool z_noopen : 1; /* Do not load on dlopen */ 253 bool z_loadfltr : 1; /* Immediately load filtees */ 254 bool z_interpose : 1; /* Interpose all objects but main */ 255 bool z_nodeflib : 1; /* Don't search default library path */ 256 bool z_global : 1; /* Make the object global */ 257 bool z_pie : 1; /* Object proclaimed itself PIE executable */ 258 bool static_tls : 1; /* Needs static TLS allocation */ 259 bool static_tls_copied : 1; /* Needs static TLS copying */ 260 bool ref_nodel : 1; /* Refcount increased to prevent dlclose */ 261 bool init_scanned: 1; /* Object is already on init list. */ 262 bool on_fini_list: 1; /* Object is already on fini list. */ 263 bool dag_inited : 1; /* Object has its DAG initialized. */ 264 bool filtees_loaded : 1; /* Filtees loaded */ 265 bool irelative : 1; /* Object has R_MACHDEP_IRELATIVE relocs */ 266 bool irelative_nonplt : 1; /* Object has R_MACHDEP_IRELATIVE non-plt relocs */ 267 bool gnu_ifunc : 1; /* Object has references to STT_GNU_IFUNC */ 268 bool non_plt_gnu_ifunc : 1; /* Object has non-plt IFUNC references */ 269 bool ifuncs_resolved : 1; /* Object ifuncs were already resolved */ 270 bool crt_no_init : 1; /* Object' crt does not call _init/_fini */ 271 bool valid_hash_sysv : 1; /* A valid System V hash hash tag is available */ 272 bool valid_hash_gnu : 1; /* A valid GNU hash tag is available */ 273 bool dlopened : 1; /* dlopen()-ed (vs. load statically) */ 274 bool marker : 1; /* marker on the global obj list */ 275 bool unholdfree : 1; /* unmap upon last unhold */ 276 bool doomed : 1; /* Object cannot be referenced */ 277 278 struct link_map linkmap; /* For GDB and dlinfo() */ 279 Objlist dldags; /* Object belongs to these dlopened DAGs (%) */ 280 Objlist dagmembers; /* DAG has these members (%) */ 281 dev_t dev; /* Object's filesystem's device */ 282 ino_t ino; /* Object's inode number */ 283 void *priv; /* Platform-dependent */ 284 } Obj_Entry; 285 286 #define RTLD_MAGIC 0xd550b87a 287 #define RTLD_VERSION 1 288 289 TAILQ_HEAD(obj_entry_q, Struct_Obj_Entry); 290 291 #define RTLD_STATIC_TLS_EXTRA 128 292 293 /* Flags to be passed into symlook_ family of functions. */ 294 #define SYMLOOK_IN_PLT 0x01 /* Lookup for PLT symbol */ 295 #define SYMLOOK_DLSYM 0x02 /* Return newest versioned symbol. Used by 296 dlsym. */ 297 #define SYMLOOK_EARLY 0x04 /* Symlook is done during initialization. */ 298 #define SYMLOOK_IFUNC 0x08 /* Allow IFUNC processing in 299 reloc_non_plt(). */ 300 301 /* Flags for load_object(). */ 302 #define RTLD_LO_NOLOAD 0x01 /* dlopen() specified RTLD_NOLOAD. */ 303 #define RTLD_LO_DLOPEN 0x02 /* Load_object() called from dlopen(). */ 304 #define RTLD_LO_TRACE 0x04 /* Only tracing. */ 305 #define RTLD_LO_NODELETE 0x08 /* Loaded object cannot be closed. */ 306 #define RTLD_LO_FILTEES 0x10 /* Loading filtee. */ 307 #define RTLD_LO_EARLY 0x20 /* Do not call ctors, postpone it to the 308 initialization during the image start. */ 309 #define RTLD_LO_IGNSTLS 0x40 /* Do not allocate static TLS */ 310 #define RTLD_LO_DEEPBIND 0x80 /* Force symbolic for this object */ 311 312 /* 313 * Symbol cache entry used during relocation to avoid multiple lookups 314 * of the same symbol. 315 */ 316 typedef struct Struct_SymCache { 317 const Elf_Sym *sym; /* Symbol table entry */ 318 const Obj_Entry *obj; /* Shared object which defines it */ 319 } SymCache; 320 321 /* 322 * This structure provides a reentrant way to keep a list of objects and 323 * check which ones have already been processed in some way. 324 */ 325 typedef struct Struct_DoneList { 326 const Obj_Entry **objs; /* Array of object pointers */ 327 unsigned int num_alloc; /* Allocated size of the array */ 328 unsigned int num_used; /* Number of array slots used */ 329 } DoneList; 330 331 struct Struct_RtldLockState { 332 int lockstate; 333 sigjmp_buf env; 334 }; 335 336 struct fill_search_info_args { 337 int request; 338 unsigned int flags; 339 struct dl_serinfo *serinfo; 340 struct dl_serpath *serpath; 341 char *strspace; 342 }; 343 344 /* 345 * The pack of arguments and results for the symbol lookup functions. 346 */ 347 typedef struct Struct_SymLook { 348 const char *name; 349 unsigned long hash; 350 uint32_t hash_gnu; 351 const Ver_Entry *ventry; 352 int flags; 353 const Obj_Entry *defobj_out; 354 const Elf_Sym *sym_out; 355 struct Struct_RtldLockState *lockstate; 356 } SymLook; 357 358 void _rtld_error(const char *, ...) __printflike(1, 2) __exported; 359 void rtld_die(void) __dead2; 360 const char *rtld_strerror(int); 361 Obj_Entry *map_object(int, const char *, const struct stat *); 362 void *xcalloc(size_t, size_t); 363 void *xmalloc(size_t); 364 char *xstrdup(const char *); 365 void *malloc_aligned(size_t size, size_t align, size_t offset); 366 void free_aligned(void *ptr); 367 extern Elf_Addr _GLOBAL_OFFSET_TABLE_[]; 368 extern Elf_Sym sym_zero; /* For resolving undefined weak refs. */ 369 extern bool ld_bind_not; 370 extern bool ld_fast_sigblock; 371 372 void dump_relocations(Obj_Entry *); 373 void dump_obj_relocations(Obj_Entry *); 374 void dump_Elf_Rel(Obj_Entry *, const Elf_Rel *, u_long); 375 void dump_Elf_Rela(Obj_Entry *, const Elf_Rela *, u_long); 376 377 /* 378 * Function declarations. 379 */ 380 uintptr_t rtld_round_page(uintptr_t); 381 uintptr_t rtld_trunc_page(uintptr_t); 382 unsigned long elf_hash(const char *); 383 const Elf_Sym *find_symdef(unsigned long, const Obj_Entry *, 384 const Obj_Entry **, int, SymCache *, struct Struct_RtldLockState *); 385 void lockdflt_init(void); 386 void digest_notes(Obj_Entry *, Elf_Addr, Elf_Addr); 387 Obj_Entry *globallist_curr(const Obj_Entry *obj); 388 Obj_Entry *globallist_next(const Obj_Entry *obj); 389 void obj_free(Obj_Entry *); 390 Obj_Entry *obj_new(void); 391 Obj_Entry *obj_from_addr(const void *); 392 void _rtld_bind_start(void); 393 void *rtld_resolve_ifunc(const Obj_Entry *obj, const Elf_Sym *def); 394 void symlook_init(SymLook *, const char *); 395 int symlook_obj(SymLook *, const Obj_Entry *); 396 void *tls_get_addr_common(uintptr_t **dtvp, int index, size_t offset); 397 void *allocate_tls(Obj_Entry *, void *, size_t, size_t); 398 void free_tls(void *, size_t, size_t); 399 void *allocate_module_tls(int index); 400 bool allocate_tls_offset(Obj_Entry *obj); 401 void free_tls_offset(Obj_Entry *obj); 402 const Ver_Entry *fetch_ventry(const Obj_Entry *obj, unsigned long); 403 int convert_prot(int elfflags); 404 bool check_elf_headers(const Elf_Ehdr *hdr, const char *path); 405 406 /* 407 * MD function declarations. 408 */ 409 int do_copy_relocations(Obj_Entry *); 410 int reloc_non_plt(Obj_Entry *, Obj_Entry *, int flags, 411 struct Struct_RtldLockState *); 412 int reloc_plt(Obj_Entry *, int flags, struct Struct_RtldLockState *); 413 int reloc_jmpslots(Obj_Entry *, int flags, struct Struct_RtldLockState *); 414 int reloc_iresolve(Obj_Entry *, struct Struct_RtldLockState *); 415 int reloc_iresolve_nonplt(Obj_Entry *, struct Struct_RtldLockState *); 416 int reloc_gnu_ifunc(Obj_Entry *, int flags, struct Struct_RtldLockState *); 417 void ifunc_init(Elf_Auxinfo[__min_size(AT_COUNT)]); 418 void init_pltgot(Obj_Entry *); 419 void allocate_initial_tls(Obj_Entry *); 420 421 void *__crt_calloc(size_t num, size_t size); 422 void __crt_free(void *cp); 423 void *__crt_malloc(size_t nbytes); 424 void *__crt_realloc(void *cp, size_t nbytes); 425 426 #endif /* } */ 427