Remove <nodeputy.h> from default flags
[barrelfish] / include / elf / elf.h
1 /** \file
2  * \brief ELF file format definitions
3  */
4
5 /*
6  * Copyright (c) 2007, 2008, 2009, 2010, ETH Zurich.
7  * All rights reserved.
8  *
9  * This file is distributed under the terms in the attached LICENSE file.
10  * If you do not find this file, copies can be found by writing to:
11  * ETH Zurich D-INFK, Haldeneggsteig 4, CH-8092 Zurich. Attn: Systems Group.
12  */
13
14 /*-
15  * Copyright (c) 1998 John D. Polstra.
16  * All rights reserved.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions
20  * are met:
21  * 1. Redistributions of source code must retain the above copyright
22  *    notice, this list of conditions and the following disclaimer.
23  * 2. Redistributions in binary form must reproduce the above copyright
24  *    notice, this list of conditions and the following disclaimer in the
25  *    documentation and/or other materials provided with the distribution.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  * $FreeBSD: src/sys/sys/elf_common.h,v 1.23 2007/12/02 00:05:18 jb Exp $
40  */
41
42 #ifndef ELF_H
43 #define ELF_H
44
45 #include <sys/cdefs.h>
46
47 __BEGIN_DECLS
48
49 /* Indexes into the e_ident array.  Keep synced with
50    http://www.sco.com/developers/gabi/latest/ch4.eheader.html */
51 #define EI_MAG0         0       /* Magic number, byte 0. */
52 #define EI_MAG1         1       /* Magic number, byte 1. */
53 #define EI_MAG2         2       /* Magic number, byte 2. */
54 #define EI_MAG3         3       /* Magic number, byte 3. */
55 #define EI_CLASS        4       /* Class of machine. */
56 #define EI_DATA         5       /* Data format. */
57 #define EI_VERSION      6       /* ELF format version. */
58 #define EI_OSABI        7       /* Operating system / ABI identification */
59 #define EI_ABIVERSION   8       /* ABI version */
60 #define OLD_EI_BRAND    8       /* Start of architecture identification. */
61 #define EI_PAD          9       /* Start of padding (per SVR4 ABI). */
62 #define EI_NIDENT       16      /* Size of e_ident array. */
63
64 /* Values for the magic number bytes. */
65 #define ELFMAG0         0x7f
66 #define ELFMAG1         'E'
67 #define ELFMAG2         'L'
68 #define ELFMAG3         'F'
69 #define ELFMAG          "\177ELF"       /* magic string */
70 #define SELFMAG         4               /* magic string size */
71
72 /* Values for e_ident[EI_VERSION] and e_version. */
73 #define EV_NONE         0
74 #define EV_CURRENT      1
75
76 /* Values for e_ident[EI_CLASS]. */
77 #define ELFCLASSNONE    0       /* Unknown class. */
78 #define ELFCLASS32      1       /* 32-bit architecture. */
79 #define ELFCLASS64      2       /* 64-bit architecture. */
80
81 /* Values for e_ident[EI_DATA]. */
82 #define ELFDATANONE     0       /* Unknown data format. */
83 #define ELFDATA2LSB     1       /* 2's complement little-endian. */
84 #define ELFDATA2MSB     2       /* 2's complement big-endian. */
85
86 /* Values for e_ident[EI_OSABI]. */
87 #define ELFOSABI_NONE           0       /* UNIX System V ABI */
88 #define ELFOSABI_HPUX           1       /* HP-UX operating system */
89 #define ELFOSABI_NETBSD         2       /* NetBSD */
90 #define ELFOSABI_LINUX          3       /* GNU/Linux */
91 #define ELFOSABI_HURD           4       /* GNU/Hurd */
92 #define ELFOSABI_86OPEN         5       /* 86Open common IA32 ABI */
93 #define ELFOSABI_SOLARIS        6       /* Solaris */
94 #define ELFOSABI_AIX            7       /* AIX */
95 #define ELFOSABI_IRIX           8       /* IRIX */
96 #define ELFOSABI_FREEBSD        9       /* FreeBSD */
97 #define ELFOSABI_TRU64          10      /* TRU64 UNIX */
98 #define ELFOSABI_MODESTO        11      /* Novell Modesto */
99 #define ELFOSABI_OPENBSD        12      /* OpenBSD */
100 #define ELFOSABI_OPENVMS        13      /* Open VMS */
101 #define ELFOSABI_NSK            14      /* HP Non-Stop Kernel */
102 #define ELFOSABI_ARM            97      /* ARM */
103 #define ELFOSABI_STANDALONE     255     /* Standalone (embedded) application */
104
105 #define ELFOSABI_SYSV           ELFOSABI_NONE   /* symbol used in old spec */
106 #define ELFOSABI_MONTEREY       ELFOSABI_AIX    /* Monterey */
107
108 /* e_ident */
109 #define IS_ELF(ehdr)    ((ehdr).e_ident[EI_MAG0] == ELFMAG0 && \
110                          (ehdr).e_ident[EI_MAG1] == ELFMAG1 && \
111                          (ehdr).e_ident[EI_MAG2] == ELFMAG2 && \
112                          (ehdr).e_ident[EI_MAG3] == ELFMAG3)
113
114 /* Values for e_type. */
115 #define ET_NONE         0       /* Unknown type. */
116 #define ET_REL          1       /* Relocatable. */
117 #define ET_EXEC         2       /* Executable. */
118 #define ET_DYN          3       /* Shared object. */
119 #define ET_CORE         4       /* Core file. */
120 #define ET_LOOS         0xfe00  /* First operating system specific. */
121 #define ET_HIOS         0xfeff  /* Last operating system-specific. */
122 #define ET_LOPROC       0xff00  /* First processor-specific. */
123 #define ET_HIPROC       0xffff  /* Last processor-specific. */
124
125 /* Values for e_machine. */
126 #define EM_NONE         0       /* Unknown machine. */
127 #define EM_M32          1       /* AT&T WE32100. */
128 #define EM_SPARC        2       /* Sun SPARC. */
129 #define EM_386          3       /* Intel i386. */
130 #define EM_68K          4       /* Motorola 68000. */
131 #define EM_88K          5       /* Motorola 88000. */
132 #define EM_860          7       /* Intel i860. */
133 #define EM_MIPS         8       /* MIPS R3000 Big-Endian only. */
134 #define EM_S370         9       /* IBM System/370. */
135 #define EM_MIPS_RS3_LE  10      /* MIPS R3000 Little-Endian. */
136 #define EM_PARISC       15      /* HP PA-RISC. */
137 #define EM_VPP500       17      /* Fujitsu VPP500. */
138 #define EM_SPARC32PLUS  18      /* SPARC v8plus. */
139 #define EM_960          19      /* Intel 80960. */
140 #define EM_PPC          20      /* PowerPC 32-bit. */
141 #define EM_PPC64        21      /* PowerPC 64-bit. */
142 #define EM_S390         22      /* IBM System/390. */
143 #define EM_V800         36      /* NEC V800. */
144 #define EM_FR20         37      /* Fujitsu FR20. */
145 #define EM_RH32         38      /* TRW RH-32. */
146 #define EM_RCE          39      /* Motorola RCE. */
147 #define EM_ARM          40      /* ARM. */
148 #define EM_SH           42      /* Hitachi SH. */
149 #define EM_SPARCV9      43      /* SPARC v9 64-bit. */
150 #define EM_TRICORE      44      /* Siemens TriCore embedded processor. */
151 #define EM_ARC          45      /* Argonaut RISC Core. */
152 #define EM_H8_300       46      /* Hitachi H8/300. */
153 #define EM_H8_300H      47      /* Hitachi H8/300H. */
154 #define EM_H8S          48      /* Hitachi H8S. */
155 #define EM_H8_500       49      /* Hitachi H8/500. */
156 #define EM_IA_64        50      /* Intel IA-64 Processor. */
157 #define EM_MIPS_X       51      /* Stanford MIPS-X. */
158 #define EM_COLDFIRE     52      /* Motorola ColdFire. */
159 #define EM_68HC12       53      /* Motorola M68HC12. */
160 #define EM_MMA          54      /* Fujitsu MMA. */
161 #define EM_PCP          55      /* Siemens PCP. */
162 #define EM_NCPU         56      /* Sony nCPU. */
163 #define EM_NDR1         57      /* Denso NDR1 microprocessor. */
164 #define EM_STARCORE     58      /* Motorola Star*Core processor. */
165 #define EM_ME16         59      /* Toyota ME16 processor. */
166 #define EM_ST100        60      /* STMicroelectronics ST100 processor. */
167 #define EM_TINYJ        61      /* Advanced Logic Corp. TinyJ processor. */
168 #define EM_X86_64       62      /* Advanced Micro Devices x86-64 */
169 #define EM_AMD64        EM_X86_64       /* Advanced Micro Devices x86-64 (compat) */
170 #define EM_K1OM         181     /* Intel K1OM (Xeon Phi) */
171
172 /* Non-standard or deprecated. */
173 #define EM_486          6       /* Intel i486. */
174 #define EM_MIPS_RS4_BE  10      /* MIPS R4000 Big-Endian */
175 #define EM_ALPHA_STD    41      /* Digital Alpha (standard value). */
176 #define EM_ALPHA        0x9026  /* Alpha (written in the absence of an ABI) */
177
178 /* Special section indexes. */
179 #define SHN_UNDEF            0          /* Undefined, missing, irrelevant. */
180 #define SHN_LORESERVE   0xff00          /* First of reserved range. */
181 #define SHN_LOPROC      0xff00          /* First processor-specific. */
182 #define SHN_HIPROC      0xff1f          /* Last processor-specific. */
183 #define SHN_LOOS        0xff20          /* First operating system-specific. */
184 #define SHN_HIOS        0xff3f          /* Last operating system-specific. */
185 #define SHN_ABS         0xfff1          /* Absolute values. */
186 #define SHN_COMMON      0xfff2          /* Common data. */
187 #define SHN_XINDEX      0xffff          /* Escape -- index stored elsewhere. */
188 #define SHN_HIRESERVE   0xffff          /* Last of reserved range. */
189
190 /* sh_type */
191 #define SHT_NULL                0       /* inactive */
192 #define SHT_PROGBITS            1       /* program defined information */
193 #define SHT_SYMTAB              2       /* symbol table section */
194 #define SHT_STRTAB              3       /* string table section */
195 #define SHT_RELA                4       /* relocation section with addends */
196 #define SHT_HASH                5       /* symbol hash table section */
197 #define SHT_DYNAMIC             6       /* dynamic section */
198 #define SHT_NOTE                7       /* note section */
199 #define SHT_NOBITS              8       /* no space section */
200 #define SHT_REL                 9       /* relocation section - no addends */
201 #define SHT_SHLIB               10      /* reserved - purpose unknown */
202 #define SHT_DYNSYM              11      /* dynamic symbol table section */
203 #define SHT_INIT_ARRAY          14      /* Initialization function pointers. */
204 #define SHT_FINI_ARRAY          15      /* Termination function pointers. */
205 #define SHT_PREINIT_ARRAY       16      /* Pre-initialization function ptrs. */
206 #define SHT_GROUP               17      /* Section group. */
207 #define SHT_SYMTAB_SHNDX        18      /* Section indexes (see SHN_XINDEX). */
208 #define SHT_LOOS                0x60000000      /* First of OS specific semantics */
209 #define SHT_HIOS                0x6fffffff      /* Last of OS specific semantics */
210 #define SHT_LOPROC              0x70000000      /* reserved range for processor */
211 #define SHT_AMD64_UNWIND        0x70000001      /* unwind information */
212 #define SHT_HIPROC              0x7fffffff      /* specific section header types */
213 #define SHT_LOUSER              0x80000000      /* reserved range for application */
214 #define SHT_HIUSER              0xffffffff      /* specific indexes */
215
216 /* Flags for sh_flags. */
217 #define SHF_WRITE               0x1     /* Section contains writable data. */
218 #define SHF_ALLOC               0x2     /* Section occupies memory. */
219 #define SHF_EXECINSTR           0x4     /* Section contains instructions. */
220 #define SHF_MERGE               0x10    /* Section may be merged. */
221 #define SHF_STRINGS             0x20    /* Section contains strings. */
222 #define SHF_INFO_LINK           0x40    /* sh_info holds section index. */
223 #define SHF_LINK_ORDER          0x80    /* Special ordering requirements. */
224 #define SHF_OS_NONCONFORMING    0x100   /* OS-specific processing required. */
225 #define SHF_GROUP               0x200   /* Member of section group. */
226 #define SHF_TLS                 0x400   /* Section contains TLS data. */
227 #define SHF_MASKOS      0x0ff00000      /* OS-specific semantics. */
228 #define SHF_MASKPROC    0xf0000000      /* Processor-specific semantics. */
229
230 /* Values for p_type. */
231 #define PT_NULL         0       /* Unused entry. */
232 #define PT_LOAD         1       /* Loadable segment. */
233 #define PT_DYNAMIC      2       /* Dynamic linking information segment. */
234 #define PT_INTERP       3       /* Pathname of interpreter. */
235 #define PT_NOTE         4       /* Auxiliary information. */
236 #define PT_SHLIB        5       /* Reserved (not used). */
237 #define PT_PHDR         6       /* Location of program header itself. */
238 #define PT_TLS          7       /* Thread local storage segment */
239 #define PT_LOOS         0x60000000      /* First OS-specific. */
240 #define PT_SUNW_UNWIND  0x6464e550      /* amd64 UNWIND program header */
241 #define PT_GNU_EH_FRAME 0x6474e550
242 #define PT_LOSUNW       0x6ffffffa
243 #define PT_SUNWBSS      0x6ffffffa      /* Sun Specific segment */
244 #define PT_SUNWSTACK    0x6ffffffb      /* describes the stack segment */
245 #define PT_SUNWDTRACE   0x6ffffffc      /* private */
246 #define PT_SUNWCAP      0x6ffffffd      /* hard/soft capabilities segment */
247 #define PT_HISUNW       0x6fffffff
248 #define PT_HIOS         0x6fffffff      /* Last OS-specific. */
249 #define PT_LOPROC       0x70000000      /* First processor-specific type. */
250 #define PT_HIPROC       0x7fffffff      /* Last processor-specific type. */
251
252 /* Values for p_flags. */
253 #define PF_X            0x1             /* Executable. */
254 #define PF_W            0x2             /* Writable. */
255 #define PF_R            0x4             /* Readable. */
256 #define PF_MASKOS       0x0ff00000      /* Operating system-specific. */
257 #define PF_MASKPROC     0xf0000000      /* Processor-specific. */
258
259 /* Extended program header index. */
260 #define PN_XNUM         0xffff
261
262 /* Values for d_tag. */
263 #define DT_NULL         0       /* Terminating entry. */
264 #define DT_NEEDED       1       /* String table offset of a needed shared
265                                    library. */
266 #define DT_PLTRELSZ     2       /* Total size in bytes of PLT relocations. */
267 #define DT_PLTGOT       3       /* Processor-dependent address. */
268 #define DT_HASH         4       /* Address of symbol hash table. */
269 #define DT_STRTAB       5       /* Address of string table. */
270 #define DT_SYMTAB       6       /* Address of symbol table. */
271 #define DT_RELA         7       /* Address of ElfNN_Rela relocations. */
272 #define DT_RELASZ       8       /* Total size of ElfNN_Rela relocations. */
273 #define DT_RELAENT      9       /* Size of each ElfNN_Rela relocation entry. */
274 #define DT_STRSZ        10      /* Size of string table. */
275 #define DT_SYMENT       11      /* Size of each symbol table entry. */
276 #define DT_INIT         12      /* Address of initialization function. */
277 #define DT_FINI         13      /* Address of finalization function. */
278 #define DT_SONAME       14      /* String table offset of shared object
279                                    name. */
280 #define DT_RPATH        15      /* String table offset of library path. [sup] */
281 #define DT_SYMBOLIC     16      /* Indicates "symbolic" linking. [sup] */
282 #define DT_REL          17      /* Address of ElfNN_Rel relocations. */
283 #define DT_RELSZ        18      /* Total size of ElfNN_Rel relocations. */
284 #define DT_RELENT       19      /* Size of each ElfNN_Rel relocation. */
285 #define DT_PLTREL       20      /* Type of relocation used for PLT. */
286 #define DT_DEBUG        21      /* Reserved (not used). */
287 #define DT_TEXTREL      22      /* Indicates there may be relocations in
288                                    non-writable segments. [sup] */
289 #define DT_JMPREL       23      /* Address of PLT relocations. */
290 #define DT_BIND_NOW     24      /* [sup] */
291 #define DT_INIT_ARRAY   25      /* Address of the array of pointers to
292                                    initialization functions */
293 #define DT_FINI_ARRAY   26      /* Address of the array of pointers to
294                                    termination functions */
295 #define DT_INIT_ARRAYSZ 27      /* Size in bytes of the array of
296                                    initialization functions. */
297 #define DT_FINI_ARRAYSZ 28      /* Size in bytes of the array of
298                                    terminationfunctions. */
299 #define DT_RUNPATH      29      /* String table offset of a null-terminated
300                                    library search path string. */
301 #define DT_FLAGS        30      /* Object specific flag values. */
302 #define DT_ENCODING     32      /* Values greater than or equal to DT_ENCODING
303                                    and less than DT_LOOS follow the rules for
304                                    the interpretation of the d_un union
305                                    as follows: even == 'd_ptr', even == 'd_val'
306                                    or none */
307 #define DT_PREINIT_ARRAY 32     /* Address of the array of pointers to
308                                    pre-initialization functions. */
309 #define DT_PREINIT_ARRAYSZ 33   /* Size in bytes of the array of
310                                    pre-initialization functions. */
311 #define DT_MAXPOSTAGS   34      /* number of positive tags */
312 #define DT_LOOS         0x6000000d      /* First OS-specific */
313 #define DT_SUNW_AUXILIARY       0x6000000d      /* symbol auxiliary name */
314 #define DT_SUNW_RTLDINF         0x6000000e      /* ld.so.1 info (private) */
315 #define DT_SUNW_FILTER          0x6000000f      /* symbol filter name */
316 #define DT_SUNW_CAP             0x60000010      /* hardware/software */
317 #define DT_HIOS         0x6ffff000      /* Last OS-specific */
318
319 /*
320  * DT_* entries which fall between DT_VALRNGHI & DT_VALRNGLO use the
321  * Dyn.d_un.d_val field of the Elf*_Dyn structure.
322  */
323 #define DT_VALRNGLO     0x6ffffd00
324 #define DT_CHECKSUM     0x6ffffdf8      /* elf checksum */
325 #define DT_PLTPADSZ     0x6ffffdf9      /* pltpadding size */
326 #define DT_MOVEENT      0x6ffffdfa      /* move table entry size */
327 #define DT_MOVESZ       0x6ffffdfb      /* move table size */
328 #define DT_FEATURE_1    0x6ffffdfc      /* feature holder */
329 #define DT_POSFLAG_1    0x6ffffdfd      /* flags for DT_* entries, effecting */
330                                         /*      the following DT_* entry. */
331                                         /*      See DF_P1_* definitions */
332 #define DT_SYMINSZ      0x6ffffdfe      /* syminfo table size (in bytes) */
333 #define DT_SYMINENT     0x6ffffdff      /* syminfo entry size (in bytes) */
334 #define DT_VALRNGHI     0x6ffffdff
335
336 /*
337  * DT_* entries which fall between DT_ADDRRNGHI & DT_ADDRRNGLO use the
338  * Dyn.d_un.d_ptr field of the Elf*_Dyn structure.
339  *
340  * If any adjustment is made to the ELF object after it has been
341  * built, these entries will need to be adjusted.
342  */
343 #define DT_ADDRRNGLO    0x6ffffe00
344 #define DT_CONFIG       0x6ffffefa      /* configuration information */
345 #define DT_DEPAUDIT     0x6ffffefb      /* dependency auditing */
346 #define DT_AUDIT        0x6ffffefc      /* object auditing */
347 #define DT_PLTPAD       0x6ffffefd      /* pltpadding (sparcv9) */
348 #define DT_MOVETAB      0x6ffffefe      /* move table */
349 #define DT_SYMINFO      0x6ffffeff      /* syminfo table */
350 #define DT_ADDRRNGHI    0x6ffffeff
351
352 #define DT_VERSYM       0x6ffffff0      /* Address of versym section. */
353 #define DT_RELACOUNT    0x6ffffff9      /* number of RELATIVE relocations */
354 #define DT_RELCOUNT     0x6ffffffa      /* number of RELATIVE relocations */
355 #define DT_FLAGS_1      0x6ffffffb      /* state flags - see DF_1_* defs */
356 #define DT_VERDEF       0x6ffffffc      /* Address of verdef section. */
357 #define DT_VERDEFNUM    0x6ffffffd      /* Number of elems in verdef section */
358 #define DT_VERNEED      0x6ffffffe      /* Address of verneed section. */
359 #define DT_VERNEEDNUM   0x6fffffff      /* Number of elems in verneed section */
360
361 #define DT_LOPROC       0x70000000      /* First processor-specific type. */
362 #define DT_DEPRECATED_SPARC_REGISTER    0x7000001
363 #define DT_AUXILIARY    0x7ffffffd      /* shared library auxiliary name */
364 #define DT_USED         0x7ffffffe      /* ignored - same as needed */
365 #define DT_FILTER       0x7fffffff      /* shared library filter name */
366 #define DT_HIPROC       0x7fffffff      /* Last processor-specific type. */
367
368 /* Values for DT_FLAGS */
369 #define DF_ORIGIN       0x0001  /* Indicates that the object being loaded may
370                                    make reference to the $ORIGIN substitution
371                                    string */
372 #define DF_SYMBOLIC     0x0002  /* Indicates "symbolic" linking. */
373 #define DF_TEXTREL      0x0004  /* Indicates there may be relocations in
374                                    non-writable segments. */
375 #define DF_BIND_NOW     0x0008  /* Indicates that the dynamic linker should
376                                    process all relocations for the object
377                                    containing this entry before transferring
378                                    control to the program. */
379 #define DF_STATIC_TLS   0x0010  /* Indicates that the shared object or
380                                    executable contains code using a static
381                                    thread-local storage scheme. */
382
383 /* Values for n_type.  Used in core files. */
384 #define NT_PRSTATUS     1       /* Process status. */
385 #define NT_FPREGSET     2       /* Floating point registers. */
386 #define NT_PRPSINFO     3       /* Process state info. */
387
388 /* Symbol Binding - ELFNN_ST_BIND - st_info */
389 #define STB_LOCAL       0       /* Local symbol */
390 #define STB_GLOBAL      1       /* Global symbol */
391 #define STB_WEAK        2       /* like global - lower precedence */
392 #define STB_LOOS        10      /* Reserved range for operating system */
393 #define STB_HIOS        12      /*   specific semantics. */
394 #define STB_LOPROC      13      /* reserved range for processor */
395 #define STB_HIPROC      15      /*   specific semantics. */
396
397 /* Symbol type - ELFNN_ST_TYPE - st_info */
398 #define STT_NOTYPE      0       /* Unspecified type. */
399 #define STT_OBJECT      1       /* Data object. */
400 #define STT_FUNC        2       /* Function. */
401 #define STT_SECTION     3       /* Section. */
402 #define STT_FILE        4       /* Source file. */
403 #define STT_COMMON      5       /* Uninitialized common block. */
404 #define STT_TLS         6       /* TLS object. */
405 #define STT_NUM         7
406 #define STT_LOOS        10      /* Reserved range for operating system */
407 #define STT_HIOS        12      /*   specific semantics. */
408 #define STT_LOPROC      13      /* reserved range for processor */
409 #define STT_HIPROC      15      /*   specific semantics. */
410
411 /* Symbol visibility - ELFNN_ST_VISIBILITY - st_other */
412 #define STV_DEFAULT     0x0     /* Default visibility (see binding). */
413 #define STV_INTERNAL    0x1     /* Special meaning in relocatable objects. */
414 #define STV_HIDDEN      0x2     /* Not visible. */
415 #define STV_PROTECTED   0x3     /* Visible but not preemptible. */
416
417 /* Special symbol table indexes. */
418 #define STN_UNDEF       0       /* Undefined symbol index. */
419
420 /* Symbol versioning flags. */
421 #define VER_DEF_CURRENT 1
422 #define VER_DEF_IDX(x)  VER_NDX(x)
423
424 #define VER_FLG_BASE    0x01
425 #define VER_FLG_WEAK    0x02
426
427 #define VER_NEED_CURRENT        1
428 #define VER_NEED_WEAK   (1u << 15)
429 #define VER_NEED_HIDDEN VER_NDX_HIDDEN
430 #define VER_NEED_IDX(x) VER_NDX(x)
431
432 #define VER_NDX_LOCAL   0
433 #define VER_NDX_GLOBAL  1
434 #define VER_NDX_GIVEN   2
435
436 #define VER_NDX_HIDDEN  (1u << 15)
437 #define VER_NDX(x)      ((x) & ~(1u << 15))
438
439 #define CA_SUNW_NULL    0
440 #define CA_SUNW_HW_1    1               /* first hardware capabilities entry */
441 #define CA_SUNW_SF_1    2               /* first software capabilities entry */
442
443 /*
444  * Syminfo flag values
445  */
446 #define SYMINFO_FLG_DIRECT      0x0001  /* symbol ref has direct association */
447                                         /*      to object containing defn. */
448 #define SYMINFO_FLG_PASSTHRU    0x0002  /* ignored - see SYMINFO_FLG_FILTER */
449 #define SYMINFO_FLG_COPY        0x0004  /* symbol is a copy-reloc */
450 #define SYMINFO_FLG_LAZYLOAD    0x0008  /* object containing defn should be */
451                                         /*      lazily-loaded */
452 #define SYMINFO_FLG_DIRECTBIND  0x0010  /* ref should be bound directly to */
453                                         /*      object containing defn. */
454 #define SYMINFO_FLG_NOEXTDIRECT 0x0020  /* don't let an external reference */
455                                         /*      directly bind to this symbol */
456 #define SYMINFO_FLG_FILTER      0x0002  /* symbol ref is associated to a */
457 #define SYMINFO_FLG_AUXILIARY   0x0040  /*      standard or auxiliary filter */
458
459 /*
460  * Syminfo.si_boundto values.
461  */
462 #define SYMINFO_BT_SELF         0xffff  /* symbol bound to self */
463 #define SYMINFO_BT_PARENT       0xfffe  /* symbol bound to parent */
464 #define SYMINFO_BT_NONE         0xfffd  /* no special symbol binding */
465 #define SYMINFO_BT_EXTERN       0xfffc  /* symbol defined as external */
466 #define SYMINFO_BT_LOWRESERVE   0xff00  /* beginning of reserved entries */
467
468 /*
469  * Syminfo version values.
470  */
471 #define SYMINFO_NONE            0       /* Syminfo version */
472 #define SYMINFO_CURRENT         1
473 #define SYMINFO_NUM             2
474
475 #define ELF64_R_SYM(i)          ((i) >> 32)
476 #define ELF64_R_TYPE(i)         ((i) & 0xffffffffL)
477
478 #define ELF32_R_SYM(i)          ((i)>>8)
479 #define ELF32_R_TYPE(i)         ((uint8_t)(i))
480 #define ELF32_R_INFO(s,t)       (((s)<<8)+(uint8_t)(t))
481
482 /* AMD x86-64 relocations.  */
483 #define R_X86_64_NONE           0       /* No relocation. */
484 #define R_X86_64_64             1       /* Add 64 bit symbol value. */
485 #define R_X86_64_PC32           2       /* PC-relative 32 bit signed sym value. */
486 #define R_X86_64_GOT32          3       /* PC-relative 32 bit GOT offset. */
487 #define R_X86_64_PLT32          4       /* PC-relative 32 bit PLT offset. */
488 #define R_X86_64_COPY           5       /* Copy data from shared object. */
489 #define R_X86_64_GLOB_DAT       6       /* Set GOT entry to data address. */
490 #define R_X86_64_JMP_SLOT       7       /* Set GOT entry to code address. */
491 #define R_X86_64_RELATIVE       8       /* Add load address of shared object. */
492 #define R_X86_64_GOTPCREL       9       /* Add 32 bit signed pcrel offset to GOT. */
493 #define R_X86_64_32             10      /* Add 32 bit zero extended symbol value */
494 #define R_X86_64_32S            11      /* Add 32 bit sign extended symbol value */
495 #define R_X86_64_16             12      /* Add 16 bit zero extended symbol value */
496 #define R_X86_64_PC16           13      /* Add 16 bit signed extended pc relative symbol value */
497 #define R_X86_64_8              14      /* Add 8 bit zero extended symbol value */
498 #define R_X86_64_PC8            15      /* Add 8 bit signed extended pc relative symbol value */
499 #define R_X86_64_DTPMOD64       16      /* ID of module containing symbol */
500 #define R_X86_64_DTPOFF64       17      /* Offset in TLS block */
501 #define R_X86_64_TPOFF64        18      /* Offset in static TLS block */
502 #define R_X86_64_TLSGD          19      /* PC relative offset to GD GOT entry */
503 #define R_X86_64_TLSLD          20      /* PC relative offset to LD GOT entry */
504 #define R_X86_64_DTPOFF32       21      /* Offset in TLS block */
505 #define R_X86_64_GOTTPOFF       22      /* PC relative offset to IE GOT entry */
506 #define R_X86_64_TPOFF32        23      /* Offset in static TLS block */
507
508 /* i386 relocations.  */
509 #define R_386_NONE              0       /* No relocation. */
510 #define R_386_32                1       /* Add symbol value. */
511 #define R_386_PC32              2       /* Add PC-relative symbol value. */
512 #define R_386_GOT32             3       /* Add PC-relative GOT offset. */
513 #define R_386_PLT32             4       /* Add PC-relative PLT offset. */
514 #define R_386_COPY              5       /* Copy data from shared object. */
515 #define R_386_GLOB_DAT          6       /* Set GOT entry to data address. */
516 #define R_386_JMP_SLOT          7       /* Set GOT entry to code address. */
517 #define R_386_RELATIVE          8       /* Add load address of shared object. */
518 #define R_386_GOTOFF            9       /* Add GOT-relative symbol address. */
519 #define R_386_GOTPC             10      /* Add PC-relative GOT table address. */
520 #define R_386_TLS_TPOFF         14      /* Negative offset in static TLS block */
521 #define R_386_TLS_IE            15      /* Absolute address of GOT for -ve static TLS */
522 #define R_386_TLS_GOTIE         16      /* GOT entry for negative static TLS block */
523 #define R_386_TLS_LE            17      /* Negative offset relative to static TLS */
524 #define R_386_TLS_GD            18      /* 32 bit offset to GOT (index,off) pair */
525 #define R_386_TLS_LDM           19      /* 32 bit offset to GOT (index,zero) pair */
526 #define R_386_TLS_GD_32         24      /* 32 bit offset to GOT (index,off) pair */
527 #define R_386_TLS_GD_PUSH       25      /* pushl instruction for Sun ABI GD sequence */
528 #define R_386_TLS_GD_CALL       26      /* call instruction for Sun ABI GD sequence */
529 #define R_386_TLS_GD_POP        27      /* popl instruction for Sun ABI GD sequence */
530 #define R_386_TLS_LDM_32        28      /* 32 bit offset to GOT (index,zero) pair */
531 #define R_386_TLS_LDM_PUSH      29      /* pushl instruction for Sun ABI LD sequence */
532 #define R_386_TLS_LDM_CALL      30      /* call instruction for Sun ABI LD sequence */
533 #define R_386_TLS_LDM_POP       31      /* popl instruction for Sun ABI LD sequence */
534 #define R_386_TLS_LDO_32        32      /* 32 bit offset from start of TLS block */
535 #define R_386_TLS_IE_32         33      /* 32 bit offset to GOT static TLS offset entry */
536 #define R_386_TLS_LE_32         34      /* 32 bit offset within static TLS block */
537 #define R_386_TLS_DTPMOD32      35      /* GOT entry containing TLS index */
538 #define R_386_TLS_DTPOFF32      36      /* GOT entry containing TLS offset */
539 #define R_386_TLS_TPOFF32       37      /* GOT entry of -ve static TLS offset */
540
541 /* ARM relocations. A LOT MISSING! */
542 #define R_ARM_NONE                              0
543 #define R_ARM_ABS32                             2
544 #define R_ARM_RELATIVE                  23
545
546 /**
547  * \brief ELF64 file header.
548  */
549 struct Elf64_Ehdr {
550     uint8_t        e_ident[EI_NIDENT];
551     uint16_t       e_type;
552     uint16_t       e_machine;
553     uint32_t       e_version;
554     uint64_t       e_entry;
555     uint64_t       e_phoff;
556     uint64_t       e_shoff;
557     uint32_t       e_flags;
558     uint16_t       e_ehsize;
559     uint16_t       e_phentsize;
560     uint16_t       e_phnum;
561     uint16_t       e_shentsize;
562     uint16_t       e_shnum;
563     uint16_t       e_shstrndx;
564 } __attribute__ ((packed));
565
566 /**
567  * \brief ELF64 program header.
568  */
569 struct Elf64_Phdr {
570     uint32_t        p_type;
571     uint32_t        p_flags;
572     uint64_t        p_offset;
573     uint64_t        p_vaddr;
574     uint64_t        p_paddr;
575     uint64_t        p_filesz;
576     uint64_t        p_memsz;
577     uint64_t        p_align;
578 } __attribute__ ((packed));
579
580 /**
581  * \brief ELF64 section header.
582  */
583 struct Elf64_Shdr {
584     uint32_t    sh_name;
585     uint32_t    sh_type;
586     uint64_t    sh_flags;
587     uint64_t    sh_addr;
588     uint64_t    sh_offset;
589     uint64_t    sh_size;
590     uint32_t    sh_link;
591     uint32_t    sh_info;
592     uint64_t    sh_addralign;
593     uint64_t    sh_entsize;
594 } __attribute__ ((packed));
595
596 /**
597  * \brief ELF64 relocation entry.
598  */
599 struct Elf64_Rela {
600     uint64_t    r_offset;
601     uint64_t    r_info;
602     int64_t     r_addend;
603 } __attribute__ ((packed));
604
605 /**
606  * \brief ELF64 symbol table entry.
607  */
608 struct Elf64_Sym {
609     uint32_t        st_name;
610     uint8_t         st_info;
611     uint8_t         st_other;
612     uint16_t        st_shndx;
613     uint64_t        st_value;
614     uint64_t        st_size;
615 } __attribute__ ((packed));
616
617 /**
618  * \brief ELF64 Dynamic section entry
619  */
620 struct Elf64_Dyn {
621     int64_t         d_tag;
622     union {
623         uint64_t    d_val;
624         uint64_t    d_ptr;
625     } d_un;
626 } __attribute__ ((packed));
627
628 /**
629  * \brief ELF32 file header.
630  */
631 struct Elf32_Ehdr {
632     uint8_t  e_ident[EI_NIDENT];        // 00
633     uint16_t e_type;                    // 16
634     uint16_t e_machine;                 // 18
635     uint32_t e_version;                 // 20
636     uint32_t e_entry;                   // 24
637     uint32_t e_phoff;                   // 28
638     uint32_t e_shoff;                   // 32
639     uint32_t e_flags;                   // 36
640     uint16_t e_ehsize;                  // 40
641     uint16_t e_phentsize;               // 42
642     uint16_t e_phnum;                   // 44
643     uint16_t e_shentsize;               // 46
644     uint16_t e_shnum;                   // 48
645     uint16_t e_shstrndx;                // 50
646 };
647
648 /**
649  * \brief ELF32 program header.
650  */
651 struct  Elf32_Phdr {
652     uint32_t p_type;                    // 0
653     uint32_t p_offset;                  // 4
654     uint32_t p_vaddr;                   // 8
655     uint32_t p_paddr;                   // 12
656     uint32_t p_filesz;                  // 16
657     uint32_t p_memsz;                   // 20
658     uint32_t p_flags;                   // 24
659     uint32_t p_align;                   // 28
660 };
661
662 /**
663  * \brief ELF32 section header.
664  */
665 struct Elf32_Shdr {
666     uint32_t sh_name;                   // 0
667     uint32_t sh_type;                   // 4
668     uint32_t sh_flags;                  // 8
669     uint32_t sh_addr;                   // 12
670     uint32_t sh_offset;                 // 16
671     uint32_t sh_size;                   // 20
672     uint32_t sh_link;                   // 24
673     uint32_t sh_info;                   // 28
674     uint32_t sh_addralign;              // 32
675     uint32_t sh_entsize;                // 36
676 };
677
678 /**
679  * \brief ELF32 relocation entry.
680  */
681 struct Elf32_Rel {
682     uint32_t r_offset;
683     uint32_t r_info;
684 };
685
686 /**
687  * \brief ELF32 relocation entry with addend.
688  */
689 struct Elf32_Rela {
690     uint32_t r_offset;
691     uint32_t r_info;
692     int32_t  r_addend;
693 };
694
695 /**
696  * \brief ELF32 symbol table entry.
697  */
698 struct Elf32_Sym {
699     uint32_t st_name;
700     uint32_t st_value;
701     uint32_t st_size;
702     uint8_t  st_info;
703     uint8_t  st_other;
704     uint16_t st_shndx;
705 };
706
707
708 struct Elf32_Dyn {
709     int32_t          d_tag;
710     union {
711         uint32_t     d_val;
712         uint32_t     d_ptr;
713     } d_un;
714 } __attribute__ ((packed));
715
716 struct Elf64_Shdr *
717 elf64_find_section_header_type(struct Elf64_Shdr *shdr,
718                                uint32_t entries, uint32_t type);
719 struct Elf32_Shdr *
720 elf32_find_section_header_type(struct Elf32_Shdr *shdr,
721                                uint32_t entries, uint32_t type);
722
723 struct Elf64_Shdr *
724 elf64_find_section_header_name(genvaddr_t elf_base, size_t elf_bytes,
725                                const char* section_name);
726 struct Elf32_Shdr *
727 elf32_find_section_header_name(genvaddr_t elf_base, size_t elf_bytes,
728                                const char* section_name);
729
730 struct Elf64_Shdr *
731 elf64_find_symtab(genvaddr_t elf_base, size_t elf_bytes);
732 struct Elf32_Shdr *
733 elf32_find_symtab(genvaddr_t elf_base, size_t elf_bytes);
734
735 struct Elf64_Sym *
736 elf64_find_symbol_by_name(genvaddr_t elf_base, size_t elf_bytes,
737                           const char *name, uint8_t contains, uint8_t type,
738                           uintptr_t *index);
739 struct Elf32_Sym *
740 elf32_find_symbol_by_name(genvaddr_t elf_base, size_t elf_bytes,
741                           const char *name,
742                           uint8_t contains, uint8_t type,
743                           uintptr_t *index);
744 uint32_t
745 elf64_count_symbol_by_name(genvaddr_t elf_base, size_t elf_bytes,
746                           const char *name, uint8_t contains, uint8_t type,
747                           size_t *ret_bytes);
748 uint32_t
749 elf32_count_symbol_by_name(genvaddr_t elf_base, size_t elf_bytes,
750                           const char *name, uint8_t contains, uint8_t type,
751                           size_t *ret_bytes);
752 struct Elf64_Sym *
753 elf64_find_symbol_by_addr(genvaddr_t elf_base, size_t elf_bytes,
754                           lvaddr_t addr, uintptr_t *index);
755 struct Elf32_Sym *
756 elf32_find_symbol_by_addr(genvaddr_t elf_base, size_t elf_bytes,
757                           lvaddr_t addr, uintptr_t *index);
758 const char *
759 elf64_get_symbolname(struct Elf64_Ehdr *head, struct Elf64_Sym *sym);
760 const char *
761 elf32_get_symbolname(struct Elf32_Ehdr *head, struct Elf32_Sym *sym);
762
763 void elf64_relocate(genvaddr_t dst, genvaddr_t src,
764                     struct Elf64_Rela * rela, size_t size,
765                     struct Elf64_Sym * symtab, size_t symsize,
766                     genvaddr_t start, void *vbase);
767 void elf32_relocate(genvaddr_t dst, genvaddr_t src,
768                     struct Elf32_Rel * rela, size_t size,
769                     struct Elf32_Sym * symtab, size_t symsize,
770                     genvaddr_t start, void *vbase);
771
772 typedef errval_t (*elf_allocator_fn)(void *state, genvaddr_t base,
773                                      size_t size, uint32_t flags, void **ret);
774
775 errval_t elf64_load(uint16_t em_machine, elf_allocator_fn allocate_func,
776                     void *state, lvaddr_t base, size_t size,
777                     genvaddr_t *retentry,
778                     genvaddr_t *ret_tlsbase, size_t *ret_tlsinitlen,
779                     size_t *ret_tlstotallen);
780
781 errval_t elf32_load(uint16_t em_machine, elf_allocator_fn allocate_func,
782                     void *state, lvaddr_t base,
783                     size_t size, genvaddr_t *retentry,
784                     genvaddr_t *ret_tlsbase, size_t *ret_tlsinitlen,
785                     size_t *ret_tlstotallen);
786 errval_t elf_load(uint16_t em_machine, elf_allocator_fn allocate_func,
787                   void *state, lvaddr_t base,
788                   size_t size, genvaddr_t *retentry);
789
790 errval_t elf_load_tls(uint16_t em_machine, elf_allocator_fn allocate_func,
791                       void *state, lvaddr_t base,
792                       size_t size, genvaddr_t *retentry,
793                       genvaddr_t *ret_tlsbase, size_t *ret_tlsinitlen,
794                       size_t *ret_tlstotallen);
795
796 size_t  elf_virtual_size(lvaddr_t base);
797
798 errval_t elf_get_eh_info(lvaddr_t elfbase, size_t elfsize,
799                          lvaddr_t *eh_frame, size_t *eh_frame_size,
800                          lvaddr_t *eh_frame_hdr, size_t *eh_frame_hdr_size);
801
802
803
804 genvaddr_t elf_virtual_base32(struct Elf32_Ehdr *ehead);
805 genvaddr_t elf_virtual_base64(struct Elf64_Ehdr *ehead);
806 genvaddr_t elf_virtual_base(lvaddr_t base);
807
808 __END_DECLS
809
810 #endif // ELF_H