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