1 //===- ELFYAML.h - ELF YAMLIO implementation --------------------*- C++ -*-===//
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 //===----------------------------------------------------------------------===//
11 /// \brief This file declares classes for handling the YAML representation
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_OBJECT_ELFYAML_H
17 #define LLVM_OBJECT_ELFYAML_H
19 #include "llvm/Object/YAML.h"
20 #include "llvm/Support/ELF.h"
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_STT)
45 // For now, hardcode 64 bits everywhere that 32 or 64 would be needed
46 // since 64-bit can hold 32-bit values too.
53 llvm::yaml::Hex64 Entry;
59 llvm::yaml::Hex64 Value;
60 llvm::yaml::Hex64 Size;
62 struct LocalGlobalWeakSymbols {
63 std::vector<Symbol> Local;
64 std::vector<Symbol> Global;
65 std::vector<Symbol> Weak;
71 llvm::yaml::Hex64 Address;
72 object::yaml::BinaryRef Content;
74 llvm::yaml::Hex64 AddressAlign;
78 std::vector<Section> Sections;
79 // Although in reality the symbols reside in a section, it is a lot
80 // cleaner and nicer if we read them from the YAML as a separate
81 // top-level key, which automatically ensures that invariants like there
82 // being a single SHT_SYMTAB section are upheld.
83 LocalGlobalWeakSymbols Symbols;
86 } // end namespace ELFYAML
87 } // end namespace llvm
89 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Section)
90 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Symbol)
96 struct ScalarEnumerationTraits<ELFYAML::ELF_ET> {
97 static void enumeration(IO &IO, ELFYAML::ELF_ET &Value);
101 struct ScalarEnumerationTraits<ELFYAML::ELF_EM> {
102 static void enumeration(IO &IO, ELFYAML::ELF_EM &Value);
106 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS> {
107 static void enumeration(IO &IO, ELFYAML::ELF_ELFCLASS &Value);
111 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA> {
112 static void enumeration(IO &IO, ELFYAML::ELF_ELFDATA &Value);
116 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI> {
117 static void enumeration(IO &IO, ELFYAML::ELF_ELFOSABI &Value);
121 struct ScalarEnumerationTraits<ELFYAML::ELF_SHT> {
122 static void enumeration(IO &IO, ELFYAML::ELF_SHT &Value);
126 struct ScalarBitSetTraits<ELFYAML::ELF_SHF> {
127 static void bitset(IO &IO, ELFYAML::ELF_SHF &Value);
131 struct ScalarEnumerationTraits<ELFYAML::ELF_STT> {
132 static void enumeration(IO &IO, ELFYAML::ELF_STT &Value);
136 struct MappingTraits<ELFYAML::FileHeader> {
137 static void mapping(IO &IO, ELFYAML::FileHeader &FileHdr);
141 struct MappingTraits<ELFYAML::Symbol> {
142 static void mapping(IO &IO, ELFYAML::Symbol &Symbol);
146 struct MappingTraits<ELFYAML::LocalGlobalWeakSymbols> {
147 static void mapping(IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols);
151 struct MappingTraits<ELFYAML::Section> {
152 static void mapping(IO &IO, ELFYAML::Section &Section);
156 struct MappingTraits<ELFYAML::Object> {
157 static void mapping(IO &IO, ELFYAML::Object &Object);
160 } // end namespace yaml
161 } // end namespace llvm