1 //===- ELFYAML.cpp - ELF YAMLIO implementation ----------------------------===//
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 file defines classes for handling the YAML representation of ELF.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/ObjectYAML/ELFYAML.h"
14 #include "llvm/ADT/APInt.h"
15 #include "llvm/ADT/MapVector.h"
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/BinaryFormat/ELF.h"
18 #include "llvm/Support/ARMEHABI.h"
19 #include "llvm/Support/Casting.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/MipsABIFlags.h"
22 #include "llvm/Support/YAMLTraits.h"
23 #include "llvm/Support/WithColor.h"
24 #include <cassert>
25 #include <cstdint>
26 
27 namespace llvm {
28 
29 ELFYAML::Chunk::~Chunk() = default;
30 
31 namespace ELFYAML {
32 ELF_ELFOSABI Object::getOSAbi() const { return Header.OSABI; }
33 
34 unsigned Object::getMachine() const {
35   if (Header.Machine)
36     return *Header.Machine;
37   return llvm::ELF::EM_NONE;
38 }
39 
40 constexpr StringRef SectionHeaderTable::TypeStr;
41 } // namespace ELFYAML
42 
43 namespace yaml {
44 
45 void ScalarEnumerationTraits<ELFYAML::ELF_ET>::enumeration(
46     IO &IO, ELFYAML::ELF_ET &Value) {
47 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
48   ECase(ET_NONE);
49   ECase(ET_REL);
50   ECase(ET_EXEC);
51   ECase(ET_DYN);
52   ECase(ET_CORE);
53 #undef ECase
54   IO.enumFallback<Hex16>(Value);
55 }
56 
57 void ScalarEnumerationTraits<ELFYAML::ELF_PT>::enumeration(
58     IO &IO, ELFYAML::ELF_PT &Value) {
59 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
60   ECase(PT_NULL);
61   ECase(PT_LOAD);
62   ECase(PT_DYNAMIC);
63   ECase(PT_INTERP);
64   ECase(PT_NOTE);
65   ECase(PT_SHLIB);
66   ECase(PT_PHDR);
67   ECase(PT_TLS);
68   ECase(PT_GNU_EH_FRAME);
69   ECase(PT_GNU_STACK);
70   ECase(PT_GNU_RELRO);
71   ECase(PT_GNU_PROPERTY);
72 #undef ECase
73   IO.enumFallback<Hex32>(Value);
74 }
75 
76 void ScalarEnumerationTraits<ELFYAML::ELF_NT>::enumeration(
77     IO &IO, ELFYAML::ELF_NT &Value) {
78 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
79   // Generic note types.
80   ECase(NT_VERSION);
81   ECase(NT_ARCH);
82   ECase(NT_GNU_BUILD_ATTRIBUTE_OPEN);
83   ECase(NT_GNU_BUILD_ATTRIBUTE_FUNC);
84   // Core note types.
85   ECase(NT_PRSTATUS);
86   ECase(NT_FPREGSET);
87   ECase(NT_PRPSINFO);
88   ECase(NT_TASKSTRUCT);
89   ECase(NT_AUXV);
90   ECase(NT_PSTATUS);
91   ECase(NT_FPREGS);
92   ECase(NT_PSINFO);
93   ECase(NT_LWPSTATUS);
94   ECase(NT_LWPSINFO);
95   ECase(NT_WIN32PSTATUS);
96   ECase(NT_PPC_VMX);
97   ECase(NT_PPC_VSX);
98   ECase(NT_PPC_TAR);
99   ECase(NT_PPC_PPR);
100   ECase(NT_PPC_DSCR);
101   ECase(NT_PPC_EBB);
102   ECase(NT_PPC_PMU);
103   ECase(NT_PPC_TM_CGPR);
104   ECase(NT_PPC_TM_CFPR);
105   ECase(NT_PPC_TM_CVMX);
106   ECase(NT_PPC_TM_CVSX);
107   ECase(NT_PPC_TM_SPR);
108   ECase(NT_PPC_TM_CTAR);
109   ECase(NT_PPC_TM_CPPR);
110   ECase(NT_PPC_TM_CDSCR);
111   ECase(NT_386_TLS);
112   ECase(NT_386_IOPERM);
113   ECase(NT_X86_XSTATE);
114   ECase(NT_S390_HIGH_GPRS);
115   ECase(NT_S390_TIMER);
116   ECase(NT_S390_TODCMP);
117   ECase(NT_S390_TODPREG);
118   ECase(NT_S390_CTRS);
119   ECase(NT_S390_PREFIX);
120   ECase(NT_S390_LAST_BREAK);
121   ECase(NT_S390_SYSTEM_CALL);
122   ECase(NT_S390_TDB);
123   ECase(NT_S390_VXRS_LOW);
124   ECase(NT_S390_VXRS_HIGH);
125   ECase(NT_S390_GS_CB);
126   ECase(NT_S390_GS_BC);
127   ECase(NT_ARM_VFP);
128   ECase(NT_ARM_TLS);
129   ECase(NT_ARM_HW_BREAK);
130   ECase(NT_ARM_HW_WATCH);
131   ECase(NT_ARM_SVE);
132   ECase(NT_ARM_PAC_MASK);
133   ECase(NT_FILE);
134   ECase(NT_PRXFPREG);
135   ECase(NT_SIGINFO);
136   // LLVM-specific notes.
137   ECase(NT_LLVM_HWASAN_GLOBALS);
138   // GNU note types
139   ECase(NT_GNU_ABI_TAG);
140   ECase(NT_GNU_HWCAP);
141   ECase(NT_GNU_BUILD_ID);
142   ECase(NT_GNU_GOLD_VERSION);
143   ECase(NT_GNU_PROPERTY_TYPE_0);
144   // FreeBSD note types.
145   ECase(NT_FREEBSD_ABI_TAG);
146   ECase(NT_FREEBSD_NOINIT_TAG);
147   ECase(NT_FREEBSD_ARCH_TAG);
148   ECase(NT_FREEBSD_FEATURE_CTL);
149   // FreeBSD core note types.
150   ECase(NT_FREEBSD_THRMISC);
151   ECase(NT_FREEBSD_PROCSTAT_PROC);
152   ECase(NT_FREEBSD_PROCSTAT_FILES);
153   ECase(NT_FREEBSD_PROCSTAT_VMMAP);
154   ECase(NT_FREEBSD_PROCSTAT_GROUPS);
155   ECase(NT_FREEBSD_PROCSTAT_UMASK);
156   ECase(NT_FREEBSD_PROCSTAT_RLIMIT);
157   ECase(NT_FREEBSD_PROCSTAT_OSREL);
158   ECase(NT_FREEBSD_PROCSTAT_PSSTRINGS);
159   ECase(NT_FREEBSD_PROCSTAT_AUXV);
160   // NetBSD core note types.
161   ECase(NT_NETBSDCORE_PROCINFO);
162   ECase(NT_NETBSDCORE_AUXV);
163   ECase(NT_NETBSDCORE_LWPSTATUS);
164   // OpenBSD core note types.
165   ECase(NT_OPENBSD_PROCINFO);
166   ECase(NT_OPENBSD_AUXV);
167   ECase(NT_OPENBSD_REGS);
168   ECase(NT_OPENBSD_FPREGS);
169   ECase(NT_OPENBSD_XFPREGS);
170   ECase(NT_OPENBSD_WCOOKIE);
171   // AMD specific notes. (Code Object V2)
172   ECase(NT_AMD_HSA_CODE_OBJECT_VERSION);
173   ECase(NT_AMD_HSA_HSAIL);
174   ECase(NT_AMD_HSA_ISA_VERSION);
175   ECase(NT_AMD_HSA_METADATA);
176   ECase(NT_AMD_HSA_ISA_NAME);
177   ECase(NT_AMD_PAL_METADATA);
178   // AMDGPU specific notes. (Code Object V3)
179   ECase(NT_AMDGPU_METADATA);
180 #undef ECase
181   IO.enumFallback<Hex32>(Value);
182 }
183 
184 void ScalarEnumerationTraits<ELFYAML::ELF_EM>::enumeration(
185     IO &IO, ELFYAML::ELF_EM &Value) {
186 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
187   ECase(EM_NONE);
188   ECase(EM_M32);
189   ECase(EM_SPARC);
190   ECase(EM_386);
191   ECase(EM_68K);
192   ECase(EM_88K);
193   ECase(EM_IAMCU);
194   ECase(EM_860);
195   ECase(EM_MIPS);
196   ECase(EM_S370);
197   ECase(EM_MIPS_RS3_LE);
198   ECase(EM_PARISC);
199   ECase(EM_VPP500);
200   ECase(EM_SPARC32PLUS);
201   ECase(EM_960);
202   ECase(EM_PPC);
203   ECase(EM_PPC64);
204   ECase(EM_S390);
205   ECase(EM_SPU);
206   ECase(EM_V800);
207   ECase(EM_FR20);
208   ECase(EM_RH32);
209   ECase(EM_RCE);
210   ECase(EM_ARM);
211   ECase(EM_ALPHA);
212   ECase(EM_SH);
213   ECase(EM_SPARCV9);
214   ECase(EM_TRICORE);
215   ECase(EM_ARC);
216   ECase(EM_H8_300);
217   ECase(EM_H8_300H);
218   ECase(EM_H8S);
219   ECase(EM_H8_500);
220   ECase(EM_IA_64);
221   ECase(EM_MIPS_X);
222   ECase(EM_COLDFIRE);
223   ECase(EM_68HC12);
224   ECase(EM_MMA);
225   ECase(EM_PCP);
226   ECase(EM_NCPU);
227   ECase(EM_NDR1);
228   ECase(EM_STARCORE);
229   ECase(EM_ME16);
230   ECase(EM_ST100);
231   ECase(EM_TINYJ);
232   ECase(EM_X86_64);
233   ECase(EM_PDSP);
234   ECase(EM_PDP10);
235   ECase(EM_PDP11);
236   ECase(EM_FX66);
237   ECase(EM_ST9PLUS);
238   ECase(EM_ST7);
239   ECase(EM_68HC16);
240   ECase(EM_68HC11);
241   ECase(EM_68HC08);
242   ECase(EM_68HC05);
243   ECase(EM_SVX);
244   ECase(EM_ST19);
245   ECase(EM_VAX);
246   ECase(EM_CRIS);
247   ECase(EM_JAVELIN);
248   ECase(EM_FIREPATH);
249   ECase(EM_ZSP);
250   ECase(EM_MMIX);
251   ECase(EM_HUANY);
252   ECase(EM_PRISM);
253   ECase(EM_AVR);
254   ECase(EM_FR30);
255   ECase(EM_D10V);
256   ECase(EM_D30V);
257   ECase(EM_V850);
258   ECase(EM_M32R);
259   ECase(EM_MN10300);
260   ECase(EM_MN10200);
261   ECase(EM_PJ);
262   ECase(EM_OPENRISC);
263   ECase(EM_ARC_COMPACT);
264   ECase(EM_XTENSA);
265   ECase(EM_VIDEOCORE);
266   ECase(EM_TMM_GPP);
267   ECase(EM_NS32K);
268   ECase(EM_TPC);
269   ECase(EM_SNP1K);
270   ECase(EM_ST200);
271   ECase(EM_IP2K);
272   ECase(EM_MAX);
273   ECase(EM_CR);
274   ECase(EM_F2MC16);
275   ECase(EM_MSP430);
276   ECase(EM_BLACKFIN);
277   ECase(EM_SE_C33);
278   ECase(EM_SEP);
279   ECase(EM_ARCA);
280   ECase(EM_UNICORE);
281   ECase(EM_EXCESS);
282   ECase(EM_DXP);
283   ECase(EM_ALTERA_NIOS2);
284   ECase(EM_CRX);
285   ECase(EM_XGATE);
286   ECase(EM_C166);
287   ECase(EM_M16C);
288   ECase(EM_DSPIC30F);
289   ECase(EM_CE);
290   ECase(EM_M32C);
291   ECase(EM_TSK3000);
292   ECase(EM_RS08);
293   ECase(EM_SHARC);
294   ECase(EM_ECOG2);
295   ECase(EM_SCORE7);
296   ECase(EM_DSP24);
297   ECase(EM_VIDEOCORE3);
298   ECase(EM_LATTICEMICO32);
299   ECase(EM_SE_C17);
300   ECase(EM_TI_C6000);
301   ECase(EM_TI_C2000);
302   ECase(EM_TI_C5500);
303   ECase(EM_MMDSP_PLUS);
304   ECase(EM_CYPRESS_M8C);
305   ECase(EM_R32C);
306   ECase(EM_TRIMEDIA);
307   ECase(EM_HEXAGON);
308   ECase(EM_8051);
309   ECase(EM_STXP7X);
310   ECase(EM_NDS32);
311   ECase(EM_ECOG1);
312   ECase(EM_ECOG1X);
313   ECase(EM_MAXQ30);
314   ECase(EM_XIMO16);
315   ECase(EM_MANIK);
316   ECase(EM_CRAYNV2);
317   ECase(EM_RX);
318   ECase(EM_METAG);
319   ECase(EM_MCST_ELBRUS);
320   ECase(EM_ECOG16);
321   ECase(EM_CR16);
322   ECase(EM_ETPU);
323   ECase(EM_SLE9X);
324   ECase(EM_L10M);
325   ECase(EM_K10M);
326   ECase(EM_AARCH64);
327   ECase(EM_AVR32);
328   ECase(EM_STM8);
329   ECase(EM_TILE64);
330   ECase(EM_TILEPRO);
331   ECase(EM_MICROBLAZE);
332   ECase(EM_CUDA);
333   ECase(EM_TILEGX);
334   ECase(EM_CLOUDSHIELD);
335   ECase(EM_COREA_1ST);
336   ECase(EM_COREA_2ND);
337   ECase(EM_ARC_COMPACT2);
338   ECase(EM_OPEN8);
339   ECase(EM_RL78);
340   ECase(EM_VIDEOCORE5);
341   ECase(EM_78KOR);
342   ECase(EM_56800EX);
343   ECase(EM_AMDGPU);
344   ECase(EM_RISCV);
345   ECase(EM_LANAI);
346   ECase(EM_BPF);
347   ECase(EM_VE);
348   ECase(EM_CSKY);
349   ECase(EM_LOONGARCH);
350 #undef ECase
351   IO.enumFallback<Hex16>(Value);
352 }
353 
354 void ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS>::enumeration(
355     IO &IO, ELFYAML::ELF_ELFCLASS &Value) {
356 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
357   // Since the semantics of ELFCLASSNONE is "invalid", just don't accept it
358   // here.
359   ECase(ELFCLASS32);
360   ECase(ELFCLASS64);
361 #undef ECase
362 }
363 
364 void ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA>::enumeration(
365     IO &IO, ELFYAML::ELF_ELFDATA &Value) {
366 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
367   // ELFDATANONE is an invalid data encoding, but we accept it because
368   // we want to be able to produce invalid binaries for the tests.
369   ECase(ELFDATANONE);
370   ECase(ELFDATA2LSB);
371   ECase(ELFDATA2MSB);
372 #undef ECase
373 }
374 
375 void ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI>::enumeration(
376     IO &IO, ELFYAML::ELF_ELFOSABI &Value) {
377 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
378   ECase(ELFOSABI_NONE);
379   ECase(ELFOSABI_HPUX);
380   ECase(ELFOSABI_NETBSD);
381   ECase(ELFOSABI_GNU);
382   ECase(ELFOSABI_LINUX);
383   ECase(ELFOSABI_HURD);
384   ECase(ELFOSABI_SOLARIS);
385   ECase(ELFOSABI_AIX);
386   ECase(ELFOSABI_IRIX);
387   ECase(ELFOSABI_FREEBSD);
388   ECase(ELFOSABI_TRU64);
389   ECase(ELFOSABI_MODESTO);
390   ECase(ELFOSABI_OPENBSD);
391   ECase(ELFOSABI_OPENVMS);
392   ECase(ELFOSABI_NSK);
393   ECase(ELFOSABI_AROS);
394   ECase(ELFOSABI_FENIXOS);
395   ECase(ELFOSABI_CLOUDABI);
396   ECase(ELFOSABI_AMDGPU_HSA);
397   ECase(ELFOSABI_AMDGPU_PAL);
398   ECase(ELFOSABI_AMDGPU_MESA3D);
399   ECase(ELFOSABI_ARM);
400   ECase(ELFOSABI_C6000_ELFABI);
401   ECase(ELFOSABI_C6000_LINUX);
402   ECase(ELFOSABI_STANDALONE);
403 #undef ECase
404   IO.enumFallback<Hex8>(Value);
405 }
406 
407 void ScalarBitSetTraits<ELFYAML::ELF_EF>::bitset(IO &IO,
408                                                  ELFYAML::ELF_EF &Value) {
409   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
410   assert(Object && "The IO context is not initialized");
411 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
412 #define BCaseMask(X, M) IO.maskedBitSetCase(Value, #X, ELF::X, ELF::M)
413   switch (Object->getMachine()) {
414   case ELF::EM_ARM:
415     BCase(EF_ARM_SOFT_FLOAT);
416     BCase(EF_ARM_VFP_FLOAT);
417     BCaseMask(EF_ARM_EABI_UNKNOWN, EF_ARM_EABIMASK);
418     BCaseMask(EF_ARM_EABI_VER1, EF_ARM_EABIMASK);
419     BCaseMask(EF_ARM_EABI_VER2, EF_ARM_EABIMASK);
420     BCaseMask(EF_ARM_EABI_VER3, EF_ARM_EABIMASK);
421     BCaseMask(EF_ARM_EABI_VER4, EF_ARM_EABIMASK);
422     BCaseMask(EF_ARM_EABI_VER5, EF_ARM_EABIMASK);
423     break;
424   case ELF::EM_MIPS:
425     BCase(EF_MIPS_NOREORDER);
426     BCase(EF_MIPS_PIC);
427     BCase(EF_MIPS_CPIC);
428     BCase(EF_MIPS_ABI2);
429     BCase(EF_MIPS_32BITMODE);
430     BCase(EF_MIPS_FP64);
431     BCase(EF_MIPS_NAN2008);
432     BCase(EF_MIPS_MICROMIPS);
433     BCase(EF_MIPS_ARCH_ASE_M16);
434     BCase(EF_MIPS_ARCH_ASE_MDMX);
435     BCaseMask(EF_MIPS_ABI_O32, EF_MIPS_ABI);
436     BCaseMask(EF_MIPS_ABI_O64, EF_MIPS_ABI);
437     BCaseMask(EF_MIPS_ABI_EABI32, EF_MIPS_ABI);
438     BCaseMask(EF_MIPS_ABI_EABI64, EF_MIPS_ABI);
439     BCaseMask(EF_MIPS_MACH_3900, EF_MIPS_MACH);
440     BCaseMask(EF_MIPS_MACH_4010, EF_MIPS_MACH);
441     BCaseMask(EF_MIPS_MACH_4100, EF_MIPS_MACH);
442     BCaseMask(EF_MIPS_MACH_4650, EF_MIPS_MACH);
443     BCaseMask(EF_MIPS_MACH_4120, EF_MIPS_MACH);
444     BCaseMask(EF_MIPS_MACH_4111, EF_MIPS_MACH);
445     BCaseMask(EF_MIPS_MACH_SB1, EF_MIPS_MACH);
446     BCaseMask(EF_MIPS_MACH_OCTEON, EF_MIPS_MACH);
447     BCaseMask(EF_MIPS_MACH_XLR, EF_MIPS_MACH);
448     BCaseMask(EF_MIPS_MACH_OCTEON2, EF_MIPS_MACH);
449     BCaseMask(EF_MIPS_MACH_OCTEON3, EF_MIPS_MACH);
450     BCaseMask(EF_MIPS_MACH_5400, EF_MIPS_MACH);
451     BCaseMask(EF_MIPS_MACH_5900, EF_MIPS_MACH);
452     BCaseMask(EF_MIPS_MACH_5500, EF_MIPS_MACH);
453     BCaseMask(EF_MIPS_MACH_9000, EF_MIPS_MACH);
454     BCaseMask(EF_MIPS_MACH_LS2E, EF_MIPS_MACH);
455     BCaseMask(EF_MIPS_MACH_LS2F, EF_MIPS_MACH);
456     BCaseMask(EF_MIPS_MACH_LS3A, EF_MIPS_MACH);
457     BCaseMask(EF_MIPS_ARCH_1, EF_MIPS_ARCH);
458     BCaseMask(EF_MIPS_ARCH_2, EF_MIPS_ARCH);
459     BCaseMask(EF_MIPS_ARCH_3, EF_MIPS_ARCH);
460     BCaseMask(EF_MIPS_ARCH_4, EF_MIPS_ARCH);
461     BCaseMask(EF_MIPS_ARCH_5, EF_MIPS_ARCH);
462     BCaseMask(EF_MIPS_ARCH_32, EF_MIPS_ARCH);
463     BCaseMask(EF_MIPS_ARCH_64, EF_MIPS_ARCH);
464     BCaseMask(EF_MIPS_ARCH_32R2, EF_MIPS_ARCH);
465     BCaseMask(EF_MIPS_ARCH_64R2, EF_MIPS_ARCH);
466     BCaseMask(EF_MIPS_ARCH_32R6, EF_MIPS_ARCH);
467     BCaseMask(EF_MIPS_ARCH_64R6, EF_MIPS_ARCH);
468     break;
469   case ELF::EM_HEXAGON:
470     BCaseMask(EF_HEXAGON_MACH_V2, EF_HEXAGON_MACH);
471     BCaseMask(EF_HEXAGON_MACH_V3, EF_HEXAGON_MACH);
472     BCaseMask(EF_HEXAGON_MACH_V4, EF_HEXAGON_MACH);
473     BCaseMask(EF_HEXAGON_MACH_V5, EF_HEXAGON_MACH);
474     BCaseMask(EF_HEXAGON_MACH_V55, EF_HEXAGON_MACH);
475     BCaseMask(EF_HEXAGON_MACH_V60, EF_HEXAGON_MACH);
476     BCaseMask(EF_HEXAGON_MACH_V62, EF_HEXAGON_MACH);
477     BCaseMask(EF_HEXAGON_MACH_V65, EF_HEXAGON_MACH);
478     BCaseMask(EF_HEXAGON_MACH_V66, EF_HEXAGON_MACH);
479     BCaseMask(EF_HEXAGON_MACH_V67, EF_HEXAGON_MACH);
480     BCaseMask(EF_HEXAGON_MACH_V67T, EF_HEXAGON_MACH);
481     BCaseMask(EF_HEXAGON_MACH_V68, EF_HEXAGON_MACH);
482     BCaseMask(EF_HEXAGON_MACH_V69, EF_HEXAGON_MACH);
483     BCaseMask(EF_HEXAGON_ISA_V2, EF_HEXAGON_ISA);
484     BCaseMask(EF_HEXAGON_ISA_V3, EF_HEXAGON_ISA);
485     BCaseMask(EF_HEXAGON_ISA_V4, EF_HEXAGON_ISA);
486     BCaseMask(EF_HEXAGON_ISA_V5, EF_HEXAGON_ISA);
487     BCaseMask(EF_HEXAGON_ISA_V55, EF_HEXAGON_ISA);
488     BCaseMask(EF_HEXAGON_ISA_V60, EF_HEXAGON_ISA);
489     BCaseMask(EF_HEXAGON_ISA_V62, EF_HEXAGON_ISA);
490     BCaseMask(EF_HEXAGON_ISA_V65, EF_HEXAGON_ISA);
491     BCaseMask(EF_HEXAGON_ISA_V66, EF_HEXAGON_ISA);
492     BCaseMask(EF_HEXAGON_ISA_V67, EF_HEXAGON_ISA);
493     BCaseMask(EF_HEXAGON_ISA_V68, EF_HEXAGON_ISA);
494     BCaseMask(EF_HEXAGON_ISA_V69, EF_HEXAGON_ISA);
495     break;
496   case ELF::EM_AVR:
497     BCaseMask(EF_AVR_ARCH_AVR1, EF_AVR_ARCH_MASK);
498     BCaseMask(EF_AVR_ARCH_AVR2, EF_AVR_ARCH_MASK);
499     BCaseMask(EF_AVR_ARCH_AVR25, EF_AVR_ARCH_MASK);
500     BCaseMask(EF_AVR_ARCH_AVR3, EF_AVR_ARCH_MASK);
501     BCaseMask(EF_AVR_ARCH_AVR31, EF_AVR_ARCH_MASK);
502     BCaseMask(EF_AVR_ARCH_AVR35, EF_AVR_ARCH_MASK);
503     BCaseMask(EF_AVR_ARCH_AVR4, EF_AVR_ARCH_MASK);
504     BCaseMask(EF_AVR_ARCH_AVR5, EF_AVR_ARCH_MASK);
505     BCaseMask(EF_AVR_ARCH_AVR51, EF_AVR_ARCH_MASK);
506     BCaseMask(EF_AVR_ARCH_AVR6, EF_AVR_ARCH_MASK);
507     BCaseMask(EF_AVR_ARCH_AVRTINY, EF_AVR_ARCH_MASK);
508     BCaseMask(EF_AVR_ARCH_XMEGA1, EF_AVR_ARCH_MASK);
509     BCaseMask(EF_AVR_ARCH_XMEGA2, EF_AVR_ARCH_MASK);
510     BCaseMask(EF_AVR_ARCH_XMEGA3, EF_AVR_ARCH_MASK);
511     BCaseMask(EF_AVR_ARCH_XMEGA4, EF_AVR_ARCH_MASK);
512     BCaseMask(EF_AVR_ARCH_XMEGA5, EF_AVR_ARCH_MASK);
513     BCaseMask(EF_AVR_ARCH_XMEGA6, EF_AVR_ARCH_MASK);
514     BCaseMask(EF_AVR_ARCH_XMEGA7, EF_AVR_ARCH_MASK);
515     BCase(EF_AVR_LINKRELAX_PREPARED);
516     break;
517   case ELF::EM_RISCV:
518     BCase(EF_RISCV_RVC);
519     BCaseMask(EF_RISCV_FLOAT_ABI_SOFT, EF_RISCV_FLOAT_ABI);
520     BCaseMask(EF_RISCV_FLOAT_ABI_SINGLE, EF_RISCV_FLOAT_ABI);
521     BCaseMask(EF_RISCV_FLOAT_ABI_DOUBLE, EF_RISCV_FLOAT_ABI);
522     BCaseMask(EF_RISCV_FLOAT_ABI_QUAD, EF_RISCV_FLOAT_ABI);
523     BCase(EF_RISCV_RVE);
524     BCase(EF_RISCV_TSO);
525     break;
526   case ELF::EM_AMDGPU:
527     BCaseMask(EF_AMDGPU_MACH_NONE, EF_AMDGPU_MACH);
528     BCaseMask(EF_AMDGPU_MACH_R600_R600, EF_AMDGPU_MACH);
529     BCaseMask(EF_AMDGPU_MACH_R600_R630, EF_AMDGPU_MACH);
530     BCaseMask(EF_AMDGPU_MACH_R600_RS880, EF_AMDGPU_MACH);
531     BCaseMask(EF_AMDGPU_MACH_R600_RV670, EF_AMDGPU_MACH);
532     BCaseMask(EF_AMDGPU_MACH_R600_RV710, EF_AMDGPU_MACH);
533     BCaseMask(EF_AMDGPU_MACH_R600_RV730, EF_AMDGPU_MACH);
534     BCaseMask(EF_AMDGPU_MACH_R600_RV770, EF_AMDGPU_MACH);
535     BCaseMask(EF_AMDGPU_MACH_R600_CEDAR, EF_AMDGPU_MACH);
536     BCaseMask(EF_AMDGPU_MACH_R600_CYPRESS, EF_AMDGPU_MACH);
537     BCaseMask(EF_AMDGPU_MACH_R600_JUNIPER, EF_AMDGPU_MACH);
538     BCaseMask(EF_AMDGPU_MACH_R600_REDWOOD, EF_AMDGPU_MACH);
539     BCaseMask(EF_AMDGPU_MACH_R600_SUMO, EF_AMDGPU_MACH);
540     BCaseMask(EF_AMDGPU_MACH_R600_BARTS, EF_AMDGPU_MACH);
541     BCaseMask(EF_AMDGPU_MACH_R600_CAICOS, EF_AMDGPU_MACH);
542     BCaseMask(EF_AMDGPU_MACH_R600_CAYMAN, EF_AMDGPU_MACH);
543     BCaseMask(EF_AMDGPU_MACH_R600_TURKS, EF_AMDGPU_MACH);
544     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX600, EF_AMDGPU_MACH);
545     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX601, EF_AMDGPU_MACH);
546     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX602, EF_AMDGPU_MACH);
547     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX700, EF_AMDGPU_MACH);
548     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX701, EF_AMDGPU_MACH);
549     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX702, EF_AMDGPU_MACH);
550     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX703, EF_AMDGPU_MACH);
551     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX704, EF_AMDGPU_MACH);
552     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX705, EF_AMDGPU_MACH);
553     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX801, EF_AMDGPU_MACH);
554     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX802, EF_AMDGPU_MACH);
555     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX803, EF_AMDGPU_MACH);
556     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX805, EF_AMDGPU_MACH);
557     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX810, EF_AMDGPU_MACH);
558     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX900, EF_AMDGPU_MACH);
559     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX902, EF_AMDGPU_MACH);
560     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX904, EF_AMDGPU_MACH);
561     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX906, EF_AMDGPU_MACH);
562     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX908, EF_AMDGPU_MACH);
563     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX909, EF_AMDGPU_MACH);
564     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX90A, EF_AMDGPU_MACH);
565     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX90C, EF_AMDGPU_MACH);
566     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1010, EF_AMDGPU_MACH);
567     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1011, EF_AMDGPU_MACH);
568     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1012, EF_AMDGPU_MACH);
569     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1013, EF_AMDGPU_MACH);
570     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1030, EF_AMDGPU_MACH);
571     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1031, EF_AMDGPU_MACH);
572     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1032, EF_AMDGPU_MACH);
573     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1033, EF_AMDGPU_MACH);
574     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1034, EF_AMDGPU_MACH);
575     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1035, EF_AMDGPU_MACH);
576     switch (Object->Header.ABIVersion) {
577     default:
578       // ELFOSABI_AMDGPU_PAL, ELFOSABI_AMDGPU_MESA3D support *_V3 flags.
579       LLVM_FALLTHROUGH;
580     case ELF::ELFABIVERSION_AMDGPU_HSA_V3:
581       BCase(EF_AMDGPU_FEATURE_XNACK_V3);
582       BCase(EF_AMDGPU_FEATURE_SRAMECC_V3);
583       break;
584     case ELF::ELFABIVERSION_AMDGPU_HSA_V4:
585     case ELF::ELFABIVERSION_AMDGPU_HSA_V5:
586       BCaseMask(EF_AMDGPU_FEATURE_XNACK_UNSUPPORTED_V4,
587                 EF_AMDGPU_FEATURE_XNACK_V4);
588       BCaseMask(EF_AMDGPU_FEATURE_XNACK_ANY_V4,
589                 EF_AMDGPU_FEATURE_XNACK_V4);
590       BCaseMask(EF_AMDGPU_FEATURE_XNACK_OFF_V4,
591                 EF_AMDGPU_FEATURE_XNACK_V4);
592       BCaseMask(EF_AMDGPU_FEATURE_XNACK_ON_V4,
593                 EF_AMDGPU_FEATURE_XNACK_V4);
594       BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_UNSUPPORTED_V4,
595                 EF_AMDGPU_FEATURE_SRAMECC_V4);
596       BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_ANY_V4,
597                 EF_AMDGPU_FEATURE_SRAMECC_V4);
598       BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_OFF_V4,
599                 EF_AMDGPU_FEATURE_SRAMECC_V4);
600       BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_ON_V4,
601                 EF_AMDGPU_FEATURE_SRAMECC_V4);
602       break;
603     }
604     break;
605   default:
606     break;
607   }
608 #undef BCase
609 #undef BCaseMask
610 }
611 
612 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
613     IO &IO, ELFYAML::ELF_SHT &Value) {
614   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
615   assert(Object && "The IO context is not initialized");
616 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
617   ECase(SHT_NULL);
618   ECase(SHT_PROGBITS);
619   ECase(SHT_SYMTAB);
620   // FIXME: Issue a diagnostic with this information.
621   ECase(SHT_STRTAB);
622   ECase(SHT_RELA);
623   ECase(SHT_HASH);
624   ECase(SHT_DYNAMIC);
625   ECase(SHT_NOTE);
626   ECase(SHT_NOBITS);
627   ECase(SHT_REL);
628   ECase(SHT_SHLIB);
629   ECase(SHT_DYNSYM);
630   ECase(SHT_INIT_ARRAY);
631   ECase(SHT_FINI_ARRAY);
632   ECase(SHT_PREINIT_ARRAY);
633   ECase(SHT_GROUP);
634   ECase(SHT_SYMTAB_SHNDX);
635   ECase(SHT_RELR);
636   ECase(SHT_ANDROID_REL);
637   ECase(SHT_ANDROID_RELA);
638   ECase(SHT_ANDROID_RELR);
639   ECase(SHT_LLVM_ODRTAB);
640   ECase(SHT_LLVM_LINKER_OPTIONS);
641   ECase(SHT_LLVM_CALL_GRAPH_PROFILE);
642   ECase(SHT_LLVM_ADDRSIG);
643   ECase(SHT_LLVM_DEPENDENT_LIBRARIES);
644   ECase(SHT_LLVM_SYMPART);
645   ECase(SHT_LLVM_PART_EHDR);
646   ECase(SHT_LLVM_PART_PHDR);
647   ECase(SHT_LLVM_BB_ADDR_MAP);
648   ECase(SHT_GNU_ATTRIBUTES);
649   ECase(SHT_GNU_HASH);
650   ECase(SHT_GNU_verdef);
651   ECase(SHT_GNU_verneed);
652   ECase(SHT_GNU_versym);
653   switch (Object->getMachine()) {
654   case ELF::EM_ARM:
655     ECase(SHT_ARM_EXIDX);
656     ECase(SHT_ARM_PREEMPTMAP);
657     ECase(SHT_ARM_ATTRIBUTES);
658     ECase(SHT_ARM_DEBUGOVERLAY);
659     ECase(SHT_ARM_OVERLAYSECTION);
660     break;
661   case ELF::EM_HEXAGON:
662     ECase(SHT_HEX_ORDERED);
663     break;
664   case ELF::EM_X86_64:
665     ECase(SHT_X86_64_UNWIND);
666     break;
667   case ELF::EM_MIPS:
668     ECase(SHT_MIPS_REGINFO);
669     ECase(SHT_MIPS_OPTIONS);
670     ECase(SHT_MIPS_DWARF);
671     ECase(SHT_MIPS_ABIFLAGS);
672     break;
673   case ELF::EM_RISCV:
674     ECase(SHT_RISCV_ATTRIBUTES);
675     break;
676   case ELF::EM_MSP430:
677     ECase(SHT_MSP430_ATTRIBUTES);
678     break;
679   default:
680     // Nothing to do.
681     break;
682   }
683 #undef ECase
684   IO.enumFallback<Hex32>(Value);
685 }
686 
687 void ScalarBitSetTraits<ELFYAML::ELF_PF>::bitset(IO &IO,
688                                                  ELFYAML::ELF_PF &Value) {
689 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
690   BCase(PF_X);
691   BCase(PF_W);
692   BCase(PF_R);
693 }
694 
695 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
696                                                   ELFYAML::ELF_SHF &Value) {
697   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
698 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
699   BCase(SHF_WRITE);
700   BCase(SHF_ALLOC);
701   BCase(SHF_EXCLUDE);
702   BCase(SHF_EXECINSTR);
703   BCase(SHF_MERGE);
704   BCase(SHF_STRINGS);
705   BCase(SHF_INFO_LINK);
706   BCase(SHF_LINK_ORDER);
707   BCase(SHF_OS_NONCONFORMING);
708   BCase(SHF_GROUP);
709   BCase(SHF_TLS);
710   BCase(SHF_COMPRESSED);
711   switch (Object->getOSAbi()) {
712   case ELF::ELFOSABI_SOLARIS:
713     BCase(SHF_SUNW_NODISCARD);
714     break;
715   default:
716     BCase(SHF_GNU_RETAIN);
717     break;
718   }
719   switch (Object->getMachine()) {
720   case ELF::EM_ARM:
721     BCase(SHF_ARM_PURECODE);
722     break;
723   case ELF::EM_HEXAGON:
724     BCase(SHF_HEX_GPREL);
725     break;
726   case ELF::EM_MIPS:
727     BCase(SHF_MIPS_NODUPES);
728     BCase(SHF_MIPS_NAMES);
729     BCase(SHF_MIPS_LOCAL);
730     BCase(SHF_MIPS_NOSTRIP);
731     BCase(SHF_MIPS_GPREL);
732     BCase(SHF_MIPS_MERGE);
733     BCase(SHF_MIPS_ADDR);
734     BCase(SHF_MIPS_STRING);
735     break;
736   case ELF::EM_X86_64:
737     BCase(SHF_X86_64_LARGE);
738     break;
739   default:
740     // Nothing to do.
741     break;
742   }
743 #undef BCase
744 }
745 
746 void ScalarEnumerationTraits<ELFYAML::ELF_SHN>::enumeration(
747     IO &IO, ELFYAML::ELF_SHN &Value) {
748 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
749   ECase(SHN_UNDEF);
750   ECase(SHN_LORESERVE);
751   ECase(SHN_LOPROC);
752   ECase(SHN_HIPROC);
753   ECase(SHN_LOOS);
754   ECase(SHN_HIOS);
755   ECase(SHN_ABS);
756   ECase(SHN_COMMON);
757   ECase(SHN_XINDEX);
758   ECase(SHN_HIRESERVE);
759   ECase(SHN_AMDGPU_LDS);
760   ECase(SHN_HEXAGON_SCOMMON);
761   ECase(SHN_HEXAGON_SCOMMON_1);
762   ECase(SHN_HEXAGON_SCOMMON_2);
763   ECase(SHN_HEXAGON_SCOMMON_4);
764   ECase(SHN_HEXAGON_SCOMMON_8);
765 #undef ECase
766   IO.enumFallback<Hex16>(Value);
767 }
768 
769 void ScalarEnumerationTraits<ELFYAML::ELF_STB>::enumeration(
770     IO &IO, ELFYAML::ELF_STB &Value) {
771 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
772   ECase(STB_LOCAL);
773   ECase(STB_GLOBAL);
774   ECase(STB_WEAK);
775   ECase(STB_GNU_UNIQUE);
776 #undef ECase
777   IO.enumFallback<Hex8>(Value);
778 }
779 
780 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
781     IO &IO, ELFYAML::ELF_STT &Value) {
782 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
783   ECase(STT_NOTYPE);
784   ECase(STT_OBJECT);
785   ECase(STT_FUNC);
786   ECase(STT_SECTION);
787   ECase(STT_FILE);
788   ECase(STT_COMMON);
789   ECase(STT_TLS);
790   ECase(STT_GNU_IFUNC);
791 #undef ECase
792   IO.enumFallback<Hex8>(Value);
793 }
794 
795 
796 void ScalarEnumerationTraits<ELFYAML::ELF_RSS>::enumeration(
797     IO &IO, ELFYAML::ELF_RSS &Value) {
798 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
799   ECase(RSS_UNDEF);
800   ECase(RSS_GP);
801   ECase(RSS_GP0);
802   ECase(RSS_LOC);
803 #undef ECase
804 }
805 
806 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
807     IO &IO, ELFYAML::ELF_REL &Value) {
808   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
809   assert(Object && "The IO context is not initialized");
810 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
811   switch (Object->getMachine()) {
812   case ELF::EM_X86_64:
813 #include "llvm/BinaryFormat/ELFRelocs/x86_64.def"
814     break;
815   case ELF::EM_MIPS:
816 #include "llvm/BinaryFormat/ELFRelocs/Mips.def"
817     break;
818   case ELF::EM_HEXAGON:
819 #include "llvm/BinaryFormat/ELFRelocs/Hexagon.def"
820     break;
821   case ELF::EM_386:
822   case ELF::EM_IAMCU:
823 #include "llvm/BinaryFormat/ELFRelocs/i386.def"
824     break;
825   case ELF::EM_AARCH64:
826 #include "llvm/BinaryFormat/ELFRelocs/AArch64.def"
827     break;
828   case ELF::EM_ARM:
829 #include "llvm/BinaryFormat/ELFRelocs/ARM.def"
830     break;
831   case ELF::EM_ARC:
832 #include "llvm/BinaryFormat/ELFRelocs/ARC.def"
833     break;
834   case ELF::EM_RISCV:
835 #include "llvm/BinaryFormat/ELFRelocs/RISCV.def"
836     break;
837   case ELF::EM_LANAI:
838 #include "llvm/BinaryFormat/ELFRelocs/Lanai.def"
839     break;
840   case ELF::EM_AMDGPU:
841 #include "llvm/BinaryFormat/ELFRelocs/AMDGPU.def"
842     break;
843   case ELF::EM_BPF:
844 #include "llvm/BinaryFormat/ELFRelocs/BPF.def"
845     break;
846   case ELF::EM_VE:
847 #include "llvm/BinaryFormat/ELFRelocs/VE.def"
848     break;
849   case ELF::EM_CSKY:
850 #include "llvm/BinaryFormat/ELFRelocs/CSKY.def"
851     break;
852   case ELF::EM_PPC:
853 #include "llvm/BinaryFormat/ELFRelocs/PowerPC.def"
854     break;
855   case ELF::EM_PPC64:
856 #include "llvm/BinaryFormat/ELFRelocs/PowerPC64.def"
857     break;
858   case ELF::EM_68K:
859 #include "llvm/BinaryFormat/ELFRelocs/M68k.def"
860     break;
861   case ELF::EM_LOONGARCH:
862 #include "llvm/BinaryFormat/ELFRelocs/LoongArch.def"
863     break;
864   default:
865     // Nothing to do.
866     break;
867   }
868 #undef ELF_RELOC
869   IO.enumFallback<Hex32>(Value);
870 }
871 
872 void ScalarEnumerationTraits<ELFYAML::ELF_DYNTAG>::enumeration(
873     IO &IO, ELFYAML::ELF_DYNTAG &Value) {
874   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
875   assert(Object && "The IO context is not initialized");
876 
877 // Disable architecture specific tags by default. We might enable them below.
878 #define AARCH64_DYNAMIC_TAG(name, value)
879 #define MIPS_DYNAMIC_TAG(name, value)
880 #define HEXAGON_DYNAMIC_TAG(name, value)
881 #define PPC_DYNAMIC_TAG(name, value)
882 #define PPC64_DYNAMIC_TAG(name, value)
883 // Ignore marker tags such as DT_HIOS (maps to DT_VERNEEDNUM), etc.
884 #define DYNAMIC_TAG_MARKER(name, value)
885 
886 #define STRINGIFY(X) (#X)
887 #define DYNAMIC_TAG(X, Y) IO.enumCase(Value, STRINGIFY(DT_##X), ELF::DT_##X);
888   switch (Object->getMachine()) {
889   case ELF::EM_AARCH64:
890 #undef AARCH64_DYNAMIC_TAG
891 #define AARCH64_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
892 #include "llvm/BinaryFormat/DynamicTags.def"
893 #undef AARCH64_DYNAMIC_TAG
894 #define AARCH64_DYNAMIC_TAG(name, value)
895     break;
896   case ELF::EM_MIPS:
897 #undef MIPS_DYNAMIC_TAG
898 #define MIPS_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
899 #include "llvm/BinaryFormat/DynamicTags.def"
900 #undef MIPS_DYNAMIC_TAG
901 #define MIPS_DYNAMIC_TAG(name, value)
902     break;
903   case ELF::EM_HEXAGON:
904 #undef HEXAGON_DYNAMIC_TAG
905 #define HEXAGON_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
906 #include "llvm/BinaryFormat/DynamicTags.def"
907 #undef HEXAGON_DYNAMIC_TAG
908 #define HEXAGON_DYNAMIC_TAG(name, value)
909     break;
910   case ELF::EM_PPC:
911 #undef PPC_DYNAMIC_TAG
912 #define PPC_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
913 #include "llvm/BinaryFormat/DynamicTags.def"
914 #undef PPC_DYNAMIC_TAG
915 #define PPC_DYNAMIC_TAG(name, value)
916     break;
917   case ELF::EM_PPC64:
918 #undef PPC64_DYNAMIC_TAG
919 #define PPC64_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
920 #include "llvm/BinaryFormat/DynamicTags.def"
921 #undef PPC64_DYNAMIC_TAG
922 #define PPC64_DYNAMIC_TAG(name, value)
923     break;
924   case ELF::EM_RISCV:
925 #undef RISCV_DYNAMIC_TAG
926 #define RISCV_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
927 #include "llvm/BinaryFormat/DynamicTags.def"
928 #undef RISCV_DYNAMIC_TAG
929 #define RISCV_DYNAMIC_TAG(name, value)
930     break;
931   default:
932 #include "llvm/BinaryFormat/DynamicTags.def"
933     break;
934   }
935 #undef AARCH64_DYNAMIC_TAG
936 #undef MIPS_DYNAMIC_TAG
937 #undef HEXAGON_DYNAMIC_TAG
938 #undef PPC_DYNAMIC_TAG
939 #undef PPC64_DYNAMIC_TAG
940 #undef DYNAMIC_TAG_MARKER
941 #undef STRINGIFY
942 #undef DYNAMIC_TAG
943 
944   IO.enumFallback<Hex64>(Value);
945 }
946 
947 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG>::enumeration(
948     IO &IO, ELFYAML::MIPS_AFL_REG &Value) {
949 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
950   ECase(REG_NONE);
951   ECase(REG_32);
952   ECase(REG_64);
953   ECase(REG_128);
954 #undef ECase
955 }
956 
957 void ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP>::enumeration(
958     IO &IO, ELFYAML::MIPS_ABI_FP &Value) {
959 #define ECase(X) IO.enumCase(Value, #X, Mips::Val_GNU_MIPS_ABI_##X)
960   ECase(FP_ANY);
961   ECase(FP_DOUBLE);
962   ECase(FP_SINGLE);
963   ECase(FP_SOFT);
964   ECase(FP_OLD_64);
965   ECase(FP_XX);
966   ECase(FP_64);
967   ECase(FP_64A);
968 #undef ECase
969 }
970 
971 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT>::enumeration(
972     IO &IO, ELFYAML::MIPS_AFL_EXT &Value) {
973 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
974   ECase(EXT_NONE);
975   ECase(EXT_XLR);
976   ECase(EXT_OCTEON2);
977   ECase(EXT_OCTEONP);
978   ECase(EXT_LOONGSON_3A);
979   ECase(EXT_OCTEON);
980   ECase(EXT_5900);
981   ECase(EXT_4650);
982   ECase(EXT_4010);
983   ECase(EXT_4100);
984   ECase(EXT_3900);
985   ECase(EXT_10000);
986   ECase(EXT_SB1);
987   ECase(EXT_4111);
988   ECase(EXT_4120);
989   ECase(EXT_5400);
990   ECase(EXT_5500);
991   ECase(EXT_LOONGSON_2E);
992   ECase(EXT_LOONGSON_2F);
993   ECase(EXT_OCTEON3);
994 #undef ECase
995 }
996 
997 void ScalarEnumerationTraits<ELFYAML::MIPS_ISA>::enumeration(
998     IO &IO, ELFYAML::MIPS_ISA &Value) {
999   IO.enumCase(Value, "MIPS1", 1);
1000   IO.enumCase(Value, "MIPS2", 2);
1001   IO.enumCase(Value, "MIPS3", 3);
1002   IO.enumCase(Value, "MIPS4", 4);
1003   IO.enumCase(Value, "MIPS5", 5);
1004   IO.enumCase(Value, "MIPS32", 32);
1005   IO.enumCase(Value, "MIPS64", 64);
1006   IO.enumFallback<Hex32>(Value);
1007 }
1008 
1009 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE>::bitset(
1010     IO &IO, ELFYAML::MIPS_AFL_ASE &Value) {
1011 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_ASE_##X)
1012   BCase(DSP);
1013   BCase(DSPR2);
1014   BCase(EVA);
1015   BCase(MCU);
1016   BCase(MDMX);
1017   BCase(MIPS3D);
1018   BCase(MT);
1019   BCase(SMARTMIPS);
1020   BCase(VIRT);
1021   BCase(MSA);
1022   BCase(MIPS16);
1023   BCase(MICROMIPS);
1024   BCase(XPA);
1025   BCase(CRC);
1026   BCase(GINV);
1027 #undef BCase
1028 }
1029 
1030 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1>::bitset(
1031     IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value) {
1032 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_FLAGS1_##X)
1033   BCase(ODDSPREG);
1034 #undef BCase
1035 }
1036 
1037 void MappingTraits<ELFYAML::SectionHeader>::mapping(
1038     IO &IO, ELFYAML::SectionHeader &SHdr) {
1039   IO.mapRequired("Name", SHdr.Name);
1040 }
1041 
1042 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
1043                                                  ELFYAML::FileHeader &FileHdr) {
1044   IO.mapRequired("Class", FileHdr.Class);
1045   IO.mapRequired("Data", FileHdr.Data);
1046   IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
1047   IO.mapOptional("ABIVersion", FileHdr.ABIVersion, Hex8(0));
1048   IO.mapRequired("Type", FileHdr.Type);
1049   IO.mapOptional("Machine", FileHdr.Machine);
1050   IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
1051   IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
1052   IO.mapOptional("SectionHeaderStringTable", FileHdr.SectionHeaderStringTable);
1053 
1054   // obj2yaml does not dump these fields.
1055   assert(!IO.outputting() ||
1056          (!FileHdr.EPhOff && !FileHdr.EPhEntSize && !FileHdr.EPhNum));
1057   IO.mapOptional("EPhOff", FileHdr.EPhOff);
1058   IO.mapOptional("EPhEntSize", FileHdr.EPhEntSize);
1059   IO.mapOptional("EPhNum", FileHdr.EPhNum);
1060   IO.mapOptional("EShEntSize", FileHdr.EShEntSize);
1061   IO.mapOptional("EShOff", FileHdr.EShOff);
1062   IO.mapOptional("EShNum", FileHdr.EShNum);
1063   IO.mapOptional("EShStrNdx", FileHdr.EShStrNdx);
1064 }
1065 
1066 void MappingTraits<ELFYAML::ProgramHeader>::mapping(
1067     IO &IO, ELFYAML::ProgramHeader &Phdr) {
1068   IO.mapRequired("Type", Phdr.Type);
1069   IO.mapOptional("Flags", Phdr.Flags, ELFYAML::ELF_PF(0));
1070   IO.mapOptional("FirstSec", Phdr.FirstSec);
1071   IO.mapOptional("LastSec", Phdr.LastSec);
1072   IO.mapOptional("VAddr", Phdr.VAddr, Hex64(0));
1073   IO.mapOptional("PAddr", Phdr.PAddr, Phdr.VAddr);
1074   IO.mapOptional("Align", Phdr.Align);
1075   IO.mapOptional("FileSize", Phdr.FileSize);
1076   IO.mapOptional("MemSize", Phdr.MemSize);
1077   IO.mapOptional("Offset", Phdr.Offset);
1078 }
1079 
1080 std::string MappingTraits<ELFYAML::ProgramHeader>::validate(
1081     IO &IO, ELFYAML::ProgramHeader &FileHdr) {
1082   if (!FileHdr.FirstSec && FileHdr.LastSec)
1083     return "the \"LastSec\" key can't be used without the \"FirstSec\" key";
1084   if (FileHdr.FirstSec && !FileHdr.LastSec)
1085     return "the \"FirstSec\" key can't be used without the \"LastSec\" key";
1086   return "";
1087 }
1088 
1089 LLVM_YAML_STRONG_TYPEDEF(StringRef, StOtherPiece)
1090 
1091 template <> struct ScalarTraits<StOtherPiece> {
1092   static void output(const StOtherPiece &Val, void *, raw_ostream &Out) {
1093     Out << Val;
1094   }
1095   static StringRef input(StringRef Scalar, void *, StOtherPiece &Val) {
1096     Val = Scalar;
1097     return {};
1098   }
1099   static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1100 };
1101 template <> struct SequenceElementTraits<StOtherPiece> {
1102   static const bool flow = true;
1103 };
1104 
1105 template <> struct ScalarTraits<ELFYAML::YAMLFlowString> {
1106   static void output(const ELFYAML::YAMLFlowString &Val, void *,
1107                      raw_ostream &Out) {
1108     Out << Val;
1109   }
1110   static StringRef input(StringRef Scalar, void *,
1111                          ELFYAML::YAMLFlowString &Val) {
1112     Val = Scalar;
1113     return {};
1114   }
1115   static QuotingType mustQuote(StringRef S) {
1116     return ScalarTraits<StringRef>::mustQuote(S);
1117   }
1118 };
1119 template <> struct SequenceElementTraits<ELFYAML::YAMLFlowString> {
1120   static const bool flow = true;
1121 };
1122 
1123 namespace {
1124 
1125 struct NormalizedOther {
1126   NormalizedOther(IO &IO) : YamlIO(IO) {}
1127   NormalizedOther(IO &IO, Optional<uint8_t> Original) : YamlIO(IO) {
1128     assert(Original && "This constructor is only used for outputting YAML and "
1129                        "assumes a non-empty Original");
1130     std::vector<StOtherPiece> Ret;
1131     const auto *Object = static_cast<ELFYAML::Object *>(YamlIO.getContext());
1132     for (std::pair<StringRef, uint8_t> &P :
1133          getFlags(Object->getMachine()).takeVector()) {
1134       uint8_t FlagValue = P.second;
1135       if ((*Original & FlagValue) != FlagValue)
1136         continue;
1137       *Original &= ~FlagValue;
1138       Ret.push_back({P.first});
1139     }
1140 
1141     if (*Original != 0) {
1142       UnknownFlagsHolder = std::to_string(*Original);
1143       Ret.push_back({UnknownFlagsHolder});
1144     }
1145 
1146     if (!Ret.empty())
1147       Other = std::move(Ret);
1148   }
1149 
1150   uint8_t toValue(StringRef Name) {
1151     const auto *Object = static_cast<ELFYAML::Object *>(YamlIO.getContext());
1152     MapVector<StringRef, uint8_t> Flags = getFlags(Object->getMachine());
1153 
1154     auto It = Flags.find(Name);
1155     if (It != Flags.end())
1156       return It->second;
1157 
1158     uint8_t Val;
1159     if (to_integer(Name, Val))
1160       return Val;
1161 
1162     YamlIO.setError("an unknown value is used for symbol's 'Other' field: " +
1163                     Name);
1164     return 0;
1165   }
1166 
1167   Optional<uint8_t> denormalize(IO &) {
1168     if (!Other)
1169       return None;
1170     uint8_t Ret = 0;
1171     for (StOtherPiece &Val : *Other)
1172       Ret |= toValue(Val);
1173     return Ret;
1174   }
1175 
1176   // st_other field is used to encode symbol visibility and platform-dependent
1177   // flags and values. This method returns a name to value map that is used for
1178   // parsing and encoding this field.
1179   MapVector<StringRef, uint8_t> getFlags(unsigned EMachine) {
1180     MapVector<StringRef, uint8_t> Map;
1181     // STV_* values are just enumeration values. We add them in a reversed order
1182     // because when we convert the st_other to named constants when printing
1183     // YAML we want to use a maximum number of bits on each step:
1184     // when we have st_other == 3, we want to print it as STV_PROTECTED (3), but
1185     // not as STV_HIDDEN (2) + STV_INTERNAL (1).
1186     Map["STV_PROTECTED"] = ELF::STV_PROTECTED;
1187     Map["STV_HIDDEN"] = ELF::STV_HIDDEN;
1188     Map["STV_INTERNAL"] = ELF::STV_INTERNAL;
1189     // STV_DEFAULT is used to represent the default visibility and has a value
1190     // 0. We want to be able to read it from YAML documents, but there is no
1191     // reason to print it.
1192     if (!YamlIO.outputting())
1193       Map["STV_DEFAULT"] = ELF::STV_DEFAULT;
1194 
1195     // MIPS is not consistent. All of the STO_MIPS_* values are bit flags,
1196     // except STO_MIPS_MIPS16 which overlaps them. It should be checked and
1197     // consumed first when we print the output, because we do not want to print
1198     // any other flags that have the same bits instead.
1199     if (EMachine == ELF::EM_MIPS) {
1200       Map["STO_MIPS_MIPS16"] = ELF::STO_MIPS_MIPS16;
1201       Map["STO_MIPS_MICROMIPS"] = ELF::STO_MIPS_MICROMIPS;
1202       Map["STO_MIPS_PIC"] = ELF::STO_MIPS_PIC;
1203       Map["STO_MIPS_PLT"] = ELF::STO_MIPS_PLT;
1204       Map["STO_MIPS_OPTIONAL"] = ELF::STO_MIPS_OPTIONAL;
1205     }
1206 
1207     if (EMachine == ELF::EM_AARCH64)
1208       Map["STO_AARCH64_VARIANT_PCS"] = ELF::STO_AARCH64_VARIANT_PCS;
1209     if (EMachine == ELF::EM_RISCV)
1210       Map["STO_RISCV_VARIANT_CC"] = ELF::STO_RISCV_VARIANT_CC;
1211     return Map;
1212   }
1213 
1214   IO &YamlIO;
1215   Optional<std::vector<StOtherPiece>> Other;
1216   std::string UnknownFlagsHolder;
1217 };
1218 
1219 } // end anonymous namespace
1220 
1221 void ScalarTraits<ELFYAML::YAMLIntUInt>::output(const ELFYAML::YAMLIntUInt &Val,
1222                                                 void *Ctx, raw_ostream &Out) {
1223   Out << Val;
1224 }
1225 
1226 StringRef ScalarTraits<ELFYAML::YAMLIntUInt>::input(StringRef Scalar, void *Ctx,
1227                                                     ELFYAML::YAMLIntUInt &Val) {
1228   const bool Is64 = static_cast<ELFYAML::Object *>(Ctx)->Header.Class ==
1229                     ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
1230   StringRef ErrMsg = "invalid number";
1231   // We do not accept negative hex numbers because their meaning is ambiguous.
1232   // For example, would -0xfffffffff mean 1 or INT32_MIN?
1233   if (Scalar.empty() || Scalar.startswith("-0x"))
1234     return ErrMsg;
1235 
1236   if (Scalar.startswith("-")) {
1237     const int64_t MinVal = Is64 ? INT64_MIN : INT32_MIN;
1238     long long Int;
1239     if (getAsSignedInteger(Scalar, /*Radix=*/0, Int) || (Int < MinVal))
1240       return ErrMsg;
1241     Val = Int;
1242     return "";
1243   }
1244 
1245   const uint64_t MaxVal = Is64 ? UINT64_MAX : UINT32_MAX;
1246   unsigned long long UInt;
1247   if (getAsUnsignedInteger(Scalar, /*Radix=*/0, UInt) || (UInt > MaxVal))
1248     return ErrMsg;
1249   Val = UInt;
1250   return "";
1251 }
1252 
1253 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
1254   IO.mapOptional("Name", Symbol.Name, StringRef());
1255   IO.mapOptional("StName", Symbol.StName);
1256   IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
1257   IO.mapOptional("Section", Symbol.Section);
1258   IO.mapOptional("Index", Symbol.Index);
1259   IO.mapOptional("Binding", Symbol.Binding, ELFYAML::ELF_STB(0));
1260   IO.mapOptional("Value", Symbol.Value);
1261   IO.mapOptional("Size", Symbol.Size);
1262 
1263   // Symbol's Other field is a bit special. It is usually a field that
1264   // represents st_other and holds the symbol visibility. However, on some
1265   // platforms, it can contain bit fields and regular values, or even sometimes a
1266   // crazy mix of them (see comments for NormalizedOther). Because of this, we
1267   // need special handling.
1268   MappingNormalization<NormalizedOther, Optional<uint8_t>> Keys(IO,
1269                                                                 Symbol.Other);
1270   IO.mapOptional("Other", Keys->Other);
1271 }
1272 
1273 std::string MappingTraits<ELFYAML::Symbol>::validate(IO &IO,
1274                                                      ELFYAML::Symbol &Symbol) {
1275   if (Symbol.Index && Symbol.Section)
1276     return "Index and Section cannot both be specified for Symbol";
1277   return "";
1278 }
1279 
1280 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
1281   IO.mapOptional("Name", Section.Name, StringRef());
1282   IO.mapRequired("Type", Section.Type);
1283   IO.mapOptional("Flags", Section.Flags);
1284   IO.mapOptional("Address", Section.Address);
1285   IO.mapOptional("Link", Section.Link);
1286   IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
1287   IO.mapOptional("EntSize", Section.EntSize);
1288   IO.mapOptional("Offset", Section.Offset);
1289 
1290   IO.mapOptional("Content", Section.Content);
1291   IO.mapOptional("Size", Section.Size);
1292 
1293   // obj2yaml does not dump these fields. They are expected to be empty when we
1294   // are producing YAML, because yaml2obj sets appropriate values for them
1295   // automatically when they are not explicitly defined.
1296   assert(!IO.outputting() ||
1297          (!Section.ShOffset && !Section.ShSize && !Section.ShName &&
1298           !Section.ShFlags && !Section.ShType && !Section.ShAddrAlign));
1299   IO.mapOptional("ShAddrAlign", Section.ShAddrAlign);
1300   IO.mapOptional("ShName", Section.ShName);
1301   IO.mapOptional("ShOffset", Section.ShOffset);
1302   IO.mapOptional("ShSize", Section.ShSize);
1303   IO.mapOptional("ShFlags", Section.ShFlags);
1304   IO.mapOptional("ShType", Section.ShType);
1305 }
1306 
1307 static void sectionMapping(IO &IO, ELFYAML::DynamicSection &Section) {
1308   commonSectionMapping(IO, Section);
1309   IO.mapOptional("Entries", Section.Entries);
1310 }
1311 
1312 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
1313   commonSectionMapping(IO, Section);
1314 
1315   // We also support reading a content as array of bytes using the ContentArray
1316   // key. obj2yaml never prints this field.
1317   assert(!IO.outputting() || !Section.ContentBuf.hasValue());
1318   IO.mapOptional("ContentArray", Section.ContentBuf);
1319   if (Section.ContentBuf) {
1320     if (Section.Content)
1321       IO.setError("Content and ContentArray can't be used together");
1322     Section.Content = yaml::BinaryRef(*Section.ContentBuf);
1323   }
1324 
1325   IO.mapOptional("Info", Section.Info);
1326 }
1327 
1328 static void sectionMapping(IO &IO, ELFYAML::BBAddrMapSection &Section) {
1329   commonSectionMapping(IO, Section);
1330   IO.mapOptional("Content", Section.Content);
1331   IO.mapOptional("Entries", Section.Entries);
1332 }
1333 
1334 static void sectionMapping(IO &IO, ELFYAML::StackSizesSection &Section) {
1335   commonSectionMapping(IO, Section);
1336   IO.mapOptional("Entries", Section.Entries);
1337 }
1338 
1339 static void sectionMapping(IO &IO, ELFYAML::HashSection &Section) {
1340   commonSectionMapping(IO, Section);
1341   IO.mapOptional("Bucket", Section.Bucket);
1342   IO.mapOptional("Chain", Section.Chain);
1343 
1344   // obj2yaml does not dump these fields. They can be used to override nchain
1345   // and nbucket values for creating broken sections.
1346   assert(!IO.outputting() ||
1347          (!Section.NBucket.hasValue() && !Section.NChain.hasValue()));
1348   IO.mapOptional("NChain", Section.NChain);
1349   IO.mapOptional("NBucket", Section.NBucket);
1350 }
1351 
1352 static void sectionMapping(IO &IO, ELFYAML::NoteSection &Section) {
1353   commonSectionMapping(IO, Section);
1354   IO.mapOptional("Notes", Section.Notes);
1355 }
1356 
1357 
1358 static void sectionMapping(IO &IO, ELFYAML::GnuHashSection &Section) {
1359   commonSectionMapping(IO, Section);
1360   IO.mapOptional("Header", Section.Header);
1361   IO.mapOptional("BloomFilter", Section.BloomFilter);
1362   IO.mapOptional("HashBuckets", Section.HashBuckets);
1363   IO.mapOptional("HashValues", Section.HashValues);
1364 }
1365 static void sectionMapping(IO &IO, ELFYAML::NoBitsSection &Section) {
1366   commonSectionMapping(IO, Section);
1367 }
1368 
1369 static void sectionMapping(IO &IO, ELFYAML::VerdefSection &Section) {
1370   commonSectionMapping(IO, Section);
1371   IO.mapOptional("Info", Section.Info);
1372   IO.mapOptional("Entries", Section.Entries);
1373 }
1374 
1375 static void sectionMapping(IO &IO, ELFYAML::SymverSection &Section) {
1376   commonSectionMapping(IO, Section);
1377   IO.mapOptional("Entries", Section.Entries);
1378 }
1379 
1380 static void sectionMapping(IO &IO, ELFYAML::VerneedSection &Section) {
1381   commonSectionMapping(IO, Section);
1382   IO.mapOptional("Info", Section.Info);
1383   IO.mapOptional("Dependencies", Section.VerneedV);
1384 }
1385 
1386 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
1387   commonSectionMapping(IO, Section);
1388   IO.mapOptional("Info", Section.RelocatableSec, StringRef());
1389   IO.mapOptional("Relocations", Section.Relocations);
1390 }
1391 
1392 static void sectionMapping(IO &IO, ELFYAML::RelrSection &Section) {
1393   commonSectionMapping(IO, Section);
1394   IO.mapOptional("Entries", Section.Entries);
1395 }
1396 
1397 static void groupSectionMapping(IO &IO, ELFYAML::GroupSection &Group) {
1398   commonSectionMapping(IO, Group);
1399   IO.mapOptional("Info", Group.Signature);
1400   IO.mapOptional("Members", Group.Members);
1401 }
1402 
1403 static void sectionMapping(IO &IO, ELFYAML::SymtabShndxSection &Section) {
1404   commonSectionMapping(IO, Section);
1405   IO.mapOptional("Entries", Section.Entries);
1406 }
1407 
1408 static void sectionMapping(IO &IO, ELFYAML::AddrsigSection &Section) {
1409   commonSectionMapping(IO, Section);
1410   IO.mapOptional("Symbols", Section.Symbols);
1411 }
1412 
1413 static void fillMapping(IO &IO, ELFYAML::Fill &Fill) {
1414   IO.mapOptional("Name", Fill.Name, StringRef());
1415   IO.mapOptional("Pattern", Fill.Pattern);
1416   IO.mapOptional("Offset", Fill.Offset);
1417   IO.mapRequired("Size", Fill.Size);
1418 }
1419 
1420 static void sectionHeaderTableMapping(IO &IO,
1421                                       ELFYAML::SectionHeaderTable &SHT) {
1422   IO.mapOptional("Offset", SHT.Offset);
1423   IO.mapOptional("Sections", SHT.Sections);
1424   IO.mapOptional("Excluded", SHT.Excluded);
1425   IO.mapOptional("NoHeaders", SHT.NoHeaders);
1426 }
1427 
1428 static void sectionMapping(IO &IO, ELFYAML::LinkerOptionsSection &Section) {
1429   commonSectionMapping(IO, Section);
1430   IO.mapOptional("Options", Section.Options);
1431 }
1432 
1433 static void sectionMapping(IO &IO,
1434                            ELFYAML::DependentLibrariesSection &Section) {
1435   commonSectionMapping(IO, Section);
1436   IO.mapOptional("Libraries", Section.Libs);
1437 }
1438 
1439 static void sectionMapping(IO &IO, ELFYAML::CallGraphProfileSection &Section) {
1440   commonSectionMapping(IO, Section);
1441   IO.mapOptional("Entries", Section.Entries);
1442 }
1443 
1444 void MappingTraits<ELFYAML::SectionOrType>::mapping(
1445     IO &IO, ELFYAML::SectionOrType &sectionOrType) {
1446   IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
1447 }
1448 
1449 static void sectionMapping(IO &IO, ELFYAML::ARMIndexTableSection &Section) {
1450   commonSectionMapping(IO, Section);
1451   IO.mapOptional("Entries", Section.Entries);
1452 }
1453 
1454 static void sectionMapping(IO &IO, ELFYAML::MipsABIFlags &Section) {
1455   commonSectionMapping(IO, Section);
1456   IO.mapOptional("Version", Section.Version, Hex16(0));
1457   IO.mapRequired("ISA", Section.ISALevel);
1458   IO.mapOptional("ISARevision", Section.ISARevision, Hex8(0));
1459   IO.mapOptional("ISAExtension", Section.ISAExtension,
1460                  ELFYAML::MIPS_AFL_EXT(Mips::AFL_EXT_NONE));
1461   IO.mapOptional("ASEs", Section.ASEs, ELFYAML::MIPS_AFL_ASE(0));
1462   IO.mapOptional("FpABI", Section.FpABI,
1463                  ELFYAML::MIPS_ABI_FP(Mips::Val_GNU_MIPS_ABI_FP_ANY));
1464   IO.mapOptional("GPRSize", Section.GPRSize,
1465                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1466   IO.mapOptional("CPR1Size", Section.CPR1Size,
1467                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1468   IO.mapOptional("CPR2Size", Section.CPR2Size,
1469                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1470   IO.mapOptional("Flags1", Section.Flags1, ELFYAML::MIPS_AFL_FLAGS1(0));
1471   IO.mapOptional("Flags2", Section.Flags2, Hex32(0));
1472 }
1473 
1474 static StringRef getStringValue(IO &IO, const char *Key) {
1475   StringRef Val;
1476   IO.mapRequired(Key, Val);
1477   return Val;
1478 }
1479 
1480 static void setStringValue(IO &IO, const char *Key, StringRef Val) {
1481   IO.mapRequired(Key, Val);
1482 }
1483 
1484 static bool isInteger(StringRef Val) {
1485   APInt Tmp;
1486   return !Val.getAsInteger(0, Tmp);
1487 }
1488 
1489 void MappingTraits<std::unique_ptr<ELFYAML::Chunk>>::mapping(
1490     IO &IO, std::unique_ptr<ELFYAML::Chunk> &Section) {
1491   ELFYAML::ELF_SHT Type;
1492   StringRef TypeStr;
1493   if (IO.outputting()) {
1494     if (auto *S = dyn_cast<ELFYAML::Section>(Section.get()))
1495       Type = S->Type;
1496     else if (auto *SHT = dyn_cast<ELFYAML::SectionHeaderTable>(Section.get()))
1497       TypeStr = SHT->TypeStr;
1498   } else {
1499     // When the Type string does not have a "SHT_" prefix, we know it is not a
1500     // description of a regular ELF output section.
1501     TypeStr = getStringValue(IO, "Type");
1502     if (TypeStr.startswith("SHT_") || isInteger(TypeStr))
1503       IO.mapRequired("Type", Type);
1504   }
1505 
1506   if (TypeStr == "Fill") {
1507     assert(!IO.outputting()); // We don't dump fills currently.
1508     Section.reset(new ELFYAML::Fill());
1509     fillMapping(IO, *cast<ELFYAML::Fill>(Section.get()));
1510     return;
1511   }
1512 
1513   if (TypeStr == ELFYAML::SectionHeaderTable::TypeStr) {
1514     if (IO.outputting())
1515       setStringValue(IO, "Type", TypeStr);
1516     else
1517       Section.reset(new ELFYAML::SectionHeaderTable(/*IsImplicit=*/false));
1518 
1519     sectionHeaderTableMapping(
1520         IO, *cast<ELFYAML::SectionHeaderTable>(Section.get()));
1521     return;
1522   }
1523 
1524   const auto &Obj = *static_cast<ELFYAML::Object *>(IO.getContext());
1525   if (Obj.getMachine() == ELF::EM_MIPS && Type == ELF::SHT_MIPS_ABIFLAGS) {
1526     if (!IO.outputting())
1527       Section.reset(new ELFYAML::MipsABIFlags());
1528     sectionMapping(IO, *cast<ELFYAML::MipsABIFlags>(Section.get()));
1529     return;
1530   }
1531 
1532   if (Obj.getMachine() == ELF::EM_ARM && Type == ELF::SHT_ARM_EXIDX) {
1533     if (!IO.outputting())
1534       Section.reset(new ELFYAML::ARMIndexTableSection());
1535     sectionMapping(IO, *cast<ELFYAML::ARMIndexTableSection>(Section.get()));
1536     return;
1537   }
1538 
1539   switch (Type) {
1540   case ELF::SHT_DYNAMIC:
1541     if (!IO.outputting())
1542       Section.reset(new ELFYAML::DynamicSection());
1543     sectionMapping(IO, *cast<ELFYAML::DynamicSection>(Section.get()));
1544     break;
1545   case ELF::SHT_REL:
1546   case ELF::SHT_RELA:
1547     if (!IO.outputting())
1548       Section.reset(new ELFYAML::RelocationSection());
1549     sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
1550     break;
1551   case ELF::SHT_RELR:
1552     if (!IO.outputting())
1553       Section.reset(new ELFYAML::RelrSection());
1554     sectionMapping(IO, *cast<ELFYAML::RelrSection>(Section.get()));
1555     break;
1556   case ELF::SHT_GROUP:
1557     if (!IO.outputting())
1558       Section.reset(new ELFYAML::GroupSection());
1559     groupSectionMapping(IO, *cast<ELFYAML::GroupSection>(Section.get()));
1560     break;
1561   case ELF::SHT_NOBITS:
1562     if (!IO.outputting())
1563       Section.reset(new ELFYAML::NoBitsSection());
1564     sectionMapping(IO, *cast<ELFYAML::NoBitsSection>(Section.get()));
1565     break;
1566   case ELF::SHT_HASH:
1567     if (!IO.outputting())
1568       Section.reset(new ELFYAML::HashSection());
1569     sectionMapping(IO, *cast<ELFYAML::HashSection>(Section.get()));
1570     break;
1571   case ELF::SHT_NOTE:
1572     if (!IO.outputting())
1573       Section.reset(new ELFYAML::NoteSection());
1574     sectionMapping(IO, *cast<ELFYAML::NoteSection>(Section.get()));
1575     break;
1576  case ELF::SHT_GNU_HASH:
1577     if (!IO.outputting())
1578       Section.reset(new ELFYAML::GnuHashSection());
1579     sectionMapping(IO, *cast<ELFYAML::GnuHashSection>(Section.get()));
1580     break;
1581   case ELF::SHT_GNU_verdef:
1582     if (!IO.outputting())
1583       Section.reset(new ELFYAML::VerdefSection());
1584     sectionMapping(IO, *cast<ELFYAML::VerdefSection>(Section.get()));
1585     break;
1586   case ELF::SHT_GNU_versym:
1587     if (!IO.outputting())
1588       Section.reset(new ELFYAML::SymverSection());
1589     sectionMapping(IO, *cast<ELFYAML::SymverSection>(Section.get()));
1590     break;
1591   case ELF::SHT_GNU_verneed:
1592     if (!IO.outputting())
1593       Section.reset(new ELFYAML::VerneedSection());
1594     sectionMapping(IO, *cast<ELFYAML::VerneedSection>(Section.get()));
1595     break;
1596   case ELF::SHT_SYMTAB_SHNDX:
1597     if (!IO.outputting())
1598       Section.reset(new ELFYAML::SymtabShndxSection());
1599     sectionMapping(IO, *cast<ELFYAML::SymtabShndxSection>(Section.get()));
1600     break;
1601   case ELF::SHT_LLVM_ADDRSIG:
1602     if (!IO.outputting())
1603       Section.reset(new ELFYAML::AddrsigSection());
1604     sectionMapping(IO, *cast<ELFYAML::AddrsigSection>(Section.get()));
1605     break;
1606   case ELF::SHT_LLVM_LINKER_OPTIONS:
1607     if (!IO.outputting())
1608       Section.reset(new ELFYAML::LinkerOptionsSection());
1609     sectionMapping(IO, *cast<ELFYAML::LinkerOptionsSection>(Section.get()));
1610     break;
1611   case ELF::SHT_LLVM_DEPENDENT_LIBRARIES:
1612     if (!IO.outputting())
1613       Section.reset(new ELFYAML::DependentLibrariesSection());
1614     sectionMapping(IO,
1615                    *cast<ELFYAML::DependentLibrariesSection>(Section.get()));
1616     break;
1617   case ELF::SHT_LLVM_CALL_GRAPH_PROFILE:
1618     if (!IO.outputting())
1619       Section.reset(new ELFYAML::CallGraphProfileSection());
1620     sectionMapping(IO, *cast<ELFYAML::CallGraphProfileSection>(Section.get()));
1621     break;
1622   case ELF::SHT_LLVM_BB_ADDR_MAP:
1623     if (!IO.outputting())
1624       Section.reset(new ELFYAML::BBAddrMapSection());
1625     sectionMapping(IO, *cast<ELFYAML::BBAddrMapSection>(Section.get()));
1626     break;
1627   default:
1628     if (!IO.outputting()) {
1629       StringRef Name;
1630       IO.mapOptional("Name", Name, StringRef());
1631       Name = ELFYAML::dropUniqueSuffix(Name);
1632 
1633       if (ELFYAML::StackSizesSection::nameMatches(Name))
1634         Section = std::make_unique<ELFYAML::StackSizesSection>();
1635       else
1636         Section = std::make_unique<ELFYAML::RawContentSection>();
1637     }
1638 
1639     if (auto S = dyn_cast<ELFYAML::RawContentSection>(Section.get()))
1640       sectionMapping(IO, *S);
1641     else
1642       sectionMapping(IO, *cast<ELFYAML::StackSizesSection>(Section.get()));
1643   }
1644 }
1645 
1646 std::string MappingTraits<std::unique_ptr<ELFYAML::Chunk>>::validate(
1647     IO &io, std::unique_ptr<ELFYAML::Chunk> &C) {
1648   if (const auto *F = dyn_cast<ELFYAML::Fill>(C.get())) {
1649     if (F->Pattern && F->Pattern->binary_size() != 0 && !F->Size)
1650       return "\"Size\" can't be 0 when \"Pattern\" is not empty";
1651     return "";
1652   }
1653 
1654   if (const auto *SHT = dyn_cast<ELFYAML::SectionHeaderTable>(C.get())) {
1655     if (SHT->NoHeaders && (SHT->Sections || SHT->Excluded || SHT->Offset))
1656       return "NoHeaders can't be used together with Offset/Sections/Excluded";
1657     return "";
1658   }
1659 
1660   const ELFYAML::Section &Sec = *cast<ELFYAML::Section>(C.get());
1661   if (Sec.Size && Sec.Content &&
1662       (uint64_t)(*Sec.Size) < Sec.Content->binary_size())
1663     return "Section size must be greater than or equal to the content size";
1664 
1665   auto BuildErrPrefix = [](ArrayRef<std::pair<StringRef, bool>> EntV) {
1666     std::string Msg;
1667     for (size_t I = 0, E = EntV.size(); I != E; ++I) {
1668       StringRef Name = EntV[I].first;
1669       if (I == 0) {
1670         Msg = "\"" + Name.str() + "\"";
1671         continue;
1672       }
1673       if (I != EntV.size() - 1)
1674         Msg += ", \"" + Name.str() + "\"";
1675       else
1676         Msg += " and \"" + Name.str() + "\"";
1677     }
1678     return Msg;
1679   };
1680 
1681   std::vector<std::pair<StringRef, bool>> Entries = Sec.getEntries();
1682   const size_t NumUsedEntries = llvm::count_if(
1683       Entries, [](const std::pair<StringRef, bool> &P) { return P.second; });
1684 
1685   if ((Sec.Size || Sec.Content) && NumUsedEntries > 0)
1686     return BuildErrPrefix(Entries) +
1687            " cannot be used with \"Content\" or \"Size\"";
1688 
1689   if (NumUsedEntries > 0 && Entries.size() != NumUsedEntries)
1690     return BuildErrPrefix(Entries) + " must be used together";
1691 
1692   if (const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(C.get())) {
1693     if (RawSection->Flags && RawSection->ShFlags)
1694       return "ShFlags and Flags cannot be used together";
1695     return "";
1696   }
1697 
1698   if (const auto *NB = dyn_cast<ELFYAML::NoBitsSection>(C.get())) {
1699     if (NB->Content)
1700       return "SHT_NOBITS section cannot have \"Content\"";
1701     return "";
1702   }
1703 
1704   if (const auto *MF = dyn_cast<ELFYAML::MipsABIFlags>(C.get())) {
1705     if (MF->Content)
1706       return "\"Content\" key is not implemented for SHT_MIPS_ABIFLAGS "
1707              "sections";
1708     if (MF->Size)
1709       return "\"Size\" key is not implemented for SHT_MIPS_ABIFLAGS sections";
1710     return "";
1711   }
1712 
1713   return "";
1714 }
1715 
1716 namespace {
1717 
1718 struct NormalizedMips64RelType {
1719   NormalizedMips64RelType(IO &)
1720       : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1721         Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1722         Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1723         SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
1724   NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
1725       : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
1726         Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
1727 
1728   ELFYAML::ELF_REL denormalize(IO &) {
1729     ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
1730     return Res;
1731   }
1732 
1733   ELFYAML::ELF_REL Type;
1734   ELFYAML::ELF_REL Type2;
1735   ELFYAML::ELF_REL Type3;
1736   ELFYAML::ELF_RSS SpecSym;
1737 };
1738 
1739 } // end anonymous namespace
1740 
1741 void MappingTraits<ELFYAML::StackSizeEntry>::mapping(
1742     IO &IO, ELFYAML::StackSizeEntry &E) {
1743   assert(IO.getContext() && "The IO context is not initialized");
1744   IO.mapOptional("Address", E.Address, Hex64(0));
1745   IO.mapRequired("Size", E.Size);
1746 }
1747 
1748 void MappingTraits<ELFYAML::BBAddrMapEntry>::mapping(
1749     IO &IO, ELFYAML::BBAddrMapEntry &E) {
1750   assert(IO.getContext() && "The IO context is not initialized");
1751   IO.mapOptional("Address", E.Address, Hex64(0));
1752   IO.mapOptional("NumBlocks", E.NumBlocks);
1753   IO.mapOptional("BBEntries", E.BBEntries);
1754 }
1755 
1756 void MappingTraits<ELFYAML::BBAddrMapEntry::BBEntry>::mapping(
1757     IO &IO, ELFYAML::BBAddrMapEntry::BBEntry &E) {
1758   assert(IO.getContext() && "The IO context is not initialized");
1759   IO.mapRequired("AddressOffset", E.AddressOffset);
1760   IO.mapRequired("Size", E.Size);
1761   IO.mapRequired("Metadata", E.Metadata);
1762 }
1763 
1764 void MappingTraits<ELFYAML::GnuHashHeader>::mapping(IO &IO,
1765                                                     ELFYAML::GnuHashHeader &E) {
1766   assert(IO.getContext() && "The IO context is not initialized");
1767   IO.mapOptional("NBuckets", E.NBuckets);
1768   IO.mapRequired("SymNdx", E.SymNdx);
1769   IO.mapOptional("MaskWords", E.MaskWords);
1770   IO.mapRequired("Shift2", E.Shift2);
1771 }
1772 
1773 void MappingTraits<ELFYAML::DynamicEntry>::mapping(IO &IO,
1774                                                    ELFYAML::DynamicEntry &Rel) {
1775   assert(IO.getContext() && "The IO context is not initialized");
1776 
1777   IO.mapRequired("Tag", Rel.Tag);
1778   IO.mapRequired("Value", Rel.Val);
1779 }
1780 
1781 void MappingTraits<ELFYAML::NoteEntry>::mapping(IO &IO, ELFYAML::NoteEntry &N) {
1782   assert(IO.getContext() && "The IO context is not initialized");
1783 
1784   IO.mapOptional("Name", N.Name);
1785   IO.mapOptional("Desc", N.Desc);
1786   IO.mapRequired("Type", N.Type);
1787 }
1788 
1789 void MappingTraits<ELFYAML::VerdefEntry>::mapping(IO &IO,
1790                                                   ELFYAML::VerdefEntry &E) {
1791   assert(IO.getContext() && "The IO context is not initialized");
1792 
1793   IO.mapOptional("Version", E.Version);
1794   IO.mapOptional("Flags", E.Flags);
1795   IO.mapOptional("VersionNdx", E.VersionNdx);
1796   IO.mapOptional("Hash", E.Hash);
1797   IO.mapRequired("Names", E.VerNames);
1798 }
1799 
1800 void MappingTraits<ELFYAML::VerneedEntry>::mapping(IO &IO,
1801                                                    ELFYAML::VerneedEntry &E) {
1802   assert(IO.getContext() && "The IO context is not initialized");
1803 
1804   IO.mapRequired("Version", E.Version);
1805   IO.mapRequired("File", E.File);
1806   IO.mapRequired("Entries", E.AuxV);
1807 }
1808 
1809 void MappingTraits<ELFYAML::VernauxEntry>::mapping(IO &IO,
1810                                                    ELFYAML::VernauxEntry &E) {
1811   assert(IO.getContext() && "The IO context is not initialized");
1812 
1813   IO.mapRequired("Name", E.Name);
1814   IO.mapRequired("Hash", E.Hash);
1815   IO.mapRequired("Flags", E.Flags);
1816   IO.mapRequired("Other", E.Other);
1817 }
1818 
1819 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
1820                                                  ELFYAML::Relocation &Rel) {
1821   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
1822   assert(Object && "The IO context is not initialized");
1823 
1824   IO.mapOptional("Offset", Rel.Offset, (Hex64)0);
1825   IO.mapOptional("Symbol", Rel.Symbol);
1826 
1827   if (Object->getMachine() == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
1828       Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
1829     MappingNormalization<NormalizedMips64RelType, ELFYAML::ELF_REL> Key(
1830         IO, Rel.Type);
1831     IO.mapRequired("Type", Key->Type);
1832     IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
1833     IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
1834     IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
1835   } else
1836     IO.mapRequired("Type", Rel.Type);
1837 
1838   IO.mapOptional("Addend", Rel.Addend, (ELFYAML::YAMLIntUInt)0);
1839 }
1840 
1841 void MappingTraits<ELFYAML::ARMIndexTableEntry>::mapping(
1842     IO &IO, ELFYAML::ARMIndexTableEntry &E) {
1843   assert(IO.getContext() && "The IO context is not initialized");
1844   IO.mapRequired("Offset", E.Offset);
1845 
1846   StringRef CantUnwind = "EXIDX_CANTUNWIND";
1847   if (IO.outputting() && (uint32_t)E.Value == ARM::EHABI::EXIDX_CANTUNWIND)
1848     IO.mapRequired("Value", CantUnwind);
1849   else if (!IO.outputting() && getStringValue(IO, "Value") == CantUnwind)
1850     E.Value = ARM::EHABI::EXIDX_CANTUNWIND;
1851   else
1852     IO.mapRequired("Value", E.Value);
1853 }
1854 
1855 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
1856   assert(!IO.getContext() && "The IO context is initialized already");
1857   IO.setContext(&Object);
1858   IO.mapTag("!ELF", true);
1859   IO.mapRequired("FileHeader", Object.Header);
1860   IO.mapOptional("ProgramHeaders", Object.ProgramHeaders);
1861   IO.mapOptional("Sections", Object.Chunks);
1862   IO.mapOptional("Symbols", Object.Symbols);
1863   IO.mapOptional("DynamicSymbols", Object.DynamicSymbols);
1864   IO.mapOptional("DWARF", Object.DWARF);
1865   if (Object.DWARF) {
1866     Object.DWARF->IsLittleEndian =
1867         Object.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB);
1868     Object.DWARF->Is64BitAddrSize =
1869         Object.Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
1870   }
1871   IO.setContext(nullptr);
1872 }
1873 
1874 void MappingTraits<ELFYAML::LinkerOption>::mapping(IO &IO,
1875                                                    ELFYAML::LinkerOption &Opt) {
1876   assert(IO.getContext() && "The IO context is not initialized");
1877   IO.mapRequired("Name", Opt.Key);
1878   IO.mapRequired("Value", Opt.Value);
1879 }
1880 
1881 void MappingTraits<ELFYAML::CallGraphEntryWeight>::mapping(
1882     IO &IO, ELFYAML::CallGraphEntryWeight &E) {
1883   assert(IO.getContext() && "The IO context is not initialized");
1884   IO.mapRequired("Weight", E.Weight);
1885 }
1886 
1887 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
1888 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
1889 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
1890 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
1891 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
1892 
1893 } // end namespace yaml
1894 
1895 } // end namespace llvm
1896