Google Git
Sign in
llvm/llvm-project/34d5bcddcfd2f3fa3ce074e1be49fe4eae920f82/./llvm/tools/llvm-readobj/MachODumper.cpp
blob: a288fbc85058fd3df26a703f995e71155233d182 [file]
//===- MachODumper.cpp - Object file dumping utility for llvm -------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file implements the MachO-specific dumper for llvm-readobj.
//
//===----------------------------------------------------------------------===//
#include "ObjDumper.h"
#include "StackMapPrinter.h"
#include "llvm-readobj.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/Object/MachO.h"
#include "llvm/Support/BinaryStreamReader.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/ScopedPrinter.h"
using namespace llvm;
using namespace object;
namespace {
class MachODumper : public ObjDumper {
public:
MachODumper(const MachOObjectFile *Obj, ScopedPrinter &Writer)
: ObjDumper(Writer, Obj->getFileName()), Obj(Obj) {}
void printFileHeaders() override;
void printSectionHeaders() override;
void printRelocations() override;
void printUnwindInfo() override;
void printStackMap() const override;
void printCGProfile() override;
void printNeededLibraries() override;
bool canCompareSymbols() const override { return true; }
bool compareSymbolsByName(object::SymbolRef LHS,
object::SymbolRef RHS) const override;
bool compareSymbolsByType(object::SymbolRef LHS,
object::SymbolRef RHS) const override;
// MachO-specific.
void printMachODataInCode() override;
void printMachOVersionMin() override;
void printMachOTargetTriple() override;
void printMachODysymtab() override;
void printMachOSegment() override;
void printMachOIndirectSymbols() override;
void printMachOLinkerOptions () override;
private:
template<class MachHeader>
void printFileHeaders(const MachHeader &Header);
StringRef getSymbolName(const SymbolRef &Symbol) const;
uint8_t getSymbolType(const SymbolRef &Symbol) const;
void printSymbols(bool ExtraSymInfo) override;
void printSymbols(std::optional<SymbolComparator> SymComp) override;
void printDynamicSymbols() override;
void printDynamicSymbols(std::optional<SymbolComparator> SymComp) override;
void printSymbol(const SymbolRef &Symbol, ScopedPrinter &W);
void printSymbol(const SymbolRef &Symbol);
void printRelocation(const RelocationRef &Reloc);
void printRelocation(const MachOObjectFile *Obj, const RelocationRef &Reloc);
void printSectionHeaders(const MachOObjectFile *Obj);
const MachOObjectFile *Obj;
};
} // namespace
namespace llvm {
std::unique_ptr<ObjDumper> createMachODumper(const object::MachOObjectFile &Obj,
ScopedPrinter &Writer) {
return std::make_unique<MachODumper>(&Obj, Writer);
}
} // namespace llvm
constexpr EnumStringDef<uint32_t> MachOMagicsDefs[] = {
{{"Magic"}, MachO::MH_MAGIC}, {{"Cigam"}, MachO::MH_CIGAM},
{{"Magic64"}, MachO::MH_MAGIC_64}, {{"Cigam64"}, MachO::MH_CIGAM_64},
{{"FatMagic"}, MachO::FAT_MAGIC}, {{"FatCigam"}, MachO::FAT_CIGAM},
};
constexpr auto MachOMagics = BUILD_ENUM_STRINGS(MachOMagicsDefs);
constexpr EnumStringDef<uint32_t> MachOHeaderFileTypesDefs[] = {
{{"Relocatable"}, MachO::MH_OBJECT},
{{"Executable"}, MachO::MH_EXECUTE},
{{"FixedVMLibrary"}, MachO::MH_FVMLIB},
{{"Core"}, MachO::MH_CORE},
{{"PreloadedExecutable"}, MachO::MH_PRELOAD},
{{"DynamicLibrary"}, MachO::MH_DYLIB},
{{"DynamicLinker"}, MachO::MH_DYLINKER},
{{"Bundle"}, MachO::MH_BUNDLE},
{{"DynamicLibraryStub"}, MachO::MH_DYLIB_STUB},
{{"DWARFSymbol"}, MachO::MH_DSYM},
{{"KextBundle"}, MachO::MH_KEXT_BUNDLE},
};
constexpr auto MachOHeaderFileTypes =
BUILD_ENUM_STRINGS(MachOHeaderFileTypesDefs);
// clang-format off
constexpr EnumStringDef<uint32_t> MachOHeaderCpuTypesDefs[] = {
{ {"Any"} , static_cast<uint32_t>(MachO::CPU_TYPE_ANY) },
{ {"X86"} , MachO::CPU_TYPE_X86 },
{ {"X86-64"} , MachO::CPU_TYPE_X86_64 },
{ {"Mc98000"} , MachO::CPU_TYPE_MC98000 },
{ {"Arm"} , MachO::CPU_TYPE_ARM },
{ {"Arm64"} , MachO::CPU_TYPE_ARM64 },
{ {"Arm64 (ILP32)"}, MachO::CPU_TYPE_ARM64_32 },
{ {"Sparc"} , MachO::CPU_TYPE_SPARC },
{ {"PowerPC"} , MachO::CPU_TYPE_POWERPC },
{ {"PowerPC64"} , MachO::CPU_TYPE_POWERPC64 },
};
constexpr auto MachOHeaderCpuTypes = BUILD_ENUM_STRINGS(MachOHeaderCpuTypesDefs);
// clang-format on
constexpr EnumStringDef<uint32_t> MachOHeaderCpuSubtypesX86Defs[] = {
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_I386_ALL),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_386),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_486),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_486SX),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_586),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTPRO),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTII_M3),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTII_M5),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_CELERON),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_CELERON_MOBILE),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_3),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_3_M),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_3_XEON),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_M),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_4),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_PENTIUM_4_M),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ITANIUM),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ITANIUM_2),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_XEON),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_XEON_MP),
};
constexpr auto MachOHeaderCpuSubtypesX86 =
BUILD_ENUM_STRINGS(MachOHeaderCpuSubtypesX86Defs);
constexpr EnumStringDef<uint32_t> MachOHeaderCpuSubtypesX64Defs[] = {
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_X86_64_ALL),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_X86_ARCH1),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_X86_64_H),
};
constexpr auto MachOHeaderCpuSubtypesX64 =
BUILD_ENUM_STRINGS(MachOHeaderCpuSubtypesX64Defs);
constexpr EnumStringDef<uint32_t> MachOHeaderCpuSubtypesARMDefs[] = {
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_ALL),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V4T),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V6),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V5),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V5TEJ),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_XSCALE),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7S),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7K),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V6M),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7M),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V7EM),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V8M_MAIN),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V8M_BASE),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM_V8_1M_MAIN),
};
constexpr auto MachOHeaderCpuSubtypesARM =
BUILD_ENUM_STRINGS(MachOHeaderCpuSubtypesARMDefs);
constexpr EnumStringDef<uint32_t> MachOHeaderCpuSubtypesARM64_32Defs[] = {
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64_32_V8),
};
constexpr auto MachOHeaderCpuSubtypesARM64_32 =
BUILD_ENUM_STRINGS(MachOHeaderCpuSubtypesARM64_32Defs);
constexpr EnumStringDef<uint32_t> MachOHeaderCpuSubtypesARM64Defs[] = {
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64_ALL),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64_V8),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_ARM64E),
};
constexpr auto MachOHeaderCpuSubtypesARM64 =
BUILD_ENUM_STRINGS(MachOHeaderCpuSubtypesARM64Defs);
constexpr EnumStringDef<uint32_t> MachOHeaderCpuSubtypesSPARCDefs[] = {
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_SPARC_ALL),
};
constexpr auto MachOHeaderCpuSubtypesSPARC =
BUILD_ENUM_STRINGS(MachOHeaderCpuSubtypesSPARCDefs);
constexpr EnumStringDef<uint32_t> MachOHeaderCpuSubtypesPPCDefs[] = {
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_ALL),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_601),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_602),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_603),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_603e),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_603ev),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_604),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_604e),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_620),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_750),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_7400),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_7450),
LLVM_READOBJ_ENUM_ENT(MachO, CPU_SUBTYPE_POWERPC_970),
};
constexpr auto MachOHeaderCpuSubtypesPPC =
BUILD_ENUM_STRINGS(MachOHeaderCpuSubtypesPPCDefs);
constexpr EnumStringDef<uint32_t> MachOHeaderFlagsDefs[] = {
LLVM_READOBJ_ENUM_ENT(MachO, MH_NOUNDEFS),
LLVM_READOBJ_ENUM_ENT(MachO, MH_INCRLINK),
LLVM_READOBJ_ENUM_ENT(MachO, MH_DYLDLINK),
LLVM_READOBJ_ENUM_ENT(MachO, MH_BINDATLOAD),
LLVM_READOBJ_ENUM_ENT(MachO, MH_PREBOUND),
LLVM_READOBJ_ENUM_ENT(MachO, MH_SPLIT_SEGS),
LLVM_READOBJ_ENUM_ENT(MachO, MH_LAZY_INIT),
LLVM_READOBJ_ENUM_ENT(MachO, MH_TWOLEVEL),
LLVM_READOBJ_ENUM_ENT(MachO, MH_FORCE_FLAT),
LLVM_READOBJ_ENUM_ENT(MachO, MH_NOMULTIDEFS),
LLVM_READOBJ_ENUM_ENT(MachO, MH_NOFIXPREBINDING),
LLVM_READOBJ_ENUM_ENT(MachO, MH_PREBINDABLE),
LLVM_READOBJ_ENUM_ENT(MachO, MH_ALLMODSBOUND),
LLVM_READOBJ_ENUM_ENT(MachO, MH_SUBSECTIONS_VIA_SYMBOLS),
LLVM_READOBJ_ENUM_ENT(MachO, MH_CANONICAL),
LLVM_READOBJ_ENUM_ENT(MachO, MH_WEAK_DEFINES),
LLVM_READOBJ_ENUM_ENT(MachO, MH_BINDS_TO_WEAK),
LLVM_READOBJ_ENUM_ENT(MachO, MH_ALLOW_STACK_EXECUTION),
LLVM_READOBJ_ENUM_ENT(MachO, MH_ROOT_SAFE),
LLVM_READOBJ_ENUM_ENT(MachO, MH_SETUID_SAFE),
LLVM_READOBJ_ENUM_ENT(MachO, MH_NO_REEXPORTED_DYLIBS),
LLVM_READOBJ_ENUM_ENT(MachO, MH_PIE),
LLVM_READOBJ_ENUM_ENT(MachO, MH_DEAD_STRIPPABLE_DYLIB),
LLVM_READOBJ_ENUM_ENT(MachO, MH_HAS_TLV_DESCRIPTORS),
LLVM_READOBJ_ENUM_ENT(MachO, MH_NO_HEAP_EXECUTION),
LLVM_READOBJ_ENUM_ENT(MachO, MH_APP_EXTENSION_SAFE),
};
constexpr auto MachOHeaderFlags = BUILD_ENUM_STRINGS(MachOHeaderFlagsDefs);
constexpr EnumStringDef<unsigned> MachOSectionTypesDefs[] = {
{{"Regular"}, MachO::S_REGULAR},
{{"ZeroFill"}, MachO::S_ZEROFILL},
{{"CStringLiterals"}, MachO::S_CSTRING_LITERALS},
{{"4ByteLiterals"}, MachO::S_4BYTE_LITERALS},
{{"8ByteLiterals"}, MachO::S_8BYTE_LITERALS},
{{"LiteralPointers"}, MachO::S_LITERAL_POINTERS},
{{"NonLazySymbolPointers"}, MachO::S_NON_LAZY_SYMBOL_POINTERS},
{{"LazySymbolPointers"}, MachO::S_LAZY_SYMBOL_POINTERS},
{{"SymbolStubs"}, MachO::S_SYMBOL_STUBS},
{{"ModInitFuncPointers"}, MachO::S_MOD_INIT_FUNC_POINTERS},
{{"ModTermFuncPointers"}, MachO::S_MOD_TERM_FUNC_POINTERS},
{{"Coalesced"}, MachO::S_COALESCED},
{{"GBZeroFill"}, MachO::S_GB_ZEROFILL},
{{"Interposing"}, MachO::S_INTERPOSING},
{{"16ByteLiterals"}, MachO::S_16BYTE_LITERALS},
{{"DTraceDOF"}, MachO::S_DTRACE_DOF},
{{"LazyDylibSymbolPointers"}, MachO::S_LAZY_DYLIB_SYMBOL_POINTERS},
{{"ThreadLocalRegular"}, MachO::S_THREAD_LOCAL_REGULAR},
{{"ThreadLocalZerofill"}, MachO::S_THREAD_LOCAL_ZEROFILL},
{{"ThreadLocalVariables"}, MachO::S_THREAD_LOCAL_VARIABLES},
{{"ThreadLocalVariablePointers"}, MachO::S_THREAD_LOCAL_VARIABLE_POINTERS},
{{"ThreadLocalInitFunctionPointers"},
MachO::S_THREAD_LOCAL_INIT_FUNCTION_POINTERS}};
constexpr auto MachOSectionTypes = BUILD_ENUM_STRINGS(MachOSectionTypesDefs);
constexpr EnumStringDef<unsigned> MachOSectionAttributesDefs[] = {
{{"LocReloc"}, 1 << 0 /*S_ATTR_LOC_RELOC*/},
{{"ExtReloc"}, 1 << 1 /*S_ATTR_EXT_RELOC*/},
{{"SomeInstructions"}, 1 << 2 /*S_ATTR_SOME_INSTRUCTIONS*/},
{{"Debug"}, 1 << 17 /*S_ATTR_DEBUG*/},
{{"SelfModifyingCode"}, 1 << 18 /*S_ATTR_SELF_MODIFYING_CODE*/},
{{"LiveSupport"}, 1 << 19 /*S_ATTR_LIVE_SUPPORT*/},
{{"NoDeadStrip"}, 1 << 20 /*S_ATTR_NO_DEAD_STRIP*/},
{{"StripStaticSyms"}, 1 << 21 /*S_ATTR_STRIP_STATIC_SYMS*/},
{{"NoTOC"}, 1 << 22 /*S_ATTR_NO_TOC*/},
{{"PureInstructions"}, 1 << 23 /*S_ATTR_PURE_INSTRUCTIONS*/},
};
constexpr auto MachOSectionAttributes =
BUILD_ENUM_STRINGS(MachOSectionAttributesDefs);
constexpr EnumStringDef<unsigned> MachOSymbolRefTypesDefs[] = {
{{"UndefinedNonLazy"}, 0},
{{"ReferenceFlagUndefinedLazy"}, 1},
{{"ReferenceFlagDefined"}, 2},
{{"ReferenceFlagPrivateDefined"}, 3},
{{"ReferenceFlagPrivateUndefinedNonLazy"}, 4},
{{"ReferenceFlagPrivateUndefinedLazy"}, 5}};
constexpr auto MachOSymbolRefTypes =
BUILD_ENUM_STRINGS(MachOSymbolRefTypesDefs);
constexpr EnumStringDef<unsigned> MachOSymbolFlagsDefs[] = {
{{"ThumbDef"}, 0x8}, {{"ReferencedDynamically"}, 0x10},
{{"NoDeadStrip"}, 0x20}, {{"WeakRef"}, 0x40},
{{"WeakDef"}, 0x80}, {{"SymbolResolver"}, 0x100},
{{"AltEntry"}, 0x200}, {{"ColdFunc"}, 0x400},
};
constexpr auto MachOSymbolFlags = BUILD_ENUM_STRINGS(MachOSymbolFlagsDefs);
constexpr EnumStringDef<unsigned> MachOSymbolTypesDefs[] = {
{{"Undef"}, 0x0},
{{"Abs"}, 0x2},
{{"Indirect"}, 0xA},
{{"PreboundUndef"}, 0xC},
{{"Section"}, 0xE}};
constexpr auto MachOSymbolTypes = BUILD_ENUM_STRINGS(MachOSymbolTypesDefs);
namespace {
struct MachOSection {
ArrayRef<char> Name;
ArrayRef<char> SegmentName;
uint64_t Address;
uint64_t Size;
uint32_t Offset;
uint32_t Alignment;
uint32_t RelocationTableOffset;
uint32_t NumRelocationTableEntries;
uint32_t Flags;
uint32_t Reserved1;
uint32_t Reserved2;
uint32_t Reserved3;
};
struct MachOSegment {
std::string CmdName;
std::string SegName;
uint64_t cmdsize;
uint64_t vmaddr;
uint64_t vmsize;
uint64_t fileoff;
uint64_t filesize;
uint32_t maxprot;
uint32_t initprot;
uint32_t nsects;
uint32_t flags;
};
struct MachOSymbol {
uint32_t StringIndex;
uint8_t Type;
uint8_t SectionIndex;
uint16_t Flags;
uint64_t Value;
};
}
static std::string getMask(uint32_t prot)
{
// TODO (davide): This always assumes prot is valid.
// Catch mistakes and report if needed.
std::string Prot;
Prot = "";
Prot += (prot & MachO::VM_PROT_READ) ? "r" : "-";
Prot += (prot & MachO::VM_PROT_WRITE) ? "w" : "-";
Prot += (prot & MachO::VM_PROT_EXECUTE) ? "x" : "-";
return Prot;
}
static void getSection(const MachOObjectFile *Obj,
DataRefImpl Sec,
MachOSection &Section) {
if (!Obj->is64Bit()) {
MachO::section Sect = Obj->getSection(Sec);
Section.Address = Sect.addr;
Section.Size = Sect.size;
Section.Offset = Sect.offset;
Section.Alignment = Sect.align;
Section.RelocationTableOffset = Sect.reloff;
Section.NumRelocationTableEntries = Sect.nreloc;
Section.Flags = Sect.flags;
Section.Reserved1 = Sect.reserved1;
Section.Reserved2 = Sect.reserved2;
return;
}
MachO::section_64 Sect = Obj->getSection64(Sec);
Section.Address = Sect.addr;
Section.Size = Sect.size;
Section.Offset = Sect.offset;
Section.Alignment = Sect.align;
Section.RelocationTableOffset = Sect.reloff;
Section.NumRelocationTableEntries = Sect.nreloc;
Section.Flags = Sect.flags;
Section.Reserved1 = Sect.reserved1;
Section.Reserved2 = Sect.reserved2;
Section.Reserved3 = Sect.reserved3;
}
static void getSegment(const MachOObjectFile *Obj,
const MachOObjectFile::LoadCommandInfo &L,
MachOSegment &Segment) {
if (!Obj->is64Bit()) {
MachO::segment_command SC = Obj->getSegmentLoadCommand(L);
Segment.CmdName = "LC_SEGMENT";
Segment.SegName = SC.segname;
Segment.cmdsize = SC.cmdsize;
Segment.vmaddr = SC.vmaddr;
Segment.vmsize = SC.vmsize;
Segment.fileoff = SC.fileoff;
Segment.filesize = SC.filesize;
Segment.maxprot = SC.maxprot;
Segment.initprot = SC.initprot;
Segment.nsects = SC.nsects;
Segment.flags = SC.flags;
return;
}
MachO::segment_command_64 SC = Obj->getSegment64LoadCommand(L);
Segment.CmdName = "LC_SEGMENT_64";
Segment.SegName = SC.segname;
Segment.cmdsize = SC.cmdsize;
Segment.vmaddr = SC.vmaddr;
Segment.vmsize = SC.vmsize;
Segment.fileoff = SC.fileoff;
Segment.filesize = SC.filesize;
Segment.maxprot = SC.maxprot;
Segment.initprot = SC.initprot;
Segment.nsects = SC.nsects;
Segment.flags = SC.flags;
}
static void getSymbol(const MachOObjectFile *Obj,
DataRefImpl DRI,
MachOSymbol &Symbol) {
if (!Obj->is64Bit()) {
MachO::nlist Entry = Obj->getSymbolTableEntry(DRI);
Symbol.StringIndex = Entry.n_strx;
Symbol.Type = Entry.n_type;
Symbol.SectionIndex = Entry.n_sect;
Symbol.Flags = Entry.n_desc;
Symbol.Value = Entry.n_value;
return;
}
MachO::nlist_64 Entry = Obj->getSymbol64TableEntry(DRI);
Symbol.StringIndex = Entry.n_strx;
Symbol.Type = Entry.n_type;
Symbol.SectionIndex = Entry.n_sect;
Symbol.Flags = Entry.n_desc;
Symbol.Value = Entry.n_value;
}
void MachODumper::printFileHeaders() {
DictScope H(W, "MachHeader");
if (!Obj->is64Bit()) {
printFileHeaders(Obj->getHeader());
} else {
printFileHeaders(Obj->getHeader64());
W.printHex("Reserved", Obj->getHeader64().reserved);
}
}
template<class MachHeader>
void MachODumper::printFileHeaders(const MachHeader &Header) {
W.printEnum("Magic", Header.magic, EnumStrings(MachOMagics));
W.printEnum("CpuType", Header.cputype, EnumStrings(MachOHeaderCpuTypes));
uint32_t subtype = Header.cpusubtype & ~MachO::CPU_SUBTYPE_MASK;
switch (Header.cputype) {
case MachO::CPU_TYPE_X86:
W.printEnum("CpuSubType", subtype, EnumStrings(MachOHeaderCpuSubtypesX86));
break;
case MachO::CPU_TYPE_X86_64:
W.printEnum("CpuSubType", subtype, EnumStrings(MachOHeaderCpuSubtypesX64));
break;
case MachO::CPU_TYPE_ARM:
W.printEnum("CpuSubType", subtype, EnumStrings(MachOHeaderCpuSubtypesARM));
break;
case MachO::CPU_TYPE_POWERPC:
W.printEnum("CpuSubType", subtype, EnumStrings(MachOHeaderCpuSubtypesPPC));
break;
case MachO::CPU_TYPE_SPARC:
W.printEnum("CpuSubType", subtype,
EnumStrings(MachOHeaderCpuSubtypesSPARC));
break;
case MachO::CPU_TYPE_ARM64:
W.printEnum("CpuSubType", subtype,
EnumStrings(MachOHeaderCpuSubtypesARM64));
break;
case MachO::CPU_TYPE_ARM64_32:
W.printEnum("CpuSubType", subtype,
EnumStrings(MachOHeaderCpuSubtypesARM64_32));
break;
case MachO::CPU_TYPE_POWERPC64:
default:
W.printHex("CpuSubType", subtype);
}
W.printEnum("FileType", Header.filetype, EnumStrings(MachOHeaderFileTypes));
W.printNumber("NumOfLoadCommands", Header.ncmds);
W.printNumber("SizeOfLoadCommands", Header.sizeofcmds);
W.printFlags("Flags", Header.flags, EnumStrings(MachOHeaderFlags));
}
void MachODumper::printSectionHeaders() { return printSectionHeaders(Obj); }
void MachODumper::printSectionHeaders(const MachOObjectFile *Obj) {
ListScope Group(W, "Sections");
int SectionIndex = -1;
for (const SectionRef &Section : Obj->sections()) {
++SectionIndex;
MachOSection MOSection;
getSection(Obj, Section.getRawDataRefImpl(), MOSection);
DataRefImpl DR = Section.getRawDataRefImpl();
StringRef Name = unwrapOrError(Obj->getFileName(), Section.getName());
ArrayRef<char> RawName = Obj->getSectionRawName(DR);
StringRef SegmentName = Obj->getSectionFinalSegmentName(DR);
ArrayRef<char> RawSegmentName = Obj->getSectionRawFinalSegmentName(DR);
DictScope SectionD(W, "Section");
W.printNumber("Index", SectionIndex);
W.printBinary("Name", Name, RawName);
W.printBinary("Segment", SegmentName, RawSegmentName);
W.printHex("Address", MOSection.Address);
W.printHex("Size", MOSection.Size);
W.printNumber("Offset", MOSection.Offset);
W.printNumber("Alignment", MOSection.Alignment);
W.printHex("RelocationOffset", MOSection.RelocationTableOffset);
W.printNumber("RelocationCount", MOSection.NumRelocationTableEntries);
W.printEnum("Type", MOSection.Flags & 0xFF, EnumStrings(MachOSectionTypes));
W.printFlags("Attributes", MOSection.Flags >> 8,
EnumStrings(MachOSectionAttributes));
W.printHex("Reserved1", MOSection.Reserved1);
W.printHex("Reserved2", MOSection.Reserved2);
if (Obj->is64Bit())
W.printHex("Reserved3", MOSection.Reserved3);
if (opts::SectionRelocations) {
ListScope D(W, "Relocations");
for (const RelocationRef &Reloc : Section.relocations())
printRelocation(Reloc);
}
if (opts::SectionSymbols) {
ListScope D(W, "Symbols");
for (const SymbolRef &Symbol : Obj->symbols()) {
if (!Section.containsSymbol(Symbol))
continue;
printSymbol(Symbol);
}
}
if (opts::SectionData && !Section.isBSS())
W.printBinaryBlock("SectionData", unwrapOrError(Obj->getFileName(),
Section.getContents()));
}
}
void MachODumper::printRelocations() {
ListScope D(W, "Relocations");
std::error_code EC;
for (const SectionRef &Section : Obj->sections()) {
StringRef Name = unwrapOrError(Obj->getFileName(), Section.getName());
bool PrintedGroup = false;
for (const RelocationRef &Reloc : Section.relocations()) {
if (!PrintedGroup) {
W.startLine() << "Section " << Name << " {\n";
W.indent();
PrintedGroup = true;
}
printRelocation(Reloc);
}
if (PrintedGroup) {
W.unindent();
W.startLine() << "}\n";
}
}
}
void MachODumper::printRelocation(const RelocationRef &Reloc) {
return printRelocation(Obj, Reloc);
}
void MachODumper::printRelocation(const MachOObjectFile *Obj,
const RelocationRef &Reloc) {
uint64_t Offset = Reloc.getOffset();
SmallString<32> RelocName;
Reloc.getTypeName(RelocName);
DataRefImpl DR = Reloc.getRawDataRefImpl();
MachO::any_relocation_info RE = Obj->getRelocation(DR);
bool IsScattered = Obj->isRelocationScattered(RE);
bool IsExtern = !IsScattered && Obj->getPlainRelocationExternal(RE);
StringRef TargetName;
if (IsExtern) {
symbol_iterator Symbol = Reloc.getSymbol();
if (Symbol != Obj->symbol_end()) {
TargetName = getSymbolName(*Symbol);
}
} else if (!IsScattered) {
section_iterator SecI = Obj->getRelocationSection(DR);
if (SecI != Obj->section_end())
TargetName = unwrapOrError(Obj->getFileName(), SecI->getName());
}
if (TargetName.empty())
TargetName = "-";
if (opts::ExpandRelocs) {
DictScope Group(W, "Relocation");
W.printHex("Offset", Offset);
W.printNumber("PCRel", Obj->getAnyRelocationPCRel(RE));
W.printNumber("Length", Obj->getAnyRelocationLength(RE));
W.printNumber("Type", RelocName, Obj->getAnyRelocationType(RE));
if (IsScattered) {
W.printHex("Value", Obj->getScatteredRelocationValue(RE));
} else {
const char *Kind = IsExtern ? "Symbol" : "Section";
W.printNumber(Kind, TargetName, Obj->getPlainRelocationSymbolNum(RE));
}
} else {
SmallString<32> SymbolNameOrOffset("0x");
if (IsScattered) {
// Scattered relocations don't really have an associated symbol for some
// reason, even if one exists in the symtab at the correct address.
SymbolNameOrOffset += utohexstr(Obj->getScatteredRelocationValue(RE));
} else {
SymbolNameOrOffset = TargetName;
}
raw_ostream& OS = W.startLine();
OS << W.hex(Offset)
<< " " << Obj->getAnyRelocationPCRel(RE)
<< " " << Obj->getAnyRelocationLength(RE);
if (IsScattered)
OS << " n/a";
else
OS << " " << Obj->getPlainRelocationExternal(RE);
OS << " " << RelocName
<< " " << IsScattered
<< " " << SymbolNameOrOffset
<< "\n";
}
}
StringRef MachODumper::getSymbolName(const SymbolRef &Symbol) const {
Expected<StringRef> SymbolNameOrErr = Symbol.getName();
if (!SymbolNameOrErr) {
reportError(SymbolNameOrErr.takeError(), Obj->getFileName());
}
return *SymbolNameOrErr;
}
uint8_t MachODumper::getSymbolType(const SymbolRef &Symbol) const {
return Obj->is64Bit()
? Obj->getSymbol64TableEntry(Symbol.getRawDataRefImpl()).n_type
: Obj->getSymbolTableEntry(Symbol.getRawDataRefImpl()).n_type;
}
bool MachODumper::compareSymbolsByName(SymbolRef LHS, SymbolRef RHS) const {
return getSymbolName(LHS).str().compare(getSymbolName(RHS).str()) < 0;
}
bool MachODumper::compareSymbolsByType(SymbolRef LHS, SymbolRef RHS) const {
return getSymbolType(LHS) < getSymbolType(RHS);
}
void MachODumper::printSymbols(bool /*ExtraSymInfo*/) {
printSymbols(std::nullopt);
}
void MachODumper::printSymbols(std::optional<SymbolComparator> SymComp) {
ListScope Group(W, "Symbols");
if (SymComp) {
auto SymbolRange = Obj->symbols();
std::vector<SymbolRef> SortedSymbols(SymbolRange.begin(),
SymbolRange.end());
llvm::stable_sort(SortedSymbols, *SymComp);
for (SymbolRef Symbol : SortedSymbols)
printSymbol(Symbol);
} else {
for (const SymbolRef &Symbol : Obj->symbols()) {
printSymbol(Symbol);
}
}
}
void MachODumper::printDynamicSymbols() {
ListScope Group(W, "DynamicSymbols");
}
void MachODumper::printDynamicSymbols(std::optional<SymbolComparator> SymComp) {
ListScope Group(W, "DynamicSymbols");
}
void MachODumper::printSymbol(const SymbolRef &Symbol) {
printSymbol(Symbol, W);
}
void MachODumper::printSymbol(const SymbolRef &Symbol, ScopedPrinter &W) {
StringRef SymbolName = getSymbolName(Symbol);
MachOSymbol MOSymbol;
getSymbol(Obj, Symbol.getRawDataRefImpl(), MOSymbol);
StringRef SectionName = "";
// Don't ask a Mach-O STABS symbol for its section unless we know that
// STAB symbol's section field refers to a valid section index. Otherwise
// the symbol may error trying to load a section that does not exist.
// TODO: Add a whitelist of STABS symbol types that contain valid section
// indices.
if (!(MOSymbol.Type & MachO::N_STAB)) {
Expected<section_iterator> SecIOrErr = Symbol.getSection();
if (!SecIOrErr)
reportError(SecIOrErr.takeError(), Obj->getFileName());
section_iterator SecI = *SecIOrErr;
if (SecI != Obj->section_end())
SectionName = unwrapOrError(Obj->getFileName(), SecI->getName());
}
DictScope D(W, "Symbol");
W.printNumber("Name", SymbolName, MOSymbol.StringIndex);
if (MOSymbol.Type & MachO::N_STAB) {
W.printHex("Type", "SymDebugTable", MOSymbol.Type);
} else {
if (MOSymbol.Type & MachO::N_PEXT)
W.startLine() << "PrivateExtern\n";
if (MOSymbol.Type & MachO::N_EXT)
W.startLine() << "Extern\n";
W.printEnum("Type", uint8_t(MOSymbol.Type & MachO::N_TYPE),
EnumStrings(MachOSymbolTypes));
}
W.printHex("Section", SectionName, MOSymbol.SectionIndex);
W.printEnum("RefType", static_cast<uint16_t>(MOSymbol.Flags & 0x7),
EnumStrings(MachOSymbolRefTypes));
W.printFlags("Flags", static_cast<uint16_t>(MOSymbol.Flags & ~0x7),
EnumStrings(MachOSymbolFlags));
W.printHex("Value", MOSymbol.Value);
}
void MachODumper::printUnwindInfo() {
W.startLine() << "UnwindInfo not implemented.\n";
}
void MachODumper::printStackMap() const {
object::SectionRef StackMapSection;
for (auto Sec : Obj->sections()) {
StringRef Name;
if (Expected<StringRef> NameOrErr = Sec.getName())
Name = *NameOrErr;
else
consumeError(NameOrErr.takeError());
if (Name == "__llvm_stackmaps") {
StackMapSection = Sec;
break;
}
}
if (StackMapSection == object::SectionRef())
return;
StringRef StackMapContents =
unwrapOrError(Obj->getFileName(), StackMapSection.getContents());
ArrayRef<uint8_t> StackMapContentsArray =
arrayRefFromStringRef(StackMapContents);
if (Obj->isLittleEndian())
prettyPrintStackMap(
W, StackMapParser<llvm::endianness::little>(StackMapContentsArray));
else
prettyPrintStackMap(
W, StackMapParser<llvm::endianness::big>(StackMapContentsArray));
}
void MachODumper::printCGProfile() {
object::SectionRef CGProfileSection;
for (auto Sec : Obj->sections()) {
StringRef Name;
if (Expected<StringRef> NameOrErr = Sec.getName())
Name = *NameOrErr;
else
consumeError(NameOrErr.takeError());
if (Name == "__cg_profile") {
CGProfileSection = Sec;
break;
}
}
if (CGProfileSection == object::SectionRef())
return;
StringRef CGProfileContents =
unwrapOrError(Obj->getFileName(), CGProfileSection.getContents());
BinaryStreamReader Reader(CGProfileContents, Obj->isLittleEndian()
? llvm::endianness::little
: llvm::endianness::big);
ListScope L(W, "CGProfile");
while (!Reader.empty()) {
uint32_t FromIndex, ToIndex;
uint64_t Count;
if (Error Err = Reader.readInteger(FromIndex))
reportError(std::move(Err), Obj->getFileName());
if (Error Err = Reader.readInteger(ToIndex))
reportError(std::move(Err), Obj->getFileName());
if (Error Err = Reader.readInteger(Count))
reportError(std::move(Err), Obj->getFileName());
DictScope D(W, "CGProfileEntry");
W.printNumber("From", getSymbolName(*Obj->getSymbolByIndex(FromIndex)),
FromIndex);
W.printNumber("To", getSymbolName(*Obj->getSymbolByIndex(ToIndex)),
ToIndex);
W.printNumber("Weight", Count);
}
}
void MachODumper::printNeededLibraries() {
ListScope D(W, "NeededLibraries");
using LibsTy = std::vector<StringRef>;
LibsTy Libs;
for (const auto &Command : Obj->load_commands()) {
if (Command.C.cmd == MachO::LC_LOAD_DYLIB ||
Command.C.cmd == MachO::LC_ID_DYLIB ||
Command.C.cmd == MachO::LC_LOAD_WEAK_DYLIB ||
Command.C.cmd == MachO::LC_REEXPORT_DYLIB ||
Command.C.cmd == MachO::LC_LAZY_LOAD_DYLIB ||
Command.C.cmd == MachO::LC_LOAD_UPWARD_DYLIB) {
MachO::dylib_command Dl = Obj->getDylibIDLoadCommand(Command);
if (Dl.dylib.name < Dl.cmdsize) {
auto *P = static_cast<const char*>(Command.Ptr) + Dl.dylib.name;
Libs.push_back(P);
}
}
}
llvm::stable_sort(Libs);
for (const auto &L : Libs) {
W.startLine() << L << "\n";
}
}
void MachODumper::printMachODataInCode() {
for (const auto &Load : Obj->load_commands()) {
if (Load.C.cmd == MachO::LC_DATA_IN_CODE) {
MachO::linkedit_data_command LLC = Obj->getLinkeditDataLoadCommand(Load);
DictScope Group(W, "DataInCode");
W.printNumber("Data offset", LLC.dataoff);
W.printNumber("Data size", LLC.datasize);
ListScope D(W, "Data entries");
unsigned NumRegions = LLC.datasize / sizeof(MachO::data_in_code_entry);
for (unsigned i = 0; i < NumRegions; ++i) {
MachO::data_in_code_entry DICE = Obj->getDataInCodeTableEntry(
LLC.dataoff, i);
DictScope Group(W, "Entry");
W.printNumber("Index", i);
W.printNumber("Offset", DICE.offset);
W.printNumber("Length", DICE.length);
W.printNumber("Kind", DICE.kind);
}
}
}
}
void MachODumper::printMachOVersionMin() {
for (const auto &Load : Obj->load_commands()) {
StringRef Cmd;
switch (Load.C.cmd) {
case MachO::LC_VERSION_MIN_MACOSX:
Cmd = "LC_VERSION_MIN_MACOSX";
break;
case MachO::LC_VERSION_MIN_IPHONEOS:
Cmd = "LC_VERSION_MIN_IPHONEOS";
break;
case MachO::LC_VERSION_MIN_TVOS:
Cmd = "LC_VERSION_MIN_TVOS";
break;
case MachO::LC_VERSION_MIN_WATCHOS:
Cmd = "LC_VERSION_MIN_WATCHOS";
break;
case MachO::LC_BUILD_VERSION:
Cmd = "LC_BUILD_VERSION";
break;
default:
continue;
}
DictScope Group(W, "MinVersion");
// Handle LC_BUILD_VERSION.
if (Load.C.cmd == MachO::LC_BUILD_VERSION) {
MachO::build_version_command BVC = Obj->getBuildVersionLoadCommand(Load);
W.printString("Cmd", Cmd);
W.printNumber("Size", BVC.cmdsize);
W.printString("Platform",
MachOObjectFile::getBuildPlatform(BVC.platform));
W.printString("Version", MachOObjectFile::getVersionString(BVC.minos));
if (BVC.sdk)
W.printString("SDK", MachOObjectFile::getVersionString(BVC.sdk));
else
W.printString("SDK", StringRef("n/a"));
continue;
}
MachO::version_min_command VMC = Obj->getVersionMinLoadCommand(Load);
W.printString("Cmd", Cmd);
W.printNumber("Size", VMC.cmdsize);
SmallString<32> Version;
Version = utostr(MachOObjectFile::getVersionMinMajor(VMC, false)) + "." +
utostr(MachOObjectFile::getVersionMinMinor(VMC, false));
uint32_t Update = MachOObjectFile::getVersionMinUpdate(VMC, false);
if (Update != 0)
Version += "." + utostr(MachOObjectFile::getVersionMinUpdate(VMC, false));
W.printString("Version", Version);
SmallString<32> SDK;
if (VMC.sdk == 0)
SDK = "n/a";
else {
SDK = utostr(MachOObjectFile::getVersionMinMajor(VMC, true)) + "." +
utostr(MachOObjectFile::getVersionMinMinor(VMC, true));
uint32_t Update = MachOObjectFile::getVersionMinUpdate(VMC, true);
if (Update != 0)
SDK += "." + utostr(MachOObjectFile::getVersionMinUpdate(VMC, true));
}
W.printString("SDK", SDK);
}
}
void MachODumper::printMachOTargetTriple() {
for (const auto &Load : Obj->load_commands()) {
if (Load.C.cmd == MachO::LC_TARGET_TRIPLE) {
DictScope Group(W, "TargetTriple");
MachO::target_triple_command TTC = Obj->getTargetTripleLoadCommand(Load);
W.printString("Cmd", "LC_TARGET_TRIPLE");
W.printNumber("Size", TTC.cmdsize);
if (TTC.triple < TTC.cmdsize)
W.printString("Triple", Load.Ptr + TTC.triple);
else
W.printNumber("Triple ?(bad offset)", TTC.triple);
}
}
}
void MachODumper::printMachODysymtab() {
for (const auto &Load : Obj->load_commands()) {
if (Load.C.cmd == MachO::LC_DYSYMTAB) {
MachO::dysymtab_command DLC = Obj->getDysymtabLoadCommand();
DictScope Group(W, "Dysymtab");
W.printNumber("ilocalsym", DLC.ilocalsym);
W.printNumber("nlocalsym", DLC.nlocalsym);
W.printNumber("iextdefsym", DLC.iextdefsym);
W.printNumber("nextdefsym", DLC.nextdefsym);
W.printNumber("iundefsym", DLC.iundefsym);
W.printNumber("nundefsym", DLC.nundefsym);
W.printNumber("tocoff", DLC.tocoff);
W.printNumber("ntoc", DLC.ntoc);
W.printNumber("modtaboff", DLC.modtaboff);
W.printNumber("nmodtab", DLC.nmodtab);
W.printNumber("extrefsymoff", DLC.extrefsymoff);
W.printNumber("nextrefsyms", DLC.nextrefsyms);
W.printNumber("indirectsymoff", DLC.indirectsymoff);
W.printNumber("nindirectsyms", DLC.nindirectsyms);
W.printNumber("extreloff", DLC.extreloff);
W.printNumber("nextrel", DLC.nextrel);
W.printNumber("locreloff", DLC.locreloff);
W.printNumber("nlocrel", DLC.nlocrel);
}
}
}
void MachODumper::printMachOSegment() {
for (const auto &Load : Obj->load_commands()) {
if (Load.C.cmd == MachO::LC_SEGMENT || Load.C.cmd == MachO::LC_SEGMENT_64) {
MachOSegment MOSegment;
getSegment(Obj, Load, MOSegment);
DictScope Group(W, "Segment");
W.printString("Cmd", MOSegment.CmdName);
W.printString("Name", MOSegment.SegName);
W.printNumber("Size", MOSegment.cmdsize);
W.printHex("vmaddr", MOSegment.vmaddr);
W.printHex("vmsize", MOSegment.vmsize);
W.printNumber("fileoff", MOSegment.fileoff);
W.printNumber("filesize", MOSegment.filesize);
W.printString("maxprot", getMask(MOSegment.maxprot));
W.printString("initprot", getMask(MOSegment.initprot));
W.printNumber("nsects", MOSegment.nsects);
W.printHex("flags", MOSegment.flags);
}
}
}
void MachODumper::printMachOIndirectSymbols() {
for (const auto &Load : Obj->load_commands()) {
if (Load.C.cmd == MachO::LC_DYSYMTAB) {
MachO::dysymtab_command DLC = Obj->getDysymtabLoadCommand();
DictScope Group(W, "Indirect Symbols");
W.printNumber("Number", DLC.nindirectsyms);
ListScope D(W, "Symbols");
for (unsigned i = 0; i < DLC.nindirectsyms; ++i) {
DictScope Group(W, "Entry");
W.printNumber("Entry Index", i);
W.printHex("Symbol Index", Obj->getIndirectSymbolTableEntry(DLC, i));
}
}
}
}
void MachODumper::printMachOLinkerOptions() {
for (const auto &Load : Obj->load_commands()) {
if (Load.C.cmd == MachO::LC_LINKER_OPTION) {
MachO::linker_option_command LOLC = Obj->getLinkerOptionLoadCommand(Load);
DictScope Group(W, "Linker Options");
W.printNumber("Size", LOLC.cmdsize);
ListScope D(W, "Strings");
uint64_t DataSize = LOLC.cmdsize - sizeof(MachO::linker_option_command);
const char *P = Load.Ptr + sizeof(MachO::linker_option_command);
StringRef Data(P, DataSize);
for (unsigned i = 0; i < LOLC.count; ++i) {
std::pair<StringRef,StringRef> Split = Data.split('\0');
W.printString("Value", Split.first);
Data = Split.second;
}
}
}
}