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