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;
61 void printSymbol(const SymbolRef &Sym);
62 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc);
63 void printDataDirectory(uint32_t Index, const std::string &FieldName);
65 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
66 void printBaseOfDataField(const pe32_header *Hdr);
67 void printBaseOfDataField(const pe32plus_header *Hdr);
69 void printCodeViewLineTables(const SectionRef &Section);
71 void cacheRelocations();
73 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
75 std::error_code resolveSymbolName(const coff_section *Section,
76 uint64_t Offset, StringRef &Name);
78 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
80 const llvm::object::COFFObjectFile *Obj;
89 std::error_code createCOFFDumper(const object::ObjectFile *Obj,
91 std::unique_ptr<ObjDumper> &Result) {
92 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
94 return readobj_error::unsupported_obj_file_format;
96 Result.reset(new COFFDumper(COFFObj, Writer));
97 return readobj_error::success;
102 // Given a a section and an offset into this section the function returns the
103 // symbol used for the relocation at the offset.
104 std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
105 uint64_t Offset, SymbolRef &Sym) {
106 const auto &Relocations = RelocMap[Section];
107 for (const auto &Relocation : Relocations) {
108 uint64_t RelocationOffset;
109 if (std::error_code EC = Relocation.getOffset(RelocationOffset))
112 if (RelocationOffset == Offset) {
113 Sym = *Relocation.getSymbol();
114 return readobj_error::success;
117 return readobj_error::unknown_symbol;
120 // Given a section and an offset into this section the function returns the name
121 // of the symbol used for the relocation at the offset.
122 std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
126 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
128 if (std::error_code EC = Symbol.getName(Name))
130 return object_error::success;
133 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
134 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
135 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
136 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
137 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
138 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
139 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
140 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
141 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
142 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
143 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
144 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
145 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
146 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
147 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
148 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
149 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
150 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
151 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
152 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
153 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
154 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
157 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
158 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
159 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
160 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
161 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
162 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
163 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
164 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
165 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
166 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
167 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
168 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
169 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
170 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
171 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
172 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
175 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
176 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
177 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
178 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
179 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
180 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
181 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
182 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
183 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
184 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
185 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
186 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
189 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
190 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
191 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
192 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
193 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
194 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
195 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
196 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
197 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
198 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
199 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
200 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
203 static const EnumEntry<COFF::SectionCharacteristics>
204 ImageSectionCharacteristics[] = {
205 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
206 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
207 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
208 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
209 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
210 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
211 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
212 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
213 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
214 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
215 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
216 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
217 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
218 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
219 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
220 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
221 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
222 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
223 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
224 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
225 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
226 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
227 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
228 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
229 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
230 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
231 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
232 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
233 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
234 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
235 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
236 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
237 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
238 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
239 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
242 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
243 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
244 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
245 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
246 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
247 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
248 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
249 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
250 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
251 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
252 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
253 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
254 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
255 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
256 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
257 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
258 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
261 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
262 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
263 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
264 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
265 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
268 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
269 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
270 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
271 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
272 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
273 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
274 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
275 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
276 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
277 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
278 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
279 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
280 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
281 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
282 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
283 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
284 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
285 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
286 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
287 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
288 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
289 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
290 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
291 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
292 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
293 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
294 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
295 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
298 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
299 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
300 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
301 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
302 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
303 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
304 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
305 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
308 static const EnumEntry<COFF::WeakExternalCharacteristics>
309 WeakExternalCharacteristics[] = {
310 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
311 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
312 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
315 template <typename T>
316 static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
317 COFFSymbolRef Symbol,
318 uint8_t AuxSymbolIdx, const T *&Aux) {
319 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
320 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
321 Aux = reinterpret_cast<const T*>(AuxData.data());
322 return readobj_error::success;
325 void COFFDumper::cacheRelocations() {
326 for (const SectionRef &S : Obj->sections()) {
327 const coff_section *Section = Obj->getCOFFSection(S);
329 for (const RelocationRef &Reloc : S.relocations())
330 RelocMap[Section].push_back(Reloc);
332 // Sort relocations by address.
333 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
338 void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
339 const data_directory *Data;
340 if (Obj->getDataDirectory(Index, Data))
342 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
343 W.printHex(FieldName + "Size", Data->Size);
346 void COFFDumper::printFileHeaders() {
347 time_t TDS = Obj->getTimeDateStamp();
348 char FormattedTime[20] = { };
349 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
352 DictScope D(W, "ImageFileHeader");
353 W.printEnum ("Machine", Obj->getMachine(),
354 makeArrayRef(ImageFileMachineType));
355 W.printNumber("SectionCount", Obj->getNumberOfSections());
356 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
357 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
358 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
359 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
360 W.printFlags ("Characteristics", Obj->getCharacteristics(),
361 makeArrayRef(ImageFileCharacteristics));
364 // Print PE header. This header does not exist if this is an object file and
365 // not an executable.
366 const pe32_header *PEHeader = nullptr;
367 if (error(Obj->getPE32Header(PEHeader)))
370 printPEHeader<pe32_header>(PEHeader);
372 const pe32plus_header *PEPlusHeader = nullptr;
373 if (error(Obj->getPE32PlusHeader(PEPlusHeader)))
376 printPEHeader<pe32plus_header>(PEPlusHeader);
379 template <class PEHeader>
380 void COFFDumper::printPEHeader(const PEHeader *Hdr) {
381 DictScope D(W, "ImageOptionalHeader");
382 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
383 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
384 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
385 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
386 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
387 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
388 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
389 printBaseOfDataField(Hdr);
390 W.printHex ("ImageBase", Hdr->ImageBase);
391 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
392 W.printNumber("FileAlignment", Hdr->FileAlignment);
393 W.printNumber("MajorOperatingSystemVersion",
394 Hdr->MajorOperatingSystemVersion);
395 W.printNumber("MinorOperatingSystemVersion",
396 Hdr->MinorOperatingSystemVersion);
397 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
398 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
399 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
400 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
401 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
402 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
403 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
404 W.printFlags ("Subsystem", Hdr->DLLCharacteristics,
405 makeArrayRef(PEDLLCharacteristics));
406 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
407 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
408 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
409 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
410 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
412 if (Hdr->NumberOfRvaAndSize > 0) {
413 DictScope D(W, "DataDirectory");
414 static const char * const directory[] = {
415 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
416 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
417 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
418 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
421 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
422 printDataDirectory(i, directory[i]);
427 void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
428 W.printHex("BaseOfData", Hdr->BaseOfData);
431 void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
433 void COFFDumper::printCodeViewLineTables(const SectionRef &Section) {
435 if (error(Section.getContents(Data)))
438 SmallVector<StringRef, 10> FunctionNames;
439 StringMap<StringRef> FunctionLineTables;
440 StringRef FileIndexToStringOffsetTable;
441 StringRef StringTable;
443 ListScope D(W, "CodeViewLineTables");
445 DataExtractor DE(Data, true, 4);
447 Magic = DE.getU32(&Offset);
448 W.printHex("Magic", Magic);
449 if (Magic != COFF::DEBUG_SECTION_MAGIC) {
450 error(object_error::parse_failed);
454 bool Finished = false;
455 while (DE.isValidOffset(Offset) && !Finished) {
456 // The section consists of a number of subsection in the following format:
457 // |Type|PayloadSize|Payload...|
458 uint32_t SubSectionType = DE.getU32(&Offset),
459 PayloadSize = DE.getU32(&Offset);
460 ListScope S(W, "Subsection");
461 W.printHex("Type", SubSectionType);
462 W.printHex("PayloadSize", PayloadSize);
463 if (PayloadSize > Data.size() - Offset) {
464 error(object_error::parse_failed);
468 // Print the raw contents to simplify debugging if anything goes wrong
470 StringRef Contents = Data.substr(Offset, PayloadSize);
471 W.printBinaryBlock("Contents", Contents);
473 switch (SubSectionType) {
474 case COFF::DEBUG_LINE_TABLE_SUBSECTION: {
475 // Holds a PC to file:line table. Some data to parse this subsection is
476 // stored in the other subsections, so just check sanity and store the
477 // pointers for deferred processing.
479 if (PayloadSize < 12) {
480 // There should be at least three words to store two function
481 // relocations and size of the code.
482 error(object_error::parse_failed);
486 StringRef FunctionName;
487 if (error(resolveSymbolName(Obj->getCOFFSection(Section), Offset,
490 W.printString("FunctionName", FunctionName);
491 if (FunctionLineTables.count(FunctionName) != 0) {
492 // Saw debug info for this function already?
493 error(object_error::parse_failed);
497 FunctionLineTables[FunctionName] = Contents;
498 FunctionNames.push_back(FunctionName);
501 case COFF::DEBUG_STRING_TABLE_SUBSECTION:
502 if (PayloadSize == 0 || StringTable.data() != nullptr ||
503 Contents.back() != '\0') {
504 // Empty or duplicate or non-null-terminated subsection.
505 error(object_error::parse_failed);
508 StringTable = Contents;
510 case COFF::DEBUG_INDEX_SUBSECTION:
511 // Holds the translation table from file indices
512 // to offsets in the string table.
514 if (PayloadSize == 0 ||
515 FileIndexToStringOffsetTable.data() != nullptr) {
516 // Empty or duplicate subsection.
517 error(object_error::parse_failed);
520 FileIndexToStringOffsetTable = Contents;
523 Offset += PayloadSize;
525 // Align the reading pointer by 4.
526 Offset += (-Offset) % 4;
530 // Dump the line tables now that we've read all the subsections and know all
531 // the required information.
532 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
533 StringRef Name = FunctionNames[I];
534 ListScope S(W, "FunctionLineTable");
535 W.printString("FunctionName", Name);
537 DataExtractor DE(FunctionLineTables[Name], true, 4);
538 uint32_t Offset = 8; // Skip relocations.
539 uint32_t FunctionSize = DE.getU32(&Offset);
540 W.printHex("CodeSize", FunctionSize);
541 while (DE.isValidOffset(Offset)) {
542 // For each range of lines with the same filename, we have a segment
543 // in the line table. The filename string is accessed using double
544 // indirection to the string table subsection using the index subsection.
545 uint32_t OffsetInIndex = DE.getU32(&Offset),
546 SegmentLength = DE.getU32(&Offset),
547 FullSegmentSize = DE.getU32(&Offset);
548 if (FullSegmentSize != 12 + 8 * SegmentLength) {
549 error(object_error::parse_failed);
553 uint32_t FilenameOffset;
555 DataExtractor SDE(FileIndexToStringOffsetTable, true, 4);
556 uint32_t OffsetInSDE = OffsetInIndex;
557 if (!SDE.isValidOffset(OffsetInSDE)) {
558 error(object_error::parse_failed);
561 FilenameOffset = SDE.getU32(&OffsetInSDE);
564 if (FilenameOffset == 0 || FilenameOffset + 1 >= StringTable.size() ||
565 StringTable.data()[FilenameOffset - 1] != '\0') {
566 // Each string in an F3 subsection should be preceded by a null
568 error(object_error::parse_failed);
572 StringRef Filename(StringTable.data() + FilenameOffset);
573 ListScope S(W, "FilenameSegment");
574 W.printString("Filename", Filename);
575 for (unsigned J = 0; J != SegmentLength && DE.isValidOffset(Offset);
577 // Then go the (PC, LineNumber) pairs. The line number is stored in the
578 // least significant 31 bits of the respective word in the table.
579 uint32_t PC = DE.getU32(&Offset),
580 LineNumber = DE.getU32(&Offset) & 0x7fffffff;
581 if (PC >= FunctionSize) {
582 error(object_error::parse_failed);
586 format("+0x%X", PC).snprint(Buffer, 32);
587 W.printNumber(Buffer, LineNumber);
593 void COFFDumper::printSections() {
594 ListScope SectionsD(W, "Sections");
595 int SectionNumber = 0;
596 for (const SectionRef &Sec : Obj->sections()) {
598 const coff_section *Section = Obj->getCOFFSection(Sec);
601 if (error(Sec.getName(Name)))
604 DictScope D(W, "Section");
605 W.printNumber("Number", SectionNumber);
606 W.printBinary("Name", Name, Section->Name);
607 W.printHex ("VirtualSize", Section->VirtualSize);
608 W.printHex ("VirtualAddress", Section->VirtualAddress);
609 W.printNumber("RawDataSize", Section->SizeOfRawData);
610 W.printHex ("PointerToRawData", Section->PointerToRawData);
611 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
612 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
613 W.printNumber("RelocationCount", Section->NumberOfRelocations);
614 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
615 W.printFlags ("Characteristics", Section->Characteristics,
616 makeArrayRef(ImageSectionCharacteristics),
617 COFF::SectionCharacteristics(0x00F00000));
619 if (opts::SectionRelocations) {
620 ListScope D(W, "Relocations");
621 for (const RelocationRef &Reloc : Sec.relocations())
622 printRelocation(Sec, Reloc);
625 if (opts::SectionSymbols) {
626 ListScope D(W, "Symbols");
627 for (const SymbolRef &Symbol : Obj->symbols()) {
628 bool Contained = false;
629 if (Sec.containsSymbol(Symbol, Contained) || !Contained)
636 if (Name == ".debug$S" && opts::CodeViewLineTables)
637 printCodeViewLineTables(Sec);
639 if (opts::SectionData &&
640 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
642 if (error(Sec.getContents(Data)))
645 W.printBinaryBlock("SectionData", Data);
650 void COFFDumper::printRelocations() {
651 ListScope D(W, "Relocations");
653 int SectionNumber = 0;
654 for (const SectionRef &Section : Obj->sections()) {
657 if (error(Section.getName(Name)))
660 bool PrintedGroup = false;
661 for (const RelocationRef &Reloc : Section.relocations()) {
663 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
668 printRelocation(Section, Reloc);
673 W.startLine() << "}\n";
678 void COFFDumper::printRelocation(const SectionRef &Section,
679 const RelocationRef &Reloc) {
682 SmallString<32> RelocName;
683 StringRef SymbolName;
685 if (error(Reloc.getOffset(Offset)))
687 if (error(Reloc.getType(RelocType)))
689 if (error(Reloc.getTypeName(RelocName)))
691 symbol_iterator Symbol = Reloc.getSymbol();
692 if (error(Symbol->getName(SymbolName)))
694 if (error(Section.getContents(Contents)))
697 if (opts::ExpandRelocs) {
698 DictScope Group(W, "Relocation");
699 W.printHex("Offset", Offset);
700 W.printNumber("Type", RelocName, RelocType);
701 W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
703 raw_ostream& OS = W.startLine();
706 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
711 void COFFDumper::printSymbols() {
712 ListScope Group(W, "Symbols");
714 for (const SymbolRef &Symbol : Obj->symbols())
718 void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
720 static StringRef getSectionName(const llvm::object::COFFObjectFile *Obj,
721 COFFSymbolRef Symbol,
722 const coff_section *Section) {
724 StringRef SectionName;
725 Obj->getSectionName(Section, SectionName);
728 int32_t SectionNumber = Symbol.getSectionNumber();
729 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
730 return "IMAGE_SYM_DEBUG";
731 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
732 return "IMAGE_SYM_ABSOLUTE";
733 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
734 return "IMAGE_SYM_UNDEFINED";
738 void COFFDumper::printSymbol(const SymbolRef &Sym) {
739 DictScope D(W, "Symbol");
741 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
742 const coff_section *Section;
743 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
744 W.startLine() << "Invalid section number: " << EC.message() << "\n";
749 StringRef SymbolName;
750 if (Obj->getSymbolName(Symbol, SymbolName))
753 StringRef SectionName = getSectionName(Obj, Symbol, Section);
755 W.printString("Name", SymbolName);
756 W.printNumber("Value", Symbol.getValue());
757 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
758 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
759 W.printEnum ("ComplexType", Symbol.getComplexType(),
760 makeArrayRef(ImageSymDType));
761 W.printEnum ("StorageClass", Symbol.getStorageClass(),
762 makeArrayRef(ImageSymClass));
763 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
765 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
766 if (Symbol.isFunctionDefinition()) {
767 const coff_aux_function_definition *Aux;
768 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
771 DictScope AS(W, "AuxFunctionDef");
772 W.printNumber("TagIndex", Aux->TagIndex);
773 W.printNumber("TotalSize", Aux->TotalSize);
774 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
775 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
777 } else if (Symbol.isWeakExternal()) {
778 const coff_aux_weak_external *Aux;
779 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
782 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
783 StringRef LinkedName;
784 std::error_code EC = Linked.getError();
785 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
790 DictScope AS(W, "AuxWeakExternal");
791 W.printNumber("Linked", LinkedName, Aux->TagIndex);
792 W.printEnum ("Search", Aux->Characteristics,
793 makeArrayRef(WeakExternalCharacteristics));
795 } else if (Symbol.isFileRecord()) {
796 const char *FileName;
797 if (error(getSymbolAuxData(Obj, Symbol, I, FileName)))
800 DictScope AS(W, "AuxFileRecord");
802 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
803 Obj->getSymbolTableEntrySize());
804 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
806 } else if (Symbol.isSectionDefinition()) {
807 const coff_aux_section_definition *Aux;
808 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
811 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
813 DictScope AS(W, "AuxSectionDef");
814 W.printNumber("Length", Aux->Length);
815 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
816 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
817 W.printHex("Checksum", Aux->CheckSum);
818 W.printNumber("Number", AuxNumber);
819 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
821 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
822 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
823 const coff_section *Assoc;
826 if ((EC = Obj->getSection(AuxNumber, Assoc)) ||
827 (EC = Obj->getSectionName(Assoc, AssocName))) {
832 W.printNumber("AssocSection", AssocName, AuxNumber);
834 } else if (Symbol.isCLRToken()) {
835 const coff_aux_clr_token *Aux;
836 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
839 ErrorOr<COFFSymbolRef> ReferredSym =
840 Obj->getSymbol(Aux->SymbolTableIndex);
841 StringRef ReferredName;
842 std::error_code EC = ReferredSym.getError();
843 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
848 DictScope AS(W, "AuxCLRToken");
849 W.printNumber("AuxType", Aux->AuxType);
850 W.printNumber("Reserved", Aux->Reserved);
851 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
854 W.startLine() << "<unhandled auxiliary record>\n";
859 void COFFDumper::printUnwindInfo() {
860 ListScope D(W, "UnwindInformation");
861 switch (Obj->getMachine()) {
862 case COFF::IMAGE_FILE_MACHINE_AMD64: {
863 Win64EH::Dumper Dumper(W);
864 Win64EH::Dumper::SymbolResolver
865 Resolver = [](const object::coff_section *Section, uint64_t Offset,
866 SymbolRef &Symbol, void *user_data) -> std::error_code {
867 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
868 return Dumper->resolveSymbol(Section, Offset, Symbol);
870 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
871 Dumper.printData(Ctx);
874 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
875 ARM::WinEH::Decoder Decoder(W);
876 Decoder.dumpProcedureData(*Obj);
880 W.printEnum("unsupported Image Machine", Obj->getMachine(),
881 makeArrayRef(ImageFileMachineType));
886 void COFFDumper::printCOFFImports() {
887 for (auto I = Obj->import_directory_begin(), E = Obj->import_directory_end();
889 DictScope Import(W, "Import");
891 if (error(I->getName(Name))) return;
892 W.printString("Name", Name);
894 if (error(I->getImportLookupTableRVA(Addr))) return;
895 W.printHex("ImportLookupTableRVA", Addr);
896 if (error(I->getImportAddressTableRVA(Addr))) return;
897 W.printHex("ImportAddressTableRVA", Addr);
898 for (auto J = I->imported_symbol_begin(), F = I->imported_symbol_end();
901 if (error(J->getSymbolName(Sym))) return;
903 if (error(J->getOrdinal(Ordinal))) return;
904 W.printNumber("Symbol", Sym, Ordinal);