VirtualBox

source: vbox/trunk/include/iprt/formats/elf-common.h@ 93941

Last change on this file since 93941 was 89970, checked in by vboxsync, 3 years ago

Runtime/ldrELF: Add RTLDRPROP_BUILDID for querying the build-id of an ELF binary [missing file]

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 17.7 KB
Line 
1/*-
2 * Copyright (c) 1998 John D. Polstra.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#ifndef IPRT_INCLUDED_formats_elf_common_h
28#define IPRT_INCLUDED_formats_elf_common_h
29#ifndef RT_WITHOUT_PRAGMA_ONCE
30# pragma once
31#endif
32
33#include <iprt/stdint.h>
34
35/*
36 * ELF definitions that are independent of architecture or word size.
37 */
38
39/*
40 * Note header. The ".note" section contains an array of notes. Each
41 * begins with this header, aligned to a word boundary. Immediately
42 * following the note header is n_namesz bytes of name, padded to the
43 * next word boundary. Then comes n_descsz bytes of descriptor, again
44 * padded to a word boundary. The values of n_namesz and n_descsz do
45 * not include the padding.
46 */
47
48typedef struct {
49 uint32_t n_namesz; /* Length of name. */
50 uint32_t n_descsz; /* Length of descriptor. */
51 uint32_t n_type; /* Type of this note. */
52} Elf_Note;
53
54/* Indexes into the e_ident array. Keep synced with
55 http://www.sco.com/developer/gabi/ch4.eheader.html */
56#define EI_MAG0 0 /* Magic number, byte 0. */
57#define EI_MAG1 1 /* Magic number, byte 1. */
58#define EI_MAG2 2 /* Magic number, byte 2. */
59#define EI_MAG3 3 /* Magic number, byte 3. */
60#define EI_CLASS 4 /* Class of machine. */
61#define EI_DATA 5 /* Data format. */
62#define EI_VERSION 6 /* ELF format version. */
63#define EI_OSABI 7 /* Operating system / ABI identification */
64#define EI_ABIVERSION 8 /* ABI version */
65#define OLD_EI_BRAND 8 /* Start of architecture identification. */
66#define EI_PAD 9 /* Start of padding (per SVR4 ABI). */
67#define EI_NIDENT 16 /* Size of e_ident array. */
68
69/* Values for the magic number bytes. */
70#define ELFMAG0 0x7f
71#define ELFMAG1 'E'
72#define ELFMAG2 'L'
73#define ELFMAG3 'F'
74#define ELFMAG "\177ELF" /* magic string */
75#define SELFMAG 4 /* magic string size */
76
77/* Values for e_ident[EI_VERSION] and e_version. */
78#define EV_NONE 0
79#define EV_CURRENT 1
80
81/* Values for e_ident[EI_CLASS]. */
82#define ELFCLASSNONE 0 /* Unknown class. */
83#define ELFCLASS32 1 /* 32-bit architecture. */
84#define ELFCLASS64 2 /* 64-bit architecture. */
85
86/* Values for e_ident[EI_DATA]. */
87#define ELFDATANONE 0 /* Unknown data format. */
88#define ELFDATA2LSB 1 /* 2's complement little-endian. */
89#define ELFDATA2MSB 2 /* 2's complement big-endian. */
90
91/* Values for e_ident[EI_OSABI]. */
92#define ELFOSABI_SYSV 0 /* UNIX System V ABI */
93#define ELFOSABI_NONE ELFOSABI_SYSV /* symbol used in old spec */
94#define ELFOSABI_HPUX 1 /* HP-UX operating system */
95#define ELFOSABI_NETBSD 2 /* NetBSD */
96#define ELFOSABI_LINUX 3 /* GNU/Linux */
97#define ELFOSABI_HURD 4 /* GNU/Hurd */
98#define ELFOSABI_86OPEN 5 /* 86Open common IA32 ABI */
99#define ELFOSABI_SOLARIS 6 /* Solaris */
100#define ELFOSABI_MONTEREY 7 /* Monterey */
101#define ELFOSABI_IRIX 8 /* IRIX */
102#define ELFOSABI_FREEBSD 9 /* FreeBSD */
103#define ELFOSABI_TRU64 10 /* TRU64 UNIX */
104#define ELFOSABI_MODESTO 11 /* Novell Modesto */
105#define ELFOSABI_OPENBSD 12 /* OpenBSD */
106#define ELFOSABI_ARM 97 /* ARM */
107#define ELFOSABI_STANDALONE 255 /* Standalone (embedded) application */
108
109/* e_ident */
110#define IS_ELF(ehdr) ((ehdr).e_ident[EI_MAG0] == ELFMAG0 && \
111 (ehdr).e_ident[EI_MAG1] == ELFMAG1 && \
112 (ehdr).e_ident[EI_MAG2] == ELFMAG2 && \
113 (ehdr).e_ident[EI_MAG3] == ELFMAG3)
114
115/* Values for e_type. */
116#define ET_NONE 0 /* Unknown type. */
117#define ET_REL 1 /* Relocatable. */
118#define ET_EXEC 2 /* Executable. */
119#define ET_DYN 3 /* Shared object. */
120#define ET_CORE 4 /* Core file. */
121
122/* Values for e_machine. */
123#define EM_NONE 0 /* Unknown machine. */
124#define EM_M32 1 /* AT&T WE32100. */
125#define EM_SPARC 2 /* Sun SPARC. */
126#define EM_386 3 /* Intel i386. */
127#define EM_68K 4 /* Motorola 68000. */
128#define EM_88K 5 /* Motorola 88000. */
129#define EM_486 6 /* Intel i486. */
130#define EM_860 7 /* Intel i860. */
131#define EM_MIPS 8 /* MIPS R3000 Big-Endian only */
132
133/* Extensions. This list is not complete. */
134#define EM_S370 9 /* IBM System/370 */
135#define EM_MIPS_RS4_BE 10 /* MIPS R4000 Big-Endian */ /* Depreciated */
136#define EM_PARISC 15 /* HPPA */
137#define EM_SPARC32PLUS 18 /* SPARC v8plus */
138#define EM_PPC 20 /* PowerPC 32-bit */
139#define EM_PPC64 21 /* PowerPC 64-bit */
140#define EM_ARM 40 /* ARM */
141#define EM_SPARCV9 43 /* SPARC v9 64-bit */
142#define EM_IA_64 50 /* Intel IA-64 Processor */
143#define EM_X86_64 62 /* Advanced Micro Devices x86-64 */
144#define EM_AMD64 EM_X86_64 /* SunOS compatibility (added by Ramshankar) */
145#define EM_ALPHA 0x9026 /* Alpha (written in the absence of an ABI */
146
147/* Special section indexes. */
148#define SHN_UNDEF 0 /* Undefined, missing, irrelevant. */
149#define SHN_LORESERVE 0xff00 /* First of reserved range. */
150#define SHN_LOPROC 0xff00 /* First processor-specific. */
151#define SHN_HIPROC 0xff1f /* Last processor-specific. */
152#define SHN_ABS 0xfff1 /* Absolute values. */
153#define SHN_COMMON 0xfff2 /* Common data. */
154#define SHN_HIRESERVE 0xffff /* Last of reserved range. */
155
156/* sh_type */
157#define SHT_NULL 0 /* inactive */
158#define SHT_PROGBITS 1 /* program defined information */
159#define SHT_SYMTAB 2 /* symbol table section */
160#define SHT_STRTAB 3 /* string table section */
161#define SHT_RELA 4 /* relocation section with addends */
162#define SHT_HASH 5 /* symbol hash table section */
163#define SHT_DYNAMIC 6 /* dynamic section */
164#define SHT_NOTE 7 /* note section */
165#define SHT_NOBITS 8 /* no space section */
166#define SHT_REL 9 /* relocation section - no addends */
167#define SHT_SHLIB 10 /* reserved - purpose unknown */
168#define SHT_DYNSYM 11 /* dynamic symbol table section */
169#define SHT_NUM 12 /* number of section types */
170#define SHT_LOOS 0x60000000 /* First of OS specific semantics */
171#define SHT_HIOS 0x6fffffff /* Last of OS specific semantics */
172#define SHT_LOPROC 0x70000000 /* reserved range for processor */
173#define SHT_HIPROC 0x7fffffff /* specific section header types */
174#define SHT_LOUSER 0x80000000 /* reserved range for application */
175#define SHT_HIUSER 0xffffffff /* specific indexes */
176
177/* Flags for sh_flags. */
178#define SHF_WRITE 0x1 /* Section contains writable data. */
179#define SHF_ALLOC 0x2 /* Section occupies memory. */
180#define SHF_EXECINSTR 0x4 /* Section contains instructions. */
181#define SHF_TLS 0x400 /* Section contains TLS data. */
182#define SHF_MASKPROC 0xf0000000 /* Reserved for processor-specific. */
183
184/* Values for p_type. */
185#define PT_NULL 0 /* Unused entry. */
186#define PT_LOAD 1 /* Loadable segment. */
187#define PT_DYNAMIC 2 /* Dynamic linking information segment. */
188#define PT_INTERP 3 /* Pathname of interpreter. */
189#define PT_NOTE 4 /* Auxiliary information. */
190#define PT_SHLIB 5 /* Reserved (not used). */
191#define PT_PHDR 6 /* Location of program header itself. */
192#define PT_TLS 7 /* Thread local storage segment */
193
194#define PT_COUNT 8 /* Number of defined p_type values. */
195
196#define PT_LOOS 0x60000000 /* OS-specific */
197#define PT_HIOS 0x6fffffff /* OS-specific */
198#define PT_LOPROC 0x70000000 /* First processor-specific type. */
199#define PT_HIPROC 0x7fffffff /* Last processor-specific type. */
200
201#define PT_GNU_EH_FRAME 0x6474e550 /**< GNU/Linux -> .eh_frame_hdr */
202#define PT_GNU_STACK 0x6474e551 /**< GNU/Linux -> stack prot (RWX or RW) */
203#define PT_GNU_RELRO 0x6474e552 /**< GNU/Linux -> make RO after relocations */
204#define PT_GNU_PROPERTY 0x6474e553 /**< GNU/Linux -> .note.gnu.property */
205
206
207/* Values for p_flags. */
208#define PF_X 0x1 /* Executable. */
209#define PF_W 0x2 /* Writable. */
210#define PF_R 0x4 /* Readable. */
211
212/* Values for d_tag. */
213#define DT_NULL 0 /* Terminating entry. */
214#define DT_NEEDED 1 /* String table offset of a needed shared
215 library. */
216#define DT_PLTRELSZ 2 /* Total size in bytes of PLT relocations. */
217#define DT_PLTGOT 3 /* Processor-dependent address. */
218#define DT_HASH 4 /* Address of symbol hash table. */
219#define DT_STRTAB 5 /* Address of string table. */
220#define DT_SYMTAB 6 /* Address of symbol table. */
221#define DT_RELA 7 /* Address of ElfNN_Rela relocations. */
222#define DT_RELASZ 8 /* Total size of ElfNN_Rela relocations. */
223#define DT_RELAENT 9 /* Size of each ElfNN_Rela relocation entry. */
224#define DT_STRSZ 10 /* Size of string table. */
225#define DT_SYMENT 11 /* Size of each symbol table entry. */
226#define DT_INIT 12 /* Address of initialization function. */
227#define DT_FINI 13 /* Address of finalization function. */
228#define DT_SONAME 14 /* String table offset of shared object
229 name. */
230#define DT_RPATH 15 /* String table offset of library path. [sup] */
231#define DT_SYMBOLIC 16 /* Indicates "symbolic" linking. [sup] */
232#define DT_REL 17 /* Address of ElfNN_Rel relocations. */
233#define DT_RELSZ 18 /* Total size of ElfNN_Rel relocations. */
234#define DT_RELENT 19 /* Size of each ElfNN_Rel relocation. */
235#define DT_PLTREL 20 /* Type of relocation used for PLT. */
236#define DT_DEBUG 21 /* Reserved (not used). */
237#define DT_TEXTREL 22 /* Indicates there may be relocations in
238 non-writable segments. [sup] */
239#define DT_JMPREL 23 /* Address of PLT relocations. */
240#define DT_BIND_NOW 24 /* [sup] */
241#define DT_INIT_ARRAY 25 /* Address of the array of pointers to
242 initialization functions */
243#define DT_FINI_ARRAY 26 /* Address of the array of pointers to
244 termination functions */
245#define DT_INIT_ARRAYSZ 27 /* Size in bytes of the array of
246 initialization functions. */
247#define DT_FINI_ARRAYSZ 28 /* Size in bytes of the array of
248 terminationfunctions. */
249#define DT_RUNPATH 29 /* String table offset of a null-terminated
250 library search path string. */
251#define DT_FLAGS 30 /* Object specific flag values. */
252#define DT_ENCODING 32 /* Values greater than or equal to DT_ENCODING
253 and less than DT_LOOS follow the rules for
254 the interpretation of the d_un union
255 as follows: even == 'd_ptr', even == 'd_val'
256 or none */
257#define DT_PREINIT_ARRAY 32 /* Address of the array of pointers to
258 pre-initialization functions. */
259#define DT_PREINIT_ARRAYSZ 33 /* Size in bytes of the array of
260 pre-initialization functions. */
261
262#define DT_COUNT 33 /* Number of defined d_tag values. */
263
264#define DT_LOOS 0x6000000d /* First OS-specific */
265#define DT_HIOS 0x6fff0000 /* Last OS-specific */
266#define DT_LOPROC 0x70000000 /* First processor-specific type. */
267#define DT_HIPROC 0x7fffffff /* Last processor-specific type. */
268
269/* Values for DT_FLAGS */
270#define DF_ORIGIN 0x0001 /* Indicates that the object being loaded may
271 make reference to the $ORIGIN substitution
272 string */
273#define DF_SYMBOLIC 0x0002 /* Indicates "symbolic" linking. */
274#define DF_TEXTREL 0x0004 /* Indicates there may be relocations in
275 non-writable segments. */
276#define DF_BIND_NOW 0x0008 /* Indicates that the dynamic linker should
277 process all relocations for the object
278 containing this entry before transferring
279 control to the program. */
280#define DF_STATIC_TLS 0x0010 /* Indicates that the shared object or
281 executable contains code using a static
282 thread-local storage scheme. */
283
284/* Values for n_type. Used in core files. */
285#if defined(RT_OS_FREEBSD)
286# define NT_PRSTATUS 1 /* Process status. */
287# define NT_FPREGSET 2 /* Floating point registers. */
288# define NT_PRPSINFO 3 /* Process state info. */
289#elif defined(RT_OS_SOLARIS)
290# define NT_PRSTATUS 1 /* prstatus_t <sys/old_procfs.h> */
291# define NT_PRFPREG 2 /* prfpregset_t <sys/old_procfs.h> */
292# define NT_PRPSINFO 3 /* prpsinfo_t <sys/old_procfs.h> */
293# define NT_PRXREG 4 /* prxregset_t <sys/procfs.h> */
294# define NT_PLATFORM 5 /* string from sysinfo(SI_PLATFORM) */
295# define NT_AUXV 6 /* auxv_t array <sys/auxv.h> */
296# define NT_LDT 9 /* ssd array <sys/sysi86.h> IA32 only */
297# define NT_PSTATUS 10 /* pstatus_t <sys/procfs.h> */
298# define NT_PSINFO 13 /* psinfo_t <sys/procfs.h> */
299# define NT_PRCRED 14 /* prcred_t <sys/procfs.h> */
300# define NT_UTSNAME 15 /* struct utsname <sys/utsname.h> */
301# define NT_LWPSTATUS 16 /* lwpstatus_t <sys/procfs.h> */
302# define NT_LWPSINFO 17 /* lwpsinfo_t <sys/procfs.h> */
303# define NT_PRPRIV 18 /* prpriv_t <sys/procfs.h> */
304# define NT_PRPRIVINFO 19 /* priv_impl_info_t <sys/priv.h> */
305# define NT_CONTENT 20 /* core_content_t <sys/corectl.h> */
306# define NT_ZONENAME 21 /* string from getzonenamebyid(3C) */
307# define PF_SUNW_FAILURE 0x00100000 /* mapping absent due to failure */
308# define PN_XNUM 0xffff /* extended program header index */
309#elif defined(RT_OS_LINUX)
310# define NT_PRSTATUS 1 /* Process status. */
311# define NT_PRFPREG 2 /* Floating point registers. */
312# define NT_PRPSINFO 3 /* Process state info. */
313# define NT_TASKSTRUCT 4 /* Task info. */
314# define NT_AUXV 6 /* Process auxiliary vectors. */
315# define NT_PRXFPREG 0x46e62b7f /* from gdb5.1/include/elf/common.h */
316#endif
317/* GNU Build ID in a dedicated section. */
318#define NT_GNU_BUILD_ID 3
319
320/* VirtualBox specific NOTE sections (added by Ramshankar) */
321#ifdef VBOX
322# define NT_VBOXCORE 0xb00
323# define NT_VBOXCPU 0xb01
324#endif
325
326/* Symbol Binding - ELFNN_ST_BIND - st_info */
327#define STB_LOCAL 0 /* Local symbol */
328#define STB_GLOBAL 1 /* Global symbol */
329#define STB_WEAK 2 /* like global - lower precedence */
330#define STB_LOPROC 13 /* reserved range for processor */
331#define STB_HIPROC 15 /* specific symbol bindings */
332
333/* Symbol type - ELFNN_ST_TYPE - st_info */
334#define STT_NOTYPE 0 /* Unspecified type. */
335#define STT_OBJECT 1 /* Data object. */
336#define STT_FUNC 2 /* Function. */
337#define STT_SECTION 3 /* Section. */
338#define STT_FILE 4 /* Source file. */
339#define STT_TLS 6 /* TLS object. */
340#define STT_NUM 7 /* Number of generic symbol types. */
341#define STT_LOPROC 13 /* reserved range for processor */
342#define STT_HIPROC 15 /* specific symbol types */
343
344/* Special symbol table indexes. */
345#define STN_UNDEF 0 /* Undefined symbol index. */
346
347#endif /* !IPRT_INCLUDED_formats_elf_common_h */
348
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette