include/llvm/ObjectYAML/ELFYAML.h

   1 //===- ELFYAML.h - ELF YAMLIO implementation --------------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 ///
   9 /// \file
  10 /// This file declares classes for handling the YAML representation
  11 /// of ELF.
  12 ///
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_OBJECTYAML_ELFYAML_H
  16 #define LLVM_OBJECTYAML_ELFYAML_H
  17
  18 #include "llvm/ADT/StringRef.h"
  19 #include "llvm/ObjectYAML/YAML.h"
  20 #include "llvm/Support/YAMLTraits.h"
  21 #include <cstdint>
  22 #include <memory>
  23 #include <vector>
  24
  25 namespace llvm {
  26 namespace ELFYAML {
  27
  28 // These types are invariant across 32/64-bit ELF, so for simplicity just
  29 // directly give them their exact sizes. We don't need to worry about
  30 // endianness because these are just the types in the YAMLIO structures,
  31 // and are appropriately converted to the necessary endianness when
  32 // reading/generating binary object files.
  33 // The naming of these types is intended to be ELF_PREFIX, where PREFIX is
  34 // the common prefix of the respective constants. E.g. ELF_EM corresponds
  35 // to the `e_machine` constants, like `EM_X86_64`.
  36 // In the future, these would probably be better suited by C++11 enum
  37 // class's with appropriate fixed underlying type.
  38 LLVM_YAML_STRONG_TYPEDEF(uint16_t, ELF_ET)
  39 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_PT)
  40 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_EM)
  41 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_ELFCLASS)
  42 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_ELFDATA)
  43 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_ELFOSABI)
  44 // Just use 64, since it can hold 32-bit values too.
  45 LLVM_YAML_STRONG_TYPEDEF(uint64_t, ELF_EF)
  46 // Just use 64, since it can hold 32-bit values too.
  47 LLVM_YAML_STRONG_TYPEDEF(uint64_t, ELF_DYNTAG)
  48 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_PF)
  49 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_SHT)
  50 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_REL)
  51 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_RSS)
  52 // Just use 64, since it can hold 32-bit values too.
  53 LLVM_YAML_STRONG_TYPEDEF(uint64_t, ELF_SHF)
  54 LLVM_YAML_STRONG_TYPEDEF(uint16_t, ELF_SHN)
  55 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STB)
  56 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STT)
  57
  58 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
  59 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
  60 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
  61 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
  62 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
  63 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_ISA)
  64
  65 // For now, hardcode 64 bits everywhere that 32 or 64 would be needed
  66 // since 64-bit can hold 32-bit values too.
  67 struct FileHeader {
  68   ELF_ELFCLASS Class;
  69   ELF_ELFDATA Data;
  70   ELF_ELFOSABI OSABI;
  71   llvm::yaml::Hex8 ABIVersion;
  72   ELF_ET Type;
  73   ELF_EM Machine;
  74   ELF_EF Flags;
  75   llvm::yaml::Hex64 Entry;
  76
  77   Optional<llvm::yaml::Hex16> SHEntSize;
  78   Optional<llvm::yaml::Hex64> SHOff;
  79   Optional<llvm::yaml::Hex16> SHNum;
  80   Optional<llvm::yaml::Hex16> SHStrNdx;
  81 };
  82
  83 struct SectionName {
  84   StringRef Section;
  85 };
  86
  87 struct ProgramHeader {
  88   ELF_PT Type;
  89   ELF_PF Flags;
  90   llvm::yaml::Hex64 VAddr;
  91   llvm::yaml::Hex64 PAddr;
  92   Optional<llvm::yaml::Hex64> Align;
  93   Optional<llvm::yaml::Hex64> FileSize;
  94   Optional<llvm::yaml::Hex64> MemSize;
  95   Optional<llvm::yaml::Hex64> Offset;
  96   std::vector<SectionName> Sections;
  97 };
  98
  99 struct Symbol {
 100   StringRef Name;
 101   Optional<uint32_t> NameIndex;
 102   ELF_STT Type;
 103   StringRef Section;
 104   Optional<ELF_SHN> Index;
 105   ELF_STB Binding;
 106   llvm::yaml::Hex64 Value;
 107   llvm::yaml::Hex64 Size;
 108   Optional<uint8_t> Other;
 109 };
 110
 111 struct SectionOrType {
 112   StringRef sectionNameOrType;
 113 };
 114
 115 struct DynamicEntry {
 116   ELF_DYNTAG Tag;
 117   llvm::yaml::Hex64 Val;
 118 };
 119
 120 struct StackSizeEntry {
 121   llvm::yaml::Hex64 Address;
 122   llvm::yaml::Hex64 Size;
 123 };
 124
 125 struct Section {
 126   enum class SectionKind {
 127     Dynamic,
 128     Group,
 129     RawContent,
 130     Relocation,
 131     NoBits,
 132     Verdef,
 133     Verneed,
 134     StackSizes,
 135     SymtabShndxSection,
 136     Symver,
 137     MipsABIFlags
 138   };
 139   SectionKind Kind;
 140   StringRef Name;
 141   ELF_SHT Type;
 142   Optional<ELF_SHF> Flags;
 143   llvm::yaml::Hex64 Address;
 144   StringRef Link;
 145   llvm::yaml::Hex64 AddressAlign;
 146   Optional<llvm::yaml::Hex64> EntSize;
 147
 148   // Usually sections are not created implicitly, but loaded from YAML.
 149   // When they are, this flag is used to signal about that.
 150   bool IsImplicit;
 151
 152   Section(SectionKind Kind, bool IsImplicit = false)
 153       : Kind(Kind), IsImplicit(IsImplicit) {}
 154   virtual ~Section();
 155
 156   // The following members are used to override section fields which is
 157   // useful for creating invalid objects.
 158
 159   // This can be used to override the offset stored in the sh_name field.
 160   // It does not affect the name stored in the string table.
 161   Optional<llvm::yaml::Hex64> ShName;
 162
 163   // This can be used to override the sh_offset field. It does not place the
 164   // section data at the offset specified.
 165   Optional<llvm::yaml::Hex64> ShOffset;
 166
 167   // This can be used to override the sh_size field. It does not affect the
 168   // content written.
 169   Optional<llvm::yaml::Hex64> ShSize;
 170 };
 171
 172 struct StackSizesSection : Section {
 173   Optional<yaml::BinaryRef> Content;
 174   Optional<std::vector<StackSizeEntry>> Entries;
 175
 176   StackSizesSection() : Section(SectionKind::StackSizes) {}
 177
 178   static bool classof(const Section *S) {
 179     return S->Kind == SectionKind::StackSizes;
 180   }
 181
 182   static bool nameMatches(StringRef Name) {
 183     return Name == ".stack_sizes";
 184   }
 185 };
 186
 187 struct DynamicSection : Section {
 188   std::vector<DynamicEntry> Entries;
 189   Optional<yaml::BinaryRef> Content;
 190
 191   DynamicSection() : Section(SectionKind::Dynamic) {}
 192
 193   static bool classof(const Section *S) {
 194     return S->Kind == SectionKind::Dynamic;
 195   }
 196 };
 197
 198 struct RawContentSection : Section {
 199   Optional<yaml::BinaryRef> Content;
 200   Optional<llvm::yaml::Hex64> Size;
 201   Optional<llvm::yaml::Hex64> Info;
 202
 203   RawContentSection() : Section(SectionKind::RawContent) {}
 204
 205   static bool classof(const Section *S) {
 206     return S->Kind == SectionKind::RawContent;
 207   }
 208 };
 209
 210 struct NoBitsSection : Section {
 211   llvm::yaml::Hex64 Size;
 212
 213   NoBitsSection() : Section(SectionKind::NoBits) {}
 214
 215   static bool classof(const Section *S) {
 216     return S->Kind == SectionKind::NoBits;
 217   }
 218 };
 219
 220 struct VernauxEntry {
 221   uint32_t Hash;
 222   uint16_t Flags;
 223   uint16_t Other;
 224   StringRef Name;
 225 };
 226
 227 struct VerneedEntry {
 228   uint16_t Version;
 229   StringRef File;
 230   std::vector<VernauxEntry> AuxV;
 231 };
 232
 233 struct VerneedSection : Section {
 234   std::vector<VerneedEntry> VerneedV;
 235   llvm::yaml::Hex64 Info;
 236
 237   VerneedSection() : Section(SectionKind::Verneed) {}
 238
 239   static bool classof(const Section *S) {
 240     return S->Kind == SectionKind::Verneed;
 241   }
 242 };
 243
 244 struct SymverSection : Section {
 245   std::vector<uint16_t> Entries;
 246
 247   SymverSection() : Section(SectionKind::Symver) {}
 248
 249   static bool classof(const Section *S) {
 250     return S->Kind == SectionKind::Symver;
 251   }
 252 };
 253
 254 struct VerdefEntry {
 255   uint16_t Version;
 256   uint16_t Flags;
 257   uint16_t VersionNdx;
 258   uint32_t Hash;
 259   std::vector<StringRef> VerNames;
 260 };
 261
 262 struct VerdefSection : Section {
 263   std::vector<VerdefEntry> Entries;
 264   llvm::yaml::Hex64 Info;
 265
 266   VerdefSection() : Section(SectionKind::Verdef) {}
 267
 268   static bool classof(const Section *S) {
 269     return S->Kind == SectionKind::Verdef;
 270   }
 271 };
 272
 273 struct Group : Section {
 274   // Members of a group contain a flag and a list of section indices
 275   // that are part of the group.
 276   std::vector<SectionOrType> Members;
 277   StringRef Signature; /* Info */
 278
 279   Group() : Section(SectionKind::Group) {}
 280
 281   static bool classof(const Section *S) {
 282     return S->Kind == SectionKind::Group;
 283   }
 284 };
 285
 286 struct Relocation {
 287   llvm::yaml::Hex64 Offset;
 288   int64_t Addend;
 289   ELF_REL Type;
 290   Optional<StringRef> Symbol;
 291 };
 292
 293 struct RelocationSection : Section {
 294   std::vector<Relocation> Relocations;
 295   StringRef RelocatableSec; /* Info */
 296
 297   RelocationSection() : Section(SectionKind::Relocation) {}
 298
 299   static bool classof(const Section *S) {
 300     return S->Kind == SectionKind::Relocation;
 301   }
 302 };
 303
 304 struct SymtabShndxSection : Section {
 305   std::vector<uint32_t> Entries;
 306
 307   SymtabShndxSection() : Section(SectionKind::SymtabShndxSection) {}
 308
 309   static bool classof(const Section *S) {
 310     return S->Kind == SectionKind::SymtabShndxSection;
 311   }
 312 };
 313
 314 // Represents .MIPS.abiflags section
 315 struct MipsABIFlags : Section {
 316   llvm::yaml::Hex16 Version;
 317   MIPS_ISA ISALevel;
 318   llvm::yaml::Hex8 ISARevision;
 319   MIPS_AFL_REG GPRSize;
 320   MIPS_AFL_REG CPR1Size;
 321   MIPS_AFL_REG CPR2Size;
 322   MIPS_ABI_FP FpABI;
 323   MIPS_AFL_EXT ISAExtension;
 324   MIPS_AFL_ASE ASEs;
 325   MIPS_AFL_FLAGS1 Flags1;
 326   llvm::yaml::Hex32 Flags2;
 327
 328   MipsABIFlags() : Section(SectionKind::MipsABIFlags) {}
 329
 330   static bool classof(const Section *S) {
 331     return S->Kind == SectionKind::MipsABIFlags;
 332   }
 333 };
 334
 335 struct Object {
 336   FileHeader Header;
 337   std::vector<ProgramHeader> ProgramHeaders;
 338   std::vector<std::unique_ptr<Section>> Sections;
 339   // Although in reality the symbols reside in a section, it is a lot
 340   // cleaner and nicer if we read them from the YAML as a separate
 341   // top-level key, which automatically ensures that invariants like there
 342   // being a single SHT_SYMTAB section are upheld.
 343   std::vector<Symbol> Symbols;
 344   std::vector<Symbol> DynamicSymbols;
 345 };
 346
 347 } // end namespace ELFYAML
 348 } // end namespace llvm
 349
 350 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::StackSizeEntry)
 351 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::DynamicEntry)
 352 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::ProgramHeader)
 353 LLVM_YAML_IS_SEQUENCE_VECTOR(std::unique_ptr<llvm::ELFYAML::Section>)
 354 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Symbol)
 355 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::VerdefEntry)
 356 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::VernauxEntry)
 357 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::VerneedEntry)
 358 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Relocation)
 359 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::SectionOrType)
 360 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::SectionName)
 361
 362 namespace llvm {
 363 namespace yaml {
 364
 365 template <>
 366 struct ScalarEnumerationTraits<ELFYAML::ELF_ET> {
 367   static void enumeration(IO &IO, ELFYAML::ELF_ET &Value);
 368 };
 369
 370 template <> struct ScalarEnumerationTraits<ELFYAML::ELF_PT> {
 371   static void enumeration(IO &IO, ELFYAML::ELF_PT &Value);
 372 };
 373
 374 template <>
 375 struct ScalarEnumerationTraits<ELFYAML::ELF_EM> {
 376   static void enumeration(IO &IO, ELFYAML::ELF_EM &Value);
 377 };
 378
 379 template <>
 380 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS> {
 381   static void enumeration(IO &IO, ELFYAML::ELF_ELFCLASS &Value);
 382 };
 383
 384 template <>
 385 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA> {
 386   static void enumeration(IO &IO, ELFYAML::ELF_ELFDATA &Value);
 387 };
 388
 389 template <>
 390 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI> {
 391   static void enumeration(IO &IO, ELFYAML::ELF_ELFOSABI &Value);
 392 };
 393
 394 template <>
 395 struct ScalarBitSetTraits<ELFYAML::ELF_EF> {
 396   static void bitset(IO &IO, ELFYAML::ELF_EF &Value);
 397 };
 398
 399 template <> struct ScalarBitSetTraits<ELFYAML::ELF_PF> {
 400   static void bitset(IO &IO, ELFYAML::ELF_PF &Value);
 401 };
 402
 403 template <>
 404 struct ScalarEnumerationTraits<ELFYAML::ELF_SHT> {
 405   static void enumeration(IO &IO, ELFYAML::ELF_SHT &Value);
 406 };
 407
 408 template <>
 409 struct ScalarBitSetTraits<ELFYAML::ELF_SHF> {
 410   static void bitset(IO &IO, ELFYAML::ELF_SHF &Value);
 411 };
 412
 413 template <> struct ScalarEnumerationTraits<ELFYAML::ELF_SHN> {
 414   static void enumeration(IO &IO, ELFYAML::ELF_SHN &Value);
 415 };
 416
 417 template <> struct ScalarEnumerationTraits<ELFYAML::ELF_STB> {
 418   static void enumeration(IO &IO, ELFYAML::ELF_STB &Value);
 419 };
 420
 421 template <>
 422 struct ScalarEnumerationTraits<ELFYAML::ELF_STT> {
 423   static void enumeration(IO &IO, ELFYAML::ELF_STT &Value);
 424 };
 425
 426 template <>
 427 struct ScalarEnumerationTraits<ELFYAML::ELF_REL> {
 428   static void enumeration(IO &IO, ELFYAML::ELF_REL &Value);
 429 };
 430
 431 template <>
 432 struct ScalarEnumerationTraits<ELFYAML::ELF_DYNTAG> {
 433   static void enumeration(IO &IO, ELFYAML::ELF_DYNTAG &Value);
 434 };
 435
 436 template <>
 437 struct ScalarEnumerationTraits<ELFYAML::ELF_RSS> {
 438   static void enumeration(IO &IO, ELFYAML::ELF_RSS &Value);
 439 };
 440
 441 template <>
 442 struct ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG> {
 443   static void enumeration(IO &IO, ELFYAML::MIPS_AFL_REG &Value);
 444 };
 445
 446 template <>
 447 struct ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP> {
 448   static void enumeration(IO &IO, ELFYAML::MIPS_ABI_FP &Value);
 449 };
 450
 451 template <>
 452 struct ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT> {
 453   static void enumeration(IO &IO, ELFYAML::MIPS_AFL_EXT &Value);
 454 };
 455
 456 template <>
 457 struct ScalarEnumerationTraits<ELFYAML::MIPS_ISA> {
 458   static void enumeration(IO &IO, ELFYAML::MIPS_ISA &Value);
 459 };
 460
 461 template <>
 462 struct ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE> {
 463   static void bitset(IO &IO, ELFYAML::MIPS_AFL_ASE &Value);
 464 };
 465
 466 template <>
 467 struct ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1> {
 468   static void bitset(IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value);
 469 };
 470
 471 template <>
 472 struct MappingTraits<ELFYAML::FileHeader> {
 473   static void mapping(IO &IO, ELFYAML::FileHeader &FileHdr);
 474 };
 475
 476 template <> struct MappingTraits<ELFYAML::ProgramHeader> {
 477   static void mapping(IO &IO, ELFYAML::ProgramHeader &FileHdr);
 478 };
 479
 480 template <>
 481 struct MappingTraits<ELFYAML::Symbol> {
 482   static void mapping(IO &IO, ELFYAML::Symbol &Symbol);
 483   static StringRef validate(IO &IO, ELFYAML::Symbol &Symbol);
 484 };
 485
 486 template <> struct MappingTraits<ELFYAML::StackSizeEntry> {
 487   static void mapping(IO &IO, ELFYAML::StackSizeEntry &Rel);
 488 };
 489
 490 template <> struct MappingTraits<ELFYAML::DynamicEntry> {
 491   static void mapping(IO &IO, ELFYAML::DynamicEntry &Rel);
 492 };
 493
 494 template <> struct MappingTraits<ELFYAML::VerdefEntry> {
 495   static void mapping(IO &IO, ELFYAML::VerdefEntry &E);
 496 };
 497
 498 template <> struct MappingTraits<ELFYAML::VerneedEntry> {
 499   static void mapping(IO &IO, ELFYAML::VerneedEntry &E);
 500 };
 501
 502 template <> struct MappingTraits<ELFYAML::VernauxEntry> {
 503   static void mapping(IO &IO, ELFYAML::VernauxEntry &E);
 504 };
 505
 506 template <> struct MappingTraits<ELFYAML::Relocation> {
 507   static void mapping(IO &IO, ELFYAML::Relocation &Rel);
 508 };
 509
 510 template <>
 511 struct MappingTraits<std::unique_ptr<ELFYAML::Section>> {
 512   static void mapping(IO &IO, std::unique_ptr<ELFYAML::Section> &Section);
 513   static StringRef validate(IO &io, std::unique_ptr<ELFYAML::Section> &Section);
 514 };
 515
 516 template <>
 517 struct MappingTraits<ELFYAML::Object> {
 518   static void mapping(IO &IO, ELFYAML::Object &Object);
 519 };
 520
 521 template <> struct MappingTraits<ELFYAML::SectionOrType> {
 522   static void mapping(IO &IO, ELFYAML::SectionOrType &sectionOrType);
 523 };
 524
 525 template <> struct MappingTraits<ELFYAML::SectionName> {
 526   static void mapping(IO &IO, ELFYAML::SectionName &sectionName);
 527 };
 528
 529 } // end namespace yaml
 530 } // end namespace llvm
 531
 532 #endif // LLVM_OBJECTYAML_ELFYAML_H