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;
60 void printSymbol(const SymbolRef &Sym);
61 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc);
62 void printDataDirectory(uint32_t Index, const std::string &FieldName);
64 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
65 void printBaseOfDataField(const pe32_header *Hdr);
66 void printBaseOfDataField(const pe32plus_header *Hdr);
68 void printCodeViewLineTables(const SectionRef &Section);
70 void cacheRelocations();
72 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
74 std::error_code resolveSymbolName(const coff_section *Section,
75 uint64_t Offset, StringRef &Name);
77 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
79 const llvm::object::COFFObjectFile *Obj;
88 std::error_code createCOFFDumper(const object::ObjectFile *Obj,
90 std::unique_ptr<ObjDumper> &Result) {
91 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
93 return readobj_error::unsupported_obj_file_format;
95 Result.reset(new COFFDumper(COFFObj, Writer));
96 return readobj_error::success;
101 // Given a a section and an offset into this section the function returns the
102 // symbol used for the relocation at the offset.
103 std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
104 uint64_t Offset, SymbolRef &Sym) {
105 const auto &Relocations = RelocMap[Section];
106 for (const auto &Relocation : Relocations) {
107 uint64_t RelocationOffset;
108 if (std::error_code EC = Relocation.getOffset(RelocationOffset))
111 if (RelocationOffset == Offset) {
112 Sym = *Relocation.getSymbol();
113 return readobj_error::success;
116 return readobj_error::unknown_symbol;
119 // Given a section and an offset into this section the function returns the name
120 // of the symbol used for the relocation at the offset.
121 std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
125 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
127 if (std::error_code EC = Symbol.getName(Name))
129 return object_error::success;
132 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
133 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
134 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
135 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
136 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
137 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
138 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
139 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
140 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
141 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
142 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
143 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
144 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
145 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
146 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
147 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
148 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
149 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
150 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
151 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
152 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
153 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
156 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
157 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
158 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
159 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
160 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
161 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
162 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
163 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
164 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
165 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
166 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
167 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
168 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
169 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
170 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
171 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
174 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
175 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
176 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
177 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
178 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
179 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
180 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
181 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
182 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
183 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
184 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
185 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
188 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
189 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
190 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
191 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
192 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
193 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
194 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
195 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
196 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
197 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
198 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
199 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
202 static const EnumEntry<COFF::SectionCharacteristics>
203 ImageSectionCharacteristics[] = {
204 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
205 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
206 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
207 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
208 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
209 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
210 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
211 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
212 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
213 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
214 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
215 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
216 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
217 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
218 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
219 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
220 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
221 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
222 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
223 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
224 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
225 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
226 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
227 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
228 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
229 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
230 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
231 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
232 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
233 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
234 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
235 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
236 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
237 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
238 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
241 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
242 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
243 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
244 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
245 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
246 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
247 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
248 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
249 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
250 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
251 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
252 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
253 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
254 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
255 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
256 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
257 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
260 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
261 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
262 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
263 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
264 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
267 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
268 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
269 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
270 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
271 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
272 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
273 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
274 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
275 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
276 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
277 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
278 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
279 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
280 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
281 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
282 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
283 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
284 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
285 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
286 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
287 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
288 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
289 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
290 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
291 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
292 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
293 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
294 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
297 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
298 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
299 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
300 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
301 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
302 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
303 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
304 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
307 static const EnumEntry<COFF::WeakExternalCharacteristics>
308 WeakExternalCharacteristics[] = {
309 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
310 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
311 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
314 template <typename T>
315 static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
316 COFFSymbolRef Symbol,
317 uint8_t AuxSymbolIdx, const T *&Aux) {
318 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
319 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
320 Aux = reinterpret_cast<const T*>(AuxData.data());
321 return readobj_error::success;
324 void COFFDumper::cacheRelocations() {
325 for (const SectionRef &S : Obj->sections()) {
326 const coff_section *Section = Obj->getCOFFSection(S);
328 for (const RelocationRef &Reloc : S.relocations())
329 RelocMap[Section].push_back(Reloc);
331 // Sort relocations by address.
332 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
337 void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
338 const data_directory *Data;
339 if (Obj->getDataDirectory(Index, Data))
341 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
342 W.printHex(FieldName + "Size", Data->Size);
345 void COFFDumper::printFileHeaders() {
346 time_t TDS = Obj->getTimeDateStamp();
347 char FormattedTime[20] = { };
348 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
351 DictScope D(W, "ImageFileHeader");
352 W.printEnum ("Machine", Obj->getMachine(),
353 makeArrayRef(ImageFileMachineType));
354 W.printNumber("SectionCount", Obj->getNumberOfSections());
355 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
356 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
357 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
358 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
359 W.printFlags ("Characteristics", Obj->getCharacteristics(),
360 makeArrayRef(ImageFileCharacteristics));
363 // Print PE header. This header does not exist if this is an object file and
364 // not an executable.
365 const pe32_header *PEHeader = nullptr;
366 if (error(Obj->getPE32Header(PEHeader)))
369 printPEHeader<pe32_header>(PEHeader);
371 const pe32plus_header *PEPlusHeader = nullptr;
372 if (error(Obj->getPE32PlusHeader(PEPlusHeader)))
375 printPEHeader<pe32plus_header>(PEPlusHeader);
378 template <class PEHeader>
379 void COFFDumper::printPEHeader(const PEHeader *Hdr) {
380 DictScope D(W, "ImageOptionalHeader");
381 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
382 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
383 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
384 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
385 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
386 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
387 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
388 printBaseOfDataField(Hdr);
389 W.printHex ("ImageBase", Hdr->ImageBase);
390 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
391 W.printNumber("FileAlignment", Hdr->FileAlignment);
392 W.printNumber("MajorOperatingSystemVersion",
393 Hdr->MajorOperatingSystemVersion);
394 W.printNumber("MinorOperatingSystemVersion",
395 Hdr->MinorOperatingSystemVersion);
396 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
397 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
398 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
399 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
400 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
401 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
402 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
403 W.printFlags ("Subsystem", Hdr->DLLCharacteristics,
404 makeArrayRef(PEDLLCharacteristics));
405 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
406 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
407 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
408 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
409 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
411 if (Hdr->NumberOfRvaAndSize > 0) {
412 DictScope D(W, "DataDirectory");
413 static const char * const directory[] = {
414 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
415 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
416 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
417 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
420 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
421 printDataDirectory(i, directory[i]);
426 void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
427 W.printHex("BaseOfData", Hdr->BaseOfData);
430 void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
432 void COFFDumper::printCodeViewLineTables(const SectionRef &Section) {
434 if (error(Section.getContents(Data)))
437 SmallVector<StringRef, 10> FunctionNames;
438 StringMap<StringRef> FunctionLineTables;
439 StringRef FileIndexToStringOffsetTable;
440 StringRef StringTable;
442 ListScope D(W, "CodeViewLineTables");
444 DataExtractor DE(Data, true, 4);
446 Magic = DE.getU32(&Offset);
447 W.printHex("Magic", Magic);
448 if (Magic != COFF::DEBUG_SECTION_MAGIC) {
449 error(object_error::parse_failed);
453 bool Finished = false;
454 while (DE.isValidOffset(Offset) && !Finished) {
455 // The section consists of a number of subsection in the following format:
456 // |Type|PayloadSize|Payload...|
457 uint32_t SubSectionType = DE.getU32(&Offset),
458 PayloadSize = DE.getU32(&Offset);
459 ListScope S(W, "Subsection");
460 W.printHex("Type", SubSectionType);
461 W.printHex("PayloadSize", PayloadSize);
462 if (PayloadSize > Data.size() - Offset) {
463 error(object_error::parse_failed);
467 // Print the raw contents to simplify debugging if anything goes wrong
469 StringRef Contents = Data.substr(Offset, PayloadSize);
470 W.printBinaryBlock("Contents", Contents);
472 switch (SubSectionType) {
473 case COFF::DEBUG_LINE_TABLE_SUBSECTION: {
474 // Holds a PC to file:line table. Some data to parse this subsection is
475 // stored in the other subsections, so just check sanity and store the
476 // pointers for deferred processing.
478 if (PayloadSize < 12) {
479 // There should be at least three words to store two function
480 // relocations and size of the code.
481 error(object_error::parse_failed);
485 StringRef FunctionName;
486 if (error(resolveSymbolName(Obj->getCOFFSection(Section), Offset,
489 W.printString("FunctionName", FunctionName);
490 if (FunctionLineTables.count(FunctionName) != 0) {
491 // Saw debug info for this function already?
492 error(object_error::parse_failed);
496 FunctionLineTables[FunctionName] = Contents;
497 FunctionNames.push_back(FunctionName);
500 case COFF::DEBUG_STRING_TABLE_SUBSECTION:
501 if (PayloadSize == 0 || StringTable.data() != nullptr ||
502 Contents.back() != '\0') {
503 // Empty or duplicate or non-null-terminated subsection.
504 error(object_error::parse_failed);
507 StringTable = Contents;
509 case COFF::DEBUG_INDEX_SUBSECTION:
510 // Holds the translation table from file indices
511 // to offsets in the string table.
513 if (PayloadSize == 0 ||
514 FileIndexToStringOffsetTable.data() != nullptr) {
515 // Empty or duplicate subsection.
516 error(object_error::parse_failed);
519 FileIndexToStringOffsetTable = Contents;
522 Offset += PayloadSize;
524 // Align the reading pointer by 4.
525 Offset += (-Offset) % 4;
529 // Dump the line tables now that we've read all the subsections and know all
530 // the required information.
531 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
532 StringRef Name = FunctionNames[I];
533 ListScope S(W, "FunctionLineTable");
534 W.printString("FunctionName", Name);
536 DataExtractor DE(FunctionLineTables[Name], true, 4);
537 uint32_t Offset = 8; // Skip relocations.
538 uint32_t FunctionSize = DE.getU32(&Offset);
539 W.printHex("CodeSize", FunctionSize);
540 while (DE.isValidOffset(Offset)) {
541 // For each range of lines with the same filename, we have a segment
542 // in the line table. The filename string is accessed using double
543 // indirection to the string table subsection using the index subsection.
544 uint32_t OffsetInIndex = DE.getU32(&Offset),
545 SegmentLength = DE.getU32(&Offset),
546 FullSegmentSize = DE.getU32(&Offset);
547 if (FullSegmentSize != 12 + 8 * SegmentLength) {
548 error(object_error::parse_failed);
552 uint32_t FilenameOffset;
554 DataExtractor SDE(FileIndexToStringOffsetTable, true, 4);
555 uint32_t OffsetInSDE = OffsetInIndex;
556 if (!SDE.isValidOffset(OffsetInSDE)) {
557 error(object_error::parse_failed);
560 FilenameOffset = SDE.getU32(&OffsetInSDE);
563 if (FilenameOffset == 0 || FilenameOffset + 1 >= StringTable.size() ||
564 StringTable.data()[FilenameOffset - 1] != '\0') {
565 // Each string in an F3 subsection should be preceded by a null
567 error(object_error::parse_failed);
571 StringRef Filename(StringTable.data() + FilenameOffset);
572 ListScope S(W, "FilenameSegment");
573 W.printString("Filename", Filename);
574 for (unsigned J = 0; J != SegmentLength && DE.isValidOffset(Offset);
576 // Then go the (PC, LineNumber) pairs. The line number is stored in the
577 // least significant 31 bits of the respective word in the table.
578 uint32_t PC = DE.getU32(&Offset),
579 LineNumber = DE.getU32(&Offset) & 0x7fffffff;
580 if (PC >= FunctionSize) {
581 error(object_error::parse_failed);
585 format("+0x%X", PC).snprint(Buffer, 32);
586 W.printNumber(Buffer, LineNumber);
592 void COFFDumper::printSections() {
593 ListScope SectionsD(W, "Sections");
594 int SectionNumber = 0;
595 for (const SectionRef &Sec : Obj->sections()) {
597 const coff_section *Section = Obj->getCOFFSection(Sec);
600 if (error(Sec.getName(Name)))
603 DictScope D(W, "Section");
604 W.printNumber("Number", SectionNumber);
605 W.printBinary("Name", Name, Section->Name);
606 W.printHex ("VirtualSize", Section->VirtualSize);
607 W.printHex ("VirtualAddress", Section->VirtualAddress);
608 W.printNumber("RawDataSize", Section->SizeOfRawData);
609 W.printHex ("PointerToRawData", Section->PointerToRawData);
610 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
611 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
612 W.printNumber("RelocationCount", Section->NumberOfRelocations);
613 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
614 W.printFlags ("Characteristics", Section->Characteristics,
615 makeArrayRef(ImageSectionCharacteristics),
616 COFF::SectionCharacteristics(0x00F00000));
618 if (opts::SectionRelocations) {
619 ListScope D(W, "Relocations");
620 for (const RelocationRef &Reloc : Sec.relocations())
621 printRelocation(Sec, Reloc);
624 if (opts::SectionSymbols) {
625 ListScope D(W, "Symbols");
626 for (const SymbolRef &Symbol : Obj->symbols()) {
627 bool Contained = false;
628 if (Sec.containsSymbol(Symbol, Contained) || !Contained)
635 if (Name == ".debug$S" && opts::CodeViewLineTables)
636 printCodeViewLineTables(Sec);
638 if (opts::SectionData &&
639 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
641 if (error(Sec.getContents(Data)))
644 W.printBinaryBlock("SectionData", Data);
649 void COFFDumper::printRelocations() {
650 ListScope D(W, "Relocations");
652 int SectionNumber = 0;
653 for (const SectionRef &Section : Obj->sections()) {
656 if (error(Section.getName(Name)))
659 bool PrintedGroup = false;
660 for (const RelocationRef &Reloc : Section.relocations()) {
662 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
667 printRelocation(Section, Reloc);
672 W.startLine() << "}\n";
677 void COFFDumper::printRelocation(const SectionRef &Section,
678 const RelocationRef &Reloc) {
681 SmallString<32> RelocName;
682 StringRef SymbolName;
684 if (error(Reloc.getOffset(Offset)))
686 if (error(Reloc.getType(RelocType)))
688 if (error(Reloc.getTypeName(RelocName)))
690 symbol_iterator Symbol = Reloc.getSymbol();
691 if (error(Symbol->getName(SymbolName)))
693 if (error(Section.getContents(Contents)))
696 if (opts::ExpandRelocs) {
697 DictScope Group(W, "Relocation");
698 W.printHex("Offset", Offset);
699 W.printNumber("Type", RelocName, RelocType);
700 W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
702 raw_ostream& OS = W.startLine();
705 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
710 void COFFDumper::printSymbols() {
711 ListScope Group(W, "Symbols");
713 for (const SymbolRef &Symbol : Obj->symbols())
717 void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
719 static StringRef getSectionName(const llvm::object::COFFObjectFile *Obj,
720 COFFSymbolRef Symbol,
721 const coff_section *Section) {
723 StringRef SectionName;
724 Obj->getSectionName(Section, SectionName);
727 int32_t SectionNumber = Symbol.getSectionNumber();
728 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
729 return "IMAGE_SYM_DEBUG";
730 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
731 return "IMAGE_SYM_ABSOLUTE";
732 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
733 return "IMAGE_SYM_UNDEFINED";
737 void COFFDumper::printSymbol(const SymbolRef &Sym) {
738 DictScope D(W, "Symbol");
740 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
741 const coff_section *Section;
742 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
743 W.startLine() << "Invalid section number: " << EC.message() << "\n";
748 StringRef SymbolName;
749 if (Obj->getSymbolName(Symbol, SymbolName))
752 StringRef SectionName = getSectionName(Obj, Symbol, Section);
754 W.printString("Name", SymbolName);
755 W.printNumber("Value", Symbol.getValue());
756 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
757 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
758 W.printEnum ("ComplexType", Symbol.getComplexType(),
759 makeArrayRef(ImageSymDType));
760 W.printEnum ("StorageClass", Symbol.getStorageClass(),
761 makeArrayRef(ImageSymClass));
762 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
764 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
765 if (Symbol.isFunctionDefinition()) {
766 const coff_aux_function_definition *Aux;
767 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
770 DictScope AS(W, "AuxFunctionDef");
771 W.printNumber("TagIndex", Aux->TagIndex);
772 W.printNumber("TotalSize", Aux->TotalSize);
773 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
774 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
776 } else if (Symbol.isWeakExternal()) {
777 const coff_aux_weak_external *Aux;
778 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
781 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
782 StringRef LinkedName;
783 std::error_code EC = Linked.getError();
784 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
789 DictScope AS(W, "AuxWeakExternal");
790 W.printNumber("Linked", LinkedName, Aux->TagIndex);
791 W.printEnum ("Search", Aux->Characteristics,
792 makeArrayRef(WeakExternalCharacteristics));
794 } else if (Symbol.isFileRecord()) {
795 const char *FileName;
796 if (error(getSymbolAuxData(Obj, Symbol, I, FileName)))
799 DictScope AS(W, "AuxFileRecord");
801 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
802 Obj->getSymbolTableEntrySize());
803 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
805 } else if (Symbol.isSectionDefinition()) {
806 const coff_aux_section_definition *Aux;
807 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
810 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
812 DictScope AS(W, "AuxSectionDef");
813 W.printNumber("Length", Aux->Length);
814 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
815 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
816 W.printHex("Checksum", Aux->CheckSum);
817 W.printNumber("Number", AuxNumber);
818 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
820 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
821 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
822 const coff_section *Assoc;
825 if ((EC = Obj->getSection(AuxNumber, Assoc)) ||
826 (EC = Obj->getSectionName(Assoc, AssocName))) {
831 W.printNumber("AssocSection", AssocName, AuxNumber);
833 } else if (Symbol.isCLRToken()) {
834 const coff_aux_clr_token *Aux;
835 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
838 ErrorOr<COFFSymbolRef> ReferredSym =
839 Obj->getSymbol(Aux->SymbolTableIndex);
840 StringRef ReferredName;
841 std::error_code EC = ReferredSym.getError();
842 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
847 DictScope AS(W, "AuxCLRToken");
848 W.printNumber("AuxType", Aux->AuxType);
849 W.printNumber("Reserved", Aux->Reserved);
850 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
853 W.startLine() << "<unhandled auxiliary record>\n";
858 void COFFDumper::printUnwindInfo() {
859 ListScope D(W, "UnwindInformation");
860 switch (Obj->getMachine()) {
861 case COFF::IMAGE_FILE_MACHINE_AMD64: {
862 Win64EH::Dumper Dumper(W);
863 Win64EH::Dumper::SymbolResolver
864 Resolver = [](const object::coff_section *Section, uint64_t Offset,
865 SymbolRef &Symbol, void *user_data) -> std::error_code {
866 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
867 return Dumper->resolveSymbol(Section, Offset, Symbol);
869 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
870 Dumper.printData(Ctx);
873 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
874 ARM::WinEH::Decoder Decoder(W);
875 Decoder.dumpProcedureData(*Obj);
879 W.printEnum("unsupported Image Machine", Obj->getMachine(),
880 makeArrayRef(ImageFileMachineType));