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