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