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/Compiler.h"
  24 #include "llvm/Support/DataTypes.h"
  25 #include <cstring>
  26
  27 namespace llvm {
  28
  29 namespace ELF {
  30
  31 typedef uint32_t Elf32_Addr; // Program address
  32 typedef uint32_t Elf32_Off;  // File offset
  33 typedef uint16_t Elf32_Half;
  34 typedef uint32_t Elf32_Word;
  35 typedef int32_t  Elf32_Sword;
  36
  37 typedef uint64_t Elf64_Addr;
  38 typedef uint64_t Elf64_Off;
  39 typedef uint16_t Elf64_Half;
  40 typedef uint32_t Elf64_Word;
  41 typedef int32_t  Elf64_Sword;
  42 typedef uint64_t Elf64_Xword;
  43 typedef int64_t  Elf64_Sxword;
  44
  45 // Object file magic string.
  46 static const char ElfMagic[] = { 0x7f, 'E', 'L', 'F', '\0' };
  47
  48 // e_ident size and indices.
  49 enum {
  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
  63 struct 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).
  87 struct 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
 110 enum {
 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
 121 enum {
 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
 129 enum {
 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_IAMCU         = 6, // Intel MCU
 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   EM_AMDGPU        = 224  // AMD GPU architecture
 313 };
 314
 315 // Object file classes.
 316 enum {
 317   ELFCLASSNONE = 0,
 318   ELFCLASS32 = 1, // 32-bit object file
 319   ELFCLASS64 = 2  // 64-bit object file
 320 };
 321
 322 // Object file byte orderings.
 323 enum {
 324   ELFDATANONE = 0, // Invalid data encoding.
 325   ELFDATA2LSB = 1, // Little-endian object file
 326   ELFDATA2MSB = 2  // Big-endian object file
 327 };
 328
 329 // OS ABI identification.
 330 enum {
 331   ELFOSABI_NONE = 0,          // UNIX System V ABI
 332   ELFOSABI_HPUX = 1,          // HP-UX operating system
 333   ELFOSABI_NETBSD = 2,        // NetBSD
 334   ELFOSABI_GNU = 3,           // GNU/Linux
 335   ELFOSABI_LINUX = 3,         // Historical alias for ELFOSABI_GNU.
 336   ELFOSABI_HURD = 4,          // GNU/Hurd
 337   ELFOSABI_SOLARIS = 6,       // Solaris
 338   ELFOSABI_AIX = 7,           // AIX
 339   ELFOSABI_IRIX = 8,          // IRIX
 340   ELFOSABI_FREEBSD = 9,       // FreeBSD
 341   ELFOSABI_TRU64 = 10,        // TRU64 UNIX
 342   ELFOSABI_MODESTO = 11,      // Novell Modesto
 343   ELFOSABI_OPENBSD = 12,      // OpenBSD
 344   ELFOSABI_OPENVMS = 13,      // OpenVMS
 345   ELFOSABI_NSK = 14,          // Hewlett-Packard Non-Stop Kernel
 346   ELFOSABI_AROS = 15,         // AROS
 347   ELFOSABI_FENIXOS = 16,      // FenixOS
 348   ELFOSABI_CLOUDABI = 17,     // Nuxi CloudABI
 349   ELFOSABI_C6000_ELFABI = 64, // Bare-metal TMS320C6000
 350   ELFOSABI_AMDGPU_HSA = 64,   // AMD HSA runtime
 351   ELFOSABI_C6000_LINUX = 65,  // Linux TMS320C6000
 352   ELFOSABI_ARM = 97,          // ARM
 353   ELFOSABI_STANDALONE = 255   // Standalone (embedded) application
 354 };
 355
 356 #define ELF_RELOC(name, value) name = value,
 357
 358 // X86_64 relocations.
 359 enum {
 360 #include "ELFRelocs/x86_64.def"
 361 };
 362
 363 // i386 relocations.
 364 enum {
 365 #include "ELFRelocs/i386.def"
 366 };
 367
 368 // ELF Relocation types for PPC32
 369 enum {
 370 #include "ELFRelocs/PowerPC.def"
 371 };
 372
 373 // Specific e_flags for PPC64
 374 enum {
 375   // e_flags bits specifying ABI:
 376   // 1 for original ABI using function descriptors,
 377   // 2 for revised ABI without function descriptors,
 378   // 0 for unspecified or not using any features affected by the differences.
 379   EF_PPC64_ABI = 3
 380 };
 381
 382 // Special values for the st_other field in the symbol table entry for PPC64.
 383 enum {
 384   STO_PPC64_LOCAL_BIT = 5,
 385   STO_PPC64_LOCAL_MASK = (7 << STO_PPC64_LOCAL_BIT)
 386 };
 387 static inline int64_t
 388 decodePPC64LocalEntryOffset(unsigned Other) {
 389   unsigned Val = (Other & STO_PPC64_LOCAL_MASK) >> STO_PPC64_LOCAL_BIT;
 390   return ((1 << Val) >> 2) << 2;
 391 }
 392 static inline unsigned
 393 encodePPC64LocalEntryOffset(int64_t Offset) {
 394   unsigned Val = (Offset >= 4 * 4
 395                   ? (Offset >= 8 * 4
 396                      ? (Offset >= 16 * 4 ? 6 : 5)
 397                      : 4)
 398                   : (Offset >= 2 * 4
 399                      ? 3
 400                      : (Offset >= 1 * 4 ? 2 : 0)));
 401   return Val << STO_PPC64_LOCAL_BIT;
 402 }
 403
 404 // ELF Relocation types for PPC64
 405 enum {
 406 #include "ELFRelocs/PowerPC64.def"
 407 };
 408
 409 // ELF Relocation types for AArch64
 410 enum {
 411 #include "ELFRelocs/AArch64.def"
 412 };
 413
 414 // ARM Specific e_flags
 415 enum : unsigned {
 416   EF_ARM_SOFT_FLOAT =     0x00000200U,
 417   EF_ARM_VFP_FLOAT =      0x00000400U,
 418   EF_ARM_EABI_UNKNOWN =   0x00000000U,
 419   EF_ARM_EABI_VER1 =      0x01000000U,
 420   EF_ARM_EABI_VER2 =      0x02000000U,
 421   EF_ARM_EABI_VER3 =      0x03000000U,
 422   EF_ARM_EABI_VER4 =      0x04000000U,
 423   EF_ARM_EABI_VER5 =      0x05000000U,
 424   EF_ARM_EABIMASK =       0xFF000000U
 425 };
 426
 427 // ELF Relocation types for ARM
 428 enum {
 429 #include "ELFRelocs/ARM.def"
 430 };
 431
 432 // AVR specific e_flags
 433 enum : unsigned {
 434   EF_AVR_ARCH_AVR1    = 1,
 435   EF_AVR_ARCH_AVR2    = 2,
 436   EF_AVR_ARCH_AVR25   = 25,
 437   EF_AVR_ARCH_AVR3    = 3,
 438   EF_AVR_ARCH_AVR31   = 31,
 439   EF_AVR_ARCH_AVR35   = 35,
 440   EF_AVR_ARCH_AVR4    = 4,
 441   EF_AVR_ARCH_AVR5    = 5,
 442   EF_AVR_ARCH_AVR51   = 51,
 443   EF_AVR_ARCH_AVR6    = 6,
 444   EF_AVR_ARCH_AVRTINY = 100,
 445   EF_AVR_ARCH_XMEGA1  = 101,
 446   EF_AVR_ARCH_XMEGA2  = 102,
 447   EF_AVR_ARCH_XMEGA3  = 103,
 448   EF_AVR_ARCH_XMEGA4  = 104,
 449   EF_AVR_ARCH_XMEGA5  = 105,
 450   EF_AVR_ARCH_XMEGA6  = 106,
 451   EF_AVR_ARCH_XMEGA7  = 107
 452 };
 453
 454 // ELF Relocation types for AVR
 455 enum {
 456 #include "ELFRelocs/AVR.def"
 457 };
 458
 459 // Mips Specific e_flags
 460 enum : unsigned {
 461   EF_MIPS_NOREORDER = 0x00000001, // Don't reorder instructions
 462   EF_MIPS_PIC       = 0x00000002, // Position independent code
 463   EF_MIPS_CPIC      = 0x00000004, // Call object with Position independent code
 464   EF_MIPS_ABI2      = 0x00000020, // File uses N32 ABI
 465   EF_MIPS_32BITMODE = 0x00000100, // Code compiled for a 64-bit machine
 466                                   // in 32-bit mode
 467   EF_MIPS_FP64      = 0x00000200, // Code compiled for a 32-bit machine
 468                                   // but uses 64-bit FP registers
 469   EF_MIPS_NAN2008   = 0x00000400, // Uses IEE 754-2008 NaN encoding
 470
 471   // ABI flags
 472   EF_MIPS_ABI_O32    = 0x00001000, // This file follows the first MIPS 32 bit ABI
 473   EF_MIPS_ABI_O64    = 0x00002000, // O32 ABI extended for 64-bit architecture.
 474   EF_MIPS_ABI_EABI32 = 0x00003000, // EABI in 32 bit mode.
 475   EF_MIPS_ABI_EABI64 = 0x00004000, // EABI in 64 bit mode.
 476   EF_MIPS_ABI        = 0x0000f000, // Mask for selecting EF_MIPS_ABI_ variant.
 477
 478   // MIPS machine variant
 479   EF_MIPS_MACH_3900    = 0x00810000, // Toshiba R3900
 480   EF_MIPS_MACH_4010    = 0x00820000, // LSI R4010
 481   EF_MIPS_MACH_4100    = 0x00830000, // NEC VR4100
 482   EF_MIPS_MACH_4650    = 0x00850000, // MIPS R4650
 483   EF_MIPS_MACH_4120    = 0x00870000, // NEC VR4120
 484   EF_MIPS_MACH_4111    = 0x00880000, // NEC VR4111/VR4181
 485   EF_MIPS_MACH_SB1     = 0x008a0000, // Broadcom SB-1
 486   EF_MIPS_MACH_OCTEON  = 0x008b0000, // Cavium Networks Octeon
 487   EF_MIPS_MACH_XLR     = 0x008c0000, // RMI Xlr
 488   EF_MIPS_MACH_OCTEON2 = 0x008d0000, // Cavium Networks Octeon2
 489   EF_MIPS_MACH_OCTEON3 = 0x008e0000, // Cavium Networks Octeon3
 490   EF_MIPS_MACH_5400    = 0x00910000, // NEC VR5400
 491   EF_MIPS_MACH_5900    = 0x00920000, // MIPS R5900
 492   EF_MIPS_MACH_5500    = 0x00980000, // NEC VR5500
 493   EF_MIPS_MACH_9000    = 0x00990000, // Unknown
 494   EF_MIPS_MACH_LS2E    = 0x00a00000, // ST Microelectronics Loongson 2E
 495   EF_MIPS_MACH_LS2F    = 0x00a10000, // ST Microelectronics Loongson 2F
 496   EF_MIPS_MACH_LS3A    = 0x00a20000, // Loongson 3A
 497   EF_MIPS_MACH         = 0x00ff0000, // EF_MIPS_MACH_xxx selection mask
 498
 499   // ARCH_ASE
 500   EF_MIPS_MICROMIPS = 0x02000000, // microMIPS
 501   EF_MIPS_ARCH_ASE_M16 =
 502                       0x04000000, // Has Mips-16 ISA extensions
 503   EF_MIPS_ARCH_ASE_MDMX =
 504                       0x08000000, // Has MDMX multimedia extensions
 505   EF_MIPS_ARCH_ASE  = 0x0f000000, // Mask for EF_MIPS_ARCH_ASE_xxx flags
 506
 507   // ARCH
 508   EF_MIPS_ARCH_1    = 0x00000000, // MIPS1 instruction set
 509   EF_MIPS_ARCH_2    = 0x10000000, // MIPS2 instruction set
 510   EF_MIPS_ARCH_3    = 0x20000000, // MIPS3 instruction set
 511   EF_MIPS_ARCH_4    = 0x30000000, // MIPS4 instruction set
 512   EF_MIPS_ARCH_5    = 0x40000000, // MIPS5 instruction set
 513   EF_MIPS_ARCH_32   = 0x50000000, // MIPS32 instruction set per linux not elf.h
 514   EF_MIPS_ARCH_64   = 0x60000000, // MIPS64 instruction set per linux not elf.h
 515   EF_MIPS_ARCH_32R2 = 0x70000000, // mips32r2, mips32r3, mips32r5
 516   EF_MIPS_ARCH_64R2 = 0x80000000, // mips64r2, mips64r3, mips64r5
 517   EF_MIPS_ARCH_32R6 = 0x90000000, // mips32r6
 518   EF_MIPS_ARCH_64R6 = 0xa0000000, // mips64r6
 519   EF_MIPS_ARCH      = 0xf0000000  // Mask for applying EF_MIPS_ARCH_ variant
 520 };
 521
 522 // ELF Relocation types for Mips
 523 enum {
 524 #include "ELFRelocs/Mips.def"
 525 };
 526
 527 // Special values for the st_other field in the symbol table entry for MIPS.
 528 enum {
 529   STO_MIPS_OPTIONAL        = 0x04,  // Symbol whose definition is optional
 530   STO_MIPS_PLT             = 0x08,  // PLT entry related dynamic table record
 531   STO_MIPS_PIC             = 0x20,  // PIC func in an object mixes PIC/non-PIC
 532   STO_MIPS_MICROMIPS       = 0x80,  // MIPS Specific ISA for MicroMips
 533   STO_MIPS_MIPS16          = 0xf0   // MIPS Specific ISA for Mips16
 534 };
 535
 536 // .MIPS.options section descriptor kinds
 537 enum {
 538   ODK_NULL       = 0,   // Undefined
 539   ODK_REGINFO    = 1,   // Register usage information
 540   ODK_EXCEPTIONS = 2,   // Exception processing options
 541   ODK_PAD        = 3,   // Section padding options
 542   ODK_HWPATCH    = 4,   // Hardware patches applied
 543   ODK_FILL       = 5,   // Linker fill value
 544   ODK_TAGS       = 6,   // Space for tool identification
 545   ODK_HWAND      = 7,   // Hardware AND patches applied
 546   ODK_HWOR       = 8,   // Hardware OR patches applied
 547   ODK_GP_GROUP   = 9,   // GP group to use for text/data sections
 548   ODK_IDENT      = 10,  // ID information
 549   ODK_PAGESIZE   = 11   // Page size information
 550 };
 551
 552 // Hexagon-specific e_flags
 553 enum {
 554   // Object processor version flags, bits[11:0]
 555   EF_HEXAGON_MACH_V2      = 0x00000001,   // Hexagon V2
 556   EF_HEXAGON_MACH_V3      = 0x00000002,   // Hexagon V3
 557   EF_HEXAGON_MACH_V4      = 0x00000003,   // Hexagon V4
 558   EF_HEXAGON_MACH_V5      = 0x00000004,   // Hexagon V5
 559   EF_HEXAGON_MACH_V55     = 0x00000005,   // Hexagon V55
 560   EF_HEXAGON_MACH_V60     = 0x00000060,   // Hexagon V60
 561
 562   // Highest ISA version flags
 563   EF_HEXAGON_ISA_MACH     = 0x00000000,   // Same as specified in bits[11:0]
 564                                           // of e_flags
 565   EF_HEXAGON_ISA_V2       = 0x00000010,   // Hexagon V2 ISA
 566   EF_HEXAGON_ISA_V3       = 0x00000020,   // Hexagon V3 ISA
 567   EF_HEXAGON_ISA_V4       = 0x00000030,   // Hexagon V4 ISA
 568   EF_HEXAGON_ISA_V5       = 0x00000040,   // Hexagon V5 ISA
 569   EF_HEXAGON_ISA_V55      = 0x00000050,   // Hexagon V55 ISA
 570   EF_HEXAGON_ISA_V60      = 0x00000060,   // Hexagon V60 ISA
 571 };
 572
 573 // Hexagon-specific section indexes for common small data
 574 enum {
 575   SHN_HEXAGON_SCOMMON     = 0xff00,       // Other access sizes
 576   SHN_HEXAGON_SCOMMON_1   = 0xff01,       // Byte-sized access
 577   SHN_HEXAGON_SCOMMON_2   = 0xff02,       // Half-word-sized access
 578   SHN_HEXAGON_SCOMMON_4   = 0xff03,       // Word-sized access
 579   SHN_HEXAGON_SCOMMON_8   = 0xff04        // Double-word-size access
 580 };
 581
 582 // ELF Relocation types for Hexagon
 583 enum {
 584 #include "ELFRelocs/Hexagon.def"
 585 };
 586
 587 // ELF Relocation types for S390/zSeries
 588 enum {
 589 #include "ELFRelocs/SystemZ.def"
 590 };
 591
 592 // ELF Relocation type for Sparc.
 593 enum {
 594 #include "ELFRelocs/Sparc.def"
 595 };
 596
 597 // ELF Relocation types for WebAssembly
 598 enum {
 599 #include "ELFRelocs/WebAssembly.def"
 600 };
 601
 602 #undef ELF_RELOC
 603
 604 // Section header.
 605 struct Elf32_Shdr {
 606   Elf32_Word sh_name;      // Section name (index into string table)
 607   Elf32_Word sh_type;      // Section type (SHT_*)
 608   Elf32_Word sh_flags;     // Section flags (SHF_*)
 609   Elf32_Addr sh_addr;      // Address where section is to be loaded
 610   Elf32_Off  sh_offset;    // File offset of section data, in bytes
 611   Elf32_Word sh_size;      // Size of section, in bytes
 612   Elf32_Word sh_link;      // Section type-specific header table index link
 613   Elf32_Word sh_info;      // Section type-specific extra information
 614   Elf32_Word sh_addralign; // Section address alignment
 615   Elf32_Word sh_entsize;   // Size of records contained within the section
 616 };
 617
 618 // Section header for ELF64 - same fields as ELF32, different types.
 619 struct Elf64_Shdr {
 620   Elf64_Word  sh_name;
 621   Elf64_Word  sh_type;
 622   Elf64_Xword sh_flags;
 623   Elf64_Addr  sh_addr;
 624   Elf64_Off   sh_offset;
 625   Elf64_Xword sh_size;
 626   Elf64_Word  sh_link;
 627   Elf64_Word  sh_info;
 628   Elf64_Xword sh_addralign;
 629   Elf64_Xword sh_entsize;
 630 };
 631
 632 // Special section indices.
 633 enum {
 634   SHN_UNDEF     = 0,      // Undefined, missing, irrelevant, or meaningless
 635   SHN_LORESERVE = 0xff00, // Lowest reserved index
 636   SHN_LOPROC    = 0xff00, // Lowest processor-specific index
 637   SHN_HIPROC    = 0xff1f, // Highest processor-specific index
 638   SHN_LOOS      = 0xff20, // Lowest operating system-specific index
 639   SHN_HIOS      = 0xff3f, // Highest operating system-specific index
 640   SHN_ABS       = 0xfff1, // Symbol has absolute value; does not need relocation
 641   SHN_COMMON    = 0xfff2, // FORTRAN COMMON or C external global variables
 642   SHN_XINDEX    = 0xffff, // Mark that the index is >= SHN_LORESERVE
 643   SHN_HIRESERVE = 0xffff  // Highest reserved index
 644 };
 645
 646 // Section types.
 647 enum : unsigned {
 648   SHT_NULL          = 0,  // No associated section (inactive entry).
 649   SHT_PROGBITS      = 1,  // Program-defined contents.
 650   SHT_SYMTAB        = 2,  // Symbol table.
 651   SHT_STRTAB        = 3,  // String table.
 652   SHT_RELA          = 4,  // Relocation entries; explicit addends.
 653   SHT_HASH          = 5,  // Symbol hash table.
 654   SHT_DYNAMIC       = 6,  // Information for dynamic linking.
 655   SHT_NOTE          = 7,  // Information about the file.
 656   SHT_NOBITS        = 8,  // Data occupies no space in the file.
 657   SHT_REL           = 9,  // Relocation entries; no explicit addends.
 658   SHT_SHLIB         = 10, // Reserved.
 659   SHT_DYNSYM        = 11, // Symbol table.
 660   SHT_INIT_ARRAY    = 14, // Pointers to initialization functions.
 661   SHT_FINI_ARRAY    = 15, // Pointers to termination functions.
 662   SHT_PREINIT_ARRAY = 16, // Pointers to pre-init functions.
 663   SHT_GROUP         = 17, // Section group.
 664   SHT_SYMTAB_SHNDX  = 18, // Indices for SHN_XINDEX entries.
 665   SHT_LOOS          = 0x60000000, // Lowest operating system-specific type.
 666   SHT_GNU_ATTRIBUTES= 0x6ffffff5, // Object attributes.
 667   SHT_GNU_HASH      = 0x6ffffff6, // GNU-style hash table.
 668   SHT_GNU_verdef    = 0x6ffffffd, // GNU version definitions.
 669   SHT_GNU_verneed   = 0x6ffffffe, // GNU version references.
 670   SHT_GNU_versym    = 0x6fffffff, // GNU symbol versions table.
 671   SHT_HIOS          = 0x6fffffff, // Highest operating system-specific type.
 672   SHT_LOPROC        = 0x70000000, // Lowest processor arch-specific type.
 673   // Fixme: All this is duplicated in MCSectionELF. Why??
 674   // Exception Index table
 675   SHT_ARM_EXIDX           = 0x70000001U,
 676   // BPABI DLL dynamic linking pre-emption map
 677   SHT_ARM_PREEMPTMAP      = 0x70000002U,
 678   //  Object file compatibility attributes
 679   SHT_ARM_ATTRIBUTES      = 0x70000003U,
 680   SHT_ARM_DEBUGOVERLAY    = 0x70000004U,
 681   SHT_ARM_OVERLAYSECTION  = 0x70000005U,
 682   SHT_HEX_ORDERED         = 0x70000000, // Link editor is to sort the entries in
 683                                         // this section based on their sizes
 684   SHT_X86_64_UNWIND       = 0x70000001, // Unwind information
 685
 686   SHT_MIPS_REGINFO        = 0x70000006, // Register usage information
 687   SHT_MIPS_OPTIONS        = 0x7000000d, // General options
 688   SHT_MIPS_ABIFLAGS       = 0x7000002a, // ABI information.
 689
 690   SHT_HIPROC        = 0x7fffffff, // Highest processor arch-specific type.
 691   SHT_LOUSER        = 0x80000000, // Lowest type reserved for applications.
 692   SHT_HIUSER        = 0xffffffff  // Highest type reserved for applications.
 693 };
 694
 695 // Section flags.
 696 enum : unsigned {
 697   // Section data should be writable during execution.
 698   SHF_WRITE = 0x1,
 699
 700   // Section occupies memory during program execution.
 701   SHF_ALLOC = 0x2,
 702
 703   // Section contains executable machine instructions.
 704   SHF_EXECINSTR = 0x4,
 705
 706   // The data in this section may be merged.
 707   SHF_MERGE = 0x10,
 708
 709   // The data in this section is null-terminated strings.
 710   SHF_STRINGS = 0x20,
 711
 712   // A field in this section holds a section header table index.
 713   SHF_INFO_LINK = 0x40U,
 714
 715   // Adds special ordering requirements for link editors.
 716   SHF_LINK_ORDER = 0x80U,
 717
 718   // This section requires special OS-specific processing to avoid incorrect
 719   // behavior.
 720   SHF_OS_NONCONFORMING = 0x100U,
 721
 722   // This section is a member of a section group.
 723   SHF_GROUP = 0x200U,
 724
 725   // This section holds Thread-Local Storage.
 726   SHF_TLS = 0x400U,
 727
 728   // This section is excluded from the final executable or shared library.
 729   SHF_EXCLUDE = 0x80000000U,
 730
 731   // Start of target-specific flags.
 732
 733   /// XCORE_SHF_CP_SECTION - All sections with the "c" flag are grouped
 734   /// together by the linker to form the constant pool and the cp register is
 735   /// set to the start of the constant pool by the boot code.
 736   XCORE_SHF_CP_SECTION = 0x800U,
 737
 738   /// XCORE_SHF_DP_SECTION - All sections with the "d" flag are grouped
 739   /// together by the linker to form the data section and the dp register is
 740   /// set to the start of the section by the boot code.
 741   XCORE_SHF_DP_SECTION = 0x1000U,
 742
 743   SHF_MASKOS   = 0x0ff00000,
 744
 745   // Bits indicating processor-specific flags.
 746   SHF_MASKPROC = 0xf0000000,
 747
 748   // If an object file section does not have this flag set, then it may not hold
 749   // more than 2GB and can be freely referred to in objects using smaller code
 750   // models. Otherwise, only objects using larger code models can refer to them.
 751   // For example, a medium code model object can refer to data in a section that
 752   // sets this flag besides being able to refer to data in a section that does
 753   // not set it; likewise, a small code model object can refer only to code in a
 754   // section that does not set this flag.
 755   SHF_X86_64_LARGE = 0x10000000,
 756
 757   // All sections with the GPREL flag are grouped into a global data area
 758   // for faster accesses
 759   SHF_HEX_GPREL = 0x10000000,
 760
 761   // Section contains text/data which may be replicated in other sections.
 762   // Linker must retain only one copy.
 763   SHF_MIPS_NODUPES = 0x01000000,
 764
 765   // Linker must generate implicit hidden weak names.
 766   SHF_MIPS_NAMES   = 0x02000000,
 767
 768   // Section data local to process.
 769   SHF_MIPS_LOCAL   = 0x04000000,
 770
 771   // Do not strip this section.
 772   SHF_MIPS_NOSTRIP = 0x08000000,
 773
 774   // Section must be part of global data area.
 775   SHF_MIPS_GPREL   = 0x10000000,
 776
 777   // This section should be merged.
 778   SHF_MIPS_MERGE   = 0x20000000,
 779
 780   // Address size to be inferred from section entry size.
 781   SHF_MIPS_ADDR    = 0x40000000,
 782
 783   // Section data is string data by default.
 784   SHF_MIPS_STRING  = 0x80000000,
 785
 786   SHF_AMDGPU_HSA_GLOBAL   = 0x00100000,
 787   SHF_AMDGPU_HSA_READONLY = 0x00200000,
 788   SHF_AMDGPU_HSA_CODE     = 0x00400000,
 789   SHF_AMDGPU_HSA_AGENT    = 0x00800000
 790 };
 791
 792 // Section Group Flags
 793 enum : unsigned {
 794   GRP_COMDAT = 0x1,
 795   GRP_MASKOS = 0x0ff00000,
 796   GRP_MASKPROC = 0xf0000000
 797 };
 798
 799 // Symbol table entries for ELF32.
 800 struct Elf32_Sym {
 801   Elf32_Word    st_name;  // Symbol name (index into string table)
 802   Elf32_Addr    st_value; // Value or address associated with the symbol
 803   Elf32_Word    st_size;  // Size of the symbol
 804   unsigned char st_info;  // Symbol's type and binding attributes
 805   unsigned char st_other; // Must be zero; reserved
 806   Elf32_Half    st_shndx; // Which section (header table index) it's defined in
 807
 808   // These accessors and mutators correspond to the ELF32_ST_BIND,
 809   // ELF32_ST_TYPE, and ELF32_ST_INFO macros defined in the ELF specification:
 810   unsigned char getBinding() const { return st_info >> 4; }
 811   unsigned char getType() const { return st_info & 0x0f; }
 812   void setBinding(unsigned char b) { setBindingAndType(b, getType()); }
 813   void setType(unsigned char t) { setBindingAndType(getBinding(), t); }
 814   void setBindingAndType(unsigned char b, unsigned char t) {
 815     st_info = (b << 4) + (t & 0x0f);
 816   }
 817 };
 818
 819 // Symbol table entries for ELF64.
 820 struct Elf64_Sym {
 821   Elf64_Word      st_name;  // Symbol name (index into string table)
 822   unsigned char   st_info;  // Symbol's type and binding attributes
 823   unsigned char   st_other; // Must be zero; reserved
 824   Elf64_Half      st_shndx; // Which section (header tbl index) it's defined in
 825   Elf64_Addr      st_value; // Value or address associated with the symbol
 826   Elf64_Xword     st_size;  // Size of the symbol
 827
 828   // These accessors and mutators are identical to those defined for ELF32
 829   // symbol table entries.
 830   unsigned char getBinding() const { return st_info >> 4; }
 831   unsigned char getType() const { return st_info & 0x0f; }
 832   void setBinding(unsigned char b) { setBindingAndType(b, getType()); }
 833   void setType(unsigned char t) { setBindingAndType(getBinding(), t); }
 834   void setBindingAndType(unsigned char b, unsigned char t) {
 835     st_info = (b << 4) + (t & 0x0f);
 836   }
 837 };
 838
 839 // The size (in bytes) of symbol table entries.
 840 enum {
 841   SYMENTRY_SIZE32 = 16, // 32-bit symbol entry size
 842   SYMENTRY_SIZE64 = 24  // 64-bit symbol entry size.
 843 };
 844
 845 // Symbol bindings.
 846 enum {
 847   STB_LOCAL = 0,   // Local symbol, not visible outside obj file containing def
 848   STB_GLOBAL = 1,  // Global symbol, visible to all object files being combined
 849   STB_WEAK = 2,    // Weak symbol, like global but lower-precedence
 850   STB_GNU_UNIQUE = 10,
 851   STB_LOOS   = 10, // Lowest operating system-specific binding type
 852   STB_HIOS   = 12, // Highest operating system-specific binding type
 853   STB_LOPROC = 13, // Lowest processor-specific binding type
 854   STB_HIPROC = 15  // Highest processor-specific binding type
 855 };
 856
 857 // Symbol types.
 858 enum {
 859   STT_NOTYPE  = 0,   // Symbol's type is not specified
 860   STT_OBJECT  = 1,   // Symbol is a data object (variable, array, etc.)
 861   STT_FUNC    = 2,   // Symbol is executable code (function, etc.)
 862   STT_SECTION = 3,   // Symbol refers to a section
 863   STT_FILE    = 4,   // Local, absolute symbol that refers to a file
 864   STT_COMMON  = 5,   // An uninitialized common block
 865   STT_TLS     = 6,   // Thread local data object
 866   STT_GNU_IFUNC = 10, // GNU indirect function
 867   STT_LOOS    = 10,  // Lowest operating system-specific symbol type
 868   STT_HIOS    = 12,  // Highest operating system-specific symbol type
 869   STT_LOPROC  = 13,  // Lowest processor-specific symbol type
 870   STT_HIPROC  = 15,  // Highest processor-specific symbol type
 871
 872   // AMDGPU symbol types
 873   STT_AMDGPU_HSA_KERNEL            = 10,
 874   STT_AMDGPU_HSA_INDIRECT_FUNCTION = 11,
 875   STT_AMDGPU_HSA_METADATA          = 12
 876 };
 877
 878 enum {
 879   STV_DEFAULT   = 0,  // Visibility is specified by binding type
 880   STV_INTERNAL  = 1,  // Defined by processor supplements
 881   STV_HIDDEN    = 2,  // Not visible to other components
 882   STV_PROTECTED = 3   // Visible in other components but not preemptable
 883 };
 884
 885 // Symbol number.
 886 enum {
 887   STN_UNDEF = 0
 888 };
 889
 890 // Special relocation symbols used in the MIPS64 ELF relocation entries
 891 enum {
 892   RSS_UNDEF = 0, // None
 893   RSS_GP = 1,    // Value of gp
 894   RSS_GP0 = 2,   // Value of gp used to create object being relocated
 895   RSS_LOC = 3    // Address of location being relocated
 896 };
 897
 898 // Relocation entry, without explicit addend.
 899 struct Elf32_Rel {
 900   Elf32_Addr r_offset; // Location (file byte offset, or program virtual addr)
 901   Elf32_Word r_info;   // Symbol table index and type of relocation to apply
 902
 903   // These accessors and mutators correspond to the ELF32_R_SYM, ELF32_R_TYPE,
 904   // and ELF32_R_INFO macros defined in the ELF specification:
 905   Elf32_Word getSymbol() const { return (r_info >> 8); }
 906   unsigned char getType() const { return (unsigned char) (r_info & 0x0ff); }
 907   void setSymbol(Elf32_Word s) { setSymbolAndType(s, getType()); }
 908   void setType(unsigned char t) { setSymbolAndType(getSymbol(), t); }
 909   void setSymbolAndType(Elf32_Word s, unsigned char t) {
 910     r_info = (s << 8) + t;
 911   }
 912 };
 913
 914 // Relocation entry with explicit addend.
 915 struct Elf32_Rela {
 916   Elf32_Addr  r_offset; // Location (file byte offset, or program virtual addr)
 917   Elf32_Word  r_info;   // Symbol table index and type of relocation to apply
 918   Elf32_Sword r_addend; // Compute value for relocatable field by adding this
 919
 920   // These accessors and mutators correspond to the ELF32_R_SYM, ELF32_R_TYPE,
 921   // and ELF32_R_INFO macros defined in the ELF specification:
 922   Elf32_Word getSymbol() const { return (r_info >> 8); }
 923   unsigned char getType() const { return (unsigned char) (r_info & 0x0ff); }
 924   void setSymbol(Elf32_Word s) { setSymbolAndType(s, getType()); }
 925   void setType(unsigned char t) { setSymbolAndType(getSymbol(), t); }
 926   void setSymbolAndType(Elf32_Word s, unsigned char t) {
 927     r_info = (s << 8) + t;
 928   }
 929 };
 930
 931 // Relocation entry, without explicit addend.
 932 struct Elf64_Rel {
 933   Elf64_Addr r_offset; // Location (file byte offset, or program virtual addr).
 934   Elf64_Xword r_info;   // Symbol table index and type of relocation to apply.
 935
 936   // These accessors and mutators correspond to the ELF64_R_SYM, ELF64_R_TYPE,
 937   // and ELF64_R_INFO macros defined in the ELF specification:
 938   Elf64_Word getSymbol() const { return (r_info >> 32); }
 939   Elf64_Word getType() const {
 940     return (Elf64_Word) (r_info & 0xffffffffL);
 941   }
 942   void setSymbol(Elf64_Word s) { setSymbolAndType(s, getType()); }
 943   void setType(Elf64_Word t) { setSymbolAndType(getSymbol(), t); }
 944   void setSymbolAndType(Elf64_Word s, Elf64_Word t) {
 945     r_info = ((Elf64_Xword)s << 32) + (t&0xffffffffL);
 946   }
 947 };
 948
 949 // Relocation entry with explicit addend.
 950 struct Elf64_Rela {
 951   Elf64_Addr  r_offset; // Location (file byte offset, or program virtual addr).
 952   Elf64_Xword  r_info;   // Symbol table index and type of relocation to apply.
 953   Elf64_Sxword r_addend; // Compute value for relocatable field by adding this.
 954
 955   // These accessors and mutators correspond to the ELF64_R_SYM, ELF64_R_TYPE,
 956   // and ELF64_R_INFO macros defined in the ELF specification:
 957   Elf64_Word getSymbol() const { return (r_info >> 32); }
 958   Elf64_Word getType() const {
 959     return (Elf64_Word) (r_info & 0xffffffffL);
 960   }
 961   void setSymbol(Elf64_Word s) { setSymbolAndType(s, getType()); }
 962   void setType(Elf64_Word t) { setSymbolAndType(getSymbol(), t); }
 963   void setSymbolAndType(Elf64_Word s, Elf64_Word t) {
 964     r_info = ((Elf64_Xword)s << 32) + (t&0xffffffffL);
 965   }
 966 };
 967
 968 // Program header for ELF32.
 969 struct Elf32_Phdr {
 970   Elf32_Word p_type;   // Type of segment
 971   Elf32_Off  p_offset; // File offset where segment is located, in bytes
 972   Elf32_Addr p_vaddr;  // Virtual address of beginning of segment
 973   Elf32_Addr p_paddr;  // Physical address of beginning of segment (OS-specific)
 974   Elf32_Word p_filesz; // Num. of bytes in file image of segment (may be zero)
 975   Elf32_Word p_memsz;  // Num. of bytes in mem image of segment (may be zero)
 976   Elf32_Word p_flags;  // Segment flags
 977   Elf32_Word p_align;  // Segment alignment constraint
 978 };
 979
 980 // Program header for ELF64.
 981 struct Elf64_Phdr {
 982   Elf64_Word   p_type;   // Type of segment
 983   Elf64_Word   p_flags;  // Segment flags
 984   Elf64_Off    p_offset; // File offset where segment is located, in bytes
 985   Elf64_Addr   p_vaddr;  // Virtual address of beginning of segment
 986   Elf64_Addr   p_paddr;  // Physical addr of beginning of segment (OS-specific)
 987   Elf64_Xword  p_filesz; // Num. of bytes in file image of segment (may be zero)
 988   Elf64_Xword  p_memsz;  // Num. of bytes in mem image of segment (may be zero)
 989   Elf64_Xword  p_align;  // Segment alignment constraint
 990 };
 991
 992 // Segment types.
 993 enum {
 994   PT_NULL    = 0, // Unused segment.
 995   PT_LOAD    = 1, // Loadable segment.
 996   PT_DYNAMIC = 2, // Dynamic linking information.
 997   PT_INTERP  = 3, // Interpreter pathname.
 998   PT_NOTE    = 4, // Auxiliary information.
 999   PT_SHLIB   = 5, // Reserved.
1000   PT_PHDR    = 6, // The program header table itself.
1001   PT_TLS     = 7, // The thread-local storage template.
1002   PT_LOOS    = 0x60000000, // Lowest operating system-specific pt entry type.
1003   PT_HIOS    = 0x6fffffff, // Highest operating system-specific pt entry type.
1004   PT_LOPROC  = 0x70000000, // Lowest processor-specific program hdr entry type.
1005   PT_HIPROC  = 0x7fffffff, // Highest processor-specific program hdr entry type.
1006
1007   // x86-64 program header types.
1008   // These all contain stack unwind tables.
1009   PT_GNU_EH_FRAME  = 0x6474e550,
1010   PT_SUNW_EH_FRAME = 0x6474e550,
1011   PT_SUNW_UNWIND   = 0x6464e550,
1012
1013   PT_GNU_STACK  = 0x6474e551, // Indicates stack executability.
1014   PT_GNU_RELRO  = 0x6474e552, // Read-only after relocation.
1015
1016   // ARM program header types.
1017   PT_ARM_ARCHEXT = 0x70000000, // Platform architecture compatibility info
1018   // These all contain stack unwind tables.
1019   PT_ARM_EXIDX   = 0x70000001,
1020   PT_ARM_UNWIND  = 0x70000001,
1021
1022   // MIPS program header types.
1023   PT_MIPS_REGINFO  = 0x70000000,  // Register usage information.
1024   PT_MIPS_RTPROC   = 0x70000001,  // Runtime procedure table.
1025   PT_MIPS_OPTIONS  = 0x70000002,  // Options segment.
1026   PT_MIPS_ABIFLAGS = 0x70000003,  // Abiflags segment.
1027
1028   // AMDGPU program header types.
1029   PT_AMDGPU_HSA_LOAD_GLOBAL_PROGRAM = 0x60000000,
1030   PT_AMDGPU_HSA_LOAD_GLOBAL_AGENT   = 0x60000001,
1031   PT_AMDGPU_HSA_LOAD_READONLY_AGENT = 0x60000002,
1032   PT_AMDGPU_HSA_LOAD_CODE_AGENT     = 0x60000003,
1033
1034   // WebAssembly program header types.
1035   PT_WEBASSEMBLY_FUNCTIONS = PT_LOPROC + 0, // Function definitions.
1036 };
1037
1038 // Segment flag bits.
1039 enum : unsigned {
1040   PF_X        = 1,         // Execute
1041   PF_W        = 2,         // Write
1042   PF_R        = 4,         // Read
1043   PF_MASKOS   = 0x0ff00000,// Bits for operating system-specific semantics.
1044   PF_MASKPROC = 0xf0000000 // Bits for processor-specific semantics.
1045 };
1046
1047 // Dynamic table entry for ELF32.
1048 struct Elf32_Dyn
1049 {
1050   Elf32_Sword d_tag;            // Type of dynamic table entry.
1051   union
1052   {
1053       Elf32_Word d_val;         // Integer value of entry.
1054       Elf32_Addr d_ptr;         // Pointer value of entry.
1055   } d_un;
1056 };
1057
1058 // Dynamic table entry for ELF64.
1059 struct Elf64_Dyn
1060 {
1061   Elf64_Sxword d_tag;           // Type of dynamic table entry.
1062   union
1063   {
1064       Elf64_Xword d_val;        // Integer value of entry.
1065       Elf64_Addr  d_ptr;        // Pointer value of entry.
1066   } d_un;
1067 };
1068
1069 // Dynamic table entry tags.
1070 enum {
1071   DT_NULL         = 0,        // Marks end of dynamic array.
1072   DT_NEEDED       = 1,        // String table offset of needed library.
1073   DT_PLTRELSZ     = 2,        // Size of relocation entries in PLT.
1074   DT_PLTGOT       = 3,        // Address associated with linkage table.
1075   DT_HASH         = 4,        // Address of symbolic hash table.
1076   DT_STRTAB       = 5,        // Address of dynamic string table.
1077   DT_SYMTAB       = 6,        // Address of dynamic symbol table.
1078   DT_RELA         = 7,        // Address of relocation table (Rela entries).
1079   DT_RELASZ       = 8,        // Size of Rela relocation table.
1080   DT_RELAENT      = 9,        // Size of a Rela relocation entry.
1081   DT_STRSZ        = 10,       // Total size of the string table.
1082   DT_SYMENT       = 11,       // Size of a symbol table entry.
1083   DT_INIT         = 12,       // Address of initialization function.
1084   DT_FINI         = 13,       // Address of termination function.
1085   DT_SONAME       = 14,       // String table offset of a shared objects name.
1086   DT_RPATH        = 15,       // String table offset of library search path.
1087   DT_SYMBOLIC     = 16,       // Changes symbol resolution algorithm.
1088   DT_REL          = 17,       // Address of relocation table (Rel entries).
1089   DT_RELSZ        = 18,       // Size of Rel relocation table.
1090   DT_RELENT       = 19,       // Size of a Rel relocation entry.
1091   DT_PLTREL       = 20,       // Type of relocation entry used for linking.
1092   DT_DEBUG        = 21,       // Reserved for debugger.
1093   DT_TEXTREL      = 22,       // Relocations exist for non-writable segments.
1094   DT_JMPREL       = 23,       // Address of relocations associated with PLT.
1095   DT_BIND_NOW     = 24,       // Process all relocations before execution.
1096   DT_INIT_ARRAY   = 25,       // Pointer to array of initialization functions.
1097   DT_FINI_ARRAY   = 26,       // Pointer to array of termination functions.
1098   DT_INIT_ARRAYSZ = 27,       // Size of DT_INIT_ARRAY.
1099   DT_FINI_ARRAYSZ = 28,       // Size of DT_FINI_ARRAY.
1100   DT_RUNPATH      = 29,       // String table offset of lib search path.
1101   DT_FLAGS        = 30,       // Flags.
1102   DT_ENCODING     = 32,       // Values from here to DT_LOOS follow the rules
1103                               // for the interpretation of the d_un union.
1104
1105   DT_PREINIT_ARRAY = 32,      // Pointer to array of preinit functions.
1106   DT_PREINIT_ARRAYSZ = 33,    // Size of the DT_PREINIT_ARRAY array.
1107
1108   DT_LOOS         = 0x60000000, // Start of environment specific tags.
1109   DT_HIOS         = 0x6FFFFFFF, // End of environment specific tags.
1110   DT_LOPROC       = 0x70000000, // Start of processor specific tags.
1111   DT_HIPROC       = 0x7FFFFFFF, // End of processor specific tags.
1112
1113   DT_GNU_HASH     = 0x6FFFFEF5, // Reference to the GNU hash table.
1114   DT_RELACOUNT    = 0x6FFFFFF9, // ELF32_Rela count.
1115   DT_RELCOUNT     = 0x6FFFFFFA, // ELF32_Rel count.
1116
1117   DT_FLAGS_1      = 0X6FFFFFFB, // Flags_1.
1118   DT_VERSYM       = 0x6FFFFFF0, // The address of .gnu.version section.
1119   DT_VERDEF       = 0X6FFFFFFC, // The address of the version definition table.
1120   DT_VERDEFNUM    = 0X6FFFFFFD, // The number of entries in DT_VERDEF.
1121   DT_VERNEED      = 0X6FFFFFFE, // The address of the version Dependency table.
1122   DT_VERNEEDNUM   = 0X6FFFFFFF, // The number of entries in DT_VERNEED.
1123
1124   // Mips specific dynamic table entry tags.
1125   DT_MIPS_RLD_VERSION   = 0x70000001, // 32 bit version number for runtime
1126                                       // linker interface.
1127   DT_MIPS_TIME_STAMP    = 0x70000002, // Time stamp.
1128   DT_MIPS_ICHECKSUM     = 0x70000003, // Checksum of external strings
1129                                       // and common sizes.
1130   DT_MIPS_IVERSION      = 0x70000004, // Index of version string
1131                                       // in string table.
1132   DT_MIPS_FLAGS         = 0x70000005, // 32 bits of flags.
1133   DT_MIPS_BASE_ADDRESS  = 0x70000006, // Base address of the segment.
1134   DT_MIPS_MSYM          = 0x70000007, // Address of .msym section.
1135   DT_MIPS_CONFLICT      = 0x70000008, // Address of .conflict section.
1136   DT_MIPS_LIBLIST       = 0x70000009, // Address of .liblist section.
1137   DT_MIPS_LOCAL_GOTNO   = 0x7000000a, // Number of local global offset
1138                                       // table entries.
1139   DT_MIPS_CONFLICTNO    = 0x7000000b, // Number of entries
1140                                       // in the .conflict section.
1141   DT_MIPS_LIBLISTNO     = 0x70000010, // Number of entries
1142                                       // in the .liblist section.
1143   DT_MIPS_SYMTABNO      = 0x70000011, // Number of entries
1144                                       // in the .dynsym section.
1145   DT_MIPS_UNREFEXTNO    = 0x70000012, // Index of first external dynamic symbol
1146                                       // not referenced locally.
1147   DT_MIPS_GOTSYM        = 0x70000013, // Index of first dynamic symbol
1148                                       // in global offset table.
1149   DT_MIPS_HIPAGENO      = 0x70000014, // Number of page table entries
1150                                       // in global offset table.
1151   DT_MIPS_RLD_MAP       = 0x70000016, // Address of run time loader map,
1152                                       // used for debugging.
1153   DT_MIPS_DELTA_CLASS       = 0x70000017, // Delta C++ class definition.
1154   DT_MIPS_DELTA_CLASS_NO    = 0x70000018, // Number of entries
1155                                           // in DT_MIPS_DELTA_CLASS.
1156   DT_MIPS_DELTA_INSTANCE    = 0x70000019, // Delta C++ class instances.
1157   DT_MIPS_DELTA_INSTANCE_NO = 0x7000001A, // Number of entries
1158                                           // in DT_MIPS_DELTA_INSTANCE.
1159   DT_MIPS_DELTA_RELOC       = 0x7000001B, // Delta relocations.
1160   DT_MIPS_DELTA_RELOC_NO    = 0x7000001C, // Number of entries
1161                                           // in DT_MIPS_DELTA_RELOC.
1162   DT_MIPS_DELTA_SYM         = 0x7000001D, // Delta symbols that Delta
1163                                           // relocations refer to.
1164   DT_MIPS_DELTA_SYM_NO      = 0x7000001E, // Number of entries
1165                                           // in DT_MIPS_DELTA_SYM.
1166   DT_MIPS_DELTA_CLASSSYM    = 0x70000020, // Delta symbols that hold
1167                                           // class declarations.
1168   DT_MIPS_DELTA_CLASSSYM_NO = 0x70000021, // Number of entries
1169                                           // in DT_MIPS_DELTA_CLASSSYM.
1170   DT_MIPS_CXX_FLAGS         = 0x70000022, // Flags indicating information
1171                                           // about C++ flavor.
1172   DT_MIPS_PIXIE_INIT        = 0x70000023, // Pixie information.
1173   DT_MIPS_SYMBOL_LIB        = 0x70000024, // Address of .MIPS.symlib
1174   DT_MIPS_LOCALPAGE_GOTIDX  = 0x70000025, // The GOT index of the first PTE
1175                                           // for a segment
1176   DT_MIPS_LOCAL_GOTIDX      = 0x70000026, // The GOT index of the first PTE
1177                                           // for a local symbol
1178   DT_MIPS_HIDDEN_GOTIDX     = 0x70000027, // The GOT index of the first PTE
1179                                           // for a hidden symbol
1180   DT_MIPS_PROTECTED_GOTIDX  = 0x70000028, // The GOT index of the first PTE
1181                                           // for a protected symbol
1182   DT_MIPS_OPTIONS           = 0x70000029, // Address of `.MIPS.options'.
1183   DT_MIPS_INTERFACE         = 0x7000002A, // Address of `.interface'.
1184   DT_MIPS_DYNSTR_ALIGN      = 0x7000002B, // Unknown.
1185   DT_MIPS_INTERFACE_SIZE    = 0x7000002C, // Size of the .interface section.
1186   DT_MIPS_RLD_TEXT_RESOLVE_ADDR = 0x7000002D, // Size of rld_text_resolve
1187                                               // function stored in the GOT.
1188   DT_MIPS_PERF_SUFFIX       = 0x7000002E, // Default suffix of DSO to be added
1189                                           // by rld on dlopen() calls.
1190   DT_MIPS_COMPACT_SIZE      = 0x7000002F, // Size of compact relocation
1191                                           // section (O32).
1192   DT_MIPS_GP_VALUE          = 0x70000030, // GP value for auxiliary GOTs.
1193   DT_MIPS_AUX_DYNAMIC       = 0x70000031, // Address of auxiliary .dynamic.
1194   DT_MIPS_PLTGOT            = 0x70000032, // Address of the base of the PLTGOT.
1195   DT_MIPS_RWPLT             = 0x70000034, // Points to the base
1196                                           // of a writable PLT.
1197   DT_MIPS_RLD_MAP_REL       = 0x70000035  // Relative offset of run time loader
1198                                           // map, used for debugging.
1199 };
1200
1201 // DT_FLAGS values.
1202 enum {
1203   DF_ORIGIN     = 0x01, // The object may reference $ORIGIN.
1204   DF_SYMBOLIC   = 0x02, // Search the shared lib before searching the exe.
1205   DF_TEXTREL    = 0x04, // Relocations may modify a non-writable segment.
1206   DF_BIND_NOW   = 0x08, // Process all relocations on load.
1207   DF_STATIC_TLS = 0x10  // Reject attempts to load dynamically.
1208 };
1209
1210 // State flags selectable in the `d_un.d_val' element of the DT_FLAGS_1 entry.
1211 enum {
1212   DF_1_NOW        = 0x00000001, // Set RTLD_NOW for this object.
1213   DF_1_GLOBAL     = 0x00000002, // Set RTLD_GLOBAL for this object.
1214   DF_1_GROUP      = 0x00000004, // Set RTLD_GROUP for this object.
1215   DF_1_NODELETE   = 0x00000008, // Set RTLD_NODELETE for this object.
1216   DF_1_LOADFLTR   = 0x00000010, // Trigger filtee loading at runtime.
1217   DF_1_INITFIRST  = 0x00000020, // Set RTLD_INITFIRST for this object.
1218   DF_1_NOOPEN     = 0x00000040, // Set RTLD_NOOPEN for this object.
1219   DF_1_ORIGIN     = 0x00000080, // $ORIGIN must be handled.
1220   DF_1_DIRECT     = 0x00000100, // Direct binding enabled.
1221   DF_1_TRANS      = 0x00000200,
1222   DF_1_INTERPOSE  = 0x00000400, // Object is used to interpose.
1223   DF_1_NODEFLIB   = 0x00000800, // Ignore default lib search path.
1224   DF_1_NODUMP     = 0x00001000, // Object can't be dldump'ed.
1225   DF_1_CONFALT    = 0x00002000, // Configuration alternative created.
1226   DF_1_ENDFILTEE  = 0x00004000, // Filtee terminates filters search.
1227   DF_1_DISPRELDNE = 0x00008000, // Disp reloc applied at build time.
1228   DF_1_DISPRELPND = 0x00010000, // Disp reloc applied at run-time.
1229   DF_1_NODIRECT   = 0x00020000, // Object has no-direct binding.
1230   DF_1_IGNMULDEF  = 0x00040000,
1231   DF_1_NOKSYMS    = 0x00080000,
1232   DF_1_NOHDR      = 0x00100000,
1233   DF_1_EDITED     = 0x00200000, // Object is modified after built.
1234   DF_1_NORELOC    = 0x00400000,
1235   DF_1_SYMINTPOSE = 0x00800000, // Object has individual interposers.
1236   DF_1_GLOBAUDIT  = 0x01000000, // Global auditing required.
1237   DF_1_SINGLETON  = 0x02000000  // Singleton symbols are used.
1238 };
1239
1240 // DT_MIPS_FLAGS values.
1241 enum {
1242   RHF_NONE                    = 0x00000000, // No flags.
1243   RHF_QUICKSTART              = 0x00000001, // Uses shortcut pointers.
1244   RHF_NOTPOT                  = 0x00000002, // Hash size is not a power of two.
1245   RHS_NO_LIBRARY_REPLACEMENT  = 0x00000004, // Ignore LD_LIBRARY_PATH.
1246   RHF_NO_MOVE                 = 0x00000008, // DSO address may not be relocated.
1247   RHF_SGI_ONLY                = 0x00000010, // SGI specific features.
1248   RHF_GUARANTEE_INIT          = 0x00000020, // Guarantee that .init will finish
1249                                             // executing before any non-init
1250                                             // code in DSO is called.
1251   RHF_DELTA_C_PLUS_PLUS       = 0x00000040, // Contains Delta C++ code.
1252   RHF_GUARANTEE_START_INIT    = 0x00000080, // Guarantee that .init will start
1253                                             // executing before any non-init
1254                                             // code in DSO is called.
1255   RHF_PIXIE                   = 0x00000100, // Generated by pixie.
1256   RHF_DEFAULT_DELAY_LOAD      = 0x00000200, // Delay-load DSO by default.
1257   RHF_REQUICKSTART            = 0x00000400, // Object may be requickstarted
1258   RHF_REQUICKSTARTED          = 0x00000800, // Object has been requickstarted
1259   RHF_CORD                    = 0x00001000, // Generated by cord.
1260   RHF_NO_UNRES_UNDEF          = 0x00002000, // Object contains no unresolved
1261                                             // undef symbols.
1262   RHF_RLD_ORDER_SAFE          = 0x00004000  // Symbol table is in a safe order.
1263 };
1264
1265 // ElfXX_VerDef structure version (GNU versioning)
1266 enum {
1267   VER_DEF_NONE    = 0,
1268   VER_DEF_CURRENT = 1
1269 };
1270
1271 // VerDef Flags (ElfXX_VerDef::vd_flags)
1272 enum {
1273   VER_FLG_BASE = 0x1,
1274   VER_FLG_WEAK = 0x2,
1275   VER_FLG_INFO = 0x4
1276 };
1277
1278 // Special constants for the version table. (SHT_GNU_versym/.gnu.version)
1279 enum {
1280   VER_NDX_LOCAL  = 0,      // Unversioned local symbol
1281   VER_NDX_GLOBAL = 1,      // Unversioned global symbol
1282   VERSYM_VERSION = 0x7fff, // Version Index mask
1283   VERSYM_HIDDEN  = 0x8000  // Hidden bit (non-default version)
1284 };
1285
1286 // ElfXX_VerNeed structure version (GNU versioning)
1287 enum {
1288   VER_NEED_NONE = 0,
1289   VER_NEED_CURRENT = 1
1290 };
1291
1292 } // end namespace ELF
1293
1294 } // end namespace llvm
1295
1296 #endif