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