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 switch (Object->Header.Machine) {
251 BCase(EF_ARM_SOFT_FLOAT)
252 BCase(EF_ARM_VFP_FLOAT)
253 BCase(EF_ARM_EABI_UNKNOWN)
254 BCase(EF_ARM_EABI_VER1)
255 BCase(EF_ARM_EABI_VER2)
256 BCase(EF_ARM_EABI_VER3)
257 BCase(EF_ARM_EABI_VER4)
258 BCase(EF_ARM_EABI_VER5)
261 BCase(EF_MIPS_NOREORDER)
265 BCase(EF_MIPS_32BITMODE)
266 BCase(EF_MIPS_ABI_O32)
267 BCase(EF_MIPS_MICROMIPS)
268 BCase(EF_MIPS_ARCH_ASE_M16)
269 BCase(EF_MIPS_ARCH_1)
270 BCase(EF_MIPS_ARCH_2)
271 BCase(EF_MIPS_ARCH_3)
272 BCase(EF_MIPS_ARCH_4)
273 BCase(EF_MIPS_ARCH_5)
274 BCase(EF_MIPS_ARCH_32)
275 BCase(EF_MIPS_ARCH_64)
276 BCase(EF_MIPS_ARCH_32R2)
277 BCase(EF_MIPS_ARCH_64R2)
279 case ELF::EM_HEXAGON:
280 BCase(EF_HEXAGON_MACH_V2)
281 BCase(EF_HEXAGON_MACH_V3)
282 BCase(EF_HEXAGON_MACH_V4)
283 BCase(EF_HEXAGON_MACH_V5)
284 BCase(EF_HEXAGON_ISA_V2)
285 BCase(EF_HEXAGON_ISA_V3)
286 BCase(EF_HEXAGON_ISA_V4)
287 BCase(EF_HEXAGON_ISA_V5)
290 llvm_unreachable("Unsupported architecture");
295 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
296 IO &IO, ELFYAML::ELF_SHT &Value) {
297 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
300 // No SHT_SYMTAB. Use the top-level `Symbols` key instead.
301 // FIXME: Issue a diagnostic with this information.
311 ECase(SHT_INIT_ARRAY)
312 ECase(SHT_FINI_ARRAY)
313 ECase(SHT_PREINIT_ARRAY)
315 ECase(SHT_SYMTAB_SHNDX)
317 ECase(SHT_GNU_ATTRIBUTES)
319 ECase(SHT_GNU_verdef)
320 ECase(SHT_GNU_verneed)
321 ECase(SHT_GNU_versym)
325 ECase(SHT_ARM_PREEMPTMAP)
326 ECase(SHT_ARM_ATTRIBUTES)
327 ECase(SHT_ARM_DEBUGOVERLAY)
328 ECase(SHT_ARM_OVERLAYSECTION)
329 ECase(SHT_HEX_ORDERED)
330 ECase(SHT_X86_64_UNWIND)
331 ECase(SHT_MIPS_REGINFO)
332 ECase(SHT_MIPS_OPTIONS)
336 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
337 ELFYAML::ELF_SHF &Value) {
338 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
346 BCase(SHF_LINK_ORDER)
347 BCase(SHF_OS_NONCONFORMING)
353 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
354 IO &IO, ELFYAML::ELF_STT &Value) {
355 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
367 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
368 IO &IO, ELFYAML::ELF_REL &Value) {
369 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
370 assert(Object && "The IO context is not initialized");
371 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
372 switch (Object->Header.Machine) {
377 ECase(R_X86_64_GOT32)
378 ECase(R_X86_64_PLT32)
380 ECase(R_X86_64_GLOB_DAT)
381 ECase(R_X86_64_JUMP_SLOT)
382 ECase(R_X86_64_RELATIVE)
383 ECase(R_X86_64_GOTPCREL)
390 ECase(R_X86_64_DTPMOD64)
391 ECase(R_X86_64_DTPOFF64)
392 ECase(R_X86_64_TPOFF64)
393 ECase(R_X86_64_TLSGD)
394 ECase(R_X86_64_TLSLD)
395 ECase(R_X86_64_DTPOFF32)
396 ECase(R_X86_64_GOTTPOFF)
397 ECase(R_X86_64_TPOFF32)
399 ECase(R_X86_64_GOTOFF64)
400 ECase(R_X86_64_GOTPC32)
401 ECase(R_X86_64_GOT64)
402 ECase(R_X86_64_GOTPCREL64)
403 ECase(R_X86_64_GOTPC64)
404 ECase(R_X86_64_GOTPLT64)
405 ECase(R_X86_64_PLTOFF64)
406 ECase(R_X86_64_SIZE32)
407 ECase(R_X86_64_SIZE64)
408 ECase(R_X86_64_GOTPC32_TLSDESC)
409 ECase(R_X86_64_TLSDESC_CALL)
410 ECase(R_X86_64_TLSDESC)
411 ECase(R_X86_64_IRELATIVE)
421 ECase(R_MIPS_GPREL16)
422 ECase(R_MIPS_LITERAL)
426 ECase(R_MIPS_GPREL32)
427 ECase(R_MIPS_UNUSED1)
428 ECase(R_MIPS_UNUSED2)
432 ECase(R_MIPS_GOT_DISP)
433 ECase(R_MIPS_GOT_PAGE)
434 ECase(R_MIPS_GOT_OFST)
435 ECase(R_MIPS_GOT_HI16)
436 ECase(R_MIPS_GOT_LO16)
438 ECase(R_MIPS_INSERT_A)
439 ECase(R_MIPS_INSERT_B)
442 ECase(R_MIPS_HIGHEST)
443 ECase(R_MIPS_CALL_HI16)
444 ECase(R_MIPS_CALL_LO16)
445 ECase(R_MIPS_SCN_DISP)
447 ECase(R_MIPS_ADD_IMMEDIATE)
451 ECase(R_MIPS_TLS_DTPMOD32)
452 ECase(R_MIPS_TLS_DTPREL32)
453 ECase(R_MIPS_TLS_DTPMOD64)
454 ECase(R_MIPS_TLS_DTPREL64)
456 ECase(R_MIPS_TLS_LDM)
457 ECase(R_MIPS_TLS_DTPREL_HI16)
458 ECase(R_MIPS_TLS_DTPREL_LO16)
459 ECase(R_MIPS_TLS_GOTTPREL)
460 ECase(R_MIPS_TLS_TPREL32)
461 ECase(R_MIPS_TLS_TPREL64)
462 ECase(R_MIPS_TLS_TPREL_HI16)
463 ECase(R_MIPS_TLS_TPREL_LO16)
464 ECase(R_MIPS_GLOB_DAT)
466 ECase(R_MIPS_JUMP_SLOT)
467 ECase(R_MICROMIPS_26_S1)
468 ECase(R_MICROMIPS_HI16)
469 ECase(R_MICROMIPS_LO16)
470 ECase(R_MICROMIPS_GOT16)
471 ECase(R_MICROMIPS_PC16_S1)
472 ECase(R_MICROMIPS_CALL16)
473 ECase(R_MICROMIPS_GOT_DISP)
474 ECase(R_MICROMIPS_GOT_PAGE)
475 ECase(R_MICROMIPS_GOT_OFST)
476 ECase(R_MICROMIPS_TLS_GD)
477 ECase(R_MICROMIPS_TLS_LDM)
478 ECase(R_MICROMIPS_TLS_DTPREL_HI16)
479 ECase(R_MICROMIPS_TLS_DTPREL_LO16)
480 ECase(R_MICROMIPS_TLS_TPREL_HI16)
481 ECase(R_MICROMIPS_TLS_TPREL_LO16)
485 case ELF::EM_HEXAGON:
487 ECase(R_HEX_B22_PCREL)
488 ECase(R_HEX_B15_PCREL)
489 ECase(R_HEX_B7_PCREL)
495 ECase(R_HEX_GPREL16_0)
496 ECase(R_HEX_GPREL16_1)
497 ECase(R_HEX_GPREL16_2)
498 ECase(R_HEX_GPREL16_3)
500 ECase(R_HEX_B13_PCREL)
501 ECase(R_HEX_B9_PCREL)
502 ECase(R_HEX_B32_PCREL_X)
504 ECase(R_HEX_B22_PCREL_X)
505 ECase(R_HEX_B15_PCREL_X)
506 ECase(R_HEX_B13_PCREL_X)
507 ECase(R_HEX_B9_PCREL_X)
508 ECase(R_HEX_B7_PCREL_X)
517 ECase(R_HEX_32_PCREL)
519 ECase(R_HEX_GLOB_DAT)
520 ECase(R_HEX_JMP_SLOT)
521 ECase(R_HEX_RELATIVE)
522 ECase(R_HEX_PLT_B22_PCREL)
523 ECase(R_HEX_GOTREL_LO16)
524 ECase(R_HEX_GOTREL_HI16)
525 ECase(R_HEX_GOTREL_32)
526 ECase(R_HEX_GOT_LO16)
527 ECase(R_HEX_GOT_HI16)
530 ECase(R_HEX_DTPMOD_32)
531 ECase(R_HEX_DTPREL_LO16)
532 ECase(R_HEX_DTPREL_HI16)
533 ECase(R_HEX_DTPREL_32)
534 ECase(R_HEX_DTPREL_16)
535 ECase(R_HEX_GD_PLT_B22_PCREL)
536 ECase(R_HEX_GD_GOT_LO16)
537 ECase(R_HEX_GD_GOT_HI16)
538 ECase(R_HEX_GD_GOT_32)
539 ECase(R_HEX_GD_GOT_16)
543 ECase(R_HEX_IE_GOT_LO16)
544 ECase(R_HEX_IE_GOT_HI16)
545 ECase(R_HEX_IE_GOT_32)
546 ECase(R_HEX_IE_GOT_16)
547 ECase(R_HEX_TPREL_LO16)
548 ECase(R_HEX_TPREL_HI16)
549 ECase(R_HEX_TPREL_32)
550 ECase(R_HEX_TPREL_16)
551 ECase(R_HEX_6_PCREL_X)
552 ECase(R_HEX_GOTREL_32_6_X)
553 ECase(R_HEX_GOTREL_16_X)
554 ECase(R_HEX_GOTREL_11_X)
555 ECase(R_HEX_GOT_32_6_X)
556 ECase(R_HEX_GOT_16_X)
557 ECase(R_HEX_GOT_11_X)
558 ECase(R_HEX_DTPREL_32_6_X)
559 ECase(R_HEX_DTPREL_16_X)
560 ECase(R_HEX_DTPREL_11_X)
561 ECase(R_HEX_GD_GOT_32_6_X)
562 ECase(R_HEX_GD_GOT_16_X)
563 ECase(R_HEX_GD_GOT_11_X)
564 ECase(R_HEX_IE_32_6_X)
566 ECase(R_HEX_IE_GOT_32_6_X)
567 ECase(R_HEX_IE_GOT_16_X)
568 ECase(R_HEX_IE_GOT_11_X)
569 ECase(R_HEX_TPREL_32_6_X)
570 ECase(R_HEX_TPREL_16_X)
571 ECase(R_HEX_TPREL_11_X)
580 ECase(R_386_GLOB_DAT)
581 ECase(R_386_JUMP_SLOT)
582 ECase(R_386_RELATIVE)
586 ECase(R_386_TLS_TPOFF)
588 ECase(R_386_TLS_GOTIE)
596 ECase(R_386_TLS_GD_32)
597 ECase(R_386_TLS_GD_PUSH)
598 ECase(R_386_TLS_GD_CALL)
599 ECase(R_386_TLS_GD_POP)
600 ECase(R_386_TLS_LDM_32)
601 ECase(R_386_TLS_LDM_PUSH)
602 ECase(R_386_TLS_LDM_CALL)
603 ECase(R_386_TLS_LDM_POP)
604 ECase(R_386_TLS_LDO_32)
605 ECase(R_386_TLS_IE_32)
606 ECase(R_386_TLS_LE_32)
607 ECase(R_386_TLS_DTPMOD32)
608 ECase(R_386_TLS_DTPOFF32)
609 ECase(R_386_TLS_TPOFF32)
610 ECase(R_386_TLS_GOTDESC)
611 ECase(R_386_TLS_DESC_CALL)
612 ECase(R_386_TLS_DESC)
613 ECase(R_386_IRELATIVE)
617 llvm_unreachable("Unsupported architecture");
622 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
623 ELFYAML::FileHeader &FileHdr) {
624 IO.mapRequired("Class", FileHdr.Class);
625 IO.mapRequired("Data", FileHdr.Data);
626 IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
627 IO.mapRequired("Type", FileHdr.Type);
628 IO.mapRequired("Machine", FileHdr.Machine);
629 IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
630 IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
633 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
634 IO.mapOptional("Name", Symbol.Name, StringRef());
635 IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
636 IO.mapOptional("Section", Symbol.Section, StringRef());
637 IO.mapOptional("Value", Symbol.Value, Hex64(0));
638 IO.mapOptional("Size", Symbol.Size, Hex64(0));
641 void MappingTraits<ELFYAML::LocalGlobalWeakSymbols>::mapping(
642 IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols) {
643 IO.mapOptional("Local", Symbols.Local);
644 IO.mapOptional("Global", Symbols.Global);
645 IO.mapOptional("Weak", Symbols.Weak);
648 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
649 IO.mapOptional("Name", Section.Name, StringRef());
650 IO.mapRequired("Type", Section.Type);
651 IO.mapOptional("Flags", Section.Flags, ELFYAML::ELF_SHF(0));
652 IO.mapOptional("Address", Section.Address, Hex64(0));
653 IO.mapOptional("Link", Section.Link);
654 IO.mapOptional("Info", Section.Info);
655 IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
658 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
659 commonSectionMapping(IO, Section);
660 IO.mapOptional("Content", Section.Content);
663 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
664 commonSectionMapping(IO, Section);
665 IO.mapOptional("Relocations", Section.Relocations);
668 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
669 IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
670 ELFYAML::ELF_SHT sectionType;
672 sectionType = Section->Type;
674 IO.mapRequired("Type", sectionType);
676 switch (sectionType) {
679 if (!IO.outputting())
680 Section.reset(new ELFYAML::RelocationSection());
681 sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
684 if (!IO.outputting())
685 Section.reset(new ELFYAML::RawContentSection());
686 sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
690 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
691 ELFYAML::Relocation &Rel) {
692 IO.mapRequired("Offset", Rel.Offset);
693 IO.mapRequired("Symbol", Rel.Symbol);
694 IO.mapRequired("Type", Rel.Type);
695 IO.mapOptional("Addend", Rel.Addend);
698 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
699 assert(!IO.getContext() && "The IO context is initialized already");
700 IO.setContext(&Object);
701 IO.mapRequired("FileHeader", Object.Header);
702 IO.mapOptional("Sections", Object.Sections);
703 IO.mapOptional("Symbols", Object.Symbols);
704 IO.setContext(nullptr);
707 } // end namespace yaml
708 } // end namespace llvm