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