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 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_SHT)
  41 // Just use 64, since it can hold 32-bit values too.
  42 LLVM_YAML_STRONG_TYPEDEF(uint64_t, ELF_SHF)
  43 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STB)
  44 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STT)
  45
  46 // For now, hardcode 64 bits everywhere that 32 or 64 would be needed
  47 // since 64-bit can hold 32-bit values too.
  48 struct FileHeader {
  49   ELF_ELFCLASS Class;
  50   ELF_ELFDATA Data;
  51   ELF_ELFOSABI OSABI;
  52   ELF_ET Type;
  53   ELF_EM Machine;
  54   llvm::yaml::Hex64 Entry;
  55 };
  56 struct Symbol {
  57   StringRef Name;
  58   ELF_STB Binding;
  59   ELF_STT Type;
  60 };
  61 struct Section {
  62   StringRef Name;
  63   ELF_SHT Type;
  64   ELF_SHF Flags;
  65   llvm::yaml::Hex64 Address;
  66   object::yaml::BinaryRef Content;
  67   StringRef Link;
  68   llvm::yaml::Hex64 AddressAlign;
  69   // For SHT_SYMTAB; should be empty otherwise.
  70   std::vector<Symbol> Symbols;
  71 };
  72 struct Object {
  73   FileHeader Header;
  74   std::vector<Section> Sections;
  75 };
  76
  77 } // end namespace ELFYAML
  78 } // end namespace llvm
  79
  80 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Section)
  81 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Symbol)
  82
  83 namespace llvm {
  84 namespace yaml {
  85
  86 template <>
  87 struct ScalarEnumerationTraits<ELFYAML::ELF_ET> {
  88   static void enumeration(IO &IO, ELFYAML::ELF_ET &Value);
  89 };
  90
  91 template <>
  92 struct ScalarEnumerationTraits<ELFYAML::ELF_EM> {
  93   static void enumeration(IO &IO, ELFYAML::ELF_EM &Value);
  94 };
  95
  96 template <>
  97 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS> {
  98   static void enumeration(IO &IO, ELFYAML::ELF_ELFCLASS &Value);
  99 };
 100
 101 template <>
 102 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA> {
 103   static void enumeration(IO &IO, ELFYAML::ELF_ELFDATA &Value);
 104 };
 105
 106 template <>
 107 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI> {
 108   static void enumeration(IO &IO, ELFYAML::ELF_ELFOSABI &Value);
 109 };
 110
 111 template <>
 112 struct ScalarEnumerationTraits<ELFYAML::ELF_SHT> {
 113   static void enumeration(IO &IO, ELFYAML::ELF_SHT &Value);
 114 };
 115
 116 template <>
 117 struct ScalarBitSetTraits<ELFYAML::ELF_SHF> {
 118   static void bitset(IO &IO, ELFYAML::ELF_SHF &Value);
 119 };
 120
 121 template <>
 122 struct ScalarEnumerationTraits<ELFYAML::ELF_STB> {
 123   static void enumeration(IO &IO, ELFYAML::ELF_STB &Value);
 124 };
 125
 126 template <>
 127 struct ScalarEnumerationTraits<ELFYAML::ELF_STT> {
 128   static void enumeration(IO &IO, ELFYAML::ELF_STT &Value);
 129 };
 130
 131 template <>
 132 struct MappingTraits<ELFYAML::FileHeader> {
 133   static void mapping(IO &IO, ELFYAML::FileHeader &FileHdr);
 134 };
 135
 136 template <>
 137 struct MappingTraits<ELFYAML::Symbol> {
 138   static void mapping(IO &IO, ELFYAML::Symbol &Symbol);
 139 };
 140
 141 template <>
 142 struct MappingTraits<ELFYAML::Section> {
 143   static void mapping(IO &IO, ELFYAML::Section &Section);
 144 };
 145
 146 template <>
 147 struct MappingTraits<ELFYAML::Object> {
 148   static void mapping(IO &IO, ELFYAML::Object &Object);
 149 };
 150
 151 } // end namespace yaml
 152 } // end namespace llvm
 153
 154 #endif