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_ARCH_1, EF_MIPS_ARCH)
280 BCaseMask(EF_MIPS_ARCH_2, EF_MIPS_ARCH)
281 BCaseMask(EF_MIPS_ARCH_3, EF_MIPS_ARCH)
282 BCaseMask(EF_MIPS_ARCH_4, EF_MIPS_ARCH)
283 BCaseMask(EF_MIPS_ARCH_5, EF_MIPS_ARCH)
284 BCaseMask(EF_MIPS_ARCH_32, EF_MIPS_ARCH)
285 BCaseMask(EF_MIPS_ARCH_64, EF_MIPS_ARCH)
286 BCaseMask(EF_MIPS_ARCH_32R2, EF_MIPS_ARCH)
287 BCaseMask(EF_MIPS_ARCH_64R2, EF_MIPS_ARCH)
288 BCaseMask(EF_MIPS_ARCH_32R6, EF_MIPS_ARCH)
289 BCaseMask(EF_MIPS_ARCH_64R6, EF_MIPS_ARCH)
291 case ELF::EM_HEXAGON:
292 BCase(EF_HEXAGON_MACH_V2)
293 BCase(EF_HEXAGON_MACH_V3)
294 BCase(EF_HEXAGON_MACH_V4)
295 BCase(EF_HEXAGON_MACH_V5)
296 BCase(EF_HEXAGON_ISA_V2)
297 BCase(EF_HEXAGON_ISA_V3)
298 BCase(EF_HEXAGON_ISA_V4)
299 BCase(EF_HEXAGON_ISA_V5)
302 llvm_unreachable("Unsupported architecture");
308 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
309 IO &IO, ELFYAML::ELF_SHT &Value) {
310 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
311 assert(Object && "The IO context is not initialized");
312 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
315 // No SHT_SYMTAB. Use the top-level `Symbols` key instead.
316 // FIXME: Issue a diagnostic with this information.
326 ECase(SHT_INIT_ARRAY)
327 ECase(SHT_FINI_ARRAY)
328 ECase(SHT_PREINIT_ARRAY)
330 ECase(SHT_SYMTAB_SHNDX)
332 ECase(SHT_GNU_ATTRIBUTES)
334 ECase(SHT_GNU_verdef)
335 ECase(SHT_GNU_verneed)
336 ECase(SHT_GNU_versym)
339 switch (Object->Header.Machine) {
342 ECase(SHT_ARM_PREEMPTMAP)
343 ECase(SHT_ARM_ATTRIBUTES)
344 ECase(SHT_ARM_DEBUGOVERLAY)
345 ECase(SHT_ARM_OVERLAYSECTION)
347 case ELF::EM_HEXAGON:
348 ECase(SHT_HEX_ORDERED)
351 ECase(SHT_X86_64_UNWIND)
354 ECase(SHT_MIPS_REGINFO)
355 ECase(SHT_MIPS_OPTIONS)
356 ECase(SHT_MIPS_ABIFLAGS)
365 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
366 ELFYAML::ELF_SHF &Value) {
367 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
375 BCase(SHF_LINK_ORDER)
376 BCase(SHF_OS_NONCONFORMING)
382 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
383 IO &IO, ELFYAML::ELF_STT &Value) {
384 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
396 void ScalarEnumerationTraits<ELFYAML::ELF_STV>::enumeration(
397 IO &IO, ELFYAML::ELF_STV &Value) {
398 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
406 void ScalarBitSetTraits<ELFYAML::ELF_STO>::bitset(IO &IO,
407 ELFYAML::ELF_STO &Value) {
408 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
409 assert(Object && "The IO context is not initialized");
410 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
411 switch (Object->Header.Machine) {
413 BCase(STO_MIPS_OPTIONAL)
416 BCase(STO_MIPS_MICROMIPS)
419 break; // Nothing to do
425 void ScalarEnumerationTraits<ELFYAML::ELF_RSS>::enumeration(
426 IO &IO, ELFYAML::ELF_RSS &Value) {
427 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
435 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
436 IO &IO, ELFYAML::ELF_REL &Value) {
437 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
438 assert(Object && "The IO context is not initialized");
439 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
440 switch (Object->Header.Machine) {
442 #include "llvm/Support/ELFRelocs/x86_64.def"
445 #include "llvm/Support/ELFRelocs/Mips.def"
447 case ELF::EM_HEXAGON:
448 #include "llvm/Support/ELFRelocs/Hexagon.def"
451 #include "llvm/Support/ELFRelocs/i386.def"
453 case ELF::EM_AARCH64:
454 #include "llvm/Support/ELFRelocs/AArch64.def"
457 #include "llvm/Support/ELFRelocs/ARM.def"
460 llvm_unreachable("Unsupported architecture");
465 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG>::enumeration(
466 IO &IO, ELFYAML::MIPS_AFL_REG &Value) {
467 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X);
475 void ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP>::enumeration(
476 IO &IO, ELFYAML::MIPS_ABI_FP &Value) {
477 #define ECase(X) IO.enumCase(Value, #X, Mips::Val_GNU_MIPS_ABI_##X);
489 void ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT>::enumeration(
490 IO &IO, ELFYAML::MIPS_AFL_EXT &Value) {
491 #define ECase(X) IO.enumCase(Value, #X, Mips::AFL_##X);
496 ECase(EXT_LOONGSON_3A)
509 ECase(EXT_LOONGSON_2E)
510 ECase(EXT_LOONGSON_2F)
515 void ScalarEnumerationTraits<ELFYAML::MIPS_ISA>::enumeration(
516 IO &IO, ELFYAML::MIPS_ISA &Value) {
517 IO.enumCase(Value, "MIPS1", 1);
518 IO.enumCase(Value, "MIPS2", 2);
519 IO.enumCase(Value, "MIPS3", 3);
520 IO.enumCase(Value, "MIPS4", 4);
521 IO.enumCase(Value, "MIPS5", 5);
522 IO.enumCase(Value, "MIPS32", 32);
523 IO.enumCase(Value, "MIPS64", 64);
526 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE>::bitset(
527 IO &IO, ELFYAML::MIPS_AFL_ASE &Value) {
528 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_ASE_##X);
545 void ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1>::bitset(
546 IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value) {
547 #define BCase(X) IO.bitSetCase(Value, #X, Mips::AFL_FLAGS1_##X);
552 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
553 ELFYAML::FileHeader &FileHdr) {
554 IO.mapRequired("Class", FileHdr.Class);
555 IO.mapRequired("Data", FileHdr.Data);
556 IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
557 IO.mapRequired("Type", FileHdr.Type);
558 IO.mapRequired("Machine", FileHdr.Machine);
559 IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
560 IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
564 struct NormalizedOther {
565 NormalizedOther(IO &)
566 : Visibility(ELFYAML::ELF_STV(0)), Other(ELFYAML::ELF_STO(0)) {}
567 NormalizedOther(IO &, uint8_t Original)
568 : Visibility(Original & 0x3), Other(Original & ~0x3) {}
570 uint8_t denormalize(IO &) { return Visibility | Other; }
572 ELFYAML::ELF_STV Visibility;
573 ELFYAML::ELF_STO Other;
577 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
578 IO.mapOptional("Name", Symbol.Name, StringRef());
579 IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
580 IO.mapOptional("Section", Symbol.Section, StringRef());
581 IO.mapOptional("Value", Symbol.Value, Hex64(0));
582 IO.mapOptional("Size", Symbol.Size, Hex64(0));
584 MappingNormalization<NormalizedOther, uint8_t> Keys(IO, Symbol.Other);
585 IO.mapOptional("Visibility", Keys->Visibility, ELFYAML::ELF_STV(0));
586 IO.mapOptional("Other", Keys->Other, ELFYAML::ELF_STO(0));
589 void MappingTraits<ELFYAML::LocalGlobalWeakSymbols>::mapping(
590 IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols) {
591 IO.mapOptional("Local", Symbols.Local);
592 IO.mapOptional("Global", Symbols.Global);
593 IO.mapOptional("Weak", Symbols.Weak);
596 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
597 IO.mapOptional("Name", Section.Name, StringRef());
598 IO.mapRequired("Type", Section.Type);
599 IO.mapOptional("Flags", Section.Flags, ELFYAML::ELF_SHF(0));
600 IO.mapOptional("Address", Section.Address, Hex64(0));
601 IO.mapOptional("Link", Section.Link, StringRef());
602 IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
603 IO.mapOptional("Info", Section.Info, StringRef());
606 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
607 commonSectionMapping(IO, Section);
608 IO.mapOptional("Content", Section.Content);
609 IO.mapOptional("Size", Section.Size, Hex64(Section.Content.binary_size()));
612 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
613 commonSectionMapping(IO, Section);
614 IO.mapOptional("Relocations", Section.Relocations);
617 static void groupSectionMapping(IO &IO, ELFYAML::Group &group) {
618 commonSectionMapping(IO, group);
619 IO.mapRequired("Members", group.Members);
622 void MappingTraits<ELFYAML::SectionOrType>::mapping(
623 IO &IO, ELFYAML::SectionOrType §ionOrType) {
624 IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
627 static void sectionMapping(IO &IO, ELFYAML::MipsABIFlags &Section) {
628 commonSectionMapping(IO, Section);
629 IO.mapOptional("Version", Section.Version, Hex16(0));
630 IO.mapRequired("ISA", Section.ISALevel);
631 IO.mapOptional("ISARevision", Section.ISARevision, Hex8(0));
632 IO.mapOptional("ISAExtension", Section.ISAExtension,
633 ELFYAML::MIPS_AFL_EXT(Mips::AFL_EXT_NONE));
634 IO.mapOptional("ASEs", Section.ASEs, ELFYAML::MIPS_AFL_ASE(0));
635 IO.mapOptional("FpABI", Section.FpABI,
636 ELFYAML::MIPS_ABI_FP(Mips::Val_GNU_MIPS_ABI_FP_ANY));
637 IO.mapOptional("GPRSize", Section.GPRSize,
638 ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
639 IO.mapOptional("CPR1Size", Section.CPR1Size,
640 ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
641 IO.mapOptional("CPR2Size", Section.CPR2Size,
642 ELFYAML::MIPS_AFL_REG(Mips::AFL_REG_NONE));
643 IO.mapOptional("Flags1", Section.Flags1, ELFYAML::MIPS_AFL_FLAGS1(0));
644 IO.mapOptional("Flags2", Section.Flags2, Hex32(0));
647 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
648 IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
649 ELFYAML::ELF_SHT sectionType;
651 sectionType = Section->Type;
653 IO.mapRequired("Type", sectionType);
655 switch (sectionType) {
658 if (!IO.outputting())
659 Section.reset(new ELFYAML::RelocationSection());
660 sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
663 if (!IO.outputting())
664 Section.reset(new ELFYAML::Group());
665 groupSectionMapping(IO, *cast<ELFYAML::Group>(Section.get()));
667 case ELF::SHT_MIPS_ABIFLAGS:
668 if (!IO.outputting())
669 Section.reset(new ELFYAML::MipsABIFlags());
670 sectionMapping(IO, *cast<ELFYAML::MipsABIFlags>(Section.get()));
673 if (!IO.outputting())
674 Section.reset(new ELFYAML::RawContentSection());
675 sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
679 StringRef MappingTraits<std::unique_ptr<ELFYAML::Section>>::validate(
680 IO &io, std::unique_ptr<ELFYAML::Section> &Section) {
681 const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(Section.get());
682 if (!RawSection || RawSection->Size >= RawSection->Content.binary_size())
684 return "Section size must be greater or equal to the content size";
688 struct NormalizedMips64RelType {
689 NormalizedMips64RelType(IO &)
690 : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
691 Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
692 Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
693 SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
694 NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
695 : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
696 Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
698 ELFYAML::ELF_REL denormalize(IO &) {
699 ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
703 ELFYAML::ELF_REL Type;
704 ELFYAML::ELF_REL Type2;
705 ELFYAML::ELF_REL Type3;
706 ELFYAML::ELF_RSS SpecSym;
710 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
711 ELFYAML::Relocation &Rel) {
712 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
713 assert(Object && "The IO context is not initialized");
715 IO.mapRequired("Offset", Rel.Offset);
716 IO.mapRequired("Symbol", Rel.Symbol);
718 if (Object->Header.Machine == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
719 Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
720 MappingNormalization<NormalizedMips64RelType, ELFYAML::ELF_REL> Key(
722 IO.mapRequired("Type", Key->Type);
723 IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
724 IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
725 IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
727 IO.mapRequired("Type", Rel.Type);
729 IO.mapOptional("Addend", Rel.Addend, (int64_t)0);
732 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
733 assert(!IO.getContext() && "The IO context is initialized already");
734 IO.setContext(&Object);
735 IO.mapRequired("FileHeader", Object.Header);
736 IO.mapOptional("Sections", Object.Sections);
737 IO.mapOptional("Symbols", Object.Symbols);
738 IO.setContext(nullptr);
741 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
742 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
743 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
744 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
745 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
747 } // end namespace yaml
748 } // end namespace llvm