rtld.h revision 1.144
1 /* $NetBSD: rtld.h,v 1.144 2022/06/21 06:52:17 skrll Exp $ */ 2 3 /* 4 * Copyright 1996 John D. Polstra. 5 * Copyright 1996 Matt Thomas <matt (at) 3am-software.com> 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by John Polstra. 19 * 4. The name of the author may not be used to endorse or promote products 20 * derived from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #ifndef RTLD_H 35 #define RTLD_H 36 37 #include <dlfcn.h> 38 #include <signal.h> 39 #include <stdbool.h> 40 #include <stddef.h> 41 #include <sys/param.h> 42 #include <sys/types.h> 43 #include <sys/queue.h> 44 #include <sys/exec_elf.h> 45 #include <sys/tls.h> 46 #include "rtldenv.h" 47 #include "link.h" 48 49 #if defined(_RTLD_SOURCE) 50 51 #if defined(__ARM_EABI__) && !defined(__ARM_DWARF_EH__) 52 #include "unwind.h" 53 #endif 54 55 #ifndef RTLD_DEFAULT_LIBRARY_PATH 56 #define RTLD_DEFAULT_LIBRARY_PATH "/usr/lib" 57 #endif 58 #define _PATH_LD_HINTS "/etc/ld.so.conf" 59 60 extern size_t _rtld_pagesz; 61 62 #define round_down(x) ((x) & ~(_rtld_pagesz - 1)) 63 #define round_up(x) round_down((x) + _rtld_pagesz - 1) 64 65 #define NEW(type) ((type *) xmalloc(sizeof(type))) 66 #define CNEW(type) ((type *) xcalloc(sizeof(type))) 67 68 /* 69 * Fill in a DoneList with an allocation large enough to hold all of 70 * the currently-loaded objects. Keep this in a macro since it calls 71 * alloca and we want that to occur within the scope of the caller. 72 */ 73 #define _rtld_donelist_init(dlp) \ 74 ((dlp)->num_alloc = _rtld_objcount, \ 75 (dlp)->objs = alloca((dlp)->num_alloc * sizeof((dlp)->objs[0])), \ 76 assert((dlp)->objs != NULL), \ 77 (dlp)->num_used = 0) 78 79 80 typedef struct Struct_Elf_Hash { 81 unsigned long sysv; 82 unsigned long gnu; 83 } Elf_Hash; 84 #endif /* _RTLD_SOURCE */ 85 86 /* 87 * C++ has mandated the use of the following keywords for its new boolean 88 * type. We might as well follow their lead. 89 */ 90 struct Struct_Obj_Entry; 91 92 typedef struct Struct_Objlist_Entry { 93 SIMPLEQ_ENTRY(Struct_Objlist_Entry) link; 94 struct Struct_Obj_Entry *obj; 95 } Objlist_Entry; 96 97 typedef SIMPLEQ_HEAD(Struct_Objlist, Struct_Objlist_Entry) Objlist; 98 99 typedef struct Struct_Name_Entry { 100 SIMPLEQ_ENTRY(Struct_Name_Entry) link; 101 char name[1]; 102 } Name_Entry; 103 104 typedef struct Struct_Needed_Entry { 105 struct Struct_Needed_Entry *next; 106 struct Struct_Obj_Entry *obj; 107 unsigned long name; /* Offset of name in string table */ 108 } Needed_Entry; 109 110 typedef struct _rtld_search_path_t { 111 struct _rtld_search_path_t *sp_next; 112 const char *sp_path; 113 size_t sp_pathlen; 114 } Search_Path; 115 116 typedef struct Struct_Ver_Entry { 117 Elf_Word hash; 118 u_int flags; 119 const char *name; 120 const char *file; 121 } Ver_Entry; 122 123 /* Ver_Entry.flags */ 124 #define VER_INFO_HIDDEN 0x01 125 126 #define RTLD_MAX_ENTRY 10 127 #define RTLD_MAX_LIBRARY 4 128 #define RTLD_MAX_CTL 2 129 typedef struct _rtld_library_xform_t { 130 struct _rtld_library_xform_t *next; 131 char *name; 132 const char *ctlname; 133 struct { 134 char *value; 135 char *library[RTLD_MAX_LIBRARY]; 136 } entry[RTLD_MAX_ENTRY]; 137 } Library_Xform; 138 139 /* 140 * Shared object descriptor. 141 * 142 * Items marked with "(%)" are dynamically allocated, and must be freed 143 * when the structure is destroyed. 144 */ 145 146 typedef void (*fptr_t)(void); 147 148 typedef struct Struct_Obj_Entry { 149 struct Struct_Obj_Entry *next; 150 char *path; /* Pathname of underlying file (%) */ 151 int refcount; 152 int dl_refcount; /* Number of times loaded by dlopen */ 153 154 /* These items are computed by map_object() or by digest_phdr(). */ 155 caddr_t mapbase; /* Base address of mapped region */ 156 size_t mapsize; /* Size of mapped region in bytes */ 157 size_t textsize; /* Size of text segment in bytes */ 158 Elf_Addr vaddrbase; /* Base address in shared object file */ 159 caddr_t relocbase; /* Reloc const = mapbase - *vaddrbase */ 160 Elf_Dyn *dynamic; /* Dynamic section */ 161 caddr_t entry; /* Entry point */ 162 const Elf_Phdr *phdr; /* Program header (may be xmalloc'ed) */ 163 size_t phsize; /* Size of program header in bytes */ 164 165 /* Items from the dynamic section. */ 166 Elf_Addr *pltgot; /* PLTGOT table */ 167 const Elf_Rel *rel; /* Relocation entries */ 168 const Elf_Rel *rellim; /* Limit of Relocation entries */ 169 const Elf_Rela *rela; /* Relocation entries */ 170 const Elf_Rela *relalim; /* Limit of Relocation entries */ 171 const Elf_Rel *pltrel; /* PLT relocation entries */ 172 const Elf_Rel *pltrellim; /* Limit of PLT relocation entries */ 173 const Elf_Rela *pltrela; /* PLT relocation entries */ 174 const Elf_Rela *pltrelalim; /* Limit of PLT relocation entries */ 175 const Elf_Sym *symtab; /* Symbol table */ 176 const char *strtab; /* String table */ 177 unsigned long strsize; /* Size in bytes of string table */ 178 #if defined(__mips__) || defined(__riscv__) 179 Elf_Word local_gotno; /* Number of local GOT entries */ 180 Elf_Word symtabno; /* Number of dynamic symbols */ 181 Elf_Word gotsym; /* First dynamic symbol in GOT */ 182 #endif 183 184 /* SysV Hash fields */ 185 const Elf_Symindx *buckets; /* Hash table buckets array */ 186 unsigned long unused1; /* Used to be nbuckets */ 187 const Elf_Symindx *chains; /* Hash table chain array */ 188 unsigned long nchains; /* Number of chains */ 189 190 Search_Path *rpaths; /* Search path specified in object */ 191 Needed_Entry *needed; /* Shared objects needed by this (%) */ 192 193 fptr_t init; /* Initialization function to call */ 194 fptr_t fini; /* Termination function to call */ 195 196 u_int32_t mainprog:1, /* True if this is the main program */ 197 rtld:1, /* True if this is the dynamic linker */ 198 textrel:1, /* True if there are relocations to 199 * text seg */ 200 symbolic:1, /* True if generated with 201 * "-Bsymbolic" */ 202 printed:1, /* True if ldd has printed it */ 203 isdynamic:1, /* True if this is a pure PIC object */ 204 mainref:1, /* True if on _rtld_list_main */ 205 globalref:1, /* True if on _rtld_list_global */ 206 init_done:1, /* True if .init has been added */ 207 init_called:1, /* True if .init function has been 208 * called */ 209 fini_called:1, /* True if .fini function has been 210 * called */ 211 z_now:1, /* True if object's symbols should be 212 bound immediately */ 213 z_nodelete:1, /* True if object should never be 214 unloaded */ 215 z_initfirst:1, /* True if object's .init/.fini take 216 * priority over others */ 217 z_noopen:1, /* True if object should never be 218 dlopen'ed */ 219 phdr_loaded:1, /* Phdr is loaded and doesn't need to 220 * be freed. */ 221 #if defined(__HAVE_TLS_VARIANT_I) || defined(__HAVE_TLS_VARIANT_II) 222 tls_done:1, /* True if static TLS offset 223 * has been allocated */ 224 #endif 225 ref_nodel:1, /* Refcount increased to prevent dlclose */ 226 sysv_hash:1, /* SysV Hash available */ 227 gnu_hash:1; /* GNU Hash available */ 228 229 struct link_map linkmap; /* for the debugger */ 230 231 /* These items are computed by map_object() or by digest_phdr(). */ 232 const char *interp; /* Pathname of the interpreter, if any */ 233 Objlist dldags; /* Object belongs to these dlopened DAGs (%) */ 234 Objlist dagmembers; /* DAG has these members (%) */ 235 dev_t dev; /* Object's filesystem's device */ 236 ino_t ino; /* Object's inode number */ 237 238 void *ehdr; 239 240 /* SysV Hash fields */ 241 uint32_t nbuckets; /* Number of buckets */ 242 uint32_t nbuckets_m; /* Precomputed for fast remainder */ 243 uint8_t nbuckets_s1; 244 uint8_t nbuckets_s2; 245 246 /* GNU Hash fields */ 247 const uint32_t *buckets_gnu; /* Hash table buckets array */ 248 uint32_t nbuckets_gnu; /* Number of GNU hash buckets */ 249 uint32_t nbuckets_m_gnu; /* Precomputed for fast remainder */ 250 uint8_t nbuckets_s1_gnu; 251 uint8_t nbuckets_s2_gnu; 252 const uint32_t *chains_gnu; /* Hash table chain array */ 253 #define nchains_gnu nchains /* Number of symbols, shared with SysV Hash */ 254 const Elf_Addr *bloom_gnu; 255 uint32_t symndx_gnu; /* First accessible symbol on dynsym table */ 256 uint32_t mask_bm_gnu; /* Bloom filter words - 1 (bitmask) */ 257 uint32_t shift2_gnu; /* Bloom filter shift count */ 258 259 size_t pathlen; /* Pathname length */ 260 SIMPLEQ_HEAD(, Struct_Name_Entry) names; /* List of names for this 261 * object we know about. */ 262 263 #ifdef __powerpc__ 264 #ifdef _LP64 265 Elf_Addr glink; /* global linkage */ 266 #else 267 Elf_Addr *gotptr; /* GOT table (secure-plt only) */ 268 #endif 269 #endif 270 271 #if defined(__HAVE_TLS_VARIANT_I) || defined(__HAVE_TLS_VARIANT_II) 272 /* Thread Local Storage support for this module */ 273 size_t tlsindex; /* Index in DTV */ 274 void *tlsinit; /* Base address of TLS init block */ 275 size_t tlsinitsize; /* Size of TLS init block */ 276 size_t tlssize; /* Size of TLS block */ 277 size_t tlsoffset; /* Offset in the static TLS block */ 278 size_t tlsalign; /* Needed alignment for static TLS */ 279 #endif 280 281 #ifdef GNU_RELRO 282 /* relocation readonly */ 283 void *relro_page; 284 size_t relro_size; 285 #endif 286 287 /* symbol versioning */ 288 const Elf_Verneed *verneed; /* Required versions. */ 289 Elf_Word verneednum; /* Number of entries in verneed table */ 290 const Elf_Verdef *verdef; /* Provided versions. */ 291 Elf_Word verdefnum; /* Number of entries in verdef table */ 292 const Elf_Versym *versyms; /* Symbol versions table */ 293 294 Ver_Entry *vertab; /* Versions required/defined by this 295 * object */ 296 int vertabnum; /* Number of entries in vertab */ 297 298 /* init_array/fini_array */ 299 fptr_t *init_array; /* start of init array */ 300 size_t init_arraysz; /* # of entries in it */ 301 fptr_t *fini_array; /* start of fini array */ 302 size_t fini_arraysz; /* # of entries in it */ 303 /* IRELATIVE relocations */ 304 size_t ifunc_remaining; 305 #if \ 306 defined(__aarch64__) || \ 307 defined(__arm__) || \ 308 defined(__i386__) || \ 309 defined(__powerpc__) || \ 310 defined(__sparc__) || \ 311 defined(__x86_64__) 312 #define IFUNC_NONPLT 313 /* On SPARC, the PLT variant is called JMP_IREL and counted above. */ 314 size_t ifunc_remaining_nonplt; 315 #endif 316 size_t cxa_refcount; /* For TLS destructors. */ 317 #ifdef __ARM_EABI__ 318 void *exidx_start; 319 size_t exidx_sz; 320 #endif 321 } Obj_Entry; 322 323 typedef struct Struct_DoneList { 324 const Obj_Entry **objs; /* Array of object pointers */ 325 unsigned int num_alloc; /* Allocated size of the array */ 326 unsigned int num_used; /* Number of array slots used */ 327 } DoneList; 328 329 330 #if defined(_RTLD_SOURCE) 331 332 extern struct r_debug _rtld_debug; 333 extern Search_Path *_rtld_default_paths; 334 extern Obj_Entry *_rtld_objlist; 335 extern Obj_Entry **_rtld_objtail; 336 extern u_int _rtld_objcount; 337 extern u_int _rtld_objloads; 338 extern const uintptr_t _rtld_compat_obj[]; 339 extern Obj_Entry *_rtld_objmain; 340 extern Obj_Entry _rtld_objself; 341 extern Search_Path *_rtld_paths; 342 extern Library_Xform *_rtld_xforms; 343 extern bool _rtld_trust; 344 extern Objlist _rtld_list_global; 345 extern Objlist _rtld_list_main; 346 extern Elf_Sym _rtld_sym_zero; 347 extern u_int _rtld_objgen; 348 349 #define RTLD_MODEMASK 0x3 350 351 /* Flags to be passed into _rtld_symlook_ family of functions. */ 352 #define SYMLOOK_IN_PLT 0x01 /* Lookup for PLT symbol */ 353 #define SYMLOOK_DLSYM 0x02 /* Return newest versioned symbol. 354 Used by dlsym. */ 355 356 /* Flags for _rtld_load_object() and friends. */ 357 #define _RTLD_GLOBAL 0x01 /* Add object to global DAG. */ 358 #define _RTLD_MAIN 0x02 359 #define _RTLD_NOLOAD 0x04 /* dlopen() specified RTLD_NOLOAD. */ 360 #define _RTLD_DLOPEN 0x08 /* Load_object() called from dlopen(). */ 361 362 /* Preallocation for static TLS model */ 363 #define RTLD_STATIC_TLS_RESERVATION 64 364 365 /* rtld.c */ 366 __dso_public char *dlerror(void); 367 __dso_public void *dlopen(const char *, int); 368 __dso_public void *dlsym(void *, const char *); 369 __dso_public int dlclose(void *); 370 __dso_public int dladdr(const void *, Dl_info *); 371 __dso_public int dlinfo(void *, int, void *); 372 __dso_public int dl_iterate_phdr(int (*)(struct dl_phdr_info *, size_t, void *), 373 void *); 374 375 __dso_public void *_dlauxinfo(void) __pure; 376 __dso_public void __dl_cxa_refcount(void *addr, ssize_t delta); 377 378 __dso_public pid_t __locked_fork(int *); 379 380 #if defined(__ARM_EABI__) && !defined(__ARM_DWARF_EH__) 381 /* 382 * This is used by libgcc to find the start and length of the exception table 383 * associated with a PC. 384 */ 385 __dso_public _Unwind_Ptr __gnu_Unwind_Find_exidx(_Unwind_Ptr, int *); 386 #endif 387 388 /* These aren't exported */ 389 void _rtld_error(const char *, ...) __printflike(1,2); 390 void _rtld_die(void) __dead; 391 void *_rtld_objmain_sym(const char *); 392 __dso_public void _rtld_debug_state(void) __noinline; 393 void _rtld_linkmap_add(Obj_Entry *); 394 void _rtld_linkmap_delete(Obj_Entry *); 395 void _rtld_objlist_push_head(Objlist *, Obj_Entry *); 396 void _rtld_objlist_push_tail(Objlist *, Obj_Entry *); 397 Objlist_Entry *_rtld_objlist_find(Objlist *, const Obj_Entry *); 398 void _rtld_ref_dag(Obj_Entry *); 399 400 void _rtld_shared_enter(void); 401 void _rtld_shared_exit(void); 402 void _rtld_exclusive_enter(sigset_t *); 403 void _rtld_exclusive_exit(sigset_t *); 404 405 int _rtld_relro(const Obj_Entry *, bool); 406 407 /* expand.c */ 408 size_t _rtld_expand_path(char *, size_t, const char *, const char *,\ 409 const char *); 410 411 /* headers.c */ 412 void _rtld_digest_dynamic(const char *, Obj_Entry *); 413 Obj_Entry *_rtld_digest_phdr(const Elf_Phdr *, int, caddr_t); 414 415 /* load.c */ 416 Obj_Entry *_rtld_load_object(const char *, int); 417 int _rtld_load_needed_objects(Obj_Entry *, int); 418 int _rtld_preload(const char *); 419 420 #define OBJ_ERR (Obj_Entry *)(-1) 421 /* path.c */ 422 void _rtld_add_paths(const char *, Search_Path **, const char *); 423 void _rtld_process_hints(const char *, Search_Path **, Library_Xform **, 424 const char *); 425 int _rtld_sysctl(const char *, void *, size_t *); 426 427 /* reloc.c */ 428 int _rtld_do_copy_relocations(const Obj_Entry *); 429 int _rtld_relocate_objects(Obj_Entry *, bool); 430 int _rtld_relocate_nonplt_objects(Obj_Entry *); 431 int _rtld_relocate_plt_lazy(Obj_Entry *); 432 int _rtld_relocate_plt_objects(const Obj_Entry *); 433 void _rtld_setup_pltgot(const Obj_Entry *); 434 Elf_Addr _rtld_resolve_ifunc(const Obj_Entry *, const Elf_Sym *); 435 Elf_Addr _rtld_resolve_ifunc2(const Obj_Entry *, Elf_Addr); 436 437 void _rtld_call_ifunc(Obj_Entry *, sigset_t *, u_int); 438 439 /* search.c */ 440 Obj_Entry *_rtld_load_library(const char *, const Obj_Entry *, int); 441 442 /* symbol.c */ 443 unsigned long _rtld_sysv_hash(const char *); 444 unsigned long _rtld_gnu_hash(const char *); 445 const Elf_Sym *_rtld_symlook_obj(const char *, Elf_Hash *, 446 const Obj_Entry *, u_int, const Ver_Entry *); 447 const Elf_Sym *_rtld_find_symdef(unsigned long, const Obj_Entry *, 448 const Obj_Entry **, u_int); 449 const Elf_Sym *_rtld_find_plt_symdef(unsigned long, const Obj_Entry *, 450 const Obj_Entry **, bool); 451 452 const Elf_Sym *_rtld_symlook_list(const char *, Elf_Hash *, 453 const Objlist *, const Obj_Entry **, u_int, const Ver_Entry *, DoneList *); 454 const Elf_Sym *_rtld_symlook_default(const char *, Elf_Hash *, 455 const Obj_Entry *, const Obj_Entry **, u_int, const Ver_Entry *); 456 const Elf_Sym *_rtld_symlook_needed(const char *, Elf_Hash *, 457 const Needed_Entry *, const Obj_Entry **, u_int, const Ver_Entry *, 458 DoneList *, DoneList *); 459 460 /* symver.c */ 461 void _rtld_object_add_name(Obj_Entry *, const char *); 462 int _rtld_object_match_name(const Obj_Entry *, const char *); 463 int _rtld_verify_object_versions(Obj_Entry *); 464 465 static __inline const Ver_Entry * 466 _rtld_fetch_ventry(const Obj_Entry *obj, unsigned long symnum) 467 { 468 Elf_Half vernum; 469 470 if (obj->vertab) { 471 vernum = VER_NDX(obj->versyms[symnum].vs_vers); 472 if (vernum >= obj->vertabnum) { 473 _rtld_error("%s: symbol %s has wrong verneed value %d", 474 obj->path, &obj->strtab[symnum], vernum); 475 } else if (obj->vertab[vernum].hash) { 476 return &obj->vertab[vernum]; 477 } 478 } 479 return NULL; 480 } 481 482 #if defined(__HAVE_TLS_VARIANT_I) || defined(__HAVE_TLS_VARIANT_II) 483 /* tls.c */ 484 void *_rtld_tls_get_addr(void *, size_t, size_t); 485 void _rtld_tls_initial_allocation(void); 486 void *_rtld_tls_module_allocate(size_t index); 487 int _rtld_tls_offset_allocate(Obj_Entry *); 488 void _rtld_tls_offset_free(Obj_Entry *); 489 490 extern size_t _rtld_tls_dtv_generation; 491 extern size_t _rtld_tls_max_index; 492 493 __dso_public extern void *__tls_get_addr(void *); 494 #ifdef __i386__ 495 __dso_public extern void *___tls_get_addr(void *) 496 __attribute__((__regparm__(1))); 497 #endif 498 #endif 499 500 /* map_object.c */ 501 struct stat; 502 Obj_Entry *_rtld_map_object(const char *, int, const struct stat *); 503 void _rtld_obj_free(Obj_Entry *); 504 Obj_Entry *_rtld_obj_new(void); 505 506 #ifdef RTLD_LOADER 507 /* function descriptors */ 508 #ifdef __HAVE_FUNCTION_DESCRIPTORS 509 Elf_Addr _rtld_function_descriptor_alloc(const Obj_Entry *, 510 const Elf_Sym *, Elf_Addr); 511 const void *_rtld_function_descriptor_function(const void *); 512 513 Elf_Addr _rtld_call_function_addr(const Obj_Entry *, Elf_Addr); 514 #else 515 static inline Elf_Addr 516 _rtld_call_function_addr(const Obj_Entry *obj, Elf_Addr addr) 517 { 518 return ((Elf_Addr(*)(void))addr)(); 519 } 520 #endif /* __HAVE_FUNCTION_DESCRIPTORS */ 521 #endif /* RTLD_LOADER */ 522 523 #endif /* _RTLD_SOURCE */ 524 525 #endif /* RTLD_H */ 526
Indexes created Mon Sep 29 21:09:56 GMT 2025