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