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 "ARMWinEHPrinter.h"
18 #include "ObjDumper.h"
19 #include "StreamWriter.h"
20 #include "Win64EHDumper.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/COFF.h"
26 #include "llvm/Support/Casting.h"
27 #include "llvm/Support/Compiler.h"
28 #include "llvm/Support/DataExtractor.h"
29 #include "llvm/Support/Format.h"
30 #include "llvm/Support/SourceMgr.h"
31 #include "llvm/Support/Win64EH.h"
32 #include "llvm/Support/raw_ostream.h"
35 #include <system_error>
39 using namespace llvm::object;
40 using namespace llvm::Win64EH;
44 class COFFDumper : public ObjDumper {
46 COFFDumper(const llvm::object::COFFObjectFile *Obj, StreamWriter& Writer)
52 void printFileHeaders() override;
53 void printSections() override;
54 void printRelocations() override;
55 void printSymbols() override;
56 void printDynamicSymbols() override;
57 void printUnwindInfo() override;
58 void printCOFFImports() override;
59 void printCOFFDirectives() override;
62 void printSymbol(const SymbolRef &Sym);
63 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc);
64 void printDataDirectory(uint32_t Index, const std::string &FieldName);
66 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
67 void printBaseOfDataField(const pe32_header *Hdr);
68 void printBaseOfDataField(const pe32plus_header *Hdr);
70 void printCodeViewLineTables(const SectionRef &Section);
72 void cacheRelocations();
74 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
76 std::error_code resolveSymbolName(const coff_section *Section,
77 uint64_t Offset, StringRef &Name);
78 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
80 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
82 const llvm::object::COFFObjectFile *Obj;
84 StringRef CVFileIndexToStringOffsetTable;
85 StringRef CVStringTable;
93 std::error_code createCOFFDumper(const object::ObjectFile *Obj,
95 std::unique_ptr<ObjDumper> &Result) {
96 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
98 return readobj_error::unsupported_obj_file_format;
100 Result.reset(new COFFDumper(COFFObj, Writer));
101 return readobj_error::success;
106 // Given a a section and an offset into this section the function returns the
107 // symbol used for the relocation at the offset.
108 std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
109 uint64_t Offset, SymbolRef &Sym) {
110 const auto &Relocations = RelocMap[Section];
111 for (const auto &Relocation : Relocations) {
112 uint64_t RelocationOffset;
113 if (std::error_code EC = Relocation.getOffset(RelocationOffset))
116 if (RelocationOffset == Offset) {
117 Sym = *Relocation.getSymbol();
118 return readobj_error::success;
121 return readobj_error::unknown_symbol;
124 // Given a section and an offset into this section the function returns the name
125 // of the symbol used for the relocation at the offset.
126 std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
130 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
132 if (std::error_code EC = Symbol.getName(Name))
134 return object_error::success;
137 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
138 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
139 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
140 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
141 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
142 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
143 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
144 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
145 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
146 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
147 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
148 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
149 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
150 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
151 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
152 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
153 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
154 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
155 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
156 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
157 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
158 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
161 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
162 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
163 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
164 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
165 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
166 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
167 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
168 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
169 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
170 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
171 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
172 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
173 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
174 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
175 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
176 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
179 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
180 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
181 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
182 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
183 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
184 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
185 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
186 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
187 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
188 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
189 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
190 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
193 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
194 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
195 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
196 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
197 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
198 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
199 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
200 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
201 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
202 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
203 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
204 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
207 static const EnumEntry<COFF::SectionCharacteristics>
208 ImageSectionCharacteristics[] = {
209 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
210 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
211 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
212 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
213 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
214 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
215 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
216 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
217 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
218 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
219 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
220 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
221 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
222 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
223 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
224 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
225 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
226 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
227 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
228 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
229 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
230 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
231 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
232 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
233 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
234 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
235 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
236 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
237 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
238 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
239 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
240 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
241 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
242 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
243 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
246 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
247 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
248 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
249 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
250 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
251 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
252 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
253 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
254 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
255 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
256 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
257 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
258 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
259 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
260 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
261 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
262 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
265 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
266 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
267 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
268 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
269 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
272 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
273 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
274 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
275 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
276 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
277 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
278 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
279 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
280 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
281 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
282 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
283 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
284 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
285 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
286 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
287 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
288 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
289 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
290 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
291 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
292 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
293 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
294 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
295 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
296 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
297 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
298 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
299 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
302 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
303 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
304 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
305 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
306 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
307 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
308 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
309 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
312 static const EnumEntry<COFF::WeakExternalCharacteristics>
313 WeakExternalCharacteristics[] = {
314 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
315 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
316 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
319 template <typename T>
320 static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
321 COFFSymbolRef Symbol,
322 uint8_t AuxSymbolIdx, const T *&Aux) {
323 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
324 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
325 Aux = reinterpret_cast<const T*>(AuxData.data());
326 return readobj_error::success;
329 void COFFDumper::cacheRelocations() {
330 for (const SectionRef &S : Obj->sections()) {
331 const coff_section *Section = Obj->getCOFFSection(S);
333 for (const RelocationRef &Reloc : S.relocations())
334 RelocMap[Section].push_back(Reloc);
336 // Sort relocations by address.
337 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
342 void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
343 const data_directory *Data;
344 if (Obj->getDataDirectory(Index, Data))
346 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
347 W.printHex(FieldName + "Size", Data->Size);
350 void COFFDumper::printFileHeaders() {
351 time_t TDS = Obj->getTimeDateStamp();
352 char FormattedTime[20] = { };
353 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
356 DictScope D(W, "ImageFileHeader");
357 W.printEnum ("Machine", Obj->getMachine(),
358 makeArrayRef(ImageFileMachineType));
359 W.printNumber("SectionCount", Obj->getNumberOfSections());
360 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
361 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
362 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
363 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
364 W.printFlags ("Characteristics", Obj->getCharacteristics(),
365 makeArrayRef(ImageFileCharacteristics));
368 // Print PE header. This header does not exist if this is an object file and
369 // not an executable.
370 const pe32_header *PEHeader = nullptr;
371 if (error(Obj->getPE32Header(PEHeader)))
374 printPEHeader<pe32_header>(PEHeader);
376 const pe32plus_header *PEPlusHeader = nullptr;
377 if (error(Obj->getPE32PlusHeader(PEPlusHeader)))
380 printPEHeader<pe32plus_header>(PEPlusHeader);
383 template <class PEHeader>
384 void COFFDumper::printPEHeader(const PEHeader *Hdr) {
385 DictScope D(W, "ImageOptionalHeader");
386 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
387 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
388 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
389 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
390 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
391 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
392 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
393 printBaseOfDataField(Hdr);
394 W.printHex ("ImageBase", Hdr->ImageBase);
395 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
396 W.printNumber("FileAlignment", Hdr->FileAlignment);
397 W.printNumber("MajorOperatingSystemVersion",
398 Hdr->MajorOperatingSystemVersion);
399 W.printNumber("MinorOperatingSystemVersion",
400 Hdr->MinorOperatingSystemVersion);
401 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
402 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
403 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
404 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
405 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
406 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
407 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
408 W.printFlags ("Subsystem", Hdr->DLLCharacteristics,
409 makeArrayRef(PEDLLCharacteristics));
410 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
411 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
412 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
413 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
414 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
416 if (Hdr->NumberOfRvaAndSize > 0) {
417 DictScope D(W, "DataDirectory");
418 static const char * const directory[] = {
419 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
420 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
421 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
422 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
425 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
426 printDataDirectory(i, directory[i]);
431 void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
432 W.printHex("BaseOfData", Hdr->BaseOfData);
435 void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
437 void COFFDumper::printCodeViewLineTables(const SectionRef &Section) {
439 if (error(Section.getContents(Data)))
442 SmallVector<StringRef, 10> FunctionNames;
443 StringMap<StringRef> FunctionLineTables;
445 ListScope D(W, "CodeViewLineTables");
447 DataExtractor DE(Data, true, 4);
449 Magic = DE.getU32(&Offset);
450 W.printHex("Magic", Magic);
451 if (Magic != COFF::DEBUG_SECTION_MAGIC) {
452 error(object_error::parse_failed);
456 bool Finished = false;
457 while (DE.isValidOffset(Offset) && !Finished) {
458 // The section consists of a number of subsection in the following format:
459 // |Type|PayloadSize|Payload...|
460 uint32_t SubSectionType = DE.getU32(&Offset),
461 PayloadSize = DE.getU32(&Offset);
462 ListScope S(W, "Subsection");
463 W.printHex("Type", SubSectionType);
464 W.printHex("PayloadSize", PayloadSize);
465 if (PayloadSize > Data.size() - Offset) {
466 error(object_error::parse_failed);
470 // Print the raw contents to simplify debugging if anything goes wrong
472 StringRef Contents = Data.substr(Offset, PayloadSize);
473 W.printBinaryBlock("Contents", Contents);
475 switch (SubSectionType) {
476 case COFF::DEBUG_LINE_TABLE_SUBSECTION: {
477 // Holds a PC to file:line table. Some data to parse this subsection is
478 // stored in the other subsections, so just check sanity and store the
479 // pointers for deferred processing.
481 if (PayloadSize < 12) {
482 // There should be at least three words to store two function
483 // relocations and size of the code.
484 error(object_error::parse_failed);
488 StringRef FunctionName;
489 if (error(resolveSymbolName(Obj->getCOFFSection(Section), Offset,
492 W.printString("FunctionName", FunctionName);
493 if (FunctionLineTables.count(FunctionName) != 0) {
494 // Saw debug info for this function already?
495 error(object_error::parse_failed);
499 FunctionLineTables[FunctionName] = Contents;
500 FunctionNames.push_back(FunctionName);
503 case COFF::DEBUG_STRING_TABLE_SUBSECTION:
504 if (PayloadSize == 0 || CVStringTable.data() != nullptr ||
505 Contents.back() != '\0') {
506 // Empty or duplicate or non-null-terminated subsection.
507 error(object_error::parse_failed);
510 CVStringTable = Contents;
512 case COFF::DEBUG_INDEX_SUBSECTION:
513 // Holds the translation table from file indices
514 // to offsets in the string table.
516 if (PayloadSize == 0 ||
517 CVFileIndexToStringOffsetTable.data() != nullptr) {
518 // Empty or duplicate subsection.
519 error(object_error::parse_failed);
522 CVFileIndexToStringOffsetTable = Contents;
525 Offset += PayloadSize;
527 // Align the reading pointer by 4.
528 Offset += (-Offset) % 4;
532 // Dump the line tables now that we've read all the subsections and know all
533 // the required information.
534 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
535 StringRef Name = FunctionNames[I];
536 ListScope S(W, "FunctionLineTable");
537 W.printString("FunctionName", Name);
539 DataExtractor DE(FunctionLineTables[Name], true, 4);
540 uint32_t Offset = 8; // Skip relocations.
541 uint32_t FunctionSize = DE.getU32(&Offset);
542 W.printHex("CodeSize", FunctionSize);
543 while (DE.isValidOffset(Offset)) {
544 // For each range of lines with the same filename, we have a segment
545 // in the line table. The filename string is accessed using double
546 // indirection to the string table subsection using the index subsection.
547 uint32_t OffsetInIndex = DE.getU32(&Offset),
548 SegmentLength = DE.getU32(&Offset),
549 FullSegmentSize = DE.getU32(&Offset);
550 if (FullSegmentSize != 12 + 8 * SegmentLength) {
551 error(object_error::parse_failed);
555 uint32_t FilenameOffset;
557 DataExtractor SDE(CVFileIndexToStringOffsetTable, true, 4);
558 uint32_t OffsetInSDE = OffsetInIndex;
559 if (!SDE.isValidOffset(OffsetInSDE)) {
560 error(object_error::parse_failed);
563 FilenameOffset = SDE.getU32(&OffsetInSDE);
566 if (FilenameOffset == 0 || FilenameOffset + 1 >= CVStringTable.size() ||
567 CVStringTable.data()[FilenameOffset - 1] != '\0') {
568 // Each string in an F3 subsection should be preceded by a null
570 error(object_error::parse_failed);
574 StringRef Filename(CVStringTable.data() + FilenameOffset);
575 ListScope S(W, "FilenameSegment");
576 W.printString("Filename", Filename);
577 for (unsigned J = 0; J != SegmentLength && DE.isValidOffset(Offset);
579 // Then go the (PC, LineNumber) pairs. The line number is stored in the
580 // least significant 31 bits of the respective word in the table.
581 uint32_t PC = DE.getU32(&Offset),
582 LineNumber = DE.getU32(&Offset) & 0x7fffffff;
583 if (PC >= FunctionSize) {
584 error(object_error::parse_failed);
588 format("+0x%X", PC).snprint(Buffer, 32);
589 W.printNumber(Buffer, LineNumber);
595 void COFFDumper::printSections() {
596 ListScope SectionsD(W, "Sections");
597 int SectionNumber = 0;
598 for (const SectionRef &Sec : Obj->sections()) {
600 const coff_section *Section = Obj->getCOFFSection(Sec);
603 if (error(Sec.getName(Name)))
606 DictScope D(W, "Section");
607 W.printNumber("Number", SectionNumber);
608 W.printBinary("Name", Name, Section->Name);
609 W.printHex ("VirtualSize", Section->VirtualSize);
610 W.printHex ("VirtualAddress", Section->VirtualAddress);
611 W.printNumber("RawDataSize", Section->SizeOfRawData);
612 W.printHex ("PointerToRawData", Section->PointerToRawData);
613 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
614 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
615 W.printNumber("RelocationCount", Section->NumberOfRelocations);
616 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
617 W.printFlags ("Characteristics", Section->Characteristics,
618 makeArrayRef(ImageSectionCharacteristics),
619 COFF::SectionCharacteristics(0x00F00000));
621 if (opts::SectionRelocations) {
622 ListScope D(W, "Relocations");
623 for (const RelocationRef &Reloc : Sec.relocations())
624 printRelocation(Sec, Reloc);
627 if (opts::SectionSymbols) {
628 ListScope D(W, "Symbols");
629 for (const SymbolRef &Symbol : Obj->symbols()) {
630 if (!Sec.containsSymbol(Symbol))
637 if (Name == ".debug$S" && opts::CodeViewLineTables)
638 printCodeViewLineTables(Sec);
640 if (opts::SectionData &&
641 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
643 if (error(Sec.getContents(Data)))
646 W.printBinaryBlock("SectionData", Data);
651 void COFFDumper::printRelocations() {
652 ListScope D(W, "Relocations");
654 int SectionNumber = 0;
655 for (const SectionRef &Section : Obj->sections()) {
658 if (error(Section.getName(Name)))
661 bool PrintedGroup = false;
662 for (const RelocationRef &Reloc : Section.relocations()) {
664 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
669 printRelocation(Section, Reloc);
674 W.startLine() << "}\n";
679 void COFFDumper::printRelocation(const SectionRef &Section,
680 const RelocationRef &Reloc) {
683 SmallString<32> RelocName;
684 StringRef SymbolName;
686 if (error(Reloc.getOffset(Offset)))
688 if (error(Reloc.getType(RelocType)))
690 if (error(Reloc.getTypeName(RelocName)))
692 symbol_iterator Symbol = Reloc.getSymbol();
693 if (error(Symbol->getName(SymbolName)))
695 if (error(Section.getContents(Contents)))
698 if (opts::ExpandRelocs) {
699 DictScope Group(W, "Relocation");
700 W.printHex("Offset", Offset);
701 W.printNumber("Type", RelocName, RelocType);
702 W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
704 raw_ostream& OS = W.startLine();
707 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
712 void COFFDumper::printSymbols() {
713 ListScope Group(W, "Symbols");
715 for (const SymbolRef &Symbol : Obj->symbols())
719 void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
721 static StringRef getSectionName(const llvm::object::COFFObjectFile *Obj,
722 COFFSymbolRef Symbol,
723 const coff_section *Section) {
725 StringRef SectionName;
726 Obj->getSectionName(Section, SectionName);
729 int32_t SectionNumber = Symbol.getSectionNumber();
730 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
731 return "IMAGE_SYM_DEBUG";
732 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
733 return "IMAGE_SYM_ABSOLUTE";
734 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
735 return "IMAGE_SYM_UNDEFINED";
739 void COFFDumper::printSymbol(const SymbolRef &Sym) {
740 DictScope D(W, "Symbol");
742 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
743 const coff_section *Section;
744 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
745 W.startLine() << "Invalid section number: " << EC.message() << "\n";
750 StringRef SymbolName;
751 if (Obj->getSymbolName(Symbol, SymbolName))
754 StringRef SectionName = getSectionName(Obj, Symbol, Section);
756 W.printString("Name", SymbolName);
757 W.printNumber("Value", Symbol.getValue());
758 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
759 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
760 W.printEnum ("ComplexType", Symbol.getComplexType(),
761 makeArrayRef(ImageSymDType));
762 W.printEnum ("StorageClass", Symbol.getStorageClass(),
763 makeArrayRef(ImageSymClass));
764 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
766 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
767 if (Symbol.isFunctionDefinition()) {
768 const coff_aux_function_definition *Aux;
769 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
772 DictScope AS(W, "AuxFunctionDef");
773 W.printNumber("TagIndex", Aux->TagIndex);
774 W.printNumber("TotalSize", Aux->TotalSize);
775 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
776 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
778 } else if (Symbol.isWeakExternal()) {
779 const coff_aux_weak_external *Aux;
780 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
783 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
784 StringRef LinkedName;
785 std::error_code EC = Linked.getError();
786 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
791 DictScope AS(W, "AuxWeakExternal");
792 W.printNumber("Linked", LinkedName, Aux->TagIndex);
793 W.printEnum ("Search", Aux->Characteristics,
794 makeArrayRef(WeakExternalCharacteristics));
796 } else if (Symbol.isFileRecord()) {
797 const char *FileName;
798 if (error(getSymbolAuxData(Obj, Symbol, I, FileName)))
801 DictScope AS(W, "AuxFileRecord");
803 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
804 Obj->getSymbolTableEntrySize());
805 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
807 } else if (Symbol.isSectionDefinition()) {
808 const coff_aux_section_definition *Aux;
809 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
812 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
814 DictScope AS(W, "AuxSectionDef");
815 W.printNumber("Length", Aux->Length);
816 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
817 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
818 W.printHex("Checksum", Aux->CheckSum);
819 W.printNumber("Number", AuxNumber);
820 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
822 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
823 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
824 const coff_section *Assoc;
827 if ((EC = Obj->getSection(AuxNumber, Assoc)) ||
828 (EC = Obj->getSectionName(Assoc, AssocName))) {
833 W.printNumber("AssocSection", AssocName, AuxNumber);
835 } else if (Symbol.isCLRToken()) {
836 const coff_aux_clr_token *Aux;
837 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
840 ErrorOr<COFFSymbolRef> ReferredSym =
841 Obj->getSymbol(Aux->SymbolTableIndex);
842 StringRef ReferredName;
843 std::error_code EC = ReferredSym.getError();
844 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
849 DictScope AS(W, "AuxCLRToken");
850 W.printNumber("AuxType", Aux->AuxType);
851 W.printNumber("Reserved", Aux->Reserved);
852 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
855 W.startLine() << "<unhandled auxiliary record>\n";
860 void COFFDumper::printUnwindInfo() {
861 ListScope D(W, "UnwindInformation");
862 switch (Obj->getMachine()) {
863 case COFF::IMAGE_FILE_MACHINE_AMD64: {
864 Win64EH::Dumper Dumper(W);
865 Win64EH::Dumper::SymbolResolver
866 Resolver = [](const object::coff_section *Section, uint64_t Offset,
867 SymbolRef &Symbol, void *user_data) -> std::error_code {
868 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
869 return Dumper->resolveSymbol(Section, Offset, Symbol);
871 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
872 Dumper.printData(Ctx);
875 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
876 ARM::WinEH::Decoder Decoder(W);
877 Decoder.dumpProcedureData(*Obj);
881 W.printEnum("unsupported Image Machine", Obj->getMachine(),
882 makeArrayRef(ImageFileMachineType));
887 void COFFDumper::printImportedSymbols(
888 iterator_range<imported_symbol_iterator> Range) {
889 for (const ImportedSymbolRef &I : Range) {
891 if (error(I.getSymbolName(Sym))) return;
893 if (error(I.getOrdinal(Ordinal))) return;
894 W.printNumber("Symbol", Sym, Ordinal);
898 void COFFDumper::printCOFFImports() {
900 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
901 DictScope Import(W, "Import");
903 if (error(I.getName(Name))) return;
904 W.printString("Name", Name);
906 if (error(I.getImportLookupTableRVA(Addr))) return;
907 W.printHex("ImportLookupTableRVA", Addr);
908 if (error(I.getImportAddressTableRVA(Addr))) return;
909 W.printHex("ImportAddressTableRVA", Addr);
910 printImportedSymbols(I.imported_symbols());
914 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
915 DictScope Import(W, "DelayImport");
917 if (error(I.getName(Name))) return;
918 W.printString("Name", Name);
919 const delay_import_directory_table_entry *Table;
920 if (error(I.getDelayImportTable(Table))) return;
921 W.printHex("Attributes", Table->Attributes);
922 W.printHex("ModuleHandle", Table->ModuleHandle);
923 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
924 W.printHex("ImportNameTable", Table->DelayImportNameTable);
925 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
926 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
927 printImportedSymbols(I.imported_symbols());
931 void COFFDumper::printCOFFDirectives() {
932 for (const SectionRef &Section : Obj->sections()) {
936 if (error(Section.getName(Name)))
938 if (Name != ".drectve")
941 if (error(Section.getContents(Contents)))
944 W.printString("Directive(s)", Contents);