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