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