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