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"
17 #include "ObjDumper.h"
18 #include "StreamWriter.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/SmallString.h"
21 #include "llvm/Object/COFF.h"
22 #include "llvm/Object/ObjectFile.h"
23 #include "llvm/Support/COFF.h"
24 #include "llvm/Support/Casting.h"
25 #include "llvm/Support/Compiler.h"
26 #include "llvm/Support/DataExtractor.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"
37 using namespace llvm::object;
38 using namespace llvm::Win64EH;
42 class COFFDumper : public ObjDumper {
44 COFFDumper(const llvm::object::COFFObjectFile *Obj, StreamWriter& Writer)
50 virtual void printFileHeaders() override;
51 virtual void printSections() override;
52 virtual void printRelocations() override;
53 virtual void printSymbols() override;
54 virtual void printDynamicSymbols() override;
55 virtual void printUnwindInfo() override;
58 void printSymbol(symbol_iterator SymI);
59 void printRelocation(section_iterator SecI, const RelocationRef &Reloc);
60 void printDataDirectory(uint32_t Index, const std::string &FieldName);
61 void printX64UnwindInfo();
63 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
64 void printBaseOfDataField(const pe32_header *Hdr);
65 void printBaseOfDataField(const pe32plus_header *Hdr);
67 void printRuntimeFunction(
68 const RuntimeFunction& RTF,
69 uint64_t OffsetInSection,
70 const std::vector<RelocationRef> &Rels);
73 const Win64EH::UnwindInfo& UI,
74 uint64_t OffsetInSection,
75 const std::vector<RelocationRef> &Rels);
77 void printUnwindCode(const Win64EH::UnwindInfo& UI, ArrayRef<UnwindCode> UCs);
79 void printCodeViewLineTables(section_iterator SecI);
81 void cacheRelocations();
83 error_code getSectionContents(
84 const std::vector<RelocationRef> &Rels,
86 ArrayRef<uint8_t> &Contents,
89 error_code getSection(
90 const std::vector<RelocationRef> &Rels,
92 const coff_section **Section,
95 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
97 const llvm::object::COFFObjectFile *Obj;
99 std::vector<RelocationRef> EmptyRelocs;
107 error_code createCOFFDumper(const object::ObjectFile *Obj, StreamWriter &Writer,
108 std::unique_ptr<ObjDumper> &Result) {
109 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
111 return readobj_error::unsupported_obj_file_format;
113 Result.reset(new COFFDumper(COFFObj, Writer));
114 return readobj_error::success;
120 // Returns the name of the unwind code.
121 static StringRef getUnwindCodeTypeName(uint8_t Code) {
123 default: llvm_unreachable("Invalid unwind code");
124 case UOP_PushNonVol: return "PUSH_NONVOL";
125 case UOP_AllocLarge: return "ALLOC_LARGE";
126 case UOP_AllocSmall: return "ALLOC_SMALL";
127 case UOP_SetFPReg: return "SET_FPREG";
128 case UOP_SaveNonVol: return "SAVE_NONVOL";
129 case UOP_SaveNonVolBig: return "SAVE_NONVOL_FAR";
130 case UOP_SaveXMM128: return "SAVE_XMM128";
131 case UOP_SaveXMM128Big: return "SAVE_XMM128_FAR";
132 case UOP_PushMachFrame: return "PUSH_MACHFRAME";
136 // Returns the name of a referenced register.
137 static StringRef getUnwindRegisterName(uint8_t Reg) {
139 default: llvm_unreachable("Invalid register");
140 case 0: return "RAX";
141 case 1: return "RCX";
142 case 2: return "RDX";
143 case 3: return "RBX";
144 case 4: return "RSP";
145 case 5: return "RBP";
146 case 6: return "RSI";
147 case 7: return "RDI";
150 case 10: return "R10";
151 case 11: return "R11";
152 case 12: return "R12";
153 case 13: return "R13";
154 case 14: return "R14";
155 case 15: return "R15";
159 // Calculates the number of array slots required for the unwind code.
160 static unsigned getNumUsedSlots(const UnwindCode &UnwindCode) {
161 switch (UnwindCode.getUnwindOp()) {
162 default: llvm_unreachable("Invalid unwind code");
166 case UOP_PushMachFrame:
171 case UOP_SaveNonVolBig:
172 case UOP_SaveXMM128Big:
175 return (UnwindCode.getOpInfo() == 0) ? 2 : 3;
179 // Given a symbol sym this functions returns the address and section of it.
180 static error_code resolveSectionAndAddress(const COFFObjectFile *Obj,
181 const SymbolRef &Sym,
182 const coff_section *&ResolvedSection,
183 uint64_t &ResolvedAddr) {
184 if (error_code EC = Sym.getAddress(ResolvedAddr))
187 section_iterator iter(Obj->section_begin());
188 if (error_code EC = Sym.getSection(iter))
191 ResolvedSection = Obj->getCOFFSection(iter);
192 return object_error::success;
195 // Given a vector of relocations for a section and an offset into this section
196 // the function returns the symbol used for the relocation at the offset.
197 static error_code resolveSymbol(const std::vector<RelocationRef> &Rels,
198 uint64_t Offset, SymbolRef &Sym) {
199 for (std::vector<RelocationRef>::const_iterator RelI = Rels.begin(),
201 RelI != RelE; ++RelI) {
203 if (error_code EC = RelI->getOffset(Ofs))
207 Sym = *RelI->getSymbol();
208 return readobj_error::success;
212 return readobj_error::unknown_symbol;
215 // Given a vector of relocations for a section and an offset into this section
216 // the function returns the name of the symbol used for the relocation at the
218 static error_code resolveSymbolName(const std::vector<RelocationRef> &Rels,
219 uint64_t Offset, StringRef &Name) {
221 if (error_code EC = resolveSymbol(Rels, Offset, Sym)) return EC;
222 if (error_code EC = Sym.getName(Name)) return EC;
223 return object_error::success;
226 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
227 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
228 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
229 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
230 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
231 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
232 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
233 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
234 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
235 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
236 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
237 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
238 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
239 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
240 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
241 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
242 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
243 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
244 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
245 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
246 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
247 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
250 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
251 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
252 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
253 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
254 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
255 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
256 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
257 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
258 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
259 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
260 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
261 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
262 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
263 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
264 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
265 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
268 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
269 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
270 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
271 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
272 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
273 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
274 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
275 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
276 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
277 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
278 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
279 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
282 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
283 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
284 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
285 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
286 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
287 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
288 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
289 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
290 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
291 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
294 static const EnumEntry<COFF::SectionCharacteristics>
295 ImageSectionCharacteristics[] = {
296 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
297 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
298 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
299 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
300 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
301 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
302 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
303 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
304 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
305 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
306 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
307 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
308 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
309 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
310 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
311 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
312 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
313 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
314 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
315 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
316 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
317 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
318 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
319 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
320 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
321 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
322 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
323 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
324 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
325 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
326 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
327 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
328 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
329 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
330 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
333 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
334 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
335 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
336 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
337 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
338 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
339 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
340 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
341 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
342 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
343 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
344 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
345 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
346 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
347 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
348 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
349 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
352 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
353 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
354 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
355 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
356 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
359 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
360 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
361 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
362 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
363 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
364 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
365 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
366 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
367 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
368 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
369 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
370 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
371 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
372 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
373 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
374 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
375 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
376 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
377 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
378 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
379 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
380 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
381 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
382 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
383 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
384 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
385 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
386 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
389 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
390 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
391 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
392 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
393 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
394 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
395 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
396 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
399 static const EnumEntry<COFF::WeakExternalCharacteristics>
400 WeakExternalCharacteristics[] = {
401 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
402 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
403 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
406 static const EnumEntry<unsigned> UnwindFlags[] = {
407 { "ExceptionHandler", Win64EH::UNW_ExceptionHandler },
408 { "TerminateHandler", Win64EH::UNW_TerminateHandler },
409 { "ChainInfo" , Win64EH::UNW_ChainInfo }
412 static const EnumEntry<unsigned> UnwindOpInfo[] = {
431 // Some additional COFF structures not defined by llvm::object.
433 struct coff_aux_function_definition {
434 support::ulittle32_t TagIndex;
435 support::ulittle32_t TotalSize;
436 support::ulittle32_t PointerToLineNumber;
437 support::ulittle32_t PointerToNextFunction;
441 struct coff_aux_weak_external_definition {
442 support::ulittle32_t TagIndex;
443 support::ulittle32_t Characteristics;
447 struct coff_aux_file_record {
451 struct coff_aux_clr_token {
452 support::ulittle8_t AuxType;
453 support::ulittle8_t Reserved;
454 support::ulittle32_t SymbolTableIndex;
459 static uint64_t getOffsetOfLSDA(const Win64EH::UnwindInfo& UI) {
460 return static_cast<const char*>(UI.getLanguageSpecificData())
461 - reinterpret_cast<const char*>(&UI);
464 static uint32_t getLargeSlotValue(ArrayRef<UnwindCode> UCs) {
468 return UCs[1].FrameOffset + (static_cast<uint32_t>(UCs[2].FrameOffset) << 16);
472 static error_code getSymbolAuxData(const COFFObjectFile *Obj,
473 const coff_symbol *Symbol, const T* &Aux) {
474 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
475 Aux = reinterpret_cast<const T*>(AuxData.data());
476 return readobj_error::success;
479 static std::string formatSymbol(const std::vector<RelocationRef> &Rels,
480 uint64_t Offset, uint32_t Disp) {
482 raw_string_ostream Str(Buffer);
485 if (resolveSymbolName(Rels, Offset, Sym)) {
486 Str << format(" (0x%" PRIX64 ")", Offset);
492 Str << format(" +0x%X (0x%" PRIX64 ")", Disp, Offset);
494 Str << format(" (0x%" PRIX64 ")", Offset);
500 // Given a vector of relocations for a section and an offset into this section
501 // the function resolves the symbol used for the relocation at the offset and
502 // returns the section content and the address inside the content pointed to
504 error_code COFFDumper::getSectionContents(
505 const std::vector<RelocationRef> &Rels, uint64_t Offset,
506 ArrayRef<uint8_t> &Contents, uint64_t &Addr) {
509 const coff_section *Section;
511 if (error_code EC = resolveSymbol(Rels, Offset, Sym))
513 if (error_code EC = resolveSectionAndAddress(Obj, Sym, Section, Addr))
515 if (error_code EC = Obj->getSectionContents(Section, Contents))
518 return object_error::success;
521 error_code COFFDumper::getSection(
522 const std::vector<RelocationRef> &Rels, uint64_t Offset,
523 const coff_section **SectionPtr, uint64_t *AddrPtr) {
526 if (error_code EC = resolveSymbol(Rels, Offset, Sym))
529 const coff_section *Section;
531 if (error_code EC = resolveSectionAndAddress(Obj, Sym, Section, Addr))
535 *SectionPtr = Section;
539 return object_error::success;
542 void COFFDumper::cacheRelocations() {
543 for (section_iterator SecI = Obj->section_begin(), SecE = Obj->section_end();
544 SecI != SecE; ++SecI) {
545 const coff_section *Section = Obj->getCOFFSection(SecI);
547 for (const RelocationRef &Reloc : SecI->relocations())
548 RelocMap[Section].push_back(Reloc);
550 // Sort relocations by address.
551 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
556 void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
557 const data_directory *Data;
558 if (Obj->getDataDirectory(Index, Data))
560 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
561 W.printHex(FieldName + "Size", Data->Size);
564 void COFFDumper::printFileHeaders() {
566 const coff_file_header *COFFHeader = 0;
567 if (error(Obj->getCOFFHeader(COFFHeader)))
570 time_t TDS = COFFHeader->TimeDateStamp;
571 char FormattedTime[20] = { };
572 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
575 DictScope D(W, "ImageFileHeader");
576 W.printEnum ("Machine", COFFHeader->Machine,
577 makeArrayRef(ImageFileMachineType));
578 W.printNumber("SectionCount", COFFHeader->NumberOfSections);
579 W.printHex ("TimeDateStamp", FormattedTime, COFFHeader->TimeDateStamp);
580 W.printHex ("PointerToSymbolTable", COFFHeader->PointerToSymbolTable);
581 W.printNumber("SymbolCount", COFFHeader->NumberOfSymbols);
582 W.printNumber("OptionalHeaderSize", COFFHeader->SizeOfOptionalHeader);
583 W.printFlags ("Characteristics", COFFHeader->Characteristics,
584 makeArrayRef(ImageFileCharacteristics));
587 // Print PE header. This header does not exist if this is an object file and
588 // not an executable.
589 const pe32_header *PEHeader = 0;
590 if (error(Obj->getPE32Header(PEHeader)))
593 printPEHeader<pe32_header>(PEHeader);
595 const pe32plus_header *PEPlusHeader = 0;
596 if (error(Obj->getPE32PlusHeader(PEPlusHeader)))
599 printPEHeader<pe32plus_header>(PEPlusHeader);
602 template <class PEHeader>
603 void COFFDumper::printPEHeader(const PEHeader *Hdr) {
604 DictScope D(W, "ImageOptionalHeader");
605 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
606 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
607 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
608 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
609 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
610 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
611 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
612 printBaseOfDataField(Hdr);
613 W.printHex ("ImageBase", Hdr->ImageBase);
614 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
615 W.printNumber("FileAlignment", Hdr->FileAlignment);
616 W.printNumber("MajorOperatingSystemVersion",
617 Hdr->MajorOperatingSystemVersion);
618 W.printNumber("MinorOperatingSystemVersion",
619 Hdr->MinorOperatingSystemVersion);
620 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
621 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
622 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
623 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
624 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
625 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
626 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
627 W.printFlags ("Subsystem", Hdr->DLLCharacteristics,
628 makeArrayRef(PEDLLCharacteristics));
629 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
630 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
631 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
632 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
633 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
635 if (Hdr->NumberOfRvaAndSize > 0) {
636 DictScope D(W, "DataDirectory");
637 static const char * const directory[] = {
638 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
639 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
640 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
641 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
644 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
645 printDataDirectory(i, directory[i]);
650 void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
651 W.printHex("BaseOfData", Hdr->BaseOfData);
654 void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
656 void COFFDumper::printCodeViewLineTables(section_iterator SecI) {
658 if (error(SecI->getContents(Data))) return;
660 SmallVector<StringRef, 10> FunctionNames;
661 StringMap<StringRef> FunctionLineTables;
662 StringRef FileIndexToStringOffsetTable;
663 StringRef StringTable;
665 ListScope D(W, "CodeViewLineTables");
667 DataExtractor DE(Data, true, 4);
669 Magic = DE.getU32(&Offset);
670 W.printHex("Magic", Magic);
671 if (Magic != COFF::DEBUG_SECTION_MAGIC) {
672 error(object_error::parse_failed);
676 bool Finished = false;
677 while (DE.isValidOffset(Offset) && !Finished) {
678 // The section consists of a number of subsection in the following format:
679 // |Type|PayloadSize|Payload...|
680 uint32_t SubSectionType = DE.getU32(&Offset),
681 PayloadSize = DE.getU32(&Offset);
682 ListScope S(W, "Subsection");
683 W.printHex("Type", SubSectionType);
684 W.printHex("PayloadSize", PayloadSize);
685 if (PayloadSize > Data.size() - Offset) {
686 error(object_error::parse_failed);
690 // Print the raw contents to simplify debugging if anything goes wrong
692 StringRef Contents = Data.substr(Offset, PayloadSize);
693 W.printBinaryBlock("Contents", Contents);
695 switch (SubSectionType) {
696 case COFF::DEBUG_LINE_TABLE_SUBSECTION: {
697 // Holds a PC to file:line table. Some data to parse this subsection is
698 // stored in the other subsections, so just check sanity and store the
699 // pointers for deferred processing.
701 if (PayloadSize < 12) {
702 // There should be at least three words to store two function
703 // relocations and size of the code.
704 error(object_error::parse_failed);
708 StringRef FunctionName;
709 if (error(resolveSymbolName(RelocMap[Obj->getCOFFSection(SecI)], Offset,
712 W.printString("FunctionName", FunctionName);
713 if (FunctionLineTables.count(FunctionName) != 0) {
714 // Saw debug info for this function already?
715 error(object_error::parse_failed);
719 FunctionLineTables[FunctionName] = Contents;
720 FunctionNames.push_back(FunctionName);
723 case COFF::DEBUG_STRING_TABLE_SUBSECTION:
724 if (PayloadSize == 0 || StringTable.data() != 0 ||
725 Contents.back() != '\0') {
726 // Empty or duplicate or non-null-terminated subsection.
727 error(object_error::parse_failed);
730 StringTable = Contents;
732 case COFF::DEBUG_INDEX_SUBSECTION:
733 // Holds the translation table from file indices
734 // to offsets in the string table.
736 if (PayloadSize == 0 || FileIndexToStringOffsetTable.data() != 0) {
737 // Empty or duplicate subsection.
738 error(object_error::parse_failed);
741 FileIndexToStringOffsetTable = Contents;
744 Offset += PayloadSize;
746 // Align the reading pointer by 4.
747 Offset += (-Offset) % 4;
751 // Dump the line tables now that we've read all the subsections and know all
752 // the required information.
753 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
754 StringRef Name = FunctionNames[I];
755 ListScope S(W, "FunctionLineTable");
756 W.printString("FunctionName", Name);
758 DataExtractor DE(FunctionLineTables[Name], true, 4);
759 uint32_t Offset = 8; // Skip relocations.
760 uint32_t FunctionSize = DE.getU32(&Offset);
761 W.printHex("CodeSize", FunctionSize);
762 while (DE.isValidOffset(Offset)) {
763 // For each range of lines with the same filename, we have a segment
764 // in the line table. The filename string is accessed using double
765 // indirection to the string table subsection using the index subsection.
766 uint32_t OffsetInIndex = DE.getU32(&Offset),
767 SegmentLength = DE.getU32(&Offset),
768 FullSegmentSize = DE.getU32(&Offset);
769 if (FullSegmentSize != 12 + 8 * SegmentLength) {
770 error(object_error::parse_failed);
774 uint32_t FilenameOffset;
776 DataExtractor SDE(FileIndexToStringOffsetTable, true, 4);
777 uint32_t OffsetInSDE = OffsetInIndex;
778 if (!SDE.isValidOffset(OffsetInSDE)) {
779 error(object_error::parse_failed);
782 FilenameOffset = SDE.getU32(&OffsetInSDE);
785 if (FilenameOffset == 0 || FilenameOffset + 1 >= StringTable.size() ||
786 StringTable.data()[FilenameOffset - 1] != '\0') {
787 // Each string in an F3 subsection should be preceded by a null
789 error(object_error::parse_failed);
793 StringRef Filename(StringTable.data() + FilenameOffset);
794 ListScope S(W, "FilenameSegment");
795 W.printString("Filename", Filename);
796 for (unsigned J = 0; J != SegmentLength && DE.isValidOffset(Offset);
798 // Then go the (PC, LineNumber) pairs. The line number is stored in the
799 // least significant 31 bits of the respective word in the table.
800 uint32_t PC = DE.getU32(&Offset),
801 LineNumber = DE.getU32(&Offset) & 0x7fffffff;
802 if (PC >= FunctionSize) {
803 error(object_error::parse_failed);
807 format("+0x%X", PC).snprint(Buffer, 32);
808 W.printNumber(Buffer, LineNumber);
814 void COFFDumper::printSections() {
815 ListScope SectionsD(W, "Sections");
816 int SectionNumber = 0;
817 for (section_iterator SecI = Obj->section_begin(),
818 SecE = Obj->section_end();
819 SecI != SecE; ++SecI) {
821 const coff_section *Section = Obj->getCOFFSection(SecI);
824 if (error(SecI->getName(Name)))
827 DictScope D(W, "Section");
828 W.printNumber("Number", SectionNumber);
829 W.printBinary("Name", Name, Section->Name);
830 W.printHex ("VirtualSize", Section->VirtualSize);
831 W.printHex ("VirtualAddress", Section->VirtualAddress);
832 W.printNumber("RawDataSize", Section->SizeOfRawData);
833 W.printHex ("PointerToRawData", Section->PointerToRawData);
834 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
835 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
836 W.printNumber("RelocationCount", Section->NumberOfRelocations);
837 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
838 W.printFlags ("Characteristics", Section->Characteristics,
839 makeArrayRef(ImageSectionCharacteristics),
840 COFF::SectionCharacteristics(0x00F00000));
842 if (opts::SectionRelocations) {
843 ListScope D(W, "Relocations");
844 for (const RelocationRef &Reloc : SecI->relocations())
845 printRelocation(SecI, Reloc);
848 if (opts::SectionSymbols) {
849 ListScope D(W, "Symbols");
850 for (symbol_iterator SymI = Obj->symbol_begin(),
851 SymE = Obj->symbol_end();
852 SymI != SymE; ++SymI) {
853 bool Contained = false;
854 if (SecI->containsSymbol(*SymI, Contained) || !Contained)
861 if (Name == ".debug$S" && opts::CodeViewLineTables)
862 printCodeViewLineTables(SecI);
864 if (opts::SectionData) {
866 if (error(SecI->getContents(Data))) break;
868 W.printBinaryBlock("SectionData", Data);
873 void COFFDumper::printRelocations() {
874 ListScope D(W, "Relocations");
876 int SectionNumber = 0;
877 for (section_iterator SecI = Obj->section_begin(),
878 SecE = Obj->section_end();
879 SecI != SecE; ++SecI) {
882 if (error(SecI->getName(Name)))
885 bool PrintedGroup = false;
886 for (const RelocationRef &Reloc : SecI->relocations()) {
888 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
893 printRelocation(SecI, Reloc);
898 W.startLine() << "}\n";
903 void COFFDumper::printRelocation(section_iterator SecI,
904 const RelocationRef &Reloc) {
907 SmallString<32> RelocName;
908 StringRef SymbolName;
910 if (error(Reloc.getOffset(Offset)))
912 if (error(Reloc.getType(RelocType)))
914 if (error(Reloc.getTypeName(RelocName)))
916 symbol_iterator Symbol = Reloc.getSymbol();
917 if (error(Symbol->getName(SymbolName)))
919 if (error(SecI->getContents(Contents)))
922 if (opts::ExpandRelocs) {
923 DictScope Group(W, "Relocation");
924 W.printHex("Offset", Offset);
925 W.printNumber("Type", RelocName, RelocType);
926 W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
928 raw_ostream& OS = W.startLine();
931 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
936 void COFFDumper::printSymbols() {
937 ListScope Group(W, "Symbols");
939 for (symbol_iterator SymI = Obj->symbol_begin(), SymE = Obj->symbol_end();
940 SymI != SymE; ++SymI)
944 void COFFDumper::printDynamicSymbols() {
945 ListScope Group(W, "DynamicSymbols");
948 void COFFDumper::printSymbol(symbol_iterator SymI) {
949 DictScope D(W, "Symbol");
951 const coff_symbol *Symbol = Obj->getCOFFSymbol(SymI);
952 const coff_section *Section;
953 if (error_code EC = Obj->getSection(Symbol->SectionNumber, Section)) {
954 W.startLine() << "Invalid section number: " << EC.message() << "\n";
959 StringRef SymbolName;
960 if (Obj->getSymbolName(Symbol, SymbolName))
963 StringRef SectionName = "";
965 Obj->getSectionName(Section, SectionName);
967 W.printString("Name", SymbolName);
968 W.printNumber("Value", Symbol->Value);
969 W.printNumber("Section", SectionName, Symbol->SectionNumber);
970 W.printEnum ("BaseType", Symbol->getBaseType(), makeArrayRef(ImageSymType));
971 W.printEnum ("ComplexType", Symbol->getComplexType(),
972 makeArrayRef(ImageSymDType));
973 W.printEnum ("StorageClass", Symbol->StorageClass,
974 makeArrayRef(ImageSymClass));
975 W.printNumber("AuxSymbolCount", Symbol->NumberOfAuxSymbols);
977 for (unsigned I = 0; I < Symbol->NumberOfAuxSymbols; ++I) {
978 if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
979 Symbol->getBaseType() == COFF::IMAGE_SYM_TYPE_NULL &&
980 Symbol->getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION &&
981 Symbol->SectionNumber > 0) {
982 const coff_aux_function_definition *Aux;
983 if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
986 DictScope AS(W, "AuxFunctionDef");
987 W.printNumber("TagIndex", Aux->TagIndex);
988 W.printNumber("TotalSize", Aux->TotalSize);
989 W.printHex("PointerToLineNumber", Aux->PointerToLineNumber);
990 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
991 W.printBinary("Unused", makeArrayRef(Aux->Unused));
994 Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL ||
995 (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
996 Symbol->SectionNumber == 0 &&
997 Symbol->Value == 0)) {
998 const coff_aux_weak_external_definition *Aux;
999 if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
1002 const coff_symbol *Linked;
1003 StringRef LinkedName;
1005 if ((EC = Obj->getSymbol(Aux->TagIndex, Linked)) ||
1006 (EC = Obj->getSymbolName(Linked, LinkedName))) {
1011 DictScope AS(W, "AuxWeakExternal");
1012 W.printNumber("Linked", LinkedName, Aux->TagIndex);
1013 W.printEnum ("Search", Aux->Characteristics,
1014 makeArrayRef(WeakExternalCharacteristics));
1015 W.printBinary("Unused", Aux->Unused);
1017 } else if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_FILE) {
1018 const coff_aux_file_record *Aux;
1019 if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
1022 DictScope AS(W, "AuxFileRecord");
1023 W.printString("FileName", StringRef(Aux->FileName));
1025 // C++/CLI creates external ABS symbols for non-const appdomain globals.
1026 // These are also followed by an auxiliary section definition.
1027 } else if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_STATIC ||
1028 (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
1029 Symbol->SectionNumber == COFF::IMAGE_SYM_ABSOLUTE)) {
1030 const coff_aux_section_definition *Aux;
1031 if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
1034 DictScope AS(W, "AuxSectionDef");
1035 W.printNumber("Length", Aux->Length);
1036 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
1037 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
1038 W.printHex("Checksum", Aux->CheckSum);
1039 W.printNumber("Number", Aux->Number);
1040 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
1041 W.printBinary("Unused", makeArrayRef(Aux->Unused));
1043 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
1044 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
1045 const coff_section *Assoc;
1046 StringRef AssocName;
1048 if ((EC = Obj->getSection(Aux->Number, Assoc)) ||
1049 (EC = Obj->getSectionName(Assoc, AssocName))) {
1054 W.printNumber("AssocSection", AssocName, Aux->Number);
1056 } else if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_CLR_TOKEN) {
1057 const coff_aux_clr_token *Aux;
1058 if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
1061 DictScope AS(W, "AuxCLRToken");
1062 W.printNumber("AuxType", Aux->AuxType);
1063 W.printNumber("Reserved", Aux->Reserved);
1064 W.printNumber("SymbolTableIndex", Aux->SymbolTableIndex);
1065 W.printBinary("Unused", Aux->Unused);
1068 W.startLine() << "<unhandled auxiliary record>\n";
1073 void COFFDumper::printUnwindInfo() {
1074 const coff_file_header *Header;
1075 if (error(Obj->getCOFFHeader(Header)))
1078 ListScope D(W, "UnwindInformation");
1079 if (Header->Machine != COFF::IMAGE_FILE_MACHINE_AMD64) {
1080 W.startLine() << "Unsupported image machine type "
1081 "(currently only AMD64 is supported).\n";
1085 printX64UnwindInfo();
1088 void COFFDumper::printX64UnwindInfo() {
1089 for (section_iterator SecI = Obj->section_begin(),
1090 SecE = Obj->section_end();
1091 SecI != SecE; ++SecI) {
1093 if (error(SecI->getName(Name)))
1095 if (Name != ".pdata" && !Name.startswith(".pdata$"))
1098 const coff_section *PData = Obj->getCOFFSection(SecI);
1100 ArrayRef<uint8_t> Contents;
1101 if (error(Obj->getSectionContents(PData, Contents)) ||
1105 ArrayRef<RuntimeFunction> RFs(
1106 reinterpret_cast<const RuntimeFunction *>(Contents.data()),
1107 Contents.size() / sizeof(RuntimeFunction));
1109 for (const RuntimeFunction *I = RFs.begin(), *E = RFs.end(); I < E; ++I) {
1110 const uint64_t OffsetInSection = std::distance(RFs.begin(), I)
1111 * sizeof(RuntimeFunction);
1113 printRuntimeFunction(*I, OffsetInSection, RelocMap[PData]);
1118 void COFFDumper::printRuntimeFunction(
1119 const RuntimeFunction& RTF,
1120 uint64_t OffsetInSection,
1121 const std::vector<RelocationRef> &Rels) {
1123 DictScope D(W, "RuntimeFunction");
1124 W.printString("StartAddress",
1125 formatSymbol(Rels, OffsetInSection + 0, RTF.StartAddress));
1126 W.printString("EndAddress",
1127 formatSymbol(Rels, OffsetInSection + 4, RTF.EndAddress));
1128 W.printString("UnwindInfoAddress",
1129 formatSymbol(Rels, OffsetInSection + 8, RTF.UnwindInfoOffset));
1131 const coff_section* XData = 0;
1132 uint64_t UnwindInfoOffset = 0;
1133 if (error(getSection(Rels, OffsetInSection + 8, &XData, &UnwindInfoOffset)))
1136 ArrayRef<uint8_t> XContents;
1137 if (error(Obj->getSectionContents(XData, XContents)) || XContents.empty())
1140 UnwindInfoOffset += RTF.UnwindInfoOffset;
1141 if (UnwindInfoOffset > XContents.size())
1144 const Win64EH::UnwindInfo *UI =
1145 reinterpret_cast<const Win64EH::UnwindInfo *>(
1146 XContents.data() + UnwindInfoOffset);
1148 printUnwindInfo(*UI, UnwindInfoOffset, RelocMap[XData]);
1151 void COFFDumper::printUnwindInfo(
1152 const Win64EH::UnwindInfo& UI,
1153 uint64_t OffsetInSection,
1154 const std::vector<RelocationRef> &Rels) {
1155 DictScope D(W, "UnwindInfo");
1156 W.printNumber("Version", UI.getVersion());
1157 W.printFlags("Flags", UI.getFlags(), makeArrayRef(UnwindFlags));
1158 W.printNumber("PrologSize", UI.PrologSize);
1159 if (UI.getFrameRegister() != 0) {
1160 W.printEnum("FrameRegister", UI.getFrameRegister(),
1161 makeArrayRef(UnwindOpInfo));
1162 W.printHex("FrameOffset", UI.getFrameOffset());
1164 W.printString("FrameRegister", StringRef("-"));
1165 W.printString("FrameOffset", StringRef("-"));
1168 W.printNumber("UnwindCodeCount", UI.NumCodes);
1170 ListScope CodesD(W, "UnwindCodes");
1171 ArrayRef<UnwindCode> UCs(&UI.UnwindCodes[0], UI.NumCodes);
1172 for (const UnwindCode *I = UCs.begin(), *E = UCs.end(); I < E; ++I) {
1173 unsigned UsedSlots = getNumUsedSlots(*I);
1174 if (UsedSlots > UCs.size()) {
1175 errs() << "Corrupt unwind data";
1178 printUnwindCode(UI, ArrayRef<UnwindCode>(I, E));
1183 uint64_t LSDAOffset = OffsetInSection + getOffsetOfLSDA(UI);
1184 if (UI.getFlags() & (UNW_ExceptionHandler | UNW_TerminateHandler)) {
1185 W.printString("Handler", formatSymbol(Rels, LSDAOffset,
1186 UI.getLanguageSpecificHandlerOffset()));
1187 } else if (UI.getFlags() & UNW_ChainInfo) {
1188 const RuntimeFunction *Chained = UI.getChainedFunctionEntry();
1190 DictScope D(W, "Chained");
1191 W.printString("StartAddress", formatSymbol(Rels, LSDAOffset + 0,
1192 Chained->StartAddress));
1193 W.printString("EndAddress", formatSymbol(Rels, LSDAOffset + 4,
1194 Chained->EndAddress));
1195 W.printString("UnwindInfoAddress", formatSymbol(Rels, LSDAOffset + 8,
1196 Chained->UnwindInfoOffset));
1201 // Prints one unwind code. Because an unwind code can occupy up to 3 slots in
1202 // the unwind codes array, this function requires that the correct number of
1203 // slots is provided.
1204 void COFFDumper::printUnwindCode(const Win64EH::UnwindInfo& UI,
1205 ArrayRef<UnwindCode> UCs) {
1206 assert(UCs.size() >= getNumUsedSlots(UCs[0]));
1208 W.startLine() << format("0x%02X: ", unsigned(UCs[0].u.CodeOffset))
1209 << getUnwindCodeTypeName(UCs[0].getUnwindOp());
1211 uint32_t AllocSize = 0;
1213 switch (UCs[0].getUnwindOp()) {
1214 case UOP_PushNonVol:
1215 outs() << " reg=" << getUnwindRegisterName(UCs[0].getOpInfo());
1218 case UOP_AllocLarge:
1219 if (UCs[0].getOpInfo() == 0) {
1220 AllocSize = UCs[1].FrameOffset * 8;
1222 AllocSize = getLargeSlotValue(UCs);
1224 outs() << " size=" << AllocSize;
1226 case UOP_AllocSmall:
1227 outs() << " size=" << ((UCs[0].getOpInfo() + 1) * 8);
1230 if (UI.getFrameRegister() == 0) {
1231 outs() << " reg=<invalid>";
1233 outs() << " reg=" << getUnwindRegisterName(UI.getFrameRegister())
1234 << format(", offset=0x%X", UI.getFrameOffset() * 16);
1237 case UOP_SaveNonVol:
1238 outs() << " reg=" << getUnwindRegisterName(UCs[0].getOpInfo())
1239 << format(", offset=0x%X", UCs[1].FrameOffset * 8);
1241 case UOP_SaveNonVolBig:
1242 outs() << " reg=" << getUnwindRegisterName(UCs[0].getOpInfo())
1243 << format(", offset=0x%X", getLargeSlotValue(UCs));
1245 case UOP_SaveXMM128:
1246 outs() << " reg=XMM" << static_cast<uint32_t>(UCs[0].getOpInfo())
1247 << format(", offset=0x%X", UCs[1].FrameOffset * 16);
1249 case UOP_SaveXMM128Big:
1250 outs() << " reg=XMM" << static_cast<uint32_t>(UCs[0].getOpInfo())
1251 << format(", offset=0x%X", getLargeSlotValue(UCs));
1253 case UOP_PushMachFrame:
1254 outs() << " errcode=" << (UCs[0].getOpInfo() == 0 ? "no" : "yes");