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