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 /// 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/ADT/StringRef.h"
20 #include "llvm/BinaryFormat/MachO.h"
21 #include "llvm/ObjectYAML/DWARFYAML.h"
22 #include "llvm/Support/YAMLTraits.h"
33 llvm::yaml::Hex64 addr;
35 llvm::yaml::Hex32 offset;
37 llvm::yaml::Hex32 reloff;
39 llvm::yaml::Hex32 flags;
40 llvm::yaml::Hex32 reserved1;
41 llvm::yaml::Hex32 reserved2;
42 llvm::yaml::Hex32 reserved3;
46 llvm::yaml::Hex32 magic;
47 llvm::yaml::Hex32 cputype;
48 llvm::yaml::Hex32 cpusubtype;
49 llvm::yaml::Hex32 filetype;
52 llvm::yaml::Hex32 flags;
53 llvm::yaml::Hex32 reserved;
57 virtual ~LoadCommand();
59 llvm::MachO::macho_load_command Data;
60 std::vector<Section> Sections;
61 std::vector<MachO::build_tool_version> Tools;
62 std::vector<llvm::yaml::Hex8> PayloadBytes;
63 std::string PayloadString;
64 uint64_t ZeroPadBytes;
69 llvm::yaml::Hex8 n_type;
76 MachO::RebaseOpcode Opcode;
78 std::vector<yaml::Hex64> ExtraData;
82 MachO::BindOpcode Opcode;
84 std::vector<yaml::Hex64> ULEBExtraData;
85 std::vector<int64_t> SLEBExtraData;
90 uint64_t TerminalSize = 0;
91 uint64_t NodeOffset = 0;
93 llvm::yaml::Hex64 Flags = 0;
94 llvm::yaml::Hex64 Address = 0;
95 llvm::yaml::Hex64 Other = 0;
96 std::string ImportName;
97 std::vector<MachOYAML::ExportEntry> Children;
100 struct LinkEditData {
101 std::vector<MachOYAML::RebaseOpcode> RebaseOpcodes;
102 std::vector<MachOYAML::BindOpcode> BindOpcodes;
103 std::vector<MachOYAML::BindOpcode> WeakBindOpcodes;
104 std::vector<MachOYAML::BindOpcode> LazyBindOpcodes;
105 MachOYAML::ExportEntry ExportTrie;
106 std::vector<NListEntry> NameList;
107 std::vector<StringRef> StringTable;
109 bool isEmpty() const;
115 std::vector<LoadCommand> LoadCommands;
116 std::vector<Section> Sections;
117 LinkEditData LinkEdit;
118 DWARFYAML::Data DWARF;
122 llvm::yaml::Hex32 magic;
127 llvm::yaml::Hex32 cputype;
128 llvm::yaml::Hex32 cpusubtype;
129 llvm::yaml::Hex64 offset;
132 llvm::yaml::Hex32 reserved;
135 struct UniversalBinary {
137 std::vector<FatArch> FatArchs;
138 std::vector<Object> Slices;
141 } // end namespace MachOYAML
142 } // end namespace llvm
144 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::LoadCommand)
145 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::Section)
146 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::RebaseOpcode)
147 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::BindOpcode)
148 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::ExportEntry)
149 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::NListEntry)
150 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::Object)
151 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachOYAML::FatArch)
152 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::MachO::build_tool_version)
160 template <> struct MappingTraits<MachOYAML::FileHeader> {
161 static void mapping(IO &IO, MachOYAML::FileHeader &FileHeader);
164 template <> struct MappingTraits<MachOYAML::Object> {
165 static void mapping(IO &IO, MachOYAML::Object &Object);
168 template <> struct MappingTraits<MachOYAML::FatHeader> {
169 static void mapping(IO &IO, MachOYAML::FatHeader &FatHeader);
172 template <> struct MappingTraits<MachOYAML::FatArch> {
173 static void mapping(IO &IO, MachOYAML::FatArch &FatArch);
176 template <> struct MappingTraits<MachOYAML::UniversalBinary> {
177 static void mapping(IO &IO, MachOYAML::UniversalBinary &UniversalBinary);
180 template <> struct MappingTraits<MachOYAML::LoadCommand> {
181 static void mapping(IO &IO, MachOYAML::LoadCommand &LoadCommand);
184 template <> struct MappingTraits<MachOYAML::LinkEditData> {
185 static void mapping(IO &IO, MachOYAML::LinkEditData &LinkEditData);
188 template <> struct MappingTraits<MachOYAML::RebaseOpcode> {
189 static void mapping(IO &IO, MachOYAML::RebaseOpcode &RebaseOpcode);
192 template <> struct MappingTraits<MachOYAML::BindOpcode> {
193 static void mapping(IO &IO, MachOYAML::BindOpcode &BindOpcode);
196 template <> struct MappingTraits<MachOYAML::ExportEntry> {
197 static void mapping(IO &IO, MachOYAML::ExportEntry &ExportEntry);
200 template <> struct MappingTraits<MachOYAML::Section> {
201 static void mapping(IO &IO, MachOYAML::Section &Section);
204 template <> struct MappingTraits<MachOYAML::NListEntry> {
205 static void mapping(IO &IO, MachOYAML::NListEntry &NListEntry);
208 template <> struct MappingTraits<MachO::build_tool_version> {
209 static void mapping(IO &IO, MachO::build_tool_version &tool);
212 #define HANDLE_LOAD_COMMAND(LCName, LCValue, LCStruct) \
213 io.enumCase(value, #LCName, MachO::LCName);
215 template <> struct ScalarEnumerationTraits<MachO::LoadCommandType> {
216 static void enumeration(IO &io, MachO::LoadCommandType &value) {
217 #include "llvm/BinaryFormat/MachO.def"
218 io.enumFallback<Hex32>(value);
222 #define ENUM_CASE(Enum) io.enumCase(value, #Enum, MachO::Enum);
224 template <> struct ScalarEnumerationTraits<MachO::RebaseOpcode> {
225 static void enumeration(IO &io, MachO::RebaseOpcode &value) {
226 ENUM_CASE(REBASE_OPCODE_DONE)
227 ENUM_CASE(REBASE_OPCODE_SET_TYPE_IMM)
228 ENUM_CASE(REBASE_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB)
229 ENUM_CASE(REBASE_OPCODE_ADD_ADDR_ULEB)
230 ENUM_CASE(REBASE_OPCODE_ADD_ADDR_IMM_SCALED)
231 ENUM_CASE(REBASE_OPCODE_DO_REBASE_IMM_TIMES)
232 ENUM_CASE(REBASE_OPCODE_DO_REBASE_ULEB_TIMES)
233 ENUM_CASE(REBASE_OPCODE_DO_REBASE_ADD_ADDR_ULEB)
234 ENUM_CASE(REBASE_OPCODE_DO_REBASE_ULEB_TIMES_SKIPPING_ULEB)
235 io.enumFallback<Hex8>(value);
239 template <> struct ScalarEnumerationTraits<MachO::BindOpcode> {
240 static void enumeration(IO &io, MachO::BindOpcode &value) {
241 ENUM_CASE(BIND_OPCODE_DONE)
242 ENUM_CASE(BIND_OPCODE_SET_DYLIB_ORDINAL_IMM)
243 ENUM_CASE(BIND_OPCODE_SET_DYLIB_ORDINAL_ULEB)
244 ENUM_CASE(BIND_OPCODE_SET_DYLIB_SPECIAL_IMM)
245 ENUM_CASE(BIND_OPCODE_SET_SYMBOL_TRAILING_FLAGS_IMM)
246 ENUM_CASE(BIND_OPCODE_SET_TYPE_IMM)
247 ENUM_CASE(BIND_OPCODE_SET_ADDEND_SLEB)
248 ENUM_CASE(BIND_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB)
249 ENUM_CASE(BIND_OPCODE_ADD_ADDR_ULEB)
250 ENUM_CASE(BIND_OPCODE_DO_BIND)
251 ENUM_CASE(BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB)
252 ENUM_CASE(BIND_OPCODE_DO_BIND_ADD_ADDR_IMM_SCALED)
253 ENUM_CASE(BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB)
254 io.enumFallback<Hex8>(value);
258 // This trait is used for 16-byte chars in Mach structures used for strings
259 using char_16 = char[16];
261 template <> struct ScalarTraits<char_16> {
262 static void output(const char_16 &Val, void *, raw_ostream &Out);
263 static StringRef input(StringRef Scalar, void *, char_16 &Val);
264 static QuotingType mustQuote(StringRef S);
267 // This trait is used for UUIDs. It reads and writes them matching otool's
269 using uuid_t = raw_ostream::uuid_t;
271 template <> struct ScalarTraits<uuid_t> {
272 static void output(const uuid_t &Val, void *, raw_ostream &Out);
273 static StringRef input(StringRef Scalar, void *, uuid_t &Val);
274 static QuotingType mustQuote(StringRef S);
277 // Load Command struct mapping traits
279 #define LOAD_COMMAND_STRUCT(LCStruct) \
280 template <> struct MappingTraits<MachO::LCStruct> { \
281 static void mapping(IO &IO, MachO::LCStruct &LoadCommand); \
284 #include "llvm/BinaryFormat/MachO.def"
286 // Extra structures used by load commands
287 template <> struct MappingTraits<MachO::dylib> {
288 static void mapping(IO &IO, MachO::dylib &LoadCommand);
291 template <> struct MappingTraits<MachO::fvmlib> {
292 static void mapping(IO &IO, MachO::fvmlib &LoadCommand);
295 template <> struct MappingTraits<MachO::section> {
296 static void mapping(IO &IO, MachO::section &LoadCommand);
299 template <> struct MappingTraits<MachO::section_64> {
300 static void mapping(IO &IO, MachO::section_64 &LoadCommand);
303 } // end namespace yaml
305 } // end namespace llvm
307 #endif // LLVM_OBJECTYAML_MACHOYAML_H