include/llvm/Object/ELFYAML.h

   1 //===- ELFYAML.h - ELF YAMLIO implementation --------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 ///
  10 /// \file
  11 /// \brief This file declares classes for handling the YAML representation
  12 /// of ELF.
  13 ///
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_OBJECT_ELFYAML_H
  17 #define LLVM_OBJECT_ELFYAML_H
  18
  19 #include "llvm/MC/YAML.h"
  20 #include "llvm/Support/ELF.h"
  21
  22 namespace llvm {
  23 namespace ELFYAML {
  24
  25 // These types are invariant across 32/64-bit ELF, so for simplicity just
  26 // directly give them their exact sizes. We don't need to worry about
  27 // endianness because these are just the types in the YAMLIO structures,
  28 // and are appropriately converted to the necessary endianness when
  29 // reading/generating binary object files.
  30 // The naming of these types is intended to be ELF_PREFIX, where PREFIX is
  31 // the common prefix of the respective constants. E.g. ELF_EM corresponds
  32 // to the `e_machine` constants, like `EM_X86_64`.
  33 // In the future, these would probably be better suited by C++11 enum
  34 // class's with appropriate fixed underlying type.
  35 LLVM_YAML_STRONG_TYPEDEF(uint16_t, ELF_ET)
  36 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_EM)
  37 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_ELFCLASS)
  38 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_ELFDATA)
  39 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_ELFOSABI)
  40 // Just use 64, since it can hold 32-bit values too.
  41 LLVM_YAML_STRONG_TYPEDEF(uint64_t, ELF_EF)
  42 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_SHT)
  43 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_REL)
  44 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_RSS)
  45 // Just use 64, since it can hold 32-bit values too.
  46 LLVM_YAML_STRONG_TYPEDEF(uint64_t, ELF_SHF)
  47 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STT)
  48 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STV)
  49 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STO)
  50
  51 // For now, hardcode 64 bits everywhere that 32 or 64 would be needed
  52 // since 64-bit can hold 32-bit values too.
  53 struct FileHeader {
  54   ELF_ELFCLASS Class;
  55   ELF_ELFDATA Data;
  56   ELF_ELFOSABI OSABI;
  57   ELF_ET Type;
  58   ELF_EM Machine;
  59   ELF_EF Flags;
  60   llvm::yaml::Hex64 Entry;
  61 };
  62 struct Symbol {
  63   StringRef Name;
  64   ELF_STT Type;
  65   StringRef Section;
  66   llvm::yaml::Hex64 Value;
  67   llvm::yaml::Hex64 Size;
  68   uint8_t Other;
  69 };
  70 struct LocalGlobalWeakSymbols {
  71   std::vector<Symbol> Local;
  72   std::vector<Symbol> Global;
  73   std::vector<Symbol> Weak;
  74 };
  75 struct Section {
  76   enum class SectionKind { RawContent, Relocation };
  77   SectionKind Kind;
  78   StringRef Name;
  79   ELF_SHT Type;
  80   ELF_SHF Flags;
  81   llvm::yaml::Hex64 Address;
  82   StringRef Link;
  83   llvm::yaml::Hex64 AddressAlign;
  84   Section(SectionKind Kind) : Kind(Kind) {}
  85   virtual ~Section();
  86 };
  87 struct RawContentSection : Section {
  88   yaml::BinaryRef Content;
  89   llvm::yaml::Hex64 Size;
  90   RawContentSection() : Section(SectionKind::RawContent) {}
  91   static bool classof(const Section *S) {
  92     return S->Kind == SectionKind::RawContent;
  93   }
  94 };
  95 struct Relocation {
  96   llvm::yaml::Hex64 Offset;
  97   int64_t Addend;
  98   ELF_REL Type;
  99   StringRef Symbol;
 100 };
 101 struct RelocationSection : Section {
 102   StringRef Info;
 103   std::vector<Relocation> Relocations;
 104   RelocationSection() : Section(SectionKind::Relocation) {}
 105   static bool classof(const Section *S) {
 106     return S->Kind == SectionKind::Relocation;
 107   }
 108 };
 109 struct Object {
 110   FileHeader Header;
 111   std::vector<std::unique_ptr<Section>> Sections;
 112   // Although in reality the symbols reside in a section, it is a lot
 113   // cleaner and nicer if we read them from the YAML as a separate
 114   // top-level key, which automatically ensures that invariants like there
 115   // being a single SHT_SYMTAB section are upheld.
 116   LocalGlobalWeakSymbols Symbols;
 117 };
 118
 119 } // end namespace ELFYAML
 120 } // end namespace llvm
 121
 122 LLVM_YAML_IS_SEQUENCE_VECTOR(std::unique_ptr<llvm::ELFYAML::Section>)
 123 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Symbol)
 124 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Relocation)
 125
 126 namespace llvm {
 127 namespace yaml {
 128
 129 template <>
 130 struct ScalarEnumerationTraits<ELFYAML::ELF_ET> {
 131   static void enumeration(IO &IO, ELFYAML::ELF_ET &Value);
 132 };
 133
 134 template <>
 135 struct ScalarEnumerationTraits<ELFYAML::ELF_EM> {
 136   static void enumeration(IO &IO, ELFYAML::ELF_EM &Value);
 137 };
 138
 139 template <>
 140 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS> {
 141   static void enumeration(IO &IO, ELFYAML::ELF_ELFCLASS &Value);
 142 };
 143
 144 template <>
 145 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA> {
 146   static void enumeration(IO &IO, ELFYAML::ELF_ELFDATA &Value);
 147 };
 148
 149 template <>
 150 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI> {
 151   static void enumeration(IO &IO, ELFYAML::ELF_ELFOSABI &Value);
 152 };
 153
 154 template <>
 155 struct ScalarBitSetTraits<ELFYAML::ELF_EF> {
 156   static void bitset(IO &IO, ELFYAML::ELF_EF &Value);
 157 };
 158
 159 template <>
 160 struct ScalarEnumerationTraits<ELFYAML::ELF_SHT> {
 161   static void enumeration(IO &IO, ELFYAML::ELF_SHT &Value);
 162 };
 163
 164 template <>
 165 struct ScalarBitSetTraits<ELFYAML::ELF_SHF> {
 166   static void bitset(IO &IO, ELFYAML::ELF_SHF &Value);
 167 };
 168
 169 template <>
 170 struct ScalarEnumerationTraits<ELFYAML::ELF_STT> {
 171   static void enumeration(IO &IO, ELFYAML::ELF_STT &Value);
 172 };
 173
 174 template <>
 175 struct ScalarEnumerationTraits<ELFYAML::ELF_STV> {
 176   static void enumeration(IO &IO, ELFYAML::ELF_STV &Value);
 177 };
 178
 179 template <>
 180 struct ScalarBitSetTraits<ELFYAML::ELF_STO> {
 181   static void bitset(IO &IO, ELFYAML::ELF_STO &Value);
 182 };
 183
 184 template <>
 185 struct ScalarEnumerationTraits<ELFYAML::ELF_REL> {
 186   static void enumeration(IO &IO, ELFYAML::ELF_REL &Value);
 187 };
 188
 189 template <>
 190 struct ScalarEnumerationTraits<ELFYAML::ELF_RSS> {
 191   static void enumeration(IO &IO, ELFYAML::ELF_RSS &Value);
 192 };
 193
 194 template <>
 195 struct MappingTraits<ELFYAML::FileHeader> {
 196   static void mapping(IO &IO, ELFYAML::FileHeader &FileHdr);
 197 };
 198
 199 template <>
 200 struct MappingTraits<ELFYAML::Symbol> {
 201   static void mapping(IO &IO, ELFYAML::Symbol &Symbol);
 202 };
 203
 204 template <>
 205 struct MappingTraits<ELFYAML::LocalGlobalWeakSymbols> {
 206   static void mapping(IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols);
 207 };
 208
 209 template <> struct MappingTraits<ELFYAML::Relocation> {
 210   static void mapping(IO &IO, ELFYAML::Relocation &Rel);
 211 };
 212
 213 template <>
 214 struct MappingTraits<std::unique_ptr<ELFYAML::Section>> {
 215   static void mapping(IO &IO, std::unique_ptr<ELFYAML::Section> &Section);
 216   static StringRef validate(IO &io, std::unique_ptr<ELFYAML::Section> &Section);
 217 };
 218
 219 template <>
 220 struct MappingTraits<ELFYAML::Object> {
 221   static void mapping(IO &IO, ELFYAML::Object &Object);
 222 };
 223
 224 } // end namespace yaml
 225 } // end namespace llvm
 226
 227 #endif