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