1 //===- ELFYAML.cpp - ELF YAMLIO implementation ----------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines classes for handling the YAML representation of ELF.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Object/ELFYAML.h"
15 #include "llvm/Support/Casting.h"
19 ELFYAML::Section::~Section() {}
24 ScalarEnumerationTraits<ELFYAML::ELF_ET>::enumeration(IO &IO,
25 ELFYAML::ELF_ET &Value) {
26 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
36 ScalarEnumerationTraits<ELFYAML::ELF_EM>::enumeration(IO &IO,
37 ELFYAML::ELF_EM &Value) {
38 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
115 ECase(EM_ARC_COMPACT)
135 ECase(EM_ALTERA_NIOS2)
150 ECase(EM_LATTICEMICO32)
156 ECase(EM_CYPRESS_M8C)
171 ECase(EM_MCST_ELBRUS)
185 ECase(EM_CLOUDSHIELD)
188 ECase(EM_ARC_COMPACT2)
197 void ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS>::enumeration(
198 IO &IO, ELFYAML::ELF_ELFCLASS &Value) {
199 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
200 // Since the semantics of ELFCLASSNONE is "invalid", just don't accept it
207 void ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA>::enumeration(
208 IO &IO, ELFYAML::ELF_ELFDATA &Value) {
209 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
210 // Since the semantics of ELFDATANONE is "invalid", just don't accept it
217 void ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI>::enumeration(
218 IO &IO, ELFYAML::ELF_ELFOSABI &Value) {
219 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
222 ECase(ELFOSABI_NETBSD)
226 ECase(ELFOSABI_SOLARIS)
229 ECase(ELFOSABI_FREEBSD)
230 ECase(ELFOSABI_TRU64)
231 ECase(ELFOSABI_MODESTO)
232 ECase(ELFOSABI_OPENBSD)
233 ECase(ELFOSABI_OPENVMS)
236 ECase(ELFOSABI_FENIXOS)
237 ECase(ELFOSABI_C6000_ELFABI)
238 ECase(ELFOSABI_C6000_LINUX)
240 ECase(ELFOSABI_STANDALONE)
244 void ScalarBitSetTraits<ELFYAML::ELF_EF>::bitset(IO &IO,
245 ELFYAML::ELF_EF &Value) {
246 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
247 BCase(EF_ARM_SOFT_FLOAT)
248 BCase(EF_ARM_VFP_FLOAT)
249 BCase(EF_ARM_EABI_UNKNOWN)
250 BCase(EF_ARM_EABI_VER1)
251 BCase(EF_ARM_EABI_VER2)
252 BCase(EF_ARM_EABI_VER3)
253 BCase(EF_ARM_EABI_VER4)
254 BCase(EF_ARM_EABI_VER5)
255 BCase(EF_ARM_EABIMASK)
256 BCase(EF_MIPS_NOREORDER)
260 BCase(EF_MIPS_32BITMODE)
261 BCase(EF_MIPS_ABI_O32)
262 BCase(EF_MIPS_MICROMIPS)
263 BCase(EF_MIPS_ARCH_ASE_M16)
264 BCase(EF_MIPS_ARCH_1)
265 BCase(EF_MIPS_ARCH_2)
266 BCase(EF_MIPS_ARCH_3)
267 BCase(EF_MIPS_ARCH_4)
268 BCase(EF_MIPS_ARCH_5)
269 BCase(EF_MIPS_ARCH_32)
270 BCase(EF_MIPS_ARCH_64)
271 BCase(EF_MIPS_ARCH_32R2)
272 BCase(EF_MIPS_ARCH_64R2)
274 BCase(EF_HEXAGON_MACH_V2)
275 BCase(EF_HEXAGON_MACH_V3)
276 BCase(EF_HEXAGON_MACH_V4)
277 BCase(EF_HEXAGON_MACH_V5)
278 BCase(EF_HEXAGON_ISA_MACH)
279 BCase(EF_HEXAGON_ISA_V2)
280 BCase(EF_HEXAGON_ISA_V3)
281 BCase(EF_HEXAGON_ISA_V4)
282 BCase(EF_HEXAGON_ISA_V5)
286 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
287 IO &IO, ELFYAML::ELF_SHT &Value) {
288 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
291 // No SHT_SYMTAB. Use the top-level `Symbols` key instead.
292 // FIXME: Issue a diagnostic with this information.
302 ECase(SHT_INIT_ARRAY)
303 ECase(SHT_FINI_ARRAY)
304 ECase(SHT_PREINIT_ARRAY)
306 ECase(SHT_SYMTAB_SHNDX)
310 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
311 ELFYAML::ELF_SHF &Value) {
312 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
320 BCase(SHF_LINK_ORDER)
321 BCase(SHF_OS_NONCONFORMING)
327 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
328 IO &IO, ELFYAML::ELF_STT &Value) {
329 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
341 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
342 IO &IO, ELFYAML::ELF_REL &Value) {
343 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
344 assert(Object && "The IO context is not initialized");
345 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
346 switch (Object->Header.Machine) {
351 ECase(R_X86_64_GOT32)
352 ECase(R_X86_64_PLT32)
354 ECase(R_X86_64_GLOB_DAT)
355 ECase(R_X86_64_JUMP_SLOT)
356 ECase(R_X86_64_RELATIVE)
357 ECase(R_X86_64_GOTPCREL)
364 ECase(R_X86_64_DTPMOD64)
365 ECase(R_X86_64_DTPOFF64)
366 ECase(R_X86_64_TPOFF64)
367 ECase(R_X86_64_TLSGD)
368 ECase(R_X86_64_TLSLD)
369 ECase(R_X86_64_DTPOFF32)
370 ECase(R_X86_64_GOTTPOFF)
371 ECase(R_X86_64_TPOFF32)
373 ECase(R_X86_64_GOTOFF64)
374 ECase(R_X86_64_GOTPC32)
375 ECase(R_X86_64_GOT64)
376 ECase(R_X86_64_GOTPCREL64)
377 ECase(R_X86_64_GOTPC64)
378 ECase(R_X86_64_GOTPLT64)
379 ECase(R_X86_64_PLTOFF64)
380 ECase(R_X86_64_SIZE32)
381 ECase(R_X86_64_SIZE64)
382 ECase(R_X86_64_GOTPC32_TLSDESC)
383 ECase(R_X86_64_TLSDESC_CALL)
384 ECase(R_X86_64_TLSDESC)
385 ECase(R_X86_64_IRELATIVE)
395 ECase(R_MIPS_GPREL16)
396 ECase(R_MIPS_LITERAL)
400 ECase(R_MIPS_GPREL32)
401 ECase(R_MIPS_UNUSED1)
402 ECase(R_MIPS_UNUSED2)
406 ECase(R_MIPS_GOT_DISP)
407 ECase(R_MIPS_GOT_PAGE)
408 ECase(R_MIPS_GOT_OFST)
409 ECase(R_MIPS_GOT_HI16)
410 ECase(R_MIPS_GOT_LO16)
412 ECase(R_MIPS_INSERT_A)
413 ECase(R_MIPS_INSERT_B)
416 ECase(R_MIPS_HIGHEST)
417 ECase(R_MIPS_CALL_HI16)
418 ECase(R_MIPS_CALL_LO16)
419 ECase(R_MIPS_SCN_DISP)
421 ECase(R_MIPS_ADD_IMMEDIATE)
425 ECase(R_MIPS_TLS_DTPMOD32)
426 ECase(R_MIPS_TLS_DTPREL32)
427 ECase(R_MIPS_TLS_DTPMOD64)
428 ECase(R_MIPS_TLS_DTPREL64)
430 ECase(R_MIPS_TLS_LDM)
431 ECase(R_MIPS_TLS_DTPREL_HI16)
432 ECase(R_MIPS_TLS_DTPREL_LO16)
433 ECase(R_MIPS_TLS_GOTTPREL)
434 ECase(R_MIPS_TLS_TPREL32)
435 ECase(R_MIPS_TLS_TPREL64)
436 ECase(R_MIPS_TLS_TPREL_HI16)
437 ECase(R_MIPS_TLS_TPREL_LO16)
438 ECase(R_MIPS_GLOB_DAT)
440 ECase(R_MIPS_JUMP_SLOT)
441 ECase(R_MICROMIPS_26_S1)
442 ECase(R_MICROMIPS_HI16)
443 ECase(R_MICROMIPS_LO16)
444 ECase(R_MICROMIPS_GOT16)
445 ECase(R_MICROMIPS_PC16_S1)
446 ECase(R_MICROMIPS_CALL16)
447 ECase(R_MICROMIPS_GOT_DISP)
448 ECase(R_MICROMIPS_GOT_PAGE)
449 ECase(R_MICROMIPS_GOT_OFST)
450 ECase(R_MICROMIPS_TLS_GD)
451 ECase(R_MICROMIPS_TLS_LDM)
452 ECase(R_MICROMIPS_TLS_DTPREL_HI16)
453 ECase(R_MICROMIPS_TLS_DTPREL_LO16)
454 ECase(R_MICROMIPS_TLS_TPREL_HI16)
455 ECase(R_MICROMIPS_TLS_TPREL_LO16)
459 case ELF::EM_HEXAGON:
461 ECase(R_HEX_B22_PCREL)
462 ECase(R_HEX_B15_PCREL)
463 ECase(R_HEX_B7_PCREL)
469 ECase(R_HEX_GPREL16_0)
470 ECase(R_HEX_GPREL16_1)
471 ECase(R_HEX_GPREL16_2)
472 ECase(R_HEX_GPREL16_3)
474 ECase(R_HEX_B13_PCREL)
475 ECase(R_HEX_B9_PCREL)
476 ECase(R_HEX_B32_PCREL_X)
478 ECase(R_HEX_B22_PCREL_X)
479 ECase(R_HEX_B15_PCREL_X)
480 ECase(R_HEX_B13_PCREL_X)
481 ECase(R_HEX_B9_PCREL_X)
482 ECase(R_HEX_B7_PCREL_X)
491 ECase(R_HEX_32_PCREL)
493 ECase(R_HEX_GLOB_DAT)
494 ECase(R_HEX_JMP_SLOT)
495 ECase(R_HEX_RELATIVE)
496 ECase(R_HEX_PLT_B22_PCREL)
497 ECase(R_HEX_GOTREL_LO16)
498 ECase(R_HEX_GOTREL_HI16)
499 ECase(R_HEX_GOTREL_32)
500 ECase(R_HEX_GOT_LO16)
501 ECase(R_HEX_GOT_HI16)
504 ECase(R_HEX_DTPMOD_32)
505 ECase(R_HEX_DTPREL_LO16)
506 ECase(R_HEX_DTPREL_HI16)
507 ECase(R_HEX_DTPREL_32)
508 ECase(R_HEX_DTPREL_16)
509 ECase(R_HEX_GD_PLT_B22_PCREL)
510 ECase(R_HEX_GD_GOT_LO16)
511 ECase(R_HEX_GD_GOT_HI16)
512 ECase(R_HEX_GD_GOT_32)
513 ECase(R_HEX_GD_GOT_16)
517 ECase(R_HEX_IE_GOT_LO16)
518 ECase(R_HEX_IE_GOT_HI16)
519 ECase(R_HEX_IE_GOT_32)
520 ECase(R_HEX_IE_GOT_16)
521 ECase(R_HEX_TPREL_LO16)
522 ECase(R_HEX_TPREL_HI16)
523 ECase(R_HEX_TPREL_32)
524 ECase(R_HEX_TPREL_16)
525 ECase(R_HEX_6_PCREL_X)
526 ECase(R_HEX_GOTREL_32_6_X)
527 ECase(R_HEX_GOTREL_16_X)
528 ECase(R_HEX_GOTREL_11_X)
529 ECase(R_HEX_GOT_32_6_X)
530 ECase(R_HEX_GOT_16_X)
531 ECase(R_HEX_GOT_11_X)
532 ECase(R_HEX_DTPREL_32_6_X)
533 ECase(R_HEX_DTPREL_16_X)
534 ECase(R_HEX_DTPREL_11_X)
535 ECase(R_HEX_GD_GOT_32_6_X)
536 ECase(R_HEX_GD_GOT_16_X)
537 ECase(R_HEX_GD_GOT_11_X)
538 ECase(R_HEX_IE_32_6_X)
540 ECase(R_HEX_IE_GOT_32_6_X)
541 ECase(R_HEX_IE_GOT_16_X)
542 ECase(R_HEX_IE_GOT_11_X)
543 ECase(R_HEX_TPREL_32_6_X)
544 ECase(R_HEX_TPREL_16_X)
545 ECase(R_HEX_TPREL_11_X)
548 llvm_unreachable("Unsupported architecture");
553 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
554 ELFYAML::FileHeader &FileHdr) {
555 IO.mapRequired("Class", FileHdr.Class);
556 IO.mapRequired("Data", FileHdr.Data);
557 IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
558 IO.mapRequired("Type", FileHdr.Type);
559 IO.mapRequired("Machine", FileHdr.Machine);
560 IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
561 IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
564 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
565 IO.mapOptional("Name", Symbol.Name, StringRef());
566 IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
567 IO.mapOptional("Section", Symbol.Section, StringRef());
568 IO.mapOptional("Value", Symbol.Value, Hex64(0));
569 IO.mapOptional("Size", Symbol.Size, Hex64(0));
572 void MappingTraits<ELFYAML::LocalGlobalWeakSymbols>::mapping(
573 IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols) {
574 IO.mapOptional("Local", Symbols.Local);
575 IO.mapOptional("Global", Symbols.Global);
576 IO.mapOptional("Weak", Symbols.Weak);
579 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
580 IO.mapOptional("Name", Section.Name, StringRef());
581 IO.mapRequired("Type", Section.Type);
582 IO.mapOptional("Flags", Section.Flags, ELFYAML::ELF_SHF(0));
583 IO.mapOptional("Address", Section.Address, Hex64(0));
584 IO.mapOptional("Link", Section.Link);
585 IO.mapOptional("Info", Section.Info);
586 IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
589 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
590 commonSectionMapping(IO, Section);
591 IO.mapOptional("Content", Section.Content);
594 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
595 commonSectionMapping(IO, Section);
596 IO.mapOptional("Relocations", Section.Relocations);
599 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
600 IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
601 ELFYAML::ELF_SHT sectionType;
603 sectionType = Section->Type;
604 IO.mapRequired("Type", sectionType);
606 switch (sectionType) {
609 if (!IO.outputting())
610 Section.reset(new ELFYAML::RelocationSection());
611 sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
614 if (!IO.outputting())
615 Section.reset(new ELFYAML::RawContentSection());
616 sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
620 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
621 ELFYAML::Relocation &Rel) {
622 IO.mapRequired("Offset", Rel.Offset);
623 IO.mapRequired("Symbol", Rel.Symbol);
624 IO.mapRequired("Type", Rel.Type);
625 IO.mapOptional("Addend", Rel.Addend);
628 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
629 assert(!IO.getContext() && "The IO context is initialized already");
630 IO.setContext(&Object);
631 IO.mapRequired("FileHeader", Object.Header);
632 IO.mapOptional("Sections", Object.Sections);
633 IO.mapOptional("Symbols", Object.Symbols);
634 IO.setContext(nullptr);
637 } // end namespace yaml
638 } // end namespace llvm