1 //===-- MachODump.cpp - Object file dumping utility for llvm --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the MachO-specific dumper for llvm-readobj.
12 //===----------------------------------------------------------------------===//
14 #include "llvm-readobj.h"
16 #include "ObjDumper.h"
17 #include "StreamWriter.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/ADT/StringExtras.h"
20 #include "llvm/Object/MachO.h"
21 #include "llvm/Support/Casting.h"
24 using namespace object;
28 class MachODumper : public ObjDumper {
30 MachODumper(const MachOObjectFile *Obj, StreamWriter& Writer)
34 void printFileHeaders() override;
35 void printSections() override;
36 void printRelocations() override;
37 void printSymbols() override;
38 void printDynamicSymbols() override;
39 void printUnwindInfo() override;
42 void printSymbol(const SymbolRef &Symbol);
44 void printRelocation(const RelocationRef &Reloc);
46 void printRelocation(const MachOObjectFile *Obj, const RelocationRef &Reloc);
48 void printSections(const MachOObjectFile *Obj);
50 const MachOObjectFile *Obj;
58 std::error_code createMachODumper(const object::ObjectFile *Obj,
60 std::unique_ptr<ObjDumper> &Result) {
61 const MachOObjectFile *MachOObj = dyn_cast<MachOObjectFile>(Obj);
63 return readobj_error::unsupported_obj_file_format;
65 Result.reset(new MachODumper(MachOObj, Writer));
66 return readobj_error::success;
72 static const EnumEntry<unsigned> MachOSectionTypes[] = {
74 { "ZeroFill" , 0x01 },
75 { "CStringLiterals" , 0x02 },
76 { "4ByteLiterals" , 0x03 },
77 { "8ByteLiterals" , 0x04 },
78 { "LiteralPointers" , 0x05 },
79 { "NonLazySymbolPointers" , 0x06 },
80 { "LazySymbolPointers" , 0x07 },
81 { "SymbolStubs" , 0x08 },
82 { "ModInitFuncs" , 0x09 },
83 { "ModTermFuncs" , 0x0A },
84 { "Coalesced" , 0x0B },
85 { "GBZeroFill" , 0x0C },
86 { "Interposing" , 0x0D },
87 { "16ByteLiterals" , 0x0E },
88 { "DTraceDOF" , 0x0F },
89 { "LazyDylibSymbolPoints" , 0x10 },
90 { "ThreadLocalRegular" , 0x11 },
91 { "ThreadLocalZerofill" , 0x12 },
92 { "ThreadLocalVariables" , 0x13 },
93 { "ThreadLocalVariablePointers" , 0x14 },
94 { "ThreadLocalInitFunctionPointers", 0x15 }
97 static const EnumEntry<unsigned> MachOSectionAttributes[] = {
98 { "LocReloc" , 1 << 0 /*S_ATTR_LOC_RELOC */ },
99 { "ExtReloc" , 1 << 1 /*S_ATTR_EXT_RELOC */ },
100 { "SomeInstructions" , 1 << 2 /*S_ATTR_SOME_INSTRUCTIONS */ },
101 { "Debug" , 1 << 17 /*S_ATTR_DEBUG */ },
102 { "SelfModifyingCode", 1 << 18 /*S_ATTR_SELF_MODIFYING_CODE*/ },
103 { "LiveSupport" , 1 << 19 /*S_ATTR_LIVE_SUPPORT */ },
104 { "NoDeadStrip" , 1 << 20 /*S_ATTR_NO_DEAD_STRIP */ },
105 { "StripStaticSyms" , 1 << 21 /*S_ATTR_STRIP_STATIC_SYMS */ },
106 { "NoTOC" , 1 << 22 /*S_ATTR_NO_TOC */ },
107 { "PureInstructions" , 1 << 23 /*S_ATTR_PURE_INSTRUCTIONS */ },
110 static const EnumEntry<unsigned> MachOSymbolRefTypes[] = {
111 { "UndefinedNonLazy", 0 },
112 { "ReferenceFlagUndefinedLazy", 1 },
113 { "ReferenceFlagDefined", 2 },
114 { "ReferenceFlagPrivateDefined", 3 },
115 { "ReferenceFlagPrivateUndefinedNonLazy", 4 },
116 { "ReferenceFlagPrivateUndefinedLazy", 5 }
119 static const EnumEntry<unsigned> MachOSymbolFlags[] = {
120 { "ReferencedDynamically", 0x10 },
121 { "NoDeadStrip", 0x20 },
126 static const EnumEntry<unsigned> MachOSymbolTypes[] = {
130 { "PreboundUndef", 0xC },
135 struct MachOSection {
137 ArrayRef<char> SegmentName;
142 uint32_t RelocationTableOffset;
143 uint32_t NumRelocationTableEntries;
150 uint32_t StringIndex;
152 uint8_t SectionIndex;
158 static void getSection(const MachOObjectFile *Obj,
160 MachOSection &Section) {
161 if (!Obj->is64Bit()) {
162 MachO::section Sect = Obj->getSection(Sec);
163 Section.Address = Sect.addr;
164 Section.Size = Sect.size;
165 Section.Offset = Sect.offset;
166 Section.Alignment = Sect.align;
167 Section.RelocationTableOffset = Sect.reloff;
168 Section.NumRelocationTableEntries = Sect.nreloc;
169 Section.Flags = Sect.flags;
170 Section.Reserved1 = Sect.reserved1;
171 Section.Reserved2 = Sect.reserved2;
174 MachO::section_64 Sect = Obj->getSection64(Sec);
175 Section.Address = Sect.addr;
176 Section.Size = Sect.size;
177 Section.Offset = Sect.offset;
178 Section.Alignment = Sect.align;
179 Section.RelocationTableOffset = Sect.reloff;
180 Section.NumRelocationTableEntries = Sect.nreloc;
181 Section.Flags = Sect.flags;
182 Section.Reserved1 = Sect.reserved1;
183 Section.Reserved2 = Sect.reserved2;
187 static void getSymbol(const MachOObjectFile *Obj,
189 MachOSymbol &Symbol) {
190 if (!Obj->is64Bit()) {
191 MachO::nlist Entry = Obj->getSymbolTableEntry(DRI);
192 Symbol.StringIndex = Entry.n_strx;
193 Symbol.Type = Entry.n_type;
194 Symbol.SectionIndex = Entry.n_sect;
195 Symbol.Flags = Entry.n_desc;
196 Symbol.Value = Entry.n_value;
199 MachO::nlist_64 Entry = Obj->getSymbol64TableEntry(DRI);
200 Symbol.StringIndex = Entry.n_strx;
201 Symbol.Type = Entry.n_type;
202 Symbol.SectionIndex = Entry.n_sect;
203 Symbol.Flags = Entry.n_desc;
204 Symbol.Value = Entry.n_value;
207 void MachODumper::printFileHeaders() {
208 W.startLine() << "FileHeaders not implemented.\n";
211 void MachODumper::printSections() {
212 return printSections(Obj);
215 void MachODumper::printSections(const MachOObjectFile *Obj) {
216 ListScope Group(W, "Sections");
218 int SectionIndex = -1;
219 for (const SectionRef &Section : Obj->sections()) {
222 MachOSection MOSection;
223 getSection(Obj, Section.getRawDataRefImpl(), MOSection);
224 DataRefImpl DR = Section.getRawDataRefImpl();
227 if (error(Section.getName(Name)))
230 ArrayRef<char> RawName = Obj->getSectionRawName(DR);
231 StringRef SegmentName = Obj->getSectionFinalSegmentName(DR);
232 ArrayRef<char> RawSegmentName = Obj->getSectionRawFinalSegmentName(DR);
234 DictScope SectionD(W, "Section");
235 W.printNumber("Index", SectionIndex);
236 W.printBinary("Name", Name, RawName);
237 W.printBinary("Segment", SegmentName, RawSegmentName);
238 W.printHex("Address", MOSection.Address);
239 W.printHex("Size", MOSection.Size);
240 W.printNumber("Offset", MOSection.Offset);
241 W.printNumber("Alignment", MOSection.Alignment);
242 W.printHex("RelocationOffset", MOSection.RelocationTableOffset);
243 W.printNumber("RelocationCount", MOSection.NumRelocationTableEntries);
244 W.printEnum("Type", MOSection.Flags & 0xFF,
245 makeArrayRef(MachOSectionAttributes));
246 W.printFlags("Attributes", MOSection.Flags >> 8,
247 makeArrayRef(MachOSectionAttributes));
248 W.printHex("Reserved1", MOSection.Reserved1);
249 W.printHex("Reserved2", MOSection.Reserved2);
251 if (opts::SectionRelocations) {
252 ListScope D(W, "Relocations");
253 for (const RelocationRef &Reloc : Section.relocations())
254 printRelocation(Reloc);
257 if (opts::SectionSymbols) {
258 ListScope D(W, "Symbols");
259 for (const SymbolRef &Symbol : Obj->symbols()) {
260 bool Contained = false;
261 if (Section.containsSymbol(Symbol, Contained) || !Contained)
268 if (opts::SectionData) {
270 if (error(Section.isBSS(IsBSS)))
274 if (error(Section.getContents(Data)))
277 W.printBinaryBlock("SectionData", Data);
283 void MachODumper::printRelocations() {
284 ListScope D(W, "Relocations");
287 for (const SectionRef &Section : Obj->sections()) {
289 if (error(Section.getName(Name)))
292 bool PrintedGroup = false;
293 for (const RelocationRef &Reloc : Section.relocations()) {
295 W.startLine() << "Section " << Name << " {\n";
300 printRelocation(Reloc);
305 W.startLine() << "}\n";
310 void MachODumper::printRelocation(const RelocationRef &Reloc) {
311 return printRelocation(Obj, Reloc);
314 void MachODumper::printRelocation(const MachOObjectFile *Obj,
315 const RelocationRef &Reloc) {
317 SmallString<32> RelocName;
318 if (error(Reloc.getOffset(Offset)))
320 if (error(Reloc.getTypeName(RelocName)))
323 DataRefImpl DR = Reloc.getRawDataRefImpl();
324 MachO::any_relocation_info RE = Obj->getRelocation(DR);
325 bool IsScattered = Obj->isRelocationScattered(RE);
326 SmallString<32> SymbolNameOrOffset("0x");
328 // Scattered relocations don't really have an associated symbol
329 // for some reason, even if one exists in the symtab at the correct address.
330 SymbolNameOrOffset += utohexstr(Obj->getScatteredRelocationValue(RE));
332 symbol_iterator Symbol = Reloc.getSymbol();
333 if (Symbol != Obj->symbol_end()) {
334 StringRef SymbolName;
335 if (error(Symbol->getName(SymbolName)))
337 SymbolNameOrOffset = SymbolName;
339 SymbolNameOrOffset += utohexstr(Obj->getPlainRelocationSymbolNum(RE));
342 if (opts::ExpandRelocs) {
343 DictScope Group(W, "Relocation");
344 W.printHex("Offset", Offset);
345 W.printNumber("PCRel", Obj->getAnyRelocationPCRel(RE));
346 W.printNumber("Length", Obj->getAnyRelocationLength(RE));
348 W.printString("Extern", StringRef("N/A"));
350 W.printNumber("Extern", Obj->getPlainRelocationExternal(RE));
351 W.printNumber("Type", RelocName, Obj->getAnyRelocationType(RE));
352 W.printString("Symbol", SymbolNameOrOffset);
353 W.printNumber("Scattered", IsScattered);
355 raw_ostream& OS = W.startLine();
357 << " " << Obj->getAnyRelocationPCRel(RE)
358 << " " << Obj->getAnyRelocationLength(RE);
362 OS << " " << Obj->getPlainRelocationExternal(RE);
363 OS << " " << RelocName
364 << " " << IsScattered
365 << " " << SymbolNameOrOffset
370 void MachODumper::printSymbols() {
371 ListScope Group(W, "Symbols");
373 for (const SymbolRef &Symbol : Obj->symbols()) {
378 void MachODumper::printDynamicSymbols() {
379 ListScope Group(W, "DynamicSymbols");
382 void MachODumper::printSymbol(const SymbolRef &Symbol) {
383 StringRef SymbolName;
384 if (Symbol.getName(SymbolName))
387 MachOSymbol MOSymbol;
388 getSymbol(Obj, Symbol.getRawDataRefImpl(), MOSymbol);
390 StringRef SectionName = "";
391 section_iterator SecI(Obj->section_begin());
392 if (!error(Symbol.getSection(SecI)) && SecI != Obj->section_end())
393 error(SecI->getName(SectionName));
395 DictScope D(W, "Symbol");
396 W.printNumber("Name", SymbolName, MOSymbol.StringIndex);
397 if (MOSymbol.Type & MachO::N_STAB) {
398 W.printHex("Type", "SymDebugTable", MOSymbol.Type);
400 if (MOSymbol.Type & MachO::N_PEXT)
401 W.startLine() << "PrivateExtern\n";
402 if (MOSymbol.Type & MachO::N_EXT)
403 W.startLine() << "Extern\n";
404 W.printEnum("Type", uint8_t(MOSymbol.Type & MachO::N_TYPE),
405 makeArrayRef(MachOSymbolTypes));
407 W.printHex("Section", SectionName, MOSymbol.SectionIndex);
408 W.printEnum("RefType", static_cast<uint16_t>(MOSymbol.Flags & 0xF),
409 makeArrayRef(MachOSymbolRefTypes));
410 W.printFlags("Flags", static_cast<uint16_t>(MOSymbol.Flags & ~0xF),
411 makeArrayRef(MachOSymbolFlags));
412 W.printHex("Value", MOSymbol.Value);
415 void MachODumper::printUnwindInfo() {
416 W.startLine() << "UnwindInfo not implemented.\n";