Fix spelling and sort CMakeLists.txt.
[oota-llvm.git] / include / llvm / Support / ELF.h
1 //===-- llvm/Support/ELF.h - ELF constants and data structures --*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This header contains common, non-processor-specific data structures and
11 // constants for the ELF file format.
12 //
13 // The details of the ELF32 bits in this file are largely based on the Tool
14 // Interface Standard (TIS) Executable and Linking Format (ELF) Specification
15 // Version 1.2, May 1995. The ELF64 stuff is based on ELF-64 Object File Format
16 // Version 1.5, Draft 2, May 1998 as well as OpenBSD header files.
17 //
18 //===----------------------------------------------------------------------===//
19
20 #ifndef LLVM_SUPPORT_ELF_H
21 #define LLVM_SUPPORT_ELF_H
22
23 #include "llvm/Support/DataTypes.h"
24 #include <cstring>
25
26 namespace llvm {
27
28 namespace ELF {
29
30 typedef uint32_t Elf32_Addr; // Program address
31 typedef uint16_t Elf32_Half;
32 typedef uint32_t Elf32_Off;  // File offset
33 typedef int32_t  Elf32_Sword;
34 typedef uint32_t Elf32_Word;
35
36 typedef uint64_t Elf64_Addr;
37 typedef uint64_t Elf64_Off;
38 typedef int32_t  Elf64_Shalf;
39 typedef int32_t  Elf64_Sword;
40 typedef uint32_t Elf64_Word;
41 typedef int64_t  Elf64_Sxword;
42 typedef uint64_t Elf64_Xword;
43 typedef uint32_t Elf64_Half;
44 typedef uint16_t Elf64_Quarter;
45
46 // Object file magic string.
47 static const char ElfMagic[] = { 0x7f, 'E', 'L', 'F', '\0' };
48
49 // e_ident size and indices.
50 enum {
51   EI_MAG0       = 0,          // File identification index.
52   EI_MAG1       = 1,          // File identification index.
53   EI_MAG2       = 2,          // File identification index.
54   EI_MAG3       = 3,          // File identification index.
55   EI_CLASS      = 4,          // File class.
56   EI_DATA       = 5,          // Data encoding.
57   EI_VERSION    = 6,          // File version.
58   EI_OSABI      = 7,          // OS/ABI identification.
59   EI_ABIVERSION = 8,          // ABI version.
60   EI_PAD        = 9,          // Start of padding bytes.
61   EI_NIDENT     = 16          // Number of bytes in e_ident.
62 };
63
64 struct Elf32_Ehdr {
65   unsigned char e_ident[EI_NIDENT]; // ELF Identification bytes
66   Elf32_Half    e_type;      // Type of file (see ET_* below)
67   Elf32_Half    e_machine;   // Required architecture for this file (see EM_*)
68   Elf32_Word    e_version;   // Must be equal to 1
69   Elf32_Addr    e_entry;     // Address to jump to in order to start program
70   Elf32_Off     e_phoff;     // Program header table's file offset, in bytes
71   Elf32_Off     e_shoff;     // Section header table's file offset, in bytes
72   Elf32_Word    e_flags;     // Processor-specific flags
73   Elf32_Half    e_ehsize;    // Size of ELF header, in bytes
74   Elf32_Half    e_phentsize; // Size of an entry in the program header table
75   Elf32_Half    e_phnum;     // Number of entries in the program header table
76   Elf32_Half    e_shentsize; // Size of an entry in the section header table
77   Elf32_Half    e_shnum;     // Number of entries in the section header table
78   Elf32_Half    e_shstrndx;  // Sect hdr table index of sect name string table
79   bool checkMagic() const {
80     return (memcmp(e_ident, ElfMagic, strlen(ElfMagic))) == 0;
81   }
82   unsigned char getFileClass() const { return e_ident[EI_CLASS]; }
83   unsigned char getDataEncoding() const { return e_ident[EI_DATA]; }
84 };
85
86 // 64-bit ELF header. Fields are the same as for ELF32, but with different
87 // types (see above).
88 struct Elf64_Ehdr {
89   unsigned char e_ident[EI_NIDENT];
90   Elf64_Quarter e_type;
91   Elf64_Quarter e_machine;
92   Elf64_Half    e_version;
93   Elf64_Addr    e_entry;
94   Elf64_Off     e_phoff;
95   Elf64_Off     e_shoff;
96   Elf64_Half    e_flags;
97   Elf64_Quarter e_ehsize;
98   Elf64_Quarter e_phentsize;
99   Elf64_Quarter e_phnum;
100   Elf64_Quarter e_shentsize;
101   Elf64_Quarter e_shnum;
102   Elf64_Quarter e_shstrndx;
103   bool checkMagic() const {
104     return (memcmp(e_ident, ElfMagic, strlen(ElfMagic))) == 0;
105   }
106   unsigned char getFileClass() const { return e_ident[EI_CLASS]; }
107   unsigned char getDataEncoding() const { return e_ident[EI_DATA]; }
108 };
109
110 // File types
111 enum {
112   ET_NONE   = 0,      // No file type
113   ET_REL    = 1,      // Relocatable file
114   ET_EXEC   = 2,      // Executable file
115   ET_DYN    = 3,      // Shared object file
116   ET_CORE   = 4,      // Core file
117   ET_LOPROC = 0xff00, // Beginning of processor-specific codes
118   ET_HIPROC = 0xffff  // Processor-specific
119 };
120
121 // Versioning
122 enum {
123   EV_NONE = 0,
124   EV_CURRENT = 1
125 };
126
127 // Machine architectures
128 enum {
129   EM_NONE = 0,      // No machine
130   EM_M32 = 1,       // AT&T WE 32100
131   EM_SPARC = 2,     // SPARC
132   EM_386 = 3,       // Intel 386
133   EM_68K = 4,       // Motorola 68000
134   EM_88K = 5,       // Motorola 88000
135   EM_486 = 6,       // Intel 486 (deprecated)
136   EM_860 = 7,       // Intel 80860
137   EM_MIPS = 8,      // MIPS R3000
138   EM_PPC = 20,      // PowerPC
139   EM_PPC64 = 21,    // PowerPC64
140   EM_ARM = 40,      // ARM
141   EM_ALPHA = 41,    // DEC Alpha
142   EM_SPARCV9 = 43,  // SPARC V9
143   EM_X86_64 = 62,   // AMD64
144   EM_MBLAZE = 47787 // Xilinx MicroBlaze
145 };
146
147 // Object file classes.
148 enum {
149   ELFCLASSNONE = 0,
150   ELFCLASS32 = 1, // 32-bit object file
151   ELFCLASS64 = 2  // 64-bit object file
152 };
153
154 // Object file byte orderings.
155 enum {
156   ELFDATANONE = 0, // Invalid data encoding.
157   ELFDATA2LSB = 1, // Little-endian object file
158   ELFDATA2MSB = 2  // Big-endian object file
159 };
160
161 // OS ABI identification.
162 enum {
163   ELFOSABI_NONE = 0,          // UNIX System V ABI
164   ELFOSABI_HPUX = 1,          // HP-UX operating system
165   ELFOSABI_NETBSD = 2,        // NetBSD
166   ELFOSABI_LINUX = 3,         // GNU/Linux
167   ELFOSABI_HURD = 4,          // GNU/Hurd
168   ELFOSABI_SOLARIS = 6,       // Solaris
169   ELFOSABI_AIX = 7,           // AIX
170   ELFOSABI_IRIX = 8,          // IRIX
171   ELFOSABI_FREEBSD = 9,       // FreeBSD
172   ELFOSABI_TRU64 = 10,        // TRU64 UNIX
173   ELFOSABI_MODESTO = 11,      // Novell Modesto
174   ELFOSABI_OPENBSD = 12,      // OpenBSD
175   ELFOSABI_OPENVMS = 13,      // OpenVMS
176   ELFOSABI_NSK = 14,          // Hewlett-Packard Non-Stop Kernel
177   ELFOSABI_AROS = 15,         // AROS
178   ELFOSABI_FENIXOS = 16,      // FenixOS
179   ELFOSABI_C6000_ELFABI = 64, // Bare-metal TMS320C6000
180   ELFOSABI_C6000_LINUX = 65,  // Linux TMS320C6000
181   ELFOSABI_ARM = 97,          // ARM
182   ELFOSABI_STANDALONE = 255   // Standalone (embedded) application
183 };
184
185 // X86_64 relocations.
186 enum {
187   R_X86_64_NONE       = 0,
188   R_X86_64_64         = 1,
189   R_X86_64_PC32       = 2,
190   R_X86_64_GOT32      = 3,
191   R_X86_64_PLT32      = 4,
192   R_X86_64_COPY       = 5,
193   R_X86_64_GLOB_DAT   = 6,
194   R_X86_64_JUMP_SLOT  = 7,
195   R_X86_64_RELATIVE   = 8,
196   R_X86_64_GOTPCREL   = 9,
197   R_X86_64_32         = 10,
198   R_X86_64_32S        = 11,
199   R_X86_64_16         = 12,
200   R_X86_64_PC16       = 13,
201   R_X86_64_8          = 14,
202   R_X86_64_PC8        = 15,
203   R_X86_64_DTPMOD64   = 16,
204   R_X86_64_DTPOFF64   = 17,
205   R_X86_64_TPOFF64    = 18,
206   R_X86_64_TLSGD      = 19,
207   R_X86_64_TLSLD      = 20,
208   R_X86_64_DTPOFF32   = 21,
209   R_X86_64_GOTTPOFF   = 22,
210   R_X86_64_TPOFF32    = 23,
211   R_X86_64_PC64       = 24,
212   R_X86_64_GOTOFF64   = 25,
213   R_X86_64_GOTPC32    = 26,
214   R_X86_64_SIZE32     = 32,
215   R_X86_64_SIZE64     = 33,
216   R_X86_64_GOTPC32_TLSDESC = 34,
217   R_X86_64_TLSDESC_CALL    = 35,
218   R_X86_64_TLSDESC    = 36
219 };
220
221 // i386 relocations.
222 // TODO: this is just a subset
223 enum {
224   R_386_NONE          = 0,
225   R_386_32            = 1,
226   R_386_PC32          = 2,
227   R_386_GOT32         = 3,
228   R_386_PLT32         = 4,
229   R_386_COPY          = 5,
230   R_386_GLOB_DAT      = 6,
231   R_386_JUMP_SLOT     = 7,
232   R_386_RELATIVE      = 8,
233   R_386_GOTOFF        = 9,
234   R_386_GOTPC         = 10,
235   R_386_32PLT         = 11,
236   R_386_TLS_TPOFF     = 14,
237   R_386_TLS_IE        = 15,
238   R_386_TLS_GOTIE     = 16,
239   R_386_TLS_LE        = 17,
240   R_386_TLS_GD        = 18,
241   R_386_TLS_LDM       = 19,
242   R_386_16            = 20,
243   R_386_PC16          = 21,
244   R_386_8             = 22,
245   R_386_PC8           = 23,
246   R_386_TLS_GD_32     = 24,
247   R_386_TLS_GD_PUSH   = 25,
248   R_386_TLS_GD_CALL   = 26,
249   R_386_TLS_GD_POP    = 27,
250   R_386_TLS_LDM_32    = 28,
251   R_386_TLS_LDM_PUSH  = 29,
252   R_386_TLS_LDM_CALL  = 30,
253   R_386_TLS_LDM_POP   = 31,
254   R_386_TLS_LDO_32    = 32,
255   R_386_TLS_IE_32     = 33,
256   R_386_TLS_LE_32     = 34,
257   R_386_TLS_DTPMOD32  = 35,
258   R_386_TLS_DTPOFF32  = 36,
259   R_386_TLS_TPOFF32   = 37,
260   R_386_TLS_GOTDESC   = 39,
261   R_386_TLS_DESC_CALL = 40,
262   R_386_TLS_DESC      = 41,
263   R_386_IRELATIVE     = 42,
264   R_386_NUM           = 43
265 };
266
267 // MBlaze relocations.
268 enum {
269   R_MICROBLAZE_NONE           = 0,
270   R_MICROBLAZE_32             = 1,
271   R_MICROBLAZE_32_PCREL       = 2,
272   R_MICROBLAZE_64_PCREL       = 3,
273   R_MICROBLAZE_32_PCREL_LO    = 4,
274   R_MICROBLAZE_64             = 5,
275   R_MICROBLAZE_32_LO          = 6,
276   R_MICROBLAZE_SRO32          = 7,
277   R_MICROBLAZE_SRW32          = 8,
278   R_MICROBLAZE_64_NONE        = 9,
279   R_MICROBLAZE_32_SYM_OP_SYM  = 10,
280   R_MICROBLAZE_GNU_VTINHERIT  = 11,
281   R_MICROBLAZE_GNU_VTENTRY    = 12,
282   R_MICROBLAZE_GOTPC_64       = 13,
283   R_MICROBLAZE_GOT_64         = 14,
284   R_MICROBLAZE_PLT_64         = 15,
285   R_MICROBLAZE_REL            = 16,
286   R_MICROBLAZE_JUMP_SLOT      = 17,
287   R_MICROBLAZE_GLOB_DAT       = 18,
288   R_MICROBLAZE_GOTOFF_64      = 19,
289   R_MICROBLAZE_GOTOFF_32      = 20,
290   R_MICROBLAZE_COPY           = 21
291 };
292
293
294 // ARM Specific e_flags
295 enum { EF_ARM_EABIMASK = 0xFF000000U };
296
297 // ELF Relocation types for ARM
298 // Meets 2.08 ABI Specs.
299
300 enum {
301   R_ARM_NONE                  = 0x00,
302   R_ARM_PC24                  = 0x01,
303   R_ARM_ABS32                 = 0x02,
304   R_ARM_REL32                 = 0x03,
305   R_ARM_LDR_PC_G0             = 0x04,
306   R_ARM_ABS16                 = 0x05,
307   R_ARM_ABS12                 = 0x06,
308   R_ARM_THM_ABS5              = 0x07,
309   R_ARM_ABS8                  = 0x08,
310   R_ARM_SBREL32               = 0x09,
311   R_ARM_THM_CALL              = 0x0a,
312   R_ARM_THM_PC8               = 0x0b,
313   R_ARM_BREL_ADJ              = 0x0c,
314   R_ARM_TLS_DESC              = 0x0d,
315   R_ARM_THM_SWI8              = 0x0e,
316   R_ARM_XPC25                 = 0x0f,
317   R_ARM_THM_XPC22             = 0x10,
318   R_ARM_TLS_DTPMOD32          = 0x11,
319   R_ARM_TLS_DTPOFF32          = 0x12,
320   R_ARM_TLS_TPOFF32           = 0x13,
321   R_ARM_COPY                  = 0x14,
322   R_ARM_GLOB_DAT              = 0x15,
323   R_ARM_JUMP_SLOT             = 0x16,
324   R_ARM_RELATIVE              = 0x17,
325   R_ARM_GOTOFF32              = 0x18,
326   R_ARM_BASE_PREL             = 0x19,
327   R_ARM_GOT_BREL              = 0x1a,
328   R_ARM_PLT32                 = 0x1b,
329   R_ARM_CALL                  = 0x1c,
330   R_ARM_JUMP24                = 0x1d,
331   R_ARM_THM_JUMP24            = 0x1e,
332   R_ARM_BASE_ABS              = 0x1f,
333   R_ARM_ALU_PCREL_7_0         = 0x20,
334   R_ARM_ALU_PCREL_15_8        = 0x21,
335   R_ARM_ALU_PCREL_23_15       = 0x22,
336   R_ARM_LDR_SBREL_11_0_NC     = 0x23,
337   R_ARM_ALU_SBREL_19_12_NC    = 0x24,
338   R_ARM_ALU_SBREL_27_20_CK    = 0x25,
339   R_ARM_TARGET1               = 0x26,
340   R_ARM_SBREL31               = 0x27,
341   R_ARM_V4BX                  = 0x28,
342   R_ARM_TARGET2               = 0x29,
343   R_ARM_PREL31                = 0x2a,
344   R_ARM_MOVW_ABS_NC           = 0x2b,
345   R_ARM_MOVT_ABS              = 0x2c,
346   R_ARM_MOVW_PREL_NC          = 0x2d,
347   R_ARM_MOVT_PREL             = 0x2e,
348   R_ARM_THM_MOVW_ABS_NC       = 0x2f,
349   R_ARM_THM_MOVT_ABS          = 0x30,
350   R_ARM_THM_MOVW_PREL_NC      = 0x31,
351   R_ARM_THM_MOVT_PREL         = 0x32,
352   R_ARM_THM_JUMP19            = 0x33,
353   R_ARM_THM_JUMP6             = 0x34,
354   R_ARM_THM_ALU_PREL_11_0     = 0x35,
355   R_ARM_THM_PC12              = 0x36,
356   R_ARM_ABS32_NOI             = 0x37,
357   R_ARM_REL32_NOI             = 0x38,
358   R_ARM_ALU_PC_G0_NC          = 0x39,
359   R_ARM_ALU_PC_G0             = 0x3a,
360   R_ARM_ALU_PC_G1_NC          = 0x3b,
361   R_ARM_ALU_PC_G1             = 0x3c,
362   R_ARM_ALU_PC_G2             = 0x3d,
363   R_ARM_LDR_PC_G1             = 0x3e,
364   R_ARM_LDR_PC_G2             = 0x3f,
365   R_ARM_LDRS_PC_G0            = 0x40,
366   R_ARM_LDRS_PC_G1            = 0x41,
367   R_ARM_LDRS_PC_G2            = 0x42,
368   R_ARM_LDC_PC_G0             = 0x43,
369   R_ARM_LDC_PC_G1             = 0x44,
370   R_ARM_LDC_PC_G2             = 0x45,
371   R_ARM_ALU_SB_G0_NC          = 0x46,
372   R_ARM_ALU_SB_G0             = 0x47,
373   R_ARM_ALU_SB_G1_NC          = 0x48,
374   R_ARM_ALU_SB_G1             = 0x49,
375   R_ARM_ALU_SB_G2             = 0x4a,
376   R_ARM_LDR_SB_G0             = 0x4b,
377   R_ARM_LDR_SB_G1             = 0x4c,
378   R_ARM_LDR_SB_G2             = 0x4d,
379   R_ARM_LDRS_SB_G0            = 0x4e,
380   R_ARM_LDRS_SB_G1            = 0x4f,
381   R_ARM_LDRS_SB_G2            = 0x50,
382   R_ARM_LDC_SB_G0             = 0x51,
383   R_ARM_LDC_SB_G1             = 0x52,
384   R_ARM_LDC_SB_G2             = 0x53,
385   R_ARM_MOVW_BREL_NC          = 0x54,
386   R_ARM_MOVT_BREL             = 0x55,
387   R_ARM_MOVW_BREL             = 0x56,
388   R_ARM_THM_MOVW_BREL_NC      = 0x57,
389   R_ARM_THM_MOVT_BREL         = 0x58,
390   R_ARM_THM_MOVW_BREL         = 0x59,
391   R_ARM_TLS_GOTDESC           = 0x5a,
392   R_ARM_TLS_CALL              = 0x5b,
393   R_ARM_TLS_DESCSEQ           = 0x5c,
394   R_ARM_THM_TLS_CALL          = 0x5d,
395   R_ARM_PLT32_ABS             = 0x5e,
396   R_ARM_GOT_ABS               = 0x5f,
397   R_ARM_GOT_PREL              = 0x60,
398   R_ARM_GOT_BREL12            = 0x61,
399   R_ARM_GOTOFF12              = 0x62,
400   R_ARM_GOTRELAX              = 0x63,
401   R_ARM_GNU_VTENTRY           = 0x64,
402   R_ARM_GNU_VTINHERIT         = 0x65,
403   R_ARM_THM_JUMP11            = 0x66,
404   R_ARM_THM_JUMP8             = 0x67,
405   R_ARM_TLS_GD32              = 0x68,
406   R_ARM_TLS_LDM32             = 0x69,
407   R_ARM_TLS_LDO32             = 0x6a,
408   R_ARM_TLS_IE32              = 0x6b,
409   R_ARM_TLS_LE32              = 0x6c,
410   R_ARM_TLS_LDO12             = 0x6d,
411   R_ARM_TLS_LE12              = 0x6e,
412   R_ARM_TLS_IE12GP            = 0x6f,
413   R_ARM_PRIVATE_0             = 0x70,
414   R_ARM_PRIVATE_1             = 0x71,
415   R_ARM_PRIVATE_2             = 0x72,
416   R_ARM_PRIVATE_3             = 0x73,
417   R_ARM_PRIVATE_4             = 0x74,
418   R_ARM_PRIVATE_5             = 0x75,
419   R_ARM_PRIVATE_6             = 0x76,
420   R_ARM_PRIVATE_7             = 0x77,
421   R_ARM_PRIVATE_8             = 0x78,
422   R_ARM_PRIVATE_9             = 0x79,
423   R_ARM_PRIVATE_10            = 0x7a,
424   R_ARM_PRIVATE_11            = 0x7b,
425   R_ARM_PRIVATE_12            = 0x7c,
426   R_ARM_PRIVATE_13            = 0x7d,
427   R_ARM_PRIVATE_14            = 0x7e,
428   R_ARM_PRIVATE_15            = 0x7f,
429   R_ARM_ME_TOO                = 0x80,
430   R_ARM_THM_TLS_DESCSEQ16     = 0x81,
431   R_ARM_THM_TLS_DESCSEQ32     = 0x82
432 };
433
434
435
436 // Section header.
437 struct Elf32_Shdr {
438   Elf32_Word sh_name;      // Section name (index into string table)
439   Elf32_Word sh_type;      // Section type (SHT_*)
440   Elf32_Word sh_flags;     // Section flags (SHF_*)
441   Elf32_Addr sh_addr;      // Address where section is to be loaded
442   Elf32_Off  sh_offset;    // File offset of section data, in bytes
443   Elf32_Word sh_size;      // Size of section, in bytes
444   Elf32_Word sh_link;      // Section type-specific header table index link
445   Elf32_Word sh_info;      // Section type-specific extra information
446   Elf32_Word sh_addralign; // Section address alignment
447   Elf32_Word sh_entsize;   // Size of records contained within the section
448 };
449
450 // Section header for ELF64 - same fields as ELF32, different types.
451 struct Elf64_Shdr {
452   Elf64_Half  sh_name;
453   Elf64_Half  sh_type;
454   Elf64_Xword sh_flags;
455   Elf64_Addr  sh_addr;
456   Elf64_Off   sh_offset;
457   Elf64_Xword sh_size;
458   Elf64_Half  sh_link;
459   Elf64_Half  sh_info;
460   Elf64_Xword sh_addralign;
461   Elf64_Xword sh_entsize;
462 };
463
464 // Special section indices.
465 enum {
466   SHN_UNDEF     = 0,      // Undefined, missing, irrelevant, or meaningless
467   SHN_LORESERVE = 0xff00, // Lowest reserved index
468   SHN_LOPROC    = 0xff00, // Lowest processor-specific index
469   SHN_HIPROC    = 0xff1f, // Highest processor-specific index
470   SHN_ABS       = 0xfff1, // Symbol has absolute value; does not need relocation
471   SHN_COMMON    = 0xfff2, // FORTRAN COMMON or C external global variables
472   SHN_XINDEX    = 0xffff, // Mark that the index is >= SHN_LORESERVE
473   SHN_HIRESERVE = 0xffff  // Highest reserved index
474 };
475
476 // Section types.
477 enum {
478   SHT_NULL          = 0,  // No associated section (inactive entry).
479   SHT_PROGBITS      = 1,  // Program-defined contents.
480   SHT_SYMTAB        = 2,  // Symbol table.
481   SHT_STRTAB        = 3,  // String table.
482   SHT_RELA          = 4,  // Relocation entries; explicit addends.
483   SHT_HASH          = 5,  // Symbol hash table.
484   SHT_DYNAMIC       = 6,  // Information for dynamic linking.
485   SHT_NOTE          = 7,  // Information about the file.
486   SHT_NOBITS        = 8,  // Data occupies no space in the file.
487   SHT_REL           = 9,  // Relocation entries; no explicit addends.
488   SHT_SHLIB         = 10, // Reserved.
489   SHT_DYNSYM        = 11, // Symbol table.
490   SHT_INIT_ARRAY    = 14, // Pointers to initialization functions.
491   SHT_FINI_ARRAY    = 15, // Pointers to termination functions.
492   SHT_PREINIT_ARRAY = 16, // Pointers to pre-init functions.
493   SHT_GROUP         = 17, // Section group.
494   SHT_SYMTAB_SHNDX  = 18, // Indices for SHN_XINDEX entries.
495   SHT_LOOS          = 0x60000000, // Lowest operating system-specific type.
496   SHT_HIOS          = 0x6fffffff, // Highest operating system-specific type.
497   SHT_LOPROC        = 0x70000000, // Lowest processor architecture-specific type.
498   // Fixme: All this is duplicated in MCSectionELF. Why??
499   // Exception Index table
500   SHT_ARM_EXIDX           = 0x70000001U,
501   // BPABI DLL dynamic linking pre-emption map
502   SHT_ARM_PREEMPTMAP      = 0x70000002U,
503   //  Object file compatibility attributes
504   SHT_ARM_ATTRIBUTES      = 0x70000003U,
505   SHT_ARM_DEBUGOVERLAY    = 0x70000004U,
506   SHT_ARM_OVERLAYSECTION  = 0x70000005U,
507
508   SHT_X86_64_UNWIND       = 0x70000001, // Unwind information
509
510   SHT_HIPROC        = 0x7fffffff, // Highest processor architecture-specific type.
511   SHT_LOUSER        = 0x80000000, // Lowest type reserved for applications.
512   SHT_HIUSER        = 0xffffffff  // Highest type reserved for applications.
513 };
514
515 // Section flags.
516 enum {
517   // Section data should be writable during execution.
518   SHF_WRITE = 0x1,
519
520   // Section occupies memory during program execution.
521   SHF_ALLOC = 0x2,
522
523   // Section contains executable machine instructions.
524   SHF_EXECINSTR = 0x4,
525
526   // The data in this section may be merged.
527   SHF_MERGE = 0x10,
528
529   // The data in this section is null-terminated strings.
530   SHF_STRINGS = 0x20,
531
532   // A field in this section holds a section header table index.
533   SHF_INFO_LINK = 0x40U,
534
535   // Adds special ordering requirements for link editors.
536   SHF_LINK_ORDER = 0x80U,
537
538   // This section requires special OS-specific processing to avoid incorrect
539   // behavior.
540   SHF_OS_NONCONFORMING = 0x100U,
541
542   // This section is a member of a section group.
543   SHF_GROUP = 0x200U,
544
545   // This section holds Thread-Local Storage.
546   SHF_TLS = 0x400U,
547
548   // Start of target-specific flags.
549
550   /// XCORE_SHF_CP_SECTION - All sections with the "c" flag are grouped
551   /// together by the linker to form the constant pool and the cp register is
552   /// set to the start of the constant pool by the boot code.
553   XCORE_SHF_CP_SECTION = 0x800U,
554
555   /// XCORE_SHF_DP_SECTION - All sections with the "d" flag are grouped
556   /// together by the linker to form the data section and the dp register is
557   /// set to the start of the section by the boot code.
558   XCORE_SHF_DP_SECTION = 0x1000U,
559
560   // Bits indicating processor-specific flags.
561   SHF_MASKPROC = 0xf0000000
562 };
563
564 // Section Group Flags
565 enum {
566   GRP_COMDAT = 0x1,
567   GRP_MASKOS = 0x0ff00000,
568   GRP_MASKPROC = 0xf0000000
569 };
570
571 // Symbol table entries for ELF32.
572 struct Elf32_Sym {
573   Elf32_Word    st_name;  // Symbol name (index into string table)
574   Elf32_Addr    st_value; // Value or address associated with the symbol
575   Elf32_Word    st_size;  // Size of the symbol
576   unsigned char st_info;  // Symbol's type and binding attributes
577   unsigned char st_other; // Must be zero; reserved
578   Elf32_Half    st_shndx; // Which section (header table index) it's defined in
579
580   // These accessors and mutators correspond to the ELF32_ST_BIND,
581   // ELF32_ST_TYPE, and ELF32_ST_INFO macros defined in the ELF specification:
582   unsigned char getBinding() const { return st_info >> 4; }
583   unsigned char getType() const { return st_info & 0x0f; }
584   void setBinding(unsigned char b) { setBindingAndType(b, getType()); }
585   void setType(unsigned char t) { setBindingAndType(getBinding(), t); }
586   void setBindingAndType(unsigned char b, unsigned char t) {
587     st_info = (b << 4) + (t & 0x0f);
588   }
589 };
590
591 // Symbol table entries for ELF64.
592 struct Elf64_Sym {
593   Elf64_Word      st_name;  // Symbol name (index into string table)
594   unsigned char   st_info;  // Symbol's type and binding attributes
595   unsigned char   st_other; // Must be zero; reserved
596   Elf64_Half      st_shndx; // Which section (header table index) it's defined in
597   Elf64_Addr      st_value; // Value or address associated with the symbol
598   Elf64_Xword     st_size;  // Size of the symbol
599
600   // These accessors and mutators are identical to those defined for ELF32
601   // symbol table entries.
602   unsigned char getBinding() const { return st_info >> 4; }
603   unsigned char getType() const { return st_info & 0x0f; }
604   void setBinding(unsigned char b) { setBindingAndType(b, getType()); }
605   void setType(unsigned char t) { setBindingAndType(getBinding(), t); }
606   void setBindingAndType(unsigned char b, unsigned char t) {
607     st_info = (b << 4) + (t & 0x0f);
608   }
609 };
610
611 // The size (in bytes) of symbol table entries.
612 enum {
613   SYMENTRY_SIZE32 = 16, // 32-bit symbol entry size
614   SYMENTRY_SIZE64 = 24  // 64-bit symbol entry size.
615 };
616
617 // Symbol bindings.
618 enum {
619   STB_LOCAL = 0,   // Local symbol, not visible outside obj file containing def
620   STB_GLOBAL = 1,  // Global symbol, visible to all object files being combined
621   STB_WEAK = 2,    // Weak symbol, like global but lower-precedence
622   STB_LOPROC = 13, // Lowest processor-specific binding type
623   STB_HIPROC = 15  // Highest processor-specific binding type
624 };
625
626 // Symbol types.
627 enum {
628   STT_NOTYPE  = 0,   // Symbol's type is not specified
629   STT_OBJECT  = 1,   // Symbol is a data object (variable, array, etc.)
630   STT_FUNC    = 2,   // Symbol is executable code (function, etc.)
631   STT_SECTION = 3,   // Symbol refers to a section
632   STT_FILE    = 4,   // Local, absolute symbol that refers to a file
633   STT_COMMON  = 5,   // An uninitialized common block
634   STT_TLS     = 6,   // Thread local data object
635   STT_LOPROC  = 13,  // Lowest processor-specific symbol type
636   STT_HIPROC  = 15   // Highest processor-specific symbol type
637 };
638
639 enum {
640   STV_DEFAULT   = 0,  // Visibility is specified by binding type
641   STV_INTERNAL  = 1,  // Defined by processor supplements
642   STV_HIDDEN    = 2,  // Not visible to other components
643   STV_PROTECTED = 3   // Visible in other components but not preemptable
644 };
645
646 // Relocation entry, without explicit addend.
647 struct Elf32_Rel {
648   Elf32_Addr r_offset; // Location (file byte offset, or program virtual addr)
649   Elf32_Word r_info;   // Symbol table index and type of relocation to apply
650
651   // These accessors and mutators correspond to the ELF32_R_SYM, ELF32_R_TYPE,
652   // and ELF32_R_INFO macros defined in the ELF specification:
653   Elf32_Word getSymbol() const { return (r_info >> 8); }
654   unsigned char getType() const { return (unsigned char) (r_info & 0x0ff); }
655   void setSymbol(Elf32_Word s) { setSymbolAndType(s, getType()); }
656   void setType(unsigned char t) { setSymbolAndType(getSymbol(), t); }
657   void setSymbolAndType(Elf32_Word s, unsigned char t) {
658     r_info = (s << 8) + t;
659   }
660 };
661
662 // Relocation entry with explicit addend.
663 struct Elf32_Rela {
664   Elf32_Addr  r_offset; // Location (file byte offset, or program virtual addr)
665   Elf32_Word  r_info;   // Symbol table index and type of relocation to apply
666   Elf32_Sword r_addend; // Compute value for relocatable field by adding this
667
668   // These accessors and mutators correspond to the ELF32_R_SYM, ELF32_R_TYPE,
669   // and ELF32_R_INFO macros defined in the ELF specification:
670   Elf32_Word getSymbol() const { return (r_info >> 8); }
671   unsigned char getType() const { return (unsigned char) (r_info & 0x0ff); }
672   void setSymbol(Elf32_Word s) { setSymbolAndType(s, getType()); }
673   void setType(unsigned char t) { setSymbolAndType(getSymbol(), t); }
674   void setSymbolAndType(Elf32_Word s, unsigned char t) {
675     r_info = (s << 8) + t;
676   }
677 };
678
679 // Relocation entry, without explicit addend.
680 struct Elf64_Rel {
681   Elf64_Addr r_offset; // Location (file byte offset, or program virtual addr).
682   Elf64_Xword r_info;   // Symbol table index and type of relocation to apply.
683
684   // These accessors and mutators correspond to the ELF64_R_SYM, ELF64_R_TYPE,
685   // and ELF64_R_INFO macros defined in the ELF specification:
686   Elf64_Xword getSymbol() const { return (r_info >> 32); }
687   unsigned char getType() const {
688     return (unsigned char) (r_info & 0xffffffffL);
689   }
690   void setSymbol(Elf32_Word s) { setSymbolAndType(s, getType()); }
691   void setType(unsigned char t) { setSymbolAndType(getSymbol(), t); }
692   void setSymbolAndType(Elf64_Xword s, unsigned char t) {
693     r_info = (s << 32) + (t&0xffffffffL);
694   }
695 };
696
697 // Relocation entry with explicit addend.
698 struct Elf64_Rela {
699   Elf64_Addr  r_offset; // Location (file byte offset, or program virtual addr).
700   Elf64_Xword  r_info;   // Symbol table index and type of relocation to apply.
701   Elf64_Sxword r_addend; // Compute value for relocatable field by adding this.
702
703   // These accessors and mutators correspond to the ELF64_R_SYM, ELF64_R_TYPE,
704   // and ELF64_R_INFO macros defined in the ELF specification:
705   Elf64_Xword getSymbol() const { return (r_info >> 32); }
706   unsigned char getType() const {
707     return (unsigned char) (r_info & 0xffffffffL);
708   }
709   void setSymbol(Elf64_Xword s) { setSymbolAndType(s, getType()); }
710   void setType(unsigned char t) { setSymbolAndType(getSymbol(), t); }
711   void setSymbolAndType(Elf64_Xword s, unsigned char t) {
712     r_info = (s << 32) + (t&0xffffffffL);
713   }
714 };
715
716 // Program header for ELF32.
717 struct Elf32_Phdr {
718   Elf32_Word p_type;   // Type of segment
719   Elf32_Off  p_offset; // File offset where segment is located, in bytes
720   Elf32_Addr p_vaddr;  // Virtual address of beginning of segment
721   Elf32_Addr p_paddr;  // Physical address of beginning of segment (OS-specific)
722   Elf32_Word p_filesz; // Num. of bytes in file image of segment (may be zero)
723   Elf32_Word p_memsz;  // Num. of bytes in mem image of segment (may be zero)
724   Elf32_Word p_flags;  // Segment flags
725   Elf32_Word p_align;  // Segment alignment constraint
726 };
727
728 // Program header for ELF64.
729 struct Elf64_Phdr {
730   Elf64_Word   p_type;   // Type of segment
731   Elf64_Word   p_flags;  // Segment flags
732   Elf64_Off    p_offset; // File offset where segment is located, in bytes
733   Elf64_Addr   p_vaddr;  // Virtual address of beginning of segment
734   Elf64_Addr   p_paddr;  // Physical address of beginning of segment (OS-specific)
735   Elf64_Xword  p_filesz; // Num. of bytes in file image of segment (may be zero)
736   Elf64_Xword  p_memsz;  // Num. of bytes in mem image of segment (may be zero)
737   Elf64_Xword  p_align;  // Segment alignment constraint
738 };
739
740 // Segment types.
741 enum {
742   PT_NULL    = 0, // Unused segment.
743   PT_LOAD    = 1, // Loadable segment.
744   PT_DYNAMIC = 2, // Dynamic linking information.
745   PT_INTERP  = 3, // Interpreter pathname.
746   PT_NOTE    = 4, // Auxiliary information.
747   PT_SHLIB   = 5, // Reserved.
748   PT_PHDR    = 6, // The program header table itself.
749   PT_LOPROC  = 0x70000000, // Lowest processor-specific program hdr entry type.
750   PT_HIPROC  = 0x7fffffff  // Highest processor-specific program hdr entry type.
751 };
752
753 // Segment flag bits.
754 enum {
755   PF_X        = 1,         // Execute
756   PF_W        = 2,         // Write
757   PF_R        = 4,         // Read
758   PF_MASKPROC = 0xf0000000 // Unspecified
759 };
760
761 // Dynamic table entry for ELF32.
762 struct Elf32_Dyn
763 {
764   Elf32_Sword d_tag;            // Type of dynamic table entry.
765   union
766   {
767       Elf32_Word d_val;         // Integer value of entry.
768       Elf32_Addr d_ptr;         // Pointer value of entry.
769   } d_un;
770 };
771
772 // Dynamic table entry for ELF64.
773 struct Elf64_Dyn
774 {
775   Elf64_Sxword d_tag;           // Type of dynamic table entry.
776   union
777   {
778       Elf64_Xword d_val;        // Integer value of entry.
779       Elf64_Addr  d_ptr;        // Pointer value of entry.
780   } d_un;
781 };
782
783 // Dynamic table entry tags.
784 enum {
785   DT_NULL         = 0,        // Marks end of dynamic array.
786   DT_NEEDED       = 1,        // String table offset of needed library.
787   DT_PLTRELSZ     = 2,        // Size of relocation entries in PLT.
788   DT_PLTGOT       = 3,        // Address associated with linkage table.
789   DT_HASH         = 4,        // Address of symbolic hash table.
790   DT_STRTAB       = 5,        // Address of dynamic string table.
791   DT_SYMTAB       = 6,        // Address of dynamic symbol table.
792   DT_RELA         = 7,        // Address of relocation table (Rela entries).
793   DT_RELASZ       = 8,        // Size of Rela relocation table.
794   DT_RELAENT      = 9,        // Size of a Rela relocation entry.
795   DT_STRSZ        = 10,       // Total size of the string table.
796   DT_SYMENT       = 11,       // Size of a symbol table entry.
797   DT_INIT         = 12,       // Address of initialization function.
798   DT_FINI         = 13,       // Address of termination function.
799   DT_SONAME       = 14,       // String table offset of a shared objects name.
800   DT_RPATH        = 15,       // String table offset of library search path.
801   DT_SYMBOLIC     = 16,       // Changes symbol resolution algorithm.
802   DT_REL          = 17,       // Address of relocation table (Rel entries).
803   DT_RELSZ        = 18,       // Size of Rel relocation table.
804   DT_RELENT       = 19,       // Size of a Rel relocation entry.
805   DT_PLTREL       = 20,       // Type of relocation entry used for linking.
806   DT_DEBUG        = 21,       // Reserved for debugger.
807   DT_TEXTREL      = 22,       // Relocations exist for non-writable segments.
808   DT_JMPREL       = 23,       // Address of relocations associated with PLT.
809   DT_BIND_NOW     = 24,       // Process all relocations before execution.
810   DT_INIT_ARRAY   = 25,       // Pointer to array of initialization functions.
811   DT_FINI_ARRAY   = 26,       // Pointer to array of termination functions.
812   DT_INIT_ARRAYSZ = 27,       // Size of DT_INIT_ARRAY.
813   DT_FINI_ARRAYSZ = 28,       // Size of DT_FINI_ARRAY.
814   DT_LOOS         = 0x60000000, // Start of environment specific tags.
815   DT_HIOS         = 0x6FFFFFFF, // End of environment specific tags.
816   DT_LOPROC       = 0x70000000, // Start of processor specific tags.
817   DT_HIPROC       = 0x7FFFFFFF  // End of processor specific tags.
818 };
819
820 } // end namespace ELF
821
822 } // end namespace llvm
823
824 #endif