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);
33 IO.enumFallback<Hex16>(Value);
37 ScalarEnumerationTraits<ELFYAML::ELF_EM>::enumeration(IO &IO,
38 ELFYAML::ELF_EM &Value) {
39 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
116 ECase(EM_ARC_COMPACT)
136 ECase(EM_ALTERA_NIOS2)
151 ECase(EM_LATTICEMICO32)
157 ECase(EM_CYPRESS_M8C)
172 ECase(EM_MCST_ELBRUS)
186 ECase(EM_CLOUDSHIELD)
189 ECase(EM_ARC_COMPACT2)
198 void ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS>::enumeration(
199 IO &IO, ELFYAML::ELF_ELFCLASS &Value) {
200 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
201 // Since the semantics of ELFCLASSNONE is "invalid", just don't accept it
208 void ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA>::enumeration(
209 IO &IO, ELFYAML::ELF_ELFDATA &Value) {
210 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
211 // Since the semantics of ELFDATANONE is "invalid", just don't accept it
218 void ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI>::enumeration(
219 IO &IO, ELFYAML::ELF_ELFOSABI &Value) {
220 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
223 ECase(ELFOSABI_NETBSD)
227 ECase(ELFOSABI_SOLARIS)
230 ECase(ELFOSABI_FREEBSD)
231 ECase(ELFOSABI_TRU64)
232 ECase(ELFOSABI_MODESTO)
233 ECase(ELFOSABI_OPENBSD)
234 ECase(ELFOSABI_OPENVMS)
237 ECase(ELFOSABI_FENIXOS)
238 ECase(ELFOSABI_C6000_ELFABI)
239 ECase(ELFOSABI_C6000_LINUX)
241 ECase(ELFOSABI_STANDALONE)
245 void ScalarBitSetTraits<ELFYAML::ELF_EF>::bitset(IO &IO,
246 ELFYAML::ELF_EF &Value) {
247 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
248 assert(Object && "The IO context is not initialized");
249 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
250 #define BCaseMask(X, M) IO.maskedBitSetCase(Value, #X, ELF::X, ELF::M);
251 switch (Object->Header.Machine) {
253 BCase(EF_ARM_SOFT_FLOAT)
254 BCase(EF_ARM_VFP_FLOAT)
255 BCaseMask(EF_ARM_EABI_UNKNOWN, EF_ARM_EABIMASK)
256 BCaseMask(EF_ARM_EABI_VER1, EF_ARM_EABIMASK)
257 BCaseMask(EF_ARM_EABI_VER2, EF_ARM_EABIMASK)
258 BCaseMask(EF_ARM_EABI_VER3, EF_ARM_EABIMASK)
259 BCaseMask(EF_ARM_EABI_VER4, EF_ARM_EABIMASK)
260 BCaseMask(EF_ARM_EABI_VER5, EF_ARM_EABIMASK)
263 BCase(EF_MIPS_NOREORDER)
267 BCase(EF_MIPS_32BITMODE)
268 BCase(EF_MIPS_NAN2008)
269 BCase(EF_MIPS_ABI_O32)
270 BCase(EF_MIPS_MICROMIPS)
271 BCase(EF_MIPS_ARCH_ASE_M16)
272 BCaseMask(EF_MIPS_ARCH_1, EF_MIPS_ARCH)
273 BCaseMask(EF_MIPS_ARCH_2, EF_MIPS_ARCH)
274 BCaseMask(EF_MIPS_ARCH_3, EF_MIPS_ARCH)
275 BCaseMask(EF_MIPS_ARCH_4, EF_MIPS_ARCH)
276 BCaseMask(EF_MIPS_ARCH_5, EF_MIPS_ARCH)
277 BCaseMask(EF_MIPS_ARCH_32, EF_MIPS_ARCH)
278 BCaseMask(EF_MIPS_ARCH_64, EF_MIPS_ARCH)
279 BCaseMask(EF_MIPS_ARCH_32R2, EF_MIPS_ARCH)
280 BCaseMask(EF_MIPS_ARCH_64R2, EF_MIPS_ARCH)
281 BCaseMask(EF_MIPS_ARCH_32R6, EF_MIPS_ARCH)
282 BCaseMask(EF_MIPS_ARCH_64R6, EF_MIPS_ARCH)
284 case ELF::EM_HEXAGON:
285 BCase(EF_HEXAGON_MACH_V2)
286 BCase(EF_HEXAGON_MACH_V3)
287 BCase(EF_HEXAGON_MACH_V4)
288 BCase(EF_HEXAGON_MACH_V5)
289 BCase(EF_HEXAGON_ISA_V2)
290 BCase(EF_HEXAGON_ISA_V3)
291 BCase(EF_HEXAGON_ISA_V4)
292 BCase(EF_HEXAGON_ISA_V5)
295 llvm_unreachable("Unsupported architecture");
301 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
302 IO &IO, ELFYAML::ELF_SHT &Value) {
303 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
304 assert(Object && "The IO context is not initialized");
305 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
308 // No SHT_SYMTAB. Use the top-level `Symbols` key instead.
309 // FIXME: Issue a diagnostic with this information.
319 ECase(SHT_INIT_ARRAY)
320 ECase(SHT_FINI_ARRAY)
321 ECase(SHT_PREINIT_ARRAY)
323 ECase(SHT_SYMTAB_SHNDX)
325 ECase(SHT_GNU_ATTRIBUTES)
327 ECase(SHT_GNU_verdef)
328 ECase(SHT_GNU_verneed)
329 ECase(SHT_GNU_versym)
332 switch (Object->Header.Machine) {
335 ECase(SHT_ARM_PREEMPTMAP)
336 ECase(SHT_ARM_ATTRIBUTES)
337 ECase(SHT_ARM_DEBUGOVERLAY)
338 ECase(SHT_ARM_OVERLAYSECTION)
340 case ELF::EM_HEXAGON:
341 ECase(SHT_HEX_ORDERED)
344 ECase(SHT_X86_64_UNWIND)
347 ECase(SHT_MIPS_REGINFO)
348 ECase(SHT_MIPS_OPTIONS)
349 ECase(SHT_MIPS_ABIFLAGS)
358 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
359 ELFYAML::ELF_SHF &Value) {
360 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
368 BCase(SHF_LINK_ORDER)
369 BCase(SHF_OS_NONCONFORMING)
375 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
376 IO &IO, ELFYAML::ELF_STT &Value) {
377 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
389 void ScalarEnumerationTraits<ELFYAML::ELF_STV>::enumeration(
390 IO &IO, ELFYAML::ELF_STV &Value) {
391 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
399 void ScalarBitSetTraits<ELFYAML::ELF_STO>::bitset(IO &IO,
400 ELFYAML::ELF_STO &Value) {
401 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
402 assert(Object && "The IO context is not initialized");
403 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
404 switch (Object->Header.Machine) {
406 BCase(STO_MIPS_OPTIONAL)
409 BCase(STO_MIPS_MICROMIPS)
412 break; // Nothing to do
418 void ScalarEnumerationTraits<ELFYAML::ELF_RSS>::enumeration(
419 IO &IO, ELFYAML::ELF_RSS &Value) {
420 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
428 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
429 IO &IO, ELFYAML::ELF_REL &Value) {
430 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
431 assert(Object && "The IO context is not initialized");
432 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
433 switch (Object->Header.Machine) {
435 #include "llvm/Support/ELFRelocs/x86_64.def"
438 #include "llvm/Support/ELFRelocs/Mips.def"
440 case ELF::EM_HEXAGON:
441 #include "llvm/Support/ELFRelocs/Hexagon.def"
444 #include "llvm/Support/ELFRelocs/i386.def"
446 case ELF::EM_AARCH64:
447 #include "llvm/Support/ELFRelocs/AArch64.def"
450 #include "llvm/Support/ELFRelocs/ARM.def"
453 llvm_unreachable("Unsupported architecture");
458 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
459 ELFYAML::FileHeader &FileHdr) {
460 IO.mapRequired("Class", FileHdr.Class);
461 IO.mapRequired("Data", FileHdr.Data);
462 IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
463 IO.mapRequired("Type", FileHdr.Type);
464 IO.mapRequired("Machine", FileHdr.Machine);
465 IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
466 IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
470 struct NormalizedOther {
471 NormalizedOther(IO &)
472 : Visibility(ELFYAML::ELF_STV(0)), Other(ELFYAML::ELF_STO(0)) {}
473 NormalizedOther(IO &, uint8_t Original)
474 : Visibility(Original & 0x3), Other(Original & ~0x3) {}
476 uint8_t denormalize(IO &) { return Visibility | Other; }
478 ELFYAML::ELF_STV Visibility;
479 ELFYAML::ELF_STO Other;
483 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
484 IO.mapOptional("Name", Symbol.Name, StringRef());
485 IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
486 IO.mapOptional("Section", Symbol.Section, StringRef());
487 IO.mapOptional("Value", Symbol.Value, Hex64(0));
488 IO.mapOptional("Size", Symbol.Size, Hex64(0));
490 MappingNormalization<NormalizedOther, uint8_t> Keys(IO, Symbol.Other);
491 IO.mapOptional("Visibility", Keys->Visibility, ELFYAML::ELF_STV(0));
492 IO.mapOptional("Other", Keys->Other, ELFYAML::ELF_STO(0));
495 void MappingTraits<ELFYAML::LocalGlobalWeakSymbols>::mapping(
496 IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols) {
497 IO.mapOptional("Local", Symbols.Local);
498 IO.mapOptional("Global", Symbols.Global);
499 IO.mapOptional("Weak", Symbols.Weak);
502 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
503 IO.mapOptional("Name", Section.Name, StringRef());
504 IO.mapRequired("Type", Section.Type);
505 IO.mapOptional("Flags", Section.Flags, ELFYAML::ELF_SHF(0));
506 IO.mapOptional("Address", Section.Address, Hex64(0));
507 IO.mapOptional("Link", Section.Link, StringRef());
508 IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
509 IO.mapOptional("Info", Section.Info, StringRef());
512 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
513 commonSectionMapping(IO, Section);
514 IO.mapOptional("Content", Section.Content);
515 IO.mapOptional("Size", Section.Size, Hex64(Section.Content.binary_size()));
518 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
519 commonSectionMapping(IO, Section);
520 IO.mapOptional("Relocations", Section.Relocations);
523 static void groupSectionMapping(IO &IO, ELFYAML::Group &group) {
524 commonSectionMapping(IO, group);
525 IO.mapRequired("Members", group.Members);
528 void MappingTraits<ELFYAML::SectionOrType>::mapping(
529 IO &IO, ELFYAML::SectionOrType §ionOrType) {
530 IO.mapRequired("SectionOrType", sectionOrType.sectionNameOrType);
533 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
534 IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
535 ELFYAML::ELF_SHT sectionType;
537 sectionType = Section->Type;
539 IO.mapRequired("Type", sectionType);
541 switch (sectionType) {
544 if (!IO.outputting())
545 Section.reset(new ELFYAML::RelocationSection());
546 sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
549 if (!IO.outputting())
550 Section.reset(new ELFYAML::Group());
551 groupSectionMapping(IO, *cast<ELFYAML::Group>(Section.get()));
554 if (!IO.outputting())
555 Section.reset(new ELFYAML::RawContentSection());
556 sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
560 StringRef MappingTraits<std::unique_ptr<ELFYAML::Section>>::validate(
561 IO &io, std::unique_ptr<ELFYAML::Section> &Section) {
562 const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(Section.get());
563 if (!RawSection || RawSection->Size >= RawSection->Content.binary_size())
565 return "Section size must be greater or equal to the content size";
569 struct NormalizedMips64RelType {
570 NormalizedMips64RelType(IO &)
571 : Type(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
572 Type2(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
573 Type3(ELFYAML::ELF_REL(ELF::R_MIPS_NONE)),
574 SpecSym(ELFYAML::ELF_REL(ELF::RSS_UNDEF)) {}
575 NormalizedMips64RelType(IO &, ELFYAML::ELF_REL Original)
576 : Type(Original & 0xFF), Type2(Original >> 8 & 0xFF),
577 Type3(Original >> 16 & 0xFF), SpecSym(Original >> 24 & 0xFF) {}
579 ELFYAML::ELF_REL denormalize(IO &) {
580 ELFYAML::ELF_REL Res = Type | Type2 << 8 | Type3 << 16 | SpecSym << 24;
584 ELFYAML::ELF_REL Type;
585 ELFYAML::ELF_REL Type2;
586 ELFYAML::ELF_REL Type3;
587 ELFYAML::ELF_RSS SpecSym;
591 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
592 ELFYAML::Relocation &Rel) {
593 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
594 assert(Object && "The IO context is not initialized");
596 IO.mapRequired("Offset", Rel.Offset);
597 IO.mapRequired("Symbol", Rel.Symbol);
599 if (Object->Header.Machine == ELFYAML::ELF_EM(ELF::EM_MIPS) &&
600 Object->Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64)) {
601 MappingNormalization<NormalizedMips64RelType, ELFYAML::ELF_REL> Key(
603 IO.mapRequired("Type", Key->Type);
604 IO.mapOptional("Type2", Key->Type2, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
605 IO.mapOptional("Type3", Key->Type3, ELFYAML::ELF_REL(ELF::R_MIPS_NONE));
606 IO.mapOptional("SpecSym", Key->SpecSym, ELFYAML::ELF_RSS(ELF::RSS_UNDEF));
608 IO.mapRequired("Type", Rel.Type);
610 IO.mapOptional("Addend", Rel.Addend, (int64_t)0);
613 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
614 assert(!IO.getContext() && "The IO context is initialized already");
615 IO.setContext(&Object);
616 IO.mapRequired("FileHeader", Object.Header);
617 IO.mapOptional("Sections", Object.Sections);
618 IO.mapOptional("Symbols", Object.Symbols);
619 IO.setContext(nullptr);
622 } // end namespace yaml
623 } // end namespace llvm