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"
16 #include "llvm/Support/MipsABIFlags.h"
20 ELFYAML::Section::~Section() {}
25 ScalarEnumerationTraits<ELFYAML::ELF_ET>::enumeration(IO &IO,
26 ELFYAML::ELF_ET &Value) {
27 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
34 IO.enumFallback<Hex16>(Value);
38 ScalarEnumerationTraits<ELFYAML::ELF_EM>::enumeration(IO &IO,
39 ELFYAML::ELF_EM &Value) {
40 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
117 ECase(EM_ARC_COMPACT)
137 ECase(EM_ALTERA_NIOS2)
152 ECase(EM_LATTICEMICO32)
158 ECase(EM_CYPRESS_M8C)
173 ECase(EM_MCST_ELBRUS)
187 ECase(EM_CLOUDSHIELD)
190 ECase(EM_ARC_COMPACT2)
199 void ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS>::enumeration(
200 IO &IO, ELFYAML::ELF_ELFCLASS &Value) {
201 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
202 // Since the semantics of ELFCLASSNONE is "invalid", just don't accept it
209 void ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA>::enumeration(
210 IO &IO, ELFYAML::ELF_ELFDATA &Value) {
211 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
212 // Since the semantics of ELFDATANONE is "invalid", just don't accept it
219 void ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI>::enumeration(
220 IO &IO, ELFYAML::ELF_ELFOSABI &Value) {
221 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
224 ECase(ELFOSABI_NETBSD)
228 ECase(ELFOSABI_SOLARIS)
231 ECase(ELFOSABI_FREEBSD)
232 ECase(ELFOSABI_TRU64)
233 ECase(ELFOSABI_MODESTO)
234 ECase(ELFOSABI_OPENBSD)
235 ECase(ELFOSABI_OPENVMS)
238 ECase(ELFOSABI_FENIXOS)
239 ECase(ELFOSABI_CLOUDABI)
240 ECase(ELFOSABI_C6000_ELFABI)
241 ECase(ELFOSABI_C6000_LINUX)
243 ECase(ELFOSABI_STANDALONE)
247 void ScalarBitSetTraits<ELFYAML::ELF_EF>::bitset(IO &IO,
248 ELFYAML::ELF_EF &Value) {
249 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
250 assert(Object && "The IO context is not initialized");
251 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
252 #define BCaseMask(X, M) IO.maskedBitSetCase(Value, #X, ELF::X, ELF::M);
253 switch (Object->Header.Machine) {
255 BCase(EF_ARM_SOFT_FLOAT)
256 BCase(EF_ARM_VFP_FLOAT)
257 BCaseMask(EF_ARM_EABI_UNKNOWN, EF_ARM_EABIMASK)
258 BCaseMask(EF_ARM_EABI_VER1, EF_ARM_EABIMASK)
259 BCaseMask(EF_ARM_EABI_VER2, EF_ARM_EABIMASK)
260 BCaseMask(EF_ARM_EABI_VER3, EF_ARM_EABIMASK)
261 BCaseMask(EF_ARM_EABI_VER4, EF_ARM_EABIMASK)
262 BCaseMask(EF_ARM_EABI_VER5, EF_ARM_EABIMASK)
265 BCase(EF_MIPS_NOREORDER)
269 BCase(EF_MIPS_32BITMODE)
271 BCase(EF_MIPS_NAN2008)
272 BCase(EF_MIPS_MICROMIPS)
273 BCase(EF_MIPS_ARCH_ASE_M16)
274 BCase(EF_MIPS_ARCH_ASE_MDMX)
275 BCaseMask(EF_MIPS_ABI_O32, EF_MIPS_ABI)
276 BCaseMask(EF_MIPS_ABI_O64, EF_MIPS_ABI)
277 BCaseMask(EF_MIPS_ABI_EABI32, EF_MIPS_ABI)
278 BCaseMask(EF_MIPS_ABI_EABI64, EF_MIPS_ABI)
279 BCaseMask(EF_MIPS_MACH_3900, EF_MIPS_MACH)
280 BCaseMask(EF_MIPS_MACH_4010, EF_MIPS_MACH)
281 BCaseMask(EF_MIPS_MACH_4100, EF_MIPS_MACH)
282 BCaseMask(EF_MIPS_MACH_4650, EF_MIPS_MACH)
283 BCaseMask(EF_MIPS_MACH_4120, EF_MIPS_MACH)
284 BCaseMask(EF_MIPS_MACH_4111, EF_MIPS_MACH)
285 BCaseMask(EF_MIPS_MACH_SB1, EF_MIPS_MACH)
286 BCaseMask(EF_MIPS_MACH_OCTEON, EF_MIPS_MACH)
287 BCaseMask(EF_MIPS_MACH_XLR, EF_MIPS_MACH)
288 BCaseMask(EF_MIPS_MACH_OCTEON2, EF_MIPS_MACH)
289 BCaseMask(EF_MIPS_MACH_OCTEON3, EF_MIPS_MACH)
290 BCaseMask(EF_MIPS_MACH_5400, EF_MIPS_MACH)
291 BCaseMask(EF_MIPS_MACH_5900, EF_MIPS_MACH)
292 BCaseMask(EF_MIPS_MACH_5500, EF_MIPS_MACH)
293 BCaseMask(EF_MIPS_MACH_9000, EF_MIPS_MACH)
294 BCaseMask(EF_MIPS_MACH_LS2E, EF_MIPS_MACH)
295 BCaseMask(EF_MIPS_MACH_LS2F, EF_MIPS_MACH)
296 BCaseMask(EF_MIPS_MACH_LS3A, EF_MIPS_MACH)
297 BCaseMask(EF_MIPS_ARCH_1, EF_MIPS_ARCH)
298 BCaseMask(EF_MIPS_ARCH_2, EF_MIPS_ARCH)
299 BCaseMask(EF_MIPS_ARCH_3, EF_MIPS_ARCH)
300 BCaseMask(EF_MIPS_ARCH_4, EF_MIPS_ARCH)
301 BCaseMask(EF_MIPS_ARCH_5, EF_MIPS_ARCH)
302 BCaseMask(EF_MIPS_ARCH_32, EF_MIPS_ARCH)
303 BCaseMask(EF_MIPS_ARCH_64, EF_MIPS_ARCH)
304 BCaseMask(EF_MIPS_ARCH_32R2, EF_MIPS_ARCH)
305 BCaseMask(EF_MIPS_ARCH_64R2, EF_MIPS_ARCH)
306 BCaseMask(EF_MIPS_ARCH_32R6, EF_MIPS_ARCH)
307 BCaseMask(EF_MIPS_ARCH_64R6, EF_MIPS_ARCH)
309 case ELF::EM_HEXAGON:
310 BCase(EF_HEXAGON_MACH_V2)
311 BCase(EF_HEXAGON_MACH_V3)
312 BCase(EF_HEXAGON_MACH_V4)
313 BCase(EF_HEXAGON_MACH_V5)
314 BCase(EF_HEXAGON_ISA_V2)
315 BCase(EF_HEXAGON_ISA_V3)
316 BCase(EF_HEXAGON_ISA_V4)
317 BCase(EF_HEXAGON_ISA_V5)
320 llvm_unreachable("Unsupported architecture");
326 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
327 IO &IO, ELFYAML::ELF_SHT &Value) {
328 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
329 assert(Object && "The IO context is not initialized");
330 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
333 // No SHT_SYMTAB. Use the top-level `Symbols` key instead.
334 // FIXME: Issue a diagnostic with this information.
344 ECase(SHT_INIT_ARRAY)
345 ECase(SHT_FINI_ARRAY)
346 ECase(SHT_PREINIT_ARRAY)
348 ECase(SHT_SYMTAB_SHNDX)
350 ECase(SHT_GNU_ATTRIBUTES)
352 ECase(SHT_GNU_verdef)
353 ECase(SHT_GNU_verneed)
354 ECase(SHT_GNU_versym)
357 switch (Object->Header.Machine) {
360 ECase(SHT_ARM_PREEMPTMAP)
361 ECase(SHT_ARM_ATTRIBUTES)
362 ECase(SHT_ARM_DEBUGOVERLAY)
363 ECase(SHT_ARM_OVERLAYSECTION)
365 case ELF::EM_HEXAGON:
366 ECase(SHT_HEX_ORDERED)
369 ECase(SHT_X86_64_UNWIND)
372 ECase(SHT_MIPS_REGINFO)
373 ECase(SHT_MIPS_OPTIONS)
374 ECase(SHT_MIPS_ABIFLAGS)
383 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
384 ELFYAML::ELF_SHF &Value) {
385 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
393 BCase(SHF_LINK_ORDER)
394 BCase(SHF_OS_NONCONFORMING)
400 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
401 IO &IO, ELFYAML::ELF_STT &Value) {
402 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
414 void ScalarEnumerationTraits<ELFYAML::ELF_STV>::enumeration(
415 IO &IO, ELFYAML::ELF_STV &Value) {
416 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
424 void ScalarBitSetTraits<ELFYAML::ELF_STO>::bitset(IO &IO,
425 ELFYAML::ELF_STO &Value) {
426 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
427 assert(Object && "The IO context is not initialized");
428 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
429 switch (Object->Header.Machine) {
431 BCase(STO_MIPS_OPTIONAL)
434 BCase(STO_MIPS_MICROMIPS)
437 break; // Nothing to do
443 void ScalarEnumerationTraits<ELFYAML::ELF_RSS>::enumeration(
444 IO &IO, ELFYAML::ELF_RSS &Value) {
445 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
453 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
454 IO &IO, ELFYAML::ELF_REL &Value) {
455 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
456 assert(Object && "The IO context is not initialized");
457 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
458 switch (Object->Header.Machine) {
460 #include "llvm/Support/ELFRelocs/x86_64.def"
463 #include "llvm/Support/ELFRelocs/Mips.def"
465 case ELF::EM_HEXAGON:
466 #include "llvm/Support/ELFRelocs/Hexagon.def"
469 #include "llvm/Support/ELFRelocs/i386.def"
471 case ELF::EM_AARCH64:
472 #include "llvm/Support/ELFRelocs/AArch64.def"
475 #include "llvm/Support/ELFRelocs/ARM.def"
478 llvm_unreachable("Unsupported architecture");
483 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG>::enumeration(
484 IO &IO, ELFYAML::MIPS_AFL_REG &Value) {
485 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X);
493 void ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP>::enumeration(
494 IO &IO, ELFYAML::MIPS_ABI_FP &Value) {
495 #define ECase(X) IO.enumCase(Value, #X, Mips::Val_GNU_MIPS_ABI_##X);
507 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT>::enumeration(
508 IO &IO, ELFYAML::MIPS_AFL_EXT &Value) {
509 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X);
514 ECase(EXT_LOONGSON_3A)
527 ECase(EXT_LOONGSON_2E)
528 ECase(EXT_LOONGSON_2F)
533 void ScalarEnumerationTraits<ELFYAML::MIPS_ISA>::enumeration(
534 IO &IO, ELFYAML::MIPS_ISA &Value) {
535 IO.enumCase(Value, "MIPS1", 1);
536 IO.enumCase(Value, "MIPS2", 2);
537 IO.enumCase(Value, "MIPS3", 3);
538 IO.enumCase(Value, "MIPS4", 4);
539 IO.enumCase(Value, "MIPS5", 5);
540 IO.enumCase(Value, "MIPS32", 32);
541 IO.enumCase(Value, "MIPS64", 64);
544 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE>::bitset(
545 IO &IO, ELFYAML::MIPS_AFL_ASE &Value) {
546 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_ASE_##X);
563 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1>::bitset(
564 IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value) {
565 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_FLAGS1_##X);
570 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
571 ELFYAML::FileHeader &FileHdr) {
572 IO.mapRequired("Class", FileHdr.Class);
573 IO.mapRequired("Data", FileHdr.Data);
574 IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
575 IO.mapRequired("Type", FileHdr.Type);
576 IO.mapRequired("Machine", FileHdr.Machine);
577 IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
578 IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
582 struct NormalizedOther {
583 NormalizedOther(IO &)
584 : Visibility(ELFYAML::ELF_STV(0)), Other(ELFYAML::ELF_STO(0)) {}
585 NormalizedOther(IO &, uint8_t Original)
586 : Visibility(Original & 0x3), Other(Original & ~0x3) {}
588 uint8_t denormalize(IO &) { return Visibility | Other; }
590 ELFYAML::ELF_STV Visibility;
591 ELFYAML::ELF_STO Other;
595 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
596 IO.mapOptional("Name", Symbol.Name, StringRef());
597 IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
598 IO.mapOptional("Section", Symbol.Section, StringRef());
599 IO.mapOptional("Value", Symbol.Value, Hex64(0));
600 IO.mapOptional("Size", Symbol.Size, Hex64(0));
602 MappingNormalization<NormalizedOther, uint8_t> Keys(IO, Symbol.Other);
603 IO.mapOptional("Visibility", Keys->Visibility, ELFYAML::ELF_STV(0));
604 IO.mapOptional("Other", Keys->Other, ELFYAML::ELF_STO(0));
607 void MappingTraits<ELFYAML::LocalGlobalWeakSymbols>::mapping(
608 IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols) {
609 IO.mapOptional("Local", Symbols.Local);
610 IO.mapOptional("Global", Symbols.Global);
611 IO.mapOptional("Weak", Symbols.Weak);
614 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
615 IO.mapOptional("Name", Section.Name, StringRef());
616 IO.mapRequired("Type", Section.Type);
617 IO.mapOptional("Flags", Section.Flags, ELFYAML::ELF_SHF(0));
618 IO.mapOptional("Address", Section.Address, Hex64(0));
619 IO.mapOptional("Link", Section.Link, StringRef());
620 IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
621 IO.mapOptional("Info", Section.Info, StringRef());
624 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
625 commonSectionMapping(IO, Section);
626 IO.mapOptional("Content", Section.Content);
627 IO.mapOptional("Size", Section.Size, Hex64(Section.Content.binary_size()));
630 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
631 commonSectionMapping(IO, Section);
632 IO.mapOptional("Relocations", Section.Relocations);
635 static void groupSectionMapping(IO &IO, ELFYAML::Group &group) {
636 commonSectionMapping(IO, group);
637 IO.mapRequired("Members", group.Members);
640 void MappingTraits<ELFYAML::SectionOrType>::mapping(
641 IO &IO, ELFYAML::SectionOrType §ionOrType) {
642 IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
645 static void sectionMapping(IO &IO, ELFYAML::MipsABIFlags &Section) {
646 commonSectionMapping(IO, Section);
647 IO.mapOptional("Version", Section.Version, Hex16(0));
648 IO.mapRequired("ISA", Section.ISALevel);
649 IO.mapOptional("ISARevision", Section.ISARevision, Hex8(0));
650 IO.mapOptional("ISAExtension", Section.ISAExtension,
651 ELFYAML::MIPS_AFL_EXT(Mips::AFL_EXT_NONE));
652 IO.mapOptional("ASEs", Section.ASEs, ELFYAML::MIPS_AFL_ASE(0));
653 IO.mapOptional("FpABI", Section.FpABI,
654 ELFYAML::MIPS_ABI_FP(Mips::Val_GNU_MIPS_ABI_FP_ANY));
655 IO.mapOptional("GPRSize", Section.GPRSize,
656 ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
657 IO.mapOptional("CPR1Size", Section.CPR1Size,
658 ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
659 IO.mapOptional("CPR2Size", Section.CPR2Size,
660 ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
661 IO.mapOptional("Flags1", Section.Flags1, ELFYAML::MIPS_AFL_FLAGS1(0));
662 IO.mapOptional("Flags2", Section.Flags2, Hex32(0));
665 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
666 IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
667 ELFYAML::ELF_SHT sectionType;
669 sectionType = Section->Type;
671 IO.mapRequired("Type", sectionType);
673 switch (sectionType) {
676 if (!IO.outputting())
677 Section.reset(new ELFYAML::RelocationSection());
678 sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
681 if (!IO.outputting())
682 Section.reset(new ELFYAML::Group());
683 groupSectionMapping(IO, *cast<ELFYAML::Group>(Section.get()));
685 case ELF::SHT_MIPS_ABIFLAGS:
686 if (!IO.outputting())
687 Section.reset(new ELFYAML::MipsABIFlags());
688 sectionMapping(IO, *cast<ELFYAML::MipsABIFlags>(Section.get()));
691 if (!IO.outputting())
692 Section.reset(new ELFYAML::RawContentSection());
693 sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
697 StringRef MappingTraits<std::unique_ptr<ELFYAML::Section>>::validate(
698 IO &io, std::unique_ptr<ELFYAML::Section> &Section) {
699 const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(Section.get());
700 if (!RawSection || RawSection->Size >= RawSection->Content.binary_size())
702 return "Section size must be greater or equal to the content size";
706 struct NormalizedMips64RelType {
707 NormalizedMips64RelType(IO &)
708 : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
709 Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
710 Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
711 SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
712 NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
713 : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
714 Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
716 ELFYAML::ELF_REL denormalize(IO &) {
717 ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
721 ELFYAML::ELF_REL Type;
722 ELFYAML::ELF_REL Type2;
723 ELFYAML::ELF_REL Type3;
724 ELFYAML::ELF_RSS SpecSym;
728 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
729 ELFYAML::Relocation &Rel) {
730 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
731 assert(Object && "The IO context is not initialized");
733 IO.mapRequired("Offset", Rel.Offset);
734 IO.mapRequired("Symbol", Rel.Symbol);
736 if (Object->Header.Machine == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
737 Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
738 MappingNormalization<NormalizedMips64RelType, ELFYAML::ELF_REL> Key(
740 IO.mapRequired("Type", Key->Type);
741 IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
742 IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
743 IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
745 IO.mapRequired("Type", Rel.Type);
747 IO.mapOptional("Addend", Rel.Addend, (int64_t)0);
750 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
751 assert(!IO.getContext() && "The IO context is initialized already");
752 IO.setContext(&Object);
753 IO.mapRequired("FileHeader", Object.Header);
754 IO.mapOptional("Sections", Object.Sections);
755 IO.mapOptional("Symbols", Object.Symbols);
756 IO.setContext(nullptr);
759 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
760 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
761 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
762 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
763 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
765 } // end namespace yaml
766 } // end namespace llvm