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 void printImportedSymbols(imported_symbol_iterator I,
79 imported_symbol_iterator E);
81 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
83 const llvm::object::COFFObjectFile *Obj;
92 std::error_code createCOFFDumper(const object::ObjectFile *Obj,
94 std::unique_ptr<ObjDumper> &Result) {
95 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
97 return readobj_error::unsupported_obj_file_format;
99 Result.reset(new COFFDumper(COFFObj, Writer));
100 return readobj_error::success;
105 // Given a a section and an offset into this section the function returns the
106 // symbol used for the relocation at the offset.
107 std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
108 uint64_t Offset, SymbolRef &Sym) {
109 const auto &Relocations = RelocMap[Section];
110 for (const auto &Relocation : Relocations) {
111 uint64_t RelocationOffset;
112 if (std::error_code EC = Relocation.getOffset(RelocationOffset))
115 if (RelocationOffset == Offset) {
116 Sym = *Relocation.getSymbol();
117 return readobj_error::success;
120 return readobj_error::unknown_symbol;
123 // Given a section and an offset into this section the function returns the name
124 // of the symbol used for the relocation at the offset.
125 std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
129 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
131 if (std::error_code EC = Symbol.getName(Name))
133 return object_error::success;
136 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
137 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
138 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
139 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
140 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
141 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
142 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
143 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
144 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
145 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
146 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
147 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
148 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
149 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
150 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
151 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
152 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
153 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
154 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
155 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
156 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
157 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
160 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
161 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
162 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
163 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
164 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
165 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
166 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
167 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
168 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
169 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
170 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
171 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
172 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
173 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
174 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
175 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
178 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
179 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
180 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
181 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
182 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
183 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
184 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
185 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
186 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
187 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
188 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
189 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
192 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
193 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
194 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
195 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
196 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
197 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
198 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
199 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
200 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
201 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
202 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
203 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
206 static const EnumEntry<COFF::SectionCharacteristics>
207 ImageSectionCharacteristics[] = {
208 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
209 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
210 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
211 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
212 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
213 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
214 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
215 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
216 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
217 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
218 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
219 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
220 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
221 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
222 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
223 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
224 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
225 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
226 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
227 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
228 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
229 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
230 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
231 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
232 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
233 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
234 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
235 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
236 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
237 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
238 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
239 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
240 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
241 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
242 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
245 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
246 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
247 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
248 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
249 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
250 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
251 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
252 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
253 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
254 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
255 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
256 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
257 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
258 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
259 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
260 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
261 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
264 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
265 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
266 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
267 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
268 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
271 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
272 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
273 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
274 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
275 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
276 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
277 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
278 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
279 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
280 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
281 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
282 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
283 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
284 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
285 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
286 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
287 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
288 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
289 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
290 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
291 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
292 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
293 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
294 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
295 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
296 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
297 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
298 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
301 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
302 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
303 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
304 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
305 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
306 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
307 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
308 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
311 static const EnumEntry<COFF::WeakExternalCharacteristics>
312 WeakExternalCharacteristics[] = {
313 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
314 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
315 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
318 template <typename T>
319 static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
320 COFFSymbolRef Symbol,
321 uint8_t AuxSymbolIdx, const T *&Aux) {
322 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
323 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
324 Aux = reinterpret_cast<const T*>(AuxData.data());
325 return readobj_error::success;
328 void COFFDumper::cacheRelocations() {
329 for (const SectionRef &S : Obj->sections()) {
330 const coff_section *Section = Obj->getCOFFSection(S);
332 for (const RelocationRef &Reloc : S.relocations())
333 RelocMap[Section].push_back(Reloc);
335 // Sort relocations by address.
336 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
341 void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
342 const data_directory *Data;
343 if (Obj->getDataDirectory(Index, Data))
345 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
346 W.printHex(FieldName + "Size", Data->Size);
349 void COFFDumper::printFileHeaders() {
350 time_t TDS = Obj->getTimeDateStamp();
351 char FormattedTime[20] = { };
352 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
355 DictScope D(W, "ImageFileHeader");
356 W.printEnum ("Machine", Obj->getMachine(),
357 makeArrayRef(ImageFileMachineType));
358 W.printNumber("SectionCount", Obj->getNumberOfSections());
359 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
360 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
361 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
362 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
363 W.printFlags ("Characteristics", Obj->getCharacteristics(),
364 makeArrayRef(ImageFileCharacteristics));
367 // Print PE header. This header does not exist if this is an object file and
368 // not an executable.
369 const pe32_header *PEHeader = nullptr;
370 if (error(Obj->getPE32Header(PEHeader)))
373 printPEHeader<pe32_header>(PEHeader);
375 const pe32plus_header *PEPlusHeader = nullptr;
376 if (error(Obj->getPE32PlusHeader(PEPlusHeader)))
379 printPEHeader<pe32plus_header>(PEPlusHeader);
382 template <class PEHeader>
383 void COFFDumper::printPEHeader(const PEHeader *Hdr) {
384 DictScope D(W, "ImageOptionalHeader");
385 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
386 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
387 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
388 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
389 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
390 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
391 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
392 printBaseOfDataField(Hdr);
393 W.printHex ("ImageBase", Hdr->ImageBase);
394 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
395 W.printNumber("FileAlignment", Hdr->FileAlignment);
396 W.printNumber("MajorOperatingSystemVersion",
397 Hdr->MajorOperatingSystemVersion);
398 W.printNumber("MinorOperatingSystemVersion",
399 Hdr->MinorOperatingSystemVersion);
400 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
401 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
402 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
403 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
404 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
405 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
406 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
407 W.printFlags ("Subsystem", Hdr->DLLCharacteristics,
408 makeArrayRef(PEDLLCharacteristics));
409 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
410 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
411 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
412 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
413 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
415 if (Hdr->NumberOfRvaAndSize > 0) {
416 DictScope D(W, "DataDirectory");
417 static const char * const directory[] = {
418 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
419 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
420 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
421 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
424 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
425 printDataDirectory(i, directory[i]);
430 void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
431 W.printHex("BaseOfData", Hdr->BaseOfData);
434 void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
436 void COFFDumper::printCodeViewLineTables(const SectionRef &Section) {
438 if (error(Section.getContents(Data)))
441 SmallVector<StringRef, 10> FunctionNames;
442 StringMap<StringRef> FunctionLineTables;
443 StringRef FileIndexToStringOffsetTable;
444 StringRef StringTable;
446 ListScope D(W, "CodeViewLineTables");
448 DataExtractor DE(Data, true, 4);
450 Magic = DE.getU32(&Offset);
451 W.printHex("Magic", Magic);
452 if (Magic != COFF::DEBUG_SECTION_MAGIC) {
453 error(object_error::parse_failed);
457 bool Finished = false;
458 while (DE.isValidOffset(Offset) && !Finished) {
459 // The section consists of a number of subsection in the following format:
460 // |Type|PayloadSize|Payload...|
461 uint32_t SubSectionType = DE.getU32(&Offset),
462 PayloadSize = DE.getU32(&Offset);
463 ListScope S(W, "Subsection");
464 W.printHex("Type", SubSectionType);
465 W.printHex("PayloadSize", PayloadSize);
466 if (PayloadSize > Data.size() - Offset) {
467 error(object_error::parse_failed);
471 // Print the raw contents to simplify debugging if anything goes wrong
473 StringRef Contents = Data.substr(Offset, PayloadSize);
474 W.printBinaryBlock("Contents", Contents);
476 switch (SubSectionType) {
477 case COFF::DEBUG_LINE_TABLE_SUBSECTION: {
478 // Holds a PC to file:line table. Some data to parse this subsection is
479 // stored in the other subsections, so just check sanity and store the
480 // pointers for deferred processing.
482 if (PayloadSize < 12) {
483 // There should be at least three words to store two function
484 // relocations and size of the code.
485 error(object_error::parse_failed);
489 StringRef FunctionName;
490 if (error(resolveSymbolName(Obj->getCOFFSection(Section), Offset,
493 W.printString("FunctionName", FunctionName);
494 if (FunctionLineTables.count(FunctionName) != 0) {
495 // Saw debug info for this function already?
496 error(object_error::parse_failed);
500 FunctionLineTables[FunctionName] = Contents;
501 FunctionNames.push_back(FunctionName);
504 case COFF::DEBUG_STRING_TABLE_SUBSECTION:
505 if (PayloadSize == 0 || StringTable.data() != nullptr ||
506 Contents.back() != '\0') {
507 // Empty or duplicate or non-null-terminated subsection.
508 error(object_error::parse_failed);
511 StringTable = Contents;
513 case COFF::DEBUG_INDEX_SUBSECTION:
514 // Holds the translation table from file indices
515 // to offsets in the string table.
517 if (PayloadSize == 0 ||
518 FileIndexToStringOffsetTable.data() != nullptr) {
519 // Empty or duplicate subsection.
520 error(object_error::parse_failed);
523 FileIndexToStringOffsetTable = Contents;
526 Offset += PayloadSize;
528 // Align the reading pointer by 4.
529 Offset += (-Offset) % 4;
533 // Dump the line tables now that we've read all the subsections and know all
534 // the required information.
535 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
536 StringRef Name = FunctionNames[I];
537 ListScope S(W, "FunctionLineTable");
538 W.printString("FunctionName", Name);
540 DataExtractor DE(FunctionLineTables[Name], true, 4);
541 uint32_t Offset = 8; // Skip relocations.
542 uint32_t FunctionSize = DE.getU32(&Offset);
543 W.printHex("CodeSize", FunctionSize);
544 while (DE.isValidOffset(Offset)) {
545 // For each range of lines with the same filename, we have a segment
546 // in the line table. The filename string is accessed using double
547 // indirection to the string table subsection using the index subsection.
548 uint32_t OffsetInIndex = DE.getU32(&Offset),
549 SegmentLength = DE.getU32(&Offset),
550 FullSegmentSize = DE.getU32(&Offset);
551 if (FullSegmentSize != 12 + 8 * SegmentLength) {
552 error(object_error::parse_failed);
556 uint32_t FilenameOffset;
558 DataExtractor SDE(FileIndexToStringOffsetTable, true, 4);
559 uint32_t OffsetInSDE = OffsetInIndex;
560 if (!SDE.isValidOffset(OffsetInSDE)) {
561 error(object_error::parse_failed);
564 FilenameOffset = SDE.getU32(&OffsetInSDE);
567 if (FilenameOffset == 0 || FilenameOffset + 1 >= StringTable.size() ||
568 StringTable.data()[FilenameOffset - 1] != '\0') {
569 // Each string in an F3 subsection should be preceded by a null
571 error(object_error::parse_failed);
575 StringRef Filename(StringTable.data() + FilenameOffset);
576 ListScope S(W, "FilenameSegment");
577 W.printString("Filename", Filename);
578 for (unsigned J = 0; J != SegmentLength && DE.isValidOffset(Offset);
580 // Then go the (PC, LineNumber) pairs. The line number is stored in the
581 // least significant 31 bits of the respective word in the table.
582 uint32_t PC = DE.getU32(&Offset),
583 LineNumber = DE.getU32(&Offset) & 0x7fffffff;
584 if (PC >= FunctionSize) {
585 error(object_error::parse_failed);
589 format("+0x%X", PC).snprint(Buffer, 32);
590 W.printNumber(Buffer, LineNumber);
596 void COFFDumper::printSections() {
597 ListScope SectionsD(W, "Sections");
598 int SectionNumber = 0;
599 for (const SectionRef &Sec : Obj->sections()) {
601 const coff_section *Section = Obj->getCOFFSection(Sec);
604 if (error(Sec.getName(Name)))
607 DictScope D(W, "Section");
608 W.printNumber("Number", SectionNumber);
609 W.printBinary("Name", Name, Section->Name);
610 W.printHex ("VirtualSize", Section->VirtualSize);
611 W.printHex ("VirtualAddress", Section->VirtualAddress);
612 W.printNumber("RawDataSize", Section->SizeOfRawData);
613 W.printHex ("PointerToRawData", Section->PointerToRawData);
614 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
615 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
616 W.printNumber("RelocationCount", Section->NumberOfRelocations);
617 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
618 W.printFlags ("Characteristics", Section->Characteristics,
619 makeArrayRef(ImageSectionCharacteristics),
620 COFF::SectionCharacteristics(0x00F00000));
622 if (opts::SectionRelocations) {
623 ListScope D(W, "Relocations");
624 for (const RelocationRef &Reloc : Sec.relocations())
625 printRelocation(Sec, Reloc);
628 if (opts::SectionSymbols) {
629 ListScope D(W, "Symbols");
630 for (const SymbolRef &Symbol : Obj->symbols()) {
631 bool Contained = false;
632 if (Sec.containsSymbol(Symbol, Contained) || !Contained)
639 if (Name == ".debug$S" && opts::CodeViewLineTables)
640 printCodeViewLineTables(Sec);
642 if (opts::SectionData &&
643 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
645 if (error(Sec.getContents(Data)))
648 W.printBinaryBlock("SectionData", Data);
653 void COFFDumper::printRelocations() {
654 ListScope D(W, "Relocations");
656 int SectionNumber = 0;
657 for (const SectionRef &Section : Obj->sections()) {
660 if (error(Section.getName(Name)))
663 bool PrintedGroup = false;
664 for (const RelocationRef &Reloc : Section.relocations()) {
666 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
671 printRelocation(Section, Reloc);
676 W.startLine() << "}\n";
681 void COFFDumper::printRelocation(const SectionRef &Section,
682 const RelocationRef &Reloc) {
685 SmallString<32> RelocName;
686 StringRef SymbolName;
688 if (error(Reloc.getOffset(Offset)))
690 if (error(Reloc.getType(RelocType)))
692 if (error(Reloc.getTypeName(RelocName)))
694 symbol_iterator Symbol = Reloc.getSymbol();
695 if (error(Symbol->getName(SymbolName)))
697 if (error(Section.getContents(Contents)))
700 if (opts::ExpandRelocs) {
701 DictScope Group(W, "Relocation");
702 W.printHex("Offset", Offset);
703 W.printNumber("Type", RelocName, RelocType);
704 W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
706 raw_ostream& OS = W.startLine();
709 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
714 void COFFDumper::printSymbols() {
715 ListScope Group(W, "Symbols");
717 for (const SymbolRef &Symbol : Obj->symbols())
721 void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
723 static StringRef getSectionName(const llvm::object::COFFObjectFile *Obj,
724 COFFSymbolRef Symbol,
725 const coff_section *Section) {
727 StringRef SectionName;
728 Obj->getSectionName(Section, SectionName);
731 int32_t SectionNumber = Symbol.getSectionNumber();
732 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
733 return "IMAGE_SYM_DEBUG";
734 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
735 return "IMAGE_SYM_ABSOLUTE";
736 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
737 return "IMAGE_SYM_UNDEFINED";
741 void COFFDumper::printSymbol(const SymbolRef &Sym) {
742 DictScope D(W, "Symbol");
744 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
745 const coff_section *Section;
746 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
747 W.startLine() << "Invalid section number: " << EC.message() << "\n";
752 StringRef SymbolName;
753 if (Obj->getSymbolName(Symbol, SymbolName))
756 StringRef SectionName = getSectionName(Obj, Symbol, Section);
758 W.printString("Name", SymbolName);
759 W.printNumber("Value", Symbol.getValue());
760 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
761 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
762 W.printEnum ("ComplexType", Symbol.getComplexType(),
763 makeArrayRef(ImageSymDType));
764 W.printEnum ("StorageClass", Symbol.getStorageClass(),
765 makeArrayRef(ImageSymClass));
766 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
768 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
769 if (Symbol.isFunctionDefinition()) {
770 const coff_aux_function_definition *Aux;
771 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
774 DictScope AS(W, "AuxFunctionDef");
775 W.printNumber("TagIndex", Aux->TagIndex);
776 W.printNumber("TotalSize", Aux->TotalSize);
777 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
778 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
780 } else if (Symbol.isWeakExternal()) {
781 const coff_aux_weak_external *Aux;
782 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
785 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
786 StringRef LinkedName;
787 std::error_code EC = Linked.getError();
788 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
793 DictScope AS(W, "AuxWeakExternal");
794 W.printNumber("Linked", LinkedName, Aux->TagIndex);
795 W.printEnum ("Search", Aux->Characteristics,
796 makeArrayRef(WeakExternalCharacteristics));
798 } else if (Symbol.isFileRecord()) {
799 const char *FileName;
800 if (error(getSymbolAuxData(Obj, Symbol, I, FileName)))
803 DictScope AS(W, "AuxFileRecord");
805 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
806 Obj->getSymbolTableEntrySize());
807 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
809 } else if (Symbol.isSectionDefinition()) {
810 const coff_aux_section_definition *Aux;
811 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
814 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
816 DictScope AS(W, "AuxSectionDef");
817 W.printNumber("Length", Aux->Length);
818 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
819 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
820 W.printHex("Checksum", Aux->CheckSum);
821 W.printNumber("Number", AuxNumber);
822 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
824 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
825 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
826 const coff_section *Assoc;
829 if ((EC = Obj->getSection(AuxNumber, Assoc)) ||
830 (EC = Obj->getSectionName(Assoc, AssocName))) {
835 W.printNumber("AssocSection", AssocName, AuxNumber);
837 } else if (Symbol.isCLRToken()) {
838 const coff_aux_clr_token *Aux;
839 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
842 ErrorOr<COFFSymbolRef> ReferredSym =
843 Obj->getSymbol(Aux->SymbolTableIndex);
844 StringRef ReferredName;
845 std::error_code EC = ReferredSym.getError();
846 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
851 DictScope AS(W, "AuxCLRToken");
852 W.printNumber("AuxType", Aux->AuxType);
853 W.printNumber("Reserved", Aux->Reserved);
854 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
857 W.startLine() << "<unhandled auxiliary record>\n";
862 void COFFDumper::printUnwindInfo() {
863 ListScope D(W, "UnwindInformation");
864 switch (Obj->getMachine()) {
865 case COFF::IMAGE_FILE_MACHINE_AMD64: {
866 Win64EH::Dumper Dumper(W);
867 Win64EH::Dumper::SymbolResolver
868 Resolver = [](const object::coff_section *Section, uint64_t Offset,
869 SymbolRef &Symbol, void *user_data) -> std::error_code {
870 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
871 return Dumper->resolveSymbol(Section, Offset, Symbol);
873 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
874 Dumper.printData(Ctx);
877 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
878 ARM::WinEH::Decoder Decoder(W);
879 Decoder.dumpProcedureData(*Obj);
883 W.printEnum("unsupported Image Machine", Obj->getMachine(),
884 makeArrayRef(ImageFileMachineType));
889 void COFFDumper::printImportedSymbols(imported_symbol_iterator I,
890 imported_symbol_iterator E) {
891 for (; I != E; ++I) {
893 if (error(I->getSymbolName(Sym))) return;
895 if (error(I->getOrdinal(Ordinal))) return;
896 W.printNumber("Symbol", Sym, Ordinal);
900 void COFFDumper::printCOFFImports() {
902 for (auto I = Obj->import_directory_begin(), E = Obj->import_directory_end();
904 DictScope Import(W, "Import");
906 if (error(I->getName(Name))) return;
907 W.printString("Name", Name);
909 if (error(I->getImportLookupTableRVA(Addr))) return;
910 W.printHex("ImportLookupTableRVA", Addr);
911 if (error(I->getImportAddressTableRVA(Addr))) return;
912 W.printHex("ImportAddressTableRVA", Addr);
913 printImportedSymbols(I->imported_symbol_begin(), I->imported_symbol_end());
917 for (auto I = Obj->delay_import_directory_begin(),
918 E = Obj->delay_import_directory_end();
920 DictScope Import(W, "DelayImport");
922 if (error(I->getName(Name))) return;
923 W.printString("Name", Name);
924 printImportedSymbols(I->imported_symbol_begin(), I->imported_symbol_end());