1 //===-- COFFDump.cpp - COFF-specific dumper ---------------------*- C++ -*-===//
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 //===----------------------------------------------------------------------===//
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
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"
27 #include <system_error>
30 using namespace object;
31 using namespace llvm::Win64EH;
33 // Returns the name of the unwind code.
34 static StringRef getUnwindCodeTypeName(uint8_t 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";
49 // Returns the name of a referenced register.
50 static StringRef getUnwindRegisterName(uint8_t Reg) {
52 default: llvm_unreachable("Invalid register");
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";
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");
79 case UOP_PushMachFrame:
84 case UOP_SaveNonVolBig:
85 case UOP_SaveXMM128Big:
88 return (UnwindCode.getOpInfo() == 0) ? 2 : 3;
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
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()) {
101 outs() << " " << getUnwindRegisterName(UCs[0].getOpInfo());
104 if (UCs[0].getOpInfo() == 0) {
105 outs() << " " << UCs[1].FrameOffset;
107 outs() << " " << UCs[1].FrameOffset
108 + (static_cast<uint32_t>(UCs[2].FrameOffset) << 16);
112 outs() << " " << ((UCs[0].getOpInfo() + 1) * 8);
118 outs() << " " << getUnwindRegisterName(UCs[0].getOpInfo())
119 << format(" [0x%04x]", 8 * UCs[1].FrameOffset);
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));
127 outs() << " XMM" << static_cast<uint32_t>(UCs[0].getOpInfo())
128 << format(" [0x%04x]", 16 * UCs[1].FrameOffset);
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));
135 case UOP_PushMachFrame:
136 outs() << " " << (UCs[0].getOpInfo() ? "w/o" : "w")
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";
154 printUnwindCode(makeArrayRef(I, E));
159 // Given a symbol sym this functions returns the address and section of it.
160 static std::error_code
161 resolveSectionAndAddress(const COFFObjectFile *Obj, const SymbolRef &Sym,
162 const coff_section *&ResolvedSection,
163 uint64_t &ResolvedAddr) {
164 Expected<uint64_t> ResolvedAddrOrErr = Sym.getAddress();
165 if (!ResolvedAddrOrErr)
166 return errorToErrorCode(ResolvedAddrOrErr.takeError());
167 ResolvedAddr = *ResolvedAddrOrErr;
168 Expected<section_iterator> Iter = Sym.getSection();
170 return errorToErrorCode(Iter.takeError());
171 ResolvedSection = Obj->getCOFFSection(**Iter);
172 return std::error_code();
175 // Given a vector of relocations for a section and an offset into this section
176 // the function returns the symbol used for the relocation at the offset.
177 static std::error_code resolveSymbol(const std::vector<RelocationRef> &Rels,
178 uint64_t Offset, SymbolRef &Sym) {
179 for (std::vector<RelocationRef>::const_iterator I = Rels.begin(),
182 uint64_t Ofs = I->getOffset();
184 Sym = *I->getSymbol();
185 return std::error_code();
188 return object_error::parse_failed;
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
195 static std::error_code
196 getSectionContents(const COFFObjectFile *Obj,
197 const std::vector<RelocationRef> &Rels, uint64_t Offset,
198 ArrayRef<uint8_t> &Contents, uint64_t &Addr) {
200 if (std::error_code EC = resolveSymbol(Rels, Offset, Sym))
202 const coff_section *Section;
203 if (std::error_code EC = resolveSectionAndAddress(Obj, Sym, Section, Addr))
205 if (std::error_code EC = Obj->getSectionContents(Section, Contents))
207 return std::error_code();
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
213 static std::error_code resolveSymbolName(const std::vector<RelocationRef> &Rels,
214 uint64_t Offset, StringRef &Name) {
216 if (std::error_code EC = resolveSymbol(Rels, Offset, Sym))
218 Expected<StringRef> NameOrErr = Sym.getName();
220 return errorToErrorCode(NameOrErr.takeError());
222 return std::error_code();
225 static void printCOFFSymbolAddress(llvm::raw_ostream &Out,
226 const std::vector<RelocationRef> &Rels,
227 uint64_t Offset, uint32_t Disp) {
229 if (!resolveSymbolName(Rels, Offset, Sym)) {
232 Out << format(" + 0x%04x", Disp);
234 Out << format("0x%04x", Disp);
239 printSEHTable(const COFFObjectFile *Obj, uint32_t TableVA, int Count) {
243 const pe32_header *PE32Header;
244 error(Obj->getPE32Header(PE32Header));
245 uint32_t ImageBase = PE32Header->ImageBase;
246 uintptr_t IntPtr = 0;
247 error(Obj->getVaPtr(TableVA, IntPtr));
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);
255 template <typename T>
256 static void printTLSDirectoryT(const coff_tls_directory<T> *TLSDir) {
257 size_t FormatWidth = sizeof(T) * 2;
258 outs() << "TLS directory:"
259 << "\n StartAddressOfRawData: "
260 << format_hex(TLSDir->StartAddressOfRawData, FormatWidth)
261 << "\n EndAddressOfRawData: "
262 << format_hex(TLSDir->EndAddressOfRawData, FormatWidth)
263 << "\n AddressOfIndex: "
264 << format_hex(TLSDir->AddressOfIndex, FormatWidth)
265 << "\n AddressOfCallBacks: "
266 << format_hex(TLSDir->AddressOfCallBacks, FormatWidth)
267 << "\n SizeOfZeroFill: "
268 << TLSDir->SizeOfZeroFill
269 << "\n Characteristics: "
270 << TLSDir->Characteristics
272 << TLSDir->getAlignment()
276 static void printTLSDirectory(const COFFObjectFile *Obj) {
277 const pe32_header *PE32Header;
278 error(Obj->getPE32Header(PE32Header));
280 const pe32plus_header *PE32PlusHeader;
281 error(Obj->getPE32PlusHeader(PE32PlusHeader));
283 // Skip if it's not executable.
284 if (!PE32Header && !PE32PlusHeader)
287 const data_directory *DataDir;
288 error(Obj->getDataDirectory(COFF::TLS_TABLE, DataDir));
289 uintptr_t IntPtr = 0;
290 if (DataDir->RelativeVirtualAddress == 0)
292 error(Obj->getRvaPtr(DataDir->RelativeVirtualAddress, IntPtr));
295 auto *TLSDir = reinterpret_cast<const coff_tls_directory32 *>(IntPtr);
296 printTLSDirectoryT(TLSDir);
298 auto *TLSDir = reinterpret_cast<const coff_tls_directory64 *>(IntPtr);
299 printTLSDirectoryT(TLSDir);
305 static void printLoadConfiguration(const COFFObjectFile *Obj) {
306 // Skip if it's not executable.
307 const pe32_header *PE32Header;
308 error(Obj->getPE32Header(PE32Header));
312 // Currently only x86 is supported
313 if (Obj->getMachine() != COFF::IMAGE_FILE_MACHINE_I386)
316 const data_directory *DataDir;
317 error(Obj->getDataDirectory(COFF::LOAD_CONFIG_TABLE, DataDir));
318 uintptr_t IntPtr = 0;
319 if (DataDir->RelativeVirtualAddress == 0)
321 error(Obj->getRvaPtr(DataDir->RelativeVirtualAddress, IntPtr));
323 auto *LoadConf = reinterpret_cast<const coff_load_configuration32 *>(IntPtr);
324 outs() << "Load configuration:"
325 << "\n Timestamp: " << LoadConf->TimeDateStamp
326 << "\n Major Version: " << LoadConf->MajorVersion
327 << "\n Minor Version: " << LoadConf->MinorVersion
328 << "\n GlobalFlags Clear: " << LoadConf->GlobalFlagsClear
329 << "\n GlobalFlags Set: " << LoadConf->GlobalFlagsSet
330 << "\n Critical Section Default Timeout: " << LoadConf->CriticalSectionDefaultTimeout
331 << "\n Decommit Free Block Threshold: " << LoadConf->DeCommitFreeBlockThreshold
332 << "\n Decommit Total Free Threshold: " << LoadConf->DeCommitTotalFreeThreshold
333 << "\n Lock Prefix Table: " << LoadConf->LockPrefixTable
334 << "\n Maximum Allocation Size: " << LoadConf->MaximumAllocationSize
335 << "\n Virtual Memory Threshold: " << LoadConf->VirtualMemoryThreshold
336 << "\n Process Affinity Mask: " << LoadConf->ProcessAffinityMask
337 << "\n Process Heap Flags: " << LoadConf->ProcessHeapFlags
338 << "\n CSD Version: " << LoadConf->CSDVersion
339 << "\n Security Cookie: " << LoadConf->SecurityCookie
340 << "\n SEH Table: " << LoadConf->SEHandlerTable
341 << "\n SEH Count: " << LoadConf->SEHandlerCount
343 printSEHTable(Obj, LoadConf->SEHandlerTable, LoadConf->SEHandlerCount);
347 // Prints import tables. The import table is a table containing the list of
348 // DLL name and symbol names which will be linked by the loader.
349 static void printImportTables(const COFFObjectFile *Obj) {
350 import_directory_iterator I = Obj->import_directory_begin();
351 import_directory_iterator E = Obj->import_directory_end();
354 outs() << "The Import Tables:\n";
355 for (const ImportDirectoryEntryRef &DirRef : Obj->import_directories()) {
356 const import_directory_table_entry *Dir;
358 if (DirRef.getImportTableEntry(Dir)) return;
359 if (DirRef.getName(Name)) return;
361 outs() << format(" lookup %08x time %08x fwd %08x name %08x addr %08x\n\n",
362 static_cast<uint32_t>(Dir->ImportLookupTableRVA),
363 static_cast<uint32_t>(Dir->TimeDateStamp),
364 static_cast<uint32_t>(Dir->ForwarderChain),
365 static_cast<uint32_t>(Dir->NameRVA),
366 static_cast<uint32_t>(Dir->ImportAddressTableRVA));
367 outs() << " DLL Name: " << Name << "\n";
368 outs() << " Hint/Ord Name\n";
369 for (const ImportedSymbolRef &Entry : DirRef.imported_symbols()) {
371 if (Entry.isOrdinal(IsOrdinal))
375 if (Entry.getOrdinal(Ordinal))
377 outs() << format(" % 6d\n", Ordinal);
380 uint32_t HintNameRVA;
381 if (Entry.getHintNameRVA(HintNameRVA))
385 if (Obj->getHintName(HintNameRVA, Hint, Name))
387 outs() << format(" % 6d ", Hint) << Name << "\n";
393 // Prints export tables. The export table is a table containing the list of
394 // exported symbol from the DLL.
395 static void printExportTable(const COFFObjectFile *Obj) {
396 outs() << "Export Table:\n";
397 export_directory_iterator I = Obj->export_directory_begin();
398 export_directory_iterator E = Obj->export_directory_end();
402 uint32_t OrdinalBase;
403 if (I->getDllName(DllName))
405 if (I->getOrdinalBase(OrdinalBase))
407 outs() << " DLL name: " << DllName << "\n";
408 outs() << " Ordinal base: " << OrdinalBase << "\n";
409 outs() << " Ordinal RVA Name\n";
410 for (; I != E; I = ++I) {
412 if (I->getOrdinal(Ordinal))
415 if (I->getExportRVA(RVA))
418 if (I->isForwarder(IsForwarder))
422 // Export table entries can be used to re-export symbols that
423 // this COFF file is imported from some DLLs. This is rare.
424 // In most cases IsForwarder is false.
425 outs() << format(" % 4d ", Ordinal);
427 outs() << format(" % 4d %# 8x", Ordinal, RVA);
431 if (I->getSymbolName(Name))
434 outs() << " " << Name;
437 if (I->getForwardTo(S))
439 outs() << " (forwarded to " << S << ")";
445 // Given the COFF object file, this function returns the relocations for .pdata
446 // and the pointer to "runtime function" structs.
447 static bool getPDataSection(const COFFObjectFile *Obj,
448 std::vector<RelocationRef> &Rels,
449 const RuntimeFunction *&RFStart, int &NumRFs) {
450 for (const SectionRef &Section : Obj->sections()) {
452 error(Section.getName(Name));
453 if (Name != ".pdata")
456 const coff_section *Pdata = Obj->getCOFFSection(Section);
457 for (const RelocationRef &Reloc : Section.relocations())
458 Rels.push_back(Reloc);
460 // Sort relocations by address.
461 std::sort(Rels.begin(), Rels.end(), RelocAddressLess);
463 ArrayRef<uint8_t> Contents;
464 error(Obj->getSectionContents(Pdata, Contents));
465 if (Contents.empty())
468 RFStart = reinterpret_cast<const RuntimeFunction *>(Contents.data());
469 NumRFs = Contents.size() / sizeof(RuntimeFunction);
475 static void printWin64EHUnwindInfo(const Win64EH::UnwindInfo *UI) {
476 // The casts to int are required in order to output the value as number.
477 // Without the casts the value would be interpreted as char data (which
478 // results in garbage output).
479 outs() << " Version: " << static_cast<int>(UI->getVersion()) << "\n";
480 outs() << " Flags: " << static_cast<int>(UI->getFlags());
481 if (UI->getFlags()) {
482 if (UI->getFlags() & UNW_ExceptionHandler)
483 outs() << " UNW_ExceptionHandler";
484 if (UI->getFlags() & UNW_TerminateHandler)
485 outs() << " UNW_TerminateHandler";
486 if (UI->getFlags() & UNW_ChainInfo)
487 outs() << " UNW_ChainInfo";
490 outs() << " Size of prolog: " << static_cast<int>(UI->PrologSize) << "\n";
491 outs() << " Number of Codes: " << static_cast<int>(UI->NumCodes) << "\n";
492 // Maybe this should move to output of UOP_SetFPReg?
493 if (UI->getFrameRegister()) {
494 outs() << " Frame register: "
495 << getUnwindRegisterName(UI->getFrameRegister()) << "\n";
496 outs() << " Frame offset: " << 16 * UI->getFrameOffset() << "\n";
498 outs() << " No frame pointer used\n";
500 if (UI->getFlags() & (UNW_ExceptionHandler | UNW_TerminateHandler)) {
501 // FIXME: Output exception handler data
502 } else if (UI->getFlags() & UNW_ChainInfo) {
503 // FIXME: Output chained unwind info
507 outs() << " Unwind Codes:\n";
509 printAllUnwindCodes(makeArrayRef(&UI->UnwindCodes[0], UI->NumCodes));
515 /// Prints out the given RuntimeFunction struct for x64, assuming that Obj is
516 /// pointing to an executable file.
517 static void printRuntimeFunction(const COFFObjectFile *Obj,
518 const RuntimeFunction &RF) {
519 if (!RF.StartAddress)
521 outs() << "Function Table:\n"
522 << format(" Start Address: 0x%04x\n",
523 static_cast<uint32_t>(RF.StartAddress))
524 << format(" End Address: 0x%04x\n",
525 static_cast<uint32_t>(RF.EndAddress))
526 << format(" Unwind Info Address: 0x%04x\n",
527 static_cast<uint32_t>(RF.UnwindInfoOffset));
529 if (Obj->getRvaPtr(RF.UnwindInfoOffset, addr))
531 printWin64EHUnwindInfo(reinterpret_cast<const Win64EH::UnwindInfo *>(addr));
534 /// Prints out the given RuntimeFunction struct for x64, assuming that Obj is
535 /// pointing to an object file. Unlike executable, fields in RuntimeFunction
536 /// struct are filled with zeros, but instead there are relocations pointing to
537 /// them so that the linker will fill targets' RVAs to the fields at link
538 /// time. This function interprets the relocations to find the data to be used
539 /// in the resulting executable.
540 static void printRuntimeFunctionRels(const COFFObjectFile *Obj,
541 const RuntimeFunction &RF,
542 uint64_t SectionOffset,
543 const std::vector<RelocationRef> &Rels) {
544 outs() << "Function Table:\n";
545 outs() << " Start Address: ";
546 printCOFFSymbolAddress(outs(), Rels,
548 /*offsetof(RuntimeFunction, StartAddress)*/ 0,
552 outs() << " End Address: ";
553 printCOFFSymbolAddress(outs(), Rels,
555 /*offsetof(RuntimeFunction, EndAddress)*/ 4,
559 outs() << " Unwind Info Address: ";
560 printCOFFSymbolAddress(outs(), Rels,
562 /*offsetof(RuntimeFunction, UnwindInfoOffset)*/ 8,
563 RF.UnwindInfoOffset);
566 ArrayRef<uint8_t> XContents;
567 uint64_t UnwindInfoOffset = 0;
568 error(getSectionContents(
569 Obj, Rels, SectionOffset +
570 /*offsetof(RuntimeFunction, UnwindInfoOffset)*/ 8,
571 XContents, UnwindInfoOffset));
572 if (XContents.empty())
575 UnwindInfoOffset += RF.UnwindInfoOffset;
576 if (UnwindInfoOffset > XContents.size())
579 auto *UI = reinterpret_cast<const Win64EH::UnwindInfo *>(XContents.data() +
581 printWin64EHUnwindInfo(UI);
584 void llvm::printCOFFUnwindInfo(const COFFObjectFile *Obj) {
585 if (Obj->getMachine() != COFF::IMAGE_FILE_MACHINE_AMD64) {
586 errs() << "Unsupported image machine type "
587 "(currently only AMD64 is supported).\n";
591 std::vector<RelocationRef> Rels;
592 const RuntimeFunction *RFStart;
594 if (!getPDataSection(Obj, Rels, RFStart, NumRFs))
596 ArrayRef<RuntimeFunction> RFs(RFStart, NumRFs);
598 bool IsExecutable = Rels.empty();
600 for (const RuntimeFunction &RF : RFs)
601 printRuntimeFunction(Obj, RF);
605 for (const RuntimeFunction &RF : RFs) {
606 uint64_t SectionOffset =
607 std::distance(RFs.begin(), &RF) * sizeof(RuntimeFunction);
608 printRuntimeFunctionRels(Obj, RF, SectionOffset, Rels);
612 void llvm::printCOFFFileHeader(const object::ObjectFile *Obj) {
613 const COFFObjectFile *file = dyn_cast<const COFFObjectFile>(Obj);
614 printTLSDirectory(file);
615 printLoadConfiguration(file);
616 printImportTables(file);
617 printExportTable(file);
620 void llvm::printCOFFSymbolTable(const COFFObjectFile *coff) {
621 for (unsigned SI = 0, SE = coff->getNumberOfSymbols(); SI != SE; ++SI) {
622 ErrorOr<COFFSymbolRef> Symbol = coff->getSymbol(SI);
624 error(Symbol.getError());
625 error(coff->getSymbolName(*Symbol, Name));
627 outs() << "[" << format("%2d", SI) << "]"
628 << "(sec " << format("%2d", int(Symbol->getSectionNumber())) << ")"
629 << "(fl 0x00)" // Flag bits, which COFF doesn't have.
630 << "(ty " << format("%3x", unsigned(Symbol->getType())) << ")"
631 << "(scl " << format("%3x", unsigned(Symbol->getStorageClass())) << ") "
632 << "(nx " << unsigned(Symbol->getNumberOfAuxSymbols()) << ") "
633 << "0x" << format("%08x", unsigned(Symbol->getValue())) << " "
636 for (unsigned AI = 0, AE = Symbol->getNumberOfAuxSymbols(); AI < AE; ++AI, ++SI) {
637 if (Symbol->isSectionDefinition()) {
638 const coff_aux_section_definition *asd;
639 error(coff->getAuxSymbol<coff_aux_section_definition>(SI + 1, asd));
641 int32_t AuxNumber = asd->getNumber(Symbol->isBigObj());
644 << format("scnlen 0x%x nreloc %d nlnno %d checksum 0x%x "
645 , unsigned(asd->Length)
646 , unsigned(asd->NumberOfRelocations)
647 , unsigned(asd->NumberOfLinenumbers)
648 , unsigned(asd->CheckSum))
649 << format("assoc %d comdat %d\n"
650 , unsigned(AuxNumber)
651 , unsigned(asd->Selection));
652 } else if (Symbol->isFileRecord()) {
653 const char *FileName;
654 error(coff->getAuxSymbol<char>(SI + 1, FileName));
656 StringRef Name(FileName, Symbol->getNumberOfAuxSymbols() *
657 coff->getSymbolTableEntrySize());
658 outs() << "AUX " << Name.rtrim(StringRef("\0", 1)) << '\n';
660 SI = SI + Symbol->getNumberOfAuxSymbols();
662 } else if (Symbol->isWeakExternal()) {
663 const coff_aux_weak_external *awe;
664 error(coff->getAuxSymbol<coff_aux_weak_external>(SI + 1, awe));
666 outs() << "AUX " << format("indx %d srch %d\n",
667 static_cast<uint32_t>(awe->TagIndex),
668 static_cast<uint32_t>(awe->Characteristics));
670 outs() << "AUX Unknown\n";