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