1 //===-- COFFDumper.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-readobj.
13 //===----------------------------------------------------------------------===//
15 #include "llvm-readobj.h"
16 #include "ObjDumper.h"
19 #include "StreamWriter.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/SmallString.h"
23 #include "llvm/Object/COFF.h"
24 #include "llvm/Object/ObjectFile.h"
25 #include "llvm/Support/Casting.h"
26 #include "llvm/Support/Compiler.h"
27 #include "llvm/Support/Format.h"
28 #include "llvm/Support/SourceMgr.h"
29 #include "llvm/Support/Win64EH.h"
30 #include "llvm/Support/raw_ostream.h"
31 #include "llvm/Support/system_error.h"
38 using namespace llvm::object;
39 using namespace llvm::Win64EH;
43 class COFFDumper : public ObjDumper {
45 COFFDumper(const llvm::object::COFFObjectFile *Obj, StreamWriter& Writer)
51 virtual void printFileHeaders() LLVM_OVERRIDE;
52 virtual void printSections() LLVM_OVERRIDE;
53 virtual void printRelocations() LLVM_OVERRIDE;
54 virtual void printSymbols() LLVM_OVERRIDE;
55 virtual void printDynamicSymbols() LLVM_OVERRIDE;
56 virtual void printUnwindInfo() LLVM_OVERRIDE;
59 void printSymbol(symbol_iterator SymI);
61 void printRelocation(section_iterator SecI, relocation_iterator RelI);
63 void printX64UnwindInfo();
65 void printRuntimeFunction(
66 const RuntimeFunction& RTF,
67 uint64_t OffsetInSection,
68 const std::vector<RelocationRef> &Rels);
71 const Win64EH::UnwindInfo& UI,
72 uint64_t OffsetInSection,
73 const std::vector<RelocationRef> &Rels);
75 void printUnwindCode(const Win64EH::UnwindInfo& UI, ArrayRef<UnwindCode> UCs);
77 void cacheRelocations();
79 error_code getSectionContents(
80 const std::vector<RelocationRef> &Rels,
82 ArrayRef<uint8_t> &Contents,
85 error_code getSection(
86 const std::vector<RelocationRef> &Rels,
88 const coff_section **Section,
91 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
93 const llvm::object::COFFObjectFile *Obj;
95 std::vector<RelocationRef> EmptyRelocs;
103 error_code createCOFFDumper(const object::ObjectFile *Obj,
104 StreamWriter& Writer,
105 OwningPtr<ObjDumper> &Result) {
106 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
108 return readobj_error::unsupported_obj_file_format;
110 Result.reset(new COFFDumper(COFFObj, Writer));
111 return readobj_error::success;
117 // Returns the name of the unwind code.
118 static StringRef getUnwindCodeTypeName(uint8_t Code) {
120 default: llvm_unreachable("Invalid unwind code");
121 case UOP_PushNonVol: return "PUSH_NONVOL";
122 case UOP_AllocLarge: return "ALLOC_LARGE";
123 case UOP_AllocSmall: return "ALLOC_SMALL";
124 case UOP_SetFPReg: return "SET_FPREG";
125 case UOP_SaveNonVol: return "SAVE_NONVOL";
126 case UOP_SaveNonVolBig: return "SAVE_NONVOL_FAR";
127 case UOP_SaveXMM128: return "SAVE_XMM128";
128 case UOP_SaveXMM128Big: return "SAVE_XMM128_FAR";
129 case UOP_PushMachFrame: return "PUSH_MACHFRAME";
133 // Returns the name of a referenced register.
134 static StringRef getUnwindRegisterName(uint8_t Reg) {
136 default: llvm_unreachable("Invalid register");
137 case 0: return "RAX";
138 case 1: return "RCX";
139 case 2: return "RDX";
140 case 3: return "RBX";
141 case 4: return "RSP";
142 case 5: return "RBP";
143 case 6: return "RSI";
144 case 7: return "RDI";
147 case 10: return "R10";
148 case 11: return "R11";
149 case 12: return "R12";
150 case 13: return "R13";
151 case 14: return "R14";
152 case 15: return "R15";
156 // Calculates the number of array slots required for the unwind code.
157 static unsigned getNumUsedSlots(const UnwindCode &UnwindCode) {
158 switch (UnwindCode.getUnwindOp()) {
159 default: llvm_unreachable("Invalid unwind code");
163 case UOP_PushMachFrame:
168 case UOP_SaveNonVolBig:
169 case UOP_SaveXMM128Big:
172 return (UnwindCode.getOpInfo() == 0) ? 2 : 3;
176 // Given a symbol sym this functions returns the address and section of it.
177 static error_code resolveSectionAndAddress(const COFFObjectFile *Obj,
178 const SymbolRef &Sym,
179 const coff_section *&ResolvedSection,
180 uint64_t &ResolvedAddr) {
181 if (error_code EC = Sym.getAddress(ResolvedAddr))
184 section_iterator iter(Obj->begin_sections());
185 if (error_code EC = Sym.getSection(iter))
188 ResolvedSection = Obj->getCOFFSection(iter);
189 return object_error::success;
192 // Given a vector of relocations for a section and an offset into this section
193 // the function returns the symbol used for the relocation at the offset.
194 static error_code resolveSymbol(const std::vector<RelocationRef> &Rels,
195 uint64_t Offset, SymbolRef &Sym) {
196 for (std::vector<RelocationRef>::const_iterator RelI = Rels.begin(),
198 RelI != RelE; ++RelI) {
200 if (error_code EC = RelI->getOffset(Ofs))
204 Sym = *RelI->getSymbol();
205 return readobj_error::success;
209 return readobj_error::unknown_symbol;
212 // Given a vector of relocations for a section and an offset into this section
213 // the function returns the name of the symbol used for the relocation at the
215 static error_code resolveSymbolName(const std::vector<RelocationRef> &Rels,
216 uint64_t Offset, StringRef &Name) {
218 if (error_code EC = resolveSymbol(Rels, Offset, Sym)) return EC;
219 if (error_code EC = Sym.getName(Name)) return EC;
220 return object_error::success;
223 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
224 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
225 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
226 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
227 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
228 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMV7 ),
229 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
230 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
231 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
232 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
233 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
234 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
235 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
236 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
237 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
238 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
239 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
240 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
241 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
242 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
243 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
244 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
247 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
248 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
249 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
250 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
251 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
252 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
253 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
254 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
255 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
256 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
257 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
258 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
259 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
260 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
261 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
262 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
265 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
266 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
267 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
268 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
269 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
270 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
271 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
272 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
273 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
274 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
275 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
276 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
279 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
280 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
281 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
282 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
283 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
284 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
285 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
286 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
287 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
290 static const EnumEntry<COFF::SectionCharacteristics>
291 ImageSectionCharacteristics[] = {
292 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
293 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
294 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
295 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
296 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
297 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
298 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
299 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
300 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
301 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
302 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
303 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
304 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
305 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
306 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
307 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
308 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
309 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
310 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
311 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
312 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
313 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
314 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
315 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
316 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
317 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
318 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
319 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
320 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
321 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
322 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
323 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
324 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
325 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
326 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
329 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
330 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
331 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
332 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
333 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
334 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
335 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
336 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
337 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
338 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
339 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
340 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
341 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
342 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
343 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
344 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
345 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
348 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
349 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
350 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
351 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
352 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
355 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
356 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
357 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
358 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
359 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
360 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
361 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
362 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
363 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
364 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
365 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
366 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
367 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
368 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
369 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
370 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
371 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
372 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
373 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
374 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
375 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
376 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
377 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
378 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
379 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
380 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
381 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
382 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
385 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
386 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
387 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
388 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
389 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
390 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
391 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
392 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
395 static const EnumEntry<COFF::WeakExternalCharacteristics>
396 WeakExternalCharacteristics[] = {
397 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
398 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
399 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
402 static const EnumEntry<unsigned> UnwindFlags[] = {
403 { "ExceptionHandler", Win64EH::UNW_ExceptionHandler },
404 { "TerminateHandler", Win64EH::UNW_TerminateHandler },
405 { "ChainInfo" , Win64EH::UNW_ChainInfo }
408 static const EnumEntry<unsigned> UnwindOpInfo[] = {
427 // Some additional COFF structures not defined by llvm::object.
429 struct coff_aux_function_definition {
430 support::ulittle32_t TagIndex;
431 support::ulittle32_t TotalSize;
432 support::ulittle32_t PointerToLineNumber;
433 support::ulittle32_t PointerToNextFunction;
437 struct coff_aux_weak_external_definition {
438 support::ulittle32_t TagIndex;
439 support::ulittle32_t Characteristics;
443 struct coff_aux_file_record {
447 struct coff_aux_clr_token {
448 support::ulittle8_t AuxType;
449 support::ulittle8_t Reserved;
450 support::ulittle32_t SymbolTableIndex;
455 static uint64_t getOffsetOfLSDA(const Win64EH::UnwindInfo& UI) {
456 return static_cast<const char*>(UI.getLanguageSpecificData())
457 - reinterpret_cast<const char*>(&UI);
460 static uint32_t getLargeSlotValue(ArrayRef<UnwindCode> UCs) {
464 return UCs[1].FrameOffset + (static_cast<uint32_t>(UCs[2].FrameOffset) << 16);
468 static error_code getSymbolAuxData(const COFFObjectFile *Obj,
469 const coff_symbol *Symbol, const T* &Aux) {
470 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
471 Aux = reinterpret_cast<const T*>(AuxData.data());
472 return readobj_error::success;
475 static std::string formatSymbol(const std::vector<RelocationRef> &Rels,
476 uint64_t Offset, uint32_t Disp) {
478 raw_string_ostream Str(Buffer);
481 if (resolveSymbolName(Rels, Offset, Sym)) {
482 Str << format(" (0x%" PRIX64 ")", Offset);
488 Str << format(" +0x%X (0x%" PRIX64 ")", Disp, Offset);
490 Str << format(" (0x%" PRIX64 ")", Offset);
496 // Given a vector of relocations for a section and an offset into this section
497 // the function resolves the symbol used for the relocation at the offset and
498 // returns the section content and the address inside the content pointed to
500 error_code COFFDumper::getSectionContents(
501 const std::vector<RelocationRef> &Rels, uint64_t Offset,
502 ArrayRef<uint8_t> &Contents, uint64_t &Addr) {
505 const coff_section *Section;
507 if (error_code EC = resolveSymbol(Rels, Offset, Sym))
509 if (error_code EC = resolveSectionAndAddress(Obj, Sym, Section, Addr))
511 if (error_code EC = Obj->getSectionContents(Section, Contents))
514 return object_error::success;
517 error_code COFFDumper::getSection(
518 const std::vector<RelocationRef> &Rels, uint64_t Offset,
519 const coff_section **SectionPtr, uint64_t *AddrPtr) {
522 if (error_code EC = resolveSymbol(Rels, Offset, Sym))
525 const coff_section *Section;
527 if (error_code EC = resolveSectionAndAddress(Obj, Sym, Section, Addr))
531 *SectionPtr = Section;
535 return object_error::success;
538 void COFFDumper::cacheRelocations() {
540 for (section_iterator SecI = Obj->begin_sections(),
541 SecE = Obj->end_sections();
542 SecI != SecE; SecI.increment(EC)) {
546 const coff_section *Section = Obj->getCOFFSection(SecI);
548 for (relocation_iterator RelI = SecI->begin_relocations(),
549 RelE = SecI->end_relocations();
550 RelI != RelE; RelI.increment(EC)) {
554 RelocMap[Section].push_back(*RelI);
557 // Sort relocations by address.
558 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
563 void COFFDumper::printFileHeaders() {
565 const coff_file_header *COFFHeader = 0;
566 if (error(Obj->getCOFFHeader(COFFHeader)))
569 time_t TDS = COFFHeader->TimeDateStamp;
570 char FormattedTime[20] = { };
571 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
574 DictScope D(W, "ImageFileHeader");
575 W.printEnum ("Machine", COFFHeader->Machine,
576 makeArrayRef(ImageFileMachineType));
577 W.printNumber("SectionCount", COFFHeader->NumberOfSections);
578 W.printHex ("TimeDateStamp", FormattedTime, COFFHeader->TimeDateStamp);
579 W.printHex ("PointerToSymbolTable", COFFHeader->PointerToSymbolTable);
580 W.printNumber("SymbolCount", COFFHeader->NumberOfSymbols);
581 W.printNumber("OptionalHeaderSize", COFFHeader->SizeOfOptionalHeader);
582 W.printFlags ("Characteristics", COFFHeader->Characteristics,
583 makeArrayRef(ImageFileCharacteristics));
586 // Print PE header. This header does not exist if this is an object file and
587 // not an executable.
588 const pe32_header *PEHeader = 0;
589 if (error(Obj->getPE32Header(PEHeader)))
593 DictScope D(W, "ImageOptionalHeader");
594 W.printNumber("MajorLinkerVersion", PEHeader->MajorLinkerVersion);
595 W.printNumber("MinorLinkerVersion", PEHeader->MinorLinkerVersion);
596 W.printNumber("SizeOfCode", PEHeader->SizeOfCode);
597 W.printNumber("SizeOfInitializedData", PEHeader->SizeOfInitializedData);
598 W.printNumber("SizeOfUninitializedData", PEHeader->SizeOfUninitializedData);
599 W.printHex ("AddressOfEntryPoint", PEHeader->AddressOfEntryPoint);
600 W.printHex ("BaseOfCode", PEHeader->BaseOfCode);
601 W.printHex ("BaseOfData", PEHeader->BaseOfData);
602 W.printHex ("ImageBase", PEHeader->ImageBase);
603 W.printNumber("SectionAlignment", PEHeader->SectionAlignment);
604 W.printNumber("FileAlignment", PEHeader->FileAlignment);
605 W.printNumber("MajorOperatingSystemVersion",
606 PEHeader->MajorOperatingSystemVersion);
607 W.printNumber("MinorOperatingSystemVersion",
608 PEHeader->MinorOperatingSystemVersion);
609 W.printNumber("MajorImageVersion", PEHeader->MajorImageVersion);
610 W.printNumber("MinorImageVersion", PEHeader->MinorImageVersion);
611 W.printNumber("MajorSubsystemVersion", PEHeader->MajorSubsystemVersion);
612 W.printNumber("MinorSubsystemVersion", PEHeader->MinorSubsystemVersion);
613 W.printNumber("SizeOfImage", PEHeader->SizeOfImage);
614 W.printNumber("SizeOfHeaders", PEHeader->SizeOfHeaders);
615 W.printEnum ("Subsystem", PEHeader->Subsystem,
616 makeArrayRef(PEWindowsSubsystem));
617 W.printFlags ("Subsystem", PEHeader->DLLCharacteristics,
618 makeArrayRef(PEDLLCharacteristics));
619 W.printNumber("SizeOfStackReserve", PEHeader->SizeOfStackReserve);
620 W.printNumber("SizeOfStackCommit", PEHeader->SizeOfStackCommit);
621 W.printNumber("SizeOfHeapReserve", PEHeader->SizeOfHeapReserve);
622 W.printNumber("SizeOfHeapCommit", PEHeader->SizeOfHeapCommit);
623 W.printNumber("NumberOfRvaAndSize", PEHeader->NumberOfRvaAndSize);
627 void COFFDumper::printSections() {
630 ListScope SectionsD(W, "Sections");
631 int SectionNumber = 0;
632 for (section_iterator SecI = Obj->begin_sections(),
633 SecE = Obj->end_sections();
634 SecI != SecE; SecI.increment(EC)) {
639 const coff_section *Section = Obj->getCOFFSection(SecI);
642 if (error(SecI->getName(Name)))
645 DictScope D(W, "Section");
646 W.printNumber("Number", SectionNumber);
647 W.printBinary("Name", Name, Section->Name);
648 W.printHex ("VirtualSize", Section->VirtualSize);
649 W.printHex ("VirtualAddress", Section->VirtualAddress);
650 W.printNumber("RawDataSize", Section->SizeOfRawData);
651 W.printHex ("PointerToRawData", Section->PointerToRawData);
652 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
653 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
654 W.printNumber("RelocationCount", Section->NumberOfRelocations);
655 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
656 W.printFlags ("Characteristics", Section->Characteristics,
657 makeArrayRef(ImageSectionCharacteristics),
658 COFF::SectionCharacteristics(0x00F00000));
660 if (opts::SectionRelocations) {
661 ListScope D(W, "Relocations");
662 for (relocation_iterator RelI = SecI->begin_relocations(),
663 RelE = SecI->end_relocations();
664 RelI != RelE; RelI.increment(EC)) {
665 if (error(EC)) break;
667 printRelocation(SecI, RelI);
671 if (opts::SectionSymbols) {
672 ListScope D(W, "Symbols");
673 for (symbol_iterator SymI = Obj->begin_symbols(),
674 SymE = Obj->end_symbols();
675 SymI != SymE; SymI.increment(EC)) {
676 if (error(EC)) break;
678 bool Contained = false;
679 if (SecI->containsSymbol(*SymI, Contained) || !Contained)
686 if (opts::SectionData) {
688 if (error(SecI->getContents(Data))) break;
690 W.printBinaryBlock("SectionData", Data);
695 void COFFDumper::printRelocations() {
696 ListScope D(W, "Relocations");
699 int SectionNumber = 0;
700 for (section_iterator SecI = Obj->begin_sections(),
701 SecE = Obj->end_sections();
702 SecI != SecE; SecI.increment(EC)) {
708 if (error(SecI->getName(Name)))
711 bool PrintedGroup = false;
712 for (relocation_iterator RelI = SecI->begin_relocations(),
713 RelE = SecI->end_relocations();
714 RelI != RelE; RelI.increment(EC)) {
715 if (error(EC)) break;
718 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
723 printRelocation(SecI, RelI);
728 W.startLine() << "}\n";
733 void COFFDumper::printRelocation(section_iterator SecI,
734 relocation_iterator RelI) {
737 SmallString<32> RelocName;
738 StringRef SymbolName;
740 if (error(RelI->getOffset(Offset))) return;
741 if (error(RelI->getType(RelocType))) return;
742 if (error(RelI->getTypeName(RelocName))) return;
743 symbol_iterator Symbol = RelI->getSymbol();
744 if (error(Symbol->getName(SymbolName))) return;
745 if (error(SecI->getContents(Contents))) return;
747 if (opts::ExpandRelocs) {
748 DictScope Group(W, "Relocation");
749 W.printHex("Offset", Offset);
750 W.printNumber("Type", RelocName, RelocType);
751 W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
753 raw_ostream& OS = W.startLine();
756 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
761 void COFFDumper::printSymbols() {
762 ListScope Group(W, "Symbols");
765 for (symbol_iterator SymI = Obj->begin_symbols(),
766 SymE = Obj->end_symbols();
767 SymI != SymE; SymI.increment(EC)) {
768 if (error(EC)) break;
774 void COFFDumper::printDynamicSymbols() {
775 ListScope Group(W, "DynamicSymbols");
778 void COFFDumper::printSymbol(symbol_iterator SymI) {
779 DictScope D(W, "Symbol");
781 const coff_symbol *Symbol = Obj->getCOFFSymbol(SymI);
782 const coff_section *Section;
783 if (error_code EC = Obj->getSection(Symbol->SectionNumber, Section)) {
784 W.startLine() << "Invalid section number: " << EC.message() << "\n";
789 StringRef SymbolName;
790 if (Obj->getSymbolName(Symbol, SymbolName))
793 StringRef SectionName = "";
795 Obj->getSectionName(Section, SectionName);
797 W.printString("Name", SymbolName);
798 W.printNumber("Value", Symbol->Value);
799 W.printNumber("Section", SectionName, Symbol->SectionNumber);
800 W.printEnum ("BaseType", Symbol->getBaseType(), makeArrayRef(ImageSymType));
801 W.printEnum ("ComplexType", Symbol->getComplexType(),
802 makeArrayRef(ImageSymDType));
803 W.printEnum ("StorageClass", Symbol->StorageClass,
804 makeArrayRef(ImageSymClass));
805 W.printNumber("AuxSymbolCount", Symbol->NumberOfAuxSymbols);
807 for (unsigned I = 0; I < Symbol->NumberOfAuxSymbols; ++I) {
808 if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
809 Symbol->getBaseType() == COFF::IMAGE_SYM_TYPE_NULL &&
810 Symbol->getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION &&
811 Symbol->SectionNumber > 0) {
812 const coff_aux_function_definition *Aux;
813 if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
816 DictScope AS(W, "AuxFunctionDef");
817 W.printNumber("TagIndex", Aux->TagIndex);
818 W.printNumber("TotalSize", Aux->TotalSize);
819 W.printHex("PointerToLineNumber", Aux->PointerToLineNumber);
820 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
821 W.printBinary("Unused", makeArrayRef(Aux->Unused));
824 Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL ||
825 (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
826 Symbol->SectionNumber == 0 &&
827 Symbol->Value == 0)) {
828 const coff_aux_weak_external_definition *Aux;
829 if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
832 const coff_symbol *Linked;
833 StringRef LinkedName;
835 if ((EC = Obj->getSymbol(Aux->TagIndex, Linked)) ||
836 (EC = Obj->getSymbolName(Linked, LinkedName))) {
841 DictScope AS(W, "AuxWeakExternal");
842 W.printNumber("Linked", LinkedName, Aux->TagIndex);
843 W.printEnum ("Search", Aux->Characteristics,
844 makeArrayRef(WeakExternalCharacteristics));
845 W.printBinary("Unused", Aux->Unused);
847 } else if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_FILE) {
848 const coff_aux_file_record *Aux;
849 if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
852 DictScope AS(W, "AuxFileRecord");
853 W.printString("FileName", StringRef(Aux->FileName));
855 } else if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_STATIC ||
856 (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
857 Symbol->SectionNumber != COFF::IMAGE_SYM_UNDEFINED)) {
858 const coff_aux_section_definition *Aux;
859 if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
862 DictScope AS(W, "AuxSectionDef");
863 W.printNumber("Length", Aux->Length);
864 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
865 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
866 W.printHex("Checksum", Aux->CheckSum);
867 W.printNumber("Number", Aux->Number);
868 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
869 W.printBinary("Unused", makeArrayRef(Aux->Unused));
871 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
872 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
873 const coff_section *Assoc;
876 if ((EC = Obj->getSection(Aux->Number, Assoc)) ||
877 (EC = Obj->getSectionName(Assoc, AssocName))) {
882 W.printNumber("AssocSection", AssocName, Aux->Number);
884 } else if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_CLR_TOKEN) {
885 const coff_aux_clr_token *Aux;
886 if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
889 DictScope AS(W, "AuxCLRToken");
890 W.printNumber("AuxType", Aux->AuxType);
891 W.printNumber("Reserved", Aux->Reserved);
892 W.printNumber("SymbolTableIndex", Aux->SymbolTableIndex);
893 W.printBinary("Unused", Aux->Unused);
896 W.startLine() << "<unhandled auxiliary record>\n";
901 void COFFDumper::printUnwindInfo() {
902 const coff_file_header *Header;
903 if (error(Obj->getCOFFHeader(Header)))
906 ListScope D(W, "UnwindInformation");
907 if (Header->Machine != COFF::IMAGE_FILE_MACHINE_AMD64) {
908 W.startLine() << "Unsupported image machine type "
909 "(currently only AMD64 is supported).\n";
913 printX64UnwindInfo();
916 void COFFDumper::printX64UnwindInfo() {
918 for (section_iterator SecI = Obj->begin_sections(),
919 SecE = Obj->end_sections();
920 SecI != SecE; SecI.increment(EC)) {
921 if (error(EC)) break;
924 if (error(SecI->getName(Name)))
926 if (Name != ".pdata" && !Name.startswith(".pdata$"))
929 const coff_section *PData = Obj->getCOFFSection(SecI);
931 ArrayRef<uint8_t> Contents;
932 if (error(Obj->getSectionContents(PData, Contents)) ||
936 ArrayRef<RuntimeFunction> RFs(
937 reinterpret_cast<const RuntimeFunction *>(Contents.data()),
938 Contents.size() / sizeof(RuntimeFunction));
940 for (const RuntimeFunction *I = RFs.begin(), *E = RFs.end(); I < E; ++I) {
941 const uint64_t OffsetInSection = std::distance(RFs.begin(), I)
942 * sizeof(RuntimeFunction);
944 printRuntimeFunction(*I, OffsetInSection, RelocMap[PData]);
949 void COFFDumper::printRuntimeFunction(
950 const RuntimeFunction& RTF,
951 uint64_t OffsetInSection,
952 const std::vector<RelocationRef> &Rels) {
954 DictScope D(W, "RuntimeFunction");
955 W.printString("StartAddress",
956 formatSymbol(Rels, OffsetInSection + 0, RTF.StartAddress));
957 W.printString("EndAddress",
958 formatSymbol(Rels, OffsetInSection + 4, RTF.EndAddress));
959 W.printString("UnwindInfoAddress",
960 formatSymbol(Rels, OffsetInSection + 8, RTF.UnwindInfoOffset));
962 const coff_section* XData = 0;
963 uint64_t UnwindInfoOffset = 0;
964 if (error(getSection(Rels, OffsetInSection + 8, &XData, &UnwindInfoOffset)))
967 ArrayRef<uint8_t> XContents;
968 if (error(Obj->getSectionContents(XData, XContents)) || XContents.empty())
971 UnwindInfoOffset += RTF.UnwindInfoOffset;
972 if (UnwindInfoOffset > XContents.size())
975 const Win64EH::UnwindInfo *UI =
976 reinterpret_cast<const Win64EH::UnwindInfo *>(
977 XContents.data() + UnwindInfoOffset);
979 printUnwindInfo(*UI, UnwindInfoOffset, RelocMap[XData]);
982 void COFFDumper::printUnwindInfo(
983 const Win64EH::UnwindInfo& UI,
984 uint64_t OffsetInSection,
985 const std::vector<RelocationRef> &Rels) {
986 DictScope D(W, "UnwindInfo");
987 W.printNumber("Version", UI.getVersion());
988 W.printFlags("Flags", UI.getFlags(), makeArrayRef(UnwindFlags));
989 W.printNumber("PrologSize", UI.PrologSize);
990 if (UI.getFrameRegister() != 0) {
991 W.printEnum("FrameRegister", UI.getFrameRegister(),
992 makeArrayRef(UnwindOpInfo));
993 W.printHex("FrameOffset", UI.getFrameOffset());
995 W.printString("FrameRegister", StringRef("-"));
996 W.printString("FrameOffset", StringRef("-"));
999 W.printNumber("UnwindCodeCount", UI.NumCodes);
1001 ListScope CodesD(W, "UnwindCodes");
1002 ArrayRef<UnwindCode> UCs(&UI.UnwindCodes[0], UI.NumCodes);
1003 for (const UnwindCode *I = UCs.begin(), *E = UCs.end(); I < E; ++I) {
1004 unsigned UsedSlots = getNumUsedSlots(*I);
1005 if (UsedSlots > UCs.size()) {
1006 errs() << "Corrupt unwind data";
1009 printUnwindCode(UI, ArrayRef<UnwindCode>(I, E));
1014 uint64_t LSDAOffset = OffsetInSection + getOffsetOfLSDA(UI);
1015 if (UI.getFlags() & (UNW_ExceptionHandler | UNW_TerminateHandler)) {
1016 W.printString("Handler", formatSymbol(Rels, LSDAOffset,
1017 UI.getLanguageSpecificHandlerOffset()));
1018 } else if (UI.getFlags() & UNW_ChainInfo) {
1019 const RuntimeFunction *Chained = UI.getChainedFunctionEntry();
1021 DictScope D(W, "Chained");
1022 W.printString("StartAddress", formatSymbol(Rels, LSDAOffset + 0,
1023 Chained->StartAddress));
1024 W.printString("EndAddress", formatSymbol(Rels, LSDAOffset + 4,
1025 Chained->EndAddress));
1026 W.printString("UnwindInfoAddress", formatSymbol(Rels, LSDAOffset + 8,
1027 Chained->UnwindInfoOffset));
1032 // Prints one unwind code. Because an unwind code can occupy up to 3 slots in
1033 // the unwind codes array, this function requires that the correct number of
1034 // slots is provided.
1035 void COFFDumper::printUnwindCode(const Win64EH::UnwindInfo& UI,
1036 ArrayRef<UnwindCode> UCs) {
1037 assert(UCs.size() >= getNumUsedSlots(UCs[0]));
1039 W.startLine() << format("0x%02X: ", unsigned(UCs[0].u.CodeOffset))
1040 << getUnwindCodeTypeName(UCs[0].getUnwindOp());
1042 uint32_t AllocSize = 0;
1044 switch (UCs[0].getUnwindOp()) {
1045 case UOP_PushNonVol:
1046 outs() << " reg=" << getUnwindRegisterName(UCs[0].getOpInfo());
1049 case UOP_AllocLarge:
1050 if (UCs[0].getOpInfo() == 0) {
1051 AllocSize = UCs[1].FrameOffset * 8;
1053 AllocSize = getLargeSlotValue(UCs);
1055 outs() << " size=" << AllocSize;
1057 case UOP_AllocSmall:
1058 outs() << " size=" << ((UCs[0].getOpInfo() + 1) * 8);
1061 if (UI.getFrameRegister() == 0) {
1062 outs() << " reg=<invalid>";
1064 outs() << " reg=" << getUnwindRegisterName(UI.getFrameRegister())
1065 << format(", offset=0x%X", UI.getFrameOffset() * 16);
1068 case UOP_SaveNonVol:
1069 outs() << " reg=" << getUnwindRegisterName(UCs[0].getOpInfo())
1070 << format(", offset=0x%X", UCs[1].FrameOffset * 8);
1072 case UOP_SaveNonVolBig:
1073 outs() << " reg=" << getUnwindRegisterName(UCs[0].getOpInfo())
1074 << format(", offset=0x%X", getLargeSlotValue(UCs));
1076 case UOP_SaveXMM128:
1077 outs() << " reg=XMM" << static_cast<uint32_t>(UCs[0].getOpInfo())
1078 << format(", offset=0x%X", UCs[1].FrameOffset * 16);
1080 case UOP_SaveXMM128Big:
1081 outs() << " reg=XMM" << static_cast<uint32_t>(UCs[0].getOpInfo())
1082 << format(", offset=0x%X", getLargeSlotValue(UCs));
1084 case UOP_PushMachFrame:
1085 outs() << " errcode=" << (UCs[0].getOpInfo() == 0 ? "no" : "yes");