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 #define BCaseMask(X, M) IO.maskedBitSetCase(Value, #X, ELF::X, ELF::M);
250 switch (Object->Header.Machine) {
252 BCase(EF_ARM_SOFT_FLOAT)
253 BCase(EF_ARM_VFP_FLOAT)
254 BCaseMask(EF_ARM_EABI_UNKNOWN, EF_ARM_EABIMASK)
255 BCaseMask(EF_ARM_EABI_VER1, EF_ARM_EABIMASK)
256 BCaseMask(EF_ARM_EABI_VER2, EF_ARM_EABIMASK)
257 BCaseMask(EF_ARM_EABI_VER3, EF_ARM_EABIMASK)
258 BCaseMask(EF_ARM_EABI_VER4, EF_ARM_EABIMASK)
259 BCaseMask(EF_ARM_EABI_VER5, EF_ARM_EABIMASK)
262 BCase(EF_MIPS_NOREORDER)
266 BCase(EF_MIPS_32BITMODE)
267 BCase(EF_MIPS_NAN2008)
268 BCase(EF_MIPS_ABI_O32)
269 BCase(EF_MIPS_MICROMIPS)
270 BCase(EF_MIPS_ARCH_ASE_M16)
271 BCaseMask(EF_MIPS_ARCH_1, EF_MIPS_ARCH)
272 BCaseMask(EF_MIPS_ARCH_2, EF_MIPS_ARCH)
273 BCaseMask(EF_MIPS_ARCH_3, EF_MIPS_ARCH)
274 BCaseMask(EF_MIPS_ARCH_4, EF_MIPS_ARCH)
275 BCaseMask(EF_MIPS_ARCH_5, EF_MIPS_ARCH)
276 BCaseMask(EF_MIPS_ARCH_32, EF_MIPS_ARCH)
277 BCaseMask(EF_MIPS_ARCH_64, EF_MIPS_ARCH)
278 BCaseMask(EF_MIPS_ARCH_32R2, EF_MIPS_ARCH)
279 BCaseMask(EF_MIPS_ARCH_64R2, EF_MIPS_ARCH)
280 BCaseMask(EF_MIPS_ARCH_32R6, EF_MIPS_ARCH)
281 BCaseMask(EF_MIPS_ARCH_64R6, EF_MIPS_ARCH)
283 case ELF::EM_HEXAGON:
284 BCase(EF_HEXAGON_MACH_V2)
285 BCase(EF_HEXAGON_MACH_V3)
286 BCase(EF_HEXAGON_MACH_V4)
287 BCase(EF_HEXAGON_MACH_V5)
288 BCase(EF_HEXAGON_ISA_V2)
289 BCase(EF_HEXAGON_ISA_V3)
290 BCase(EF_HEXAGON_ISA_V4)
291 BCase(EF_HEXAGON_ISA_V5)
294 llvm_unreachable("Unsupported architecture");
300 void ScalarEnumerationTraits<ELFYAML::ELF_SHT>::enumeration(
301 IO &IO, ELFYAML::ELF_SHT &Value) {
302 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
303 assert(Object && "The IO context is not initialized");
304 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
307 // No SHT_SYMTAB. Use the top-level `Symbols` key instead.
308 // FIXME: Issue a diagnostic with this information.
318 ECase(SHT_INIT_ARRAY)
319 ECase(SHT_FINI_ARRAY)
320 ECase(SHT_PREINIT_ARRAY)
322 ECase(SHT_SYMTAB_SHNDX)
324 ECase(SHT_GNU_ATTRIBUTES)
326 ECase(SHT_GNU_verdef)
327 ECase(SHT_GNU_verneed)
328 ECase(SHT_GNU_versym)
331 switch (Object->Header.Machine) {
334 ECase(SHT_ARM_PREEMPTMAP)
335 ECase(SHT_ARM_ATTRIBUTES)
336 ECase(SHT_ARM_DEBUGOVERLAY)
337 ECase(SHT_ARM_OVERLAYSECTION)
339 case ELF::EM_HEXAGON:
340 ECase(SHT_HEX_ORDERED)
343 ECase(SHT_X86_64_UNWIND)
346 ECase(SHT_MIPS_REGINFO)
347 ECase(SHT_MIPS_OPTIONS)
348 ECase(SHT_MIPS_ABIFLAGS)
357 void ScalarBitSetTraits<ELFYAML::ELF_SHF>::bitset(IO &IO,
358 ELFYAML::ELF_SHF &Value) {
359 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
367 BCase(SHF_LINK_ORDER)
368 BCase(SHF_OS_NONCONFORMING)
374 void ScalarEnumerationTraits<ELFYAML::ELF_STT>::enumeration(
375 IO &IO, ELFYAML::ELF_STT &Value) {
376 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
388 void ScalarEnumerationTraits<ELFYAML::ELF_STV>::enumeration(
389 IO &IO, ELFYAML::ELF_STV &Value) {
390 #define ECase(X) IO.enumCase(Value, #X, ELF::X);
398 void ScalarBitSetTraits<ELFYAML::ELF_STO>::bitset(IO &IO,
399 ELFYAML::ELF_STO &Value) {
400 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
401 assert(Object && "The IO context is not initialized");
402 #define BCase(X) IO.bitSetCase(Value, #X, ELF::X);
403 switch (Object->Header.Machine) {
405 BCase(STO_MIPS_OPTIONAL)
408 BCase(STO_MIPS_MICROMIPS)
411 break; // Nothing to do
417 void ScalarEnumerationTraits<ELFYAML::ELF_REL>::enumeration(
418 IO &IO, ELFYAML::ELF_REL &Value) {
419 const auto *Object = static_cast<ELFYAML::Object *>(IO.getContext());
420 assert(Object && "The IO context is not initialized");
421 #define ELF_RELOC(X, Y) IO.enumCase(Value, #X, ELF::X);
422 switch (Object->Header.Machine) {
424 #include "llvm/Support/ELFRelocs/x86_64.def"
427 #include "llvm/Support/ELFRelocs/Mips.def"
429 case ELF::EM_HEXAGON:
430 #include "llvm/Support/ELFRelocs/Hexagon.def"
433 #include "llvm/Support/ELFRelocs/i386.def"
435 case ELF::EM_AARCH64:
436 #include "llvm/Support/ELFRelocs/AArch64.def"
439 llvm_unreachable("Unsupported architecture");
444 void MappingTraits<ELFYAML::FileHeader>::mapping(IO &IO,
445 ELFYAML::FileHeader &FileHdr) {
446 IO.mapRequired("Class", FileHdr.Class);
447 IO.mapRequired("Data", FileHdr.Data);
448 IO.mapOptional("OSABI", FileHdr.OSABI, ELFYAML::ELF_ELFOSABI(0));
449 IO.mapRequired("Type", FileHdr.Type);
450 IO.mapRequired("Machine", FileHdr.Machine);
451 IO.mapOptional("Flags", FileHdr.Flags, ELFYAML::ELF_EF(0));
452 IO.mapOptional("Entry", FileHdr.Entry, Hex64(0));
456 struct NormalizedOther {
457 NormalizedOther(IO &)
458 : Visibility(ELFYAML::ELF_STV(0)), Other(ELFYAML::ELF_STO(0)) {}
459 NormalizedOther(IO &, uint8_t Original)
460 : Visibility(Original & 0x3), Other(Original & ~0x3) {}
462 uint8_t denormalize(IO &) { return Visibility | Other; }
464 ELFYAML::ELF_STV Visibility;
465 ELFYAML::ELF_STO Other;
469 void MappingTraits<ELFYAML::Symbol>::mapping(IO &IO, ELFYAML::Symbol &Symbol) {
470 IO.mapOptional("Name", Symbol.Name, StringRef());
471 IO.mapOptional("Type", Symbol.Type, ELFYAML::ELF_STT(0));
472 IO.mapOptional("Section", Symbol.Section, StringRef());
473 IO.mapOptional("Value", Symbol.Value, Hex64(0));
474 IO.mapOptional("Size", Symbol.Size, Hex64(0));
476 MappingNormalization<NormalizedOther, uint8_t> Keys(IO, Symbol.Other);
477 IO.mapOptional("Visibility", Keys->Visibility, ELFYAML::ELF_STV(0));
478 IO.mapOptional("Other", Keys->Other, ELFYAML::ELF_STO(0));
481 void MappingTraits<ELFYAML::LocalGlobalWeakSymbols>::mapping(
482 IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols) {
483 IO.mapOptional("Local", Symbols.Local);
484 IO.mapOptional("Global", Symbols.Global);
485 IO.mapOptional("Weak", Symbols.Weak);
488 static void commonSectionMapping(IO &IO, ELFYAML::Section &Section) {
489 IO.mapOptional("Name", Section.Name, StringRef());
490 IO.mapRequired("Type", Section.Type);
491 IO.mapOptional("Flags", Section.Flags, ELFYAML::ELF_SHF(0));
492 IO.mapOptional("Address", Section.Address, Hex64(0));
493 IO.mapOptional("Link", Section.Link, StringRef());
494 IO.mapOptional("AddressAlign", Section.AddressAlign, Hex64(0));
497 static void sectionMapping(IO &IO, ELFYAML::RawContentSection &Section) {
498 commonSectionMapping(IO, Section);
499 IO.mapOptional("Content", Section.Content);
500 IO.mapOptional("Size", Section.Size, Hex64(Section.Content.binary_size()));
503 static void sectionMapping(IO &IO, ELFYAML::RelocationSection &Section) {
504 commonSectionMapping(IO, Section);
505 IO.mapOptional("Info", Section.Info, StringRef());
506 IO.mapOptional("Relocations", Section.Relocations);
509 void MappingTraits<std::unique_ptr<ELFYAML::Section>>::mapping(
510 IO &IO, std::unique_ptr<ELFYAML::Section> &Section) {
511 ELFYAML::ELF_SHT sectionType;
513 sectionType = Section->Type;
515 IO.mapRequired("Type", sectionType);
517 switch (sectionType) {
520 if (!IO.outputting())
521 Section.reset(new ELFYAML::RelocationSection());
522 sectionMapping(IO, *cast<ELFYAML::RelocationSection>(Section.get()));
525 if (!IO.outputting())
526 Section.reset(new ELFYAML::RawContentSection());
527 sectionMapping(IO, *cast<ELFYAML::RawContentSection>(Section.get()));
531 StringRef MappingTraits<std::unique_ptr<ELFYAML::Section>>::validate(
532 IO &io, std::unique_ptr<ELFYAML::Section> &Section) {
533 const auto *RawSection = dyn_cast<ELFYAML::RawContentSection>(Section.get());
534 if (!RawSection || RawSection->Size >= RawSection->Content.binary_size())
536 return "Section size must be greater or equal to the content size";
539 void MappingTraits<ELFYAML::Relocation>::mapping(IO &IO,
540 ELFYAML::Relocation &Rel) {
541 IO.mapRequired("Offset", Rel.Offset);
542 IO.mapRequired("Symbol", Rel.Symbol);
543 IO.mapRequired("Type", Rel.Type);
544 IO.mapOptional("Addend", Rel.Addend);
547 void MappingTraits<ELFYAML::Object>::mapping(IO &IO, ELFYAML::Object &Object) {
548 assert(!IO.getContext() && "The IO context is initialized already");
549 IO.setContext(&Object);
550 IO.mapRequired("FileHeader", Object.Header);
551 IO.mapOptional("Sections", Object.Sections);
552 IO.mapOptional("Symbols", Object.Symbols);
553 IO.setContext(nullptr);
556 } // end namespace yaml
557 } // end namespace llvm