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