1 //===-- COFFDump.cpp - COFF-specific dumper ---------------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 ///
10 /// \file
11 /// \brief This file implements the COFF-specific dumper for llvm-objdump.
12 /// It outputs the Win64 EH data structures as plain text.
13 /// The encoding of the unwind codes is described in MSDN:
14 /// http://msdn.microsoft.com/en-us/library/ck9asaa9.aspx
15 ///
16 //===----------------------------------------------------------------------===//
18 #include "llvm-objdump.h"
19 #include "llvm/Object/COFF.h"
20 #include "llvm/Object/ObjectFile.h"
21 #include "llvm/Support/Format.h"
22 #include "llvm/Support/SourceMgr.h"
23 #include "llvm/Support/Win64EH.h"
24 #include "llvm/Support/raw_ostream.h"
25 #include "llvm/Support/system_error.h"
26 #include <algorithm>
27 #include <cstring>
29 using namespace llvm;
30 using namespace object;
31 using namespace llvm::Win64EH;
33 // Returns the name of the unwind code.
34 static StringRef getUnwindCodeTypeName(uint8_t Code) {
35 switch(Code) {
36 default: llvm_unreachable("Invalid unwind code");
37 case UOP_PushNonVol: return "UOP_PushNonVol";
38 case UOP_AllocLarge: return "UOP_AllocLarge";
39 case UOP_AllocSmall: return "UOP_AllocSmall";
40 case UOP_SetFPReg: return "UOP_SetFPReg";
41 case UOP_SaveNonVol: return "UOP_SaveNonVol";
42 case UOP_SaveNonVolBig: return "UOP_SaveNonVolBig";
43 case UOP_SaveXMM128: return "UOP_SaveXMM128";
44 case UOP_SaveXMM128Big: return "UOP_SaveXMM128Big";
45 case UOP_PushMachFrame: return "UOP_PushMachFrame";
46 }
47 }
49 // Returns the name of a referenced register.
50 static StringRef getUnwindRegisterName(uint8_t Reg) {
51 switch(Reg) {
52 default: llvm_unreachable("Invalid register");
53 case 0: return "RAX";
54 case 1: return "RCX";
55 case 2: return "RDX";
56 case 3: return "RBX";
57 case 4: return "RSP";
58 case 5: return "RBP";
59 case 6: return "RSI";
60 case 7: return "RDI";
61 case 8: return "R8";
62 case 9: return "R9";
63 case 10: return "R10";
64 case 11: return "R11";
65 case 12: return "R12";
66 case 13: return "R13";
67 case 14: return "R14";
68 case 15: return "R15";
69 }
70 }
72 // Calculates the number of array slots required for the unwind code.
73 static unsigned getNumUsedSlots(const UnwindCode &UnwindCode) {
74 switch (UnwindCode.getUnwindOp()) {
75 default: llvm_unreachable("Invalid unwind code");
76 case UOP_PushNonVol:
77 case UOP_AllocSmall:
78 case UOP_SetFPReg:
79 case UOP_PushMachFrame:
80 return 1;
81 case UOP_SaveNonVol:
82 case UOP_SaveXMM128:
83 return 2;
84 case UOP_SaveNonVolBig:
85 case UOP_SaveXMM128Big:
86 return 3;
87 case UOP_AllocLarge:
88 return (UnwindCode.getOpInfo() == 0) ? 2 : 3;
89 }
90 }
92 // Prints one unwind code. Because an unwind code can occupy up to 3 slots in
93 // the unwind codes array, this function requires that the correct number of
94 // slots is provided.
95 static void printUnwindCode(ArrayRef<UnwindCode> UCs) {
96 assert(UCs.size() >= getNumUsedSlots(UCs[0]));
97 outs() << format(" 0x%02x: ", unsigned(UCs[0].u.CodeOffset))
98 << getUnwindCodeTypeName(UCs[0].getUnwindOp());
99 switch (UCs[0].getUnwindOp()) {
100 case UOP_PushNonVol:
101 outs() << " " << getUnwindRegisterName(UCs[0].getOpInfo());
102 break;
103 case UOP_AllocLarge:
104 if (UCs[0].getOpInfo() == 0) {
105 outs() << " " << UCs[1].FrameOffset;
106 } else {
107 outs() << " " << UCs[1].FrameOffset
108 + (static_cast<uint32_t>(UCs[2].FrameOffset) << 16);
109 }
110 break;
111 case UOP_AllocSmall:
112 outs() << " " << ((UCs[0].getOpInfo() + 1) * 8);
113 break;
114 case UOP_SetFPReg:
115 outs() << " ";
116 break;
117 case UOP_SaveNonVol:
118 outs() << " " << getUnwindRegisterName(UCs[0].getOpInfo())
119 << format(" [0x%04x]", 8 * UCs[1].FrameOffset);
120 break;
121 case UOP_SaveNonVolBig:
122 outs() << " " << getUnwindRegisterName(UCs[0].getOpInfo())
123 << format(" [0x%08x]", UCs[1].FrameOffset
124 + (static_cast<uint32_t>(UCs[2].FrameOffset) << 16));
125 break;
126 case UOP_SaveXMM128:
127 outs() << " XMM" << static_cast<uint32_t>(UCs[0].getOpInfo())
128 << format(" [0x%04x]", 16 * UCs[1].FrameOffset);
129 break;
130 case UOP_SaveXMM128Big:
131 outs() << " XMM" << UCs[0].getOpInfo()
132 << format(" [0x%08x]", UCs[1].FrameOffset
133 + (static_cast<uint32_t>(UCs[2].FrameOffset) << 16));
134 break;
135 case UOP_PushMachFrame:
136 outs() << " " << (UCs[0].getOpInfo() ? "w/o" : "w")
137 << " error code";
138 break;
139 }
140 outs() << "\n";
141 }
143 static void printAllUnwindCodes(ArrayRef<UnwindCode> UCs) {
144 for (const UnwindCode *I = UCs.begin(), *E = UCs.end(); I < E; ) {
145 unsigned UsedSlots = getNumUsedSlots(*I);
146 if (UsedSlots > UCs.size()) {
147 outs() << "Unwind data corrupted: Encountered unwind op "
148 << getUnwindCodeTypeName((*I).getUnwindOp())
149 << " which requires " << UsedSlots
150 << " slots, but only " << UCs.size()
151 << " remaining in buffer";
152 return ;
153 }
154 printUnwindCode(ArrayRef<UnwindCode>(I, E));
155 I += UsedSlots;
156 }
157 }
159 // Given a symbol sym this functions returns the address and section of it.
160 static error_code resolveSectionAndAddress(const COFFObjectFile *Obj,
161 const SymbolRef &Sym,
162 const coff_section *&ResolvedSection,
163 uint64_t &ResolvedAddr) {
164 if (error_code EC = Sym.getAddress(ResolvedAddr))
165 return EC;
166 section_iterator iter(Obj->section_begin());
167 if (error_code EC = Sym.getSection(iter))
168 return EC;
169 ResolvedSection = Obj->getCOFFSection(iter);
170 return object_error::success;
171 }
173 // Given a vector of relocations for a section and an offset into this section
174 // the function returns the symbol used for the relocation at the offset.
175 static error_code resolveSymbol(const std::vector<RelocationRef> &Rels,
176 uint64_t Offset, SymbolRef &Sym) {
177 for (std::vector<RelocationRef>::const_iterator I = Rels.begin(),
178 E = Rels.end();
179 I != E; ++I) {
180 uint64_t Ofs;
181 if (error_code EC = I->getOffset(Ofs))
182 return EC;
183 if (Ofs == Offset) {
184 Sym = *I->getSymbol();
185 break;
186 }
187 }
188 return object_error::success;
189 }
191 // Given a vector of relocations for a section and an offset into this section
192 // the function resolves the symbol used for the relocation at the offset and
193 // returns the section content and the address inside the content pointed to
194 // by the symbol.
195 static error_code getSectionContents(const COFFObjectFile *Obj,
196 const std::vector<RelocationRef> &Rels,
197 uint64_t Offset,
198 ArrayRef<uint8_t> &Contents,
199 uint64_t &Addr) {
200 SymbolRef Sym;
201 if (error_code ec = resolveSymbol(Rels, Offset, Sym)) return ec;
202 const coff_section *Section;
203 if (error_code EC = resolveSectionAndAddress(Obj, Sym, Section, Addr))
204 return EC;
205 if (error_code EC = Obj->getSectionContents(Section, Contents))
206 return EC;
207 return object_error::success;
208 }
210 // Given a vector of relocations for a section and an offset into this section
211 // the function returns the name of the symbol used for the relocation at the
212 // offset.
213 static error_code resolveSymbolName(const std::vector<RelocationRef> &Rels,
214 uint64_t Offset, StringRef &Name) {
215 SymbolRef Sym;
216 if (error_code EC = resolveSymbol(Rels, Offset, Sym))
217 return EC;
218 if (error_code EC = Sym.getName(Name))
219 return EC;
220 return object_error::success;
221 }
223 static void printCOFFSymbolAddress(llvm::raw_ostream &Out,
224 const std::vector<RelocationRef> &Rels,
225 uint64_t Offset, uint32_t Disp) {
226 StringRef Sym;
227 if (error_code EC = resolveSymbolName(Rels, Offset, Sym)) {
228 error(EC);
229 return ;
230 }
231 Out << Sym;
232 if (Disp > 0)
233 Out << format(" + 0x%04x", Disp);
234 }
236 static void
237 printSEHTable(const COFFObjectFile *Obj, uint32_t TableVA, int Count) {
238 if (Count == 0)
239 return;
241 const pe32_header *PE32Header;
242 if (error(Obj->getPE32Header(PE32Header)))
243 return;
244 uint32_t ImageBase = PE32Header->ImageBase;
245 uintptr_t IntPtr = 0;
246 if (error(Obj->getVaPtr(TableVA, IntPtr)))
247 return;
248 const support::ulittle32_t *P = (const support::ulittle32_t *)IntPtr;
249 outs() << "SEH Table:";
250 for (int I = 0; I < Count; ++I)
251 outs() << format(" 0x%x", P[I] + ImageBase);
252 outs() << "\n\n";
253 }
255 static void printLoadConfiguration(const COFFObjectFile *Obj) {
256 // Skip if it's not executable.
257 const pe32_header *PE32Header;
258 if (error(Obj->getPE32Header(PE32Header)))
259 return;
260 if (!PE32Header)
261 return;
263 const coff_file_header *Header;
264 if (error(Obj->getCOFFHeader(Header)))
265 return;
266 // Currently only x86 is supported
267 if (Header->Machine != COFF::IMAGE_FILE_MACHINE_I386)
268 return;
270 const data_directory *DataDir;
271 if (error(Obj->getDataDirectory(COFF::LOAD_CONFIG_TABLE, DataDir)))
272 return;
273 uintptr_t IntPtr = 0;
274 if (DataDir->RelativeVirtualAddress == 0)
275 return;
276 if (error(Obj->getRvaPtr(DataDir->RelativeVirtualAddress, IntPtr)))
277 return;
279 const coff_load_configuration32 *LoadConf =
280 reinterpret_cast<const coff_load_configuration32 *>(IntPtr);
282 outs() << "Load configuration:"
283 << "\n Timestamp: " << LoadConf->TimeDateStamp
284 << "\n Major Version: " << LoadConf->MajorVersion
285 << "\n Minor Version: " << LoadConf->MinorVersion
286 << "\n GlobalFlags Clear: " << LoadConf->GlobalFlagsClear
287 << "\n GlobalFlags Set: " << LoadConf->GlobalFlagsSet
288 << "\n Critical Section Default Timeout: " << LoadConf->CriticalSectionDefaultTimeout
289 << "\n Decommit Free Block Threshold: " << LoadConf->DeCommitFreeBlockThreshold
290 << "\n Decommit Total Free Threshold: " << LoadConf->DeCommitTotalFreeThreshold
291 << "\n Lock Prefix Table: " << LoadConf->LockPrefixTable
292 << "\n Maximum Allocation Size: " << LoadConf->MaximumAllocationSize
293 << "\n Virtual Memory Threshold: " << LoadConf->VirtualMemoryThreshold
294 << "\n Process Affinity Mask: " << LoadConf->ProcessAffinityMask
295 << "\n Process Heap Flags: " << LoadConf->ProcessHeapFlags
296 << "\n CSD Version: " << LoadConf->CSDVersion
297 << "\n Security Cookie: " << LoadConf->SecurityCookie
298 << "\n SEH Table: " << LoadConf->SEHandlerTable
299 << "\n SEH Count: " << LoadConf->SEHandlerCount
300 << "\n\n";
301 printSEHTable(Obj, LoadConf->SEHandlerTable, LoadConf->SEHandlerCount);
302 outs() << "\n";
303 }
305 // Prints import tables. The import table is a table containing the list of
306 // DLL name and symbol names which will be linked by the loader.
307 static void printImportTables(const COFFObjectFile *Obj) {
308 import_directory_iterator I = Obj->import_directory_begin();
309 import_directory_iterator E = Obj->import_directory_end();
310 if (I == E)
311 return;
312 outs() << "The Import Tables:\n";
313 for (; I != E; I = ++I) {
314 const import_directory_table_entry *Dir;
315 StringRef Name;
316 if (I->getImportTableEntry(Dir)) return;
317 if (I->getName(Name)) return;
319 outs() << format(" lookup %08x time %08x fwd %08x name %08x addr %08x\n\n",
320 static_cast<uint32_t>(Dir->ImportLookupTableRVA),
321 static_cast<uint32_t>(Dir->TimeDateStamp),
322 static_cast<uint32_t>(Dir->ForwarderChain),
323 static_cast<uint32_t>(Dir->NameRVA),
324 static_cast<uint32_t>(Dir->ImportAddressTableRVA));
325 outs() << " DLL Name: " << Name << "\n";
326 outs() << " Hint/Ord Name\n";
327 const import_lookup_table_entry32 *entry;
328 if (I->getImportLookupEntry(entry))
329 return;
330 for (; entry->data; ++entry) {
331 if (entry->isOrdinal()) {
332 outs() << format(" % 6d\n", entry->getOrdinal());
333 continue;
334 }
335 uint16_t Hint;
336 StringRef Name;
337 if (Obj->getHintName(entry->getHintNameRVA(), Hint, Name))
338 return;
339 outs() << format(" % 6d ", Hint) << Name << "\n";
340 }
341 outs() << "\n";
342 }
343 }
345 // Prints export tables. The export table is a table containing the list of
346 // exported symbol from the DLL.
347 static void printExportTable(const COFFObjectFile *Obj) {
348 outs() << "Export Table:\n";
349 export_directory_iterator I = Obj->export_directory_begin();
350 export_directory_iterator E = Obj->export_directory_end();
351 if (I == E)
352 return;
353 StringRef DllName;
354 uint32_t OrdinalBase;
355 if (I->getDllName(DllName))
356 return;
357 if (I->getOrdinalBase(OrdinalBase))
358 return;
359 outs() << " DLL name: " << DllName << "\n";
360 outs() << " Ordinal base: " << OrdinalBase << "\n";
361 outs() << " Ordinal RVA Name\n";
362 for (; I != E; I = ++I) {
363 uint32_t Ordinal;
364 if (I->getOrdinal(Ordinal))
365 return;
366 uint32_t RVA;
367 if (I->getExportRVA(RVA))
368 return;
369 outs() << format(" % 4d %# 8x", Ordinal, RVA);
371 StringRef Name;
372 if (I->getSymbolName(Name))
373 continue;
374 if (!Name.empty())
375 outs() << " " << Name;
376 outs() << "\n";
377 }
378 }
380 void llvm::printCOFFUnwindInfo(const COFFObjectFile *Obj) {
381 const coff_file_header *Header;
382 if (error(Obj->getCOFFHeader(Header))) return;
384 if (Header->Machine != COFF::IMAGE_FILE_MACHINE_AMD64) {
385 errs() << "Unsupported image machine type "
386 "(currently only AMD64 is supported).\n";
387 return;
388 }
390 const coff_section *Pdata = 0;
392 for (section_iterator SI = Obj->section_begin(), SE = Obj->section_end();
393 SI != SE; ++SI) {
394 StringRef Name;
395 if (error(SI->getName(Name))) continue;
397 if (Name != ".pdata") continue;
399 Pdata = Obj->getCOFFSection(SI);
400 std::vector<RelocationRef> Rels;
401 for (relocation_iterator RI = SI->relocation_begin(),
402 RE = SI->relocation_end();
403 RI != RE; ++RI)
404 Rels.push_back(*RI);
406 // Sort relocations by address.
407 std::sort(Rels.begin(), Rels.end(), RelocAddressLess);
409 ArrayRef<uint8_t> Contents;
410 if (error(Obj->getSectionContents(Pdata, Contents))) continue;
411 if (Contents.empty()) continue;
413 ArrayRef<RuntimeFunction> RFs(
414 reinterpret_cast<const RuntimeFunction *>(Contents.data()),
415 Contents.size() / sizeof(RuntimeFunction));
416 for (const RuntimeFunction *I = RFs.begin(), *E = RFs.end(); I < E; ++I) {
417 const uint64_t SectionOffset = std::distance(RFs.begin(), I)
418 * sizeof(RuntimeFunction);
420 outs() << "Function Table:\n";
422 outs() << " Start Address: ";
423 printCOFFSymbolAddress(outs(), Rels, SectionOffset +
424 /*offsetof(RuntimeFunction, StartAddress)*/ 0,
425 I->StartAddress);
426 outs() << "\n";
428 outs() << " End Address: ";
429 printCOFFSymbolAddress(outs(), Rels, SectionOffset +
430 /*offsetof(RuntimeFunction, EndAddress)*/ 4,
431 I->EndAddress);
432 outs() << "\n";
434 outs() << " Unwind Info Address: ";
435 printCOFFSymbolAddress(outs(), Rels, SectionOffset +
436 /*offsetof(RuntimeFunction, UnwindInfoOffset)*/ 8,
437 I->UnwindInfoOffset);
438 outs() << "\n";
440 ArrayRef<uint8_t> XContents;
441 uint64_t UnwindInfoOffset = 0;
442 if (error(getSectionContents(Obj, Rels, SectionOffset +
443 /*offsetof(RuntimeFunction, UnwindInfoOffset)*/ 8,
444 XContents, UnwindInfoOffset))) continue;
445 if (XContents.empty()) continue;
447 UnwindInfoOffset += I->UnwindInfoOffset;
448 if (UnwindInfoOffset > XContents.size()) continue;
450 const Win64EH::UnwindInfo *UI =
451 reinterpret_cast<const Win64EH::UnwindInfo *>
452 (XContents.data() + UnwindInfoOffset);
454 // The casts to int are required in order to output the value as number.
455 // Without the casts the value would be interpreted as char data (which
456 // results in garbage output).
457 outs() << " Version: " << static_cast<int>(UI->getVersion()) << "\n";
458 outs() << " Flags: " << static_cast<int>(UI->getFlags());
459 if (UI->getFlags()) {
460 if (UI->getFlags() & UNW_ExceptionHandler)
461 outs() << " UNW_ExceptionHandler";
462 if (UI->getFlags() & UNW_TerminateHandler)
463 outs() << " UNW_TerminateHandler";
464 if (UI->getFlags() & UNW_ChainInfo)
465 outs() << " UNW_ChainInfo";
466 }
467 outs() << "\n";
468 outs() << " Size of prolog: "
469 << static_cast<int>(UI->PrologSize) << "\n";
470 outs() << " Number of Codes: "
471 << static_cast<int>(UI->NumCodes) << "\n";
472 // Maybe this should move to output of UOP_SetFPReg?
473 if (UI->getFrameRegister()) {
474 outs() << " Frame register: "
475 << getUnwindRegisterName(UI->getFrameRegister())
476 << "\n";
477 outs() << " Frame offset: "
478 << 16 * UI->getFrameOffset()
479 << "\n";
480 } else {
481 outs() << " No frame pointer used\n";
482 }
483 if (UI->getFlags() & (UNW_ExceptionHandler | UNW_TerminateHandler)) {
484 // FIXME: Output exception handler data
485 } else if (UI->getFlags() & UNW_ChainInfo) {
486 // FIXME: Output chained unwind info
487 }
489 if (UI->NumCodes)
490 outs() << " Unwind Codes:\n";
492 printAllUnwindCodes(ArrayRef<UnwindCode>(&UI->UnwindCodes[0],
493 UI->NumCodes));
495 outs() << "\n\n";
496 outs().flush();
497 }
498 }
499 }
501 void llvm::printCOFFFileHeader(const object::ObjectFile *Obj) {
502 const COFFObjectFile *file = dyn_cast<const COFFObjectFile>(Obj);
503 printLoadConfiguration(file);
504 printImportTables(file);
505 printExportTable(file);
506 }