xref: /titanic_50/usr/src/head/link.h (revision c9a6ea2e938727c95af7108c5e00eee4c890c7ae)
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  * Copyright (c) 1989, 2010, Oracle and/or its affiliates. All rights reserved.
23  */
24 
25 #ifndef _LINK_H
26 #define	_LINK_H
27 
28 #include <sys/link.h>
29 
30 #ifndef _ASM
31 #include <libelf.h>
32 #include <sys/types.h>
33 #include <dlfcn.h>
34 #endif
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 #ifndef _ASM
41 /*
42  * ld support library calls
43  */
44 #ifdef __STDC__
45 extern uint_t	ld_version(uint_t);
46 extern void	ld_input_done(uint_t *);
47 
48 extern void	ld_start(const char *, const Elf32_Half, const char *);
49 extern void	ld_atexit(int);
50 extern void	ld_open(const char **, const char **, int *, int, Elf **,
51 			Elf *, size_t, const Elf_Kind);
52 extern void	ld_file(const char *, const Elf_Kind, int, Elf *);
53 extern void	ld_input_section(const char *, Elf32_Shdr **, Elf32_Word,
54 			Elf_Data *, Elf *, uint_t *);
55 extern void	ld_section(const char *, Elf32_Shdr *, Elf32_Word,
56 			Elf_Data *, Elf *);
57 
58 #if defined(_LP64) || defined(_LONGLONG_TYPE)
59 extern void	ld_start64(const char *, const Elf64_Half, const char *);
60 extern void	ld_atexit64(int);
61 extern void	ld_open64(const char **, const char **, int *, int, Elf **,
62 			Elf *, size_t, const Elf_Kind);
63 extern void	ld_file64(const char *, const Elf_Kind, int, Elf *);
64 extern void	ld_input_section64(const char *, Elf64_Shdr **, Elf64_Word,
65 			Elf_Data *, Elf *, uint_t *);
66 extern void	ld_section64(const char *, Elf64_Shdr *, Elf64_Word,
67 			Elf_Data *, Elf *);
68 
69 #endif /* (defined(_LP64) || defined(_LONGLONG_TYPE) */
70 #else
71 extern void	ld_version();
72 extern void	ld_input_done();
73 
74 extern void	ld_start();
75 extern void	ld_atexit();
76 extern void	ld_open();
77 extern void	ld_file();
78 extern void	ld_input_section();
79 extern void	ld_section();
80 
81 #if defined(_LP64) || defined(_LONGLONG_TYPE)
82 extern void	ld_start64();
83 extern void	ld_atexit64();
84 extern void	ld_open64();
85 extern void	ld_file64();
86 extern void	ld_input_section64();
87 extern void	ld_section64();
88 
89 #endif /* (defined(_LP64) || defined(_LONGLONG_TYPE) */
90 #endif /* __STDC__ */
91 
92 /*
93  * ld_version() version values.
94  */
95 #define	LD_SUP_VNONE	0
96 #define	LD_SUP_VERSION1	1
97 #define	LD_SUP_VERSION2	2
98 #define	LD_SUP_VERSION3	3
99 #define	LD_SUP_VCURRENT	LD_SUP_VERSION3
100 
101 /*
102  * Flags passed to ld support calls.
103  */
104 #define	LD_SUP_DERIVED		0x1	/* derived filename */
105 #define	LD_SUP_INHERITED	0x2	/* file inherited from .so DT_NEEDED */
106 #define	LD_SUP_EXTRACTED	0x4	/* file extracted from archive */
107 #endif
108 
109 /*
110  * Runtime link-map identifiers.
111  */
112 #define	LM_ID_BASE		0x00
113 #define	LM_ID_LDSO		0x01
114 #define	LM_ID_NUM		2
115 
116 #define	LM_ID_BRAND		0xfd	/* brand emulation linkmap objs */
117 #define	LM_ID_NONE		0xfe	/* no link map specified */
118 #define	LM_ID_NEWLM		0xff	/* create a new link-map */
119 
120 /*
121  * Runtime Link-Edit Auditing.
122  */
123 #define	LAV_NONE		0
124 #define	LAV_VERSION1		1
125 #define	LAV_VERSION2		2
126 #define	LAV_VERSION3		3
127 #define	LAV_VERSION4		4
128 #define	LAV_VERSION5		5
129 #define	LAV_CURRENT		LAV_VERSION5
130 #define	LAV_NUM			6
131 
132 /*
133  * Flags that can be or'd into the la_objopen() return code
134  */
135 #define	LA_FLG_BINDTO		0x0001	/* audit symbinds TO this object */
136 #define	LA_FLG_BINDFROM		0x0002	/* audit symbinding FROM this object */
137 
138 /*
139  * Flags that can be or'd into the 'flags' argument of la_symbind()
140  */
141 #define	LA_SYMB_NOPLTENTER	0x0001	/* disable pltenter for this symbol */
142 #define	LA_SYMB_NOPLTEXIT	0x0002	/* disable pltexit for this symbol */
143 #define	LA_SYMB_STRUCTCALL	0x0004	/* this function call passes a */
144 					/*	structure as it's return code */
145 #define	LA_SYMB_DLSYM		0x0008	/* this symbol bindings is due to */
146 					/*	a call to dlsym() */
147 #define	LA_SYMB_ALTVALUE	0x0010	/* alternate symbol binding returned */
148 					/*	by la_symbind() */
149 
150 /*
151  * Flags that describe the object passed to la_objsearch()
152  */
153 #define	LA_SER_ORIG		0x001	/* original (needed) name */
154 #define	LA_SER_LIBPATH		0x002	/* LD_LIBRARY_PATH entry prepended */
155 #define	LA_SER_RUNPATH		0x004	/* runpath entry prepended */
156 #define	LA_SER_CONFIG		0x008	/* configuration entry prepended */
157 #define	LA_SER_DEFAULT		0x040	/* default path prepended */
158 #define	LA_SER_SECURE		0x080	/* default (secure) path prepended */
159 
160 #define	LA_SER_MASK		0xfff	/* mask of known flags */
161 
162 /*
163  * Flags that describe the la_activity()
164  */
165 #define	LA_ACT_CONSISTENT	0x00	/* add/deletion of objects complete */
166 #define	LA_ACT_ADD		0x01	/* objects being added */
167 #define	LA_ACT_DELETE		0x02	/* objects being deleted */
168 #define	LA_ACT_MAX		3
169 
170 
171 #ifndef	_KERNEL
172 #ifndef	_ASM
173 
174 #if defined(_LP64)
175 typedef long	lagreg_t;
176 #else
177 typedef int	lagreg_t;
178 #endif
179 
180 struct _la_sparc_regs {
181 	lagreg_t	lr_rego0;
182 	lagreg_t	lr_rego1;
183 	lagreg_t	lr_rego2;
184 	lagreg_t	lr_rego3;
185 	lagreg_t	lr_rego4;
186 	lagreg_t	lr_rego5;
187 	lagreg_t	lr_rego6;
188 	lagreg_t	lr_rego7;
189 };
190 
191 #if defined(_LP64)
192 typedef struct _la_sparc_regs	La_sparcv9_regs;
193 typedef struct {
194 	lagreg_t	lr_rsp;
195 	lagreg_t	lr_rbp;
196 	lagreg_t	lr_rdi;	    /* arg1 */
197 	lagreg_t	lr_rsi;	    /* arg2 */
198 	lagreg_t	lr_rdx;	    /* arg3 */
199 	lagreg_t	lr_rcx;	    /* arg4 */
200 	lagreg_t	lr_r8;	    /* arg5 */
201 	lagreg_t	lr_r9;	    /* arg6 */
202 } La_amd64_regs;
203 #else
204 typedef struct _la_sparc_regs	La_sparcv8_regs;
205 typedef struct {
206 	lagreg_t	lr_esp;
207 	lagreg_t	lr_ebp;
208 } La_i86_regs;
209 #endif
210 
211 #if	!defined(_SYS_INT_TYPES_H)
212 #if	defined(_LP64) || defined(_I32LPx)
213 typedef unsigned long		uintptr_t;
214 #else
215 typedef	unsigned int		uintptr_t;
216 #endif
217 #endif
218 
219 
220 #ifdef	__STDC__
221 extern uint_t		la_version(uint_t);
222 extern void		la_activity(uintptr_t *, uint_t);
223 extern void		la_preinit(uintptr_t *);
224 extern char		*la_objsearch(const char *, uintptr_t *, uint_t);
225 extern uint_t		la_objopen(Link_map *, Lmid_t, uintptr_t *);
226 extern uint_t		la_objclose(uintptr_t *);
227 extern int		la_objfilter(uintptr_t *, const char *, uintptr_t *,
228 				uint_t);
229 #if	defined(_LP64)
230 extern uintptr_t	la_amd64_pltenter(Elf64_Sym *, uint_t, uintptr_t *,
231 				uintptr_t *, La_amd64_regs *,	uint_t *,
232 				const char *);
233 extern uintptr_t	la_symbind64(Elf64_Sym *, uint_t, uintptr_t *,
234 				uintptr_t *, uint_t *, const char *);
235 extern uintptr_t	la_sparcv9_pltenter(Elf64_Sym *, uint_t, uintptr_t *,
236 				uintptr_t *, La_sparcv9_regs *,	uint_t *,
237 				const char *);
238 extern uintptr_t	la_pltexit64(Elf64_Sym *, uint_t, uintptr_t *,
239 				uintptr_t *, uintptr_t, const char *);
240 #else  /* !defined(_LP64) */
241 extern uintptr_t	la_symbind32(Elf32_Sym *, uint_t, uintptr_t *,
242 				uintptr_t *, uint_t *);
243 extern uintptr_t	la_sparcv8_pltenter(Elf32_Sym *, uint_t, uintptr_t *,
244 				uintptr_t *, La_sparcv8_regs *, uint_t *);
245 extern uintptr_t	la_i86_pltenter(Elf32_Sym *, uint_t, uintptr_t *,
246 				uintptr_t *, La_i86_regs *, uint_t *);
247 extern uintptr_t	la_pltexit(Elf32_Sym *, uint_t, uintptr_t *,
248 				uintptr_t *, uintptr_t);
249 #endif /* _LP64 */
250 #else  /* __STDC__ */
251 extern uint_t		la_version();
252 extern void		la_preinit();
253 extern uint_t		la_objopen();
254 extern uint_t		la_objclose();
255 extern int		la_objfilter();
256 #if	defined(_LP64)
257 extern uintptr_t	la_sparcv9_pltenter();
258 extern uintptr_t	la_pltexit64();
259 extern uintptr_t	la_symbind64();
260 #else  /* _ILP32 */
261 extern uintptr_t	la_sparcv8_pltenter();
262 extern uintptr_t	la_i86_pltenter();
263 extern uintptr_t	la_pltexit();
264 extern uintptr_t	la_symbind32();
265 #endif /* _LP64 */
266 #endif /* __STDC__ */
267 
268 #ifdef	__STDC__
269 /*
270  * The ElfW() macro is a GNU/Linux feature, provided as support for
271  * the dl_phdr_info structure used by dl_phdr_iterate(), which also
272  * originated under Linux. Given an ELF data type, without the ElfXX_
273  * prefix, it supplies the appropriate prefix (Elf32_ or Elf64_) for
274  * the ELFCLASS of the code being compiled.
275  *
276  * Note that ElfW() is not suitable in situations in which the ELFCLASS
277  * of the code being compiled does not match that of the objects that
278  * code is intended to operate on (e.g. a 32-bit link-editor building
279  * a 64-bit object). The macros defined in <sys/machelf.h> are
280  * recommended in such cases.
281  */
282 #ifdef _LP64
283 #define	ElfW(type)	Elf64_ ## type
284 #else
285 #define	ElfW(type)	Elf32_ ## type
286 #endif
287 
288 /*
289  * The callback function to dl_interate_phdr() receives a pointer
290  * to a structure of this type.
291  *
292  * dlpi_addr is defined such that the address of any segment in
293  * the program header array can be calculated as:
294  *
295  *	addr == info->dlpi_addr + info->dlpi_phdr[x].p_vaddr;
296  *
297  * It is therefore 0 for ET_EXEC objects, and the base address at
298  * which the object is mapped otherwise.
299  */
300 struct dl_phdr_info {
301 	ElfW(Addr)		dlpi_addr;	/* Base address of object */
302 	const char		*dlpi_name;	/* Null-terminated obj name */
303 	const ElfW(Phdr)	*dlpi_phdr;	/* Ptr to ELF program hdr arr */
304 	ElfW(Half)		dlpi_phnum;	/* # of items in dlpi_phdr[] */
305 
306 	/*
307 	 * Note: Following members were introduced after the first version
308 	 * of this structure was available.  The dl_iterate_phdr() callback
309 	 * function is passed a 'size' argument giving the size of the info
310 	 * structure, and must compare that size to the offset of these fields
311 	 * before accessing them to ensure that they are present.
312 	 */
313 
314 	/* Incremented when a new object is mapped into the process */
315 	u_longlong_t		dlpi_adds;
316 	/* Incremented when an object is unmapped from the process */
317 	u_longlong_t		dlpi_subs;
318 };
319 
320 extern  int dl_iterate_phdr(int (*)(struct dl_phdr_info *, size_t, void *),
321 	    void *);
322 #endif /* __STDC__ */
323 
324 #endif	/* _ASM */
325 #endif /* _KERNEL */
326 
327 
328 #ifdef __cplusplus
329 }
330 #endif
331 
332 #endif	/* _LINK_H */
333