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