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