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