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