xref: /titanic_51/usr/src/cmd/sgs/include/rtld.h (revision 2017c9656f884256b400be40fa25d96d630bf02a)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
55aefb655Srie  * Common Development and Distribution License (the "License").
65aefb655Srie  * You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate  *
87c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate  * and limitations under the License.
127c478bd9Sstevel@tonic-gate  *
137c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate  *
197c478bd9Sstevel@tonic-gate  * CDDL HEADER END
207c478bd9Sstevel@tonic-gate  */
215aefb655Srie 
227c478bd9Sstevel@tonic-gate /*
2356deab07SRod Evans  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
247c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
257c478bd9Sstevel@tonic-gate  */
267c478bd9Sstevel@tonic-gate #ifndef	_RTLD_H
277c478bd9Sstevel@tonic-gate #define	_RTLD_H
287c478bd9Sstevel@tonic-gate 
297c478bd9Sstevel@tonic-gate /*
3010a4fa49Srie  * Global include file for the runtime linker.
317c478bd9Sstevel@tonic-gate  */
3256deab07SRod Evans #include <sys/mman.h>
337c478bd9Sstevel@tonic-gate #include <time.h>
347c478bd9Sstevel@tonic-gate #include <sgs.h>
357c478bd9Sstevel@tonic-gate #include <thread.h>
367c478bd9Sstevel@tonic-gate #include <synch.h>
37ba2be530Sab196087 #include <link.h>
387c478bd9Sstevel@tonic-gate #include <sys/avl.h>
397c478bd9Sstevel@tonic-gate #include <alist.h>
4010a4fa49Srie #include <libc_int.h>
417c478bd9Sstevel@tonic-gate 
427c478bd9Sstevel@tonic-gate #ifdef	_SYSCALL32
437c478bd9Sstevel@tonic-gate #include <inttypes.h>
447c478bd9Sstevel@tonic-gate #endif
457c478bd9Sstevel@tonic-gate 
467c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
477c478bd9Sstevel@tonic-gate extern "C" {
487c478bd9Sstevel@tonic-gate #endif
497c478bd9Sstevel@tonic-gate 
507c478bd9Sstevel@tonic-gate /*
51cb511613SAli Bahrami  * We use rtld_ino_t instead of ino_t so that we can get
52cb511613SAli Bahrami  * access to large inode values from 32-bit code.
53cb511613SAli Bahrami  */
54cb511613SAli Bahrami #ifdef _LP64
55cb511613SAli Bahrami typedef ino_t		rtld_ino_t;
56cb511613SAli Bahrami #else
57cb511613SAli Bahrami typedef ino64_t		rtld_ino_t;
58cb511613SAli Bahrami #endif
59cb511613SAli Bahrami 
607c478bd9Sstevel@tonic-gate typedef struct rt_map	Rt_map;
6156deab07SRod Evans typedef struct slookup	Slookup;
627c478bd9Sstevel@tonic-gate 
637c478bd9Sstevel@tonic-gate /*
647c478bd9Sstevel@tonic-gate  * A binding descriptor.  Establishes the binding relationship between two
655aefb655Srie  * objects, the caller (originator) and the dependency (destination).
66*2017c965SRod Evans  *
67*2017c965SRod Evans  * Every relationship between two objects is tracked by a binding descriptor.
68*2017c965SRod Evans  * This descriptor is referenced from a link-map's DEPENDS and CALLERS lists.
69*2017c965SRod Evans  * Note, Aplist's are diagramed to fully expose the allocations required to
70*2017c965SRod Evans  * establish the data structure relationships.
71*2017c965SRod Evans  *
72*2017c965SRod Evans  *                                  Bnd_desc
73*2017c965SRod Evans  *                                 ----------
74*2017c965SRod Evans  *                    ------------| b_caller |
75*2017c965SRod Evans  *                   |            | b_depend | ----------
76*2017c965SRod Evans  *                   |            |          |           |
77*2017c965SRod Evans  *      Rt_map       |             ----------            |       Rt_map
78*2017c965SRod Evans  *    ----------     |                ^ ^                |     ----------
79*2017c965SRod Evans  *   |          | <--                 | |                 --> |          |
80*2017c965SRod Evans  *   |          |        --------     | |                     |          |
81*2017c965SRod Evans  *   | DEPENDS  | ----> |        |    | |     --------        |          |
82*2017c965SRod Evans  *   |          |       |        |    | |    |        | <---- | CALLERS  |
83*2017c965SRod Evans  *   |          |       |        | ---  |    |        |       |          |
84*2017c965SRod Evans  *   |          |       |        |       --- |        |       |          |
85*2017c965SRod Evans  *   |          |        --------            |        |       |          |
86*2017c965SRod Evans  *    ----------          Aplist              --------         ----------
87*2017c965SRod Evans  *                                             Aplist
887c478bd9Sstevel@tonic-gate  */
897c478bd9Sstevel@tonic-gate typedef struct {
907c478bd9Sstevel@tonic-gate 	Rt_map		*b_caller;	/* caller (originator) of a binding */
917c478bd9Sstevel@tonic-gate 	Rt_map		*b_depend;	/* dependency (destination) of a */
927c478bd9Sstevel@tonic-gate 					/*	binding */
937c478bd9Sstevel@tonic-gate 	uint_t		b_flags;	/* relationship of caller to the */
947c478bd9Sstevel@tonic-gate 					/*	dependency */
957c478bd9Sstevel@tonic-gate } Bnd_desc;
967c478bd9Sstevel@tonic-gate 
977c478bd9Sstevel@tonic-gate #define	BND_NEEDED	0x0001		/* caller NEEDED the dependency */
987c478bd9Sstevel@tonic-gate #define	BND_REFER	0x0002		/* caller relocation references the */
997c478bd9Sstevel@tonic-gate 					/*	dependency */
100*2017c965SRod Evans #define	BND_FILTER	0x0004		/* binding identifies filter, used */
101*2017c965SRod Evans 					/*	for diagnostics only */
1027c478bd9Sstevel@tonic-gate /*
1037c478bd9Sstevel@tonic-gate  * Private structure for communication between rtld_db and rtld.
1047c478bd9Sstevel@tonic-gate  *
10510a4fa49Srie  * We must bump the version number when ever an update in one of the
10610a4fa49Srie  * structures/fields that rtld_db reads is updated.  This hopefully permits
10710a4fa49Srie  * rtld_db implementations of the future to recognize core files produced on
10810a4fa49Srie  * older systems and deal with these core files accordingly.
1097c478bd9Sstevel@tonic-gate  *
11056deab07SRod Evans  * As of version 'R_RTLDDB_VERSION <= 2' the following fields were valid for
11156deab07SRod Evans  * core file examination (basically the public Link_map):
1127c478bd9Sstevel@tonic-gate  *
1137c478bd9Sstevel@tonic-gate  *		ADDR()
1147c478bd9Sstevel@tonic-gate  *		NAME()
1157c478bd9Sstevel@tonic-gate  *		DYN()
1167c478bd9Sstevel@tonic-gate  *		NEXT()
1177c478bd9Sstevel@tonic-gate  *		PREV()
1187c478bd9Sstevel@tonic-gate  *
11956deab07SRod Evans  * Valid fields for R_RTLDDB_VERSION3
1207c478bd9Sstevel@tonic-gate  *
1217c478bd9Sstevel@tonic-gate  *		PATHNAME()
1227c478bd9Sstevel@tonic-gate  *		PADSTART()
1237c478bd9Sstevel@tonic-gate  *		PADIMLEN()
1247c478bd9Sstevel@tonic-gate  *		MSIZE()
1257c478bd9Sstevel@tonic-gate  *		FLAGS()
1267c478bd9Sstevel@tonic-gate  *		FLAGS1()
1277c478bd9Sstevel@tonic-gate  *
12856deab07SRod Evans  * Valid fields for R_RTLDDB_VERSION4
1297c478bd9Sstevel@tonic-gate  *
1307c478bd9Sstevel@tonic-gate  *		TLSMODID()
1317c478bd9Sstevel@tonic-gate  *
13256deab07SRod Evans  * Valid fields for R_RTLDDB_VERSION5
1337c478bd9Sstevel@tonic-gate  *
1347c478bd9Sstevel@tonic-gate  *		Added rtld_flags & FLG_RT_RELOCED to stable flags range
1357c478bd9Sstevel@tonic-gate  *
1367c478bd9Sstevel@tonic-gate  */
1377c478bd9Sstevel@tonic-gate #define	R_RTLDDB_VERSION1	1	/* base version level - used for core */
1387c478bd9Sstevel@tonic-gate 					/*	file examination */
13910a4fa49Srie #define	R_RTLDDB_VERSION2	2	/* minor revision - not relevant for */
1407c478bd9Sstevel@tonic-gate 					/*	core files */
1417c478bd9Sstevel@tonic-gate #define	R_RTLDDB_VERSION3	3
1427c478bd9Sstevel@tonic-gate #define	R_RTLDDB_VERSION4	4
1437c478bd9Sstevel@tonic-gate #define	R_RTLDDB_VERSION5	5
1447c478bd9Sstevel@tonic-gate #define	R_RTLDDB_VERSION	R_RTLDDB_VERSION5	/* current version */
1457c478bd9Sstevel@tonic-gate 
1467c478bd9Sstevel@tonic-gate typedef struct rtld_db_priv {
1477c478bd9Sstevel@tonic-gate 	struct r_debug	rtd_rdebug;	/* original r_debug structure */
1487c478bd9Sstevel@tonic-gate 	Word		rtd_version;	/* version no. */
1497c478bd9Sstevel@tonic-gate 	size_t		rtd_objpad;	/* padding around mmap()ed objects */
15057ef7aa9SRod Evans 	APlist		**rtd_dynlmlst;	/* pointer to dynlm_list pointer */
1517c478bd9Sstevel@tonic-gate } Rtld_db_priv;
1527c478bd9Sstevel@tonic-gate 
1537c478bd9Sstevel@tonic-gate #ifdef _SYSCALL32
1547c478bd9Sstevel@tonic-gate typedef struct rtld_db_priv32 {
1557c478bd9Sstevel@tonic-gate 	struct r_debug32 rtd_rdebug;	/* original r_debug structure */
1567c478bd9Sstevel@tonic-gate 	Elf32_Word	rtd_version;	/* version no. */
1577c478bd9Sstevel@tonic-gate 	Elf32_Word	rtd_objpad;	/* padding around mmap()ed objects */
15857ef7aa9SRod Evans 	Elf32_Addr	rtd_dynlmlst;	/* pointer to dynlm_list */
1597c478bd9Sstevel@tonic-gate } Rtld_db_priv32;
1607c478bd9Sstevel@tonic-gate #endif	/* _SYSCALL32 */
1617c478bd9Sstevel@tonic-gate 
16210a4fa49Srie /*
16310a4fa49Srie  * External function definitions.  ld.so.1 must convey information to libc in
16410a4fa49Srie  * regards to threading.  libc also provides routines for atexit() and message
16510a4fa49Srie  * localization.  libc provides the necessary interfaces via its RTLDINFO
16610a4fa49Srie  * structure and/or later _ld_libc() calls.
16710a4fa49Srie  *
16810a4fa49Srie  * These external functions are maintained for each link-map list, and used
16910a4fa49Srie  * where appropriate.  The functions are associated with the object that
17010a4fa49Srie  * provided them, so that should the object be deleted (say, from an alternative
17110a4fa49Srie  * link-map), the functions can be removed.
17210a4fa49Srie  */
17310a4fa49Srie typedef struct {
17410a4fa49Srie 	Rt_map	*lc_lmp;			/* function provider */
17510a4fa49Srie 	union {
17610a4fa49Srie 		int		(*lc_func)();	/* external function pointer */
17710a4fa49Srie 		uintptr_t	lc_val;		/* external value */
17810a4fa49Srie 		char    	*lc_ptr;	/* external character pointer */
17910a4fa49Srie 	} lc_un;
18010a4fa49Srie } Lc_desc;
1817c478bd9Sstevel@tonic-gate 
1827c478bd9Sstevel@tonic-gate /*
1837c478bd9Sstevel@tonic-gate  * Link map list definition.  Link-maps are used to describe each loaded object.
1847c478bd9Sstevel@tonic-gate  * Lists of these link-maps describe the various namespaces within a process.
1857c478bd9Sstevel@tonic-gate  * The process executable and its dependencies are maintained on the lml_main
1867c478bd9Sstevel@tonic-gate  * list.  The runtime linker, and its dependencies are maintained on the
1877c478bd9Sstevel@tonic-gate  * lml_rtld list.  Additional lists can be created (see dlmopen()) for such
1887c478bd9Sstevel@tonic-gate  * things as auditors and their dependencies.
1897c478bd9Sstevel@tonic-gate  *
1907c478bd9Sstevel@tonic-gate  * Each link-map list maintains an Alist of one, or more, linked lists of
1917c478bd9Sstevel@tonic-gate  * link-maps.  For backward compatibility, the lm_head/lm_tail elements are
1927c478bd9Sstevel@tonic-gate  * initialized to the first linked-list of link-maps:
1937c478bd9Sstevel@tonic-gate  *
1947c478bd9Sstevel@tonic-gate  *      Lm_list
1957c478bd9Sstevel@tonic-gate  *    ----------
1967c478bd9Sstevel@tonic-gate  *   | lm_tail  | ------------------------------------
1977c478bd9Sstevel@tonic-gate  *   | lm_head  | --------------------                |
1987c478bd9Sstevel@tonic-gate  *   |          |                     |     Rt_map    |     Rt_map
1997c478bd9Sstevel@tonic-gate  *   |          |                     |     ------    |     ------
2007c478bd9Sstevel@tonic-gate  *   |          |          Alist       --> |      |   |--> |      |
2017c478bd9Sstevel@tonic-gate  *   |          |        ---------    |    |      | --     |      |
2027c478bd9Sstevel@tonic-gate  *   | lm_lists | ----> |         |   |    |      |    --> |      |
2037c478bd9Sstevel@tonic-gate  *   |          |       |---------|   |    |      |   |    |      |
2047c478bd9Sstevel@tonic-gate  *   |          |       | lc_head | --      ------    |     ------
2057c478bd9Sstevel@tonic-gate  *   |          |       | lc_tail | ------------------
2067c478bd9Sstevel@tonic-gate  *   |          |       |---------|
207*2017c965SRod Evans  *    ----------        | lc_head |
2087c478bd9Sstevel@tonic-gate  *                      | lc_tail |
2097c478bd9Sstevel@tonic-gate  *                      |---------|
2107c478bd9Sstevel@tonic-gate  *
2117c478bd9Sstevel@tonic-gate  * Multiple link-map lists exist to support the addition of lazy loaded
2127c478bd9Sstevel@tonic-gate  * families, filtee families, and dlopen() families.  The intent of these
2137c478bd9Sstevel@tonic-gate  * lists is to insure that a family of objects that are to be loaded are
2147c478bd9Sstevel@tonic-gate  * fully relocatable, and hence usable, before they become part of the main
2157c478bd9Sstevel@tonic-gate  * (al_data[0]) link-map control list.  This main link-map control list is
2167c478bd9Sstevel@tonic-gate  * the only list in existence when control is transferred to user code.
2177c478bd9Sstevel@tonic-gate  *
2187c478bd9Sstevel@tonic-gate  * During process initialization, the dynamic executable and its non-lazy
2197c478bd9Sstevel@tonic-gate  * dependencies are maintained on al_data[0].  If a new object is loaded, then
2207c478bd9Sstevel@tonic-gate  * this object is added to the next available control list [1], typically
2217c478bd9Sstevel@tonic-gate  * al_data[1].  Any dependencies of this object that have not already been
2227c478bd9Sstevel@tonic-gate  * loaded are added to the same control list.  Once all of the objects on the
2237c478bd9Sstevel@tonic-gate  * new control list have been successfully relocated, the objects are moved from
2247c478bd9Sstevel@tonic-gate  * the new control list to the highest control list to which objects of the new
2257c478bd9Sstevel@tonic-gate  * control list bound to, typically al_data[1] to al_data[0].
2267c478bd9Sstevel@tonic-gate  *
2277c478bd9Sstevel@tonic-gate  * Each loading scenario can be broken down as follows:
2287c478bd9Sstevel@tonic-gate  *
2297c478bd9Sstevel@tonic-gate  *  setup() - only the initial link-map control list is used:
2307c478bd9Sstevel@tonic-gate  *   i.	  create al_data[0]
2317c478bd9Sstevel@tonic-gate  *   ii.  add new link-map for main on al_data[0]
2327c478bd9Sstevel@tonic-gate  *   iii. analyze al_data[0] to add all non-lazy dependencies
2337c478bd9Sstevel@tonic-gate  *   iv.  relocate al_data[0] dependencies.
2347c478bd9Sstevel@tonic-gate  *
2357c478bd9Sstevel@tonic-gate  *  dlopen() - the initiator can only be the initial link-map control list:
2367c478bd9Sstevel@tonic-gate  *   i.   create al_data[1] from caller al_data[0]
2377c478bd9Sstevel@tonic-gate  *   ii.  add new link-map for the dlopen'ed object on al_data[1]
2387c478bd9Sstevel@tonic-gate  *   iii. analyze al_data[1] to add all non-lazy dependencies
2397c478bd9Sstevel@tonic-gate  *   iv.  relocate al_data[1] dependencies, and move to al_data[0].
2407c478bd9Sstevel@tonic-gate  *
2417c478bd9Sstevel@tonic-gate  *  filtee and lazy loading processing - the initiator can be any link-map
2427c478bd9Sstevel@tonic-gate  *  control list that is being relocated:
2437c478bd9Sstevel@tonic-gate  *   i.   create al_data[y] from caller al_data[x]
2447c478bd9Sstevel@tonic-gate  *   ii.  add new link-map for the new object on al_data[y]
2457c478bd9Sstevel@tonic-gate  *   iii. analyze al_data[y] to add all non-lazy dependencies
2467c478bd9Sstevel@tonic-gate  *   iv.  relocate al_data[y] dependencies, and move to al_data[x].
2477c478bd9Sstevel@tonic-gate  *
2487c478bd9Sstevel@tonic-gate  * This Alist therefore maintains a stack of link-map control lists.  The newest
2497c478bd9Sstevel@tonic-gate  * link-map control list can locate symbols within any of the former lists,
2507c478bd9Sstevel@tonic-gate  * however, control is not passed to a former list until the newest lists
2517c478bd9Sstevel@tonic-gate  * processing is complete.  Thus, objects can't bind to new objects until they
2527c478bd9Sstevel@tonic-gate  * have been fully analyzed and relocated.
2537c478bd9Sstevel@tonic-gate  *
2547c478bd9Sstevel@tonic-gate  * [1]  Note, additional link-map control list creation occurs after the head
2557c478bd9Sstevel@tonic-gate  * link-map object (typically the dynamic executable) has been relocated.  This
2567c478bd9Sstevel@tonic-gate  * staging is required to satisfy the binding requirements of copy relocations.
2577c478bd9Sstevel@tonic-gate  * Copy relocations, effectively, transfer the bindings of the copied data
2587c478bd9Sstevel@tonic-gate  * (say _iob in libc.so.1) to the copy location (_iob in the application).
2597c478bd9Sstevel@tonic-gate  * Thus an object that might bind to the original copy data must be redirected
2607c478bd9Sstevel@tonic-gate  * to the copy reference.  As the knowledge of a copy relocation having taken
2617c478bd9Sstevel@tonic-gate  * place is only known after relocating the application, link-map control list
2627c478bd9Sstevel@tonic-gate  * additions are suspended until after this relocation has completed.
2637c478bd9Sstevel@tonic-gate  */
2647c478bd9Sstevel@tonic-gate typedef struct {
2657c478bd9Sstevel@tonic-gate 	Rt_map		*lc_head;
2667c478bd9Sstevel@tonic-gate 	Rt_map		*lc_tail;
267cce0e03bSab196087 	APlist		*lc_now;	/* pending promoted bind-now objects */
2687c478bd9Sstevel@tonic-gate 	uint_t		lc_flags;
2697c478bd9Sstevel@tonic-gate } Lm_cntl;
2707c478bd9Sstevel@tonic-gate 
2717c478bd9Sstevel@tonic-gate #define	LMC_FLG_ANALYZING	0x01	/* control list is being analyzed */
2727c478bd9Sstevel@tonic-gate #define	LMC_FLG_RELOCATING	0x02	/* control list is being relocated */
2737c478bd9Sstevel@tonic-gate #define	LMC_FLG_REANALYZE	0x04	/* repeat analysis (established when */
2747c478bd9Sstevel@tonic-gate 					/*	interposers are added */
2757c478bd9Sstevel@tonic-gate 
2765aefb655Srie struct lm_list {
2777c478bd9Sstevel@tonic-gate 	/*
2787c478bd9Sstevel@tonic-gate 	 * BEGIN: Exposed to rtld_db - don't move, don't delete
2797c478bd9Sstevel@tonic-gate 	 */
2807c478bd9Sstevel@tonic-gate 	Rt_map		*lm_head;	/* linked list pointers to active */
2817c478bd9Sstevel@tonic-gate 	Rt_map		*lm_tail;	/*	link-map list */
282cce0e03bSab196087 	APlist		*lm_handle;	/* not used by rtld_db - but spacing */
2837c478bd9Sstevel@tonic-gate 					/*	is required for flags */
2847c478bd9Sstevel@tonic-gate 	Word		lm_flags;
2857c478bd9Sstevel@tonic-gate 	/*
2867c478bd9Sstevel@tonic-gate 	 * END: Exposed to rtld_db - don't move, don't delete
2877c478bd9Sstevel@tonic-gate 	 */
28810a4fa49Srie 	Alist		*lm_rti;	/* list of RTLDINFO tables */
2898af2c5b9Srie 	Audit_list	*lm_alp;	/* audit list descriptor */
2907c478bd9Sstevel@tonic-gate 	avl_tree_t	*lm_fpavl;	/* avl tree of objects loaded */
2917c478bd9Sstevel@tonic-gate 	Alist		*lm_lists;	/* active and pending link-map lists */
29241072f3cSrie 	char		***lm_environ;	/* pointer to environment array */
2937c478bd9Sstevel@tonic-gate 	Word		lm_tflags;	/* transferable flags */
2945aefb655Srie 	uint_t		lm_obj;		/* total number of objs on link-map */
2955aefb655Srie 	uint_t		lm_init;	/* new obj since last init processing */
2965aefb655Srie 	uint_t		lm_lazy;	/* obj with pending lazy dependencies */
29710a4fa49Srie 	uint_t		lm_tls;		/* new obj that require TLS */
2985aefb655Srie 	uint_t		lm_lmid;	/* unique link-map list identifier, */
2995aefb655Srie 	char		*lm_lmidstr;	/* and associated diagnostic string */
300cce0e03bSab196087 	APlist		*lm_actaudit;	/* list of pending audit activity */
30110a4fa49Srie 	Lc_desc		lm_lcs[CI_MAX];	/* external libc functions */
3025aefb655Srie };
3037c478bd9Sstevel@tonic-gate 
3047c478bd9Sstevel@tonic-gate #ifdef	_SYSCALL32
3055aefb655Srie struct lm_list32 {
3067c478bd9Sstevel@tonic-gate 	/*
3077c478bd9Sstevel@tonic-gate 	 * BEGIN: Exposed to rtld_db - don't move, don't delete
3087c478bd9Sstevel@tonic-gate 	 */
3097c478bd9Sstevel@tonic-gate 	Elf32_Addr	lm_head;
3107c478bd9Sstevel@tonic-gate 	Elf32_Addr	lm_tail;
3117c478bd9Sstevel@tonic-gate 	Elf32_Addr	lm_handle;
3127c478bd9Sstevel@tonic-gate 	Elf32_Word	lm_flags;
3137c478bd9Sstevel@tonic-gate 	/*
3147c478bd9Sstevel@tonic-gate 	 * END: Exposed to rtld_db - don't move, don't delete
3157c478bd9Sstevel@tonic-gate 	 */
31610a4fa49Srie 	Elf32_Addr	lm_rti;
3177c478bd9Sstevel@tonic-gate 	Elf32_Addr	lm_fpavl;
3187c478bd9Sstevel@tonic-gate 	Elf32_Addr	lm_lists;
31941072f3cSrie 	Elf32_Addr	lm_environ;
3207c478bd9Sstevel@tonic-gate 	Elf32_Word	lm_tflags;
3215aefb655Srie 	uint_t		lm_obj;
3225aefb655Srie 	uint_t		lm_init;
3235aefb655Srie 	uint_t		lm_lazy;
32410a4fa49Srie 	uint_t		lm_tls;
3255aefb655Srie 	uint_t		lm_lmid;
3265aefb655Srie 	Elf32_Addr	lm_lmidstr;
3277247f888Srie 	Elf32_Addr	lm_actaudit;
32810a4fa49Srie 	Elf32_Addr	lm_lcs[CI_MAX];
3295aefb655Srie };
3307c478bd9Sstevel@tonic-gate #endif /* _SYSCALL32 */
3317c478bd9Sstevel@tonic-gate 
3327c478bd9Sstevel@tonic-gate /*
3337c478bd9Sstevel@tonic-gate  * Possible Link_map list flags (Lm_list.lm_flags)
3347c478bd9Sstevel@tonic-gate  */
3357c478bd9Sstevel@tonic-gate /*
3367c478bd9Sstevel@tonic-gate  * BEGIN: Exposed to rtld_db - don't move, don't delete
3377c478bd9Sstevel@tonic-gate  */
3387c478bd9Sstevel@tonic-gate #define	LML_FLG_BASELM		0x00000001	/* primary link-map */
3397c478bd9Sstevel@tonic-gate #define	LML_FLG_RTLDLM		0x00000002	/* rtld link-map */
3407c478bd9Sstevel@tonic-gate /*
3417c478bd9Sstevel@tonic-gate  * END: Exposed to rtld_db - don't move, don't delete
3427c478bd9Sstevel@tonic-gate  */
3437c478bd9Sstevel@tonic-gate #define	LML_FLG_NOAUDIT		0x00000004	/* symbol auditing disabled */
3447c478bd9Sstevel@tonic-gate #define	LML_FLG_PLTREL		0x00000008	/* deferred plt relocation */
3457c478bd9Sstevel@tonic-gate 						/* 	initialization */
3467c478bd9Sstevel@tonic-gate 						/*	(ld.so.1 only) */
3477c478bd9Sstevel@tonic-gate #define	LML_FLG_HOLDLOCK	0x00000010	/* hold the rtld mutex lock */
3487c478bd9Sstevel@tonic-gate #define	LML_FLG_ENVIRON		0x00000020	/* environ var initialized */
3497c478bd9Sstevel@tonic-gate #define	LML_FLG_INTRPOSE	0x00000040	/* interposing objs on list */
3507c478bd9Sstevel@tonic-gate #define	LML_FLG_LOCAUDIT	0x00000080	/* local auditors exists for */
3517c478bd9Sstevel@tonic-gate 						/*	this link-map list */
3527c478bd9Sstevel@tonic-gate #define	LML_FLG_LOADAVAIL	0x00000100	/* load anything available */
3537c478bd9Sstevel@tonic-gate #define	LML_FLG_IGNRELERR	0x00000200	/* ignore relocation errors - */
3547c478bd9Sstevel@tonic-gate 						/*	internal for crle(1) */
3557c478bd9Sstevel@tonic-gate #define	LML_FLG_DBNOTIF		0x00000400	/* binding activity going on */
356dffec89cSrie #define	LML_FLG_STARTREL	0x00000800	/* relocation started */
357dffec89cSrie #define	LML_FLG_ATEXIT		0x00001000	/* atexit processing */
358dffec89cSrie #define	LML_FLG_OBJADDED	0x00002000	/* object(s) added */
359dffec89cSrie #define	LML_FLG_OBJDELETED	0x00004000	/* object(s) deleted */
360dffec89cSrie #define	LML_FLG_OBJREEVAL	0x00008000	/* existing object(s) needs */
361dffec89cSrie 						/*	tsort reevaluation */
3622926dd2eSrie #define	LML_FLG_NOPENDGLBLAZY	0x00010000	/* no pending, global, lazy */
3632926dd2eSrie 						/*	dependencies remain */
364883c6d49Srie #define	LML_FLG_INTRPOSETSORT	0x00020000	/* interpose tsorting done */
3657247f888Srie #define	LML_FLG_AUDITNOTIFY	0x00040000	/* audit consistent required */
36660758829Srie #define	LML_FLG_GROUPSEXIST	0x00080000	/* local groups exist */
3672926dd2eSrie 
3687c478bd9Sstevel@tonic-gate #define	LML_FLG_TRC_LDDSTUB	0x00100000	/* identify lddstub */
3697c478bd9Sstevel@tonic-gate #define	LML_FLG_TRC_ENABLE	0x00200000	/* tracing enabled (ldd) */
3707c478bd9Sstevel@tonic-gate #define	LML_FLG_TRC_WARN	0x00400000	/* print warnings for undefs */
3717c478bd9Sstevel@tonic-gate #define	LML_FLG_TRC_VERBOSE	0x00800000	/* verbose (versioning) trace */
3727c478bd9Sstevel@tonic-gate #define	LML_FLG_TRC_SEARCH	0x01000000	/* trace search paths */
3737c478bd9Sstevel@tonic-gate #define	LML_FLG_TRC_UNREF	0x02000000	/* trace unreferenced */
3747c478bd9Sstevel@tonic-gate 						/*	dependencies */
3757c478bd9Sstevel@tonic-gate #define	LML_FLG_TRC_UNUSED	0x04000000	/* trace unused dependencies */
3767c478bd9Sstevel@tonic-gate #define	LML_FLG_TRC_INIT	0x08000000	/* print .init order */
377df4628cbSrie #define	LML_FLG_TRC_NOUNRESWEAK	0x10000000	/* unresolved weak references */
378df4628cbSrie 						/*	are not allowed */
379dae2dfb7Srie #define	LML_FLG_TRC_NOPAREXT	0x20000000	/* unresolved PARENT/EXTERN */
380dae2dfb7Srie 						/*	references are not */
381dae2dfb7Srie 						/*	allowed */
3827c478bd9Sstevel@tonic-gate #define	LML_MSK_TRC		0xfff00000	/* tracing mask */
3837c478bd9Sstevel@tonic-gate 
3847c478bd9Sstevel@tonic-gate /*
3857c478bd9Sstevel@tonic-gate  * Possible Link_map transferable flags (Lm_list.lm_tflags), i.e., link-map
3867c478bd9Sstevel@tonic-gate  * list flags that can be propagated to any new link-map list created.
3877c478bd9Sstevel@tonic-gate  */
3887c478bd9Sstevel@tonic-gate #define	LML_TFLG_NOLAZYLD	0x00000001	/* lazy loading disabled */
3897c478bd9Sstevel@tonic-gate #define	LML_TFLG_NODIRECT	0x00000002	/* direct bindings disabled */
3907c478bd9Sstevel@tonic-gate 
3917c478bd9Sstevel@tonic-gate #define	LML_TFLG_LOADFLTR	0x00000008	/* trigger filtee loading */
3927c478bd9Sstevel@tonic-gate 
39356deab07SRod Evans #define	LML_TFLG_AUD_PREINIT	0x00001000	/* preinit (audit) exists */
39456deab07SRod Evans #define	LML_TFLG_AUD_OBJSEARCH	0x00002000	/* objsearch (audit) exists */
39556deab07SRod Evans #define	LML_TFLG_AUD_OBJOPEN	0x00004000	/* objopen (audit) exists */
39656deab07SRod Evans #define	LML_TFLG_AUD_OBJFILTER	0x00008000	/* objfilter (audit) exists */
39756deab07SRod Evans #define	LML_TFLG_AUD_OBJCLOSE	0x00010000	/* objclose (audit) exists */
39856deab07SRod Evans #define	LML_TFLG_AUD_SYMBIND	0x00020000	/* symbind (audit) exists */
39956deab07SRod Evans #define	LML_TFLG_AUD_PLTENTER	0x00040000	/* pltenter (audit) exists */
40056deab07SRod Evans #define	LML_TFLG_AUD_PLTEXIT	0x00080000	/* pltexit (audit) exists */
40156deab07SRod Evans #define	LML_TFLG_AUD_ACTIVITY	0x00100000	/* activity (audit) exists */
4027c478bd9Sstevel@tonic-gate 
4037c478bd9Sstevel@tonic-gate /*
40456deab07SRod Evans  * NOTE: Each auditing module establishes a set of audit flags, AFLAGS(), that
40556deab07SRod Evans  * define the auditing interfaces the module offers.  These auditing flags are
40656deab07SRod Evans  * the LML_TFLG_AUD_ flags defined above.  Global auditors result in setting
40756deab07SRod Evans  * the lm_tflags too.  Local auditors only use the AFLAGS().  All tests for
40856deab07SRod Evans  * auditing inspect the lm_tflags and AFLAGS() for a specific auditing
40956deab07SRod Evans  * interface, and thus use the same flag to test for both types of auditors.
4107c478bd9Sstevel@tonic-gate  */
41156deab07SRod Evans #define	LML_TFLG_AUD_MASK	0x0ffff000	/* audit interfaces mask */
4127c478bd9Sstevel@tonic-gate 
4137c478bd9Sstevel@tonic-gate /*
4148af2c5b9Srie  * Define a Group Handle.
4158af2c5b9Srie  *
4168af2c5b9Srie  * The capability of ld.so.1 to associate a group of objects, look for symbols
4178af2c5b9Srie  * within that group, ensure that groups are isolated from one another (with
418*2017c965SRod Evans  * regard to relocations), and to unload a group, centers around a handle.
4198af2c5b9Srie  *
420*2017c965SRod Evans  * Dependencies can be added to an existing handle as the dependencies are
421*2017c965SRod Evans  * lazily loaded.  The core dependencies on the handle are the ldd(1) list of
422*2017c965SRod Evans  * the referenced object.
423*2017c965SRod Evans  *
424*2017c965SRod Evans  * Handles can be created from:
425*2017c965SRod Evans  *
426*2017c965SRod Evans  *  -	a dlopen() request.  This associates a caller to a reference object,
427*2017c965SRod Evans  * 	and the referenced objects dependencies.  This group of objects can
428*2017c965SRod Evans  *	then be inspected for symbols (dlsym()).
429*2017c965SRod Evans  *  -	a filtering request.  This associates a filter (caller) to a referenced
430*2017c965SRod Evans  *	object (filtee).  The redirection of filter symbols to their filtee
431*2017c965SRod Evans  *	counterpart is essentially a dlsym() using the filtee's handle.
432*2017c965SRod Evans  *
433*2017c965SRod Evans  * The handle created for these events is referred to as a public handle.  This
434*2017c965SRod Evans  * handle tracks the referenced object, all of the dependencies of the
435*2017c965SRod Evans  * referenced object, and the caller (parent).
4368af2c5b9Srie  *
4378af2c5b9Srie  * Presently, an object may have two handles, one requested with RTLD_FIRST
4388af2c5b9Srie  * and one without.
4398af2c5b9Srie  *
440*2017c965SRod Evans  * A handle may be referenced by any number of callers (parents).  A reference
4418af2c5b9Srie  * count tracks the number.  A dlclose() operation drops the reference count,
4428af2c5b9Srie  * and when the count is zero, the handle is used to determine the family of
4438af2c5b9Srie  * objects to unload.  As bindings may occur to objects on the handle from
444*2017c965SRod Evans  * other handles, it may not be possible to remove a complete family of objects
445*2017c965SRod Evans  * or the handle itself.  Handles in this state are moved to an orphan list.
446*2017c965SRod Evans  * A handle on the orphan list is taken off the orphan list if the associated
447*2017c965SRod Evans  * object is reopened.  Otherwise, the handle remains on the orphan list for
448*2017c965SRod Evans  * the duration of the process.  The orphan list is inspected any time objects
449*2017c965SRod Evans  * are unloaded, to determine if the orphaned objects can also be unloaded.
450*2017c965SRod Evans  *
451*2017c965SRod Evans  * Handles can also be created for internal uses:
452*2017c965SRod Evans  *
453*2017c965SRod Evans  *  -	to promote objects to RTLD_NOW.
454*2017c965SRod Evans  *  -	to establish families for symbol binding fallback, required when lazy
455*2017c965SRod Evans  *	loadable objects are still pending.
456*2017c965SRod Evans  *
457*2017c965SRod Evans  * The handle created for these events is referred to as a private handle.  This
458*2017c965SRod Evans  * handle does not need to track the caller (parent), and because of this, does
459*2017c965SRod Evans  * not need to be considered during dlclose() operations, as the handle can not
460*2017c965SRod Evans  * be referenced by callers outside of the referenced objects family.
461*2017c965SRod Evans  *
462*2017c965SRod Evans  * Note, a private handle is essentially a subset of a public handle.  Should
463*2017c965SRod Evans  * an internal operation require a private handle, and a public handle already
464*2017c965SRod Evans  * exist, the public handle can be used.  Should an external operation require
465*2017c965SRod Evans  * a public handle, and a private handle exist, the private handle is promoted
466*2017c965SRod Evans  * to a public handle.  Any handle that gets created will remain in existence
467*2017c965SRod Evans  * for the life time of the referenced object.
4688af2c5b9Srie  *
4698af2c5b9Srie  * Objects can be dlopened using RTLD_NOW.  This attribute requires that all
4708af2c5b9Srie  * relocations of the object, and its dependencies are processed immediately,
4718af2c5b9Srie  * before return to the caller.  Typically, an object is loaded without
4728af2c5b9Srie  * RTLD_NOW, and procedure linkage relocations are satisfied when their
4738af2c5b9Srie  * associated function is first called.  If an object is already loaded, and an
4748af2c5b9Srie  * RTLD_NOW request is made, then the object, and its dependencies, most undergo
4758af2c5b9Srie  * additional relocation processing.   This promotion from lazy binding to
4768af2c5b9Srie  * immediate binding is carried out using handles, as the handle defines the
477*2017c965SRod Evans  * dependencies that must be processed.
478*2017c965SRod Evans  *
479*2017c965SRod Evans  * To ensure that objects within a lazy loadable environment can be relocated,
480*2017c965SRod Evans  * no matter whether the objects have their dependencies described completely,
481*2017c965SRod Evans  * a symbol lookup fallback is employed.  Any pending lazy loadable objects are
482*2017c965SRod Evans  * loaded, and a handle established to search the object and it's dependencies
483*2017c965SRod Evans  * for the required symbol.
484*2017c965SRod Evans  *
485*2017c965SRod Evans  * A group handle (and its associated group descriptors), is referenced from
486*2017c965SRod Evans  * a link-map's HANDLES and GROUPS lists.  Note, Aplist's are diagramed to
487*2017c965SRod Evans  * fully expose the allocations required to establish the data structure
488*2017c965SRod Evans  * relationships.
489*2017c965SRod Evans  *
490*2017c965SRod Evans  *                                  Grp_desc
491*2017c965SRod Evans  *                                   Alist
492*2017c965SRod Evans  *                                 -----------
493*2017c965SRod Evans  *                            --> |           |
494*2017c965SRod Evans  *                           |    |-----------|
495*2017c965SRod Evans  *                           |    | gd_depend | ---------
496*2017c965SRod Evans  *                           |    |           |          |
497*2017c965SRod Evans  *                           |    |-----------|          |
498*2017c965SRod Evans  *                   --------|--- | gd_depend |          |
499*2017c965SRod Evans  *                  |        |    | (parent)  |          |
500*2017c965SRod Evans  *                  |        |    |-----------|          |
501*2017c965SRod Evans  *                  |        |    | gd_depend |          |
502*2017c965SRod Evans  *                  |        |    |           |          |
503*2017c965SRod Evans  *                  |        |    |           |          |
504*2017c965SRod Evans  *                  |        |     -----------           |
505*2017c965SRod Evans  *                  |        |                           |
506*2017c965SRod Evans  *                  |        |      Grp_hdl              |
507*2017c965SRod Evans  *                  |        |    -----------            |
508*2017c965SRod Evans  *                  |         -- | gh_depends |          |
509*2017c965SRod Evans  *                  |  --------- | gh_ownlmp  |          |
510*2017c965SRod Evans  *                  | |          |            |          |
511*2017c965SRod Evans  *                  | |          |            |          |
512*2017c965SRod Evans  *                  | |          |            |          |
513*2017c965SRod Evans  *      Rt_map      | |           ------------           |       Rt_map
514*2017c965SRod Evans  *    ----------    | |               ^ ^                |     ----------
515*2017c965SRod Evans  *   |          | <-  |               | |                 --> |          |
516*2017c965SRod Evans  *   |          | <---   --------     | |                     |          |
517*2017c965SRod Evans  *   | HANDLES  | ----> |        |    | |     --------        |          |
518*2017c965SRod Evans  *   |          |       |        |    | |    |        | <---- |  GROUPS  |
519*2017c965SRod Evans  *   |          |       |        | ---  |    |        |       |          |
520*2017c965SRod Evans  *   |          |       |        |       --- |        |       |          |
521*2017c965SRod Evans  *   |          |        --------            |        |       |          |
522*2017c965SRod Evans  *    ----------          Aplist              --------         ----------
523*2017c965SRod Evans  *                                             Aplist
5247c478bd9Sstevel@tonic-gate  */
5257c478bd9Sstevel@tonic-gate typedef struct {
5267c478bd9Sstevel@tonic-gate 	Alist		*gh_depends;	/* handle dependency list */
5275aefb655Srie 	Rt_map		*gh_ownlmp;	/* handle owners link-map */
5285aefb655Srie 	Lm_list		*gh_ownlml;	/* handle owners link-map list */
5297c478bd9Sstevel@tonic-gate 	uint_t		gh_refcnt;	/* handle reference count */
5308af2c5b9Srie 	uint_t		gh_flags;	/* handle flags (GPH_ values) */
5317c478bd9Sstevel@tonic-gate } Grp_hdl;
5327c478bd9Sstevel@tonic-gate 
533*2017c965SRod Evans /*
534*2017c965SRod Evans  * Define the two categories of handle.
535*2017c965SRod Evans  */
536*2017c965SRod Evans #define	GPH_PUBLIC	0x0001		/* handle returned to caller(s) */
537*2017c965SRod Evans #define	GPH_PRIVATE	0x0002		/* handle used internally */
5387c478bd9Sstevel@tonic-gate 
5397c478bd9Sstevel@tonic-gate /*
540*2017c965SRod Evans  * Define any flags that affects how the handle is used.
541*2017c965SRod Evans  */
542*2017c965SRod Evans #define	GPH_ZERO	0x0010		/* special handle for dlopen(0) */
543*2017c965SRod Evans #define	GPH_LDSO	0x0020		/* special handle for ld.so.1 */
544*2017c965SRod Evans #define	GPH_FIRST	0x0040		/* dlsym() can only use originating */
545*2017c965SRod Evans 					/*	dependency */
546*2017c965SRod Evans #define	GPH_FILTEE	0x0080		/* handle identifies a filtee, used */
547*2017c965SRod Evans 					/*	for diagnostics only */
548*2017c965SRod Evans /*
549*2017c965SRod Evans  * Define any state that is associated with the handle.
550*2017c965SRod Evans  */
551*2017c965SRod Evans #define	GPH_INITIAL	0x0100		/* handle is initialized */
552*2017c965SRod Evans #define	GPH_NOPENDLAZY	0x0200		/* no pending lazy dependencies */
553*2017c965SRod Evans 					/*	remain for this handle */
554*2017c965SRod Evans /*
5558af2c5b9Srie  * Define a Group Descriptor.
5568af2c5b9Srie  *
5578af2c5b9Srie  * Each dependency associated with a group handle is maintained by a group
5588af2c5b9Srie  * descriptor.  The descriptor defines the associated dependency together with
5598af2c5b9Srie  * flags that indicate how the dependency can be used.
5607c478bd9Sstevel@tonic-gate  */
5617c478bd9Sstevel@tonic-gate typedef struct {
5627c478bd9Sstevel@tonic-gate 	Rt_map		*gd_depend;	/* dependency */
5638af2c5b9Srie 	uint_t		gd_flags;	/* dependency flags (GPD_ values) */
5647c478bd9Sstevel@tonic-gate } Grp_desc;
5657c478bd9Sstevel@tonic-gate 
566efb9e8b8Srie #define	GPD_DLSYM	0x0001		/* dependency available to dlsym() */
567efb9e8b8Srie #define	GPD_RELOC	0x0002		/* dependency available to satisfy */
568efb9e8b8Srie 					/*	relocation binding */
569efb9e8b8Srie #define	GPD_ADDEPS	0x0004		/* dependencies of this dependency */
5707c478bd9Sstevel@tonic-gate 					/*	should be added to handle */
571efb9e8b8Srie #define	GPD_PARENT	0x0008		/* dependency is a parent */
572efb9e8b8Srie #define	GPD_FILTER	0x0010		/* dependency is our filter */
573*2017c965SRod Evans #define	GPD_REMOVE	0x0100		/* descriptor is a candidate for */
5747c478bd9Sstevel@tonic-gate 					/*	removal from the group */
575*2017c965SRod Evans #define	GPD_MODECHANGE	0x0200		/* dependency mode has changed, e.g. */
576*2017c965SRod Evans 					/*	promoted to RTLD_GOBAL */
5777c478bd9Sstevel@tonic-gate 
5787c478bd9Sstevel@tonic-gate /*
5797c478bd9Sstevel@tonic-gate  * Define threading structures.  For compatibility with libthread (T1_VERSION 1
5807c478bd9Sstevel@tonic-gate  * and TI_VERSION 2) our locking structure is sufficient to hold a mutex or a
5817c478bd9Sstevel@tonic-gate  * readers/writers lock.
5827c478bd9Sstevel@tonic-gate  */
5837c478bd9Sstevel@tonic-gate typedef struct {
5847c478bd9Sstevel@tonic-gate 	union {
5857c478bd9Sstevel@tonic-gate 		mutex_t		l_mutex;
5867c478bd9Sstevel@tonic-gate 		rwlock_t	l_rwlock;
5877c478bd9Sstevel@tonic-gate 	} u;
5887c478bd9Sstevel@tonic-gate } Rt_lock;
5897c478bd9Sstevel@tonic-gate 
5907c478bd9Sstevel@tonic-gate typedef	cond_t	Rt_cond;
5917c478bd9Sstevel@tonic-gate 
5927c478bd9Sstevel@tonic-gate /*
5937c478bd9Sstevel@tonic-gate  * Define a dynamic section information descriptor.  This parallels the entries
5947c478bd9Sstevel@tonic-gate  * in the .dynamic section and holds auxiliary information to implement lazy
5957c478bd9Sstevel@tonic-gate  * loading and filtee processing.
5967c478bd9Sstevel@tonic-gate  */
5977c478bd9Sstevel@tonic-gate typedef struct {
5987c478bd9Sstevel@tonic-gate 	uint_t	di_flags;
5997c478bd9Sstevel@tonic-gate 	void	*di_info;
6007c478bd9Sstevel@tonic-gate } Dyninfo;
6017c478bd9Sstevel@tonic-gate 
6027c478bd9Sstevel@tonic-gate #define	FLG_DI_STDFLTR	0x00001		/* .dynamic entry for DT_FILTER */
6037c478bd9Sstevel@tonic-gate #define	FLG_DI_AUXFLTR	0x00002		/* .dynamic entry for DT_AUXILIARY */
6047c478bd9Sstevel@tonic-gate #define	FLG_DI_SYMFLTR	0x00004		/* .dynamic entry for DT_SYMFILTER */
6057c478bd9Sstevel@tonic-gate 					/*	and DT_SYMAUXILIARY */
6067c478bd9Sstevel@tonic-gate #define	MSK_DI_FILTER	0x0000f		/* mask for all filter possibilities */
6077c478bd9Sstevel@tonic-gate 
60875e7992aSrie #define	FLG_DI_POSFLAG1	0x00010		/* .dynamic entry for DT_POSFLAG_1 */
60975e7992aSrie #define	FLG_DI_NEEDED	0x00020		/* .dynamic entry for DT_NEEDED */
61075e7992aSrie #define	FLG_DI_LAZY	0x00100		/* lazy needed entry - preceded by */
61175e7992aSrie 					/*    DF_P1_LAZYLOAD (DT_POSFLAG_1) */
61275e7992aSrie #define	FLG_DI_GROUP	0x00200		/* group needed entry - preceded by */
61375e7992aSrie 					/*    DF_P1_GROUPPERM (DT_POSFLAG_1) */
6147c478bd9Sstevel@tonic-gate 
61575e7992aSrie #define	FLG_DI_LDD_DONE	0x01000		/* entry has been processed (ldd) */
61675e7992aSrie #define	FLG_DI_LAZYFAIL	0x02000		/* the lazy loading of this entry */
61775e7992aSrie 					/*    failed */
6187c478bd9Sstevel@tonic-gate /*
6199aa23310Srie  * Data structure to track AVL tree of pathnames.  This structure provides the
6209aa23310Srie  * basis of both the "not-found" node tree, and the "full-path" node tree.  Both
6219aa23310Srie  * of these trees persist for the life of a process, although the "not-found"
6229aa23310Srie  * tree may be moved aside during a dlopen() or dlsym() fall back operation.
6237c478bd9Sstevel@tonic-gate  */
6247c478bd9Sstevel@tonic-gate typedef struct {
6259aa23310Srie 	const char	*pn_name;	/* path name */
6269aa23310Srie 	avl_node_t	pn_avl;		/* avl book-keeping (see SGSOFFSETOF) */
6279aa23310Srie 	uint_t		pn_hash;	/* path name hash value */
6289aa23310Srie } PathNode;
6299aa23310Srie 
6309aa23310Srie /*
6319aa23310Srie  * Data structure to track AVL tree for full path names of objects that are
6329aa23310Srie  * loaded into memory.
6339aa23310Srie  */
6349aa23310Srie typedef struct {
6359aa23310Srie 	PathNode	fpn_node;	/* path node */
6367c478bd9Sstevel@tonic-gate 	Rt_map		*fpn_lmp;	/* object link-map */
6379aa23310Srie } FullPathNode;
6387c478bd9Sstevel@tonic-gate 
6397c478bd9Sstevel@tonic-gate /*
640cce0e03bSab196087  * A given link-map can hold either a supplier or receiver copy
641cce0e03bSab196087  * relocation list, but not both. This union is used to overlap
642cce0e03bSab196087  * the space used for the two lists.
643cce0e03bSab196087  */
644cce0e03bSab196087 typedef union {
645cce0e03bSab196087 	Alist	*rtc_r;		/* receiver list (Rel_copy) */
646cce0e03bSab196087 	APlist	*rtc_s;		/* supplier list (Rt_map *) */
647cce0e03bSab196087 } Rt_map_copy;
648cce0e03bSab196087 
649cce0e03bSab196087 
650cce0e03bSab196087 /*
6517c478bd9Sstevel@tonic-gate  * Link-map definition.
6527c478bd9Sstevel@tonic-gate  */
6537c478bd9Sstevel@tonic-gate struct rt_map {
6547c478bd9Sstevel@tonic-gate 	/*
6557c478bd9Sstevel@tonic-gate 	 * BEGIN: Exposed to rtld_db - don't move, don't delete
6567c478bd9Sstevel@tonic-gate 	 */
6577c478bd9Sstevel@tonic-gate 	Link_map	rt_public;	/* public data */
65856deab07SRod Evans 	const char	*rt_pathname;	/* full pathname of loaded object */
6597c478bd9Sstevel@tonic-gate 	ulong_t		rt_padstart;	/* start of image (including padding) */
6607c478bd9Sstevel@tonic-gate 	ulong_t		rt_padimlen;	/* size of image (including padding */
66156deab07SRod Evans 	ulong_t		rt_msize;	/* total memory reservation range */
6627c478bd9Sstevel@tonic-gate 	uint_t		rt_flags;	/* state flags, see FLG below */
6637c478bd9Sstevel@tonic-gate 	uint_t		rt_flags1;	/* state flags1, see FL1 below */
6647c478bd9Sstevel@tonic-gate 	ulong_t		rt_tlsmodid;	/* TLS module id */
6657c478bd9Sstevel@tonic-gate 	/*
6667c478bd9Sstevel@tonic-gate 	 * END: Exposed to rtld_db - don't move, don't delete
6677c478bd9Sstevel@tonic-gate 	 */
668cce0e03bSab196087 	APlist		*rt_alias;	/* list of linked file names */
669cce0e03bSab196087 	APlist		*rt_fpnode;	/* list of FullpathNode AVL nodes */
6707c478bd9Sstevel@tonic-gate 	char		*rt_runpath;	/* LD_RUN_PATH and its equivalent */
67156deab07SRod Evans 	Alist		*rt_runlist;	/*	Pdesc structures */
672cce0e03bSab196087 	APlist		*rt_depends;	/* list of dependencies */
673cce0e03bSab196087 	APlist		*rt_callers;	/* list of callers */
674cce0e03bSab196087 	APlist		*rt_handles;	/* dlopen handles */
675cce0e03bSab196087 	APlist		*rt_groups;	/* groups we're a member of */
6767c478bd9Sstevel@tonic-gate 	struct fct	*rt_fct;	/* file class table for this object */
6777c478bd9Sstevel@tonic-gate 	void		*rt_priv;	/* private data, object type specific */
6787c478bd9Sstevel@tonic-gate 	Lm_list		*rt_list;	/* link map list we belong to */
6797c478bd9Sstevel@tonic-gate 	uint_t		rt_objfltrndx;	/* object filtees .dynamic index */
6807c478bd9Sstevel@tonic-gate 	uint_t		rt_symsfltrcnt;	/* number of standard symbol filtees */
6817c478bd9Sstevel@tonic-gate 	uint_t		rt_symafltrcnt;	/* number of auxiliary symbol filtees */
6827c478bd9Sstevel@tonic-gate 	int		rt_mode;	/* usage mode, see RTLD mode flags */
683dffec89cSrie 	int		rt_sortval;	/* temporary buffer to traverse graph */
6847c478bd9Sstevel@tonic-gate 	uint_t		rt_cycgroup;	/* cyclic group */
6857c478bd9Sstevel@tonic-gate 	dev_t		rt_stdev;	/* device id and inode number for .so */
686cb511613SAli Bahrami 	rtld_ino_t	rt_stino;	/*	multiple inclusion checks */
68756deab07SRod Evans 	const char	*rt_origname;	/* original pathname of loaded object */
6887c478bd9Sstevel@tonic-gate 	size_t		rt_dirsz;	/*	and its size */
68956deab07SRod Evans 	size_t		rt_lmsize;	/* size of the link-map allocation */
690cce0e03bSab196087 	Rt_map_copy	rt_copy;	/* list of copy relocations */
6917c478bd9Sstevel@tonic-gate 	Audit_desc	*rt_auditors;	/* audit descriptor array */
6927c478bd9Sstevel@tonic-gate 	Audit_info	*rt_audinfo;	/* audit information descriptor */
6937c478bd9Sstevel@tonic-gate 	Syminfo		*rt_syminfo;	/* elf .syminfo section - here */
6947c478bd9Sstevel@tonic-gate 					/*	because it is checked in */
6957c478bd9Sstevel@tonic-gate 					/*	common code */
6967c478bd9Sstevel@tonic-gate 	Addr		*rt_initarray;	/* .initarray table */
6977c478bd9Sstevel@tonic-gate 	Addr		*rt_finiarray;	/* .finiarray table */
6987c478bd9Sstevel@tonic-gate 	Addr		*rt_preinitarray; /* .preinitarray table */
69956deab07SRod Evans 	mmapobj_result_t *rt_mmaps;	/* array of mapping information */
7007c478bd9Sstevel@tonic-gate 	uint_t		rt_mmapcnt;	/*	and associated number */
7017c478bd9Sstevel@tonic-gate 	uint_t		rt_initarraysz;	/* size of .initarray table */
7027c478bd9Sstevel@tonic-gate 	uint_t		rt_finiarraysz;	/* size of .finiarray table */
7037c478bd9Sstevel@tonic-gate 	uint_t		rt_preinitarraysz; /* size of .preinitarray table */
7047c478bd9Sstevel@tonic-gate 	Dyninfo		*rt_dyninfo;	/* .dynamic information descriptors */
7057c478bd9Sstevel@tonic-gate 	uint_t		rt_dyninfocnt;	/* count of dyninfo entries */
7067c478bd9Sstevel@tonic-gate 	uint_t		rt_relacount;	/* no. of RELATIVE relocations */
7077c478bd9Sstevel@tonic-gate 	uint_t		rt_idx;		/* hold index within linkmap list */
7087c478bd9Sstevel@tonic-gate 	uint_t		rt_lazy;	/* lazy dependencies pending */
7097c478bd9Sstevel@tonic-gate 	Xword		rt_hwcap;	/* hardware capabilities */
7107c478bd9Sstevel@tonic-gate 	Xword		rt_sfcap;	/* software capabilities */
7117c478bd9Sstevel@tonic-gate 	uint_t		rt_cntl;	/* link-map control list we belong to */
71256deab07SRod Evans 	uint_t		rt_aflags;	/* auditor flags, see LML_TFLG_AUD_ */
71356deab07SRod Evans 					/* address of _init */
71456deab07SRod Evans 	void		(*rt_init)(void);
71556deab07SRod Evans 					/* address of _fini */
71656deab07SRod Evans 	void		(*rt_fini)(void);
71756deab07SRod Evans 					/* link map symbol interpreter */
71856deab07SRod Evans 	Sym		*(*rt_symintp)(Slookup *, Rt_map **, uint_t *, int *);
7197c478bd9Sstevel@tonic-gate };
7207c478bd9Sstevel@tonic-gate 
7217c478bd9Sstevel@tonic-gate #ifdef _SYSCALL32
7227c478bd9Sstevel@tonic-gate /*
7237c478bd9Sstevel@tonic-gate  * Structure to allow 64-bit rtld_db to read 32-bit processes out of procfs.
7247c478bd9Sstevel@tonic-gate  */
725cce0e03bSab196087 typedef union {
726cce0e03bSab196087 	uint32_t	rtc_r;
727cce0e03bSab196087 	uint32_t	rtc_s;
728cce0e03bSab196087 } Rt_map_copy32;
729cce0e03bSab196087 
7307c478bd9Sstevel@tonic-gate typedef struct rt_map32 {
7317c478bd9Sstevel@tonic-gate 	/*
7327c478bd9Sstevel@tonic-gate 	 * BEGIN: Exposed to rtld_db - don't move, don't delete
7337c478bd9Sstevel@tonic-gate 	 */
7347c478bd9Sstevel@tonic-gate 	Link_map32	rt_public;
7357c478bd9Sstevel@tonic-gate 	uint32_t	rt_pathname;
7367c478bd9Sstevel@tonic-gate 	uint32_t	rt_padstart;
7377c478bd9Sstevel@tonic-gate 	uint32_t	rt_padimlen;
7387c478bd9Sstevel@tonic-gate 	uint32_t	rt_msize;
7397c478bd9Sstevel@tonic-gate 	uint32_t	rt_flags;
7407c478bd9Sstevel@tonic-gate 	uint32_t	rt_flags1;
7417c478bd9Sstevel@tonic-gate 	uint32_t	rt_tlsmodid;
7427c478bd9Sstevel@tonic-gate 	/*
7437c478bd9Sstevel@tonic-gate 	 * END: Exposed to rtld_db - don't move, don't delete
7447c478bd9Sstevel@tonic-gate 	 */
7457c478bd9Sstevel@tonic-gate 	uint32_t	rt_alias;
7467c478bd9Sstevel@tonic-gate 	uint32_t	rt_fpnode;
7477c478bd9Sstevel@tonic-gate 	uint32_t	rt_runpath;
7487c478bd9Sstevel@tonic-gate 	uint32_t	rt_runlist;
7497c478bd9Sstevel@tonic-gate 	uint32_t	rt_depends;
7507c478bd9Sstevel@tonic-gate 	uint32_t	rt_callers;
7517c478bd9Sstevel@tonic-gate 	uint32_t	rt_handles;
7527c478bd9Sstevel@tonic-gate 	uint32_t	rt_groups;
7537c478bd9Sstevel@tonic-gate 	uint32_t	rt_fct;
7547c478bd9Sstevel@tonic-gate 	uint32_t	rt_priv;
7557c478bd9Sstevel@tonic-gate 	uint32_t 	rt_list;
7567c478bd9Sstevel@tonic-gate 	uint32_t 	rt_objfltrndx;
7577c478bd9Sstevel@tonic-gate 	uint32_t 	rt_symsfltrcnt;
7587c478bd9Sstevel@tonic-gate 	uint32_t 	rt_symafltrcnt;
759dffec89cSrie 	int32_t		rt_mode;
760dffec89cSrie 	int32_t		rt_sortval;
7617c478bd9Sstevel@tonic-gate 	uint32_t	rt_cycgroup;
7627c478bd9Sstevel@tonic-gate 	uint32_t	rt_stdev;
7637c478bd9Sstevel@tonic-gate 	uint32_t	rt_stino;
7647c478bd9Sstevel@tonic-gate 	uint32_t	rt_origname;
7657c478bd9Sstevel@tonic-gate 	uint32_t	rt_dirsz;
766cce0e03bSab196087 	Rt_map_copy32	rt_copy;
7677c478bd9Sstevel@tonic-gate 	uint32_t 	rt_auditors;
7687c478bd9Sstevel@tonic-gate 	uint32_t 	rt_audinfo;
7697c478bd9Sstevel@tonic-gate 	uint32_t	rt_syminfo;
7707c478bd9Sstevel@tonic-gate 	uint32_t	rt_initarray;
7717c478bd9Sstevel@tonic-gate 	uint32_t	rt_finiarray;
7727c478bd9Sstevel@tonic-gate 	uint32_t	rt_preinitarray;
7737c478bd9Sstevel@tonic-gate 	uint32_t	rt_mmaps;
7747c478bd9Sstevel@tonic-gate 	uint32_t	rt_mmapcnt;
7757c478bd9Sstevel@tonic-gate 	uint32_t	rt_initarraysz;
7767c478bd9Sstevel@tonic-gate 	uint32_t	rt_finiarraysz;
7777c478bd9Sstevel@tonic-gate 	uint32_t	rt_preinitarraysz;
7787c478bd9Sstevel@tonic-gate 	uint32_t 	rt_dyninfo;
7797c478bd9Sstevel@tonic-gate 	uint32_t 	rt_dyninfocnt;
7807c478bd9Sstevel@tonic-gate 	uint32_t	rt_relacount;
7817c478bd9Sstevel@tonic-gate 	uint32_t	rt_idx;
7827c478bd9Sstevel@tonic-gate 	uint32_t	rt_lazy;
7837c478bd9Sstevel@tonic-gate 	uint32_t	rt_hwcap;
7847c478bd9Sstevel@tonic-gate 	uint32_t	rt_sfcap;
7857c478bd9Sstevel@tonic-gate 	uint32_t	rt_cntl;
78656deab07SRod Evans 	uint32_t	rt_aflags;
78756deab07SRod Evans 	uint32_t 	rt_init;
78856deab07SRod Evans 	uint32_t	rt_fini;
78956deab07SRod Evans 	uint32_t	rt_symintp;
7907c478bd9Sstevel@tonic-gate } Rt_map32;
7917c478bd9Sstevel@tonic-gate 
7927c478bd9Sstevel@tonic-gate #endif	/* _SYSCALL32 */
7937c478bd9Sstevel@tonic-gate 
7947c478bd9Sstevel@tonic-gate /*
7957c478bd9Sstevel@tonic-gate  * Link map state flags.
7967c478bd9Sstevel@tonic-gate  */
7977c478bd9Sstevel@tonic-gate /*
7987c478bd9Sstevel@tonic-gate  * BEGIN: Exposed to rtld_db - don't move, don't delete
7997c478bd9Sstevel@tonic-gate  */
8007c478bd9Sstevel@tonic-gate #define	FLG_RT_ISMAIN	0x00000001	/* object represents main executable */
8017c478bd9Sstevel@tonic-gate #define	FLG_RT_IMGALLOC	0x00000002	/* image is allocated (not mmap'ed) */
8027c478bd9Sstevel@tonic-gate 	/*
80356deab07SRod Evans 	 * Available for r_debug version >= R_RTLDDB_VERSION5
8047c478bd9Sstevel@tonic-gate 	 */
8057c478bd9Sstevel@tonic-gate #define	FLG_RT_RELOCED	0x00000004	/* object has been relocated */
8067c478bd9Sstevel@tonic-gate /*
8077c478bd9Sstevel@tonic-gate  * END: Exposed to rtld_db - don't move, don't delete
8087c478bd9Sstevel@tonic-gate  */
8097c478bd9Sstevel@tonic-gate #define	FLG_RT_SETGROUP	0x00000008	/* group establishment required */
8107c478bd9Sstevel@tonic-gate #define	FLG_RT_HWCAP	0x00000010	/* process $HWCAP expansion */
8117c478bd9Sstevel@tonic-gate #define	FLG_RT_OBJECT	0x00000020	/* object processing (ie. .o's) */
812390b98b5Srie #define	FLG_RT_NEWLOAD	0x00000040	/* object is newly loaded */
8137c478bd9Sstevel@tonic-gate #define	FLG_RT_NODUMP	0x00000080	/* object can't be dldump(3x)'ed */
8147c478bd9Sstevel@tonic-gate #define	FLG_RT_DELETE	0x00000100	/* object can be deleted */
8157c478bd9Sstevel@tonic-gate #define	FLG_RT_ANALYZED	0x00000200	/* object has been analyzed */
8167c478bd9Sstevel@tonic-gate #define	FLG_RT_INITDONE	0x00000400	/* objects .init has been completed */
8177c478bd9Sstevel@tonic-gate #define	FLG_RT_TRANS	0x00000800	/* object is acting as a translator */
8187c478bd9Sstevel@tonic-gate #define	FLG_RT_FIXED	0x00001000	/* image location is fixed */
8197c478bd9Sstevel@tonic-gate #define	FLG_RT_PRELOAD	0x00002000	/* object was preloaded */
8207c478bd9Sstevel@tonic-gate #define	FLG_RT_ALTER	0x00004000	/* alternative object used */
8217c478bd9Sstevel@tonic-gate #define	FLG_RT_LOADFLTR	0x00008000	/* trigger filtee loading */
8227c478bd9Sstevel@tonic-gate #define	FLG_RT_AUDIT	0x00010000	/* object is an auditor */
8237c478bd9Sstevel@tonic-gate #define	FLG_RT_MODESET	0x00020000	/* MODE() has been initialized */
8247c478bd9Sstevel@tonic-gate #define	FLG_RT_ANALZING	0x00040000	/* object is being analyzed */
8257c478bd9Sstevel@tonic-gate #define	FLG_RT_INITFRST 0x00080000	/* execute .init first */
8267c478bd9Sstevel@tonic-gate #define	FLG_RT_NOOPEN	0x00100000	/* dlopen() not allowed */
8277c478bd9Sstevel@tonic-gate #define	FLG_RT_FINICLCT	0x00200000	/* fini has been collected (tsort) */
8287c478bd9Sstevel@tonic-gate #define	FLG_RT_INITCALL	0x00400000	/* objects .init has been called */
82935450702SAli Bahrami #define	FLG_RT_OBJINTPO	0x00800000	/* object is a global interposer */
83035450702SAli Bahrami #define	FLG_RT_SYMINTPO	0x01000000	/* object contains symbol interposer */
83135450702SAli Bahrami #define	MSK_RT_INTPOSE	0x01800000	/* mask for all interposer */
8329a411307Srie 					/*	possibilities */
83335450702SAli Bahrami #define	FLG_RT_MOVE	0x02000000	/* object needs move operation */
834*2017c965SRod Evans #define	FLG_RT_RELOCING	0x04000000	/* object is being relocated */
83535450702SAli Bahrami #define	FLG_RT_REGSYMS	0x08000000	/* object has DT_REGISTER entries */
83635450702SAli Bahrami #define	FLG_RT_INITCLCT	0x10000000	/* init has been collected (tsort) */
837*2017c965SRod Evans #define	FLG_RT_PUBHDL	0x20000000	/* generate a handle for this object */
838*2017c965SRod Evans #define	FLG_RT_PRIHDL	0x40000000	/*	either public or private */
8397c478bd9Sstevel@tonic-gate 
8407c478bd9Sstevel@tonic-gate #define	FL1_RT_COPYTOOK	0x00000001	/* copy relocation taken */
84156deab07SRod Evans 
8427c478bd9Sstevel@tonic-gate #define	FL1_RT_CONFSET	0x00000004	/* object was loaded by crle(1) */
8437c478bd9Sstevel@tonic-gate #define	FL1_RT_NODEFLIB	0x00000008	/* ignore default library search */
8447c478bd9Sstevel@tonic-gate #define	FL1_RT_ENDFILTE	0x00000010	/* filtee terminates filters search */
8457c478bd9Sstevel@tonic-gate #define	FL1_RT_DISPREL	0x00000020	/* object has *disp* relocation */
84656deab07SRod Evans #define	FL1_RT_DTFLAGS	0x00000040	/* DT_FLAGS element exists */
84756deab07SRod Evans 
8487c478bd9Sstevel@tonic-gate #define	FL1_RT_LDDSTUB	0x00000100	/* identify lddstub */
8497c478bd9Sstevel@tonic-gate #define	FL1_RT_NOINIFIN	0x00000200	/* no .init or .fini exists */
8507c478bd9Sstevel@tonic-gate #define	FL1_RT_USED	0x00000400	/* symbol referenced from this object */
8517c478bd9Sstevel@tonic-gate #define	FL1_RT_SYMBOLIC	0x00000800	/* DF_SYMBOLIC was set - use */
8527c478bd9Sstevel@tonic-gate 					/*	symbolic sym resolution */
8537c478bd9Sstevel@tonic-gate #define	FL1_RT_OBJSFLTR	0x00001000	/* object is acting as a standard */
8547c478bd9Sstevel@tonic-gate #define	FL1_RT_OBJAFLTR	0x00002000	/*	or auxiliary filter */
8557c478bd9Sstevel@tonic-gate #define	FL1_RT_SYMSFLTR	0x00004000	/* symbol is acting as a standard */
8567c478bd9Sstevel@tonic-gate #define	FL1_RT_SYMAFLTR	0x00008000	/*	or auxiliary filter */
8578af2c5b9Srie #define	MSK_RT_FILTER	0x0000f000	/* mask for all filter possibilities */
8587c478bd9Sstevel@tonic-gate 
85910a4fa49Srie #define	FL1_RT_TLSADD	0x00010000	/* objects TLS has been registered */
860d326b23bSrie #define	FL1_RT_TLSSTAT	0x00020000	/* object requires static TLS */
8619a411307Srie #define	FL1_RT_DIRECT	0x00040000	/* object has DIRECT bindings enabled */
8627247f888Srie #define	FL1_RT_GLOBAUD	0x00080000	/* establish global auditing */
86310a4fa49Srie 
8647c478bd9Sstevel@tonic-gate /*
8657c478bd9Sstevel@tonic-gate  * Flags for the tls_modactivity() routine
8667c478bd9Sstevel@tonic-gate  */
8677c478bd9Sstevel@tonic-gate #define	TM_FLG_MODADD	0x01		/* call tls_modadd() interface */
8687c478bd9Sstevel@tonic-gate #define	TM_FLG_MODREM	0x02		/* call tls_modrem() interface */
8697c478bd9Sstevel@tonic-gate 
8707c478bd9Sstevel@tonic-gate /*
87156deab07SRod Evans  * Macros for getting to exposed, link_map data (R_RTLDDB_VERSION <= 2).
8727c478bd9Sstevel@tonic-gate  */
8737c478bd9Sstevel@tonic-gate #define	ADDR(X)		((X)->rt_public.l_addr)
8747c478bd9Sstevel@tonic-gate #define	NAME(X)		((X)->rt_public.l_name)
8757c478bd9Sstevel@tonic-gate #define	DYN(X)		((X)->rt_public.l_ld)
8767c478bd9Sstevel@tonic-gate #define	NEXT(X)		((X)->rt_public.l_next)
8777c478bd9Sstevel@tonic-gate #define	PREV(X)		((X)->rt_public.l_prev)
8787c478bd9Sstevel@tonic-gate #define	REFNAME(X)	((X)->rt_public.l_refname)
8797c478bd9Sstevel@tonic-gate 
8807c478bd9Sstevel@tonic-gate /*
881cb511613SAli Bahrami  * An Rt_map starts with a Link_map, followed by other information.
882cb511613SAli Bahrami  * ld.so.1 allocates Rt_map structures, and then casts them to Link_map,
883cb511613SAli Bahrami  * and back, depending on context.
884cb511613SAli Bahrami  *
885cb511613SAli Bahrami  * On some platforms, Rt_map can have a higher alignment requirement
886cb511613SAli Bahrami  * than Link_map. On such platforms, the cast from Link_map to Rt_map will
887cb511613SAli Bahrami  * draw an E_BAD_PTR_CAST_ALIGN warning from lint. Since we allocate
888cb511613SAli Bahrami  * the memory as the higher alignment Rt_map, we know that this is a safe
889cb511613SAli Bahrami  * conversion. The LINKMAP_TO_RTMAP macro is used to handle the conversion
890cb511613SAli Bahrami  * in a manner that satisfies lint.
891cb511613SAli Bahrami  */
892cb511613SAli Bahrami #ifdef lint
893cb511613SAli Bahrami #define	LINKMAP_TO_RTMAP(X)	(Rt_map *)(void *)(X)
894cb511613SAli Bahrami #else
895cb511613SAli Bahrami #define	LINKMAP_TO_RTMAP(X)	(Rt_map *)(X)
896cb511613SAli Bahrami #endif
897cb511613SAli Bahrami 
898cb511613SAli Bahrami /*
899cb511613SAli Bahrami  * Convenience macros for the common case of using
900cb511613SAli Bahrami  * NEXT()/PREV() and casting the result to (Rt_map *)
901cb511613SAli Bahrami  */
902cb511613SAli Bahrami #define	NEXT_RT_MAP(X)	LINKMAP_TO_RTMAP(NEXT(X))
903cb511613SAli Bahrami #define	PREV_RT_MAP(X)	LINKMAP_TO_RTMAP(PREV(X))
904cb511613SAli Bahrami 
905cb511613SAli Bahrami /*
90656deab07SRod Evans  * Macros for getting to exposed, link_map data (R_RTLDDB_VERSION3).
9077c478bd9Sstevel@tonic-gate  */
9087c478bd9Sstevel@tonic-gate #define	PATHNAME(X)	((X)->rt_pathname)
9097c478bd9Sstevel@tonic-gate #define	PADSTART(X)	((X)->rt_padstart)
9107c478bd9Sstevel@tonic-gate #define	PADIMLEN(X)	((X)->rt_padimlen)
9117c478bd9Sstevel@tonic-gate #define	MSIZE(X)	((X)->rt_msize)
9127c478bd9Sstevel@tonic-gate #define	FLAGS(X)	((X)->rt_flags)
9137c478bd9Sstevel@tonic-gate #define	FLAGS1(X)	((X)->rt_flags1)
91456deab07SRod Evans 
91556deab07SRod Evans /*
91656deab07SRod Evans  * Macros for getting to exposed, link_map data (R_RTLDDB_VERSION4).
91756deab07SRod Evans  */
9187c478bd9Sstevel@tonic-gate #define	TLSMODID(X)	((X)->rt_tlsmodid)
9197c478bd9Sstevel@tonic-gate 
92056deab07SRod Evans /*
92156deab07SRod Evans  * Macros for getting to unexposed, link-map data.
92256deab07SRod Evans  */
92356deab07SRod Evans #define	LMSIZE(X)	((X)->rt_lmsize)
92456deab07SRod Evans #define	AFLAGS(X)	((X)->rt_aflags)
9257c478bd9Sstevel@tonic-gate #define	ALIAS(X)	((X)->rt_alias)
9267c478bd9Sstevel@tonic-gate #define	FPNODE(X)	((X)->rt_fpnode)
9277c478bd9Sstevel@tonic-gate #define	INIT(X)		((X)->rt_init)
9287c478bd9Sstevel@tonic-gate #define	FINI(X)		((X)->rt_fini)
9297c478bd9Sstevel@tonic-gate #define	RPATH(X)	((X)->rt_runpath)
9307c478bd9Sstevel@tonic-gate #define	RLIST(X)	((X)->rt_runlist)
9317c478bd9Sstevel@tonic-gate #define	DEPENDS(X)	((X)->rt_depends)
9327c478bd9Sstevel@tonic-gate #define	CALLERS(X)	((X)->rt_callers)
9337c478bd9Sstevel@tonic-gate #define	HANDLES(X)	((X)->rt_handles)
9347c478bd9Sstevel@tonic-gate #define	GROUPS(X)	((X)->rt_groups)
9357c478bd9Sstevel@tonic-gate #define	FCT(X)		((X)->rt_fct)
9367c478bd9Sstevel@tonic-gate #define	SYMINTP(X)	((X)->rt_symintp)
9377c478bd9Sstevel@tonic-gate #define	LIST(X)		((X)->rt_list)
9387c478bd9Sstevel@tonic-gate #define	OBJFLTRNDX(X)	((X)->rt_objfltrndx)
9397c478bd9Sstevel@tonic-gate #define	SYMSFLTRCNT(X)	((X)->rt_symsfltrcnt)
9407c478bd9Sstevel@tonic-gate #define	SYMAFLTRCNT(X)	((X)->rt_symafltrcnt)
9417c478bd9Sstevel@tonic-gate #define	MODE(X)		((X)->rt_mode)
9427c478bd9Sstevel@tonic-gate #define	SORTVAL(X)	((X)->rt_sortval)
9437c478bd9Sstevel@tonic-gate #define	CYCGROUP(X)	((X)->rt_cycgroup)
9447c478bd9Sstevel@tonic-gate #define	STDEV(X)	((X)->rt_stdev)
9457c478bd9Sstevel@tonic-gate #define	STINO(X)	((X)->rt_stino)
9467c478bd9Sstevel@tonic-gate #define	ORIGNAME(X)	((X)->rt_origname)
9477c478bd9Sstevel@tonic-gate #define	DIRSZ(X)	((X)->rt_dirsz)
948cce0e03bSab196087 #define	COPY_R(X)	((X)->rt_copy.rtc_r)
949cce0e03bSab196087 #define	COPY_S(X)	((X)->rt_copy.rtc_s)
9507c478bd9Sstevel@tonic-gate #define	AUDITORS(X)	((X)->rt_auditors)
9517c478bd9Sstevel@tonic-gate #define	AUDINFO(X)	((X)->rt_audinfo)
9527c478bd9Sstevel@tonic-gate #define	SYMINFO(X)	((X)->rt_syminfo)
9537c478bd9Sstevel@tonic-gate #define	INITARRAY(X)	((X)->rt_initarray)
9547c478bd9Sstevel@tonic-gate #define	FINIARRAY(X)	((X)->rt_finiarray)
9557c478bd9Sstevel@tonic-gate #define	PREINITARRAY(X)	((X)->rt_preinitarray)
9567c478bd9Sstevel@tonic-gate #define	MMAPS(X)	((X)->rt_mmaps)
9577c478bd9Sstevel@tonic-gate #define	MMAPCNT(X)	((X)->rt_mmapcnt)
9587c478bd9Sstevel@tonic-gate #define	INITARRAYSZ(X)	((X)->rt_initarraysz)
9597c478bd9Sstevel@tonic-gate #define	FINIARRAYSZ(X)	((X)->rt_finiarraysz)
9607c478bd9Sstevel@tonic-gate #define	PREINITARRAYSZ(X) ((X)->rt_preinitarraysz)
9617c478bd9Sstevel@tonic-gate #define	DYNINFO(X)	((X)->rt_dyninfo)
9627c478bd9Sstevel@tonic-gate #define	DYNINFOCNT(X)	((X)->rt_dyninfocnt)
9637c478bd9Sstevel@tonic-gate #define	RELACOUNT(X)	((X)->rt_relacount)
9647c478bd9Sstevel@tonic-gate #define	IDX(X)		((X)->rt_idx)
9657c478bd9Sstevel@tonic-gate #define	LAZY(X)		((X)->rt_lazy)
9667c478bd9Sstevel@tonic-gate #define	CNTL(X)		((X)->rt_cntl)
9677c478bd9Sstevel@tonic-gate #define	HWCAP(X)	((X)->rt_hwcap)
9687c478bd9Sstevel@tonic-gate #define	SFCAP(X)	((X)->rt_sfcap)
9697c478bd9Sstevel@tonic-gate 
970dffec89cSrie /*
971dffec89cSrie  * Flags for tsorting.
972dffec89cSrie  */
973dffec89cSrie #define	RT_SORT_FWD	0x01		/* topological sort (.fini) */
974dffec89cSrie #define	RT_SORT_REV	0x02		/* reverse topological sort (.init) */
97556deab07SRod Evans #define	RT_SORT_DELETE	0x10		/* process FLG_RT_DELETE objects */
976dffec89cSrie 					/*	only (called via dlclose()) */
977883c6d49Srie #define	RT_SORT_INTPOSE	0x20		/* process interposer objects */
978883c6d49Srie 
9797c478bd9Sstevel@tonic-gate /*
9807c478bd9Sstevel@tonic-gate  * Flags for lookup_sym (and hence find_sym) routines.
9817c478bd9Sstevel@tonic-gate  */
9827c478bd9Sstevel@tonic-gate #define	LKUP_DEFT	0x0000		/* simple lookup request */
9837c478bd9Sstevel@tonic-gate #define	LKUP_SPEC	0x0001		/* special ELF lookup (allows address */
9847c478bd9Sstevel@tonic-gate 					/*	resolutions to plt[] entries) */
9857c478bd9Sstevel@tonic-gate #define	LKUP_LDOT	0x0002		/* indicates the original A_OUT */
9867c478bd9Sstevel@tonic-gate 					/*	symbol had a leading `.' */
9877c478bd9Sstevel@tonic-gate #define	LKUP_FIRST	0x0004		/* lookup symbol in first link map */
9887c478bd9Sstevel@tonic-gate 					/*	only */
9897c478bd9Sstevel@tonic-gate #define	LKUP_COPY	0x0008		/* lookup symbol for a COPY reloc, do */
9907c478bd9Sstevel@tonic-gate 					/*	not bind to symbol at head */
99160758829Srie #define	LKUP_STDRELOC	0x0010		/* lookup originates from a standard */
99260758829Srie 					/*	relocation (elf_reloc()) */
9937c478bd9Sstevel@tonic-gate #define	LKUP_SELF	0x0020		/* lookup symbol in ourself - undef */
9947c478bd9Sstevel@tonic-gate 					/*	is valid */
9957c478bd9Sstevel@tonic-gate #define	LKUP_WEAK	0x0040		/* relocation reference is weak */
9967c478bd9Sstevel@tonic-gate #define	LKUP_NEXT	0x0080		/* request originates from RTLD_NEXT */
9977c478bd9Sstevel@tonic-gate #define	LKUP_NODESCENT	0x0100		/* don't descend through dependencies */
99875e7992aSrie #define	LKUP_NOFALLBACK	0x0200		/* don't fall back to loading */
9997c478bd9Sstevel@tonic-gate 					/*	pending lazy dependencies */
10007c478bd9Sstevel@tonic-gate #define	LKUP_DIRECT	0x0400		/* direct binding request */
1001660acd81Srie #define	LKUP_SYMNDX	0x0800		/* establish symbol index */
100260758829Srie #define	LKUP_SINGLETON	0x1000		/* search for a singleton symbol */
100360758829Srie #define	LKUP_STANDARD	0x2000		/* standard lookup - originated from */
100460758829Srie 					/* 	head link-map element */
100537ffaf83SRod Evans #define	LKUP_WORLD	0x4000		/* ensure world lookup */
10067c478bd9Sstevel@tonic-gate 
10077c478bd9Sstevel@tonic-gate /*
100875e7992aSrie  * For the runtime linker to perform a symbol search, a number of data items
100975e7992aSrie  * related to the search are required.  An Slookup data structure is used to
101075e7992aSrie  * convey this data to lookup_sym(), and in special cases, to other core
101175e7992aSrie  * routines that provide the implementation details for lookup_sym()
101275e7992aSrie  *
101375e7992aSrie  * The symbol name (sl_name), the caller (sl_cmap), and the link-map from which
101475e7992aSrie  * to start the search (sl_imap) are fundamental to the symbol search.  The
101575e7992aSrie  * initial search link-map might get modified by the core routines that provide
101675e7992aSrie  * the implementation details for lookup_sym().  This modification accommodates
101775e7992aSrie  * requirements such as processing a handle, direct binding and interposition.
101875e7992aSrie  * The association between the caller and the potential destination also
101975e7992aSrie  * determines whether the destination is a candidate to search.
102075e7992aSrie  *
102175e7992aSrie  * The lookup identifier (sl_id) is used to identify a runtime linker operation.
102275e7992aSrie  * Within this operation, any lazy loads that fail are not re-examined.  This
102375e7992aSrie  * technique keeps the overhead of processing a failed lazy load to a minimum.
102475e7992aSrie  *
102575e7992aSrie  * Symbol searches that originate from a relocation record are accompanied by
102675e7992aSrie  * the relocation index (sl_rsymndx), the symbol reference (sl_rsym) and
102775e7992aSrie  * possibly the relocation type (sl_rtype).  This data provides for determining
102875e7992aSrie  * lazy loading, direct binding, and special symbol processing requirements
102975e7992aSrie  * such as copy relocations and singleton lookup.
103075e7992aSrie  *
103175e7992aSrie  * The symbols hash value is computed by lookup_sym, and propagated throughout
103275e7992aSrie  * the search engine.  Note, occasionally the Slookup data is passed to a core
103375e7992aSrie  * routine that provides the implementation details for lookup_sym(), ie.
103475e7992aSrie  * elf_find_sym(), in which case the caller must initialize the hash value.
103575e7992aSrie  *
103675e7992aSrie  * The symbols binding information is established by lookup_sym() when the
103775e7992aSrie  * symbols relocation type is supplied.  Weak bindings allow relocations to
103875e7992aSrie  * be set to zero should a symbol lookup fail.
103975e7992aSrie  *
104075e7992aSrie  * The flags allow the caller to control aspects of the search, including the
104175e7992aSrie  * interpretation of copy relocations, etc.  Note, a number of flag settings
104275e7992aSrie  * are established in lookup_sym() from attributes of the symbol reference.
10437c478bd9Sstevel@tonic-gate  */
104456deab07SRod Evans struct slookup {
10457c478bd9Sstevel@tonic-gate 	const char	*sl_name;	/* symbol name */
10467c478bd9Sstevel@tonic-gate 	Rt_map		*sl_cmap;	/* callers link-map */
10477c478bd9Sstevel@tonic-gate 	Rt_map		*sl_imap;	/* initial link-map to search */
104875e7992aSrie 	ulong_t		sl_id;		/* identifier for this lookup */
10497c478bd9Sstevel@tonic-gate 	ulong_t		sl_hash;	/* symbol hash value */
10507c478bd9Sstevel@tonic-gate 	ulong_t		sl_rsymndx;	/* referencing reloc symndx */
105160758829Srie 	Sym		*sl_rsym;	/* referencing symbol */
105260758829Srie 	uchar_t		sl_rtype;	/* relocation type associate with */
105360758829Srie 					/*    symbol */
105460758829Srie 	uchar_t		sl_bind;	/* symbols binding (returned) */
10557c478bd9Sstevel@tonic-gate 	uint_t		sl_flags;	/* lookup flags */
105656deab07SRod Evans };
10577c478bd9Sstevel@tonic-gate 
105875e7992aSrie #define	SLOOKUP_INIT(sl, name, cmap, imap, id, hash, rsymndx, rsym, rtype, \
105975e7992aSrie     flags) \
106075e7992aSrie 	(void) (sl.sl_name = (name), sl.sl_cmap = (cmap), sl.sl_imap = (imap), \
106175e7992aSrie 	    sl.sl_id = (id), sl.sl_hash = (hash), sl.sl_rsymndx = (rsymndx), \
106275e7992aSrie 	    sl.sl_rsym = (rsym), sl.sl_rtype = (rtype), sl.sl_bind = 0, \
106375e7992aSrie 	    sl.sl_flags = (flags))
10647c478bd9Sstevel@tonic-gate 
106575e7992aSrie /*
106675e7992aSrie  * Define a number of .plt lookup outcomes, for use in binding diagnostics.
106775e7992aSrie  */
10687c478bd9Sstevel@tonic-gate typedef	enum {
10697c478bd9Sstevel@tonic-gate 	PLT_T_NONE = 0,
10707c478bd9Sstevel@tonic-gate 	PLT_T_21D,
10717c478bd9Sstevel@tonic-gate 	PLT_T_24D,
10727c478bd9Sstevel@tonic-gate 	PLT_T_U32,
10737c478bd9Sstevel@tonic-gate 	PLT_T_U44,
10747c478bd9Sstevel@tonic-gate 	PLT_T_FULL,
10757c478bd9Sstevel@tonic-gate 	PLT_T_FAR,
10767c478bd9Sstevel@tonic-gate 	PLT_T_NUM			/* Must be last */
10777c478bd9Sstevel@tonic-gate } Pltbindtype;
10787c478bd9Sstevel@tonic-gate 
10797c478bd9Sstevel@tonic-gate /*
10807c478bd9Sstevel@tonic-gate  * Prototypes.
10817c478bd9Sstevel@tonic-gate  */
108275e7992aSrie extern ulong_t		ld_entry_cnt;	/* counter bumped on each entry to */
108375e7992aSrie 					/*    ld.so.1. */
10847c478bd9Sstevel@tonic-gate extern Lm_list		lml_main;	/* main's link map list */
10857c478bd9Sstevel@tonic-gate extern Lm_list		lml_rtld;	/* rtld's link map list */
10867c478bd9Sstevel@tonic-gate extern Lm_list		*lml_list[];
10877c478bd9Sstevel@tonic-gate 
10887c478bd9Sstevel@tonic-gate extern Pltbindtype	elf_plt_write(uintptr_t, uintptr_t, void *, uintptr_t,
10897c478bd9Sstevel@tonic-gate 			    Xword);
10909aa23310Srie extern Rt_map		*is_so_loaded(Lm_list *, const char *, int *);
10919aa23310Srie extern Sym		*lookup_sym(Slookup *, Rt_map **, uint_t *, int *);
10927c478bd9Sstevel@tonic-gate extern int		rt_dldump(Rt_map *, const char *, int, Addr);
10937c478bd9Sstevel@tonic-gate 
10947c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
10957c478bd9Sstevel@tonic-gate }
10967c478bd9Sstevel@tonic-gate #endif
10977c478bd9Sstevel@tonic-gate 
10987c478bd9Sstevel@tonic-gate #endif /* _RTLD_H */
1099