llvm-objdump: Print x64 unwind info in executable.
[oota-llvm.git] / tools / llvm-objdump / COFFDump.cpp
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 //===----------------------------------------------------------------------===//
17
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>
28
29 using namespace llvm;
30 using namespace object;
31 using namespace llvm::Win64EH;
32
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 }
48
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 }
71
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 }
91
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 }
142
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 }
158
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 }
172
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       return object_error::success;
186     }
187   }
188   return object_error::parse_failed;
189 }
190
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))
202     return EC;
203   const coff_section *Section;
204   if (error_code EC = resolveSectionAndAddress(Obj, Sym, Section, Addr))
205     return EC;
206   if (error_code EC = Obj->getSectionContents(Section, Contents))
207     return EC;
208   return object_error::success;
209 }
210
211 // Given a vector of relocations for a section and an offset into this section
212 // the function returns the name of the symbol used for the relocation at the
213 // offset.
214 static error_code resolveSymbolName(const std::vector<RelocationRef> &Rels,
215                                     uint64_t Offset, StringRef &Name) {
216   SymbolRef Sym;
217   if (error_code EC = resolveSymbol(Rels, Offset, Sym))
218     return EC;
219   if (error_code EC = Sym.getName(Name))
220     return EC;
221   return object_error::success;
222 }
223
224 static void printCOFFSymbolAddress(llvm::raw_ostream &Out,
225                                    const std::vector<RelocationRef> &Rels,
226                                    uint64_t Offset, uint32_t Disp) {
227   StringRef Sym;
228   if (!resolveSymbolName(Rels, Offset, Sym)) {
229     Out << Sym;
230     if (Disp > 0)
231       Out << format(" + 0x%04x", Disp);
232   } else {
233     Out << format("0x%04x", Disp);
234   }
235 }
236
237 static void
238 printSEHTable(const COFFObjectFile *Obj, uint32_t TableVA, int Count) {
239   if (Count == 0)
240     return;
241
242   const pe32_header *PE32Header;
243   if (error(Obj->getPE32Header(PE32Header)))
244     return;
245   uint32_t ImageBase = PE32Header->ImageBase;
246   uintptr_t IntPtr = 0;
247   if (error(Obj->getVaPtr(TableVA, IntPtr)))
248     return;
249   const support::ulittle32_t *P = (const support::ulittle32_t *)IntPtr;
250   outs() << "SEH Table:";
251   for (int I = 0; I < Count; ++I)
252     outs() << format(" 0x%x", P[I] + ImageBase);
253   outs() << "\n\n";
254 }
255
256 static void printLoadConfiguration(const COFFObjectFile *Obj) {
257   // Skip if it's not executable.
258   const pe32_header *PE32Header;
259   if (error(Obj->getPE32Header(PE32Header)))
260     return;
261   if (!PE32Header)
262     return;
263
264   const coff_file_header *Header;
265   if (error(Obj->getCOFFHeader(Header)))
266     return;
267   // Currently only x86 is supported
268   if (Header->Machine != COFF::IMAGE_FILE_MACHINE_I386)
269     return;
270
271   const data_directory *DataDir;
272   if (error(Obj->getDataDirectory(COFF::LOAD_CONFIG_TABLE, DataDir)))
273     return;
274   uintptr_t IntPtr = 0;
275   if (DataDir->RelativeVirtualAddress == 0)
276     return;
277   if (error(Obj->getRvaPtr(DataDir->RelativeVirtualAddress, IntPtr)))
278     return;
279
280   const coff_load_configuration32 *LoadConf =
281       reinterpret_cast<const coff_load_configuration32 *>(IntPtr);
282
283   outs() << "Load configuration:"
284          << "\n  Timestamp: " << LoadConf->TimeDateStamp
285          << "\n  Major Version: " << LoadConf->MajorVersion
286          << "\n  Minor Version: " << LoadConf->MinorVersion
287          << "\n  GlobalFlags Clear: " << LoadConf->GlobalFlagsClear
288          << "\n  GlobalFlags Set: " << LoadConf->GlobalFlagsSet
289          << "\n  Critical Section Default Timeout: " << LoadConf->CriticalSectionDefaultTimeout
290          << "\n  Decommit Free Block Threshold: " << LoadConf->DeCommitFreeBlockThreshold
291          << "\n  Decommit Total Free Threshold: " << LoadConf->DeCommitTotalFreeThreshold
292          << "\n  Lock Prefix Table: " << LoadConf->LockPrefixTable
293          << "\n  Maximum Allocation Size: " << LoadConf->MaximumAllocationSize
294          << "\n  Virtual Memory Threshold: " << LoadConf->VirtualMemoryThreshold
295          << "\n  Process Affinity Mask: " << LoadConf->ProcessAffinityMask
296          << "\n  Process Heap Flags: " << LoadConf->ProcessHeapFlags
297          << "\n  CSD Version: " << LoadConf->CSDVersion
298          << "\n  Security Cookie: " << LoadConf->SecurityCookie
299          << "\n  SEH Table: " << LoadConf->SEHandlerTable
300          << "\n  SEH Count: " << LoadConf->SEHandlerCount
301          << "\n\n";
302   printSEHTable(Obj, LoadConf->SEHandlerTable, LoadConf->SEHandlerCount);
303   outs() << "\n";
304 }
305
306 // Prints import tables. The import table is a table containing the list of
307 // DLL name and symbol names which will be linked by the loader.
308 static void printImportTables(const COFFObjectFile *Obj) {
309   import_directory_iterator I = Obj->import_directory_begin();
310   import_directory_iterator E = Obj->import_directory_end();
311   if (I == E)
312     return;
313   outs() << "The Import Tables:\n";
314   for (; I != E; I = ++I) {
315     const import_directory_table_entry *Dir;
316     StringRef Name;
317     if (I->getImportTableEntry(Dir)) return;
318     if (I->getName(Name)) return;
319
320     outs() << format("  lookup %08x time %08x fwd %08x name %08x addr %08x\n\n",
321                      static_cast<uint32_t>(Dir->ImportLookupTableRVA),
322                      static_cast<uint32_t>(Dir->TimeDateStamp),
323                      static_cast<uint32_t>(Dir->ForwarderChain),
324                      static_cast<uint32_t>(Dir->NameRVA),
325                      static_cast<uint32_t>(Dir->ImportAddressTableRVA));
326     outs() << "    DLL Name: " << Name << "\n";
327     outs() << "    Hint/Ord  Name\n";
328     const import_lookup_table_entry32 *entry;
329     if (I->getImportLookupEntry(entry))
330       return;
331     for (; entry->data; ++entry) {
332       if (entry->isOrdinal()) {
333         outs() << format("      % 6d\n", entry->getOrdinal());
334         continue;
335       }
336       uint16_t Hint;
337       StringRef Name;
338       if (Obj->getHintName(entry->getHintNameRVA(), Hint, Name))
339         return;
340       outs() << format("      % 6d  ", Hint) << Name << "\n";
341     }
342     outs() << "\n";
343   }
344 }
345
346 // Prints export tables. The export table is a table containing the list of
347 // exported symbol from the DLL.
348 static void printExportTable(const COFFObjectFile *Obj) {
349   outs() << "Export Table:\n";
350   export_directory_iterator I = Obj->export_directory_begin();
351   export_directory_iterator E = Obj->export_directory_end();
352   if (I == E)
353     return;
354   StringRef DllName;
355   uint32_t OrdinalBase;
356   if (I->getDllName(DllName))
357     return;
358   if (I->getOrdinalBase(OrdinalBase))
359     return;
360   outs() << " DLL name: " << DllName << "\n";
361   outs() << " Ordinal base: " << OrdinalBase << "\n";
362   outs() << " Ordinal      RVA  Name\n";
363   for (; I != E; I = ++I) {
364     uint32_t Ordinal;
365     if (I->getOrdinal(Ordinal))
366       return;
367     uint32_t RVA;
368     if (I->getExportRVA(RVA))
369       return;
370     outs() << format("    % 4d %# 8x", Ordinal, RVA);
371
372     StringRef Name;
373     if (I->getSymbolName(Name))
374       continue;
375     if (!Name.empty())
376       outs() << "  " << Name;
377     outs() << "\n";
378   }
379 }
380
381 // Given the COFF object file, this function returns the relocations for .pdata
382 // and the pointer to "runtime function" structs.
383 static bool getPDataSection(const COFFObjectFile *Obj,
384                             std::vector<RelocationRef> &Rels,
385                             const RuntimeFunction *&RFStart, int &NumRFs) {
386   for (section_iterator SI = Obj->section_begin(), SE = Obj->section_end();
387        SI != SE; ++SI) {
388     StringRef Name;
389     if (error(SI->getName(Name)))
390       continue;
391     if (Name != ".pdata")
392       continue;
393
394     const coff_section *Pdata = Obj->getCOFFSection(SI);
395     for (relocation_iterator RI = SI->relocation_begin(),
396                              RE = SI->relocation_end();
397          RI != RE; ++RI)
398       Rels.push_back(*RI);
399
400     // Sort relocations by address.
401     std::sort(Rels.begin(), Rels.end(), RelocAddressLess);
402
403     ArrayRef<uint8_t> Contents;
404     if (error(Obj->getSectionContents(Pdata, Contents)))
405       continue;
406     if (Contents.empty())
407       continue;
408
409     RFStart = reinterpret_cast<const RuntimeFunction *>(Contents.data());
410     NumRFs = Contents.size() / sizeof(RuntimeFunction);
411     return true;
412   }
413   return false;
414 }
415
416 static void printWin64EHUnwindInfo(const Win64EH::UnwindInfo *UI) {
417   // The casts to int are required in order to output the value as number.
418   // Without the casts the value would be interpreted as char data (which
419   // results in garbage output).
420   outs() << "  Version: " << static_cast<int>(UI->getVersion()) << "\n";
421   outs() << "  Flags: " << static_cast<int>(UI->getFlags());
422   if (UI->getFlags()) {
423     if (UI->getFlags() & UNW_ExceptionHandler)
424       outs() << " UNW_ExceptionHandler";
425     if (UI->getFlags() & UNW_TerminateHandler)
426       outs() << " UNW_TerminateHandler";
427     if (UI->getFlags() & UNW_ChainInfo)
428       outs() << " UNW_ChainInfo";
429   }
430   outs() << "\n";
431   outs() << "  Size of prolog: " << static_cast<int>(UI->PrologSize) << "\n";
432   outs() << "  Number of Codes: " << static_cast<int>(UI->NumCodes) << "\n";
433   // Maybe this should move to output of UOP_SetFPReg?
434   if (UI->getFrameRegister()) {
435     outs() << "  Frame register: "
436            << getUnwindRegisterName(UI->getFrameRegister()) << "\n";
437     outs() << "  Frame offset: " << 16 * UI->getFrameOffset() << "\n";
438   } else {
439     outs() << "  No frame pointer used\n";
440   }
441   if (UI->getFlags() & (UNW_ExceptionHandler | UNW_TerminateHandler)) {
442     // FIXME: Output exception handler data
443   } else if (UI->getFlags() & UNW_ChainInfo) {
444     // FIXME: Output chained unwind info
445   }
446
447   if (UI->NumCodes)
448     outs() << "  Unwind Codes:\n";
449
450   printAllUnwindCodes(ArrayRef<UnwindCode>(&UI->UnwindCodes[0], UI->NumCodes));
451
452   outs() << "\n\n";
453   outs().flush();
454 }
455
456 /// Prints out the given RuntumeFunction struct for x64, assuming that Obj is
457 /// pointing to an executable file.
458 static void printRuntimeFunction(const COFFObjectFile *Obj,
459                                  const RuntimeFunction &RF) {
460   if (!RF.StartAddress)
461     return;
462   outs() << "Function Table:\n"
463          << format("  Start Address: 0x%04x\n", RF.StartAddress)
464          << format("  End Address: 0x%04x\n", RF.EndAddress)
465          << format("  Unwind Info Address: : 0x%04x\n\n", RF.UnwindInfoOffset);
466   uintptr_t addr;
467   if (Obj->getRvaPtr(RF.UnwindInfoOffset, addr))
468     return;
469   printWin64EHUnwindInfo(reinterpret_cast<const Win64EH::UnwindInfo *>(addr));
470 }
471
472 /// Prints out the given RuntumeFunction struct for x64, assuming that Obj is
473 /// pointing to an object file. Unlike executable, fields in RuntumeFunction
474 /// struct are filled with zeros, but instead there are relocations pointing to
475 /// them so that the linker will fill targets' RVAs to the fields at link
476 /// time. This function interprets the relocations to find the data to be used
477 /// in the resulting executable.
478 static void printRuntimeFunctionRels(const COFFObjectFile *Obj,
479                                      const RuntimeFunction &RF,
480                                      uint64_t SectionOffset,
481                                      const std::vector<RelocationRef> &Rels) {
482   outs() << "Function Table:\n";
483   outs() << "  Start Address: ";
484   printCOFFSymbolAddress(outs(), Rels,
485                          SectionOffset +
486                              /*offsetof(RuntimeFunction, StartAddress)*/ 0,
487                          RF.StartAddress);
488   outs() << "\n";
489
490   outs() << "  End Address: ";
491   printCOFFSymbolAddress(outs(), Rels,
492                          SectionOffset +
493                              /*offsetof(RuntimeFunction, EndAddress)*/ 4,
494                          RF.EndAddress);
495   outs() << "\n";
496
497   outs() << "  Unwind Info Address: ";
498   printCOFFSymbolAddress(outs(), Rels,
499                          SectionOffset +
500                              /*offsetof(RuntimeFunction, UnwindInfoOffset)*/ 8,
501                          RF.UnwindInfoOffset);
502   outs() << "\n";
503
504   ArrayRef<uint8_t> XContents;
505   uint64_t UnwindInfoOffset = 0;
506   if (error(getSectionContents(
507           Obj, Rels, SectionOffset +
508                          /*offsetof(RuntimeFunction, UnwindInfoOffset)*/ 8,
509           XContents, UnwindInfoOffset)))
510     return;
511   if (XContents.empty())
512     return;
513
514   UnwindInfoOffset += RF.UnwindInfoOffset;
515   if (UnwindInfoOffset > XContents.size())
516     return;
517
518   const Win64EH::UnwindInfo *UI = reinterpret_cast<const Win64EH::UnwindInfo *>(
519       XContents.data() + UnwindInfoOffset);
520   printWin64EHUnwindInfo(UI);
521 }
522
523 void llvm::printCOFFUnwindInfo(const COFFObjectFile *Obj) {
524   const coff_file_header *Header;
525   if (error(Obj->getCOFFHeader(Header)))
526     return;
527
528   if (Header->Machine != COFF::IMAGE_FILE_MACHINE_AMD64) {
529     errs() << "Unsupported image machine type "
530               "(currently only AMD64 is supported).\n";
531     return;
532   }
533
534   std::vector<RelocationRef> Rels;
535   const RuntimeFunction *RFStart;
536   int NumRFs;
537   if (!getPDataSection(Obj, Rels, RFStart, NumRFs))
538     return;
539   ArrayRef<RuntimeFunction> RFs(RFStart, NumRFs);
540
541   bool IsExecutable = Rels.empty();
542   if (IsExecutable) {
543     for (const RuntimeFunction &RF : RFs)
544       printRuntimeFunction(Obj, RF);
545     return;
546   }
547
548   for (const RuntimeFunction &RF : RFs) {
549     uint64_t SectionOffset =
550         std::distance(RFs.begin(), &RF) * sizeof(RuntimeFunction);
551     printRuntimeFunctionRels(Obj, RF, SectionOffset, Rels);
552   }
553 }
554
555 void llvm::printCOFFFileHeader(const object::ObjectFile *Obj) {
556   const COFFObjectFile *file = dyn_cast<const COFFObjectFile>(Obj);
557   printLoadConfiguration(file);
558   printImportTables(file);
559   printExportTable(file);
560 }