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