MachODumper.cpp 32 KB

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