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