xref: /illumos-gate/usr/src/cmd/sgs/include/libld.h (revision 9e11eb24108a4735199cb20067ce66706c492016)
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 	APlist		*ofl_symasserts; /* assertions about symbols */
411 					/* from mapfiles */
412 };
413 
414 #define	FLG_OF_DYNAMIC	0x00000001	/* generate dynamic output module */
415 #define	FLG_OF_STATIC	0x00000002	/* generate static output module */
416 #define	FLG_OF_EXEC	0x00000004	/* generate an executable */
417 #define	FLG_OF_RELOBJ	0x00000008	/* generate a relocatable object */
418 #define	FLG_OF_SHAROBJ	0x00000010	/* generate a shared object */
419 #define	FLG_OF_BFLAG	0x00000020	/* do no special plt building: -b */
420 #define	FLG_OF_IGNENV	0x00000040	/* ignore LD_LIBRARY_PATH: -i */
421 #define	FLG_OF_STRIP	0x00000080	/* strip output: -s */
422 #define	FLG_OF_NOWARN	0x00000100	/* disable symbol warnings: -t */
423 #define	FLG_OF_NOUNDEF	0x00000200	/* allow no undefined symbols: -zdefs */
424 #define	FLG_OF_PURETXT	0x00000400	/* allow no text relocations: -ztext */
425 #define	FLG_OF_GENMAP	0x00000800	/* generate a memory map: -m */
426 #define	FLG_OF_DYNLIBS	0x00001000	/* dynamic input allowed: -Bdynamic */
427 #define	FLG_OF_SYMBOLIC	0x00002000	/* bind global symbols: -Bsymbolic */
428 #define	FLG_OF_ADDVERS	0x00004000	/* add version stamp: -Qy */
429 #define	FLG_OF_NOLDYNSYM 0x00008000	/* -znoldynsym set */
430 #define	FLG_OF_IS_ORDER	0x00010000	/* input section ordering within a */
431 					/*	segment is required */
432 #define	FLG_OF_EC_FILES	0x00020000	/* Ent_desc exist w/non-NULL ec_files */
433 #define	FLG_OF_TEXTREL	0x00040000	/* text relocations have been found */
434 #define	FLG_OF_MULDEFS	0x00080000	/* multiple symbols are allowed */
435 #define	FLG_OF_TLSPHDR	0x00100000	/* a TLS program header is required */
436 #define	FLG_OF_BLDGOT	0x00200000	/* build GOT table */
437 #define	FLG_OF_VERDEF	0x00400000	/* record version definitions */
438 #define	FLG_OF_VERNEED	0x00800000	/* record version dependencies */
439 #define	FLG_OF_NOVERSEC 0x01000000	/* don't record version sections */
440 #define	FLG_OF_KEY	0x02000000	/* file requires sort keys */
441 #define	FLG_OF_PROCRED	0x04000000	/* process any symbol reductions by */
442 					/*	effecting the symbol table */
443 					/*	output and relocations */
444 #define	FLG_OF_SYMINFO	0x08000000	/* create a syminfo section */
445 #define	FLG_OF_AUX	0x10000000	/* ofl_filter is an auxiliary filter */
446 #define	FLG_OF_FATAL	0x20000000	/* fatal error during input */
447 #define	FLG_OF_WARN	0x40000000	/* warning during input processing. */
448 #define	FLG_OF_VERBOSE	0x80000000	/* -z verbose flag set */
449 
450 #define	FLG_OF_MAPSYMB	0x000100000000	/* symbolic scope definition seen */
451 #define	FLG_OF_MAPGLOB	0x000200000000	/* global scope definition seen */
452 #define	FLG_OF_COMREL	0x000400000000	/* -z combreloc set, which enables */
453 					/*	DT_RELACNT tracking, */
454 #define	FLG_OF_NOCOMREL	0x000800000000	/* -z nocombreloc set */
455 #define	FLG_OF_AUTOLCL	0x001000000000	/* automatically reduce unspecified */
456 					/*	global symbols to locals */
457 #define	FLG_OF_AUTOELM	0x002000000000	/* automatically eliminate */
458 					/*	unspecified global symbols */
459 #define	FLG_OF_REDLSYM	0x004000000000	/* reduce local symbols */
460 #define	FLG_OF_OS_ORDER	0x008000000000	/* output section ordering required */
461 #define	FLG_OF_OSABI	0x010000000000	/* tag object as ELFOSABI_SOLARIS */
462 #define	FLG_OF_ADJOSCNT	0x020000000000	/* adjust ofl_shdrcnt to accommodate */
463 					/*	discarded sections */
464 #define	FLG_OF_OTOSCAP	0x040000000000	/* convert object capabilities to */
465 					/*	symbol capabilities */
466 #define	FLG_OF_PTCAP	0x080000000000	/* PT_SUNWCAP required */
467 #define	FLG_OF_CAPSTRS	0x100000000000	/* capability strings are required */
468 #define	FLG_OF_EHFRAME	0x200000000000	/* output contains .eh_frame section */
469 #define	FLG_OF_FATWARN	0x400000000000	/* make warnings fatal */
470 #define	FLG_OF_ADEFLIB	0x800000000000	/* no libraries in default path */
471 
472 #define	FLG_OF_KMOD	0x1000000000000	/* output is a kernel module */
473 
474 /*
475  * In the flags1 arena, establish any options that are applicable to archive
476  * extraction first, and associate a mask.  These values are recorded with any
477  * archive descriptor so that they may be reset should the archive require a
478  * rescan to try and resolve undefined symbols.
479  */
480 #define	FLG_OF1_ALLEXRT	0x0000000001	/* extract all members from an */
481 					/*	archive file */
482 #define	FLG_OF1_WEAKEXT	0x0000000002	/* allow archive extraction to */
483 					/*	resolve weak references */
484 #define	MSK_OF1_ARCHIVE	0x0000000003	/* archive flags mask */
485 
486 #define	FLG_OF1_NOINTRP	0x0000000008	/* -z nointerp flag set */
487 #define	FLG_OF1_ZDIRECT	0x0000000010	/* -z direct flag set */
488 #define	FLG_OF1_NDIRECT	0x0000000020	/* no-direct bindings specified */
489 #define	FLG_OF1_DEFERRED 0x0000000040	/* deferred dependency recording */
490 
491 #define	FLG_OF1_RELDYN	0x0000000100	/* process .dynamic in rel obj */
492 #define	FLG_OF1_NRLXREL	0x0000000200	/* -z norelaxreloc flag set */
493 #define	FLG_OF1_RLXREL	0x0000000400	/* -z relaxreloc flag set */
494 #define	FLG_OF1_IGNORE	0x0000000800	/* ignore unused dependencies */
495 #define	FLG_OF1_NOSGHND	0x0000001000	/* -z nosighandler flag set */
496 #define	FLG_OF1_TEXTOFF 0x0000002000	/* text relocations are ok */
497 #define	FLG_OF1_ABSEXEC	0x0000004000	/* -zabsexec set */
498 #define	FLG_OF1_LAZYLD	0x0000008000	/* lazy loading of objects enabled */
499 #define	FLG_OF1_GRPPRM	0x0000010000	/* dependencies are to have */
500 					/*	GROUPPERM enabled */
501 
502 #define	FLG_OF1_NOPARTI	0x0000040000	/* -znopartial set */
503 #define	FLG_OF1_BSSOREL	0x0000080000	/* output relocation against bss */
504 					/*	section */
505 #define	FLG_OF1_TLSOREL	0x0000100000	/* output relocation against .tlsbss */
506 					/*	section */
507 #define	FLG_OF1_MEMORY	0x0000200000	/* produce a memory model */
508 #define	FLG_OF1_NGLBDIR	0x0000400000	/* no DT_1_DIRECT flag allowed */
509 #define	FLG_OF1_ENCDIFF	0x0000800000	/* host running linker has different */
510 					/*	byte order than output object */
511 #define	FLG_OF1_VADDR	0x0001000000	/* a segment defines explicit vaddr */
512 #define	FLG_OF1_EXTRACT	0x0002000000	/* archive member has been extracted */
513 #define	FLG_OF1_RESCAN	0x0004000000	/* any archives should be rescanned */
514 #define	FLG_OF1_IGNPRC	0x0008000000	/* ignore processing required */
515 #define	FLG_OF1_NCSTTAB	0x0010000000	/* -znocompstrtab set */
516 #define	FLG_OF1_DONE	0x0020000000	/* link-editor processing complete */
517 #define	FLG_OF1_NONREG	0x0040000000	/* non-regular file specified as */
518 					/*	the output file */
519 #define	FLG_OF1_ALNODIR	0x0080000000	/* establish NODIRECT for all */
520 					/*	exported interfaces. */
521 #define	FLG_OF1_OVHWCAP1 0x0100000000	/* override CA_SUNW_HW_1 capabilities */
522 #define	FLG_OF1_OVSFCAP1 0x0200000000	/* override CA_SUNW_SF_1 capabilities */
523 #define	FLG_OF1_OVHWCAP2 0x0400000000	/* override CA_SUNW_HW_2 capabilities */
524 #define	FLG_OF1_OVMACHCAP 0x0800000000	/* override CA_SUNW_MACH capability */
525 #define	FLG_OF1_OVPLATCAP 0x1000000000	/* override CA_SUNW_PLAT capability */
526 #define	FLG_OF1_OVIDCAP	0x2000000000	/* override CA_SUNW_ID capability */
527 
528 /*
529  * Guidance flags. The flags with the FLG_OFG_NO_ prefix are used to suppress
530  * messages for a given category, and use the lower 28 bits of the word,
531  * The upper nibble is reserved for other guidance status.
532  */
533 #define	FLG_OFG_ENABLE		0x10000000	/* -z guidance option active */
534 #define	FLG_OFG_ISSUED		0x20000000	/* -z guidance message issued */
535 
536 #define	FLG_OFG_NO_ALL		0x0fffffff	/* disable all guidance */
537 #define	FLG_OFG_NO_DEFS		0x00000001	/* specify all dependencies */
538 #define	FLG_OFG_NO_DB		0x00000002	/* use direct bindings */
539 #define	FLG_OFG_NO_LAZY		0x00000004	/* be explicit about lazyload */
540 #define	FLG_OFG_NO_MF		0x00000008	/* use v2 mapfile syntax */
541 #define	FLG_OFG_NO_TEXT		0x00000010	/* verify pure text segment */
542 #define	FLG_OFG_NO_UNUSED	0x00000020	/* remove unused dependency */
543 #define	FLG_OFG_NO_ASSERTS	0x00000040	/* suggest mapfile assertions */
544 
545 /*
546  * Test to see if a guidance should be given for a given category
547  * or not. _no_flag is one of the FLG_OFG_NO_xxx flags. Returns TRUE
548  * if the guidance should be issued, and FALSE to remain silent.
549  */
550 #define	OFL_GUIDANCE(_ofl, _no_flag) (((_ofl)->ofl_guideflags & \
551 	(FLG_OFG_ENABLE | (_no_flag))) == FLG_OFG_ENABLE)
552 
553 /*
554  * Test to see if the output file would allow the presence of
555  * a .dynsym section.
556  */
557 #define	OFL_ALLOW_DYNSYM(_ofl) (((_ofl)->ofl_flags & \
558 	(FLG_OF_DYNAMIC | FLG_OF_RELOBJ)) == FLG_OF_DYNAMIC)
559 
560 /*
561  * Test to see if the output file would allow the presence of
562  * a .SUNW_ldynsym section. The requirements are that a .dynsym
563  * is allowed, and -znoldynsym has not been specified. Note that
564  * even if the answer is True (1), we will only generate one if there
565  * are local symbols that require it.
566  */
567 #define	OFL_ALLOW_LDYNSYM(_ofl) (((_ofl)->ofl_flags & \
568 	(FLG_OF_DYNAMIC | FLG_OF_RELOBJ | FLG_OF_NOLDYNSYM)) == FLG_OF_DYNAMIC)
569 
570 /*
571  * Test to see if relocation processing should be done. This is normally
572  * true, but can be disabled via the '-z noreloc' option. Note that
573  * relocatable objects are still relocated even if '-z noreloc' is present.
574  */
575 #define	OFL_DO_RELOC(_ofl) (((_ofl)->ofl_flags & FLG_OF_RELOBJ) || \
576 	!((_ofl)->ofl_dtflags_1 & DF_1_NORELOC))
577 
578 /*
579  * Determine whether a static executable is being built.
580  */
581 #define	OFL_IS_STATIC_EXEC(_ofl) (((_ofl)->ofl_flags & \
582 	(FLG_OF_STATIC | FLG_OF_EXEC)) == (FLG_OF_STATIC | FLG_OF_EXEC))
583 
584 /*
585  * Determine whether a static object is being built.  This macro is used
586  * to select the appropriate string table, and symbol table that other
587  * sections need to reference.
588  */
589 #define	OFL_IS_STATIC_OBJ(_ofl) ((_ofl)->ofl_flags & \
590 	(FLG_OF_RELOBJ | FLG_OF_STATIC))
591 
592 /*
593  * Macros for counting symbol table entries.  These are used to size symbol
594  * tables and associated sections (.syminfo, SUNW_capinfo, .hash, etc.) and
595  * set required sh_info entries (the offset to the first global symbol).
596  */
597 #define	SYMTAB_LOC_CNT(_ofl)		/* local .symtab entries */	\
598 	(2 +				/*    NULL and STT_FILE */	\
599 	(_ofl)->ofl_shdrcnt +		/*    section symbol */		\
600 	(_ofl)->ofl_caploclcnt +	/*    local capabilities */	\
601 	(_ofl)->ofl_scopecnt +		/*    scoped symbols */		\
602 	(_ofl)->ofl_locscnt)		/*    standard locals */
603 #define	SYMTAB_ALL_CNT(_ofl)		/* all .symtab entries */	\
604 	(SYMTAB_LOC_CNT(_ofl) +		/*    .symtab locals */		\
605 	(_ofl)->ofl_globcnt)		/*    standard globals */
606 
607 #define	DYNSYM_LOC_CNT(_ofl)		/* local .dynsym entries */	\
608 	(1 +				/*    NULL */			\
609 	(_ofl)->ofl_dynshdrcnt +	/*    section symbols */	\
610 	(_ofl)->ofl_caploclcnt +	/*    local capabilities */	\
611 	(_ofl)->ofl_lregsymcnt)		/*    local register symbols */
612 #define	DYNSYM_ALL_CNT(_ofl)		/* all .dynsym entries */	\
613 	(DYNSYM_LOC_CNT(_ofl) +		/*    .dynsym locals */		\
614 	(_ofl)->ofl_globcnt)		/*    standard globals */
615 
616 /*
617  * Define a move descriptor used within relocation structures.
618  */
619 typedef struct {
620 	Move		*mr_move;
621 	Sym_desc	*mr_sym;
622 } Mv_reloc;
623 
624 /*
625  * Relocation (active & output) processing structure - transparent to common
626  * code. There can be millions of these structures in a large link, so it
627  * is important to keep it small. You should only add new items to Rel_desc
628  * if they are critical, apply to most relocations, and cannot be easily
629  * computed from the other information.
630  *
631  * Items that can be derived should be implemented as a function that accepts
632  * a Rel_desc argument, and returns the desired data. ld_reloc_sym_name() is
633  * an example of this.
634  *
635  * Lesser used relocation data is kept in an auxiliary block, Rel_aux,
636  * that is only allocated as necessary. In exchange for adding one pointer
637  * of overhead to Rel_desc (rel_aux), most relocations are reduced in size
638  * by the size of Rel_aux. This strategy relies on the data in Rel_aux
639  * being rarely needed --- otherwise it will backfire badly.
640  *
641  * Note that rel_raddend is primarily only of interest to RELA relocations,
642  * and is set to 0 for REL. However, there is an exception: If FLG_REL_NADDEND
643  * is set, then rel_raddend contains a replacement value for the implicit
644  * addend found in the relocation target.
645  *
646  * Fields should be ordered from largest to smallest, to minimize packing
647  * holes in the struct layout.
648  */
649 struct rel_desc {
650 	Is_desc		*rel_isdesc;	/* input section reloc is against */
651 	Sym_desc	*rel_sym;	/* sym relocation is against */
652 	Rel_aux		*rel_aux;	/* NULL, or auxiliary data */
653 	Xword		rel_roffset;	/* relocation offset */
654 	Sxword		rel_raddend;	/* addend from input relocation */
655 	Word		rel_flags;	/* misc. flags for relocations */
656 	Word		rel_rtype;	/* relocation type */
657 };
658 
659 /*
660  * Data that would be kept in Rel_desc if the size of that structure was
661  * not an issue. This auxiliary block is only allocated as needed,
662  * and must only contain rarely needed items. The goal is for the vast
663  * majority of Rel_desc structs to not have an auxiliary block.
664  *
665  * When a Rel_desc does not have an auxiliary block, a default value
666  * is assumed for each auxiliary item:
667  *
668  * -	ra_osdesc:
669  *	Output section to which relocation applies. The default
670  *	value for this is the output section associated with the
671  *	input section (rel_isdesc->is_osdesc), or NULL if there
672  *	is no associated input section.
673  *
674  * -	ra_usym:
675  *	If the symbol associated with a relocation is part of a weak/strong
676  *	pair, then ra_usym contains the strong symbol and rel_sym the weak.
677  *	Otherwise, the default value is the same value as rel_sym.
678  *
679  * -	ra_move:
680  *	Move table data. The default value is NULL.
681  *
682  * -	ra_typedata:
683  *	ELF_R_TYPE_DATA(info). This value applies only to a small
684  *	subset of 64-bit sparc relocations, and is otherwise 0. The
685  *	default value is 0.
686  *
687  * If any value in Rel_aux is non-default, then an auxiliary block is
688  * necessary, and each field contains its actual value. If all the auxiliary
689  * values are default, no Rel_aux is needed, and the RELAUX_GET_xxx()
690  * macros below are able to supply the proper default.
691  *
692  * To set a Rel_aux value, use the ld_reloc_set_aux_XXX() functions.
693  * These functions are written to avoid unnecessary auxiliary allocations,
694  * and know the rules for each item.
695  */
696 struct rel_aux {
697 	Os_desc		*ra_osdesc;	/* output section reloc is against */
698 	Sym_desc	*ra_usym;	/* strong sym if this is a weak pair */
699 	Mv_reloc	*ra_move;	/* move table information */
700 	Word		ra_typedata;	/* ELF_R_TYPE_DATA(info) */
701 };
702 
703 /*
704  * Test a given auxiliary value to determine if it has the default value
705  * for that item, as described above. If all the auxiliary items have
706  * their default values, no auxiliary place is necessary to represent them.
707  * If any one of them is non-default, the auxiliary block is needed.
708  */
709 #define	RELAUX_ISDEFAULT_MOVE(_rdesc, _mv) (_mv == NULL)
710 #define	RELAUX_ISDEFAULT_USYM(_rdesc, _usym) ((_rdesc)->rel_sym == _usym)
711 #define	RELAUX_ISDEFAULT_OSDESC(_rdesc, _osdesc) \
712 	((((_rdesc)->rel_isdesc == NULL) && (_osdesc == NULL)) || \
713 	((_rdesc)->rel_isdesc && ((_rdesc)->rel_isdesc->is_osdesc == _osdesc)))
714 #define	RELAUX_ISDEFAULT_TYPEDATA(_rdesc, _typedata) (_typedata == 0)
715 
716 /*
717  * Retrieve the value of an auxiliary relocation item, preserving the illusion
718  * that every relocation descriptor has an auxiliary block attached. The
719  * real implementation is that an auxiliary block is only present if one or
720  * more auxiliary items have non-default values. These macros return the true
721  * value if an auxiliary block is present, and the default value for the
722  * item otherwise.
723  */
724 #define	RELAUX_GET_MOVE(_rdesc) \
725 	((_rdesc)->rel_aux ? (_rdesc)->rel_aux->ra_move : NULL)
726 #define	RELAUX_GET_USYM(_rdesc) \
727 	((_rdesc)->rel_aux ? (_rdesc)->rel_aux->ra_usym : (_rdesc)->rel_sym)
728 #define	RELAUX_GET_OSDESC(_rdesc) \
729 	((_rdesc)->rel_aux ? (_rdesc)->rel_aux->ra_osdesc : \
730 	((_rdesc)->rel_isdesc ? (_rdesc)->rel_isdesc->is_osdesc : NULL))
731 #define	RELAUX_GET_TYPEDATA(_rdesc) \
732 	((_rdesc)->rel_aux ? (_rdesc)->rel_aux->ra_typedata : 0)
733 
734 /*
735  * common flags used on the Rel_desc structure (defined in machrel.h).
736  */
737 #define	FLG_REL_GOT	0x00000001	/* relocation against GOT */
738 #define	FLG_REL_PLT	0x00000002	/* relocation against PLT */
739 #define	FLG_REL_BSS	0x00000004	/* relocation against BSS */
740 #define	FLG_REL_LOAD	0x00000008	/* section loadable */
741 #define	FLG_REL_SCNNDX	0x00000010	/* use section index for symbol ndx */
742 #define	FLG_REL_CLVAL	0x00000020	/* clear VALUE for active relocation */
743 #define	FLG_REL_ADVAL	0x00000040	/* add VALUE for output relocation, */
744 					/*	only relevant to SPARC and */
745 					/*	R_SPARC_RELATIVE */
746 #define	FLG_REL_GOTCL	0x00000080	/* clear the GOT entry.  This is */
747 					/* relevant to RELA relocations, */
748 					/* not REL (i386) relocations */
749 #define	FLG_REL_MOVETAB	0x00000100	/* Relocation against .SUNW_move */
750 					/*	adjustments required before */
751 					/*	actual relocation */
752 #define	FLG_REL_NOINFO	0x00000200	/* Relocation comes from a section */
753 					/*	with a null sh_info field */
754 #define	FLG_REL_REG	0x00000400	/* Relocation target is reg sym */
755 #define	FLG_REL_FPTR	0x00000800	/* relocation against func. desc. */
756 #define	FLG_REL_RFPTR1	0x00001000	/* Relative relocation against */
757 					/*   1st part of FD */
758 #define	FLG_REL_RFPTR2	0x00002000	/* Relative relocation against */
759 					/*   2nd part of FD */
760 #define	FLG_REL_DISP	0x00004000	/* *disp* relocation */
761 #define	FLG_REL_STLS	0x00008000	/* IE TLS reference to */
762 					/*	static TLS GOT index */
763 #define	FLG_REL_DTLS	0x00010000	/* GD TLS reference relative to */
764 					/*	dynamic TLS GOT index */
765 #define	FLG_REL_MTLS	0x00020000	/* LD TLS reference against GOT */
766 #define	FLG_REL_STTLS	0x00040000	/* LE TLS reference directly */
767 					/*	to static tls index */
768 #define	FLG_REL_TLSFIX	0x00080000	/* relocation points to TLS instr. */
769 					/*	which needs updating */
770 #define	FLG_REL_RELA	0x00100000	/* descriptor captures a Rela */
771 #define	FLG_REL_GOTFIX	0x00200000	/* relocation points to GOTOP instr. */
772 					/*	which needs updating */
773 #define	FLG_REL_NADDEND	0x00400000	/* Replace implicit addend in dest */
774 					/*	with value in rel_raddend */
775 					/*	Relevant to REL (i386) */
776 					/*	relocations, not to RELA. */
777 
778 /*
779  * We often need the name of the symbol contained in a relocation descriptor
780  * for diagnostic or error output. This is usually the symbol name, but
781  * we substitute a constructed name in some cases. Hence, the name is
782  * generated on the fly by a private function within libld. This is the
783  * prototype for that function.
784  */
785 typedef const char *(* rel_desc_sname_func_t)(Rel_desc *);
786 
787 /*
788  * Header for a relocation descriptor cache buffer.
789  */
790 struct rel_cachebuf {
791 	Rel_desc	*rc_end;
792 	Rel_desc	*rc_free;
793 	Rel_desc	rc_arr[1];
794 };
795 
796 /*
797  * Header for a relocation auxiliary descriptor cache buffer.
798  */
799 struct rel_aux_cachebuf {
800 	Rel_aux		*rac_end;
801 	Rel_aux		*rac_free;
802 	Rel_aux		rac_arr[1];
803 };
804 
805 /*
806  * Convenience macro for traversing every relocation descriptor found within
807  * a given relocation cache, transparently handling the cache buffers and
808  * skipping any unallocated descriptors within the buffers.
809  *
810  * entry:
811  *	_rel_cache - Relocate descriptor cache (Rel_cache) to traverse
812  *	_idx - Aliste index variable for use by the macro
813  *	_rcbp - Cache buffer pointer, for use by the macro
814  *	_orsp - Rel_desc pointer, which will take on the value of a different
815  *		relocation descriptor in the cache in each iteration.
816  *
817  * The caller must not assign new values to _idx, _rcbp, or _orsp within
818  * the scope of REL_CACHE_TRAVERSE.
819  */
820 #define	REL_CACHE_TRAVERSE(_rel_cache, _idx, _rcbp, _orsp) \
821 	for (APLIST_TRAVERSE((_rel_cache)->rc_list, _idx, _rcbp)) \
822 		for (_orsp = _rcbp->rc_arr; _orsp < _rcbp->rc_free; _orsp++)
823 
824 /*
825  * Symbol value descriptor.  For relocatable objects, each symbols value is
826  * its offset within its associated section.  Therefore, to uniquely define
827  * each symbol within a relocatable object, record and sort the sh_offset and
828  * symbol value.  This information is used to search for displacement
829  * relocations as part of copy relocation validation.
830  */
831 typedef struct {
832 	Addr		ssv_value;
833 	Sym_desc	*ssv_sdp;
834 } Ssv_desc;
835 
836 /*
837  * Input file processing structures.
838  */
839 struct ifl_desc {			/* input file descriptor */
840 	const char	*ifl_name;	/* full file name */
841 	const char	*ifl_soname;	/* shared object name */
842 	dev_t		ifl_stdev;	/* device id and inode number for .so */
843 	ino_t		ifl_stino;	/*	multiple inclusion checks */
844 	Ehdr		*ifl_ehdr;	/* elf header describing this file */
845 	Elf		*ifl_elf;	/* elf descriptor for this file */
846 	Sym_desc	**ifl_oldndx;	/* original symbol table indices */
847 	Sym_desc	*ifl_locs;	/* symbol desc version of locals */
848 	Ssv_desc	*ifl_sortsyms;	/* sorted list of symbols by value */
849 	Word		ifl_locscnt;	/* no. of local symbols to process */
850 	Word		ifl_symscnt;	/* total no. of symbols to process */
851 	Word		ifl_sortcnt;	/* no. of sorted symbols to process */
852 	Word		ifl_shnum;	/* number of sections in file */
853 	Word		ifl_shstrndx;	/* index to .shstrtab */
854 	Word		ifl_vercnt;	/* number of versions in file */
855 	Half		ifl_neededndx;	/* index to NEEDED in .dyn section */
856 	Word		ifl_flags;	/* explicit/implicit reference */
857 	Is_desc		**ifl_isdesc;	/* isdesc[scn ndx] = Is_desc ptr */
858 	Sdf_desc	*ifl_sdfdesc;	/* control definition */
859 	Versym		*ifl_versym;	/* version symbol table array */
860 	Ver_index	*ifl_verndx;	/* verndx[ver ndx] = Ver_index */
861 	APlist		*ifl_verdesc;	/* version descriptor list */
862 	APlist		*ifl_relsect;	/* relocation section list */
863 	Alist		*ifl_groups;	/* SHT_GROUP section list */
864 	Cap_desc	*ifl_caps;	/* capabilities descriptor */
865 };
866 
867 #define	FLG_IF_CMDLINE	0x00000001	/* full filename specified from the */
868 					/*	command line (no -l) */
869 #define	FLG_IF_NEEDED	0x00000002	/* shared object should be recorded */
870 #define	FLG_IF_DIRECT	0x00000004	/* establish direct bindings to this */
871 					/*	object */
872 #define	FLG_IF_EXTRACT	0x00000008	/* file extracted from an archive */
873 #define	FLG_IF_VERNEED	0x00000010	/* version dependency information is */
874 					/*	required */
875 #define	FLG_IF_DEPREQD	0x00000020	/* dependency is required to satisfy */
876 					/*	symbol references */
877 #define	FLG_IF_NEEDSTR	0x00000040	/* dependency specified by -Nn */
878 					/*	flag */
879 #define	FLG_IF_IGNORE	0x00000080	/* ignore unused dependencies */
880 #define	FLG_IF_NODIRECT	0x00000100	/* object contains symbols that */
881 					/*	cannot be directly bound to */
882 #define	FLG_IF_LAZYLD	0x00000200	/* dependency should be lazy loaded */
883 #define	FLG_IF_GRPPRM	0x00000400	/* dependency establishes a group */
884 #define	FLG_IF_DISPPEND 0x00000800	/* displacement relocation done */
885 					/*	in the ld time. */
886 #define	FLG_IF_DISPDONE 0x00001000	/* displacement relocation done */
887 					/*	at the run time */
888 #define	FLG_IF_MAPFILE	0x00002000	/* file is a mapfile */
889 #define	FLG_IF_HSTRTAB	0x00004000	/* file has a string section */
890 #define	FLG_IF_FILEREF	0x00008000	/* file contains a section which */
891 					/*	is included in the output */
892 					/*	allocatable image */
893 #define	FLG_IF_GNUVER	0x00010000	/* file used GNU-style versioning */
894 #define	FLG_IF_ORDERED	0x00020000	/* ordered section processing */
895 					/*	required */
896 #define	FLG_IF_OTOSCAP	0x00040000	/* convert object capabilities to */
897 					/*	symbol capabilities */
898 #define	FLG_IF_DEFERRED	0x00080000	/* dependency is deferred */
899 #define	FLG_IF_RTLDINF	0x00100000	/* dependency has DT_SUNW_RTLTINF set */
900 #define	FLG_IF_GROUPS	0x00200000	/* input file has groups to process */
901 
902 /*
903  * Symbol states that require the generation of a DT_POSFLAG_1 .dynamic entry.
904  */
905 #define	MSK_IF_POSFLAG1	(FLG_IF_LAZYLD | FLG_IF_GRPPRM | FLG_IF_DEFERRED)
906 
907 /*
908  * Symbol states that require an associated Syminfo entry.
909  */
910 #define	MSK_IF_SYMINFO	(FLG_IF_LAZYLD | FLG_IF_DIRECT | FLG_IF_DEFERRED)
911 
912 
913 struct is_desc {			/* input section descriptor */
914 	const char	*is_name;	/* original section name */
915 	const char	*is_sym_name;	/* NULL, or name string to use for */
916 					/*	related STT_SECTION symbols */
917 	Shdr		*is_shdr;	/* the elf section header */
918 	Ifl_desc	*is_file;	/* infile desc for this section */
919 	Os_desc		*is_osdesc;	/* new output section for this */
920 					/*	input section */
921 	Elf_Data	*is_indata;	/* input sections raw data */
922 	Is_desc		*is_symshndx;	/* related SHT_SYM_SHNDX section */
923 	Is_desc		*is_comdatkeep;	/* If COMDAT section is discarded, */
924 					/*	this is section that was kept */
925 	Word		is_scnndx;	/* original section index in file */
926 	Word		is_ordndx;	/* index for section.  Used to decide */
927 					/*	where to insert section when */
928 					/*	reordering sections */
929 	Word		is_keyident;	/* key for SHF_{ORDERED|LINK_ORDER} */
930 					/*	processing and ident used for */
931 					/*	 placing/ordering sections */
932 	Word		is_flags;	/* Various flags */
933 };
934 
935 #define	FLG_IS_ORDERED	0x0001		/* this is a SHF_ORDERED section */
936 #define	FLG_IS_KEY	0x0002		/* section requires sort keys */
937 #define	FLG_IS_DISCARD	0x0004		/* section is to be discarded */
938 #define	FLG_IS_RELUPD	0x0008		/* symbol defined here may have moved */
939 #define	FLG_IS_SECTREF	0x0010		/* section has been referenced */
940 #define	FLG_IS_GDATADEF	0x0020		/* section contains global data sym */
941 #define	FLG_IS_EXTERNAL	0x0040		/* isp from a user file */
942 #define	FLG_IS_INSTRMRG	0x0080		/* Usable SHF_MERGE|SHF_STRINGS sec */
943 #define	FLG_IS_GNSTRMRG	0x0100		/* Generated mergeable string section */
944 
945 #define	FLG_IS_PLACE	0x0400		/* section requires to be placed */
946 #define	FLG_IS_COMDAT	0x0800		/* section is COMDAT */
947 #define	FLG_IS_EHFRAME	0x1000		/* section is .eh_frame */
948 
949 /*
950  * Output sections contain lists of input sections that are assigned to them.
951  * These items fall into 4 categories:
952  *	BEFORE - Ordered sections that specify SHN_BEFORE, in input order.
953  *	ORDERED - Ordered sections that are sorted using unsorted sections
954  *		as the sort key.
955  *	DEFAULT - Sections that are placed into the output section
956  *		in input order.
957  *	AFTER - Ordered sections that specify SHN_AFTER, in input order.
958  */
959 #define	OS_ISD_BEFORE	0
960 #define	OS_ISD_ORDERED	1
961 #define	OS_ISD_DEFAULT	2
962 #define	OS_ISD_AFTER	3
963 #define	OS_ISD_NUM	4
964 typedef APlist *os_isdecs_arr[OS_ISD_NUM];
965 
966 /*
967  * Convenience macro for traversing every input section associated
968  * with a given output section. The primary benefit of this macro
969  * is that it preserves a precious level of code indentation in the
970  * code that uses it.
971  */
972 #define	OS_ISDESCS_TRAVERSE(_list_idx, _osp, _idx, _isp) \
973 	for (_list_idx = 0; _list_idx < OS_ISD_NUM; _list_idx++) \
974 		for (APLIST_TRAVERSE(_osp->os_isdescs[_list_idx], _idx, _isp))
975 
976 
977 /*
978  * Map file and output file processing structures
979  */
980 struct os_desc {			/* Output section descriptor */
981 	const char	*os_name;	/* the section name */
982 	Elf_Scn		*os_scn;	/* the elf section descriptor */
983 	Shdr		*os_shdr;	/* the elf section header */
984 	Os_desc		*os_relosdesc;	/* the output relocation section */
985 	APlist		*os_relisdescs;	/* reloc input section descriptors */
986 					/*	for this output section */
987 	os_isdecs_arr	os_isdescs;	/* lists of input sections in output */
988 	APlist		*os_mstrisdescs; /* FLG_IS_INSTRMRG input sections */
989 	Sg_desc		*os_sgdesc;	/* segment os_desc is placed on */
990 	Elf_Data	*os_outdata;	/* output sections raw data */
991 	avl_tree_t	*os_comdats;	/* AVL tree of COMDAT input sections */
992 					/*	associated to output section */
993 	Word		os_identndx;	/* section identifier for input */
994 					/*	section processing, followed */
995 					/*	by section symbol index */
996 	Word		os_ordndx;	/* index for section.  Used to decide */
997 					/*	where to insert section when */
998 					/*	reordering sections */
999 	Xword		os_szoutrels;	/* size of output relocation section */
1000 	uint_t		os_namehash;	/* hash on section name */
1001 	uchar_t		os_flags;	/* various flags */
1002 };
1003 
1004 #define	FLG_OS_KEY		0x01	/* section requires sort keys */
1005 #define	FLG_OS_OUTREL		0x02	/* output rel against this section */
1006 #define	FLG_OS_SECTREF		0x04	/* isps are not affected by -zignore */
1007 #define	FLG_OS_EHFRAME		0x08	/* section is .eh_frame */
1008 
1009 /*
1010  * The sg_id field of the segment descriptor is used to establish the default
1011  * order for program headers and segments in the output object. Segments are
1012  * ordered according to the following SGID values that classify them based on
1013  * their attributes. The initial set of built in segments are in this order,
1014  * and new mapfile defined segments are inserted into these groups. Within a
1015  * given SGID group, the position of new segments depends on the syntax
1016  * version of the mapfile that creates them. Version 1 (original sysv)
1017  * mapfiles place the new segment at the head of their group (reverse creation
1018  * order). The newer syntax places them at the end, following the others
1019  * (creation order).
1020  *
1021  * Note that any new segments must always be added after PT_PHDR and
1022  * PT_INTERP (refer Generic ABI, Page 5-4).
1023  */
1024 #define	SGID_PHDR	0	/* PT_PHDR */
1025 #define	SGID_INTERP	1	/* PT_INTERP */
1026 #define	SGID_SUNWCAP	2	/* PT_SUNWCAP */
1027 #define	SGID_TEXT	3	/* PT_LOAD */
1028 #define	SGID_DATA	4	/* PT_LOAD */
1029 #define	SGID_BSS	5	/* PT_LOAD */
1030 #if	defined(_ELF64)
1031 #define	SGID_LRODATA	6	/* PT_LOAD (amd64-only) */
1032 #define	SGID_LDATA	7	/* PT_LOAD (amd64-only) */
1033 #endif
1034 #define	SGID_TEXT_EMPTY	8	/* PT_LOAD, reserved (?E in version 1 syntax) */
1035 #define	SGID_NULL_EMPTY	9	/* PT_NULL, reserved (?E in version 1 syntax) */
1036 #define	SGID_DYN	10	/* PT_DYNAMIC */
1037 #define	SGID_DTRACE	11	/* PT_SUNWDTRACE */
1038 #define	SGID_TLS	12	/* PT_TLS */
1039 #define	SGID_UNWIND	13	/* PT_SUNW_UNWIND */
1040 #define	SGID_SUNWSTACK	14	/* PT_SUNWSTACK */
1041 #define	SGID_NOTE	15	/* PT_NOTE */
1042 #define	SGID_NULL	16	/* PT_NULL,  mapfile defined empty phdr slots */
1043 				/*	for use by post processors */
1044 #define	SGID_EXTRA	17	/* PT_NULL (final catchall) */
1045 
1046 typedef Half sg_flags_t;
1047 struct sg_desc {			/* output segment descriptor */
1048 	Word		sg_id;		/* segment identifier (for sorting) */
1049 	Phdr		sg_phdr;	/* segment header for output file */
1050 	const char	*sg_name;	/* segment name for PT_LOAD, PT_NOTE, */
1051 					/*	and PT_NULL, otherwise NULL */
1052 	Xword		sg_round;	/* data rounding required (mapfile) */
1053 	Xword		sg_length;	/* maximum segment length; if 0 */
1054 					/*	segment is not specified */
1055 	APlist		*sg_osdescs;	/* list of output section descriptors */
1056 	APlist		*sg_is_order;	/* list of entry criteria */
1057 					/*	giving input section order */
1058 	Alist		*sg_os_order;	/* list specifying output section */
1059 					/*	ordering for the segment */
1060 	sg_flags_t	sg_flags;
1061 	APlist		*sg_sizesym;	/* size symbols for this segment */
1062 	Xword		sg_align;	/* LCM of sh_addralign */
1063 	Elf_Scn		*sg_fscn;	/* the SCN of the first section. */
1064 	avl_node_t	sg_avlnode;	/* AVL book-keeping */
1065 };
1066 
1067 #define	FLG_SG_P_VADDR		0x0001	/* p_vaddr segment attribute set */
1068 #define	FLG_SG_P_PADDR		0x0002	/* p_paddr segment attribute set */
1069 #define	FLG_SG_LENGTH		0x0004	/* length segment attribute set */
1070 #define	FLG_SG_P_ALIGN		0x0008	/* p_align segment attribute set */
1071 #define	FLG_SG_ROUND		0x0010	/* round segment attribute set */
1072 #define	FLG_SG_P_FLAGS		0x0020	/* p_flags segment attribute set */
1073 #define	FLG_SG_P_TYPE		0x0040	/* p_type segment attribute set */
1074 #define	FLG_SG_IS_ORDER		0x0080	/* input section ordering is required */
1075 					/*	for this segment. */
1076 #define	FLG_SG_NOHDR		0x0100	/* don't map ELF or phdrs into */
1077 					/*	this segment */
1078 #define	FLG_SG_EMPTY		0x0200	/* an empty segment specification */
1079 					/*	no input sections will be */
1080 					/*	associated to this section */
1081 #define	FLG_SG_KEY		0x0400	/* segment requires sort keys */
1082 #define	FLG_SG_NODISABLE	0x0800	/* FLG_SG_DISABLED is not allowed on */
1083 					/*	this segment */
1084 #define	FLG_SG_DISABLED		0x1000	/* this segment is disabled */
1085 #define	FLG_SG_PHREQ		0x2000	/* this segment requires a program */
1086 					/* header */
1087 #define	FLG_SG_ORDERED		0x4000	/* SEGMENT_ORDER segment */
1088 
1089 struct sec_order {
1090 	const char	*sco_secname;	/* section name to be ordered */
1091 	Half		sco_flags;
1092 };
1093 
1094 #define	FLG_SGO_USED	0x0001		/* was ordering used? */
1095 
1096 typedef Half ec_flags_t;
1097 struct ent_desc {			/* input section entrance criteria */
1098 	const char	*ec_name;	/* entrace criteria name, or NULL */
1099 	Alist		*ec_files;	/* files from which to accept */
1100 					/*	sections */
1101 	const char	*ec_is_name;	/* input section name to match */
1102 					/*	(NULL if none) */
1103 	Word		ec_type;	/* section type */
1104 	Word		ec_attrmask;	/* section attribute mask (AWX) */
1105 	Word		ec_attrbits;	/* sections attribute bits */
1106 	Sg_desc		*ec_segment;	/* output segment to enter if matched */
1107 	Word		ec_ordndx;	/* index to determine where section */
1108 					/*	meeting this criteria should */
1109 					/*	inserted. Used for reordering */
1110 					/*	of sections. */
1111 	ec_flags_t	ec_flags;
1112 	avl_node_t	ec_avlnode;	/* AVL book-keeping */
1113 };
1114 
1115 #define	FLG_EC_BUILTIN	0x0001		/* built in descriptor */
1116 #define	FLG_EC_USED	0x0002		/* entrance criteria met? */
1117 #define	FLG_EC_CATCHALL	0x0004		/* Catches any section */
1118 
1119 /*
1120  * Ent_desc_file is the type of element maintained in the ec_files Alist
1121  * of an entrance criteria descriptor. Each item maintains one file
1122  * path, and a set of flags that specify the type of comparison it implies,
1123  * and other information about it. The comparison type is maintained in
1124  * the bottom byte of the flags.
1125  */
1126 #define	TYP_ECF_MASK		0x00ff  /* Comparison type mask */
1127 #define	TYP_ECF_PATH		0	/* Compare to file path */
1128 #define	TYP_ECF_BASENAME	1	/* Compare to file basename */
1129 #define	TYP_ECF_OBJNAME		2	/* Compare to regular file basename, */
1130 					/*	 or to archive member name */
1131 #define	TYP_ECF_NUM		3
1132 
1133 #define	FLG_ECF_ARMEMBER	0x0100	/* name includes archive member */
1134 
1135 typedef struct {
1136 	Word		edf_flags;	/* Type of comparison */
1137 	const char	*edf_name;	/* String to compare to */
1138 	size_t		edf_name_len;	/* strlen(edf_name) */
1139 } Ent_desc_file;
1140 
1141 /*
1142  * One structure is allocated for a move entry, and associated to the symbol
1143  * against which a move is targeted.
1144  */
1145 typedef struct {
1146 	Move		*md_move;	/* original Move entry */
1147 	Xword		md_start;	/* start position */
1148 	Xword		md_len;		/* length of initialization */
1149 	Word		md_oidx;	/* output Move entry index */
1150 } Mv_desc;
1151 
1152 #define	SYM_ASSERT_SIZE		0x01
1153 #define	SYM_ASSERT_BIND		0x02
1154 #define	SYM_ASSERT_TYPE		0x04
1155 #define	SYM_ASSERT_BITS		0x08
1156 #define	SYM_ASSERT_ALIAS	0x10
1157 
1158 typedef struct {
1159 	Sym_desc	*ass_sdp;
1160 	char		*ass_file;
1161 	Lineno		ass_lineno;
1162 	uchar_t		ass_type;
1163 	uchar_t		ass_bind;
1164 	Lword		ass_size;
1165 	Boolean		ass_bits;
1166 	const char	*ass_alias;
1167 	/* Assertions explicitly enabled by user */
1168 	uint_t		ass_enabled;
1169 } Ass_desc;
1170 
1171 /*
1172  * Symbol descriptor.
1173  */
1174 typedef	Lword		sd_flag_t;
1175 struct sym_desc {
1176 	Alist		*sd_GOTndxs;	/* list of associated GOT entries */
1177 	Sym		*sd_sym;	/* pointer to symbol table entry */
1178 	Sym		*sd_osym;	/* copy of the original symbol entry */
1179 					/*	used only for local partial */
1180 	Alist		*sd_move;	/* move information associated with a */
1181 					/*	partially initialized symbol */
1182 	const char	*sd_name;	/* symbols name */
1183 	Ifl_desc	*sd_file;	/* file where symbol is taken */
1184 	Is_desc		*sd_isc;	/* input section of symbol definition */
1185 	Sym_aux		*sd_aux;	/* auxiliary global symbol info. */
1186 	Word		sd_symndx;	/* index in output symbol table */
1187 	Word		sd_shndx;	/* sect. index sym is associated w/ */
1188 	sd_flag_t	sd_flags;	/* state flags */
1189 	Half		sd_ref;		/* reference definition of symbol */
1190 	Ass_desc	*sd_ass;	/* pointer back to symbol assertions */
1191 };
1192 
1193 /*
1194  * The auxiliary symbol descriptor contains the additional information (beyond
1195  * the symbol descriptor) required to process global symbols.  These symbols are
1196  * accessed via an internal symbol hash table where locality of reference is
1197  * important for performance.
1198  */
1199 struct sym_aux {
1200 	APlist		*sa_dfiles;	/* files where symbol is defined */
1201 	Sym		sa_sym;		/* copy of symtab entry */
1202 	const char	*sa_vfile;	/* first unavailable definition */
1203 	const char	*sa_rfile;	/* file with first symbol referenced */
1204 	Word		sa_hash;	/* the pure hash value of symbol */
1205 	Word		sa_PLTndx;	/* index into PLT for symbol */
1206 	Word		sa_PLTGOTndx;	/* GOT entry indx for PLT indirection */
1207 	Word		sa_linkndx;	/* index of associated symbol from */
1208 					/*	ET_DYN file */
1209 	Half		sa_symspec;	/* special symbol ids */
1210 	Half		sa_overndx;	/* output file versioning index */
1211 	Half		sa_dverndx;	/* dependency versioning index */
1212 	Os_desc		*sa_boundsec;	/* output section of SECBOUND_ syms */
1213 };
1214 
1215 /*
1216  * Nodes used to track symbols in the global AVL symbol dictionary.
1217  */
1218 struct sym_avlnode {
1219 	avl_node_t	sav_node;	/* AVL node */
1220 	Word		sav_hash;	/* symbol hash value */
1221 	const char	*sav_name;	/* symbol name */
1222 	Sym_desc	*sav_sdp;	/* symbol descriptor */
1223 };
1224 
1225 /*
1226  * These are the ids for processing of `Special symbols'.  They are used
1227  * to set the sym->sd_aux->sa_symspec field.
1228  */
1229 #define	SDAUX_ID_ETEXT		1	/* etext && _etext symbol */
1230 #define	SDAUX_ID_EDATA		2	/* edata && _edata symbol */
1231 #define	SDAUX_ID_END		3	/* end, _end, && _END_ symbol */
1232 #define	SDAUX_ID_DYN		4	/* DYNAMIC && _DYNAMIC symbol */
1233 #define	SDAUX_ID_PLT		5	/* _PROCEDURE_LINKAGE_TABLE_ symbol */
1234 #define	SDAUX_ID_GOT		6	/* _GLOBAL_OFFSET_TABLE_ symbol */
1235 #define	SDAUX_ID_START		7	/* START_ && _START_ symbol */
1236 #define	SDAUX_ID_SECBOUND_START	8	/* __start_<section> symbols */
1237 #define	SDAUX_ID_SECBOUND_STOP	9	/* __stop_<section> symbols */
1238 
1239 /*
1240  * Flags for sym_desc.sd_flags
1241  */
1242 #define	FLG_SY_MVTOCOMM	0x00000001	/* assign symbol to common (.bss) */
1243 					/*	this is a result of a */
1244 					/*	copy reloc against sym */
1245 #define	FLG_SY_GLOBREF	0x00000002	/* a global reference has been seen */
1246 #define	FLG_SY_WEAKDEF	0x00000004	/* a weak definition has been used */
1247 #define	FLG_SY_CLEAN	0x00000008	/* `Sym' entry points to original */
1248 					/*	input file (read-only). */
1249 #define	FLG_SY_UPREQD	0x00000010	/* symbol value update is required, */
1250 					/*	either it's used as an entry */
1251 					/*	point or for relocation, but */
1252 					/*	it must be updated even if */
1253 					/*	the -s flag is in effect */
1254 #define	FLG_SY_NOTAVAIL	0x00000020	/* symbol is not available to the */
1255 					/*	application either because it */
1256 					/*	originates from an implicitly */
1257 					/*	referenced shared object, or */
1258 					/*	because it is not part of a */
1259 					/*	specified version. */
1260 #define	FLG_SY_REDUCED	0x00000040	/* a global is reduced to local */
1261 #define	FLG_SY_VERSPROM	0x00000080	/* version definition has been */
1262 					/*	promoted to output file */
1263 #define	FLG_SY_PROT	0x00000100	/* stv_protected visibility seen */
1264 #define	FLG_SY_MAPREF	0x00000200	/* symbol reference generated by user */
1265 					/*	from mapfile */
1266 #define	FLG_SY_REFRSD	0x00000400	/* symbols sd_ref has been raised */
1267 					/*	due to a copy-relocs */
1268 					/*	weak-strong pairing */
1269 #define	FLG_SY_INTPOSE	0x00000800	/* symbol defines an interposer */
1270 #define	FLG_SY_INVALID	0x00001000	/* unwanted/erroneous symbol */
1271 #define	FLG_SY_SMGOT	0x00002000	/* small got index assigned to symbol */
1272 					/*	sparc only */
1273 #define	FLG_SY_PARENT	0x00004000	/* symbol to be found in parent */
1274 					/*    only used with direct bindings */
1275 #define	FLG_SY_LAZYLD	0x00008000	/* symbol to cause lazyloading of */
1276 					/*	parent object */
1277 #define	FLG_SY_ISDISC	0x00010000	/* symbol is a member of a DISCARDED */
1278 					/*	section (COMDAT) */
1279 #define	FLG_SY_PAREXPN	0x00020000	/* partially init. symbol to be */
1280 					/*	expanded */
1281 #define	FLG_SY_PLTPAD	0x00040000	/* pltpadding has been allocated for */
1282 					/*	this symbol */
1283 #define	FLG_SY_REGSYM	0x00080000	/* REGISTER symbol (sparc only) */
1284 #define	FLG_SY_SOFOUND	0x00100000	/* compared against an SO definition */
1285 #define	FLG_SY_EXTERN	0x00200000	/* symbol is external, allows -zdefs */
1286 					/*    error suppression */
1287 #define	FLG_SY_MAPUSED	0x00400000	/* mapfile symbol used (occurred */
1288 					/*    within a relocatable object) */
1289 #define	FLG_SY_COMMEXP	0x00800000	/* COMMON symbol which has been */
1290 					/*	allocated */
1291 #define	FLG_SY_CMDREF	0x01000000	/* symbol was referenced from the */
1292 					/*	command line.  (ld -u <>, */
1293 					/*	ld -zrtldinfo=<>, ...) */
1294 #define	FLG_SY_SPECSEC	0x02000000	/* section index is reserved value */
1295 					/*	ABS, COMMON, ... */
1296 #define	FLG_SY_TENTSYM	0x04000000	/* tentative symbol */
1297 #define	FLG_SY_VISIBLE	0x08000000	/* symbols visibility determined */
1298 #define	FLG_SY_STDFLTR	0x10000000	/* symbol is a standard filter */
1299 #define	FLG_SY_AUXFLTR	0x20000000	/* symbol is an auxiliary filter */
1300 #define	FLG_SY_DYNSORT	0x40000000	/* req. in dyn[sym|tls]sort section */
1301 #define	FLG_SY_NODYNSORT 0x80000000	/* excluded from dyn[sym_tls]sort sec */
1302 
1303 #define	FLG_SY_DEFAULT	0x0000100000000	/* global symbol, default */
1304 #define	FLG_SY_SINGLE	0x0000200000000	/* global symbol, singleton defined */
1305 #define	FLG_SY_PROTECT	0x0000400000000	/* global symbol, protected defined */
1306 #define	FLG_SY_EXPORT	0x0000800000000	/* global symbol, exported defined */
1307 
1308 #define	MSK_SY_GLOBAL \
1309 	(FLG_SY_DEFAULT | FLG_SY_SINGLE | FLG_SY_PROTECT | FLG_SY_EXPORT)
1310 					/* this mask indicates that the */
1311 					/*    symbol has been explicitly */
1312 					/*    defined within a mapfile */
1313 					/*    definition, and is a candidate */
1314 					/*    for versioning */
1315 
1316 #define	FLG_SY_HIDDEN	0x0001000000000	/* global symbol, reduce to local */
1317 #define	FLG_SY_ELIM	0x0002000000000	/* global symbol, eliminate */
1318 #define	FLG_SY_IGNORE	0x0004000000000	/* global symbol, ignored */
1319 
1320 #define	MSK_SY_LOCAL	(FLG_SY_HIDDEN | FLG_SY_ELIM | FLG_SY_IGNORE)
1321 					/* this mask allows all local state */
1322 					/*    flags to be removed when the */
1323 					/*    symbol is copy relocated */
1324 
1325 #define	FLG_SY_EXPDEF	0x0008000000000	/* symbol visibility defined */
1326 					/*    explicitly */
1327 
1328 #define	MSK_SY_NOAUTO	(FLG_SY_SINGLE | FLG_SY_EXPORT | FLG_SY_EXPDEF)
1329 					/* this mask indicates that the */
1330 					/*    symbol is not a candidate for */
1331 					/*    auto-reduction/elimination */
1332 
1333 #define	FLG_SY_MAPFILE	0x0010000000000	/* symbol attribute defined in a */
1334 					/*    mapfile */
1335 #define	FLG_SY_DIR	0x0020000000000	/* global symbol, direct bindings */
1336 #define	FLG_SY_NDIR	0x0040000000000	/* global symbol, nondirect bindings */
1337 #define	FLG_SY_OVERLAP	0x0080000000000	/* move entry overlap detected */
1338 #define	FLG_SY_CAP	0x0100000000000	/* symbol is associated with */
1339 					/*    capabilities */
1340 #define	FLG_SY_DEFERRED	0x0200000000000	/* symbol should not be bound to */
1341 					/*	during BIND_NOW relocations */
1342 
1343 #define	FLG_SY_MAPASSRT	0x0400000000000 /* Symbol has attribute assertions */
1344 
1345 /*
1346  * A symbol can only be truly hidden if it is not a capabilities symbol.
1347  */
1348 #define	SYM_IS_HIDDEN(_sdp) \
1349 	(((_sdp)->sd_flags & (FLG_SY_HIDDEN | FLG_SY_CAP)) == FLG_SY_HIDDEN)
1350 
1351 /*
1352  * Create a mask for (sym.st_other & visibility) since the gABI does not yet
1353  * define a ELF*_ST_OTHER macro.
1354  */
1355 #define	MSK_SYM_VISIBILITY	0x7
1356 
1357 /*
1358  * Structure to manage the shared object definition lists.  There are two lists
1359  * that use this structure:
1360  *
1361  *  -	ofl_soneed; maintain the list of implicitly required dependencies
1362  *	(ie. shared objects needed by other shared objects).  These definitions
1363  *	may include RPATH's required to locate the dependencies, and any
1364  *	version requirements.
1365  *
1366  *  -	ofl_socntl; maintains the shared object control definitions.  These are
1367  *	provided by the user (via a mapfile) and are used to indicate any
1368  *	version control requirements.
1369  */
1370 struct	sdf_desc {
1371 	const char	*sdf_name;	/* the shared objects file name */
1372 	char		*sdf_rpath;	/* library search path DT_RPATH */
1373 	const char	*sdf_rfile;	/* referencing file for diagnostics */
1374 	Ifl_desc	*sdf_file;	/* the final input file descriptor */
1375 	Alist		*sdf_vers;	/* list of versions that are required */
1376 					/*	from this object */
1377 	Alist		*sdf_verneed;	/* list of VERNEEDS to create for */
1378 					/*	object via mapfile ADDVERS */
1379 	Word		sdf_flags;
1380 };
1381 
1382 #define	FLG_SDF_SELECT	0x01		/* version control selection required */
1383 #define	FLG_SDF_VERIFY	0x02		/* version definition verification */
1384 					/*	required */
1385 #define	FLG_SDF_ADDVER	0x04		/* add VERNEED references */
1386 
1387 /*
1388  * Structure to manage shared object version usage requirements.
1389  */
1390 struct	sdv_desc {
1391 	const char	*sdv_name;	/* version name */
1392 	const char	*sdv_ref;	/* versions reference */
1393 	Word		sdv_flags;	/* flags */
1394 };
1395 
1396 #define	FLG_SDV_MATCHED	0x01		/* VERDEF found and matched */
1397 
1398 /*
1399  * Structures to manage versioning information.  Two versioning structures are
1400  * defined:
1401  *
1402  *   -	a version descriptor maintains a linked list of versions and their
1403  *	associated dependencies.  This is used to build the version definitions
1404  *	for an image being created (see map_symbol), and to determine the
1405  *	version dependency graph for any input files that are versioned.
1406  *
1407  *   -	a version index array contains each version of an input file that is
1408  *	being processed.  It informs us which versions are available for
1409  *	binding, and is used to generate any version dependency information.
1410  */
1411 struct	ver_desc {
1412 	const char	*vd_name;	/* version name */
1413 	Ifl_desc	*vd_file;	/* file that defined version */
1414 	Word		vd_hash;	/* hash value of name */
1415 	Half		vd_ndx;		/* coordinates with symbol index */
1416 	Half		vd_flags;	/* version information */
1417 	APlist		*vd_deps;	/* version dependencies */
1418 	Ver_desc	*vd_ref;	/* dependency's first reference */
1419 };
1420 
1421 struct	ver_index {
1422 	const char	*vi_name;	/* dependency version name */
1423 	Half		vi_flags;	/* communicates availability */
1424 	Half		vi_overndx;	/* index assigned to this version in */
1425 					/*	output object Verneed section */
1426 	Ver_desc	*vi_desc;	/* cross reference to descriptor */
1427 };
1428 
1429 /*
1430  * Define any internal version descriptor flags ([vd|vi]_flags).  Note that the
1431  * first byte is reserved for user visible flags (refer VER_FLG's in link.h).
1432  */
1433 #define	MSK_VER_USER	0x0f		/* mask for user visible flags */
1434 
1435 #define	FLG_VER_AVAIL	0x10		/* version is available for binding */
1436 #define	FLG_VER_REFER	0x20		/* version has been referenced */
1437 #define	FLG_VER_CYCLIC	0x40		/* a member of cyclic dependency */
1438 
1439 /*
1440  * isalist(1) descriptor - used to break an isalist string into its component
1441  * options.
1442  */
1443 struct	isa_opt {
1444 	char		*isa_name;	/* individual isa option name */
1445 	size_t		isa_namesz;	/*	and associated size */
1446 };
1447 
1448 struct	isa_desc {
1449 	char		*isa_list;	/* sysinfo(SI_ISALIST) list */
1450 	size_t		isa_listsz;	/*	and associated size */
1451 	Isa_opt		*isa_opt;	/* table of individual isa options */
1452 	size_t		isa_optno;	/*	and associated number */
1453 };
1454 
1455 /*
1456  * uname(2) descriptor - used to break a utsname structure into its component
1457  * options (at least those that we're interested in).
1458  */
1459 struct	uts_desc {
1460 	char		*uts_osname;	/* operating system name */
1461 	size_t		uts_osnamesz;	/*	and associated size */
1462 	char		*uts_osrel;	/* operating system release */
1463 	size_t		uts_osrelsz;	/*	and associated size */
1464 };
1465 
1466 /*
1467  * SHT_GROUP descriptor - used to track group sections at the global
1468  * level to resolve conflicts and determine which to keep.
1469  */
1470 struct group_desc {
1471 	Is_desc		*gd_isc;	/* input section descriptor */
1472 	Is_desc		*gd_oisc;	/* overriding input section */
1473 					/*	descriptor when discarded */
1474 	const char	*gd_name;	/* group name (signature symbol) */
1475 	Word		*gd_data;	/* data for group section */
1476 	size_t		gd_cnt;		/* number of entries in group data */
1477 };
1478 
1479 /*
1480  * Indexes into the ld_support_funcs[] table.
1481  */
1482 typedef enum {
1483 	LDS_VERSION = 0,	/* Must be first and have value 0 */
1484 	LDS_INPUT_DONE,
1485 	LDS_START,
1486 	LDS_ATEXIT,
1487 	LDS_OPEN,
1488 	LDS_FILE,
1489 	LDS_INSEC,
1490 	LDS_SEC,
1491 	LDS_NUM
1492 } Support_ndx;
1493 
1494 /*
1495  * Structure to manage archive member caching.  Each archive has an archive
1496  * descriptor (Ar_desc) associated with it.  This contains pointers to the
1497  * archive symbol table (obtained by elf_getarsyms(3e)) and an auxiliary
1498  * structure (Ar_uax[]) that parallels this symbol table.  The member element
1499  * of this auxiliary table indicates whether the archive member associated with
1500  * the symbol offset has already been extracted (AREXTRACTED) or partially
1501  * processed (refer process_member()).
1502  */
1503 typedef struct ar_mem {
1504 	Elf		*am_elf;	/* elf descriptor for this member */
1505 	const char	*am_name;	/* members name */
1506 	const char	*am_path;	/* path (ie. lib(foo.o)) */
1507 	Sym		*am_syms;	/* start of global symbols */
1508 	char		*am_strs;	/* associated string table start */
1509 	Xword		am_symn;	/* no. of global symbols */
1510 } Ar_mem;
1511 
1512 typedef struct ar_aux {
1513 	Sym_desc	*au_syms;	/* internal symbol descriptor */
1514 	Ar_mem		*au_mem;	/* associated member */
1515 } Ar_aux;
1516 
1517 #define	FLG_ARMEM_PROC	(Ar_mem *)-1
1518 
1519 typedef struct ar_desc {
1520 	const char	*ad_name;	/* archive file name */
1521 	Elf		*ad_elf;	/* elf descriptor for the archive */
1522 	Elf_Arsym	*ad_start;	/* archive symbol table start */
1523 	Ar_aux		*ad_aux;	/* auxiliary symbol information */
1524 	dev_t		ad_stdev;	/* device id and inode number for */
1525 	ino_t		ad_stino;	/*	multiple inclusion checks */
1526 	ofl_flag_t	ad_flags;	/* archive specific cmd line flags */
1527 } Ar_desc;
1528 
1529 /*
1530  * Define any archive descriptor flags.  NOTE, make sure they do not clash with
1531  * any output file descriptor archive extraction flags, as these are saved in
1532  * the same entry (see MSK_OF1_ARCHIVE).
1533  */
1534 #define	FLG_ARD_EXTRACT	0x00010000	/* archive member has been extracted */
1535 
1536 /* Mapfile versions supported by libld */
1537 #define	MFV_NONE	0	/* Not a valid version */
1538 #define	MFV_SYSV	1	/* Original System V syntax */
1539 #define	MFV_SOLARIS	2	/* Solaris mapfile syntax */
1540 #define	MFV_NUM		3	/* # of mapfile versions */
1541 
1542 
1543 /*
1544  * Function Declarations.
1545  */
1546 #if	defined(_ELF64)
1547 
1548 #define	ld_create_outfile	ld64_create_outfile
1549 #define	ld_ent_setup		ld64_ent_setup
1550 #define	ld_init_strings		ld64_init_strings
1551 #define	ld_init_target		ld64_init_target
1552 #define	ld_make_sections	ld64_make_sections
1553 #define	ld_main			ld64_main
1554 #define	ld_ofl_cleanup		ld64_ofl_cleanup
1555 #define	ld_process_mem		ld64_process_mem
1556 #define	ld_reloc_init		ld64_reloc_init
1557 #define	ld_reloc_process	ld64_reloc_process
1558 #define	ld_sym_validate		ld64_sym_validate
1559 #define	ld_update_outfile	ld64_update_outfile
1560 
1561 #else
1562 
1563 #define	ld_create_outfile	ld32_create_outfile
1564 #define	ld_ent_setup		ld32_ent_setup
1565 #define	ld_init_strings		ld32_init_strings
1566 #define	ld_init_target		ld32_init_target
1567 #define	ld_make_sections	ld32_make_sections
1568 #define	ld_main			ld32_main
1569 #define	ld_ofl_cleanup		ld32_ofl_cleanup
1570 #define	ld_process_mem		ld32_process_mem
1571 #define	ld_reloc_init		ld32_reloc_init
1572 #define	ld_reloc_process	ld32_reloc_process
1573 #define	ld_sym_validate		ld32_sym_validate
1574 #define	ld_update_outfile	ld32_update_outfile
1575 
1576 #endif
1577 
1578 extern int		ld_getopt(Lm_list *, int, int, char **);
1579 
1580 extern int		ld32_main(int, char **, Half);
1581 extern int		ld64_main(int, char **, Half);
1582 
1583 extern uintptr_t	ld_create_outfile(Ofl_desc *);
1584 extern uintptr_t	ld_ent_setup(Ofl_desc *, Xword);
1585 extern uintptr_t	ld_init_strings(Ofl_desc *);
1586 extern int		ld_init_target(Lm_list *, Half mach);
1587 extern uintptr_t	ld_make_sections(Ofl_desc *);
1588 extern void		ld_ofl_cleanup(Ofl_desc *);
1589 extern Ifl_desc		*ld_process_mem(const char *, const char *, char *,
1590 			    size_t, Ofl_desc *, Rej_desc *);
1591 extern uintptr_t	ld_reloc_init(Ofl_desc *);
1592 extern uintptr_t	ld_reloc_process(Ofl_desc *);
1593 extern uintptr_t	ld_sym_validate(Ofl_desc *);
1594 extern uintptr_t	ld_update_outfile(Ofl_desc *);
1595 
1596 #ifdef	__cplusplus
1597 }
1598 #endif
1599 
1600 #endif	/* _LIBLD_H */
1601