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 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
247 BCase(EF_ARM_SOFT_FLOAT)
248 BCase(EF_ARM_VFP_FLOAT)
249 BCase(EF_ARM_EABI_UNKNOWN)
250 BCase(EF_ARM_EABI_VER1)
251 BCase(EF_ARM_EABI_VER2)
252 BCase(EF_ARM_EABI_VER3)
253 BCase(EF_ARM_EABI_VER4)
254 BCase(EF_ARM_EABI_VER5)
255 BCase(EF_ARM_EABIMASK)
256 BCase(EF_MIPS_NOREORDER)
260 BCase(EF_MIPS_32BITMODE)
261 BCase(EF_MIPS_ABI_O32)
262 BCase(EF_MIPS_MICROMIPS)
263 BCase(EF_MIPS_ARCH_ASE_M16)
264 BCase(EF_MIPS_ARCH_1)
265 BCase(EF_MIPS_ARCH_2)
266 BCase(EF_MIPS_ARCH_3)
267 BCase(EF_MIPS_ARCH_4)
268 BCase(EF_MIPS_ARCH_5)
269 BCase(EF_MIPS_ARCH_32)
270 BCase(EF_MIPS_ARCH_64)
271 BCase(EF_MIPS_ARCH_32R2)
272 BCase(EF_MIPS_ARCH_64R2)
274 BCase(EF_HEXAGON_MACH_V2)
275 BCase(EF_HEXAGON_MACH_V3)
276 BCase(EF_HEXAGON_MACH_V4)
277 BCase(EF_HEXAGON_MACH_V5)
278 BCase(EF_HEXAGON_ISA_MACH)
279 BCase(EF_HEXAGON_ISA_V2)
280 BCase(EF_HEXAGON_ISA_V3)
281 BCase(EF_HEXAGON_ISA_V4)
282 BCase(EF_HEXAGON_ISA_V5)
286 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
287 IO &IO, ELFYAML::ELF_SHT &Value) {
288 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
291 // No SHT_SYMTAB. Use the top-level `Symbols` key instead.
292 // FIXME: Issue a diagnostic with this information.
302 ECase(SHT_INIT_ARRAY)
303 ECase(SHT_FINI_ARRAY)
304 ECase(SHT_PREINIT_ARRAY)
306 ECase(SHT_SYMTAB_SHNDX)
308 ECase(SHT_GNU_ATTRIBUTES)
310 ECase(SHT_GNU_verdef)
311 ECase(SHT_GNU_verneed)
312 ECase(SHT_GNU_versym)
316 ECase(SHT_ARM_PREEMPTMAP)
317 ECase(SHT_ARM_ATTRIBUTES)
318 ECase(SHT_ARM_DEBUGOVERLAY)
319 ECase(SHT_ARM_OVERLAYSECTION)
320 ECase(SHT_HEX_ORDERED)
321 ECase(SHT_X86_64_UNWIND)
322 ECase(SHT_MIPS_REGINFO)
323 ECase(SHT_MIPS_OPTIONS)
327 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
328 ELFYAML::ELF_SHF &Value) {
329 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
337 BCase(SHF_LINK_ORDER)
338 BCase(SHF_OS_NONCONFORMING)
344 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
345 IO &IO, ELFYAML::ELF_STT &Value) {
346 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
358 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
359 IO &IO, ELFYAML::ELF_REL &Value) {
360 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
361 assert(Object && "The IO context is not initialized");
362 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
363 switch (Object->Header.Machine) {
368 ECase(R_X86_64_GOT32)
369 ECase(R_X86_64_PLT32)
371 ECase(R_X86_64_GLOB_DAT)
372 ECase(R_X86_64_JUMP_SLOT)
373 ECase(R_X86_64_RELATIVE)
374 ECase(R_X86_64_GOTPCREL)
381 ECase(R_X86_64_DTPMOD64)
382 ECase(R_X86_64_DTPOFF64)
383 ECase(R_X86_64_TPOFF64)
384 ECase(R_X86_64_TLSGD)
385 ECase(R_X86_64_TLSLD)
386 ECase(R_X86_64_DTPOFF32)
387 ECase(R_X86_64_GOTTPOFF)
388 ECase(R_X86_64_TPOFF32)
390 ECase(R_X86_64_GOTOFF64)
391 ECase(R_X86_64_GOTPC32)
392 ECase(R_X86_64_GOT64)
393 ECase(R_X86_64_GOTPCREL64)
394 ECase(R_X86_64_GOTPC64)
395 ECase(R_X86_64_GOTPLT64)
396 ECase(R_X86_64_PLTOFF64)
397 ECase(R_X86_64_SIZE32)
398 ECase(R_X86_64_SIZE64)
399 ECase(R_X86_64_GOTPC32_TLSDESC)
400 ECase(R_X86_64_TLSDESC_CALL)
401 ECase(R_X86_64_TLSDESC)
402 ECase(R_X86_64_IRELATIVE)
412 ECase(R_MIPS_GPREL16)
413 ECase(R_MIPS_LITERAL)
417 ECase(R_MIPS_GPREL32)
418 ECase(R_MIPS_UNUSED1)
419 ECase(R_MIPS_UNUSED2)
423 ECase(R_MIPS_GOT_DISP)
424 ECase(R_MIPS_GOT_PAGE)
425 ECase(R_MIPS_GOT_OFST)
426 ECase(R_MIPS_GOT_HI16)
427 ECase(R_MIPS_GOT_LO16)
429 ECase(R_MIPS_INSERT_A)
430 ECase(R_MIPS_INSERT_B)
433 ECase(R_MIPS_HIGHEST)
434 ECase(R_MIPS_CALL_HI16)
435 ECase(R_MIPS_CALL_LO16)
436 ECase(R_MIPS_SCN_DISP)
438 ECase(R_MIPS_ADD_IMMEDIATE)
442 ECase(R_MIPS_TLS_DTPMOD32)
443 ECase(R_MIPS_TLS_DTPREL32)
444 ECase(R_MIPS_TLS_DTPMOD64)
445 ECase(R_MIPS_TLS_DTPREL64)
447 ECase(R_MIPS_TLS_LDM)
448 ECase(R_MIPS_TLS_DTPREL_HI16)
449 ECase(R_MIPS_TLS_DTPREL_LO16)
450 ECase(R_MIPS_TLS_GOTTPREL)
451 ECase(R_MIPS_TLS_TPREL32)
452 ECase(R_MIPS_TLS_TPREL64)
453 ECase(R_MIPS_TLS_TPREL_HI16)
454 ECase(R_MIPS_TLS_TPREL_LO16)
455 ECase(R_MIPS_GLOB_DAT)
457 ECase(R_MIPS_JUMP_SLOT)
458 ECase(R_MICROMIPS_26_S1)
459 ECase(R_MICROMIPS_HI16)
460 ECase(R_MICROMIPS_LO16)
461 ECase(R_MICROMIPS_GOT16)
462 ECase(R_MICROMIPS_PC16_S1)
463 ECase(R_MICROMIPS_CALL16)
464 ECase(R_MICROMIPS_GOT_DISP)
465 ECase(R_MICROMIPS_GOT_PAGE)
466 ECase(R_MICROMIPS_GOT_OFST)
467 ECase(R_MICROMIPS_TLS_GD)
468 ECase(R_MICROMIPS_TLS_LDM)
469 ECase(R_MICROMIPS_TLS_DTPREL_HI16)
470 ECase(R_MICROMIPS_TLS_DTPREL_LO16)
471 ECase(R_MICROMIPS_TLS_TPREL_HI16)
472 ECase(R_MICROMIPS_TLS_TPREL_LO16)
476 case ELF::EM_HEXAGON:
478 ECase(R_HEX_B22_PCREL)
479 ECase(R_HEX_B15_PCREL)
480 ECase(R_HEX_B7_PCREL)
486 ECase(R_HEX_GPREL16_0)
487 ECase(R_HEX_GPREL16_1)
488 ECase(R_HEX_GPREL16_2)
489 ECase(R_HEX_GPREL16_3)
491 ECase(R_HEX_B13_PCREL)
492 ECase(R_HEX_B9_PCREL)
493 ECase(R_HEX_B32_PCREL_X)
495 ECase(R_HEX_B22_PCREL_X)
496 ECase(R_HEX_B15_PCREL_X)
497 ECase(R_HEX_B13_PCREL_X)
498 ECase(R_HEX_B9_PCREL_X)
499 ECase(R_HEX_B7_PCREL_X)
508 ECase(R_HEX_32_PCREL)
510 ECase(R_HEX_GLOB_DAT)
511 ECase(R_HEX_JMP_SLOT)
512 ECase(R_HEX_RELATIVE)
513 ECase(R_HEX_PLT_B22_PCREL)
514 ECase(R_HEX_GOTREL_LO16)
515 ECase(R_HEX_GOTREL_HI16)
516 ECase(R_HEX_GOTREL_32)
517 ECase(R_HEX_GOT_LO16)
518 ECase(R_HEX_GOT_HI16)
521 ECase(R_HEX_DTPMOD_32)
522 ECase(R_HEX_DTPREL_LO16)
523 ECase(R_HEX_DTPREL_HI16)
524 ECase(R_HEX_DTPREL_32)
525 ECase(R_HEX_DTPREL_16)
526 ECase(R_HEX_GD_PLT_B22_PCREL)
527 ECase(R_HEX_GD_GOT_LO16)
528 ECase(R_HEX_GD_GOT_HI16)
529 ECase(R_HEX_GD_GOT_32)
530 ECase(R_HEX_GD_GOT_16)
534 ECase(R_HEX_IE_GOT_LO16)
535 ECase(R_HEX_IE_GOT_HI16)
536 ECase(R_HEX_IE_GOT_32)
537 ECase(R_HEX_IE_GOT_16)
538 ECase(R_HEX_TPREL_LO16)
539 ECase(R_HEX_TPREL_HI16)
540 ECase(R_HEX_TPREL_32)
541 ECase(R_HEX_TPREL_16)
542 ECase(R_HEX_6_PCREL_X)
543 ECase(R_HEX_GOTREL_32_6_X)
544 ECase(R_HEX_GOTREL_16_X)
545 ECase(R_HEX_GOTREL_11_X)
546 ECase(R_HEX_GOT_32_6_X)
547 ECase(R_HEX_GOT_16_X)
548 ECase(R_HEX_GOT_11_X)
549 ECase(R_HEX_DTPREL_32_6_X)
550 ECase(R_HEX_DTPREL_16_X)
551 ECase(R_HEX_DTPREL_11_X)
552 ECase(R_HEX_GD_GOT_32_6_X)
553 ECase(R_HEX_GD_GOT_16_X)
554 ECase(R_HEX_GD_GOT_11_X)
555 ECase(R_HEX_IE_32_6_X)
557 ECase(R_HEX_IE_GOT_32_6_X)
558 ECase(R_HEX_IE_GOT_16_X)
559 ECase(R_HEX_IE_GOT_11_X)
560 ECase(R_HEX_TPREL_32_6_X)
561 ECase(R_HEX_TPREL_16_X)
562 ECase(R_HEX_TPREL_11_X)
565 llvm_unreachable("Unsupported architecture");
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));
581 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
582 IO.mapOptional("Name", Symbol.Name, StringRef());
583 IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
584 IO.mapOptional("Section", Symbol.Section, StringRef());
585 IO.mapOptional("Value", Symbol.Value, Hex64(0));
586 IO.mapOptional("Size", Symbol.Size, Hex64(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);
602 IO.mapOptional("Info", Section.Info);
603 IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
606 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
607 commonSectionMapping(IO, Section);
608 IO.mapOptional("Content", Section.Content);
611 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
612 commonSectionMapping(IO, Section);
613 IO.mapOptional("Relocations", Section.Relocations);
616 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
617 IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
618 ELFYAML::ELF_SHT sectionType;
620 sectionType = Section->Type;
621 IO.mapRequired("Type", sectionType);
623 switch (sectionType) {
626 if (!IO.outputting())
627 Section.reset(new ELFYAML::RelocationSection());
628 sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
631 if (!IO.outputting())
632 Section.reset(new ELFYAML::RawContentSection());
633 sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
637 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
638 ELFYAML::Relocation &Rel) {
639 IO.mapRequired("Offset", Rel.Offset);
640 IO.mapRequired("Symbol", Rel.Symbol);
641 IO.mapRequired("Type", Rel.Type);
642 IO.mapOptional("Addend", Rel.Addend);
645 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
646 assert(!IO.getContext() && "The IO context is initialized already");
647 IO.setContext(&Object);
648 IO.mapRequired("FileHeader", Object.Header);
649 IO.mapOptional("Sections", Object.Sections);
650 IO.mapOptional("Symbols", Object.Symbols);
651 IO.setContext(nullptr);
654 } // end namespace yaml
655 } // end namespace llvm