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 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
247 assert(Object && "The IO context is not initialized");
248 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
249 #define BCaseMask(X, M) IO.maskedBitSetCase(Value, #X, ELF::X, ELF::M);
250 switch (Object->Header.Machine) {
252 BCase(EF_ARM_SOFT_FLOAT)
253 BCase(EF_ARM_VFP_FLOAT)
254 BCaseMask(EF_ARM_EABI_UNKNOWN, EF_ARM_EABIMASK)
255 BCaseMask(EF_ARM_EABI_VER1, EF_ARM_EABIMASK)
256 BCaseMask(EF_ARM_EABI_VER2, EF_ARM_EABIMASK)
257 BCaseMask(EF_ARM_EABI_VER3, EF_ARM_EABIMASK)
258 BCaseMask(EF_ARM_EABI_VER4, EF_ARM_EABIMASK)
259 BCaseMask(EF_ARM_EABI_VER5, EF_ARM_EABIMASK)
262 BCase(EF_MIPS_NOREORDER)
266 BCase(EF_MIPS_32BITMODE)
267 BCase(EF_MIPS_ABI_O32)
268 BCase(EF_MIPS_MICROMIPS)
269 BCase(EF_MIPS_ARCH_ASE_M16)
270 BCaseMask(EF_MIPS_ARCH_1, EF_MIPS_ARCH)
271 BCaseMask(EF_MIPS_ARCH_2, EF_MIPS_ARCH)
272 BCaseMask(EF_MIPS_ARCH_3, EF_MIPS_ARCH)
273 BCaseMask(EF_MIPS_ARCH_4, EF_MIPS_ARCH)
274 BCaseMask(EF_MIPS_ARCH_5, EF_MIPS_ARCH)
275 BCaseMask(EF_MIPS_ARCH_32, EF_MIPS_ARCH)
276 BCaseMask(EF_MIPS_ARCH_64, EF_MIPS_ARCH)
277 BCaseMask(EF_MIPS_ARCH_32R2, EF_MIPS_ARCH)
278 BCaseMask(EF_MIPS_ARCH_64R2, EF_MIPS_ARCH)
279 BCaseMask(EF_MIPS_ARCH_32R6, EF_MIPS_ARCH)
280 BCaseMask(EF_MIPS_ARCH_64R6, EF_MIPS_ARCH)
282 case ELF::EM_HEXAGON:
283 BCase(EF_HEXAGON_MACH_V2)
284 BCase(EF_HEXAGON_MACH_V3)
285 BCase(EF_HEXAGON_MACH_V4)
286 BCase(EF_HEXAGON_MACH_V5)
287 BCase(EF_HEXAGON_ISA_V2)
288 BCase(EF_HEXAGON_ISA_V3)
289 BCase(EF_HEXAGON_ISA_V4)
290 BCase(EF_HEXAGON_ISA_V5)
293 llvm_unreachable("Unsupported architecture");
299 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
300 IO &IO, ELFYAML::ELF_SHT &Value) {
301 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
302 assert(Object && "The IO context is not initialized");
303 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
306 // No SHT_SYMTAB. Use the top-level `Symbols` key instead.
307 // FIXME: Issue a diagnostic with this information.
317 ECase(SHT_INIT_ARRAY)
318 ECase(SHT_FINI_ARRAY)
319 ECase(SHT_PREINIT_ARRAY)
321 ECase(SHT_SYMTAB_SHNDX)
323 ECase(SHT_GNU_ATTRIBUTES)
325 ECase(SHT_GNU_verdef)
326 ECase(SHT_GNU_verneed)
327 ECase(SHT_GNU_versym)
330 switch (Object->Header.Machine) {
333 ECase(SHT_ARM_PREEMPTMAP)
334 ECase(SHT_ARM_ATTRIBUTES)
335 ECase(SHT_ARM_DEBUGOVERLAY)
336 ECase(SHT_ARM_OVERLAYSECTION)
338 case ELF::EM_HEXAGON:
339 ECase(SHT_HEX_ORDERED)
342 ECase(SHT_X86_64_UNWIND)
345 ECase(SHT_MIPS_REGINFO)
346 ECase(SHT_MIPS_OPTIONS)
354 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
355 ELFYAML::ELF_SHF &Value) {
356 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
364 BCase(SHF_LINK_ORDER)
365 BCase(SHF_OS_NONCONFORMING)
371 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
372 IO &IO, ELFYAML::ELF_STT &Value) {
373 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
385 void ScalarEnumerationTraits<ELFYAML::ELF_STV>::enumeration(
386 IO &IO, ELFYAML::ELF_STV &Value) {
387 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
395 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
396 IO &IO, ELFYAML::ELF_REL &Value) {
397 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
398 assert(Object && "The IO context is not initialized");
399 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
400 switch (Object->Header.Machine) {
405 ECase(R_X86_64_GOT32)
406 ECase(R_X86_64_PLT32)
408 ECase(R_X86_64_GLOB_DAT)
409 ECase(R_X86_64_JUMP_SLOT)
410 ECase(R_X86_64_RELATIVE)
411 ECase(R_X86_64_GOTPCREL)
418 ECase(R_X86_64_DTPMOD64)
419 ECase(R_X86_64_DTPOFF64)
420 ECase(R_X86_64_TPOFF64)
421 ECase(R_X86_64_TLSGD)
422 ECase(R_X86_64_TLSLD)
423 ECase(R_X86_64_DTPOFF32)
424 ECase(R_X86_64_GOTTPOFF)
425 ECase(R_X86_64_TPOFF32)
427 ECase(R_X86_64_GOTOFF64)
428 ECase(R_X86_64_GOTPC32)
429 ECase(R_X86_64_GOT64)
430 ECase(R_X86_64_GOTPCREL64)
431 ECase(R_X86_64_GOTPC64)
432 ECase(R_X86_64_GOTPLT64)
433 ECase(R_X86_64_PLTOFF64)
434 ECase(R_X86_64_SIZE32)
435 ECase(R_X86_64_SIZE64)
436 ECase(R_X86_64_GOTPC32_TLSDESC)
437 ECase(R_X86_64_TLSDESC_CALL)
438 ECase(R_X86_64_TLSDESC)
439 ECase(R_X86_64_IRELATIVE)
449 ECase(R_MIPS_GPREL16)
450 ECase(R_MIPS_LITERAL)
454 ECase(R_MIPS_GPREL32)
455 ECase(R_MIPS_UNUSED1)
456 ECase(R_MIPS_UNUSED2)
460 ECase(R_MIPS_GOT_DISP)
461 ECase(R_MIPS_GOT_PAGE)
462 ECase(R_MIPS_GOT_OFST)
463 ECase(R_MIPS_GOT_HI16)
464 ECase(R_MIPS_GOT_LO16)
466 ECase(R_MIPS_INSERT_A)
467 ECase(R_MIPS_INSERT_B)
470 ECase(R_MIPS_HIGHEST)
471 ECase(R_MIPS_CALL_HI16)
472 ECase(R_MIPS_CALL_LO16)
473 ECase(R_MIPS_SCN_DISP)
475 ECase(R_MIPS_ADD_IMMEDIATE)
479 ECase(R_MIPS_TLS_DTPMOD32)
480 ECase(R_MIPS_TLS_DTPREL32)
481 ECase(R_MIPS_TLS_DTPMOD64)
482 ECase(R_MIPS_TLS_DTPREL64)
484 ECase(R_MIPS_TLS_LDM)
485 ECase(R_MIPS_TLS_DTPREL_HI16)
486 ECase(R_MIPS_TLS_DTPREL_LO16)
487 ECase(R_MIPS_TLS_GOTTPREL)
488 ECase(R_MIPS_TLS_TPREL32)
489 ECase(R_MIPS_TLS_TPREL64)
490 ECase(R_MIPS_TLS_TPREL_HI16)
491 ECase(R_MIPS_TLS_TPREL_LO16)
492 ECase(R_MIPS_GLOB_DAT)
493 ECase(R_MIPS_PC21_S2)
494 ECase(R_MIPS_PC26_S2)
495 ECase(R_MIPS_PC18_S3)
496 ECase(R_MIPS_PC19_S2)
499 ECase(R_MIPS16_GOT16)
503 ECase(R_MIPS_JUMP_SLOT)
504 ECase(R_MICROMIPS_26_S1)
505 ECase(R_MICROMIPS_HI16)
506 ECase(R_MICROMIPS_LO16)
507 ECase(R_MICROMIPS_GOT16)
508 ECase(R_MICROMIPS_PC16_S1)
509 ECase(R_MICROMIPS_CALL16)
510 ECase(R_MICROMIPS_GOT_DISP)
511 ECase(R_MICROMIPS_GOT_PAGE)
512 ECase(R_MICROMIPS_GOT_OFST)
513 ECase(R_MICROMIPS_TLS_GD)
514 ECase(R_MICROMIPS_TLS_LDM)
515 ECase(R_MICROMIPS_TLS_DTPREL_HI16)
516 ECase(R_MICROMIPS_TLS_DTPREL_LO16)
517 ECase(R_MICROMIPS_TLS_TPREL_HI16)
518 ECase(R_MICROMIPS_TLS_TPREL_LO16)
522 case ELF::EM_HEXAGON:
524 ECase(R_HEX_B22_PCREL)
525 ECase(R_HEX_B15_PCREL)
526 ECase(R_HEX_B7_PCREL)
532 ECase(R_HEX_GPREL16_0)
533 ECase(R_HEX_GPREL16_1)
534 ECase(R_HEX_GPREL16_2)
535 ECase(R_HEX_GPREL16_3)
537 ECase(R_HEX_B13_PCREL)
538 ECase(R_HEX_B9_PCREL)
539 ECase(R_HEX_B32_PCREL_X)
541 ECase(R_HEX_B22_PCREL_X)
542 ECase(R_HEX_B15_PCREL_X)
543 ECase(R_HEX_B13_PCREL_X)
544 ECase(R_HEX_B9_PCREL_X)
545 ECase(R_HEX_B7_PCREL_X)
554 ECase(R_HEX_32_PCREL)
556 ECase(R_HEX_GLOB_DAT)
557 ECase(R_HEX_JMP_SLOT)
558 ECase(R_HEX_RELATIVE)
559 ECase(R_HEX_PLT_B22_PCREL)
560 ECase(R_HEX_GOTREL_LO16)
561 ECase(R_HEX_GOTREL_HI16)
562 ECase(R_HEX_GOTREL_32)
563 ECase(R_HEX_GOT_LO16)
564 ECase(R_HEX_GOT_HI16)
567 ECase(R_HEX_DTPMOD_32)
568 ECase(R_HEX_DTPREL_LO16)
569 ECase(R_HEX_DTPREL_HI16)
570 ECase(R_HEX_DTPREL_32)
571 ECase(R_HEX_DTPREL_16)
572 ECase(R_HEX_GD_PLT_B22_PCREL)
573 ECase(R_HEX_GD_GOT_LO16)
574 ECase(R_HEX_GD_GOT_HI16)
575 ECase(R_HEX_GD_GOT_32)
576 ECase(R_HEX_GD_GOT_16)
580 ECase(R_HEX_IE_GOT_LO16)
581 ECase(R_HEX_IE_GOT_HI16)
582 ECase(R_HEX_IE_GOT_32)
583 ECase(R_HEX_IE_GOT_16)
584 ECase(R_HEX_TPREL_LO16)
585 ECase(R_HEX_TPREL_HI16)
586 ECase(R_HEX_TPREL_32)
587 ECase(R_HEX_TPREL_16)
588 ECase(R_HEX_6_PCREL_X)
589 ECase(R_HEX_GOTREL_32_6_X)
590 ECase(R_HEX_GOTREL_16_X)
591 ECase(R_HEX_GOTREL_11_X)
592 ECase(R_HEX_GOT_32_6_X)
593 ECase(R_HEX_GOT_16_X)
594 ECase(R_HEX_GOT_11_X)
595 ECase(R_HEX_DTPREL_32_6_X)
596 ECase(R_HEX_DTPREL_16_X)
597 ECase(R_HEX_DTPREL_11_X)
598 ECase(R_HEX_GD_GOT_32_6_X)
599 ECase(R_HEX_GD_GOT_16_X)
600 ECase(R_HEX_GD_GOT_11_X)
601 ECase(R_HEX_IE_32_6_X)
603 ECase(R_HEX_IE_GOT_32_6_X)
604 ECase(R_HEX_IE_GOT_16_X)
605 ECase(R_HEX_IE_GOT_11_X)
606 ECase(R_HEX_TPREL_32_6_X)
607 ECase(R_HEX_TPREL_16_X)
608 ECase(R_HEX_TPREL_11_X)
617 ECase(R_386_GLOB_DAT)
618 ECase(R_386_JUMP_SLOT)
619 ECase(R_386_RELATIVE)
623 ECase(R_386_TLS_TPOFF)
625 ECase(R_386_TLS_GOTIE)
633 ECase(R_386_TLS_GD_32)
634 ECase(R_386_TLS_GD_PUSH)
635 ECase(R_386_TLS_GD_CALL)
636 ECase(R_386_TLS_GD_POP)
637 ECase(R_386_TLS_LDM_32)
638 ECase(R_386_TLS_LDM_PUSH)
639 ECase(R_386_TLS_LDM_CALL)
640 ECase(R_386_TLS_LDM_POP)
641 ECase(R_386_TLS_LDO_32)
642 ECase(R_386_TLS_IE_32)
643 ECase(R_386_TLS_LE_32)
644 ECase(R_386_TLS_DTPMOD32)
645 ECase(R_386_TLS_DTPOFF32)
646 ECase(R_386_TLS_TPOFF32)
647 ECase(R_386_TLS_GOTDESC)
648 ECase(R_386_TLS_DESC_CALL)
649 ECase(R_386_TLS_DESC)
650 ECase(R_386_IRELATIVE)
654 llvm_unreachable("Unsupported architecture");
659 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
660 ELFYAML::FileHeader &FileHdr) {
661 IO.mapRequired("Class", FileHdr.Class);
662 IO.mapRequired("Data", FileHdr.Data);
663 IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
664 IO.mapRequired("Type", FileHdr.Type);
665 IO.mapRequired("Machine", FileHdr.Machine);
666 IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
667 IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
670 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
671 IO.mapOptional("Name", Symbol.Name, StringRef());
672 IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
673 IO.mapOptional("Section", Symbol.Section, StringRef());
674 IO.mapOptional("Value", Symbol.Value, Hex64(0));
675 IO.mapOptional("Size", Symbol.Size, Hex64(0));
676 IO.mapOptional("Visibility", Symbol.Visibility, ELFYAML::ELF_STV(0));
679 void MappingTraits<ELFYAML::LocalGlobalWeakSymbols>::mapping(
680 IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols) {
681 IO.mapOptional("Local", Symbols.Local);
682 IO.mapOptional("Global", Symbols.Global);
683 IO.mapOptional("Weak", Symbols.Weak);
686 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
687 IO.mapOptional("Name", Section.Name, StringRef());
688 IO.mapRequired("Type", Section.Type);
689 IO.mapOptional("Flags", Section.Flags, ELFYAML::ELF_SHF(0));
690 IO.mapOptional("Address", Section.Address, Hex64(0));
691 IO.mapOptional("Link", Section.Link, StringRef());
692 IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
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()));
701 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
702 commonSectionMapping(IO, Section);
703 IO.mapOptional("Info", Section.Info, StringRef());
704 IO.mapOptional("Relocations", Section.Relocations);
707 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
708 IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
709 ELFYAML::ELF_SHT sectionType;
711 sectionType = Section->Type;
713 IO.mapRequired("Type", sectionType);
715 switch (sectionType) {
718 if (!IO.outputting())
719 Section.reset(new ELFYAML::RelocationSection());
720 sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
723 if (!IO.outputting())
724 Section.reset(new ELFYAML::RawContentSection());
725 sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
729 StringRef MappingTraits<std::unique_ptr<ELFYAML::Section>>::validate(
730 IO &io, std::unique_ptr<ELFYAML::Section> &Section) {
731 const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(Section.get());
732 if (!RawSection || RawSection->Size >= RawSection->Content.binary_size())
734 return "Section size must be greater or equal to the content size";
737 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
738 ELFYAML::Relocation &Rel) {
739 IO.mapRequired("Offset", Rel.Offset);
740 IO.mapRequired("Symbol", Rel.Symbol);
741 IO.mapRequired("Type", Rel.Type);
742 IO.mapOptional("Addend", Rel.Addend);
745 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
746 assert(!IO.getContext() && "The IO context is initialized already");
747 IO.setContext(&Object);
748 IO.mapRequired("FileHeader", Object.Header);
749 IO.mapOptional("Sections", Object.Sections);
750 IO.mapOptional("Symbols", Object.Symbols);
751 IO.setContext(nullptr);
754 } // end namespace yaml
755 } // end namespace llvm