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     BCase(EF_AVR_ARCH_AVR1);
477     BCase(EF_AVR_ARCH_AVR2);
478     BCase(EF_AVR_ARCH_AVR25);
479     BCase(EF_AVR_ARCH_AVR3);
480     BCase(EF_AVR_ARCH_AVR31);
481     BCase(EF_AVR_ARCH_AVR35);
482     BCase(EF_AVR_ARCH_AVR4);
483     BCase(EF_AVR_ARCH_AVR51);
484     BCase(EF_AVR_ARCH_AVR6);
485     BCase(EF_AVR_ARCH_AVRTINY);
486     BCase(EF_AVR_ARCH_XMEGA1);
487     BCase(EF_AVR_ARCH_XMEGA2);
488     BCase(EF_AVR_ARCH_XMEGA3);
489     BCase(EF_AVR_ARCH_XMEGA4);
490     BCase(EF_AVR_ARCH_XMEGA5);
491     BCase(EF_AVR_ARCH_XMEGA6);
492     BCase(EF_AVR_ARCH_XMEGA7);
493     break;
494   case ELF::EM_RISCV:
495     BCase(EF_RISCV_RVC);
496     BCaseMask(EF_RISCV_FLOAT_ABI_SOFT, EF_RISCV_FLOAT_ABI);
497     BCaseMask(EF_RISCV_FLOAT_ABI_SINGLE, EF_RISCV_FLOAT_ABI);
498     BCaseMask(EF_RISCV_FLOAT_ABI_DOUBLE, EF_RISCV_FLOAT_ABI);
499     BCaseMask(EF_RISCV_FLOAT_ABI_QUAD, EF_RISCV_FLOAT_ABI);
500     BCase(EF_RISCV_RVE);
501     break;
502   case ELF::EM_AMDGPU:
503     BCaseMask(EF_AMDGPU_MACH_NONE, EF_AMDGPU_MACH);
504     BCaseMask(EF_AMDGPU_MACH_R600_R600, EF_AMDGPU_MACH);
505     BCaseMask(EF_AMDGPU_MACH_R600_R630, EF_AMDGPU_MACH);
506     BCaseMask(EF_AMDGPU_MACH_R600_RS880, EF_AMDGPU_MACH);
507     BCaseMask(EF_AMDGPU_MACH_R600_RV670, EF_AMDGPU_MACH);
508     BCaseMask(EF_AMDGPU_MACH_R600_RV710, EF_AMDGPU_MACH);
509     BCaseMask(EF_AMDGPU_MACH_R600_RV730, EF_AMDGPU_MACH);
510     BCaseMask(EF_AMDGPU_MACH_R600_RV770, EF_AMDGPU_MACH);
511     BCaseMask(EF_AMDGPU_MACH_R600_CEDAR, EF_AMDGPU_MACH);
512     BCaseMask(EF_AMDGPU_MACH_R600_CYPRESS, EF_AMDGPU_MACH);
513     BCaseMask(EF_AMDGPU_MACH_R600_JUNIPER, EF_AMDGPU_MACH);
514     BCaseMask(EF_AMDGPU_MACH_R600_REDWOOD, EF_AMDGPU_MACH);
515     BCaseMask(EF_AMDGPU_MACH_R600_SUMO, EF_AMDGPU_MACH);
516     BCaseMask(EF_AMDGPU_MACH_R600_BARTS, EF_AMDGPU_MACH);
517     BCaseMask(EF_AMDGPU_MACH_R600_CAICOS, EF_AMDGPU_MACH);
518     BCaseMask(EF_AMDGPU_MACH_R600_CAYMAN, EF_AMDGPU_MACH);
519     BCaseMask(EF_AMDGPU_MACH_R600_TURKS, EF_AMDGPU_MACH);
520     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX600, EF_AMDGPU_MACH);
521     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX601, EF_AMDGPU_MACH);
522     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX602, EF_AMDGPU_MACH);
523     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX700, EF_AMDGPU_MACH);
524     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX701, EF_AMDGPU_MACH);
525     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX702, EF_AMDGPU_MACH);
526     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX703, EF_AMDGPU_MACH);
527     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX704, EF_AMDGPU_MACH);
528     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX705, EF_AMDGPU_MACH);
529     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX801, EF_AMDGPU_MACH);
530     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX802, EF_AMDGPU_MACH);
531     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX803, EF_AMDGPU_MACH);
532     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX805, EF_AMDGPU_MACH);
533     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX810, EF_AMDGPU_MACH);
534     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX900, EF_AMDGPU_MACH);
535     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX902, EF_AMDGPU_MACH);
536     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX904, EF_AMDGPU_MACH);
537     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX906, EF_AMDGPU_MACH);
538     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX908, EF_AMDGPU_MACH);
539     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX909, EF_AMDGPU_MACH);
540     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX90A, EF_AMDGPU_MACH);
541     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX90C, EF_AMDGPU_MACH);
542     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1010, EF_AMDGPU_MACH);
543     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1011, EF_AMDGPU_MACH);
544     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1012, EF_AMDGPU_MACH);
545     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1030, EF_AMDGPU_MACH);
546     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1031, EF_AMDGPU_MACH);
547     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1032, EF_AMDGPU_MACH);
548     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX1033, EF_AMDGPU_MACH);
549     switch (Object->Header.ABIVersion) {
550     default:
551       // ELFOSABI_AMDGPU_PAL, ELFOSABI_AMDGPU_MESA3D support *_V3 flags.
552       LLVM_FALLTHROUGH;
553     case ELF::ELFABIVERSION_AMDGPU_HSA_V3:
554       BCase(EF_AMDGPU_FEATURE_XNACK_V3);
555       BCase(EF_AMDGPU_FEATURE_SRAMECC_V3);
556       break;
557     case ELF::ELFABIVERSION_AMDGPU_HSA_V4:
558       BCaseMask(EF_AMDGPU_FEATURE_XNACK_UNSUPPORTED_V4,
559                 EF_AMDGPU_FEATURE_XNACK_V4);
560       BCaseMask(EF_AMDGPU_FEATURE_XNACK_ANY_V4,
561                 EF_AMDGPU_FEATURE_XNACK_V4);
562       BCaseMask(EF_AMDGPU_FEATURE_XNACK_OFF_V4,
563                 EF_AMDGPU_FEATURE_XNACK_V4);
564       BCaseMask(EF_AMDGPU_FEATURE_XNACK_ON_V4,
565                 EF_AMDGPU_FEATURE_XNACK_V4);
566       BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_UNSUPPORTED_V4,
567                 EF_AMDGPU_FEATURE_SRAMECC_V4);
568       BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_ANY_V4,
569                 EF_AMDGPU_FEATURE_SRAMECC_V4);
570       BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_OFF_V4,
571                 EF_AMDGPU_FEATURE_SRAMECC_V4);
572       BCaseMask(EF_AMDGPU_FEATURE_SRAMECC_ON_V4,
573                 EF_AMDGPU_FEATURE_SRAMECC_V4);
574       break;
575     }
576     break;
577   default:
578     break;
579   }
580 #undef BCase
581 #undef BCaseMask
582 }
583 
584 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
585     IO &IO, ELFYAML::ELF_SHT &Value) {
586   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
587   assert(Object && "The IO context is not initialized");
588 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
589   ECase(SHT_NULL);
590   ECase(SHT_PROGBITS);
591   ECase(SHT_SYMTAB);
592   // FIXME: Issue a diagnostic with this information.
593   ECase(SHT_STRTAB);
594   ECase(SHT_RELA);
595   ECase(SHT_HASH);
596   ECase(SHT_DYNAMIC);
597   ECase(SHT_NOTE);
598   ECase(SHT_NOBITS);
599   ECase(SHT_REL);
600   ECase(SHT_SHLIB);
601   ECase(SHT_DYNSYM);
602   ECase(SHT_INIT_ARRAY);
603   ECase(SHT_FINI_ARRAY);
604   ECase(SHT_PREINIT_ARRAY);
605   ECase(SHT_GROUP);
606   ECase(SHT_SYMTAB_SHNDX);
607   ECase(SHT_RELR);
608   ECase(SHT_ANDROID_REL);
609   ECase(SHT_ANDROID_RELA);
610   ECase(SHT_ANDROID_RELR);
611   ECase(SHT_LLVM_ODRTAB);
612   ECase(SHT_LLVM_LINKER_OPTIONS);
613   ECase(SHT_LLVM_CALL_GRAPH_PROFILE);
614   ECase(SHT_LLVM_ADDRSIG);
615   ECase(SHT_LLVM_DEPENDENT_LIBRARIES);
616   ECase(SHT_LLVM_SYMPART);
617   ECase(SHT_LLVM_PART_EHDR);
618   ECase(SHT_LLVM_PART_PHDR);
619   ECase(SHT_LLVM_BB_ADDR_MAP);
620   ECase(SHT_GNU_ATTRIBUTES);
621   ECase(SHT_GNU_HASH);
622   ECase(SHT_GNU_verdef);
623   ECase(SHT_GNU_verneed);
624   ECase(SHT_GNU_versym);
625   switch (Object->getMachine()) {
626   case ELF::EM_ARM:
627     ECase(SHT_ARM_EXIDX);
628     ECase(SHT_ARM_PREEMPTMAP);
629     ECase(SHT_ARM_ATTRIBUTES);
630     ECase(SHT_ARM_DEBUGOVERLAY);
631     ECase(SHT_ARM_OVERLAYSECTION);
632     break;
633   case ELF::EM_HEXAGON:
634     ECase(SHT_HEX_ORDERED);
635     break;
636   case ELF::EM_X86_64:
637     ECase(SHT_X86_64_UNWIND);
638     break;
639   case ELF::EM_MIPS:
640     ECase(SHT_MIPS_REGINFO);
641     ECase(SHT_MIPS_OPTIONS);
642     ECase(SHT_MIPS_DWARF);
643     ECase(SHT_MIPS_ABIFLAGS);
644     break;
645   case ELF::EM_RISCV:
646     ECase(SHT_RISCV_ATTRIBUTES);
647     break;
648   default:
649     // Nothing to do.
650     break;
651   }
652 #undef ECase
653   IO.enumFallback<Hex32>(Value);
654 }
655 
656 void ScalarBitSetTraits<ELFYAML::ELF_PF>::bitset(IO &IO,
657                                                  ELFYAML::ELF_PF &Value) {
658 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
659   BCase(PF_X);
660   BCase(PF_W);
661   BCase(PF_R);
662 }
663 
664 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
665                                                   ELFYAML::ELF_SHF &Value) {
666   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
667 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
668   BCase(SHF_WRITE);
669   BCase(SHF_ALLOC);
670   BCase(SHF_EXCLUDE);
671   BCase(SHF_EXECINSTR);
672   BCase(SHF_MERGE);
673   BCase(SHF_STRINGS);
674   BCase(SHF_INFO_LINK);
675   BCase(SHF_LINK_ORDER);
676   BCase(SHF_OS_NONCONFORMING);
677   BCase(SHF_GROUP);
678   BCase(SHF_TLS);
679   BCase(SHF_COMPRESSED);
680   BCase(SHF_GNU_RETAIN);
681   switch (Object->getMachine()) {
682   case ELF::EM_ARM:
683     BCase(SHF_ARM_PURECODE);
684     break;
685   case ELF::EM_HEXAGON:
686     BCase(SHF_HEX_GPREL);
687     break;
688   case ELF::EM_MIPS:
689     BCase(SHF_MIPS_NODUPES);
690     BCase(SHF_MIPS_NAMES);
691     BCase(SHF_MIPS_LOCAL);
692     BCase(SHF_MIPS_NOSTRIP);
693     BCase(SHF_MIPS_GPREL);
694     BCase(SHF_MIPS_MERGE);
695     BCase(SHF_MIPS_ADDR);
696     BCase(SHF_MIPS_STRING);
697     break;
698   case ELF::EM_X86_64:
699     BCase(SHF_X86_64_LARGE);
700     break;
701   default:
702     // Nothing to do.
703     break;
704   }
705 #undef BCase
706 }
707 
708 void ScalarEnumerationTraits<ELFYAML::ELF_SHN>::enumeration(
709     IO &IO, ELFYAML::ELF_SHN &Value) {
710 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
711   ECase(SHN_UNDEF);
712   ECase(SHN_LORESERVE);
713   ECase(SHN_LOPROC);
714   ECase(SHN_HIPROC);
715   ECase(SHN_LOOS);
716   ECase(SHN_HIOS);
717   ECase(SHN_ABS);
718   ECase(SHN_COMMON);
719   ECase(SHN_XINDEX);
720   ECase(SHN_HIRESERVE);
721   ECase(SHN_AMDGPU_LDS);
722   ECase(SHN_HEXAGON_SCOMMON);
723   ECase(SHN_HEXAGON_SCOMMON_1);
724   ECase(SHN_HEXAGON_SCOMMON_2);
725   ECase(SHN_HEXAGON_SCOMMON_4);
726   ECase(SHN_HEXAGON_SCOMMON_8);
727 #undef ECase
728   IO.enumFallback<Hex16>(Value);
729 }
730 
731 void ScalarEnumerationTraits<ELFYAML::ELF_STB>::enumeration(
732     IO &IO, ELFYAML::ELF_STB &Value) {
733 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
734   ECase(STB_LOCAL);
735   ECase(STB_GLOBAL);
736   ECase(STB_WEAK);
737   ECase(STB_GNU_UNIQUE);
738 #undef ECase
739   IO.enumFallback<Hex8>(Value);
740 }
741 
742 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
743     IO &IO, ELFYAML::ELF_STT &Value) {
744 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
745   ECase(STT_NOTYPE);
746   ECase(STT_OBJECT);
747   ECase(STT_FUNC);
748   ECase(STT_SECTION);
749   ECase(STT_FILE);
750   ECase(STT_COMMON);
751   ECase(STT_TLS);
752   ECase(STT_GNU_IFUNC);
753 #undef ECase
754   IO.enumFallback<Hex8>(Value);
755 }
756 
757 
758 void ScalarEnumerationTraits<ELFYAML::ELF_RSS>::enumeration(
759     IO &IO, ELFYAML::ELF_RSS &Value) {
760 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
761   ECase(RSS_UNDEF);
762   ECase(RSS_GP);
763   ECase(RSS_GP0);
764   ECase(RSS_LOC);
765 #undef ECase
766 }
767 
768 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
769     IO &IO, ELFYAML::ELF_REL &Value) {
770   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
771   assert(Object && "The IO context is not initialized");
772 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
773   switch (Object->getMachine()) {
774   case ELF::EM_X86_64:
775 #include "llvm/BinaryFormat/ELFRelocs/x86_64.def"
776     break;
777   case ELF::EM_MIPS:
778 #include "llvm/BinaryFormat/ELFRelocs/Mips.def"
779     break;
780   case ELF::EM_HEXAGON:
781 #include "llvm/BinaryFormat/ELFRelocs/Hexagon.def"
782     break;
783   case ELF::EM_386:
784   case ELF::EM_IAMCU:
785 #include "llvm/BinaryFormat/ELFRelocs/i386.def"
786     break;
787   case ELF::EM_AARCH64:
788 #include "llvm/BinaryFormat/ELFRelocs/AArch64.def"
789     break;
790   case ELF::EM_ARM:
791 #include "llvm/BinaryFormat/ELFRelocs/ARM.def"
792     break;
793   case ELF::EM_ARC:
794 #include "llvm/BinaryFormat/ELFRelocs/ARC.def"
795     break;
796   case ELF::EM_RISCV:
797 #include "llvm/BinaryFormat/ELFRelocs/RISCV.def"
798     break;
799   case ELF::EM_LANAI:
800 #include "llvm/BinaryFormat/ELFRelocs/Lanai.def"
801     break;
802   case ELF::EM_AMDGPU:
803 #include "llvm/BinaryFormat/ELFRelocs/AMDGPU.def"
804     break;
805   case ELF::EM_BPF:
806 #include "llvm/BinaryFormat/ELFRelocs/BPF.def"
807     break;
808   case ELF::EM_VE:
809 #include "llvm/BinaryFormat/ELFRelocs/VE.def"
810     break;
811   case ELF::EM_CSKY:
812 #include "llvm/BinaryFormat/ELFRelocs/CSKY.def"
813     break;
814   case ELF::EM_PPC64:
815 #include "llvm/BinaryFormat/ELFRelocs/PowerPC64.def"
816     break;
817   case ELF::EM_68K:
818 #include "llvm/BinaryFormat/ELFRelocs/M68k.def"
819     break;
820   default:
821     // Nothing to do.
822     break;
823   }
824 #undef ELF_RELOC
825   IO.enumFallback<Hex32>(Value);
826 }
827 
828 void ScalarEnumerationTraits<ELFYAML::ELF_DYNTAG>::enumeration(
829     IO &IO, ELFYAML::ELF_DYNTAG &Value) {
830   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
831   assert(Object && "The IO context is not initialized");
832 
833 // Disable architecture specific tags by default. We might enable them below.
834 #define AARCH64_DYNAMIC_TAG(name, value)
835 #define MIPS_DYNAMIC_TAG(name, value)
836 #define HEXAGON_DYNAMIC_TAG(name, value)
837 #define PPC_DYNAMIC_TAG(name, value)
838 #define PPC64_DYNAMIC_TAG(name, value)
839 // Ignore marker tags such as DT_HIOS (maps to DT_VERNEEDNUM), etc.
840 #define DYNAMIC_TAG_MARKER(name, value)
841 
842 #define STRINGIFY(X) (#X)
843 #define DYNAMIC_TAG(X, Y) IO.enumCase(Value, STRINGIFY(DT_##X), ELF::DT_##X);
844   switch (Object->getMachine()) {
845   case ELF::EM_AARCH64:
846 #undef AARCH64_DYNAMIC_TAG
847 #define AARCH64_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
848 #include "llvm/BinaryFormat/DynamicTags.def"
849 #undef AARCH64_DYNAMIC_TAG
850 #define AARCH64_DYNAMIC_TAG(name, value)
851     break;
852   case ELF::EM_MIPS:
853 #undef MIPS_DYNAMIC_TAG
854 #define MIPS_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
855 #include "llvm/BinaryFormat/DynamicTags.def"
856 #undef MIPS_DYNAMIC_TAG
857 #define MIPS_DYNAMIC_TAG(name, value)
858     break;
859   case ELF::EM_HEXAGON:
860 #undef HEXAGON_DYNAMIC_TAG
861 #define HEXAGON_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
862 #include "llvm/BinaryFormat/DynamicTags.def"
863 #undef HEXAGON_DYNAMIC_TAG
864 #define HEXAGON_DYNAMIC_TAG(name, value)
865     break;
866   case ELF::EM_PPC:
867 #undef PPC_DYNAMIC_TAG
868 #define PPC_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
869 #include "llvm/BinaryFormat/DynamicTags.def"
870 #undef PPC_DYNAMIC_TAG
871 #define PPC_DYNAMIC_TAG(name, value)
872     break;
873   case ELF::EM_PPC64:
874 #undef PPC64_DYNAMIC_TAG
875 #define PPC64_DYNAMIC_TAG(name, value) DYNAMIC_TAG(name, value)
876 #include "llvm/BinaryFormat/DynamicTags.def"
877 #undef PPC64_DYNAMIC_TAG
878 #define PPC64_DYNAMIC_TAG(name, value)
879     break;
880   default:
881 #include "llvm/BinaryFormat/DynamicTags.def"
882     break;
883   }
884 #undef AARCH64_DYNAMIC_TAG
885 #undef MIPS_DYNAMIC_TAG
886 #undef HEXAGON_DYNAMIC_TAG
887 #undef PPC_DYNAMIC_TAG
888 #undef PPC64_DYNAMIC_TAG
889 #undef DYNAMIC_TAG_MARKER
890 #undef STRINGIFY
891 #undef DYNAMIC_TAG
892 
893   IO.enumFallback<Hex64>(Value);
894 }
895 
896 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG>::enumeration(
897     IO &IO, ELFYAML::MIPS_AFL_REG &Value) {
898 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
899   ECase(REG_NONE);
900   ECase(REG_32);
901   ECase(REG_64);
902   ECase(REG_128);
903 #undef ECase
904 }
905 
906 void ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP>::enumeration(
907     IO &IO, ELFYAML::MIPS_ABI_FP &Value) {
908 #define ECase(X) IO.enumCase(Value, #X, Mips::Val_GNU_MIPS_ABI_##X)
909   ECase(FP_ANY);
910   ECase(FP_DOUBLE);
911   ECase(FP_SINGLE);
912   ECase(FP_SOFT);
913   ECase(FP_OLD_64);
914   ECase(FP_XX);
915   ECase(FP_64);
916   ECase(FP_64A);
917 #undef ECase
918 }
919 
920 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT>::enumeration(
921     IO &IO, ELFYAML::MIPS_AFL_EXT &Value) {
922 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
923   ECase(EXT_NONE);
924   ECase(EXT_XLR);
925   ECase(EXT_OCTEON2);
926   ECase(EXT_OCTEONP);
927   ECase(EXT_LOONGSON_3A);
928   ECase(EXT_OCTEON);
929   ECase(EXT_5900);
930   ECase(EXT_4650);
931   ECase(EXT_4010);
932   ECase(EXT_4100);
933   ECase(EXT_3900);
934   ECase(EXT_10000);
935   ECase(EXT_SB1);
936   ECase(EXT_4111);
937   ECase(EXT_4120);
938   ECase(EXT_5400);
939   ECase(EXT_5500);
940   ECase(EXT_LOONGSON_2E);
941   ECase(EXT_LOONGSON_2F);
942   ECase(EXT_OCTEON3);
943 #undef ECase
944 }
945 
946 void ScalarEnumerationTraits<ELFYAML::MIPS_ISA>::enumeration(
947     IO &IO, ELFYAML::MIPS_ISA &Value) {
948   IO.enumCase(Value, "MIPS1", 1);
949   IO.enumCase(Value, "MIPS2", 2);
950   IO.enumCase(Value, "MIPS3", 3);
951   IO.enumCase(Value, "MIPS4", 4);
952   IO.enumCase(Value, "MIPS5", 5);
953   IO.enumCase(Value, "MIPS32", 32);
954   IO.enumCase(Value, "MIPS64", 64);
955   IO.enumFallback<Hex32>(Value);
956 }
957 
958 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE>::bitset(
959     IO &IO, ELFYAML::MIPS_AFL_ASE &Value) {
960 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_ASE_##X)
961   BCase(DSP);
962   BCase(DSPR2);
963   BCase(EVA);
964   BCase(MCU);
965   BCase(MDMX);
966   BCase(MIPS3D);
967   BCase(MT);
968   BCase(SMARTMIPS);
969   BCase(VIRT);
970   BCase(MSA);
971   BCase(MIPS16);
972   BCase(MICROMIPS);
973   BCase(XPA);
974   BCase(CRC);
975   BCase(GINV);
976 #undef BCase
977 }
978 
979 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1>::bitset(
980     IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value) {
981 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_FLAGS1_##X)
982   BCase(ODDSPREG);
983 #undef BCase
984 }
985 
986 void MappingTraits<ELFYAML::SectionHeader>::mapping(
987     IO &IO, ELFYAML::SectionHeader &SHdr) {
988   IO.mapRequired("Name", SHdr.Name);
989 }
990 
991 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
992                                                  ELFYAML::FileHeader &FileHdr) {
993   IO.mapRequired("Class", FileHdr.Class);
994   IO.mapRequired("Data", FileHdr.Data);
995   IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
996   IO.mapOptional("ABIVersion", FileHdr.ABIVersion, Hex8(0));
997   IO.mapRequired("Type", FileHdr.Type);
998   IO.mapOptional("Machine", FileHdr.Machine);
999   IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
1000   IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
1001 
1002   // obj2yaml does not dump these fields.
1003   assert(!IO.outputting() ||
1004          (!FileHdr.EPhOff && !FileHdr.EPhEntSize && !FileHdr.EPhNum));
1005   IO.mapOptional("EPhOff", FileHdr.EPhOff);
1006   IO.mapOptional("EPhEntSize", FileHdr.EPhEntSize);
1007   IO.mapOptional("EPhNum", FileHdr.EPhNum);
1008   IO.mapOptional("EShEntSize", FileHdr.EShEntSize);
1009   IO.mapOptional("EShOff", FileHdr.EShOff);
1010   IO.mapOptional("EShNum", FileHdr.EShNum);
1011   IO.mapOptional("EShStrNdx", FileHdr.EShStrNdx);
1012 }
1013 
1014 void MappingTraits<ELFYAML::ProgramHeader>::mapping(
1015     IO &IO, ELFYAML::ProgramHeader &Phdr) {
1016   IO.mapRequired("Type", Phdr.Type);
1017   IO.mapOptional("Flags", Phdr.Flags, ELFYAML::ELF_PF(0));
1018   IO.mapOptional("FirstSec", Phdr.FirstSec);
1019   IO.mapOptional("LastSec", Phdr.LastSec);
1020   IO.mapOptional("VAddr", Phdr.VAddr, Hex64(0));
1021   IO.mapOptional("PAddr", Phdr.PAddr, Phdr.VAddr);
1022   IO.mapOptional("Align", Phdr.Align);
1023   IO.mapOptional("FileSize", Phdr.FileSize);
1024   IO.mapOptional("MemSize", Phdr.MemSize);
1025   IO.mapOptional("Offset", Phdr.Offset);
1026 }
1027 
1028 std::string MappingTraits<ELFYAML::ProgramHeader>::validate(
1029     IO &IO, ELFYAML::ProgramHeader &FileHdr) {
1030   if (!FileHdr.FirstSec && FileHdr.LastSec)
1031     return "the \"LastSec\" key can't be used without the \"FirstSec\" key";
1032   if (FileHdr.FirstSec && !FileHdr.LastSec)
1033     return "the \"FirstSec\" key can't be used without the \"LastSec\" key";
1034   return "";
1035 }
1036 
1037 LLVM_YAML_STRONG_TYPEDEF(StringRef, StOtherPiece)
1038 
1039 template <> struct ScalarTraits<StOtherPiece> {
1040   static void output(const StOtherPiece &Val, void *, raw_ostream &Out) {
1041     Out << Val;
1042   }
1043   static StringRef input(StringRef Scalar, void *, StOtherPiece &Val) {
1044     Val = Scalar;
1045     return {};
1046   }
1047   static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1048 };
1049 template <> struct SequenceElementTraits<StOtherPiece> {
1050   static const bool flow = true;
1051 };
1052 
1053 template <> struct ScalarTraits<ELFYAML::YAMLFlowString> {
1054   static void output(const ELFYAML::YAMLFlowString &Val, void *,
1055                      raw_ostream &Out) {
1056     Out << Val;
1057   }
1058   static StringRef input(StringRef Scalar, void *,
1059                          ELFYAML::YAMLFlowString &Val) {
1060     Val = Scalar;
1061     return {};
1062   }
1063   static QuotingType mustQuote(StringRef S) {
1064     return ScalarTraits<StringRef>::mustQuote(S);
1065   }
1066 };
1067 template <> struct SequenceElementTraits<ELFYAML::YAMLFlowString> {
1068   static const bool flow = true;
1069 };
1070 
1071 namespace {
1072 
1073 struct NormalizedOther {
1074   NormalizedOther(IO &IO) : YamlIO(IO) {}
1075   NormalizedOther(IO &IO, Optional<uint8_t> Original) : YamlIO(IO) {
1076     assert(Original && "This constructor is only used for outputting YAML and "
1077                        "assumes a non-empty Original");
1078     std::vector<StOtherPiece> Ret;
1079     const auto *Object = static_cast<ELFYAML::Object *>(YamlIO.getContext());
1080     for (std::pair<StringRef, uint8_t> &P :
1081          getFlags(Object->getMachine()).takeVector()) {
1082       uint8_t FlagValue = P.second;
1083       if ((*Original & FlagValue) != FlagValue)
1084         continue;
1085       *Original &= ~FlagValue;
1086       Ret.push_back({P.first});
1087     }
1088 
1089     if (*Original != 0) {
1090       UnknownFlagsHolder = std::to_string(*Original);
1091       Ret.push_back({UnknownFlagsHolder});
1092     }
1093 
1094     if (!Ret.empty())
1095       Other = std::move(Ret);
1096   }
1097 
1098   uint8_t toValue(StringRef Name) {
1099     const auto *Object = static_cast<ELFYAML::Object *>(YamlIO.getContext());
1100     MapVector<StringRef, uint8_t> Flags = getFlags(Object->getMachine());
1101 
1102     auto It = Flags.find(Name);
1103     if (It != Flags.end())
1104       return It->second;
1105 
1106     uint8_t Val;
1107     if (to_integer(Name, Val))
1108       return Val;
1109 
1110     YamlIO.setError("an unknown value is used for symbol's 'Other' field: " +
1111                     Name);
1112     return 0;
1113   }
1114 
1115   Optional<uint8_t> denormalize(IO &) {
1116     if (!Other)
1117       return None;
1118     uint8_t Ret = 0;
1119     for (StOtherPiece &Val : *Other)
1120       Ret |= toValue(Val);
1121     return Ret;
1122   }
1123 
1124   // st_other field is used to encode symbol visibility and platform-dependent
1125   // flags and values. This method returns a name to value map that is used for
1126   // parsing and encoding this field.
1127   MapVector<StringRef, uint8_t> getFlags(unsigned EMachine) {
1128     MapVector<StringRef, uint8_t> Map;
1129     // STV_* values are just enumeration values. We add them in a reversed order
1130     // because when we convert the st_other to named constants when printing
1131     // YAML we want to use a maximum number of bits on each step:
1132     // when we have st_other == 3, we want to print it as STV_PROTECTED (3), but
1133     // not as STV_HIDDEN (2) + STV_INTERNAL (1).
1134     Map["STV_PROTECTED"] = ELF::STV_PROTECTED;
1135     Map["STV_HIDDEN"] = ELF::STV_HIDDEN;
1136     Map["STV_INTERNAL"] = ELF::STV_INTERNAL;
1137     // STV_DEFAULT is used to represent the default visibility and has a value
1138     // 0. We want to be able to read it from YAML documents, but there is no
1139     // reason to print it.
1140     if (!YamlIO.outputting())
1141       Map["STV_DEFAULT"] = ELF::STV_DEFAULT;
1142 
1143     // MIPS is not consistent. All of the STO_MIPS_* values are bit flags,
1144     // except STO_MIPS_MIPS16 which overlaps them. It should be checked and
1145     // consumed first when we print the output, because we do not want to print
1146     // any other flags that have the same bits instead.
1147     if (EMachine == ELF::EM_MIPS) {
1148       Map["STO_MIPS_MIPS16"] = ELF::STO_MIPS_MIPS16;
1149       Map["STO_MIPS_MICROMIPS"] = ELF::STO_MIPS_MICROMIPS;
1150       Map["STO_MIPS_PIC"] = ELF::STO_MIPS_PIC;
1151       Map["STO_MIPS_PLT"] = ELF::STO_MIPS_PLT;
1152       Map["STO_MIPS_OPTIONAL"] = ELF::STO_MIPS_OPTIONAL;
1153     }
1154 
1155     if (EMachine == ELF::EM_AARCH64)
1156       Map["STO_AARCH64_VARIANT_PCS"] = ELF::STO_AARCH64_VARIANT_PCS;
1157     return Map;
1158   }
1159 
1160   IO &YamlIO;
1161   Optional<std::vector<StOtherPiece>> Other;
1162   std::string UnknownFlagsHolder;
1163 };
1164 
1165 } // end anonymous namespace
1166 
1167 void ScalarTraits<ELFYAML::YAMLIntUInt>::output(const ELFYAML::YAMLIntUInt &Val,
1168                                                 void *Ctx, raw_ostream &Out) {
1169   Out << Val;
1170 }
1171 
1172 StringRef ScalarTraits<ELFYAML::YAMLIntUInt>::input(StringRef Scalar, void *Ctx,
1173                                                     ELFYAML::YAMLIntUInt &Val) {
1174   const bool Is64 = static_cast<ELFYAML::Object *>(Ctx)->Header.Class ==
1175                     ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
1176   StringRef ErrMsg = "invalid number";
1177   // We do not accept negative hex numbers because their meaning is ambiguous.
1178   // For example, would -0xfffffffff mean 1 or INT32_MIN?
1179   if (Scalar.empty() || Scalar.startswith("-0x"))
1180     return ErrMsg;
1181 
1182   if (Scalar.startswith("-")) {
1183     const int64_t MinVal = Is64 ? INT64_MIN : INT32_MIN;
1184     long long Int;
1185     if (getAsSignedInteger(Scalar, /*Radix=*/0, Int) || (Int < MinVal))
1186       return ErrMsg;
1187     Val = Int;
1188     return "";
1189   }
1190 
1191   const uint64_t MaxVal = Is64 ? UINT64_MAX : UINT32_MAX;
1192   unsigned long long UInt;
1193   if (getAsUnsignedInteger(Scalar, /*Radix=*/0, UInt) || (UInt > MaxVal))
1194     return ErrMsg;
1195   Val = UInt;
1196   return "";
1197 }
1198 
1199 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
1200   IO.mapOptional("Name", Symbol.Name, StringRef());
1201   IO.mapOptional("StName", Symbol.StName);
1202   IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
1203   IO.mapOptional("Section", Symbol.Section);
1204   IO.mapOptional("Index", Symbol.Index);
1205   IO.mapOptional("Binding", Symbol.Binding, ELFYAML::ELF_STB(0));
1206   IO.mapOptional("Value", Symbol.Value);
1207   IO.mapOptional("Size", Symbol.Size);
1208 
1209   // Symbol's Other field is a bit special. It is usually a field that
1210   // represents st_other and holds the symbol visibility. However, on some
1211   // platforms, it can contain bit fields and regular values, or even sometimes a
1212   // crazy mix of them (see comments for NormalizedOther). Because of this, we
1213   // need special handling.
1214   MappingNormalization<NormalizedOther, Optional<uint8_t>> Keys(IO,
1215                                                                 Symbol.Other);
1216   IO.mapOptional("Other", Keys->Other);
1217 }
1218 
1219 std::string MappingTraits<ELFYAML::Symbol>::validate(IO &IO,
1220                                                      ELFYAML::Symbol &Symbol) {
1221   if (Symbol.Index && Symbol.Section)
1222     return "Index and Section cannot both be specified for Symbol";
1223   return "";
1224 }
1225 
1226 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
1227   IO.mapOptional("Name", Section.Name, StringRef());
1228   IO.mapRequired("Type", Section.Type);
1229   IO.mapOptional("Flags", Section.Flags);
1230   IO.mapOptional("Address", Section.Address);
1231   IO.mapOptional("Link", Section.Link);
1232   IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
1233   IO.mapOptional("EntSize", Section.EntSize);
1234   IO.mapOptional("Offset", Section.Offset);
1235 
1236   IO.mapOptional("Content", Section.Content);
1237   IO.mapOptional("Size", Section.Size);
1238 
1239   // obj2yaml does not dump these fields. They are expected to be empty when we
1240   // are producing YAML, because yaml2obj sets appropriate values for them
1241   // automatically when they are not explicitly defined.
1242   assert(!IO.outputting() ||
1243          (!Section.ShOffset && !Section.ShSize && !Section.ShName &&
1244           !Section.ShFlags && !Section.ShType && !Section.ShAddrAlign));
1245   IO.mapOptional("ShAddrAlign", Section.ShAddrAlign);
1246   IO.mapOptional("ShName", Section.ShName);
1247   IO.mapOptional("ShOffset", Section.ShOffset);
1248   IO.mapOptional("ShSize", Section.ShSize);
1249   IO.mapOptional("ShFlags", Section.ShFlags);
1250   IO.mapOptional("ShType", Section.ShType);
1251 }
1252 
1253 static void sectionMapping(IO &IO, ELFYAML::DynamicSection &Section) {
1254   commonSectionMapping(IO, Section);
1255   IO.mapOptional("Entries", Section.Entries);
1256 }
1257 
1258 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
1259   commonSectionMapping(IO, Section);
1260 
1261   // We also support reading a content as array of bytes using the ContentArray
1262   // key. obj2yaml never prints this field.
1263   assert(!IO.outputting() || !Section.ContentBuf.hasValue());
1264   IO.mapOptional("ContentArray", Section.ContentBuf);
1265   if (Section.ContentBuf) {
1266     if (Section.Content)
1267       IO.setError("Content and ContentArray can't be used together");
1268     Section.Content = yaml::BinaryRef(*Section.ContentBuf);
1269   }
1270 
1271   IO.mapOptional("Info", Section.Info);
1272 }
1273 
1274 static void sectionMapping(IO &IO, ELFYAML::BBAddrMapSection &Section) {
1275   commonSectionMapping(IO, Section);
1276   IO.mapOptional("Content", Section.Content);
1277   IO.mapOptional("Entries", Section.Entries);
1278 }
1279 
1280 static void sectionMapping(IO &IO, ELFYAML::StackSizesSection &Section) {
1281   commonSectionMapping(IO, Section);
1282   IO.mapOptional("Entries", Section.Entries);
1283 }
1284 
1285 static void sectionMapping(IO &IO, ELFYAML::HashSection &Section) {
1286   commonSectionMapping(IO, Section);
1287   IO.mapOptional("Bucket", Section.Bucket);
1288   IO.mapOptional("Chain", Section.Chain);
1289 
1290   // obj2yaml does not dump these fields. They can be used to override nchain
1291   // and nbucket values for creating broken sections.
1292   assert(!IO.outputting() ||
1293          (!Section.NBucket.hasValue() && !Section.NChain.hasValue()));
1294   IO.mapOptional("NChain", Section.NChain);
1295   IO.mapOptional("NBucket", Section.NBucket);
1296 }
1297 
1298 static void sectionMapping(IO &IO, ELFYAML::NoteSection &Section) {
1299   commonSectionMapping(IO, Section);
1300   IO.mapOptional("Notes", Section.Notes);
1301 }
1302 
1303 
1304 static void sectionMapping(IO &IO, ELFYAML::GnuHashSection &Section) {
1305   commonSectionMapping(IO, Section);
1306   IO.mapOptional("Header", Section.Header);
1307   IO.mapOptional("BloomFilter", Section.BloomFilter);
1308   IO.mapOptional("HashBuckets", Section.HashBuckets);
1309   IO.mapOptional("HashValues", Section.HashValues);
1310 }
1311 static void sectionMapping(IO &IO, ELFYAML::NoBitsSection &Section) {
1312   commonSectionMapping(IO, Section);
1313 }
1314 
1315 static void sectionMapping(IO &IO, ELFYAML::VerdefSection &Section) {
1316   commonSectionMapping(IO, Section);
1317   IO.mapOptional("Info", Section.Info);
1318   IO.mapOptional("Entries", Section.Entries);
1319 }
1320 
1321 static void sectionMapping(IO &IO, ELFYAML::SymverSection &Section) {
1322   commonSectionMapping(IO, Section);
1323   IO.mapOptional("Entries", Section.Entries);
1324 }
1325 
1326 static void sectionMapping(IO &IO, ELFYAML::VerneedSection &Section) {
1327   commonSectionMapping(IO, Section);
1328   IO.mapOptional("Info", Section.Info);
1329   IO.mapOptional("Dependencies", Section.VerneedV);
1330 }
1331 
1332 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
1333   commonSectionMapping(IO, Section);
1334   IO.mapOptional("Info", Section.RelocatableSec, StringRef());
1335   IO.mapOptional("Relocations", Section.Relocations);
1336 }
1337 
1338 static void sectionMapping(IO &IO, ELFYAML::RelrSection &Section) {
1339   commonSectionMapping(IO, Section);
1340   IO.mapOptional("Entries", Section.Entries);
1341 }
1342 
1343 static void groupSectionMapping(IO &IO, ELFYAML::GroupSection &Group) {
1344   commonSectionMapping(IO, Group);
1345   IO.mapOptional("Info", Group.Signature);
1346   IO.mapOptional("Members", Group.Members);
1347 }
1348 
1349 static void sectionMapping(IO &IO, ELFYAML::SymtabShndxSection &Section) {
1350   commonSectionMapping(IO, Section);
1351   IO.mapOptional("Entries", Section.Entries);
1352 }
1353 
1354 static void sectionMapping(IO &IO, ELFYAML::AddrsigSection &Section) {
1355   commonSectionMapping(IO, Section);
1356   IO.mapOptional("Symbols", Section.Symbols);
1357 }
1358 
1359 static void fillMapping(IO &IO, ELFYAML::Fill &Fill) {
1360   IO.mapOptional("Name", Fill.Name, StringRef());
1361   IO.mapOptional("Pattern", Fill.Pattern);
1362   IO.mapOptional("Offset", Fill.Offset);
1363   IO.mapRequired("Size", Fill.Size);
1364 }
1365 
1366 static void sectionHeaderTableMapping(IO &IO,
1367                                       ELFYAML::SectionHeaderTable &SHT) {
1368   IO.mapOptional("Offset", SHT.Offset);
1369   IO.mapOptional("Sections", SHT.Sections);
1370   IO.mapOptional("Excluded", SHT.Excluded);
1371   IO.mapOptional("NoHeaders", SHT.NoHeaders);
1372 }
1373 
1374 static void sectionMapping(IO &IO, ELFYAML::LinkerOptionsSection &Section) {
1375   commonSectionMapping(IO, Section);
1376   IO.mapOptional("Options", Section.Options);
1377 }
1378 
1379 static void sectionMapping(IO &IO,
1380                            ELFYAML::DependentLibrariesSection &Section) {
1381   commonSectionMapping(IO, Section);
1382   IO.mapOptional("Libraries", Section.Libs);
1383 }
1384 
1385 static void sectionMapping(IO &IO, ELFYAML::CallGraphProfileSection &Section) {
1386   commonSectionMapping(IO, Section);
1387   IO.mapOptional("Entries", Section.Entries);
1388 }
1389 
1390 void MappingTraits<ELFYAML::SectionOrType>::mapping(
1391     IO &IO, ELFYAML::SectionOrType &sectionOrType) {
1392   IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
1393 }
1394 
1395 static void sectionMapping(IO &IO, ELFYAML::ARMIndexTableSection &Section) {
1396   commonSectionMapping(IO, Section);
1397   IO.mapOptional("Entries", Section.Entries);
1398 }
1399 
1400 static void sectionMapping(IO &IO, ELFYAML::MipsABIFlags &Section) {
1401   commonSectionMapping(IO, Section);
1402   IO.mapOptional("Version", Section.Version, Hex16(0));
1403   IO.mapRequired("ISA", Section.ISALevel);
1404   IO.mapOptional("ISARevision", Section.ISARevision, Hex8(0));
1405   IO.mapOptional("ISAExtension", Section.ISAExtension,
1406                  ELFYAML::MIPS_AFL_EXT(Mips::AFL_EXT_NONE));
1407   IO.mapOptional("ASEs", Section.ASEs, ELFYAML::MIPS_AFL_ASE(0));
1408   IO.mapOptional("FpABI", Section.FpABI,
1409                  ELFYAML::MIPS_ABI_FP(Mips::Val_GNU_MIPS_ABI_FP_ANY));
1410   IO.mapOptional("GPRSize", Section.GPRSize,
1411                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1412   IO.mapOptional("CPR1Size", Section.CPR1Size,
1413                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1414   IO.mapOptional("CPR2Size", Section.CPR2Size,
1415                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
1416   IO.mapOptional("Flags1", Section.Flags1, ELFYAML::MIPS_AFL_FLAGS1(0));
1417   IO.mapOptional("Flags2", Section.Flags2, Hex32(0));
1418 }
1419 
1420 static StringRef getStringValue(IO &IO, const char *Key) {
1421   StringRef Val;
1422   IO.mapRequired(Key, Val);
1423   return Val;
1424 }
1425 
1426 static void setStringValue(IO &IO, const char *Key, StringRef Val) {
1427   IO.mapRequired(Key, Val);
1428 }
1429 
1430 static bool isInteger(StringRef Val) {
1431   APInt Tmp;
1432   return !Val.getAsInteger(0, Tmp);
1433 }
1434 
1435 void MappingTraits<std::unique_ptr<ELFYAML::Chunk>>::mapping(
1436     IO &IO, std::unique_ptr<ELFYAML::Chunk> &Section) {
1437   ELFYAML::ELF_SHT Type;
1438   StringRef TypeStr;
1439   if (IO.outputting()) {
1440     if (auto *S = dyn_cast<ELFYAML::Section>(Section.get()))
1441       Type = S->Type;
1442     else if (auto *SHT = dyn_cast<ELFYAML::SectionHeaderTable>(Section.get()))
1443       TypeStr = SHT->TypeStr;
1444   } else {
1445     // When the Type string does not have a "SHT_" prefix, we know it is not a
1446     // description of a regular ELF output section.
1447     TypeStr = getStringValue(IO, "Type");
1448     if (TypeStr.startswith("SHT_") || isInteger(TypeStr))
1449       IO.mapRequired("Type", Type);
1450   }
1451 
1452   if (TypeStr == "Fill") {
1453     assert(!IO.outputting()); // We don't dump fills currently.
1454     Section.reset(new ELFYAML::Fill());
1455     fillMapping(IO, *cast<ELFYAML::Fill>(Section.get()));
1456     return;
1457   }
1458 
1459   if (TypeStr == ELFYAML::SectionHeaderTable::TypeStr) {
1460     if (IO.outputting())
1461       setStringValue(IO, "Type", TypeStr);
1462     else
1463       Section.reset(new ELFYAML::SectionHeaderTable(/*IsImplicit=*/false));
1464 
1465     sectionHeaderTableMapping(
1466         IO, *cast<ELFYAML::SectionHeaderTable>(Section.get()));
1467     return;
1468   }
1469 
1470   const auto &Obj = *static_cast<ELFYAML::Object *>(IO.getContext());
1471   if (Obj.getMachine() == ELF::EM_MIPS && Type == ELF::SHT_MIPS_ABIFLAGS) {
1472     if (!IO.outputting())
1473       Section.reset(new ELFYAML::MipsABIFlags());
1474     sectionMapping(IO, *cast<ELFYAML::MipsABIFlags>(Section.get()));
1475     return;
1476   }
1477 
1478   if (Obj.getMachine() == ELF::EM_ARM && Type == ELF::SHT_ARM_EXIDX) {
1479     if (!IO.outputting())
1480       Section.reset(new ELFYAML::ARMIndexTableSection());
1481     sectionMapping(IO, *cast<ELFYAML::ARMIndexTableSection>(Section.get()));
1482     return;
1483   }
1484 
1485   switch (Type) {
1486   case ELF::SHT_DYNAMIC:
1487     if (!IO.outputting())
1488       Section.reset(new ELFYAML::DynamicSection());
1489     sectionMapping(IO, *cast<ELFYAML::DynamicSection>(Section.get()));
1490     break;
1491   case ELF::SHT_REL:
1492   case ELF::SHT_RELA:
1493     if (!IO.outputting())
1494       Section.reset(new ELFYAML::RelocationSection());
1495     sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
1496     break;
1497   case ELF::SHT_RELR:
1498     if (!IO.outputting())
1499       Section.reset(new ELFYAML::RelrSection());
1500     sectionMapping(IO, *cast<ELFYAML::RelrSection>(Section.get()));
1501     break;
1502   case ELF::SHT_GROUP:
1503     if (!IO.outputting())
1504       Section.reset(new ELFYAML::GroupSection());
1505     groupSectionMapping(IO, *cast<ELFYAML::GroupSection>(Section.get()));
1506     break;
1507   case ELF::SHT_NOBITS:
1508     if (!IO.outputting())
1509       Section.reset(new ELFYAML::NoBitsSection());
1510     sectionMapping(IO, *cast<ELFYAML::NoBitsSection>(Section.get()));
1511     break;
1512   case ELF::SHT_HASH:
1513     if (!IO.outputting())
1514       Section.reset(new ELFYAML::HashSection());
1515     sectionMapping(IO, *cast<ELFYAML::HashSection>(Section.get()));
1516     break;
1517   case ELF::SHT_NOTE:
1518     if (!IO.outputting())
1519       Section.reset(new ELFYAML::NoteSection());
1520     sectionMapping(IO, *cast<ELFYAML::NoteSection>(Section.get()));
1521     break;
1522  case ELF::SHT_GNU_HASH:
1523     if (!IO.outputting())
1524       Section.reset(new ELFYAML::GnuHashSection());
1525     sectionMapping(IO, *cast<ELFYAML::GnuHashSection>(Section.get()));
1526     break;
1527   case ELF::SHT_GNU_verdef:
1528     if (!IO.outputting())
1529       Section.reset(new ELFYAML::VerdefSection());
1530     sectionMapping(IO, *cast<ELFYAML::VerdefSection>(Section.get()));
1531     break;
1532   case ELF::SHT_GNU_versym:
1533     if (!IO.outputting())
1534       Section.reset(new ELFYAML::SymverSection());
1535     sectionMapping(IO, *cast<ELFYAML::SymverSection>(Section.get()));
1536     break;
1537   case ELF::SHT_GNU_verneed:
1538     if (!IO.outputting())
1539       Section.reset(new ELFYAML::VerneedSection());
1540     sectionMapping(IO, *cast<ELFYAML::VerneedSection>(Section.get()));
1541     break;
1542   case ELF::SHT_SYMTAB_SHNDX:
1543     if (!IO.outputting())
1544       Section.reset(new ELFYAML::SymtabShndxSection());
1545     sectionMapping(IO, *cast<ELFYAML::SymtabShndxSection>(Section.get()));
1546     break;
1547   case ELF::SHT_LLVM_ADDRSIG:
1548     if (!IO.outputting())
1549       Section.reset(new ELFYAML::AddrsigSection());
1550     sectionMapping(IO, *cast<ELFYAML::AddrsigSection>(Section.get()));
1551     break;
1552   case ELF::SHT_LLVM_LINKER_OPTIONS:
1553     if (!IO.outputting())
1554       Section.reset(new ELFYAML::LinkerOptionsSection());
1555     sectionMapping(IO, *cast<ELFYAML::LinkerOptionsSection>(Section.get()));
1556     break;
1557   case ELF::SHT_LLVM_DEPENDENT_LIBRARIES:
1558     if (!IO.outputting())
1559       Section.reset(new ELFYAML::DependentLibrariesSection());
1560     sectionMapping(IO,
1561                    *cast<ELFYAML::DependentLibrariesSection>(Section.get()));
1562     break;
1563   case ELF::SHT_LLVM_CALL_GRAPH_PROFILE:
1564     if (!IO.outputting())
1565       Section.reset(new ELFYAML::CallGraphProfileSection());
1566     sectionMapping(IO, *cast<ELFYAML::CallGraphProfileSection>(Section.get()));
1567     break;
1568   case ELF::SHT_LLVM_BB_ADDR_MAP:
1569     if (!IO.outputting())
1570       Section.reset(new ELFYAML::BBAddrMapSection());
1571     sectionMapping(IO, *cast<ELFYAML::BBAddrMapSection>(Section.get()));
1572     break;
1573   default:
1574     if (!IO.outputting()) {
1575       StringRef Name;
1576       IO.mapOptional("Name", Name, StringRef());
1577       Name = ELFYAML::dropUniqueSuffix(Name);
1578 
1579       if (ELFYAML::StackSizesSection::nameMatches(Name))
1580         Section = std::make_unique<ELFYAML::StackSizesSection>();
1581       else
1582         Section = std::make_unique<ELFYAML::RawContentSection>();
1583     }
1584 
1585     if (auto S = dyn_cast<ELFYAML::RawContentSection>(Section.get()))
1586       sectionMapping(IO, *S);
1587     else
1588       sectionMapping(IO, *cast<ELFYAML::StackSizesSection>(Section.get()));
1589   }
1590 }
1591 
1592 std::string MappingTraits<std::unique_ptr<ELFYAML::Chunk>>::validate(
1593     IO &io, std::unique_ptr<ELFYAML::Chunk> &C) {
1594   if (const auto *F = dyn_cast<ELFYAML::Fill>(C.get())) {
1595     if (F->Pattern && F->Pattern->binary_size() != 0 && !F->Size)
1596       return "\"Size\" can't be 0 when \"Pattern\" is not empty";
1597     return "";
1598   }
1599 
1600   if (const auto *SHT = dyn_cast<ELFYAML::SectionHeaderTable>(C.get())) {
1601     if (SHT->NoHeaders && (SHT->Sections || SHT->Excluded || SHT->Offset))
1602       return "NoHeaders can't be used together with Offset/Sections/Excluded";
1603     return "";
1604   }
1605 
1606   const ELFYAML::Section &Sec = *cast<ELFYAML::Section>(C.get());
1607   if (Sec.Size && Sec.Content &&
1608       (uint64_t)(*Sec.Size) < Sec.Content->binary_size())
1609     return "Section size must be greater than or equal to the content size";
1610 
1611   auto BuildErrPrefix = [](ArrayRef<std::pair<StringRef, bool>> EntV) {
1612     std::string Msg;
1613     for (size_t I = 0, E = EntV.size(); I != E; ++I) {
1614       StringRef Name = EntV[I].first;
1615       if (I == 0) {
1616         Msg = "\"" + Name.str() + "\"";
1617         continue;
1618       }
1619       if (I != EntV.size() - 1)
1620         Msg += ", \"" + Name.str() + "\"";
1621       else
1622         Msg += " and \"" + Name.str() + "\"";
1623     }
1624     return Msg;
1625   };
1626 
1627   std::vector<std::pair<StringRef, bool>> Entries = Sec.getEntries();
1628   const size_t NumUsedEntries = llvm::count_if(
1629       Entries, [](const std::pair<StringRef, bool> &P) { return P.second; });
1630 
1631   if ((Sec.Size || Sec.Content) && NumUsedEntries > 0)
1632     return BuildErrPrefix(Entries) +
1633            " cannot be used with \"Content\" or \"Size\"";
1634 
1635   if (NumUsedEntries > 0 && Entries.size() != NumUsedEntries)
1636     return BuildErrPrefix(Entries) + " must be used together";
1637 
1638   if (const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(C.get())) {
1639     if (RawSection->Flags && RawSection->ShFlags)
1640       return "ShFlags and Flags cannot be used together";
1641     return "";
1642   }
1643 
1644   if (const auto *NB = dyn_cast<ELFYAML::NoBitsSection>(C.get())) {
1645     if (NB->Content)
1646       return "SHT_NOBITS section cannot have \"Content\"";
1647     return "";
1648   }
1649 
1650   if (const auto *MF = dyn_cast<ELFYAML::MipsABIFlags>(C.get())) {
1651     if (MF->Content)
1652       return "\"Content\" key is not implemented for SHT_MIPS_ABIFLAGS "
1653              "sections";
1654     if (MF->Size)
1655       return "\"Size\" key is not implemented for SHT_MIPS_ABIFLAGS sections";
1656     return "";
1657   }
1658 
1659   return "";
1660 }
1661 
1662 namespace {
1663 
1664 struct NormalizedMips64RelType {
1665   NormalizedMips64RelType(IO &)
1666       : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1667         Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1668         Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
1669         SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
1670   NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
1671       : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
1672         Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
1673 
1674   ELFYAML::ELF_REL denormalize(IO &) {
1675     ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
1676     return Res;
1677   }
1678 
1679   ELFYAML::ELF_REL Type;
1680   ELFYAML::ELF_REL Type2;
1681   ELFYAML::ELF_REL Type3;
1682   ELFYAML::ELF_RSS SpecSym;
1683 };
1684 
1685 } // end anonymous namespace
1686 
1687 void MappingTraits<ELFYAML::StackSizeEntry>::mapping(
1688     IO &IO, ELFYAML::StackSizeEntry &E) {
1689   assert(IO.getContext() && "The IO context is not initialized");
1690   IO.mapOptional("Address", E.Address, Hex64(0));
1691   IO.mapRequired("Size", E.Size);
1692 }
1693 
1694 void MappingTraits<ELFYAML::BBAddrMapEntry>::mapping(
1695     IO &IO, ELFYAML::BBAddrMapEntry &E) {
1696   assert(IO.getContext() && "The IO context is not initialized");
1697   IO.mapOptional("Address", E.Address, Hex64(0));
1698   IO.mapOptional("NumBlocks", E.NumBlocks);
1699   IO.mapOptional("BBEntries", E.BBEntries);
1700 }
1701 
1702 void MappingTraits<ELFYAML::BBAddrMapEntry::BBEntry>::mapping(
1703     IO &IO, ELFYAML::BBAddrMapEntry::BBEntry &E) {
1704   assert(IO.getContext() && "The IO context is not initialized");
1705   IO.mapRequired("AddressOffset", E.AddressOffset);
1706   IO.mapRequired("Size", E.Size);
1707   IO.mapRequired("Metadata", E.Metadata);
1708 }
1709 
1710 void MappingTraits<ELFYAML::GnuHashHeader>::mapping(IO &IO,
1711                                                     ELFYAML::GnuHashHeader &E) {
1712   assert(IO.getContext() && "The IO context is not initialized");
1713   IO.mapOptional("NBuckets", E.NBuckets);
1714   IO.mapRequired("SymNdx", E.SymNdx);
1715   IO.mapOptional("MaskWords", E.MaskWords);
1716   IO.mapRequired("Shift2", E.Shift2);
1717 }
1718 
1719 void MappingTraits<ELFYAML::DynamicEntry>::mapping(IO &IO,
1720                                                    ELFYAML::DynamicEntry &Rel) {
1721   assert(IO.getContext() && "The IO context is not initialized");
1722 
1723   IO.mapRequired("Tag", Rel.Tag);
1724   IO.mapRequired("Value", Rel.Val);
1725 }
1726 
1727 void MappingTraits<ELFYAML::NoteEntry>::mapping(IO &IO, ELFYAML::NoteEntry &N) {
1728   assert(IO.getContext() && "The IO context is not initialized");
1729 
1730   IO.mapOptional("Name", N.Name);
1731   IO.mapOptional("Desc", N.Desc);
1732   IO.mapRequired("Type", N.Type);
1733 }
1734 
1735 void MappingTraits<ELFYAML::VerdefEntry>::mapping(IO &IO,
1736                                                   ELFYAML::VerdefEntry &E) {
1737   assert(IO.getContext() && "The IO context is not initialized");
1738 
1739   IO.mapOptional("Version", E.Version);
1740   IO.mapOptional("Flags", E.Flags);
1741   IO.mapOptional("VersionNdx", E.VersionNdx);
1742   IO.mapOptional("Hash", E.Hash);
1743   IO.mapRequired("Names", E.VerNames);
1744 }
1745 
1746 void MappingTraits<ELFYAML::VerneedEntry>::mapping(IO &IO,
1747                                                    ELFYAML::VerneedEntry &E) {
1748   assert(IO.getContext() && "The IO context is not initialized");
1749 
1750   IO.mapRequired("Version", E.Version);
1751   IO.mapRequired("File", E.File);
1752   IO.mapRequired("Entries", E.AuxV);
1753 }
1754 
1755 void MappingTraits<ELFYAML::VernauxEntry>::mapping(IO &IO,
1756                                                    ELFYAML::VernauxEntry &E) {
1757   assert(IO.getContext() && "The IO context is not initialized");
1758 
1759   IO.mapRequired("Name", E.Name);
1760   IO.mapRequired("Hash", E.Hash);
1761   IO.mapRequired("Flags", E.Flags);
1762   IO.mapRequired("Other", E.Other);
1763 }
1764 
1765 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
1766                                                  ELFYAML::Relocation &Rel) {
1767   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
1768   assert(Object && "The IO context is not initialized");
1769 
1770   IO.mapOptional("Offset", Rel.Offset, (Hex64)0);
1771   IO.mapOptional("Symbol", Rel.Symbol);
1772 
1773   if (Object->getMachine() == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
1774       Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
1775     MappingNormalization<NormalizedMips64RelType, ELFYAML::ELF_REL> Key(
1776         IO, Rel.Type);
1777     IO.mapRequired("Type", Key->Type);
1778     IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
1779     IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
1780     IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
1781   } else
1782     IO.mapRequired("Type", Rel.Type);
1783 
1784   IO.mapOptional("Addend", Rel.Addend, (ELFYAML::YAMLIntUInt)0);
1785 }
1786 
1787 void MappingTraits<ELFYAML::ARMIndexTableEntry>::mapping(
1788     IO &IO, ELFYAML::ARMIndexTableEntry &E) {
1789   assert(IO.getContext() && "The IO context is not initialized");
1790   IO.mapRequired("Offset", E.Offset);
1791 
1792   StringRef CantUnwind = "EXIDX_CANTUNWIND";
1793   if (IO.outputting() && (uint32_t)E.Value == ARM::EHABI::EXIDX_CANTUNWIND)
1794     IO.mapRequired("Value", CantUnwind);
1795   else if (!IO.outputting() && getStringValue(IO, "Value") == CantUnwind)
1796     E.Value = ARM::EHABI::EXIDX_CANTUNWIND;
1797   else
1798     IO.mapRequired("Value", E.Value);
1799 }
1800 
1801 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
1802   assert(!IO.getContext() && "The IO context is initialized already");
1803   IO.setContext(&Object);
1804   IO.mapTag("!ELF", true);
1805   IO.mapRequired("FileHeader", Object.Header);
1806   IO.mapOptional("ProgramHeaders", Object.ProgramHeaders);
1807   IO.mapOptional("Sections", Object.Chunks);
1808   IO.mapOptional("Symbols", Object.Symbols);
1809   IO.mapOptional("DynamicSymbols", Object.DynamicSymbols);
1810   IO.mapOptional("DWARF", Object.DWARF);
1811   if (Object.DWARF) {
1812     Object.DWARF->IsLittleEndian =
1813         Object.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB);
1814     Object.DWARF->Is64BitAddrSize =
1815         Object.Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
1816   }
1817   IO.setContext(nullptr);
1818 }
1819 
1820 void MappingTraits<ELFYAML::LinkerOption>::mapping(IO &IO,
1821                                                    ELFYAML::LinkerOption &Opt) {
1822   assert(IO.getContext() && "The IO context is not initialized");
1823   IO.mapRequired("Name", Opt.Key);
1824   IO.mapRequired("Value", Opt.Value);
1825 }
1826 
1827 void MappingTraits<ELFYAML::CallGraphEntry>::mapping(
1828     IO &IO, ELFYAML::CallGraphEntry &E) {
1829   assert(IO.getContext() && "The IO context is not initialized");
1830   IO.mapRequired("From", E.From);
1831   IO.mapRequired("To", E.To);
1832   IO.mapRequired("Weight", E.Weight);
1833 }
1834 
1835 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
1836 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
1837 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
1838 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
1839 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
1840 
1841 } // end namespace yaml
1842 
1843 } // end namespace llvm
1844