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