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