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"
19 #include "llvm/ADT/SmallString.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 llvm::object::MachOObjectFile *Obj, StreamWriter& Writer)
34 virtual void printFileHeaders() LLVM_OVERRIDE;
35 virtual void printSections() LLVM_OVERRIDE;
36 virtual void printRelocations() LLVM_OVERRIDE;
37 virtual void printSymbols() LLVM_OVERRIDE;
38 virtual void printDynamicSymbols() LLVM_OVERRIDE;
39 virtual void printUnwindInfo() LLVM_OVERRIDE;
42 void printSymbol(symbol_iterator SymI);
44 void printRelocation(section_iterator SecI, relocation_iterator RelI);
46 const llvm::object::MachOObjectFile *Obj;
54 error_code createMachODumper(const object::ObjectFile *Obj,
56 OwningPtr<ObjDumper> &Result) {
57 const MachOObjectFile *MachOObj = dyn_cast<MachOObjectFile>(Obj);
59 return readobj_error::unsupported_obj_file_format;
61 Result.reset(new MachODumper(MachOObj, Writer));
62 return readobj_error::success;
68 static const EnumEntry<unsigned> MachOSectionTypes[] = {
70 { "ZeroFill" , 0x01 },
71 { "CStringLiterals" , 0x02 },
72 { "4ByteLiterals" , 0x03 },
73 { "8ByteLiterals" , 0x04 },
74 { "LiteralPointers" , 0x05 },
75 { "NonLazySymbolPointers" , 0x06 },
76 { "LazySymbolPointers" , 0x07 },
77 { "SymbolStubs" , 0x08 },
78 { "ModInitFuncs" , 0x09 },
79 { "ModTermFuncs" , 0x0A },
80 { "Coalesced" , 0x0B },
81 { "GBZeroFill" , 0x0C },
82 { "Interposing" , 0x0D },
83 { "16ByteLiterals" , 0x0E },
84 { "DTraceDOF" , 0x0F },
85 { "LazyDylibSymbolPoints" , 0x10 },
86 { "ThreadLocalRegular" , 0x11 },
87 { "ThreadLocalZerofill" , 0x12 },
88 { "ThreadLocalVariables" , 0x13 },
89 { "ThreadLocalVariablePointers" , 0x14 },
90 { "ThreadLocalInitFunctionPointers", 0x15 }
93 static const EnumEntry<unsigned> MachOSectionAttributes[] = {
94 { "LocReloc" , 1 << 0 /*S_ATTR_LOC_RELOC */ },
95 { "ExtReloc" , 1 << 1 /*S_ATTR_EXT_RELOC */ },
96 { "SomeInstructions" , 1 << 2 /*S_ATTR_SOME_INSTRUCTIONS */ },
97 { "Debug" , 1 << 17 /*S_ATTR_DEBUG */ },
98 { "SelfModifyingCode", 1 << 18 /*S_ATTR_SELF_MODIFYING_CODE*/ },
99 { "LiveSupport" , 1 << 19 /*S_ATTR_LIVE_SUPPORT */ },
100 { "NoDeadStrip" , 1 << 20 /*S_ATTR_NO_DEAD_STRIP */ },
101 { "StripStaticSyms" , 1 << 21 /*S_ATTR_STRIP_STATIC_SYMS */ },
102 { "NoTOC" , 1 << 22 /*S_ATTR_NO_TOC */ },
103 { "PureInstructions" , 1 << 23 /*S_ATTR_PURE_INSTRUCTIONS */ },
106 static const EnumEntry<unsigned> MachOSymbolRefTypes[] = {
107 { "UndefinedNonLazy", 0 },
108 { "ReferenceFlagUndefinedLazy", 1 },
109 { "ReferenceFlagDefined", 2 },
110 { "ReferenceFlagPrivateDefined", 3 },
111 { "ReferenceFlagPrivateUndefinedNonLazy", 4 },
112 { "ReferenceFlagPrivateUndefinedLazy", 5 }
115 static const EnumEntry<unsigned> MachOSymbolFlags[] = {
116 { "ReferencedDynamically", 0x10 },
117 { "NoDeadStrip", 0x20 },
122 static const EnumEntry<unsigned> MachOSymbolTypes[] = {
127 { "PreboundUndef", 0xC },
129 { "PrivateExternal", 0x10 }
137 struct MachOSection {
139 ArrayRef<char> SegmentName;
144 uint32_t RelocationTableOffset;
145 uint32_t NumRelocationTableEntries;
152 uint32_t StringIndex;
154 uint8_t SectionIndex;
160 static bool is64BitLoadCommand(const MachOObject *MachOObj, DataRefImpl DRI) {
161 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
162 if (LCI.Command.Type == macho::LCT_Segment64)
164 assert(LCI.Command.Type == macho::LCT_Segment && "Unexpected Type.");
168 static void getSection(const MachOObject *MachOObj,
170 MachOSection &Section) {
171 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
172 if (is64BitLoadCommand(MachOObj, DRI)) {
173 InMemoryStruct<macho::Section64> Sect;
174 MachOObj->ReadSection64(LCI, DRI.d.b, Sect);
176 Section.Address = Sect->Address;
177 Section.Size = Sect->Size;
178 Section.Offset = Sect->Offset;
179 Section.Alignment = Sect->Align;
180 Section.RelocationTableOffset = Sect->RelocationTableOffset;
181 Section.NumRelocationTableEntries = Sect->NumRelocationTableEntries;
182 Section.Flags = Sect->Flags;
183 Section.Reserved1 = Sect->Reserved1;
184 Section.Reserved2 = Sect->Reserved2;
186 InMemoryStruct<macho::Section> Sect;
187 MachOObj->ReadSection(LCI, DRI.d.b, Sect);
189 Section.Address = Sect->Address;
190 Section.Size = Sect->Size;
191 Section.Offset = Sect->Offset;
192 Section.Alignment = Sect->Align;
193 Section.RelocationTableOffset = Sect->RelocationTableOffset;
194 Section.NumRelocationTableEntries = Sect->NumRelocationTableEntries;
195 Section.Flags = Sect->Flags;
196 Section.Reserved1 = Sect->Reserved1;
197 Section.Reserved2 = Sect->Reserved2;
201 static void getSymbolTableEntry(const MachOObject *MachO,
203 InMemoryStruct<macho::SymbolTableEntry> &Res) {
204 InMemoryStruct<macho::SymtabLoadCommand> SymtabLoadCmd;
205 LoadCommandInfo LCI = MachO->getLoadCommandInfo(DRI.d.a);
206 MachO->ReadSymtabLoadCommand(LCI, SymtabLoadCmd);
207 MachO->ReadSymbolTableEntry(SymtabLoadCmd->SymbolTableOffset, DRI.d.b, Res);
210 static void getSymbol64TableEntry(const MachOObject *MachO,
212 InMemoryStruct<macho::Symbol64TableEntry> &Res) {
213 InMemoryStruct<macho::SymtabLoadCommand> SymtabLoadCmd;
214 LoadCommandInfo LCI = MachO->getLoadCommandInfo(DRI.d.a);
215 MachO->ReadSymtabLoadCommand(LCI, SymtabLoadCmd);
216 MachO->ReadSymbol64TableEntry(SymtabLoadCmd->SymbolTableOffset, DRI.d.b, Res);
219 static void getSymbol(const MachOObject *MachOObj,
221 MachOSymbol &Symbol) {
222 if (MachOObj->is64Bit()) {
223 InMemoryStruct<macho::Symbol64TableEntry> Entry;
224 getSymbol64TableEntry(MachOObj, DRI, Entry);
225 Symbol.StringIndex = Entry->StringIndex;
226 Symbol.Type = Entry->Type;
227 Symbol.SectionIndex = Entry->SectionIndex;
228 Symbol.Flags = Entry->Flags;
229 Symbol.Value = Entry->Value;
231 InMemoryStruct<macho::SymbolTableEntry> Entry;
232 getSymbolTableEntry(MachOObj, DRI, Entry);
233 Symbol.StringIndex = Entry->StringIndex;
234 Symbol.Type = Entry->Type;
235 Symbol.SectionIndex = Entry->SectionIndex;
236 Symbol.Flags = Entry->Flags;
237 Symbol.Value = Entry->Value;
241 void MachODumper::printFileHeaders() {
242 W.startLine() << "FileHeaders not implemented.\n";
245 void MachODumper::printSections() {
246 ListScope Group(W, "Sections");
248 int SectionIndex = -1;
250 for (section_iterator SecI = Obj->begin_sections(),
251 SecE = Obj->end_sections();
252 SecI != SecE; SecI.increment(EC)) {
253 if (error(EC)) break;
257 const MachOObject *MachO = Obj->getObject();
259 MachOSection Section;
260 getSection(MachO, SecI->getRawDataRefImpl(), Section);
261 DataRefImpl DR = SecI->getRawDataRefImpl();
264 if (error(SecI->getName(Name)))
267 ArrayRef<char> RawName = Obj->getSectionRawName(DR);
268 StringRef SegmentName = Obj->getSectionFinalSegmentName(DR);
269 ArrayRef<char> RawSegmentName = Obj->getSectionRawFinalSegmentName(DR);
271 DictScope SectionD(W, "Section");
272 W.printNumber("Index", SectionIndex);
273 W.printBinary("Name", Name, RawName);
274 W.printBinary("Segment", SegmentName, RawSegmentName);
275 W.printHex ("Address", Section.Address);
276 W.printHex ("Size", Section.Size);
277 W.printNumber("Offset", Section.Offset);
278 W.printNumber("Alignment", Section.Alignment);
279 W.printHex ("RelocationOffset", Section.RelocationTableOffset);
280 W.printNumber("RelocationCount", Section.NumRelocationTableEntries);
281 W.printEnum ("Type", Section.Flags & 0xFF,
282 makeArrayRef(MachOSectionAttributes));
283 W.printFlags ("Attributes", Section.Flags >> 8,
284 makeArrayRef(MachOSectionAttributes));
285 W.printHex ("Reserved1", Section.Reserved1);
286 W.printHex ("Reserved2", Section.Reserved2);
288 if (opts::SectionRelocations) {
289 ListScope D(W, "Relocations");
290 for (relocation_iterator RelI = SecI->begin_relocations(),
291 RelE = SecI->end_relocations();
292 RelI != RelE; RelI.increment(EC)) {
293 if (error(EC)) break;
295 printRelocation(SecI, RelI);
299 if (opts::SectionSymbols) {
300 ListScope D(W, "Symbols");
301 for (symbol_iterator SymI = Obj->begin_symbols(),
302 SymE = Obj->end_symbols();
303 SymI != SymE; SymI.increment(EC)) {
304 if (error(EC)) break;
306 bool Contained = false;
307 if (SecI->containsSymbol(*SymI, Contained) || !Contained)
314 if (opts::SectionData) {
316 if (error(SecI->getContents(Data))) break;
318 W.printBinaryBlock("SectionData", Data);
323 void MachODumper::printRelocations() {
324 ListScope D(W, "Relocations");
327 for (section_iterator SecI = Obj->begin_sections(),
328 SecE = Obj->end_sections();
329 SecI != SecE; SecI.increment(EC)) {
330 if (error(EC)) break;
333 if (error(SecI->getName(Name)))
336 bool PrintedGroup = false;
337 for (relocation_iterator RelI = SecI->begin_relocations(),
338 RelE = SecI->end_relocations();
339 RelI != RelE; RelI.increment(EC)) {
340 if (error(EC)) break;
343 W.startLine() << "Section " << Name << " {\n";
348 printRelocation(SecI, RelI);
353 W.startLine() << "}\n";
358 void MachODumper::printRelocation(section_iterator SecI,
359 relocation_iterator RelI) {
361 SmallString<32> RelocName;
363 StringRef SymbolName;
365 if (error(RelI->getOffset(Offset))) return;
366 if (error(RelI->getTypeName(RelocName))) return;
367 if (error(RelI->getAdditionalInfo(Info))) return;
368 if (error(RelI->getSymbol(Symbol))) return;
369 if (error(Symbol.getName(SymbolName))) return;
371 raw_ostream& OS = W.startLine();
374 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
375 << " " << W.hex(Info)
379 void MachODumper::printSymbols() {
380 ListScope Group(W, "Symbols");
383 for (symbol_iterator SymI = Obj->begin_symbols(),
384 SymE = Obj->end_symbols();
385 SymI != SymE; SymI.increment(EC)) {
386 if (error(EC)) break;
392 void MachODumper::printDynamicSymbols() {
393 ListScope Group(W, "DynamicSymbols");
396 void MachODumper::printSymbol(symbol_iterator SymI) {
399 StringRef SymbolName;
400 if (SymI->getName(SymbolName))
403 const MachOObject *MachO = const_cast<MachOObjectFile*>(Obj)->getObject();
406 getSymbol(MachO, SymI->getRawDataRefImpl(), Symbol);
408 StringRef SectionName;
409 section_iterator SecI(Obj->end_sections());
410 if (error(SymI->getSection(SecI)) ||
411 error(SecI->getName(SectionName)))
414 DictScope D(W, "Symbol");
415 W.printNumber("Name", SymbolName, Symbol.StringIndex);
416 if (Symbol.Type & N_STAB) {
417 W.printHex ("Type", "SymDebugTable", Symbol.Type);
419 W.printEnum("Type", Symbol.Type, makeArrayRef(MachOSymbolTypes));
421 W.printHex ("Section", SectionName, Symbol.SectionIndex);
422 W.printEnum ("RefType", static_cast<uint16_t>(Symbol.Flags & 0xF),
423 makeArrayRef(MachOSymbolRefTypes));
424 W.printFlags ("Flags", static_cast<uint16_t>(Symbol.Flags & ~0xF),
425 makeArrayRef(MachOSymbolFlags));
426 W.printHex ("Value", Symbol.Value);
429 void MachODumper::printUnwindInfo() {
430 W.startLine() << "UnwindInfo not implemented.\n";