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