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/MC/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 // 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)
51 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
52 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
53 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
54 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
55 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
56 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_ISA)
58 // For now, hardcode 64 bits everywhere that 32 or 64 would be needed
59 // since 64-bit can hold 32-bit values too.
67 llvm::yaml::Hex64 Entry;
73 llvm::yaml::Hex64 Value;
74 llvm::yaml::Hex64 Size;
77 struct LocalGlobalWeakSymbols {
78 std::vector<Symbol> Local;
79 std::vector<Symbol> Global;
80 std::vector<Symbol> Weak;
83 struct SectionOrType {
84 StringRef sectionNameOrType;
88 enum class SectionKind { Group, RawContent, Relocation, MipsABIFlags };
93 llvm::yaml::Hex64 Address;
96 llvm::yaml::Hex64 AddressAlign;
97 Section(SectionKind Kind) : Kind(Kind) {}
100 struct RawContentSection : Section {
101 yaml::BinaryRef Content;
102 llvm::yaml::Hex64 Size;
103 RawContentSection() : Section(SectionKind::RawContent) {}
104 static bool classof(const Section *S) {
105 return S->Kind == SectionKind::RawContent;
109 struct Group : Section {
110 // Members of a group contain a flag and a list of section indices
111 // that are part of the group.
112 std::vector<SectionOrType> Members;
113 Group() : Section(SectionKind::Group) {}
114 static bool classof(const Section *S) {
115 return S->Kind == SectionKind::Group;
120 llvm::yaml::Hex64 Offset;
125 struct RelocationSection : Section {
126 std::vector<Relocation> Relocations;
127 RelocationSection() : Section(SectionKind::Relocation) {}
128 static bool classof(const Section *S) {
129 return S->Kind == SectionKind::Relocation;
133 // Represents .MIPS.abiflags section
134 struct MipsABIFlags : Section {
135 llvm::yaml::Hex16 Version;
137 llvm::yaml::Hex8 ISARevision;
138 MIPS_AFL_REG GPRSize;
139 MIPS_AFL_REG CPR1Size;
140 MIPS_AFL_REG CPR2Size;
142 MIPS_AFL_EXT ISAExtension;
144 MIPS_AFL_FLAGS1 Flags1;
145 llvm::yaml::Hex32 Flags2;
146 MipsABIFlags() : Section(SectionKind::MipsABIFlags) {}
147 static bool classof(const Section *S) {
148 return S->Kind == SectionKind::MipsABIFlags;
154 std::vector<std::unique_ptr<Section>> Sections;
155 // Although in reality the symbols reside in a section, it is a lot
156 // cleaner and nicer if we read them from the YAML as a separate
157 // top-level key, which automatically ensures that invariants like there
158 // being a single SHT_SYMTAB section are upheld.
159 LocalGlobalWeakSymbols Symbols;
162 } // end namespace ELFYAML
163 } // end namespace llvm
165 LLVM_YAML_IS_SEQUENCE_VECTOR(std::unique_ptr<llvm::ELFYAML::Section>)
166 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Symbol)
167 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Relocation)
168 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::SectionOrType)
174 struct ScalarEnumerationTraits<ELFYAML::ELF_ET> {
175 static void enumeration(IO &IO, ELFYAML::ELF_ET &Value);
179 struct ScalarEnumerationTraits<ELFYAML::ELF_EM> {
180 static void enumeration(IO &IO, ELFYAML::ELF_EM &Value);
184 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS> {
185 static void enumeration(IO &IO, ELFYAML::ELF_ELFCLASS &Value);
189 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA> {
190 static void enumeration(IO &IO, ELFYAML::ELF_ELFDATA &Value);
194 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI> {
195 static void enumeration(IO &IO, ELFYAML::ELF_ELFOSABI &Value);
199 struct ScalarBitSetTraits<ELFYAML::ELF_EF> {
200 static void bitset(IO &IO, ELFYAML::ELF_EF &Value);
204 struct ScalarEnumerationTraits<ELFYAML::ELF_SHT> {
205 static void enumeration(IO &IO, ELFYAML::ELF_SHT &Value);
209 struct ScalarBitSetTraits<ELFYAML::ELF_SHF> {
210 static void bitset(IO &IO, ELFYAML::ELF_SHF &Value);
214 struct ScalarEnumerationTraits<ELFYAML::ELF_STT> {
215 static void enumeration(IO &IO, ELFYAML::ELF_STT &Value);
219 struct ScalarEnumerationTraits<ELFYAML::ELF_STV> {
220 static void enumeration(IO &IO, ELFYAML::ELF_STV &Value);
224 struct ScalarBitSetTraits<ELFYAML::ELF_STO> {
225 static void bitset(IO &IO, ELFYAML::ELF_STO &Value);
229 struct ScalarEnumerationTraits<ELFYAML::ELF_REL> {
230 static void enumeration(IO &IO, ELFYAML::ELF_REL &Value);
234 struct ScalarEnumerationTraits<ELFYAML::ELF_RSS> {
235 static void enumeration(IO &IO, ELFYAML::ELF_RSS &Value);
239 struct ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG> {
240 static void enumeration(IO &IO, ELFYAML::MIPS_AFL_REG &Value);
244 struct ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP> {
245 static void enumeration(IO &IO, ELFYAML::MIPS_ABI_FP &Value);
249 struct ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT> {
250 static void enumeration(IO &IO, ELFYAML::MIPS_AFL_EXT &Value);
254 struct ScalarEnumerationTraits<ELFYAML::MIPS_ISA> {
255 static void enumeration(IO &IO, ELFYAML::MIPS_ISA &Value);
259 struct ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE> {
260 static void bitset(IO &IO, ELFYAML::MIPS_AFL_ASE &Value);
264 struct ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1> {
265 static void bitset(IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value);
269 struct MappingTraits<ELFYAML::FileHeader> {
270 static void mapping(IO &IO, ELFYAML::FileHeader &FileHdr);
274 struct MappingTraits<ELFYAML::Symbol> {
275 static void mapping(IO &IO, ELFYAML::Symbol &Symbol);
279 struct MappingTraits<ELFYAML::LocalGlobalWeakSymbols> {
280 static void mapping(IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols);
283 template <> struct MappingTraits<ELFYAML::Relocation> {
284 static void mapping(IO &IO, ELFYAML::Relocation &Rel);
288 struct MappingTraits<std::unique_ptr<ELFYAML::Section>> {
289 static void mapping(IO &IO, std::unique_ptr<ELFYAML::Section> &Section);
290 static StringRef validate(IO &io, std::unique_ptr<ELFYAML::Section> &Section);
294 struct MappingTraits<ELFYAML::Object> {
295 static void mapping(IO &IO, ELFYAML::Object &Object);
298 template <> struct MappingTraits<ELFYAML::SectionOrType> {
299 static void mapping(IO &IO, ELFYAML::SectionOrType §ionOrType);
302 } // end namespace yaml
303 } // end namespace llvm