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 printSections() 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 printSections(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::printSections() {
432   return printSections(Obj);
433 }
434 
435 void MachODumper::printSections(const MachOObjectFile *Obj) {
436   ListScope Group(W, "Sections");
437 
438   int SectionIndex = -1;
439   for (const SectionRef &Section : Obj->sections()) {
440     ++SectionIndex;
441 
442     MachOSection MOSection;
443     getSection(Obj, Section.getRawDataRefImpl(), MOSection);
444     DataRefImpl DR = Section.getRawDataRefImpl();
445 
446     StringRef Name;
447     error(Section.getName(Name));
448 
449     ArrayRef<char> RawName = Obj->getSectionRawName(DR);
450     StringRef SegmentName = Obj->getSectionFinalSegmentName(DR);
451     ArrayRef<char> RawSegmentName = Obj->getSectionRawFinalSegmentName(DR);
452 
453     DictScope SectionD(W, "Section");
454     W.printNumber("Index", SectionIndex);
455     W.printBinary("Name", Name, RawName);
456     W.printBinary("Segment", SegmentName, RawSegmentName);
457     W.printHex("Address", MOSection.Address);
458     W.printHex("Size", MOSection.Size);
459     W.printNumber("Offset", MOSection.Offset);
460     W.printNumber("Alignment", MOSection.Alignment);
461     W.printHex("RelocationOffset", MOSection.RelocationTableOffset);
462     W.printNumber("RelocationCount", MOSection.NumRelocationTableEntries);
463     W.printEnum("Type", MOSection.Flags & 0xFF,
464                 makeArrayRef(MachOSectionAttributes));
465     W.printFlags("Attributes", MOSection.Flags >> 8,
466                  makeArrayRef(MachOSectionAttributes));
467     W.printHex("Reserved1", MOSection.Reserved1);
468     W.printHex("Reserved2", MOSection.Reserved2);
469     if (Obj->is64Bit())
470       W.printHex("Reserved3", MOSection.Reserved3);
471 
472     if (opts::SectionRelocations) {
473       ListScope D(W, "Relocations");
474       for (const RelocationRef &Reloc : Section.relocations())
475         printRelocation(Reloc);
476     }
477 
478     if (opts::SectionSymbols) {
479       ListScope D(W, "Symbols");
480       for (const SymbolRef &Symbol : Obj->symbols()) {
481         if (!Section.containsSymbol(Symbol))
482           continue;
483 
484         printSymbol(Symbol);
485       }
486     }
487 
488     if (opts::SectionData) {
489       bool IsBSS = Section.isBSS();
490       if (!IsBSS) {
491         StringRef Data;
492         error(Section.getContents(Data));
493 
494         W.printBinaryBlock("SectionData", Data);
495       }
496     }
497   }
498 }
499 
500 void MachODumper::printRelocations() {
501   ListScope D(W, "Relocations");
502 
503   std::error_code EC;
504   for (const SectionRef &Section : Obj->sections()) {
505     StringRef Name;
506     error(Section.getName(Name));
507 
508     bool PrintedGroup = false;
509     for (const RelocationRef &Reloc : Section.relocations()) {
510       if (!PrintedGroup) {
511         W.startLine() << "Section " << Name << " {\n";
512         W.indent();
513         PrintedGroup = true;
514       }
515 
516       printRelocation(Reloc);
517     }
518 
519     if (PrintedGroup) {
520       W.unindent();
521       W.startLine() << "}\n";
522     }
523   }
524 }
525 
526 void MachODumper::printRelocation(const RelocationRef &Reloc) {
527   return printRelocation(Obj, Reloc);
528 }
529 
530 void MachODumper::printRelocation(const MachOObjectFile *Obj,
531                                   const RelocationRef &Reloc) {
532   uint64_t Offset = Reloc.getOffset();
533   SmallString<32> RelocName;
534   Reloc.getTypeName(RelocName);
535 
536   DataRefImpl DR = Reloc.getRawDataRefImpl();
537   MachO::any_relocation_info RE = Obj->getRelocation(DR);
538   bool IsScattered = Obj->isRelocationScattered(RE);
539   bool IsExtern = !IsScattered && Obj->getPlainRelocationExternal(RE);
540 
541   StringRef TargetName;
542   if (IsExtern) {
543     symbol_iterator Symbol = Reloc.getSymbol();
544     if (Symbol != Obj->symbol_end()) {
545       Expected<StringRef> TargetNameOrErr = Symbol->getName();
546       if (!TargetNameOrErr)
547         error(errorToErrorCode(TargetNameOrErr.takeError()));
548       TargetName = *TargetNameOrErr;
549     }
550   } else if (!IsScattered) {
551     section_iterator SecI = Obj->getRelocationSection(DR);
552     if (SecI != Obj->section_end()) {
553       error(SecI->getName(TargetName));
554     }
555   }
556   if (TargetName.empty())
557     TargetName = "-";
558 
559   if (opts::ExpandRelocs) {
560     DictScope Group(W, "Relocation");
561     W.printHex("Offset", Offset);
562     W.printNumber("PCRel", Obj->getAnyRelocationPCRel(RE));
563     W.printNumber("Length", Obj->getAnyRelocationLength(RE));
564     W.printNumber("Type", RelocName, Obj->getAnyRelocationType(RE));
565     if (IsScattered) {
566       W.printHex("Value", Obj->getScatteredRelocationValue(RE));
567     } else {
568       const char *Kind = IsExtern ? "Symbol" : "Section";
569       W.printNumber(Kind, TargetName, Obj->getPlainRelocationSymbolNum(RE));
570     }
571   } else {
572     SmallString<32> SymbolNameOrOffset("0x");
573     if (IsScattered) {
574       // Scattered relocations don't really have an associated symbol for some
575       // reason, even if one exists in the symtab at the correct address.
576       SymbolNameOrOffset += utohexstr(Obj->getScatteredRelocationValue(RE));
577     } else {
578       SymbolNameOrOffset = TargetName;
579     }
580 
581     raw_ostream& OS = W.startLine();
582     OS << W.hex(Offset)
583        << " " << Obj->getAnyRelocationPCRel(RE)
584        << " " << Obj->getAnyRelocationLength(RE);
585     if (IsScattered)
586       OS << " n/a";
587     else
588       OS << " " << Obj->getPlainRelocationExternal(RE);
589     OS << " " << RelocName
590        << " " << IsScattered
591        << " " << SymbolNameOrOffset
592        << "\n";
593   }
594 }
595 
596 void MachODumper::printSymbols() {
597   ListScope Group(W, "Symbols");
598 
599   for (const SymbolRef &Symbol : Obj->symbols()) {
600     printSymbol(Symbol);
601   }
602 }
603 
604 void MachODumper::printDynamicSymbols() {
605   ListScope Group(W, "DynamicSymbols");
606 }
607 
608 void MachODumper::printSymbol(const SymbolRef &Symbol) {
609   StringRef SymbolName;
610   Expected<StringRef> SymbolNameOrErr = Symbol.getName();
611   if (!SymbolNameOrErr) {
612     // TODO: Actually report errors helpfully.
613     consumeError(SymbolNameOrErr.takeError());
614   } else
615     SymbolName = *SymbolNameOrErr;
616 
617   MachOSymbol MOSymbol;
618   getSymbol(Obj, Symbol.getRawDataRefImpl(), MOSymbol);
619 
620   StringRef SectionName = "";
621   Expected<section_iterator> SecIOrErr = Symbol.getSection();
622   error(errorToErrorCode(SecIOrErr.takeError()));
623   section_iterator SecI = *SecIOrErr;
624   if (SecI != Obj->section_end())
625     error(SecI->getName(SectionName));
626 
627   DictScope D(W, "Symbol");
628   W.printNumber("Name", SymbolName, MOSymbol.StringIndex);
629   if (MOSymbol.Type & MachO::N_STAB) {
630     W.printHex("Type", "SymDebugTable", MOSymbol.Type);
631   } else {
632     if (MOSymbol.Type & MachO::N_PEXT)
633       W.startLine() << "PrivateExtern\n";
634     if (MOSymbol.Type & MachO::N_EXT)
635       W.startLine() << "Extern\n";
636     W.printEnum("Type", uint8_t(MOSymbol.Type & MachO::N_TYPE),
637                 makeArrayRef(MachOSymbolTypes));
638   }
639   W.printHex("Section", SectionName, MOSymbol.SectionIndex);
640   W.printEnum("RefType", static_cast<uint16_t>(MOSymbol.Flags & 0xF),
641               makeArrayRef(MachOSymbolRefTypes));
642   W.printFlags("Flags", static_cast<uint16_t>(MOSymbol.Flags & ~0xF),
643                makeArrayRef(MachOSymbolFlags));
644   W.printHex("Value", MOSymbol.Value);
645 }
646 
647 void MachODumper::printUnwindInfo() {
648   W.startLine() << "UnwindInfo not implemented.\n";
649 }
650 
651 void MachODumper::printStackMap() const {
652   object::SectionRef StackMapSection;
653   for (auto Sec : Obj->sections()) {
654     StringRef Name;
655     Sec.getName(Name);
656     if (Name == "__llvm_stackmaps") {
657       StackMapSection = Sec;
658       break;
659     }
660   }
661 
662   if (StackMapSection == object::SectionRef())
663     return;
664 
665   StringRef StackMapContents;
666   StackMapSection.getContents(StackMapContents);
667   ArrayRef<uint8_t> StackMapContentsArray(
668       reinterpret_cast<const uint8_t*>(StackMapContents.data()),
669       StackMapContents.size());
670 
671   if (Obj->isLittleEndian())
672      prettyPrintStackMap(
673                       llvm::outs(),
674                       StackMapV2Parser<support::little>(StackMapContentsArray));
675   else
676      prettyPrintStackMap(llvm::outs(),
677                          StackMapV2Parser<support::big>(StackMapContentsArray));
678 }
679 
680 void MachODumper::printNeededLibraries() {
681   ListScope D(W, "NeededLibraries");
682 
683   using LibsTy = std::vector<StringRef>;
684   LibsTy Libs;
685 
686   for (const auto &Command : Obj->load_commands()) {
687     if (Command.C.cmd == MachO::LC_LOAD_DYLIB ||
688         Command.C.cmd == MachO::LC_ID_DYLIB ||
689         Command.C.cmd == MachO::LC_LOAD_WEAK_DYLIB ||
690         Command.C.cmd == MachO::LC_REEXPORT_DYLIB ||
691         Command.C.cmd == MachO::LC_LAZY_LOAD_DYLIB ||
692         Command.C.cmd == MachO::LC_LOAD_UPWARD_DYLIB) {
693       MachO::dylib_command Dl = Obj->getDylibIDLoadCommand(Command);
694       if (Dl.dylib.name < Dl.cmdsize) {
695         auto *P = static_cast<const char*>(Command.Ptr) + Dl.dylib.name;
696         Libs.push_back(P);
697       }
698     }
699   }
700 
701   std::stable_sort(Libs.begin(), Libs.end());
702 
703   for (const auto &L : Libs) {
704     outs() << "  " << L << "\n";
705   }
706 }
707 
708 void MachODumper::printMachODataInCode() {
709   for (const auto &Load : Obj->load_commands()) {
710     if (Load.C.cmd  == MachO::LC_DATA_IN_CODE) {
711       MachO::linkedit_data_command LLC = Obj->getLinkeditDataLoadCommand(Load);
712       DictScope Group(W, "DataInCode");
713       W.printNumber("Data offset", LLC.dataoff);
714       W.printNumber("Data size", LLC.datasize);
715       ListScope D(W, "Data entries");
716       unsigned NumRegions = LLC.datasize / sizeof(MachO::data_in_code_entry);
717       for (unsigned i = 0; i < NumRegions; ++i) {
718         MachO::data_in_code_entry DICE = Obj->getDataInCodeTableEntry(
719                                                               LLC.dataoff, i);
720         DictScope Group(W, "Entry");
721         W.printNumber("Index", i);
722         W.printNumber("Offset", DICE.offset);
723         W.printNumber("Length", DICE.length);
724         W.printNumber("Kind", DICE.kind);
725       }
726     }
727   }
728 }
729 
730 void MachODumper::printMachOVersionMin() {
731   for (const auto &Load : Obj->load_commands()) {
732     StringRef Cmd;
733     switch (Load.C.cmd) {
734     case MachO::LC_VERSION_MIN_MACOSX:
735       Cmd = "LC_VERSION_MIN_MACOSX";
736       break;
737     case MachO::LC_VERSION_MIN_IPHONEOS:
738       Cmd = "LC_VERSION_MIN_IPHONEOS";
739       break;
740     case MachO::LC_VERSION_MIN_TVOS:
741       Cmd = "LC_VERSION_MIN_TVOS";
742       break;
743     case MachO::LC_VERSION_MIN_WATCHOS:
744       Cmd = "LC_VERSION_MIN_WATCHOS";
745       break;
746     case MachO::LC_BUILD_VERSION:
747       Cmd = "LC_BUILD_VERSION";
748       break;
749     default:
750       continue;
751     }
752 
753     DictScope Group(W, "MinVersion");
754     // Handle LC_BUILD_VERSION.
755     if (Load.C.cmd == MachO::LC_BUILD_VERSION) {
756       MachO::build_version_command BVC = Obj->getBuildVersionLoadCommand(Load);
757       W.printString("Cmd", Cmd);
758       W.printNumber("Size", BVC.cmdsize);
759       W.printString("Platform",
760                     MachOObjectFile::getBuildPlatform(BVC.platform));
761       W.printString("Version", MachOObjectFile::getVersionString(BVC.minos));
762       if (BVC.sdk)
763         W.printString("SDK", MachOObjectFile::getVersionString(BVC.sdk));
764       else
765         W.printString("SDK", StringRef("n/a"));
766       continue;
767     }
768 
769     MachO::version_min_command VMC = Obj->getVersionMinLoadCommand(Load);
770     W.printString("Cmd", Cmd);
771     W.printNumber("Size", VMC.cmdsize);
772     SmallString<32> Version;
773     Version = utostr(MachOObjectFile::getVersionMinMajor(VMC, false)) + "." +
774               utostr(MachOObjectFile::getVersionMinMinor(VMC, false));
775     uint32_t Update = MachOObjectFile::getVersionMinUpdate(VMC, false);
776     if (Update != 0)
777       Version += "." + utostr(MachOObjectFile::getVersionMinUpdate(VMC, false));
778     W.printString("Version", Version);
779     SmallString<32> SDK;
780     if (VMC.sdk == 0)
781       SDK = "n/a";
782     else {
783       SDK = utostr(MachOObjectFile::getVersionMinMajor(VMC, true)) + "." +
784             utostr(MachOObjectFile::getVersionMinMinor(VMC, true));
785       uint32_t Update = MachOObjectFile::getVersionMinUpdate(VMC, true);
786       if (Update != 0)
787         SDK += "." + utostr(MachOObjectFile::getVersionMinUpdate(VMC, true));
788     }
789     W.printString("SDK", SDK);
790   }
791 }
792 
793 void MachODumper::printMachODysymtab() {
794   for (const auto &Load : Obj->load_commands()) {
795     if (Load.C.cmd == MachO::LC_DYSYMTAB) {
796       MachO::dysymtab_command DLC = Obj->getDysymtabLoadCommand();
797       DictScope Group(W, "Dysymtab");
798       W.printNumber("ilocalsym", DLC.ilocalsym);
799       W.printNumber("nlocalsym", DLC.nlocalsym);
800       W.printNumber("iextdefsym", DLC.iextdefsym);
801       W.printNumber("nextdefsym", DLC.nextdefsym);
802       W.printNumber("iundefsym", DLC.iundefsym);
803       W.printNumber("nundefsym", DLC.nundefsym);
804       W.printNumber("tocoff", DLC.tocoff);
805       W.printNumber("ntoc", DLC.ntoc);
806       W.printNumber("modtaboff", DLC.modtaboff);
807       W.printNumber("nmodtab", DLC.nmodtab);
808       W.printNumber("extrefsymoff", DLC.extrefsymoff);
809       W.printNumber("nextrefsyms", DLC.nextrefsyms);
810       W.printNumber("indirectsymoff", DLC.indirectsymoff);
811       W.printNumber("nindirectsyms", DLC.nindirectsyms);
812       W.printNumber("extreloff", DLC.extreloff);
813       W.printNumber("nextrel", DLC.nextrel);
814       W.printNumber("locreloff", DLC.locreloff);
815       W.printNumber("nlocrel", DLC.nlocrel);
816     }
817   }
818 }
819 
820 void MachODumper::printMachOSegment() {
821   for (const auto &Load : Obj->load_commands()) {
822     if (Load.C.cmd == MachO::LC_SEGMENT || Load.C.cmd == MachO::LC_SEGMENT_64) {
823       MachOSegment MOSegment;
824       getSegment(Obj, Load, MOSegment);
825       DictScope Group(W, "Segment");
826       W.printString("Cmd", MOSegment.CmdName);
827       W.printString("Name", MOSegment.SegName);
828       W.printNumber("Size", MOSegment.cmdsize);
829       W.printHex("vmaddr", MOSegment.vmaddr);
830       W.printHex("vmsize", MOSegment.vmsize);
831       W.printNumber("fileoff", MOSegment.fileoff);
832       W.printNumber("filesize", MOSegment.filesize);
833       W.printString("maxprot", getMask(MOSegment.maxprot));
834       W.printString("initprot", getMask(MOSegment.initprot));
835       W.printNumber("nsects", MOSegment.nsects);
836       W.printHex("flags", MOSegment.flags);
837     }
838   }
839 }
840 
841 void MachODumper::printMachOIndirectSymbols() {
842   for (const auto &Load : Obj->load_commands()) {
843     if (Load.C.cmd == MachO::LC_DYSYMTAB) {
844       MachO::dysymtab_command DLC = Obj->getDysymtabLoadCommand();
845       DictScope Group(W, "Indirect Symbols");
846       W.printNumber("Number", DLC.nindirectsyms);
847       ListScope D(W, "Symbols");
848       for (unsigned i = 0; i < DLC.nindirectsyms; ++i) {
849         DictScope Group(W, "Entry");
850         W.printNumber("Entry Index", i);
851         W.printHex("Symbol Index", Obj->getIndirectSymbolTableEntry(DLC, i));
852       }
853     }
854   }
855 }
856 
857 void MachODumper::printMachOLinkerOptions() {
858   for (const auto &Load : Obj->load_commands()) {
859     if (Load.C.cmd == MachO::LC_LINKER_OPTION) {
860       MachO::linker_option_command LOLC = Obj->getLinkerOptionLoadCommand(Load);
861       DictScope Group(W, "Linker Options");
862       W.printNumber("Size", LOLC.cmdsize);
863       ListScope D(W, "Strings");
864       uint64_t DataSize = LOLC.cmdsize - sizeof(MachO::linker_option_command);
865       const char *P = Load.Ptr + sizeof(MachO::linker_option_command);
866       StringRef Data(P, DataSize);
867       for (unsigned i = 0; i < LOLC.count; ++i) {
868         std::pair<StringRef,StringRef> Split = Data.split('\0');
869         W.printString("Value", Split.first);
870         Data = Split.second;
871       }
872     }
873   }
874 }
875