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