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 "llvm-readobj.h"
15 #include "Error.h"
16 #include "ObjDumper.h"
17 #include "StackMapPrinter.h"
18 #include "StreamWriter.h"
19 #include "llvm/ADT/SmallString.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/Object/MachO.h"
22 #include "llvm/Support/Casting.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, StreamWriter& Writer)
32     : ObjDumper(Writer)
33     , Obj(Obj) { }
34 
35   void printFileHeaders() override;
36   void printSections() override;
37   void printRelocations() override;
38   void printSymbols() override;
39   void printDynamicSymbols() override;
40   void printUnwindInfo() override;
41   void printStackMap() const override;
42 
43   // MachO-specific.
44   void printMachODataInCode() override;
45   void printMachOVersionMin() override;
46   void printMachODysymtab() override;
47   void printMachOSegment() override;
48   void printMachOIndirectSymbols() override;
49   void printMachOLinkerOptions () override;
50 
51 private:
52   template<class MachHeader>
53   void printFileHeaders(const MachHeader &Header);
54 
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 printSections(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                                   StreamWriter &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 };
166 
167 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesSPARC[] = {
168   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_SPARC_ALL),
169 };
170 
171 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesPPC[] = {
172   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_ALL),
173   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_601),
174   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_602),
175   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_603),
176   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_603e),
177   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_603ev),
178   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_604),
179   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_604e),
180   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_620),
181   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_750),
182   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_7400),
183   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_7450),
184   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_970),
185 };
186 
187 static const EnumEntry<uint32_t> MachOHeaderFlags[] = {
188   LLVM_READOBJ_ENUM_ENT(MachO, MH_NOUNDEFS),
189   LLVM_READOBJ_ENUM_ENT(MachO, MH_INCRLINK),
190   LLVM_READOBJ_ENUM_ENT(MachO, MH_DYLDLINK),
191   LLVM_READOBJ_ENUM_ENT(MachO, MH_BINDATLOAD),
192   LLVM_READOBJ_ENUM_ENT(MachO, MH_PREBOUND),
193   LLVM_READOBJ_ENUM_ENT(MachO, MH_SPLIT_SEGS),
194   LLVM_READOBJ_ENUM_ENT(MachO, MH_LAZY_INIT),
195   LLVM_READOBJ_ENUM_ENT(MachO, MH_TWOLEVEL),
196   LLVM_READOBJ_ENUM_ENT(MachO, MH_FORCE_FLAT),
197   LLVM_READOBJ_ENUM_ENT(MachO, MH_NOMULTIDEFS),
198   LLVM_READOBJ_ENUM_ENT(MachO, MH_NOFIXPREBINDING),
199   LLVM_READOBJ_ENUM_ENT(MachO, MH_PREBINDABLE),
200   LLVM_READOBJ_ENUM_ENT(MachO, MH_ALLMODSBOUND),
201   LLVM_READOBJ_ENUM_ENT(MachO, MH_SUBSECTIONS_VIA_SYMBOLS),
202   LLVM_READOBJ_ENUM_ENT(MachO, MH_CANONICAL),
203   LLVM_READOBJ_ENUM_ENT(MachO, MH_WEAK_DEFINES),
204   LLVM_READOBJ_ENUM_ENT(MachO, MH_BINDS_TO_WEAK),
205   LLVM_READOBJ_ENUM_ENT(MachO, MH_ALLOW_STACK_EXECUTION),
206   LLVM_READOBJ_ENUM_ENT(MachO, MH_ROOT_SAFE),
207   LLVM_READOBJ_ENUM_ENT(MachO, MH_SETUID_SAFE),
208   LLVM_READOBJ_ENUM_ENT(MachO, MH_NO_REEXPORTED_DYLIBS),
209   LLVM_READOBJ_ENUM_ENT(MachO, MH_PIE),
210   LLVM_READOBJ_ENUM_ENT(MachO, MH_DEAD_STRIPPABLE_DYLIB),
211   LLVM_READOBJ_ENUM_ENT(MachO, MH_HAS_TLV_DESCRIPTORS),
212   LLVM_READOBJ_ENUM_ENT(MachO, MH_NO_HEAP_EXECUTION),
213   LLVM_READOBJ_ENUM_ENT(MachO, MH_APP_EXTENSION_SAFE),
214 };
215 
216 static const EnumEntry<unsigned> MachOSectionAttributes[] = {
217   { "LocReloc"         , 1 <<  0 /*S_ATTR_LOC_RELOC          */ },
218   { "ExtReloc"         , 1 <<  1 /*S_ATTR_EXT_RELOC          */ },
219   { "SomeInstructions" , 1 <<  2 /*S_ATTR_SOME_INSTRUCTIONS  */ },
220   { "Debug"            , 1 << 17 /*S_ATTR_DEBUG              */ },
221   { "SelfModifyingCode", 1 << 18 /*S_ATTR_SELF_MODIFYING_CODE*/ },
222   { "LiveSupport"      , 1 << 19 /*S_ATTR_LIVE_SUPPORT       */ },
223   { "NoDeadStrip"      , 1 << 20 /*S_ATTR_NO_DEAD_STRIP      */ },
224   { "StripStaticSyms"  , 1 << 21 /*S_ATTR_STRIP_STATIC_SYMS  */ },
225   { "NoTOC"            , 1 << 22 /*S_ATTR_NO_TOC             */ },
226   { "PureInstructions" , 1 << 23 /*S_ATTR_PURE_INSTRUCTIONS  */ },
227 };
228 
229 static const EnumEntry<unsigned> MachOSymbolRefTypes[] = {
230   { "UndefinedNonLazy",                     0 },
231   { "ReferenceFlagUndefinedLazy",           1 },
232   { "ReferenceFlagDefined",                 2 },
233   { "ReferenceFlagPrivateDefined",          3 },
234   { "ReferenceFlagPrivateUndefinedNonLazy", 4 },
235   { "ReferenceFlagPrivateUndefinedLazy",    5 }
236 };
237 
238 static const EnumEntry<unsigned> MachOSymbolFlags[] = {
239   { "ReferencedDynamically", 0x10 },
240   { "NoDeadStrip",           0x20 },
241   { "WeakRef",               0x40 },
242   { "WeakDef",               0x80 },
243   { "AltEntry",             0x200 },
244 };
245 
246 static const EnumEntry<unsigned> MachOSymbolTypes[] = {
247   { "Undef",           0x0 },
248   { "Abs",             0x2 },
249   { "Indirect",        0xA },
250   { "PreboundUndef",   0xC },
251   { "Section",         0xE }
252 };
253 
254 namespace {
255   struct MachOSection {
256     ArrayRef<char> Name;
257     ArrayRef<char> SegmentName;
258     uint64_t Address;
259     uint64_t Size;
260     uint32_t Offset;
261     uint32_t Alignment;
262     uint32_t RelocationTableOffset;
263     uint32_t NumRelocationTableEntries;
264     uint32_t Flags;
265     uint32_t Reserved1;
266     uint32_t Reserved2;
267     uint32_t Reserved3;
268   };
269 
270   struct MachOSegment {
271     std::string CmdName;
272     std::string SegName;
273     uint64_t cmdsize;
274     uint64_t vmaddr;
275     uint64_t vmsize;
276     uint64_t fileoff;
277     uint64_t filesize;
278     uint32_t maxprot;
279     uint32_t initprot;
280     uint32_t nsects;
281     uint32_t flags;
282   };
283 
284   struct MachOSymbol {
285     uint32_t StringIndex;
286     uint8_t Type;
287     uint8_t SectionIndex;
288     uint16_t Flags;
289     uint64_t Value;
290   };
291 }
292 
293 static std::string getMask(uint32_t prot)
294 {
295   // TODO (davide): This always assumes prot is valid.
296   // Catch mistakes and report if needed.
297   std::string Prot;
298   Prot = "";
299   Prot += (prot & MachO::VM_PROT_READ) ? "r" : "-";
300   Prot += (prot & MachO::VM_PROT_WRITE) ? "w" : "-";
301   Prot += (prot & MachO::VM_PROT_EXECUTE) ? "x" : "-";
302   return Prot;
303 }
304 
305 static void getSection(const MachOObjectFile *Obj,
306                        DataRefImpl Sec,
307                        MachOSection &Section) {
308   if (!Obj->is64Bit()) {
309     MachO::section Sect = Obj->getSection(Sec);
310     Section.Address     = Sect.addr;
311     Section.Size        = Sect.size;
312     Section.Offset      = Sect.offset;
313     Section.Alignment   = Sect.align;
314     Section.RelocationTableOffset = Sect.reloff;
315     Section.NumRelocationTableEntries = Sect.nreloc;
316     Section.Flags       = Sect.flags;
317     Section.Reserved1   = Sect.reserved1;
318     Section.Reserved2   = Sect.reserved2;
319     return;
320   }
321   MachO::section_64 Sect = Obj->getSection64(Sec);
322   Section.Address     = Sect.addr;
323   Section.Size        = Sect.size;
324   Section.Offset      = Sect.offset;
325   Section.Alignment   = Sect.align;
326   Section.RelocationTableOffset = Sect.reloff;
327   Section.NumRelocationTableEntries = Sect.nreloc;
328   Section.Flags       = Sect.flags;
329   Section.Reserved1   = Sect.reserved1;
330   Section.Reserved2   = Sect.reserved2;
331   Section.Reserved3   = Sect.reserved3;
332 }
333 
334 static void getSegment(const MachOObjectFile *Obj,
335                        const MachOObjectFile::LoadCommandInfo &L,
336                        MachOSegment &Segment) {
337   if (!Obj->is64Bit()) {
338     MachO::segment_command SC = Obj->getSegmentLoadCommand(L);
339     Segment.CmdName = "LC_SEGMENT";
340     Segment.SegName = SC.segname;
341     Segment.cmdsize = SC.cmdsize;
342     Segment.vmaddr = SC.vmaddr;
343     Segment.vmsize = SC.vmsize;
344     Segment.fileoff = SC.fileoff;
345     Segment.filesize = SC.filesize;
346     Segment.maxprot = SC.maxprot;
347     Segment.initprot = SC.initprot;
348     Segment.nsects = SC.nsects;
349     Segment.flags = SC.flags;
350     return;
351   }
352   MachO::segment_command_64 SC = Obj->getSegment64LoadCommand(L);
353   Segment.CmdName = "LC_SEGMENT_64";
354   Segment.SegName = SC.segname;
355   Segment.cmdsize = SC.cmdsize;
356   Segment.vmaddr = SC.vmaddr;
357   Segment.vmsize = SC.vmsize;
358   Segment.fileoff = SC.fileoff;
359   Segment.filesize = SC.filesize;
360   Segment.maxprot = SC.maxprot;
361   Segment.initprot = SC.initprot;
362   Segment.nsects = SC.nsects;
363   Segment.flags = SC.flags;
364 }
365 
366 static void getSymbol(const MachOObjectFile *Obj,
367                       DataRefImpl DRI,
368                       MachOSymbol &Symbol) {
369   if (!Obj->is64Bit()) {
370     MachO::nlist Entry = Obj->getSymbolTableEntry(DRI);
371     Symbol.StringIndex  = Entry.n_strx;
372     Symbol.Type         = Entry.n_type;
373     Symbol.SectionIndex = Entry.n_sect;
374     Symbol.Flags        = Entry.n_desc;
375     Symbol.Value        = Entry.n_value;
376     return;
377   }
378   MachO::nlist_64 Entry = Obj->getSymbol64TableEntry(DRI);
379   Symbol.StringIndex  = Entry.n_strx;
380   Symbol.Type         = Entry.n_type;
381   Symbol.SectionIndex = Entry.n_sect;
382   Symbol.Flags        = Entry.n_desc;
383   Symbol.Value        = Entry.n_value;
384 }
385 
386 void MachODumper::printFileHeaders() {
387   DictScope H(W, "MachHeader");
388   if (!Obj->is64Bit()) {
389     printFileHeaders(Obj->getHeader());
390   } else {
391     printFileHeaders(Obj->getHeader64());
392     W.printHex("Reserved", Obj->getHeader64().reserved);
393   }
394 }
395 
396 template<class MachHeader>
397 void MachODumper::printFileHeaders(const MachHeader &Header) {
398   W.printEnum("Magic", Header.magic, makeArrayRef(MachOMagics));
399   W.printEnum("CpuType", Header.cputype, makeArrayRef(MachOHeaderCpuTypes));
400   uint32_t subtype = Header.cpusubtype & ~MachO::CPU_SUBTYPE_MASK;
401   switch (Header.cputype) {
402   case MachO::CPU_TYPE_X86:
403     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesX86));
404     break;
405   case MachO::CPU_TYPE_X86_64:
406     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesX64));
407     break;
408   case MachO::CPU_TYPE_ARM:
409     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesARM));
410     break;
411   case MachO::CPU_TYPE_POWERPC:
412     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesPPC));
413     break;
414   case MachO::CPU_TYPE_SPARC:
415     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesSPARC));
416     break;
417   case MachO::CPU_TYPE_ARM64:
418     W.printEnum("CpuSubType", subtype, makeArrayRef(MachOHeaderCpuSubtypesARM64));
419     break;
420   case MachO::CPU_TYPE_POWERPC64:
421   default:
422     W.printHex("CpuSubtype", subtype);
423   }
424   W.printEnum("FileType", Header.filetype, makeArrayRef(MachOHeaderFileTypes));
425   W.printNumber("NumOfLoadCommands", Header.ncmds);
426   W.printNumber("SizeOfLoadCommands", Header.sizeofcmds);
427   W.printFlags("Flags", Header.flags, makeArrayRef(MachOHeaderFlags));
428 }
429 
430 void MachODumper::printSections() {
431   return printSections(Obj);
432 }
433 
434 void MachODumper::printSections(const MachOObjectFile *Obj) {
435   ListScope Group(W, "Sections");
436 
437   int SectionIndex = -1;
438   for (const SectionRef &Section : Obj->sections()) {
439     ++SectionIndex;
440 
441     MachOSection MOSection;
442     getSection(Obj, Section.getRawDataRefImpl(), MOSection);
443     DataRefImpl DR = Section.getRawDataRefImpl();
444 
445     StringRef Name;
446     error(Section.getName(Name));
447 
448     ArrayRef<char> RawName = Obj->getSectionRawName(DR);
449     StringRef SegmentName = Obj->getSectionFinalSegmentName(DR);
450     ArrayRef<char> RawSegmentName = Obj->getSectionRawFinalSegmentName(DR);
451 
452     DictScope SectionD(W, "Section");
453     W.printNumber("Index", SectionIndex);
454     W.printBinary("Name", Name, RawName);
455     W.printBinary("Segment", SegmentName, RawSegmentName);
456     W.printHex("Address", MOSection.Address);
457     W.printHex("Size", MOSection.Size);
458     W.printNumber("Offset", MOSection.Offset);
459     W.printNumber("Alignment", MOSection.Alignment);
460     W.printHex("RelocationOffset", MOSection.RelocationTableOffset);
461     W.printNumber("RelocationCount", MOSection.NumRelocationTableEntries);
462     W.printEnum("Type", MOSection.Flags & 0xFF,
463                 makeArrayRef(MachOSectionAttributes));
464     W.printFlags("Attributes", MOSection.Flags >> 8,
465                  makeArrayRef(MachOSectionAttributes));
466     W.printHex("Reserved1", MOSection.Reserved1);
467     W.printHex("Reserved2", MOSection.Reserved2);
468     if (Obj->is64Bit())
469       W.printHex("Reserved3", MOSection.Reserved3);
470 
471     if (opts::SectionRelocations) {
472       ListScope D(W, "Relocations");
473       for (const RelocationRef &Reloc : Section.relocations())
474         printRelocation(Reloc);
475     }
476 
477     if (opts::SectionSymbols) {
478       ListScope D(W, "Symbols");
479       for (const SymbolRef &Symbol : Obj->symbols()) {
480         if (!Section.containsSymbol(Symbol))
481           continue;
482 
483         printSymbol(Symbol);
484       }
485     }
486 
487     if (opts::SectionData) {
488       bool IsBSS = Section.isBSS();
489       if (!IsBSS) {
490         StringRef Data;
491         error(Section.getContents(Data));
492 
493         W.printBinaryBlock("SectionData", Data);
494       }
495     }
496   }
497 }
498 
499 void MachODumper::printRelocations() {
500   ListScope D(W, "Relocations");
501 
502   std::error_code EC;
503   for (const SectionRef &Section : Obj->sections()) {
504     StringRef Name;
505     error(Section.getName(Name));
506 
507     bool PrintedGroup = false;
508     for (const RelocationRef &Reloc : Section.relocations()) {
509       if (!PrintedGroup) {
510         W.startLine() << "Section " << Name << " {\n";
511         W.indent();
512         PrintedGroup = true;
513       }
514 
515       printRelocation(Reloc);
516     }
517 
518     if (PrintedGroup) {
519       W.unindent();
520       W.startLine() << "}\n";
521     }
522   }
523 }
524 
525 void MachODumper::printRelocation(const RelocationRef &Reloc) {
526   return printRelocation(Obj, Reloc);
527 }
528 
529 void MachODumper::printRelocation(const MachOObjectFile *Obj,
530                                   const RelocationRef &Reloc) {
531   uint64_t Offset = Reloc.getOffset();
532   SmallString<32> RelocName;
533   Reloc.getTypeName(RelocName);
534 
535   DataRefImpl DR = Reloc.getRawDataRefImpl();
536   MachO::any_relocation_info RE = Obj->getRelocation(DR);
537   bool IsScattered = Obj->isRelocationScattered(RE);
538   bool IsExtern = !IsScattered && Obj->getPlainRelocationExternal(RE);
539 
540   StringRef TargetName;
541   if (IsExtern) {
542     symbol_iterator Symbol = Reloc.getSymbol();
543     if (Symbol != Obj->symbol_end()) {
544       Expected<StringRef> TargetNameOrErr = Symbol->getName();
545       if (!TargetNameOrErr)
546         error(errorToErrorCode(TargetNameOrErr.takeError()));
547       TargetName = *TargetNameOrErr;
548     }
549   } else if (!IsScattered) {
550     section_iterator SecI = Obj->getRelocationSection(DR);
551     if (SecI != Obj->section_end()) {
552       error(SecI->getName(TargetName));
553     }
554   }
555   if (TargetName.empty())
556     TargetName = "-";
557 
558   if (opts::ExpandRelocs) {
559     DictScope Group(W, "Relocation");
560     W.printHex("Offset", Offset);
561     W.printNumber("PCRel", Obj->getAnyRelocationPCRel(RE));
562     W.printNumber("Length", Obj->getAnyRelocationLength(RE));
563     W.printNumber("Type", RelocName, Obj->getAnyRelocationType(RE));
564     if (IsScattered) {
565       W.printHex("Value", Obj->getScatteredRelocationValue(RE));
566     } else {
567       const char *Kind = IsExtern ? "Symbol" : "Section";
568       W.printNumber(Kind, TargetName, Obj->getPlainRelocationSymbolNum(RE));
569     }
570   } else {
571     SmallString<32> SymbolNameOrOffset("0x");
572     if (IsScattered) {
573       // Scattered relocations don't really have an associated symbol for some
574       // reason, even if one exists in the symtab at the correct address.
575       SymbolNameOrOffset += utohexstr(Obj->getScatteredRelocationValue(RE));
576     } else {
577       SymbolNameOrOffset = TargetName;
578     }
579 
580     raw_ostream& OS = W.startLine();
581     OS << W.hex(Offset)
582        << " " << Obj->getAnyRelocationPCRel(RE)
583        << " " << Obj->getAnyRelocationLength(RE);
584     if (IsScattered)
585       OS << " n/a";
586     else
587       OS << " " << Obj->getPlainRelocationExternal(RE);
588     OS << " " << RelocName
589        << " " << IsScattered
590        << " " << SymbolNameOrOffset
591        << "\n";
592   }
593 }
594 
595 void MachODumper::printSymbols() {
596   ListScope Group(W, "Symbols");
597 
598   for (const SymbolRef &Symbol : Obj->symbols()) {
599     printSymbol(Symbol);
600   }
601 }
602 
603 void MachODumper::printDynamicSymbols() {
604   ListScope Group(W, "DynamicSymbols");
605 }
606 
607 void MachODumper::printSymbol(const SymbolRef &Symbol) {
608   StringRef SymbolName;
609   Expected<StringRef> SymbolNameOrErr = Symbol.getName();
610   if (!SymbolNameOrErr) {
611     // TODO: Actually report errors helpfully.
612     consumeError(SymbolNameOrErr.takeError());
613   } else
614     SymbolName = *SymbolNameOrErr;
615 
616   MachOSymbol MOSymbol;
617   getSymbol(Obj, Symbol.getRawDataRefImpl(), MOSymbol);
618 
619   StringRef SectionName = "";
620   ErrorOr<section_iterator> SecIOrErr = Symbol.getSection();
621   error(SecIOrErr.getError());
622   section_iterator SecI = *SecIOrErr;
623   if (SecI != Obj->section_end())
624     error(SecI->getName(SectionName));
625 
626   DictScope D(W, "Symbol");
627   W.printNumber("Name", SymbolName, MOSymbol.StringIndex);
628   if (MOSymbol.Type & MachO::N_STAB) {
629     W.printHex("Type", "SymDebugTable", MOSymbol.Type);
630   } else {
631     if (MOSymbol.Type & MachO::N_PEXT)
632       W.startLine() << "PrivateExtern\n";
633     if (MOSymbol.Type & MachO::N_EXT)
634       W.startLine() << "Extern\n";
635     W.printEnum("Type", uint8_t(MOSymbol.Type & MachO::N_TYPE),
636                 makeArrayRef(MachOSymbolTypes));
637   }
638   W.printHex("Section", SectionName, MOSymbol.SectionIndex);
639   W.printEnum("RefType", static_cast<uint16_t>(MOSymbol.Flags & 0xF),
640               makeArrayRef(MachOSymbolRefTypes));
641   W.printFlags("Flags", static_cast<uint16_t>(MOSymbol.Flags & ~0xF),
642                makeArrayRef(MachOSymbolFlags));
643   W.printHex("Value", MOSymbol.Value);
644 }
645 
646 void MachODumper::printUnwindInfo() {
647   W.startLine() << "UnwindInfo not implemented.\n";
648 }
649 
650 void MachODumper::printStackMap() const {
651   object::SectionRef StackMapSection;
652   for (auto Sec : Obj->sections()) {
653     StringRef Name;
654     Sec.getName(Name);
655     if (Name == "__llvm_stackmaps") {
656       StackMapSection = Sec;
657       break;
658     }
659   }
660 
661   if (StackMapSection == object::SectionRef())
662     return;
663 
664   StringRef StackMapContents;
665   StackMapSection.getContents(StackMapContents);
666   ArrayRef<uint8_t> StackMapContentsArray(
667       reinterpret_cast<const uint8_t*>(StackMapContents.data()),
668       StackMapContents.size());
669 
670   if (Obj->isLittleEndian())
671      prettyPrintStackMap(
672                       llvm::outs(),
673                       StackMapV1Parser<support::little>(StackMapContentsArray));
674   else
675      prettyPrintStackMap(llvm::outs(),
676                          StackMapV1Parser<support::big>(StackMapContentsArray));
677 }
678 
679 void MachODumper::printMachODataInCode() {
680   for (const auto &Load : Obj->load_commands()) {
681     if (Load.C.cmd  == MachO::LC_DATA_IN_CODE) {
682       MachO::linkedit_data_command LLC = Obj->getLinkeditDataLoadCommand(Load);
683       DictScope Group(W, "DataInCode");
684       W.printNumber("Data offset", LLC.dataoff);
685       W.printNumber("Data size", LLC.datasize);
686       ListScope D(W, "Data entries");
687       unsigned NumRegions = LLC.datasize / sizeof(MachO::data_in_code_entry);
688       for (unsigned i = 0; i < NumRegions; ++i) {
689         MachO::data_in_code_entry DICE = Obj->getDataInCodeTableEntry(
690                                                               LLC.dataoff, i);
691         DictScope Group(W, "Entry");
692         W.printNumber("Index", i);
693         W.printNumber("Offset", DICE.offset);
694         W.printNumber("Length", DICE.length);
695         W.printNumber("Kind", DICE.kind);
696       }
697     }
698   }
699 }
700 
701 void MachODumper::printMachOVersionMin() {
702   for (const auto &Load : Obj->load_commands()) {
703     StringRef Cmd;
704     switch (Load.C.cmd) {
705     case MachO::LC_VERSION_MIN_MACOSX:
706       Cmd = "LC_VERSION_MIN_MACOSX";
707       break;
708     case MachO::LC_VERSION_MIN_IPHONEOS:
709       Cmd = "LC_VERSION_MIN_IPHONEOS";
710       break;
711     case MachO::LC_VERSION_MIN_TVOS:
712       Cmd = "LC_VERSION_MIN_TVOS";
713       break;
714     case MachO::LC_VERSION_MIN_WATCHOS:
715       Cmd = "LC_VERSION_MIN_WATCHOS";
716       break;
717     default:
718       continue;
719     }
720 
721     MachO::version_min_command VMC = Obj->getVersionMinLoadCommand(Load);
722     DictScope Group(W, "MinVersion");
723     W.printString("Cmd", Cmd);
724     W.printNumber("Size", VMC.cmdsize);
725     SmallString<32> Version;
726     Version = utostr(MachOObjectFile::getVersionMinMajor(VMC, false)) + "." +
727               utostr(MachOObjectFile::getVersionMinMinor(VMC, false));
728     uint32_t Update = MachOObjectFile::getVersionMinUpdate(VMC, false);
729     if (Update != 0)
730       Version += "." + utostr(MachOObjectFile::getVersionMinUpdate(VMC, false));
731     W.printString("Version", Version);
732     SmallString<32> SDK;
733     if (VMC.sdk == 0)
734       SDK = "n/a";
735     else {
736       SDK = utostr(MachOObjectFile::getVersionMinMajor(VMC, true)) + "." +
737             utostr(MachOObjectFile::getVersionMinMinor(VMC, true));
738       uint32_t Update = MachOObjectFile::getVersionMinUpdate(VMC, true);
739       if (Update != 0)
740         SDK += "." + utostr(MachOObjectFile::getVersionMinUpdate(VMC, true));
741     }
742     W.printString("SDK", SDK);
743   }
744 }
745 
746 void MachODumper::printMachODysymtab() {
747   for (const auto &Load : Obj->load_commands()) {
748     if (Load.C.cmd == MachO::LC_DYSYMTAB) {
749       MachO::dysymtab_command DLC = Obj->getDysymtabLoadCommand();
750       DictScope Group(W, "Dysymtab");
751       W.printNumber("ilocalsym", DLC.ilocalsym);
752       W.printNumber("nlocalsym", DLC.nlocalsym);
753       W.printNumber("iextdefsym", DLC.iextdefsym);
754       W.printNumber("nextdefsym", DLC.nextdefsym);
755       W.printNumber("iundefsym", DLC.iundefsym);
756       W.printNumber("nundefsym", DLC.nundefsym);
757       W.printNumber("tocoff", DLC.tocoff);
758       W.printNumber("ntoc", DLC.ntoc);
759       W.printNumber("modtaboff", DLC.modtaboff);
760       W.printNumber("nmodtab", DLC.nmodtab);
761       W.printNumber("extrefsymoff", DLC.extrefsymoff);
762       W.printNumber("nextrefsyms", DLC.nextrefsyms);
763       W.printNumber("indirectsymoff", DLC.indirectsymoff);
764       W.printNumber("nindirectsyms", DLC.nindirectsyms);
765       W.printNumber("extreloff", DLC.extreloff);
766       W.printNumber("nextrel", DLC.nextrel);
767       W.printNumber("locreloff", DLC.locreloff);
768       W.printNumber("nlocrel", DLC.nlocrel);
769     }
770   }
771 }
772 
773 void MachODumper::printMachOSegment() {
774   for (const auto &Load : Obj->load_commands()) {
775     if (Load.C.cmd == MachO::LC_SEGMENT || Load.C.cmd == MachO::LC_SEGMENT_64) {
776       MachOSegment MOSegment;
777       getSegment(Obj, Load, MOSegment);
778       DictScope Group(W, "Segment");
779       W.printString("Cmd", MOSegment.CmdName);
780       W.printString("Name", MOSegment.SegName);
781       W.printNumber("Size", MOSegment.cmdsize);
782       W.printHex("vmaddr", MOSegment.vmaddr);
783       W.printHex("vmsize", MOSegment.vmsize);
784       W.printNumber("fileoff", MOSegment.fileoff);
785       W.printNumber("filesize", MOSegment.filesize);
786       W.printString("maxprot", getMask(MOSegment.maxprot));
787       W.printString("initprot", getMask(MOSegment.initprot));
788       W.printNumber("nsects", MOSegment.nsects);
789       W.printHex("flags", MOSegment.flags);
790     }
791   }
792 }
793 
794 void MachODumper::printMachOIndirectSymbols() {
795   for (const auto &Load : Obj->load_commands()) {
796     if (Load.C.cmd == MachO::LC_DYSYMTAB) {
797       MachO::dysymtab_command DLC = Obj->getDysymtabLoadCommand();
798       DictScope Group(W, "Indirect Symbols");
799       W.printNumber("Number", DLC.nindirectsyms);
800       ListScope D(W, "Symbols");
801       for (unsigned i = 0; i < DLC.nindirectsyms; ++i) {
802         DictScope Group(W, "Entry");
803         W.printNumber("Entry Index", i);
804         W.printHex("Symbol Index", Obj->getIndirectSymbolTableEntry(DLC, i));
805       }
806     }
807   }
808 }
809 
810 void MachODumper::printMachOLinkerOptions() {
811   for (const auto &Load : Obj->load_commands()) {
812     if (Load.C.cmd == MachO::LC_LINKER_OPTION) {
813       MachO::linker_option_command LOLC = Obj->getLinkerOptionLoadCommand(Load);
814       DictScope Group(W, "Linker Options");
815       W.printNumber("Size", LOLC.cmdsize);
816       ListScope D(W, "Strings");
817       uint64_t DataSize = LOLC.cmdsize - sizeof(MachO::linker_option_command);
818       const char *P = Load.Ptr + sizeof(MachO::linker_option_command);
819       StringRef Data(P, DataSize);
820       for (unsigned i = 0; i < LOLC.count; ++i) {
821         std::pair<StringRef,StringRef> Split = Data.split('\0');
822         W.printString("Value", Split.first);
823         Data = Split.second;
824       }
825     }
826   }
827 }
828