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_OBJECTYAML_ELFYAML_H
17 #define LLVM_OBJECTYAML_ELFYAML_H
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/ObjectYAML/YAML.h"
21 #include "llvm/Support/YAMLTraits.h"
29 // These types are invariant across 32/64-bit ELF, so for simplicity just
30 // directly give them their exact sizes. We don't need to worry about
31 // endianness because these are just the types in the YAMLIO structures,
32 // and are appropriately converted to the necessary endianness when
33 // reading/generating binary object files.
34 // The naming of these types is intended to be ELF_PREFIX, where PREFIX is
35 // the common prefix of the respective constants. E.g. ELF_EM corresponds
36 // to the `e_machine` constants, like `EM_X86_64`.
37 // In the future, these would probably be better suited by C++11 enum
38 // class's with appropriate fixed underlying type.
39 LLVM_YAML_STRONG_TYPEDEF(uint16_t, ELF_ET)
40 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_PT)
41 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_EM)
42 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_ELFCLASS)
43 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_ELFDATA)
44 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_ELFOSABI)
45 // Just use 64, since it can hold 32-bit values too.
46 LLVM_YAML_STRONG_TYPEDEF(uint64_t, ELF_EF)
47 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_PF)
48 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_SHT)
49 LLVM_YAML_STRONG_TYPEDEF(uint32_t, ELF_REL)
50 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_RSS)
51 // Just use 64, since it can hold 32-bit values too.
52 LLVM_YAML_STRONG_TYPEDEF(uint64_t, ELF_SHF)
53 LLVM_YAML_STRONG_TYPEDEF(uint16_t, ELF_SHN)
54 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STT)
55 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STV)
56 LLVM_YAML_STRONG_TYPEDEF(uint8_t, ELF_STO)
58 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_AFL_REG)
59 LLVM_YAML_STRONG_TYPEDEF(uint8_t, MIPS_ABI_FP)
60 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_EXT)
61 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_ASE)
62 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_AFL_FLAGS1)
63 LLVM_YAML_STRONG_TYPEDEF(uint32_t, MIPS_ISA)
65 // For now, hardcode 64 bits everywhere that 32 or 64 would be needed
66 // since 64-bit can hold 32-bit values too.
74 llvm::yaml::Hex64 Entry;
81 struct ProgramHeader {
84 llvm::yaml::Hex64 VAddr;
85 llvm::yaml::Hex64 PAddr;
86 Optional<llvm::yaml::Hex64> Align;
87 std::vector<SectionName> Sections;
94 Optional<ELF_SHN> Index;
95 llvm::yaml::Hex64 Value;
96 llvm::yaml::Hex64 Size;
100 struct LocalGlobalWeakSymbols {
101 std::vector<Symbol> Local;
102 std::vector<Symbol> Global;
103 std::vector<Symbol> Weak;
106 struct SectionOrType {
107 StringRef sectionNameOrType;
111 enum class SectionKind {
122 llvm::yaml::Hex64 Address;
125 llvm::yaml::Hex64 AddressAlign;
127 Section(SectionKind Kind) : Kind(Kind) {}
130 struct RawContentSection : Section {
131 yaml::BinaryRef Content;
132 llvm::yaml::Hex64 Size;
134 RawContentSection() : Section(SectionKind::RawContent) {}
136 static bool classof(const Section *S) {
137 return S->Kind == SectionKind::RawContent;
141 struct NoBitsSection : Section {
142 llvm::yaml::Hex64 Size;
144 NoBitsSection() : Section(SectionKind::NoBits) {}
146 static bool classof(const Section *S) {
147 return S->Kind == SectionKind::NoBits;
151 struct Group : Section {
152 // Members of a group contain a flag and a list of section indices
153 // that are part of the group.
154 std::vector<SectionOrType> Members;
156 Group() : Section(SectionKind::Group) {}
158 static bool classof(const Section *S) {
159 return S->Kind == SectionKind::Group;
164 llvm::yaml::Hex64 Offset;
167 Optional<StringRef> Symbol;
170 struct RelocationSection : Section {
171 std::vector<Relocation> Relocations;
173 RelocationSection() : Section(SectionKind::Relocation) {}
175 static bool classof(const Section *S) {
176 return S->Kind == SectionKind::Relocation;
180 // Represents .MIPS.abiflags section
181 struct MipsABIFlags : Section {
182 llvm::yaml::Hex16 Version;
184 llvm::yaml::Hex8 ISARevision;
185 MIPS_AFL_REG GPRSize;
186 MIPS_AFL_REG CPR1Size;
187 MIPS_AFL_REG CPR2Size;
189 MIPS_AFL_EXT ISAExtension;
191 MIPS_AFL_FLAGS1 Flags1;
192 llvm::yaml::Hex32 Flags2;
194 MipsABIFlags() : Section(SectionKind::MipsABIFlags) {}
196 static bool classof(const Section *S) {
197 return S->Kind == SectionKind::MipsABIFlags;
203 std::vector<ProgramHeader> ProgramHeaders;
204 std::vector<std::unique_ptr<Section>> Sections;
205 // Although in reality the symbols reside in a section, it is a lot
206 // cleaner and nicer if we read them from the YAML as a separate
207 // top-level key, which automatically ensures that invariants like there
208 // being a single SHT_SYMTAB section are upheld.
209 LocalGlobalWeakSymbols Symbols;
210 LocalGlobalWeakSymbols DynamicSymbols;
213 } // end namespace ELFYAML
214 } // end namespace llvm
216 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::ProgramHeader)
217 LLVM_YAML_IS_SEQUENCE_VECTOR(std::unique_ptr<llvm::ELFYAML::Section>)
218 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Symbol)
219 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::Relocation)
220 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::SectionOrType)
221 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::ELFYAML::SectionName)
227 struct ScalarEnumerationTraits<ELFYAML::ELF_ET> {
228 static void enumeration(IO &IO, ELFYAML::ELF_ET &Value);
231 template <> struct ScalarEnumerationTraits<ELFYAML::ELF_PT> {
232 static void enumeration(IO &IO, ELFYAML::ELF_PT &Value);
236 struct ScalarEnumerationTraits<ELFYAML::ELF_EM> {
237 static void enumeration(IO &IO, ELFYAML::ELF_EM &Value);
241 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFCLASS> {
242 static void enumeration(IO &IO, ELFYAML::ELF_ELFCLASS &Value);
246 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFDATA> {
247 static void enumeration(IO &IO, ELFYAML::ELF_ELFDATA &Value);
251 struct ScalarEnumerationTraits<ELFYAML::ELF_ELFOSABI> {
252 static void enumeration(IO &IO, ELFYAML::ELF_ELFOSABI &Value);
256 struct ScalarBitSetTraits<ELFYAML::ELF_EF> {
257 static void bitset(IO &IO, ELFYAML::ELF_EF &Value);
260 template <> struct ScalarBitSetTraits<ELFYAML::ELF_PF> {
261 static void bitset(IO &IO, ELFYAML::ELF_PF &Value);
265 struct ScalarEnumerationTraits<ELFYAML::ELF_SHT> {
266 static void enumeration(IO &IO, ELFYAML::ELF_SHT &Value);
270 struct ScalarBitSetTraits<ELFYAML::ELF_SHF> {
271 static void bitset(IO &IO, ELFYAML::ELF_SHF &Value);
274 template <> struct ScalarEnumerationTraits<ELFYAML::ELF_SHN> {
275 static void enumeration(IO &IO, ELFYAML::ELF_SHN &Value);
279 struct ScalarEnumerationTraits<ELFYAML::ELF_STT> {
280 static void enumeration(IO &IO, ELFYAML::ELF_STT &Value);
284 struct ScalarEnumerationTraits<ELFYAML::ELF_STV> {
285 static void enumeration(IO &IO, ELFYAML::ELF_STV &Value);
289 struct ScalarBitSetTraits<ELFYAML::ELF_STO> {
290 static void bitset(IO &IO, ELFYAML::ELF_STO &Value);
294 struct ScalarEnumerationTraits<ELFYAML::ELF_REL> {
295 static void enumeration(IO &IO, ELFYAML::ELF_REL &Value);
299 struct ScalarEnumerationTraits<ELFYAML::ELF_RSS> {
300 static void enumeration(IO &IO, ELFYAML::ELF_RSS &Value);
304 struct ScalarEnumerationTraits<ELFYAML::MIPS_AFL_REG> {
305 static void enumeration(IO &IO, ELFYAML::MIPS_AFL_REG &Value);
309 struct ScalarEnumerationTraits<ELFYAML::MIPS_ABI_FP> {
310 static void enumeration(IO &IO, ELFYAML::MIPS_ABI_FP &Value);
314 struct ScalarEnumerationTraits<ELFYAML::MIPS_AFL_EXT> {
315 static void enumeration(IO &IO, ELFYAML::MIPS_AFL_EXT &Value);
319 struct ScalarEnumerationTraits<ELFYAML::MIPS_ISA> {
320 static void enumeration(IO &IO, ELFYAML::MIPS_ISA &Value);
324 struct ScalarBitSetTraits<ELFYAML::MIPS_AFL_ASE> {
325 static void bitset(IO &IO, ELFYAML::MIPS_AFL_ASE &Value);
329 struct ScalarBitSetTraits<ELFYAML::MIPS_AFL_FLAGS1> {
330 static void bitset(IO &IO, ELFYAML::MIPS_AFL_FLAGS1 &Value);
334 struct MappingTraits<ELFYAML::FileHeader> {
335 static void mapping(IO &IO, ELFYAML::FileHeader &FileHdr);
338 template <> struct MappingTraits<ELFYAML::ProgramHeader> {
339 static void mapping(IO &IO, ELFYAML::ProgramHeader &FileHdr);
343 struct MappingTraits<ELFYAML::Symbol> {
344 static void mapping(IO &IO, ELFYAML::Symbol &Symbol);
345 static StringRef validate(IO &IO, ELFYAML::Symbol &Symbol);
349 struct MappingTraits<ELFYAML::LocalGlobalWeakSymbols> {
350 static void mapping(IO &IO, ELFYAML::LocalGlobalWeakSymbols &Symbols);
353 template <> struct MappingTraits<ELFYAML::Relocation> {
354 static void mapping(IO &IO, ELFYAML::Relocation &Rel);
358 struct MappingTraits<std::unique_ptr<ELFYAML::Section>> {
359 static void mapping(IO &IO, std::unique_ptr<ELFYAML::Section> &Section);
360 static StringRef validate(IO &io, std::unique_ptr<ELFYAML::Section> &Section);
364 struct MappingTraits<ELFYAML::Object> {
365 static void mapping(IO &IO, ELFYAML::Object &Object);
368 template <> struct MappingTraits<ELFYAML::SectionOrType> {
369 static void mapping(IO &IO, ELFYAML::SectionOrType §ionOrType);
372 template <> struct MappingTraits<ELFYAML::SectionName> {
373 static void mapping(IO &IO, ELFYAML::SectionName §ionName);
376 } // end namespace yaml
377 } // end namespace llvm
379 #endif // LLVM_OBJECTYAML_ELFYAML_H