tools/llvm-readobj/MachODumper.cpp

   1 //===-- MachODump.cpp - Object file dumping utility for llvm --------------===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // This file implements the MachO-specific dumper for llvm-readobj.
  10 //
  11 //===----------------------------------------------------------------------===//
  12
  13 #include "Error.h"
  14 #include "ObjDumper.h"
  15 #include "StackMapPrinter.h"
  16 #include "llvm-readobj.h"
  17 #include "llvm/ADT/SmallString.h"
  18 #include "llvm/ADT/StringExtras.h"
  19 #include "llvm/Object/MachO.h"
  20 #include "llvm/Support/Casting.h"
  21 #include "llvm/Support/ScopedPrinter.h"
  22
  23 using namespace llvm;
  24 using namespace object;
  25
  26 namespace {
  27
  28 class MachODumper : public ObjDumper {
  29 public:
  30   MachODumper(const MachOObjectFile *Obj, ScopedPrinter &Writer)
  31       : ObjDumper(Writer), Obj(Obj) {}
  32
  33   void printFileHeaders() override;
  34   void printSectionHeaders() override;
  35   void printRelocations() override;
  36   void printUnwindInfo() override;
  37   void printStackMap() const override;
  38
  39   void printNeededLibraries() override;
  40
  41   // MachO-specific.
  42   void printMachODataInCode() override;
  43   void printMachOVersionMin() override;
  44   void printMachODysymtab() override;
  45   void printMachOSegment() override;
  46   void printMachOIndirectSymbols() override;
  47   void printMachOLinkerOptions () override;
  48
  49 private:
  50   template<class MachHeader>
  51   void printFileHeaders(const MachHeader &Header);
  52
  53   void printSymbols() override;
  54   void printDynamicSymbols() override;
  55   void printSymbol(const SymbolRef &Symbol);
  56
  57   void printRelocation(const RelocationRef &Reloc);
  58
  59   void printRelocation(const MachOObjectFile *Obj, const RelocationRef &Reloc);
  60
  61   void printSectionHeaders(const MachOObjectFile *Obj);
  62
  63   const MachOObjectFile *Obj;
  64 };
  65
  66 } // namespace
  67
  68
  69 namespace llvm {
  70
  71 std::error_code createMachODumper(const object::ObjectFile *Obj,
  72                                   ScopedPrinter &Writer,
  73                                   std::unique_ptr<ObjDumper> &Result) {
  74   const MachOObjectFile *MachOObj = dyn_cast<MachOObjectFile>(Obj);
  75   if (!MachOObj)
  76     return readobj_error::unsupported_obj_file_format;
  77
  78   Result.reset(new MachODumper(MachOObj, Writer));
  79   return readobj_error::success;
  80 }
  81
  82 } // namespace llvm
  83
  84 static const EnumEntry<uint32_t> MachOMagics[] = {
  85   { "Magic",      MachO::MH_MAGIC    },
  86   { "Cigam",      MachO::MH_CIGAM    },
  87   { "Magic64",    MachO::MH_MAGIC_64 },
  88   { "Cigam64",    MachO::MH_CIGAM_64 },
  89   { "FatMagic",   MachO::FAT_MAGIC   },
  90   { "FatCigam",   MachO::FAT_CIGAM   },
  91 };
  92
  93 static const EnumEntry<uint32_t> MachOHeaderFileTypes[] = {
  94   { "Relocatable",          MachO::MH_OBJECT      },
  95   { "Executable",           MachO::MH_EXECUTE     },
  96   { "FixedVMLibrary",       MachO::MH_FVMLIB      },
  97   { "Core",                 MachO::MH_CORE        },
  98   { "PreloadedExecutable",  MachO::MH_PRELOAD     },
  99   { "DynamicLibrary",       MachO::MH_DYLIB       },
 100   { "DynamicLinker",        MachO::MH_DYLINKER    },
 101   { "Bundle",               MachO::MH_BUNDLE      },
 102   { "DynamicLibraryStub",   MachO::MH_DYLIB_STUB  },
 103   { "DWARFSymbol",          MachO::MH_DSYM        },
 104   { "KextBundle",           MachO::MH_KEXT_BUNDLE },
 105 };
 106
 107 static const EnumEntry<uint32_t> MachOHeaderCpuTypes[] = {
 108   { "Any"       , static_cast<uint32_t>(MachO::CPU_TYPE_ANY) },
 109   { "X86"       , MachO::CPU_TYPE_X86       },
 110   { "X86-64"    , MachO::CPU_TYPE_X86_64    },
 111   { "Mc98000"   , MachO::CPU_TYPE_MC98000   },
 112   { "Arm"       , MachO::CPU_TYPE_ARM       },
 113   { "Arm64"     , MachO::CPU_TYPE_ARM64     },
 114   { "Sparc"     , MachO::CPU_TYPE_SPARC     },
 115   { "PowerPC"   , MachO::CPU_TYPE_POWERPC   },
 116   { "PowerPC64" , MachO::CPU_TYPE_POWERPC64 },
 117 };
 118
 119 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesX86[] = {
 120   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_I386_ALL),
 121   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_386),
 122   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_486),
 123   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_486SX),
 124   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_586),
 125   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTPRO),
 126   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTII_M3),
 127   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTII_M5),
 128   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_CELERON),
 129   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_CELERON_MOBILE),
 130   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_3),
 131   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_3_M),
 132   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_3_XEON),
 133   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_M),
 134   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_4),
 135   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_4_M),
 136   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ITANIUM),
 137   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ITANIUM_2),
 138   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_XEON),
 139   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_XEON_MP),
 140 };
 141
 142 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesX64[] = {
 143   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_X86_64_ALL),
 144   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_X86_ARCH1),
 145   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_X86_64_H),
 146 };
 147
 148 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesARM[] = {
 149   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_ALL),
 150   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V4T),
 151   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V6),
 152   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V5),
 153   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V5TEJ),
 154   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_XSCALE),
 155   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7),
 156   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7S),
 157   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7K),
 158   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V6M),
 159   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7M),
 160   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7EM),
 161 };
 162
 163 static const EnumEntry<uint32_t> MachOHeaderCpuSubtypesARM64[] = {
 164   LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64_ALL),
 165 };
 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::printSectionHeaders() { return printSectionHeaders(Obj); }
 431
 432 void MachODumper::printSectionHeaders(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       Expected<StringRef> TargetNameOrErr = Symbol->getName();
 543       if (!TargetNameOrErr)
 544         error(errorToErrorCode(TargetNameOrErr.takeError()));
 545       TargetName = *TargetNameOrErr;
 546     }
 547   } else if (!IsScattered) {
 548     section_iterator SecI = Obj->getRelocationSection(DR);
 549     if (SecI != Obj->section_end()) {
 550       error(SecI->getName(TargetName));
 551     }
 552   }
 553   if (TargetName.empty())
 554     TargetName = "-";
 555
 556   if (opts::ExpandRelocs) {
 557     DictScope Group(W, "Relocation");
 558     W.printHex("Offset", Offset);
 559     W.printNumber("PCRel", Obj->getAnyRelocationPCRel(RE));
 560     W.printNumber("Length", Obj->getAnyRelocationLength(RE));
 561     W.printNumber("Type", RelocName, Obj->getAnyRelocationType(RE));
 562     if (IsScattered) {
 563       W.printHex("Value", Obj->getScatteredRelocationValue(RE));
 564     } else {
 565       const char *Kind = IsExtern ? "Symbol" : "Section";
 566       W.printNumber(Kind, TargetName, Obj->getPlainRelocationSymbolNum(RE));
 567     }
 568   } else {
 569     SmallString<32> SymbolNameOrOffset("0x");
 570     if (IsScattered) {
 571       // Scattered relocations don't really have an associated symbol for some
 572       // reason, even if one exists in the symtab at the correct address.
 573       SymbolNameOrOffset += utohexstr(Obj->getScatteredRelocationValue(RE));
 574     } else {
 575       SymbolNameOrOffset = TargetName;
 576     }
 577
 578     raw_ostream& OS = W.startLine();
 579     OS << W.hex(Offset)
 580        << " " << Obj->getAnyRelocationPCRel(RE)
 581        << " " << Obj->getAnyRelocationLength(RE);
 582     if (IsScattered)
 583       OS << " n/a";
 584     else
 585       OS << " " << Obj->getPlainRelocationExternal(RE);
 586     OS << " " << RelocName
 587        << " " << IsScattered
 588        << " " << SymbolNameOrOffset
 589        << "\n";
 590   }
 591 }
 592
 593 void MachODumper::printSymbols() {
 594   ListScope Group(W, "Symbols");
 595
 596   for (const SymbolRef &Symbol : Obj->symbols()) {
 597     printSymbol(Symbol);
 598   }
 599 }
 600
 601 void MachODumper::printDynamicSymbols() {
 602   ListScope Group(W, "DynamicSymbols");
 603 }
 604
 605 void MachODumper::printSymbol(const SymbolRef &Symbol) {
 606   StringRef SymbolName;
 607   Expected<StringRef> SymbolNameOrErr = Symbol.getName();
 608   if (!SymbolNameOrErr) {
 609     // TODO: Actually report errors helpfully.
 610     consumeError(SymbolNameOrErr.takeError());
 611   } else
 612     SymbolName = *SymbolNameOrErr;
 613
 614   MachOSymbol MOSymbol;
 615   getSymbol(Obj, Symbol.getRawDataRefImpl(), MOSymbol);
 616
 617   StringRef SectionName = "";
 618   Expected<section_iterator> SecIOrErr = Symbol.getSection();
 619   error(errorToErrorCode(SecIOrErr.takeError()));
 620   section_iterator SecI = *SecIOrErr;
 621   if (SecI != Obj->section_end())
 622     error(SecI->getName(SectionName));
 623
 624   DictScope D(W, "Symbol");
 625   W.printNumber("Name", SymbolName, MOSymbol.StringIndex);
 626   if (MOSymbol.Type & MachO::N_STAB) {
 627     W.printHex("Type", "SymDebugTable", MOSymbol.Type);
 628   } else {
 629     if (MOSymbol.Type & MachO::N_PEXT)
 630       W.startLine() << "PrivateExtern\n";
 631     if (MOSymbol.Type & MachO::N_EXT)
 632       W.startLine() << "Extern\n";
 633     W.printEnum("Type", uint8_t(MOSymbol.Type & MachO::N_TYPE),
 634                 makeArrayRef(MachOSymbolTypes));
 635   }
 636   W.printHex("Section", SectionName, MOSymbol.SectionIndex);
 637   W.printEnum("RefType", static_cast<uint16_t>(MOSymbol.Flags & 0xF),
 638               makeArrayRef(MachOSymbolRefTypes));
 639   W.printFlags("Flags", static_cast<uint16_t>(MOSymbol.Flags & ~0xF),
 640                makeArrayRef(MachOSymbolFlags));
 641   W.printHex("Value", MOSymbol.Value);
 642 }
 643
 644 void MachODumper::printUnwindInfo() {
 645   W.startLine() << "UnwindInfo not implemented.\n";
 646 }
 647
 648 void MachODumper::printStackMap() const {
 649   object::SectionRef StackMapSection;
 650   for (auto Sec : Obj->sections()) {
 651     StringRef Name;
 652     Sec.getName(Name);
 653     if (Name == "__llvm_stackmaps") {
 654       StackMapSection = Sec;
 655       break;
 656     }
 657   }
 658
 659   if (StackMapSection == object::SectionRef())
 660     return;
 661
 662   StringRef StackMapContents;
 663   StackMapSection.getContents(StackMapContents);
 664   ArrayRef<uint8_t> StackMapContentsArray(
 665       reinterpret_cast<const uint8_t*>(StackMapContents.data()),
 666       StackMapContents.size());
 667
 668   if (Obj->isLittleEndian())
 669     prettyPrintStackMap(
 670         W, StackMapV2Parser<support::little>(StackMapContentsArray));
 671   else
 672     prettyPrintStackMap(W,
 673                         StackMapV2Parser<support::big>(StackMapContentsArray));
 674 }
 675
 676 void MachODumper::printNeededLibraries() {
 677   ListScope D(W, "NeededLibraries");
 678
 679   using LibsTy = std::vector<StringRef>;
 680   LibsTy Libs;
 681
 682   for (const auto &Command : Obj->load_commands()) {
 683     if (Command.C.cmd == MachO::LC_LOAD_DYLIB ||
 684         Command.C.cmd == MachO::LC_ID_DYLIB ||
 685         Command.C.cmd == MachO::LC_LOAD_WEAK_DYLIB ||
 686         Command.C.cmd == MachO::LC_REEXPORT_DYLIB ||
 687         Command.C.cmd == MachO::LC_LAZY_LOAD_DYLIB ||
 688         Command.C.cmd == MachO::LC_LOAD_UPWARD_DYLIB) {
 689       MachO::dylib_command Dl = Obj->getDylibIDLoadCommand(Command);
 690       if (Dl.dylib.name < Dl.cmdsize) {
 691         auto *P = static_cast<const char*>(Command.Ptr) + Dl.dylib.name;
 692         Libs.push_back(P);
 693       }
 694     }
 695   }
 696
 697   std::stable_sort(Libs.begin(), Libs.end());
 698
 699   for (const auto &L : Libs) {
 700     outs() << "  " << L << "\n";
 701   }
 702 }
 703
 704 void MachODumper::printMachODataInCode() {
 705   for (const auto &Load : Obj->load_commands()) {
 706     if (Load.C.cmd  == MachO::LC_DATA_IN_CODE) {
 707       MachO::linkedit_data_command LLC = Obj->getLinkeditDataLoadCommand(Load);
 708       DictScope Group(W, "DataInCode");
 709       W.printNumber("Data offset", LLC.dataoff);
 710       W.printNumber("Data size", LLC.datasize);
 711       ListScope D(W, "Data entries");
 712       unsigned NumRegions = LLC.datasize / sizeof(MachO::data_in_code_entry);
 713       for (unsigned i = 0; i < NumRegions; ++i) {
 714         MachO::data_in_code_entry DICE = Obj->getDataInCodeTableEntry(
 715                                                               LLC.dataoff, i);
 716         DictScope Group(W, "Entry");
 717         W.printNumber("Index", i);
 718         W.printNumber("Offset", DICE.offset);
 719         W.printNumber("Length", DICE.length);
 720         W.printNumber("Kind", DICE.kind);
 721       }
 722     }
 723   }
 724 }
 725
 726 void MachODumper::printMachOVersionMin() {
 727   for (const auto &Load : Obj->load_commands()) {
 728     StringRef Cmd;
 729     switch (Load.C.cmd) {
 730     case MachO::LC_VERSION_MIN_MACOSX:
 731       Cmd = "LC_VERSION_MIN_MACOSX";
 732       break;
 733     case MachO::LC_VERSION_MIN_IPHONEOS:
 734       Cmd = "LC_VERSION_MIN_IPHONEOS";
 735       break;
 736     case MachO::LC_VERSION_MIN_TVOS:
 737       Cmd = "LC_VERSION_MIN_TVOS";
 738       break;
 739     case MachO::LC_VERSION_MIN_WATCHOS:
 740       Cmd = "LC_VERSION_MIN_WATCHOS";
 741       break;
 742     case MachO::LC_BUILD_VERSION:
 743       Cmd = "LC_BUILD_VERSION";
 744       break;
 745     default:
 746       continue;
 747     }
 748
 749     DictScope Group(W, "MinVersion");
 750     // Handle LC_BUILD_VERSION.
 751     if (Load.C.cmd == MachO::LC_BUILD_VERSION) {
 752       MachO::build_version_command BVC = Obj->getBuildVersionLoadCommand(Load);
 753       W.printString("Cmd", Cmd);
 754       W.printNumber("Size", BVC.cmdsize);
 755       W.printString("Platform",
 756                     MachOObjectFile::getBuildPlatform(BVC.platform));
 757       W.printString("Version", MachOObjectFile::getVersionString(BVC.minos));
 758       if (BVC.sdk)
 759         W.printString("SDK", MachOObjectFile::getVersionString(BVC.sdk));
 760       else
 761         W.printString("SDK", StringRef("n/a"));
 762       continue;
 763     }
 764
 765     MachO::version_min_command VMC = Obj->getVersionMinLoadCommand(Load);
 766     W.printString("Cmd", Cmd);
 767     W.printNumber("Size", VMC.cmdsize);
 768     SmallString<32> Version;
 769     Version = utostr(MachOObjectFile::getVersionMinMajor(VMC, false)) + "." +
 770               utostr(MachOObjectFile::getVersionMinMinor(VMC, false));
 771     uint32_t Update = MachOObjectFile::getVersionMinUpdate(VMC, false);
 772     if (Update != 0)
 773       Version += "." + utostr(MachOObjectFile::getVersionMinUpdate(VMC, false));
 774     W.printString("Version", Version);
 775     SmallString<32> SDK;
 776     if (VMC.sdk == 0)
 777       SDK = "n/a";
 778     else {
 779       SDK = utostr(MachOObjectFile::getVersionMinMajor(VMC, true)) + "." +
 780             utostr(MachOObjectFile::getVersionMinMinor(VMC, true));
 781       uint32_t Update = MachOObjectFile::getVersionMinUpdate(VMC, true);
 782       if (Update != 0)
 783         SDK += "." + utostr(MachOObjectFile::getVersionMinUpdate(VMC, true));
 784     }
 785     W.printString("SDK", SDK);
 786   }
 787 }
 788
 789 void MachODumper::printMachODysymtab() {
 790   for (const auto &Load : Obj->load_commands()) {
 791     if (Load.C.cmd == MachO::LC_DYSYMTAB) {
 792       MachO::dysymtab_command DLC = Obj->getDysymtabLoadCommand();
 793       DictScope Group(W, "Dysymtab");
 794       W.printNumber("ilocalsym", DLC.ilocalsym);
 795       W.printNumber("nlocalsym", DLC.nlocalsym);
 796       W.printNumber("iextdefsym", DLC.iextdefsym);
 797       W.printNumber("nextdefsym", DLC.nextdefsym);
 798       W.printNumber("iundefsym", DLC.iundefsym);
 799       W.printNumber("nundefsym", DLC.nundefsym);
 800       W.printNumber("tocoff", DLC.tocoff);
 801       W.printNumber("ntoc", DLC.ntoc);
 802       W.printNumber("modtaboff", DLC.modtaboff);
 803       W.printNumber("nmodtab", DLC.nmodtab);
 804       W.printNumber("extrefsymoff", DLC.extrefsymoff);
 805       W.printNumber("nextrefsyms", DLC.nextrefsyms);
 806       W.printNumber("indirectsymoff", DLC.indirectsymoff);
 807       W.printNumber("nindirectsyms", DLC.nindirectsyms);
 808       W.printNumber("extreloff", DLC.extreloff);
 809       W.printNumber("nextrel", DLC.nextrel);
 810       W.printNumber("locreloff", DLC.locreloff);
 811       W.printNumber("nlocrel", DLC.nlocrel);
 812     }
 813   }
 814 }
 815
 816 void MachODumper::printMachOSegment() {
 817   for (const auto &Load : Obj->load_commands()) {
 818     if (Load.C.cmd == MachO::LC_SEGMENT || Load.C.cmd == MachO::LC_SEGMENT_64) {
 819       MachOSegment MOSegment;
 820       getSegment(Obj, Load, MOSegment);
 821       DictScope Group(W, "Segment");
 822       W.printString("Cmd", MOSegment.CmdName);
 823       W.printString("Name", MOSegment.SegName);
 824       W.printNumber("Size", MOSegment.cmdsize);
 825       W.printHex("vmaddr", MOSegment.vmaddr);
 826       W.printHex("vmsize", MOSegment.vmsize);
 827       W.printNumber("fileoff", MOSegment.fileoff);
 828       W.printNumber("filesize", MOSegment.filesize);
 829       W.printString("maxprot", getMask(MOSegment.maxprot));
 830       W.printString("initprot", getMask(MOSegment.initprot));
 831       W.printNumber("nsects", MOSegment.nsects);
 832       W.printHex("flags", MOSegment.flags);
 833     }
 834   }
 835 }
 836
 837 void MachODumper::printMachOIndirectSymbols() {
 838   for (const auto &Load : Obj->load_commands()) {
 839     if (Load.C.cmd == MachO::LC_DYSYMTAB) {
 840       MachO::dysymtab_command DLC = Obj->getDysymtabLoadCommand();
 841       DictScope Group(W, "Indirect Symbols");
 842       W.printNumber("Number", DLC.nindirectsyms);
 843       ListScope D(W, "Symbols");
 844       for (unsigned i = 0; i < DLC.nindirectsyms; ++i) {
 845         DictScope Group(W, "Entry");
 846         W.printNumber("Entry Index", i);
 847         W.printHex("Symbol Index", Obj->getIndirectSymbolTableEntry(DLC, i));
 848       }
 849     }
 850   }
 851 }
 852
 853 void MachODumper::printMachOLinkerOptions() {
 854   for (const auto &Load : Obj->load_commands()) {
 855     if (Load.C.cmd == MachO::LC_LINKER_OPTION) {
 856       MachO::linker_option_command LOLC = Obj->getLinkerOptionLoadCommand(Load);
 857       DictScope Group(W, "Linker Options");
 858       W.printNumber("Size", LOLC.cmdsize);
 859       ListScope D(W, "Strings");
 860       uint64_t DataSize = LOLC.cmdsize - sizeof(MachO::linker_option_command);
 861       const char *P = Load.Ptr + sizeof(MachO::linker_option_command);
 862       StringRef Data(P, DataSize);
 863       for (unsigned i = 0; i < LOLC.count; ++i) {
 864         std::pair<StringRef,StringRef> Split = Data.split('\0');
 865         W.printString("Value", Split.first);
 866         Data = Split.second;
 867       }
 868     }
 869   }
 870 }