1 //===- MachODumper.cpp - Object file dumping utility for llvm -------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the MachO-specific dumper for llvm-readobj.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "Error.h"
14 #include "ObjDumper.h"
15 #include "StackMapPrinter.h"
16 #include "llvm-readobj.h"
17 #include "llvm/ADT/SmallString.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/Object/MachO.h"
20 #include "llvm/Support/Casting.h"
21 #include "llvm/Support/ScopedPrinter.h"
22 
23 using namespace llvm;
24 using namespace object;
25 
26 namespace {
27 
28 class MachODumper : public ObjDumper {
29 public:
30   MachODumper(const MachOObjectFile *Obj, ScopedPrinter &Writer)
31       : ObjDumper(Writer), Obj(Obj) {}
32 
33   void printFileHeaders() override;
34   void printSectionHeaders() override;
35   void printRelocations() override;
36   void printUnwindInfo() override;
37   void printStackMap() const override;
38 
39   void printNeededLibraries() override;
40 
41   // MachO-specific.
42   void printMachODataInCode() override;
43   void printMachOVersionMin() override;
44   void printMachODysymtab() override;
45   void printMachOSegment() override;
46   void printMachOIndirectSymbols() override;
47   void printMachOLinkerOptions () override;
48 
49 private:
50   template<class MachHeader>
51   void printFileHeaders(const MachHeader &Header);
52 
53   void printSymbols() override;
54   void printDynamicSymbols() override;
55   void printSymbol(const SymbolRef &Symbol);
56 
57   void printRelocation(const RelocationRef &Reloc);
58 
59   void printRelocation(const MachOObjectFile *Obj, const RelocationRef &Reloc);
60 
61   void printSectionHeaders(const MachOObjectFile *Obj);
62 
63   const MachOObjectFile *Obj;
64 };
65 
66 } // namespace
67 
68 
69 namespace llvm {
70 
71 std::error_code createMachODumper(const object::ObjectFile *Obj,
72                                   ScopedPrinter &Writer,
73                                   std::unique_ptr<ObjDumper> &Result) {
74   const MachOObjectFile *MachOObj = dyn_cast<MachOObjectFile>(Obj);
75   if (!MachOObj)
76     return readobj_error::unsupported_obj_file_format;
77 
78   Result.reset(new MachODumper(MachOObj, Writer));
79   return readobj_error::success;
80 }
81 
82 } // namespace llvm
83 
84 static const EnumEntry<uint32_t> MachOMagics[] = {
85   { "Magic",      MachO::MH_MAGIC    },
86   { "Cigam",      MachO::MH_CIGAM    },
87   { "Magic64",    MachO::MH_MAGIC_64 },
88   { "Cigam64",    MachO::MH_CIGAM_64 },
89   { "FatMagic",   MachO::FAT_MAGIC   },
90   { "FatCigam",   MachO::FAT_CIGAM   },
91 };
92 
93 static const EnumEntry<uint32_t> MachOHeaderFileTypes[] = {
94   { "Relocatable",          MachO::MH_OBJECT      },
95   { "Executable",           MachO::MH_EXECUTE     },
96   { "FixedVMLibrary",       MachO::MH_FVMLIB      },
97   { "Core",                 MachO::MH_CORE        },
98   { "PreloadedExecutable",  MachO::MH_PRELOAD     },
99   { "DynamicLibrary",       MachO::MH_DYLIB       },
100   { "DynamicLinker",        MachO::MH_DYLINKER    },
101   { "Bundle",               MachO::MH_BUNDLE      },
102   { "DynamicLibraryStub",   MachO::MH_DYLIB_STUB  },
103   { "DWARFSymbol",          MachO::MH_DSYM        },
104   { "KextBundle",           MachO::MH_KEXT_BUNDLE },
105 };
106 
107 static const EnumEntry<uint32_t> MachOHeaderCpuTypes[] = {
108   { "Any"       , static_cast<uint32_t>(MachO::CPU_TYPE_ANY) },
109   { "X86"       , MachO::CPU_TYPE_X86       },
110   { "X86-64"    , MachO::CPU_TYPE_X86_64    },
111   { "Mc98000"   , MachO::CPU_TYPE_MC98000   },
112   { "Arm"       , MachO::CPU_TYPE_ARM       },
113   { "Arm64"     , MachO::CPU_TYPE_ARM64     },
114   { "Sparc"     , MachO::CPU_TYPE_SPARC     },
115   { "PowerPC"   , MachO::CPU_TYPE_POWERPC   },
116   { "PowerPC64" , MachO::CPU_TYPE_POWERPC64 },
117 };
118 
119 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesX86[] = {
120   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_I386_ALL),
121   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_386),
122   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_486),
123   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_486SX),
124   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_586),
125   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTPRO),
126   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTII_M3),
127   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTII_M5),
128   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_CELERON),
129   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_CELERON_MOBILE),
130   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_3),
131   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_3_M),
132   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_3_XEON),
133   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_M),
134   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_4),
135   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_4_M),
136   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ITANIUM),
137   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ITANIUM_2),
138   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_XEON),
139   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_XEON_MP),
140 };
141 
142 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesX64[] = {
143   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_X86_64_ALL),
144   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_X86_ARCH1),
145   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_X86_64_H),
146 };
147 
148 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesARM[] = {
149   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_ALL),
150   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V4T),
151   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V6),
152   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V5),
153   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V5TEJ),
154   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_XSCALE),
155   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7),
156   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7S),
157   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7K),
158   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V6M),
159   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7M),
160   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7EM),
161 };
162 
163 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesARM64[] = {
164     LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64_ALL),
165     LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64_V8),
166     LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64E),
167 };
168 
169 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesSPARC[] = {
170   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_SPARC_ALL),
171 };
172 
173 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesPPC[] = {
174   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_ALL),
175   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_601),
176   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_602),
177   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_603),
178   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_603e),
179   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_603ev),
180   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_604),
181   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_604e),
182   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_620),
183   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_750),
184   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_7400),
185   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_7450),
186   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_970),
187 };
188 
189 static const EnumEntry<uint32_t> MachOHeaderFlags[] = {
190   LLVM_READOBJ_ENUM_ENT(MachO, MH_NOUNDEFS),
191   LLVM_READOBJ_ENUM_ENT(MachO, MH_INCRLINK),
192   LLVM_READOBJ_ENUM_ENT(MachO, MH_DYLDLINK),
193   LLVM_READOBJ_ENUM_ENT(MachO, MH_BINDATLOAD),
194   LLVM_READOBJ_ENUM_ENT(MachO, MH_PREBOUND),
195   LLVM_READOBJ_ENUM_ENT(MachO, MH_SPLIT_SEGS),
196   LLVM_READOBJ_ENUM_ENT(MachO, MH_LAZY_INIT),
197   LLVM_READOBJ_ENUM_ENT(MachO, MH_TWOLEVEL),
198   LLVM_READOBJ_ENUM_ENT(MachO, MH_FORCE_FLAT),
199   LLVM_READOBJ_ENUM_ENT(MachO, MH_NOMULTIDEFS),
200   LLVM_READOBJ_ENUM_ENT(MachO, MH_NOFIXPREBINDING),
201   LLVM_READOBJ_ENUM_ENT(MachO, MH_PREBINDABLE),
202   LLVM_READOBJ_ENUM_ENT(MachO, MH_ALLMODSBOUND),
203   LLVM_READOBJ_ENUM_ENT(MachO, MH_SUBSECTIONS_VIA_SYMBOLS),
204   LLVM_READOBJ_ENUM_ENT(MachO, MH_CANONICAL),
205   LLVM_READOBJ_ENUM_ENT(MachO, MH_WEAK_DEFINES),
206   LLVM_READOBJ_ENUM_ENT(MachO, MH_BINDS_TO_WEAK),
207   LLVM_READOBJ_ENUM_ENT(MachO, MH_ALLOW_STACK_EXECUTION),
208   LLVM_READOBJ_ENUM_ENT(MachO, MH_ROOT_SAFE),
209   LLVM_READOBJ_ENUM_ENT(MachO, MH_SETUID_SAFE),
210   LLVM_READOBJ_ENUM_ENT(MachO, MH_NO_REEXPORTED_DYLIBS),
211   LLVM_READOBJ_ENUM_ENT(MachO, MH_PIE),
212   LLVM_READOBJ_ENUM_ENT(MachO, MH_DEAD_STRIPPABLE_DYLIB),
213   LLVM_READOBJ_ENUM_ENT(MachO, MH_HAS_TLV_DESCRIPTORS),
214   LLVM_READOBJ_ENUM_ENT(MachO, MH_NO_HEAP_EXECUTION),
215   LLVM_READOBJ_ENUM_ENT(MachO, MH_APP_EXTENSION_SAFE),
216 };
217 
218 static const EnumEntry<unsigned> MachOSectionTypes[] = {
219   { "Regular"                        , MachO::S_REGULAR },
220   { "ZeroFill"                       , MachO::S_ZEROFILL },
221   { "CStringLiterals"                , MachO::S_CSTRING_LITERALS },
222   { "4ByteLiterals"                  , MachO::S_4BYTE_LITERALS },
223   { "8ByteLiterals"                  , MachO::S_8BYTE_LITERALS },
224   { "LiteralPointers"                , MachO::S_LITERAL_POINTERS },
225   { "NonLazySymbolPointers"          , MachO::S_NON_LAZY_SYMBOL_POINTERS },
226   { "LazySymbolPointers"             , MachO::S_LAZY_SYMBOL_POINTERS },
227   { "SymbolStubs"                    , MachO::S_SYMBOL_STUBS },
228   { "ModInitFuncPointers"            , MachO::S_MOD_INIT_FUNC_POINTERS },
229   { "ModTermFuncPointers"            , MachO::S_MOD_TERM_FUNC_POINTERS },
230   { "Coalesced"                      , MachO::S_COALESCED },
231   { "GBZeroFill"                     , MachO::S_GB_ZEROFILL },
232   { "Interposing"                    , MachO::S_INTERPOSING },
233   { "16ByteLiterals"                 , MachO::S_16BYTE_LITERALS },
234   { "DTraceDOF"                      , MachO::S_DTRACE_DOF },
235   { "LazyDylibSymbolPointers"        , MachO::S_LAZY_DYLIB_SYMBOL_POINTERS },
236   { "ThreadLocalRegular"             , MachO::S_THREAD_LOCAL_REGULAR },
237   { "ThreadLocalZerofill"            , MachO::S_THREAD_LOCAL_ZEROFILL },
238   { "ThreadLocalVariables"           , MachO::S_THREAD_LOCAL_VARIABLES },
239   { "ThreadLocalVariablePointers"    , MachO::S_THREAD_LOCAL_VARIABLE_POINTERS },
240   { "ThreadLocalInitFunctionPointers", MachO::S_THREAD_LOCAL_INIT_FUNCTION_POINTERS }
241 };
242 
243 static const EnumEntry<unsigned> MachOSectionAttributes[] = {
244   { "LocReloc"         , 1 <<  0 /*S_ATTR_LOC_RELOC          */ },
245   { "ExtReloc"         , 1 <<  1 /*S_ATTR_EXT_RELOC          */ },
246   { "SomeInstructions" , 1 <<  2 /*S_ATTR_SOME_INSTRUCTIONS  */ },
247   { "Debug"            , 1 << 17 /*S_ATTR_DEBUG              */ },
248   { "SelfModifyingCode", 1 << 18 /*S_ATTR_SELF_MODIFYING_CODE*/ },
249   { "LiveSupport"      , 1 << 19 /*S_ATTR_LIVE_SUPPORT       */ },
250   { "NoDeadStrip"      , 1 << 20 /*S_ATTR_NO_DEAD_STRIP      */ },
251   { "StripStaticSyms"  , 1 << 21 /*S_ATTR_STRIP_STATIC_SYMS  */ },
252   { "NoTOC"            , 1 << 22 /*S_ATTR_NO_TOC             */ },
253   { "PureInstructions" , 1 << 23 /*S_ATTR_PURE_INSTRUCTIONS  */ },
254 };
255 
256 static const EnumEntry<unsigned> MachOSymbolRefTypes[] = {
257   { "UndefinedNonLazy",                     0 },
258   { "ReferenceFlagUndefinedLazy",           1 },
259   { "ReferenceFlagDefined",                 2 },
260   { "ReferenceFlagPrivateDefined",          3 },
261   { "ReferenceFlagPrivateUndefinedNonLazy", 4 },
262   { "ReferenceFlagPrivateUndefinedLazy",    5 }
263 };
264 
265 static const EnumEntry<unsigned> MachOSymbolFlags[] = {
266   { "ReferencedDynamically", 0x10 },
267   { "NoDeadStrip",           0x20 },
268   { "WeakRef",               0x40 },
269   { "WeakDef",               0x80 },
270   { "AltEntry",             0x200 },
271 };
272 
273 static const EnumEntry<unsigned> MachOSymbolTypes[] = {
274   { "Undef",           0x0 },
275   { "Abs",             0x2 },
276   { "Indirect",        0xA },
277   { "PreboundUndef",   0xC },
278   { "Section",         0xE }
279 };
280 
281 namespace {
282   struct MachOSection {
283     ArrayRef<char> Name;
284     ArrayRef<char> SegmentName;
285     uint64_t Address;
286     uint64_t Size;
287     uint32_t Offset;
288     uint32_t Alignment;
289     uint32_t RelocationTableOffset;
290     uint32_t NumRelocationTableEntries;
291     uint32_t Flags;
292     uint32_t Reserved1;
293     uint32_t Reserved2;
294     uint32_t Reserved3;
295   };
296 
297   struct MachOSegment {
298     std::string CmdName;
299     std::string SegName;
300     uint64_t cmdsize;
301     uint64_t vmaddr;
302     uint64_t vmsize;
303     uint64_t fileoff;
304     uint64_t filesize;
305     uint32_t maxprot;
306     uint32_t initprot;
307     uint32_t nsects;
308     uint32_t flags;
309   };
310 
311   struct MachOSymbol {
312     uint32_t StringIndex;
313     uint8_t Type;
314     uint8_t SectionIndex;
315     uint16_t Flags;
316     uint64_t Value;
317   };
318 }
319 
320 static std::string getMask(uint32_t prot)
321 {
322   // TODO (davide): This always assumes prot is valid.
323   // Catch mistakes and report if needed.
324   std::string Prot;
325   Prot = "";
326   Prot += (prot & MachO::VM_PROT_READ) ? "r" : "-";
327   Prot += (prot & MachO::VM_PROT_WRITE) ? "w" : "-";
328   Prot += (prot & MachO::VM_PROT_EXECUTE) ? "x" : "-";
329   return Prot;
330 }
331 
332 static void getSection(const MachOObjectFile *Obj,
333                        DataRefImpl Sec,
334                        MachOSection &Section) {
335   if (!Obj->is64Bit()) {
336     MachO::section Sect = Obj->getSection(Sec);
337     Section.Address     = Sect.addr;
338     Section.Size        = Sect.size;
339     Section.Offset      = Sect.offset;
340     Section.Alignment   = Sect.align;
341     Section.RelocationTableOffset = Sect.reloff;
342     Section.NumRelocationTableEntries = Sect.nreloc;
343     Section.Flags       = Sect.flags;
344     Section.Reserved1   = Sect.reserved1;
345     Section.Reserved2   = Sect.reserved2;
346     return;
347   }
348   MachO::section_64 Sect = Obj->getSection64(Sec);
349   Section.Address     = Sect.addr;
350   Section.Size        = Sect.size;
351   Section.Offset      = Sect.offset;
352   Section.Alignment   = Sect.align;
353   Section.RelocationTableOffset = Sect.reloff;
354   Section.NumRelocationTableEntries = Sect.nreloc;
355   Section.Flags       = Sect.flags;
356   Section.Reserved1   = Sect.reserved1;
357   Section.Reserved2   = Sect.reserved2;
358   Section.Reserved3   = Sect.reserved3;
359 }
360 
361 static void getSegment(const MachOObjectFile *Obj,
362                        const MachOObjectFile::LoadCommandInfo &L,
363                        MachOSegment &Segment) {
364   if (!Obj->is64Bit()) {
365     MachO::segment_command SC = Obj->getSegmentLoadCommand(L);
366     Segment.CmdName = "LC_SEGMENT";
367     Segment.SegName = SC.segname;
368     Segment.cmdsize = SC.cmdsize;
369     Segment.vmaddr = SC.vmaddr;
370     Segment.vmsize = SC.vmsize;
371     Segment.fileoff = SC.fileoff;
372     Segment.filesize = SC.filesize;
373     Segment.maxprot = SC.maxprot;
374     Segment.initprot = SC.initprot;
375     Segment.nsects = SC.nsects;
376     Segment.flags = SC.flags;
377     return;
378   }
379   MachO::segment_command_64 SC = Obj->getSegment64LoadCommand(L);
380   Segment.CmdName = "LC_SEGMENT_64";
381   Segment.SegName = SC.segname;
382   Segment.cmdsize = SC.cmdsize;
383   Segment.vmaddr = SC.vmaddr;
384   Segment.vmsize = SC.vmsize;
385   Segment.fileoff = SC.fileoff;
386   Segment.filesize = SC.filesize;
387   Segment.maxprot = SC.maxprot;
388   Segment.initprot = SC.initprot;
389   Segment.nsects = SC.nsects;
390   Segment.flags = SC.flags;
391 }
392 
393 static void getSymbol(const MachOObjectFile *Obj,
394                       DataRefImpl DRI,
395                       MachOSymbol &Symbol) {
396   if (!Obj->is64Bit()) {
397     MachO::nlist Entry = Obj->getSymbolTableEntry(DRI);
398     Symbol.StringIndex  = Entry.n_strx;
399     Symbol.Type         = Entry.n_type;
400     Symbol.SectionIndex = Entry.n_sect;
401     Symbol.Flags        = Entry.n_desc;
402     Symbol.Value        = Entry.n_value;
403     return;
404   }
405   MachO::nlist_64 Entry = Obj->getSymbol64TableEntry(DRI);
406   Symbol.StringIndex  = Entry.n_strx;
407   Symbol.Type         = Entry.n_type;
408   Symbol.SectionIndex = Entry.n_sect;
409   Symbol.Flags        = Entry.n_desc;
410   Symbol.Value        = Entry.n_value;
411 }
412 
413 void MachODumper::printFileHeaders() {
414   DictScope H(W, "MachHeader");
415   if (!Obj->is64Bit()) {
416     printFileHeaders(Obj->getHeader());
417   } else {
418     printFileHeaders(Obj->getHeader64());
419     W.printHex("Reserved", Obj->getHeader64().reserved);
420   }
421 }
422 
423 template<class MachHeader>
424 void MachODumper::printFileHeaders(const MachHeader &Header) {
425   W.printEnum("Magic", Header.magic, makeArrayRef(MachOMagics));
426   W.printEnum("CpuType", Header.cputype, makeArrayRef(MachOHeaderCpuTypes));
427   uint32_t subtype = Header.cpusubtype & ~MachO::CPU_SUBTYPE_MASK;
428   switch (Header.cputype) {
429   case MachO::CPU_TYPE_X86:
430     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesX86));
431     break;
432   case MachO::CPU_TYPE_X86_64:
433     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesX64));
434     break;
435   case MachO::CPU_TYPE_ARM:
436     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesARM));
437     break;
438   case MachO::CPU_TYPE_POWERPC:
439     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesPPC));
440     break;
441   case MachO::CPU_TYPE_SPARC:
442     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesSPARC));
443     break;
444   case MachO::CPU_TYPE_ARM64:
445     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesARM64));
446     break;
447   case MachO::CPU_TYPE_POWERPC64:
448   default:
449     W.printHex("CpuSubtype", subtype);
450   }
451   W.printEnum("FileType", Header.filetype, makeArrayRef(MachOHeaderFileTypes));
452   W.printNumber("NumOfLoadCommands", Header.ncmds);
453   W.printNumber("SizeOfLoadCommands", Header.sizeofcmds);
454   W.printFlags("Flags", Header.flags, makeArrayRef(MachOHeaderFlags));
455 }
456 
457 void MachODumper::printSectionHeaders() { return printSectionHeaders(Obj); }
458 
459 void MachODumper::printSectionHeaders(const MachOObjectFile *Obj) {
460   ListScope Group(W, "Sections");
461 
462   int SectionIndex = -1;
463   for (const SectionRef &Section : Obj->sections()) {
464     ++SectionIndex;
465 
466     MachOSection MOSection;
467     getSection(Obj, Section.getRawDataRefImpl(), MOSection);
468     DataRefImpl DR = Section.getRawDataRefImpl();
469     StringRef Name = unwrapOrError(Obj->getFileName(), Section.getName());
470     ArrayRef<char> RawName = Obj->getSectionRawName(DR);
471     StringRef SegmentName = Obj->getSectionFinalSegmentName(DR);
472     ArrayRef<char> RawSegmentName = Obj->getSectionRawFinalSegmentName(DR);
473 
474     DictScope SectionD(W, "Section");
475     W.printNumber("Index", SectionIndex);
476     W.printBinary("Name", Name, RawName);
477     W.printBinary("Segment", SegmentName, RawSegmentName);
478     W.printHex("Address", MOSection.Address);
479     W.printHex("Size", MOSection.Size);
480     W.printNumber("Offset", MOSection.Offset);
481     W.printNumber("Alignment", MOSection.Alignment);
482     W.printHex("RelocationOffset", MOSection.RelocationTableOffset);
483     W.printNumber("RelocationCount", MOSection.NumRelocationTableEntries);
484     W.printEnum("Type", MOSection.Flags & 0xFF,
485                 makeArrayRef(MachOSectionTypes));
486     W.printFlags("Attributes", MOSection.Flags >> 8,
487                  makeArrayRef(MachOSectionAttributes));
488     W.printHex("Reserved1", MOSection.Reserved1);
489     W.printHex("Reserved2", MOSection.Reserved2);
490     if (Obj->is64Bit())
491       W.printHex("Reserved3", MOSection.Reserved3);
492 
493     if (opts::SectionRelocations) {
494       ListScope D(W, "Relocations");
495       for (const RelocationRef &Reloc : Section.relocations())
496         printRelocation(Reloc);
497     }
498 
499     if (opts::SectionSymbols) {
500       ListScope D(W, "Symbols");
501       for (const SymbolRef &Symbol : Obj->symbols()) {
502         if (!Section.containsSymbol(Symbol))
503           continue;
504 
505         printSymbol(Symbol);
506       }
507     }
508 
509     if (opts::SectionData && !Section.isBSS())
510       W.printBinaryBlock("SectionData", unwrapOrError(Obj->getFileName(),
511                                                       Section.getContents()));
512   }
513 }
514 
515 void MachODumper::printRelocations() {
516   ListScope D(W, "Relocations");
517 
518   std::error_code EC;
519   for (const SectionRef &Section : Obj->sections()) {
520     StringRef Name = unwrapOrError(Obj->getFileName(), Section.getName());
521     bool PrintedGroup = false;
522     for (const RelocationRef &Reloc : Section.relocations()) {
523       if (!PrintedGroup) {
524         W.startLine() << "Section " << Name << " {\n";
525         W.indent();
526         PrintedGroup = true;
527       }
528 
529       printRelocation(Reloc);
530     }
531 
532     if (PrintedGroup) {
533       W.unindent();
534       W.startLine() << "}\n";
535     }
536   }
537 }
538 
539 void MachODumper::printRelocation(const RelocationRef &Reloc) {
540   return printRelocation(Obj, Reloc);
541 }
542 
543 void MachODumper::printRelocation(const MachOObjectFile *Obj,
544                                   const RelocationRef &Reloc) {
545   uint64_t Offset = Reloc.getOffset();
546   SmallString<32> RelocName;
547   Reloc.getTypeName(RelocName);
548 
549   DataRefImpl DR = Reloc.getRawDataRefImpl();
550   MachO::any_relocation_info RE = Obj->getRelocation(DR);
551   bool IsScattered = Obj->isRelocationScattered(RE);
552   bool IsExtern = !IsScattered && Obj->getPlainRelocationExternal(RE);
553 
554   StringRef TargetName;
555   if (IsExtern) {
556     symbol_iterator Symbol = Reloc.getSymbol();
557     if (Symbol != Obj->symbol_end()) {
558       Expected<StringRef> TargetNameOrErr = Symbol->getName();
559       if (!TargetNameOrErr)
560         reportError(TargetNameOrErr.takeError(), Obj->getFileName());
561       TargetName = *TargetNameOrErr;
562     }
563   } else if (!IsScattered) {
564     section_iterator SecI = Obj->getRelocationSection(DR);
565     if (SecI != Obj->section_end())
566       TargetName = unwrapOrError(Obj->getFileName(), SecI->getName());
567   }
568   if (TargetName.empty())
569     TargetName = "-";
570 
571   if (opts::ExpandRelocs) {
572     DictScope Group(W, "Relocation");
573     W.printHex("Offset", Offset);
574     W.printNumber("PCRel", Obj->getAnyRelocationPCRel(RE));
575     W.printNumber("Length", Obj->getAnyRelocationLength(RE));
576     W.printNumber("Type", RelocName, Obj->getAnyRelocationType(RE));
577     if (IsScattered) {
578       W.printHex("Value", Obj->getScatteredRelocationValue(RE));
579     } else {
580       const char *Kind = IsExtern ? "Symbol" : "Section";
581       W.printNumber(Kind, TargetName, Obj->getPlainRelocationSymbolNum(RE));
582     }
583   } else {
584     SmallString<32> SymbolNameOrOffset("0x");
585     if (IsScattered) {
586       // Scattered relocations don't really have an associated symbol for some
587       // reason, even if one exists in the symtab at the correct address.
588       SymbolNameOrOffset += utohexstr(Obj->getScatteredRelocationValue(RE));
589     } else {
590       SymbolNameOrOffset = TargetName;
591     }
592 
593     raw_ostream& OS = W.startLine();
594     OS << W.hex(Offset)
595        << " " << Obj->getAnyRelocationPCRel(RE)
596        << " " << Obj->getAnyRelocationLength(RE);
597     if (IsScattered)
598       OS << " n/a";
599     else
600       OS << " " << Obj->getPlainRelocationExternal(RE);
601     OS << " " << RelocName
602        << " " << IsScattered
603        << " " << SymbolNameOrOffset
604        << "\n";
605   }
606 }
607 
608 void MachODumper::printSymbols() {
609   ListScope Group(W, "Symbols");
610 
611   for (const SymbolRef &Symbol : Obj->symbols()) {
612     printSymbol(Symbol);
613   }
614 }
615 
616 void MachODumper::printDynamicSymbols() {
617   ListScope Group(W, "DynamicSymbols");
618 }
619 
620 void MachODumper::printSymbol(const SymbolRef &Symbol) {
621   StringRef SymbolName;
622   Expected<StringRef> SymbolNameOrErr = Symbol.getName();
623   if (!SymbolNameOrErr) {
624     // TODO: Actually report errors helpfully.
625     consumeError(SymbolNameOrErr.takeError());
626   } else
627     SymbolName = *SymbolNameOrErr;
628 
629   MachOSymbol MOSymbol;
630   getSymbol(Obj, Symbol.getRawDataRefImpl(), MOSymbol);
631 
632   StringRef SectionName = "";
633   Expected<section_iterator> SecIOrErr = Symbol.getSection();
634   if (!SecIOrErr)
635     reportError(SecIOrErr.takeError(), Obj->getFileName());
636 
637   section_iterator SecI = *SecIOrErr;
638   if (SecI != Obj->section_end())
639     SectionName = unwrapOrError(Obj->getFileName(), SecI->getName());
640 
641   DictScope D(W, "Symbol");
642   W.printNumber("Name", SymbolName, MOSymbol.StringIndex);
643   if (MOSymbol.Type & MachO::N_STAB) {
644     W.printHex("Type", "SymDebugTable", MOSymbol.Type);
645   } else {
646     if (MOSymbol.Type & MachO::N_PEXT)
647       W.startLine() << "PrivateExtern\n";
648     if (MOSymbol.Type & MachO::N_EXT)
649       W.startLine() << "Extern\n";
650     W.printEnum("Type", uint8_t(MOSymbol.Type & MachO::N_TYPE),
651                 makeArrayRef(MachOSymbolTypes));
652   }
653   W.printHex("Section", SectionName, MOSymbol.SectionIndex);
654   W.printEnum("RefType", static_cast<uint16_t>(MOSymbol.Flags & 0xF),
655               makeArrayRef(MachOSymbolRefTypes));
656   W.printFlags("Flags", static_cast<uint16_t>(MOSymbol.Flags & ~0xF),
657                makeArrayRef(MachOSymbolFlags));
658   W.printHex("Value", MOSymbol.Value);
659 }
660 
661 void MachODumper::printUnwindInfo() {
662   W.startLine() << "UnwindInfo not implemented.\n";
663 }
664 
665 void MachODumper::printStackMap() const {
666   object::SectionRef StackMapSection;
667   for (auto Sec : Obj->sections()) {
668     StringRef Name;
669     if (Expected<StringRef> NameOrErr = Sec.getName())
670       Name = *NameOrErr;
671     else
672       consumeError(NameOrErr.takeError());
673 
674     if (Name == "__llvm_stackmaps") {
675       StackMapSection = Sec;
676       break;
677     }
678   }
679 
680   if (StackMapSection == object::SectionRef())
681     return;
682 
683   StringRef StackMapContents =
684       unwrapOrError(Obj->getFileName(), StackMapSection.getContents());
685   ArrayRef<uint8_t> StackMapContentsArray =
686       arrayRefFromStringRef(StackMapContents);
687 
688   if (Obj->isLittleEndian())
689     prettyPrintStackMap(
690         W, StackMapParser<support::little>(StackMapContentsArray));
691   else
692     prettyPrintStackMap(
693         W, StackMapParser<support::big>(StackMapContentsArray));
694 }
695 
696 void MachODumper::printNeededLibraries() {
697   ListScope D(W, "NeededLibraries");
698 
699   using LibsTy = std::vector<StringRef>;
700   LibsTy Libs;
701 
702   for (const auto &Command : Obj->load_commands()) {
703     if (Command.C.cmd == MachO::LC_LOAD_DYLIB ||
704         Command.C.cmd == MachO::LC_ID_DYLIB ||
705         Command.C.cmd == MachO::LC_LOAD_WEAK_DYLIB ||
706         Command.C.cmd == MachO::LC_REEXPORT_DYLIB ||
707         Command.C.cmd == MachO::LC_LAZY_LOAD_DYLIB ||
708         Command.C.cmd == MachO::LC_LOAD_UPWARD_DYLIB) {
709       MachO::dylib_command Dl = Obj->getDylibIDLoadCommand(Command);
710       if (Dl.dylib.name < Dl.cmdsize) {
711         auto *P = static_cast<const char*>(Command.Ptr) + Dl.dylib.name;
712         Libs.push_back(P);
713       }
714     }
715   }
716 
717   llvm::stable_sort(Libs);
718 
719   for (const auto &L : Libs) {
720     W.startLine() << L << "\n";
721   }
722 }
723 
724 void MachODumper::printMachODataInCode() {
725   for (const auto &Load : Obj->load_commands()) {
726     if (Load.C.cmd  == MachO::LC_DATA_IN_CODE) {
727       MachO::linkedit_data_command LLC = Obj->getLinkeditDataLoadCommand(Load);
728       DictScope Group(W, "DataInCode");
729       W.printNumber("Data offset", LLC.dataoff);
730       W.printNumber("Data size", LLC.datasize);
731       ListScope D(W, "Data entries");
732       unsigned NumRegions = LLC.datasize / sizeof(MachO::data_in_code_entry);
733       for (unsigned i = 0; i < NumRegions; ++i) {
734         MachO::data_in_code_entry DICE = Obj->getDataInCodeTableEntry(
735                                                               LLC.dataoff, i);
736         DictScope Group(W, "Entry");
737         W.printNumber("Index", i);
738         W.printNumber("Offset", DICE.offset);
739         W.printNumber("Length", DICE.length);
740         W.printNumber("Kind", DICE.kind);
741       }
742     }
743   }
744 }
745 
746 void MachODumper::printMachOVersionMin() {
747   for (const auto &Load : Obj->load_commands()) {
748     StringRef Cmd;
749     switch (Load.C.cmd) {
750     case MachO::LC_VERSION_MIN_MACOSX:
751       Cmd = "LC_VERSION_MIN_MACOSX";
752       break;
753     case MachO::LC_VERSION_MIN_IPHONEOS:
754       Cmd = "LC_VERSION_MIN_IPHONEOS";
755       break;
756     case MachO::LC_VERSION_MIN_TVOS:
757       Cmd = "LC_VERSION_MIN_TVOS";
758       break;
759     case MachO::LC_VERSION_MIN_WATCHOS:
760       Cmd = "LC_VERSION_MIN_WATCHOS";
761       break;
762     case MachO::LC_BUILD_VERSION:
763       Cmd = "LC_BUILD_VERSION";
764       break;
765     default:
766       continue;
767     }
768 
769     DictScope Group(W, "MinVersion");
770     // Handle LC_BUILD_VERSION.
771     if (Load.C.cmd == MachO::LC_BUILD_VERSION) {
772       MachO::build_version_command BVC = Obj->getBuildVersionLoadCommand(Load);
773       W.printString("Cmd", Cmd);
774       W.printNumber("Size", BVC.cmdsize);
775       W.printString("Platform",
776                     MachOObjectFile::getBuildPlatform(BVC.platform));
777       W.printString("Version", MachOObjectFile::getVersionString(BVC.minos));
778       if (BVC.sdk)
779         W.printString("SDK", MachOObjectFile::getVersionString(BVC.sdk));
780       else
781         W.printString("SDK", StringRef("n/a"));
782       continue;
783     }
784 
785     MachO::version_min_command VMC = Obj->getVersionMinLoadCommand(Load);
786     W.printString("Cmd", Cmd);
787     W.printNumber("Size", VMC.cmdsize);
788     SmallString<32> Version;
789     Version = utostr(MachOObjectFile::getVersionMinMajor(VMC, false)) + "." +
790               utostr(MachOObjectFile::getVersionMinMinor(VMC, false));
791     uint32_t Update = MachOObjectFile::getVersionMinUpdate(VMC, false);
792     if (Update != 0)
793       Version += "." + utostr(MachOObjectFile::getVersionMinUpdate(VMC, false));
794     W.printString("Version", Version);
795     SmallString<32> SDK;
796     if (VMC.sdk == 0)
797       SDK = "n/a";
798     else {
799       SDK = utostr(MachOObjectFile::getVersionMinMajor(VMC, true)) + "." +
800             utostr(MachOObjectFile::getVersionMinMinor(VMC, true));
801       uint32_t Update = MachOObjectFile::getVersionMinUpdate(VMC, true);
802       if (Update != 0)
803         SDK += "." + utostr(MachOObjectFile::getVersionMinUpdate(VMC, true));
804     }
805     W.printString("SDK", SDK);
806   }
807 }
808 
809 void MachODumper::printMachODysymtab() {
810   for (const auto &Load : Obj->load_commands()) {
811     if (Load.C.cmd == MachO::LC_DYSYMTAB) {
812       MachO::dysymtab_command DLC = Obj->getDysymtabLoadCommand();
813       DictScope Group(W, "Dysymtab");
814       W.printNumber("ilocalsym", DLC.ilocalsym);
815       W.printNumber("nlocalsym", DLC.nlocalsym);
816       W.printNumber("iextdefsym", DLC.iextdefsym);
817       W.printNumber("nextdefsym", DLC.nextdefsym);
818       W.printNumber("iundefsym", DLC.iundefsym);
819       W.printNumber("nundefsym", DLC.nundefsym);
820       W.printNumber("tocoff", DLC.tocoff);
821       W.printNumber("ntoc", DLC.ntoc);
822       W.printNumber("modtaboff", DLC.modtaboff);
823       W.printNumber("nmodtab", DLC.nmodtab);
824       W.printNumber("extrefsymoff", DLC.extrefsymoff);
825       W.printNumber("nextrefsyms", DLC.nextrefsyms);
826       W.printNumber("indirectsymoff", DLC.indirectsymoff);
827       W.printNumber("nindirectsyms", DLC.nindirectsyms);
828       W.printNumber("extreloff", DLC.extreloff);
829       W.printNumber("nextrel", DLC.nextrel);
830       W.printNumber("locreloff", DLC.locreloff);
831       W.printNumber("nlocrel", DLC.nlocrel);
832     }
833   }
834 }
835 
836 void MachODumper::printMachOSegment() {
837   for (const auto &Load : Obj->load_commands()) {
838     if (Load.C.cmd == MachO::LC_SEGMENT || Load.C.cmd == MachO::LC_SEGMENT_64) {
839       MachOSegment MOSegment;
840       getSegment(Obj, Load, MOSegment);
841       DictScope Group(W, "Segment");
842       W.printString("Cmd", MOSegment.CmdName);
843       W.printString("Name", MOSegment.SegName);
844       W.printNumber("Size", MOSegment.cmdsize);
845       W.printHex("vmaddr", MOSegment.vmaddr);
846       W.printHex("vmsize", MOSegment.vmsize);
847       W.printNumber("fileoff", MOSegment.fileoff);
848       W.printNumber("filesize", MOSegment.filesize);
849       W.printString("maxprot", getMask(MOSegment.maxprot));
850       W.printString("initprot", getMask(MOSegment.initprot));
851       W.printNumber("nsects", MOSegment.nsects);
852       W.printHex("flags", MOSegment.flags);
853     }
854   }
855 }
856 
857 void MachODumper::printMachOIndirectSymbols() {
858   for (const auto &Load : Obj->load_commands()) {
859     if (Load.C.cmd == MachO::LC_DYSYMTAB) {
860       MachO::dysymtab_command DLC = Obj->getDysymtabLoadCommand();
861       DictScope Group(W, "Indirect Symbols");
862       W.printNumber("Number", DLC.nindirectsyms);
863       ListScope D(W, "Symbols");
864       for (unsigned i = 0; i < DLC.nindirectsyms; ++i) {
865         DictScope Group(W, "Entry");
866         W.printNumber("Entry Index", i);
867         W.printHex("Symbol Index", Obj->getIndirectSymbolTableEntry(DLC, i));
868       }
869     }
870   }
871 }
872 
873 void MachODumper::printMachOLinkerOptions() {
874   for (const auto &Load : Obj->load_commands()) {
875     if (Load.C.cmd == MachO::LC_LINKER_OPTION) {
876       MachO::linker_option_command LOLC = Obj->getLinkerOptionLoadCommand(Load);
877       DictScope Group(W, "Linker Options");
878       W.printNumber("Size", LOLC.cmdsize);
879       ListScope D(W, "Strings");
880       uint64_t DataSize = LOLC.cmdsize - sizeof(MachO::linker_option_command);
881       const char *P = Load.Ptr + sizeof(MachO::linker_option_command);
882       StringRef Data(P, DataSize);
883       for (unsigned i = 0; i < LOLC.count; ++i) {
884         std::pair<StringRef,StringRef> Split = Data.split('\0');
885         W.printString("Value", Split.first);
886         Data = Split.second;
887       }
888     }
889   }
890 }
891