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