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 void printDOSHeader(const dos_header *DH);
67 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
68 void printBaseOfDataField(const pe32_header *Hdr);
69 void printBaseOfDataField(const pe32plus_header *Hdr);
71 void printCodeViewLineTables(const SectionRef &Section);
73 void printCodeViewSymbolsSubsection(StringRef Subsection,
74 const SectionRef &Section,
77 void cacheRelocations();
79 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
81 std::error_code resolveSymbolName(const coff_section *Section,
82 uint64_t Offset, StringRef &Name);
83 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
85 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
87 const llvm::object::COFFObjectFile *Obj;
89 StringRef CVFileIndexToStringOffsetTable;
90 StringRef CVStringTable;
98 std::error_code createCOFFDumper(const object::ObjectFile *Obj,
100 std::unique_ptr<ObjDumper> &Result) {
101 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
103 return readobj_error::unsupported_obj_file_format;
105 Result.reset(new COFFDumper(COFFObj, Writer));
106 return readobj_error::success;
111 // Given a a section and an offset into this section the function returns the
112 // symbol used for the relocation at the offset.
113 std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
114 uint64_t Offset, SymbolRef &Sym) {
115 const auto &Relocations = RelocMap[Section];
116 for (const auto &Relocation : Relocations) {
117 uint64_t RelocationOffset;
118 if (std::error_code EC = Relocation.getOffset(RelocationOffset))
121 if (RelocationOffset == Offset) {
122 Sym = *Relocation.getSymbol();
123 return readobj_error::success;
126 return readobj_error::unknown_symbol;
129 // Given a section and an offset into this section the function returns the name
130 // of the symbol used for the relocation at the offset.
131 std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
135 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
137 if (std::error_code EC = Symbol.getName(Name))
139 return object_error::success;
142 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
143 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
144 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
145 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
146 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
147 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
148 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
149 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
150 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
151 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
152 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
153 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
154 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
155 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
156 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
157 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
158 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
159 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
160 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
161 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
162 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
163 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
166 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
167 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
168 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
169 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
170 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
171 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
172 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
173 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
174 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
175 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
176 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
177 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
178 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
179 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
180 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
181 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
184 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
185 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
186 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
187 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
188 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
189 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
190 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
191 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
192 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
193 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
194 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
195 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
198 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
199 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
200 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
201 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
202 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
203 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
204 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
205 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
206 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
207 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
208 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
209 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
212 static const EnumEntry<COFF::SectionCharacteristics>
213 ImageSectionCharacteristics[] = {
214 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
215 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
216 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
217 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
218 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
219 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
220 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
221 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
222 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
223 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
224 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
225 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
226 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
227 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
228 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
229 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
230 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
231 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
232 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
233 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
234 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
235 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
236 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
237 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
238 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
239 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
240 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
241 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
242 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
243 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
244 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
245 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
246 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
247 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
248 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
251 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
252 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
253 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
254 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
255 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
256 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
257 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
258 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
259 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
260 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
261 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
262 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
263 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
264 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
265 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
266 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
267 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
270 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
271 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
272 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
273 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
274 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
277 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
278 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
279 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
280 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
281 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
282 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
283 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
284 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
285 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
286 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
287 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
288 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
289 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
290 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
291 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
292 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
293 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
294 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
295 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
296 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
297 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
298 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
299 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
300 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
301 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
302 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
303 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
304 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
307 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
308 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
309 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
310 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
311 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
312 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
313 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
314 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
317 static const EnumEntry<COFF::WeakExternalCharacteristics>
318 WeakExternalCharacteristics[] = {
319 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
320 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
321 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
324 template <typename T>
325 static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
326 COFFSymbolRef Symbol,
327 uint8_t AuxSymbolIdx, const T *&Aux) {
328 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
329 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
330 Aux = reinterpret_cast<const T*>(AuxData.data());
331 return readobj_error::success;
334 void COFFDumper::cacheRelocations() {
335 for (const SectionRef &S : Obj->sections()) {
336 const coff_section *Section = Obj->getCOFFSection(S);
338 for (const RelocationRef &Reloc : S.relocations())
339 RelocMap[Section].push_back(Reloc);
341 // Sort relocations by address.
342 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
347 void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
348 const data_directory *Data;
349 if (Obj->getDataDirectory(Index, Data))
351 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
352 W.printHex(FieldName + "Size", Data->Size);
355 void COFFDumper::printFileHeaders() {
356 time_t TDS = Obj->getTimeDateStamp();
357 char FormattedTime[20] = { };
358 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
361 DictScope D(W, "ImageFileHeader");
362 W.printEnum ("Machine", Obj->getMachine(),
363 makeArrayRef(ImageFileMachineType));
364 W.printNumber("SectionCount", Obj->getNumberOfSections());
365 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
366 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
367 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
368 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
369 W.printFlags ("Characteristics", Obj->getCharacteristics(),
370 makeArrayRef(ImageFileCharacteristics));
373 // Print PE header. This header does not exist if this is an object file and
374 // not an executable.
375 const pe32_header *PEHeader = nullptr;
376 if (error(Obj->getPE32Header(PEHeader)))
379 printPEHeader<pe32_header>(PEHeader);
381 const pe32plus_header *PEPlusHeader = nullptr;
382 if (error(Obj->getPE32PlusHeader(PEPlusHeader)))
385 printPEHeader<pe32plus_header>(PEPlusHeader);
387 if (const dos_header *DH = Obj->getDOSHeader())
391 void COFFDumper::printDOSHeader(const dos_header *DH) {
392 DictScope D(W, "DOSHeader");
393 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
394 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
395 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
396 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
397 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
398 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
399 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
400 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
401 W.printNumber("InitialSP", DH->InitialSP);
402 W.printNumber("Checksum", DH->Checksum);
403 W.printNumber("InitialIP", DH->InitialIP);
404 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
405 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
406 W.printNumber("OverlayNumber", DH->OverlayNumber);
407 W.printNumber("OEMid", DH->OEMid);
408 W.printNumber("OEMinfo", DH->OEMinfo);
409 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
412 template <class PEHeader>
413 void COFFDumper::printPEHeader(const PEHeader *Hdr) {
414 DictScope D(W, "ImageOptionalHeader");
415 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
416 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
417 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
418 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
419 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
420 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
421 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
422 printBaseOfDataField(Hdr);
423 W.printHex ("ImageBase", Hdr->ImageBase);
424 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
425 W.printNumber("FileAlignment", Hdr->FileAlignment);
426 W.printNumber("MajorOperatingSystemVersion",
427 Hdr->MajorOperatingSystemVersion);
428 W.printNumber("MinorOperatingSystemVersion",
429 Hdr->MinorOperatingSystemVersion);
430 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
431 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
432 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
433 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
434 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
435 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
436 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
437 W.printFlags ("Subsystem", Hdr->DLLCharacteristics,
438 makeArrayRef(PEDLLCharacteristics));
439 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
440 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
441 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
442 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
443 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
445 if (Hdr->NumberOfRvaAndSize > 0) {
446 DictScope D(W, "DataDirectory");
447 static const char * const directory[] = {
448 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
449 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
450 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
451 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
454 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
455 printDataDirectory(i, directory[i]);
460 void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
461 W.printHex("BaseOfData", Hdr->BaseOfData);
464 void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
466 void COFFDumper::printCodeViewLineTables(const SectionRef &Section) {
468 if (error(Section.getContents(Data)))
471 SmallVector<StringRef, 10> FunctionNames;
472 StringMap<StringRef> FunctionLineTables;
474 ListScope D(W, "CodeViewLineTables");
476 // FIXME: Add more offset correctness checks.
477 DataExtractor DE(Data, true, 4);
479 Magic = DE.getU32(&Offset);
480 W.printHex("Magic", Magic);
481 if (Magic != COFF::DEBUG_SECTION_MAGIC) {
482 error(object_error::parse_failed);
486 bool Finished = false;
487 while (DE.isValidOffset(Offset) && !Finished) {
488 // The section consists of a number of subsection in the following format:
489 // |Type|PayloadSize|Payload...|
490 uint32_t SubSectionType = DE.getU32(&Offset),
491 PayloadSize = DE.getU32(&Offset);
492 ListScope S(W, "Subsection");
493 W.printHex("Type", SubSectionType);
494 W.printHex("PayloadSize", PayloadSize);
495 if (PayloadSize > Data.size() - Offset) {
496 error(object_error::parse_failed);
500 // Print the raw contents to simplify debugging if anything goes wrong
502 StringRef Contents = Data.substr(Offset, PayloadSize);
503 W.printBinaryBlock("Contents", Contents);
505 switch (SubSectionType) {
506 case COFF::DEBUG_SYMBOL_SUBSECTION:
507 printCodeViewSymbolsSubsection(Contents, Section, Offset);
509 case COFF::DEBUG_LINE_TABLE_SUBSECTION: {
510 // Holds a PC to file:line table. Some data to parse this subsection is
511 // stored in the other subsections, so just check sanity and store the
512 // pointers for deferred processing.
514 if (PayloadSize < 12) {
515 // There should be at least three words to store two function
516 // relocations and size of the code.
517 error(object_error::parse_failed);
521 StringRef FunctionName;
522 if (error(resolveSymbolName(Obj->getCOFFSection(Section), Offset,
525 W.printString("FunctionName", FunctionName);
526 if (FunctionLineTables.count(FunctionName) != 0) {
527 // Saw debug info for this function already?
528 error(object_error::parse_failed);
532 FunctionLineTables[FunctionName] = Contents;
533 FunctionNames.push_back(FunctionName);
536 case COFF::DEBUG_STRING_TABLE_SUBSECTION:
537 if (PayloadSize == 0 || CVStringTable.data() != nullptr ||
538 Contents.back() != '\0') {
539 // Empty or duplicate or non-null-terminated subsection.
540 error(object_error::parse_failed);
543 CVStringTable = Contents;
545 case COFF::DEBUG_INDEX_SUBSECTION:
546 // Holds the translation table from file indices
547 // to offsets in the string table.
549 if (PayloadSize == 0 ||
550 CVFileIndexToStringOffsetTable.data() != nullptr) {
551 // Empty or duplicate subsection.
552 error(object_error::parse_failed);
555 CVFileIndexToStringOffsetTable = Contents;
558 Offset += PayloadSize;
560 // Align the reading pointer by 4.
561 Offset += (-Offset) % 4;
565 // Dump the line tables now that we've read all the subsections and know all
566 // the required information.
567 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
568 StringRef Name = FunctionNames[I];
569 ListScope S(W, "FunctionLineTable");
570 W.printString("FunctionName", Name);
572 DataExtractor DE(FunctionLineTables[Name], true, 4);
573 uint32_t Offset = 8; // Skip relocations.
574 uint32_t FunctionSize = DE.getU32(&Offset);
575 W.printHex("CodeSize", FunctionSize);
576 while (DE.isValidOffset(Offset)) {
577 // For each range of lines with the same filename, we have a segment
578 // in the line table. The filename string is accessed using double
579 // indirection to the string table subsection using the index subsection.
580 uint32_t OffsetInIndex = DE.getU32(&Offset),
581 SegmentLength = DE.getU32(&Offset),
582 FullSegmentSize = DE.getU32(&Offset);
583 if (FullSegmentSize != 12 + 8 * SegmentLength) {
584 error(object_error::parse_failed);
588 uint32_t FilenameOffset;
590 DataExtractor SDE(CVFileIndexToStringOffsetTable, true, 4);
591 uint32_t OffsetInSDE = OffsetInIndex;
592 if (!SDE.isValidOffset(OffsetInSDE)) {
593 error(object_error::parse_failed);
596 FilenameOffset = SDE.getU32(&OffsetInSDE);
599 if (FilenameOffset == 0 || FilenameOffset + 1 >= CVStringTable.size() ||
600 CVStringTable.data()[FilenameOffset - 1] != '\0') {
601 // Each string in an F3 subsection should be preceded by a null
603 error(object_error::parse_failed);
607 StringRef Filename(CVStringTable.data() + FilenameOffset);
608 ListScope S(W, "FilenameSegment");
609 W.printString("Filename", Filename);
610 for (unsigned J = 0; J != SegmentLength && DE.isValidOffset(Offset);
612 // Then go the (PC, LineNumber) pairs. The line number is stored in the
613 // least significant 31 bits of the respective word in the table.
614 uint32_t PC = DE.getU32(&Offset),
615 LineNumber = DE.getU32(&Offset) & 0x7fffffff;
616 if (PC >= FunctionSize) {
617 error(object_error::parse_failed);
621 format("+0x%X", PC).snprint(Buffer, 32);
622 W.printNumber(Buffer, LineNumber);
628 void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
629 const SectionRef &Section,
630 uint32_t OffsetInSection) {
631 if (Subsection.size() == 0) {
632 error(object_error::parse_failed);
635 DataExtractor DE(Subsection, true, 4);
638 // Function-level subsections have "procedure start" and "procedure end"
639 // commands that should come in pairs and surround relevant info.
640 bool InFunctionScope = false;
641 while (DE.isValidOffset(Offset)) {
642 // Read subsection segments one by one.
643 uint16_t Size = DE.getU16(&Offset);
644 // The section size includes the size of the type identifier.
645 if (Size < 2 || !DE.isValidOffsetForDataOfSize(Offset, Size)) {
646 error(object_error::parse_failed);
650 uint16_t Type = DE.getU16(&Offset);
652 case COFF::DEBUG_SYMBOL_TYPE_PROC_START: {
653 DictScope S(W, "ProcStart");
654 if (InFunctionScope || Size < 36) {
655 error(object_error::parse_failed);
658 InFunctionScope = true;
660 // We're currently interested in a limited subset of fields in this
661 // segment, just ignore the rest of the fields for now.
663 DE.getU8(&Offset, Unused, 12);
664 uint32_t CodeSize = DE.getU32(&Offset);
665 DE.getU8(&Offset, Unused, 12);
666 StringRef SectionName;
667 if (error(resolveSymbolName(Obj->getCOFFSection(Section),
668 OffsetInSection + Offset, SectionName)))
671 DE.getU8(&Offset, Unused, 3);
672 StringRef FunctionName = DE.getCStr(&Offset);
673 if (!DE.isValidOffset(Offset)) {
674 error(object_error::parse_failed);
677 W.printString("FunctionName", FunctionName);
678 W.printString("Section", SectionName);
679 W.printHex("CodeSize", CodeSize);
683 case COFF::DEBUG_SYMBOL_TYPE_PROC_END: {
684 W.startLine() << "ProcEnd\n";
685 if (!InFunctionScope || Size > 0) {
686 error(object_error::parse_failed);
689 InFunctionScope = false;
699 error(object_error::parse_failed);
702 void COFFDumper::printSections() {
703 ListScope SectionsD(W, "Sections");
704 int SectionNumber = 0;
705 for (const SectionRef &Sec : Obj->sections()) {
707 const coff_section *Section = Obj->getCOFFSection(Sec);
710 if (error(Sec.getName(Name)))
713 DictScope D(W, "Section");
714 W.printNumber("Number", SectionNumber);
715 W.printBinary("Name", Name, Section->Name);
716 W.printHex ("VirtualSize", Section->VirtualSize);
717 W.printHex ("VirtualAddress", Section->VirtualAddress);
718 W.printNumber("RawDataSize", Section->SizeOfRawData);
719 W.printHex ("PointerToRawData", Section->PointerToRawData);
720 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
721 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
722 W.printNumber("RelocationCount", Section->NumberOfRelocations);
723 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
724 W.printFlags ("Characteristics", Section->Characteristics,
725 makeArrayRef(ImageSectionCharacteristics),
726 COFF::SectionCharacteristics(0x00F00000));
728 if (opts::SectionRelocations) {
729 ListScope D(W, "Relocations");
730 for (const RelocationRef &Reloc : Sec.relocations())
731 printRelocation(Sec, Reloc);
734 if (opts::SectionSymbols) {
735 ListScope D(W, "Symbols");
736 for (const SymbolRef &Symbol : Obj->symbols()) {
737 if (!Sec.containsSymbol(Symbol))
744 if (Name == ".debug$S" && opts::CodeViewLineTables)
745 printCodeViewLineTables(Sec);
747 if (opts::SectionData &&
748 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
750 if (error(Sec.getContents(Data)))
753 W.printBinaryBlock("SectionData", Data);
758 void COFFDumper::printRelocations() {
759 ListScope D(W, "Relocations");
761 int SectionNumber = 0;
762 for (const SectionRef &Section : Obj->sections()) {
765 if (error(Section.getName(Name)))
768 bool PrintedGroup = false;
769 for (const RelocationRef &Reloc : Section.relocations()) {
771 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
776 printRelocation(Section, Reloc);
781 W.startLine() << "}\n";
786 void COFFDumper::printRelocation(const SectionRef &Section,
787 const RelocationRef &Reloc) {
790 SmallString<32> RelocName;
791 StringRef SymbolName;
793 if (error(Reloc.getOffset(Offset)))
795 if (error(Reloc.getType(RelocType)))
797 if (error(Reloc.getTypeName(RelocName)))
799 symbol_iterator Symbol = Reloc.getSymbol();
800 if (error(Symbol->getName(SymbolName)))
802 if (error(Section.getContents(Contents)))
805 if (opts::ExpandRelocs) {
806 DictScope Group(W, "Relocation");
807 W.printHex("Offset", Offset);
808 W.printNumber("Type", RelocName, RelocType);
809 W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
811 raw_ostream& OS = W.startLine();
814 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
819 void COFFDumper::printSymbols() {
820 ListScope Group(W, "Symbols");
822 for (const SymbolRef &Symbol : Obj->symbols())
826 void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
828 static StringRef getSectionName(const llvm::object::COFFObjectFile *Obj,
829 COFFSymbolRef Symbol,
830 const coff_section *Section) {
832 StringRef SectionName;
833 Obj->getSectionName(Section, SectionName);
836 int32_t SectionNumber = Symbol.getSectionNumber();
837 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
838 return "IMAGE_SYM_DEBUG";
839 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
840 return "IMAGE_SYM_ABSOLUTE";
841 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
842 return "IMAGE_SYM_UNDEFINED";
846 void COFFDumper::printSymbol(const SymbolRef &Sym) {
847 DictScope D(W, "Symbol");
849 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
850 const coff_section *Section;
851 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
852 W.startLine() << "Invalid section number: " << EC.message() << "\n";
857 StringRef SymbolName;
858 if (Obj->getSymbolName(Symbol, SymbolName))
861 StringRef SectionName = getSectionName(Obj, Symbol, Section);
863 W.printString("Name", SymbolName);
864 W.printNumber("Value", Symbol.getValue());
865 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
866 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
867 W.printEnum ("ComplexType", Symbol.getComplexType(),
868 makeArrayRef(ImageSymDType));
869 W.printEnum ("StorageClass", Symbol.getStorageClass(),
870 makeArrayRef(ImageSymClass));
871 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
873 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
874 if (Symbol.isFunctionDefinition()) {
875 const coff_aux_function_definition *Aux;
876 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
879 DictScope AS(W, "AuxFunctionDef");
880 W.printNumber("TagIndex", Aux->TagIndex);
881 W.printNumber("TotalSize", Aux->TotalSize);
882 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
883 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
885 } else if (Symbol.isAnyUndefined()) {
886 const coff_aux_weak_external *Aux;
887 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
890 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
891 StringRef LinkedName;
892 std::error_code EC = Linked.getError();
893 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
898 DictScope AS(W, "AuxWeakExternal");
899 W.printNumber("Linked", LinkedName, Aux->TagIndex);
900 W.printEnum ("Search", Aux->Characteristics,
901 makeArrayRef(WeakExternalCharacteristics));
903 } else if (Symbol.isFileRecord()) {
904 const char *FileName;
905 if (error(getSymbolAuxData(Obj, Symbol, I, FileName)))
908 DictScope AS(W, "AuxFileRecord");
910 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
911 Obj->getSymbolTableEntrySize());
912 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
914 } else if (Symbol.isSectionDefinition()) {
915 const coff_aux_section_definition *Aux;
916 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
919 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
921 DictScope AS(W, "AuxSectionDef");
922 W.printNumber("Length", Aux->Length);
923 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
924 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
925 W.printHex("Checksum", Aux->CheckSum);
926 W.printNumber("Number", AuxNumber);
927 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
929 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
930 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
931 const coff_section *Assoc;
934 if ((EC = Obj->getSection(AuxNumber, Assoc)) ||
935 (EC = Obj->getSectionName(Assoc, AssocName))) {
940 W.printNumber("AssocSection", AssocName, AuxNumber);
942 } else if (Symbol.isCLRToken()) {
943 const coff_aux_clr_token *Aux;
944 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
947 ErrorOr<COFFSymbolRef> ReferredSym =
948 Obj->getSymbol(Aux->SymbolTableIndex);
949 StringRef ReferredName;
950 std::error_code EC = ReferredSym.getError();
951 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
956 DictScope AS(W, "AuxCLRToken");
957 W.printNumber("AuxType", Aux->AuxType);
958 W.printNumber("Reserved", Aux->Reserved);
959 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
962 W.startLine() << "<unhandled auxiliary record>\n";
967 void COFFDumper::printUnwindInfo() {
968 ListScope D(W, "UnwindInformation");
969 switch (Obj->getMachine()) {
970 case COFF::IMAGE_FILE_MACHINE_AMD64: {
971 Win64EH::Dumper Dumper(W);
972 Win64EH::Dumper::SymbolResolver
973 Resolver = [](const object::coff_section *Section, uint64_t Offset,
974 SymbolRef &Symbol, void *user_data) -> std::error_code {
975 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
976 return Dumper->resolveSymbol(Section, Offset, Symbol);
978 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
979 Dumper.printData(Ctx);
982 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
983 ARM::WinEH::Decoder Decoder(W);
984 Decoder.dumpProcedureData(*Obj);
988 W.printEnum("unsupported Image Machine", Obj->getMachine(),
989 makeArrayRef(ImageFileMachineType));
994 void COFFDumper::printImportedSymbols(
995 iterator_range<imported_symbol_iterator> Range) {
996 for (const ImportedSymbolRef &I : Range) {
998 if (error(I.getSymbolName(Sym))) return;
1000 if (error(I.getOrdinal(Ordinal))) return;
1001 W.printNumber("Symbol", Sym, Ordinal);
1005 void COFFDumper::printCOFFImports() {
1007 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
1008 DictScope Import(W, "Import");
1010 if (error(I.getName(Name))) return;
1011 W.printString("Name", Name);
1013 if (error(I.getImportLookupTableRVA(Addr))) return;
1014 W.printHex("ImportLookupTableRVA", Addr);
1015 if (error(I.getImportAddressTableRVA(Addr))) return;
1016 W.printHex("ImportAddressTableRVA", Addr);
1017 printImportedSymbols(I.imported_symbols());
1021 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
1022 DictScope Import(W, "DelayImport");
1024 if (error(I.getName(Name))) return;
1025 W.printString("Name", Name);
1026 const delay_import_directory_table_entry *Table;
1027 if (error(I.getDelayImportTable(Table))) return;
1028 W.printHex("Attributes", Table->Attributes);
1029 W.printHex("ModuleHandle", Table->ModuleHandle);
1030 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
1031 W.printHex("ImportNameTable", Table->DelayImportNameTable);
1032 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
1033 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
1034 printImportedSymbols(I.imported_symbols());
1038 void COFFDumper::printCOFFDirectives() {
1039 for (const SectionRef &Section : Obj->sections()) {
1043 if (error(Section.getName(Name)))
1045 if (Name != ".drectve")
1048 if (error(Section.getContents(Contents)))
1051 W.printString("Directive(s)", Contents);