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_ARCH_R600, EF_AMDGPU_ARCH);
373     BCaseMask(EF_AMDGPU_ARCH_GCN, EF_AMDGPU_ARCH);
374     break;
375   case ELF::EM_X86_64:
376     break;
377   default:
378     llvm_unreachable("Unsupported architecture");
379   }
380 #undef BCase
381 #undef BCaseMask
382 }
383 
384 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
385     IO &IO, ELFYAML::ELF_SHT &Value) {
386   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
387   assert(Object && "The IO context is not initialized");
388 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
389   ECase(SHT_NULL);
390   ECase(SHT_PROGBITS);
391   ECase(SHT_SYMTAB);
392   // FIXME: Issue a diagnostic with this information.
393   ECase(SHT_STRTAB);
394   ECase(SHT_RELA);
395   ECase(SHT_HASH);
396   ECase(SHT_DYNAMIC);
397   ECase(SHT_NOTE);
398   ECase(SHT_NOBITS);
399   ECase(SHT_REL);
400   ECase(SHT_SHLIB);
401   ECase(SHT_DYNSYM);
402   ECase(SHT_INIT_ARRAY);
403   ECase(SHT_FINI_ARRAY);
404   ECase(SHT_PREINIT_ARRAY);
405   ECase(SHT_GROUP);
406   ECase(SHT_SYMTAB_SHNDX);
407   ECase(SHT_LOOS);
408   ECase(SHT_ANDROID_REL);
409   ECase(SHT_ANDROID_RELA);
410   ECase(SHT_LLVM_ODRTAB);
411   ECase(SHT_LLVM_LINKER_OPTIONS);
412   ECase(SHT_GNU_ATTRIBUTES);
413   ECase(SHT_GNU_HASH);
414   ECase(SHT_GNU_verdef);
415   ECase(SHT_GNU_verneed);
416   ECase(SHT_GNU_versym);
417   ECase(SHT_HIOS);
418   ECase(SHT_LOPROC);
419   switch (Object->Header.Machine) {
420   case ELF::EM_ARM:
421     ECase(SHT_ARM_EXIDX);
422     ECase(SHT_ARM_PREEMPTMAP);
423     ECase(SHT_ARM_ATTRIBUTES);
424     ECase(SHT_ARM_DEBUGOVERLAY);
425     ECase(SHT_ARM_OVERLAYSECTION);
426     break;
427   case ELF::EM_HEXAGON:
428     ECase(SHT_HEX_ORDERED);
429     break;
430   case ELF::EM_X86_64:
431     ECase(SHT_X86_64_UNWIND);
432     break;
433   case ELF::EM_MIPS:
434     ECase(SHT_MIPS_REGINFO);
435     ECase(SHT_MIPS_OPTIONS);
436     ECase(SHT_MIPS_ABIFLAGS);
437     break;
438   default:
439     // Nothing to do.
440     break;
441   }
442 #undef ECase
443 }
444 
445 void ScalarBitSetTraits<ELFYAML::ELF_PF>::bitset(IO &IO,
446                                                  ELFYAML::ELF_PF &Value) {
447 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
448   BCase(PF_X);
449   BCase(PF_W);
450   BCase(PF_R);
451 }
452 
453 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
454                                                   ELFYAML::ELF_SHF &Value) {
455   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
456 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
457   BCase(SHF_WRITE);
458   BCase(SHF_ALLOC);
459   BCase(SHF_EXCLUDE);
460   BCase(SHF_EXECINSTR);
461   BCase(SHF_MERGE);
462   BCase(SHF_STRINGS);
463   BCase(SHF_INFO_LINK);
464   BCase(SHF_LINK_ORDER);
465   BCase(SHF_OS_NONCONFORMING);
466   BCase(SHF_GROUP);
467   BCase(SHF_TLS);
468   BCase(SHF_COMPRESSED);
469   switch (Object->Header.Machine) {
470   case ELF::EM_ARM:
471     BCase(SHF_ARM_PURECODE);
472     break;
473   case ELF::EM_HEXAGON:
474     BCase(SHF_HEX_GPREL);
475     break;
476   case ELF::EM_MIPS:
477     BCase(SHF_MIPS_NODUPES);
478     BCase(SHF_MIPS_NAMES);
479     BCase(SHF_MIPS_LOCAL);
480     BCase(SHF_MIPS_NOSTRIP);
481     BCase(SHF_MIPS_GPREL);
482     BCase(SHF_MIPS_MERGE);
483     BCase(SHF_MIPS_ADDR);
484     BCase(SHF_MIPS_STRING);
485     break;
486   case ELF::EM_X86_64:
487     BCase(SHF_X86_64_LARGE);
488     break;
489   default:
490     // Nothing to do.
491     break;
492   }
493 #undef BCase
494 }
495 
496 void ScalarEnumerationTraits<ELFYAML::ELF_SHN>::enumeration(
497     IO &IO, ELFYAML::ELF_SHN &Value) {
498 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
499   ECase(SHN_UNDEF);
500   ECase(SHN_LORESERVE);
501   ECase(SHN_LOPROC);
502   ECase(SHN_HIPROC);
503   ECase(SHN_LOOS);
504   ECase(SHN_HIOS);
505   ECase(SHN_ABS);
506   ECase(SHN_COMMON);
507   ECase(SHN_XINDEX);
508   ECase(SHN_HIRESERVE);
509   ECase(SHN_HEXAGON_SCOMMON);
510   ECase(SHN_HEXAGON_SCOMMON_1);
511   ECase(SHN_HEXAGON_SCOMMON_2);
512   ECase(SHN_HEXAGON_SCOMMON_4);
513   ECase(SHN_HEXAGON_SCOMMON_8);
514 #undef ECase
515   IO.enumFallback<Hex32>(Value);
516 }
517 
518 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
519     IO &IO, ELFYAML::ELF_STT &Value) {
520 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
521   ECase(STT_NOTYPE);
522   ECase(STT_OBJECT);
523   ECase(STT_FUNC);
524   ECase(STT_SECTION);
525   ECase(STT_FILE);
526   ECase(STT_COMMON);
527   ECase(STT_TLS);
528   ECase(STT_GNU_IFUNC);
529 #undef ECase
530 }
531 
532 void ScalarEnumerationTraits<ELFYAML::ELF_STV>::enumeration(
533     IO &IO, ELFYAML::ELF_STV &Value) {
534 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
535   ECase(STV_DEFAULT);
536   ECase(STV_INTERNAL);
537   ECase(STV_HIDDEN);
538   ECase(STV_PROTECTED);
539 #undef ECase
540 }
541 
542 void ScalarBitSetTraits<ELFYAML::ELF_STO>::bitset(IO &IO,
543                                                   ELFYAML::ELF_STO &Value) {
544   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
545   assert(Object && "The IO context is not initialized");
546 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X)
547   switch (Object->Header.Machine) {
548   case ELF::EM_MIPS:
549     BCase(STO_MIPS_OPTIONAL);
550     BCase(STO_MIPS_PLT);
551     BCase(STO_MIPS_PIC);
552     BCase(STO_MIPS_MICROMIPS);
553     break;
554   default:
555     break; // Nothing to do
556   }
557 #undef BCase
558 #undef BCaseMask
559 }
560 
561 void ScalarEnumerationTraits<ELFYAML::ELF_RSS>::enumeration(
562     IO &IO, ELFYAML::ELF_RSS &Value) {
563 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
564   ECase(RSS_UNDEF);
565   ECase(RSS_GP);
566   ECase(RSS_GP0);
567   ECase(RSS_LOC);
568 #undef ECase
569 }
570 
571 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
572     IO &IO, ELFYAML::ELF_REL &Value) {
573   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
574   assert(Object && "The IO context is not initialized");
575 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
576   switch (Object->Header.Machine) {
577   case ELF::EM_X86_64:
578 #include "llvm/BinaryFormat/ELFRelocs/x86_64.def"
579     break;
580   case ELF::EM_MIPS:
581 #include "llvm/BinaryFormat/ELFRelocs/Mips.def"
582     break;
583   case ELF::EM_HEXAGON:
584 #include "llvm/BinaryFormat/ELFRelocs/Hexagon.def"
585     break;
586   case ELF::EM_386:
587   case ELF::EM_IAMCU:
588 #include "llvm/BinaryFormat/ELFRelocs/i386.def"
589     break;
590   case ELF::EM_AARCH64:
591 #include "llvm/BinaryFormat/ELFRelocs/AArch64.def"
592     break;
593   case ELF::EM_ARM:
594 #include "llvm/BinaryFormat/ELFRelocs/ARM.def"
595     break;
596   case ELF::EM_ARC:
597 #include "llvm/BinaryFormat/ELFRelocs/ARC.def"
598     break;
599   case ELF::EM_RISCV:
600 #include "llvm/BinaryFormat/ELFRelocs/RISCV.def"
601     break;
602   case ELF::EM_LANAI:
603 #include "llvm/BinaryFormat/ELFRelocs/Lanai.def"
604     break;
605   case ELF::EM_AMDGPU:
606 #include "llvm/BinaryFormat/ELFRelocs/AMDGPU.def"
607     break;
608   case ELF::EM_BPF:
609 #include "llvm/BinaryFormat/ELFRelocs/BPF.def"
610     break;
611   default:
612     llvm_unreachable("Unsupported architecture");
613   }
614 #undef ELF_RELOC
615   IO.enumFallback<Hex32>(Value);
616 }
617 
618 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG>::enumeration(
619     IO &IO, ELFYAML::MIPS_AFL_REG &Value) {
620 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
621   ECase(REG_NONE);
622   ECase(REG_32);
623   ECase(REG_64);
624   ECase(REG_128);
625 #undef ECase
626 }
627 
628 void ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP>::enumeration(
629     IO &IO, ELFYAML::MIPS_ABI_FP &Value) {
630 #define ECase(X) IO.enumCase(Value, #X, Mips::Val_GNU_MIPS_ABI_##X)
631   ECase(FP_ANY);
632   ECase(FP_DOUBLE);
633   ECase(FP_SINGLE);
634   ECase(FP_SOFT);
635   ECase(FP_OLD_64);
636   ECase(FP_XX);
637   ECase(FP_64);
638   ECase(FP_64A);
639 #undef ECase
640 }
641 
642 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT>::enumeration(
643     IO &IO, ELFYAML::MIPS_AFL_EXT &Value) {
644 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X)
645   ECase(EXT_NONE);
646   ECase(EXT_XLR);
647   ECase(EXT_OCTEON2);
648   ECase(EXT_OCTEONP);
649   ECase(EXT_LOONGSON_3A);
650   ECase(EXT_OCTEON);
651   ECase(EXT_5900);
652   ECase(EXT_4650);
653   ECase(EXT_4010);
654   ECase(EXT_4100);
655   ECase(EXT_3900);
656   ECase(EXT_10000);
657   ECase(EXT_SB1);
658   ECase(EXT_4111);
659   ECase(EXT_4120);
660   ECase(EXT_5400);
661   ECase(EXT_5500);
662   ECase(EXT_LOONGSON_2E);
663   ECase(EXT_LOONGSON_2F);
664   ECase(EXT_OCTEON3);
665 #undef ECase
666 }
667 
668 void ScalarEnumerationTraits<ELFYAML::MIPS_ISA>::enumeration(
669     IO &IO, ELFYAML::MIPS_ISA &Value) {
670   IO.enumCase(Value, "MIPS1", 1);
671   IO.enumCase(Value, "MIPS2", 2);
672   IO.enumCase(Value, "MIPS3", 3);
673   IO.enumCase(Value, "MIPS4", 4);
674   IO.enumCase(Value, "MIPS5", 5);
675   IO.enumCase(Value, "MIPS32", 32);
676   IO.enumCase(Value, "MIPS64", 64);
677 }
678 
679 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE>::bitset(
680     IO &IO, ELFYAML::MIPS_AFL_ASE &Value) {
681 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_ASE_##X)
682   BCase(DSP);
683   BCase(DSPR2);
684   BCase(EVA);
685   BCase(MCU);
686   BCase(MDMX);
687   BCase(MIPS3D);
688   BCase(MT);
689   BCase(SMARTMIPS);
690   BCase(VIRT);
691   BCase(MSA);
692   BCase(MIPS16);
693   BCase(MICROMIPS);
694   BCase(XPA);
695 #undef BCase
696 }
697 
698 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1>::bitset(
699     IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value) {
700 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_FLAGS1_##X)
701   BCase(ODDSPREG);
702 #undef BCase
703 }
704 
705 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
706                                                  ELFYAML::FileHeader &FileHdr) {
707   IO.mapRequired("Class", FileHdr.Class);
708   IO.mapRequired("Data", FileHdr.Data);
709   IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
710   IO.mapRequired("Type", FileHdr.Type);
711   IO.mapRequired("Machine", FileHdr.Machine);
712   IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
713   IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
714 }
715 
716 void MappingTraits<ELFYAML::ProgramHeader>::mapping(
717     IO &IO, ELFYAML::ProgramHeader &Phdr) {
718   IO.mapRequired("Type", Phdr.Type);
719   IO.mapOptional("Flags", Phdr.Flags, ELFYAML::ELF_PF(0));
720   IO.mapOptional("Sections", Phdr.Sections);
721   IO.mapOptional("VAddr", Phdr.VAddr, Hex64(0));
722   IO.mapOptional("PAddr", Phdr.PAddr, Hex64(0));
723   IO.mapOptional("Align", Phdr.Align);
724 }
725 
726 namespace {
727 
728 struct NormalizedOther {
729   NormalizedOther(IO &)
730       : Visibility(ELFYAML::ELF_STV(0)), Other(ELFYAML::ELF_STO(0)) {}
731   NormalizedOther(IO &, uint8_t Original)
732       : Visibility(Original & 0x3), Other(Original & ~0x3) {}
733 
734   uint8_t denormalize(IO &) { return Visibility | Other; }
735 
736   ELFYAML::ELF_STV Visibility;
737   ELFYAML::ELF_STO Other;
738 };
739 
740 } // end anonymous namespace
741 
742 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
743   IO.mapOptional("Name", Symbol.Name, StringRef());
744   IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
745   IO.mapOptional("Section", Symbol.Section, StringRef());
746   IO.mapOptional("Index", Symbol.Index);
747   IO.mapOptional("Value", Symbol.Value, Hex64(0));
748   IO.mapOptional("Size", Symbol.Size, Hex64(0));
749 
750   MappingNormalization<NormalizedOther, uint8_t> Keys(IO, Symbol.Other);
751   IO.mapOptional("Visibility", Keys->Visibility, ELFYAML::ELF_STV(0));
752   IO.mapOptional("Other", Keys->Other, ELFYAML::ELF_STO(0));
753 }
754 
755 StringRef MappingTraits<ELFYAML::Symbol>::validate(IO &IO,
756                                                    ELFYAML::Symbol &Symbol) {
757   if (Symbol.Index && Symbol.Section.data()) {
758     return "Index and Section cannot both be specified for Symbol";
759   }
760   if (Symbol.Index && *Symbol.Index == ELFYAML::ELF_SHN(ELF::SHN_XINDEX)) {
761     return "Large indexes are not supported";
762   }
763   if (Symbol.Index && *Symbol.Index < ELFYAML::ELF_SHN(ELF::SHN_LORESERVE)) {
764     return "Use a section name to define which section a symbol is defined in";
765   }
766   return StringRef();
767 }
768 
769 void MappingTraits<ELFYAML::LocalGlobalWeakSymbols>::mapping(
770     IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols) {
771   IO.mapOptional("Local", Symbols.Local);
772   IO.mapOptional("Global", Symbols.Global);
773   IO.mapOptional("Weak", Symbols.Weak);
774 }
775 
776 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
777   IO.mapOptional("Name", Section.Name, StringRef());
778   IO.mapRequired("Type", Section.Type);
779   IO.mapOptional("Flags", Section.Flags, ELFYAML::ELF_SHF(0));
780   IO.mapOptional("Address", Section.Address, Hex64(0));
781   IO.mapOptional("Link", Section.Link, StringRef());
782   IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
783   IO.mapOptional("Info", Section.Info, StringRef());
784 }
785 
786 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
787   commonSectionMapping(IO, Section);
788   IO.mapOptional("Content", Section.Content);
789   IO.mapOptional("Size", Section.Size, Hex64(Section.Content.binary_size()));
790 }
791 
792 static void sectionMapping(IO &IO, ELFYAML::NoBitsSection &Section) {
793   commonSectionMapping(IO, Section);
794   IO.mapOptional("Size", Section.Size, Hex64(0));
795 }
796 
797 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
798   commonSectionMapping(IO, Section);
799   IO.mapOptional("Relocations", Section.Relocations);
800 }
801 
802 static void groupSectionMapping(IO &IO, ELFYAML::Group &group) {
803   commonSectionMapping(IO, group);
804   IO.mapRequired("Members", group.Members);
805 }
806 
807 void MappingTraits<ELFYAML::SectionOrType>::mapping(
808     IO &IO, ELFYAML::SectionOrType &sectionOrType) {
809   IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
810 }
811 
812 void MappingTraits<ELFYAML::SectionName>::mapping(
813     IO &IO, ELFYAML::SectionName &sectionName) {
814   IO.mapRequired("Section", sectionName.Section);
815 }
816 
817 static void sectionMapping(IO &IO, ELFYAML::MipsABIFlags &Section) {
818   commonSectionMapping(IO, Section);
819   IO.mapOptional("Version", Section.Version, Hex16(0));
820   IO.mapRequired("ISA", Section.ISALevel);
821   IO.mapOptional("ISARevision", Section.ISARevision, Hex8(0));
822   IO.mapOptional("ISAExtension", Section.ISAExtension,
823                  ELFYAML::MIPS_AFL_EXT(Mips::AFL_EXT_NONE));
824   IO.mapOptional("ASEs", Section.ASEs, ELFYAML::MIPS_AFL_ASE(0));
825   IO.mapOptional("FpABI", Section.FpABI,
826                  ELFYAML::MIPS_ABI_FP(Mips::Val_GNU_MIPS_ABI_FP_ANY));
827   IO.mapOptional("GPRSize", Section.GPRSize,
828                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
829   IO.mapOptional("CPR1Size", Section.CPR1Size,
830                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
831   IO.mapOptional("CPR2Size", Section.CPR2Size,
832                  ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
833   IO.mapOptional("Flags1", Section.Flags1, ELFYAML::MIPS_AFL_FLAGS1(0));
834   IO.mapOptional("Flags2", Section.Flags2, Hex32(0));
835 }
836 
837 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
838     IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
839   ELFYAML::ELF_SHT sectionType;
840   if (IO.outputting())
841     sectionType = Section->Type;
842   else
843     IO.mapRequired("Type", sectionType);
844 
845   switch (sectionType) {
846   case ELF::SHT_REL:
847   case ELF::SHT_RELA:
848     if (!IO.outputting())
849       Section.reset(new ELFYAML::RelocationSection());
850     sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
851     break;
852   case ELF::SHT_GROUP:
853     if (!IO.outputting())
854       Section.reset(new ELFYAML::Group());
855     groupSectionMapping(IO, *cast<ELFYAML::Group>(Section.get()));
856     break;
857   case ELF::SHT_NOBITS:
858     if (!IO.outputting())
859       Section.reset(new ELFYAML::NoBitsSection());
860     sectionMapping(IO, *cast<ELFYAML::NoBitsSection>(Section.get()));
861     break;
862   case ELF::SHT_MIPS_ABIFLAGS:
863     if (!IO.outputting())
864       Section.reset(new ELFYAML::MipsABIFlags());
865     sectionMapping(IO, *cast<ELFYAML::MipsABIFlags>(Section.get()));
866     break;
867   default:
868     if (!IO.outputting())
869       Section.reset(new ELFYAML::RawContentSection());
870     sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
871   }
872 }
873 
874 StringRef MappingTraits<std::unique_ptr<ELFYAML::Section>>::validate(
875     IO &io, std::unique_ptr<ELFYAML::Section> &Section) {
876   const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(Section.get());
877   if (!RawSection || RawSection->Size >= RawSection->Content.binary_size())
878     return StringRef();
879   return "Section size must be greater or equal to the content size";
880 }
881 
882 namespace {
883 
884 struct NormalizedMips64RelType {
885   NormalizedMips64RelType(IO &)
886       : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
887         Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
888         Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
889         SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
890   NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
891       : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
892         Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
893 
894   ELFYAML::ELF_REL denormalize(IO &) {
895     ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
896     return Res;
897   }
898 
899   ELFYAML::ELF_REL Type;
900   ELFYAML::ELF_REL Type2;
901   ELFYAML::ELF_REL Type3;
902   ELFYAML::ELF_RSS SpecSym;
903 };
904 
905 } // end anonymous namespace
906 
907 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
908                                                  ELFYAML::Relocation &Rel) {
909   const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
910   assert(Object && "The IO context is not initialized");
911 
912   IO.mapRequired("Offset", Rel.Offset);
913   IO.mapOptional("Symbol", Rel.Symbol);
914 
915   if (Object->Header.Machine == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
916       Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
917     MappingNormalization<NormalizedMips64RelType, ELFYAML::ELF_REL> Key(
918         IO, Rel.Type);
919     IO.mapRequired("Type", Key->Type);
920     IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
921     IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
922     IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
923   } else
924     IO.mapRequired("Type", Rel.Type);
925 
926   IO.mapOptional("Addend", Rel.Addend, (int64_t)0);
927 }
928 
929 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
930   assert(!IO.getContext() && "The IO context is initialized already");
931   IO.setContext(&Object);
932   IO.mapTag("!ELF", true);
933   IO.mapRequired("FileHeader", Object.Header);
934   IO.mapOptional("ProgramHeaders", Object.ProgramHeaders);
935   IO.mapOptional("Sections", Object.Sections);
936   IO.mapOptional("Symbols", Object.Symbols);
937   IO.mapOptional("DynamicSymbols", Object.DynamicSymbols);
938   IO.setContext(nullptr);
939 }
940 
941 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
942 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
943 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
944 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
945 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
946 
947 } // end namespace yaml
948 
949 } // end namespace llvm
950