xref: /illumos-gate/usr/src/cmd/sgs/include/libld.h (revision 47842382d52f28aa3173aa6b511781c322ccb6a2)
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 2009 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 
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  * GOT reference models
105  */
106 typedef enum {
107 	GOT_REF_GENERIC,	/* generic symbol reference */
108 	GOT_REF_TLSIE,		/* TLS initial exec (gnu) reference */
109 	GOT_REF_TLSLD,		/* TLS local dynamic reference */
110 	GOT_REF_TLSGD		/* TLS general dynamic reference */
111 } Gotref;
112 
113 typedef struct {
114 	Xword		gn_addend;	/* addend associated with GOT entry */
115 	Sword		gn_gotndx;	/* GOT table index */
116 	Gotref		gn_gotref;
117 } Gotndx;
118 
119 /*
120  * Got debugging structure.  The got index is defined as a signed value as we
121  * do so much mucking around with negative and positive gots on SPARC, and sign
122  * extension is necessary when building 64-bit objects.  On intel we explicitly
123  * cast this variable to an unsigned value.
124  */
125 typedef struct {
126 	Sym_desc *	gt_sym;
127 	Gotndx		gt_gndx;
128 } Gottable;
129 
130 /*
131  * The link-editor caches the results of sloppy relocation processing
132  * in a variable of this type. Symbols come for processing in sorted
133  * order, so a 1 element cache suffices to eliminate duplicate lookups.
134  */
135 typedef struct sreloc_cache {
136 	Sym_desc	*sr_osdp;	/* Original symbol */
137 	Sym_desc	*sr_rsdp;	/* Replacement symbol */
138 } Sreloc_cache;
139 
140 /*
141  * Output file processing structure
142  */
143 typedef Lword ofl_flag_t;
144 struct ofl_desc {
145 	char		*ofl_sgsid;	/* link-editor identification */
146 	const char	*ofl_name;	/* full file name */
147 	Elf		*ofl_elf;	/* elf_memory() elf descriptor */
148 	Elf		*ofl_welf;	/* ELF_C_WRITE elf descriptor */
149 	Ehdr		*ofl_dehdr;	/* default elf header, and new elf */
150 	Ehdr		*ofl_nehdr;	/*	header describing this file */
151 	Phdr		*ofl_phdr;	/* program header descriptor */
152 	Phdr		*ofl_tlsphdr;	/* TLS phdr */
153 	int		ofl_fd;		/* file descriptor */
154 	size_t		ofl_size;	/* image size */
155 	List		ofl_maps;	/* list of input mapfiles */
156 	List		ofl_segs;	/* list of segments */
157 	List		ofl_ents;	/* list of entrance descriptors */
158 	List		ofl_objs;	/* relocatable object file list */
159 	Word		ofl_objscnt;	/* 	and count */
160 	List		ofl_ars;	/* archive library list */
161 	Word		ofl_arscnt;	/* 	and count */
162 	int		ofl_ars_gsandx; /* archive group argv index. 0 means */
163 					/*	no current group, < 0 means */
164 					/*	error reported. >0 is cur ndx */
165 	Word		ofl_ars_gsndx;	/* current -zrescan-start ofl_ars ndx */
166 	List		ofl_sos;	/* shared object list */
167 	Word		ofl_soscnt;	/* 	and count */
168 	List		ofl_soneed;	/* list of implicitly required .so's */
169 	List		ofl_socntl;	/* list of .so control definitions */
170 	List		ofl_outrels;	/* list of output relocations */
171 	Word		ofl_outrelscnt;	/* 	and count */
172 	List		ofl_actrels;	/* list of relocations to perform */
173 	Word		ofl_actrelscnt;	/* 	and count */
174 	Word		ofl_entrelscnt;	/* no of relocations entered */
175 	List		ofl_copyrels;	/* list of copy relocations */
176 	List		ofl_ordered;	/* list of shf_ordered sections */
177 	List		ofl_syminfsyms;	/* list of interesting syms */
178 					/*	for syminfo processing */
179 	List		ofl_ismove;	/* list of .SUNW_move sections */
180 	List		ofl_mvrelisdescs; /* list of relocation input section */
181 					/* targeting to expanded area */
182 	List		ofl_parsym; 	/* list of Parsym_info */
183 	List		ofl_extrarels;	/* relocation sections which have */
184 					/*    a NULL sh_info */
185 	avl_tree_t	*ofl_groups;	/* pointer to head of Groups AVL tree */
186 	List		ofl_initarray;	/* list of init array func names */
187 	List		ofl_finiarray;	/* list of fini array func names */
188 	List		ofl_preiarray;	/* list of preinit array func names */
189 	List		ofl_rtldinfo;	/* list of rtldinfo syms */
190 	List		ofl_osgroups;	/* list of output GROUP sections */
191 	List		ofl_ostlsseg;	/* pointer to sections in TLS segment */
192 #if	defined(_ELF64)			/* for amd64 target only */
193 	List		ofl_unwind;	/* list of unwind output sections */
194 	Os_desc		*ofl_unwindhdr;	/* Unwind hdr */
195 #endif
196 	avl_tree_t	ofl_symavl;	/* pointer to head of Syms AVL tree */
197 	Sym_desc	**ofl_regsyms;	/* array of potential register */
198 	Word		ofl_regsymsno;	/*    symbols and array count */
199 	Word		ofl_regsymcnt;	/* no. of output register symbols */
200 	Word		ofl_lregsymcnt;	/* no. of local register symbols */
201 	Sym_desc	*ofl_dtracesym;	/* ld -zdtrace= */
202 	ofl_flag_t	ofl_flags;	/* various state bits, args etc. */
203 	ofl_flag_t	ofl_flags1;	/*	more flags */
204 	void		*ofl_entry;	/* entry point (-e and Sym_desc *) */
205 	char		*ofl_filtees;	/* shared objects we are a filter for */
206 	const char	*ofl_soname;	/* (-h option) output file name for */
207 					/*	dynamic structure */
208 	const char	*ofl_interp;	/* interpreter name used by exec() */
209 	char		*ofl_rpath;	/* run path to store in .dynamic */
210 	char		*ofl_config;	/* config path to store in .dynamic */
211 	List		ofl_ulibdirs;	/* user supplied library search list */
212 	List		ofl_dlibdirs;	/* default library search list */
213 	Word		ofl_vercnt;	/* number of versions to generate */
214 	List		ofl_verdesc;	/* list of version descriptors */
215 	size_t		ofl_verdefsz;	/* size of version definition section */
216 	size_t		ofl_verneedsz;	/* size of version needed section */
217 	Word		ofl_entercnt;	/* no. of global symbols entered */
218 	Word		ofl_globcnt;	/* no. of global symbols to output */
219 	Word		ofl_scopecnt;	/* no. of scoped symbols to output */
220 	Word		ofl_dynscopecnt; /* no. scoped syms in .SUNW_ldynsym */
221 	Word		ofl_elimcnt;	/* no. of eliminated symbols */
222 	Word		ofl_locscnt;	/* no. of local symbols in .symtab */
223 	Word		ofl_dynlocscnt;	/* no. local symbols in .SUNW_ldynsym */
224 	Word		ofl_dynsymsortcnt; /* no. ndx in .SUNW_dynsymsort */
225 	Word		ofl_dyntlssortcnt; /* no. ndx in .SUNW_dyntlssort */
226 	Word		ofl_dynshdrcnt;	/* no. of output section in .dynsym */
227 	Word		ofl_shdrcnt;	/* no. of output sections */
228 	Str_tbl		*ofl_shdrsttab;	/* Str_tbl for shdr strtab */
229 	Str_tbl		*ofl_strtab;	/* Str_tbl for symtab strtab */
230 	Str_tbl		*ofl_dynstrtab;	/* Str_tbl for dymsym strtab */
231 	Gotndx		*ofl_tlsldgotndx; /* index to LD TLS_index structure */
232 	Xword		ofl_relocsz;	/* size of output relocations */
233 	Xword		ofl_relocgotsz;	/* size of .got relocations */
234 	Xword		ofl_relocpltsz;	/* size of .plt relocations */
235 	Xword		ofl_relocbsssz;	/* size of .bss (copy) relocations */
236 	Xword		ofl_relocrelsz;	/* size of .rel[a] relocations */
237 	Word		ofl_relocincnt;	/* no. of input relocations */
238 	Word		ofl_reloccnt;	/* tot number of output relocations */
239 	Word		ofl_reloccntsub; /* tot numb of output relocations to */
240 					/*	skip (-zignore) */
241 	Word		ofl_relocrelcnt; /* tot number of relative */
242 					/*	relocations */
243 	Word		ofl_gotcnt;	/* no. of .got entries */
244 	Word		ofl_pltcnt;	/* no. of .plt entries */
245 	Word		ofl_pltpad;	/* no. of .plt padd entries */
246 	Word		ofl_hashbkts;	/* no. of hash buckets required */
247 	Is_desc		*ofl_isbss;	/* .bss input section (globals) */
248 	Is_desc		*ofl_islbss;	/* .lbss input section (globals) */
249 	Is_desc		*ofl_istlsbss;	/* .tlsbss input section (globals) */
250 	Is_desc		*ofl_isparexpn;	/* -z nopartial .data input section */
251 	Os_desc		*ofl_osdynamic;	/* .dynamic output section */
252 	Os_desc		*ofl_osdynsym;	/* .dynsym output section */
253 	Os_desc		*ofl_osldynsym;	/* .SUNW_ldynsym output section */
254 	Os_desc		*ofl_osdynstr;	/* .dynstr output section */
255 	Os_desc		*ofl_osdynsymsort; /* .SUNW_dynsymsort output section */
256 	Os_desc		*ofl_osdyntlssort; /* .SUNW_dyntlssort output section */
257 	Os_desc		*ofl_osgot;	/* .got output section */
258 	Os_desc		*ofl_oshash;	/* .hash output section */
259 	Os_desc		*ofl_osinitarray; /* .initarray output section */
260 	Os_desc		*ofl_osfiniarray; /* .finiarray output section */
261 	Os_desc		*ofl_ospreinitarray; /* .preinitarray output section */
262 	Os_desc		*ofl_osinterp;	/* .interp output section */
263 	Os_desc		*ofl_oscap;	/* .SUNW_cap output section */
264 	Os_desc		*ofl_osplt;	/* .plt output section */
265 	Os_desc		*ofl_osmove;	/* .SUNW_move output section */
266 	Os_desc		*ofl_osrelhead;	/* first relocation section */
267 	Os_desc		*ofl_osrel;	/* .rel[a] relocation section */
268 	Os_desc		*ofl_osshstrtab; /* .shstrtab output section */
269 	Os_desc		*ofl_osstrtab;	/* .strtab output section */
270 	Os_desc		*ofl_ossymtab;	/* .symtab output section */
271 	Os_desc		*ofl_ossymshndx; /* .symtab_shndx output section */
272 	Os_desc		*ofl_osdynshndx; /* .dynsym_shndx output section */
273 	Os_desc		*ofl_osldynshndx; /* .SUNW_ldynsym_shndx output sec */
274 	Os_desc		*ofl_osverdef;	/* .version definition output section */
275 	Os_desc		*ofl_osverneed;	/* .version needed output section */
276 	Os_desc		*ofl_osversym;	/* .version symbol ndx output section */
277 	Word		ofl_dtflags_1;	/* DT_FLAGS_1 entries */
278 	Word		ofl_dtflags;	/* DT_FLAGS entries */
279 	Os_desc		*ofl_ossyminfo;	/* .SUNW_syminfo output section */
280 	Half		ofl_parexpnndx;	/* -z nopartial section index */
281 					/* Ref. at perform_outreloc() in */
282 					/* libld/{mach}/machrel.c */
283 	Xword		*ofl_checksum;	/* DT_CHECKSUM value address */
284 	char		*ofl_depaudit;	/* dependency auditing required (-P) */
285 	char		*ofl_audit;	/* object auditing required (-p) */
286 	Alist		*ofl_symfltrs;	/* per-symbol filtees and their */
287 	Alist		*ofl_dtsfltrs;	/*	associated .dynamic/.dynstrs */
288 	Xword		ofl_hwcap_1;	/* hardware capabilities */
289 	Xword		ofl_sfcap_1;	/* software capabilities */
290 	Lm_list		*ofl_lml;	/* runtime link-map list */
291 	Gottable	*ofl_gottable;	/* debugging got information */
292 	Sreloc_cache	ofl_sr_cache;	/* Cache last result from */
293 					/*	sloppy_comdat_reloc() */
294 };
295 
296 #define	FLG_OF_DYNAMIC	0x00000001	/* generate dynamic output module */
297 #define	FLG_OF_STATIC	0x00000002	/* generate static output module */
298 #define	FLG_OF_EXEC	0x00000004	/* generate an executable */
299 #define	FLG_OF_RELOBJ	0x00000008	/* generate a relocatable object */
300 #define	FLG_OF_SHAROBJ	0x00000010	/* generate a shared object */
301 #define	FLG_OF_BFLAG	0x00000020	/* do no special plt building: -b */
302 #define	FLG_OF_IGNENV	0x00000040	/* ignore LD_LIBRARY_PATH: -i */
303 #define	FLG_OF_STRIP	0x00000080	/* strip output: -s */
304 #define	FLG_OF_NOWARN	0x00000100	/* disable symbol warnings: -t */
305 #define	FLG_OF_NOUNDEF	0x00000200	/* allow no undefined symbols: -zdefs */
306 #define	FLG_OF_PURETXT	0x00000400	/* allow no text relocations: -ztext  */
307 #define	FLG_OF_GENMAP	0x00000800	/* generate a memory map: -m */
308 #define	FLG_OF_DYNLIBS	0x00001000	/* dynamic input allowed: -Bdynamic */
309 #define	FLG_OF_SYMBOLIC	0x00002000	/* bind global symbols: -Bsymbolic */
310 #define	FLG_OF_ADDVERS	0x00004000	/* add version stamp: -Qy */
311 #define	FLG_OF_NOLDYNSYM 0x00008000	/* -znoldynsym set */
312 #define	FLG_OF_SEGORDER	0x00010000	/* segment ordering is required */
313 #define	FLG_OF_SEGSORT	0x00020000	/* segment sorting is required */
314 #define	FLG_OF_TEXTREL	0x00040000	/* text relocations have been found */
315 #define	FLG_OF_MULDEFS	0x00080000	/* multiple symbols are allowed */
316 #define	FLG_OF_TLSPHDR	0x00100000	/* a TLS program header is required */
317 #define	FLG_OF_BLDGOT	0x00200000	/* build GOT table */
318 #define	FLG_OF_VERDEF	0x00400000	/* record version definitions */
319 #define	FLG_OF_VERNEED	0x00800000	/* record version dependencies */
320 #define	FLG_OF_NOVERSEC 0x01000000	/* don't record version sections */
321 #define	FLG_OF_KEY	0x02000000	/* file requires sort keys */
322 #define	FLG_OF_PROCRED	0x04000000	/* process any symbol reductions by */
323 					/*	effecting the symbol table */
324 					/*	output and relocations */
325 #define	FLG_OF_SYMINFO	0x08000000	/* create a syminfo section */
326 #define	FLG_OF_AUX	0x10000000	/* ofl_filter is an auxiliary filter */
327 #define	FLG_OF_FATAL	0x20000000	/* fatal error during input */
328 #define	FLG_OF_WARN	0x40000000	/* warning during input processing. */
329 #define	FLG_OF_VERBOSE	0x80000000	/* -z verbose flag set */
330 
331 #define	FLG_OF_MAPSYMB	0x000100000000	/* symbolic scope definition seen */
332 #define	FLG_OF_MAPGLOB	0x000200000000	/* global scope definition seen */
333 #define	FLG_OF_COMREL	0x000400000000	/* -z combreloc set, which enables */
334 					/*	DT_RELACNT tracking, */
335 #define	FLG_OF_NOCOMREL	0x000800000000	/* -z nocombreloc set */
336 #define	FLG_OF_AUTOLCL	0x001000000000	/* automatically reduce unspecified */
337 					/*	global symbols to locals */
338 #define	FLG_OF_AUTOELM	0x002000000000	/* automatically eliminate  */
339 					/*	unspecified global symbols */
340 #define	FLG_OF_REDLSYM	0x004000000000	/* reduce local symbols */
341 #define	FLG_OF_SECORDER	0x008000000000	/* section ordering is required */
342 
343 /*
344  * In the flags1 arena, establish any options that are applicable to archive
345  * extraction first, and associate a mask.  These values are recorded with any
346  * archive descriptor so that they may be reset should the archive require a
347  * rescan to try and resolve undefined symbols.
348  */
349 #define	FLG_OF1_ALLEXRT	0x00000001	/* extract all members from an */
350 					/*	archive file */
351 #define	FLG_OF1_WEAKEXT	0x00000002	/* allow archive extraction to */
352 					/*	resolve weak references */
353 #define	MSK_OF1_ARCHIVE	0x00000003	/* archive flags mask */
354 
355 #define	FLG_OF1_NOINTRP	0x00000008	/* -z nointerp flag set */
356 #define	FLG_OF1_ZDIRECT	0x00000010	/* -z direct flag set */
357 #define	FLG_OF1_NDIRECT	0x00000020	/* no-direct bindings specified */
358 #define	FLG_OF1_OVHWCAP	0x00000040	/* override any input hardware or */
359 #define	FLG_OF1_OVSFCAP	0x00000080	/*	software capabilities */
360 #define	FLG_OF1_RELDYN	0x00000100	/* process .dynamic in rel obj */
361 #define	FLG_OF1_NRLXREL	0x00000200	/* -z norelaxreloc flag set */
362 #define	FLG_OF1_RLXREL	0x00000400	/* -z relaxreloc flag set */
363 #define	FLG_OF1_IGNORE	0x00000800	/* ignore unused dependencies */
364 
365 #define	FLG_OF1_TEXTOFF 0x00002000	/* text relocations are ok */
366 #define	FLG_OF1_ABSEXEC	0x00004000	/* -zabsexec set */
367 #define	FLG_OF1_LAZYLD	0x00008000	/* lazy loading of objects enabled */
368 #define	FLG_OF1_GRPPRM	0x00010000	/* dependencies are to have */
369 					/*	GROUPPERM enabled */
370 #define	FLG_OF1_OVRFLW	0x00020000	/* size exceeds 32-bit limitation */
371 					/*	of 32-bit libld */
372 #define	FLG_OF1_NOPARTI	0x00040000	/* -znopartial set */
373 #define	FLG_OF1_BSSOREL	0x00080000	/* output relocation against bss */
374 					/*	section */
375 #define	FLG_OF1_TLSOREL	0x00100000	/* output relocation against .tlsbss */
376 					/*	section */
377 #define	FLG_OF1_MEMORY	0x00200000	/* produce a memory model */
378 
379 #define	FLG_OF1_ENCDIFF	0x00800000	/* Host running linker has different */
380 					/*	byte order than output object */
381 #define	FLG_OF1_VADDR	0x01000000	/* vaddr was explicitly set */
382 #define	FLG_OF1_EXTRACT	0x02000000	/* archive member has been extracted */
383 #define	FLG_OF1_RESCAN	0x04000000	/* any archives should be rescanned */
384 #define	FLG_OF1_IGNPRC	0x08000000	/* ignore processing required */
385 #define	FLG_OF1_NCSTTAB	0x10000000	/* -znocompstrtab set */
386 #define	FLG_OF1_DONE	0x20000000	/* link-editor processing complete */
387 #define	FLG_OF1_NONREG	0x40000000	/* non-regular file specified as */
388 					/*	the output file */
389 #define	FLG_OF1_ALNODIR	0x80000000	/* establish NODIRECT for all */
390 					/*	exported interfaces. */
391 
392 /*
393  * Test to see if the output file would allow the presence of
394  * a .dynsym section.
395  */
396 #define	OFL_ALLOW_DYNSYM(_ofl) (((_ofl)->ofl_flags & \
397 	(FLG_OF_DYNAMIC | FLG_OF_RELOBJ)) == FLG_OF_DYNAMIC)
398 
399 /*
400  * Test to see if the output file would allow the presence of
401  * a .SUNW_ldynsym section. The requirements are that a .dynsym
402  * is allowed, and -znoldynsym has not been specified. Note that
403  * even if the answer is True (1), we will only generate one if there
404  * are local symbols that require it.
405  */
406 #define	OFL_ALLOW_LDYNSYM(_ofl) (((_ofl)->ofl_flags & \
407 	(FLG_OF_DYNAMIC | FLG_OF_RELOBJ | FLG_OF_NOLDYNSYM)) == FLG_OF_DYNAMIC)
408 
409 /*
410  * Test to see if relocation processing should be done. This is normally
411  * true, but can be disabled via the '-z noreloc' option. Note that
412  * relocatable objects are still relocated even if '-z noreloc' is present.
413  */
414 #define	OFL_DO_RELOC(_ofl) (((_ofl)->ofl_flags & FLG_OF_RELOBJ) || \
415 	!((_ofl)->ofl_dtflags_1 & DF_1_NORELOC))
416 
417 /*
418  * Relocation (active & output) processing structure - transparent to common
419  * code.
420  *
421  * Note that rel_raddend is primarily only of interest to RELA relocations,
422  * and is set to 0 for REL. However, there is an exception: If FLG_REL_NADDEND
423  * is set, then rel_raddend contains a replacement value for the implicit
424  * addend found in the relocation target.
425  */
426 struct rel_desc {
427 	Os_desc		*rel_osdesc;	/* output section reloc is against */
428 	Is_desc		*rel_isdesc;	/* input section reloc is against */
429 	const char	*rel_sname;	/* symbol name (may be "unknown") */
430 	Sym_desc	*rel_sym;	/* sym relocation is against */
431 	Sym_desc	*rel_usym;	/* strong sym if this is a weak pair */
432 	Mv_desc		*rel_move;	/* move table information */
433 	Word		rel_flags;	/* misc. flags for relocations */
434 	Word		rel_rtype;	/* relocation type */
435 	Xword		rel_roffset;	/* relocation offset */
436 	Sxword		rel_raddend;	/* addend from input relocation */
437 	Word		rel_typedata;	/* ELF_R_TYPE_DATA(info) */
438 };
439 
440 /*
441  * common flags used on the Rel_desc structure (defined in machrel.h).
442  */
443 #define	FLG_REL_GOT	0x00000001	/* relocation against GOT */
444 #define	FLG_REL_PLT	0x00000002	/* relocation against PLT */
445 #define	FLG_REL_BSS	0x00000004	/* relocation against BSS */
446 #define	FLG_REL_LOAD	0x00000008	/* section loadable */
447 #define	FLG_REL_SCNNDX	0x00000010	/* use section index for symbol ndx */
448 #define	FLG_REL_CLVAL	0x00000020	/* clear VALUE for active relocation */
449 #define	FLG_REL_ADVAL	0x00000040	/* add VALUE for output relocation, */
450 					/*	only relevant to SPARC and */
451 					/*	R_SPARC_RELATIVE */
452 #define	FLG_REL_GOTCL	0x00000080	/* clear the GOT entry.  This is */
453 					/* relevant to RELA relocations, */
454 					/* not REL (i386) relocations */
455 #define	FLG_REL_MOVETAB	0x00000100	/* Relocation against .SUNW_move */
456 					/*	adjustments required before */
457 					/*	actual relocation */
458 #define	FLG_REL_NOINFO	0x00000200	/* Relocation comes from a section */
459 					/*	with a null sh_info field */
460 #define	FLG_REL_REG	0x00000400	/* Relocation target is reg sym */
461 #define	FLG_REL_FPTR	0x00000800	/* relocation against func. desc. */
462 #define	FLG_REL_RFPTR1	0x00001000	/* Relative relocation against */
463 					/*   1st part of FD */
464 #define	FLG_REL_RFPTR2	0x00002000	/* Relative relocation against */
465 					/*   2nd part of FD */
466 #define	FLG_REL_DISP	0x00004000	/* *disp* relocation */
467 #define	FLG_REL_STLS	0x00008000	/* IE TLS reference to */
468 					/*	static TLS GOT index */
469 #define	FLG_REL_DTLS	0x00010000	/* GD TLS reference relative to */
470 					/*	dynamic TLS GOT index */
471 #define	FLG_REL_MTLS	0x00020000	/* LD TLS reference against GOT */
472 #define	FLG_REL_STTLS	0x00040000	/* LE TLS reference directly */
473 					/*	to static tls index */
474 #define	FLG_REL_TLSFIX	0x00080000	/* relocation points to TLS instr. */
475 					/*	which needs updating */
476 #define	FLG_REL_RELA	0x00100000	/* descripter captures a Rela */
477 #define	FLG_REL_GOTFIX	0x00200000	/* relocation points to GOTOP instr. */
478 					/*	which needs updating */
479 #define	FLG_REL_NADDEND	0x00400000	/* Replace implicit addend in dest */
480 					/*	with value in rel_raddend */
481 					/*	Relevant to REL (i386) */
482 					/*	relocations, not to RELA. */
483 
484 /*
485  * Structure to hold a cache of Relocations.
486  */
487 struct rel_cache {
488 	Rel_desc	*rc_end;
489 	Rel_desc	*rc_free;
490 };
491 
492 /*
493  * Symbol value descriptor.  For relocatable objects, each symbols value is
494  * its offset within its associated section.  Therefore, to uniquely define
495  * each symbol within a reloctable object, record and sort the sh_offset and
496  * symbol value.  This information is used to seach for displacement
497  * relocations as part of copy relocation validation.
498  */
499 typedef struct {
500 	Addr		ssv_value;
501 	Sym_desc	*ssv_sdp;
502 } Ssv_desc;
503 
504 /*
505  * Input file processing structures.
506  */
507 struct ifl_desc {			/* input file descriptor */
508 	const char	*ifl_name;	/* full file name */
509 	const char	*ifl_soname;	/* shared object name */
510 	dev_t		ifl_stdev;	/* device id and inode number for .so */
511 	ino_t		ifl_stino;	/*	multiple inclusion checks */
512 	Ehdr		*ifl_ehdr;	/* elf header describing this file */
513 	Elf		*ifl_elf;	/* elf descriptor for this file */
514 	Sym_desc	**ifl_oldndx;	/* original symbol table indices */
515 	Sym_desc	*ifl_locs;	/* symbol desc version of locals */
516 	Ssv_desc	*ifl_sortsyms;	/* sorted list of symbols by value */
517 	Word		ifl_locscnt;	/* no. of local symbols to process */
518 	Word		ifl_symscnt;	/* total no. of symbols to process */
519 	Word		ifl_sortcnt;	/* no. of sorted symbols to process */
520 	Word		ifl_shnum;	/* number of sections in file */
521 	Word		ifl_shstrndx;	/* index to .shstrtab */
522 	Word		ifl_vercnt;	/* number of versions in file */
523 	Is_desc		**ifl_isdesc;	/* isdesc[scn ndx] = Is_desc ptr */
524 	Sdf_desc	*ifl_sdfdesc;	/* control definition */
525 	Versym		*ifl_versym;	/* version symbol table array */
526 	Ver_index	*ifl_verndx;	/* verndx[ver ndx] = Ver_index */
527 	List		ifl_verdesc;	/* version descriptor list */
528 	List		ifl_relsect;	/* relocation section list */
529 	Alist		*ifl_groups;	/* SHT_GROUP section list */
530 	Half		ifl_neededndx;	/* index to NEEDED in .dyn section */
531 	Word		ifl_flags;	/* Explicit/implicit reference */
532 };
533 
534 #define	FLG_IF_CMDLINE	0x00000001	/* full filename specified from the */
535 					/*	command line (no -l) */
536 #define	FLG_IF_NEEDED	0x00000002	/* shared object should be recorded */
537 #define	FLG_IF_DIRECT	0x00000004	/* establish direct bindings to this */
538 					/*	object */
539 #define	FLG_IF_EXTRACT	0x00000008	/* file extracted from an archive */
540 #define	FLG_IF_VERNEED	0x00000010	/* version dependency information is */
541 					/*	required */
542 #define	FLG_IF_DEPREQD	0x00000020	/* dependency is required to satisfy */
543 					/*	symbol references */
544 #define	FLG_IF_NEEDSTR	0x00000040	/* dependency specified by -Nn */
545 					/*	flag */
546 #define	FLG_IF_IGNORE	0x00000080	/* ignore unused dependencies */
547 #define	FLG_IF_NODIRECT	0x00000100	/* object contains symbols that */
548 					/*	cannot be directly bound to. */
549 #define	FLG_IF_LAZYLD	0x00000200	/* bindings to this object should be */
550 					/*	lazy loaded */
551 #define	FLG_IF_GRPPRM	0x00000400	/* this dependency should have the */
552 					/*	DF_P1_GROUPPERM flag set */
553 #define	FLG_IF_DISPPEND 0x00000800	/* displacement relocation done */
554 					/*	in the ld time. */
555 #define	FLG_IF_DISPDONE 0x00001000	/* displacement relocation done */
556 					/* 	at the run time */
557 #define	FLG_IF_MAPFILE	0x00002000	/* file is a mapfile */
558 #define	FLG_IF_HSTRTAB	0x00004000	/* file has a string section */
559 #define	FLG_IF_FILEREF	0x00008000	/* file contains a section which */
560 					/*	is included in the output */
561 					/*	allocatable image */
562 #define	FLG_IF_GNUVER	0x00010000	/* file used GNU-style versioning */
563 #define	FLG_IF_ORDERED	0x00020000	/* ordered section processing */
564 					/*	required */
565 
566 struct is_desc {			/* input section descriptor */
567 	const char	*is_name;	/* original section name */
568 	Shdr		*is_shdr;	/* the elf section header */
569 	Ifl_desc	*is_file;	/* infile desc for this section */
570 	Os_desc		*is_osdesc;	/* new output section for this */
571 					/*	input section */
572 	Elf_Data	*is_indata;	/* input sections raw data */
573 	Is_desc		*is_symshndx;	/* related SHT_SYM_SHNDX section */
574 	Is_desc		*is_comdatkeep;	/* If COMDAT section is discarded, */
575 					/* 	this is section that was kept */
576 	Word		is_scnndx;	/* original section index in file */
577 	Word		is_txtndx;	/* Index for section.  Used to decide */
578 					/*	where to insert section when */
579 					/* 	reordering sections */
580 	Word		is_keyident;	/* key for SHF_ORDERED processing */
581 					/*	and identifier used for */
582 					/*	placing/ordering sections */
583 	Word		is_flags;	/* Various flags */
584 };
585 
586 #define	FLG_IS_ORDERED	0x0001		/* this is a SHF_ORDERED section */
587 #define	FLG_IS_KEY	0x0002		/* section requires sort keys */
588 #define	FLG_IS_DISCARD	0x0004		/* section is to be discarded */
589 #define	FLG_IS_RELUPD	0x0008		/* symbol defined here may have moved */
590 #define	FLG_IS_SECTREF	0x0010		/* section has been referenced */
591 #define	FLG_IS_GDATADEF	0x0020		/* section contains global data sym */
592 #define	FLG_IS_EXTERNAL	0x0040		/* isp from an user file */
593 #define	FLG_IS_INSTRMRG	0x0080		/* Usable SHF_MERGE|SHF_STRINGS sec */
594 #define	FLG_IS_GNSTRMRG	0x0100		/* Generated mergeable string section */
595 #define	FLG_IS_GROUPS	0x0200		/* section has groups to process */
596 #define	FLG_IS_PLACE	0x0400		/* section requires to be placed */
597 #define	FLG_IS_COMDAT	0x0800		/* section is COMDAT */
598 
599 /*
600  * Map file and output file processing structures
601  */
602 struct os_desc {			/* Output section descriptor */
603 	const char	*os_name;	/* the section name */
604 	Elf_Scn		*os_scn;	/* the elf section descriptor */
605 	Shdr		*os_shdr;	/* the elf section header */
606 	Os_desc		*os_relosdesc;	/* the output relocation section */
607 	APlist		*os_relisdescs;	/* reloc input section descriptors */
608 					/*	for this output section */
609 	List		os_isdescs;	/* list of input sections in output */
610 	APlist		*os_mstrisdescs; /* FLG_IS_INSTRMRG input sections */
611 	Sort_desc	*os_sort;	/* used for sorting sections */
612 	Sg_desc		*os_sgdesc;	/* segment os_desc is placed on */
613 	Elf_Data	*os_outdata;	/* output sections raw data */
614 	avl_tree_t	*os_comdats;	/* AVL tree of COMDAT input sections */
615 					/*	associated to output section */
616 	Word		os_scnsymndx;	/* index in output symtab of section */
617 					/*	symbol for this section */
618 	Word		os_txtndx;	/* Index for section.  Used to decide */
619 					/*	where to insert section when */
620 					/* 	reordering sections */
621 	Xword		os_szoutrels;	/* size of output relocation section */
622 	uint_t		os_namehash;	/* hash on section name */
623 	uchar_t		os_flags;	/* various flags */
624 };
625 
626 #define	FLG_OS_KEY		0x01	/* section requires sort keys */
627 #define	FLG_OS_OUTREL		0x02	/* output rel against this section */
628 #define	FLG_OS_SECTREF		0x04	/* isps are not affected by -zignore */
629 
630 /*
631  * For sorting sections.
632  */
633 struct sort_desc {
634 	Is_desc		**st_order;
635 	Word		st_ordercnt;
636 	Is_desc		**st_before;
637 	Word		st_beforecnt;
638 	Is_desc		**st_after;
639 	Word		st_aftercnt;
640 };
641 
642 struct sg_desc {			/* output segment descriptor */
643 	Phdr		sg_phdr;	/* segment header for output file */
644 	const char	*sg_name;	/* segment name */
645 	Xword		sg_round;	/* data rounding required (mapfile) */
646 	Xword		sg_length;	/* maximum segment length; if 0 */
647 					/*	segment is not specified */
648 	APlist		*sg_osdescs;	/* list of output section descriptors */
649 	APlist		*sg_secorder;	/* list specifying section ordering */
650 					/*	for the segment */
651 	Half		sg_flags;
652 	Sym_desc	*sg_sizesym;	/* size symbol for this segment */
653 	Xword		sg_addralign;	/* LCM of sh_addralign */
654 	Elf_Scn		*sg_fscn;	/* the SCN of the first section. */
655 };
656 
657 #define	FLG_SG_VADDR	0x0001		/* vaddr segment attribute set */
658 #define	FLG_SG_PADDR	0x0002		/* paddr segment attribute set */
659 #define	FLG_SG_LENGTH	0x0004		/* length segment attribute set */
660 #define	FLG_SG_ALIGN	0x0008		/* align segment attribute set */
661 #define	FLG_SG_ROUND	0x0010		/* round segment attribute set */
662 #define	FLG_SG_FLAGS	0x0020		/* flags segment attribute set */
663 #define	FLG_SG_TYPE	0x0040		/* type segment attribute set */
664 #define	FLG_SG_ORDER	0x0080		/* has ordering been turned on for */
665 					/* 	this segment. */
666 					/*	i.e. ?[O] option in mapfile */
667 #define	FLG_SG_NOHDR	0x0100		/* don't map ELF or phdrs into */
668 					/* 	this segment */
669 #define	FLG_SG_EMPTY	0x0200		/* an empty segment specification */
670 					/*	no input sections will be */
671 					/*	associated to this section */
672 #define	FLG_SG_KEY	0x0400		/* segment requires sort keys */
673 #define	FLG_SG_DISABLED	0x0800		/* this segment is disabled */
674 #define	FLG_SG_PHREQ	0x1000		/* this segment requires a program */
675 					/* header */
676 
677 struct sec_order {
678 	const char	*sco_secname;	/* section name to be ordered */
679 	Word		sco_index;	/* ordering index for section */
680 	Half		sco_flags;
681 };
682 
683 #define	FLG_SGO_USED	0x0001		/* was ordering used? */
684 
685 struct ent_desc {			/* input section entrance criteria */
686 	List		ec_files;	/* files from which to accept */
687 					/*	sections */
688 	const char	*ec_name;	/* name to match (NULL if none) */
689 	Word		ec_type;	/* section type */
690 	Word		ec_attrmask;	/* section attribute mask (AWX) */
691 	Word		ec_attrbits;	/* sections attribute bits */
692 	Sg_desc		*ec_segment;	/* output segment to enter if matched */
693 	Word		ec_ndx;		/* index to determine where section */
694 					/*	meeting this criteria should */
695 					/*	inserted. Used for reordering */
696 					/*	of sections. */
697 	Half		ec_flags;
698 };
699 
700 #define	FLG_EC_USED	0x0001		/* entrance criteria met? */
701 
702 /*
703  *  Move supplementary structures
704  *	Sorted by symbol local/global and then by name.
705  */
706 typedef struct psym_info {
707 	Sym_desc	*psym_symd;	/* partially initialized symbol */
708 	Word 		psym_num;	/* number of move entires */
709 	Half 		psym_flag;	/* various flag */
710 	List 		psym_mvs;	/* the list of move entries */
711 } Psym_info;
712 
713 #define	FLG_PSYM_OVERLAP	0x01	/* Overlapping */
714 
715 /*
716  * One structure is allocated for a move entry.
717  */
718 typedef struct mv_itm {
719 	Xword		mv_start;	/* start position */
720 	Xword		mv_length;	/* The length of initialization */
721 	Half		mv_flag;	/* various flags */
722 	Is_desc		*mv_isp;	/* input desc. this entry is from */
723 	Move		*mv_ientry;	/* Input Move_entry */
724 	Word 		mv_oidx;	/* Output Move_entry index */
725 } Mv_itm;
726 
727 #define	FLG_MV_OUTSECT	0x01	/* Will be in move section */
728 
729 /*
730  * Define a move descripter used within relocation structures.
731  */
732 struct mv_desc {
733 	Move		*mvd_move;
734 	Sym_desc	*mvd_sym;
735 };
736 
737 struct sym_desc {
738 	List		sd_GOTndxs;	/* list of associated GOT entries */
739 	Sym		*sd_sym;	/* pointer to symbol table entry */
740 	Sym		*sd_osym;	/* copy of the original symbol entry */
741 					/*	used only for local partial */
742 	Psym_info	*sd_psyminfo;	/* for partial symbols, maintain a */
743 					/*	pointer to parsym_info */
744 	const char	*sd_name;	/* symbols name */
745 	Ifl_desc	*sd_file;	/* file where symbol is taken */
746 	Is_desc		*sd_isc;	/* input section of symbol definition */
747 	Sym_aux		*sd_aux;	/* auxiliary global symbol info. */
748 	Word		sd_symndx;	/* index in output symbol table */
749 	Word		sd_shndx;	/* sect. index sym is associated w/ */
750 	Word		sd_flags;	/* state flags */
751 	Half		sd_flags1;	/* more symbol flags */
752 	Half		sd_ref;		/* reference definition of symbol */
753 };
754 
755 /*
756  * The auxiliary symbol descriptor contains the additional information (beyond
757  * the symbol descriptor) required to process global symbols.  These symbols are
758  * accessed via an internal symbol hash table where locality of reference is
759  * important for performance.
760  */
761 struct sym_aux {
762 	List 		sa_dfiles;	/* files where symbol is defined */
763 	Sym		sa_sym;		/* copy of symtab entry */
764 	const char	*sa_vfile;	/* first unavailable definition */
765 	Ifl_desc	*sa_bindto;	/* symbol to bind to - for translator */
766 	const char	*sa_rfile;	/* file with first symbol referenced */
767 	Word		sa_hash;	/* the pure hash value of symbol */
768 	Word		sa_PLTndx;	/* index into PLT for symbol */
769 	Word		sa_PLTGOTndx;	/* GOT entry indx for PLT indirection */
770 	Word		sa_linkndx;	/* index of associated symbol from */
771 					/*	ET_DYN file */
772 	Half		sa_symspec;	/* special symbol ids */
773 	Half		sa_overndx;	/* output file versioning index */
774 	Half		sa_dverndx;	/* dependency versioning index */
775 };
776 
777 /*
778  * Nodes used to track symbols in the global AVL symbol dictionary.
779  */
780 struct sym_avlnode {
781 	avl_node_t	sav_node;	/* AVL node */
782 	Word		sav_hash;	/* symbol hash value */
783 	const char	*sav_name;	/* symbol name */
784 	Sym_desc	*sav_symdesc;	/* SymDesc entry */
785 };
786 
787 /*
788  * These are the ids for processing of `Special symbols'.  They are used
789  * to set the sym->sd_aux->sa_symspec field.
790  */
791 #define	SDAUX_ID_ETEXT	1		/* etext && _etext symbol */
792 #define	SDAUX_ID_EDATA	2		/* edata && _edata symbol */
793 #define	SDAUX_ID_END	3		/* end, _end, && _END_ symbol */
794 #define	SDAUX_ID_DYN	4		/* DYNAMIC && _DYNAMIC symbol */
795 #define	SDAUX_ID_PLT	5		/* _PROCEDURE_LINKAGE_TABLE_ symbol */
796 #define	SDAUX_ID_GOT	6		/* _GLOBAL_OFFSET_TABLE_ symbol */
797 #define	SDAUX_ID_START	7		/* START_ && _START_ symbol */
798 
799 /*
800  * Flags for sym_desc.sd_flags
801  */
802 #define	FLG_SY_MVTOCOMM	0x00000001	/* assign symbol to common (.bss) */
803 					/*	this is a result of a */
804 					/*	copy reloc against sym */
805 #define	FLG_SY_GLOBREF	0x00000002	/* a global reference has been seen */
806 #define	FLG_SY_WEAKDEF	0x00000004	/* a weak definition has been used */
807 #define	FLG_SY_CLEAN	0x00000008	/* `Sym' entry points to original */
808 					/*	input file (read-only). */
809 #define	FLG_SY_UPREQD	0x00000010	/* symbol value update is required, */
810 					/*	either it's used as an entry */
811 					/*	point or for relocation, but */
812 					/*	it must be updated even if */
813 					/*	the -s flag is in effect */
814 #define	FLG_SY_NOTAVAIL	0x00000020	/* symbol is not available to the */
815 					/*	application either because it */
816 					/*	originates from an implicitly */
817 					/* 	referenced shared object, or */
818 					/*	because it is not part of a */
819 					/*	specified version. */
820 #define	FLG_SY_REDUCED	0x00000040	/* a global is reduced to local */
821 #define	FLG_SY_VERSPROM	0x00000080	/* version definition has been */
822 					/*	promoted to output file */
823 #define	FLG_SY_PROT	0x00000100	/* stv_protected visibility seen */
824 
825 #define	FLG_SY_MAPREF	0x00000200	/* symbol reference generated by user */
826 					/*	from mapfile */
827 #define	FLG_SY_REFRSD	0x00000400	/* symbols sd_ref has been raised */
828 					/* 	due to a copy-relocs */
829 					/*	weak-strong pairing */
830 #define	FLG_SY_INTPOSE	0x00000800	/* symbol defines an interposer */
831 #define	FLG_SY_INVALID	0x00001000	/* unwanted/erroneous symbol */
832 #define	FLG_SY_SMGOT	0x00002000	/* small got index assigned to symbol */
833 					/*	sparc only */
834 #define	FLG_SY_PARENT	0x00004000	/* symbol to be found in parent */
835 					/*    only used with direct bindings */
836 #define	FLG_SY_LAZYLD	0x00008000	/* symbol to cause lazyloading of */
837 					/*	parent object */
838 #define	FLG_SY_ISDISC	0x00010000	/* symbol is a member of a DISCARDED */
839 					/*	section (COMDAT) */
840 #define	FLG_SY_PAREXPN	0x00020000	/* partially init. symbol to be */
841 					/*	expanded */
842 #define	FLG_SY_PLTPAD	0x00040000	/* pltpadding has been allocated for */
843 					/*	this symbol */
844 #define	FLG_SY_REGSYM	0x00080000	/* REGISTER symbol (sparc only) */
845 #define	FLG_SY_SOFOUND	0x00100000	/* compared against an SO definition */
846 #define	FLG_SY_EXTERN	0x00200000	/* symbol is external, allows -zdefs */
847 					/*    error suppression */
848 #define	FLG_SY_MAPUSED	0x00400000	/* mapfile symbol used (occurred */
849 					/*    within a relocatable object) */
850 #define	FLG_SY_COMMEXP	0x00800000	/* COMMON symbol which has been */
851 					/*	allocated */
852 #define	FLG_SY_CMDREF	0x01000000	/* symbol was referenced from the */
853 					/*	command line.  (ld -u <>, */
854 					/*	ld -zrtldinfo=<>, ...) */
855 #define	FLG_SY_SPECSEC	0x02000000	/* section index is reserved value */
856 					/*	ABS, COMMON, ... */
857 #define	FLG_SY_TENTSYM	0x04000000	/* tentative symbol */
858 #define	FLG_SY_VISIBLE	0x08000000	/* symbols visibility determined */
859 #define	FLG_SY_STDFLTR	0x10000000	/* symbol is a standard filter */
860 #define	FLG_SY_AUXFLTR	0x20000000	/* symbol is an auxiliary filter */
861 #define	FLG_SY_DYNSORT	0x40000000	/* req. in dyn[sym|tls]sort section */
862 #define	FLG_SY_NODYNSORT 0x80000000	/* excluded from dyn[sym_tls]sort sec */
863 
864 /*
865  * Sym_desc.sd_flags1
866  */
867 #define	FLG_SY1_DEFAULT	0x00000001	/* global symbol, default */
868 #define	FLG_SY1_SINGLE	0x00000002	/* global symbol, singleton defined */
869 #define	FLG_SY1_PROTECT	0x00000004	/* global symbol, protected defined */
870 #define	FLG_SY1_EXPORT	0x00000008	/* global symbol, exported defined */
871 
872 #define	MSK_SY1_GLOBAL \
873 	(FLG_SY1_DEFAULT | FLG_SY1_SINGLE | FLG_SY1_PROTECT | FLG_SY1_EXPORT)
874 					/* this mask indicates that the */
875 					/*    symbol has been explicitly */
876 					/*    defined within a mapfile */
877 					/*    definition, and is a candidate */
878 					/*    for versioning */
879 
880 #define	FLG_SY1_HIDDEN	0x00000010	/* global symbol, reduce to local */
881 #define	FLG_SY1_ELIM	0x00000020	/* global symbol, eliminate */
882 #define	FLG_SY1_IGNORE	0x00000040	/* global symbol, ignored */
883 
884 #define	MSK_SY1_LOCAL	(FLG_SY1_HIDDEN | FLG_SY1_ELIM | FLG_SY1_IGNORE)
885 					/* this mask allows all local state */
886 					/*    flags to be removed when the */
887 					/*    symbol is copy relocated */
888 
889 #define	FLG_SY1_EXPDEF	0x00000100	/* symbol visibility defined */
890 					/*    explicitly */
891 
892 #define	MSK_SY1_NOAUTO	(FLG_SY1_SINGLE | FLG_SY1_EXPORT | FLG_SY1_EXPDEF)
893 					/* this mask indicates that the */
894 					/*    symbol is not a  candidate for */
895 					/*    auto-reduction/elimination */
896 
897 #define	FLG_SY1_MAPFILE 0x00000200	/* symbol attribute defined in a */
898 					/*    mapfile */
899 #define	FLG_SY1_DIR	0x00000400	/* global symbol, direct bindings */
900 #define	FLG_SY1_NDIR	0x00000800	/* global symbol, nondirect bindings */
901 
902 /*
903  * Create a mask for (sym.st_other & visibility) since the gABI does not yet
904  * define a ELF*_ST_OTHER macro.
905  */
906 #define	MSK_SYM_VISIBILITY	0x7
907 
908 /*
909  * Structure to manage the shared object definition lists.  There are two lists
910  * that use this structure:
911  *
912  *  o	ofl_soneed; maintain the list of implicitly required dependencies
913  *	(ie. shared objects needed by other shared objects).  These definitions
914  *	may include RPATH's required to locate the dependencies, and any
915  *	version requirements.
916  *
917  *  o	ofl_socntl; maintains the shared object control definitions.  These are
918  *	provided by the user (via a mapfile) and are used to indicate any
919  *	SONAME translations and verion control requirements.
920  */
921 struct	sdf_desc {
922 	const char	*sdf_name;	/* the shared objects file name */
923 	const char	*sdf_soname;	/* the shared objects SONAME */
924 	char		*sdf_rpath;	/* library search path DT_RPATH */
925 	const char	*sdf_rfile;	/* referencing file for diagnostics */
926 	Ifl_desc	*sdf_file;	/* the final input file descriptor */
927 	List		sdf_vers;	/* list of versions that are required */
928 					/*	from this object */
929 	List		sdf_verneed;	/* list of VERNEEDS to create for */
930 					/*	this object (via SPECVERS or */
931 					/*	ADDVERS) */
932 	Word		sdf_flags;
933 };
934 
935 #define	FLG_SDF_SONAME	0x02		/* An alternative SONAME is supplied */
936 #define	FLG_SDF_SELECT	0x04		/* version control selection required */
937 #define	FLG_SDF_VERIFY	0x08		/* version definition verification */
938 					/*	required */
939 #define	FLG_SDF_SPECVER	0x10		/* specify VERNEEDS */
940 #define	FLG_SDF_ADDVER	0x20		/* add VERNEED references */
941 
942 /*
943  * Structure to manage shared object version usage requirements.
944  */
945 struct	sdv_desc {
946 	const char	*sdv_name;	/* version name */
947 	const char	*sdv_ref;	/* versions reference */
948 	Word		sdv_flags;	/* flags */
949 };
950 
951 #define	FLG_SDV_MATCHED	0x01		/* VERDEF found and matched */
952 
953 /*
954  * Structures to manage versioning information.  Two versioning structures are
955  * defined:
956  *
957  *   o	a version descriptor maintains a linked list of versions and their
958  *	associated dependencies.  This is used to build the version definitions
959  *	for an image being created (see map_symbol), and to determine the
960  *	version dependency graph for any input files that are versioned.
961  *
962  *   o	a version index array contains each version of an input file that is
963  *	being processed.  It informs us which versions are available for
964  *	binding, and is used to generate any version dependency information.
965  */
966 struct	ver_desc {
967 	const char	*vd_name;	/* version name */
968 	Word		vd_hash;	/* hash value of name */
969 	Ifl_desc	*vd_file;	/* file that defined version */
970 	Half		vd_ndx;		/* coordinates with symbol index */
971 	Half		vd_flags;	/* version information */
972 	List		vd_deps;	/* version dependencies */
973 	Ver_desc	*vd_ref;	/* dependency's first reference */
974 };
975 
976 struct	ver_index {
977 	const char	*vi_name;	/* dependency version name */
978 	Half		vi_flags;	/* communicates availability */
979 	Half		vi_overndx;	/* Index asssigned to this version in */
980 					/*	output object Verneed section */
981 	Ver_desc	*vi_desc;	/* cross reference to descriptor */
982 };
983 
984 /*
985  * Define any internal version descriptor flags ([vd|vi]_flags).  Note that the
986  * first byte is reserved for user visible flags (refer VER_FLG's in link.h).
987  */
988 #define	MSK_VER_USER	0x0f		/* mask for user visible flags */
989 
990 #define	FLG_VER_AVAIL	0x10		/* version is available for binding */
991 #define	FLG_VER_REFER	0x20		/* version has been referenced */
992 #define	FLG_VER_SPECVER	0x40		/* via $SPECVERS in mapfile. */
993 					/* 	Cannot be normalized away */
994 #define	FLG_VER_CYCLIC	0x80		/* a member of cyclic dependency */
995 
996 /*
997  * isalist(1) descriptor - used to break an isalist string into its component
998  * options.
999  */
1000 struct	isa_opt {
1001 	char		*isa_name;	/* individual isa option name */
1002 	size_t		isa_namesz;	/*	and associated size */
1003 };
1004 
1005 struct	isa_desc {
1006 	char		*isa_list;	/* sysinfo(SI_ISALIST) list */
1007 	size_t		isa_listsz;	/*	and associated size */
1008 	Isa_opt		*isa_opt;	/* table of individual isa options */
1009 	size_t		isa_optno;	/*	and associated number */
1010 };
1011 
1012 /*
1013  * uname(2) descriptor - used to break a utsname structure into its component
1014  * options (at least those that we're interested in).
1015  */
1016 struct	uts_desc {
1017 	char		*uts_osname;	/* operating system name */
1018 	size_t		uts_osnamesz;	/*	and associated size */
1019 	char		*uts_osrel;	/* operating system release */
1020 	size_t		uts_osrelsz;	/*	and associated size */
1021 };
1022 
1023 /*
1024  * SHT_GROUP descriptor - used to track group sections at the global
1025  * level to resolve conflicts and determine which to keep.
1026  */
1027 struct group_desc {
1028 	Is_desc		*gd_isc;	/* input section descriptor */
1029 	Is_desc		*gd_oisc;	/* overriding input section */
1030 					/*	descriptor when discarded */
1031 	const char	*gd_name;	/* group name (signature symbol) */
1032 	Word		*gd_data;	/* data for group section */
1033 	size_t		gd_cnt;		/* number of entries in group data */
1034 };
1035 
1036 /*
1037  * Indexes into the ld_support_funcs[] table.
1038  */
1039 typedef enum {
1040 	LDS_VERSION = 0,	/* Must be first and have value 0 */
1041 	LDS_INPUT_DONE,
1042 	LDS_START,
1043 	LDS_ATEXIT,
1044 	LDS_OPEN,
1045 	LDS_FILE,
1046 	LDS_INSEC,
1047 	LDS_SEC,
1048 	LDS_NUM
1049 } Support_ndx;
1050 
1051 /*
1052  * Structure to manage archive member caching.  Each archive has an archive
1053  * descriptor (Ar_desc) associated with it.  This contains pointers to the
1054  * archive symbol table (obtained by elf_getarsyms(3e)) and an auxiliary
1055  * structure (Ar_uax[]) that parallels this symbol table.  The member element
1056  * of this auxiliary table indicates whether the archive member associated with
1057  * the symbol offset has already been extracted (AREXTRACTED) or partially
1058  * processed (refer process_member()).
1059  */
1060 typedef struct ar_mem {
1061 	Elf		*am_elf;	/* elf descriptor for this member */
1062 	char		*am_name;	/* members name */
1063 	char		*am_path;	/* path (ie. lib(foo.o)) */
1064 	Sym		*am_syms;	/* start of global symbols */
1065 	char		*am_strs;	/* associated string table start */
1066 	Xword		am_symn;	/* no. of global symbols */
1067 } Ar_mem;
1068 
1069 typedef struct ar_aux {
1070 	Sym_desc	*au_syms;	/* internal symbol descriptor */
1071 	Ar_mem		*au_mem;	/* associated member */
1072 } Ar_aux;
1073 
1074 #define	FLG_ARMEM_PROC	(Ar_mem *)-1
1075 
1076 typedef struct ar_desc {
1077 	const char	*ad_name;	/* archive file name */
1078 	Elf		*ad_elf;	/* elf descriptor for the archive */
1079 	Elf_Arsym	*ad_start;	/* archive symbol table start */
1080 	Ar_aux		*ad_aux;	/* auxiliary symbol information */
1081 	dev_t		ad_stdev;	/* device id and inode number for */
1082 	ino_t		ad_stino;	/*	multiple inclusion checks */
1083 	ofl_flag_t	ad_flags;	/* archive specific cmd line flags */
1084 } Ar_desc;
1085 
1086 /*
1087  * Define any archive descriptor flags.  NOTE, make sure they do not clash with
1088  * any output file descriptor archive extraction flags, as these are saved in
1089  * the same entry (see MSK_OF1_ARCHIVE).
1090  */
1091 #define	FLG_ARD_EXTRACT	0x00010000	/* archive member has been extracted */
1092 
1093 /*
1094  * Function Declarations.
1095  */
1096 #if	defined(_ELF64)
1097 
1098 #define	ld_create_outfile	ld64_create_outfile
1099 #define	ld_ent_setup		ld64_ent_setup
1100 #define	ld_init_strings		ld64_init_strings
1101 #define	ld_init_target		ld64_init_target
1102 #define	ld_make_sections	ld64_make_sections
1103 #define	ld_main			ld64_main
1104 #define	ld_ofl_cleanup		ld64_ofl_cleanup
1105 #define	ld_process_mem		ld64_process_mem
1106 #define	ld_reloc_init		ld64_reloc_init
1107 #define	ld_reloc_process	ld64_reloc_process
1108 #define	ld_sym_validate		ld64_sym_validate
1109 #define	ld_update_outfile	ld64_update_outfile
1110 
1111 #else
1112 
1113 #define	ld_create_outfile	ld32_create_outfile
1114 #define	ld_ent_setup		ld32_ent_setup
1115 #define	ld_init_strings		ld32_init_strings
1116 #define	ld_init_target		ld32_init_target
1117 #define	ld_make_sections	ld32_make_sections
1118 #define	ld_main			ld32_main
1119 #define	ld_ofl_cleanup		ld32_ofl_cleanup
1120 #define	ld_process_mem		ld32_process_mem
1121 #define	ld_reloc_init		ld32_reloc_init
1122 #define	ld_reloc_process	ld32_reloc_process
1123 #define	ld_sym_validate		ld32_sym_validate
1124 #define	ld_update_outfile	ld32_update_outfile
1125 
1126 #endif
1127 
1128 extern int		ld_getopt(Lm_list *, int, int, char **);
1129 
1130 extern int		ld32_main(int, char **, Half);
1131 extern int		ld64_main(int, char **, Half);
1132 
1133 extern uintptr_t	ld_create_outfile(Ofl_desc *);
1134 extern uintptr_t	ld_ent_setup(Ofl_desc *, Xword);
1135 extern uintptr_t	ld_init_strings(Ofl_desc *);
1136 extern int		ld_init_target(Lm_list *, Half mach);
1137 extern uintptr_t	ld_make_sections(Ofl_desc *);
1138 extern void		ld_ofl_cleanup(Ofl_desc *);
1139 extern Ifl_desc		*ld_process_mem(const char *, const char *, char *,
1140 			    size_t, Ofl_desc *, Rej_desc *);
1141 extern uintptr_t	ld_reloc_init(Ofl_desc *);
1142 extern uintptr_t	ld_reloc_process(Ofl_desc *);
1143 extern uintptr_t	ld_sym_validate(Ofl_desc *);
1144 extern uintptr_t	ld_update_outfile(Ofl_desc *);
1145 
1146 #ifdef	__cplusplus
1147 }
1148 #endif
1149 
1150 #endif	/* _LIBLD_H */
1151