1 //===- MachOYAML.h - Mach-O 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_MACHOYAML_H
17 #define LLVM_OBJECTYAML_MACHOYAML_H
19 #include "llvm/ObjectYAML/YAML.h"
20 #include "llvm/ObjectYAML/DWARFYAML.h"
21 #include "llvm/Support/MachO.h"
29 llvm::yaml::Hex64 addr;
31 llvm::yaml::Hex32 offset;
33 llvm::yaml::Hex32 reloff;
35 llvm::yaml::Hex32 flags;
36 llvm::yaml::Hex32 reserved1;
37 llvm::yaml::Hex32 reserved2;
38 llvm::yaml::Hex32 reserved3;
42 llvm::yaml::Hex32 magic;
43 llvm::yaml::Hex32 cputype;
44 llvm::yaml::Hex32 cpusubtype;
45 llvm::yaml::Hex32 filetype;
48 llvm::yaml::Hex32 flags;
49 llvm::yaml::Hex32 reserved;
53 virtual ~LoadCommand();
54 llvm::MachO::macho_load_command Data;
55 std::vector<Section> Sections;
56 std::vector<llvm::yaml::Hex8> PayloadBytes;
57 std::string PayloadString;
58 uint64_t ZeroPadBytes;
63 llvm::yaml::Hex8 n_type;
69 MachO::RebaseOpcode Opcode;
71 std::vector<yaml::Hex64> ExtraData;
75 MachO::BindOpcode Opcode;
77 std::vector<yaml::Hex64> ULEBExtraData;
78 std::vector<int64_t> SLEBExtraData;
84 : TerminalSize(0), NodeOffset(0), Name(), Flags(0), Address(0), Other(0),
85 ImportName(), Children() {}
86 uint64_t TerminalSize;
89 llvm::yaml::Hex64 Flags;
90 llvm::yaml::Hex64 Address;
91 llvm::yaml::Hex64 Other;
92 std::string ImportName;
93 std::vector<MachOYAML::ExportEntry> Children;
97 std::vector<MachOYAML::RebaseOpcode> RebaseOpcodes;
98 std::vector<MachOYAML::BindOpcode> BindOpcodes;
99 std::vector<MachOYAML::BindOpcode> WeakBindOpcodes;
100 std::vector<MachOYAML::BindOpcode> LazyBindOpcodes;
101 MachOYAML::ExportEntry ExportTrie;
102 std::vector<NListEntry> NameList;
103 std::vector<StringRef> StringTable;
105 bool isEmpty() const;
111 std::vector<LoadCommand> LoadCommands;
112 std::vector<Section> Sections;
113 LinkEditData LinkEdit;
114 DWARFYAML::Data DWARF;
118 llvm::yaml::Hex32 magic;
123 llvm::yaml::Hex32 cputype;
124 llvm::yaml::Hex32 cpusubtype;
125 llvm::yaml::Hex64 offset;
128 llvm::yaml::Hex32 reserved;
131 struct UniversalBinary {
133 std::vector<FatArch> FatArchs;
134 std::vector<Object> Slices;
137 } // namespace llvm::MachOYAML
140 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::LoadCommand)
141 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::Section)
142 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::yaml::Hex64)
143 LLVM_YAML_IS_SEQUENCE_VECTOR(int64_t)
144 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::RebaseOpcode)
145 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::BindOpcode)
146 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::ExportEntry)
147 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::NListEntry)
148 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::Object)
149 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::FatArch)
154 template <> struct MappingTraits<MachOYAML::FileHeader> {
155 static void mapping(IO &IO, MachOYAML::FileHeader &FileHeader);
158 template <> struct MappingTraits<MachOYAML::Object> {
159 static void mapping(IO &IO, MachOYAML::Object &Object);
162 template <> struct MappingTraits<MachOYAML::FatHeader> {
163 static void mapping(IO &IO, MachOYAML::FatHeader &FatHeader);
166 template <> struct MappingTraits<MachOYAML::FatArch> {
167 static void mapping(IO &IO, MachOYAML::FatArch &FatArch);
170 template <> struct MappingTraits<MachOYAML::UniversalBinary> {
171 static void mapping(IO &IO, MachOYAML::UniversalBinary &UniversalBinary);
174 template <> struct MappingTraits<MachOYAML::LoadCommand> {
175 static void mapping(IO &IO, MachOYAML::LoadCommand &LoadCommand);
178 template <> struct MappingTraits<MachOYAML::LinkEditData> {
179 static void mapping(IO &IO, MachOYAML::LinkEditData &LinkEditData);
182 template <> struct MappingTraits<MachOYAML::RebaseOpcode> {
183 static void mapping(IO &IO, MachOYAML::RebaseOpcode &RebaseOpcode);
186 template <> struct MappingTraits<MachOYAML::BindOpcode> {
187 static void mapping(IO &IO, MachOYAML::BindOpcode &BindOpcode);
190 template <> struct MappingTraits<MachOYAML::ExportEntry> {
191 static void mapping(IO &IO, MachOYAML::ExportEntry &ExportEntry);
194 template <> struct MappingTraits<MachOYAML::Section> {
195 static void mapping(IO &IO, MachOYAML::Section &Section);
198 template <> struct MappingTraits<MachOYAML::NListEntry> {
199 static void mapping(IO &IO, MachOYAML::NListEntry &NListEntry);
202 #define HANDLE_LOAD_COMMAND(LCName, LCValue, LCStruct) \
203 io.enumCase(value, #LCName, MachO::LCName);
205 template <> struct ScalarEnumerationTraits<MachO::LoadCommandType> {
206 static void enumeration(IO &io, MachO::LoadCommandType &value) {
207 #include "llvm/Support/MachO.def"
208 io.enumFallback<Hex32>(value);
212 #define ENUM_CASE(Enum) io.enumCase(value, #Enum, MachO::Enum);
214 template <> struct ScalarEnumerationTraits<MachO::RebaseOpcode> {
215 static void enumeration(IO &io, MachO::RebaseOpcode &value) {
216 ENUM_CASE(REBASE_OPCODE_DONE)
217 ENUM_CASE(REBASE_OPCODE_SET_TYPE_IMM)
218 ENUM_CASE(REBASE_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB)
219 ENUM_CASE(REBASE_OPCODE_ADD_ADDR_ULEB)
220 ENUM_CASE(REBASE_OPCODE_ADD_ADDR_IMM_SCALED)
221 ENUM_CASE(REBASE_OPCODE_DO_REBASE_IMM_TIMES)
222 ENUM_CASE(REBASE_OPCODE_DO_REBASE_ULEB_TIMES)
223 ENUM_CASE(REBASE_OPCODE_DO_REBASE_ADD_ADDR_ULEB)
224 ENUM_CASE(REBASE_OPCODE_DO_REBASE_ULEB_TIMES_SKIPPING_ULEB)
225 io.enumFallback<Hex8>(value);
229 template <> struct ScalarEnumerationTraits<MachO::BindOpcode> {
230 static void enumeration(IO &io, MachO::BindOpcode &value) {
231 ENUM_CASE(BIND_OPCODE_DONE)
232 ENUM_CASE(BIND_OPCODE_SET_DYLIB_ORDINAL_IMM)
233 ENUM_CASE(BIND_OPCODE_SET_DYLIB_ORDINAL_ULEB)
234 ENUM_CASE(BIND_OPCODE_SET_DYLIB_SPECIAL_IMM)
235 ENUM_CASE(BIND_OPCODE_SET_SYMBOL_TRAILING_FLAGS_IMM)
236 ENUM_CASE(BIND_OPCODE_SET_TYPE_IMM)
237 ENUM_CASE(BIND_OPCODE_SET_ADDEND_SLEB)
238 ENUM_CASE(BIND_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB)
239 ENUM_CASE(BIND_OPCODE_ADD_ADDR_ULEB)
240 ENUM_CASE(BIND_OPCODE_DO_BIND)
241 ENUM_CASE(BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB)
242 ENUM_CASE(BIND_OPCODE_DO_BIND_ADD_ADDR_IMM_SCALED)
243 ENUM_CASE(BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB)
244 io.enumFallback<Hex8>(value);
248 // This trait is used for 16-byte chars in Mach structures used for strings
249 typedef char char_16[16];
251 template <> struct ScalarTraits<char_16> {
252 static void output(const char_16 &Val, void *, llvm::raw_ostream &Out);
254 static StringRef input(StringRef Scalar, void *, char_16 &Val);
255 static bool mustQuote(StringRef S);
258 // This trait is used for UUIDs. It reads and writes them matching otool's
260 typedef uint8_t uuid_t[16];
262 template <> struct ScalarTraits<uuid_t> {
263 static void output(const uuid_t &Val, void *, llvm::raw_ostream &Out);
265 static StringRef input(StringRef Scalar, void *, uuid_t &Val);
266 static bool mustQuote(StringRef S);
269 // Load Command struct mapping traits
271 #define LOAD_COMMAND_STRUCT(LCStruct) \
272 template <> struct MappingTraits<MachO::LCStruct> { \
273 static void mapping(IO &IO, MachO::LCStruct &LoadCommand); \
276 #include "llvm/Support/MachO.def"
278 // Extra structures used by load commands
279 template <> struct MappingTraits<MachO::dylib> {
280 static void mapping(IO &IO, MachO::dylib &LoadCommand);
283 template <> struct MappingTraits<MachO::fvmlib> {
284 static void mapping(IO &IO, MachO::fvmlib &LoadCommand);
287 template <> struct MappingTraits<MachO::section> {
288 static void mapping(IO &IO, MachO::section &LoadCommand);
291 template <> struct MappingTraits<MachO::section_64> {
292 static void mapping(IO &IO, MachO::section_64 &LoadCommand);
295 } // namespace llvm::yaml