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/Object/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(uint8_t, ELF_REL)
  44 // Just use 64, since it can hold 32-bit values too.
  45 LLVM_YAML_STRONG_TYPEDEF(uint64_t, ELF_SHF)
  46 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STT)
  47
  48 // For now, hardcode 64 bits everywhere that 32 or 64 would be needed
  49 // since 64-bit can hold 32-bit values too.
  50 struct FileHeader {
  51   ELF_ELFCLASS Class;
  52   ELF_ELFDATA Data;
  53   ELF_ELFOSABI OSABI;
  54   ELF_ET Type;
  55   ELF_EM Machine;
  56   ELF_EF Flags;
  57   llvm::yaml::Hex64 Entry;
  58 };
  59 struct Symbol {
  60   StringRef Name;
  61   ELF_STT Type;
  62   StringRef Section;
  63   llvm::yaml::Hex64 Value;
  64   llvm::yaml::Hex64 Size;
  65 };
  66 struct LocalGlobalWeakSymbols {
  67   std::vector<Symbol> Local;
  68   std::vector<Symbol> Global;
  69   std::vector<Symbol> Weak;
  70 };
  71 struct Section {
  72   enum class SectionKind { RawContent, Relocation };
  73   SectionKind Kind;
  74   StringRef Name;
  75   ELF_SHT Type;
  76   ELF_SHF Flags;
  77   llvm::yaml::Hex64 Address;
  78   StringRef Link;
  79   StringRef Info;
  80   llvm::yaml::Hex64 AddressAlign;
  81   Section(SectionKind Kind) : Kind(Kind) {}
  82 };
  83 struct RawContentSection : Section {
  84   object::yaml::BinaryRef Content;
  85   RawContentSection() : Section(SectionKind::RawContent) {}
  86   static bool classof(const Section *S) {
  87     return S->Kind == SectionKind::RawContent;
  88   }
  89 };
  90 struct Relocation {
  91   uint32_t Offset;
  92   uint32_t Addend;
  93   ELF_REL Type;
  94   StringRef Symbol;
  95 };
  96 struct RelocationSection : Section {
  97   std::vector<Relocation> Relocations;
  98   RelocationSection() : Section(SectionKind::Relocation) {}
  99   static bool classof(const Section *S) {
 100     return S->Kind == SectionKind::Relocation;
 101   }
 102 };
 103 struct Object {
 104   FileHeader Header;
 105   std::vector<std::unique_ptr<Section>> Sections;
 106   // Although in reality the symbols reside in a section, it is a lot
 107   // cleaner and nicer if we read them from the YAML as a separate
 108   // top-level key, which automatically ensures that invariants like there
 109   // being a single SHT_SYMTAB section are upheld.
 110   LocalGlobalWeakSymbols Symbols;
 111 };
 112
 113 } // end namespace ELFYAML
 114 } // end namespace llvm
 115
 116 LLVM_YAML_IS_SEQUENCE_VECTOR(std::unique_ptr<llvm::ELFYAML::Section>)
 117 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Symbol)
 118 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Relocation)
 119
 120 namespace llvm {
 121 namespace yaml {
 122
 123 template <>
 124 struct ScalarEnumerationTraits<ELFYAML::ELF_ET> {
 125   static void enumeration(IO &IO, ELFYAML::ELF_ET &Value);
 126 };
 127
 128 template <>
 129 struct ScalarEnumerationTraits<ELFYAML::ELF_EM> {
 130   static void enumeration(IO &IO, ELFYAML::ELF_EM &Value);
 131 };
 132
 133 template <>
 134 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS> {
 135   static void enumeration(IO &IO, ELFYAML::ELF_ELFCLASS &Value);
 136 };
 137
 138 template <>
 139 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA> {
 140   static void enumeration(IO &IO, ELFYAML::ELF_ELFDATA &Value);
 141 };
 142
 143 template <>
 144 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI> {
 145   static void enumeration(IO &IO, ELFYAML::ELF_ELFOSABI &Value);
 146 };
 147
 148 template <>
 149 struct ScalarBitSetTraits<ELFYAML::ELF_EF> {
 150   static void bitset(IO &IO, ELFYAML::ELF_EF &Value);
 151 };
 152
 153 template <>
 154 struct ScalarEnumerationTraits<ELFYAML::ELF_SHT> {
 155   static void enumeration(IO &IO, ELFYAML::ELF_SHT &Value);
 156 };
 157
 158 template <>
 159 struct ScalarBitSetTraits<ELFYAML::ELF_SHF> {
 160   static void bitset(IO &IO, ELFYAML::ELF_SHF &Value);
 161 };
 162
 163 template <>
 164 struct ScalarEnumerationTraits<ELFYAML::ELF_STT> {
 165   static void enumeration(IO &IO, ELFYAML::ELF_STT &Value);
 166 };
 167
 168 template <>
 169 struct ScalarEnumerationTraits<ELFYAML::ELF_REL> {
 170   static void enumeration(IO &IO, ELFYAML::ELF_REL &Value);
 171 };
 172
 173 template <>
 174 struct MappingTraits<ELFYAML::FileHeader> {
 175   static void mapping(IO &IO, ELFYAML::FileHeader &FileHdr);
 176 };
 177
 178 template <>
 179 struct MappingTraits<ELFYAML::Symbol> {
 180   static void mapping(IO &IO, ELFYAML::Symbol &Symbol);
 181 };
 182
 183 template <>
 184 struct MappingTraits<ELFYAML::LocalGlobalWeakSymbols> {
 185   static void mapping(IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols);
 186 };
 187
 188 template <> struct MappingTraits<ELFYAML::Relocation> {
 189   static void mapping(IO &IO, ELFYAML::Relocation &Rel);
 190 };
 191
 192 template <>
 193 struct MappingTraits<std::unique_ptr<ELFYAML::Section>> {
 194   static void mapping(IO &IO, std::unique_ptr<ELFYAML::Section> &Section);
 195 };
 196
 197 template <>
 198 struct MappingTraits<ELFYAML::Object> {
 199   static void mapping(IO &IO, ELFYAML::Object &Object);
 200 };
 201
 202 } // end namespace yaml
 203 } // end namespace llvm
 204
 205 #endif