xref: /illumos-gate/usr/src/cmd/sgs/include/rtld.h (revision cf74e62b28857cc7cf88dd0a34d34df9a7e26fe8)
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 2007 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 	Alist		*lm_actaudit;	/* list of pending audit activity */
283 	Lc_desc		lm_lcs[CI_MAX];	/* external libc functions */
284 };
285 
286 #ifdef	_SYSCALL32
287 struct lm_list32 {
288 	/*
289 	 * BEGIN: Exposed to rtld_db - don't move, don't delete
290 	 */
291 	Elf32_Addr	lm_head;
292 	Elf32_Addr	lm_tail;
293 	Elf32_Addr	lm_handle;
294 	Elf32_Word	lm_flags;
295 	/*
296 	 * END: Exposed to rtld_db - don't move, don't delete
297 	 */
298 	Elf32_Addr	lm_rti;
299 	Elf32_Addr	lm_fpavl;
300 	Elf32_Addr	lm_lists;
301 	Elf32_Addr	lm_environ;
302 	Elf32_Word	lm_tflags;
303 	uint_t		lm_obj;
304 	uint_t		lm_init;
305 	uint_t		lm_lazy;
306 	uint_t		lm_tls;
307 	uint_t		lm_lmid;
308 	Elf32_Addr	lm_lmidstr;
309 	Elf32_Addr	lm_actaudit;
310 	Elf32_Addr	lm_lcs[CI_MAX];
311 };
312 #endif /* _SYSCALL32 */
313 
314 /*
315  * Possible Link_map list flags (Lm_list.lm_flags)
316  */
317 /*
318  * BEGIN: Exposed to rtld_db - don't move, don't delete
319  */
320 #define	LML_FLG_BASELM		0x00000001	/* primary link-map */
321 #define	LML_FLG_RTLDLM		0x00000002	/* rtld link-map */
322 /*
323  * END: Exposed to rtld_db - don't move, don't delete
324  */
325 #define	LML_FLG_NOAUDIT		0x00000004	/* symbol auditing disabled */
326 #define	LML_FLG_PLTREL		0x00000008	/* deferred plt relocation */
327 						/* 	initialization */
328 						/*	(ld.so.1 only) */
329 #define	LML_FLG_HOLDLOCK	0x00000010	/* hold the rtld mutex lock */
330 #define	LML_FLG_ENVIRON		0x00000020	/* environ var initialized */
331 #define	LML_FLG_INTRPOSE	0x00000040	/* interposing objs on list */
332 #define	LML_FLG_LOCAUDIT	0x00000080	/* local auditors exists for */
333 						/*	this link-map list */
334 #define	LML_FLG_LOADAVAIL	0x00000100	/* load anything available */
335 #define	LML_FLG_IGNRELERR	0x00000200	/* ignore relocation errors - */
336 						/*	internal for crle(1) */
337 #define	LML_FLG_DBNOTIF		0x00000400	/* binding activity going on */
338 #define	LML_FLG_STARTREL	0x00000800	/* relocation started */
339 #define	LML_FLG_ATEXIT		0x00001000	/* atexit processing */
340 #define	LML_FLG_OBJADDED	0x00002000	/* object(s) added */
341 #define	LML_FLG_OBJDELETED	0x00004000	/* object(s) deleted */
342 #define	LML_FLG_OBJREEVAL	0x00008000	/* existing object(s) needs */
343 						/*	tsort reevaluation */
344 #define	LML_FLG_NOPENDGLBLAZY	0x00010000	/* no pending, global, lazy */
345 						/*	dependencies remain */
346 #define	LML_FLG_INTRPOSETSORT	0x00020000	/* interpose tsorting done */
347 #define	LML_FLG_AUDITNOTIFY	0x00040000	/* audit consistent required */
348 
349 #define	LML_FLG_TRC_LDDSTUB	0x00100000	/* identify lddstub */
350 #define	LML_FLG_TRC_ENABLE	0x00200000	/* tracing enabled (ldd) */
351 #define	LML_FLG_TRC_WARN	0x00400000	/* print warnings for undefs */
352 #define	LML_FLG_TRC_VERBOSE	0x00800000	/* verbose (versioning) trace */
353 #define	LML_FLG_TRC_SEARCH	0x01000000	/* trace search paths */
354 #define	LML_FLG_TRC_UNREF	0x02000000	/* trace unreferenced */
355 						/*	dependencies */
356 #define	LML_FLG_TRC_UNUSED	0x04000000	/* trace unused dependencies */
357 #define	LML_FLG_TRC_INIT	0x08000000	/* print .init order */
358 
359 #define	LML_MSK_TRC		0xfff00000	/* tracing mask */
360 
361 /*
362  * Possible Link_map transferable flags (Lm_list.lm_tflags), i.e., link-map
363  * list flags that can be propagated to any new link-map list created.
364  */
365 #define	LML_TFLG_NOLAZYLD	0x00000001	/* lazy loading disabled */
366 #define	LML_TFLG_NODIRECT	0x00000002	/* direct bindings disabled */
367 
368 #define	LML_TFLG_LOADFLTR	0x00000008	/* trigger filtee loading */
369 
370 #define	LML_TFLG_AUD_PREINIT	0x00100000	/* preinit (audit) exists */
371 #define	LML_TFLG_AUD_OBJSEARCH	0x00200000	/* objsearch (audit) exists */
372 #define	LML_TFLG_AUD_OBJOPEN	0x00400000	/* objopen (audit) exists */
373 #define	LML_TFLG_AUD_OBJFILTER	0x00800000	/* objfilter (audit) exists */
374 #define	LML_TFLG_AUD_OBJCLOSE	0x01000000	/* objclose (audit) exists */
375 #define	LML_TFLG_AUD_SYMBIND	0x02000000	/* symbind (audit) exists */
376 #define	LML_TFLG_AUD_PLTENTER	0x04000000	/* pltenter (audit) exists */
377 #define	LML_TFLG_AUD_PLTEXIT	0x08000000	/* pltexit (audit) exists */
378 #define	LML_TFLG_AUD_ACTIVITY	0x10000000	/* activity (audit) exists */
379 
380 /*
381  * NOTE: Audit flags have duplicated FLAGS1() values.  If more audit flags are
382  * added, update the FLAGS1() reservation FL1_AUD_RS_STR to FL1_AUD_RS_END
383  * defined later.
384  */
385 #define	LML_TFLG_AUD_MASK	0xfff00000	/* audit interfaces mask */
386 
387 
388 /*
389  * Information for dlopen(), dlsym(), and dlclose() on libraries linked by rtld.
390  * Each shared object referred from a dlopen call has an associated group
391  * handle structure returned that describes a group of one or more objects.
392  */
393 typedef struct {
394 	Alist		*gh_depends;	/* handle dependency list */
395 	Rt_map		*gh_ownlmp;	/* handle owners link-map */
396 	Lm_list		*gh_ownlml;	/* handle owners link-map list */
397 	uint_t		gh_refcnt;	/* handle reference count */
398 	uint_t		gh_flags;	/* handle flags */
399 } Grp_hdl;
400 
401 #define	GPH_ZERO	0x0001		/* special handle for dlopen(0) */
402 #define	GPH_LDSO	0x0002		/* special handle for ld.so.1 */
403 #define	GPH_FIRST	0x0004		/* dlsym() can only use originating */
404 					/*	dependency */
405 #define	GPH_PARENT	0x0008		/* assign caller as a parent */
406 #define	GPH_FILTEE	0x0010		/* handle used to specify a filtee */
407 #define	GPH_INITIAL	0x0020		/* handle is initialized */
408 #define	GPH_NOPENDLAZY	0x0040		/* no pending lazy dependencies */
409 					/*	remain for this handle */
410 
411 /*
412  * A group descriptor.  A group handle (Grp_hdl) refers to a group of objects,
413  * each object, and its relationship to the handle, is maintained within a
414  * group descriptor.
415  */
416 typedef struct {
417 	Rt_map *	gd_depend;	/* dependency */
418 	uint_t		gd_flags;	/* dependency flags */
419 } Grp_desc;
420 
421 #define	GPD_DLSYM	0x0001		/* dependency available to dlsym() */
422 #define	GPD_RELOC	0x0002		/* dependency available to satisfy */
423 					/*	relocation binding */
424 #define	GPD_ADDEPS	0x0004		/* dependencies of this dependency */
425 					/*	should be added to handle */
426 #define	GPD_PARENT	0x0008		/* dependency is a parent */
427 #define	GPD_FILTER	0x0010		/* dependency is our filter */
428 #define	GPD_REMOVE	0x1000		/* descriptor is a candidate for */
429 					/*	removal from the group */
430 
431 /*
432  * Define threading structures.  For compatibility with libthread (T1_VERSION 1
433  * and TI_VERSION 2) our locking structure is sufficient to hold a mutex or a
434  * readers/writers lock.
435  */
436 typedef struct {
437 	union {
438 		mutex_t		l_mutex;
439 		rwlock_t	l_rwlock;
440 	} u;
441 } Rt_lock;
442 
443 typedef	cond_t	Rt_cond;
444 
445 /*
446  * Define a dynamic section information descriptor.  This parallels the entries
447  * in the .dynamic section and holds auxiliary information to implement lazy
448  * loading and filtee processing.
449  */
450 typedef struct {
451 	uint_t	di_flags;
452 	void	*di_info;
453 } Dyninfo;
454 
455 #define	FLG_DI_STDFLTR	0x00001		/* .dynamic entry for DT_FILTER */
456 #define	FLG_DI_AUXFLTR	0x00002		/* .dynamic entry for DT_AUXILIARY */
457 #define	FLG_DI_SYMFLTR	0x00004		/* .dynamic entry for DT_SYMFILTER */
458 					/*	and DT_SYMAUXILIARY */
459 #define	MSK_DI_FILTER	0x0000f		/* mask for all filter possibilities */
460 
461 #define	FLG_DI_NEEDED	0x00010		/* entry represents a dependency */
462 #define	FLG_DI_GROUP	0x00020		/* open dependency as a group */
463 #define	FLG_DI_PROCESSD	0x00040		/* entry has been processed */
464 
465 /*
466  * Data Structure to track AVL tree for pathnames of objects
467  * loaded into memory
468  */
469 typedef struct {
470 	const char	*fpn_name;	/* object name */
471 	Rt_map		*fpn_lmp;	/* object link-map */
472 	avl_node_t	fpn_avl;	/* avl book-keeping (see SGSOFFSETOF) */
473 	uint_t		fpn_hash;	/* object name hash value */
474 } FullpathNode;
475 
476 /*
477  * Define a mapping structure, which is maintained to describe each mapping
478  * of an object, ie. the text segment, data segment, bss segment, etc.
479  */
480 typedef struct {
481 	caddr_t		m_vaddr;	/* mapping address */
482 	size_t		m_fsize;	/* backing file size */
483 	size_t		m_msize;	/* mapping size */
484 	int		m_perm;		/* mapping permissions */
485 } Mmap;
486 
487 /*
488  * Link-map definition.
489  */
490 struct rt_map {
491 	/*
492 	 * BEGIN: Exposed to rtld_db - don't move, don't delete
493 	 */
494 	Link_map	rt_public;	/* public data */
495 	char		*rt_pathname;	/* full pathname of loaded object */
496 	ulong_t		rt_padstart;	/* start of image (including padding) */
497 	ulong_t		rt_padimlen;	/* size of image (including padding */
498 	ulong_t		rt_msize;	/* total memory mapped */
499 	uint_t		rt_flags;	/* state flags, see FLG below */
500 	uint_t		rt_flags1;	/* state flags1, see FL1 below */
501 	ulong_t		rt_tlsmodid;	/* TLS module id */
502 	/*
503 	 * END: Exposed to rtld_db - don't move, don't delete
504 	 */
505 	Alist		*rt_alias;	/* list of linked file names */
506 	Alist		*rt_fpnode;	/* list of FullpathNode AVL nodes */
507 	void		(*rt_init)();	/* address of _init */
508 	void		(*rt_fini)();	/* address of _fini */
509 	char		*rt_runpath;	/* LD_RUN_PATH and its equivalent */
510 	Pnode		*rt_runlist;	/*	Pnode structures */
511 	Alist		*rt_depends;	/* list of dependencies */
512 	Alist		*rt_callers;	/* list of callers */
513 	Alist		*rt_handles;	/* dlopen handles */
514 	Alist		*rt_groups;	/* groups we're a member of */
515 	ulong_t		rt_etext;	/* etext address */
516 	struct fct	*rt_fct;	/* file class table for this object */
517 	Sym		*(*rt_symintp)(); /* link map symbol interpreter */
518 	void		*rt_priv;	/* private data, object type specific */
519 	Lm_list		*rt_list;	/* link map list we belong to */
520 	uint_t		rt_objfltrndx;	/* object filtees .dynamic index */
521 	uint_t		rt_symsfltrcnt;	/* number of standard symbol filtees */
522 	uint_t		rt_symafltrcnt;	/* number of auxiliary symbol filtees */
523 	int		rt_mode;	/* usage mode, see RTLD mode flags */
524 	int		rt_sortval;	/* temporary buffer to traverse graph */
525 	uint_t		rt_cycgroup;	/* cyclic group */
526 	dev_t		rt_stdev;	/* device id and inode number for .so */
527 	ino_t		rt_stino;	/*	multiple inclusion checks */
528 	char		*rt_origname;	/* original pathname of loaded object */
529 	size_t		rt_dirsz;	/*	and its size */
530 	Alist		*rt_copy;	/* list of copy relocations */
531 	Audit_desc	*rt_auditors;	/* audit descriptor array */
532 	Audit_info	*rt_audinfo;	/* audit information descriptor */
533 	Syminfo		*rt_syminfo;	/* elf .syminfo section - here */
534 					/*	because it is checked in */
535 					/*	common code */
536 	Addr		*rt_initarray;	/* .initarray table */
537 	Addr		*rt_finiarray;	/* .finiarray table */
538 	Addr		*rt_preinitarray; /* .preinitarray table */
539 	Mmap		*rt_mmaps;	/* array of mapping information */
540 	uint_t		rt_mmapcnt;	/*	and associated number */
541 	uint_t		rt_initarraysz;	/* size of .initarray table */
542 	uint_t		rt_finiarraysz;	/* size of .finiarray table */
543 	uint_t		rt_preinitarraysz; /* size of .preinitarray table */
544 	Dyninfo		*rt_dyninfo;	/* .dynamic information descriptors */
545 	uint_t		rt_dyninfocnt;	/* count of dyninfo entries */
546 	uint_t		rt_relacount;	/* no. of RELATIVE relocations */
547 	uint_t		rt_idx;		/* hold index within linkmap list */
548 	uint_t		rt_lazy;	/* lazy dependencies pending */
549 	Rt_cond		*rt_condvar;	/*	variables */
550 	Xword		rt_hwcap;	/* hardware capabilities */
551 	Xword		rt_sfcap;	/* software capabilities */
552 	thread_t	rt_threadid;	/* thread init/fini synchronization */
553 	uint_t		rt_cntl;	/* link-map control list we belong to */
554 };
555 
556 
557 #ifdef _SYSCALL32
558 /*
559  * Structure to allow 64-bit rtld_db to read 32-bit processes out of procfs.
560  */
561 typedef struct rt_map32 {
562 	/*
563 	 * BEGIN: Exposed to rtld_db - don't move, don't delete
564 	 */
565 	Link_map32	rt_public;
566 	uint32_t	rt_pathname;
567 	uint32_t	rt_padstart;
568 	uint32_t	rt_padimlen;
569 	uint32_t	rt_msize;
570 	uint32_t	rt_flags;
571 	uint32_t	rt_flags1;
572 	uint32_t	rt_tlsmodid;
573 	/*
574 	 * END: Exposed to rtld_db - don't move, don't delete
575 	 */
576 	uint32_t	rt_alias;
577 	uint32_t	rt_fpnode;
578 	uint32_t 	rt_init;
579 	uint32_t	rt_fini;
580 	uint32_t	rt_runpath;
581 	uint32_t	rt_runlist;
582 	uint32_t	rt_depends;
583 	uint32_t	rt_callers;
584 	uint32_t	rt_handles;
585 	uint32_t	rt_groups;
586 	uint32_t	rt_etext;
587 	uint32_t	rt_fct;
588 	uint32_t	rt_symintp;
589 	uint32_t	rt_priv;
590 	uint32_t 	rt_list;
591 	uint32_t 	rt_objfltrndx;
592 	uint32_t 	rt_symsfltrcnt;
593 	uint32_t 	rt_symafltrcnt;
594 	int32_t		rt_mode;
595 	int32_t		rt_sortval;
596 	uint32_t	rt_cycgroup;
597 	uint32_t	rt_stdev;
598 	uint32_t	rt_stino;
599 	uint32_t	rt_origname;
600 	uint32_t	rt_dirsz;
601 	uint32_t	rt_copy;
602 	uint32_t 	rt_auditors;
603 	uint32_t 	rt_audinfo;
604 	uint32_t	rt_syminfo;
605 	uint32_t	rt_initarray;
606 	uint32_t	rt_finiarray;
607 	uint32_t	rt_preinitarray;
608 	uint32_t	rt_mmaps;
609 	uint32_t	rt_mmapcnt;
610 	uint32_t	rt_initarraysz;
611 	uint32_t	rt_finiarraysz;
612 	uint32_t	rt_preinitarraysz;
613 	uint32_t 	rt_dyninfo;
614 	uint32_t 	rt_dyninfocnt;
615 	uint32_t	rt_relacount;
616 	uint32_t	rt_idx;
617 	uint32_t	rt_lazy;
618 	uint32_t	rt_condvar;
619 	uint32_t	rt_hwcap;
620 	uint32_t	rt_sfcap;
621 	uint32_t	rt_threadid;
622 	uint32_t	rt_cntl;
623 } Rt_map32;
624 
625 #endif	/* _SYSCALL32 */
626 
627 /*
628  * Link map state flags.
629  */
630 /*
631  * BEGIN: Exposed to rtld_db - don't move, don't delete
632  */
633 #define	FLG_RT_ISMAIN	0x00000001	/* object represents main executable */
634 #define	FLG_RT_IMGALLOC	0x00000002	/* image is allocated (not mmap'ed) */
635 	/*
636 	 * Available for r_debug version >= RTLD_DB_VERSION5
637 	 */
638 #define	FLG_RT_RELOCED	0x00000004	/* object has been relocated */
639 /*
640  * END: Exposed to rtld_db - don't move, don't delete
641  */
642 #define	FLG_RT_SETGROUP	0x00000008	/* group establishment required */
643 #define	FLG_RT_HWCAP	0x00000010	/* process $HWCAP expansion */
644 #define	FLG_RT_OBJECT	0x00000020	/* object processing (ie. .o's) */
645 #define	FLG_RT_NEWLOAD	0x00000040	/* object is newly loaded */
646 #define	FLG_RT_NODUMP	0x00000080	/* object can't be dldump(3x)'ed */
647 #define	FLG_RT_DELETE	0x00000100	/* object can be deleted */
648 #define	FLG_RT_ANALYZED	0x00000200	/* object has been analyzed */
649 #define	FLG_RT_INITDONE	0x00000400	/* objects .init has been completed */
650 #define	FLG_RT_TRANS	0x00000800	/* object is acting as a translator */
651 #define	FLG_RT_FIXED	0x00001000	/* image location is fixed */
652 #define	FLG_RT_PRELOAD	0x00002000	/* object was preloaded */
653 #define	FLG_RT_ALTER	0x00004000	/* alternative object used */
654 #define	FLG_RT_LOADFLTR	0x00008000	/* trigger filtee loading */
655 #define	FLG_RT_AUDIT	0x00010000	/* object is an auditor */
656 #define	FLG_RT_MODESET	0x00020000	/* MODE() has been initialized */
657 #define	FLG_RT_ANALZING	0x00040000	/* object is being analyzed */
658 #define	FLG_RT_INITFRST 0x00080000	/* execute .init first */
659 #define	FLG_RT_NOOPEN	0x00100000	/* dlopen() not allowed */
660 #define	FLG_RT_FINICLCT	0x00200000	/* fini has been collected (tsort) */
661 #define	FLG_RT_INITCALL	0x00400000	/* objects .init has been called */
662 #define	FLG_RT_SUNWBSS	0x00800000	/* object with PT_SUNWBSS, not mapped */
663 #define	FLG_RT_OBJINTPO	0x01000000	/* object is a global interposer */
664 #define	FLG_RT_SYMINTPO	0x02000000	/* object contains symbol interposer */
665 #define	MSK_RT_INTPOSE	0x03000000	/* mask for all interposer */
666 					/*	possibilities */
667 #define	FLG_RT_MOVE	0x04000000	/* object needs move operation */
668 #define	FLG_RT_DLSYM	0x08000000	/* dlsym in progress on object */
669 #define	FLG_RT_REGSYMS	0x10000000	/* object has DT_REGISTER entries */
670 #define	FLG_RT_INITCLCT	0x20000000	/* init has been collected (tsort) */
671 #define	FLG_RT_HANDLE	0x40000000	/* generate a handle for this object */
672 #define	FLG_RT_RELOCING	0x80000000	/* object is being relocated */
673 
674 #define	FL1_RT_COPYTOOK	0x00000001	/* copy relocation taken */
675 #define	FL1_RT_RELATIVE	0x00000002	/* relative path expansion required */
676 #define	FL1_RT_CONFSET	0x00000004	/* object was loaded by crle(1) */
677 #define	FL1_RT_NODEFLIB	0x00000008	/* ignore default library search */
678 #define	FL1_RT_ENDFILTE	0x00000010	/* filtee terminates filters search */
679 #define	FL1_RT_DISPREL	0x00000020	/* object has *disp* relocation */
680 #define	FL1_RT_TEXTREL	0x00000040	/* DT_TEXTREL set in object */
681 #define	FL1_RT_INITWAIT	0x00000080	/* threads are waiting on .init */
682 #define	FL1_RT_LDDSTUB	0x00000100	/* identify lddstub */
683 #define	FL1_RT_NOINIFIN	0x00000200	/* no .init or .fini exists */
684 #define	FL1_RT_USED	0x00000400	/* symbol referenced from this object */
685 #define	FL1_RT_SYMBOLIC	0x00000800	/* DF_SYMBOLIC was set - use */
686 					/*	symbolic sym resolution */
687 #define	FL1_RT_OBJSFLTR	0x00001000	/* object is acting as a standard */
688 #define	FL1_RT_OBJAFLTR	0x00002000	/*	or auxiliary filter */
689 #define	FL1_RT_SYMSFLTR	0x00004000	/* symbol is acting as a standard */
690 #define	FL1_RT_SYMAFLTR	0x00008000	/*	or auxiliary filter */
691 #define	MSK_RT_FILTER	0x0000f000	/* mask for all filter possibilites */
692 
693 #define	FL1_RT_TLSADD	0x00010000	/* objects TLS has been registered */
694 #define	FL1_RT_TLSSTAT	0x00020000	/* object requires static TLS */
695 #define	FL1_RT_DIRECT	0x00040000	/* object has DIRECT bindings enabled */
696 #define	FL1_RT_GLOBAUD	0x00080000	/* establish global auditing */
697 
698 /*
699  * The following range of bits are reserved to hold LML_TFLG_AUD_ values
700  * (although the definitions themselves aren't used anywhere).
701  */
702 #define	FL1_AUD_RS_STR	0x00100000	/* RESERVATION start for AU flags */
703 #define	FL1_AUD_RS_END	0x80000000	/* RESERVATION end for AU flags */
704 
705 
706 /*
707  * Flags for the tls_modactivity() routine
708  */
709 #define	TM_FLG_MODADD	0x01		/* call tls_modadd() interface */
710 #define	TM_FLG_MODREM	0x02		/* call tls_modrem() interface */
711 
712 /*
713  * Macros for getting to link_map data.
714  */
715 #define	ADDR(X)		((X)->rt_public.l_addr)
716 #define	NAME(X)		((X)->rt_public.l_name)
717 #define	DYN(X)		((X)->rt_public.l_ld)
718 #define	NEXT(X)		((X)->rt_public.l_next)
719 #define	PREV(X)		((X)->rt_public.l_prev)
720 #define	REFNAME(X)	((X)->rt_public.l_refname)
721 
722 /*
723  * Macros for getting to linker private data.
724  */
725 #define	PATHNAME(X)	((X)->rt_pathname)
726 #define	PADSTART(X)	((X)->rt_padstart)
727 #define	PADIMLEN(X)	((X)->rt_padimlen)
728 #define	MSIZE(X)	((X)->rt_msize)
729 #define	FLAGS(X)	((X)->rt_flags)
730 #define	FLAGS1(X)	((X)->rt_flags1)
731 #define	TLSMODID(X)	((X)->rt_tlsmodid)
732 
733 #define	ALIAS(X)	((X)->rt_alias)
734 #define	FPNODE(X)	((X)->rt_fpnode)
735 #define	INIT(X)		((X)->rt_init)
736 #define	FINI(X)		((X)->rt_fini)
737 #define	RPATH(X)	((X)->rt_runpath)
738 #define	RLIST(X)	((X)->rt_runlist)
739 #define	DEPENDS(X)	((X)->rt_depends)
740 #define	CALLERS(X)	((X)->rt_callers)
741 #define	HANDLES(X)	((X)->rt_handles)
742 #define	GROUPS(X)	((X)->rt_groups)
743 #define	ETEXT(X)	((X)->rt_etext)
744 #define	FCT(X)		((X)->rt_fct)
745 #define	SYMINTP(X)	((X)->rt_symintp)
746 #define	LIST(X)		((X)->rt_list)
747 #define	OBJFLTRNDX(X)	((X)->rt_objfltrndx)
748 #define	SYMSFLTRCNT(X)	((X)->rt_symsfltrcnt)
749 #define	SYMAFLTRCNT(X)	((X)->rt_symafltrcnt)
750 #define	MODE(X)		((X)->rt_mode)
751 #define	SORTVAL(X)	((X)->rt_sortval)
752 #define	CYCGROUP(X)	((X)->rt_cycgroup)
753 #define	STDEV(X)	((X)->rt_stdev)
754 #define	STINO(X)	((X)->rt_stino)
755 #define	ORIGNAME(X)	((X)->rt_origname)
756 #define	DIRSZ(X)	((X)->rt_dirsz)
757 #define	COPY(X)		((X)->rt_copy)
758 #define	AUDITORS(X)	((X)->rt_auditors)
759 #define	AUDINFO(X)	((X)->rt_audinfo)
760 #define	SYMINFO(X)	((X)->rt_syminfo)
761 #define	INITARRAY(X)	((X)->rt_initarray)
762 #define	FINIARRAY(X)	((X)->rt_finiarray)
763 #define	PREINITARRAY(X)	((X)->rt_preinitarray)
764 #define	MMAPS(X)	((X)->rt_mmaps)
765 #define	MMAPCNT(X)	((X)->rt_mmapcnt)
766 #define	INITARRAYSZ(X)	((X)->rt_initarraysz)
767 #define	FINIARRAYSZ(X)	((X)->rt_finiarraysz)
768 #define	PREINITARRAYSZ(X) ((X)->rt_preinitarraysz)
769 #define	DYNINFO(X)	((X)->rt_dyninfo)
770 #define	DYNINFOCNT(X)	((X)->rt_dyninfocnt)
771 #define	RELACOUNT(X)	((X)->rt_relacount)
772 #define	IDX(X)		((X)->rt_idx)
773 #define	LAZY(X)		((X)->rt_lazy)
774 #define	CONDVAR(X)	((X)->rt_condvar)
775 #define	CNTL(X)		((X)->rt_cntl)
776 #define	HWCAP(X)	((X)->rt_hwcap)
777 #define	SFCAP(X)	((X)->rt_sfcap)
778 #define	THREADID(X)	((X)->rt_threadid)
779 
780 /*
781  * Flags for tsorting.
782  */
783 #define	RT_SORT_FWD	0x01		/* topological sort (.fini) */
784 #define	RT_SORT_REV	0x02		/* reverse topological sort (.init) */
785 #define	RT_SORT_DELETE	0x10		/* process FLG_RT_DELNEED objects */
786 					/*	only (called via dlclose()) */
787 #define	RT_SORT_INTPOSE	0x20		/* process interposer objects */
788 
789 /*
790  * Flags for lookup_sym (and hence find_sym) routines.
791  */
792 #define	LKUP_DEFT	0x0000		/* simple lookup request */
793 #define	LKUP_SPEC	0x0001		/* special ELF lookup (allows address */
794 					/*	resolutions to plt[] entries) */
795 #define	LKUP_LDOT	0x0002		/* indicates the original A_OUT */
796 					/*	symbol had a leading `.' */
797 #define	LKUP_FIRST	0x0004		/* lookup symbol in first link map */
798 					/*	only */
799 #define	LKUP_COPY	0x0008		/* lookup symbol for a COPY reloc, do */
800 					/*	not bind to symbol at head */
801 #define	LKUP_ALLCNTLIST	0x0010		/* lookup symbol in all control lists */
802 #define	LKUP_SELF	0x0020		/* lookup symbol in ourself - undef */
803 					/*	is valid */
804 #define	LKUP_WEAK	0x0040		/* relocation reference is weak */
805 #define	LKUP_NEXT	0x0080		/* request originates from RTLD_NEXT */
806 #define	LKUP_NODESCENT	0x0100		/* don't descend through dependencies */
807 #define	LKUP_NOFALBACK	0x0200		/* don't fall back to loading */
808 					/*	pending lazy dependencies */
809 #define	LKUP_DIRECT	0x0400		/* direct binding request */
810 #define	LKUP_SYMNDX	0x0800		/* establish symbol index */
811 
812 /*
813  * Data structure for calling lookup_sym()
814  */
815 typedef struct {
816 	const char	*sl_name;	/* symbol name */
817 	Rt_map		*sl_cmap;	/* callers link-map */
818 	Rt_map		*sl_imap;	/* initial link-map to search */
819 	ulong_t		sl_hash;	/* symbol hash value */
820 	ulong_t		sl_rsymndx;	/* referencing reloc symndx */
821 	uint_t		sl_flags;	/* lookup flags */
822 } Slookup;
823 
824 
825 typedef	enum {
826 	PLT_T_NONE = 0,
827 	PLT_T_21D,
828 	PLT_T_24D,
829 	PLT_T_U32,
830 	PLT_T_U44,
831 	PLT_T_FULL,
832 	PLT_T_FAR,
833 	PLT_T_NUM			/* Must be last */
834 } Pltbindtype;
835 
836 /*
837  * Prototypes.
838  */
839 extern Lm_list		lml_main;	/* main's link map list */
840 extern Lm_list		lml_rtld;	/* rtld's link map list */
841 extern Lm_list		*lml_list[];
842 
843 extern Pltbindtype	elf_plt_write(uintptr_t, uintptr_t, void *, uintptr_t,
844 			    Xword);
845 extern Rt_map		*is_so_loaded(Lm_list *, const char *);
846 extern Sym		*lookup_sym(Slookup *, Rt_map **, uint_t *);
847 extern int		rt_dldump(Rt_map *, const char *, int, Addr);
848 
849 #ifdef	__cplusplus
850 }
851 #endif
852 
853 #endif /* _RTLD_H */
854