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