• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //===- llvm/BinaryFormat/ELF.h - ELF constants and structures ---*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This header contains common, non-processor-specific data structures and
10 // constants for the ELF file format.
11 //
12 // The details of the ELF32 bits in this file are largely based on the Tool
13 // Interface Standard (TIS) Executable and Linking Format (ELF) Specification
14 // Version 1.2, May 1995. The ELF64 stuff is based on ELF-64 Object File Format
15 // Version 1.5, Draft 2, May 1998 as well as OpenBSD header files.
16 //
17 //===----------------------------------------------------------------------===//
18 
19 #ifndef LLVM_BINARYFORMAT_ELF_H
20 #define LLVM_BINARYFORMAT_ELF_H
21 
22 #include "llvm/ADT/StringRef.h"
23 #include <cstdint>
24 #include <cstring>
25 #include <type_traits>
26 
27 namespace llvm {
28 namespace ELF {
29 
30 using Elf32_Addr = uint32_t; // Program address
31 using Elf32_Off = uint32_t;  // File offset
32 using Elf32_Half = uint16_t;
33 using Elf32_Word = uint32_t;
34 using Elf32_Sword = int32_t;
35 
36 using Elf64_Addr = uint64_t;
37 using Elf64_Off = uint64_t;
38 using Elf64_Half = uint16_t;
39 using Elf64_Word = uint32_t;
40 using Elf64_Sword = int32_t;
41 using Elf64_Xword = uint64_t;
42 using Elf64_Sxword = int64_t;
43 
44 // Object file magic string.
45 static const char ElfMagic[] = {0x7f, 'E', 'L', 'F', '\0'};
46 
47 // e_ident size and indices.
48 enum {
49   EI_MAG0 = 0,       // File identification index.
50   EI_MAG1 = 1,       // File identification index.
51   EI_MAG2 = 2,       // File identification index.
52   EI_MAG3 = 3,       // File identification index.
53   EI_CLASS = 4,      // File class.
54   EI_DATA = 5,       // Data encoding.
55   EI_VERSION = 6,    // File version.
56   EI_OSABI = 7,      // OS/ABI identification.
57   EI_ABIVERSION = 8, // ABI version.
58   EI_PAD = 9,        // Start of padding bytes.
59   EI_NIDENT = 16     // Number of bytes in e_ident.
60 };
61 
62 struct Elf32_Ehdr {
63   unsigned char e_ident[EI_NIDENT]; // ELF Identification bytes
64   Elf32_Half e_type;                // Type of file (see ET_* below)
65   Elf32_Half e_machine;   // Required architecture for this file (see EM_*)
66   Elf32_Word e_version;   // Must be equal to 1
67   Elf32_Addr e_entry;     // Address to jump to in order to start program
68   Elf32_Off e_phoff;      // Program header table's file offset, in bytes
69   Elf32_Off e_shoff;      // Section header table's file offset, in bytes
70   Elf32_Word e_flags;     // Processor-specific flags
71   Elf32_Half e_ehsize;    // Size of ELF header, in bytes
72   Elf32_Half e_phentsize; // Size of an entry in the program header table
73   Elf32_Half e_phnum;     // Number of entries in the program header table
74   Elf32_Half e_shentsize; // Size of an entry in the section header table
75   Elf32_Half e_shnum;     // Number of entries in the section header table
76   Elf32_Half e_shstrndx;  // Sect hdr table index of sect name string table
77 
checkMagicElf32_Ehdr78   bool checkMagic() const {
79     return (memcmp(e_ident, ElfMagic, strlen(ElfMagic))) == 0;
80   }
81 
getFileClassElf32_Ehdr82   unsigned char getFileClass() const { return e_ident[EI_CLASS]; }
getDataEncodingElf32_Ehdr83   unsigned char getDataEncoding() const { return e_ident[EI_DATA]; }
84 };
85 
86 // 64-bit ELF header. Fields are the same as for ELF32, but with different
87 // types (see above).
88 struct Elf64_Ehdr {
89   unsigned char e_ident[EI_NIDENT];
90   Elf64_Half e_type;
91   Elf64_Half e_machine;
92   Elf64_Word e_version;
93   Elf64_Addr e_entry;
94   Elf64_Off e_phoff;
95   Elf64_Off e_shoff;
96   Elf64_Word e_flags;
97   Elf64_Half e_ehsize;
98   Elf64_Half e_phentsize;
99   Elf64_Half e_phnum;
100   Elf64_Half e_shentsize;
101   Elf64_Half e_shnum;
102   Elf64_Half e_shstrndx;
103 
checkMagicElf64_Ehdr104   bool checkMagic() const {
105     return (memcmp(e_ident, ElfMagic, strlen(ElfMagic))) == 0;
106   }
107 
getFileClassElf64_Ehdr108   unsigned char getFileClass() const { return e_ident[EI_CLASS]; }
getDataEncodingElf64_Ehdr109   unsigned char getDataEncoding() const { return e_ident[EI_DATA]; }
110 };
111 
112 // File types.
113 // See current registered ELF types at:
114 //    http://www.sco.com/developers/gabi/latest/ch4.eheader.html
115 enum {
116   ET_NONE = 0,        // No file type
117   ET_REL = 1,         // Relocatable file
118   ET_EXEC = 2,        // Executable file
119   ET_DYN = 3,         // Shared object file
120   ET_CORE = 4,        // Core file
121   ET_LOOS = 0xfe00,   // Beginning of operating system-specific codes
122   ET_HIOS = 0xfeff,   // Operating system-specific
123   ET_LOPROC = 0xff00, // Beginning of processor-specific codes
124   ET_HIPROC = 0xffff  // Processor-specific
125 };
126 
127 // Versioning
128 enum { EV_NONE = 0, EV_CURRENT = 1 };
129 
130 // Machine architectures
131 // See current registered ELF machine architectures at:
132 //    http://www.uxsglobal.com/developers/gabi/latest/ch4.eheader.html
133 enum {
134   EM_NONE = 0,           // No machine
135   EM_M32 = 1,            // AT&T WE 32100
136   EM_SPARC = 2,          // SPARC
137   EM_386 = 3,            // Intel 386
138   EM_68K = 4,            // Motorola 68000
139   EM_88K = 5,            // Motorola 88000
140   EM_IAMCU = 6,          // Intel MCU
141   EM_860 = 7,            // Intel 80860
142   EM_MIPS = 8,           // MIPS R3000
143   EM_S370 = 9,           // IBM System/370
144   EM_MIPS_RS3_LE = 10,   // MIPS RS3000 Little-endian
145   EM_PARISC = 15,        // Hewlett-Packard PA-RISC
146   EM_VPP500 = 17,        // Fujitsu VPP500
147   EM_SPARC32PLUS = 18,   // Enhanced instruction set SPARC
148   EM_960 = 19,           // Intel 80960
149   EM_PPC = 20,           // PowerPC
150   EM_PPC64 = 21,         // PowerPC64
151   EM_S390 = 22,          // IBM System/390
152   EM_SPU = 23,           // IBM SPU/SPC
153   EM_V800 = 36,          // NEC V800
154   EM_FR20 = 37,          // Fujitsu FR20
155   EM_RH32 = 38,          // TRW RH-32
156   EM_RCE = 39,           // Motorola RCE
157   EM_ARM = 40,           // ARM
158   EM_ALPHA = 41,         // DEC Alpha
159   EM_SH = 42,            // Hitachi SH
160   EM_SPARCV9 = 43,       // SPARC V9
161   EM_TRICORE = 44,       // Siemens TriCore
162   EM_ARC = 45,           // Argonaut RISC Core
163   EM_H8_300 = 46,        // Hitachi H8/300
164   EM_H8_300H = 47,       // Hitachi H8/300H
165   EM_H8S = 48,           // Hitachi H8S
166   EM_H8_500 = 49,        // Hitachi H8/500
167   EM_IA_64 = 50,         // Intel IA-64 processor architecture
168   EM_MIPS_X = 51,        // Stanford MIPS-X
169   EM_COLDFIRE = 52,      // Motorola ColdFire
170   EM_68HC12 = 53,        // Motorola M68HC12
171   EM_MMA = 54,           // Fujitsu MMA Multimedia Accelerator
172   EM_PCP = 55,           // Siemens PCP
173   EM_NCPU = 56,          // Sony nCPU embedded RISC processor
174   EM_NDR1 = 57,          // Denso NDR1 microprocessor
175   EM_STARCORE = 58,      // Motorola Star*Core processor
176   EM_ME16 = 59,          // Toyota ME16 processor
177   EM_ST100 = 60,         // STMicroelectronics ST100 processor
178   EM_TINYJ = 61,         // Advanced Logic Corp. TinyJ embedded processor family
179   EM_X86_64 = 62,        // AMD x86-64 architecture
180   EM_PDSP = 63,          // Sony DSP Processor
181   EM_PDP10 = 64,         // Digital Equipment Corp. PDP-10
182   EM_PDP11 = 65,         // Digital Equipment Corp. PDP-11
183   EM_FX66 = 66,          // Siemens FX66 microcontroller
184   EM_ST9PLUS = 67,       // STMicroelectronics ST9+ 8/16 bit microcontroller
185   EM_ST7 = 68,           // STMicroelectronics ST7 8-bit microcontroller
186   EM_68HC16 = 69,        // Motorola MC68HC16 Microcontroller
187   EM_68HC11 = 70,        // Motorola MC68HC11 Microcontroller
188   EM_68HC08 = 71,        // Motorola MC68HC08 Microcontroller
189   EM_68HC05 = 72,        // Motorola MC68HC05 Microcontroller
190   EM_SVX = 73,           // Silicon Graphics SVx
191   EM_ST19 = 74,          // STMicroelectronics ST19 8-bit microcontroller
192   EM_VAX = 75,           // Digital VAX
193   EM_CRIS = 76,          // Axis Communications 32-bit embedded processor
194   EM_JAVELIN = 77,       // Infineon Technologies 32-bit embedded processor
195   EM_FIREPATH = 78,      // Element 14 64-bit DSP Processor
196   EM_ZSP = 79,           // LSI Logic 16-bit DSP Processor
197   EM_MMIX = 80,          // Donald Knuth's educational 64-bit processor
198   EM_HUANY = 81,         // Harvard University machine-independent object files
199   EM_PRISM = 82,         // SiTera Prism
200   EM_AVR = 83,           // Atmel AVR 8-bit microcontroller
201   EM_FR30 = 84,          // Fujitsu FR30
202   EM_D10V = 85,          // Mitsubishi D10V
203   EM_D30V = 86,          // Mitsubishi D30V
204   EM_V850 = 87,          // NEC v850
205   EM_M32R = 88,          // Mitsubishi M32R
206   EM_MN10300 = 89,       // Matsushita MN10300
207   EM_MN10200 = 90,       // Matsushita MN10200
208   EM_PJ = 91,            // picoJava
209   EM_OPENRISC = 92,      // OpenRISC 32-bit embedded processor
210   EM_ARC_COMPACT = 93,   // ARC International ARCompact processor (old
211                          // spelling/synonym: EM_ARC_A5)
212   EM_XTENSA = 94,        // Tensilica Xtensa Architecture
213   EM_VIDEOCORE = 95,     // Alphamosaic VideoCore processor
214   EM_TMM_GPP = 96,       // Thompson Multimedia General Purpose Processor
215   EM_NS32K = 97,         // National Semiconductor 32000 series
216   EM_TPC = 98,           // Tenor Network TPC processor
217   EM_SNP1K = 99,         // Trebia SNP 1000 processor
218   EM_ST200 = 100,        // STMicroelectronics (www.st.com) ST200
219   EM_IP2K = 101,         // Ubicom IP2xxx microcontroller family
220   EM_MAX = 102,          // MAX Processor
221   EM_CR = 103,           // National Semiconductor CompactRISC microprocessor
222   EM_F2MC16 = 104,       // Fujitsu F2MC16
223   EM_MSP430 = 105,       // Texas Instruments embedded microcontroller msp430
224   EM_BLACKFIN = 106,     // Analog Devices Blackfin (DSP) processor
225   EM_SE_C33 = 107,       // S1C33 Family of Seiko Epson processors
226   EM_SEP = 108,          // Sharp embedded microprocessor
227   EM_ARCA = 109,         // Arca RISC Microprocessor
228   EM_UNICORE = 110,      // Microprocessor series from PKU-Unity Ltd. and MPRC
229                          // of Peking University
230   EM_EXCESS = 111,       // eXcess: 16/32/64-bit configurable embedded CPU
231   EM_DXP = 112,          // Icera Semiconductor Inc. Deep Execution Processor
232   EM_ALTERA_NIOS2 = 113, // Altera Nios II soft-core processor
233   EM_CRX = 114,          // National Semiconductor CompactRISC CRX
234   EM_XGATE = 115,        // Motorola XGATE embedded processor
235   EM_C166 = 116,         // Infineon C16x/XC16x processor
236   EM_M16C = 117,         // Renesas M16C series microprocessors
237   EM_DSPIC30F = 118,     // Microchip Technology dsPIC30F Digital Signal
238                          // Controller
239   EM_CE = 119,           // Freescale Communication Engine RISC core
240   EM_M32C = 120,         // Renesas M32C series microprocessors
241   EM_TSK3000 = 131,      // Altium TSK3000 core
242   EM_RS08 = 132,         // Freescale RS08 embedded processor
243   EM_SHARC = 133,        // Analog Devices SHARC family of 32-bit DSP
244                          // processors
245   EM_ECOG2 = 134,        // Cyan Technology eCOG2 microprocessor
246   EM_SCORE7 = 135,       // Sunplus S+core7 RISC processor
247   EM_DSP24 = 136,        // New Japan Radio (NJR) 24-bit DSP Processor
248   EM_VIDEOCORE3 = 137,   // Broadcom VideoCore III processor
249   EM_LATTICEMICO32 = 138, // RISC processor for Lattice FPGA architecture
250   EM_SE_C17 = 139,        // Seiko Epson C17 family
251   EM_TI_C6000 = 140,      // The Texas Instruments TMS320C6000 DSP family
252   EM_TI_C2000 = 141,      // The Texas Instruments TMS320C2000 DSP family
253   EM_TI_C5500 = 142,      // The Texas Instruments TMS320C55x DSP family
254   EM_MMDSP_PLUS = 160,    // STMicroelectronics 64bit VLIW Data Signal Processor
255   EM_CYPRESS_M8C = 161,   // Cypress M8C microprocessor
256   EM_R32C = 162,          // Renesas R32C series microprocessors
257   EM_TRIMEDIA = 163,      // NXP Semiconductors TriMedia architecture family
258   EM_HEXAGON = 164,       // Qualcomm Hexagon processor
259   EM_8051 = 165,          // Intel 8051 and variants
260   EM_STXP7X = 166,        // STMicroelectronics STxP7x family of configurable
261                           // and extensible RISC processors
262   EM_NDS32 = 167,         // Andes Technology compact code size embedded RISC
263                           // processor family
264   EM_ECOG1 = 168,         // Cyan Technology eCOG1X family
265   EM_ECOG1X = 168,        // Cyan Technology eCOG1X family
266   EM_MAXQ30 = 169,        // Dallas Semiconductor MAXQ30 Core Micro-controllers
267   EM_XIMO16 = 170,        // New Japan Radio (NJR) 16-bit DSP Processor
268   EM_MANIK = 171,         // M2000 Reconfigurable RISC Microprocessor
269   EM_CRAYNV2 = 172,       // Cray Inc. NV2 vector architecture
270   EM_RX = 173,            // Renesas RX family
271   EM_METAG = 174,         // Imagination Technologies META processor
272                           // architecture
273   EM_MCST_ELBRUS = 175,   // MCST Elbrus general purpose hardware architecture
274   EM_ECOG16 = 176,        // Cyan Technology eCOG16 family
275   EM_CR16 = 177,          // National Semiconductor CompactRISC CR16 16-bit
276                           // microprocessor
277   EM_ETPU = 178,          // Freescale Extended Time Processing Unit
278   EM_SLE9X = 179,         // Infineon Technologies SLE9X core
279   EM_L10M = 180,          // Intel L10M
280   EM_K10M = 181,          // Intel K10M
281   EM_AARCH64 = 183,       // ARM AArch64
282   EM_AVR32 = 185,         // Atmel Corporation 32-bit microprocessor family
283   EM_STM8 = 186,          // STMicroeletronics STM8 8-bit microcontroller
284   EM_TILE64 = 187,        // Tilera TILE64 multicore architecture family
285   EM_TILEPRO = 188,       // Tilera TILEPro multicore architecture family
286   EM_MICROBLAZE = 189,    // Xilinx MicroBlaze 32-bit RISC soft processor core
287   EM_CUDA = 190,          // NVIDIA CUDA architecture
288   EM_TILEGX = 191,        // Tilera TILE-Gx multicore architecture family
289   EM_CLOUDSHIELD = 192,   // CloudShield architecture family
290   EM_COREA_1ST = 193,     // KIPO-KAIST Core-A 1st generation processor family
291   EM_COREA_2ND = 194,     // KIPO-KAIST Core-A 2nd generation processor family
292   EM_ARC_COMPACT2 = 195,  // Synopsys ARCompact V2
293   EM_OPEN8 = 196,         // Open8 8-bit RISC soft processor core
294   EM_RL78 = 197,          // Renesas RL78 family
295   EM_VIDEOCORE5 = 198,    // Broadcom VideoCore V processor
296   EM_78KOR = 199,         // Renesas 78KOR family
297   EM_56800EX = 200,       // Freescale 56800EX Digital Signal Controller (DSC)
298   EM_BA1 = 201,           // Beyond BA1 CPU architecture
299   EM_BA2 = 202,           // Beyond BA2 CPU architecture
300   EM_XCORE = 203,         // XMOS xCORE processor family
301   EM_MCHP_PIC = 204,      // Microchip 8-bit PIC(r) family
302   EM_INTEL205 = 205,      // Reserved by Intel
303   EM_INTEL206 = 206,      // Reserved by Intel
304   EM_INTEL207 = 207,      // Reserved by Intel
305   EM_INTEL208 = 208,      // Reserved by Intel
306   EM_INTEL209 = 209,      // Reserved by Intel
307   EM_KM32 = 210,          // KM211 KM32 32-bit processor
308   EM_KMX32 = 211,         // KM211 KMX32 32-bit processor
309   EM_KMX16 = 212,         // KM211 KMX16 16-bit processor
310   EM_KMX8 = 213,          // KM211 KMX8 8-bit processor
311   EM_KVARC = 214,         // KM211 KVARC processor
312   EM_CDP = 215,           // Paneve CDP architecture family
313   EM_COGE = 216,          // Cognitive Smart Memory Processor
314   EM_COOL = 217,          // iCelero CoolEngine
315   EM_NORC = 218,          // Nanoradio Optimized RISC
316   EM_CSR_KALIMBA = 219,   // CSR Kalimba architecture family
317   EM_AMDGPU = 224,        // AMD GPU architecture
318   EM_RISCV = 243,         // RISC-V
319   EM_LANAI = 244,         // Lanai 32-bit processor
320   EM_BPF = 247,           // Linux kernel bpf virtual machine
321   EM_VE = 251,            // NEC SX-Aurora VE
322   EM_CSKY = 252,          // C-SKY 32-bit processor
323   EM_LOONGARCH = 258,     // LoongArch
324 };
325 
326 // Object file classes.
327 enum {
328   ELFCLASSNONE = 0,
329   ELFCLASS32 = 1, // 32-bit object file
330   ELFCLASS64 = 2  // 64-bit object file
331 };
332 
333 // Object file byte orderings.
334 enum {
335   ELFDATANONE = 0, // Invalid data encoding.
336   ELFDATA2LSB = 1, // Little-endian object file
337   ELFDATA2MSB = 2  // Big-endian object file
338 };
339 
340 // OS ABI identification.
341 enum {
342   ELFOSABI_NONE = 0,           // UNIX System V ABI
343   ELFOSABI_HPUX = 1,           // HP-UX operating system
344   ELFOSABI_NETBSD = 2,         // NetBSD
345   ELFOSABI_GNU = 3,            // GNU/Linux
346   ELFOSABI_LINUX = 3,          // Historical alias for ELFOSABI_GNU.
347   ELFOSABI_HURD = 4,           // GNU/Hurd
348   ELFOSABI_SOLARIS = 6,        // Solaris
349   ELFOSABI_AIX = 7,            // AIX
350   ELFOSABI_IRIX = 8,           // IRIX
351   ELFOSABI_FREEBSD = 9,        // FreeBSD
352   ELFOSABI_TRU64 = 10,         // TRU64 UNIX
353   ELFOSABI_MODESTO = 11,       // Novell Modesto
354   ELFOSABI_OPENBSD = 12,       // OpenBSD
355   ELFOSABI_OPENVMS = 13,       // OpenVMS
356   ELFOSABI_NSK = 14,           // Hewlett-Packard Non-Stop Kernel
357   ELFOSABI_AROS = 15,          // AROS
358   ELFOSABI_FENIXOS = 16,       // FenixOS
359   ELFOSABI_CLOUDABI = 17,      // Nuxi CloudABI
360   ELFOSABI_CUDA = 51,          // NVIDIA CUDA architecture.
361   ELFOSABI_FIRST_ARCH = 64,    // First architecture-specific OS ABI
362   ELFOSABI_AMDGPU_HSA = 64,    // AMD HSA runtime
363   ELFOSABI_AMDGPU_PAL = 65,    // AMD PAL runtime
364   ELFOSABI_AMDGPU_MESA3D = 66, // AMD GCN GPUs (GFX6+) for MESA runtime
365   ELFOSABI_ARM = 97,           // ARM
366   ELFOSABI_ARM_FDPIC = 65,     // ARM FDPIC
367   ELFOSABI_C6000_ELFABI = 64,  // Bare-metal TMS320C6000
368   ELFOSABI_C6000_LINUX = 65,   // Linux TMS320C6000
369   ELFOSABI_STANDALONE = 255,   // Standalone (embedded) application
370   ELFOSABI_LAST_ARCH = 255     // Last Architecture-specific OS ABI
371 };
372 
373 // AMDGPU OS ABI Version identification.
374 enum {
375   // ELFABIVERSION_AMDGPU_HSA_V1 does not exist because OS ABI identification
376   // was never defined for V1.
377   ELFABIVERSION_AMDGPU_HSA_V2 = 0,
378   ELFABIVERSION_AMDGPU_HSA_V3 = 1,
379   ELFABIVERSION_AMDGPU_HSA_V4 = 2,
380   ELFABIVERSION_AMDGPU_HSA_V5 = 3,
381   ELFABIVERSION_AMDGPU_HSA_V6 = 4,
382 };
383 
384 #define ELF_RELOC(name, value) name = value,
385 
386 // X86_64 relocations.
387 enum {
388 #include "ELFRelocs/x86_64.def"
389 };
390 
391 // i386 relocations.
392 enum {
393 #include "ELFRelocs/i386.def"
394 };
395 
396 // ELF Relocation types for PPC32
397 enum {
398 #include "ELFRelocs/PowerPC.def"
399 };
400 
401 // Specific e_flags for PPC64
402 enum {
403   // e_flags bits specifying ABI:
404   // 1 for original ABI using function descriptors,
405   // 2 for revised ABI without function descriptors,
406   // 0 for unspecified or not using any features affected by the differences.
407   EF_PPC64_ABI = 3
408 };
409 
410 // Special values for the st_other field in the symbol table entry for PPC64.
411 enum {
412   STO_PPC64_LOCAL_BIT = 5,
413   STO_PPC64_LOCAL_MASK = (7 << STO_PPC64_LOCAL_BIT)
414 };
decodePPC64LocalEntryOffset(unsigned Other)415 static inline int64_t decodePPC64LocalEntryOffset(unsigned Other) {
416   unsigned Val = (Other & STO_PPC64_LOCAL_MASK) >> STO_PPC64_LOCAL_BIT;
417   return ((1 << Val) >> 2) << 2;
418 }
419 
420 // ELF Relocation types for PPC64
421 enum {
422 #include "ELFRelocs/PowerPC64.def"
423 };
424 
425 // ELF Relocation types for AArch64
426 enum {
427 #include "ELFRelocs/AArch64.def"
428 };
429 
430 // Special values for the st_other field in the symbol table entry for AArch64.
431 enum {
432   // Symbol may follow different calling convention than base PCS.
433   STO_AARCH64_VARIANT_PCS = 0x80
434 };
435 
436 // ARM Specific e_flags
437 enum : unsigned {
438   EF_ARM_SOFT_FLOAT = 0x00000200U,     // Legacy pre EABI_VER5
439   EF_ARM_ABI_FLOAT_SOFT = 0x00000200U, // EABI_VER5
440   EF_ARM_VFP_FLOAT = 0x00000400U,      // Legacy pre EABI_VER5
441   EF_ARM_ABI_FLOAT_HARD = 0x00000400U, // EABI_VER5
442   EF_ARM_BE8 = 0x00800000U,
443   EF_ARM_EABI_UNKNOWN = 0x00000000U,
444   EF_ARM_EABI_VER1 = 0x01000000U,
445   EF_ARM_EABI_VER2 = 0x02000000U,
446   EF_ARM_EABI_VER3 = 0x03000000U,
447   EF_ARM_EABI_VER4 = 0x04000000U,
448   EF_ARM_EABI_VER5 = 0x05000000U,
449   EF_ARM_EABIMASK = 0xFF000000U
450 };
451 
452 // ELF Relocation types for ARM
453 enum {
454 #include "ELFRelocs/ARM.def"
455 };
456 
457 // ARC Specific e_flags
458 enum : unsigned {
459   EF_ARC_MACH_MSK = 0x000000ff,
460   EF_ARC_OSABI_MSK = 0x00000f00,
461   E_ARC_MACH_ARC600 = 0x00000002,
462   E_ARC_MACH_ARC601 = 0x00000004,
463   E_ARC_MACH_ARC700 = 0x00000003,
464   EF_ARC_CPU_ARCV2EM = 0x00000005,
465   EF_ARC_CPU_ARCV2HS = 0x00000006,
466   E_ARC_OSABI_ORIG = 0x00000000,
467   E_ARC_OSABI_V2 = 0x00000200,
468   E_ARC_OSABI_V3 = 0x00000300,
469   E_ARC_OSABI_V4 = 0x00000400,
470   EF_ARC_PIC = 0x00000100
471 };
472 
473 // ELF Relocation types for ARC
474 enum {
475 #include "ELFRelocs/ARC.def"
476 };
477 
478 // AVR specific e_flags
479 enum : unsigned {
480   EF_AVR_ARCH_AVR1 = 1,
481   EF_AVR_ARCH_AVR2 = 2,
482   EF_AVR_ARCH_AVR25 = 25,
483   EF_AVR_ARCH_AVR3 = 3,
484   EF_AVR_ARCH_AVR31 = 31,
485   EF_AVR_ARCH_AVR35 = 35,
486   EF_AVR_ARCH_AVR4 = 4,
487   EF_AVR_ARCH_AVR5 = 5,
488   EF_AVR_ARCH_AVR51 = 51,
489   EF_AVR_ARCH_AVR6 = 6,
490   EF_AVR_ARCH_AVRTINY = 100,
491   EF_AVR_ARCH_XMEGA1 = 101,
492   EF_AVR_ARCH_XMEGA2 = 102,
493   EF_AVR_ARCH_XMEGA3 = 103,
494   EF_AVR_ARCH_XMEGA4 = 104,
495   EF_AVR_ARCH_XMEGA5 = 105,
496   EF_AVR_ARCH_XMEGA6 = 106,
497   EF_AVR_ARCH_XMEGA7 = 107,
498 
499   EF_AVR_ARCH_MASK = 0x7f, // EF_AVR_ARCH_xxx selection mask
500 
501   EF_AVR_LINKRELAX_PREPARED = 0x80, // The file is prepared for linker
502                                     // relaxation to be applied
503 };
504 
505 // ELF Relocation types for AVR
506 enum {
507 #include "ELFRelocs/AVR.def"
508 };
509 
510 // Mips Specific e_flags
511 enum : unsigned {
512   EF_MIPS_NOREORDER = 0x00000001, // Don't reorder instructions
513   EF_MIPS_PIC = 0x00000002,       // Position independent code
514   EF_MIPS_CPIC = 0x00000004,      // Call object with Position independent code
515   EF_MIPS_ABI2 = 0x00000020,      // File uses N32 ABI
516   EF_MIPS_32BITMODE = 0x00000100, // Code compiled for a 64-bit machine
517                                   // in 32-bit mode
518   EF_MIPS_FP64 = 0x00000200,      // Code compiled for a 32-bit machine
519                                   // but uses 64-bit FP registers
520   EF_MIPS_NAN2008 = 0x00000400,   // Uses IEE 754-2008 NaN encoding
521 
522   // ABI flags
523   EF_MIPS_ABI_O32 = 0x00001000, // This file follows the first MIPS 32 bit ABI
524   EF_MIPS_ABI_O64 = 0x00002000, // O32 ABI extended for 64-bit architecture.
525   EF_MIPS_ABI_EABI32 = 0x00003000, // EABI in 32 bit mode.
526   EF_MIPS_ABI_EABI64 = 0x00004000, // EABI in 64 bit mode.
527   EF_MIPS_ABI = 0x0000f000,        // Mask for selecting EF_MIPS_ABI_ variant.
528 
529   // MIPS machine variant
530   EF_MIPS_MACH_NONE = 0x00000000,    // A standard MIPS implementation.
531   EF_MIPS_MACH_3900 = 0x00810000,    // Toshiba R3900
532   EF_MIPS_MACH_4010 = 0x00820000,    // LSI R4010
533   EF_MIPS_MACH_4100 = 0x00830000,    // NEC VR4100
534   EF_MIPS_MACH_4650 = 0x00850000,    // MIPS R4650
535   EF_MIPS_MACH_4120 = 0x00870000,    // NEC VR4120
536   EF_MIPS_MACH_4111 = 0x00880000,    // NEC VR4111/VR4181
537   EF_MIPS_MACH_SB1 = 0x008a0000,     // Broadcom SB-1
538   EF_MIPS_MACH_OCTEON = 0x008b0000,  // Cavium Networks Octeon
539   EF_MIPS_MACH_XLR = 0x008c0000,     // RMI Xlr
540   EF_MIPS_MACH_OCTEON2 = 0x008d0000, // Cavium Networks Octeon2
541   EF_MIPS_MACH_OCTEON3 = 0x008e0000, // Cavium Networks Octeon3
542   EF_MIPS_MACH_5400 = 0x00910000,    // NEC VR5400
543   EF_MIPS_MACH_5900 = 0x00920000,    // MIPS R5900
544   EF_MIPS_MACH_5500 = 0x00980000,    // NEC VR5500
545   EF_MIPS_MACH_9000 = 0x00990000,    // Unknown
546   EF_MIPS_MACH_LS2E = 0x00a00000,    // ST Microelectronics Loongson 2E
547   EF_MIPS_MACH_LS2F = 0x00a10000,    // ST Microelectronics Loongson 2F
548   EF_MIPS_MACH_LS3A = 0x00a20000,    // Loongson 3A
549   EF_MIPS_MACH = 0x00ff0000,         // EF_MIPS_MACH_xxx selection mask
550 
551   // ARCH_ASE
552   EF_MIPS_MICROMIPS = 0x02000000,     // microMIPS
553   EF_MIPS_ARCH_ASE_M16 = 0x04000000,  // Has Mips-16 ISA extensions
554   EF_MIPS_ARCH_ASE_MDMX = 0x08000000, // Has MDMX multimedia extensions
555   EF_MIPS_ARCH_ASE = 0x0f000000,      // Mask for EF_MIPS_ARCH_ASE_xxx flags
556 
557   // ARCH
558   EF_MIPS_ARCH_1 = 0x00000000,    // MIPS1 instruction set
559   EF_MIPS_ARCH_2 = 0x10000000,    // MIPS2 instruction set
560   EF_MIPS_ARCH_3 = 0x20000000,    // MIPS3 instruction set
561   EF_MIPS_ARCH_4 = 0x30000000,    // MIPS4 instruction set
562   EF_MIPS_ARCH_5 = 0x40000000,    // MIPS5 instruction set
563   EF_MIPS_ARCH_32 = 0x50000000,   // MIPS32 instruction set per linux not elf.h
564   EF_MIPS_ARCH_64 = 0x60000000,   // MIPS64 instruction set per linux not elf.h
565   EF_MIPS_ARCH_32R2 = 0x70000000, // mips32r2, mips32r3, mips32r5
566   EF_MIPS_ARCH_64R2 = 0x80000000, // mips64r2, mips64r3, mips64r5
567   EF_MIPS_ARCH_32R6 = 0x90000000, // mips32r6
568   EF_MIPS_ARCH_64R6 = 0xa0000000, // mips64r6
569   EF_MIPS_ARCH = 0xf0000000       // Mask for applying EF_MIPS_ARCH_ variant
570 };
571 
572 // MIPS-specific section indexes
573 enum {
574   SHN_MIPS_ACOMMON = 0xff00,   // Common symbols which are defined and allocated
575   SHN_MIPS_TEXT = 0xff01,      // Not ABI compliant
576   SHN_MIPS_DATA = 0xff02,      // Not ABI compliant
577   SHN_MIPS_SCOMMON = 0xff03,   // Common symbols for global data area
578   SHN_MIPS_SUNDEFINED = 0xff04 // Undefined symbols for global data area
579 };
580 
581 // ELF Relocation types for Mips
582 enum {
583 #include "ELFRelocs/Mips.def"
584 };
585 
586 // Special values for the st_other field in the symbol table entry for MIPS.
587 enum {
588   STO_MIPS_OPTIONAL = 0x04,  // Symbol whose definition is optional
589   STO_MIPS_PLT = 0x08,       // PLT entry related dynamic table record
590   STO_MIPS_PIC = 0x20,       // PIC func in an object mixes PIC/non-PIC
591   STO_MIPS_MICROMIPS = 0x80, // MIPS Specific ISA for MicroMips
592   STO_MIPS_MIPS16 = 0xf0     // MIPS Specific ISA for Mips16
593 };
594 
595 // .MIPS.options section descriptor kinds
596 enum {
597   ODK_NULL = 0,       // Undefined
598   ODK_REGINFO = 1,    // Register usage information
599   ODK_EXCEPTIONS = 2, // Exception processing options
600   ODK_PAD = 3,        // Section padding options
601   ODK_HWPATCH = 4,    // Hardware patches applied
602   ODK_FILL = 5,       // Linker fill value
603   ODK_TAGS = 6,       // Space for tool identification
604   ODK_HWAND = 7,      // Hardware AND patches applied
605   ODK_HWOR = 8,       // Hardware OR patches applied
606   ODK_GP_GROUP = 9,   // GP group to use for text/data sections
607   ODK_IDENT = 10,     // ID information
608   ODK_PAGESIZE = 11   // Page size information
609 };
610 
611 // Hexagon-specific e_flags
612 enum {
613   // Object processor version flags, bits[11:0]
614   EF_HEXAGON_MACH_V2 = 0x00000001,   // Hexagon V2
615   EF_HEXAGON_MACH_V3 = 0x00000002,   // Hexagon V3
616   EF_HEXAGON_MACH_V4 = 0x00000003,   // Hexagon V4
617   EF_HEXAGON_MACH_V5 = 0x00000004,   // Hexagon V5
618   EF_HEXAGON_MACH_V55 = 0x00000005,  // Hexagon V55
619   EF_HEXAGON_MACH_V60 = 0x00000060,  // Hexagon V60
620   EF_HEXAGON_MACH_V62 = 0x00000062,  // Hexagon V62
621   EF_HEXAGON_MACH_V65 = 0x00000065,  // Hexagon V65
622   EF_HEXAGON_MACH_V66 = 0x00000066,  // Hexagon V66
623   EF_HEXAGON_MACH_V67 = 0x00000067,  // Hexagon V67
624   EF_HEXAGON_MACH_V67T = 0x00008067, // Hexagon V67T
625   EF_HEXAGON_MACH_V68 = 0x00000068,  // Hexagon V68
626   EF_HEXAGON_MACH_V69 = 0x00000069,  // Hexagon V69
627   EF_HEXAGON_MACH_V71 = 0x00000071,  // Hexagon V71
628   EF_HEXAGON_MACH_V71T = 0x00008071, // Hexagon V71T
629   EF_HEXAGON_MACH_V73 = 0x00000073,  // Hexagon V73
630   EF_HEXAGON_MACH = 0x000003ff,      // Hexagon V..
631 
632   // Highest ISA version flags
633   EF_HEXAGON_ISA_MACH = 0x00000000, // Same as specified in bits[11:0]
634                                     // of e_flags
635   EF_HEXAGON_ISA_V2 = 0x00000010,   // Hexagon V2 ISA
636   EF_HEXAGON_ISA_V3 = 0x00000020,   // Hexagon V3 ISA
637   EF_HEXAGON_ISA_V4 = 0x00000030,   // Hexagon V4 ISA
638   EF_HEXAGON_ISA_V5 = 0x00000040,   // Hexagon V5 ISA
639   EF_HEXAGON_ISA_V55 = 0x00000050,  // Hexagon V55 ISA
640   EF_HEXAGON_ISA_V60 = 0x00000060,  // Hexagon V60 ISA
641   EF_HEXAGON_ISA_V62 = 0x00000062,  // Hexagon V62 ISA
642   EF_HEXAGON_ISA_V65 = 0x00000065,  // Hexagon V65 ISA
643   EF_HEXAGON_ISA_V66 = 0x00000066,  // Hexagon V66 ISA
644   EF_HEXAGON_ISA_V67 = 0x00000067,  // Hexagon V67 ISA
645   EF_HEXAGON_ISA_V68 = 0x00000068,  // Hexagon V68 ISA
646   EF_HEXAGON_ISA_V69 = 0x00000069,  // Hexagon V69 ISA
647   EF_HEXAGON_ISA_V71 = 0x00000071,  // Hexagon V71 ISA
648   EF_HEXAGON_ISA_V73 = 0x00000073,  // Hexagon V73 ISA
649   EF_HEXAGON_ISA_V75 = 0x00000075,  // Hexagon V75 ISA
650   EF_HEXAGON_ISA = 0x000003ff,      // Hexagon V.. ISA
651 };
652 
653 // Hexagon-specific section indexes for common small data
654 enum {
655   SHN_HEXAGON_SCOMMON = 0xff00,   // Other access sizes
656   SHN_HEXAGON_SCOMMON_1 = 0xff01, // Byte-sized access
657   SHN_HEXAGON_SCOMMON_2 = 0xff02, // Half-word-sized access
658   SHN_HEXAGON_SCOMMON_4 = 0xff03, // Word-sized access
659   SHN_HEXAGON_SCOMMON_8 = 0xff04  // Double-word-size access
660 };
661 
662 // ELF Relocation types for Hexagon
663 enum {
664 #include "ELFRelocs/Hexagon.def"
665 };
666 
667 // ELF Relocation type for Lanai.
668 enum {
669 #include "ELFRelocs/Lanai.def"
670 };
671 
672 // RISCV Specific e_flags
673 enum : unsigned {
674   EF_RISCV_RVC = 0x0001,
675   EF_RISCV_FLOAT_ABI = 0x0006,
676   EF_RISCV_FLOAT_ABI_SOFT = 0x0000,
677   EF_RISCV_FLOAT_ABI_SINGLE = 0x0002,
678   EF_RISCV_FLOAT_ABI_DOUBLE = 0x0004,
679   EF_RISCV_FLOAT_ABI_QUAD = 0x0006,
680   EF_RISCV_RVE = 0x0008,
681   EF_RISCV_TSO = 0x0010,
682 };
683 
684 // ELF Relocation types for RISC-V
685 enum {
686 #include "ELFRelocs/RISCV.def"
687 };
688 
689 enum {
690   // Symbol may follow different calling convention than the standard calling
691   // convention.
692   STO_RISCV_VARIANT_CC = 0x80
693 };
694 
695 // ELF Relocation types for S390/zSeries
696 enum {
697 #include "ELFRelocs/SystemZ.def"
698 };
699 
700 // SPARC Specific e_flags
701 enum : unsigned {
702   // ELF extension mask.
703   // All values are available for EM_SPARC32PLUS & EM_SPARCV9 objects, except
704   // EF_SPARC_32PLUS which is a EM_SPARC32PLUS-only flag.
705   //
706   // Note that those features are not mutually exclusive (one can set more than
707   // one flag in this group).
708   EF_SPARC_EXT_MASK = 0xffff00,
709   EF_SPARC_32PLUS = 0x000100,
710   EF_SPARC_SUN_US1 = 0x000200,
711   EF_SPARC_HAL_R1 = 0x000400,
712   EF_SPARC_SUN_US3 = 0x000800,
713 
714   // Memory model selection mask for EM_SPARCV9 objects.
715   EF_SPARCV9_MM = 0x3,
716   EF_SPARCV9_TSO = 0x0,
717   EF_SPARCV9_PSO = 0x1,
718   EF_SPARCV9_RMO = 0x2,
719 };
720 
721 // ELF Relocation type for Sparc.
722 enum {
723 #include "ELFRelocs/Sparc.def"
724 };
725 
726 // AMDGPU specific e_flags.
727 enum : unsigned {
728   // Processor selection mask for EF_AMDGPU_MACH_* values.
729   EF_AMDGPU_MACH = 0x0ff,
730 
731   // Not specified processor.
732   EF_AMDGPU_MACH_NONE = 0x000,
733 
734   // R600-based processors.
735 
736   // Radeon HD 2000/3000 Series (R600).
737   EF_AMDGPU_MACH_R600_R600 = 0x001,
738   EF_AMDGPU_MACH_R600_R630 = 0x002,
739   EF_AMDGPU_MACH_R600_RS880 = 0x003,
740   EF_AMDGPU_MACH_R600_RV670 = 0x004,
741   // Radeon HD 4000 Series (R700).
742   EF_AMDGPU_MACH_R600_RV710 = 0x005,
743   EF_AMDGPU_MACH_R600_RV730 = 0x006,
744   EF_AMDGPU_MACH_R600_RV770 = 0x007,
745   // Radeon HD 5000 Series (Evergreen).
746   EF_AMDGPU_MACH_R600_CEDAR = 0x008,
747   EF_AMDGPU_MACH_R600_CYPRESS = 0x009,
748   EF_AMDGPU_MACH_R600_JUNIPER = 0x00a,
749   EF_AMDGPU_MACH_R600_REDWOOD = 0x00b,
750   EF_AMDGPU_MACH_R600_SUMO = 0x00c,
751   // Radeon HD 6000 Series (Northern Islands).
752   EF_AMDGPU_MACH_R600_BARTS = 0x00d,
753   EF_AMDGPU_MACH_R600_CAICOS = 0x00e,
754   EF_AMDGPU_MACH_R600_CAYMAN = 0x00f,
755   EF_AMDGPU_MACH_R600_TURKS = 0x010,
756 
757   // Reserved for R600-based processors.
758   EF_AMDGPU_MACH_R600_RESERVED_FIRST = 0x011,
759   EF_AMDGPU_MACH_R600_RESERVED_LAST = 0x01f,
760 
761   // First/last R600-based processors.
762   EF_AMDGPU_MACH_R600_FIRST = EF_AMDGPU_MACH_R600_R600,
763   EF_AMDGPU_MACH_R600_LAST = EF_AMDGPU_MACH_R600_TURKS,
764 
765   // AMDGCN-based processors.
766   // clang-format off
767   EF_AMDGPU_MACH_AMDGCN_GFX600          = 0x020,
768   EF_AMDGPU_MACH_AMDGCN_GFX601          = 0x021,
769   EF_AMDGPU_MACH_AMDGCN_GFX700          = 0x022,
770   EF_AMDGPU_MACH_AMDGCN_GFX701          = 0x023,
771   EF_AMDGPU_MACH_AMDGCN_GFX702          = 0x024,
772   EF_AMDGPU_MACH_AMDGCN_GFX703          = 0x025,
773   EF_AMDGPU_MACH_AMDGCN_GFX704          = 0x026,
774   EF_AMDGPU_MACH_AMDGCN_RESERVED_0X27   = 0x027,
775   EF_AMDGPU_MACH_AMDGCN_GFX801          = 0x028,
776   EF_AMDGPU_MACH_AMDGCN_GFX802          = 0x029,
777   EF_AMDGPU_MACH_AMDGCN_GFX803          = 0x02a,
778   EF_AMDGPU_MACH_AMDGCN_GFX810          = 0x02b,
779   EF_AMDGPU_MACH_AMDGCN_GFX900          = 0x02c,
780   EF_AMDGPU_MACH_AMDGCN_GFX902          = 0x02d,
781   EF_AMDGPU_MACH_AMDGCN_GFX904          = 0x02e,
782   EF_AMDGPU_MACH_AMDGCN_GFX906          = 0x02f,
783   EF_AMDGPU_MACH_AMDGCN_GFX908          = 0x030,
784   EF_AMDGPU_MACH_AMDGCN_GFX909          = 0x031,
785   EF_AMDGPU_MACH_AMDGCN_GFX90C          = 0x032,
786   EF_AMDGPU_MACH_AMDGCN_GFX1010         = 0x033,
787   EF_AMDGPU_MACH_AMDGCN_GFX1011         = 0x034,
788   EF_AMDGPU_MACH_AMDGCN_GFX1012         = 0x035,
789   EF_AMDGPU_MACH_AMDGCN_GFX1030         = 0x036,
790   EF_AMDGPU_MACH_AMDGCN_GFX1031         = 0x037,
791   EF_AMDGPU_MACH_AMDGCN_GFX1032         = 0x038,
792   EF_AMDGPU_MACH_AMDGCN_GFX1033         = 0x039,
793   EF_AMDGPU_MACH_AMDGCN_GFX602          = 0x03a,
794   EF_AMDGPU_MACH_AMDGCN_GFX705          = 0x03b,
795   EF_AMDGPU_MACH_AMDGCN_GFX805          = 0x03c,
796   EF_AMDGPU_MACH_AMDGCN_GFX1035         = 0x03d,
797   EF_AMDGPU_MACH_AMDGCN_GFX1034         = 0x03e,
798   EF_AMDGPU_MACH_AMDGCN_GFX90A          = 0x03f,
799   EF_AMDGPU_MACH_AMDGCN_GFX940          = 0x040,
800   EF_AMDGPU_MACH_AMDGCN_GFX1100         = 0x041,
801   EF_AMDGPU_MACH_AMDGCN_GFX1013         = 0x042,
802   EF_AMDGPU_MACH_AMDGCN_GFX1150         = 0x043,
803   EF_AMDGPU_MACH_AMDGCN_GFX1103         = 0x044,
804   EF_AMDGPU_MACH_AMDGCN_GFX1036         = 0x045,
805   EF_AMDGPU_MACH_AMDGCN_GFX1101         = 0x046,
806   EF_AMDGPU_MACH_AMDGCN_GFX1102         = 0x047,
807   EF_AMDGPU_MACH_AMDGCN_GFX1200         = 0x048,
808   EF_AMDGPU_MACH_AMDGCN_RESERVED_0X49   = 0x049,
809   EF_AMDGPU_MACH_AMDGCN_GFX1151         = 0x04a,
810   EF_AMDGPU_MACH_AMDGCN_GFX941          = 0x04b,
811   EF_AMDGPU_MACH_AMDGCN_GFX942          = 0x04c,
812   EF_AMDGPU_MACH_AMDGCN_RESERVED_0X4D   = 0x04d,
813   EF_AMDGPU_MACH_AMDGCN_GFX1201         = 0x04e,
814   EF_AMDGPU_MACH_AMDGCN_RESERVED_0X4F   = 0x04f,
815   EF_AMDGPU_MACH_AMDGCN_RESERVED_0X50   = 0x050,
816   EF_AMDGPU_MACH_AMDGCN_GFX9_GENERIC    = 0x051,
817   EF_AMDGPU_MACH_AMDGCN_GFX10_1_GENERIC = 0x052,
818   EF_AMDGPU_MACH_AMDGCN_GFX10_3_GENERIC = 0x053,
819   EF_AMDGPU_MACH_AMDGCN_GFX11_GENERIC   = 0x054,
820   EF_AMDGPU_MACH_AMDGCN_GFX1152         = 0x055,
821   EF_AMDGPU_MACH_AMDGCN_RESERVED_0X56   = 0x056,
822   EF_AMDGPU_MACH_AMDGCN_RESERVED_0X57   = 0x057,
823   EF_AMDGPU_MACH_AMDGCN_RESERVED_0X58   = 0x058,
824   EF_AMDGPU_MACH_AMDGCN_GFX12_GENERIC   = 0x059,
825   // clang-format on
826 
827   // First/last AMDGCN-based processors.
828   EF_AMDGPU_MACH_AMDGCN_FIRST = EF_AMDGPU_MACH_AMDGCN_GFX600,
829   EF_AMDGPU_MACH_AMDGCN_LAST = EF_AMDGPU_MACH_AMDGCN_GFX12_GENERIC,
830 
831   // Indicates if the "xnack" target feature is enabled for all code contained
832   // in the object.
833   //
834   // Only valid for ELFOSABI_AMDGPU_HSA and ELFABIVERSION_AMDGPU_HSA_V2.
835   EF_AMDGPU_FEATURE_XNACK_V2 = 0x01,
836   // Indicates if the trap handler is enabled for all code contained
837   // in the object.
838   //
839   // Only valid for ELFOSABI_AMDGPU_HSA and ELFABIVERSION_AMDGPU_HSA_V2.
840   EF_AMDGPU_FEATURE_TRAP_HANDLER_V2 = 0x02,
841 
842   // Indicates if the "xnack" target feature is enabled for all code contained
843   // in the object.
844   //
845   // Only valid for ELFOSABI_AMDGPU_HSA and ELFABIVERSION_AMDGPU_HSA_V3.
846   EF_AMDGPU_FEATURE_XNACK_V3 = 0x100,
847   // Indicates if the "sramecc" target feature is enabled for all code
848   // contained in the object.
849   //
850   // Only valid for ELFOSABI_AMDGPU_HSA and ELFABIVERSION_AMDGPU_HSA_V3.
851   EF_AMDGPU_FEATURE_SRAMECC_V3 = 0x200,
852 
853   // XNACK selection mask for EF_AMDGPU_FEATURE_XNACK_* values.
854   //
855   // Only valid for ELFOSABI_AMDGPU_HSA and ELFABIVERSION_AMDGPU_HSA_V4.
856   EF_AMDGPU_FEATURE_XNACK_V4 = 0x300,
857   // XNACK is not supported.
858   EF_AMDGPU_FEATURE_XNACK_UNSUPPORTED_V4 = 0x000,
859   // XNACK is any/default/unspecified.
860   EF_AMDGPU_FEATURE_XNACK_ANY_V4 = 0x100,
861   // XNACK is off.
862   EF_AMDGPU_FEATURE_XNACK_OFF_V4 = 0x200,
863   // XNACK is on.
864   EF_AMDGPU_FEATURE_XNACK_ON_V4 = 0x300,
865 
866   // SRAMECC selection mask for EF_AMDGPU_FEATURE_SRAMECC_* values.
867   //
868   // Only valid for ELFOSABI_AMDGPU_HSA and ELFABIVERSION_AMDGPU_HSA_V4.
869   EF_AMDGPU_FEATURE_SRAMECC_V4 = 0xc00,
870   // SRAMECC is not supported.
871   EF_AMDGPU_FEATURE_SRAMECC_UNSUPPORTED_V4 = 0x000,
872   // SRAMECC is any/default/unspecified.
873   EF_AMDGPU_FEATURE_SRAMECC_ANY_V4 = 0x400,
874   // SRAMECC is off.
875   EF_AMDGPU_FEATURE_SRAMECC_OFF_V4 = 0x800,
876   // SRAMECC is on.
877   EF_AMDGPU_FEATURE_SRAMECC_ON_V4 = 0xc00,
878 
879   // Generic target versioning. This is contained in the list byte of EFLAGS.
880   EF_AMDGPU_GENERIC_VERSION = 0xff000000,
881   EF_AMDGPU_GENERIC_VERSION_OFFSET = 24,
882   EF_AMDGPU_GENERIC_VERSION_MIN = 1,
883   EF_AMDGPU_GENERIC_VERSION_MAX = 0xff,
884 };
885 
886 // ELF Relocation types for AMDGPU
887 enum {
888 #include "ELFRelocs/AMDGPU.def"
889 };
890 
891 // NVPTX specific e_flags.
892 enum : unsigned {
893   // Processor selection mask for EF_CUDA_SM* values.
894   EF_CUDA_SM = 0xff,
895 
896   // SM based processor values.
897   EF_CUDA_SM20 = 0x14,
898   EF_CUDA_SM21 = 0x15,
899   EF_CUDA_SM30 = 0x1e,
900   EF_CUDA_SM32 = 0x20,
901   EF_CUDA_SM35 = 0x23,
902   EF_CUDA_SM37 = 0x25,
903   EF_CUDA_SM50 = 0x32,
904   EF_CUDA_SM52 = 0x34,
905   EF_CUDA_SM53 = 0x35,
906   EF_CUDA_SM60 = 0x3c,
907   EF_CUDA_SM61 = 0x3d,
908   EF_CUDA_SM62 = 0x3e,
909   EF_CUDA_SM70 = 0x46,
910   EF_CUDA_SM72 = 0x48,
911   EF_CUDA_SM75 = 0x4b,
912   EF_CUDA_SM80 = 0x50,
913   EF_CUDA_SM86 = 0x56,
914   EF_CUDA_SM87 = 0x57,
915   EF_CUDA_SM89 = 0x59,
916   // The sm_90a variant uses the same machine flag.
917   EF_CUDA_SM90 = 0x5a,
918 
919   // Unified texture binding is enabled.
920   EF_CUDA_TEXMODE_UNIFIED = 0x100,
921   // Independent texture binding is enabled.
922   EF_CUDA_TEXMODE_INDEPENDANT = 0x200,
923   // The target is using 64-bit addressing.
924   EF_CUDA_64BIT_ADDRESS = 0x400,
925   // Set when using the sm_90a processor.
926   EF_CUDA_ACCELERATORS = 0x800,
927   // Undocumented software feature.
928   EF_CUDA_SW_FLAG_V2 = 0x1000,
929 
930   // Virtual processor selection mask for EF_CUDA_VIRTUAL_SM* values.
931   EF_CUDA_VIRTUAL_SM = 0xff0000,
932 };
933 
934 // ELF Relocation types for BPF
935 enum {
936 #include "ELFRelocs/BPF.def"
937 };
938 
939 // ELF Relocation types for M68k
940 enum {
941 #include "ELFRelocs/M68k.def"
942 };
943 
944 // MSP430 specific e_flags
945 enum : unsigned {
946   EF_MSP430_MACH_MSP430x11 = 11,
947   EF_MSP430_MACH_MSP430x11x1 = 110,
948   EF_MSP430_MACH_MSP430x12 = 12,
949   EF_MSP430_MACH_MSP430x13 = 13,
950   EF_MSP430_MACH_MSP430x14 = 14,
951   EF_MSP430_MACH_MSP430x15 = 15,
952   EF_MSP430_MACH_MSP430x16 = 16,
953   EF_MSP430_MACH_MSP430x20 = 20,
954   EF_MSP430_MACH_MSP430x22 = 22,
955   EF_MSP430_MACH_MSP430x23 = 23,
956   EF_MSP430_MACH_MSP430x24 = 24,
957   EF_MSP430_MACH_MSP430x26 = 26,
958   EF_MSP430_MACH_MSP430x31 = 31,
959   EF_MSP430_MACH_MSP430x32 = 32,
960   EF_MSP430_MACH_MSP430x33 = 33,
961   EF_MSP430_MACH_MSP430x41 = 41,
962   EF_MSP430_MACH_MSP430x42 = 42,
963   EF_MSP430_MACH_MSP430x43 = 43,
964   EF_MSP430_MACH_MSP430x44 = 44,
965   EF_MSP430_MACH_MSP430X = 45,
966   EF_MSP430_MACH_MSP430x46 = 46,
967   EF_MSP430_MACH_MSP430x47 = 47,
968   EF_MSP430_MACH_MSP430x54 = 54,
969 };
970 
971 // ELF Relocation types for MSP430
972 enum {
973 #include "ELFRelocs/MSP430.def"
974 };
975 
976 // ELF Relocation type for VE.
977 enum {
978 #include "ELFRelocs/VE.def"
979 };
980 
981 // CSKY Specific e_flags
982 enum : unsigned {
983   EF_CSKY_801 = 0xa,
984   EF_CSKY_802 = 0x10,
985   EF_CSKY_803 = 0x9,
986   EF_CSKY_805 = 0x11,
987   EF_CSKY_807 = 0x6,
988   EF_CSKY_810 = 0x8,
989   EF_CSKY_860 = 0xb,
990   EF_CSKY_800 = 0x1f,
991   EF_CSKY_FLOAT = 0x2000,
992   EF_CSKY_DSP = 0x4000,
993   EF_CSKY_ABIV2 = 0x20000000,
994   EF_CSKY_EFV1 = 0x1000000,
995   EF_CSKY_EFV2 = 0x2000000,
996   EF_CSKY_EFV3 = 0x3000000
997 };
998 
999 // ELF Relocation types for CSKY
1000 enum {
1001 #include "ELFRelocs/CSKY.def"
1002 };
1003 
1004 // LoongArch Specific e_flags
1005 enum : unsigned {
1006   // Definitions from LoongArch ELF psABI v2.01.
1007   // Reference: https://github.com/loongson/LoongArch-Documentation
1008   // (commit hash 296de4def055c871809068e0816325a4ac04eb12)
1009 
1010   // Base ABI Modifiers
1011   EF_LOONGARCH_ABI_SOFT_FLOAT    = 0x1,
1012   EF_LOONGARCH_ABI_SINGLE_FLOAT  = 0x2,
1013   EF_LOONGARCH_ABI_DOUBLE_FLOAT  = 0x3,
1014   EF_LOONGARCH_ABI_MODIFIER_MASK = 0x7,
1015 
1016   // Object file ABI versions
1017   EF_LOONGARCH_OBJABI_V0   = 0x0,
1018   EF_LOONGARCH_OBJABI_V1   = 0x40,
1019   EF_LOONGARCH_OBJABI_MASK = 0xC0,
1020 };
1021 
1022 // ELF Relocation types for LoongArch
1023 enum {
1024 #include "ELFRelocs/LoongArch.def"
1025 };
1026 
1027 // Xtensa specific e_flags
1028 enum : unsigned {
1029   // Four-bit Xtensa machine type mask.
1030   EF_XTENSA_MACH = 0x0000000f,
1031   // Various CPU types.
1032   EF_XTENSA_MACH_NONE = 0x00000000, // A base Xtensa implementation
1033   EF_XTENSA_XT_INSN = 0x00000100,
1034   EF_XTENSA_XT_LIT = 0x00000200,
1035 };
1036 
1037 // ELF Relocation types for Xtensa
1038 enum {
1039 #include "ELFRelocs/Xtensa.def"
1040 };
1041 
1042 #undef ELF_RELOC
1043 
1044 // Section header.
1045 struct Elf32_Shdr {
1046   Elf32_Word sh_name;      // Section name (index into string table)
1047   Elf32_Word sh_type;      // Section type (SHT_*)
1048   Elf32_Word sh_flags;     // Section flags (SHF_*)
1049   Elf32_Addr sh_addr;      // Address where section is to be loaded
1050   Elf32_Off sh_offset;     // File offset of section data, in bytes
1051   Elf32_Word sh_size;      // Size of section, in bytes
1052   Elf32_Word sh_link;      // Section type-specific header table index link
1053   Elf32_Word sh_info;      // Section type-specific extra information
1054   Elf32_Word sh_addralign; // Section address alignment
1055   Elf32_Word sh_entsize;   // Size of records contained within the section
1056 };
1057 
1058 // Section header for ELF64 - same fields as ELF32, different types.
1059 struct Elf64_Shdr {
1060   Elf64_Word sh_name;
1061   Elf64_Word sh_type;
1062   Elf64_Xword sh_flags;
1063   Elf64_Addr sh_addr;
1064   Elf64_Off sh_offset;
1065   Elf64_Xword sh_size;
1066   Elf64_Word sh_link;
1067   Elf64_Word sh_info;
1068   Elf64_Xword sh_addralign;
1069   Elf64_Xword sh_entsize;
1070 };
1071 
1072 // Special section indices.
1073 enum {
1074   SHN_UNDEF = 0,          // Undefined, missing, irrelevant, or meaningless
1075   SHN_LORESERVE = 0xff00, // Lowest reserved index
1076   SHN_LOPROC = 0xff00,    // Lowest processor-specific index
1077   SHN_HIPROC = 0xff1f,    // Highest processor-specific index
1078   SHN_LOOS = 0xff20,      // Lowest operating system-specific index
1079   SHN_HIOS = 0xff3f,      // Highest operating system-specific index
1080   SHN_ABS = 0xfff1,       // Symbol has absolute value; does not need relocation
1081   SHN_COMMON = 0xfff2,    // FORTRAN COMMON or C external global variables
1082   SHN_XINDEX = 0xffff,    // Mark that the index is >= SHN_LORESERVE
1083   SHN_HIRESERVE = 0xffff  // Highest reserved index
1084 };
1085 
1086 // Section types.
1087 enum : unsigned {
1088   SHT_NULL = 0,           // No associated section (inactive entry).
1089   SHT_PROGBITS = 1,       // Program-defined contents.
1090   SHT_SYMTAB = 2,         // Symbol table.
1091   SHT_STRTAB = 3,         // String table.
1092   SHT_RELA = 4,           // Relocation entries; explicit addends.
1093   SHT_HASH = 5,           // Symbol hash table.
1094   SHT_DYNAMIC = 6,        // Information for dynamic linking.
1095   SHT_NOTE = 7,           // Information about the file.
1096   SHT_NOBITS = 8,         // Data occupies no space in the file.
1097   SHT_REL = 9,            // Relocation entries; no explicit addends.
1098   SHT_SHLIB = 10,         // Reserved.
1099   SHT_DYNSYM = 11,        // Symbol table.
1100   SHT_INIT_ARRAY = 14,    // Pointers to initialization functions.
1101   SHT_FINI_ARRAY = 15,    // Pointers to termination functions.
1102   SHT_PREINIT_ARRAY = 16, // Pointers to pre-init functions.
1103   SHT_GROUP = 17,         // Section group.
1104   SHT_SYMTAB_SHNDX = 18,  // Indices for SHN_XINDEX entries.
1105   // Experimental support for SHT_RELR sections. For details, see proposal
1106   // at https://groups.google.com/forum/#!topic/generic-abi/bX460iggiKg
1107   SHT_RELR = 19, // Relocation entries; only offsets.
1108   // TODO: Experimental CREL relocations. LLVM will change the value and
1109   // break compatibility in the future.
1110   SHT_CREL = 0x40000014,
1111   SHT_LOOS = 0x60000000, // Lowest operating system-specific type.
1112   // Android packed relocation section types.
1113   // https://android.googlesource.com/platform/bionic/+/6f12bfece5dcc01325e0abba56a46b1bcf991c69/tools/relocation_packer/src/elf_file.cc#37
1114   SHT_ANDROID_REL = 0x60000001,
1115   SHT_ANDROID_RELA = 0x60000002,
1116   SHT_LLVM_ODRTAB = 0x6fff4c00,         // LLVM ODR table.
1117   SHT_LLVM_LINKER_OPTIONS = 0x6fff4c01, // LLVM Linker Options.
1118   SHT_LLVM_ADDRSIG = 0x6fff4c03,        // List of address-significant symbols
1119                                         // for safe ICF.
1120   SHT_LLVM_DEPENDENT_LIBRARIES =
1121       0x6fff4c04,                  // LLVM Dependent Library Specifiers.
1122   SHT_LLVM_SYMPART = 0x6fff4c05,   // Symbol partition specification.
1123   SHT_LLVM_PART_EHDR = 0x6fff4c06, // ELF header for loadable partition.
1124   SHT_LLVM_PART_PHDR = 0x6fff4c07, // Phdrs for loadable partition.
1125   SHT_LLVM_BB_ADDR_MAP_V0 =
1126       0x6fff4c08, // LLVM Basic Block Address Map (old version kept for
1127                   // backward-compatibility).
1128   SHT_LLVM_CALL_GRAPH_PROFILE = 0x6fff4c09, // LLVM Call Graph Profile.
1129   SHT_LLVM_BB_ADDR_MAP = 0x6fff4c0a,        // LLVM Basic Block Address Map.
1130   SHT_LLVM_OFFLOADING = 0x6fff4c0b,         // LLVM device offloading data.
1131   SHT_LLVM_LTO = 0x6fff4c0c,                // .llvm.lto for fat LTO.
1132   // Android's experimental support for SHT_RELR sections.
1133   // https://android.googlesource.com/platform/bionic/+/b7feec74547f84559a1467aca02708ff61346d2a/libc/include/elf.h#512
1134   SHT_ANDROID_RELR = 0x6fffff00,   // Relocation entries; only offsets.
1135   SHT_GNU_ATTRIBUTES = 0x6ffffff5, // Object attributes.
1136   SHT_GNU_HASH = 0x6ffffff6,       // GNU-style hash table.
1137   SHT_GNU_verdef = 0x6ffffffd,     // GNU version definitions.
1138   SHT_GNU_verneed = 0x6ffffffe,    // GNU version references.
1139   SHT_GNU_versym = 0x6fffffff,     // GNU symbol versions table.
1140   SHT_HIOS = 0x6fffffff,           // Highest operating system-specific type.
1141   SHT_LOPROC = 0x70000000,         // Lowest processor arch-specific type.
1142   // Fixme: All this is duplicated in MCSectionELF. Why??
1143   // Exception Index table
1144   SHT_ARM_EXIDX = 0x70000001U,
1145   // BPABI DLL dynamic linking pre-emption map
1146   SHT_ARM_PREEMPTMAP = 0x70000002U,
1147   //  Object file compatibility attributes
1148   SHT_ARM_ATTRIBUTES = 0x70000003U,
1149   SHT_ARM_DEBUGOVERLAY = 0x70000004U,
1150   SHT_ARM_OVERLAYSECTION = 0x70000005U,
1151   // Special aarch64-specific section for MTE support, as described in:
1152   // https://github.com/ARM-software/abi-aa/blob/main/pauthabielf64/pauthabielf64.rst#section-types
1153   SHT_AARCH64_AUTH_RELR = 0x70000004U,
1154   // Special aarch64-specific sections for MTE support, as described in:
1155   // https://github.com/ARM-software/abi-aa/blob/main/memtagabielf64/memtagabielf64.rst#7section-types
1156   SHT_AARCH64_MEMTAG_GLOBALS_STATIC = 0x70000007U,
1157   SHT_AARCH64_MEMTAG_GLOBALS_DYNAMIC = 0x70000008U,
1158   SHT_HEX_ORDERED = 0x70000000,   // Link editor is to sort the entries in
1159                                   // this section based on their sizes
1160   SHT_X86_64_UNWIND = 0x70000001, // Unwind information
1161 
1162   SHT_MIPS_REGINFO = 0x70000006,  // Register usage information
1163   SHT_MIPS_OPTIONS = 0x7000000d,  // General options
1164   SHT_MIPS_DWARF = 0x7000001e,    // DWARF debugging section.
1165   SHT_MIPS_ABIFLAGS = 0x7000002a, // ABI information.
1166 
1167   SHT_MSP430_ATTRIBUTES = 0x70000003U,
1168 
1169   SHT_RISCV_ATTRIBUTES = 0x70000003U,
1170 
1171   SHT_CSKY_ATTRIBUTES = 0x70000001U,
1172 
1173   SHT_HEXAGON_ATTRIBUTES = 0x70000003U,
1174 
1175   SHT_HIPROC = 0x7fffffff, // Highest processor arch-specific type.
1176   SHT_LOUSER = 0x80000000, // Lowest type reserved for applications.
1177   SHT_HIUSER = 0xffffffff  // Highest type reserved for applications.
1178 };
1179 
1180 // Section flags.
1181 enum : unsigned {
1182   // Section data should be writable during execution.
1183   SHF_WRITE = 0x1,
1184 
1185   // Section occupies memory during program execution.
1186   SHF_ALLOC = 0x2,
1187 
1188   // Section contains executable machine instructions.
1189   SHF_EXECINSTR = 0x4,
1190 
1191   // The data in this section may be merged.
1192   SHF_MERGE = 0x10,
1193 
1194   // The data in this section is null-terminated strings.
1195   SHF_STRINGS = 0x20,
1196 
1197   // A field in this section holds a section header table index.
1198   SHF_INFO_LINK = 0x40U,
1199 
1200   // Adds special ordering requirements for link editors.
1201   SHF_LINK_ORDER = 0x80U,
1202 
1203   // This section requires special OS-specific processing to avoid incorrect
1204   // behavior.
1205   SHF_OS_NONCONFORMING = 0x100U,
1206 
1207   // This section is a member of a section group.
1208   SHF_GROUP = 0x200U,
1209 
1210   // This section holds Thread-Local Storage.
1211   SHF_TLS = 0x400U,
1212 
1213   // Identifies a section containing compressed data.
1214   SHF_COMPRESSED = 0x800U,
1215 
1216   // This section should not be garbage collected by the linker.
1217   SHF_GNU_RETAIN = 0x200000,
1218 
1219   // This section is excluded from the final executable or shared library.
1220   SHF_EXCLUDE = 0x80000000U,
1221 
1222   // Start of target-specific flags.
1223 
1224   SHF_MASKOS = 0x0ff00000,
1225 
1226   // Solaris equivalent of SHF_GNU_RETAIN.
1227   SHF_SUNW_NODISCARD = 0x00100000,
1228 
1229   // Bits indicating processor-specific flags.
1230   SHF_MASKPROC = 0xf0000000,
1231 
1232   /// All sections with the "d" flag are grouped together by the linker to form
1233   /// the data section and the dp register is set to the start of the section by
1234   /// the boot code.
1235   XCORE_SHF_DP_SECTION = 0x10000000,
1236 
1237   /// All sections with the "c" flag are grouped together by the linker to form
1238   /// the constant pool and the cp register is set to the start of the constant
1239   /// pool by the boot code.
1240   XCORE_SHF_CP_SECTION = 0x20000000,
1241 
1242   // If an object file section does not have this flag set, then it may not hold
1243   // more than 2GB and can be freely referred to in objects using smaller code
1244   // models. Otherwise, only objects using larger code models can refer to them.
1245   // For example, a medium code model object can refer to data in a section that
1246   // sets this flag besides being able to refer to data in a section that does
1247   // not set it; likewise, a small code model object can refer only to code in a
1248   // section that does not set this flag.
1249   SHF_X86_64_LARGE = 0x10000000,
1250 
1251   // All sections with the GPREL flag are grouped into a global data area
1252   // for faster accesses
1253   SHF_HEX_GPREL = 0x10000000,
1254 
1255   // Section contains text/data which may be replicated in other sections.
1256   // Linker must retain only one copy.
1257   SHF_MIPS_NODUPES = 0x01000000,
1258 
1259   // Linker must generate implicit hidden weak names.
1260   SHF_MIPS_NAMES = 0x02000000,
1261 
1262   // Section data local to process.
1263   SHF_MIPS_LOCAL = 0x04000000,
1264 
1265   // Do not strip this section.
1266   SHF_MIPS_NOSTRIP = 0x08000000,
1267 
1268   // Section must be part of global data area.
1269   SHF_MIPS_GPREL = 0x10000000,
1270 
1271   // This section should be merged.
1272   SHF_MIPS_MERGE = 0x20000000,
1273 
1274   // Address size to be inferred from section entry size.
1275   SHF_MIPS_ADDR = 0x40000000,
1276 
1277   // Section data is string data by default.
1278   SHF_MIPS_STRING = 0x80000000,
1279 
1280   // Make code section unreadable when in execute-only mode
1281   SHF_ARM_PURECODE = 0x20000000
1282 };
1283 
1284 // Section Group Flags
1285 enum : unsigned {
1286   GRP_COMDAT = 0x1,
1287   GRP_MASKOS = 0x0ff00000,
1288   GRP_MASKPROC = 0xf0000000
1289 };
1290 
1291 // Symbol table entries for ELF32.
1292 struct Elf32_Sym {
1293   Elf32_Word st_name;     // Symbol name (index into string table)
1294   Elf32_Addr st_value;    // Value or address associated with the symbol
1295   Elf32_Word st_size;     // Size of the symbol
1296   unsigned char st_info;  // Symbol's type and binding attributes
1297   unsigned char st_other; // Must be zero; reserved
1298   Elf32_Half st_shndx;    // Which section (header table index) it's defined in
1299 
1300   // These accessors and mutators correspond to the ELF32_ST_BIND,
1301   // ELF32_ST_TYPE, and ELF32_ST_INFO macros defined in the ELF specification:
getBindingElf32_Sym1302   unsigned char getBinding() const { return st_info >> 4; }
getTypeElf32_Sym1303   unsigned char getType() const { return st_info & 0x0f; }
setBindingElf32_Sym1304   void setBinding(unsigned char b) { setBindingAndType(b, getType()); }
setTypeElf32_Sym1305   void setType(unsigned char t) { setBindingAndType(getBinding(), t); }
setBindingAndTypeElf32_Sym1306   void setBindingAndType(unsigned char b, unsigned char t) {
1307     st_info = (b << 4) + (t & 0x0f);
1308   }
1309 };
1310 
1311 // Symbol table entries for ELF64.
1312 struct Elf64_Sym {
1313   Elf64_Word st_name;     // Symbol name (index into string table)
1314   unsigned char st_info;  // Symbol's type and binding attributes
1315   unsigned char st_other; // Must be zero; reserved
1316   Elf64_Half st_shndx;    // Which section (header tbl index) it's defined in
1317   Elf64_Addr st_value;    // Value or address associated with the symbol
1318   Elf64_Xword st_size;    // Size of the symbol
1319 
1320   // These accessors and mutators are identical to those defined for ELF32
1321   // symbol table entries.
getBindingElf64_Sym1322   unsigned char getBinding() const { return st_info >> 4; }
getTypeElf64_Sym1323   unsigned char getType() const { return st_info & 0x0f; }
setBindingElf64_Sym1324   void setBinding(unsigned char b) { setBindingAndType(b, getType()); }
setTypeElf64_Sym1325   void setType(unsigned char t) { setBindingAndType(getBinding(), t); }
setBindingAndTypeElf64_Sym1326   void setBindingAndType(unsigned char b, unsigned char t) {
1327     st_info = (b << 4) + (t & 0x0f);
1328   }
1329 };
1330 
1331 // The size (in bytes) of symbol table entries.
1332 enum {
1333   SYMENTRY_SIZE32 = 16, // 32-bit symbol entry size
1334   SYMENTRY_SIZE64 = 24  // 64-bit symbol entry size.
1335 };
1336 
1337 // Symbol bindings.
1338 enum {
1339   STB_LOCAL = 0,  // Local symbol, not visible outside obj file containing def
1340   STB_GLOBAL = 1, // Global symbol, visible to all object files being combined
1341   STB_WEAK = 2,   // Weak symbol, like global but lower-precedence
1342   STB_GNU_UNIQUE = 10,
1343   STB_LOOS = 10,   // Lowest operating system-specific binding type
1344   STB_HIOS = 12,   // Highest operating system-specific binding type
1345   STB_LOPROC = 13, // Lowest processor-specific binding type
1346   STB_HIPROC = 15  // Highest processor-specific binding type
1347 };
1348 
1349 // Symbol types.
1350 enum {
1351   STT_NOTYPE = 0,     // Symbol's type is not specified
1352   STT_OBJECT = 1,     // Symbol is a data object (variable, array, etc.)
1353   STT_FUNC = 2,       // Symbol is executable code (function, etc.)
1354   STT_SECTION = 3,    // Symbol refers to a section
1355   STT_FILE = 4,       // Local, absolute symbol that refers to a file
1356   STT_COMMON = 5,     // An uninitialized common block
1357   STT_TLS = 6,        // Thread local data object
1358   STT_GNU_IFUNC = 10, // GNU indirect function
1359   STT_LOOS = 10,      // Lowest operating system-specific symbol type
1360   STT_HIOS = 12,      // Highest operating system-specific symbol type
1361   STT_LOPROC = 13,    // Lowest processor-specific symbol type
1362   STT_HIPROC = 15,    // Highest processor-specific symbol type
1363 
1364   // AMDGPU symbol types
1365   STT_AMDGPU_HSA_KERNEL = 10
1366 };
1367 
1368 enum {
1369   STV_DEFAULT = 0,  // Visibility is specified by binding type
1370   STV_INTERNAL = 1, // Defined by processor supplements
1371   STV_HIDDEN = 2,   // Not visible to other components
1372   STV_PROTECTED = 3 // Visible in other components but not preemptable
1373 };
1374 
1375 // Symbol number.
1376 enum { STN_UNDEF = 0 };
1377 
1378 // Special relocation symbols used in the MIPS64 ELF relocation entries
1379 enum {
1380   RSS_UNDEF = 0, // None
1381   RSS_GP = 1,    // Value of gp
1382   RSS_GP0 = 2,   // Value of gp used to create object being relocated
1383   RSS_LOC = 3    // Address of location being relocated
1384 };
1385 
1386 // Relocation entry, without explicit addend.
1387 struct Elf32_Rel {
1388   Elf32_Addr r_offset; // Location (file byte offset, or program virtual addr)
1389   Elf32_Word r_info;   // Symbol table index and type of relocation to apply
1390 
1391   // These accessors and mutators correspond to the ELF32_R_SYM, ELF32_R_TYPE,
1392   // and ELF32_R_INFO macros defined in the ELF specification:
getSymbolElf32_Rel1393   Elf32_Word getSymbol() const { return (r_info >> 8); }
getTypeElf32_Rel1394   unsigned char getType() const { return (unsigned char)(r_info & 0x0ff); }
setSymbolElf32_Rel1395   void setSymbol(Elf32_Word s) { setSymbolAndType(s, getType()); }
setTypeElf32_Rel1396   void setType(unsigned char t) { setSymbolAndType(getSymbol(), t); }
setSymbolAndTypeElf32_Rel1397   void setSymbolAndType(Elf32_Word s, unsigned char t) {
1398     r_info = (s << 8) + t;
1399   }
1400 };
1401 
1402 // Relocation entry with explicit addend.
1403 struct Elf32_Rela {
1404   Elf32_Addr r_offset;  // Location (file byte offset, or program virtual addr)
1405   Elf32_Word r_info;    // Symbol table index and type of relocation to apply
1406   Elf32_Sword r_addend; // Compute value for relocatable field by adding this
1407 
1408   // These accessors and mutators correspond to the ELF32_R_SYM, ELF32_R_TYPE,
1409   // and ELF32_R_INFO macros defined in the ELF specification:
getSymbolElf32_Rela1410   Elf32_Word getSymbol() const { return (r_info >> 8); }
getTypeElf32_Rela1411   unsigned char getType() const { return (unsigned char)(r_info & 0x0ff); }
setSymbolElf32_Rela1412   void setSymbol(Elf32_Word s) { setSymbolAndType(s, getType()); }
setTypeElf32_Rela1413   void setType(unsigned char t) { setSymbolAndType(getSymbol(), t); }
setSymbolAndTypeElf32_Rela1414   void setSymbolAndType(Elf32_Word s, unsigned char t) {
1415     r_info = (s << 8) + t;
1416   }
1417 };
1418 
1419 // Relocation entry without explicit addend or info (relative relocations only).
1420 typedef Elf32_Word Elf32_Relr; // offset/bitmap for relative relocations
1421 
1422 // Relocation entry, without explicit addend.
1423 struct Elf64_Rel {
1424   Elf64_Addr r_offset; // Location (file byte offset, or program virtual addr).
1425   Elf64_Xword r_info;  // Symbol table index and type of relocation to apply.
1426 
1427   // These accessors and mutators correspond to the ELF64_R_SYM, ELF64_R_TYPE,
1428   // and ELF64_R_INFO macros defined in the ELF specification:
getSymbolElf64_Rel1429   Elf64_Word getSymbol() const { return (r_info >> 32); }
getTypeElf64_Rel1430   Elf64_Word getType() const { return (Elf64_Word)(r_info & 0xffffffffL); }
setSymbolElf64_Rel1431   void setSymbol(Elf64_Word s) { setSymbolAndType(s, getType()); }
setTypeElf64_Rel1432   void setType(Elf64_Word t) { setSymbolAndType(getSymbol(), t); }
setSymbolAndTypeElf64_Rel1433   void setSymbolAndType(Elf64_Word s, Elf64_Word t) {
1434     r_info = ((Elf64_Xword)s << 32) + (t & 0xffffffffL);
1435   }
1436 };
1437 
1438 // Relocation entry with explicit addend.
1439 struct Elf64_Rela {
1440   Elf64_Addr r_offset; // Location (file byte offset, or program virtual addr).
1441   Elf64_Xword r_info;  // Symbol table index and type of relocation to apply.
1442   Elf64_Sxword r_addend; // Compute value for relocatable field by adding this.
1443 
1444   // These accessors and mutators correspond to the ELF64_R_SYM, ELF64_R_TYPE,
1445   // and ELF64_R_INFO macros defined in the ELF specification:
getSymbolElf64_Rela1446   Elf64_Word getSymbol() const { return (r_info >> 32); }
getTypeElf64_Rela1447   Elf64_Word getType() const { return (Elf64_Word)(r_info & 0xffffffffL); }
setSymbolElf64_Rela1448   void setSymbol(Elf64_Word s) { setSymbolAndType(s, getType()); }
setTypeElf64_Rela1449   void setType(Elf64_Word t) { setSymbolAndType(getSymbol(), t); }
setSymbolAndTypeElf64_Rela1450   void setSymbolAndType(Elf64_Word s, Elf64_Word t) {
1451     r_info = ((Elf64_Xword)s << 32) + (t & 0xffffffffL);
1452   }
1453 };
1454 
1455 // In-memory representation of CREL. The serialized representation uses LEB128.
1456 template <bool Is64> struct Elf_Crel {
1457   std::conditional_t<Is64, uint64_t, uint32_t> r_offset;
1458   uint32_t r_symidx;
1459   uint32_t r_type;
1460   std::conditional_t<Is64, int64_t, int32_t> r_addend;
1461 };
1462 
1463 // Relocation entry without explicit addend or info (relative relocations only).
1464 typedef Elf64_Xword Elf64_Relr; // offset/bitmap for relative relocations
1465 
1466 // Program header for ELF32.
1467 struct Elf32_Phdr {
1468   Elf32_Word p_type;   // Type of segment
1469   Elf32_Off p_offset;  // File offset where segment is located, in bytes
1470   Elf32_Addr p_vaddr;  // Virtual address of beginning of segment
1471   Elf32_Addr p_paddr;  // Physical address of beginning of segment (OS-specific)
1472   Elf32_Word p_filesz; // Num. of bytes in file image of segment (may be zero)
1473   Elf32_Word p_memsz;  // Num. of bytes in mem image of segment (may be zero)
1474   Elf32_Word p_flags;  // Segment flags
1475   Elf32_Word p_align;  // Segment alignment constraint
1476 };
1477 
1478 // Program header for ELF64.
1479 struct Elf64_Phdr {
1480   Elf64_Word p_type;    // Type of segment
1481   Elf64_Word p_flags;   // Segment flags
1482   Elf64_Off p_offset;   // File offset where segment is located, in bytes
1483   Elf64_Addr p_vaddr;   // Virtual address of beginning of segment
1484   Elf64_Addr p_paddr;   // Physical addr of beginning of segment (OS-specific)
1485   Elf64_Xword p_filesz; // Num. of bytes in file image of segment (may be zero)
1486   Elf64_Xword p_memsz;  // Num. of bytes in mem image of segment (may be zero)
1487   Elf64_Xword p_align;  // Segment alignment constraint
1488 };
1489 
1490 // Segment types.
1491 enum {
1492   PT_NULL = 0,            // Unused segment.
1493   PT_LOAD = 1,            // Loadable segment.
1494   PT_DYNAMIC = 2,         // Dynamic linking information.
1495   PT_INTERP = 3,          // Interpreter pathname.
1496   PT_NOTE = 4,            // Auxiliary information.
1497   PT_SHLIB = 5,           // Reserved.
1498   PT_PHDR = 6,            // The program header table itself.
1499   PT_TLS = 7,             // The thread-local storage template.
1500   PT_LOOS = 0x60000000,   // Lowest operating system-specific pt entry type.
1501   PT_HIOS = 0x6fffffff,   // Highest operating system-specific pt entry type.
1502   PT_LOPROC = 0x70000000, // Lowest processor-specific program hdr entry type.
1503   PT_HIPROC = 0x7fffffff, // Highest processor-specific program hdr entry type.
1504 
1505   // x86-64 program header types.
1506   // These all contain stack unwind tables.
1507   PT_GNU_EH_FRAME = 0x6474e550,
1508   PT_SUNW_EH_FRAME = 0x6474e550,
1509   PT_SUNW_UNWIND = 0x6464e550,
1510 
1511   PT_GNU_STACK = 0x6474e551,    // Indicates stack executability.
1512   PT_GNU_RELRO = 0x6474e552,    // Read-only after relocation.
1513   PT_GNU_PROPERTY = 0x6474e553, // .note.gnu.property notes sections.
1514 
1515   PT_OPENBSD_MUTABLE = 0x65a3dbe5,   // Like bss, but not immutable.
1516   PT_OPENBSD_RANDOMIZE = 0x65a3dbe6, // Fill with random data.
1517   PT_OPENBSD_WXNEEDED = 0x65a3dbe7,  // Program does W^X violations.
1518   PT_OPENBSD_NOBTCFI = 0x65a3dbe8,   // Do not enforce branch target CFI.
1519   PT_OPENBSD_SYSCALLS = 0x65a3dbe9,  // System call sites.
1520   PT_OPENBSD_BOOTDATA = 0x65a41be6,  // Section for boot arguments.
1521 
1522   // ARM program header types.
1523   PT_ARM_ARCHEXT = 0x70000000, // Platform architecture compatibility info
1524   // These all contain stack unwind tables.
1525   PT_ARM_EXIDX = 0x70000001,
1526   PT_ARM_UNWIND = 0x70000001,
1527   // MTE memory tag segment type
1528   PT_AARCH64_MEMTAG_MTE = 0x70000002,
1529 
1530   // MIPS program header types.
1531   PT_MIPS_REGINFO = 0x70000000,  // Register usage information.
1532   PT_MIPS_RTPROC = 0x70000001,   // Runtime procedure table.
1533   PT_MIPS_OPTIONS = 0x70000002,  // Options segment.
1534   PT_MIPS_ABIFLAGS = 0x70000003, // Abiflags segment.
1535 
1536   // RISCV program header types.
1537   PT_RISCV_ATTRIBUTES = 0x70000003,
1538 };
1539 
1540 // Segment flag bits.
1541 enum : unsigned {
1542   PF_X = 1,                // Execute
1543   PF_W = 2,                // Write
1544   PF_R = 4,                // Read
1545   PF_MASKOS = 0x0ff00000,  // Bits for operating system-specific semantics.
1546   PF_MASKPROC = 0xf0000000 // Bits for processor-specific semantics.
1547 };
1548 
1549 // Dynamic table entry for ELF32.
1550 struct Elf32_Dyn {
1551   Elf32_Sword d_tag; // Type of dynamic table entry.
1552   union {
1553     Elf32_Word d_val; // Integer value of entry.
1554     Elf32_Addr d_ptr; // Pointer value of entry.
1555   } d_un;
1556 };
1557 
1558 // Dynamic table entry for ELF64.
1559 struct Elf64_Dyn {
1560   Elf64_Sxword d_tag; // Type of dynamic table entry.
1561   union {
1562     Elf64_Xword d_val; // Integer value of entry.
1563     Elf64_Addr d_ptr;  // Pointer value of entry.
1564   } d_un;
1565 };
1566 
1567 // Dynamic table entry tags.
1568 enum {
1569 #define DYNAMIC_TAG(name, value) DT_##name = value,
1570 #include "DynamicTags.def"
1571 #undef DYNAMIC_TAG
1572 };
1573 
1574 // DT_FLAGS values.
1575 enum {
1576   DF_ORIGIN = 0x01,    // The object may reference $ORIGIN.
1577   DF_SYMBOLIC = 0x02,  // Search the shared lib before searching the exe.
1578   DF_TEXTREL = 0x04,   // Relocations may modify a non-writable segment.
1579   DF_BIND_NOW = 0x08,  // Process all relocations on load.
1580   DF_STATIC_TLS = 0x10 // Reject attempts to load dynamically.
1581 };
1582 
1583 // State flags selectable in the `d_un.d_val' element of the DT_FLAGS_1 entry.
1584 enum {
1585   DF_1_NOW = 0x00000001,       // Set RTLD_NOW for this object.
1586   DF_1_GLOBAL = 0x00000002,    // Set RTLD_GLOBAL for this object.
1587   DF_1_GROUP = 0x00000004,     // Set RTLD_GROUP for this object.
1588   DF_1_NODELETE = 0x00000008,  // Set RTLD_NODELETE for this object.
1589   DF_1_LOADFLTR = 0x00000010,  // Trigger filtee loading at runtime.
1590   DF_1_INITFIRST = 0x00000020, // Set RTLD_INITFIRST for this object.
1591   DF_1_NOOPEN = 0x00000040,    // Set RTLD_NOOPEN for this object.
1592   DF_1_ORIGIN = 0x00000080,    // $ORIGIN must be handled.
1593   DF_1_DIRECT = 0x00000100,    // Direct binding enabled.
1594   DF_1_TRANS = 0x00000200,
1595   DF_1_INTERPOSE = 0x00000400,  // Object is used to interpose.
1596   DF_1_NODEFLIB = 0x00000800,   // Ignore default lib search path.
1597   DF_1_NODUMP = 0x00001000,     // Object can't be dldump'ed.
1598   DF_1_CONFALT = 0x00002000,    // Configuration alternative created.
1599   DF_1_ENDFILTEE = 0x00004000,  // Filtee terminates filters search.
1600   DF_1_DISPRELDNE = 0x00008000, // Disp reloc applied at build time.
1601   DF_1_DISPRELPND = 0x00010000, // Disp reloc applied at run-time.
1602   DF_1_NODIRECT = 0x00020000,   // Object has no-direct binding.
1603   DF_1_IGNMULDEF = 0x00040000,
1604   DF_1_NOKSYMS = 0x00080000,
1605   DF_1_NOHDR = 0x00100000,
1606   DF_1_EDITED = 0x00200000, // Object is modified after built.
1607   DF_1_NORELOC = 0x00400000,
1608   DF_1_SYMINTPOSE = 0x00800000, // Object has individual interposers.
1609   DF_1_GLOBAUDIT = 0x01000000,  // Global auditing required.
1610   DF_1_SINGLETON = 0x02000000,  // Singleton symbols are used.
1611   DF_1_PIE = 0x08000000,        // Object is a position-independent executable.
1612 };
1613 
1614 // DT_MIPS_FLAGS values.
1615 enum {
1616   RHF_NONE = 0x00000000,                   // No flags.
1617   RHF_QUICKSTART = 0x00000001,             // Uses shortcut pointers.
1618   RHF_NOTPOT = 0x00000002,                 // Hash size is not a power of two.
1619   RHS_NO_LIBRARY_REPLACEMENT = 0x00000004, // Ignore LD_LIBRARY_PATH.
1620   RHF_NO_MOVE = 0x00000008,                // DSO address may not be relocated.
1621   RHF_SGI_ONLY = 0x00000010,               // SGI specific features.
1622   RHF_GUARANTEE_INIT = 0x00000020,         // Guarantee that .init will finish
1623                                            // executing before any non-init
1624                                            // code in DSO is called.
1625   RHF_DELTA_C_PLUS_PLUS = 0x00000040,      // Contains Delta C++ code.
1626   RHF_GUARANTEE_START_INIT = 0x00000080,   // Guarantee that .init will start
1627                                            // executing before any non-init
1628                                            // code in DSO is called.
1629   RHF_PIXIE = 0x00000100,                  // Generated by pixie.
1630   RHF_DEFAULT_DELAY_LOAD = 0x00000200,     // Delay-load DSO by default.
1631   RHF_REQUICKSTART = 0x00000400,           // Object may be requickstarted
1632   RHF_REQUICKSTARTED = 0x00000800,         // Object has been requickstarted
1633   RHF_CORD = 0x00001000,                   // Generated by cord.
1634   RHF_NO_UNRES_UNDEF = 0x00002000,         // Object contains no unresolved
1635                                            // undef symbols.
1636   RHF_RLD_ORDER_SAFE = 0x00004000          // Symbol table is in a safe order.
1637 };
1638 
1639 // ElfXX_VerDef structure version (GNU versioning)
1640 enum { VER_DEF_NONE = 0, VER_DEF_CURRENT = 1 };
1641 
1642 // VerDef Flags (ElfXX_VerDef::vd_flags)
1643 enum { VER_FLG_BASE = 0x1, VER_FLG_WEAK = 0x2, VER_FLG_INFO = 0x4 };
1644 
1645 // Special constants for the version table. (SHT_GNU_versym/.gnu.version)
1646 enum {
1647   VER_NDX_LOCAL = 0,       // Unversioned local symbol
1648   VER_NDX_GLOBAL = 1,      // Unversioned global symbol
1649   VERSYM_VERSION = 0x7fff, // Version Index mask
1650   VERSYM_HIDDEN = 0x8000   // Hidden bit (non-default version)
1651 };
1652 
1653 // ElfXX_VerNeed structure version (GNU versioning)
1654 enum { VER_NEED_NONE = 0, VER_NEED_CURRENT = 1 };
1655 
1656 // SHT_NOTE section types.
1657 
1658 // Generic note types.
1659 enum : unsigned {
1660   NT_VERSION = 1,
1661   NT_ARCH = 2,
1662   NT_GNU_BUILD_ATTRIBUTE_OPEN = 0x100,
1663   NT_GNU_BUILD_ATTRIBUTE_FUNC = 0x101,
1664 };
1665 
1666 // Core note types.
1667 enum : unsigned {
1668   NT_PRSTATUS = 1,
1669   NT_FPREGSET = 2,
1670   NT_PRPSINFO = 3,
1671   NT_TASKSTRUCT = 4,
1672   NT_AUXV = 6,
1673   NT_PSTATUS = 10,
1674   NT_FPREGS = 12,
1675   NT_PSINFO = 13,
1676   NT_LWPSTATUS = 16,
1677   NT_LWPSINFO = 17,
1678   NT_WIN32PSTATUS = 18,
1679 
1680   NT_PPC_VMX = 0x100,
1681   NT_PPC_VSX = 0x102,
1682   NT_PPC_TAR = 0x103,
1683   NT_PPC_PPR = 0x104,
1684   NT_PPC_DSCR = 0x105,
1685   NT_PPC_EBB = 0x106,
1686   NT_PPC_PMU = 0x107,
1687   NT_PPC_TM_CGPR = 0x108,
1688   NT_PPC_TM_CFPR = 0x109,
1689   NT_PPC_TM_CVMX = 0x10a,
1690   NT_PPC_TM_CVSX = 0x10b,
1691   NT_PPC_TM_SPR = 0x10c,
1692   NT_PPC_TM_CTAR = 0x10d,
1693   NT_PPC_TM_CPPR = 0x10e,
1694   NT_PPC_TM_CDSCR = 0x10f,
1695 
1696   NT_386_TLS = 0x200,
1697   NT_386_IOPERM = 0x201,
1698   NT_X86_XSTATE = 0x202,
1699 
1700   NT_S390_HIGH_GPRS = 0x300,
1701   NT_S390_TIMER = 0x301,
1702   NT_S390_TODCMP = 0x302,
1703   NT_S390_TODPREG = 0x303,
1704   NT_S390_CTRS = 0x304,
1705   NT_S390_PREFIX = 0x305,
1706   NT_S390_LAST_BREAK = 0x306,
1707   NT_S390_SYSTEM_CALL = 0x307,
1708   NT_S390_TDB = 0x308,
1709   NT_S390_VXRS_LOW = 0x309,
1710   NT_S390_VXRS_HIGH = 0x30a,
1711   NT_S390_GS_CB = 0x30b,
1712   NT_S390_GS_BC = 0x30c,
1713 
1714   NT_ARM_VFP = 0x400,
1715   NT_ARM_TLS = 0x401,
1716   NT_ARM_HW_BREAK = 0x402,
1717   NT_ARM_HW_WATCH = 0x403,
1718   NT_ARM_SVE = 0x405,
1719   NT_ARM_PAC_MASK = 0x406,
1720   NT_ARM_TAGGED_ADDR_CTRL = 0x409,
1721   NT_ARM_SSVE = 0x40b,
1722   NT_ARM_ZA = 0x40c,
1723   NT_ARM_ZT = 0x40d,
1724   NT_ARM_FPMR = 0x40e,
1725 
1726   NT_FILE = 0x46494c45,
1727   NT_PRXFPREG = 0x46e62b7f,
1728   NT_SIGINFO = 0x53494749,
1729 };
1730 
1731 // LLVM-specific notes.
1732 enum {
1733   NT_LLVM_HWASAN_GLOBALS = 3,
1734 };
1735 
1736 // GNU note types.
1737 enum {
1738   NT_GNU_ABI_TAG = 1,
1739   NT_GNU_HWCAP = 2,
1740   NT_GNU_BUILD_ID = 3,
1741   NT_GNU_GOLD_VERSION = 4,
1742   NT_GNU_PROPERTY_TYPE_0 = 5,
1743   FDO_PACKAGING_METADATA = 0xcafe1a7e,
1744 };
1745 
1746 // Android note types.
1747 enum {
1748   NT_ANDROID_TYPE_IDENT = 1,
1749   NT_ANDROID_TYPE_KUSER = 3,
1750   NT_ANDROID_TYPE_MEMTAG = 4,
1751 };
1752 
1753 // Memory tagging values used in NT_ANDROID_TYPE_MEMTAG notes.
1754 enum {
1755   // Enumeration to determine the tagging mode. In Android-land, 'SYNC' means
1756   // running all threads in MTE Synchronous mode, and 'ASYNC' means to use the
1757   // kernels auto-upgrade feature to allow for either MTE Asynchronous,
1758   // Asymmetric, or Synchronous mode. This allows silicon vendors to specify, on
1759   // a per-cpu basis what 'ASYNC' should mean. Generally, the expectation is
1760   // "pick the most precise mode that's very fast".
1761   NT_MEMTAG_LEVEL_NONE = 0,
1762   NT_MEMTAG_LEVEL_ASYNC = 1,
1763   NT_MEMTAG_LEVEL_SYNC = 2,
1764   NT_MEMTAG_LEVEL_MASK = 3,
1765   // Bits indicating whether the loader should prepare for MTE to be enabled on
1766   // the heap and/or stack.
1767   NT_MEMTAG_HEAP = 4,
1768   NT_MEMTAG_STACK = 8,
1769 };
1770 
1771 // Property types used in GNU_PROPERTY_TYPE_0 notes.
1772 enum : unsigned {
1773   GNU_PROPERTY_STACK_SIZE = 1,
1774   GNU_PROPERTY_NO_COPY_ON_PROTECTED = 2,
1775   GNU_PROPERTY_AARCH64_FEATURE_1_AND = 0xc0000000,
1776   GNU_PROPERTY_AARCH64_FEATURE_PAUTH = 0xc0000001,
1777   GNU_PROPERTY_X86_FEATURE_1_AND = 0xc0000002,
1778 
1779   GNU_PROPERTY_X86_UINT32_OR_LO = 0xc0008000,
1780   GNU_PROPERTY_X86_FEATURE_2_NEEDED = GNU_PROPERTY_X86_UINT32_OR_LO + 1,
1781   GNU_PROPERTY_X86_ISA_1_NEEDED = GNU_PROPERTY_X86_UINT32_OR_LO + 2,
1782 
1783   GNU_PROPERTY_X86_UINT32_OR_AND_LO = 0xc0010000,
1784   GNU_PROPERTY_X86_FEATURE_2_USED = GNU_PROPERTY_X86_UINT32_OR_AND_LO + 1,
1785   GNU_PROPERTY_X86_ISA_1_USED = GNU_PROPERTY_X86_UINT32_OR_AND_LO + 2,
1786 };
1787 
1788 // aarch64 processor feature bits.
1789 enum : unsigned {
1790   GNU_PROPERTY_AARCH64_FEATURE_1_BTI = 1 << 0,
1791   GNU_PROPERTY_AARCH64_FEATURE_1_PAC = 1 << 1,
1792   GNU_PROPERTY_AARCH64_FEATURE_1_GCS = 1 << 2,
1793 };
1794 
1795 // aarch64 PAuth platforms.
1796 enum : unsigned {
1797   AARCH64_PAUTH_PLATFORM_INVALID = 0x0,
1798   AARCH64_PAUTH_PLATFORM_BAREMETAL = 0x1,
1799   AARCH64_PAUTH_PLATFORM_LLVM_LINUX = 0x10000002,
1800 };
1801 
1802 // Bit positions of version flags for AARCH64_PAUTH_PLATFORM_LLVM_LINUX.
1803 enum : unsigned {
1804   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_INTRINSICS = 0,
1805   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_CALLS = 1,
1806   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_RETURNS = 2,
1807   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_AUTHTRAPS = 3,
1808   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_VPTRADDRDISCR = 4,
1809   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_VPTRTYPEDISCR = 5,
1810   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_INITFINI = 6,
1811   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_INITFINIADDRDISC = 7,
1812   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_GOT = 8,
1813   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_GOTOS = 9,
1814   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_TYPEINFOVPTRDISCR = 10,
1815   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_FPTRTYPEDISCR = 11,
1816   AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_LAST =
1817       AARCH64_PAUTH_PLATFORM_LLVM_LINUX_VERSION_FPTRTYPEDISCR,
1818 };
1819 
1820 // x86 processor feature bits.
1821 enum : unsigned {
1822   GNU_PROPERTY_X86_FEATURE_1_IBT = 1 << 0,
1823   GNU_PROPERTY_X86_FEATURE_1_SHSTK = 1 << 1,
1824 
1825   GNU_PROPERTY_X86_FEATURE_2_X86 = 1 << 0,
1826   GNU_PROPERTY_X86_FEATURE_2_X87 = 1 << 1,
1827   GNU_PROPERTY_X86_FEATURE_2_MMX = 1 << 2,
1828   GNU_PROPERTY_X86_FEATURE_2_XMM = 1 << 3,
1829   GNU_PROPERTY_X86_FEATURE_2_YMM = 1 << 4,
1830   GNU_PROPERTY_X86_FEATURE_2_ZMM = 1 << 5,
1831   GNU_PROPERTY_X86_FEATURE_2_FXSR = 1 << 6,
1832   GNU_PROPERTY_X86_FEATURE_2_XSAVE = 1 << 7,
1833   GNU_PROPERTY_X86_FEATURE_2_XSAVEOPT = 1 << 8,
1834   GNU_PROPERTY_X86_FEATURE_2_XSAVEC = 1 << 9,
1835 
1836   GNU_PROPERTY_X86_ISA_1_BASELINE = 1 << 0,
1837   GNU_PROPERTY_X86_ISA_1_V2 = 1 << 1,
1838   GNU_PROPERTY_X86_ISA_1_V3 = 1 << 2,
1839   GNU_PROPERTY_X86_ISA_1_V4 = 1 << 3,
1840 };
1841 
1842 // FreeBSD note types.
1843 enum {
1844   NT_FREEBSD_ABI_TAG = 1,
1845   NT_FREEBSD_NOINIT_TAG = 2,
1846   NT_FREEBSD_ARCH_TAG = 3,
1847   NT_FREEBSD_FEATURE_CTL = 4,
1848 };
1849 
1850 // NT_FREEBSD_FEATURE_CTL values (see FreeBSD's sys/sys/elf_common.h).
1851 enum {
1852   NT_FREEBSD_FCTL_ASLR_DISABLE = 0x00000001,
1853   NT_FREEBSD_FCTL_PROTMAX_DISABLE = 0x00000002,
1854   NT_FREEBSD_FCTL_STKGAP_DISABLE = 0x00000004,
1855   NT_FREEBSD_FCTL_WXNEEDED = 0x00000008,
1856   NT_FREEBSD_FCTL_LA48 = 0x00000010,
1857   NT_FREEBSD_FCTL_ASG_DISABLE = 0x00000020,
1858 };
1859 
1860 // FreeBSD core note types.
1861 enum {
1862   NT_FREEBSD_THRMISC = 7,
1863   NT_FREEBSD_PROCSTAT_PROC = 8,
1864   NT_FREEBSD_PROCSTAT_FILES = 9,
1865   NT_FREEBSD_PROCSTAT_VMMAP = 10,
1866   NT_FREEBSD_PROCSTAT_GROUPS = 11,
1867   NT_FREEBSD_PROCSTAT_UMASK = 12,
1868   NT_FREEBSD_PROCSTAT_RLIMIT = 13,
1869   NT_FREEBSD_PROCSTAT_OSREL = 14,
1870   NT_FREEBSD_PROCSTAT_PSSTRINGS = 15,
1871   NT_FREEBSD_PROCSTAT_AUXV = 16,
1872 };
1873 
1874 // NetBSD core note types.
1875 enum {
1876   NT_NETBSDCORE_PROCINFO = 1,
1877   NT_NETBSDCORE_AUXV = 2,
1878   NT_NETBSDCORE_LWPSTATUS = 24,
1879 };
1880 
1881 // OpenBSD core note types.
1882 enum {
1883   NT_OPENBSD_PROCINFO = 10,
1884   NT_OPENBSD_AUXV = 11,
1885   NT_OPENBSD_REGS = 20,
1886   NT_OPENBSD_FPREGS = 21,
1887   NT_OPENBSD_XFPREGS = 22,
1888   NT_OPENBSD_WCOOKIE = 23,
1889 };
1890 
1891 // AMDGPU-specific section indices.
1892 enum {
1893   SHN_AMDGPU_LDS = 0xff00, // Variable in LDS; symbol encoded like SHN_COMMON
1894 };
1895 
1896 // AMD vendor specific notes. (Code Object V2)
1897 enum {
1898   NT_AMD_HSA_CODE_OBJECT_VERSION = 1,
1899   NT_AMD_HSA_HSAIL = 2,
1900   NT_AMD_HSA_ISA_VERSION = 3,
1901   // Note types with values between 4 and 9 (inclusive) are reserved.
1902   NT_AMD_HSA_METADATA = 10,
1903   NT_AMD_HSA_ISA_NAME = 11,
1904   NT_AMD_PAL_METADATA = 12
1905 };
1906 
1907 // AMDGPU vendor specific notes. (Code Object V3)
1908 enum {
1909   // Note types with values between 0 and 31 (inclusive) are reserved.
1910   NT_AMDGPU_METADATA = 32
1911 };
1912 
1913 // LLVMOMPOFFLOAD specific notes.
1914 enum : unsigned {
1915   NT_LLVM_OPENMP_OFFLOAD_VERSION = 1,
1916   NT_LLVM_OPENMP_OFFLOAD_PRODUCER = 2,
1917   NT_LLVM_OPENMP_OFFLOAD_PRODUCER_VERSION = 3
1918 };
1919 
1920 enum {
1921   GNU_ABI_TAG_LINUX = 0,
1922   GNU_ABI_TAG_HURD = 1,
1923   GNU_ABI_TAG_SOLARIS = 2,
1924   GNU_ABI_TAG_FREEBSD = 3,
1925   GNU_ABI_TAG_NETBSD = 4,
1926   GNU_ABI_TAG_SYLLABLE = 5,
1927   GNU_ABI_TAG_NACL = 6,
1928 };
1929 
1930 constexpr const char *ELF_NOTE_GNU = "GNU";
1931 
1932 // Android packed relocation group flags.
1933 enum {
1934   RELOCATION_GROUPED_BY_INFO_FLAG = 1,
1935   RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG = 2,
1936   RELOCATION_GROUPED_BY_ADDEND_FLAG = 4,
1937   RELOCATION_GROUP_HAS_ADDEND_FLAG = 8,
1938 };
1939 
1940 // Compressed section header for ELF32.
1941 struct Elf32_Chdr {
1942   Elf32_Word ch_type;
1943   Elf32_Word ch_size;
1944   Elf32_Word ch_addralign;
1945 };
1946 
1947 // Compressed section header for ELF64.
1948 struct Elf64_Chdr {
1949   Elf64_Word ch_type;
1950   Elf64_Word ch_reserved;
1951   Elf64_Xword ch_size;
1952   Elf64_Xword ch_addralign;
1953 };
1954 
1955 // Note header for ELF32.
1956 struct Elf32_Nhdr {
1957   Elf32_Word n_namesz;
1958   Elf32_Word n_descsz;
1959   Elf32_Word n_type;
1960 };
1961 
1962 // Note header for ELF64.
1963 struct Elf64_Nhdr {
1964   Elf64_Word n_namesz;
1965   Elf64_Word n_descsz;
1966   Elf64_Word n_type;
1967 };
1968 
1969 // Legal values for ch_type field of compressed section header.
1970 enum {
1971   ELFCOMPRESS_ZLIB = 1,            // ZLIB/DEFLATE algorithm.
1972   ELFCOMPRESS_ZSTD = 2,            // Zstandard algorithm
1973   ELFCOMPRESS_LOOS = 0x60000000,   // Start of OS-specific.
1974   ELFCOMPRESS_HIOS = 0x6fffffff,   // End of OS-specific.
1975   ELFCOMPRESS_LOPROC = 0x70000000, // Start of processor-specific.
1976   ELFCOMPRESS_HIPROC = 0x7fffffff  // End of processor-specific.
1977 };
1978 
1979 constexpr unsigned CREL_HDR_ADDEND = 4;
1980 
1981 /// Convert an architecture name into ELF's e_machine value.
1982 uint16_t convertArchNameToEMachine(StringRef Arch);
1983 
1984 /// Convert an ELF's e_machine value into an architecture name.
1985 StringRef convertEMachineToArchName(uint16_t EMachine);
1986 
1987 // Convert a lowercase string identifier into an OSABI value.
1988 uint8_t convertNameToOSABI(StringRef Name);
1989 
1990 // Convert an OSABI value into a string that identifies the OS- or ABI-
1991 // specific ELF extension.
1992 StringRef convertOSABIToName(uint8_t OSABI);
1993 
1994 } // end namespace ELF
1995 } // end namespace llvm
1996 
1997 #endif // LLVM_BINARYFORMAT_ELF_H
1998