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