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