1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _RTLD_H 28 #define _RTLD_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 /* 33 * Global include file for the runtime linker. 34 */ 35 #include <time.h> 36 #include <sgs.h> 37 #include <thread.h> 38 #include <synch.h> 39 #include <machdep.h> 40 #include <sys/avl.h> 41 #include <alist.h> 42 #include <libc_int.h> 43 44 #ifdef _SYSCALL32 45 #include <inttypes.h> 46 #endif 47 48 #ifdef __cplusplus 49 extern "C" { 50 #endif 51 52 53 /* 54 * Linked list of directories or filenames (built from colon separated string). 55 */ 56 typedef struct pnode { 57 const char *p_name; 58 const char *p_oname; 59 size_t p_len; 60 uint_t p_orig; 61 void *p_info; 62 struct pnode *p_next; 63 } Pnode; 64 65 typedef struct rt_map Rt_map; 66 67 /* 68 * A binding descriptor. Establishes the binding relationship between two 69 * objects, the caller (originator) and the dependency (destination). 70 */ 71 typedef struct { 72 Rt_map *b_caller; /* caller (originator) of a binding */ 73 Rt_map *b_depend; /* dependency (destination) of a */ 74 /* binding */ 75 uint_t b_flags; /* relationship of caller to the */ 76 /* dependency */ 77 } Bnd_desc; 78 79 #define BND_NEEDED 0x0001 /* caller NEEDED the dependency */ 80 #define BND_REFER 0x0002 /* caller relocation references the */ 81 /* dependency */ 82 #define BND_FILTER 0x0004 /* pseudo binding to identify filter */ 83 84 /* 85 * Private structure for communication between rtld_db and rtld. 86 * 87 * We must bump the version number when ever an update in one of the 88 * structures/fields that rtld_db reads is updated. This hopefully permits 89 * rtld_db implementations of the future to recognize core files produced on 90 * older systems and deal with these core files accordingly. 91 * 92 * As of version 'RTLD_DB_VERSION <= 2' the following fields were valid for core 93 * file examination (basically the public Link_map): 94 * 95 * ADDR() 96 * NAME() 97 * DYN() 98 * NEXT() 99 * PREV() 100 * 101 * Valid fields for RTLD_DB_VERSION3 102 * 103 * PATHNAME() 104 * PADSTART() 105 * PADIMLEN() 106 * MSIZE() 107 * FLAGS() 108 * FLAGS1() 109 * 110 * Valid fields for RTLD_DB_VERSION4 111 * 112 * TLSMODID() 113 * 114 * Valid fields for RTLD_DB_VERSION5 115 * 116 * Added rtld_flags & FLG_RT_RELOCED to stable flags range 117 * 118 */ 119 #define R_RTLDDB_VERSION1 1 /* base version level - used for core */ 120 /* file examination */ 121 #define R_RTLDDB_VERSION2 2 /* minor revision - not relevant for */ 122 /* core files */ 123 #define R_RTLDDB_VERSION3 3 124 #define R_RTLDDB_VERSION4 4 125 #define R_RTLDDB_VERSION5 5 126 #define R_RTLDDB_VERSION R_RTLDDB_VERSION5 /* current version */ 127 128 typedef struct rtld_db_priv { 129 struct r_debug rtd_rdebug; /* original r_debug structure */ 130 Word rtd_version; /* version no. */ 131 size_t rtd_objpad; /* padding around mmap()ed objects */ 132 List * rtd_dynlmlst; /* pointer to Dynlm_list */ 133 } Rtld_db_priv; 134 135 #ifdef _SYSCALL32 136 typedef struct rtld_db_priv32 { 137 struct r_debug32 rtd_rdebug; /* original r_debug structure */ 138 Elf32_Word rtd_version; /* version no. */ 139 Elf32_Word rtd_objpad; /* padding around mmap()ed objects */ 140 Elf32_Addr rtd_dynlmlst; /* pointer to Dynlm_list */ 141 } Rtld_db_priv32; 142 #endif /* _SYSCALL32 */ 143 144 /* 145 * External function definitions. ld.so.1 must convey information to libc in 146 * regards to threading. libc also provides routines for atexit() and message 147 * localization. libc provides the necessary interfaces via its RTLDINFO 148 * structure and/or later _ld_libc() calls. 149 * 150 * These external functions are maintained for each link-map list, and used 151 * where appropriate. The functions are associated with the object that 152 * provided them, so that should the object be deleted (say, from an alternative 153 * link-map), the functions can be removed. 154 */ 155 typedef struct { 156 Rt_map *lc_lmp; /* function provider */ 157 union { 158 int (*lc_func)(); /* external function pointer */ 159 uintptr_t lc_val; /* external value */ 160 char *lc_ptr; /* external character pointer */ 161 } lc_un; 162 } Lc_desc; 163 164 /* 165 * Link map list definition. Link-maps are used to describe each loaded object. 166 * Lists of these link-maps describe the various namespaces within a process. 167 * The process executable and its dependencies are maintained on the lml_main 168 * list. The runtime linker, and its dependencies are maintained on the 169 * lml_rtld list. Additional lists can be created (see dlmopen()) for such 170 * things as auditors and their dependencies. 171 * 172 * Each link-map list maintains an Alist of one, or more, linked lists of 173 * link-maps. For backward compatibility, the lm_head/lm_tail elements are 174 * initialized to the first linked-list of link-maps: 175 * 176 * Lm_list 177 * ---------- 178 * | lm_tail | ------------------------------------ 179 * | lm_head | -------------------- | 180 * | | | Rt_map | Rt_map 181 * | | | ------ | ------ 182 * | | Alist --> | | |--> | | 183 * | | --------- | | | -- | | 184 * | lm_lists | ----> | | | | | --> | | 185 * | | |---------| | | | | | | 186 * | | | lc_head | -- ------ | ------ 187 * | | | lc_tail | ------------------ 188 * | | |---------| 189 * | lc_head | 190 * | lc_tail | 191 * |---------| 192 * 193 * Multiple link-map lists exist to support the addition of lazy loaded 194 * families, filtee families, and dlopen() families. The intent of these 195 * lists is to insure that a family of objects that are to be loaded are 196 * fully relocatable, and hence usable, before they become part of the main 197 * (al_data[0]) link-map control list. This main link-map control list is 198 * the only list in existence when control is transferred to user code. 199 * 200 * During process initialization, the dynamic executable and its non-lazy 201 * dependencies are maintained on al_data[0]. If a new object is loaded, then 202 * this object is added to the next available control list [1], typically 203 * al_data[1]. Any dependencies of this object that have not already been 204 * loaded are added to the same control list. Once all of the objects on the 205 * new control list have been successfully relocated, the objects are moved from 206 * the new control list to the highest control list to which objects of the new 207 * control list bound to, typically al_data[1] to al_data[0]. 208 * 209 * Each loading scenario can be broken down as follows: 210 * 211 * setup() - only the initial link-map control list is used: 212 * i. create al_data[0] 213 * ii. add new link-map for main on al_data[0] 214 * iii. analyze al_data[0] to add all non-lazy dependencies 215 * iv. relocate al_data[0] dependencies. 216 * 217 * dlopen() - the initiator can only be the initial link-map control list: 218 * i. create al_data[1] from caller al_data[0] 219 * ii. add new link-map for the dlopen'ed object on al_data[1] 220 * iii. analyze al_data[1] to add all non-lazy dependencies 221 * iv. relocate al_data[1] dependencies, and move to al_data[0]. 222 * 223 * filtee and lazy loading processing - the initiator can be any link-map 224 * control list that is being relocated: 225 * i. create al_data[y] from caller al_data[x] 226 * ii. add new link-map for the new object on al_data[y] 227 * iii. analyze al_data[y] to add all non-lazy dependencies 228 * iv. relocate al_data[y] dependencies, and move to al_data[x]. 229 * 230 * This Alist therefore maintains a stack of link-map control lists. The newest 231 * link-map control list can locate symbols within any of the former lists, 232 * however, control is not passed to a former list until the newest lists 233 * processing is complete. Thus, objects can't bind to new objects until they 234 * have been fully analyzed and relocated. 235 * 236 * [1] Note, additional link-map control list creation occurs after the head 237 * link-map object (typically the dynamic executable) has been relocated. This 238 * staging is required to satisfy the binding requirements of copy relocations. 239 * Copy relocations, effectively, transfer the bindings of the copied data 240 * (say _iob in libc.so.1) to the copy location (_iob in the application). 241 * Thus an object that might bind to the original copy data must be redirected 242 * to the copy reference. As the knowledge of a copy relocation having taken 243 * place is only known after relocating the application, link-map control list 244 * additions are suspended until after this relocation has completed. 245 */ 246 typedef struct { 247 Rt_map *lc_head; 248 Rt_map *lc_tail; 249 Alist *lc_now; /* pending promoted bind-now objects */ 250 uint_t lc_flags; 251 } Lm_cntl; 252 253 #define LMC_FLG_ANALYZING 0x01 /* control list is being analyzed */ 254 #define LMC_FLG_RELOCATING 0x02 /* control list is being relocated */ 255 #define LMC_FLG_REANALYZE 0x04 /* repeat analysis (established when */ 256 /* interposers are added */ 257 258 struct lm_list { 259 /* 260 * BEGIN: Exposed to rtld_db - don't move, don't delete 261 */ 262 Rt_map *lm_head; /* linked list pointers to active */ 263 Rt_map *lm_tail; /* link-map list */ 264 Alist *lm_handle; /* not used by rtld_db - but spacing */ 265 /* is required for flags */ 266 Word lm_flags; 267 /* 268 * END: Exposed to rtld_db - don't move, don't delete 269 */ 270 Alist *lm_rti; /* list of RTLDINFO tables */ 271 Audit_list *lm_alp; /* audit list descripter */ 272 avl_tree_t *lm_fpavl; /* avl tree of objects loaded */ 273 Alist *lm_lists; /* active and pending link-map lists */ 274 char ***lm_environ; /* pointer to environment array */ 275 Word lm_tflags; /* transferable flags */ 276 uint_t lm_obj; /* total number of objs on link-map */ 277 uint_t lm_init; /* new obj since last init processing */ 278 uint_t lm_lazy; /* obj with pending lazy dependencies */ 279 uint_t lm_tls; /* new obj that require TLS */ 280 uint_t lm_lmid; /* unique link-map list identifier, */ 281 char *lm_lmidstr; /* and associated diagnostic string */ 282 Lc_desc lm_lcs[CI_MAX]; /* external libc functions */ 283 }; 284 285 #ifdef _SYSCALL32 286 struct lm_list32 { 287 /* 288 * BEGIN: Exposed to rtld_db - don't move, don't delete 289 */ 290 Elf32_Addr lm_head; 291 Elf32_Addr lm_tail; 292 Elf32_Addr lm_handle; 293 Elf32_Word lm_flags; 294 /* 295 * END: Exposed to rtld_db - don't move, don't delete 296 */ 297 Elf32_Addr lm_rti; 298 Elf32_Addr lm_fpavl; 299 Elf32_Addr lm_lists; 300 Elf32_Addr lm_environ; 301 Elf32_Word lm_tflags; 302 uint_t lm_obj; 303 uint_t lm_init; 304 uint_t lm_lazy; 305 uint_t lm_tls; 306 uint_t lm_lmid; 307 Elf32_Addr lm_lmidstr; 308 Elf32_Addr lm_lcs[CI_MAX]; 309 }; 310 #endif /* _SYSCALL32 */ 311 312 /* 313 * Possible Link_map list flags (Lm_list.lm_flags) 314 */ 315 /* 316 * BEGIN: Exposed to rtld_db - don't move, don't delete 317 */ 318 #define LML_FLG_BASELM 0x00000001 /* primary link-map */ 319 #define LML_FLG_RTLDLM 0x00000002 /* rtld link-map */ 320 /* 321 * END: Exposed to rtld_db - don't move, don't delete 322 */ 323 #define LML_FLG_NOAUDIT 0x00000004 /* symbol auditing disabled */ 324 #define LML_FLG_PLTREL 0x00000008 /* deferred plt relocation */ 325 /* initialization */ 326 /* (ld.so.1 only) */ 327 #define LML_FLG_HOLDLOCK 0x00000010 /* hold the rtld mutex lock */ 328 #define LML_FLG_ENVIRON 0x00000020 /* environ var initialized */ 329 #define LML_FLG_INTRPOSE 0x00000040 /* interposing objs on list */ 330 #define LML_FLG_LOCAUDIT 0x00000080 /* local auditors exists for */ 331 /* this link-map list */ 332 #define LML_FLG_LOADAVAIL 0x00000100 /* load anything available */ 333 #define LML_FLG_IGNRELERR 0x00000200 /* ignore relocation errors - */ 334 /* internal for crle(1) */ 335 #define LML_FLG_DBNOTIF 0x00000400 /* binding activity going on */ 336 #define LML_FLG_STARTREL 0x00000800 /* relocation started */ 337 #define LML_FLG_ATEXIT 0x00001000 /* atexit processing */ 338 #define LML_FLG_OBJADDED 0x00002000 /* object(s) added */ 339 #define LML_FLG_OBJDELETED 0x00004000 /* object(s) deleted */ 340 #define LML_FLG_OBJREEVAL 0x00008000 /* existing object(s) needs */ 341 /* tsort reevaluation */ 342 #define LML_FLG_TRC_LDDSTUB 0x00100000 /* identify lddstub */ 343 #define LML_FLG_TRC_ENABLE 0x00200000 /* tracing enabled (ldd) */ 344 #define LML_FLG_TRC_WARN 0x00400000 /* print warnings for undefs */ 345 #define LML_FLG_TRC_VERBOSE 0x00800000 /* verbose (versioning) trace */ 346 #define LML_FLG_TRC_SEARCH 0x01000000 /* trace search paths */ 347 #define LML_FLG_TRC_UNREF 0x02000000 /* trace unreferenced */ 348 /* dependencies */ 349 #define LML_FLG_TRC_UNUSED 0x04000000 /* trace unused dependencies */ 350 #define LML_FLG_TRC_INIT 0x08000000 /* print .init order */ 351 352 #define LML_MSK_TRC 0xfff00000 /* tracing mask */ 353 354 /* 355 * Possible Link_map transferable flags (Lm_list.lm_tflags), i.e., link-map 356 * list flags that can be propagated to any new link-map list created. 357 */ 358 #define LML_TFLG_NOLAZYLD 0x00000001 /* lazy loading disabled */ 359 #define LML_TFLG_NODIRECT 0x00000002 /* direct bindings disabled */ 360 361 #define LML_TFLG_LOADFLTR 0x00000008 /* trigger filtee loading */ 362 363 #define LML_TFLG_AUD_PREINIT 0x00100000 /* preinit (audit) exists */ 364 #define LML_TFLG_AUD_OBJSEARCH 0x00200000 /* objsearch (audit) exists */ 365 #define LML_TFLG_AUD_OBJOPEN 0x00400000 /* objopen (audit) exists */ 366 #define LML_TFLG_AUD_OBJFILTER 0x00800000 /* objfilter (audit) exists */ 367 #define LML_TFLG_AUD_OBJCLOSE 0x01000000 /* objclose (audit) exists */ 368 #define LML_TFLG_AUD_SYMBIND 0x02000000 /* symbind (audit) exists */ 369 #define LML_TFLG_AUD_PLTENTER 0x04000000 /* pltenter (audit) exists */ 370 #define LML_TFLG_AUD_PLTEXIT 0x08000000 /* pltexit (audit) exists */ 371 #define LML_TFLG_AUD_ACTIVITY 0x10000000 /* activity (audit) exists */ 372 373 /* 374 * NOTE: Audit flags have duplicated FLAGS1() values. If more audit flags are 375 * added, update the FLAGS1() reservation FL1_AUD_RS_STR to FL1_AUD_RS_END 376 * defined later. 377 */ 378 #define LML_TFLG_AUD_MASK 0xfff00000 /* audit interfaces mask */ 379 380 381 /* 382 * Information for dlopen(), dlsym(), and dlclose() on libraries linked by rtld. 383 * Each shared object referred from a dlopen call has an associated group 384 * handle structure returned that describes a group of one or more objects. 385 */ 386 typedef struct { 387 Alist *gh_depends; /* handle dependency list */ 388 Rt_map *gh_ownlmp; /* handle owners link-map */ 389 Lm_list *gh_ownlml; /* handle owners link-map list */ 390 uint_t gh_refcnt; /* handle reference count */ 391 uint_t gh_flags; /* handle flags */ 392 } Grp_hdl; 393 394 #define GPH_ZERO 0x0001 /* special handle for dlopen(0) */ 395 #define GPH_LDSO 0x0002 /* special handle for ld.so.1 */ 396 #define GPH_FIRST 0x0004 /* dlsym() can only use originating */ 397 /* dependency */ 398 #define GPH_PARENT 0x0008 /* assign caller as a parent */ 399 #define GPH_FILTEE 0x0010 /* handle used to specify a filtee */ 400 #define GPH_INITIAL 0x0020 /* handle is initialized */ 401 #define GPH_STICKY 0x0040 /* handle is unreferenced, but should */ 402 /* not trigger object removal */ 403 404 /* 405 * A group descriptor. A group handle (Grp_hdl) refers to a group of objects, 406 * each object, and its relationship to the handle, is maintained within a 407 * group descriptor. 408 */ 409 typedef struct { 410 Rt_map * gd_depend; /* dependency */ 411 uint_t gd_flags; /* dependency flags */ 412 } Grp_desc; 413 414 #define GPD_AVAIL 0x0001 /* dependency available to dlsym() */ 415 #define GPD_ADDEPS 0x0002 /* dependencies of this dependency */ 416 /* should be added to handle */ 417 #define GPD_PARENT 0x0004 /* dependency is a parent */ 418 #define GPD_FILTER 0x0008 /* dependency is our filter */ 419 #define GPD_REMOVE 0x1000 /* descriptor is a candidate for */ 420 /* removal from the group */ 421 422 /* 423 * Define threading structures. For compatibility with libthread (T1_VERSION 1 424 * and TI_VERSION 2) our locking structure is sufficient to hold a mutex or a 425 * readers/writers lock. 426 */ 427 typedef struct { 428 union { 429 mutex_t l_mutex; 430 rwlock_t l_rwlock; 431 } u; 432 } Rt_lock; 433 434 typedef cond_t Rt_cond; 435 436 /* 437 * Define a dynamic section information descriptor. This parallels the entries 438 * in the .dynamic section and holds auxiliary information to implement lazy 439 * loading and filtee processing. 440 */ 441 typedef struct { 442 uint_t di_flags; 443 void *di_info; 444 } Dyninfo; 445 446 #define FLG_DI_STDFLTR 0x00001 /* .dynamic entry for DT_FILTER */ 447 #define FLG_DI_AUXFLTR 0x00002 /* .dynamic entry for DT_AUXILIARY */ 448 #define FLG_DI_SYMFLTR 0x00004 /* .dynamic entry for DT_SYMFILTER */ 449 /* and DT_SYMAUXILIARY */ 450 #define MSK_DI_FILTER 0x0000f /* mask for all filter possibilities */ 451 452 #define FLG_DI_NEEDED 0x00010 /* entry represents a dependency */ 453 #define FLG_DI_GROUP 0x00020 /* open dependency as a group */ 454 #define FLG_DI_PROCESSD 0x00040 /* entry has been processed */ 455 456 /* 457 * Data Structure to track AVL tree for pathnames of objects 458 * loaded into memory 459 */ 460 typedef struct { 461 const char *fpn_name; /* object name */ 462 Rt_map *fpn_lmp; /* object link-map */ 463 avl_node_t fpn_avl; /* avl book-keeping (see SGSOFFSETOF) */ 464 uint_t fpn_hash; /* object name hash value */ 465 } FullpathNode; 466 467 /* 468 * Define a mapping structure, which is maintained to describe each mapping 469 * of an object, ie. the text segment, data segment, bss segment, etc. 470 */ 471 typedef struct { 472 caddr_t m_vaddr; /* mapping address */ 473 size_t m_fsize; /* backing file size */ 474 size_t m_msize; /* mapping size */ 475 int m_perm; /* mapping permissions */ 476 } Mmap; 477 478 /* 479 * Link-map definition. 480 */ 481 struct rt_map { 482 /* 483 * BEGIN: Exposed to rtld_db - don't move, don't delete 484 */ 485 Link_map rt_public; /* public data */ 486 char *rt_pathname; /* full pathname of loaded object */ 487 ulong_t rt_padstart; /* start of image (including padding) */ 488 ulong_t rt_padimlen; /* size of image (including padding */ 489 ulong_t rt_msize; /* total memory mapped */ 490 uint_t rt_flags; /* state flags, see FLG below */ 491 uint_t rt_flags1; /* state flags1, see FL1 below */ 492 ulong_t rt_tlsmodid; /* TLS module id */ 493 /* 494 * END: Exposed to rtld_db - don't move, don't delete 495 */ 496 Alist *rt_alias; /* list of linked file names */ 497 Alist *rt_fpnode; /* list of FullpathNode AVL nodes */ 498 void (*rt_init)(); /* address of _init */ 499 void (*rt_fini)(); /* address of _fini */ 500 char *rt_runpath; /* LD_RUN_PATH and its equivalent */ 501 Pnode *rt_runlist; /* Pnode structures */ 502 Alist *rt_depends; /* list of dependencies */ 503 Alist *rt_callers; /* list of callers */ 504 Alist *rt_handles; /* dlopen handles */ 505 Alist *rt_groups; /* groups we're a member of */ 506 ulong_t rt_etext; /* etext address */ 507 struct fct *rt_fct; /* file class table for this object */ 508 Sym *(*rt_symintp)(); /* link map symbol interpreter */ 509 void *rt_priv; /* private data, object type specific */ 510 Lm_list *rt_list; /* link map list we belong to */ 511 uint_t rt_objfltrndx; /* object filtees .dynamic index */ 512 uint_t rt_symsfltrcnt; /* number of standard symbol filtees */ 513 uint_t rt_symafltrcnt; /* number of auxiliary symbol filtees */ 514 int rt_mode; /* usage mode, see RTLD mode flags */ 515 int rt_sortval; /* temporary buffer to traverse graph */ 516 uint_t rt_cycgroup; /* cyclic group */ 517 dev_t rt_stdev; /* device id and inode number for .so */ 518 ino_t rt_stino; /* multiple inclusion checks */ 519 char *rt_origname; /* original pathname of loaded object */ 520 size_t rt_dirsz; /* and its size */ 521 Alist *rt_copy; /* list of copy relocations */ 522 Audit_desc *rt_auditors; /* audit descriptor array */ 523 Audit_info *rt_audinfo; /* audit information descriptor */ 524 Syminfo *rt_syminfo; /* elf .syminfo section - here */ 525 /* because it is checked in */ 526 /* common code */ 527 Addr *rt_initarray; /* .initarray table */ 528 Addr *rt_finiarray; /* .finiarray table */ 529 Addr *rt_preinitarray; /* .preinitarray table */ 530 Mmap *rt_mmaps; /* array of mapping information */ 531 uint_t rt_mmapcnt; /* and associated number */ 532 uint_t rt_initarraysz; /* size of .initarray table */ 533 uint_t rt_finiarraysz; /* size of .finiarray table */ 534 uint_t rt_preinitarraysz; /* size of .preinitarray table */ 535 Dyninfo *rt_dyninfo; /* .dynamic information descriptors */ 536 uint_t rt_dyninfocnt; /* count of dyninfo entries */ 537 uint_t rt_relacount; /* no. of RELATIVE relocations */ 538 uint_t rt_idx; /* hold index within linkmap list */ 539 uint_t rt_lazy; /* lazy dependencies pending */ 540 Rt_cond *rt_condvar; /* variables */ 541 Xword rt_hwcap; /* hardware capabilities */ 542 Xword rt_sfcap; /* software capabilities */ 543 thread_t rt_threadid; /* thread init/fini synchronization */ 544 uint_t rt_cntl; /* link-map control list we belong to */ 545 }; 546 547 548 #ifdef _SYSCALL32 549 /* 550 * Structure to allow 64-bit rtld_db to read 32-bit processes out of procfs. 551 */ 552 typedef struct rt_map32 { 553 /* 554 * BEGIN: Exposed to rtld_db - don't move, don't delete 555 */ 556 Link_map32 rt_public; 557 uint32_t rt_pathname; 558 uint32_t rt_padstart; 559 uint32_t rt_padimlen; 560 uint32_t rt_msize; 561 uint32_t rt_flags; 562 uint32_t rt_flags1; 563 uint32_t rt_tlsmodid; 564 /* 565 * END: Exposed to rtld_db - don't move, don't delete 566 */ 567 uint32_t rt_alias; 568 uint32_t rt_fpnode; 569 uint32_t rt_init; 570 uint32_t rt_fini; 571 uint32_t rt_runpath; 572 uint32_t rt_runlist; 573 uint32_t rt_depends; 574 uint32_t rt_callers; 575 uint32_t rt_handles; 576 uint32_t rt_groups; 577 uint32_t rt_etext; 578 uint32_t rt_fct; 579 uint32_t rt_symintp; 580 uint32_t rt_priv; 581 uint32_t rt_list; 582 uint32_t rt_objfltrndx; 583 uint32_t rt_symsfltrcnt; 584 uint32_t rt_symafltrcnt; 585 int32_t rt_mode; 586 int32_t rt_sortval; 587 uint32_t rt_cycgroup; 588 uint32_t rt_stdev; 589 uint32_t rt_stino; 590 uint32_t rt_origname; 591 uint32_t rt_dirsz; 592 uint32_t rt_copy; 593 uint32_t rt_auditors; 594 uint32_t rt_audinfo; 595 uint32_t rt_syminfo; 596 uint32_t rt_initarray; 597 uint32_t rt_finiarray; 598 uint32_t rt_preinitarray; 599 uint32_t rt_mmaps; 600 uint32_t rt_mmapcnt; 601 uint32_t rt_initarraysz; 602 uint32_t rt_finiarraysz; 603 uint32_t rt_preinitarraysz; 604 uint32_t rt_dyninfo; 605 uint32_t rt_dyninfocnt; 606 uint32_t rt_relacount; 607 uint32_t rt_idx; 608 uint32_t rt_lazy; 609 uint32_t rt_condvar; 610 uint32_t rt_hwcap; 611 uint32_t rt_sfcap; 612 uint32_t rt_threadid; 613 uint32_t rt_cntl; 614 } Rt_map32; 615 616 #endif /* _SYSCALL32 */ 617 618 /* 619 * Link map state flags. 620 */ 621 /* 622 * BEGIN: Exposed to rtld_db - don't move, don't delete 623 */ 624 #define FLG_RT_ISMAIN 0x00000001 /* object represents main executable */ 625 #define FLG_RT_IMGALLOC 0x00000002 /* image is allocated (not mmap'ed) */ 626 /* 627 * Available for r_debug version >= RTLD_DB_VERSION5 628 */ 629 #define FLG_RT_RELOCED 0x00000004 /* object has been relocated */ 630 /* 631 * END: Exposed to rtld_db - don't move, don't delete 632 */ 633 #define FLG_RT_SETGROUP 0x00000008 /* group establishment required */ 634 #define FLG_RT_HWCAP 0x00000010 /* process $HWCAP expansion */ 635 #define FLG_RT_OBJECT 0x00000020 /* object processing (ie. .o's) */ 636 #define FLG_RT_NEWLOAD 0x00000040 /* object is newly loaded */ 637 #define FLG_RT_NODUMP 0x00000080 /* object can't be dldump(3x)'ed */ 638 #define FLG_RT_DELETE 0x00000100 /* object can be deleted */ 639 #define FLG_RT_ANALYZED 0x00000200 /* object has been analyzed */ 640 #define FLG_RT_INITDONE 0x00000400 /* objects .init has been completed */ 641 #define FLG_RT_TRANS 0x00000800 /* object is acting as a translator */ 642 #define FLG_RT_FIXED 0x00001000 /* image location is fixed */ 643 #define FLG_RT_PRELOAD 0x00002000 /* object was preloaded */ 644 #define FLG_RT_ALTER 0x00004000 /* alternative object used */ 645 #define FLG_RT_LOADFLTR 0x00008000 /* trigger filtee loading */ 646 #define FLG_RT_AUDIT 0x00010000 /* object is an auditor */ 647 #define FLG_RT_MODESET 0x00020000 /* MODE() has been initialized */ 648 #define FLG_RT_ANALZING 0x00040000 /* object is being analyzed */ 649 #define FLG_RT_INITFRST 0x00080000 /* execute .init first */ 650 #define FLG_RT_NOOPEN 0x00100000 /* dlopen() not allowed */ 651 #define FLG_RT_FINICLCT 0x00200000 /* fini has been collected (tsort) */ 652 #define FLG_RT_INITCALL 0x00400000 /* objects .init has been called */ 653 #define FLG_RT_INTRPOSE 0x00800000 /* object is an INTERPOSER */ 654 #define FLG_RT_DIRECT 0x01000000 /* object has DIRECT bindings enabled */ 655 #define FLG_RT_SUNWBSS 0x02000000 /* object with PT_SUNWBSS, not mapped */ 656 #define FLG_RT_MOVE 0x04000000 /* object needs move operation */ 657 #define FLG_RT_DLSYM 0x08000000 /* dlsym in progress on object */ 658 #define FLG_RT_REGSYMS 0x10000000 /* object has DT_REGISTER entries */ 659 #define FLG_RT_INITCLCT 0x20000000 /* init has been collected (tsort) */ 660 #define FLG_RT_HANDLE 0x40000000 /* generate a handle for this object */ 661 #define FLG_RT_RELOCING 0x80000000 /* object is being relocated */ 662 663 #define FL1_RT_COPYTOOK 0x00000001 /* copy relocation taken */ 664 #define FL1_RT_RELATIVE 0x00000002 /* relative path expansion required */ 665 #define FL1_RT_CONFSET 0x00000004 /* object was loaded by crle(1) */ 666 #define FL1_RT_NODEFLIB 0x00000008 /* ignore default library search */ 667 #define FL1_RT_ENDFILTE 0x00000010 /* filtee terminates filters search */ 668 #define FL1_RT_DISPREL 0x00000020 /* object has *disp* relocation */ 669 #define FL1_RT_TEXTREL 0x00000040 /* DT_TEXTREL set in object */ 670 #define FL1_RT_INITWAIT 0x00000080 /* threads are waiting on .init */ 671 #define FL1_RT_LDDSTUB 0x00000100 /* identify lddstub */ 672 #define FL1_RT_NOINIFIN 0x00000200 /* no .init or .fini exists */ 673 #define FL1_RT_USED 0x00000400 /* symbol referenced from this object */ 674 #define FL1_RT_SYMBOLIC 0x00000800 /* DF_SYMBOLIC was set - use */ 675 /* symbolic sym resolution */ 676 #define FL1_RT_OBJSFLTR 0x00001000 /* object is acting as a standard */ 677 #define FL1_RT_OBJAFLTR 0x00002000 /* or auxiliary filter */ 678 #define FL1_RT_SYMSFLTR 0x00004000 /* symbol is acting as a standard */ 679 #define FL1_RT_SYMAFLTR 0x00008000 /* or auxiliary filter */ 680 #define MSK_RT_FILTER 0x0000f000 /* mask for all filter possibilites */ 681 682 #define FL1_RT_TLSADD 0x00010000 /* objects TLS has been registered */ 683 #define FL1_RT_TLSSTAT 0x00020000 /* object requires static TLS */ 684 685 /* 686 * The following range of bits are reserved to hold LML_TFLG_AUD_ values 687 * (although the definitions themselves aren't used anywhere). 688 */ 689 #define FL1_AUD_RS_STR 0x00100000 /* RESERVATION start for AU flags */ 690 #define FL1_AUD_RS_END 0x80000000 /* RESERVATION end for AU flags */ 691 692 693 /* 694 * Flags for the tls_modactivity() routine 695 */ 696 #define TM_FLG_MODADD 0x01 /* call tls_modadd() interface */ 697 #define TM_FLG_MODREM 0x02 /* call tls_modrem() interface */ 698 699 /* 700 * Macros for getting to link_map data. 701 */ 702 #define ADDR(X) ((X)->rt_public.l_addr) 703 #define NAME(X) ((X)->rt_public.l_name) 704 #define DYN(X) ((X)->rt_public.l_ld) 705 #define NEXT(X) ((X)->rt_public.l_next) 706 #define PREV(X) ((X)->rt_public.l_prev) 707 #define REFNAME(X) ((X)->rt_public.l_refname) 708 709 /* 710 * Macros for getting to linker private data. 711 */ 712 #define PATHNAME(X) ((X)->rt_pathname) 713 #define PADSTART(X) ((X)->rt_padstart) 714 #define PADIMLEN(X) ((X)->rt_padimlen) 715 #define MSIZE(X) ((X)->rt_msize) 716 #define FLAGS(X) ((X)->rt_flags) 717 #define FLAGS1(X) ((X)->rt_flags1) 718 #define TLSMODID(X) ((X)->rt_tlsmodid) 719 720 #define ALIAS(X) ((X)->rt_alias) 721 #define FPNODE(X) ((X)->rt_fpnode) 722 #define INIT(X) ((X)->rt_init) 723 #define FINI(X) ((X)->rt_fini) 724 #define RPATH(X) ((X)->rt_runpath) 725 #define RLIST(X) ((X)->rt_runlist) 726 #define DEPENDS(X) ((X)->rt_depends) 727 #define CALLERS(X) ((X)->rt_callers) 728 #define HANDLES(X) ((X)->rt_handles) 729 #define GROUPS(X) ((X)->rt_groups) 730 #define ETEXT(X) ((X)->rt_etext) 731 #define FCT(X) ((X)->rt_fct) 732 #define SYMINTP(X) ((X)->rt_symintp) 733 #define LIST(X) ((X)->rt_list) 734 #define OBJFLTRNDX(X) ((X)->rt_objfltrndx) 735 #define SYMSFLTRCNT(X) ((X)->rt_symsfltrcnt) 736 #define SYMAFLTRCNT(X) ((X)->rt_symafltrcnt) 737 #define MODE(X) ((X)->rt_mode) 738 #define SORTVAL(X) ((X)->rt_sortval) 739 #define CYCGROUP(X) ((X)->rt_cycgroup) 740 #define STDEV(X) ((X)->rt_stdev) 741 #define STINO(X) ((X)->rt_stino) 742 #define ORIGNAME(X) ((X)->rt_origname) 743 #define DIRSZ(X) ((X)->rt_dirsz) 744 #define COPY(X) ((X)->rt_copy) 745 #define AUDITORS(X) ((X)->rt_auditors) 746 #define AUDINFO(X) ((X)->rt_audinfo) 747 #define SYMINFO(X) ((X)->rt_syminfo) 748 #define INITARRAY(X) ((X)->rt_initarray) 749 #define FINIARRAY(X) ((X)->rt_finiarray) 750 #define PREINITARRAY(X) ((X)->rt_preinitarray) 751 #define MMAPS(X) ((X)->rt_mmaps) 752 #define MMAPCNT(X) ((X)->rt_mmapcnt) 753 #define INITARRAYSZ(X) ((X)->rt_initarraysz) 754 #define FINIARRAYSZ(X) ((X)->rt_finiarraysz) 755 #define PREINITARRAYSZ(X) ((X)->rt_preinitarraysz) 756 #define DYNINFO(X) ((X)->rt_dyninfo) 757 #define DYNINFOCNT(X) ((X)->rt_dyninfocnt) 758 #define RELACOUNT(X) ((X)->rt_relacount) 759 #define IDX(X) ((X)->rt_idx) 760 #define LAZY(X) ((X)->rt_lazy) 761 #define CONDVAR(X) ((X)->rt_condvar) 762 #define CNTL(X) ((X)->rt_cntl) 763 #define HWCAP(X) ((X)->rt_hwcap) 764 #define SFCAP(X) ((X)->rt_sfcap) 765 #define THREADID(X) ((X)->rt_threadid) 766 767 /* 768 * Flags for tsorting. 769 */ 770 #define RT_SORT_FWD 0x01 /* topological sort (.fini) */ 771 #define RT_SORT_REV 0x02 /* reverse topological sort (.init) */ 772 #define RT_SORT_DELETE 0x10 /* process FLG_RT_DELNEED objects */ 773 /* only (called via dlclose()) */ 774 /* 775 * Flags for lookup_sym (and hence find_sym) routines. 776 */ 777 #define LKUP_DEFT 0x0000 /* simple lookup request */ 778 #define LKUP_SPEC 0x0001 /* special ELF lookup (allows address */ 779 /* resolutions to plt[] entries) */ 780 #define LKUP_LDOT 0x0002 /* indicates the original A_OUT */ 781 /* symbol had a leading `.' */ 782 #define LKUP_FIRST 0x0004 /* lookup symbol in first link map */ 783 /* only */ 784 #define LKUP_COPY 0x0008 /* lookup symbol for a COPY reloc, do */ 785 /* not bind to symbol at head */ 786 #define LKUP_ALLCNTLIST 0x0010 /* lookup symbol in all control lists */ 787 #define LKUP_SELF 0x0020 /* lookup symbol in ourself - undef */ 788 /* is valid */ 789 #define LKUP_WEAK 0x0040 /* relocation reference is weak */ 790 #define LKUP_NEXT 0x0080 /* request originates from RTLD_NEXT */ 791 #define LKUP_NODESCENT 0x0100 /* don't descend through dependencies */ 792 #define LKUP_NOFALBACK 0x0200 /* don't fall back to loading */ 793 /* pending lazy dependencies */ 794 #define LKUP_DIRECT 0x0400 /* direct binding request */ 795 #define LKUP_SYMNDX 0x0800 /* establish symbol index */ 796 797 /* 798 * Data structure for calling lookup_sym() 799 */ 800 typedef struct { 801 const char *sl_name; /* symbol name */ 802 Rt_map *sl_cmap; /* callers link-map */ 803 Rt_map *sl_imap; /* initial link-map to search */ 804 ulong_t sl_hash; /* symbol hash value */ 805 ulong_t sl_rsymndx; /* referencing reloc symndx */ 806 uint_t sl_flags; /* lookup flags */ 807 } Slookup; 808 809 810 typedef enum { 811 PLT_T_NONE = 0, 812 PLT_T_21D, 813 PLT_T_24D, 814 PLT_T_U32, 815 PLT_T_U44, 816 PLT_T_FULL, 817 PLT_T_FAR, 818 PLT_T_NUM /* Must be last */ 819 } Pltbindtype; 820 821 /* 822 * Prototypes. 823 */ 824 extern Lm_list lml_main; /* main's link map list */ 825 extern Lm_list lml_rtld; /* rtld's link map list */ 826 extern Lm_list *lml_list[]; 827 828 extern Pltbindtype elf_plt_write(uintptr_t, uintptr_t, void *, uintptr_t, 829 Xword); 830 extern Rt_map *is_so_loaded(Lm_list *, const char *, int); 831 extern Sym *lookup_sym(Slookup *, Rt_map **, uint_t *); 832 extern int rt_dldump(Rt_map *, const char *, int, Addr); 833 834 #ifdef __cplusplus 835 } 836 #endif 837 838 #endif /* _RTLD_H */ 839