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);
79 void printImportedSymbols(imported_symbol_iterator I,
80 imported_symbol_iterator E);
82 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
84 const llvm::object::COFFObjectFile *Obj;
86 StringRef CVFileIndexToStringOffsetTable;
87 StringRef CVStringTable;
95 std::error_code createCOFFDumper(const object::ObjectFile *Obj,
97 std::unique_ptr<ObjDumper> &Result) {
98 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
100 return readobj_error::unsupported_obj_file_format;
102 Result.reset(new COFFDumper(COFFObj, Writer));
103 return readobj_error::success;
108 // Given a a section and an offset into this section the function returns the
109 // symbol used for the relocation at the offset.
110 std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
111 uint64_t Offset, SymbolRef &Sym) {
112 const auto &Relocations = RelocMap[Section];
113 for (const auto &Relocation : Relocations) {
114 uint64_t RelocationOffset;
115 if (std::error_code EC = Relocation.getOffset(RelocationOffset))
118 if (RelocationOffset == Offset) {
119 Sym = *Relocation.getSymbol();
120 return readobj_error::success;
123 return readobj_error::unknown_symbol;
126 // Given a section and an offset into this section the function returns the name
127 // of the symbol used for the relocation at the offset.
128 std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
132 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
134 if (std::error_code EC = Symbol.getName(Name))
136 return object_error::success;
139 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
140 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
141 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
142 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
143 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
144 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
145 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
146 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
147 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
148 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
149 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
150 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
151 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
152 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
153 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
154 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
155 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
156 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
157 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
158 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
159 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
160 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
163 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
164 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
165 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
166 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
167 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
168 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
169 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
170 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
171 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
172 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
173 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
174 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
175 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
176 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
177 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
178 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
181 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
182 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
183 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
184 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
185 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
186 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
187 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
188 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
189 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
190 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
191 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
192 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
195 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
196 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
197 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
198 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
199 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
200 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
201 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
202 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
203 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
204 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
205 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
206 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
209 static const EnumEntry<COFF::SectionCharacteristics>
210 ImageSectionCharacteristics[] = {
211 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
212 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
213 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
214 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
215 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
216 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
217 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
218 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
219 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
220 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
221 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
222 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
223 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
224 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
225 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
226 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
227 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
228 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
229 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
230 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
231 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
232 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
233 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
234 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
235 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
236 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
237 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
238 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
239 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
240 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
241 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
242 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
243 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
244 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
245 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
248 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
249 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
250 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
251 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
252 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
253 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
254 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
255 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
256 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
257 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
258 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
259 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
260 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
261 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
262 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
263 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
264 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
267 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
268 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
269 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
270 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
271 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
274 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
275 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
276 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
277 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
278 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
279 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
280 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
281 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
282 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
283 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
284 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
285 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
286 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
287 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
288 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
289 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
290 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
291 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
292 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
293 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
294 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
295 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
296 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
297 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
298 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
299 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
300 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
301 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
304 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
305 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
306 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
307 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
308 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
309 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
310 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
311 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
314 static const EnumEntry<COFF::WeakExternalCharacteristics>
315 WeakExternalCharacteristics[] = {
316 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
317 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
318 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
321 template <typename T>
322 static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
323 COFFSymbolRef Symbol,
324 uint8_t AuxSymbolIdx, const T *&Aux) {
325 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
326 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
327 Aux = reinterpret_cast<const T*>(AuxData.data());
328 return readobj_error::success;
331 void COFFDumper::cacheRelocations() {
332 for (const SectionRef &S : Obj->sections()) {
333 const coff_section *Section = Obj->getCOFFSection(S);
335 for (const RelocationRef &Reloc : S.relocations())
336 RelocMap[Section].push_back(Reloc);
338 // Sort relocations by address.
339 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
344 void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
345 const data_directory *Data;
346 if (Obj->getDataDirectory(Index, Data))
348 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
349 W.printHex(FieldName + "Size", Data->Size);
352 void COFFDumper::printFileHeaders() {
353 time_t TDS = Obj->getTimeDateStamp();
354 char FormattedTime[20] = { };
355 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
358 DictScope D(W, "ImageFileHeader");
359 W.printEnum ("Machine", Obj->getMachine(),
360 makeArrayRef(ImageFileMachineType));
361 W.printNumber("SectionCount", Obj->getNumberOfSections());
362 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
363 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
364 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
365 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
366 W.printFlags ("Characteristics", Obj->getCharacteristics(),
367 makeArrayRef(ImageFileCharacteristics));
370 // Print PE header. This header does not exist if this is an object file and
371 // not an executable.
372 const pe32_header *PEHeader = nullptr;
373 if (error(Obj->getPE32Header(PEHeader)))
376 printPEHeader<pe32_header>(PEHeader);
378 const pe32plus_header *PEPlusHeader = nullptr;
379 if (error(Obj->getPE32PlusHeader(PEPlusHeader)))
382 printPEHeader<pe32plus_header>(PEPlusHeader);
385 template <class PEHeader>
386 void COFFDumper::printPEHeader(const PEHeader *Hdr) {
387 DictScope D(W, "ImageOptionalHeader");
388 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
389 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
390 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
391 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
392 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
393 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
394 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
395 printBaseOfDataField(Hdr);
396 W.printHex ("ImageBase", Hdr->ImageBase);
397 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
398 W.printNumber("FileAlignment", Hdr->FileAlignment);
399 W.printNumber("MajorOperatingSystemVersion",
400 Hdr->MajorOperatingSystemVersion);
401 W.printNumber("MinorOperatingSystemVersion",
402 Hdr->MinorOperatingSystemVersion);
403 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
404 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
405 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
406 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
407 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
408 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
409 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
410 W.printFlags ("Subsystem", Hdr->DLLCharacteristics,
411 makeArrayRef(PEDLLCharacteristics));
412 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
413 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
414 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
415 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
416 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
418 if (Hdr->NumberOfRvaAndSize > 0) {
419 DictScope D(W, "DataDirectory");
420 static const char * const directory[] = {
421 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
422 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
423 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
424 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
427 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
428 printDataDirectory(i, directory[i]);
433 void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
434 W.printHex("BaseOfData", Hdr->BaseOfData);
437 void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
439 void COFFDumper::printCodeViewLineTables(const SectionRef &Section) {
441 if (error(Section.getContents(Data)))
444 SmallVector<StringRef, 10> FunctionNames;
445 StringMap<StringRef> FunctionLineTables;
447 ListScope D(W, "CodeViewLineTables");
449 DataExtractor DE(Data, true, 4);
451 Magic = DE.getU32(&Offset);
452 W.printHex("Magic", Magic);
453 if (Magic != COFF::DEBUG_SECTION_MAGIC) {
454 error(object_error::parse_failed);
458 bool Finished = false;
459 while (DE.isValidOffset(Offset) && !Finished) {
460 // The section consists of a number of subsection in the following format:
461 // |Type|PayloadSize|Payload...|
462 uint32_t SubSectionType = DE.getU32(&Offset),
463 PayloadSize = DE.getU32(&Offset);
464 ListScope S(W, "Subsection");
465 W.printHex("Type", SubSectionType);
466 W.printHex("PayloadSize", PayloadSize);
467 if (PayloadSize > Data.size() - Offset) {
468 error(object_error::parse_failed);
472 // Print the raw contents to simplify debugging if anything goes wrong
474 StringRef Contents = Data.substr(Offset, PayloadSize);
475 W.printBinaryBlock("Contents", Contents);
477 switch (SubSectionType) {
478 case COFF::DEBUG_LINE_TABLE_SUBSECTION: {
479 // Holds a PC to file:line table. Some data to parse this subsection is
480 // stored in the other subsections, so just check sanity and store the
481 // pointers for deferred processing.
483 if (PayloadSize < 12) {
484 // There should be at least three words to store two function
485 // relocations and size of the code.
486 error(object_error::parse_failed);
490 StringRef FunctionName;
491 if (error(resolveSymbolName(Obj->getCOFFSection(Section), Offset,
494 W.printString("FunctionName", FunctionName);
495 if (FunctionLineTables.count(FunctionName) != 0) {
496 // Saw debug info for this function already?
497 error(object_error::parse_failed);
501 FunctionLineTables[FunctionName] = Contents;
502 FunctionNames.push_back(FunctionName);
505 case COFF::DEBUG_STRING_TABLE_SUBSECTION:
506 if (PayloadSize == 0 || CVStringTable.data() != nullptr ||
507 Contents.back() != '\0') {
508 // Empty or duplicate or non-null-terminated subsection.
509 error(object_error::parse_failed);
512 CVStringTable = Contents;
514 case COFF::DEBUG_INDEX_SUBSECTION:
515 // Holds the translation table from file indices
516 // to offsets in the string table.
518 if (PayloadSize == 0 ||
519 CVFileIndexToStringOffsetTable.data() != nullptr) {
520 // Empty or duplicate subsection.
521 error(object_error::parse_failed);
524 CVFileIndexToStringOffsetTable = Contents;
527 Offset += PayloadSize;
529 // Align the reading pointer by 4.
530 Offset += (-Offset) % 4;
534 // Dump the line tables now that we've read all the subsections and know all
535 // the required information.
536 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
537 StringRef Name = FunctionNames[I];
538 ListScope S(W, "FunctionLineTable");
539 W.printString("FunctionName", Name);
541 DataExtractor DE(FunctionLineTables[Name], true, 4);
542 uint32_t Offset = 8; // Skip relocations.
543 uint32_t FunctionSize = DE.getU32(&Offset);
544 W.printHex("CodeSize", FunctionSize);
545 while (DE.isValidOffset(Offset)) {
546 // For each range of lines with the same filename, we have a segment
547 // in the line table. The filename string is accessed using double
548 // indirection to the string table subsection using the index subsection.
549 uint32_t OffsetInIndex = DE.getU32(&Offset),
550 SegmentLength = DE.getU32(&Offset),
551 FullSegmentSize = DE.getU32(&Offset);
552 if (FullSegmentSize != 12 + 8 * SegmentLength) {
553 error(object_error::parse_failed);
557 uint32_t FilenameOffset;
559 DataExtractor SDE(CVFileIndexToStringOffsetTable, true, 4);
560 uint32_t OffsetInSDE = OffsetInIndex;
561 if (!SDE.isValidOffset(OffsetInSDE)) {
562 error(object_error::parse_failed);
565 FilenameOffset = SDE.getU32(&OffsetInSDE);
568 if (FilenameOffset == 0 || FilenameOffset + 1 >= CVStringTable.size() ||
569 CVStringTable.data()[FilenameOffset - 1] != '\0') {
570 // Each string in an F3 subsection should be preceded by a null
572 error(object_error::parse_failed);
576 StringRef Filename(CVStringTable.data() + FilenameOffset);
577 ListScope S(W, "FilenameSegment");
578 W.printString("Filename", Filename);
579 for (unsigned J = 0; J != SegmentLength && DE.isValidOffset(Offset);
581 // Then go the (PC, LineNumber) pairs. The line number is stored in the
582 // least significant 31 bits of the respective word in the table.
583 uint32_t PC = DE.getU32(&Offset),
584 LineNumber = DE.getU32(&Offset) & 0x7fffffff;
585 if (PC >= FunctionSize) {
586 error(object_error::parse_failed);
590 format("+0x%X", PC).snprint(Buffer, 32);
591 W.printNumber(Buffer, LineNumber);
597 void COFFDumper::printSections() {
598 ListScope SectionsD(W, "Sections");
599 int SectionNumber = 0;
600 for (const SectionRef &Sec : Obj->sections()) {
602 const coff_section *Section = Obj->getCOFFSection(Sec);
605 if (error(Sec.getName(Name)))
608 DictScope D(W, "Section");
609 W.printNumber("Number", SectionNumber);
610 W.printBinary("Name", Name, Section->Name);
611 W.printHex ("VirtualSize", Section->VirtualSize);
612 W.printHex ("VirtualAddress", Section->VirtualAddress);
613 W.printNumber("RawDataSize", Section->SizeOfRawData);
614 W.printHex ("PointerToRawData", Section->PointerToRawData);
615 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
616 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
617 W.printNumber("RelocationCount", Section->NumberOfRelocations);
618 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
619 W.printFlags ("Characteristics", Section->Characteristics,
620 makeArrayRef(ImageSectionCharacteristics),
621 COFF::SectionCharacteristics(0x00F00000));
623 if (opts::SectionRelocations) {
624 ListScope D(W, "Relocations");
625 for (const RelocationRef &Reloc : Sec.relocations())
626 printRelocation(Sec, Reloc);
629 if (opts::SectionSymbols) {
630 ListScope D(W, "Symbols");
631 for (const SymbolRef &Symbol : Obj->symbols()) {
632 bool Contained = false;
633 if (Sec.containsSymbol(Symbol, Contained) || !Contained)
640 if (Name == ".debug$S" && opts::CodeViewLineTables)
641 printCodeViewLineTables(Sec);
643 if (opts::SectionData &&
644 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
646 if (error(Sec.getContents(Data)))
649 W.printBinaryBlock("SectionData", Data);
654 void COFFDumper::printRelocations() {
655 ListScope D(W, "Relocations");
657 int SectionNumber = 0;
658 for (const SectionRef &Section : Obj->sections()) {
661 if (error(Section.getName(Name)))
664 bool PrintedGroup = false;
665 for (const RelocationRef &Reloc : Section.relocations()) {
667 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
672 printRelocation(Section, Reloc);
677 W.startLine() << "}\n";
682 void COFFDumper::printRelocation(const SectionRef &Section,
683 const RelocationRef &Reloc) {
686 SmallString<32> RelocName;
687 StringRef SymbolName;
689 if (error(Reloc.getOffset(Offset)))
691 if (error(Reloc.getType(RelocType)))
693 if (error(Reloc.getTypeName(RelocName)))
695 symbol_iterator Symbol = Reloc.getSymbol();
696 if (error(Symbol->getName(SymbolName)))
698 if (error(Section.getContents(Contents)))
701 if (opts::ExpandRelocs) {
702 DictScope Group(W, "Relocation");
703 W.printHex("Offset", Offset);
704 W.printNumber("Type", RelocName, RelocType);
705 W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
707 raw_ostream& OS = W.startLine();
710 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
715 void COFFDumper::printSymbols() {
716 ListScope Group(W, "Symbols");
718 for (const SymbolRef &Symbol : Obj->symbols())
722 void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
724 static StringRef getSectionName(const llvm::object::COFFObjectFile *Obj,
725 COFFSymbolRef Symbol,
726 const coff_section *Section) {
728 StringRef SectionName;
729 Obj->getSectionName(Section, SectionName);
732 int32_t SectionNumber = Symbol.getSectionNumber();
733 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
734 return "IMAGE_SYM_DEBUG";
735 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
736 return "IMAGE_SYM_ABSOLUTE";
737 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
738 return "IMAGE_SYM_UNDEFINED";
742 void COFFDumper::printSymbol(const SymbolRef &Sym) {
743 DictScope D(W, "Symbol");
745 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
746 const coff_section *Section;
747 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
748 W.startLine() << "Invalid section number: " << EC.message() << "\n";
753 StringRef SymbolName;
754 if (Obj->getSymbolName(Symbol, SymbolName))
757 StringRef SectionName = getSectionName(Obj, Symbol, Section);
759 W.printString("Name", SymbolName);
760 W.printNumber("Value", Symbol.getValue());
761 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
762 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
763 W.printEnum ("ComplexType", Symbol.getComplexType(),
764 makeArrayRef(ImageSymDType));
765 W.printEnum ("StorageClass", Symbol.getStorageClass(),
766 makeArrayRef(ImageSymClass));
767 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
769 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
770 if (Symbol.isFunctionDefinition()) {
771 const coff_aux_function_definition *Aux;
772 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
775 DictScope AS(W, "AuxFunctionDef");
776 W.printNumber("TagIndex", Aux->TagIndex);
777 W.printNumber("TotalSize", Aux->TotalSize);
778 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
779 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
781 } else if (Symbol.isWeakExternal()) {
782 const coff_aux_weak_external *Aux;
783 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
786 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
787 StringRef LinkedName;
788 std::error_code EC = Linked.getError();
789 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
794 DictScope AS(W, "AuxWeakExternal");
795 W.printNumber("Linked", LinkedName, Aux->TagIndex);
796 W.printEnum ("Search", Aux->Characteristics,
797 makeArrayRef(WeakExternalCharacteristics));
799 } else if (Symbol.isFileRecord()) {
800 const char *FileName;
801 if (error(getSymbolAuxData(Obj, Symbol, I, FileName)))
804 DictScope AS(W, "AuxFileRecord");
806 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
807 Obj->getSymbolTableEntrySize());
808 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
810 } else if (Symbol.isSectionDefinition()) {
811 const coff_aux_section_definition *Aux;
812 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
815 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
817 DictScope AS(W, "AuxSectionDef");
818 W.printNumber("Length", Aux->Length);
819 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
820 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
821 W.printHex("Checksum", Aux->CheckSum);
822 W.printNumber("Number", AuxNumber);
823 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
825 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
826 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
827 const coff_section *Assoc;
830 if ((EC = Obj->getSection(AuxNumber, Assoc)) ||
831 (EC = Obj->getSectionName(Assoc, AssocName))) {
836 W.printNumber("AssocSection", AssocName, AuxNumber);
838 } else if (Symbol.isCLRToken()) {
839 const coff_aux_clr_token *Aux;
840 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
843 ErrorOr<COFFSymbolRef> ReferredSym =
844 Obj->getSymbol(Aux->SymbolTableIndex);
845 StringRef ReferredName;
846 std::error_code EC = ReferredSym.getError();
847 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
852 DictScope AS(W, "AuxCLRToken");
853 W.printNumber("AuxType", Aux->AuxType);
854 W.printNumber("Reserved", Aux->Reserved);
855 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
858 W.startLine() << "<unhandled auxiliary record>\n";
863 void COFFDumper::printUnwindInfo() {
864 ListScope D(W, "UnwindInformation");
865 switch (Obj->getMachine()) {
866 case COFF::IMAGE_FILE_MACHINE_AMD64: {
867 Win64EH::Dumper Dumper(W);
868 Win64EH::Dumper::SymbolResolver
869 Resolver = [](const object::coff_section *Section, uint64_t Offset,
870 SymbolRef &Symbol, void *user_data) -> std::error_code {
871 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
872 return Dumper->resolveSymbol(Section, Offset, Symbol);
874 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
875 Dumper.printData(Ctx);
878 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
879 ARM::WinEH::Decoder Decoder(W);
880 Decoder.dumpProcedureData(*Obj);
884 W.printEnum("unsupported Image Machine", Obj->getMachine(),
885 makeArrayRef(ImageFileMachineType));
890 void COFFDumper::printImportedSymbols(imported_symbol_iterator I,
891 imported_symbol_iterator E) {
892 for (; I != E; ++I) {
894 if (error(I->getSymbolName(Sym))) return;
896 if (error(I->getOrdinal(Ordinal))) return;
897 W.printNumber("Symbol", Sym, Ordinal);
901 void COFFDumper::printCOFFImports() {
903 for (auto I = Obj->import_directory_begin(), E = Obj->import_directory_end();
905 DictScope Import(W, "Import");
907 if (error(I->getName(Name))) return;
908 W.printString("Name", Name);
910 if (error(I->getImportLookupTableRVA(Addr))) return;
911 W.printHex("ImportLookupTableRVA", Addr);
912 if (error(I->getImportAddressTableRVA(Addr))) return;
913 W.printHex("ImportAddressTableRVA", Addr);
914 printImportedSymbols(I->imported_symbol_begin(), I->imported_symbol_end());
918 for (auto I = Obj->delay_import_directory_begin(),
919 E = Obj->delay_import_directory_end();
921 DictScope Import(W, "DelayImport");
923 if (error(I->getName(Name))) return;
924 W.printString("Name", Name);
925 const delay_import_directory_table_entry *Table;
926 if (error(I->getDelayImportTable(Table))) return;
927 W.printHex("Attributes", Table->Attributes);
928 W.printHex("ModuleHandle", Table->ModuleHandle);
929 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
930 W.printHex("ImportNameTable", Table->DelayImportNameTable);
931 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
932 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
933 printImportedSymbols(I->imported_symbol_begin(), I->imported_symbol_end());
937 void COFFDumper::printCOFFDirectives() {
938 for (const SectionRef &Section : Obj->sections()) {
942 if (error(Section.getName(Name)))
944 if (Name != ".drectve")
947 if (error(Section.getContents(Contents)))
950 W.printString("Directive(s)", Contents);