1 //===- ELFYAML.cpp - ELF YAMLIO implementation ----------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines classes for handling the YAML representation of ELF.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/ObjectYAML/ELFYAML.h"
15 #include "llvm/ADT/StringRef.h"
16 #include "llvm/BinaryFormat/ELF.h"
17 #include "llvm/Support/Casting.h"
18 #include "llvm/Support/ErrorHandling.h"
19 #include "llvm/Support/MipsABIFlags.h"
20 #include "llvm/Support/YAMLTraits.h"
21 #include <cassert>
22 #include <cstdint>
23 
24 namespace llvm {
25 
26 ELFYAML::Section::~Section() = default;
27 
28 namespace yaml {
29 
30 void ScalarEnumerationTraits<ELFYAML::ELF_ET>::enumeration(
31     IO &IO, ELFYAML::ELF_ET &Value) {
32 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
33   ECase(ET_NONE);
34   ECase(ET_REL);
35   ECase(ET_EXEC);
36   ECase(ET_DYN);
37   ECase(ET_CORE);
38 #undef ECase
39   IO.enumFallback<Hex16>(Value);
40 }
41 
42 void ScalarEnumerationTraits<ELFYAML::ELF_PT>::enumeration(
43     IO &IO, ELFYAML::ELF_PT &Value) {
44 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
45   ECase(PT_NULL);
46   ECase(PT_LOAD);
47   ECase(PT_DYNAMIC);
48   ECase(PT_INTERP);
49   ECase(PT_NOTE);
50   ECase(PT_SHLIB);
51   ECase(PT_PHDR);
52   ECase(PT_TLS);
53 #undef ECase
54   IO.enumFallback<Hex32>(Value);
55 }
56 
57 void ScalarEnumerationTraits<ELFYAML::ELF_EM>::enumeration(
58     IO &IO, ELFYAML::ELF_EM &Value) {
59 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
60   ECase(EM_NONE);
61   ECase(EM_M32);
62   ECase(EM_SPARC);
63   ECase(EM_386);
64   ECase(EM_68K);
65   ECase(EM_88K);
66   ECase(EM_IAMCU);
67   ECase(EM_860);
68   ECase(EM_MIPS);
69   ECase(EM_S370);
70   ECase(EM_MIPS_RS3_LE);
71   ECase(EM_PARISC);
72   ECase(EM_VPP500);
73   ECase(EM_SPARC32PLUS);
74   ECase(EM_960);
75   ECase(EM_PPC);
76   ECase(EM_PPC64);
77   ECase(EM_S390);
78   ECase(EM_SPU);
79   ECase(EM_V800);
80   ECase(EM_FR20);
81   ECase(EM_RH32);
82   ECase(EM_RCE);
83   ECase(EM_ARM);
84   ECase(EM_ALPHA);
85   ECase(EM_SH);
86   ECase(EM_SPARCV9);
87   ECase(EM_TRICORE);
88   ECase(EM_ARC);
89   ECase(EM_H8_300);
90   ECase(EM_H8_300H);
91   ECase(EM_H8S);
92   ECase(EM_H8_500);
93   ECase(EM_IA_64);
94   ECase(EM_MIPS_X);
95   ECase(EM_COLDFIRE);
96   ECase(EM_68HC12);
97   ECase(EM_MMA);
98   ECase(EM_PCP);
99   ECase(EM_NCPU);
100   ECase(EM_NDR1);
101   ECase(EM_STARCORE);
102   ECase(EM_ME16);
103   ECase(EM_ST100);
104   ECase(EM_TINYJ);
105   ECase(EM_X86_64);
106   ECase(EM_PDSP);
107   ECase(EM_PDP10);
108   ECase(EM_PDP11);
109   ECase(EM_FX66);
110   ECase(EM_ST9PLUS);
111   ECase(EM_ST7);
112   ECase(EM_68HC16);
113   ECase(EM_68HC11);
114   ECase(EM_68HC08);
115   ECase(EM_68HC05);
116   ECase(EM_SVX);
117   ECase(EM_ST19);
118   ECase(EM_VAX);
119   ECase(EM_CRIS);
120   ECase(EM_JAVELIN);
121   ECase(EM_FIREPATH);
122   ECase(EM_ZSP);
123   ECase(EM_MMIX);
124   ECase(EM_HUANY);
125   ECase(EM_PRISM);
126   ECase(EM_AVR);
127   ECase(EM_FR30);
128   ECase(EM_D10V);
129   ECase(EM_D30V);
130   ECase(EM_V850);
131   ECase(EM_M32R);
132   ECase(EM_MN10300);
133   ECase(EM_MN10200);
134   ECase(EM_PJ);
135   ECase(EM_OPENRISC);
136   ECase(EM_ARC_COMPACT);
137   ECase(EM_XTENSA);
138   ECase(EM_VIDEOCORE);
139   ECase(EM_TMM_GPP);
140   ECase(EM_NS32K);
141   ECase(EM_TPC);
142   ECase(EM_SNP1K);
143   ECase(EM_ST200);
144   ECase(EM_IP2K);
145   ECase(EM_MAX);
146   ECase(EM_CR);
147   ECase(EM_F2MC16);
148   ECase(EM_MSP430);
149   ECase(EM_BLACKFIN);
150   ECase(EM_SE_C33);
151   ECase(EM_SEP);
152   ECase(EM_ARCA);
153   ECase(EM_UNICORE);
154   ECase(EM_EXCESS);
155   ECase(EM_DXP);
156   ECase(EM_ALTERA_NIOS2);
157   ECase(EM_CRX);
158   ECase(EM_XGATE);
159   ECase(EM_C166);
160   ECase(EM_M16C);
161   ECase(EM_DSPIC30F);
162   ECase(EM_CE);
163   ECase(EM_M32C);
164   ECase(EM_TSK3000);
165   ECase(EM_RS08);
166   ECase(EM_SHARC);
167   ECase(EM_ECOG2);
168   ECase(EM_SCORE7);
169   ECase(EM_DSP24);
170   ECase(EM_VIDEOCORE3);
171   ECase(EM_LATTICEMICO32);
172   ECase(EM_SE_C17);
173   ECase(EM_TI_C6000);
174   ECase(EM_TI_C2000);
175   ECase(EM_TI_C5500);
176   ECase(EM_MMDSP_PLUS);
177   ECase(EM_CYPRESS_M8C);
178   ECase(EM_R32C);
179   ECase(EM_TRIMEDIA);
180   ECase(EM_HEXAGON);
181   ECase(EM_8051);
182   ECase(EM_STXP7X);
183   ECase(EM_NDS32);
184   ECase(EM_ECOG1);
185   ECase(EM_ECOG1X);
186   ECase(EM_MAXQ30);
187   ECase(EM_XIMO16);
188   ECase(EM_MANIK);
189   ECase(EM_CRAYNV2);
190   ECase(EM_RX);
191   ECase(EM_METAG);
192   ECase(EM_MCST_ELBRUS);
193   ECase(EM_ECOG16);
194   ECase(EM_CR16);
195   ECase(EM_ETPU);
196   ECase(EM_SLE9X);
197   ECase(EM_L10M);
198   ECase(EM_K10M);
199   ECase(EM_AARCH64);
200   ECase(EM_AVR32);
201   ECase(EM_STM8);
202   ECase(EM_TILE64);
203   ECase(EM_TILEPRO);
204   ECase(EM_CUDA);
205   ECase(EM_TILEGX);
206   ECase(EM_CLOUDSHIELD);
207   ECase(EM_COREA_1ST);
208   ECase(EM_COREA_2ND);
209   ECase(EM_ARC_COMPACT2);
210   ECase(EM_OPEN8);
211   ECase(EM_RL78);
212   ECase(EM_VIDEOCORE5);
213   ECase(EM_78KOR);
214   ECase(EM_56800EX);
215   ECase(EM_AMDGPU);
216   ECase(EM_RISCV);
217   ECase(EM_LANAI);
218   ECase(EM_BPF);
219 #undef ECase
220 }
221 
222 void ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS>::enumeration(
223     IO &IO, ELFYAML::ELF_ELFCLASS &Value) {
224 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
225   // Since the semantics of ELFCLASSNONE is "invalid", just don't accept it
226   // here.
227   ECase(ELFCLASS32);
228   ECase(ELFCLASS64);
229 #undef ECase
230 }
231 
232 void ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA>::enumeration(
233     IO &IO, ELFYAML::ELF_ELFDATA &Value) {
234 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
235   // Since the semantics of ELFDATANONE is "invalid", just don't accept it
236   // here.
237   ECase(ELFDATA2LSB);
238   ECase(ELFDATA2MSB);
239 #undef ECase
240 }
241 
242 void ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI>::enumeration(
243     IO &IO, ELFYAML::ELF_ELFOSABI &Value) {
244 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
245   ECase(ELFOSABI_NONE);
246   ECase(ELFOSABI_HPUX);
247   ECase(ELFOSABI_NETBSD);
248   ECase(ELFOSABI_GNU);
249   ECase(ELFOSABI_HURD);
250   ECase(ELFOSABI_SOLARIS);
251   ECase(ELFOSABI_AIX);
252   ECase(ELFOSABI_IRIX);
253   ECase(ELFOSABI_FREEBSD);
254   ECase(ELFOSABI_TRU64);
255   ECase(ELFOSABI_MODESTO);
256   ECase(ELFOSABI_OPENBSD);
257   ECase(ELFOSABI_OPENVMS);
258   ECase(ELFOSABI_NSK);
259   ECase(ELFOSABI_AROS);
260   ECase(ELFOSABI_FENIXOS);
261   ECase(ELFOSABI_CLOUDABI);
262   ECase(ELFOSABI_AMDGPU_HSA);
263   ECase(ELFOSABI_AMDGPU_PAL);
264   ECase(ELFOSABI_AMDGPU_MESA3D);
265   ECase(ELFOSABI_ARM);
266   ECase(ELFOSABI_C6000_ELFABI);
267   ECase(ELFOSABI_C6000_LINUX);
268   ECase(ELFOSABI_STANDALONE);
269 #undef ECase
270 }
271 
272 void ScalarBitSetTraits<ELFYAML::ELF_EF>::bitset(IO &IO,
273                                                  ELFYAML::ELF_EF &Value) {
274   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
275   assert(Object && "The IO context is not initialized");
276 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
277 #define BCaseMask(X, M) IO.maskedBitSetCase(Value, #X, ELF::X, ELF::M)
278   switch (Object->Header.Machine) {
279   case ELF::EM_ARM:
280     BCase(EF_ARM_SOFT_FLOAT);
281     BCase(EF_ARM_VFP_FLOAT);
282     BCaseMask(EF_ARM_EABI_UNKNOWN, EF_ARM_EABIMASK);
283     BCaseMask(EF_ARM_EABI_VER1, EF_ARM_EABIMASK);
284     BCaseMask(EF_ARM_EABI_VER2, EF_ARM_EABIMASK);
285     BCaseMask(EF_ARM_EABI_VER3, EF_ARM_EABIMASK);
286     BCaseMask(EF_ARM_EABI_VER4, EF_ARM_EABIMASK);
287     BCaseMask(EF_ARM_EABI_VER5, EF_ARM_EABIMASK);
288     break;
289   case ELF::EM_MIPS:
290     BCase(EF_MIPS_NOREORDER);
291     BCase(EF_MIPS_PIC);
292     BCase(EF_MIPS_CPIC);
293     BCase(EF_MIPS_ABI2);
294     BCase(EF_MIPS_32BITMODE);
295     BCase(EF_MIPS_FP64);
296     BCase(EF_MIPS_NAN2008);
297     BCase(EF_MIPS_MICROMIPS);
298     BCase(EF_MIPS_ARCH_ASE_M16);
299     BCase(EF_MIPS_ARCH_ASE_MDMX);
300     BCaseMask(EF_MIPS_ABI_O32, EF_MIPS_ABI);
301     BCaseMask(EF_MIPS_ABI_O64, EF_MIPS_ABI);
302     BCaseMask(EF_MIPS_ABI_EABI32, EF_MIPS_ABI);
303     BCaseMask(EF_MIPS_ABI_EABI64, EF_MIPS_ABI);
304     BCaseMask(EF_MIPS_MACH_3900, EF_MIPS_MACH);
305     BCaseMask(EF_MIPS_MACH_4010, EF_MIPS_MACH);
306     BCaseMask(EF_MIPS_MACH_4100, EF_MIPS_MACH);
307     BCaseMask(EF_MIPS_MACH_4650, EF_MIPS_MACH);
308     BCaseMask(EF_MIPS_MACH_4120, EF_MIPS_MACH);
309     BCaseMask(EF_MIPS_MACH_4111, EF_MIPS_MACH);
310     BCaseMask(EF_MIPS_MACH_SB1, EF_MIPS_MACH);
311     BCaseMask(EF_MIPS_MACH_OCTEON, EF_MIPS_MACH);
312     BCaseMask(EF_MIPS_MACH_XLR, EF_MIPS_MACH);
313     BCaseMask(EF_MIPS_MACH_OCTEON2, EF_MIPS_MACH);
314     BCaseMask(EF_MIPS_MACH_OCTEON3, EF_MIPS_MACH);
315     BCaseMask(EF_MIPS_MACH_5400, EF_MIPS_MACH);
316     BCaseMask(EF_MIPS_MACH_5900, EF_MIPS_MACH);
317     BCaseMask(EF_MIPS_MACH_5500, EF_MIPS_MACH);
318     BCaseMask(EF_MIPS_MACH_9000, EF_MIPS_MACH);
319     BCaseMask(EF_MIPS_MACH_LS2E, EF_MIPS_MACH);
320     BCaseMask(EF_MIPS_MACH_LS2F, EF_MIPS_MACH);
321     BCaseMask(EF_MIPS_MACH_LS3A, EF_MIPS_MACH);
322     BCaseMask(EF_MIPS_ARCH_1, EF_MIPS_ARCH);
323     BCaseMask(EF_MIPS_ARCH_2, EF_MIPS_ARCH);
324     BCaseMask(EF_MIPS_ARCH_3, EF_MIPS_ARCH);
325     BCaseMask(EF_MIPS_ARCH_4, EF_MIPS_ARCH);
326     BCaseMask(EF_MIPS_ARCH_5, EF_MIPS_ARCH);
327     BCaseMask(EF_MIPS_ARCH_32, EF_MIPS_ARCH);
328     BCaseMask(EF_MIPS_ARCH_64, EF_MIPS_ARCH);
329     BCaseMask(EF_MIPS_ARCH_32R2, EF_MIPS_ARCH);
330     BCaseMask(EF_MIPS_ARCH_64R2, EF_MIPS_ARCH);
331     BCaseMask(EF_MIPS_ARCH_32R6, EF_MIPS_ARCH);
332     BCaseMask(EF_MIPS_ARCH_64R6, EF_MIPS_ARCH);
333     break;
334   case ELF::EM_HEXAGON:
335     BCase(EF_HEXAGON_MACH_V2);
336     BCase(EF_HEXAGON_MACH_V3);
337     BCase(EF_HEXAGON_MACH_V4);
338     BCase(EF_HEXAGON_MACH_V5);
339     BCase(EF_HEXAGON_ISA_V2);
340     BCase(EF_HEXAGON_ISA_V3);
341     BCase(EF_HEXAGON_ISA_V4);
342     BCase(EF_HEXAGON_ISA_V5);
343     break;
344   case ELF::EM_AVR:
345     BCase(EF_AVR_ARCH_AVR1);
346     BCase(EF_AVR_ARCH_AVR2);
347     BCase(EF_AVR_ARCH_AVR25);
348     BCase(EF_AVR_ARCH_AVR3);
349     BCase(EF_AVR_ARCH_AVR31);
350     BCase(EF_AVR_ARCH_AVR35);
351     BCase(EF_AVR_ARCH_AVR4);
352     BCase(EF_AVR_ARCH_AVR51);
353     BCase(EF_AVR_ARCH_AVR6);
354     BCase(EF_AVR_ARCH_AVRTINY);
355     BCase(EF_AVR_ARCH_XMEGA1);
356     BCase(EF_AVR_ARCH_XMEGA2);
357     BCase(EF_AVR_ARCH_XMEGA3);
358     BCase(EF_AVR_ARCH_XMEGA4);
359     BCase(EF_AVR_ARCH_XMEGA5);
360     BCase(EF_AVR_ARCH_XMEGA6);
361     BCase(EF_AVR_ARCH_XMEGA7);
362     break;
363   case ELF::EM_RISCV:
364     BCase(EF_RISCV_RVC);
365     BCaseMask(EF_RISCV_FLOAT_ABI_SOFT, EF_RISCV_FLOAT_ABI);
366     BCaseMask(EF_RISCV_FLOAT_ABI_SINGLE, EF_RISCV_FLOAT_ABI);
367     BCaseMask(EF_RISCV_FLOAT_ABI_DOUBLE, EF_RISCV_FLOAT_ABI);
368     BCaseMask(EF_RISCV_FLOAT_ABI_QUAD, EF_RISCV_FLOAT_ABI);
369     BCase(EF_RISCV_RVE);
370     break;
371   case ELF::EM_AMDGPU:
372     BCaseMask(EF_AMDGPU_MACH_NONE, EF_AMDGPU_MACH);
373     BCaseMask(EF_AMDGPU_MACH_R600_R600, EF_AMDGPU_MACH);
374     BCaseMask(EF_AMDGPU_MACH_R600_R630, EF_AMDGPU_MACH);
375     BCaseMask(EF_AMDGPU_MACH_R600_RS880, EF_AMDGPU_MACH);
376     BCaseMask(EF_AMDGPU_MACH_R600_RV670, EF_AMDGPU_MACH);
377     BCaseMask(EF_AMDGPU_MACH_R600_RV710, EF_AMDGPU_MACH);
378     BCaseMask(EF_AMDGPU_MACH_R600_RV730, EF_AMDGPU_MACH);
379     BCaseMask(EF_AMDGPU_MACH_R600_RV770, EF_AMDGPU_MACH);
380     BCaseMask(EF_AMDGPU_MACH_R600_CEDAR, EF_AMDGPU_MACH);
381     BCaseMask(EF_AMDGPU_MACH_R600_CYPRESS, EF_AMDGPU_MACH);
382     BCaseMask(EF_AMDGPU_MACH_R600_JUNIPER, EF_AMDGPU_MACH);
383     BCaseMask(EF_AMDGPU_MACH_R600_REDWOOD, EF_AMDGPU_MACH);
384     BCaseMask(EF_AMDGPU_MACH_R600_SUMO, EF_AMDGPU_MACH);
385     BCaseMask(EF_AMDGPU_MACH_R600_BARTS, EF_AMDGPU_MACH);
386     BCaseMask(EF_AMDGPU_MACH_R600_CAICOS, EF_AMDGPU_MACH);
387     BCaseMask(EF_AMDGPU_MACH_R600_CAYMAN, EF_AMDGPU_MACH);
388     BCaseMask(EF_AMDGPU_MACH_R600_TURKS, EF_AMDGPU_MACH);
389     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX600, EF_AMDGPU_MACH);
390     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX601, EF_AMDGPU_MACH);
391     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX700, EF_AMDGPU_MACH);
392     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX701, EF_AMDGPU_MACH);
393     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX702, EF_AMDGPU_MACH);
394     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX703, EF_AMDGPU_MACH);
395     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX704, EF_AMDGPU_MACH);
396     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX801, EF_AMDGPU_MACH);
397     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX802, EF_AMDGPU_MACH);
398     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX803, EF_AMDGPU_MACH);
399     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX810, EF_AMDGPU_MACH);
400     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX900, EF_AMDGPU_MACH);
401     BCaseMask(EF_AMDGPU_MACH_AMDGCN_GFX902, EF_AMDGPU_MACH);
402     BCase(EF_AMDGPU_XNACK);
403     break;
404   case ELF::EM_X86_64:
405     break;
406   default:
407     llvm_unreachable("Unsupported architecture");
408   }
409 #undef BCase
410 #undef BCaseMask
411 }
412 
413 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
414     IO &IO, ELFYAML::ELF_SHT &Value) {
415   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
416   assert(Object && "The IO context is not initialized");
417 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
418   ECase(SHT_NULL);
419   ECase(SHT_PROGBITS);
420   ECase(SHT_SYMTAB);
421   // FIXME: Issue a diagnostic with this information.
422   ECase(SHT_STRTAB);
423   ECase(SHT_RELA);
424   ECase(SHT_HASH);
425   ECase(SHT_DYNAMIC);
426   ECase(SHT_NOTE);
427   ECase(SHT_NOBITS);
428   ECase(SHT_REL);
429   ECase(SHT_SHLIB);
430   ECase(SHT_DYNSYM);
431   ECase(SHT_INIT_ARRAY);
432   ECase(SHT_FINI_ARRAY);
433   ECase(SHT_PREINIT_ARRAY);
434   ECase(SHT_GROUP);
435   ECase(SHT_SYMTAB_SHNDX);
436   ECase(SHT_LOOS);
437   ECase(SHT_ANDROID_REL);
438   ECase(SHT_ANDROID_RELA);
439   ECase(SHT_LLVM_ODRTAB);
440   ECase(SHT_LLVM_LINKER_OPTIONS);
441   ECase(SHT_GNU_ATTRIBUTES);
442   ECase(SHT_GNU_HASH);
443   ECase(SHT_GNU_verdef);
444   ECase(SHT_GNU_verneed);
445   ECase(SHT_GNU_versym);
446   ECase(SHT_HIOS);
447   ECase(SHT_LOPROC);
448   switch (Object->Header.Machine) {
449   case ELF::EM_ARM:
450     ECase(SHT_ARM_EXIDX);
451     ECase(SHT_ARM_PREEMPTMAP);
452     ECase(SHT_ARM_ATTRIBUTES);
453     ECase(SHT_ARM_DEBUGOVERLAY);
454     ECase(SHT_ARM_OVERLAYSECTION);
455     break;
456   case ELF::EM_HEXAGON:
457     ECase(SHT_HEX_ORDERED);
458     break;
459   case ELF::EM_X86_64:
460     ECase(SHT_X86_64_UNWIND);
461     break;
462   case ELF::EM_MIPS:
463     ECase(SHT_MIPS_REGINFO);
464     ECase(SHT_MIPS_OPTIONS);
465     ECase(SHT_MIPS_ABIFLAGS);
466     break;
467   default:
468     // Nothing to do.
469     break;
470   }
471 #undef ECase
472 }
473 
474 void ScalarBitSetTraits<ELFYAML::ELF_PF>::bitset(IO &IO,
475                                                  ELFYAML::ELF_PF &Value) {
476 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
477   BCase(PF_X);
478   BCase(PF_W);
479   BCase(PF_R);
480 }
481 
482 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
483                                                   ELFYAML::ELF_SHF &Value) {
484   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
485 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
486   BCase(SHF_WRITE);
487   BCase(SHF_ALLOC);
488   BCase(SHF_EXCLUDE);
489   BCase(SHF_EXECINSTR);
490   BCase(SHF_MERGE);
491   BCase(SHF_STRINGS);
492   BCase(SHF_INFO_LINK);
493   BCase(SHF_LINK_ORDER);
494   BCase(SHF_OS_NONCONFORMING);
495   BCase(SHF_GROUP);
496   BCase(SHF_TLS);
497   BCase(SHF_COMPRESSED);
498   switch (Object->Header.Machine) {
499   case ELF::EM_ARM:
500     BCase(SHF_ARM_PURECODE);
501     break;
502   case ELF::EM_HEXAGON:
503     BCase(SHF_HEX_GPREL);
504     break;
505   case ELF::EM_MIPS:
506     BCase(SHF_MIPS_NODUPES);
507     BCase(SHF_MIPS_NAMES);
508     BCase(SHF_MIPS_LOCAL);
509     BCase(SHF_MIPS_NOSTRIP);
510     BCase(SHF_MIPS_GPREL);
511     BCase(SHF_MIPS_MERGE);
512     BCase(SHF_MIPS_ADDR);
513     BCase(SHF_MIPS_STRING);
514     break;
515   case ELF::EM_X86_64:
516     BCase(SHF_X86_64_LARGE);
517     break;
518   default:
519     // Nothing to do.
520     break;
521   }
522 #undef BCase
523 }
524 
525 void ScalarEnumerationTraits<ELFYAML::ELF_SHN>::enumeration(
526     IO &IO, ELFYAML::ELF_SHN &Value) {
527 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
528   ECase(SHN_UNDEF);
529   ECase(SHN_LORESERVE);
530   ECase(SHN_LOPROC);
531   ECase(SHN_HIPROC);
532   ECase(SHN_LOOS);
533   ECase(SHN_HIOS);
534   ECase(SHN_ABS);
535   ECase(SHN_COMMON);
536   ECase(SHN_XINDEX);
537   ECase(SHN_HIRESERVE);
538   ECase(SHN_HEXAGON_SCOMMON);
539   ECase(SHN_HEXAGON_SCOMMON_1);
540   ECase(SHN_HEXAGON_SCOMMON_2);
541   ECase(SHN_HEXAGON_SCOMMON_4);
542   ECase(SHN_HEXAGON_SCOMMON_8);
543 #undef ECase
544   IO.enumFallback<Hex32>(Value);
545 }
546 
547 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
548     IO &IO, ELFYAML::ELF_STT &Value) {
549 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
550   ECase(STT_NOTYPE);
551   ECase(STT_OBJECT);
552   ECase(STT_FUNC);
553   ECase(STT_SECTION);
554   ECase(STT_FILE);
555   ECase(STT_COMMON);
556   ECase(STT_TLS);
557   ECase(STT_GNU_IFUNC);
558 #undef ECase
559 }
560 
561 void ScalarEnumerationTraits<ELFYAML::ELF_STV>::enumeration(
562     IO &IO, ELFYAML::ELF_STV &Value) {
563 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
564   ECase(STV_DEFAULT);
565   ECase(STV_INTERNAL);
566   ECase(STV_HIDDEN);
567   ECase(STV_PROTECTED);
568 #undef ECase
569 }
570 
571 void ScalarBitSetTraits<ELFYAML::ELF_STO>::bitset(IO &IO,
572                                                   ELFYAML::ELF_STO &Value) {
573   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
574   assert(Object && "The IO context is not initialized");
575 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
576   switch (Object->Header.Machine) {
577   case ELF::EM_MIPS:
578     BCase(STO_MIPS_OPTIONAL);
579     BCase(STO_MIPS_PLT);
580     BCase(STO_MIPS_PIC);
581     BCase(STO_MIPS_MICROMIPS);
582     break;
583   default:
584     break; // Nothing to do
585   }
586 #undef BCase
587 #undef BCaseMask
588 }
589 
590 void ScalarEnumerationTraits<ELFYAML::ELF_RSS>::enumeration(
591     IO &IO, ELFYAML::ELF_RSS &Value) {
592 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
593   ECase(RSS_UNDEF);
594   ECase(RSS_GP);
595   ECase(RSS_GP0);
596   ECase(RSS_LOC);
597 #undef ECase
598 }
599 
600 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
601     IO &IO, ELFYAML::ELF_REL &Value) {
602   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
603   assert(Object && "The IO context is not initialized");
604 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
605   switch (Object->Header.Machine) {
606   case ELF::EM_X86_64:
607 #include "llvm/BinaryFormat/ELFRelocs/x86_64.def"
608     break;
609   case ELF::EM_MIPS:
610 #include "llvm/BinaryFormat/ELFRelocs/Mips.def"
611     break;
612   case ELF::EM_HEXAGON:
613 #include "llvm/BinaryFormat/ELFRelocs/Hexagon.def"
614     break;
615   case ELF::EM_386:
616   case ELF::EM_IAMCU:
617 #include "llvm/BinaryFormat/ELFRelocs/i386.def"
618     break;
619   case ELF::EM_AARCH64:
620 #include "llvm/BinaryFormat/ELFRelocs/AArch64.def"
621     break;
622   case ELF::EM_ARM:
623 #include "llvm/BinaryFormat/ELFRelocs/ARM.def"
624     break;
625   case ELF::EM_ARC:
626 #include "llvm/BinaryFormat/ELFRelocs/ARC.def"
627     break;
628   case ELF::EM_RISCV:
629 #include "llvm/BinaryFormat/ELFRelocs/RISCV.def"
630     break;
631   case ELF::EM_LANAI:
632 #include "llvm/BinaryFormat/ELFRelocs/Lanai.def"
633     break;
634   case ELF::EM_AMDGPU:
635 #include "llvm/BinaryFormat/ELFRelocs/AMDGPU.def"
636     break;
637   case ELF::EM_BPF:
638 #include "llvm/BinaryFormat/ELFRelocs/BPF.def"
639     break;
640   default:
641     llvm_unreachable("Unsupported architecture");
642   }
643 #undef ELF_RELOC
644   IO.enumFallback<Hex32>(Value);
645 }
646 
647 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG>::enumeration(
648     IO &IO, ELFYAML::MIPS_AFL_REG &Value) {
649 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
650   ECase(REG_NONE);
651   ECase(REG_32);
652   ECase(REG_64);
653   ECase(REG_128);
654 #undef ECase
655 }
656 
657 void ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP>::enumeration(
658     IO &IO, ELFYAML::MIPS_ABI_FP &Value) {
659 #define ECase(X) IO.enumCase(Value, #X, Mips::Val_GNU_MIPS_ABI_##X)
660   ECase(FP_ANY);
661   ECase(FP_DOUBLE);
662   ECase(FP_SINGLE);
663   ECase(FP_SOFT);
664   ECase(FP_OLD_64);
665   ECase(FP_XX);
666   ECase(FP_64);
667   ECase(FP_64A);
668 #undef ECase
669 }
670 
671 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT>::enumeration(
672     IO &IO, ELFYAML::MIPS_AFL_EXT &Value) {
673 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
674   ECase(EXT_NONE);
675   ECase(EXT_XLR);
676   ECase(EXT_OCTEON2);
677   ECase(EXT_OCTEONP);
678   ECase(EXT_LOONGSON_3A);
679   ECase(EXT_OCTEON);
680   ECase(EXT_5900);
681   ECase(EXT_4650);
682   ECase(EXT_4010);
683   ECase(EXT_4100);
684   ECase(EXT_3900);
685   ECase(EXT_10000);
686   ECase(EXT_SB1);
687   ECase(EXT_4111);
688   ECase(EXT_4120);
689   ECase(EXT_5400);
690   ECase(EXT_5500);
691   ECase(EXT_LOONGSON_2E);
692   ECase(EXT_LOONGSON_2F);
693   ECase(EXT_OCTEON3);
694 #undef ECase
695 }
696 
697 void ScalarEnumerationTraits<ELFYAML::MIPS_ISA>::enumeration(
698     IO &IO, ELFYAML::MIPS_ISA &Value) {
699   IO.enumCase(Value, "MIPS1", 1);
700   IO.enumCase(Value, "MIPS2", 2);
701   IO.enumCase(Value, "MIPS3", 3);
702   IO.enumCase(Value, "MIPS4", 4);
703   IO.enumCase(Value, "MIPS5", 5);
704   IO.enumCase(Value, "MIPS32", 32);
705   IO.enumCase(Value, "MIPS64", 64);
706 }
707 
708 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE>::bitset(
709     IO &IO, ELFYAML::MIPS_AFL_ASE &Value) {
710 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_ASE_##X)
711   BCase(DSP);
712   BCase(DSPR2);
713   BCase(EVA);
714   BCase(MCU);
715   BCase(MDMX);
716   BCase(MIPS3D);
717   BCase(MT);
718   BCase(SMARTMIPS);
719   BCase(VIRT);
720   BCase(MSA);
721   BCase(MIPS16);
722   BCase(MICROMIPS);
723   BCase(XPA);
724 #undef BCase
725 }
726 
727 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1>::bitset(
728     IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value) {
729 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_FLAGS1_##X)
730   BCase(ODDSPREG);
731 #undef BCase
732 }
733 
734 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
735                                                  ELFYAML::FileHeader &FileHdr) {
736   IO.mapRequired("Class", FileHdr.Class);
737   IO.mapRequired("Data", FileHdr.Data);
738   IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
739   IO.mapRequired("Type", FileHdr.Type);
740   IO.mapRequired("Machine", FileHdr.Machine);
741   IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
742   IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
743 }
744 
745 void MappingTraits<ELFYAML::ProgramHeader>::mapping(
746     IO &IO, ELFYAML::ProgramHeader &Phdr) {
747   IO.mapRequired("Type", Phdr.Type);
748   IO.mapOptional("Flags", Phdr.Flags, ELFYAML::ELF_PF(0));
749   IO.mapOptional("Sections", Phdr.Sections);
750   IO.mapOptional("VAddr", Phdr.VAddr, Hex64(0));
751   IO.mapOptional("PAddr", Phdr.PAddr, Hex64(0));
752   IO.mapOptional("Align", Phdr.Align);
753 }
754 
755 namespace {
756 
757 struct NormalizedOther {
758   NormalizedOther(IO &)
759       : Visibility(ELFYAML::ELF_STV(0)), Other(ELFYAML::ELF_STO(0)) {}
760   NormalizedOther(IO &, uint8_t Original)
761       : Visibility(Original & 0x3), Other(Original & ~0x3) {}
762 
763   uint8_t denormalize(IO &) { return Visibility | Other; }
764 
765   ELFYAML::ELF_STV Visibility;
766   ELFYAML::ELF_STO Other;
767 };
768 
769 } // end anonymous namespace
770 
771 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
772   IO.mapOptional("Name", Symbol.Name, StringRef());
773   IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
774   IO.mapOptional("Section", Symbol.Section, StringRef());
775   IO.mapOptional("Index", Symbol.Index);
776   IO.mapOptional("Value", Symbol.Value, Hex64(0));
777   IO.mapOptional("Size", Symbol.Size, Hex64(0));
778 
779   MappingNormalization<NormalizedOther, uint8_t> Keys(IO, Symbol.Other);
780   IO.mapOptional("Visibility", Keys->Visibility, ELFYAML::ELF_STV(0));
781   IO.mapOptional("Other", Keys->Other, ELFYAML::ELF_STO(0));
782 }
783 
784 StringRef MappingTraits<ELFYAML::Symbol>::validate(IO &IO,
785                                                    ELFYAML::Symbol &Symbol) {
786   if (Symbol.Index && Symbol.Section.data()) {
787     return "Index and Section cannot both be specified for Symbol";
788   }
789   if (Symbol.Index && *Symbol.Index == ELFYAML::ELF_SHN(ELF::SHN_XINDEX)) {
790     return "Large indexes are not supported";
791   }
792   if (Symbol.Index && *Symbol.Index < ELFYAML::ELF_SHN(ELF::SHN_LORESERVE)) {
793     return "Use a section name to define which section a symbol is defined in";
794   }
795   return StringRef();
796 }
797 
798 void MappingTraits<ELFYAML::LocalGlobalWeakSymbols>::mapping(
799     IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols) {
800   IO.mapOptional("Local", Symbols.Local);
801   IO.mapOptional("Global", Symbols.Global);
802   IO.mapOptional("Weak", Symbols.Weak);
803 }
804 
805 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
806   IO.mapOptional("Name", Section.Name, StringRef());
807   IO.mapRequired("Type", Section.Type);
808   IO.mapOptional("Flags", Section.Flags, ELFYAML::ELF_SHF(0));
809   IO.mapOptional("Address", Section.Address, Hex64(0));
810   IO.mapOptional("Link", Section.Link, StringRef());
811   IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
812   IO.mapOptional("Info", Section.Info, StringRef());
813 }
814 
815 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
816   commonSectionMapping(IO, Section);
817   IO.mapOptional("Content", Section.Content);
818   IO.mapOptional("Size", Section.Size, Hex64(Section.Content.binary_size()));
819 }
820 
821 static void sectionMapping(IO &IO, ELFYAML::NoBitsSection &Section) {
822   commonSectionMapping(IO, Section);
823   IO.mapOptional("Size", Section.Size, Hex64(0));
824 }
825 
826 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
827   commonSectionMapping(IO, Section);
828   IO.mapOptional("Relocations", Section.Relocations);
829 }
830 
831 static void groupSectionMapping(IO &IO, ELFYAML::Group &group) {
832   commonSectionMapping(IO, group);
833   IO.mapRequired("Members", group.Members);
834 }
835 
836 void MappingTraits<ELFYAML::SectionOrType>::mapping(
837     IO &IO, ELFYAML::SectionOrType &sectionOrType) {
838   IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
839 }
840 
841 void MappingTraits<ELFYAML::SectionName>::mapping(
842     IO &IO, ELFYAML::SectionName &sectionName) {
843   IO.mapRequired("Section", sectionName.Section);
844 }
845 
846 static void sectionMapping(IO &IO, ELFYAML::MipsABIFlags &Section) {
847   commonSectionMapping(IO, Section);
848   IO.mapOptional("Version", Section.Version, Hex16(0));
849   IO.mapRequired("ISA", Section.ISALevel);
850   IO.mapOptional("ISARevision", Section.ISARevision, Hex8(0));
851   IO.mapOptional("ISAExtension", Section.ISAExtension,
852                  ELFYAML::MIPS_AFL_EXT(Mips::AFL_EXT_NONE));
853   IO.mapOptional("ASEs", Section.ASEs, ELFYAML::MIPS_AFL_ASE(0));
854   IO.mapOptional("FpABI", Section.FpABI,
855                  ELFYAML::MIPS_ABI_FP(Mips::Val_GNU_MIPS_ABI_FP_ANY));
856   IO.mapOptional("GPRSize", Section.GPRSize,
857                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
858   IO.mapOptional("CPR1Size", Section.CPR1Size,
859                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
860   IO.mapOptional("CPR2Size", Section.CPR2Size,
861                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
862   IO.mapOptional("Flags1", Section.Flags1, ELFYAML::MIPS_AFL_FLAGS1(0));
863   IO.mapOptional("Flags2", Section.Flags2, Hex32(0));
864 }
865 
866 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
867     IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
868   ELFYAML::ELF_SHT sectionType;
869   if (IO.outputting())
870     sectionType = Section->Type;
871   else
872     IO.mapRequired("Type", sectionType);
873 
874   switch (sectionType) {
875   case ELF::SHT_REL:
876   case ELF::SHT_RELA:
877     if (!IO.outputting())
878       Section.reset(new ELFYAML::RelocationSection());
879     sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
880     break;
881   case ELF::SHT_GROUP:
882     if (!IO.outputting())
883       Section.reset(new ELFYAML::Group());
884     groupSectionMapping(IO, *cast<ELFYAML::Group>(Section.get()));
885     break;
886   case ELF::SHT_NOBITS:
887     if (!IO.outputting())
888       Section.reset(new ELFYAML::NoBitsSection());
889     sectionMapping(IO, *cast<ELFYAML::NoBitsSection>(Section.get()));
890     break;
891   case ELF::SHT_MIPS_ABIFLAGS:
892     if (!IO.outputting())
893       Section.reset(new ELFYAML::MipsABIFlags());
894     sectionMapping(IO, *cast<ELFYAML::MipsABIFlags>(Section.get()));
895     break;
896   default:
897     if (!IO.outputting())
898       Section.reset(new ELFYAML::RawContentSection());
899     sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
900   }
901 }
902 
903 StringRef MappingTraits<std::unique_ptr<ELFYAML::Section>>::validate(
904     IO &io, std::unique_ptr<ELFYAML::Section> &Section) {
905   const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(Section.get());
906   if (!RawSection || RawSection->Size >= RawSection->Content.binary_size())
907     return StringRef();
908   return "Section size must be greater or equal to the content size";
909 }
910 
911 namespace {
912 
913 struct NormalizedMips64RelType {
914   NormalizedMips64RelType(IO &)
915       : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
916         Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
917         Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
918         SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
919   NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
920       : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
921         Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
922 
923   ELFYAML::ELF_REL denormalize(IO &) {
924     ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
925     return Res;
926   }
927 
928   ELFYAML::ELF_REL Type;
929   ELFYAML::ELF_REL Type2;
930   ELFYAML::ELF_REL Type3;
931   ELFYAML::ELF_RSS SpecSym;
932 };
933 
934 } // end anonymous namespace
935 
936 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
937                                                  ELFYAML::Relocation &Rel) {
938   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
939   assert(Object && "The IO context is not initialized");
940 
941   IO.mapRequired("Offset", Rel.Offset);
942   IO.mapOptional("Symbol", Rel.Symbol);
943 
944   if (Object->Header.Machine == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
945       Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
946     MappingNormalization<NormalizedMips64RelType, ELFYAML::ELF_REL> Key(
947         IO, Rel.Type);
948     IO.mapRequired("Type", Key->Type);
949     IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
950     IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
951     IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
952   } else
953     IO.mapRequired("Type", Rel.Type);
954 
955   IO.mapOptional("Addend", Rel.Addend, (int64_t)0);
956 }
957 
958 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
959   assert(!IO.getContext() && "The IO context is initialized already");
960   IO.setContext(&Object);
961   IO.mapTag("!ELF", true);
962   IO.mapRequired("FileHeader", Object.Header);
963   IO.mapOptional("ProgramHeaders", Object.ProgramHeaders);
964   IO.mapOptional("Sections", Object.Sections);
965   IO.mapOptional("Symbols", Object.Symbols);
966   IO.mapOptional("DynamicSymbols", Object.DynamicSymbols);
967   IO.setContext(nullptr);
968 }
969 
970 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
971 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
972 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
973 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
974 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
975 
976 } // end namespace yaml
977 
978 } // end namespace llvm
979