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/Compiler.h"
24#include "llvm/Support/DataTypes.h"
25#include <cstring>
26
27namespace llvm {
28
29namespace ELF {
30
31typedef uint32_t Elf32_Addr; // Program address
32typedef uint32_t Elf32_Off;  // File offset
33typedef uint16_t Elf32_Half;
34typedef uint32_t Elf32_Word;
35typedef int32_t  Elf32_Sword;
36
37typedef uint64_t Elf64_Addr;
38typedef uint64_t Elf64_Off;
39typedef uint16_t Elf64_Half;
40typedef uint32_t Elf64_Word;
41typedef int32_t  Elf64_Sword;
42typedef uint64_t Elf64_Xword;
43typedef int64_t  Elf64_Sxword;
44
45// Object file magic string.
46static const char ElfMagic[] = { 0x7f, 'E', 'L', 'F', '\0' };
47
48// e_ident size and indices.
49enum {
50  EI_MAG0       = 0,          // File identification index.
51  EI_MAG1       = 1,          // File identification index.
52  EI_MAG2       = 2,          // File identification index.
53  EI_MAG3       = 3,          // File identification index.
54  EI_CLASS      = 4,          // File class.
55  EI_DATA       = 5,          // Data encoding.
56  EI_VERSION    = 6,          // File version.
57  EI_OSABI      = 7,          // OS/ABI identification.
58  EI_ABIVERSION = 8,          // ABI version.
59  EI_PAD        = 9,          // Start of padding bytes.
60  EI_NIDENT     = 16          // Number of bytes in e_ident.
61};
62
63struct Elf32_Ehdr {
64  unsigned char e_ident[EI_NIDENT]; // ELF Identification bytes
65  Elf32_Half    e_type;      // Type of file (see ET_* below)
66  Elf32_Half    e_machine;   // Required architecture for this file (see EM_*)
67  Elf32_Word    e_version;   // Must be equal to 1
68  Elf32_Addr    e_entry;     // Address to jump to in order to start program
69  Elf32_Off     e_phoff;     // Program header table's file offset, in bytes
70  Elf32_Off     e_shoff;     // Section header table's file offset, in bytes
71  Elf32_Word    e_flags;     // Processor-specific flags
72  Elf32_Half    e_ehsize;    // Size of ELF header, in bytes
73  Elf32_Half    e_phentsize; // Size of an entry in the program header table
74  Elf32_Half    e_phnum;     // Number of entries in the program header table
75  Elf32_Half    e_shentsize; // Size of an entry in the section header table
76  Elf32_Half    e_shnum;     // Number of entries in the section header table
77  Elf32_Half    e_shstrndx;  // Sect hdr table index of sect name string table
78  bool checkMagic() const {
79    return (memcmp(e_ident, ElfMagic, strlen(ElfMagic))) == 0;
80  }
81  unsigned char getFileClass() const { return e_ident[EI_CLASS]; }
82  unsigned char getDataEncoding() const { return e_ident[EI_DATA]; }
83};
84
85// 64-bit ELF header. Fields are the same as for ELF32, but with different
86// types (see above).
87struct Elf64_Ehdr {
88  unsigned char e_ident[EI_NIDENT];
89  Elf64_Half    e_type;
90  Elf64_Half    e_machine;
91  Elf64_Word    e_version;
92  Elf64_Addr    e_entry;
93  Elf64_Off     e_phoff;
94  Elf64_Off     e_shoff;
95  Elf64_Word    e_flags;
96  Elf64_Half    e_ehsize;
97  Elf64_Half    e_phentsize;
98  Elf64_Half    e_phnum;
99  Elf64_Half    e_shentsize;
100  Elf64_Half    e_shnum;
101  Elf64_Half    e_shstrndx;
102  bool checkMagic() const {
103    return (memcmp(e_ident, ElfMagic, strlen(ElfMagic))) == 0;
104  }
105  unsigned char getFileClass() const { return e_ident[EI_CLASS]; }
106  unsigned char getDataEncoding() const { return e_ident[EI_DATA]; }
107};
108
109// File types
110enum {
111  ET_NONE   = 0,      // No file type
112  ET_REL    = 1,      // Relocatable file
113  ET_EXEC   = 2,      // Executable file
114  ET_DYN    = 3,      // Shared object file
115  ET_CORE   = 4,      // Core file
116  ET_LOPROC = 0xff00, // Beginning of processor-specific codes
117  ET_HIPROC = 0xffff  // Processor-specific
118};
119
120// Versioning
121enum {
122  EV_NONE = 0,
123  EV_CURRENT = 1
124};
125
126// Machine architectures
127// See current registered ELF machine architectures at:
128//    http://www.uxsglobal.com/developers/gabi/latest/ch4.eheader.html
129enum {
130  EM_NONE          = 0, // No machine
131  EM_M32           = 1, // AT&T WE 32100
132  EM_SPARC         = 2, // SPARC
133  EM_386           = 3, // Intel 386
134  EM_68K           = 4, // Motorola 68000
135  EM_88K           = 5, // Motorola 88000
136  EM_486           = 6, // Intel 486 (deprecated)
137  EM_860           = 7, // Intel 80860
138  EM_MIPS          = 8, // MIPS R3000
139  EM_S370          = 9, // IBM System/370
140  EM_MIPS_RS3_LE   = 10, // MIPS RS3000 Little-endian
141  EM_PARISC        = 15, // Hewlett-Packard PA-RISC
142  EM_VPP500        = 17, // Fujitsu VPP500
143  EM_SPARC32PLUS   = 18, // Enhanced instruction set SPARC
144  EM_960           = 19, // Intel 80960
145  EM_PPC           = 20, // PowerPC
146  EM_PPC64         = 21, // PowerPC64
147  EM_S390          = 22, // IBM System/390
148  EM_SPU           = 23, // IBM SPU/SPC
149  EM_V800          = 36, // NEC V800
150  EM_FR20          = 37, // Fujitsu FR20
151  EM_RH32          = 38, // TRW RH-32
152  EM_RCE           = 39, // Motorola RCE
153  EM_ARM           = 40, // ARM
154  EM_ALPHA         = 41, // DEC Alpha
155  EM_SH            = 42, // Hitachi SH
156  EM_SPARCV9       = 43, // SPARC V9
157  EM_TRICORE       = 44, // Siemens TriCore
158  EM_ARC           = 45, // Argonaut RISC Core
159  EM_H8_300        = 46, // Hitachi H8/300
160  EM_H8_300H       = 47, // Hitachi H8/300H
161  EM_H8S           = 48, // Hitachi H8S
162  EM_H8_500        = 49, // Hitachi H8/500
163  EM_IA_64         = 50, // Intel IA-64 processor architecture
164  EM_MIPS_X        = 51, // Stanford MIPS-X
165  EM_COLDFIRE      = 52, // Motorola ColdFire
166  EM_68HC12        = 53, // Motorola M68HC12
167  EM_MMA           = 54, // Fujitsu MMA Multimedia Accelerator
168  EM_PCP           = 55, // Siemens PCP
169  EM_NCPU          = 56, // Sony nCPU embedded RISC processor
170  EM_NDR1          = 57, // Denso NDR1 microprocessor
171  EM_STARCORE      = 58, // Motorola Star*Core processor
172  EM_ME16          = 59, // Toyota ME16 processor
173  EM_ST100         = 60, // STMicroelectronics ST100 processor
174  EM_TINYJ         = 61, // Advanced Logic Corp. TinyJ embedded processor family
175  EM_X86_64        = 62, // AMD x86-64 architecture
176  EM_PDSP          = 63, // Sony DSP Processor
177  EM_PDP10         = 64, // Digital Equipment Corp. PDP-10
178  EM_PDP11         = 65, // Digital Equipment Corp. PDP-11
179  EM_FX66          = 66, // Siemens FX66 microcontroller
180  EM_ST9PLUS       = 67, // STMicroelectronics ST9+ 8/16 bit microcontroller
181  EM_ST7           = 68, // STMicroelectronics ST7 8-bit microcontroller
182  EM_68HC16        = 69, // Motorola MC68HC16 Microcontroller
183  EM_68HC11        = 70, // Motorola MC68HC11 Microcontroller
184  EM_68HC08        = 71, // Motorola MC68HC08 Microcontroller
185  EM_68HC05        = 72, // Motorola MC68HC05 Microcontroller
186  EM_SVX           = 73, // Silicon Graphics SVx
187  EM_ST19          = 74, // STMicroelectronics ST19 8-bit microcontroller
188  EM_VAX           = 75, // Digital VAX
189  EM_CRIS          = 76, // Axis Communications 32-bit embedded processor
190  EM_JAVELIN       = 77, // Infineon Technologies 32-bit embedded processor
191  EM_FIREPATH      = 78, // Element 14 64-bit DSP Processor
192  EM_ZSP           = 79, // LSI Logic 16-bit DSP Processor
193  EM_MMIX          = 80, // Donald Knuth's educational 64-bit processor
194  EM_HUANY         = 81, // Harvard University machine-independent object files
195  EM_PRISM         = 82, // SiTera Prism
196  EM_AVR           = 83, // Atmel AVR 8-bit microcontroller
197  EM_FR30          = 84, // Fujitsu FR30
198  EM_D10V          = 85, // Mitsubishi D10V
199  EM_D30V          = 86, // Mitsubishi D30V
200  EM_V850          = 87, // NEC v850
201  EM_M32R          = 88, // Mitsubishi M32R
202  EM_MN10300       = 89, // Matsushita MN10300
203  EM_MN10200       = 90, // Matsushita MN10200
204  EM_PJ            = 91, // picoJava
205  EM_OPENRISC      = 92, // OpenRISC 32-bit embedded processor
206  EM_ARC_COMPACT   = 93, // ARC International ARCompact processor (old
207                         // spelling/synonym: EM_ARC_A5)
208  EM_XTENSA        = 94, // Tensilica Xtensa Architecture
209  EM_VIDEOCORE     = 95, // Alphamosaic VideoCore processor
210  EM_TMM_GPP       = 96, // Thompson Multimedia General Purpose Processor
211  EM_NS32K         = 97, // National Semiconductor 32000 series
212  EM_TPC           = 98, // Tenor Network TPC processor
213  EM_SNP1K         = 99, // Trebia SNP 1000 processor
214  EM_ST200         = 100, // STMicroelectronics (www.st.com) ST200
215  EM_IP2K          = 101, // Ubicom IP2xxx microcontroller family
216  EM_MAX           = 102, // MAX Processor
217  EM_CR            = 103, // National Semiconductor CompactRISC microprocessor
218  EM_F2MC16        = 104, // Fujitsu F2MC16
219  EM_MSP430        = 105, // Texas Instruments embedded microcontroller msp430
220  EM_BLACKFIN      = 106, // Analog Devices Blackfin (DSP) processor
221  EM_SE_C33        = 107, // S1C33 Family of Seiko Epson processors
222  EM_SEP           = 108, // Sharp embedded microprocessor
223  EM_ARCA          = 109, // Arca RISC Microprocessor
224  EM_UNICORE       = 110, // Microprocessor series from PKU-Unity Ltd. and MPRC
225                          // of Peking University
226  EM_EXCESS        = 111, // eXcess: 16/32/64-bit configurable embedded CPU
227  EM_DXP           = 112, // Icera Semiconductor Inc. Deep Execution Processor
228  EM_ALTERA_NIOS2  = 113, // Altera Nios II soft-core processor
229  EM_CRX           = 114, // National Semiconductor CompactRISC CRX
230  EM_XGATE         = 115, // Motorola XGATE embedded processor
231  EM_C166          = 116, // Infineon C16x/XC16x processor
232  EM_M16C          = 117, // Renesas M16C series microprocessors
233  EM_DSPIC30F      = 118, // Microchip Technology dsPIC30F Digital Signal
234                          // Controller
235  EM_CE            = 119, // Freescale Communication Engine RISC core
236  EM_M32C          = 120, // Renesas M32C series microprocessors
237  EM_TSK3000       = 131, // Altium TSK3000 core
238  EM_RS08          = 132, // Freescale RS08 embedded processor
239  EM_SHARC         = 133, // Analog Devices SHARC family of 32-bit DSP
240                          // processors
241  EM_ECOG2         = 134, // Cyan Technology eCOG2 microprocessor
242  EM_SCORE7        = 135, // Sunplus S+core7 RISC processor
243  EM_DSP24         = 136, // New Japan Radio (NJR) 24-bit DSP Processor
244  EM_VIDEOCORE3    = 137, // Broadcom VideoCore III processor
245  EM_LATTICEMICO32 = 138, // RISC processor for Lattice FPGA architecture
246  EM_SE_C17        = 139, // Seiko Epson C17 family
247  EM_TI_C6000      = 140, // The Texas Instruments TMS320C6000 DSP family
248  EM_TI_C2000      = 141, // The Texas Instruments TMS320C2000 DSP family
249  EM_TI_C5500      = 142, // The Texas Instruments TMS320C55x DSP family
250  EM_MMDSP_PLUS    = 160, // STMicroelectronics 64bit VLIW Data Signal Processor
251  EM_CYPRESS_M8C   = 161, // Cypress M8C microprocessor
252  EM_R32C          = 162, // Renesas R32C series microprocessors
253  EM_TRIMEDIA      = 163, // NXP Semiconductors TriMedia architecture family
254  EM_HEXAGON       = 164, // Qualcomm Hexagon processor
255  EM_8051          = 165, // Intel 8051 and variants
256  EM_STXP7X        = 166, // STMicroelectronics STxP7x family of configurable
257                          // and extensible RISC processors
258  EM_NDS32         = 167, // Andes Technology compact code size embedded RISC
259                          // processor family
260  EM_ECOG1         = 168, // Cyan Technology eCOG1X family
261  EM_ECOG1X        = 168, // Cyan Technology eCOG1X family
262  EM_MAXQ30        = 169, // Dallas Semiconductor MAXQ30 Core Micro-controllers
263  EM_XIMO16        = 170, // New Japan Radio (NJR) 16-bit DSP Processor
264  EM_MANIK         = 171, // M2000 Reconfigurable RISC Microprocessor
265  EM_CRAYNV2       = 172, // Cray Inc. NV2 vector architecture
266  EM_RX            = 173, // Renesas RX family
267  EM_METAG         = 174, // Imagination Technologies META processor
268                          // architecture
269  EM_MCST_ELBRUS   = 175, // MCST Elbrus general purpose hardware architecture
270  EM_ECOG16        = 176, // Cyan Technology eCOG16 family
271  EM_CR16          = 177, // National Semiconductor CompactRISC CR16 16-bit
272                          // microprocessor
273  EM_ETPU          = 178, // Freescale Extended Time Processing Unit
274  EM_SLE9X         = 179, // Infineon Technologies SLE9X core
275  EM_L10M          = 180, // Intel L10M
276  EM_K10M          = 181, // Intel K10M
277  EM_AARCH64       = 183, // ARM AArch64
278  EM_AVR32         = 185, // Atmel Corporation 32-bit microprocessor family
279  EM_STM8          = 186, // STMicroeletronics STM8 8-bit microcontroller
280  EM_TILE64        = 187, // Tilera TILE64 multicore architecture family
281  EM_TILEPRO       = 188, // Tilera TILEPro multicore architecture family
282  EM_CUDA          = 190, // NVIDIA CUDA architecture
283  EM_TILEGX        = 191, // Tilera TILE-Gx multicore architecture family
284  EM_CLOUDSHIELD   = 192, // CloudShield architecture family
285  EM_COREA_1ST     = 193, // KIPO-KAIST Core-A 1st generation processor family
286  EM_COREA_2ND     = 194, // KIPO-KAIST Core-A 2nd generation processor family
287  EM_ARC_COMPACT2  = 195, // Synopsys ARCompact V2
288  EM_OPEN8         = 196, // Open8 8-bit RISC soft processor core
289  EM_RL78          = 197, // Renesas RL78 family
290  EM_VIDEOCORE5    = 198, // Broadcom VideoCore V processor
291  EM_78KOR         = 199, // Renesas 78KOR family
292  EM_56800EX       = 200, // Freescale 56800EX Digital Signal Controller (DSC)
293  EM_BA1           = 201, // Beyond BA1 CPU architecture
294  EM_BA2           = 202, // Beyond BA2 CPU architecture
295  EM_XCORE         = 203, // XMOS xCORE processor family
296  EM_MCHP_PIC      = 204, // Microchip 8-bit PIC(r) family
297  EM_INTEL205      = 205, // Reserved by Intel
298  EM_INTEL206      = 206, // Reserved by Intel
299  EM_INTEL207      = 207, // Reserved by Intel
300  EM_INTEL208      = 208, // Reserved by Intel
301  EM_INTEL209      = 209, // Reserved by Intel
302  EM_KM32          = 210, // KM211 KM32 32-bit processor
303  EM_KMX32         = 211, // KM211 KMX32 32-bit processor
304  EM_KMX16         = 212, // KM211 KMX16 16-bit processor
305  EM_KMX8          = 213, // KM211 KMX8 8-bit processor
306  EM_KVARC         = 214, // KM211 KVARC processor
307  EM_CDP           = 215, // Paneve CDP architecture family
308  EM_COGE          = 216, // Cognitive Smart Memory Processor
309  EM_COOL          = 217, // iCelero CoolEngine
310  EM_NORC          = 218, // Nanoradio Optimized RISC
311  EM_CSR_KALIMBA   = 219  // CSR Kalimba architecture family
312};
313
314// Object file classes.
315enum {
316  ELFCLASSNONE = 0,
317  ELFCLASS32 = 1, // 32-bit object file
318  ELFCLASS64 = 2  // 64-bit object file
319};
320
321// Object file byte orderings.
322enum {
323  ELFDATANONE = 0, // Invalid data encoding.
324  ELFDATA2LSB = 1, // Little-endian object file
325  ELFDATA2MSB = 2  // Big-endian object file
326};
327
328// OS ABI identification.
329enum {
330  ELFOSABI_NONE = 0,          // UNIX System V ABI
331  ELFOSABI_HPUX = 1,          // HP-UX operating system
332  ELFOSABI_NETBSD = 2,        // NetBSD
333  ELFOSABI_GNU = 3,           // GNU/Linux
334  ELFOSABI_LINUX = 3,         // Historical alias for ELFOSABI_GNU.
335  ELFOSABI_HURD = 4,          // GNU/Hurd
336  ELFOSABI_SOLARIS = 6,       // Solaris
337  ELFOSABI_AIX = 7,           // AIX
338  ELFOSABI_IRIX = 8,          // IRIX
339  ELFOSABI_FREEBSD = 9,       // FreeBSD
340  ELFOSABI_TRU64 = 10,        // TRU64 UNIX
341  ELFOSABI_MODESTO = 11,      // Novell Modesto
342  ELFOSABI_OPENBSD = 12,      // OpenBSD
343  ELFOSABI_OPENVMS = 13,      // OpenVMS
344  ELFOSABI_NSK = 14,          // Hewlett-Packard Non-Stop Kernel
345  ELFOSABI_AROS = 15,         // AROS
346  ELFOSABI_FENIXOS = 16,      // FenixOS
347  ELFOSABI_CLOUDABI = 17,     // Nuxi CloudABI
348  ELFOSABI_C6000_ELFABI = 64, // Bare-metal TMS320C6000
349  ELFOSABI_C6000_LINUX = 65,  // Linux TMS320C6000
350  ELFOSABI_ARM = 97,          // ARM
351  ELFOSABI_STANDALONE = 255   // Standalone (embedded) application
352};
353
354#define ELF_RELOC(name, value) name = value,
355
356// X86_64 relocations.
357enum {
358#include "ELFRelocs/x86_64.def"
359};
360
361// i386 relocations.
362enum {
363#include "ELFRelocs/i386.def"
364};
365
366// ELF Relocation types for PPC32
367enum {
368#include "ELFRelocs/PowerPC.def"
369};
370
371// Specific e_flags for PPC64
372enum {
373  // e_flags bits specifying ABI:
374  // 1 for original ABI using function descriptors,
375  // 2 for revised ABI without function descriptors,
376  // 0 for unspecified or not using any features affected by the differences.
377  EF_PPC64_ABI = 3
378};
379
380// Special values for the st_other field in the symbol table entry for PPC64.
381enum {
382  STO_PPC64_LOCAL_BIT = 5,
383  STO_PPC64_LOCAL_MASK = (7 << STO_PPC64_LOCAL_BIT)
384};
385static inline int64_t
386decodePPC64LocalEntryOffset(unsigned Other) {
387  unsigned Val = (Other & STO_PPC64_LOCAL_MASK) >> STO_PPC64_LOCAL_BIT;
388  return ((1 << Val) >> 2) << 2;
389}
390static inline unsigned
391encodePPC64LocalEntryOffset(int64_t Offset) {
392  unsigned Val = (Offset >= 4 * 4
393                  ? (Offset >= 8 * 4
394                     ? (Offset >= 16 * 4 ? 6 : 5)
395                     : 4)
396                  : (Offset >= 2 * 4
397                     ? 3
398                     : (Offset >= 1 * 4 ? 2 : 0)));
399  return Val << STO_PPC64_LOCAL_BIT;
400}
401
402// ELF Relocation types for PPC64
403enum {
404#include "ELFRelocs/PowerPC64.def"
405};
406
407// ELF Relocation types for AArch64
408enum {
409#include "ELFRelocs/AArch64.def"
410};
411
412// ARM Specific e_flags
413enum : unsigned {
414  EF_ARM_SOFT_FLOAT =     0x00000200U,
415  EF_ARM_VFP_FLOAT =      0x00000400U,
416  EF_ARM_EABI_UNKNOWN =   0x00000000U,
417  EF_ARM_EABI_VER1 =      0x01000000U,
418  EF_ARM_EABI_VER2 =      0x02000000U,
419  EF_ARM_EABI_VER3 =      0x03000000U,
420  EF_ARM_EABI_VER4 =      0x04000000U,
421  EF_ARM_EABI_VER5 =      0x05000000U,
422  EF_ARM_EABIMASK =       0xFF000000U
423};
424
425// ELF Relocation types for ARM
426enum {
427#include "ELFRelocs/ARM.def"
428};
429
430// Mips Specific e_flags
431enum : unsigned {
432  EF_MIPS_NOREORDER = 0x00000001, // Don't reorder instructions
433  EF_MIPS_PIC       = 0x00000002, // Position independent code
434  EF_MIPS_CPIC      = 0x00000004, // Call object with Position independent code
435  EF_MIPS_ABI2      = 0x00000020,
436  EF_MIPS_32BITMODE = 0x00000100,
437  EF_MIPS_NAN2008   = 0x00000400, // Uses IEE 754-2008 NaN encoding
438
439  // ABI flags
440  EF_MIPS_ABI_O32   = 0x00001000, // This file follows the first MIPS 32 bit ABI
441  EF_MIPS_ABI_O64    = 0x00002000, // O32 ABI extended for 64-bit architecture.
442  EF_MIPS_ABI_EABI32 = 0x00003000, // EABI in 32 bit mode.
443  EF_MIPS_ABI_EABI64 = 0x00004000, // EABI in 64 bit mode.
444  EF_MIPS_ABI        = 0x0000f000, // Mask for selecting EF_MIPS_ABI_ variant.
445
446  //ARCH_ASE
447  EF_MIPS_MICROMIPS = 0x02000000, // microMIPS
448  EF_MIPS_ARCH_ASE_M16 =
449                      0x04000000, // Has Mips-16 ISA extensions
450  //ARCH
451  EF_MIPS_ARCH_1    = 0x00000000, // MIPS1 instruction set
452  EF_MIPS_ARCH_2    = 0x10000000, // MIPS2 instruction set
453  EF_MIPS_ARCH_3    = 0x20000000, // MIPS3 instruction set
454  EF_MIPS_ARCH_4    = 0x30000000, // MIPS4 instruction set
455  EF_MIPS_ARCH_5    = 0x40000000, // MIPS5 instruction set
456  EF_MIPS_ARCH_32   = 0x50000000, // MIPS32 instruction set per linux not elf.h
457  EF_MIPS_ARCH_64   = 0x60000000, // MIPS64 instruction set per linux not elf.h
458  EF_MIPS_ARCH_32R2 = 0x70000000, // mips32r2, mips32r3, mips32r5
459  EF_MIPS_ARCH_64R2 = 0x80000000, // mips64r2, mips64r3, mips64r5
460  EF_MIPS_ARCH_32R6 = 0x90000000, // mips32r6
461  EF_MIPS_ARCH_64R6 = 0xa0000000, // mips64r6
462  EF_MIPS_ARCH      = 0xf0000000  // Mask for applying EF_MIPS_ARCH_ variant
463};
464
465// ELF Relocation types for Mips
466enum {
467#include "ELFRelocs/Mips.def"
468};
469
470// Special values for the st_other field in the symbol table entry for MIPS.
471enum {
472  STO_MIPS_OPTIONAL        = 0x04,  // Symbol whose definition is optional
473  STO_MIPS_PLT             = 0x08,  // PLT entry related dynamic table record
474  STO_MIPS_PIC             = 0x20,  // PIC func in an object mixes PIC/non-PIC
475  STO_MIPS_MICROMIPS       = 0x80,  // MIPS Specific ISA for MicroMips
476  STO_MIPS_MIPS16          = 0xf0   // MIPS Specific ISA for Mips16
477};
478
479// .MIPS.options section descriptor kinds
480enum {
481  ODK_NULL       = 0,   // Undefined
482  ODK_REGINFO    = 1,   // Register usage information
483  ODK_EXCEPTIONS = 2,   // Exception processing options
484  ODK_PAD        = 3,   // Section padding options
485  ODK_HWPATCH    = 4,   // Hardware patches applied
486  ODK_FILL       = 5,   // Linker fill value
487  ODK_TAGS       = 6,   // Space for tool identification
488  ODK_HWAND      = 7,   // Hardware AND patches applied
489  ODK_HWOR       = 8,   // Hardware OR patches applied
490  ODK_GP_GROUP   = 9,   // GP group to use for text/data sections
491  ODK_IDENT      = 10,  // ID information
492  ODK_PAGESIZE   = 11   // Page size information
493};
494
495// Hexagon Specific e_flags
496// Release 5 ABI
497enum {
498  // Object processor version flags, bits[3:0]
499  EF_HEXAGON_MACH_V2      = 0x00000001,   // Hexagon V2
500  EF_HEXAGON_MACH_V3      = 0x00000002,   // Hexagon V3
501  EF_HEXAGON_MACH_V4      = 0x00000003,   // Hexagon V4
502  EF_HEXAGON_MACH_V5      = 0x00000004,   // Hexagon V5
503
504  // Highest ISA version flags
505  EF_HEXAGON_ISA_MACH     = 0x00000000,   // Same as specified in bits[3:0]
506                                          // of e_flags
507  EF_HEXAGON_ISA_V2       = 0x00000010,   // Hexagon V2 ISA
508  EF_HEXAGON_ISA_V3       = 0x00000020,   // Hexagon V3 ISA
509  EF_HEXAGON_ISA_V4       = 0x00000030,   // Hexagon V4 ISA
510  EF_HEXAGON_ISA_V5       = 0x00000040    // Hexagon V5 ISA
511};
512
513// Hexagon specific Section indexes for common small data
514// Release 5 ABI
515enum {
516  SHN_HEXAGON_SCOMMON     = 0xff00,       // Other access sizes
517  SHN_HEXAGON_SCOMMON_1   = 0xff01,       // Byte-sized access
518  SHN_HEXAGON_SCOMMON_2   = 0xff02,       // Half-word-sized access
519  SHN_HEXAGON_SCOMMON_4   = 0xff03,       // Word-sized access
520  SHN_HEXAGON_SCOMMON_8   = 0xff04        // Double-word-size access
521};
522
523// ELF Relocation types for Hexagon
524enum {
525#include "ELFRelocs/Hexagon.def"
526};
527
528// ELF Relocation types for S390/zSeries
529enum {
530#include "ELFRelocs/SystemZ.def"
531};
532
533// ELF Relocation type for Sparc.
534enum {
535#include "ELFRelocs/Sparc.def"
536};
537
538#undef ELF_RELOC
539
540// Section header.
541struct Elf32_Shdr {
542  Elf32_Word sh_name;      // Section name (index into string table)
543  Elf32_Word sh_type;      // Section type (SHT_*)
544  Elf32_Word sh_flags;     // Section flags (SHF_*)
545  Elf32_Addr sh_addr;      // Address where section is to be loaded
546  Elf32_Off  sh_offset;    // File offset of section data, in bytes
547  Elf32_Word sh_size;      // Size of section, in bytes
548  Elf32_Word sh_link;      // Section type-specific header table index link
549  Elf32_Word sh_info;      // Section type-specific extra information
550  Elf32_Word sh_addralign; // Section address alignment
551  Elf32_Word sh_entsize;   // Size of records contained within the section
552};
553
554// Section header for ELF64 - same fields as ELF32, different types.
555struct Elf64_Shdr {
556  Elf64_Word  sh_name;
557  Elf64_Word  sh_type;
558  Elf64_Xword sh_flags;
559  Elf64_Addr  sh_addr;
560  Elf64_Off   sh_offset;
561  Elf64_Xword sh_size;
562  Elf64_Word  sh_link;
563  Elf64_Word  sh_info;
564  Elf64_Xword sh_addralign;
565  Elf64_Xword sh_entsize;
566};
567
568// Special section indices.
569enum {
570  SHN_UNDEF     = 0,      // Undefined, missing, irrelevant, or meaningless
571  SHN_LORESERVE = 0xff00, // Lowest reserved index
572  SHN_LOPROC    = 0xff00, // Lowest processor-specific index
573  SHN_HIPROC    = 0xff1f, // Highest processor-specific index
574  SHN_LOOS      = 0xff20, // Lowest operating system-specific index
575  SHN_HIOS      = 0xff3f, // Highest operating system-specific index
576  SHN_ABS       = 0xfff1, // Symbol has absolute value; does not need relocation
577  SHN_COMMON    = 0xfff2, // FORTRAN COMMON or C external global variables
578  SHN_XINDEX    = 0xffff, // Mark that the index is >= SHN_LORESERVE
579  SHN_HIRESERVE = 0xffff  // Highest reserved index
580};
581
582// Section types.
583enum : unsigned {
584  SHT_NULL          = 0,  // No associated section (inactive entry).
585  SHT_PROGBITS      = 1,  // Program-defined contents.
586  SHT_SYMTAB        = 2,  // Symbol table.
587  SHT_STRTAB        = 3,  // String table.
588  SHT_RELA          = 4,  // Relocation entries; explicit addends.
589  SHT_HASH          = 5,  // Symbol hash table.
590  SHT_DYNAMIC       = 6,  // Information for dynamic linking.
591  SHT_NOTE          = 7,  // Information about the file.
592  SHT_NOBITS        = 8,  // Data occupies no space in the file.
593  SHT_REL           = 9,  // Relocation entries; no explicit addends.
594  SHT_SHLIB         = 10, // Reserved.
595  SHT_DYNSYM        = 11, // Symbol table.
596  SHT_INIT_ARRAY    = 14, // Pointers to initialization functions.
597  SHT_FINI_ARRAY    = 15, // Pointers to termination functions.
598  SHT_PREINIT_ARRAY = 16, // Pointers to pre-init functions.
599  SHT_GROUP         = 17, // Section group.
600  SHT_SYMTAB_SHNDX  = 18, // Indices for SHN_XINDEX entries.
601  SHT_LOOS          = 0x60000000, // Lowest operating system-specific type.
602  SHT_GNU_ATTRIBUTES= 0x6ffffff5, // Object attributes.
603  SHT_GNU_HASH      = 0x6ffffff6, // GNU-style hash table.
604  SHT_GNU_verdef    = 0x6ffffffd, // GNU version definitions.
605  SHT_GNU_verneed   = 0x6ffffffe, // GNU version references.
606  SHT_GNU_versym    = 0x6fffffff, // GNU symbol versions table.
607  SHT_HIOS          = 0x6fffffff, // Highest operating system-specific type.
608  SHT_LOPROC        = 0x70000000, // Lowest processor arch-specific type.
609  // Fixme: All this is duplicated in MCSectionELF. Why??
610  // Exception Index table
611  SHT_ARM_EXIDX           = 0x70000001U,
612  // BPABI DLL dynamic linking pre-emption map
613  SHT_ARM_PREEMPTMAP      = 0x70000002U,
614  //  Object file compatibility attributes
615  SHT_ARM_ATTRIBUTES      = 0x70000003U,
616  SHT_ARM_DEBUGOVERLAY    = 0x70000004U,
617  SHT_ARM_OVERLAYSECTION  = 0x70000005U,
618  SHT_HEX_ORDERED         = 0x70000000, // Link editor is to sort the entries in
619                                        // this section based on their sizes
620  SHT_X86_64_UNWIND       = 0x70000001, // Unwind information
621
622  SHT_MIPS_REGINFO        = 0x70000006, // Register usage information
623  SHT_MIPS_OPTIONS        = 0x7000000d, // General options
624  SHT_MIPS_ABIFLAGS       = 0x7000002a, // ABI information.
625
626  SHT_HIPROC        = 0x7fffffff, // Highest processor arch-specific type.
627  SHT_LOUSER        = 0x80000000, // Lowest type reserved for applications.
628  SHT_HIUSER        = 0xffffffff  // Highest type reserved for applications.
629};
630
631// Section flags.
632enum : unsigned {
633  // Section data should be writable during execution.
634  SHF_WRITE = 0x1,
635
636  // Section occupies memory during program execution.
637  SHF_ALLOC = 0x2,
638
639  // Section contains executable machine instructions.
640  SHF_EXECINSTR = 0x4,
641
642  // The data in this section may be merged.
643  SHF_MERGE = 0x10,
644
645  // The data in this section is null-terminated strings.
646  SHF_STRINGS = 0x20,
647
648  // A field in this section holds a section header table index.
649  SHF_INFO_LINK = 0x40U,
650
651  // Adds special ordering requirements for link editors.
652  SHF_LINK_ORDER = 0x80U,
653
654  // This section requires special OS-specific processing to avoid incorrect
655  // behavior.
656  SHF_OS_NONCONFORMING = 0x100U,
657
658  // This section is a member of a section group.
659  SHF_GROUP = 0x200U,
660
661  // This section holds Thread-Local Storage.
662  SHF_TLS = 0x400U,
663
664  // This section is excluded from the final executable or shared library.
665  SHF_EXCLUDE = 0x80000000U,
666
667  // Start of target-specific flags.
668
669  /// XCORE_SHF_CP_SECTION - All sections with the "c" flag are grouped
670  /// together by the linker to form the constant pool and the cp register is
671  /// set to the start of the constant pool by the boot code.
672  XCORE_SHF_CP_SECTION = 0x800U,
673
674  /// XCORE_SHF_DP_SECTION - All sections with the "d" flag are grouped
675  /// together by the linker to form the data section and the dp register is
676  /// set to the start of the section by the boot code.
677  XCORE_SHF_DP_SECTION = 0x1000U,
678
679  SHF_MASKOS   = 0x0ff00000,
680
681  // Bits indicating processor-specific flags.
682  SHF_MASKPROC = 0xf0000000,
683
684  // If an object file section does not have this flag set, then it may not hold
685  // more than 2GB and can be freely referred to in objects using smaller code
686  // models. Otherwise, only objects using larger code models can refer to them.
687  // For example, a medium code model object can refer to data in a section that
688  // sets this flag besides being able to refer to data in a section that does
689  // not set it; likewise, a small code model object can refer only to code in a
690  // section that does not set this flag.
691  SHF_X86_64_LARGE = 0x10000000,
692
693  // All sections with the GPREL flag are grouped into a global data area
694  // for faster accesses
695  SHF_HEX_GPREL = 0x10000000,
696
697  // Section contains text/data which may be replicated in other sections.
698  // Linker must retain only one copy.
699  SHF_MIPS_NODUPES = 0x01000000,
700
701  // Linker must generate implicit hidden weak names.
702  SHF_MIPS_NAMES   = 0x02000000,
703
704  // Section data local to process.
705  SHF_MIPS_LOCAL   = 0x04000000,
706
707  // Do not strip this section.
708  SHF_MIPS_NOSTRIP = 0x08000000,
709
710  // Section must be part of global data area.
711  SHF_MIPS_GPREL   = 0x10000000,
712
713  // This section should be merged.
714  SHF_MIPS_MERGE   = 0x20000000,
715
716  // Address size to be inferred from section entry size.
717  SHF_MIPS_ADDR    = 0x40000000,
718
719  // Section data is string data by default.
720  SHF_MIPS_STRING  = 0x80000000
721};
722
723// Section Group Flags
724enum : unsigned {
725  GRP_COMDAT = 0x1,
726  GRP_MASKOS = 0x0ff00000,
727  GRP_MASKPROC = 0xf0000000
728};
729
730// Symbol table entries for ELF32.
731struct Elf32_Sym {
732  Elf32_Word    st_name;  // Symbol name (index into string table)
733  Elf32_Addr    st_value; // Value or address associated with the symbol
734  Elf32_Word    st_size;  // Size of the symbol
735  unsigned char st_info;  // Symbol's type and binding attributes
736  unsigned char st_other; // Must be zero; reserved
737  Elf32_Half    st_shndx; // Which section (header table index) it's defined in
738
739  // These accessors and mutators correspond to the ELF32_ST_BIND,
740  // ELF32_ST_TYPE, and ELF32_ST_INFO macros defined in the ELF specification:
741  unsigned char getBinding() const { return st_info >> 4; }
742  unsigned char getType() const { return st_info & 0x0f; }
743  void setBinding(unsigned char b) { setBindingAndType(b, getType()); }
744  void setType(unsigned char t) { setBindingAndType(getBinding(), t); }
745  void setBindingAndType(unsigned char b, unsigned char t) {
746    st_info = (b << 4) + (t & 0x0f);
747  }
748};
749
750// Symbol table entries for ELF64.
751struct Elf64_Sym {
752  Elf64_Word      st_name;  // Symbol name (index into string table)
753  unsigned char   st_info;  // Symbol's type and binding attributes
754  unsigned char   st_other; // Must be zero; reserved
755  Elf64_Half      st_shndx; // Which section (header tbl index) it's defined in
756  Elf64_Addr      st_value; // Value or address associated with the symbol
757  Elf64_Xword     st_size;  // Size of the symbol
758
759  // These accessors and mutators are identical to those defined for ELF32
760  // symbol table entries.
761  unsigned char getBinding() const { return st_info >> 4; }
762  unsigned char getType() const { return st_info & 0x0f; }
763  void setBinding(unsigned char b) { setBindingAndType(b, getType()); }
764  void setType(unsigned char t) { setBindingAndType(getBinding(), t); }
765  void setBindingAndType(unsigned char b, unsigned char t) {
766    st_info = (b << 4) + (t & 0x0f);
767  }
768};
769
770// The size (in bytes) of symbol table entries.
771enum {
772  SYMENTRY_SIZE32 = 16, // 32-bit symbol entry size
773  SYMENTRY_SIZE64 = 24  // 64-bit symbol entry size.
774};
775
776// Symbol bindings.
777enum {
778  STB_LOCAL = 0,   // Local symbol, not visible outside obj file containing def
779  STB_GLOBAL = 1,  // Global symbol, visible to all object files being combined
780  STB_WEAK = 2,    // Weak symbol, like global but lower-precedence
781  STB_GNU_UNIQUE = 10,
782  STB_LOOS   = 10, // Lowest operating system-specific binding type
783  STB_HIOS   = 12, // Highest operating system-specific binding type
784  STB_LOPROC = 13, // Lowest processor-specific binding type
785  STB_HIPROC = 15  // Highest processor-specific binding type
786};
787
788// Symbol types.
789enum {
790  STT_NOTYPE  = 0,   // Symbol's type is not specified
791  STT_OBJECT  = 1,   // Symbol is a data object (variable, array, etc.)
792  STT_FUNC    = 2,   // Symbol is executable code (function, etc.)
793  STT_SECTION = 3,   // Symbol refers to a section
794  STT_FILE    = 4,   // Local, absolute symbol that refers to a file
795  STT_COMMON  = 5,   // An uninitialized common block
796  STT_TLS     = 6,   // Thread local data object
797  STT_LOOS    = 7,   // Lowest operating system-specific symbol type
798  STT_HIOS    = 8,   // Highest operating system-specific symbol type
799  STT_GNU_IFUNC = 10, // GNU indirect function
800  STT_LOPROC  = 13,  // Lowest processor-specific symbol type
801  STT_HIPROC  = 15   // Highest processor-specific symbol type
802};
803
804enum {
805  STV_DEFAULT   = 0,  // Visibility is specified by binding type
806  STV_INTERNAL  = 1,  // Defined by processor supplements
807  STV_HIDDEN    = 2,  // Not visible to other components
808  STV_PROTECTED = 3   // Visible in other components but not preemptable
809};
810
811// Symbol number.
812enum {
813  STN_UNDEF = 0
814};
815
816// Special relocation symbols used in the MIPS64 ELF relocation entries
817enum {
818  RSS_UNDEF = 0, // None
819  RSS_GP = 1,    // Value of gp
820  RSS_GP0 = 2,   // Value of gp used to create object being relocated
821  RSS_LOC = 3    // Address of location being relocated
822};
823
824// Relocation entry, without explicit addend.
825struct Elf32_Rel {
826  Elf32_Addr r_offset; // Location (file byte offset, or program virtual addr)
827  Elf32_Word r_info;   // Symbol table index and type of relocation to apply
828
829  // These accessors and mutators correspond to the ELF32_R_SYM, ELF32_R_TYPE,
830  // and ELF32_R_INFO macros defined in the ELF specification:
831  Elf32_Word getSymbol() const { return (r_info >> 8); }
832  unsigned char getType() const { return (unsigned char) (r_info & 0x0ff); }
833  void setSymbol(Elf32_Word s) { setSymbolAndType(s, getType()); }
834  void setType(unsigned char t) { setSymbolAndType(getSymbol(), t); }
835  void setSymbolAndType(Elf32_Word s, unsigned char t) {
836    r_info = (s << 8) + t;
837  }
838};
839
840// Relocation entry with explicit addend.
841struct Elf32_Rela {
842  Elf32_Addr  r_offset; // Location (file byte offset, or program virtual addr)
843  Elf32_Word  r_info;   // Symbol table index and type of relocation to apply
844  Elf32_Sword r_addend; // Compute value for relocatable field by adding this
845
846  // These accessors and mutators correspond to the ELF32_R_SYM, ELF32_R_TYPE,
847  // and ELF32_R_INFO macros defined in the ELF specification:
848  Elf32_Word getSymbol() const { return (r_info >> 8); }
849  unsigned char getType() const { return (unsigned char) (r_info & 0x0ff); }
850  void setSymbol(Elf32_Word s) { setSymbolAndType(s, getType()); }
851  void setType(unsigned char t) { setSymbolAndType(getSymbol(), t); }
852  void setSymbolAndType(Elf32_Word s, unsigned char t) {
853    r_info = (s << 8) + t;
854  }
855};
856
857// Relocation entry, without explicit addend.
858struct Elf64_Rel {
859  Elf64_Addr r_offset; // Location (file byte offset, or program virtual addr).
860  Elf64_Xword r_info;   // Symbol table index and type of relocation to apply.
861
862  // These accessors and mutators correspond to the ELF64_R_SYM, ELF64_R_TYPE,
863  // and ELF64_R_INFO macros defined in the ELF specification:
864  Elf64_Word getSymbol() const { return (r_info >> 32); }
865  Elf64_Word getType() const {
866    return (Elf64_Word) (r_info & 0xffffffffL);
867  }
868  void setSymbol(Elf64_Word s) { setSymbolAndType(s, getType()); }
869  void setType(Elf64_Word t) { setSymbolAndType(getSymbol(), t); }
870  void setSymbolAndType(Elf64_Word s, Elf64_Word t) {
871    r_info = ((Elf64_Xword)s << 32) + (t&0xffffffffL);
872  }
873};
874
875// Relocation entry with explicit addend.
876struct Elf64_Rela {
877  Elf64_Addr  r_offset; // Location (file byte offset, or program virtual addr).
878  Elf64_Xword  r_info;   // Symbol table index and type of relocation to apply.
879  Elf64_Sxword r_addend; // Compute value for relocatable field by adding this.
880
881  // These accessors and mutators correspond to the ELF64_R_SYM, ELF64_R_TYPE,
882  // and ELF64_R_INFO macros defined in the ELF specification:
883  Elf64_Word getSymbol() const { return (r_info >> 32); }
884  Elf64_Word getType() const {
885    return (Elf64_Word) (r_info & 0xffffffffL);
886  }
887  void setSymbol(Elf64_Word s) { setSymbolAndType(s, getType()); }
888  void setType(Elf64_Word t) { setSymbolAndType(getSymbol(), t); }
889  void setSymbolAndType(Elf64_Word s, Elf64_Word t) {
890    r_info = ((Elf64_Xword)s << 32) + (t&0xffffffffL);
891  }
892};
893
894// Program header for ELF32.
895struct Elf32_Phdr {
896  Elf32_Word p_type;   // Type of segment
897  Elf32_Off  p_offset; // File offset where segment is located, in bytes
898  Elf32_Addr p_vaddr;  // Virtual address of beginning of segment
899  Elf32_Addr p_paddr;  // Physical address of beginning of segment (OS-specific)
900  Elf32_Word p_filesz; // Num. of bytes in file image of segment (may be zero)
901  Elf32_Word p_memsz;  // Num. of bytes in mem image of segment (may be zero)
902  Elf32_Word p_flags;  // Segment flags
903  Elf32_Word p_align;  // Segment alignment constraint
904};
905
906// Program header for ELF64.
907struct Elf64_Phdr {
908  Elf64_Word   p_type;   // Type of segment
909  Elf64_Word   p_flags;  // Segment flags
910  Elf64_Off    p_offset; // File offset where segment is located, in bytes
911  Elf64_Addr   p_vaddr;  // Virtual address of beginning of segment
912  Elf64_Addr   p_paddr;  // Physical addr of beginning of segment (OS-specific)
913  Elf64_Xword  p_filesz; // Num. of bytes in file image of segment (may be zero)
914  Elf64_Xword  p_memsz;  // Num. of bytes in mem image of segment (may be zero)
915  Elf64_Xword  p_align;  // Segment alignment constraint
916};
917
918// Segment types.
919enum {
920  PT_NULL    = 0, // Unused segment.
921  PT_LOAD    = 1, // Loadable segment.
922  PT_DYNAMIC = 2, // Dynamic linking information.
923  PT_INTERP  = 3, // Interpreter pathname.
924  PT_NOTE    = 4, // Auxiliary information.
925  PT_SHLIB   = 5, // Reserved.
926  PT_PHDR    = 6, // The program header table itself.
927  PT_TLS     = 7, // The thread-local storage template.
928  PT_LOOS    = 0x60000000, // Lowest operating system-specific pt entry type.
929  PT_HIOS    = 0x6fffffff, // Highest operating system-specific pt entry type.
930  PT_LOPROC  = 0x70000000, // Lowest processor-specific program hdr entry type.
931  PT_HIPROC  = 0x7fffffff, // Highest processor-specific program hdr entry type.
932
933  // x86-64 program header types.
934  // These all contain stack unwind tables.
935  PT_GNU_EH_FRAME  = 0x6474e550,
936  PT_SUNW_EH_FRAME = 0x6474e550,
937  PT_SUNW_UNWIND   = 0x6464e550,
938
939  PT_GNU_STACK  = 0x6474e551, // Indicates stack executability.
940  PT_GNU_RELRO  = 0x6474e552, // Read-only after relocation.
941
942  // ARM program header types.
943  PT_ARM_ARCHEXT = 0x70000000, // Platform architecture compatibility info
944  // These all contain stack unwind tables.
945  PT_ARM_EXIDX   = 0x70000001,
946  PT_ARM_UNWIND  = 0x70000001,
947
948  // MIPS program header types.
949  PT_MIPS_REGINFO  = 0x70000000,  // Register usage information.
950  PT_MIPS_RTPROC   = 0x70000001,  // Runtime procedure table.
951  PT_MIPS_OPTIONS  = 0x70000002,  // Options segment.
952  PT_MIPS_ABIFLAGS = 0x70000003   // Abiflags segment.
953};
954
955// Segment flag bits.
956enum : unsigned {
957  PF_X        = 1,         // Execute
958  PF_W        = 2,         // Write
959  PF_R        = 4,         // Read
960  PF_MASKOS   = 0x0ff00000,// Bits for operating system-specific semantics.
961  PF_MASKPROC = 0xf0000000 // Bits for processor-specific semantics.
962};
963
964// Dynamic table entry for ELF32.
965struct Elf32_Dyn
966{
967  Elf32_Sword d_tag;            // Type of dynamic table entry.
968  union
969  {
970      Elf32_Word d_val;         // Integer value of entry.
971      Elf32_Addr d_ptr;         // Pointer value of entry.
972  } d_un;
973};
974
975// Dynamic table entry for ELF64.
976struct Elf64_Dyn
977{
978  Elf64_Sxword d_tag;           // Type of dynamic table entry.
979  union
980  {
981      Elf64_Xword d_val;        // Integer value of entry.
982      Elf64_Addr  d_ptr;        // Pointer value of entry.
983  } d_un;
984};
985
986// Dynamic table entry tags.
987enum {
988  DT_NULL         = 0,        // Marks end of dynamic array.
989  DT_NEEDED       = 1,        // String table offset of needed library.
990  DT_PLTRELSZ     = 2,        // Size of relocation entries in PLT.
991  DT_PLTGOT       = 3,        // Address associated with linkage table.
992  DT_HASH         = 4,        // Address of symbolic hash table.
993  DT_STRTAB       = 5,        // Address of dynamic string table.
994  DT_SYMTAB       = 6,        // Address of dynamic symbol table.
995  DT_RELA         = 7,        // Address of relocation table (Rela entries).
996  DT_RELASZ       = 8,        // Size of Rela relocation table.
997  DT_RELAENT      = 9,        // Size of a Rela relocation entry.
998  DT_STRSZ        = 10,       // Total size of the string table.
999  DT_SYMENT       = 11,       // Size of a symbol table entry.
1000  DT_INIT         = 12,       // Address of initialization function.
1001  DT_FINI         = 13,       // Address of termination function.
1002  DT_SONAME       = 14,       // String table offset of a shared objects name.
1003  DT_RPATH        = 15,       // String table offset of library search path.
1004  DT_SYMBOLIC     = 16,       // Changes symbol resolution algorithm.
1005  DT_REL          = 17,       // Address of relocation table (Rel entries).
1006  DT_RELSZ        = 18,       // Size of Rel relocation table.
1007  DT_RELENT       = 19,       // Size of a Rel relocation entry.
1008  DT_PLTREL       = 20,       // Type of relocation entry used for linking.
1009  DT_DEBUG        = 21,       // Reserved for debugger.
1010  DT_TEXTREL      = 22,       // Relocations exist for non-writable segments.
1011  DT_JMPREL       = 23,       // Address of relocations associated with PLT.
1012  DT_BIND_NOW     = 24,       // Process all relocations before execution.
1013  DT_INIT_ARRAY   = 25,       // Pointer to array of initialization functions.
1014  DT_FINI_ARRAY   = 26,       // Pointer to array of termination functions.
1015  DT_INIT_ARRAYSZ = 27,       // Size of DT_INIT_ARRAY.
1016  DT_FINI_ARRAYSZ = 28,       // Size of DT_FINI_ARRAY.
1017  DT_RUNPATH      = 29,       // String table offset of lib search path.
1018  DT_FLAGS        = 30,       // Flags.
1019  DT_ENCODING     = 32,       // Values from here to DT_LOOS follow the rules
1020                              // for the interpretation of the d_un union.
1021
1022  DT_PREINIT_ARRAY = 32,      // Pointer to array of preinit functions.
1023  DT_PREINIT_ARRAYSZ = 33,    // Size of the DT_PREINIT_ARRAY array.
1024
1025  DT_LOOS         = 0x60000000, // Start of environment specific tags.
1026  DT_HIOS         = 0x6FFFFFFF, // End of environment specific tags.
1027  DT_LOPROC       = 0x70000000, // Start of processor specific tags.
1028  DT_HIPROC       = 0x7FFFFFFF, // End of processor specific tags.
1029
1030  DT_GNU_HASH     = 0x6FFFFEF5, // Reference to the GNU hash table.
1031  DT_RELACOUNT    = 0x6FFFFFF9, // ELF32_Rela count.
1032  DT_RELCOUNT     = 0x6FFFFFFA, // ELF32_Rel count.
1033
1034  DT_FLAGS_1      = 0X6FFFFFFB, // Flags_1.
1035  DT_VERSYM       = 0x6FFFFFF0, // The address of .gnu.version section.
1036  DT_VERDEF       = 0X6FFFFFFC, // The address of the version definition table.
1037  DT_VERDEFNUM    = 0X6FFFFFFD, // The number of entries in DT_VERDEF.
1038  DT_VERNEED      = 0X6FFFFFFE, // The address of the version Dependency table.
1039  DT_VERNEEDNUM   = 0X6FFFFFFF, // The number of entries in DT_VERNEED.
1040
1041  // Mips specific dynamic table entry tags.
1042  DT_MIPS_RLD_VERSION   = 0x70000001, // 32 bit version number for runtime
1043                                      // linker interface.
1044  DT_MIPS_TIME_STAMP    = 0x70000002, // Time stamp.
1045  DT_MIPS_ICHECKSUM     = 0x70000003, // Checksum of external strings
1046                                      // and common sizes.
1047  DT_MIPS_IVERSION      = 0x70000004, // Index of version string
1048                                      // in string table.
1049  DT_MIPS_FLAGS         = 0x70000005, // 32 bits of flags.
1050  DT_MIPS_BASE_ADDRESS  = 0x70000006, // Base address of the segment.
1051  DT_MIPS_MSYM          = 0x70000007, // Address of .msym section.
1052  DT_MIPS_CONFLICT      = 0x70000008, // Address of .conflict section.
1053  DT_MIPS_LIBLIST       = 0x70000009, // Address of .liblist section.
1054  DT_MIPS_LOCAL_GOTNO   = 0x7000000a, // Number of local global offset
1055                                      // table entries.
1056  DT_MIPS_CONFLICTNO    = 0x7000000b, // Number of entries
1057                                      // in the .conflict section.
1058  DT_MIPS_LIBLISTNO     = 0x70000010, // Number of entries
1059                                      // in the .liblist section.
1060  DT_MIPS_SYMTABNO      = 0x70000011, // Number of entries
1061                                      // in the .dynsym section.
1062  DT_MIPS_UNREFEXTNO    = 0x70000012, // Index of first external dynamic symbol
1063                                      // not referenced locally.
1064  DT_MIPS_GOTSYM        = 0x70000013, // Index of first dynamic symbol
1065                                      // in global offset table.
1066  DT_MIPS_HIPAGENO      = 0x70000014, // Number of page table entries
1067                                      // in global offset table.
1068  DT_MIPS_RLD_MAP       = 0x70000016, // Address of run time loader map,
1069                                      // used for debugging.
1070  DT_MIPS_DELTA_CLASS       = 0x70000017, // Delta C++ class definition.
1071  DT_MIPS_DELTA_CLASS_NO    = 0x70000018, // Number of entries
1072                                          // in DT_MIPS_DELTA_CLASS.
1073  DT_MIPS_DELTA_INSTANCE    = 0x70000019, // Delta C++ class instances.
1074  DT_MIPS_DELTA_INSTANCE_NO = 0x7000001A, // Number of entries
1075                                          // in DT_MIPS_DELTA_INSTANCE.
1076  DT_MIPS_DELTA_RELOC       = 0x7000001B, // Delta relocations.
1077  DT_MIPS_DELTA_RELOC_NO    = 0x7000001C, // Number of entries
1078                                          // in DT_MIPS_DELTA_RELOC.
1079  DT_MIPS_DELTA_SYM         = 0x7000001D, // Delta symbols that Delta
1080                                          // relocations refer to.
1081  DT_MIPS_DELTA_SYM_NO      = 0x7000001E, // Number of entries
1082                                          // in DT_MIPS_DELTA_SYM.
1083  DT_MIPS_DELTA_CLASSSYM    = 0x70000020, // Delta symbols that hold
1084                                          // class declarations.
1085  DT_MIPS_DELTA_CLASSSYM_NO = 0x70000021, // Number of entries
1086                                          // in DT_MIPS_DELTA_CLASSSYM.
1087  DT_MIPS_CXX_FLAGS         = 0x70000022, // Flags indicating information
1088                                          // about C++ flavor.
1089  DT_MIPS_PIXIE_INIT        = 0x70000023, // Pixie information.
1090  DT_MIPS_SYMBOL_LIB        = 0x70000024, // Address of .MIPS.symlib
1091  DT_MIPS_LOCALPAGE_GOTIDX  = 0x70000025, // The GOT index of the first PTE
1092                                          // for a segment
1093  DT_MIPS_LOCAL_GOTIDX      = 0x70000026, // The GOT index of the first PTE
1094                                          // for a local symbol
1095  DT_MIPS_HIDDEN_GOTIDX     = 0x70000027, // The GOT index of the first PTE
1096                                          // for a hidden symbol
1097  DT_MIPS_PROTECTED_GOTIDX  = 0x70000028, // The GOT index of the first PTE
1098                                          // for a protected symbol
1099  DT_MIPS_OPTIONS           = 0x70000029, // Address of `.MIPS.options'.
1100  DT_MIPS_INTERFACE         = 0x7000002A, // Address of `.interface'.
1101  DT_MIPS_DYNSTR_ALIGN      = 0x7000002B, // Unknown.
1102  DT_MIPS_INTERFACE_SIZE    = 0x7000002C, // Size of the .interface section.
1103  DT_MIPS_RLD_TEXT_RESOLVE_ADDR = 0x7000002D, // Size of rld_text_resolve
1104                                              // function stored in the GOT.
1105  DT_MIPS_PERF_SUFFIX       = 0x7000002E, // Default suffix of DSO to be added
1106                                          // by rld on dlopen() calls.
1107  DT_MIPS_COMPACT_SIZE      = 0x7000002F, // Size of compact relocation
1108                                          // section (O32).
1109  DT_MIPS_GP_VALUE          = 0x70000030, // GP value for auxiliary GOTs.
1110  DT_MIPS_AUX_DYNAMIC       = 0x70000031, // Address of auxiliary .dynamic.
1111  DT_MIPS_PLTGOT            = 0x70000032, // Address of the base of the PLTGOT.
1112  DT_MIPS_RWPLT             = 0x70000034  // Points to the base
1113                                          // of a writable PLT.
1114};
1115
1116// DT_FLAGS values.
1117enum {
1118  DF_ORIGIN     = 0x01, // The object may reference $ORIGIN.
1119  DF_SYMBOLIC   = 0x02, // Search the shared lib before searching the exe.
1120  DF_TEXTREL    = 0x04, // Relocations may modify a non-writable segment.
1121  DF_BIND_NOW   = 0x08, // Process all relocations on load.
1122  DF_STATIC_TLS = 0x10  // Reject attempts to load dynamically.
1123};
1124
1125// State flags selectable in the `d_un.d_val' element of the DT_FLAGS_1 entry.
1126enum {
1127  DF_1_NOW        = 0x00000001, // Set RTLD_NOW for this object.
1128  DF_1_GLOBAL     = 0x00000002, // Set RTLD_GLOBAL for this object.
1129  DF_1_GROUP      = 0x00000004, // Set RTLD_GROUP for this object.
1130  DF_1_NODELETE   = 0x00000008, // Set RTLD_NODELETE for this object.
1131  DF_1_LOADFLTR   = 0x00000010, // Trigger filtee loading at runtime.
1132  DF_1_INITFIRST  = 0x00000020, // Set RTLD_INITFIRST for this object.
1133  DF_1_NOOPEN     = 0x00000040, // Set RTLD_NOOPEN for this object.
1134  DF_1_ORIGIN     = 0x00000080, // $ORIGIN must be handled.
1135  DF_1_DIRECT     = 0x00000100, // Direct binding enabled.
1136  DF_1_TRANS      = 0x00000200,
1137  DF_1_INTERPOSE  = 0x00000400, // Object is used to interpose.
1138  DF_1_NODEFLIB   = 0x00000800, // Ignore default lib search path.
1139  DF_1_NODUMP     = 0x00001000, // Object can't be dldump'ed.
1140  DF_1_CONFALT    = 0x00002000, // Configuration alternative created.
1141  DF_1_ENDFILTEE  = 0x00004000, // Filtee terminates filters search.
1142  DF_1_DISPRELDNE = 0x00008000, // Disp reloc applied at build time.
1143  DF_1_DISPRELPND = 0x00010000  // Disp reloc applied at run-time.
1144};
1145
1146// DT_MIPS_FLAGS values.
1147enum {
1148  RHF_NONE                    = 0x00000000, // No flags.
1149  RHF_QUICKSTART              = 0x00000001, // Uses shortcut pointers.
1150  RHF_NOTPOT                  = 0x00000002, // Hash size is not a power of two.
1151  RHS_NO_LIBRARY_REPLACEMENT  = 0x00000004, // Ignore LD_LIBRARY_PATH.
1152  RHF_NO_MOVE                 = 0x00000008, // DSO address may not be relocated.
1153  RHF_SGI_ONLY                = 0x00000010, // SGI specific features.
1154  RHF_GUARANTEE_INIT          = 0x00000020, // Guarantee that .init will finish
1155                                            // executing before any non-init
1156                                            // code in DSO is called.
1157  RHF_DELTA_C_PLUS_PLUS       = 0x00000040, // Contains Delta C++ code.
1158  RHF_GUARANTEE_START_INIT    = 0x00000080, // Guarantee that .init will start
1159                                            // executing before any non-init
1160                                            // code in DSO is called.
1161  RHF_PIXIE                   = 0x00000100, // Generated by pixie.
1162  RHF_DEFAULT_DELAY_LOAD      = 0x00000200, // Delay-load DSO by default.
1163  RHF_REQUICKSTART            = 0x00000400, // Object may be requickstarted
1164  RHF_REQUICKSTARTED          = 0x00000800, // Object has been requickstarted
1165  RHF_CORD                    = 0x00001000, // Generated by cord.
1166  RHF_NO_UNRES_UNDEF          = 0x00002000, // Object contains no unresolved
1167                                            // undef symbols.
1168  RHF_RLD_ORDER_SAFE          = 0x00004000  // Symbol table is in a safe order.
1169};
1170
1171// ElfXX_VerDef structure version (GNU versioning)
1172enum {
1173  VER_DEF_NONE    = 0,
1174  VER_DEF_CURRENT = 1
1175};
1176
1177// VerDef Flags (ElfXX_VerDef::vd_flags)
1178enum {
1179  VER_FLG_BASE = 0x1,
1180  VER_FLG_WEAK = 0x2,
1181  VER_FLG_INFO = 0x4
1182};
1183
1184// Special constants for the version table. (SHT_GNU_versym/.gnu.version)
1185enum {
1186  VER_NDX_LOCAL  = 0,      // Unversioned local symbol
1187  VER_NDX_GLOBAL = 1,      // Unversioned global symbol
1188  VERSYM_VERSION = 0x7fff, // Version Index mask
1189  VERSYM_HIDDEN  = 0x8000  // Hidden bit (non-default version)
1190};
1191
1192// ElfXX_VerNeed structure version (GNU versioning)
1193enum {
1194  VER_NEED_NONE = 0,
1195  VER_NEED_CURRENT = 1
1196};
1197
1198} // end namespace ELF
1199
1200} // end namespace llvm
1201
1202#endif
1203