xref: /titanic_41/usr/src/cmd/sgs/rtld/common/_rtld.h (revision 5a7797ce9bcfe70ce0ab366abc3051dce3cede6f)
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 (c) 1988 AT&T
24  *	  All Rights Reserved
25  *
26  * Copyright (c) 1990, 2010, Oracle and/or its affiliates. All rights reserved.
27  */
28 #ifndef	__RTLD_H
29 #define	__RTLD_H
30 
31 /*
32  * Common header for run-time linker.
33  */
34 #include <sys/types.h>
35 #include <sys/stat.h>
36 #include <sys/avl.h>
37 #include <sys/mman.h>
38 #include <stdarg.h>
39 #include <synch.h>
40 #include <signal.h>
41 #include <errno.h>
42 #include <unistd.h>
43 #include <link.h>
44 #include <rtld.h>
45 #include <sgs.h>
46 #include <machdep.h>
47 #include <rtc.h>
48 #include <debug.h>
49 #include <msg.h>
50 #include <libc_int.h>
51 
52 #ifdef	__cplusplus
53 extern "C" {
54 #endif
55 
56 /*
57  * Dependency search rule order.
58  */
59 #define	RPLENV		1		/* replaceable LD_LIBRARY_PATH */
60 #define	PRMENV		2		/* permanent LD_LIBRARY_PATH */
61 #define	RUNPATH		3		/* callers runpath */
62 #define	DEFAULT		4		/* default library path */
63 
64 typedef struct fdesc	Fdesc;
65 typedef struct fct	Fct;
66 typedef	struct pdesc	Pdesc;
67 
68 /*
69  * Data structure for file class specific functions and data.
70  */
71 struct fct {
72 	/* Verify that the object is of this class. */
73 	Fct	*(*fct_verify_file)(caddr_t, size_t, Fdesc *, const char *,
74 	    Rej_desc *);
75 
76 	/* Generate a link-map to describe the loaded object. */
77 	Rt_map	*(*fct_new_lmp)(Lm_list *, Aliste, Fdesc *, Addr, size_t,
78 	    void *, Rt_map *, int *);
79 
80 	/* Retrieve the entry point of the object. */
81 	Addr	(*fct_entry_pt)(void);
82 
83 	/* Determine the objects dependencies (needed entries). */
84 	int	(*fct_needed)(Lm_list *, Aliste, Rt_map *, int *);
85 
86 	/* Look up a symbol for the object. */
87 	int	(*fct_lookup_sym)(Slookup *, Sresult *, uint_t *, int *);
88 
89 	/* Relocate the object. */
90 	int	(*fct_reloc)(Rt_map *, uint_t, int *, APlist **);
91 
92 	/* List of default directories to search for dependencies. */
93 	Alist	**(*fct_get_def_dirs)(void);
94 
95 	/* List of secure directories to search for dependencies. */
96 	Alist	**(*fct_get_sec_dirs)(void);
97 
98 	/* Transpose the name of the object. */
99 	int	(*fct_fix_name)(const char *, Rt_map *, Alist **, Aliste,
100 	    uint_t);
101 
102 	/* Get a shared object name */
103 	char	*(*fct_get_so)(const char *, const char *, size_t, size_t);
104 
105 	/* Retrieve a symbolic address from the object. */
106 	void	(*fct_dladdr)(ulong_t, Rt_map *, Dl_info *, void **, int);
107 
108 	/* Process a dlsym(3c) request within the object. */
109 	int	(*fct_dlsym)(Grp_hdl *, Slookup *, Sresult *, uint_t *, int *);
110 };
111 
112 /*
113  * Macros for getting to the file class table.
114  */
115 #define	LM_ENTRY_PT(X)		((X)->rt_fct->fct_entry_pt)
116 #define	LM_NEEDED(X)		((X)->rt_fct->fct_needed)
117 #define	LM_LOOKUP_SYM(X)	((X)->rt_fct->fct_lookup_sym)
118 #define	LM_RELOC(X)		((X)->rt_fct->fct_reloc)
119 #define	LM_DEFAULT_DIRS(X)	((X)->rt_fct->fct_get_def_dirs)
120 #define	LM_SECURE_DIRS(X)	((X)->rt_fct->fct_get_sec_dirs)
121 #define	LM_FIX_NAME(X)		((X)->rt_fct->fct_fix_name)
122 #define	LM_GET_SO(X)		((X)->rt_fct->fct_get_so)
123 #define	LM_DLADDR(X)		((X)->rt_fct->fct_dladdr)
124 #define	LM_DLSYM(X)		((X)->rt_fct->fct_dlsym)
125 
126 /*
127  * Initial memory map allocation.  Typical ELF objects contain a text and data
128  * segment, which can be augmented with a bss mapping.  Add a bunch more for
129  * luck.
130  */
131 #define	MMAPFD_NUM	10
132 
133 /*
134  * Define Alist initialization counts.
135  */
136 #define	AL_CNT_ALIAS	2		/* ALIAS() */
137 #define	AL_CNT_DEPENDS	20		/* DEPENDS() */
138 #define	AL_CNT_CALLERS	20		/* CALLERS() */
139 #define	AL_CNT_GROUPS	20		/* GROUPS() */
140 #define	AL_CNT_COPYREL	10		/* COPY() */
141 #define	AL_CNT_LAZYFIND	10		/* elf_lazy_find_sym() */
142 #define	AL_CNT_GRPCLCT	10		/* gdp_collect() */
143 #define	AL_CNT_DEPCLCT	10		/* load_finish() */
144 #define	AL_CNT_RTLDINFO	1		/* RTLDINFO() */
145 #define	AL_CNT_FPNODE	4		/* FPNODE() */
146 #define	AL_CNT_LMLISTS	20		/* lm_lists */
147 #define	AL_CNT_LMNOW	8		/* lm_now */
148 #define	AL_CNT_RELBIND	20		/* relocation binding */
149 #define	AL_CNT_ACTAUDIT	2		/* lm_actaudit */
150 #define	AL_CNT_MOVES	10		/* move_data */
151 #define	AL_CNT_MPOBJS	4		/* elf_obj_file() */
152 #define	AL_CNT_TEXTREL	2		/* text relocation segment */
153 #define	AL_CNT_NEEDED	1		/* dependency path */
154 #define	AL_CNT_SEARCH	4		/* search path */
155 #define	AL_CNT_FILTEES	2		/* filtee path */
156 #define	AL_CNT_HANDLES	1		/* hdl_list[] */
157 #define	AL_CNT_FREELIST	80		/* free_alp */
158 #define	AL_CNT_CAP	10		/* capabilities candidate */
159 #define	AL_CNT_SPATH	4		/* search path */
160 #define	AL_CNT_DYNLIST	2		/* dynlm_list */
161 #define	AL_CNT_PENDING	2		/* pending tsort list (INITFIRST) */
162 #define	AL_CNT_PLTPAD	10		/* plt padding */
163 #define	AL_CNT_AUDITORS	2		/* auditing list */
164 #define	AL_CNT_ENVIRON	20		/* environment list (enough for ldd) */
165 #define	AL_CNT_COOKIES	2		/* head link-map list cookies */
166 
167 /*
168  * Size of buffer for building error messages.
169  */
170 #define	ERRSIZE		2048		/* MAXPATHLEN * 2 */
171 
172 /*
173  * Configuration file information.
174  */
175 typedef struct config {
176 	const char	*c_name;
177 	Addr		c_bgn;
178 	Addr		c_end;
179 	Word		*c_hashtbl;
180 	Word		*c_hashchain;
181 	const char	*c_strtbl;
182 	Rtc_obj		*c_objtbl;
183 	Rtc_fltr	*c_fltr;
184 	Rtc_flte	*c_flte;
185 } Config;
186 
187 /*
188  * Register symbol list.
189  */
190 typedef struct reglist {
191 	Rt_map		*rl_lmp;	/* defining object */
192 	Sym		*rl_sym;	/* regsym */
193 	struct reglist	*rl_next;	/* next entry */
194 } Reglist;
195 
196 /*
197  * Data structure to hold interpreter information.
198  */
199 typedef struct interp {
200 	char		*i_name;	/* interpreter name */
201 	caddr_t		i_faddr;	/* address interpreter is mapped at */
202 } Interp;
203 
204 /*
205  * Data structure used to keep track of copy relocations.  These relocations
206  * are collected during initial relocation processing and maintained on the
207  * COPY(lmp) list of the defining object.  Each copy list is also added to the
208  * COPY(lmp) of the head object (normally the application dynamic executable)
209  * from which they will be processed after all relocations are done.
210  *
211  * The use of RTLD_GROUP will also reference individual objects COPY(lmp) lists
212  * in case a bound symbol must be assigned to it actual copy relocation.
213  */
214 typedef struct {
215 	const char	*r_name;	/* symbol name */
216 	Sym		*r_rsym;	/* reference symbol table entry */
217 	Rt_map		*r_rlmp;	/* reference link map */
218 	Rt_map		*r_dlmp;	/* definition link map */
219 	Sym		*r_dsym;	/* definition symbol table entry */
220 	void		*r_radd;	/* copy to address */
221 	const void	*r_dadd;	/* copy from address */
222 	ulong_t		r_size;		/* copy size bytes */
223 } Rel_copy;
224 
225 /*
226  * Define a file descriptor, which maintains information regarding a pathname
227  * that has been opened and minimally inspected.
228  */
229 struct fdesc {
230 	Rt_map		*fd_lmp;	/* existing link-map pointer */
231 	Lm_list		*fd_lml;	/* callers link-map list */
232 	Fct		*fd_ftp;	/* file functions pointer */
233 	const char	*fd_oname;	/* original file name */
234 	const char	*fd_odir;	/* original directory name */
235 	const char	*fd_nname;	/* new file (expanded) name */
236 	const char	*fd_pname;	/* new path (resolved) name */
237 	dev_t		fd_dev;		/* file device number */
238 	rtld_ino_t	fd_ino;		/* file inode number */
239 	avl_index_t	fd_avlwhere;	/* avl tree insertion index */
240 	Syscapset	fd_scapset;	/* capabilities */
241 	mmapobj_result_t *fd_mapp;	/* mapping pointer */
242 	uint_t		fd_mapn;	/* mapping number */
243 	uint_t		fd_flags;
244 };
245 
246 #define	FLG_FD_ALTER	0x0001		/* file is an alternate */
247 #define	FLG_FD_SLASH	0x0002		/* file contains a "/" */
248 #define	FLG_FD_RESOLVED	0x0004		/* fd_nname has been resolved */
249 #define	FLG_FD_ALTCHECK	0x0008		/* alternative system capabilities */
250 					/*	checked */
251 #define	FLG_FD_ALTCAP	0x0010		/* alternative system capabilities */
252 					/*	should be used */
253 #define	FLG_FD_IGNORE	0x0020		/* descriptor should be ignored */
254 
255 /*
256  * File descriptor availability flag.
257  */
258 #define	FD_UNAVAIL	-1
259 
260 /*
261  * Disabled filter flag.  Filter objects are referenced using their .dynamic
262  * index (DT_FILTER or DT_AUXILIARY).  This index is saved and used to lookup
263  * the required filter.  Note that 0 is a valid .dynamic index.  The caller's
264  * OBJFLTRNDX() element is initialized using the following flag, and should
265  * the filter's initialization fail, is reset to this value to indicate the
266  * filter is disabled.  UINT_MAX provides a convenient invalid .dynamic index.
267  */
268 #define	FLTR_DISABLED	UINT_MAX
269 
270 /*
271  * Status flags for rtld_flags
272  */
273 #define	RT_FL_THREADS	0x00000001	/* threads are enabled */
274 #define	RT_FL_WARNFLTR	0x00000002	/* warn of missing filtees (ldd) */
275 #define	RT_FL_DBNOTIF	0x00000004	/* binding activity going on */
276 #define	RT_FL_DEFERRED	0x00000008	/* load deferred dependencies (ldd) */
277 #define	RT_FL_NOBIND	0x00000010	/* don't carry out plt binding */
278 #define	RT_FL_NOVERSION	0x00000020	/* disable version checking */
279 #define	RT_FL_SECURE	0x00000040	/* setuid/segid flag */
280 #define	RT_FL_APPLIC	0x00000080	/* executing application code */
281 #define	RT_FL_NOENVIRON	0x00000100	/* don't process environment */
282 					/*	variables (ld.so.1 -e) */
283 #define	RT_FL_CONFGEN	0x00000200	/* don't relocate initiating object */
284 					/*	set by crle(1) */
285 #define	RT_FL_CONFAPP	0x00000400	/* application specific configuration */
286 					/*	cache required */
287 #define	RT_FL_DEBUGGER	0x00000800	/* a debugger is monitoring us */
288 #define	RT_FL_OPERATION	0x00001000	/* start recording operations */
289 #define	RT_FL_NEWLOCALE	0x00002000	/* message locale has changed */
290 #define	RT_FL_NOBAPLT	0x00004000	/* sparc: don't use ba plt's */
291 #define	RT_FL_NOAUXFLTR	0x00008000	/* disable auxiliary filters */
292 
293 #define	RT_FL_NOAUDIT	0x00020000	/* disable auditing */
294 #define	RT_FL_ATEXIT	0x00040000	/* we're shutting down */
295 #define	RT_FL_SILENCERR	0x00080000	/* silence error messages */
296 
297 #define	RT_FL_INITFIRST	0x00200000	/* processing a DT_INITFIRST object */
298 
299 #define	RT_FL_DEMANGLE	0x01000000	/* demangle C++ symbol names */
300 #define	RT_FL_NOCFG	0x02000000	/* disable config file use */
301 #define	RT_FL_NODIRCFG	0x04000000	/* disable directory config use */
302 #define	RT_FL_NOOBJALT	0x08000000	/* disable object alternative use */
303 #define	RT_FL_NOENVCFG	0x10000000	/* disable config envars use */
304 #define	RT_FL_DIRCFG	0x20000000	/* directory config info available */
305 #define	RT_FL_OBJALT	0x40000000	/* object alternatives are available */
306 #define	RT_FL_MEMRESV	0x80000000	/* memory reservation established */
307 
308 /*
309  * Status flags for rtld_flags2
310  */
311 #define	RT_FL2_HASAUDIT	0x00000001	/* auditing lm_list is present */
312 #define	RT_FL2_RTLDSEEN	0x00000002	/* rtldinfo has been set */
313 #define	RT_FL2_UNIFPROC	0x00000004	/* libc/libthread unified environment */
314 
315 #define	RT_FL2_NOFLTCFG	0x00000010	/* disable config filter use */
316 #define	RT_FL2_FLTCFG	0x00000020	/* filter config info available */
317 #define	RT_FL2_HWCAP	0x00000040	/* hardware capabilities available */
318 #define	RT_FL2_FTL2WARN	0x00000080	/* convert fatal to warning messages */
319 #define	RT_FL2_BINDNOW	0x00000100	/* LD_BIND_NOW in effect */
320 #define	RT_FL2_BINDLAZY	0x00000200	/* disable RTLD_NOW (and LD_BIND_NOW) */
321 #define	RT_FL2_PLMSETUP	0x00000400	/* primary link-map set up complete */
322 #define	RT_FL2_BRANDED	0x00000800	/* process is branded */
323 #define	RT_FL2_NOPLM	0x00001000	/* process has no primary link map */
324 #define	RT_FL2_SETUID	0x00002000	/* ld.so.1 is setuid root */
325 #define	RT_FL2_ADDR32	0x00004000	/* 32-bit address space requirement */
326 
327 /*
328  * Information flags for env_info.
329  */
330 #define	ENV_INF_PATHCFG	0x00000001	/* replaceable LD_LIBRARY_PATH */
331 					/*	originates from configuration */
332 					/*	file */
333 #define	ENV_INF_FLAGCFG	0x00000002	/* replaceable LD_FLAGS originates */
334 					/*	from configuration file */
335 
336 /*
337  * RTLDINFO descriptor.
338  */
339 typedef struct {
340 	Rt_map		*rti_lmp;	/* RTLDINFO provider */
341 	Lc_interface	*rti_info;	/* RTLDINFO data */
342 } Rti_desc;
343 
344 /*
345  * Binding flags for the rt_bind_guard()/rt_bind_clear() routines.
346  * These are defined in usr/src/lib/libc/inc/libc_int.h in the
347  * latest version of the libc/rtld runtime interface (CI_V_FIVE).
348  */
349 #if !defined(CI_V_FIVE)
350 #define	THR_FLG_RTLD	0x00000001	/* rtldlock bind guard flag */
351 #define	THR_FLG_NOLOCK	0x00000000	/* no-op before CI_V_FIVE */
352 #define	THR_FLG_REENTER	0x00000000	/* no-op before CI_V_FIVE */
353 #endif
354 
355 #define	ROUND(x, a)	(((int)(x) + ((int)(a) - 1)) & ~((int)(a) - 1))
356 
357 /*
358  * Print buffer.
359  */
360 typedef struct {
361 	char	*pr_buf;	/* pointer to beginning of buffer */
362 	char	*pr_cur;	/* pointer to next free char in buffer */
363 	size_t	pr_len;		/* buffer size */
364 	int	pr_fd;		/* output fd */
365 } Prfbuf;
366 
367 /*
368  * Path name descriptor.  Used to construct various path names such as search
369  * paths, dependency paths, filter paths etc.  The pd_info element can be used
370  * to hold various pointers, like Grp_hdl, Rtc_obj, etc.
371  */
372 struct pdesc {
373 	const char	*pd_pname;	/* path name - may be expanded */
374 	const char	*pd_oname;	/* original name - unexpanded */
375 	void		*pd_info;	/* possible auxiliary information */
376 	size_t		pd_plen;	/* path name length */
377 	uint_t		pd_flags;	/* descriptor specific flags */
378 };
379 
380 /*
381  * Path name descriptors are passed to expand_path() and expand().  These
382  * routines break down possible multiple path strings (separated with ":"),
383  * and perform any reserved token expansion.  These routines are passed
384  * information that indicates the use of the path, for example, search paths,
385  * i.e., LD_LIBRARY_PATH, RPATHS, etc. are defined using la_objsearch()
386  * information (see LA_SER flags in link.h).  This information is recorded in
387  * the pd_flags field for later use.
388  *
389  * Define expansion path tokens.  These are used to prevent various expansions
390  * from occurring, and record those expansions that do.  Any expansion
391  * information is also recorded in the pd_flags field, and thus is or'd
392  * together with any LA_SER flags.
393  */
394 #define	PD_TKN_ORIGIN	0x00001000	/* $ORIGIN expansion has occurred */
395 #define	PD_TKN_PLATFORM	0x00002000	/* $PLATFORM expansion has occurred */
396 #define	PD_TKN_OSNAME	0x00004000	/* $OSNAME expansion has occurred */
397 #define	PD_TKN_OSREL	0x00008000	/* $OSREL expansion has occurred */
398 #define	PD_TKN_ISALIST	0x00010000	/* $ISALIST expansion has occurred */
399 #define	PD_TKN_CAP	0x00020000	/* $CAPABILITY/$HWCAP expansion has */
400 					/*	occurred */
401 #define	PD_TKN_MACHINE	0x00040000	/* $MACHINE expansion has occurred */
402 #define	PD_TKN_RESOLVED	0x00080000	/* resolvepath() expansion has */
403 					/*	occurred */
404 #define	PD_MSK_EXPAND	0x000ff000	/* mask for all expansions */
405 
406 /*
407  * Define additional path information.  These definitions extend the path
408  * information, and may be passed into expand_path(), or set internally, or
409  * inherited from expand().  These definitions are or'd together with any
410  * LA_SER_ flags and PD_TKN_ flags.
411  */
412 #define	PD_FLG_PNSLASH	0x00100000	/* pd_pname contains a slash */
413 #define	PD_FLG_DUPLICAT	0x00200000	/* path is a duplicate */
414 #define	PD_FLG_EXTLOAD	0x00400000	/* path defines extra loaded objects */
415 					/*	(preload, audit etc.) */
416 #define	PD_FLG_UNIQUE	0x00800000	/* ensure path is unique */
417 #define	PD_FLG_USED	0x01000000	/* indicate that path is used */
418 #define	PD_FLG_FULLPATH	0x02000000	/* ensure path is a full path */
419 
420 #define	PD_MSK_INHERIT	0x0ffff000	/* mask for pd_flags incorporation */
421 
422 /*
423  * Additional token expansion information.  Although these flags may be set
424  * within a token data item return from expand(), they are masked off with
425  * PD_MSK_INHERIT prior to any expansion information being recorded in a path
426  * name descriptor for later diagnostics.
427  */
428 #define	TKN_NONE	0x00000001	/* no token expansion has occurred */
429 #define	TKN_DOTSLASH	0x00000002	/* path contains a "./" */
430 
431 /*
432  * dlopen() handle list size.
433  */
434 #define	HDLIST_SZ	101	/* prime no. for hashing */
435 #define	HDLIST_ORP	102	/* orphan handle list */
436 
437 /*
438  * Define a path name search descriptor.  This "cookie" maintains state as
439  * search paths are processed with get_next_dir().  Note, the path list is an
440  * indirect pointer, as search paths can be reevaluated for secure applications
441  * to provide better error diagnostics.
442  */
443 typedef struct {
444 	uchar_t		*sp_rule;	/* present search rule */
445 	Alist		**sp_dalpp;	/* present path list within rule */
446 	Aliste		sp_idx;		/* present index within path list */
447 } Spath_desc;
448 
449 /*
450  * Define a path name definition descriptor.  Used to maintain initial ELF and
451  * AOUT path name definitions.
452  */
453 typedef struct {
454 	const char	*sd_name;	/* path name */
455 	size_t		sd_len;		/* path name size */
456 } Spath_defn;
457 
458 /*
459  * Define _caller flags.
460  */
461 #define	CL_NONE		0
462 #define	CL_EXECDEF	1		/* supply the executable as a default */
463 					/* if the caller can't be determined */
464 
465 /*
466  * Binding information flags.  These flags are passed up from low level binding
467  * routines to indicate "additional" information, such as why a binding has been
468  * rejected.  These flags use the same data element as is used to record any
469  * DBG_BINFO flags.  The DBG_BINFO flags are used to define the final bindings
470  * information and are used to provide better binding diagnostics.
471  */
472 #define	BINFO_REJDIRECT		0x010000	/* reject a direct binding */
473 #define	BINFO_REJSINGLE		0x100000	/* reject a singleton binding */
474 #define	BINFO_REJGROUP		0x200000	/* reject a group binding */
475 
476 #define	BINFO_MSK_TRYAGAIN	0xf00000	/* a mask of bindings that */
477 						/*    should be retried */
478 #define	BINFO_MSK_REJECTED	0xff0000	/* a mask of bindings that */
479 						/*    have been rejected */
480 
481 /*
482  * The 32-bit version of rtld uses special stat() wrapper functions
483  * that preserve the non-largefile semantics of stat()/fstat() while
484  * allowing for large inode values. The 64-bit rtld uses stat() directly.
485  */
486 #ifdef _LP64
487 #define	rtld_fstat	fstat
488 #define	rtld_stat	stat
489 typedef	struct stat	rtld_stat_t;
490 #else
491 typedef struct {
492 	dev_t		st_dev;
493 	rtld_ino_t	st_ino;
494 	mode_t		st_mode;
495 	uid_t		st_uid;
496 	off_t		st_size;
497 	timestruc_t	st_mtim;
498 #ifdef sparc
499 	blksize_t	st_blksize;
500 #endif
501 } rtld_stat_t;
502 #endif
503 
504 /*
505  * Some capabilities aux vector definitions have been removed over time.
506  * However, existing objects may define these capabilities.  Establish
507  * capability masks that provide for deleting any removed capabilities, so
508  * that these capabilities are not used to validate the associated object.
509  *
510  * These masks are tightly coupled to the aux vector definitions in auxv_386.h
511  * and auxv_SPARC.h, however they are maintained here, as only ld.so.1 needs
512  * to remove these capabilities.  These definitions also describe where the
513  * flags are associated and allow for providing multi-architecture definitions
514  * should they become necessary, without having to pollute global header files.
515  */
516 #if	defined(__x86)
517 #define	AV_HW1_IGNORE	(0x8000 | 0x2000)	/* withdrawn MON and PAUSE */
518 #else						/*    auxv_386.h flags */
519 #define	AV_HW1_IGNORE	0
520 #endif
521 
522 /*
523  * Error messages generated by ld.so.1 can be written to two different places.
524  * During initial startup, messages are flushed to the stderr.  Once ld.so.1
525  * has jumped to the application, messages are stored in an internal buffer for
526  * retrieval by dlerror().  Between these two conditions, events such as libc's
527  * callbacks, and calls to auditors, are effectively jumping to application
528  * code.  These transitions from application code to ld.so.1 code are guarded by
529  * the following macros to ensure any error messages are directed to the
530  * appropriate output.  The single argument, "f", is a local variable that
531  * can retain, and reinstate, the RT_FL_APPLIC flag of the global rtld_flags
532  * variable.
533  */
534 #define	APPLICATION_ENTER(f) \
535 	f = (rtld_flags & RT_FL_APPLIC) ? 0 : RT_FL_APPLIC; \
536 	rtld_flags |= f;
537 #define	APPLICATION_RETURN(f) \
538 	rtld_flags &= ~f;
539 
540 /*
541  * Data declarations.
542  */
543 extern Lc_desc		glcs[];		/* global external interfaces */
544 
545 extern	Rt_lock		rtldlock;	/* rtld lock */
546 extern	int		thr_flg_nolock;
547 extern	int		thr_flg_reenter;
548 
549 extern APlist		*dynlm_list;	/* dynamic list of link-maps */
550 extern char		**environ;	/* environ pointer */
551 
552 extern int		dyn_plt_ent_size; /* Size of dynamic plt's */
553 extern ulong_t		at_flags;	/* machine specific file flags */
554 extern const char	*procname;	/* file name of executing process */
555 extern Rtld_db_priv	r_debug;	/* debugging information */
556 extern char		*lasterr;	/* string describing last error */
557 extern Interp		*interp;	/* ELF executable interpreter info */
558 extern const char	*rtldname;	/* name of the dynamic linker */
559 extern APlist		*hdl_alp[];	/* dlopen() handle list */
560 extern size_t		syspagsz;	/* system page size */
561 extern Isa_desc		*isa;		/* isalist descriptor */
562 extern Uts_desc		*uts;		/* utsname descriptor */
563 extern uint_t		rtld_flags;	/* status flags for RTLD */
564 extern uint_t		rtld_flags2;	/* additional status flags for RTLD */
565 extern uint32_t		pltcnt21d;	/* cnt of 21d PLTs */
566 extern uint32_t		pltcnt24d;	/* cnt of 24d PLTs */
567 extern uint32_t		pltcntu32;	/* cnt of u32 PLTs */
568 extern uint32_t		pltcntu44;	/* cnt of u44 PLTs */
569 extern uint32_t		pltcntfull;	/* cnt of full PLTs */
570 extern uint32_t		pltcntfar;	/* cnt of far PLTs */
571 extern uchar_t		search_rules[];	/* dependency search rules */
572 
573 extern Fct		elf_fct;	/* ELF file class dependent data */
574 
575 #if	defined(__sparc) && !defined(__sparcv9)
576 extern Fct		aout_fct;	/* a.out (4.x) file class dependent */
577 					/*	data */
578 #endif
579 
580 extern Config		*config;		/* configuration structure */
581 extern const char	*locale;		/* locale environment setting */
582 
583 extern const char	*rpl_audit;	/* replaceable LD_AUDIT string */
584 extern const char	*rpl_debug;	/* replaceable LD_DEBUG string */
585 extern const char	*rpl_ldflags;	/* replaceable LD_FLAGS string */
586 extern const char	*rpl_libpath;	/* replaceable LD_LIBRARY string */
587 extern Alist		*rpl_libdirs;	/*	and its associated Pdesc list */
588 extern const char	*rpl_preload;	/* replaceable LD_PRELOAD string */
589 
590 extern const char	*prm_audit;	/* permanent LD_AUDIT string */
591 extern const char	*prm_debug;	/* permanent LD_DEBUG string */
592 extern const char	*prm_ldflags;	/* permanent LD_FLAGS string */
593 extern const char	*prm_libpath;	/* permanent LD_LIBRARY string */
594 extern Alist		*prm_libdirs;	/*	and its associated Pdesc list */
595 extern const char	*prm_preload;	/* permanent LD_PRELOAD string */
596 
597 extern Alist		*elf_def_dirs;	/* ELF default directory seach paths */
598 extern Alist		*elf_sec_dirs;	/* ELF secure directory seach paths */
599 extern Alist		*aout_def_dirs;	/* AOUT default directory seach paths */
600 extern Alist		*aout_sec_dirs;	/* AOUT secure directory seach paths */
601 
602 extern uint_t		env_info;	/* information regarding environment */
603 					/*	variables */
604 extern int		killsig;	/* signal sent on fatal exit */
605 extern APlist		*free_alp;	/* defragmentation list */
606 
607 extern uint_t		audit_argcnt;	/* no. of stack args to copy */
608 extern Audit_desc	*auditors;	/* global auditors */
609 extern APlist		*aud_preinit;	/* list of objects defining local */
610 extern APlist		*aud_activity;	/*    preinit and activity auditors */
611 
612 extern char		**_environ;	/* environ reference for libc */
613 
614 extern const char	*dbg_file;	/* debugging directed to a file */
615 
616 extern Reglist		*reglist;	/* list of register symbols */
617 
618 extern const Msg	err_reject[];	/* rejection error message tables */
619 extern const Msg	ldd_reject[];
620 extern const Msg	ldd_warn[];
621 
622 extern const char	*profile_name;	/* object being profiled */
623 extern const char	*profile_out;	/* profile output file */
624 extern const char	*profile_lib;	/* audit library to perform profile */
625 
626 extern Dl_argsinfo	argsinfo;	/* process argument, environment and */
627 					/*	auxv information */
628 
629 extern const char	*err_strs[ERR_NUM];
630 					/* diagnostic error string headers */
631 extern const char	*nosym_str;	/* MSG_GEN_NOSYM message cache */
632 
633 extern Syscapset	*org_scapset;	/* original system capabilities */
634 extern Syscapset	*alt_scapset;	/* alternative system capabilities */
635 
636 extern const char	*rpl_hwcap;	/* replaceable hwcap str */
637 extern const char	*rpl_sfcap;	/* replaceable sfcap str */
638 extern const char	*rpl_machcap;	/* replaceable machcap str */
639 extern const char	*rpl_platcap;	/* replaceable platcap str */
640 extern const char	*rpl_cap_files;	/* associated files */
641 
642 extern const char	*prm_hwcap;	/* permanent hwcap str */
643 extern const char	*prm_sfcap;	/* permanent sfcap str */
644 extern const char	*prm_machcap;	/* permanent machcap str */
645 extern const char	*prm_platcap;	/* permanent platcap str */
646 extern const char	*prm_cap_files;	/* associated files */
647 
648 extern avl_tree_t	*capavl;	/* capabilities files */
649 extern avl_tree_t	*nfavl;		/* not-found path names */
650 extern avl_tree_t	*spavl;		/* secure path names */
651 
652 extern u_longlong_t	cnt_map;	/* Incr. for each object mapped */
653 extern u_longlong_t	cnt_unmap;	/* Incr. for each object unmapped */
654 
655 /*
656  * Function declarations.
657  */
658 extern void		addfree(void *, size_t);
659 extern int		append_alias(Rt_map *, const char *, int *);
660 extern Rt_map		*analyze_lmc(Lm_list *, Aliste, Rt_map *, Rt_map *,
661 			    int *);
662 extern void		atexit_fini(void);
663 extern int		bind_one(Rt_map *, Rt_map *, uint_t);
664 extern int		bufprint(Prfbuf *, const char *, ...);
665 extern void		call_array(Addr *, uint_t, Rt_map *, Word);
666 extern void		call_fini(Lm_list *, Rt_map **, Rt_map *);
667 extern void		call_init(Rt_map **, int);
668 extern int		callable(Rt_map *, Rt_map *, Grp_hdl *, uint_t);
669 extern Rt_map		*_caller(caddr_t, int);
670 extern caddr_t		caller(void);
671 extern void		*calloc(size_t, size_t);
672 extern int		cap_alternative(void);
673 extern int		cap_check_fdesc(Fdesc *, Cap *, char *, Rej_desc *);
674 extern int		cap_check_lmp(Rt_map *, Rej_desc *);
675 extern int 		cap_filtees(Alist **, Aliste, const char *, Aliste,
676 			    Rt_map *, Rt_map *, const char *, int, uint_t,
677 			    int *);
678 extern int		cap_match(Sresult *, uint_t, Sym *, char *);
679 extern const char	*_conv_reloc_type(uint_t rel);
680 extern Aliste		create_cntl(Lm_list *, int);
681 extern void		defrag(void);
682 extern int		dbg_setup(const char *, Dbg_desc *);
683 extern const char	*demangle(const char *);
684 extern int		dlclose_intn(Grp_hdl *, Rt_map *);
685 extern int		dlclose_core(Grp_hdl *, Rt_map *, Lm_list *);
686 extern int		dlsym_handle(Grp_hdl *, Slookup *, Sresult *, uint_t *,
687 			    int *);
688 extern void		*dlsym_intn(void *, const char *, Rt_map *, Rt_map **);
689 extern Grp_hdl		*dlmopen_intn(Lm_list *, const char *, int, Rt_map *,
690 			    uint_t, uint_t);
691 extern size_t		doprf(const char *, va_list, Prfbuf *);
692 extern int		dowrite(Prfbuf *);
693 extern void		*dz_map(Lm_list *, caddr_t, size_t, int, int);
694 extern int		enter(int);
695 extern uint_t		expand(char **, size_t *, char **, uint_t, uint_t,
696 			    Rt_map *);
697 extern int		expand_paths(Rt_map *, const char *, Alist **, Aliste,
698 			    uint_t, uint_t);
699 extern void		free_hdl(Grp_hdl *);
700 extern void		file_notfound(Lm_list *, const char *, Rt_map *,
701 			    uint_t, Rej_desc *);
702 extern int		find_path(Lm_list *, Rt_map *, uint_t, Fdesc *,
703 			    Rej_desc *, int *);
704 extern int		fpavl_insert(Lm_list *, Rt_map *, const char *,
705 			    avl_index_t);
706 extern Rt_map		*fpavl_recorded(Lm_list *, const char *, uint_t,
707 			    avl_index_t *);
708 extern void		fpavl_remove(Rt_map *);
709 extern size_t		fullpath(Rt_map *, Fdesc *);
710 extern Lmid_t		get_linkmap_id(Lm_list *);
711 extern Pdesc		*get_next_dir(Spath_desc *, Rt_map *, uint_t);
712 extern Grp_desc		*hdl_add(Grp_hdl *, Rt_map *, uint_t, int *);
713 extern Grp_hdl		*hdl_create(Lm_list *, Rt_map *, Rt_map *, uint_t,
714 			    uint_t, uint_t);
715 extern int		hdl_initialize(Grp_hdl *, Rt_map *, int, int);
716 extern int		hwcap1_check(Syscapset *, Xword, Rej_desc *);
717 extern int		hwcap2_check(Syscapset *, Xword, Rej_desc *);
718 extern void		is_dep_init(Rt_map *, Rt_map *);
719 extern int		is_move_data(caddr_t);
720 extern int		is_path_secure(char *, Rt_map *, uint_t, uint_t);
721 extern int		is_rtld_setuid();
722 extern int		is_sym_interposer(Rt_map *, Sym *);
723 extern void		ldso_plt_init(Rt_map *);
724 extern void		leave(Lm_list *, int);
725 extern void		lm_append(Lm_list *, Aliste, Rt_map *);
726 extern void		lm_delete(Lm_list *, Rt_map *, Rt_map *);
727 extern void		lm_move(Lm_list *, Aliste, Aliste, Lm_cntl *,
728 			    Lm_cntl *);
729 extern Rt_map 		*load_cap(Lm_list *, Aliste, const char *, Rt_map *,
730 			    uint_t, uint_t, Grp_hdl **, Rej_desc *, int *);
731 extern void		load_completion(Rt_map *);
732 extern Rt_map		*load_file(Lm_list *, Aliste, Rt_map *, Fdesc *, int *);
733 extern Rt_map		*load_path(Lm_list *, Aliste, Rt_map *, int, uint_t,
734 			    Grp_hdl **, Fdesc *, Rej_desc *, int *);
735 extern Rt_map		*load_one(Lm_list *, Aliste, Alist *, Rt_map *, int,
736 			    uint_t, Grp_hdl **, int *);
737 extern const char	*load_trace(Lm_list *, Pdesc *, Rt_map *, Fdesc *);
738 extern void		nfavl_insert(const char *, avl_index_t);
739 extern void		*nu_map(Lm_list *, caddr_t, size_t, int, int);
740 extern Fct		*map_obj(Lm_list *, Fdesc *, size_t, const char *, int,
741 			    Rej_desc *);
742 extern void		*malloc(size_t);
743 extern int		machcap_check(Syscapset *, const char *, Rej_desc *);
744 extern void		machine_name(Syscapset *);
745 extern int		move_data(Rt_map *, APlist **);
746 extern int		platcap_check(Syscapset *, const char *, Rej_desc *);
747 extern void		platform_name(Syscapset *);
748 extern int		pnavl_recorded(avl_tree_t **, const char *, uint_t,
749 			    avl_index_t *);
750 extern int		procenv_user(APlist *, Word *, Word *, int);
751 extern void		rd_event(Lm_list *, rd_event_e, r_state_e);
752 extern int		readenv_user(const char **, APlist **);
753 extern int		readenv_config(Rtc_env *, Addr, int);
754 extern void		rejection_inherit(Rej_desc *, Rej_desc *);
755 extern int		relocate_lmc(Lm_list *, Aliste, Rt_map *, Rt_map *,
756 			    int *);
757 extern int		relocate_finish(Rt_map *, APlist *, int);
758 extern void		remove_alist(Alist **, int);
759 extern void		remove_cntl(Lm_list *, Aliste);
760 extern int		remove_hdl(Grp_hdl *, Rt_map *, int *);
761 extern void		remove_lmc(Lm_list *, Rt_map *, Aliste, const char *);
762 extern void		remove_lml(Lm_list *);
763 extern void		remove_so(Lm_list *, Rt_map *, Rt_map *);
764 extern int		rt_cond_wait(Rt_cond *, Rt_lock *);
765 extern int		rt_critical(void);
766 extern int		rt_bind_guard(int);
767 extern int		rt_bind_clear(int);
768 extern int		rt_get_extern(Lm_list *, Rt_map *);
769 extern int		rt_mutex_lock(Rt_lock *);
770 extern int		rt_mutex_unlock(Rt_lock *);
771 extern void		rt_thr_init(Lm_list *);
772 extern thread_t		rt_thr_self(void);
773 extern void		rtld_db_dlactivity(Lm_list *);
774 extern void		rtld_db_preinit(Lm_list *);
775 extern void		rtld_db_postinit(Lm_list *);
776 extern void		rtldexit(Lm_list *, int);
777 #ifndef _LP64
778 extern int		rtld_fstat(int, rtld_stat_t *restrict);
779 extern int		rtld_stat(const char *restrict, rtld_stat_t *restrict);
780 #endif
781 extern int		rtld_getopt(char **, char ***, auxv_t **, Word *,
782 			    Word *, int);
783 extern void		security(uid_t, uid_t, gid_t, gid_t, int);
784 extern void		set_environ(Lm_list *);
785 extern void		set_dirs(Alist **, Spath_defn *, uint_t);
786 extern int		set_prot(Rt_map *, mmapobj_result_t *, int);
787 extern Rt_map		*setup(char **, auxv_t *, Word, char *, int, char *,
788 			    ulong_t, ulong_t, int fd, Phdr *, char *, char **,
789 			    uid_t, uid_t, gid_t, gid_t, void *, int, uint_t);
790 extern const char	*stravl_insert(const char *, uint_t, size_t, int);
791 extern void		spavl_insert(const char *);
792 extern int		sfcap1_check(Syscapset *, Xword, Rej_desc *);
793 extern int		tls_assign(Lm_list *, Rt_map *, Phdr *);
794 extern void		tls_modaddrem(Rt_map *, uint_t);
795 extern int		tls_statmod(Lm_list *, Rt_map *);
796 extern Rt_map		**tsort(Rt_map *, int, int);
797 extern void		unused(Lm_list *);
798 extern void		unmap_obj(mmapobj_result_t *, uint_t);
799 extern int		update_mode(Rt_map *, int, int);
800 extern void		zero(caddr_t, size_t);
801 
802 #if	defined(__sparc)
803 /*
804  * SPARC Register symbol support.
805  */
806 extern int		elf_regsyms(Rt_map *);
807 extern void		set_sparc_g1(ulong_t);
808 extern void		set_sparc_g2(ulong_t);
809 extern void		set_sparc_g3(ulong_t);
810 extern void		set_sparc_g4(ulong_t);
811 extern void		set_sparc_g5(ulong_t);
812 extern void		set_sparc_g6(ulong_t);
813 extern void		set_sparc_g7(ulong_t);
814 #endif
815 
816 extern long		_sysconfig(int);
817 
818 #ifdef	__cplusplus
819 }
820 #endif
821 
822 #endif /* __RTLD_H */
823