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 MachOObjectFile *Obj,
170 MachOSection &Section) {
171 const MachOObject *MachOObj = Obj->getObject();
173 if (is64BitLoadCommand(MachOObj, DRI)) {
174 const MachOFormat::Section64 *Sect = Obj->getSection64(DRI);
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 const MachOFormat::Section *Sect = Obj->getSection(DRI);
188 Section.Address = Sect->Address;
189 Section.Size = Sect->Size;
190 Section.Offset = Sect->Offset;
191 Section.Alignment = Sect->Align;
192 Section.RelocationTableOffset = Sect->RelocationTableOffset;
193 Section.NumRelocationTableEntries = Sect->NumRelocationTableEntries;
194 Section.Flags = Sect->Flags;
195 Section.Reserved1 = Sect->Reserved1;
196 Section.Reserved2 = Sect->Reserved2;
200 static void getSymbol(const MachOObjectFile *Obj,
202 MachOSymbol &Symbol) {
203 const MachOObject *MachOObj = Obj->getObject();
204 if (MachOObj->is64Bit()) {
205 const MachOFormat::Symbol64TableEntry *Entry =
206 Obj->getSymbol64TableEntry( DRI);
207 Symbol.StringIndex = Entry->StringIndex;
208 Symbol.Type = Entry->Type;
209 Symbol.SectionIndex = Entry->SectionIndex;
210 Symbol.Flags = Entry->Flags;
211 Symbol.Value = Entry->Value;
213 const MachOFormat::SymbolTableEntry *Entry = Obj->getSymbolTableEntry(DRI);
214 Symbol.StringIndex = Entry->StringIndex;
215 Symbol.Type = Entry->Type;
216 Symbol.SectionIndex = Entry->SectionIndex;
217 Symbol.Flags = Entry->Flags;
218 Symbol.Value = Entry->Value;
222 void MachODumper::printFileHeaders() {
223 W.startLine() << "FileHeaders not implemented.\n";
226 void MachODumper::printSections() {
227 ListScope Group(W, "Sections");
229 int SectionIndex = -1;
231 for (section_iterator SecI = Obj->begin_sections(),
232 SecE = Obj->end_sections();
233 SecI != SecE; SecI.increment(EC)) {
234 if (error(EC)) break;
238 MachOSection Section;
239 getSection(Obj, SecI->getRawDataRefImpl(), Section);
240 DataRefImpl DR = SecI->getRawDataRefImpl();
243 if (error(SecI->getName(Name)))
246 ArrayRef<char> RawName = Obj->getSectionRawName(DR);
247 StringRef SegmentName = Obj->getSectionFinalSegmentName(DR);
248 ArrayRef<char> RawSegmentName = Obj->getSectionRawFinalSegmentName(DR);
250 DictScope SectionD(W, "Section");
251 W.printNumber("Index", SectionIndex);
252 W.printBinary("Name", Name, RawName);
253 W.printBinary("Segment", SegmentName, RawSegmentName);
254 W.printHex ("Address", Section.Address);
255 W.printHex ("Size", Section.Size);
256 W.printNumber("Offset", Section.Offset);
257 W.printNumber("Alignment", Section.Alignment);
258 W.printHex ("RelocationOffset", Section.RelocationTableOffset);
259 W.printNumber("RelocationCount", Section.NumRelocationTableEntries);
260 W.printEnum ("Type", Section.Flags & 0xFF,
261 makeArrayRef(MachOSectionAttributes));
262 W.printFlags ("Attributes", Section.Flags >> 8,
263 makeArrayRef(MachOSectionAttributes));
264 W.printHex ("Reserved1", Section.Reserved1);
265 W.printHex ("Reserved2", Section.Reserved2);
267 if (opts::SectionRelocations) {
268 ListScope D(W, "Relocations");
269 for (relocation_iterator RelI = SecI->begin_relocations(),
270 RelE = SecI->end_relocations();
271 RelI != RelE; RelI.increment(EC)) {
272 if (error(EC)) break;
274 printRelocation(SecI, RelI);
278 if (opts::SectionSymbols) {
279 ListScope D(W, "Symbols");
280 for (symbol_iterator SymI = Obj->begin_symbols(),
281 SymE = Obj->end_symbols();
282 SymI != SymE; SymI.increment(EC)) {
283 if (error(EC)) break;
285 bool Contained = false;
286 if (SecI->containsSymbol(*SymI, Contained) || !Contained)
293 if (opts::SectionData) {
295 if (error(SecI->getContents(Data))) break;
297 W.printBinaryBlock("SectionData", Data);
302 void MachODumper::printRelocations() {
303 ListScope D(W, "Relocations");
306 for (section_iterator SecI = Obj->begin_sections(),
307 SecE = Obj->end_sections();
308 SecI != SecE; SecI.increment(EC)) {
309 if (error(EC)) break;
312 if (error(SecI->getName(Name)))
315 bool PrintedGroup = false;
316 for (relocation_iterator RelI = SecI->begin_relocations(),
317 RelE = SecI->end_relocations();
318 RelI != RelE; RelI.increment(EC)) {
319 if (error(EC)) break;
322 W.startLine() << "Section " << Name << " {\n";
327 printRelocation(SecI, RelI);
332 W.startLine() << "}\n";
337 void MachODumper::printRelocation(section_iterator SecI,
338 relocation_iterator RelI) {
340 SmallString<32> RelocName;
342 StringRef SymbolName;
344 if (error(RelI->getOffset(Offset))) return;
345 if (error(RelI->getTypeName(RelocName))) return;
346 if (error(RelI->getAdditionalInfo(Info))) return;
347 if (error(RelI->getSymbol(Symbol))) return;
348 if (error(Symbol.getName(SymbolName))) return;
350 raw_ostream& OS = W.startLine();
353 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
354 << " " << W.hex(Info)
358 void MachODumper::printSymbols() {
359 ListScope Group(W, "Symbols");
362 for (symbol_iterator SymI = Obj->begin_symbols(),
363 SymE = Obj->end_symbols();
364 SymI != SymE; SymI.increment(EC)) {
365 if (error(EC)) break;
371 void MachODumper::printDynamicSymbols() {
372 ListScope Group(W, "DynamicSymbols");
375 void MachODumper::printSymbol(symbol_iterator SymI) {
378 StringRef SymbolName;
379 if (SymI->getName(SymbolName))
383 getSymbol(Obj, SymI->getRawDataRefImpl(), Symbol);
385 StringRef SectionName;
386 section_iterator SecI(Obj->end_sections());
387 if (error(SymI->getSection(SecI)) ||
388 error(SecI->getName(SectionName)))
391 DictScope D(W, "Symbol");
392 W.printNumber("Name", SymbolName, Symbol.StringIndex);
393 if (Symbol.Type & N_STAB) {
394 W.printHex ("Type", "SymDebugTable", Symbol.Type);
396 W.printEnum("Type", Symbol.Type, makeArrayRef(MachOSymbolTypes));
398 W.printHex ("Section", SectionName, Symbol.SectionIndex);
399 W.printEnum ("RefType", static_cast<uint16_t>(Symbol.Flags & 0xF),
400 makeArrayRef(MachOSymbolRefTypes));
401 W.printFlags ("Flags", static_cast<uint16_t>(Symbol.Flags & ~0xF),
402 makeArrayRef(MachOSymbolFlags));
403 W.printHex ("Value", Symbol.Value);
406 void MachODumper::printUnwindInfo() {
407 W.startLine() << "UnwindInfo not implemented.\n";