_libld.h revision 11827:d7ef53deac3f
1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22/*
23 *	Copyright (c) 1988 AT&T
24 *	  All Rights Reserved
25 *
26 * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
27 * Use is subject to license terms.
28 */
29
30/*
31 * Local include file for ld library.
32 */
33
34#ifndef	_LIBLD_DOT_H
35#define	_LIBLD_DOT_H
36
37#include <libld.h>
38#include <_libelf.h>
39#include <debug.h>
40#include <conv.h>
41#include <msg.h>
42#include <reloc_defs.h>
43
44#ifdef	__cplusplus
45extern "C" {
46#endif
47
48/*
49 * In order to allow for cross linking, we need to be able to build
50 * libld with support for multiple targets within a single object.
51 * This is done using a global variable (ld_targ) of type Target to
52 * access target-specific code for the current target via indirection.
53 */
54
55/*
56 * Machine information for target
57 */
58typedef struct {
59	Half		m_mach;		/* ELF machine code for target */
60	Half		m_machplus;	/* Alt ELF machine code for target */
61					/*	Used for EM_SPARC32PLUS */
62	Word		m_flagsplus;	/* ELF header flags used to identify */
63					/*	a machplus object */
64	uchar_t		m_class;	/* Target ELFCLASS */
65	uchar_t		m_data;		/* Target byte order */
66
67	Xword		m_segm_align;	/* segment alignment */
68	Xword		m_segm_origin;	/* Default 1st segment origin */
69	Xword		m_segm_aorigin;	/* Alternative 1st segment origin */
70	Word		m_dataseg_perm;	/* data segment permission mask */
71	Word		m_stack_perm;	/* ABI default stack permission mask */
72	Word		m_word_align;	/* alignment to use for Word sections */
73	const char	*m_def_interp;	/* Def. interpreter for dyn objects */
74
75	/* Relocation type codes */
76	Word		m_r_arrayaddr;
77	Word		m_r_copy;
78	Word		m_r_glob_dat;
79	Word		m_r_jmp_slot;
80	Word		m_r_num;
81	Word		m_r_none;
82	Word		m_r_relative;
83	Word		m_r_register;
84
85	/* Relocation related constants */
86	Word		m_rel_dt_count;	/* Either DT_REL or DT_RELA */
87	Word		m_rel_dt_ent;	/* Either DT_RELENT or DT_RELAENT */
88	Word		m_rel_dt_size;	/* Either DT_RELSZ or DT_RELASZ */
89	Word		m_rel_dt_type;	/* Either DT_RELCOUNT or DT_RELACOUNT */
90	Word		m_rel_sht_type;	/* Either SHT_REL or SHT_RELA */
91
92	/* GOT related constants */
93	Word		m_got_entsize;
94	Word		m_got_xnumber;	/* reserved # of got ents */
95
96	/* PLT related constants */
97	Word		m_plt_align;
98	Word		m_plt_entsize;
99	Word		m_plt_reservsz;
100	Word		m_plt_shf_flags;
101
102	/* Section type of .eh_frame/.eh_frame_hdr sections */
103	Word		m_sht_unwind;
104
105	Word		m_dt_register;
106} Target_mach;
107
108
109/*
110 * Section identifiers, used to order sections in output object
111 */
112typedef struct {
113	Word		id_array;
114	Word		id_bss;
115	Word		id_cap;
116	Word		id_capinfo;
117	Word		id_capchain;
118	Word		id_data;
119	Word		id_dynamic;
120	Word		id_dynsort;
121	Word		id_dynstr;
122	Word		id_dynsym;
123	Word		id_dynsym_ndx;
124	Word		id_got;
125	Word		id_gotdata;
126	Word		id_hash;
127	Word		id_interp;
128	Word		id_lbss;
129	Word		id_ldynsym;
130	Word		id_note;
131	Word		id_null;
132	Word		id_plt;
133	Word		id_rel;
134	Word		id_strtab;
135	Word		id_syminfo;
136	Word		id_symtab;
137	Word		id_symtab_ndx;
138	Word		id_text;
139	Word		id_tls;
140	Word		id_tlsbss;
141	Word		id_unknown;
142	Word		id_unwind;
143	Word		id_unwindhdr;
144	Word		id_user;
145	Word		id_version;
146} Target_machid;
147
148/*
149 * Target_nullfunc supplies machine code for generating a
150 *
151 *	void (*)(void)
152 *
153 * unnamed function. Such a function can be called, and returns
154 * immediately without doing any work. This is used to back FUNC
155 * symbol definitions added with a mapfile.
156 *
157 * The machine instructions are specified as an array of bytes rather
158 * than a larger integer type in order to avoid byte order issues that
159 * can otherwise occur in cross linking.
160 */
161typedef struct {
162	const uchar_t	*nf_template;	/* Array of machine inst. bytes */
163	size_t		nf_size;	/* # bytes in nf_template */
164} Target_nullfunc;
165
166/*
167 * Target_fill supplies machine code for fill bytes in executable output
168 * sections. Normally, libelf fills the gaps caused by alignment and size
169 * requirements of the constituent input sections with 0. Depending on the
170 * target architecture, it may be desirable to instead fill with executable
171 * NOP instructions. There are two reasons to do this:
172 *
173 *  -	So that .init/.fini sections will not contain unexecutable gaps
174 *	that cause the executing program to trap and die.
175 *
176 *  -	To eliminate confusing garbage instructions between sections containing
177 *	executable code when viewed with a disassembler.
178 *
179 * The ff_execfill function is allowed to be NULL if the underlying target
180 * does not require a special fill for executable sections.
181 */
182typedef struct {
183	_elf_execfill_func_t	*ff_execfill;
184} Target_fillfunc;
185
186/*
187 * Target_machrel holds pointers to the reloc_table and machrel functions
188 * for a given target machine.
189 *
190 * The following function pointers are allowed to be NULL, if the
191 * underlying target does not require the specified operation. All
192 * other functions must be supplied:
193 *
194 *	mr_assign_got
195 *	mr_reloc_register
196 *	mr_reloc_GOTOP
197 *	mr_allocate_got
198 */
199typedef struct {
200	const Rel_entry	*mr_reloc_table;
201
202	Word		(* mr_init_rel)(Rel_desc *, void *);
203	void 		(* mr_mach_eflags)(Ehdr *, Ofl_desc *);
204	void		(* mr_mach_make_dynamic)(Ofl_desc *, size_t *);
205	void		(* mr_mach_update_odynamic)(Ofl_desc *, Dyn **);
206	Xword		(* mr_calc_plt_addr)(Sym_desc *, Ofl_desc *);
207	uintptr_t	(* mr_perform_outreloc)(Rel_desc *, Ofl_desc *);
208	uintptr_t	(* mr_do_activerelocs)(Ofl_desc *);
209	uintptr_t	(* mr_add_outrel)(Word, Rel_desc *, Ofl_desc *);
210	uintptr_t	(* mr_reloc_register)(Rel_desc *, Is_desc *,
211			    Ofl_desc *);
212	uintptr_t	(* mr_reloc_local)(Rel_desc *, Ofl_desc *);
213	uintptr_t	(* mr_reloc_GOTOP)(Boolean, Rel_desc *, Ofl_desc *);
214	uintptr_t	(* mr_reloc_TLS)(Boolean, Rel_desc *, Ofl_desc *);
215	uintptr_t	(* mr_assign_got)(Ofl_desc *, Sym_desc *);
216
217	Gotndx		*(* mr_find_got_ndx)(Alist *, Gotref, Ofl_desc *,
218			    Rel_desc *);
219	Xword		(* mr_calc_got_offset)(Rel_desc *, Ofl_desc *);
220	uintptr_t	(* mr_assign_got_ndx)(Alist **, Gotndx *, Gotref,
221			    Ofl_desc *, Rel_desc *, Sym_desc *);
222	void		(* mr_assign_plt_ndx)(Sym_desc *, Ofl_desc *);
223	uintptr_t	(* mr_allocate_got)(Ofl_desc *);
224	uintptr_t	(* mr_fillin_gotplt)(Ofl_desc *);
225} Target_machrel;
226
227
228/*
229 * Target_machsym holds pointers to the machsym functions
230 * for a given target machine.
231 *
232 * These fields are allowed to be NULL for targets that do not require
233 * special handling of register symbols. Register symbols are used by
234 * sparc targets. If any of these fields are non-NULL, all of them are
235 * required to be present (use empty stub routines if necessary).
236 */
237typedef struct {
238	int		(* ms_reg_check)(Sym_desc *, Sym *, const char *,
239			    Ifl_desc *, Ofl_desc *);
240	int		(* ms_mach_sym_typecheck)(Sym_desc *, Sym *,
241			    Ifl_desc *, Ofl_desc *);
242	const char	*(* ms_is_regsym)(Ofl_desc *, Ifl_desc *, Sym *,
243			    const char *, int, Word, const char *, sd_flag_t *);
244	Sym_desc	*(* ms_reg_find)(Sym * sym, Ofl_desc * ofl);
245	int		(* ms_reg_enter)(Sym_desc *, Ofl_desc *);
246} Target_machsym;
247
248typedef struct {
249	Target_mach	t_m;
250	Target_machid	t_id;
251	Target_nullfunc	t_nf;
252	Target_fillfunc	t_ff;
253	Target_machrel	t_mr;
254	Target_machsym	t_ms;
255} Target;
256
257/*
258 * Structure to manage the update of weak symbols from their associated alias.
259 */
260typedef	struct wk_desc {
261	Sym		*wk_symtab;	/* the .symtab entry */
262	Sym		*wk_dynsym;	/* the .dynsym entry */
263	Sym_desc	*wk_weak;	/* the original weak symbol */
264	Sym_desc	*wk_alias;	/* the real symbol */
265} Wk_desc;
266
267/*
268 * Structure to manage the support library interfaces.
269 */
270typedef struct func_list {
271	const char	*fl_obj;	/* name of support object */
272					/*	function is from */
273	void		(*fl_fptr)();	/* function pointer */
274	uint_t		fl_version;	/* ld_version() level */
275} Func_list;
276
277typedef	struct support_list {
278	const char	*sup_name;	/* ld_support function name */
279	Alist		*sup_funcs;	/* list of support functions */
280} Support_list;
281
282/*
283 * Structure to manage a sorted output relocation list.
284 *
285 *	rl_key1		->	pointer to needed ndx
286 *	rl_key2		->	pointer to symbol relocation is against
287 *	rl_key3		->	virtual offset of relocation
288 */
289typedef struct reloc_list {
290	Sym_desc	*rl_key2;
291	Xword		rl_key3;
292	Rel_desc	*rl_rsp;
293	Half		rl_key1;
294} Reloc_list;
295
296
297typedef struct sym_s_list {
298	Word		sl_hval;
299	Sym_desc	*sl_sdp;
300} Sym_s_list;
301
302/*
303 * ld heap management structure
304 */
305typedef struct _ld_heap Ld_heap;
306struct _ld_heap {
307	Ld_heap		*lh_next;
308	void		*lh_free;
309	void		*lh_end;
310};
311
312#define	HEAPBLOCK	0x800000	/* default allocation block size */
313#define	HEAPALIGN	0x8		/* heap blocks alignment requirement */
314
315/*
316 * Dynamic per-symbol filtee string table descriptor.  This associates filtee
317 * strings that will be created in the .dynstr, with .dynamic entries.
318 */
319typedef struct {
320	const char	*dft_str;	/* dynstr string */
321	Word		dft_flag;	/* auxiliary/filtee type */
322	Half		dft_ndx;	/* eventual ndx into .dynamic */
323} Dfltr_desc;
324
325/*
326 * Per-symbol filtee descriptor.  This associates symbol definitions with
327 * their filtees.
328 */
329typedef struct {
330	Sym_desc	*sft_sdp;	/* symbol descriptor */
331	Aliste		sft_idx;	/* index into dtstr descriptor */
332} Sfltr_desc;
333
334/*
335 * Capabilities descriptor, and capabilities group descriptor, used to track
336 * the symbol capabilities of any input files and the output file.
337 *
338 * A relocatable object input file may contain one or more symbol capabilities
339 * groups.  The Cap_desc structures keep track of all unique groups that are
340 * collected for the output file.  Relocatable objects that contain an object
341 * capabilities group, and the -z symbolcap option is in effect, have their
342 * object group translated to a symbol capabilities group.
343 *
344 * Individual capabilities groups are maintained with the Cap_group descriptor.
345 * A group can consist of one or more capabilities definitions.  One or more
346 * symbols can be associated with each group.
347 *
348 * For the output file, capabilities families are used to track the symbols of
349 * a given family, each symbol being associated with a different group.  This
350 * collection of data is used to create the final Capinfo structure, and for
351 * dynamic objects, the Capchain structure.
352 *
353 * For example, an object may contain two capabilities groups:
354 *
355 *	CA_SUNW_MACH - sun4u		CA_SUNW_MACH - sun4v
356 *
357 * Two symbols can be associated with each group:
358 *
359 *	foo%sun4u			foo%sun4v
360 *	bar%sun4u			bar%sun4v
361 *
362 * Two families are maintained, and include the generic, or lead, instance of
363 * the capabilities members:
364 *
365 *	foo,  foo%sun4u,  foo%sun4v
366 *	bar,  bar%sun4u,  bar%sun4v
367 */
368struct cap_desc {
369	APlist		*ca_groups;	/* capabilities groups (Cap_group) */
370	APlist		*ca_syms;	/* copies of symbols that are being */
371					/*	translated from object to */
372};					/*	symbol capabilities */
373
374typedef struct {
375	Objcapset	cg_set;		/* unpacked SHT_SUNW_cap elements */
376	APlist		*cg_secs;	/* sections, and hence files, that */
377					/*	use this descriptor */
378	Word		cg_num;		/* number of comparable elements in */
379					/*	the group */
380	Word		cg_ndx;		/* final capability group index */
381} Cap_group;
382
383/*
384 * A Capabilities family node, extends a symbol node, and provides for tracking
385 * capabilities families.  A family is defined by its lead symbol (for example,
386 * a generic, non-capabilities aware foo()), and one or more capabilities
387 * members (for example, capabilities instances foo%sun4u(), foo%sun4v(), etc.).
388 *
389 * Each member associates a symbol with its group using a Cap_sym structure.
390 */
391typedef struct {
392	Sym_avlnode	cn_symavlnode;
393	APlist		*cn_members;
394	APlist		*cn_aliases;
395} Cap_avlnode;
396
397typedef struct {
398	Sym_desc	*cs_sdp;	/* capabilities symbol descriptor */
399	Cap_group	*cs_group;	/* associated capabilities group */
400} Cap_sym;
401
402/*
403 * Define Alist initialization sizes.
404 */
405#define	AL_CNT_IFL_GROUPS	20	/* ifl_groups */
406#define	AL_CNT_IFL_RELSECS	6	/* ifl_relsect */
407
408#define	AL_CNT_CAP_DESCS	4	/* symbol capabilities descriptors */
409#define	AL_CNT_CAP_SYMS		20	/* capabilities symbols */
410#define	AL_CNT_CAP_SECS		10	/* capabilities sections */
411#define	AL_CNT_CAP_NAMES	10	/* Objcapset platform and machine */
412					/*	names */
413#define	AL_CNT_CAP_MEMS		10	/* capability family members */
414#define	AL_CNT_CAP_PAIRS	10	/* capability symbol pairs */
415#define	AL_CNT_CAP_ALIASES	2	/* capability lead symbol aliases */
416
417#define	AL_CNT_OFL_DTSFLTRS	4	/* ofl_dtsfltrs */
418#define	AL_CNT_OFL_SYMFLTRS	20	/* ofl_symfltrs */
419#define	AL_CNT_OFL_MAPSECS	10	/* ofl_map{text|data} */
420#define	AL_CNT_OFL_OBJS		50	/* ofl_objs */
421#define	AL_CNT_OFL_LIBS		10	/* ofl_sos */
422#define	AL_CNT_OFL_LIBDIRS	10	/* ofl_[ud]libdirs */
423#define	AL_CNT_OFL_MAPFILES	6	/* ofl_maps */
424#define	AL_CNT_OFL_ENTRANCE	10	/* ofl_ents */
425#define	AL_CNT_OFL_RELS		4	/* ofl_outrels */
426#define	AL_CNT_OFL_COPYRELS	10	/* ofl_copyrels */
427#define	AL_CNT_OFL_ARRAYS	10	/* ofl_{init|fini|prei}array */
428#define	AL_CNT_OFL_OSGROUPS	10	/* ofl_osgroups */
429#define	AL_CNT_OFL_OSTLSSEG	4	/* ofl_ostlsseg */
430#define	AL_CNT_OFL_ORDERED	4	/* ofl_ordered */
431#define	AL_CNT_OFL_SYMINFOSYMS	50	/* ofl_syminfsyms */
432#define	AL_CNT_OFL_MOVE		10	/* ofl_ismove */
433#define	AL_CNT_OFL_UNWIND	1	/* ofl_unwind */
434#define	AL_CNT_OFL_PARSYMS	10	/* ofl_parsyms */
435
436#define	AL_CNT_OS_MSTRISDESCS	10	/* os_mstrisdescs */
437#define	AL_CNT_OS_RELISDESCS	100	/* os_relisdescs */
438#define	AL_CNT_OS_COMDATS	20	/* os_comdats */
439#define	AL_CNT_OS_ISDESCS_BA	4	/* os_isdesc: BEFORE|AFTER */
440#define	AL_CNT_OS_ISDESCS	60	/* os_isdesc: ORDERED|DEFAULT */
441
442#define	AL_CNT_SG_IS_ORDER	40	/* sg_is_order */
443#define	AL_CNT_SG_OSDESC	40	/* sg_osdescs */
444#define	AL_CNT_SG_SECORDER	40	/* sg_secorder */
445#define	AL_CNT_SG_SIZESYM	1	/* sg_sizesym */
446
447#define	AL_CNT_SDP_GOT		1	/* sd_GOTndxs */
448#define	AL_CNT_SDP_MOVE		1	/* sd_move */
449#define	AL_CNT_SDP_DFILES	1	/* sa_dfiles */
450
451#define	AL_CNT_SDF_VERSIONS	2	/* sdf_{vers|verneed} */
452
453#define	AL_CNT_EC_FILES		1	/* ec_files */
454
455#define	AL_CNT_VERDESCS		20	/* version desc */
456#define	AL_CNT_WEAK		20	/* weak desc */
457#define	AL_CNT_SUPPORT		2	/* support libraries */
458#define	AL_CNT_STRMRGREL	500	/* ld_make_strmerge() reloc alist cnt */
459#define	AL_CNT_STRMRGSYM	20	/* ld_make_strmerge() sym alist cnt */
460#define	AL_CNT_SEGMENTS		20	/* ofl_segs */
461
462/*
463 * Return codes for {tls|got}_fixups() routines
464 */
465typedef enum {
466	FIX_ERROR,	/* fatal error - time to punt */
467	FIX_DONE,	/* relocation done - no further processing required */
468	FIX_RELOC	/* do_reloc() relocation processing required */
469} Fixupret;
470
471#ifndef	FILENAME_MAX
472#define	FILENAME_MAX	BUFSIZ		/* maximum length of a path name */
473#endif
474
475/*
476 * We pad the end of the .dynstr section with a block of DYNSTR_EXTRA_PAD
477 * bytes, and we insert DYNAMIC_EXTRA_ELTS unused items into the
478 * .dynamic section (with value DT_NULL). This provides the resources needed
479 * to add and/or alter string items in the .dynamic section, such as runpath.
480 */
481#define	DYNSTR_EXTRA_PAD	512
482#define	DYNAMIC_EXTRA_ELTS	10
483
484/*
485 * Relocation buckets are sized based on the number of input relocations and
486 * the following constants.
487 */
488#define	REL_HAIDESCNO	1000		/* high water mark active buckets */
489#define	REL_LAIDESCNO	50		/* low water mark active buckets */
490#define	REL_HOIDESCNO	500		/* high water mark output buckets */
491#define	REL_LOIDESCNO	10		/* low water mark output buckets */
492
493/*
494 * Given a symbol of a type that is allowed within a .SUNW_dynsymsort or
495 * .SUNW_dyntlssort section, examine the symbol attributes to determine
496 * if this particular symbol should be included or not.
497 *
498 * entry:
499 *	The symbol must have an allowed type: Either a type verified by
500 *	dynsymsort_symtype[] or STT_TLS.
501 *
502 *	_sdp - Pointer to symbol descriptor
503 *	_sym - Pointer to symbol referenced by _sdp.
504 *
505 *	_sym is derivable from _sdp: _sdp->sd_sym
506 *	However, most callers assign it to a local variable for efficiency,
507 *	and this macro allows such a variable to be used within. If you
508 *	don't have such a variable, supply _sdp->sd_sym.
509 *
510 * The tests used require some explanation:
511 *
512 *	(_sdp->sd_flags & FLG_SY_DYNSORT)
513 *		Some special symbols are kept even if they don't meet the
514 *		usual requirements. These symbols have the FLG_SY_DYNSORT
515 *		bit set. If this bit isn't set then we look at the other
516 *		attributes.
517 *
518 *	(((_sdp->sd_ref != REF_DYN_NEED) &&
519 *		(_sdp->sd_sym->st_shndx != SHN_UNDEF))
520 *	|| (_sdp->sd_flags & FLG_SY_MVTOCOMM))
521 *		We do not want to include symbols that are not defined within
522 *		the object we are creating. REF_DYN_NEED corresponds to those
523 *		UNDEF items. However, if the symbol is the target of a copy
524 *		relocation, then it effectively becomes defined within the
525 *		object after all. FLG_SY_MVTOCOMM indicates a copy relocation,
526 *		and prevents us from culling those exceptions.
527 *
528 *	(_sym->st_size != 0)
529 *		Symbols with 0 length are labels injected by the compilers
530 *		or the linker for purposes of code generation, and do
531 *		not directly correspond to actual code. In fact, most of the
532 *		symbols we mark with FLG_SY_DYNSORT need that flag set because
533 *		they have size 0. This size test filters out the others.
534 *
535 *	!(_sdp->sd_flags & FLG_SY_NODYNSORT)
536 *		Some symbols are not kept, even though they do meet the usual
537 *		requirements. These symbols have FLG_SY_NODYNSORT set.
538 *		For example, if there are weak and non-weak versions of a given
539 *		symbol, we only want to keep one of them. So, we set
540 *		FLG_SY_NODYNSORT on the one we don't want.
541 */
542#define	DYNSORT_TEST_ATTR(_sdp, _sym) \
543	((_sdp->sd_flags & FLG_SY_DYNSORT) || \
544	((((_sdp->sd_ref != REF_DYN_NEED) && \
545		(_sdp->sd_sym->st_shndx != SHN_UNDEF)) || \
546		(_sdp->sd_flags & FLG_SY_MVTOCOMM)) && \
547	(_sym->st_size != 0) && \
548	!(_sdp->sd_flags & FLG_SY_NODYNSORT)))
549
550/*
551 * We use output section descriptor counters to add up the number of
552 * symbol indexes to put in the .SUNW_dynsort and .SUNW_dyntlssort sections.
553 * Non-TLS symbols are counted by ofl->ofl_dynsymsortcnt, while TLS symbols are
554 * counted by ofl->ofl_dyntlssortcnt. This computation is done inline in
555 * several places. The DYNSORT_COUNT macro allows us to generate this from
556 * a single description.
557 *
558 * entry:
559 *	_sdp, _sym - As per DYNSORT_TEST_ATTR
560 *	_type - Type of symbol (STT_*)
561 *	_inc_or_dec_op - Either ++, or --. This specifies the operation
562 *		to be applied to the counter, and determines whether we
563 *		are adding, or removing, a symbol from .SUNW_dynsymsort.
564 *
565 * Note that _type is derivable from _sym: ELF_ST_TYPE(_sdp->sd_sym->st_info).
566 * Most callers already have it in a variable, so this allows us to use that
567 * variable. If you don't have such a variable, use ELF_ST_TYPE() as shown.
568 */
569#define	DYNSORT_COUNT(_sdp, _sym, _type, _inc_or_dec_op) \
570{ \
571	Word *_cnt_var; \
572	\
573	if (dynsymsort_symtype[_type]) {	/* Non-TLS counter */ \
574		_cnt_var = &ofl->ofl_dynsymsortcnt; \
575	} else if ((_type) == STT_TLS) {	/* TLS counter */ \
576		_cnt_var = &ofl->ofl_dyntlssortcnt; \
577	} else {				/* Don't count this symbol */ \
578		_cnt_var = NULL; \
579	} \
580	if ((_cnt_var != NULL) && DYNSORT_TEST_ATTR(_sdp, _sym)) \
581		(*_cnt_var)_inc_or_dec_op;	/* Increment/Decrement */ \
582}
583
584/*
585 * The OFL_SWAP_RELOC macros are used to determine whether
586 * relocation processing needs to swap the data being relocated.
587 * It is an optimization to ld_swap_reloc_data(), as it avoids
588 * the function call in the case where the linker host and the
589 * target have the same byte order.
590 */
591#define	OFL_SWAP_RELOC_DATA(_ofl, _rel) \
592	(((_ofl)->ofl_flags1 & FLG_OF1_ENCDIFF) && \
593	ld_swap_reloc_data(_ofl, _rel))
594
595/*
596 * Define an AVL node for maintaining input section descriptors. AVL trees of
597 * these descriptors are used to process group and COMDAT section.
598 *
599 * Pure COMDAT uses the input section name as the search key, while
600 * SHT_GROUP sections use the name of a special signature symbol. We
601 * support both by using the isd_name field to carry the name. An alternative
602 * design would be to use a separate type for each use, saving the cost
603 * of the unneeded pointer for pure COMDAT. We favor a single implementation
604 * because we believe that SHT_GROUP comdat will be more common going forward,
605 * particularly in the largest objects produced by C++ where SHT_GROUP is
606 * needed to manage the complex section relationships. In contrast, we think
607 * that pure COMDAT is both more rare, and used in smaller objects where the
608 * cost of an extra pointer per node is relatively unimportant.
609 */
610typedef struct {
611	avl_node_t	isd_avl;	/* avl book-keeping (see SGSOFFSETOF) */
612	Is_desc		*isd_isp;	/* input section descriptor */
613	const char	*isd_name;	/* name used as search key */
614	uint_t		isd_hash;	/* input section name hash value */
615} Isd_node;
616
617/*
618 * Type used to break down an input file path into its component parts,
619 * as used by ld_place_section() to compare an input file path to
620 * entrance criteria ec_files file strings.
621 *
622 * We define a path in the usual Unix '/' separated manner, augmented
623 * with an optional archive member suffix enclosed in parenthesis:
624 *
625 *	/dir/.../dir/basename(armember)
626 *
627 * The basename is the final path component, and includes the archive
628 * member, if present. The meaning of "object name" depends on whether or
629 * not the file comes from an archive or not. If not an archive, it is the
630 * same as the basename. If an archive, it is the name of the archive member
631 * from within the file.
632 *
633 * Variables of this type are initialized with ld_place_path_info_init().
634 */
635typedef struct {
636	const char	*ppi_path;	/* Full path */
637	const char	*ppi_bname;	/* basename(ppi_path) */
638	const char	*ppi_oname;	/* object name: Not NULL terminated */
639	Boolean		ppi_isar;	/* TRUE if path has archive member */
640	size_t		ppi_path_len;	/* strlen(ppi_path) */
641	size_t		ppi_bname_len;	/* strlen(ppi_bname) */
642	size_t		ppi_oname_len;	/* strlen(ppi_oname) */
643} Place_path_info;
644
645/*
646 * Local data items.
647 */
648extern char		*Plibpath;
649extern char		*Llibdir;
650extern char		*Ulibdir;
651extern Ld_heap		*ld_heap;
652extern APlist		*lib_support;
653extern int		demangle_flag;
654extern const Msg	reject[];
655extern int		Verbose;
656extern const int	ldynsym_symtype[];
657extern const int	dynsymsort_symtype[];
658
659/*
660 * Local functions.
661 */
662extern char		*add_string(char *, char *);
663extern const char	*demangle(const char *);
664extern int		cap_names_match(Alist *, Alist *);
665
666extern void		lds_atexit(Ofl_desc *, int);
667
668extern void		libld_free(void *);
669extern void		*libld_malloc(size_t);
670extern void		*libld_realloc(void *, size_t);
671
672extern int		isdavl_compare(const void *, const void *);
673
674extern Sdf_desc		*sdf_add(const char *, APlist **);
675extern Sdf_desc		*sdf_find(const char *, APlist *);
676
677#if	defined(_ELF64)
678
679#define	ld_add_actrel		ld64_add_actrel
680#define	ld_add_libdir		ld64_add_libdir
681#define	ld_add_rel_cache	ld64_add_rel_cache
682#define	ld_adj_movereloc	ld64_adj_movereloc
683#define	ld_am_I_partial		ld64_am_I_partial
684#define	ld_ar_member		ld64_ar_member
685#define	ld_ar_setup		ld64_ar_setup
686#define	ld_assign_got_TLS	ld64_assign_got_TLS
687#define	ld_bswap_Word		ld64_bswap_Word
688#define	ld_bswap_Xword		ld64_bswap_Xword
689#define	ld_cap_add_family	ld64_cap_add_family
690#define	ld_cap_move_symtoobj	ld64_cap_move_symtoobj
691#define	ld_disp_errmsg		ld64_disp_errmsg
692#define	ld_ent_check		ld64_ent_check
693#define	ld_ent_lookup		ld64_ent_lookup
694#define	ld_exit			ld64_exit
695#define	ld_find_library		ld64_find_library
696#define	ld_finish_libs		ld64_finish_libs
697#define	ld_get_group		ld64_get_group
698#define	ld_group_process	ld64_group_process
699#define	ld_lib_setup		ld64_lib_setup
700#define	ld_init_sighandler	ld64_init_sighandler
701#define	ld_lcm			ld64_lcm
702#define	ld_make_bss		ld64_make_bss
703#define	ld_make_data		ld64_make_data
704#define	ld_make_got		ld64_make_got
705#define	ld_make_parexpn_data	ld64_make_parexpn_data
706#define	ld_make_sunwmove	ld64_make_sunmove
707#define	ld_make_text		ld64_make_text
708#define	ld_map_out		ld64_map_out
709#define	ld_map_parse		ld64_map_parse
710#define	ld_map_post_process	ld64_map_post_process
711#define	ld_open_outfile		ld64_open_outfile
712#define	ld_os_first_isdesc	ld64_os_first_isdesc
713#define	ld_place_path_info_init	ld64_place_path_info_init
714#define	ld_place_section	ld64_place_section
715#define	ld_process_archive	ld64_process_archive
716#define	ld_process_files	ld64_process_files
717#define	ld_process_flags	ld64_process_flags
718#define	ld_process_ifl		ld64_process_ifl
719#define	ld_process_move		ld64_process_move
720#define	ld_process_open		ld64_process_open
721#define	ld_process_ordered	ld64_process_ordered
722#define	ld_process_sym_reloc	ld64_process_sym_reloc
723#define	ld_reloc_GOT_relative	ld64_reloc_GOT_relative
724#define	ld_reloc_plt		ld64_reloc_plt
725#define	ld_reloc_remain_entry	ld64_reloc_remain_entry
726#define	ld_reloc_targval_get	ld64_reloc_targval_get
727#define	ld_reloc_targval_set	ld64_reloc_targval_set
728#define	ld_sec_validate		ld64_sec_validate
729#define	ld_seg_lookup		ld64_seg_lookup
730#define	ld_sort_ordered		ld64_sort_ordered
731#define	ld_stt_section_sym_name	ld64_stt_section_sym_name
732#define	ld_sunw_ldmach		ld64_sunw_ldmach
733#define	ld_sup_atexit		ld64_sup_atexit
734#define	ld_sup_open		ld64_sup_open
735#define	ld_sup_file		ld64_sup_file
736#define	ld_sup_loadso		ld64_sup_loadso
737#define	ld_sup_input_done	ld64_sup_input_done
738#define	ld_sup_input_section	ld64_sup_input_section
739#define	ld_sup_section		ld64_sup_section
740#define	ld_sup_start		ld64_sup_start
741#define	ld_swap_reloc_data	ld64_swap_reloc_data
742#define	ld_sym_add_u		ld64_sym_add_u
743#define	ld_sym_adjust_vis	ld64_sym_adjust_vis
744#define	ld_sym_avl_comp		ld64_sym_avl_comp
745#define	ld_sym_copy		ld64_sym_copy
746#define	ld_sym_enter		ld64_sym_enter
747#define	ld_sym_find		ld64_sym_find
748#define	ld_sym_nodirect		ld64_sym_nodirect
749#define	ld_sym_process		ld64_sym_process
750#define	ld_sym_resolve		ld64_sym_resolve
751#define	ld_sym_spec		ld64_sym_spec
752#define	ld_targ			ld64_targ
753#define	ld_targ_init_sparc	ld64_targ_init_sparc
754#define	ld_targ_init_x86	ld64_targ_init_x86
755#define	ld_unwind_make_hdr	ld64_unwind_make_hdr
756#define	ld_unwind_populate_hdr	ld64_unwind_populate_hdr
757#define	ld_unwind_register	ld64_unwind_register
758#define	ld_vers_base		ld64_vers_base
759#define	ld_vers_check_defs	ld64_vers_check_defs
760#define	ld_vers_check_need	ld64_vers_check_need
761#define	ld_vers_def_process	ld64_vers_def_process
762#define	ld_vers_desc		ld64_vers_desc
763#define	ld_vers_find		ld64_vers_find
764#define	ld_vers_need_process	ld64_vers_need_process
765#define	ld_vers_promote		ld64_vers_promote
766#define	ld_vers_sym_process	ld64_vers_sym_process
767#define	ld_vers_verify		ld64_vers_verify
768#define	ld_wrap_enter		ld64_wrap_enter
769
770#else
771
772#define	ld_add_actrel		ld32_add_actrel
773#define	ld_add_libdir		ld32_add_libdir
774#define	ld_add_rel_cache	ld32_add_rel_cache
775#define	ld_adj_movereloc	ld32_adj_movereloc
776#define	ld_am_I_partial		ld32_am_I_partial
777#define	ld_ar_member		ld32_ar_member
778#define	ld_ar_setup		ld32_ar_setup
779#define	ld_assign_got_TLS	ld32_assign_got_TLS
780#define	ld_bswap_Word		ld32_bswap_Word
781#define	ld_bswap_Xword		ld32_bswap_Xword
782#define	ld_cap_add_family	ld32_cap_add_family
783#define	ld_cap_move_symtoobj	ld32_cap_move_symtoobj
784#define	ld_disp_errmsg		ld32_disp_errmsg
785#define	ld_ent_check		ld32_ent_check
786#define	ld_ent_lookup		ld32_ent_lookup
787#define	ld_exit			ld32_exit
788#define	ld_find_library		ld32_find_library
789#define	ld_finish_libs		ld32_finish_libs
790#define	ld_get_group		ld32_get_group
791#define	ld_group_process	ld32_group_process
792#define	ld_lib_setup		ld32_lib_setup
793#define	ld_init_sighandler	ld32_init_sighandler
794#define	ld_lcm			ld32_lcm
795#define	ld_make_bss		ld32_make_bss
796#define	ld_make_data		ld32_make_data
797#define	ld_make_got		ld32_make_got
798#define	ld_make_parexpn_data	ld32_make_parexpn_data
799#define	ld_make_sunwmove	ld32_make_sunmove
800#define	ld_make_text		ld32_make_text
801#define	ld_map_out		ld32_map_out
802#define	ld_map_parse		ld32_map_parse
803#define	ld_map_post_process	ld32_map_post_process
804#define	ld_open_outfile		ld32_open_outfile
805#define	ld_os_first_isdesc	ld32_os_first_isdesc
806#define	ld_place_path_info_init	ld32_place_path_info_init
807#define	ld_place_section	ld32_place_section
808#define	ld_process_archive	ld32_process_archive
809#define	ld_process_files	ld32_process_files
810#define	ld_process_flags	ld32_process_flags
811#define	ld_process_ifl		ld32_process_ifl
812#define	ld_process_move		ld32_process_move
813#define	ld_process_open		ld32_process_open
814#define	ld_process_ordered	ld32_process_ordered
815#define	ld_process_sym_reloc	ld32_process_sym_reloc
816#define	ld_reloc_GOT_relative	ld32_reloc_GOT_relative
817#define	ld_reloc_plt		ld32_reloc_plt
818#define	ld_reloc_remain_entry	ld32_reloc_remain_entry
819#define	ld_reloc_targval_get	ld32_reloc_targval_get
820#define	ld_reloc_targval_set	ld32_reloc_targval_set
821#define	ld_sec_validate		ld32_sec_validate
822#define	ld_seg_lookup		ld32_seg_lookup
823#define	ld_sort_ordered		ld32_sort_ordered
824#define	ld_stt_section_sym_name	ld32_stt_section_sym_name
825#define	ld_sunw_ldmach		ld32_sunw_ldmach
826#define	ld_sup_atexit		ld32_sup_atexit
827#define	ld_sup_open		ld32_sup_open
828#define	ld_sup_file		ld32_sup_file
829#define	ld_sup_loadso		ld32_sup_loadso
830#define	ld_sup_input_done	ld32_sup_input_done
831#define	ld_sup_input_section	ld32_sup_input_section
832#define	ld_sup_section		ld32_sup_section
833#define	ld_sup_start		ld32_sup_start
834#define	ld_swap_reloc_data	ld32_swap_reloc_data
835#define	ld_sym_add_u		ld32_sym_add_u
836#define	ld_sym_adjust_vis	ld32_sym_adjust_vis
837#define	ld_sym_avl_comp		ld32_sym_avl_comp
838#define	ld_sym_copy		ld32_sym_copy
839#define	ld_sym_enter		ld32_sym_enter
840#define	ld_sym_find		ld32_sym_find
841#define	ld_sym_nodirect		ld32_sym_nodirect
842#define	ld_sym_process		ld32_sym_process
843#define	ld_sym_resolve		ld32_sym_resolve
844#define	ld_sym_spec		ld32_sym_spec
845#define	ld_targ			ld32_targ
846#define	ld_targ_init_sparc	ld32_targ_init_sparc
847#define	ld_targ_init_x86	ld32_targ_init_x86
848#define	ld_unwind_make_hdr	ld32_unwind_make_hdr
849#define	ld_unwind_populate_hdr	ld32_unwind_populate_hdr
850#define	ld_unwind_register	ld32_unwind_register
851#define	ld_vers_base		ld32_vers_base
852#define	ld_vers_check_defs	ld32_vers_check_defs
853#define	ld_vers_check_need	ld32_vers_check_need
854#define	ld_vers_def_process	ld32_vers_def_process
855#define	ld_vers_desc		ld32_vers_desc
856#define	ld_vers_find		ld32_vers_find
857#define	ld_vers_need_process	ld32_vers_need_process
858#define	ld_vers_promote		ld32_vers_promote
859#define	ld_vers_sym_process	ld32_vers_sym_process
860#define	ld_vers_verify		ld32_vers_verify
861#define	ld_wrap_enter		ld32_wrap_enter
862
863#endif
864
865extern void		dbg_cleanup(void);
866extern int		dbg_setup(Ofl_desc *, const char *, int);
867
868extern uintptr_t	ld_add_actrel(Word, Rel_desc *, Ofl_desc *);
869extern uintptr_t	ld_add_libdir(Ofl_desc *, const char *);
870extern Rel_cache	*ld_add_rel_cache(Ofl_desc *, APlist **, size_t *,
871			    size_t, size_t);
872extern void 		ld_adj_movereloc(Ofl_desc *, Rel_desc *);
873extern Sym_desc * 	ld_am_I_partial(Rel_desc *, Xword);
874extern void		ld_ar_member(Ar_desc *, Elf_Arsym *, Ar_aux *,
875			    Ar_mem *);
876extern Ar_desc		*ld_ar_setup(const char *, Elf *, Ofl_desc *);
877extern uintptr_t	ld_assign_got_TLS(Boolean, Rel_desc *, Ofl_desc *,
878			    Sym_desc *, Gotndx *, Gotref, Word, Word,
879			    Word, Word);
880
881extern Word		ld_bswap_Word(Word);
882extern Xword		ld_bswap_Xword(Xword);
883
884extern uintptr_t	ld_cap_add_family(Ofl_desc *, Sym_desc *, Sym_desc *,
885			    Cap_group *, APlist **);
886extern void		ld_cap_move_symtoobj(Ofl_desc *);
887
888extern void		ld_disp_errmsg(const char *, Rel_desc *, Ofl_desc *);
889
890extern void		ld_ent_check(Ofl_desc *);
891extern Ent_desc		*ld_ent_lookup(Ofl_desc *, const char *name,
892			    avl_index_t *where);
893extern int		ld_exit(Ofl_desc *);
894
895extern uintptr_t	ld_find_library(const char *, Ofl_desc *);
896extern uintptr_t	ld_finish_libs(Ofl_desc *);
897
898extern const char	*ld_stt_section_sym_name(Is_desc *);
899
900extern Group_desc	*ld_get_group(Ofl_desc *, Is_desc *);
901extern uintptr_t	ld_group_process(Is_desc *, Ofl_desc *);
902
903extern uintptr_t	ld_lib_setup(Ofl_desc *);
904
905extern void		ld_init_sighandler(Ofl_desc *);
906
907extern Xword		ld_lcm(Xword, Xword);
908
909extern uintptr_t	ld_make_bss(Ofl_desc *, Xword, Xword, uint_t);
910extern Is_desc		*ld_make_data(Ofl_desc *, size_t);
911extern uintptr_t	ld_make_got(Ofl_desc *);
912extern uintptr_t	ld_make_parexpn_data(Ofl_desc *, size_t, Xword);
913extern uintptr_t	ld_make_sunwmove(Ofl_desc *, int);
914extern Is_desc		*ld_make_text(Ofl_desc *, size_t);
915extern void		ld_map_out(Ofl_desc *);
916extern Boolean		ld_map_parse(const char *, Ofl_desc *);
917extern Boolean		ld_map_post_process(Ofl_desc *);
918
919extern uintptr_t	ld_open_outfile(Ofl_desc *);
920
921extern Is_desc		*ld_os_first_isdesc(Os_desc *);
922extern Place_path_info	*ld_place_path_info_init(Ofl_desc *, Ifl_desc *,
923			    Place_path_info *);
924extern Os_desc		*ld_place_section(Ofl_desc *, Is_desc *,
925			    Place_path_info *path_info,  int, const char *);
926extern uintptr_t	ld_process_archive(const char *, int, Ar_desc *,
927			    Ofl_desc *);
928extern uintptr_t	ld_process_files(Ofl_desc *, int, char **);
929extern uintptr_t	ld_process_flags(Ofl_desc *, int, char **);
930extern Ifl_desc		*ld_process_ifl(const char *, const char *, int, Elf *,
931			    Word, Ofl_desc *, Rej_desc *);
932extern uintptr_t	ld_process_move(Ofl_desc *);
933extern Ifl_desc		*ld_process_open(const char *, const char *, int *,
934			    Ofl_desc *, Word, Rej_desc *);
935extern uintptr_t	ld_process_ordered(Ofl_desc *, Ifl_desc *,
936			    Place_path_info *path_info,  Word);
937extern uintptr_t	ld_process_sym_reloc(Ofl_desc *, Rel_desc *, Rel *,
938			    Is_desc *, const char *, Word);
939
940extern uintptr_t	ld_reloc_GOT_relative(Boolean, Rel_desc *, Ofl_desc *);
941extern uintptr_t	ld_reloc_plt(Rel_desc *, Ofl_desc *);
942extern void		ld_reloc_remain_entry(Rel_desc *, Os_desc *,
943			    Ofl_desc *);
944extern int		ld_reloc_targval_get(Ofl_desc *, Rel_desc *,
945			    uchar_t *, Xword *);
946extern int		ld_reloc_targval_set(Ofl_desc *, Rel_desc *,
947			    uchar_t *, Xword);
948
949extern Sg_desc		*ld_seg_lookup(Ofl_desc *, const char *,
950			    avl_index_t *where);
951extern void		ld_sec_validate(Ofl_desc *);
952extern uintptr_t	ld_sort_ordered(Ofl_desc *);
953extern Half		ld_sunw_ldmach();
954extern void		ld_sup_atexit(Ofl_desc *, int);
955extern void		ld_sup_open(Ofl_desc *, const char **, const char **,
956			    int *, int, Elf **, Elf *ref, size_t,
957			    const Elf_Kind);
958extern void		ld_sup_file(Ofl_desc *, const char *, const Elf_Kind,
959			    int flags, Elf *);
960extern uintptr_t	ld_sup_loadso(Ofl_desc *, const char *);
961extern void		ld_sup_input_done(Ofl_desc *);
962extern void		ld_sup_section(Ofl_desc *, const char *, Shdr *, Word,
963			    Elf_Data *, Elf *);
964extern uintptr_t	ld_sup_input_section(Ofl_desc*, Ifl_desc *,
965			    const char *, Shdr **, Word, Elf_Scn *, Elf *);
966extern void		ld_sup_start(Ofl_desc *, const Half, const char *);
967extern int		ld_swap_reloc_data(Ofl_desc *, Rel_desc *);
968extern Sym_desc		*ld_sym_add_u(const char *, Ofl_desc *, Msg);
969extern void		ld_sym_adjust_vis(Sym_desc *, Ofl_desc *);
970extern int		ld_sym_avl_comp(const void *, const void *);
971extern uintptr_t	ld_sym_copy(Sym_desc *);
972extern Sym_desc		*ld_sym_enter(const char *, Sym *, Word, Ifl_desc *,
973			    Ofl_desc *, Word, Word, sd_flag_t, avl_index_t *);
974extern Sym_desc		*ld_sym_find(const char *, Word, avl_index_t *,
975			    Ofl_desc *);
976extern uintptr_t	ld_sym_nodirect(Is_desc *, Ifl_desc *, Ofl_desc *);
977extern uintptr_t	ld_sym_process(Is_desc *, Ifl_desc *, Ofl_desc *);
978extern uintptr_t	ld_sym_resolve(Sym_desc *, Sym *, Ifl_desc *,
979			    Ofl_desc *, int, Word, sd_flag_t);
980extern uintptr_t	ld_sym_spec(Ofl_desc *);
981
982extern Target		ld_targ;
983extern const Target	*ld_targ_init_sparc(void);
984extern const Target	*ld_targ_init_x86(void);
985
986extern uintptr_t	ld_unwind_make_hdr(Ofl_desc *);
987extern uintptr_t	ld_unwind_populate_hdr(Ofl_desc *);
988extern uintptr_t	ld_unwind_register(Os_desc *, Ofl_desc *);
989
990extern Ver_desc		*ld_vers_base(Ofl_desc *);
991extern uintptr_t	ld_vers_check_defs(Ofl_desc *);
992extern uintptr_t	ld_vers_check_need(Ofl_desc *);
993extern uintptr_t	ld_vers_def_process(Is_desc *, Ifl_desc *, Ofl_desc *);
994extern Ver_desc		*ld_vers_desc(const char *, Word, APlist **);
995extern Ver_desc		*ld_vers_find(const char *, Word, APlist *);
996extern uintptr_t	ld_vers_need_process(Is_desc *, Ifl_desc *, Ofl_desc *);
997extern void		ld_vers_promote(Sym_desc *, Word, Ifl_desc *,
998			    Ofl_desc *);
999extern int		ld_vers_sym_process(Lm_list *, Is_desc *, Ifl_desc *);
1000extern int		ld_vers_verify(Ofl_desc *);
1001extern WrapSymNode	*ld_wrap_enter(Ofl_desc *, const char *);
1002
1003extern uintptr_t	add_regsym(Sym_desc *, Ofl_desc *);
1004extern Word		hashbkts(Word);
1005extern Xword		lcm(Xword, Xword);
1006
1007/*
1008 * Most platforms have both a 32 and 64-bit variant (e.g. EM_SPARC and
1009 * EM_SPARCV9). To support this, there many files in libld that are built
1010 * twice, once for ELFCLASS64 (_ELF64), and once for ELFCLASS32. In these
1011 * files, we sometimes want to supply one value for the ELFCLASS32 case
1012 * and another for ELFCLASS64. The LD_TARG_BYCLASS macro is used to do
1013 * this. It is called with both both alternatives, and yields the one
1014 * that applies to the current compilation environment.
1015 */
1016#ifdef	_ELF64
1017#define	LD_TARG_BYCLASS(_ec32, _ec64) (_ec64)
1018#else
1019#define	LD_TARG_BYCLASS(_ec32, _ec64) (_ec32)
1020#endif
1021
1022
1023#ifdef	__cplusplus
1024}
1025#endif
1026
1027#endif /* _LIBLD_DOT_H */
1028