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