xref: /illumos-gate/usr/src/cmd/sgs/include/libld.h (revision f0b6369d)
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) 1992, 2010, Oracle and/or its affiliates. All rights reserved.
27  */
28 
29 #ifndef	_LIBLD_H
30 #define	_LIBLD_H
31 
32 #include <stdlib.h>
33 #include <libelf.h>
34 #include <sgs.h>
35 #include <_machelf.h>
36 #include <string_table.h>
37 #include <sys/avl.h>
38 #include <alist.h>
39 #include <elfcap.h>
40 
41 #ifdef	__cplusplus
42 extern "C" {
43 #endif
44 
45 /*
46  * Default directory search path manipulation for the link-editor.  YLDIR
47  * indicates which directory in LIBPATH is replaced by the -YL option to cc
48  * and ld.  YUDIR indicates which directory is replaced by -YU.
49  */
50 #define	YLDIR	1
51 #define	YUDIR	2
52 
53 /*
54  * Define a hash value that can never be returned from elf_hash().
55  */
56 #define	SYM_NOHASH	(~(Word)0)
57 
58 /*
59  * Macro that can be used to represent both ORDER flags
60  * in a section header.
61  */
62 #define	ALL_SHF_ORDER	(SHF_ORDERED | SHF_LINK_ORDER)
63 
64 /*
65  * The linker merges (concatenates) sections with the same name and
66  * compatible section header flags. When comparing these flags,
67  * there are some that should not be included in the decision.
68  * The ALL_SHF_IGNORE constant defines these flags.
69  *
70  * NOTE: SHF_MERGE|SHF_STRINGS:
71  * The compiler is allowed to set the SHF_MERGE|SHF_STRINGS flags in
72  * order to tell the linker that:
73  *
74  *      1) There is nothing in the section except null terminated strings.
75  *	2) Those strings do not contain NULL bytes, except as termination.
76  *	3) All references to these strings occur via standard relocation
77  *		records.
78  *
79  * As a result, if two compatible sections both have these flags set, it is
80  * OK to combine the strings they contain into a single merged string table
81  * with duplicates removed and tail strings merged.
82  *
83  * This is a different meaning than the simple concatenating of sections
84  * that the linker always does. It is a hint that an additional optimization
85  * is possible, but not required. This means that sections that do not
86  * share the same SHF_MERGE|SHF_STRINGS values can be concatenated,
87  * but cannot have their duplicate strings combined. Hence, the
88  * SHF_MERGE|SHF_STRINGS flags should be ignored when deciding whether
89  * two sections can be concatenated.
90  */
91 #define	ALL_SHF_IGNORE	(ALL_SHF_ORDER | SHF_GROUP | SHF_MERGE | SHF_STRINGS)
92 
93 /*
94  * Define symbol reference types for use in symbol resolution.
95  */
96 typedef enum {
97 	REF_DYN_SEEN,			/* a .so symbol has been seen */
98 	REF_DYN_NEED,			/* a .so symbol satisfies a .o symbol */
99 	REF_REL_NEED,			/* a .o symbol */
100 	REF_NUM				/* the number of symbol references */
101 } Symref;
102 
103 /*
104  * Relocation descriptor cache
105  */
106 struct rel_cache {
107 	APlist		*rc_list;	/* list of Rel_cachebuf */
108 	Word		rc_cnt;		/*	and count */
109 };
110 
111 /*
112  * GOT reference models
113  */
114 typedef enum {
115 	GOT_REF_GENERIC,	/* generic symbol reference */
116 	GOT_REF_TLSIE,		/* TLS initial exec (gnu) reference */
117 	GOT_REF_TLSLD,		/* TLS local dynamic reference */
118 	GOT_REF_TLSGD		/* TLS general dynamic reference */
119 } Gotref;
120 
121 typedef struct {
122 	Xword		gn_addend;	/* addend associated with GOT entry */
123 	Sword		gn_gotndx;	/* GOT table index */
124 	Gotref		gn_gotref;
125 } Gotndx;
126 
127 /*
128  * Got debugging structure.  The got index is defined as a signed value as we
129  * do so much mucking around with negative and positive gots on SPARC, and sign
130  * extension is necessary when building 64-bit objects.  On intel we explicitly
131  * cast this variable to an unsigned value.
132  */
133 typedef struct {
134 	Sym_desc	*gt_sym;
135 	Gotndx		gt_gndx;
136 } Gottable;
137 
138 /*
139  * The link-editor caches the results of sloppy relocation processing
140  * in a variable of type Rlxrel_cache. Symbols come for processing in sorted
141  * order, so a single item cache suffices to eliminate duplicate lookups.
142  *
143  * When sloppy relocation processing fails, the Rlxrel_rej enum reports
144  * the underlying reason.
145  */
146 typedef enum {
147 	RLXREL_REJ_NONE = 0,	/* Replacement symbol was found */
148 	RLXREL_REJ_TARGET,	/* Target sec disallows relaxed relocations */
149 	RLXREL_REJ_SECTION,	/* Either there is no replacement section, */
150 				/*	or its attributes are incompatible */
151 	RLXREL_REJ_SYMBOL,	/* Replacement symbol not found */
152 } Rlxrel_rej;
153 
154 typedef struct sreloc_cache {
155 	Sym_desc	*sr_osdp;	/* Original symbol */
156 	Sym_desc	*sr_rsdp;	/* Replacement symbol */
157 	Rlxrel_rej	sr_rej;		/* Reason for failure if NULL sr_rsdp */
158 } Rlxrel_cache;
159 
160 /*
161  * Nodes in an ofl_wrap AVL tree
162  *
163  * wsn_name is the name of the symbol to be wrapped. wsn_wrapname is used
164  * when we need to refer to the wrap symbol, and consists of the symbol
165  * name with a __wrap_ prefix.
166  */
167 typedef struct wrap_sym_node {
168 	avl_node_t	wsn_avlnode;	/* AVL book-keeping */
169 	const char	*wsn_name;	/* Symbol name: XXX */
170 	const char	*wsn_wrapname;	/* Wrap symbol name: __wrap_XXX */
171 } WrapSymNode;
172 
173 /*
174  * Capabilities structures, used to maintain a capabilities set.
175  *
176  * Capabilities can be defined within input relocatable objects, and can be
177  * augmented or replaced by mapfile directives.  In addition, mapfile directives
178  * can be used to exclude capabilities that would otherwise be carried over to
179  * the output object.
180  *
181  * CA_SUNW_HW_1, CA_SUNW_SF_1 and CA_SUNW_HW_2 values are bitmasks.  A current
182  * value, and an exclude value are maintained for each capability.
183  *
184  * There can be multiple CA_SUNW_PLAT and CA_SUNW_MACH entries and thus Alists
185  * are used to collect these entries.  A current list for each capability is
186  * maintained as Capstr entries, which provide for maintaining the strings
187  * eventual index into a string table.  An exclude list is maintained as a
188  * list of string pointers.
189  */
190 typedef struct {
191 	elfcap_mask_t	cm_val;		/* bitmask value */
192 	elfcap_mask_t	cm_exc;		/* bits to exclude from final object */
193 } Capmask;
194 
195 typedef struct {
196 	Alist		*cl_val;	/* string (Capstr) value */
197 	APlist		*cl_exc;	/* strings to exclude from final */
198 } Caplist;				/*	object */
199 
200 typedef	struct {
201 	char		*cs_str;	/* platform or machine name */
202 	Word		cs_ndx;		/* the entries output Cap index */
203 } Capstr;
204 
205 typedef	uint_t		oc_flag_t;
206 typedef	struct {
207 	Capmask		oc_hw_1;	/* CA_SUNW_HW_1 capabilities */
208 	Capmask		oc_sf_1;	/* CA_SUNW_SF_1 capabilities */
209 	Capmask		oc_hw_2;	/* CA_SUNW_HW_2 capabilities */
210 	Caplist		oc_plat;	/* CA_SUNW_PLAT capabilities */
211 	Caplist		oc_mach;	/* CA_SUNW_MACH capabilities */
212 	Capstr		oc_id;		/* CA_SUNW_ID capability */
213 	oc_flag_t	oc_flags;
214 } Objcapset;
215 
216 #define	FLG_OCS_USRDEFID	0x1	/* user defined CA_SUNW_ID */
217 
218 /*
219  * Bitmasks for a single capability. Capabilities come from input objects,
220  * augmented or replaced by mapfile directives. In addition, mapfile directives
221  * can be used to exclude bits that would otherwise be set in the output object.
222  */
223 typedef struct {
224 	elfcap_mask_t	cm_value;	/* Bitmask value */
225 	elfcap_mask_t	cm_exclude;	/* Bits to remove from final object */
226 } CapMask;
227 
228 /*
229  * Combine the bitmask in a CapMask with the exclusion mask and
230  * return the resulting final value.
231  */
232 #define	CAPMASK_VALUE(_cbmp) ((_cbmp)->cm_value & ~(_cbmp)->cm_exclude)
233 
234 typedef struct {
235 	CapMask		c_hw_1;		/* CA_SUNW_HW_1 capabilities */
236 	CapMask		c_sf_1;		/* CA_SUNW_SF_1 capabilities */
237 	CapMask		c_hw_2;		/* CA_SUNW_HW_2 capabilities */
238 } Outcapset;
239 
240 
241 /*
242  * Output file processing structure
243  */
244 typedef Lword	ofl_flag_t;
245 typedef Word	ofl_guideflag_t;
246 struct ofl_desc {
247 	char		*ofl_sgsid;	/* link-editor identification */
248 	const char	*ofl_name;	/* full file name */
249 	Elf		*ofl_elf;	/* elf_memory() elf descriptor */
250 	Elf		*ofl_welf;	/* ELF_C_WRITE elf descriptor */
251 	Ehdr		*ofl_dehdr;	/* default elf header, and new elf */
252 	Ehdr		*ofl_nehdr;	/*	header describing this file */
253 	Phdr		*ofl_phdr;	/* program header descriptor */
254 	Phdr		*ofl_tlsphdr;	/* TLS phdr */
255 	int		ofl_fd;		/* file descriptor */
256 	size_t		ofl_size;	/* image size */
257 	APlist		*ofl_maps;	/* list of input mapfiles */
258 	APlist		*ofl_segs;	/* list of segments */
259 	APlist		*ofl_segs_order; /* SEGMENT_ORDER segments */
260 	avl_tree_t	ofl_segs_avl;	/* O(log N) access to named segments */
261 	APlist		*ofl_ents;	/* list of entrance descriptors */
262 	avl_tree_t	ofl_ents_avl;	/* O(log N) access to named ent. desc */
263 	APlist		*ofl_objs;	/* relocatable object file list */
264 	Word		ofl_objscnt;	/*	and count */
265 	APlist		*ofl_ars;	/* archive library list */
266 	Word		ofl_arscnt;	/*	and count */
267 	int		ofl_ars_gsandx; /* archive group argv index. 0 means */
268 					/*	no current group, < 0 means */
269 					/*	error reported. >0 is cur ndx */
270 	Word		ofl_ars_gsndx;	/* current -zrescan-start ofl_ars ndx */
271 	APlist		*ofl_sos;	/* shared object list */
272 	Word		ofl_soscnt;	/*	and count */
273 	APlist		*ofl_soneed;	/* list of implicitly required .so's */
274 	APlist		*ofl_socntl;	/* list of .so control definitions */
275 	Rel_cache	ofl_outrels;	/* list of output relocations */
276 	Rel_cache	ofl_actrels;	/* list of relocations to perform */
277 	APlist		*ofl_relaux;	/* Rel_aux cache for outrels/actrels */
278 	Word		ofl_entrelscnt;	/* no of relocations entered */
279 	Alist		*ofl_copyrels;	/* list of copy relocations */
280 	APlist		*ofl_ordered;	/* list of shf_ordered sections */
281 	APlist		*ofl_symdtent;	/* list of syminfo symbols that need */
282 					/*	to reference .dynamic entries */
283 	APlist		*ofl_ismove;	/* list of .SUNW_move sections */
284 	APlist		*ofl_ismoverel;	/* list of relocation input section */
285 					/* targeting to expanded area */
286 	APlist		*ofl_parsyms;	/* list of partially initialized */
287 					/*	symbols (ie. move symbols) */
288 	APlist		*ofl_extrarels;	/* relocation sections which have */
289 					/*    a NULL sh_info */
290 	avl_tree_t	*ofl_groups;	/* pointer to head of Groups AVL tree */
291 	APlist		*ofl_initarray;	/* list of init array func names */
292 	APlist		*ofl_finiarray;	/* list of fini array func names */
293 	APlist		*ofl_preiarray;	/* list of preinit array func names */
294 	APlist		*ofl_rtldinfo;	/* list of rtldinfo syms */
295 	APlist		*ofl_osgroups;	/* list of output GROUP sections */
296 	APlist		*ofl_ostlsseg;	/* pointer to sections in TLS segment */
297 	APlist		*ofl_unwind;	/* list of unwind output sections */
298 	Os_desc		*ofl_unwindhdr;	/* Unwind hdr */
299 	avl_tree_t	ofl_symavl;	/* pointer to head of Syms AVL tree */
300 	Sym_desc	**ofl_regsyms;	/* array of potential register */
301 	Word		ofl_regsymsno;	/*    symbols and array count */
302 	Word		ofl_regsymcnt;	/* no. of output register symbols */
303 	Word		ofl_lregsymcnt;	/* no. of local register symbols */
304 	Sym_desc	*ofl_dtracesym;	/* ld -zdtrace= */
305 	ofl_flag_t	ofl_flags;	/* various state bits, args etc. */
306 	ofl_flag_t	ofl_flags1;	/*	more flags */
307 	void		*ofl_entry;	/* entry point (-e and Sym_desc *) */
308 	char		*ofl_filtees;	/* shared objects we are a filter for */
309 	const char	*ofl_soname;	/* (-h option) output file name for */
310 					/*	dynamic structure */
311 	const char	*ofl_interp;	/* interpreter name used by exec() */
312 	char		*ofl_rpath;	/* run path to store in .dynamic */
313 	char		*ofl_config;	/* config path to store in .dynamic */
314 	APlist		*ofl_ulibdirs;	/* user supplied library search list */
315 	APlist		*ofl_dlibdirs;	/* default library search list */
316 	Word		ofl_vercnt;	/* number of versions to generate */
317 	APlist		*ofl_verdesc;	/* list of version descriptors */
318 	size_t		ofl_verdefsz;	/* size of version definition section */
319 	size_t		ofl_verneedsz;	/* size of version needed section */
320 	Word		ofl_entercnt;	/* no. of global symbols entered */
321 	Word		ofl_globcnt;	/* no. of global symbols to output */
322 	Word		ofl_scopecnt;	/* no. of scoped symbols to output */
323 	Word		ofl_dynscopecnt; /* no. scoped syms in .SUNW_ldynsym */
324 	Word		ofl_elimcnt;	/* no. of eliminated symbols */
325 	Word		ofl_locscnt;	/* no. of local symbols in .symtab */
326 	Word		ofl_dynlocscnt;	/* no. local symbols in .SUNW_ldynsym */
327 	Word		ofl_dynsymsortcnt; /* no. ndx in .SUNW_dynsymsort */
328 	Word		ofl_dyntlssortcnt; /* no. ndx in .SUNW_dyntlssort */
329 	Word		ofl_dynshdrcnt;	/* no. of output section in .dynsym */
330 	Word		ofl_shdrcnt;	/* no. of output sections */
331 	Word		ofl_caploclcnt;	/* no. of local capabilities symbols */
332 	Word		ofl_capsymcnt;	/* no. of symbol capabilities entries */
333 					/*	required */
334 	Word		ofl_capchaincnt; /* no. of Capchain symbols */
335 	APlist		*ofl_capgroups;	/* list of capabilities groups */
336 	avl_tree_t	*ofl_capfamilies; /* capability family AVL tree */
337 	Str_tbl		*ofl_shdrsttab;	/* Str_tbl for shdr strtab */
338 	Str_tbl		*ofl_strtab;	/* Str_tbl for symtab strtab */
339 	Str_tbl		*ofl_dynstrtab;	/* Str_tbl for dymsym strtab */
340 	Gotndx		*ofl_tlsldgotndx; /* index to LD TLS_index structure */
341 	Xword		ofl_relocsz;	/* size of output relocations */
342 	Xword		ofl_relocgotsz;	/* size of .got relocations */
343 	Xword		ofl_relocpltsz;	/* size of .plt relocations */
344 	Xword		ofl_relocbsssz;	/* size of .bss (copy) relocations */
345 	Xword		ofl_relocrelsz;	/* size of .rel[a] relocations */
346 	Word		ofl_relocincnt;	/* no. of input relocations */
347 	Word		ofl_reloccnt;	/* tot number of output relocations */
348 	Word		ofl_reloccntsub; /* tot numb of output relocations to */
349 					/*	skip (-zignore) */
350 	Word		ofl_relocrelcnt; /* tot number of relative */
351 					/*	relocations */
352 	Word		ofl_gotcnt;	/* no. of .got entries */
353 	Word		ofl_pltcnt;	/* no. of .plt entries */
354 	Word		ofl_pltpad;	/* no. of .plt padd entries */
355 	Word		ofl_hashbkts;	/* no. of hash buckets required */
356 	Is_desc		*ofl_isbss;	/* .bss input section (globals) */
357 	Is_desc		*ofl_islbss;	/* .lbss input section (globals) */
358 	Is_desc		*ofl_istlsbss;	/* .tlsbss input section (globals) */
359 	Is_desc		*ofl_isparexpn;	/* -z nopartial .data input section */
360 	Os_desc		*ofl_osdynamic;	/* .dynamic output section */
361 	Os_desc		*ofl_osdynsym;	/* .dynsym output section */
362 	Os_desc		*ofl_osldynsym;	/* .SUNW_ldynsym output section */
363 	Os_desc		*ofl_osdynstr;	/* .dynstr output section */
364 	Os_desc		*ofl_osdynsymsort; /* .SUNW_dynsymsort output section */
365 	Os_desc		*ofl_osdyntlssort; /* .SUNW_dyntlssort output section */
366 	Os_desc		*ofl_osgot;	/* .got output section */
367 	Os_desc		*ofl_oshash;	/* .hash output section */
368 	Os_desc		*ofl_osinitarray; /* .init_array output section */
369 	Os_desc		*ofl_osfiniarray; /* .fini_array output section */
370 	Os_desc		*ofl_ospreinitarray; /* .preinit_array output section */
371 	Os_desc		*ofl_osinterp;	/* .interp output section */
372 	Os_desc		*ofl_oscap;	/* .SUNW_cap output section */
373 	Os_desc		*ofl_oscapinfo;	/* .SUNW_capinfo output section */
374 	Os_desc		*ofl_oscapchain; /* .SUNW_capchain output section */
375 	Os_desc		*ofl_osplt;	/* .plt output section */
376 	Os_desc		*ofl_osmove;	/* .SUNW_move output section */
377 	Os_desc		*ofl_osrelhead;	/* first relocation section */
378 	Os_desc		*ofl_osrel;	/* .rel[a] relocation section */
379 	Os_desc		*ofl_osshstrtab; /* .shstrtab output section */
380 	Os_desc		*ofl_osstrtab;	/* .strtab output section */
381 	Os_desc		*ofl_ossymtab;	/* .symtab output section */
382 	Os_desc		*ofl_ossymshndx; /* .symtab_shndx output section */
383 	Os_desc		*ofl_osdynshndx; /* .dynsym_shndx output section */
384 	Os_desc		*ofl_osldynshndx; /* .SUNW_ldynsym_shndx output sec */
385 	Os_desc		*ofl_osverdef;	/* .version definition output section */
386 	Os_desc		*ofl_osverneed;	/* .version needed output section */
387 	Os_desc		*ofl_osversym;	/* .version symbol ndx output section */
388 	Word		ofl_dtflags_1;	/* DT_FLAGS_1 entries */
389 	Word		ofl_dtflags;	/* DT_FLAGS entries */
390 	Os_desc		*ofl_ossyminfo;	/* .SUNW_syminfo output section */
391 	Half		ofl_parexpnndx;	/* -z nopartial section index */
392 					/* Ref. at perform_outreloc() in */
393 					/* libld/{mach}/machrel.c */
394 	Xword		*ofl_checksum;	/* DT_CHECKSUM value address */
395 	char		*ofl_depaudit;	/* dependency auditing required (-P) */
396 	char		*ofl_audit;	/* object auditing required (-p) */
397 	Alist		*ofl_symfltrs;	/* per-symbol filtees and their */
398 	Alist		*ofl_dtsfltrs;	/*	associated .dynamic/.dynstrs */
399 	Objcapset	ofl_ocapset;	/* object capabilities */
400 	Lm_list		*ofl_lml;	/* runtime link-map list */
401 	Gottable	*ofl_gottable;	/* debugging got information */
402 	Rlxrel_cache	ofl_sr_cache;	/* Cache last result from */
403 					/*	sloppy_comdat_reloc() */
404 	APlist		*ofl_maptext;	/* mapfile added text sections */
405 	APlist		*ofl_mapdata;	/* mapfile added data sections */
406 	avl_tree_t	*ofl_wrap;	/* -z wrap symbols */
407 	ofl_guideflag_t	ofl_guideflags;	/* -z guide flags */
408 	APlist		*ofl_assdeflib;	/* -z assert-deflib exceptions */
409 	int		ofl_aslr;	/* -z aslr, -1 disable, 1 enable */
410 };
411 
412 #define	FLG_OF_DYNAMIC	0x00000001	/* generate dynamic output module */
413 #define	FLG_OF_STATIC	0x00000002	/* generate static output module */
414 #define	FLG_OF_EXEC	0x00000004	/* generate an executable */
415 #define	FLG_OF_RELOBJ	0x00000008	/* generate a relocatable object */
416 #define	FLG_OF_SHAROBJ	0x00000010	/* generate a shared object */
417 #define	FLG_OF_BFLAG	0x00000020	/* do no special plt building: -b */
418 #define	FLG_OF_IGNENV	0x00000040	/* ignore LD_LIBRARY_PATH: -i */
419 #define	FLG_OF_STRIP	0x00000080	/* strip output: -s */
420 #define	FLG_OF_NOWARN	0x00000100	/* disable symbol warnings: -t */
421 #define	FLG_OF_NOUNDEF	0x00000200	/* allow no undefined symbols: -zdefs */
422 #define	FLG_OF_PURETXT	0x00000400	/* allow no text relocations: -ztext */
423 #define	FLG_OF_GENMAP	0x00000800	/* generate a memory map: -m */
424 #define	FLG_OF_DYNLIBS	0x00001000	/* dynamic input allowed: -Bdynamic */
425 #define	FLG_OF_SYMBOLIC	0x00002000	/* bind global symbols: -Bsymbolic */
426 #define	FLG_OF_ADDVERS	0x00004000	/* add version stamp: -Qy */
427 #define	FLG_OF_NOLDYNSYM 0x00008000	/* -znoldynsym set */
428 #define	FLG_OF_IS_ORDER	0x00010000	/* input section ordering within a */
429 					/*	segment is required */
430 #define	FLG_OF_EC_FILES	0x00020000	/* Ent_desc exist w/non-NULL ec_files */
431 #define	FLG_OF_TEXTREL	0x00040000	/* text relocations have been found */
432 #define	FLG_OF_MULDEFS	0x00080000	/* multiple symbols are allowed */
433 #define	FLG_OF_TLSPHDR	0x00100000	/* a TLS program header is required */
434 #define	FLG_OF_BLDGOT	0x00200000	/* build GOT table */
435 #define	FLG_OF_VERDEF	0x00400000	/* record version definitions */
436 #define	FLG_OF_VERNEED	0x00800000	/* record version dependencies */
437 #define	FLG_OF_NOVERSEC 0x01000000	/* don't record version sections */
438 #define	FLG_OF_KEY	0x02000000	/* file requires sort keys */
439 #define	FLG_OF_PROCRED	0x04000000	/* process any symbol reductions by */
440 					/*	effecting the symbol table */
441 					/*	output and relocations */
442 #define	FLG_OF_SYMINFO	0x08000000	/* create a syminfo section */
443 #define	FLG_OF_AUX	0x10000000	/* ofl_filter is an auxiliary filter */
444 #define	FLG_OF_FATAL	0x20000000	/* fatal error during input */
445 #define	FLG_OF_WARN	0x40000000	/* warning during input processing. */
446 #define	FLG_OF_VERBOSE	0x80000000	/* -z verbose flag set */
447 
448 #define	FLG_OF_MAPSYMB	0x000100000000	/* symbolic scope definition seen */
449 #define	FLG_OF_MAPGLOB	0x000200000000	/* global scope definition seen */
450 #define	FLG_OF_COMREL	0x000400000000	/* -z combreloc set, which enables */
451 					/*	DT_RELACNT tracking, */
452 #define	FLG_OF_NOCOMREL	0x000800000000	/* -z nocombreloc set */
453 #define	FLG_OF_AUTOLCL	0x001000000000	/* automatically reduce unspecified */
454 					/*	global symbols to locals */
455 #define	FLG_OF_AUTOELM	0x002000000000	/* automatically eliminate */
456 					/*	unspecified global symbols */
457 #define	FLG_OF_REDLSYM	0x004000000000	/* reduce local symbols */
458 #define	FLG_OF_OS_ORDER	0x008000000000	/* output section ordering required */
459 #define	FLG_OF_OSABI	0x010000000000	/* tag object as ELFOSABI_SOLARIS */
460 #define	FLG_OF_ADJOSCNT	0x020000000000	/* adjust ofl_shdrcnt to accommodate */
461 					/*	discarded sections */
462 #define	FLG_OF_OTOSCAP	0x040000000000	/* convert object capabilities to */
463 					/*	symbol capabilities */
464 #define	FLG_OF_PTCAP	0x080000000000	/* PT_SUNWCAP required */
465 #define	FLG_OF_CAPSTRS	0x100000000000	/* capability strings are required */
466 #define	FLG_OF_EHFRAME	0x200000000000	/* output contains .eh_frame section */
467 #define	FLG_OF_FATWARN	0x400000000000	/* make warnings fatal */
468 #define	FLG_OF_ADEFLIB	0x800000000000	/* no libraries in default path */
469 
470 #define	FLG_OF_KMOD	0x1000000000000	/* output is a kernel module */
471 
472 /*
473  * In the flags1 arena, establish any options that are applicable to archive
474  * extraction first, and associate a mask.  These values are recorded with any
475  * archive descriptor so that they may be reset should the archive require a
476  * rescan to try and resolve undefined symbols.
477  */
478 #define	FLG_OF1_ALLEXRT	0x0000000001	/* extract all members from an */
479 					/*	archive file */
480 #define	FLG_OF1_WEAKEXT	0x0000000002	/* allow archive extraction to */
481 					/*	resolve weak references */
482 #define	MSK_OF1_ARCHIVE	0x0000000003	/* archive flags mask */
483 
484 #define	FLG_OF1_NOINTRP	0x0000000008	/* -z nointerp flag set */
485 #define	FLG_OF1_ZDIRECT	0x0000000010	/* -z direct flag set */
486 #define	FLG_OF1_NDIRECT	0x0000000020	/* no-direct bindings specified */
487 #define	FLG_OF1_DEFERRED 0x0000000040	/* deferred dependency recording */
488 
489 #define	FLG_OF1_RELDYN	0x0000000100	/* process .dynamic in rel obj */
490 #define	FLG_OF1_NRLXREL	0x0000000200	/* -z norelaxreloc flag set */
491 #define	FLG_OF1_RLXREL	0x0000000400	/* -z relaxreloc flag set */
492 #define	FLG_OF1_IGNORE	0x0000000800	/* ignore unused dependencies */
493 #define	FLG_OF1_NOSGHND	0x0000001000	/* -z nosighandler flag set */
494 #define	FLG_OF1_TEXTOFF 0x0000002000	/* text relocations are ok */
495 #define	FLG_OF1_ABSEXEC	0x0000004000	/* -zabsexec set */
496 #define	FLG_OF1_LAZYLD	0x0000008000	/* lazy loading of objects enabled */
497 #define	FLG_OF1_GRPPRM	0x0000010000	/* dependencies are to have */
498 					/*	GROUPPERM enabled */
499 
500 #define	FLG_OF1_NOPARTI	0x0000040000	/* -znopartial set */
501 #define	FLG_OF1_BSSOREL	0x0000080000	/* output relocation against bss */
502 					/*	section */
503 #define	FLG_OF1_TLSOREL	0x0000100000	/* output relocation against .tlsbss */
504 					/*	section */
505 #define	FLG_OF1_MEMORY	0x0000200000	/* produce a memory model */
506 #define	FLG_OF1_NGLBDIR	0x0000400000	/* no DT_1_DIRECT flag allowed */
507 #define	FLG_OF1_ENCDIFF	0x0000800000	/* host running linker has different */
508 					/*	byte order than output object */
509 #define	FLG_OF1_VADDR	0x0001000000	/* a segment defines explicit vaddr */
510 #define	FLG_OF1_EXTRACT	0x0002000000	/* archive member has been extracted */
511 #define	FLG_OF1_RESCAN	0x0004000000	/* any archives should be rescanned */
512 #define	FLG_OF1_IGNPRC	0x0008000000	/* ignore processing required */
513 #define	FLG_OF1_NCSTTAB	0x0010000000	/* -znocompstrtab set */
514 #define	FLG_OF1_DONE	0x0020000000	/* link-editor processing complete */
515 #define	FLG_OF1_NONREG	0x0040000000	/* non-regular file specified as */
516 					/*	the output file */
517 #define	FLG_OF1_ALNODIR	0x0080000000	/* establish NODIRECT for all */
518 					/*	exported interfaces. */
519 #define	FLG_OF1_OVHWCAP1 0x0100000000	/* override CA_SUNW_HW_1 capabilities */
520 #define	FLG_OF1_OVSFCAP1 0x0200000000	/* override CA_SUNW_SF_1 capabilities */
521 #define	FLG_OF1_OVHWCAP2 0x0400000000	/* override CA_SUNW_HW_2 capabilities */
522 #define	FLG_OF1_OVMACHCAP 0x0800000000	/* override CA_SUNW_MACH capability */
523 #define	FLG_OF1_OVPLATCAP 0x1000000000	/* override CA_SUNW_PLAT capability */
524 #define	FLG_OF1_OVIDCAP	0x2000000000	/* override CA_SUNW_ID capability */
525 
526 /*
527  * Guidance flags. The flags with the FLG_OFG_NO_ prefix are used to suppress
528  * messages for a given category, and use the lower 28 bits of the word,
529  * The upper nibble is reserved for other guidance status.
530  */
531 #define	FLG_OFG_ENABLE		0x10000000	/* -z guidance option active */
532 #define	FLG_OFG_ISSUED		0x20000000	/* -z guidance message issued */
533 
534 #define	FLG_OFG_NO_ALL		0x0fffffff	/* disable all guidance */
535 #define	FLG_OFG_NO_DEFS		0x00000001	/* specify all dependencies */
536 #define	FLG_OFG_NO_DB		0x00000002	/* use direct bindings */
537 #define	FLG_OFG_NO_LAZY		0x00000004	/* be explicit about lazyload */
538 #define	FLG_OFG_NO_MF		0x00000008	/* use v2 mapfile syntax */
539 #define	FLG_OFG_NO_TEXT		0x00000010	/* verify pure text segment */
540 #define	FLG_OFG_NO_UNUSED	0x00000020	/* remove unused dependency */
541 
542 /*
543  * Test to see if a guidance should be given for a given category
544  * or not. _no_flag is one of the FLG_OFG_NO_xxx flags. Returns TRUE
545  * if the guidance should be issued, and FALSE to remain silent.
546  */
547 #define	OFL_GUIDANCE(_ofl, _no_flag) (((_ofl)->ofl_guideflags & \
548 	(FLG_OFG_ENABLE | (_no_flag))) == FLG_OFG_ENABLE)
549 
550 /*
551  * Test to see if the output file would allow the presence of
552  * a .dynsym section.
553  */
554 #define	OFL_ALLOW_DYNSYM(_ofl) (((_ofl)->ofl_flags & \
555 	(FLG_OF_DYNAMIC | FLG_OF_RELOBJ)) == FLG_OF_DYNAMIC)
556 
557 /*
558  * Test to see if the output file would allow the presence of
559  * a .SUNW_ldynsym section. The requirements are that a .dynsym
560  * is allowed, and -znoldynsym has not been specified. Note that
561  * even if the answer is True (1), we will only generate one if there
562  * are local symbols that require it.
563  */
564 #define	OFL_ALLOW_LDYNSYM(_ofl) (((_ofl)->ofl_flags & \
565 	(FLG_OF_DYNAMIC | FLG_OF_RELOBJ | FLG_OF_NOLDYNSYM)) == FLG_OF_DYNAMIC)
566 
567 /*
568  * Test to see if relocation processing should be done. This is normally
569  * true, but can be disabled via the '-z noreloc' option. Note that
570  * relocatable objects are still relocated even if '-z noreloc' is present.
571  */
572 #define	OFL_DO_RELOC(_ofl) (((_ofl)->ofl_flags & FLG_OF_RELOBJ) || \
573 	!((_ofl)->ofl_dtflags_1 & DF_1_NORELOC))
574 
575 /*
576  * Determine whether a static executable is being built.
577  */
578 #define	OFL_IS_STATIC_EXEC(_ofl) (((_ofl)->ofl_flags & \
579 	(FLG_OF_STATIC | FLG_OF_EXEC)) == (FLG_OF_STATIC | FLG_OF_EXEC))
580 
581 /*
582  * Determine whether a static object is being built.  This macro is used
583  * to select the appropriate string table, and symbol table that other
584  * sections need to reference.
585  */
586 #define	OFL_IS_STATIC_OBJ(_ofl) ((_ofl)->ofl_flags & \
587 	(FLG_OF_RELOBJ | FLG_OF_STATIC))
588 
589 /*
590  * Macros for counting symbol table entries.  These are used to size symbol
591  * tables and associated sections (.syminfo, SUNW_capinfo, .hash, etc.) and
592  * set required sh_info entries (the offset to the first global symbol).
593  */
594 #define	SYMTAB_LOC_CNT(_ofl)		/* local .symtab entries */	\
595 	(2 +				/*    NULL and STT_FILE */	\
596 	(_ofl)->ofl_shdrcnt +		/*    section symbol */		\
597 	(_ofl)->ofl_caploclcnt +	/*    local capabilities */	\
598 	(_ofl)->ofl_scopecnt +		/*    scoped symbols */		\
599 	(_ofl)->ofl_locscnt)		/*    standard locals */
600 #define	SYMTAB_ALL_CNT(_ofl)		/* all .symtab entries */	\
601 	(SYMTAB_LOC_CNT(_ofl) +		/*    .symtab locals */		\
602 	(_ofl)->ofl_globcnt)		/*    standard globals */
603 
604 #define	DYNSYM_LOC_CNT(_ofl)		/* local .dynsym entries */	\
605 	(1 +				/*    NULL */			\
606 	(_ofl)->ofl_dynshdrcnt +	/*    section symbols */	\
607 	(_ofl)->ofl_caploclcnt +	/*    local capabilities */	\
608 	(_ofl)->ofl_lregsymcnt)		/*    local register symbols */
609 #define	DYNSYM_ALL_CNT(_ofl)		/* all .dynsym entries */	\
610 	(DYNSYM_LOC_CNT(_ofl) +		/*    .dynsym locals */		\
611 	(_ofl)->ofl_globcnt)		/*    standard globals */
612 
613 /*
614  * Define a move descriptor used within relocation structures.
615  */
616 typedef struct {
617 	Move		*mr_move;
618 	Sym_desc	*mr_sym;
619 } Mv_reloc;
620 
621 /*
622  * Relocation (active & output) processing structure - transparent to common
623  * code. There can be millions of these structures in a large link, so it
624  * is important to keep it small. You should only add new items to Rel_desc
625  * if they are critical, apply to most relocations, and cannot be easily
626  * computed from the other information.
627  *
628  * Items that can be derived should be implemented as a function that accepts
629  * a Rel_desc argument, and returns the desired data. ld_reloc_sym_name() is
630  * an example of this.
631  *
632  * Lesser used relocation data is kept in an auxiliary block, Rel_aux,
633  * that is only allocated as necessary. In exchange for adding one pointer
634  * of overhead to Rel_desc (rel_aux), most relocations are reduced in size
635  * by the size of Rel_aux. This strategy relies on the data in Rel_aux
636  * being rarely needed --- otherwise it will backfire badly.
637  *
638  * Note that rel_raddend is primarily only of interest to RELA relocations,
639  * and is set to 0 for REL. However, there is an exception: If FLG_REL_NADDEND
640  * is set, then rel_raddend contains a replacement value for the implicit
641  * addend found in the relocation target.
642  *
643  * Fields should be ordered from largest to smallest, to minimize packing
644  * holes in the struct layout.
645  */
646 struct rel_desc {
647 	Is_desc		*rel_isdesc;	/* input section reloc is against */
648 	Sym_desc	*rel_sym;	/* sym relocation is against */
649 	Rel_aux		*rel_aux;	/* NULL, or auxiliary data */
650 	Xword		rel_roffset;	/* relocation offset */
651 	Sxword		rel_raddend;	/* addend from input relocation */
652 	Word		rel_flags;	/* misc. flags for relocations */
653 	Word		rel_rtype;	/* relocation type */
654 };
655 
656 /*
657  * Data that would be kept in Rel_desc if the size of that structure was
658  * not an issue. This auxiliary block is only allocated as needed,
659  * and must only contain rarely needed items. The goal is for the vast
660  * majority of Rel_desc structs to not have an auxiliary block.
661  *
662  * When a Rel_desc does not have an auxiliary block, a default value
663  * is assumed for each auxiliary item:
664  *
665  * -	ra_osdesc:
666  *	Output section to which relocation applies. The default
667  *	value for this is the output section associated with the
668  *	input section (rel_isdesc->is_osdesc), or NULL if there
669  *	is no associated input section.
670  *
671  * -	ra_usym:
672  *	If the symbol associated with a relocation is part of a weak/strong
673  *	pair, then ra_usym contains the strong symbol and rel_sym the weak.
674  *	Otherwise, the default value is the same value as rel_sym.
675  *
676  * -	ra_move:
677  *	Move table data. The default value is NULL.
678  *
679  * -	ra_typedata:
680  *	ELF_R_TYPE_DATA(info). This value applies only to a small
681  *	subset of 64-bit sparc relocations, and is otherwise 0. The
682  *	default value is 0.
683  *
684  * If any value in Rel_aux is non-default, then an auxiliary block is
685  * necessary, and each field contains its actual value. If all the auxiliary
686  * values are default, no Rel_aux is needed, and the RELAUX_GET_xxx()
687  * macros below are able to supply the proper default.
688  *
689  * To set a Rel_aux value, use the ld_reloc_set_aux_XXX() functions.
690  * These functions are written to avoid unnecessary auxiliary allocations,
691  * and know the rules for each item.
692  */
693 struct rel_aux {
694 	Os_desc		*ra_osdesc;	/* output section reloc is against */
695 	Sym_desc	*ra_usym;	/* strong sym if this is a weak pair */
696 	Mv_reloc	*ra_move;	/* move table information */
697 	Word		ra_typedata;	/* ELF_R_TYPE_DATA(info) */
698 };
699 
700 /*
701  * Test a given auxiliary value to determine if it has the default value
702  * for that item, as described above. If all the auxiliary items have
703  * their default values, no auxiliary place is necessary to represent them.
704  * If any one of them is non-default, the auxiliary block is needed.
705  */
706 #define	RELAUX_ISDEFAULT_MOVE(_rdesc, _mv) (_mv == NULL)
707 #define	RELAUX_ISDEFAULT_USYM(_rdesc, _usym) ((_rdesc)->rel_sym == _usym)
708 #define	RELAUX_ISDEFAULT_OSDESC(_rdesc, _osdesc) \
709 	((((_rdesc)->rel_isdesc == NULL) && (_osdesc == NULL)) || \
710 	((_rdesc)->rel_isdesc && ((_rdesc)->rel_isdesc->is_osdesc == _osdesc)))
711 #define	RELAUX_ISDEFAULT_TYPEDATA(_rdesc, _typedata) (_typedata == 0)
712 
713 /*
714  * Retrieve the value of an auxiliary relocation item, preserving the illusion
715  * that every relocation descriptor has an auxiliary block attached. The
716  * real implementation is that an auxiliary block is only present if one or
717  * more auxiliary items have non-default values. These macros return the true
718  * value if an auxiliary block is present, and the default value for the
719  * item otherwise.
720  */
721 #define	RELAUX_GET_MOVE(_rdesc) \
722 	((_rdesc)->rel_aux ? (_rdesc)->rel_aux->ra_move : NULL)
723 #define	RELAUX_GET_USYM(_rdesc) \
724 	((_rdesc)->rel_aux ? (_rdesc)->rel_aux->ra_usym : (_rdesc)->rel_sym)
725 #define	RELAUX_GET_OSDESC(_rdesc) \
726 	((_rdesc)->rel_aux ? (_rdesc)->rel_aux->ra_osdesc : \
727 	((_rdesc)->rel_isdesc ? (_rdesc)->rel_isdesc->is_osdesc : NULL))
728 #define	RELAUX_GET_TYPEDATA(_rdesc) \
729 	((_rdesc)->rel_aux ? (_rdesc)->rel_aux->ra_typedata : 0)
730 
731 /*
732  * common flags used on the Rel_desc structure (defined in machrel.h).
733  */
734 #define	FLG_REL_GOT	0x00000001	/* relocation against GOT */
735 #define	FLG_REL_PLT	0x00000002	/* relocation against PLT */
736 #define	FLG_REL_BSS	0x00000004	/* relocation against BSS */
737 #define	FLG_REL_LOAD	0x00000008	/* section loadable */
738 #define	FLG_REL_SCNNDX	0x00000010	/* use section index for symbol ndx */
739 #define	FLG_REL_CLVAL	0x00000020	/* clear VALUE for active relocation */
740 #define	FLG_REL_ADVAL	0x00000040	/* add VALUE for output relocation, */
741 					/*	only relevant to SPARC and */
742 					/*	R_SPARC_RELATIVE */
743 #define	FLG_REL_GOTCL	0x00000080	/* clear the GOT entry.  This is */
744 					/* relevant to RELA relocations, */
745 					/* not REL (i386) relocations */
746 #define	FLG_REL_MOVETAB	0x00000100	/* Relocation against .SUNW_move */
747 					/*	adjustments required before */
748 					/*	actual relocation */
749 #define	FLG_REL_NOINFO	0x00000200	/* Relocation comes from a section */
750 					/*	with a null sh_info field */
751 #define	FLG_REL_REG	0x00000400	/* Relocation target is reg sym */
752 #define	FLG_REL_FPTR	0x00000800	/* relocation against func. desc. */
753 #define	FLG_REL_RFPTR1	0x00001000	/* Relative relocation against */
754 					/*   1st part of FD */
755 #define	FLG_REL_RFPTR2	0x00002000	/* Relative relocation against */
756 					/*   2nd part of FD */
757 #define	FLG_REL_DISP	0x00004000	/* *disp* relocation */
758 #define	FLG_REL_STLS	0x00008000	/* IE TLS reference to */
759 					/*	static TLS GOT index */
760 #define	FLG_REL_DTLS	0x00010000	/* GD TLS reference relative to */
761 					/*	dynamic TLS GOT index */
762 #define	FLG_REL_MTLS	0x00020000	/* LD TLS reference against GOT */
763 #define	FLG_REL_STTLS	0x00040000	/* LE TLS reference directly */
764 					/*	to static tls index */
765 #define	FLG_REL_TLSFIX	0x00080000	/* relocation points to TLS instr. */
766 					/*	which needs updating */
767 #define	FLG_REL_RELA	0x00100000	/* descriptor captures a Rela */
768 #define	FLG_REL_GOTFIX	0x00200000	/* relocation points to GOTOP instr. */
769 					/*	which needs updating */
770 #define	FLG_REL_NADDEND	0x00400000	/* Replace implicit addend in dest */
771 					/*	with value in rel_raddend */
772 					/*	Relevant to REL (i386) */
773 					/*	relocations, not to RELA. */
774 
775 /*
776  * We often need the name of the symbol contained in a relocation descriptor
777  * for diagnostic or error output. This is usually the symbol name, but
778  * we substitute a constructed name in some cases. Hence, the name is
779  * generated on the fly by a private function within libld. This is the
780  * prototype for that function.
781  */
782 typedef const char *(* rel_desc_sname_func_t)(Rel_desc *);
783 
784 /*
785  * Header for a relocation descriptor cache buffer.
786  */
787 struct rel_cachebuf {
788 	Rel_desc	*rc_end;
789 	Rel_desc	*rc_free;
790 	Rel_desc	rc_arr[1];
791 };
792 
793 /*
794  * Header for a relocation auxiliary descriptor cache buffer.
795  */
796 struct rel_aux_cachebuf {
797 	Rel_aux		*rac_end;
798 	Rel_aux		*rac_free;
799 	Rel_aux		rac_arr[1];
800 };
801 
802 /*
803  * Convenience macro for traversing every relocation descriptor found within
804  * a given relocation cache, transparently handling the cache buffers and
805  * skipping any unallocated descriptors within the buffers.
806  *
807  * entry:
808  *	_rel_cache - Relocate descriptor cache (Rel_cache) to traverse
809  *	_idx - Aliste index variable for use by the macro
810  *	_rcbp - Cache buffer pointer, for use by the macro
811  *	_orsp - Rel_desc pointer, which will take on the value of a different
812  *		relocation descriptor in the cache in each iteration.
813  *
814  * The caller must not assign new values to _idx, _rcbp, or _orsp within
815  * the scope of REL_CACHE_TRAVERSE.
816  */
817 #define	REL_CACHE_TRAVERSE(_rel_cache, _idx, _rcbp, _orsp) \
818 	for (APLIST_TRAVERSE((_rel_cache)->rc_list, _idx, _rcbp)) \
819 		for (_orsp = _rcbp->rc_arr; _orsp < _rcbp->rc_free; _orsp++)
820 
821 /*
822  * Symbol value descriptor.  For relocatable objects, each symbols value is
823  * its offset within its associated section.  Therefore, to uniquely define
824  * each symbol within a relocatable object, record and sort the sh_offset and
825  * symbol value.  This information is used to search for displacement
826  * relocations as part of copy relocation validation.
827  */
828 typedef struct {
829 	Addr		ssv_value;
830 	Sym_desc	*ssv_sdp;
831 } Ssv_desc;
832 
833 /*
834  * Input file processing structures.
835  */
836 struct ifl_desc {			/* input file descriptor */
837 	const char	*ifl_name;	/* full file name */
838 	const char	*ifl_soname;	/* shared object name */
839 	dev_t		ifl_stdev;	/* device id and inode number for .so */
840 	ino_t		ifl_stino;	/*	multiple inclusion checks */
841 	Ehdr		*ifl_ehdr;	/* elf header describing this file */
842 	Elf		*ifl_elf;	/* elf descriptor for this file */
843 	Sym_desc	**ifl_oldndx;	/* original symbol table indices */
844 	Sym_desc	*ifl_locs;	/* symbol desc version of locals */
845 	Ssv_desc	*ifl_sortsyms;	/* sorted list of symbols by value */
846 	Word		ifl_locscnt;	/* no. of local symbols to process */
847 	Word		ifl_symscnt;	/* total no. of symbols to process */
848 	Word		ifl_sortcnt;	/* no. of sorted symbols to process */
849 	Word		ifl_shnum;	/* number of sections in file */
850 	Word		ifl_shstrndx;	/* index to .shstrtab */
851 	Word		ifl_vercnt;	/* number of versions in file */
852 	Half		ifl_neededndx;	/* index to NEEDED in .dyn section */
853 	Word		ifl_flags;	/* explicit/implicit reference */
854 	Is_desc		**ifl_isdesc;	/* isdesc[scn ndx] = Is_desc ptr */
855 	Sdf_desc	*ifl_sdfdesc;	/* control definition */
856 	Versym		*ifl_versym;	/* version symbol table array */
857 	Ver_index	*ifl_verndx;	/* verndx[ver ndx] = Ver_index */
858 	APlist		*ifl_verdesc;	/* version descriptor list */
859 	APlist		*ifl_relsect;	/* relocation section list */
860 	Alist		*ifl_groups;	/* SHT_GROUP section list */
861 	Cap_desc	*ifl_caps;	/* capabilities descriptor */
862 };
863 
864 #define	FLG_IF_CMDLINE	0x00000001	/* full filename specified from the */
865 					/*	command line (no -l) */
866 #define	FLG_IF_NEEDED	0x00000002	/* shared object should be recorded */
867 #define	FLG_IF_DIRECT	0x00000004	/* establish direct bindings to this */
868 					/*	object */
869 #define	FLG_IF_EXTRACT	0x00000008	/* file extracted from an archive */
870 #define	FLG_IF_VERNEED	0x00000010	/* version dependency information is */
871 					/*	required */
872 #define	FLG_IF_DEPREQD	0x00000020	/* dependency is required to satisfy */
873 					/*	symbol references */
874 #define	FLG_IF_NEEDSTR	0x00000040	/* dependency specified by -Nn */
875 					/*	flag */
876 #define	FLG_IF_IGNORE	0x00000080	/* ignore unused dependencies */
877 #define	FLG_IF_NODIRECT	0x00000100	/* object contains symbols that */
878 					/*	cannot be directly bound to */
879 #define	FLG_IF_LAZYLD	0x00000200	/* dependency should be lazy loaded */
880 #define	FLG_IF_GRPPRM	0x00000400	/* dependency establishes a group */
881 #define	FLG_IF_DISPPEND 0x00000800	/* displacement relocation done */
882 					/*	in the ld time. */
883 #define	FLG_IF_DISPDONE 0x00001000	/* displacement relocation done */
884 					/*	at the run time */
885 #define	FLG_IF_MAPFILE	0x00002000	/* file is a mapfile */
886 #define	FLG_IF_HSTRTAB	0x00004000	/* file has a string section */
887 #define	FLG_IF_FILEREF	0x00008000	/* file contains a section which */
888 					/*	is included in the output */
889 					/*	allocatable image */
890 #define	FLG_IF_GNUVER	0x00010000	/* file used GNU-style versioning */
891 #define	FLG_IF_ORDERED	0x00020000	/* ordered section processing */
892 					/*	required */
893 #define	FLG_IF_OTOSCAP	0x00040000	/* convert object capabilities to */
894 					/*	symbol capabilities */
895 #define	FLG_IF_DEFERRED	0x00080000	/* dependency is deferred */
896 #define	FLG_IF_RTLDINF	0x00100000	/* dependency has DT_SUNW_RTLTINF set */
897 #define	FLG_IF_GROUPS	0x00200000	/* input file has groups to process */
898 
899 /*
900  * Symbol states that require the generation of a DT_POSFLAG_1 .dynamic entry.
901  */
902 #define	MSK_IF_POSFLAG1	(FLG_IF_LAZYLD | FLG_IF_GRPPRM | FLG_IF_DEFERRED)
903 
904 /*
905  * Symbol states that require an associated Syminfo entry.
906  */
907 #define	MSK_IF_SYMINFO	(FLG_IF_LAZYLD | FLG_IF_DIRECT | FLG_IF_DEFERRED)
908 
909 
910 struct is_desc {			/* input section descriptor */
911 	const char	*is_name;	/* original section name */
912 	const char	*is_sym_name;	/* NULL, or name string to use for */
913 					/*	related STT_SECTION symbols */
914 	Shdr		*is_shdr;	/* the elf section header */
915 	Ifl_desc	*is_file;	/* infile desc for this section */
916 	Os_desc		*is_osdesc;	/* new output section for this */
917 					/*	input section */
918 	Elf_Data	*is_indata;	/* input sections raw data */
919 	Is_desc		*is_symshndx;	/* related SHT_SYM_SHNDX section */
920 	Is_desc		*is_comdatkeep;	/* If COMDAT section is discarded, */
921 					/*	this is section that was kept */
922 	Word		is_scnndx;	/* original section index in file */
923 	Word		is_ordndx;	/* index for section.  Used to decide */
924 					/*	where to insert section when */
925 					/*	reordering sections */
926 	Word		is_keyident;	/* key for SHF_{ORDERED|LINK_ORDER} */
927 					/*	processing and ident used for */
928 					/*	 placing/ordering sections */
929 	Word		is_flags;	/* Various flags */
930 };
931 
932 #define	FLG_IS_ORDERED	0x0001		/* this is a SHF_ORDERED section */
933 #define	FLG_IS_KEY	0x0002		/* section requires sort keys */
934 #define	FLG_IS_DISCARD	0x0004		/* section is to be discarded */
935 #define	FLG_IS_RELUPD	0x0008		/* symbol defined here may have moved */
936 #define	FLG_IS_SECTREF	0x0010		/* section has been referenced */
937 #define	FLG_IS_GDATADEF	0x0020		/* section contains global data sym */
938 #define	FLG_IS_EXTERNAL	0x0040		/* isp from a user file */
939 #define	FLG_IS_INSTRMRG	0x0080		/* Usable SHF_MERGE|SHF_STRINGS sec */
940 #define	FLG_IS_GNSTRMRG	0x0100		/* Generated mergeable string section */
941 
942 #define	FLG_IS_PLACE	0x0400		/* section requires to be placed */
943 #define	FLG_IS_COMDAT	0x0800		/* section is COMDAT */
944 #define	FLG_IS_EHFRAME	0x1000		/* section is .eh_frame */
945 
946 /*
947  * Output sections contain lists of input sections that are assigned to them.
948  * These items fall into 4 categories:
949  *	BEFORE - Ordered sections that specify SHN_BEFORE, in input order.
950  *	ORDERED - Ordered sections that are sorted using unsorted sections
951  *		as the sort key.
952  *	DEFAULT - Sections that are placed into the output section
953  *		in input order.
954  *	AFTER - Ordered sections that specify SHN_AFTER, in input order.
955  */
956 #define	OS_ISD_BEFORE	0
957 #define	OS_ISD_ORDERED	1
958 #define	OS_ISD_DEFAULT	2
959 #define	OS_ISD_AFTER	3
960 #define	OS_ISD_NUM	4
961 typedef APlist *os_isdecs_arr[OS_ISD_NUM];
962 
963 /*
964  * Convenience macro for traversing every input section associated
965  * with a given output section. The primary benefit of this macro
966  * is that it preserves a precious level of code indentation in the
967  * code that uses it.
968  */
969 #define	OS_ISDESCS_TRAVERSE(_list_idx, _osp, _idx, _isp) \
970 	for (_list_idx = 0; _list_idx < OS_ISD_NUM; _list_idx++) \
971 		for (APLIST_TRAVERSE(_osp->os_isdescs[_list_idx], _idx, _isp))
972 
973 
974 /*
975  * Map file and output file processing structures
976  */
977 struct os_desc {			/* Output section descriptor */
978 	const char	*os_name;	/* the section name */
979 	Elf_Scn		*os_scn;	/* the elf section descriptor */
980 	Shdr		*os_shdr;	/* the elf section header */
981 	Os_desc		*os_relosdesc;	/* the output relocation section */
982 	APlist		*os_relisdescs;	/* reloc input section descriptors */
983 					/*	for this output section */
984 	os_isdecs_arr	os_isdescs;	/* lists of input sections in output */
985 	APlist		*os_mstrisdescs; /* FLG_IS_INSTRMRG input sections */
986 	Sg_desc		*os_sgdesc;	/* segment os_desc is placed on */
987 	Elf_Data	*os_outdata;	/* output sections raw data */
988 	avl_tree_t	*os_comdats;	/* AVL tree of COMDAT input sections */
989 					/*	associated to output section */
990 	Word		os_identndx;	/* section identifier for input */
991 					/*	section processing, followed */
992 					/*	by section symbol index */
993 	Word		os_ordndx;	/* index for section.  Used to decide */
994 					/*	where to insert section when */
995 					/*	reordering sections */
996 	Xword		os_szoutrels;	/* size of output relocation section */
997 	uint_t		os_namehash;	/* hash on section name */
998 	uchar_t		os_flags;	/* various flags */
999 };
1000 
1001 #define	FLG_OS_KEY		0x01	/* section requires sort keys */
1002 #define	FLG_OS_OUTREL		0x02	/* output rel against this section */
1003 #define	FLG_OS_SECTREF		0x04	/* isps are not affected by -zignore */
1004 #define	FLG_OS_EHFRAME		0x08	/* section is .eh_frame */
1005 
1006 /*
1007  * The sg_id field of the segment descriptor is used to establish the default
1008  * order for program headers and segments in the output object. Segments are
1009  * ordered according to the following SGID values that classify them based on
1010  * their attributes. The initial set of built in segments are in this order,
1011  * and new mapfile defined segments are inserted into these groups. Within a
1012  * given SGID group, the position of new segments depends on the syntax
1013  * version of the mapfile that creates them. Version 1 (original sysv)
1014  * mapfiles place the new segment at the head of their group (reverse creation
1015  * order). The newer syntax places them at the end, following the others
1016  * (creation order).
1017  *
1018  * Note that any new segments must always be added after PT_PHDR and
1019  * PT_INTERP (refer Generic ABI, Page 5-4).
1020  */
1021 #define	SGID_PHDR	0	/* PT_PHDR */
1022 #define	SGID_INTERP	1	/* PT_INTERP */
1023 #define	SGID_SUNWCAP	2	/* PT_SUNWCAP */
1024 #define	SGID_TEXT	3	/* PT_LOAD */
1025 #define	SGID_DATA	4	/* PT_LOAD */
1026 #define	SGID_BSS	5	/* PT_LOAD */
1027 #if	defined(_ELF64)
1028 #define	SGID_LRODATA	6	/* PT_LOAD (amd64-only) */
1029 #define	SGID_LDATA	7	/* PT_LOAD (amd64-only) */
1030 #endif
1031 #define	SGID_TEXT_EMPTY	8	/* PT_LOAD, reserved (?E in version 1 syntax) */
1032 #define	SGID_NULL_EMPTY	9	/* PT_NULL, reserved (?E in version 1 syntax) */
1033 #define	SGID_DYN	10	/* PT_DYNAMIC */
1034 #define	SGID_DTRACE	11	/* PT_SUNWDTRACE */
1035 #define	SGID_TLS	12	/* PT_TLS */
1036 #define	SGID_UNWIND	13	/* PT_SUNW_UNWIND */
1037 #define	SGID_SUNWSTACK	14	/* PT_SUNWSTACK */
1038 #define	SGID_NOTE	15	/* PT_NOTE */
1039 #define	SGID_NULL	16	/* PT_NULL,  mapfile defined empty phdr slots */
1040 				/*	for use by post processors */
1041 #define	SGID_EXTRA	17	/* PT_NULL (final catchall) */
1042 
1043 typedef Half sg_flags_t;
1044 struct sg_desc {			/* output segment descriptor */
1045 	Word		sg_id;		/* segment identifier (for sorting) */
1046 	Phdr		sg_phdr;	/* segment header for output file */
1047 	const char	*sg_name;	/* segment name for PT_LOAD, PT_NOTE, */
1048 					/*	and PT_NULL, otherwise NULL */
1049 	Xword		sg_round;	/* data rounding required (mapfile) */
1050 	Xword		sg_length;	/* maximum segment length; if 0 */
1051 					/*	segment is not specified */
1052 	APlist		*sg_osdescs;	/* list of output section descriptors */
1053 	APlist		*sg_is_order;	/* list of entry criteria */
1054 					/*	giving input section order */
1055 	Alist		*sg_os_order;	/* list specifying output section */
1056 					/*	ordering for the segment */
1057 	sg_flags_t	sg_flags;
1058 	APlist		*sg_sizesym;	/* size symbols for this segment */
1059 	Xword		sg_align;	/* LCM of sh_addralign */
1060 	Elf_Scn		*sg_fscn;	/* the SCN of the first section. */
1061 	avl_node_t	sg_avlnode;	/* AVL book-keeping */
1062 };
1063 
1064 #define	FLG_SG_P_VADDR		0x0001	/* p_vaddr segment attribute set */
1065 #define	FLG_SG_P_PADDR		0x0002	/* p_paddr segment attribute set */
1066 #define	FLG_SG_LENGTH		0x0004	/* length segment attribute set */
1067 #define	FLG_SG_P_ALIGN		0x0008	/* p_align segment attribute set */
1068 #define	FLG_SG_ROUND		0x0010	/* round segment attribute set */
1069 #define	FLG_SG_P_FLAGS		0x0020	/* p_flags segment attribute set */
1070 #define	FLG_SG_P_TYPE		0x0040	/* p_type segment attribute set */
1071 #define	FLG_SG_IS_ORDER		0x0080	/* input section ordering is required */
1072 					/*	for this segment. */
1073 #define	FLG_SG_NOHDR		0x0100	/* don't map ELF or phdrs into */
1074 					/*	this segment */
1075 #define	FLG_SG_EMPTY		0x0200	/* an empty segment specification */
1076 					/*	no input sections will be */
1077 					/*	associated to this section */
1078 #define	FLG_SG_KEY		0x0400	/* segment requires sort keys */
1079 #define	FLG_SG_NODISABLE	0x0800	/* FLG_SG_DISABLED is not allowed on */
1080 					/*	this segment */
1081 #define	FLG_SG_DISABLED		0x1000	/* this segment is disabled */
1082 #define	FLG_SG_PHREQ		0x2000	/* this segment requires a program */
1083 					/* header */
1084 #define	FLG_SG_ORDERED		0x4000	/* SEGMENT_ORDER segment */
1085 
1086 struct sec_order {
1087 	const char	*sco_secname;	/* section name to be ordered */
1088 	Half		sco_flags;
1089 };
1090 
1091 #define	FLG_SGO_USED	0x0001		/* was ordering used? */
1092 
1093 typedef Half ec_flags_t;
1094 struct ent_desc {			/* input section entrance criteria */
1095 	const char	*ec_name;	/* entrace criteria name, or NULL */
1096 	Alist		*ec_files;	/* files from which to accept */
1097 					/*	sections */
1098 	const char	*ec_is_name;	/* input section name to match */
1099 					/*	(NULL if none) */
1100 	Word		ec_type;	/* section type */
1101 	Word		ec_attrmask;	/* section attribute mask (AWX) */
1102 	Word		ec_attrbits;	/* sections attribute bits */
1103 	Sg_desc		*ec_segment;	/* output segment to enter if matched */
1104 	Word		ec_ordndx;	/* index to determine where section */
1105 					/*	meeting this criteria should */
1106 					/*	inserted. Used for reordering */
1107 					/*	of sections. */
1108 	ec_flags_t	ec_flags;
1109 	avl_node_t	ec_avlnode;	/* AVL book-keeping */
1110 };
1111 
1112 #define	FLG_EC_BUILTIN	0x0001		/* built in descriptor */
1113 #define	FLG_EC_USED	0x0002		/* entrance criteria met? */
1114 #define	FLG_EC_CATCHALL	0x0004		/* Catches any section */
1115 
1116 /*
1117  * Ent_desc_file is the type of element maintained in the ec_files Alist
1118  * of an entrance criteria descriptor. Each item maintains one file
1119  * path, and a set of flags that specify the type of comparison it implies,
1120  * and other information about it. The comparison type is maintained in
1121  * the bottom byte of the flags.
1122  */
1123 #define	TYP_ECF_MASK		0x00ff  /* Comparison type mask */
1124 #define	TYP_ECF_PATH		0	/* Compare to file path */
1125 #define	TYP_ECF_BASENAME	1	/* Compare to file basename */
1126 #define	TYP_ECF_OBJNAME		2	/* Compare to regular file basename, */
1127 					/*	 or to archive member name */
1128 #define	TYP_ECF_NUM		3
1129 
1130 #define	FLG_ECF_ARMEMBER	0x0100	/* name includes archive member */
1131 
1132 typedef struct {
1133 	Word		edf_flags;	/* Type of comparison */
1134 	const char	*edf_name;	/* String to compare to */
1135 	size_t		edf_name_len;	/* strlen(edf_name) */
1136 } Ent_desc_file;
1137 
1138 /*
1139  * One structure is allocated for a move entry, and associated to the symbol
1140  * against which a move is targeted.
1141  */
1142 typedef struct {
1143 	Move		*md_move;	/* original Move entry */
1144 	Xword		md_start;	/* start position */
1145 	Xword		md_len;		/* length of initialization */
1146 	Word		md_oidx;	/* output Move entry index */
1147 } Mv_desc;
1148 
1149 /*
1150  * Symbol descriptor.
1151  */
1152 typedef	Lword		sd_flag_t;
1153 struct sym_desc {
1154 	Alist		*sd_GOTndxs;	/* list of associated GOT entries */
1155 	Sym		*sd_sym;	/* pointer to symbol table entry */
1156 	Sym		*sd_osym;	/* copy of the original symbol entry */
1157 					/*	used only for local partial */
1158 	Alist		*sd_move;	/* move information associated with a */
1159 					/*	partially initialized symbol */
1160 	const char	*sd_name;	/* symbols name */
1161 	Ifl_desc	*sd_file;	/* file where symbol is taken */
1162 	Is_desc		*sd_isc;	/* input section of symbol definition */
1163 	Sym_aux		*sd_aux;	/* auxiliary global symbol info. */
1164 	Word		sd_symndx;	/* index in output symbol table */
1165 	Word		sd_shndx;	/* sect. index sym is associated w/ */
1166 	sd_flag_t	sd_flags;	/* state flags */
1167 	Half		sd_ref;		/* reference definition of symbol */
1168 };
1169 
1170 /*
1171  * The auxiliary symbol descriptor contains the additional information (beyond
1172  * the symbol descriptor) required to process global symbols.  These symbols are
1173  * accessed via an internal symbol hash table where locality of reference is
1174  * important for performance.
1175  */
1176 struct sym_aux {
1177 	APlist		*sa_dfiles;	/* files where symbol is defined */
1178 	Sym		sa_sym;		/* copy of symtab entry */
1179 	const char	*sa_vfile;	/* first unavailable definition */
1180 	const char	*sa_rfile;	/* file with first symbol referenced */
1181 	Word		sa_hash;	/* the pure hash value of symbol */
1182 	Word		sa_PLTndx;	/* index into PLT for symbol */
1183 	Word		sa_PLTGOTndx;	/* GOT entry indx for PLT indirection */
1184 	Word		sa_linkndx;	/* index of associated symbol from */
1185 					/*	ET_DYN file */
1186 	Half		sa_symspec;	/* special symbol ids */
1187 	Half		sa_overndx;	/* output file versioning index */
1188 	Half		sa_dverndx;	/* dependency versioning index */
1189 	Os_desc		*sa_boundsec;	/* output section of SECBOUND_ syms */
1190 };
1191 
1192 /*
1193  * Nodes used to track symbols in the global AVL symbol dictionary.
1194  */
1195 struct sym_avlnode {
1196 	avl_node_t	sav_node;	/* AVL node */
1197 	Word		sav_hash;	/* symbol hash value */
1198 	const char	*sav_name;	/* symbol name */
1199 	Sym_desc	*sav_sdp;	/* symbol descriptor */
1200 };
1201 
1202 /*
1203  * These are the ids for processing of `Special symbols'.  They are used
1204  * to set the sym->sd_aux->sa_symspec field.
1205  */
1206 #define	SDAUX_ID_ETEXT		1	/* etext && _etext symbol */
1207 #define	SDAUX_ID_EDATA		2	/* edata && _edata symbol */
1208 #define	SDAUX_ID_END		3	/* end, _end, && _END_ symbol */
1209 #define	SDAUX_ID_DYN		4	/* DYNAMIC && _DYNAMIC symbol */
1210 #define	SDAUX_ID_PLT		5	/* _PROCEDURE_LINKAGE_TABLE_ symbol */
1211 #define	SDAUX_ID_GOT		6	/* _GLOBAL_OFFSET_TABLE_ symbol */
1212 #define	SDAUX_ID_START		7	/* START_ && _START_ symbol */
1213 #define	SDAUX_ID_SECBOUND_START	8	/* __start_<section> symbols */
1214 #define	SDAUX_ID_SECBOUND_STOP	9	/* __stop_<section> symbols */
1215 
1216 /*
1217  * Flags for sym_desc.sd_flags
1218  */
1219 #define	FLG_SY_MVTOCOMM	0x00000001	/* assign symbol to common (.bss) */
1220 					/*	this is a result of a */
1221 					/*	copy reloc against sym */
1222 #define	FLG_SY_GLOBREF	0x00000002	/* a global reference has been seen */
1223 #define	FLG_SY_WEAKDEF	0x00000004	/* a weak definition has been used */
1224 #define	FLG_SY_CLEAN	0x00000008	/* `Sym' entry points to original */
1225 					/*	input file (read-only). */
1226 #define	FLG_SY_UPREQD	0x00000010	/* symbol value update is required, */
1227 					/*	either it's used as an entry */
1228 					/*	point or for relocation, but */
1229 					/*	it must be updated even if */
1230 					/*	the -s flag is in effect */
1231 #define	FLG_SY_NOTAVAIL	0x00000020	/* symbol is not available to the */
1232 					/*	application either because it */
1233 					/*	originates from an implicitly */
1234 					/*	referenced shared object, or */
1235 					/*	because it is not part of a */
1236 					/*	specified version. */
1237 #define	FLG_SY_REDUCED	0x00000040	/* a global is reduced to local */
1238 #define	FLG_SY_VERSPROM	0x00000080	/* version definition has been */
1239 					/*	promoted to output file */
1240 #define	FLG_SY_PROT	0x00000100	/* stv_protected visibility seen */
1241 #define	FLG_SY_MAPREF	0x00000200	/* symbol reference generated by user */
1242 					/*	from mapfile */
1243 #define	FLG_SY_REFRSD	0x00000400	/* symbols sd_ref has been raised */
1244 					/*	due to a copy-relocs */
1245 					/*	weak-strong pairing */
1246 #define	FLG_SY_INTPOSE	0x00000800	/* symbol defines an interposer */
1247 #define	FLG_SY_INVALID	0x00001000	/* unwanted/erroneous symbol */
1248 #define	FLG_SY_SMGOT	0x00002000	/* small got index assigned to symbol */
1249 					/*	sparc only */
1250 #define	FLG_SY_PARENT	0x00004000	/* symbol to be found in parent */
1251 					/*    only used with direct bindings */
1252 #define	FLG_SY_LAZYLD	0x00008000	/* symbol to cause lazyloading of */
1253 					/*	parent object */
1254 #define	FLG_SY_ISDISC	0x00010000	/* symbol is a member of a DISCARDED */
1255 					/*	section (COMDAT) */
1256 #define	FLG_SY_PAREXPN	0x00020000	/* partially init. symbol to be */
1257 					/*	expanded */
1258 #define	FLG_SY_PLTPAD	0x00040000	/* pltpadding has been allocated for */
1259 					/*	this symbol */
1260 #define	FLG_SY_REGSYM	0x00080000	/* REGISTER symbol (sparc only) */
1261 #define	FLG_SY_SOFOUND	0x00100000	/* compared against an SO definition */
1262 #define	FLG_SY_EXTERN	0x00200000	/* symbol is external, allows -zdefs */
1263 					/*    error suppression */
1264 #define	FLG_SY_MAPUSED	0x00400000	/* mapfile symbol used (occurred */
1265 					/*    within a relocatable object) */
1266 #define	FLG_SY_COMMEXP	0x00800000	/* COMMON symbol which has been */
1267 					/*	allocated */
1268 #define	FLG_SY_CMDREF	0x01000000	/* symbol was referenced from the */
1269 					/*	command line.  (ld -u <>, */
1270 					/*	ld -zrtldinfo=<>, ...) */
1271 #define	FLG_SY_SPECSEC	0x02000000	/* section index is reserved value */
1272 					/*	ABS, COMMON, ... */
1273 #define	FLG_SY_TENTSYM	0x04000000	/* tentative symbol */
1274 #define	FLG_SY_VISIBLE	0x08000000	/* symbols visibility determined */
1275 #define	FLG_SY_STDFLTR	0x10000000	/* symbol is a standard filter */
1276 #define	FLG_SY_AUXFLTR	0x20000000	/* symbol is an auxiliary filter */
1277 #define	FLG_SY_DYNSORT	0x40000000	/* req. in dyn[sym|tls]sort section */
1278 #define	FLG_SY_NODYNSORT 0x80000000	/* excluded from dyn[sym_tls]sort sec */
1279 
1280 #define	FLG_SY_DEFAULT	0x0000100000000	/* global symbol, default */
1281 #define	FLG_SY_SINGLE	0x0000200000000	/* global symbol, singleton defined */
1282 #define	FLG_SY_PROTECT	0x0000400000000	/* global symbol, protected defined */
1283 #define	FLG_SY_EXPORT	0x0000800000000	/* global symbol, exported defined */
1284 
1285 #define	MSK_SY_GLOBAL \
1286 	(FLG_SY_DEFAULT | FLG_SY_SINGLE | FLG_SY_PROTECT | FLG_SY_EXPORT)
1287 					/* this mask indicates that the */
1288 					/*    symbol has been explicitly */
1289 					/*    defined within a mapfile */
1290 					/*    definition, and is a candidate */
1291 					/*    for versioning */
1292 
1293 #define	FLG_SY_HIDDEN	0x0001000000000	/* global symbol, reduce to local */
1294 #define	FLG_SY_ELIM	0x0002000000000	/* global symbol, eliminate */
1295 #define	FLG_SY_IGNORE	0x0004000000000	/* global symbol, ignored */
1296 
1297 #define	MSK_SY_LOCAL	(FLG_SY_HIDDEN | FLG_SY_ELIM | FLG_SY_IGNORE)
1298 					/* this mask allows all local state */
1299 					/*    flags to be removed when the */
1300 					/*    symbol is copy relocated */
1301 
1302 #define	FLG_SY_EXPDEF	0x0008000000000	/* symbol visibility defined */
1303 					/*    explicitly */
1304 
1305 #define	MSK_SY_NOAUTO	(FLG_SY_SINGLE | FLG_SY_EXPORT | FLG_SY_EXPDEF)
1306 					/* this mask indicates that the */
1307 					/*    symbol is not a candidate for */
1308 					/*    auto-reduction/elimination */
1309 
1310 #define	FLG_SY_MAPFILE	0x0010000000000	/* symbol attribute defined in a */
1311 					/*    mapfile */
1312 #define	FLG_SY_DIR	0x0020000000000	/* global symbol, direct bindings */
1313 #define	FLG_SY_NDIR	0x0040000000000	/* global symbol, nondirect bindings */
1314 #define	FLG_SY_OVERLAP	0x0080000000000	/* move entry overlap detected */
1315 #define	FLG_SY_CAP	0x0100000000000	/* symbol is associated with */
1316 					/*    capabilities */
1317 #define	FLG_SY_DEFERRED	0x0200000000000	/* symbol should not be bound to */
1318 					/*	during BIND_NOW relocations */
1319 
1320 /*
1321  * A symbol can only be truly hidden if it is not a capabilities symbol.
1322  */
1323 #define	SYM_IS_HIDDEN(_sdp) \
1324 	(((_sdp)->sd_flags & (FLG_SY_HIDDEN | FLG_SY_CAP)) == FLG_SY_HIDDEN)
1325 
1326 /*
1327  * Create a mask for (sym.st_other & visibility) since the gABI does not yet
1328  * define a ELF*_ST_OTHER macro.
1329  */
1330 #define	MSK_SYM_VISIBILITY	0x7
1331 
1332 /*
1333  * Structure to manage the shared object definition lists.  There are two lists
1334  * that use this structure:
1335  *
1336  *  -	ofl_soneed; maintain the list of implicitly required dependencies
1337  *	(ie. shared objects needed by other shared objects).  These definitions
1338  *	may include RPATH's required to locate the dependencies, and any
1339  *	version requirements.
1340  *
1341  *  -	ofl_socntl; maintains the shared object control definitions.  These are
1342  *	provided by the user (via a mapfile) and are used to indicate any
1343  *	version control requirements.
1344  */
1345 struct	sdf_desc {
1346 	const char	*sdf_name;	/* the shared objects file name */
1347 	char		*sdf_rpath;	/* library search path DT_RPATH */
1348 	const char	*sdf_rfile;	/* referencing file for diagnostics */
1349 	Ifl_desc	*sdf_file;	/* the final input file descriptor */
1350 	Alist		*sdf_vers;	/* list of versions that are required */
1351 					/*	from this object */
1352 	Alist		*sdf_verneed;	/* list of VERNEEDS to create for */
1353 					/*	object via mapfile ADDVERS */
1354 	Word		sdf_flags;
1355 };
1356 
1357 #define	FLG_SDF_SELECT	0x01		/* version control selection required */
1358 #define	FLG_SDF_VERIFY	0x02		/* version definition verification */
1359 					/*	required */
1360 #define	FLG_SDF_ADDVER	0x04		/* add VERNEED references */
1361 
1362 /*
1363  * Structure to manage shared object version usage requirements.
1364  */
1365 struct	sdv_desc {
1366 	const char	*sdv_name;	/* version name */
1367 	const char	*sdv_ref;	/* versions reference */
1368 	Word		sdv_flags;	/* flags */
1369 };
1370 
1371 #define	FLG_SDV_MATCHED	0x01		/* VERDEF found and matched */
1372 
1373 /*
1374  * Structures to manage versioning information.  Two versioning structures are
1375  * defined:
1376  *
1377  *   -	a version descriptor maintains a linked list of versions and their
1378  *	associated dependencies.  This is used to build the version definitions
1379  *	for an image being created (see map_symbol), and to determine the
1380  *	version dependency graph for any input files that are versioned.
1381  *
1382  *   -	a version index array contains each version of an input file that is
1383  *	being processed.  It informs us which versions are available for
1384  *	binding, and is used to generate any version dependency information.
1385  */
1386 struct	ver_desc {
1387 	const char	*vd_name;	/* version name */
1388 	Ifl_desc	*vd_file;	/* file that defined version */
1389 	Word		vd_hash;	/* hash value of name */
1390 	Half		vd_ndx;		/* coordinates with symbol index */
1391 	Half		vd_flags;	/* version information */
1392 	APlist		*vd_deps;	/* version dependencies */
1393 	Ver_desc	*vd_ref;	/* dependency's first reference */
1394 };
1395 
1396 struct	ver_index {
1397 	const char	*vi_name;	/* dependency version name */
1398 	Half		vi_flags;	/* communicates availability */
1399 	Half		vi_overndx;	/* index assigned to this version in */
1400 					/*	output object Verneed section */
1401 	Ver_desc	*vi_desc;	/* cross reference to descriptor */
1402 };
1403 
1404 /*
1405  * Define any internal version descriptor flags ([vd|vi]_flags).  Note that the
1406  * first byte is reserved for user visible flags (refer VER_FLG's in link.h).
1407  */
1408 #define	MSK_VER_USER	0x0f		/* mask for user visible flags */
1409 
1410 #define	FLG_VER_AVAIL	0x10		/* version is available for binding */
1411 #define	FLG_VER_REFER	0x20		/* version has been referenced */
1412 #define	FLG_VER_CYCLIC	0x40		/* a member of cyclic dependency */
1413 
1414 /*
1415  * isalist(1) descriptor - used to break an isalist string into its component
1416  * options.
1417  */
1418 struct	isa_opt {
1419 	char		*isa_name;	/* individual isa option name */
1420 	size_t		isa_namesz;	/*	and associated size */
1421 };
1422 
1423 struct	isa_desc {
1424 	char		*isa_list;	/* sysinfo(SI_ISALIST) list */
1425 	size_t		isa_listsz;	/*	and associated size */
1426 	Isa_opt		*isa_opt;	/* table of individual isa options */
1427 	size_t		isa_optno;	/*	and associated number */
1428 };
1429 
1430 /*
1431  * uname(2) descriptor - used to break a utsname structure into its component
1432  * options (at least those that we're interested in).
1433  */
1434 struct	uts_desc {
1435 	char		*uts_osname;	/* operating system name */
1436 	size_t		uts_osnamesz;	/*	and associated size */
1437 	char		*uts_osrel;	/* operating system release */
1438 	size_t		uts_osrelsz;	/*	and associated size */
1439 };
1440 
1441 /*
1442  * SHT_GROUP descriptor - used to track group sections at the global
1443  * level to resolve conflicts and determine which to keep.
1444  */
1445 struct group_desc {
1446 	Is_desc		*gd_isc;	/* input section descriptor */
1447 	Is_desc		*gd_oisc;	/* overriding input section */
1448 					/*	descriptor when discarded */
1449 	const char	*gd_name;	/* group name (signature symbol) */
1450 	Word		*gd_data;	/* data for group section */
1451 	size_t		gd_cnt;		/* number of entries in group data */
1452 };
1453 
1454 /*
1455  * Indexes into the ld_support_funcs[] table.
1456  */
1457 typedef enum {
1458 	LDS_VERSION = 0,	/* Must be first and have value 0 */
1459 	LDS_INPUT_DONE,
1460 	LDS_START,
1461 	LDS_ATEXIT,
1462 	LDS_OPEN,
1463 	LDS_FILE,
1464 	LDS_INSEC,
1465 	LDS_SEC,
1466 	LDS_NUM
1467 } Support_ndx;
1468 
1469 /*
1470  * Structure to manage archive member caching.  Each archive has an archive
1471  * descriptor (Ar_desc) associated with it.  This contains pointers to the
1472  * archive symbol table (obtained by elf_getarsyms(3e)) and an auxiliary
1473  * structure (Ar_uax[]) that parallels this symbol table.  The member element
1474  * of this auxiliary table indicates whether the archive member associated with
1475  * the symbol offset has already been extracted (AREXTRACTED) or partially
1476  * processed (refer process_member()).
1477  */
1478 typedef struct ar_mem {
1479 	Elf		*am_elf;	/* elf descriptor for this member */
1480 	const char	*am_name;	/* members name */
1481 	const char	*am_path;	/* path (ie. lib(foo.o)) */
1482 	Sym		*am_syms;	/* start of global symbols */
1483 	char		*am_strs;	/* associated string table start */
1484 	Xword		am_symn;	/* no. of global symbols */
1485 } Ar_mem;
1486 
1487 typedef struct ar_aux {
1488 	Sym_desc	*au_syms;	/* internal symbol descriptor */
1489 	Ar_mem		*au_mem;	/* associated member */
1490 } Ar_aux;
1491 
1492 #define	FLG_ARMEM_PROC	(Ar_mem *)-1
1493 
1494 typedef struct ar_desc {
1495 	const char	*ad_name;	/* archive file name */
1496 	Elf		*ad_elf;	/* elf descriptor for the archive */
1497 	Elf_Arsym	*ad_start;	/* archive symbol table start */
1498 	Ar_aux		*ad_aux;	/* auxiliary symbol information */
1499 	dev_t		ad_stdev;	/* device id and inode number for */
1500 	ino_t		ad_stino;	/*	multiple inclusion checks */
1501 	ofl_flag_t	ad_flags;	/* archive specific cmd line flags */
1502 } Ar_desc;
1503 
1504 /*
1505  * Define any archive descriptor flags.  NOTE, make sure they do not clash with
1506  * any output file descriptor archive extraction flags, as these are saved in
1507  * the same entry (see MSK_OF1_ARCHIVE).
1508  */
1509 #define	FLG_ARD_EXTRACT	0x00010000	/* archive member has been extracted */
1510 
1511 /* Mapfile versions supported by libld */
1512 #define	MFV_NONE	0	/* Not a valid version */
1513 #define	MFV_SYSV	1	/* Original System V syntax */
1514 #define	MFV_SOLARIS	2	/* Solaris mapfile syntax */
1515 #define	MFV_NUM		3	/* # of mapfile versions */
1516 
1517 
1518 /*
1519  * Function Declarations.
1520  */
1521 #if	defined(_ELF64)
1522 
1523 #define	ld_create_outfile	ld64_create_outfile
1524 #define	ld_ent_setup		ld64_ent_setup
1525 #define	ld_init_strings		ld64_init_strings
1526 #define	ld_init_target		ld64_init_target
1527 #define	ld_make_sections	ld64_make_sections
1528 #define	ld_main			ld64_main
1529 #define	ld_ofl_cleanup		ld64_ofl_cleanup
1530 #define	ld_process_mem		ld64_process_mem
1531 #define	ld_reloc_init		ld64_reloc_init
1532 #define	ld_reloc_process	ld64_reloc_process
1533 #define	ld_sym_validate		ld64_sym_validate
1534 #define	ld_update_outfile	ld64_update_outfile
1535 
1536 #else
1537 
1538 #define	ld_create_outfile	ld32_create_outfile
1539 #define	ld_ent_setup		ld32_ent_setup
1540 #define	ld_init_strings		ld32_init_strings
1541 #define	ld_init_target		ld32_init_target
1542 #define	ld_make_sections	ld32_make_sections
1543 #define	ld_main			ld32_main
1544 #define	ld_ofl_cleanup		ld32_ofl_cleanup
1545 #define	ld_process_mem		ld32_process_mem
1546 #define	ld_reloc_init		ld32_reloc_init
1547 #define	ld_reloc_process	ld32_reloc_process
1548 #define	ld_sym_validate		ld32_sym_validate
1549 #define	ld_update_outfile	ld32_update_outfile
1550 
1551 #endif
1552 
1553 extern int		ld_getopt(Lm_list *, int, int, char **);
1554 
1555 extern int		ld32_main(int, char **, Half);
1556 extern int		ld64_main(int, char **, Half);
1557 
1558 extern uintptr_t	ld_create_outfile(Ofl_desc *);
1559 extern uintptr_t	ld_ent_setup(Ofl_desc *, Xword);
1560 extern uintptr_t	ld_init_strings(Ofl_desc *);
1561 extern int		ld_init_target(Lm_list *, Half mach);
1562 extern uintptr_t	ld_make_sections(Ofl_desc *);
1563 extern void		ld_ofl_cleanup(Ofl_desc *);
1564 extern Ifl_desc		*ld_process_mem(const char *, const char *, char *,
1565 			    size_t, Ofl_desc *, Rej_desc *);
1566 extern uintptr_t	ld_reloc_init(Ofl_desc *);
1567 extern uintptr_t	ld_reloc_process(Ofl_desc *);
1568 extern uintptr_t	ld_sym_validate(Ofl_desc *);
1569 extern uintptr_t	ld_update_outfile(Ofl_desc *);
1570 
1571 #ifdef	__cplusplus
1572 }
1573 #endif
1574 
1575 #endif	/* _LIBLD_H */
1576