blob: 04386875b95adb58bb5eddb1b9d132cb18af2bfd [file] [log] [blame]
Eric Christopher9cad53c2013-04-03 18:31:38 +00001//===-- COFFDumper.cpp - COFF-specific dumper -------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11/// \brief This file implements the COFF-specific dumper for llvm-readobj.
12///
13//===----------------------------------------------------------------------===//
14
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000015#include "ARMWinEHPrinter.h"
Reid Kleckner72e2ba72016-01-13 19:32:35 +000016#include "CodeView.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000017#include "Error.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000018#include "ObjDumper.h"
Lang Hames0000afd2015-06-26 23:56:53 +000019#include "StackMapPrinter.h"
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +000020#include "Win64EHDumper.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000021#include "llvm-readobj.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000022#include "llvm/ADT/DenseMap.h"
23#include "llvm/ADT/SmallString.h"
Colin LeMahieu9fbffee2014-11-19 17:10:39 +000024#include "llvm/ADT/StringExtras.h"
Zachary Turnera9054dd2017-01-11 00:35:43 +000025#include "llvm/DebugInfo/CodeView/CVTypeDumper.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000026#include "llvm/DebugInfo/CodeView/CodeView.h"
Reid Klecknere9ab3492016-01-14 19:20:17 +000027#include "llvm/DebugInfo/CodeView/Line.h"
Zachary Turnerc37cb0c2017-04-27 16:12:16 +000028#include "llvm/DebugInfo/CodeView/ModuleDebugFileChecksumFragment.h"
Zachary Turneredef1452017-05-02 16:56:09 +000029#include "llvm/DebugInfo/CodeView/ModuleDebugInlineeLinesFragment.h"
Zachary Turner05bd9f32017-04-28 23:41:36 +000030#include "llvm/DebugInfo/CodeView/ModuleDebugLineFragment.h"
Zachary Turneraaad5742016-05-23 23:41:13 +000031#include "llvm/DebugInfo/CodeView/RecordSerialization.h"
Zachary Turner2d5c2cd2017-05-03 17:11:11 +000032#include "llvm/DebugInfo/CodeView/StringTable.h"
Zachary Turner0d840742016-10-07 21:34:46 +000033#include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
Zachary Turneraaad5742016-05-23 23:41:13 +000034#include "llvm/DebugInfo/CodeView/SymbolDumpDelegate.h"
35#include "llvm/DebugInfo/CodeView/SymbolDumper.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000036#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
Zachary Turner629cb7d2017-01-11 23:24:22 +000037#include "llvm/DebugInfo/CodeView/TypeDumpVisitor.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000038#include "llvm/DebugInfo/CodeView/TypeIndex.h"
39#include "llvm/DebugInfo/CodeView/TypeRecord.h"
Reid Kleckner0b269742016-05-14 00:02:53 +000040#include "llvm/DebugInfo/CodeView/TypeStreamMerger.h"
Zachary Turner4efa0a42016-11-08 22:24:53 +000041#include "llvm/DebugInfo/CodeView/TypeTableBuilder.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000042#include "llvm/Object/COFF.h"
43#include "llvm/Object/ObjectFile.h"
Zachary Turnerd9dc2822017-03-02 20:52:51 +000044#include "llvm/Support/BinaryByteStream.h"
Zachary Turner05bd9f32017-04-28 23:41:36 +000045#include "llvm/Support/BinaryStreamReader.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000046#include "llvm/Support/COFF.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000047#include "llvm/Support/Casting.h"
48#include "llvm/Support/Compiler.h"
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000049#include "llvm/Support/DataExtractor.h"
Zachary Turner05bd9f32017-04-28 23:41:36 +000050#include "llvm/Support/FormatVariadic.h"
Zachary Turner7b327d02017-02-16 23:35:45 +000051#include "llvm/Support/Path.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000052#include "llvm/Support/ScopedPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000053#include "llvm/Support/SourceMgr.h"
54#include "llvm/Support/Win64EH.h"
55#include "llvm/Support/raw_ostream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000056#include <algorithm>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000057#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000058#include <system_error>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000059#include <time.h>
Eric Christopher9cad53c2013-04-03 18:31:38 +000060
61using namespace llvm;
62using namespace llvm::object;
Reid Kleckner72e2ba72016-01-13 19:32:35 +000063using namespace llvm::codeview;
Reid Kleckner6b3faef2016-01-13 23:44:57 +000064using namespace llvm::support;
Eric Christopher9cad53c2013-04-03 18:31:38 +000065using namespace llvm::Win64EH;
66
67namespace {
68
69class COFFDumper : public ObjDumper {
70public:
Zachary Turneraaad5742016-05-23 23:41:13 +000071 friend class COFFObjectDumpDelegate;
Zachary Turner88bb1632016-05-03 00:28:04 +000072 COFFDumper(const llvm::object::COFFObjectFile *Obj, ScopedPrinter &Writer)
Zachary Turner629cb7d2017-01-11 23:24:22 +000073 : ObjDumper(Writer), Obj(Obj), Writer(Writer) {}
Eric Christopher9cad53c2013-04-03 18:31:38 +000074
Craig Topperfd38cbe2014-08-30 16:48:34 +000075 void printFileHeaders() override;
76 void printSections() override;
77 void printRelocations() override;
78 void printSymbols() override;
79 void printDynamicSymbols() override;
80 void printUnwindInfo() override;
Rui Ueyama1e152d52014-10-02 17:02:18 +000081 void printCOFFImports() override;
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +000082 void printCOFFExports() override;
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +000083 void printCOFFDirectives() override;
Rui Ueyama74e85132014-11-19 00:18:07 +000084 void printCOFFBaseReloc() override;
Reid Kleckner2da433e2016-06-02 17:10:43 +000085 void printCOFFDebugDirectory() override;
Zachary Turner8d6396d2017-04-27 19:38:38 +000086 void printCOFFResources() override;
Reid Kleckner83ebad32015-12-16 18:28:12 +000087 void printCodeViewDebugInfo() override;
Reid Kleckner5d577522017-03-24 17:26:38 +000088 void mergeCodeViewTypes(llvm::codeview::TypeTableBuilder &CVIDs,
89 llvm::codeview::TypeTableBuilder &CVTypes) override;
Lang Hames0000afd2015-06-26 23:56:53 +000090 void printStackMap() const override;
Eric Christopher9cad53c2013-04-03 18:31:38 +000091private:
Alexey Samsonov27dc8392014-03-18 06:53:02 +000092 void printSymbol(const SymbolRef &Sym);
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +000093 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc,
94 uint64_t Bias = 0);
Rui Ueyamaed64342b2013-07-19 23:23:29 +000095 void printDataDirectory(uint32_t Index, const std::string &FieldName);
Eric Christopher9cad53c2013-04-03 18:31:38 +000096
David Majnemer50267222014-11-05 06:24:35 +000097 void printDOSHeader(const dos_header *DH);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +000098 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
99 void printBaseOfDataField(const pe32_header *Hdr);
100 void printBaseOfDataField(const pe32plus_header *Hdr);
101
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000102 void printCodeViewSymbolSection(StringRef SectionName, const SectionRef &Section);
103 void printCodeViewTypeSection(StringRef SectionName, const SectionRef &Section);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000104 StringRef getTypeName(TypeIndex Ty);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000105 StringRef getFileNameForFileOffset(uint32_t FileOffset);
106 void printFileNameForOffset(StringRef Label, uint32_t FileOffset);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000107 void printTypeIndex(StringRef FieldName, TypeIndex TI) {
108 // Forward to CVTypeDumper for simplicity.
Zachary Turner629cb7d2017-01-11 23:24:22 +0000109 CVTypeDumper::printTypeIndex(Writer, FieldName, TI, TypeDB);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000110 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000111
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000112 void printCodeViewSymbolsSubsection(StringRef Subsection,
113 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000114 StringRef SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000115
Reid Klecknerc31f5302016-01-15 18:06:25 +0000116 void printCodeViewFileChecksums(StringRef Subsection);
117
Reid Klecknere9ab3492016-01-14 19:20:17 +0000118 void printCodeViewInlineeLines(StringRef Subsection);
119
Reid Kleckner2893fd12016-01-14 17:51:54 +0000120 void printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000121 uint32_t RelocOffset, uint32_t Offset,
122 StringRef *RelocSym = nullptr);
123
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000124 void printBinaryBlockWithRelocs(StringRef Label, const SectionRef &Sec,
125 StringRef SectionContents, StringRef Block);
126
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000127 /// Given a .debug$S section, find the string table and file checksum table.
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000128 void initializeFileAndStringTables(BinaryStreamReader &Reader);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000129
Eric Christopher9cad53c2013-04-03 18:31:38 +0000130 void cacheRelocations();
131
Rafael Espindola4453e42942014-06-13 03:07:50 +0000132 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
133 SymbolRef &Sym);
134 std::error_code resolveSymbolName(const coff_section *Section,
135 uint64_t Offset, StringRef &Name);
Reid Kleckner2893fd12016-01-14 17:51:54 +0000136 std::error_code resolveSymbolName(const coff_section *Section,
137 StringRef SectionContents,
138 const void *RelocPtr, StringRef &Name);
Rui Ueyama979fb402014-10-09 02:16:38 +0000139 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +0000140 void printDelayImportedSymbols(
141 const DelayImportDirectoryEntryRef &I,
142 iterator_range<imported_symbol_iterator> Range);
Rui Ueyama15d99352014-10-03 00:41:58 +0000143
Eric Christopher9cad53c2013-04-03 18:31:38 +0000144 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
145
146 const llvm::object::COFFObjectFile *Obj;
Rafael Espindola76d650e2015-07-06 14:26:07 +0000147 bool RelocCached = false;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000148 RelocMapTy RelocMap;
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000149
150 BinaryByteStream ChecksumContents;
151 VarStreamArray<FileChecksumEntry> CVFileChecksumTable;
152
153 BinaryByteStream StringTableContents;
154 StringTableRef CVStringTable;
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000155
Zachary Turner629cb7d2017-01-11 23:24:22 +0000156 ScopedPrinter &Writer;
157 TypeDatabase TypeDB;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000158};
159
Zachary Turneraaad5742016-05-23 23:41:13 +0000160class COFFObjectDumpDelegate : public SymbolDumpDelegate {
161public:
162 COFFObjectDumpDelegate(COFFDumper &CD, const SectionRef &SR,
163 const COFFObjectFile *Obj, StringRef SectionContents)
Zachary Turner537014c2016-05-24 03:32:34 +0000164 : CD(CD), SR(SR), SectionContents(SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000165 Sec = Obj->getCOFFSection(SR);
166 }
167
Zachary Turner120faca2017-02-27 22:11:43 +0000168 uint32_t getRecordOffset(BinaryStreamReader Reader) override {
Zachary Turner4d49eb92016-10-20 18:31:19 +0000169 ArrayRef<uint8_t> Data;
170 if (auto EC = Reader.readLongestContiguousChunk(Data)) {
171 llvm::consumeError(std::move(EC));
172 return 0;
173 }
174 return Data.data() - SectionContents.bytes_begin();
Zachary Turneraaad5742016-05-23 23:41:13 +0000175 }
176
177 void printRelocatedField(StringRef Label, uint32_t RelocOffset,
178 uint32_t Offset, StringRef *RelocSym) override {
179 CD.printRelocatedField(Label, Sec, RelocOffset, Offset, RelocSym);
180 }
181
182 void printBinaryBlockWithRelocs(StringRef Label,
183 ArrayRef<uint8_t> Block) override {
184 StringRef SBlock(reinterpret_cast<const char *>(Block.data()),
185 Block.size());
186 if (opts::CodeViewSubsectionBytes)
187 CD.printBinaryBlockWithRelocs(Label, SR, SectionContents, SBlock);
188 }
189
190 StringRef getFileNameForFileOffset(uint32_t FileOffset) override {
191 return CD.getFileNameForFileOffset(FileOffset);
192 }
193
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000194 StringTableRef getStringTable() override { return CD.CVStringTable; }
Zachary Turneraaad5742016-05-23 23:41:13 +0000195
196private:
197 COFFDumper &CD;
198 const SectionRef &SR;
Zachary Turneraaad5742016-05-23 23:41:13 +0000199 const coff_section *Sec;
200 StringRef SectionContents;
201};
202
Reid Kleckner4a14bca2016-05-05 00:34:33 +0000203} // end namespace
Eric Christopher9cad53c2013-04-03 18:31:38 +0000204
205namespace llvm {
206
Rafael Espindola4453e42942014-06-13 03:07:50 +0000207std::error_code createCOFFDumper(const object::ObjectFile *Obj,
Zachary Turner88bb1632016-05-03 00:28:04 +0000208 ScopedPrinter &Writer,
Rafael Espindola4453e42942014-06-13 03:07:50 +0000209 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000210 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
211 if (!COFFObj)
212 return readobj_error::unsupported_obj_file_format;
213
214 Result.reset(new COFFDumper(COFFObj, Writer));
215 return readobj_error::success;
216}
217
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000218} // namespace llvm
Eric Christopher9cad53c2013-04-03 18:31:38 +0000219
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000220// Given a a section and an offset into this section the function returns the
221// symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000222std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
223 uint64_t Offset, SymbolRef &Sym) {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000224 cacheRelocations();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000225 const auto &Relocations = RelocMap[Section];
David Majnemer61f17982016-05-29 06:18:08 +0000226 auto SymI = Obj->symbol_end();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000227 for (const auto &Relocation : Relocations) {
Rafael Espindola96d071c2015-06-29 23:29:12 +0000228 uint64_t RelocationOffset = Relocation.getOffset();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000229
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000230 if (RelocationOffset == Offset) {
David Majnemer61f17982016-05-29 06:18:08 +0000231 SymI = Relocation.getSymbol();
232 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000233 }
234 }
David Majnemer61f17982016-05-29 06:18:08 +0000235 if (SymI == Obj->symbol_end())
236 return readobj_error::unknown_symbol;
237 Sym = *SymI;
238 return readobj_error::success;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000239}
240
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000241// Given a section and an offset into this section the function returns the name
242// of the symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000243std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
244 uint64_t Offset,
245 StringRef &Name) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000246 SymbolRef Symbol;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000247 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000248 return EC;
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000249 Expected<StringRef> NameOrErr = Symbol.getName();
250 if (!NameOrErr)
251 return errorToErrorCode(NameOrErr.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000252 Name = *NameOrErr;
Rui Ueyama7d099192015-06-09 15:20:42 +0000253 return std::error_code();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000254}
255
Reid Kleckner2893fd12016-01-14 17:51:54 +0000256// Helper for when you have a pointer to real data and you want to know about
257// relocations against it.
258std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
259 StringRef SectionContents,
260 const void *RelocPtr,
261 StringRef &Name) {
262 assert(SectionContents.data() < RelocPtr &&
263 RelocPtr < SectionContents.data() + SectionContents.size() &&
264 "pointer to relocated object is not in section");
265 uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) -
266 SectionContents.data());
267 return resolveSymbolName(Section, Offset, Name);
268}
269
270void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000271 uint32_t RelocOffset, uint32_t Offset,
272 StringRef *RelocSym) {
273 StringRef SymStorage;
274 StringRef &Symbol = RelocSym ? *RelocSym : SymStorage;
275 if (!resolveSymbolName(Sec, RelocOffset, Symbol))
276 W.printSymbolOffset(Label, Symbol, Offset);
277 else
278 W.printHex(Label, RelocOffset);
279}
280
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000281void COFFDumper::printBinaryBlockWithRelocs(StringRef Label,
282 const SectionRef &Sec,
283 StringRef SectionContents,
284 StringRef Block) {
285 W.printBinaryBlock(Label, Block);
286
287 assert(SectionContents.begin() < Block.begin() &&
288 SectionContents.end() >= Block.end() &&
289 "Block is not contained in SectionContents");
290 uint64_t OffsetStart = Block.data() - SectionContents.data();
291 uint64_t OffsetEnd = OffsetStart + Block.size();
292
Zachary Turneraaad5742016-05-23 23:41:13 +0000293 W.flush();
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000294 cacheRelocations();
295 ListScope D(W, "BlockRelocations");
296 const coff_section *Section = Obj->getCOFFSection(Sec);
297 const auto &Relocations = RelocMap[Section];
298 for (const auto &Relocation : Relocations) {
299 uint64_t RelocationOffset = Relocation.getOffset();
300 if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd)
301 printRelocation(Sec, Relocation, OffsetStart);
302 }
303}
304
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000305static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000306 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
307 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
308 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
309 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
Saleem Abdulrasool5e1780e2014-03-11 03:08:37 +0000310 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000311 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
312 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
313 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
314 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
315 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
316 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
317 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
318 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
319 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
320 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
321 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
322 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
323 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
324 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
325 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
326 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
327};
328
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000329static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000330 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
331 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
332 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
333 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
334 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
335 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
336 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
337 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
338 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
339 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
340 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
341 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
342 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
343 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
344 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
345};
346
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000347static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000348 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
349 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
350 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
351 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
352 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
353 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
354 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
355 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
356 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
357 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
358 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
359};
360
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000361static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
Rui Ueyama06dc5e72014-01-27 04:22:24 +0000362 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000363 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
364 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
365 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
366 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
367 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
368 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000369 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000370 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000371 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000372 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
373};
374
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000375static const EnumEntry<COFF::SectionCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000376ImageSectionCharacteristics[] = {
David Majnemerd3238882015-07-30 16:47:56 +0000377 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000378 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
379 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
380 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
381 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
382 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
383 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
384 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
385 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
386 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
387 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
388 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
389 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
390 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
391 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
392 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
393 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
394 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
395 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
396 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
397 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
398 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
399 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
400 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
401 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
402 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
403 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
404 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
405 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
406 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
407 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
408 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
409 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
410 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
411 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
412 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
413};
414
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000415static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000416 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
417 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
418 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
419 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
420 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
421 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
422 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
423 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
424 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
425 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
426 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
427 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
428 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
429 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
430 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
431 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
432};
433
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000434static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000435 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
436 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
437 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
438 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
439};
440
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000441static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000442 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
443 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
444 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
445 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
446 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
447 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
448 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
449 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
450 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
451 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
452 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
453 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
454 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
455 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
456 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
457 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
458 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
459 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
460 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
461 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
462 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
463 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
464 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
465 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
466 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
467 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
468 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
469};
470
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000471static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000472 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
473 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
474 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
475 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
476 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
477 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
478 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
479};
480
Reid Kleckner2da433e2016-06-02 17:10:43 +0000481static const EnumEntry<COFF::DebugType> ImageDebugType[] = {
482 { "Unknown" , COFF::IMAGE_DEBUG_TYPE_UNKNOWN },
483 { "COFF" , COFF::IMAGE_DEBUG_TYPE_COFF },
484 { "CodeView" , COFF::IMAGE_DEBUG_TYPE_CODEVIEW },
485 { "FPO" , COFF::IMAGE_DEBUG_TYPE_FPO },
486 { "Misc" , COFF::IMAGE_DEBUG_TYPE_MISC },
487 { "Exception" , COFF::IMAGE_DEBUG_TYPE_EXCEPTION },
488 { "Fixup" , COFF::IMAGE_DEBUG_TYPE_FIXUP },
489 { "OmapToSrc" , COFF::IMAGE_DEBUG_TYPE_OMAP_TO_SRC },
490 { "OmapFromSrc", COFF::IMAGE_DEBUG_TYPE_OMAP_FROM_SRC },
491 { "Borland" , COFF::IMAGE_DEBUG_TYPE_BORLAND },
David Majnemera2a2a732016-06-02 17:32:11 +0000492 { "Reserved10" , COFF::IMAGE_DEBUG_TYPE_RESERVED10 },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000493 { "CLSID" , COFF::IMAGE_DEBUG_TYPE_CLSID },
494 { "VCFeature" , COFF::IMAGE_DEBUG_TYPE_VC_FEATURE },
495 { "POGO" , COFF::IMAGE_DEBUG_TYPE_POGO },
496 { "ILTCG" , COFF::IMAGE_DEBUG_TYPE_ILTCG },
497 { "MPX" , COFF::IMAGE_DEBUG_TYPE_MPX },
David Majnemera2a2a732016-06-02 17:32:11 +0000498 { "Repro" , COFF::IMAGE_DEBUG_TYPE_REPRO },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000499};
500
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000501static const EnumEntry<COFF::WeakExternalCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000502WeakExternalCharacteristics[] = {
503 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
504 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
505 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
506};
507
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000508static const EnumEntry<uint32_t> SubSectionTypes[] = {
Zachary Turner67c56012017-04-27 16:11:19 +0000509 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, Symbols),
510 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, Lines),
511 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, StringTable),
512 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, FileChecksums),
513 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, FrameData),
514 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, InlineeLines),
515 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, CrossScopeImports),
516 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, CrossScopeExports),
517 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, ILLines),
518 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, FuncMDTokenMap),
519 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, TypeMDTokenMap),
520 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, MergedAssemblyInput),
521 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, CoffSymbolRVA),
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000522};
523
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000524static const EnumEntry<uint32_t> FrameDataFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000525 LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH),
526 LLVM_READOBJ_ENUM_ENT(FrameData, HasEH),
527 LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart),
528};
529
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000530static const EnumEntry<uint8_t> FileChecksumKindNames[] = {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000531 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, None),
532 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, MD5),
533 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA1),
534 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA256),
535};
536
Rafael Espindola4453e42942014-06-13 03:07:50 +0000537template <typename T>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000538static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
David Majnemer44f51e52014-09-10 12:51:52 +0000539 COFFSymbolRef Symbol,
540 uint8_t AuxSymbolIdx, const T *&Aux) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000541 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
David Majnemer44f51e52014-09-10 12:51:52 +0000542 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000543 Aux = reinterpret_cast<const T*>(AuxData.data());
544 return readobj_error::success;
545}
546
Eric Christopher9cad53c2013-04-03 18:31:38 +0000547void COFFDumper::cacheRelocations() {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000548 if (RelocCached)
549 return;
550 RelocCached = true;
551
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000552 for (const SectionRef &S : Obj->sections()) {
553 const coff_section *Section = Obj->getCOFFSection(S);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000554
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000555 for (const RelocationRef &Reloc : S.relocations())
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000556 RelocMap[Section].push_back(Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000557
558 // Sort relocations by address.
559 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
560 relocAddressLess);
561 }
562}
563
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000564void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
565 const data_directory *Data;
566 if (Obj->getDataDirectory(Index, Data))
567 return;
568 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
569 W.printHex(FieldName + "Size", Data->Size);
570}
571
Eric Christopher9cad53c2013-04-03 18:31:38 +0000572void COFFDumper::printFileHeaders() {
David Majnemer44f51e52014-09-10 12:51:52 +0000573 time_t TDS = Obj->getTimeDateStamp();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000574 char FormattedTime[20] = { };
575 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
576
577 {
578 DictScope D(W, "ImageFileHeader");
David Majnemer44f51e52014-09-10 12:51:52 +0000579 W.printEnum ("Machine", Obj->getMachine(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000580 makeArrayRef(ImageFileMachineType));
David Majnemer44f51e52014-09-10 12:51:52 +0000581 W.printNumber("SectionCount", Obj->getNumberOfSections());
582 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
583 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
584 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
585 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
586 W.printFlags ("Characteristics", Obj->getCharacteristics(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000587 makeArrayRef(ImageFileCharacteristics));
588 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000589
590 // Print PE header. This header does not exist if this is an object file and
591 // not an executable.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000592 const pe32_header *PEHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000593 error(Obj->getPE32Header(PEHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000594 if (PEHeader)
595 printPEHeader<pe32_header>(PEHeader);
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000596
Craig Toppere6cb63e2014-04-25 04:24:47 +0000597 const pe32plus_header *PEPlusHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000598 error(Obj->getPE32PlusHeader(PEPlusHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000599 if (PEPlusHeader)
600 printPEHeader<pe32plus_header>(PEPlusHeader);
David Majnemer50267222014-11-05 06:24:35 +0000601
602 if (const dos_header *DH = Obj->getDOSHeader())
603 printDOSHeader(DH);
604}
605
606void COFFDumper::printDOSHeader(const dos_header *DH) {
607 DictScope D(W, "DOSHeader");
608 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
609 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
610 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
611 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
612 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
613 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
614 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
615 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
616 W.printNumber("InitialSP", DH->InitialSP);
617 W.printNumber("Checksum", DH->Checksum);
618 W.printNumber("InitialIP", DH->InitialIP);
619 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
620 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
621 W.printNumber("OverlayNumber", DH->OverlayNumber);
622 W.printNumber("OEMid", DH->OEMid);
623 W.printNumber("OEMinfo", DH->OEMinfo);
624 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000625}
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000626
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000627template <class PEHeader>
628void COFFDumper::printPEHeader(const PEHeader *Hdr) {
629 DictScope D(W, "ImageOptionalHeader");
630 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
631 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
632 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
633 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
634 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
635 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
636 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
637 printBaseOfDataField(Hdr);
638 W.printHex ("ImageBase", Hdr->ImageBase);
639 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
640 W.printNumber("FileAlignment", Hdr->FileAlignment);
641 W.printNumber("MajorOperatingSystemVersion",
642 Hdr->MajorOperatingSystemVersion);
643 W.printNumber("MinorOperatingSystemVersion",
644 Hdr->MinorOperatingSystemVersion);
645 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
646 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
647 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
648 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
649 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
650 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
651 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
David Majnemer774aadf2014-11-18 02:45:28 +0000652 W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000653 makeArrayRef(PEDLLCharacteristics));
654 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
655 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
656 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
657 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
658 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000659
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000660 if (Hdr->NumberOfRvaAndSize > 0) {
661 DictScope D(W, "DataDirectory");
662 static const char * const directory[] = {
663 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
664 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
665 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
666 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
667 };
668
Reid Kleckner2da433e2016-06-02 17:10:43 +0000669 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i)
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000670 printDataDirectory(i, directory[i]);
Reid Kleckner2da433e2016-06-02 17:10:43 +0000671 }
672}
673
674void COFFDumper::printCOFFDebugDirectory() {
675 ListScope LS(W, "DebugDirectory");
676 for (const debug_directory &D : Obj->debug_directories()) {
677 char FormattedTime[20] = {};
678 time_t TDS = D.TimeDateStamp;
679 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
680 DictScope S(W, "DebugEntry");
681 W.printHex("Characteristics", D.Characteristics);
682 W.printHex("TimeDateStamp", FormattedTime, D.TimeDateStamp);
683 W.printHex("MajorVersion", D.MajorVersion);
684 W.printHex("MinorVersion", D.MinorVersion);
685 W.printEnum("Type", D.Type, makeArrayRef(ImageDebugType));
686 W.printHex("SizeOfData", D.SizeOfData);
687 W.printHex("AddressOfRawData", D.AddressOfRawData);
688 W.printHex("PointerToRawData", D.PointerToRawData);
689 if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW) {
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000690 const codeview::DebugInfo *DebugInfo;
Reid Kleckner2da433e2016-06-02 17:10:43 +0000691 StringRef PDBFileName;
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000692 error(Obj->getDebugPDBInfo(&D, DebugInfo, PDBFileName));
Reid Kleckner2da433e2016-06-02 17:10:43 +0000693 DictScope PDBScope(W, "PDBInfo");
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000694 W.printHex("PDBSignature", DebugInfo->Signature.CVSignature);
695 if (DebugInfo->Signature.CVSignature == OMF::Signature::PDB70) {
696 W.printBinary("PDBGUID", makeArrayRef(DebugInfo->PDB70.Signature));
697 W.printNumber("PDBAge", DebugInfo->PDB70.Age);
698 W.printString("PDBFileName", PDBFileName);
699 }
Reid Kleckner2da433e2016-06-02 17:10:43 +0000700 } else {
701 // FIXME: Type values of 12 and 13 are commonly observed but are not in
702 // the documented type enum. Figure out what they mean.
703 ArrayRef<uint8_t> RawData;
704 error(
705 Obj->getRvaAndSizeAsBytes(D.AddressOfRawData, D.SizeOfData, RawData));
706 W.printBinaryBlock("RawData", RawData);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000707 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000708 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000709}
710
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000711void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
712 W.printHex("BaseOfData", Hdr->BaseOfData);
713}
714
715void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
716
Reid Kleckner83ebad32015-12-16 18:28:12 +0000717void COFFDumper::printCodeViewDebugInfo() {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000718 // Print types first to build CVUDTNames, then print symbols.
Reid Kleckner83ebad32015-12-16 18:28:12 +0000719 for (const SectionRef &S : Obj->sections()) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000720 StringRef SectionName;
721 error(S.getName(SectionName));
722 if (SectionName == ".debug$T")
723 printCodeViewTypeSection(SectionName, S);
724 }
725 for (const SectionRef &S : Obj->sections()) {
726 StringRef SectionName;
727 error(S.getName(SectionName));
728 if (SectionName == ".debug$S")
729 printCodeViewSymbolSection(SectionName, S);
Reid Kleckner83ebad32015-12-16 18:28:12 +0000730 }
731}
732
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000733void COFFDumper::initializeFileAndStringTables(BinaryStreamReader &Reader) {
734 while (Reader.bytesRemaining() > 0 &&
735 (!CVFileChecksumTable.valid() || !CVStringTable.valid())) {
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000736 // The section consists of a number of subsection in the following format:
737 // |SubSectionType|SubSectionSize|Contents...|
738 uint32_t SubType, SubSectionSize;
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000739 error(Reader.readInteger(SubType));
740 error(Reader.readInteger(SubSectionSize));
741
742 StringRef Contents;
743 error(Reader.readFixedString(Contents, SubSectionSize));
744
Zachary Turner67c56012017-04-27 16:11:19 +0000745 switch (ModuleDebugFragmentKind(SubType)) {
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000746 case ModuleDebugFragmentKind::FileChecksums: {
747 ChecksumContents = BinaryByteStream(Contents, support::little);
748 BinaryStreamReader CSR(ChecksumContents);
749 error(CSR.readArray(CVFileChecksumTable, CSR.getLength()));
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000750 break;
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000751 }
752 case ModuleDebugFragmentKind::StringTable: {
753 StringTableContents = BinaryByteStream(Contents, support::little);
754 error(CVStringTable.initialize(StringTableContents));
755 } break;
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000756 default:
757 break;
758 }
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000759
David Majnemerefaaf412016-05-28 20:04:48 +0000760 uint32_t PaddedSize = alignTo(SubSectionSize, 4);
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000761 error(Reader.skip(PaddedSize - SubSectionSize));
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000762 }
763}
764
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000765void COFFDumper::printCodeViewSymbolSection(StringRef SectionName,
766 const SectionRef &Section) {
767 StringRef SectionContents;
768 error(Section.getContents(SectionContents));
769 StringRef Data = SectionContents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000770
771 SmallVector<StringRef, 10> FunctionNames;
772 StringMap<StringRef> FunctionLineTables;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000773
Zachary Turner99f02152015-02-18 19:32:05 +0000774 ListScope D(W, "CodeViewDebugInfo");
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000775 // Print the section to allow correlation with printSections.
776 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000777
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000778 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000779 error(consume(Data, Magic));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000780 W.printHex("Magic", Magic);
781 if (Magic != COFF::DEBUG_SECTION_MAGIC)
782 return error(object_error::parse_failed);
783
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000784 BinaryByteStream FileAndStrings(Data, support::little);
785 BinaryStreamReader FSReader(FileAndStrings);
786 initializeFileAndStringTables(FSReader);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000787
Zachary Turnera96cce62016-06-03 03:25:59 +0000788 // TODO: Convert this over to using ModuleSubstreamVisitor.
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000789 while (!Data.empty()) {
790 // The section consists of a number of subsection in the following format:
791 // |SubSectionType|SubSectionSize|Contents...|
792 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000793 error(consume(Data, SubType));
794 error(consume(Data, SubSectionSize));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000795
796 ListScope S(W, "Subsection");
797 W.printEnum("SubSectionType", SubType, makeArrayRef(SubSectionTypes));
798 W.printHex("SubSectionSize", SubSectionSize);
799
800 // Get the contents of the subsection.
801 if (SubSectionSize > Data.size())
802 return error(object_error::parse_failed);
803 StringRef Contents = Data.substr(0, SubSectionSize);
804
805 // Add SubSectionSize to the current offset and align that offset to find
806 // the next subsection.
807 size_t SectionOffset = Data.data() - SectionContents.data();
808 size_t NextOffset = SectionOffset + SubSectionSize;
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000809 NextOffset = alignTo(NextOffset, 4);
David Majnemercab2b462016-05-28 20:04:50 +0000810 if (NextOffset > SectionContents.size())
811 return error(object_error::parse_failed);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000812 Data = SectionContents.drop_front(NextOffset);
813
814 // Optionally print the subsection bytes in case our parsing gets confused
815 // later.
816 if (opts::CodeViewSubsectionBytes)
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000817 printBinaryBlockWithRelocs("SubSectionContents", Section, SectionContents,
818 Contents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000819
Zachary Turner67c56012017-04-27 16:11:19 +0000820 switch (ModuleDebugFragmentKind(SubType)) {
821 case ModuleDebugFragmentKind::Symbols:
Reid Kleckner2893fd12016-01-14 17:51:54 +0000822 printCodeViewSymbolsSubsection(Contents, Section, SectionContents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000823 break;
Reid Klecknere9ab3492016-01-14 19:20:17 +0000824
Zachary Turner67c56012017-04-27 16:11:19 +0000825 case ModuleDebugFragmentKind::InlineeLines:
Reid Klecknere9ab3492016-01-14 19:20:17 +0000826 printCodeViewInlineeLines(Contents);
827 break;
828
Zachary Turner67c56012017-04-27 16:11:19 +0000829 case ModuleDebugFragmentKind::FileChecksums:
Reid Klecknerc31f5302016-01-15 18:06:25 +0000830 printCodeViewFileChecksums(Contents);
831 break;
832
Zachary Turner67c56012017-04-27 16:11:19 +0000833 case ModuleDebugFragmentKind::Lines: {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000834 // Holds a PC to file:line table. Some data to parse this subsection is
835 // stored in the other subsections, so just check sanity and store the
836 // pointers for deferred processing.
837
838 if (SubSectionSize < 12) {
839 // There should be at least three words to store two function
840 // relocations and size of the code.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000841 error(object_error::parse_failed);
842 return;
843 }
844
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000845 StringRef LinkageName;
846 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset,
847 LinkageName));
848 W.printString("LinkageName", LinkageName);
849 if (FunctionLineTables.count(LinkageName) != 0) {
850 // Saw debug info for this function already?
851 error(object_error::parse_failed);
852 return;
Zachary Turner99f02152015-02-18 19:32:05 +0000853 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000854
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000855 FunctionLineTables[LinkageName] = Contents;
856 FunctionNames.push_back(LinkageName);
857 break;
858 }
Zachary Turner67c56012017-04-27 16:11:19 +0000859 case ModuleDebugFragmentKind::FrameData: {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000860 // First four bytes is a relocation against the function.
Zachary Turner695ed562017-02-28 00:04:07 +0000861 BinaryByteStream S(Contents, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +0000862 BinaryStreamReader SR(S);
NAKAMURA Takumi05a75e42017-02-25 17:04:23 +0000863 const uint32_t *CodePtr;
864 error(SR.readObject(CodePtr));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000865 StringRef LinkageName;
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000866 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionContents,
NAKAMURA Takumi05a75e42017-02-25 17:04:23 +0000867 CodePtr, LinkageName));
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000868 W.printString("LinkageName", LinkageName);
869
870 // To find the active frame description, search this array for the
871 // smallest PC range that includes the current PC.
Zachary Turner4d49eb92016-10-20 18:31:19 +0000872 while (!SR.empty()) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000873 const FrameData *FD;
Zachary Turner4d49eb92016-10-20 18:31:19 +0000874 error(SR.readObject(FD));
David Majnemera6d93fd2016-05-28 19:45:49 +0000875
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000876 StringRef FrameFunc = error(CVStringTable.getString(FD->FrameFunc));
David Majnemera6d93fd2016-05-28 19:45:49 +0000877
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000878 DictScope S(W, "FrameData");
879 W.printHex("RvaStart", FD->RvaStart);
880 W.printHex("CodeSize", FD->CodeSize);
881 W.printHex("LocalSize", FD->LocalSize);
882 W.printHex("ParamsSize", FD->ParamsSize);
883 W.printHex("MaxStackSize", FD->MaxStackSize);
David Majnemera6d93fd2016-05-28 19:45:49 +0000884 W.printString("FrameFunc", FrameFunc);
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000885 W.printHex("PrologSize", FD->PrologSize);
886 W.printHex("SavedRegsSize", FD->SavedRegsSize);
887 W.printFlags("Flags", FD->Flags, makeArrayRef(FrameDataFlags));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000888 }
889 break;
890 }
891
892 // Do nothing for unrecognized subsections.
893 default:
894 break;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000895 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000896 W.flush();
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000897 }
898
899 // Dump the line tables now that we've read all the subsections and know all
900 // the required information.
901 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
902 StringRef Name = FunctionNames[I];
903 ListScope S(W, "FunctionLineTable");
Reid Kleckner7c0c0c02015-12-15 01:23:55 +0000904 W.printString("LinkageName", Name);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000905
Zachary Turner05bd9f32017-04-28 23:41:36 +0000906 BinaryByteStream LineTableInfo(FunctionLineTables[Name], support::little);
907 BinaryStreamReader Reader(LineTableInfo);
David Majnemer0373d532015-07-09 18:14:31 +0000908
Zachary Turner7cc13e52017-05-01 16:46:39 +0000909 ModuleDebugLineFragmentRef LineInfo;
Zachary Turner05bd9f32017-04-28 23:41:36 +0000910 error(LineInfo.initialize(Reader));
David Majnemer04948362016-01-13 01:05:16 +0000911
Zachary Turner05bd9f32017-04-28 23:41:36 +0000912 W.printHex("Flags", LineInfo.header()->Flags);
913 W.printHex("CodeSize", LineInfo.header()->CodeSize);
914 for (const auto &Entry : LineInfo) {
Justin Bognera1413db2015-07-09 04:27:36 +0000915
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000916 ListScope S(W, "FilenameSegment");
Zachary Turner05bd9f32017-04-28 23:41:36 +0000917 printFileNameForOffset("Filename", Entry.NameIndex);
Zachary Turner4346ae12017-04-29 00:03:32 +0000918 uint32_t ColumnIndex = 0;
Zachary Turner05bd9f32017-04-28 23:41:36 +0000919 for (const auto &Line : Entry.LineNumbers) {
920 if (Line.Offset >= LineInfo.header()->CodeSize) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000921 error(object_error::parse_failed);
922 return;
923 }
Zachary Turner05bd9f32017-04-28 23:41:36 +0000924
925 std::string PC = formatv("+{0:X}", uint32_t(Line.Offset));
926 ListScope PCScope(W, PC);
927 codeview::LineInfo LI(Line.Flags);
928
David Majnemera4859df2016-02-04 17:57:12 +0000929 if (LI.isAlwaysStepInto())
930 W.printString("StepInto", StringRef("Always"));
931 else if (LI.isNeverStepInto())
932 W.printString("StepInto", StringRef("Never"));
933 else
934 W.printNumber("LineNumberStart", LI.getStartLine());
935 W.printNumber("LineNumberEndDelta", LI.getLineDelta());
936 W.printBoolean("IsStatement", LI.isStatement());
Zachary Turner5b6e4e02017-04-29 01:13:21 +0000937 if (LineInfo.hasColumnInfo()) {
Zachary Turner4346ae12017-04-29 00:03:32 +0000938 W.printNumber("ColStart", Entry.Columns[ColumnIndex].StartColumn);
939 W.printNumber("ColEnd", Entry.Columns[ColumnIndex].EndColumn);
940 ++ColumnIndex;
David Majnemer04948362016-01-13 01:05:16 +0000941 }
942 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000943 }
944 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000945}
946
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000947void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
948 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000949 StringRef SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000950 ArrayRef<uint8_t> BinaryData(Subsection.bytes_begin(),
951 Subsection.bytes_end());
952 auto CODD = llvm::make_unique<COFFObjectDumpDelegate>(*this, Section, Obj,
953 SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000954
Zachary Turner629cb7d2017-01-11 23:24:22 +0000955 CVSymbolDumper CVSD(W, TypeDB, std::move(CODD),
956 opts::CodeViewSubsectionBytes);
Zachary Turner695ed562017-02-28 00:04:07 +0000957 BinaryByteStream Stream(BinaryData, llvm::support::little);
Zachary Turner0d43c1c2016-05-28 05:21:57 +0000958 CVSymbolArray Symbols;
Zachary Turner120faca2017-02-27 22:11:43 +0000959 BinaryStreamReader Reader(Stream);
Zachary Turner0d43c1c2016-05-28 05:21:57 +0000960 if (auto EC = Reader.readArray(Symbols, Reader.getLength())) {
961 consumeError(std::move(EC));
962 W.flush();
963 error(object_error::parse_failed);
964 }
Reid Kleckner2893fd12016-01-14 17:51:54 +0000965
Zachary Turner0d840742016-10-07 21:34:46 +0000966 if (auto EC = CVSD.dump(Symbols)) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000967 W.flush();
Zachary Turner0d840742016-10-07 21:34:46 +0000968 error(std::move(EC));
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000969 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000970 W.flush();
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000971}
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000972
Reid Klecknerc31f5302016-01-15 18:06:25 +0000973void COFFDumper::printCodeViewFileChecksums(StringRef Subsection) {
Zachary Turner695ed562017-02-28 00:04:07 +0000974 BinaryByteStream S(Subsection, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +0000975 BinaryStreamReader SR(S);
Zachary Turner7cc13e52017-05-01 16:46:39 +0000976 ModuleDebugFileChecksumFragmentRef Checksums;
Zachary Turnerc37cb0c2017-04-27 16:12:16 +0000977 error(Checksums.initialize(SR));
978
979 for (auto &FC : Checksums) {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000980 DictScope S(W, "FileChecksum");
Zachary Turnerc37cb0c2017-04-27 16:12:16 +0000981
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000982 StringRef Filename = error(CVStringTable.getString(FC.FileNameOffset));
Zachary Turnerc37cb0c2017-04-27 16:12:16 +0000983 W.printHex("Filename", Filename, FC.FileNameOffset);
984 W.printHex("ChecksumSize", FC.Checksum.size());
985 W.printEnum("ChecksumKind", uint8_t(FC.Kind),
Reid Klecknerc31f5302016-01-15 18:06:25 +0000986 makeArrayRef(FileChecksumKindNames));
Zachary Turnerc37cb0c2017-04-27 16:12:16 +0000987
988 W.printBinary("ChecksumBytes", FC.Checksum);
Reid Klecknerc31f5302016-01-15 18:06:25 +0000989 }
990}
991
Reid Klecknere9ab3492016-01-14 19:20:17 +0000992void COFFDumper::printCodeViewInlineeLines(StringRef Subsection) {
Zachary Turner695ed562017-02-28 00:04:07 +0000993 BinaryByteStream S(Subsection, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +0000994 BinaryStreamReader SR(S);
Zachary Turneredef1452017-05-02 16:56:09 +0000995 ModuleDebugInlineeLineFragmentRef Lines;
996 error(Lines.initialize(SR));
Reid Klecknere9ab3492016-01-14 19:20:17 +0000997
Zachary Turneredef1452017-05-02 16:56:09 +0000998 for (auto &Line : Lines) {
Reid Klecknere9ab3492016-01-14 19:20:17 +0000999 DictScope S(W, "InlineeSourceLine");
Zachary Turneredef1452017-05-02 16:56:09 +00001000 printTypeIndex("Inlinee", Line.Header->Inlinee);
1001 printFileNameForOffset("FileID", Line.Header->FileID);
1002 W.printNumber("SourceLineNum", Line.Header->SourceLineNum);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001003
Zachary Turneredef1452017-05-02 16:56:09 +00001004 if (Lines.hasExtraFiles()) {
1005 W.printNumber("ExtraFileCount", Line.ExtraFiles.size());
Reid Klecknere9ab3492016-01-14 19:20:17 +00001006 ListScope ExtraFiles(W, "ExtraFiles");
Zachary Turneredef1452017-05-02 16:56:09 +00001007 for (const auto &FID : Line.ExtraFiles) {
1008 printFileNameForOffset("FileID", FID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001009 }
1010 }
1011 }
1012}
1013
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001014StringRef COFFDumper::getFileNameForFileOffset(uint32_t FileOffset) {
1015 // The file checksum subsection should precede all references to it.
Zachary Turner2d5c2cd2017-05-03 17:11:11 +00001016 if (!CVFileChecksumTable.valid() || !CVStringTable.valid())
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001017 error(object_error::parse_failed);
Zachary Turner2d5c2cd2017-05-03 17:11:11 +00001018
1019 auto Iter = CVFileChecksumTable.at(FileOffset);
1020
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001021 // Check if the file checksum table offset is valid.
Zachary Turner2d5c2cd2017-05-03 17:11:11 +00001022 if (Iter == CVFileChecksumTable.end())
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001023 error(object_error::parse_failed);
1024
Zachary Turner2d5c2cd2017-05-03 17:11:11 +00001025 return error(CVStringTable.getString(Iter->FileNameOffset));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001026}
1027
1028void COFFDumper::printFileNameForOffset(StringRef Label, uint32_t FileOffset) {
1029 W.printHex(Label, getFileNameForFileOffset(FileOffset), FileOffset);
1030}
1031
Reid Kleckner5d577522017-03-24 17:26:38 +00001032void COFFDumper::mergeCodeViewTypes(TypeTableBuilder &CVIDs,
1033 TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001034 for (const SectionRef &S : Obj->sections()) {
1035 StringRef SectionName;
1036 error(S.getName(SectionName));
1037 if (SectionName == ".debug$T") {
1038 StringRef Data;
1039 error(S.getContents(Data));
David Majnemer78b0d722016-05-28 19:17:48 +00001040 uint32_t Magic;
1041 error(consume(Data, Magic));
Reid Kleckner0b269742016-05-14 00:02:53 +00001042 if (Magic != 4)
1043 error(object_error::parse_failed);
Reid Kleckner0b269742016-05-14 00:02:53 +00001044 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(Data.data()),
1045 Data.size());
Zachary Turner695ed562017-02-28 00:04:07 +00001046 BinaryByteStream Stream(Bytes, llvm::support::little);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001047 CVTypeArray Types;
Zachary Turner120faca2017-02-27 22:11:43 +00001048 BinaryStreamReader Reader(Stream);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001049 if (auto EC = Reader.readArray(Types, Reader.getLength())) {
1050 consumeError(std::move(EC));
1051 W.flush();
1052 error(object_error::parse_failed);
1053 }
1054
Reid Klecknerc4b5d792017-04-03 23:58:15 +00001055 if (auto EC = mergeTypeStreams(CVIDs, CVTypes, nullptr, Types))
1056 return error(std::move(EC));
Reid Kleckner0b269742016-05-14 00:02:53 +00001057 }
1058 }
1059}
1060
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001061void COFFDumper::printCodeViewTypeSection(StringRef SectionName,
1062 const SectionRef &Section) {
1063 ListScope D(W, "CodeViewTypes");
1064 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Adrian McCarthy963a3312016-05-02 23:45:03 +00001065
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001066 StringRef Data;
1067 error(Section.getContents(Data));
Reid Klecknerb2bd2812016-05-02 18:10:00 +00001068 if (opts::CodeViewSubsectionBytes)
1069 W.printBinaryBlock("Data", Data);
Reid Kleckner7960de92016-05-04 19:39:28 +00001070
1071 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001072 error(consume(Data, Magic));
Reid Kleckner7960de92016-05-04 19:39:28 +00001073 W.printHex("Magic", Magic);
1074 if (Magic != COFF::DEBUG_SECTION_MAGIC)
1075 return error(object_error::parse_failed);
1076
Zachary Turner629cb7d2017-01-11 23:24:22 +00001077 CVTypeDumper CVTD(TypeDB);
1078 TypeDumpVisitor TDV(TypeDB, &W, opts::CodeViewSubsectionBytes);
1079 if (auto EC = CVTD.dump({Data.bytes_begin(), Data.bytes_end()}, TDV)) {
Reid Kleckner4a14bca2016-05-05 00:34:33 +00001080 W.flush();
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001081 error(llvm::errorToErrorCode(std::move(EC)));
Reid Kleckner7960de92016-05-04 19:39:28 +00001082 }
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001083}
1084
Eric Christopher9cad53c2013-04-03 18:31:38 +00001085void COFFDumper::printSections() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001086 ListScope SectionsD(W, "Sections");
1087 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001088 for (const SectionRef &Sec : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001089 ++SectionNumber;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001090 const coff_section *Section = Obj->getCOFFSection(Sec);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001091
1092 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001093 error(Sec.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001094
1095 DictScope D(W, "Section");
1096 W.printNumber("Number", SectionNumber);
1097 W.printBinary("Name", Name, Section->Name);
1098 W.printHex ("VirtualSize", Section->VirtualSize);
1099 W.printHex ("VirtualAddress", Section->VirtualAddress);
1100 W.printNumber("RawDataSize", Section->SizeOfRawData);
1101 W.printHex ("PointerToRawData", Section->PointerToRawData);
1102 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
1103 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
1104 W.printNumber("RelocationCount", Section->NumberOfRelocations);
1105 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
1106 W.printFlags ("Characteristics", Section->Characteristics,
1107 makeArrayRef(ImageSectionCharacteristics),
1108 COFF::SectionCharacteristics(0x00F00000));
1109
1110 if (opts::SectionRelocations) {
1111 ListScope D(W, "Relocations");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001112 for (const RelocationRef &Reloc : Sec.relocations())
1113 printRelocation(Sec, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001114 }
1115
1116 if (opts::SectionSymbols) {
1117 ListScope D(W, "Symbols");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001118 for (const SymbolRef &Symbol : Obj->symbols()) {
Rafael Espindola80291272014-10-08 15:28:58 +00001119 if (!Sec.containsSymbol(Symbol))
Eric Christopher9cad53c2013-04-03 18:31:38 +00001120 continue;
1121
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001122 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001123 }
1124 }
1125
David Majnemerdac39852014-09-26 22:32:16 +00001126 if (opts::SectionData &&
1127 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001128 StringRef Data;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001129 error(Sec.getContents(Data));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001130
1131 W.printBinaryBlock("SectionData", Data);
1132 }
1133 }
1134}
1135
1136void COFFDumper::printRelocations() {
1137 ListScope D(W, "Relocations");
1138
Eric Christopher9cad53c2013-04-03 18:31:38 +00001139 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001140 for (const SectionRef &Section : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001141 ++SectionNumber;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001142 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001143 error(Section.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001144
1145 bool PrintedGroup = false;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001146 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001147 if (!PrintedGroup) {
1148 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
1149 W.indent();
1150 PrintedGroup = true;
1151 }
1152
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001153 printRelocation(Section, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001154 }
1155
1156 if (PrintedGroup) {
1157 W.unindent();
1158 W.startLine() << "}\n";
1159 }
1160 }
1161}
1162
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001163void COFFDumper::printRelocation(const SectionRef &Section,
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00001164 const RelocationRef &Reloc, uint64_t Bias) {
1165 uint64_t Offset = Reloc.getOffset() - Bias;
Rafael Espindola99c041b2015-06-30 01:53:01 +00001166 uint64_t RelocType = Reloc.getType();
Eric Christopher9cad53c2013-04-03 18:31:38 +00001167 SmallString<32> RelocName;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001168 StringRef SymbolName;
Rafael Espindola41bb4322015-06-30 04:08:37 +00001169 Reloc.getTypeName(RelocName);
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001170 symbol_iterator Symbol = Reloc.getSymbol();
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001171 if (Symbol != Obj->symbol_end()) {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001172 Expected<StringRef> SymbolNameOrErr = Symbol->getName();
1173 error(errorToErrorCode(SymbolNameOrErr.takeError()));
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001174 SymbolName = *SymbolNameOrErr;
1175 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001176
Nico Rieckf3f0b792013-04-12 04:01:52 +00001177 if (opts::ExpandRelocs) {
1178 DictScope Group(W, "Relocation");
1179 W.printHex("Offset", Offset);
1180 W.printNumber("Type", RelocName, RelocType);
David Majnemer1f80b0a2014-11-13 07:42:11 +00001181 W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName);
Nico Rieckf3f0b792013-04-12 04:01:52 +00001182 } else {
1183 raw_ostream& OS = W.startLine();
1184 OS << W.hex(Offset)
1185 << " " << RelocName
David Majnemer1f80b0a2014-11-13 07:42:11 +00001186 << " " << (SymbolName.empty() ? "-" : SymbolName)
Nico Rieckf3f0b792013-04-12 04:01:52 +00001187 << "\n";
1188 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001189}
1190
1191void COFFDumper::printSymbols() {
1192 ListScope Group(W, "Symbols");
1193
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001194 for (const SymbolRef &Symbol : Obj->symbols())
1195 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001196}
1197
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001198void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001199
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001200static ErrorOr<StringRef>
David Majnemer236b0ca2014-11-17 11:17:17 +00001201getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber,
1202 const coff_section *Section) {
David Majnemerf4dc4562014-09-20 00:25:06 +00001203 if (Section) {
1204 StringRef SectionName;
David Majnemer236b0ca2014-11-17 11:17:17 +00001205 if (std::error_code EC = Obj->getSectionName(Section, SectionName))
1206 return EC;
David Majnemerf4dc4562014-09-20 00:25:06 +00001207 return SectionName;
1208 }
David Majnemerf4dc4562014-09-20 00:25:06 +00001209 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
David Majnemer236b0ca2014-11-17 11:17:17 +00001210 return StringRef("IMAGE_SYM_DEBUG");
David Majnemerf4dc4562014-09-20 00:25:06 +00001211 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
David Majnemer236b0ca2014-11-17 11:17:17 +00001212 return StringRef("IMAGE_SYM_ABSOLUTE");
David Majnemerf4dc4562014-09-20 00:25:06 +00001213 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
David Majnemer236b0ca2014-11-17 11:17:17 +00001214 return StringRef("IMAGE_SYM_UNDEFINED");
1215 return StringRef("");
David Majnemerf4dc4562014-09-20 00:25:06 +00001216}
1217
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001218void COFFDumper::printSymbol(const SymbolRef &Sym) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001219 DictScope D(W, "Symbol");
1220
David Majnemer44f51e52014-09-10 12:51:52 +00001221 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001222 const coff_section *Section;
David Majnemer44f51e52014-09-10 12:51:52 +00001223 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001224 W.startLine() << "Invalid section number: " << EC.message() << "\n";
1225 W.flush();
1226 return;
1227 }
1228
1229 StringRef SymbolName;
1230 if (Obj->getSymbolName(Symbol, SymbolName))
1231 SymbolName = "";
1232
David Majnemer236b0ca2014-11-17 11:17:17 +00001233 StringRef SectionName = "";
1234 ErrorOr<StringRef> Res =
1235 getSectionName(Obj, Symbol.getSectionNumber(), Section);
1236 if (Res)
1237 SectionName = *Res;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001238
1239 W.printString("Name", SymbolName);
David Majnemer44f51e52014-09-10 12:51:52 +00001240 W.printNumber("Value", Symbol.getValue());
1241 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
1242 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
1243 W.printEnum ("ComplexType", Symbol.getComplexType(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001244 makeArrayRef(ImageSymDType));
David Majnemer44f51e52014-09-10 12:51:52 +00001245 W.printEnum ("StorageClass", Symbol.getStorageClass(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001246 makeArrayRef(ImageSymClass));
David Majnemer44f51e52014-09-10 12:51:52 +00001247 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
Eric Christopher9cad53c2013-04-03 18:31:38 +00001248
David Majnemer44f51e52014-09-10 12:51:52 +00001249 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
1250 if (Symbol.isFunctionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001251 const coff_aux_function_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001252 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001253
1254 DictScope AS(W, "AuxFunctionDef");
1255 W.printNumber("TagIndex", Aux->TagIndex);
1256 W.printNumber("TotalSize", Aux->TotalSize);
David Majnemerf3a2af52014-03-19 04:33:27 +00001257 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001258 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001259
David Majnemerc7d7c6f2014-10-31 05:07:00 +00001260 } else if (Symbol.isAnyUndefined()) {
David Majnemerf3a2af52014-03-19 04:33:27 +00001261 const coff_aux_weak_external *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001262 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001263
David Majnemer44f51e52014-09-10 12:51:52 +00001264 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001265 StringRef LinkedName;
David Majnemer44f51e52014-09-10 12:51:52 +00001266 std::error_code EC = Linked.getError();
1267 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001268 LinkedName = "";
1269 error(EC);
1270 }
1271
1272 DictScope AS(W, "AuxWeakExternal");
1273 W.printNumber("Linked", LinkedName, Aux->TagIndex);
1274 W.printEnum ("Search", Aux->Characteristics,
1275 makeArrayRef(WeakExternalCharacteristics));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001276
David Majnemer44f51e52014-09-10 12:51:52 +00001277 } else if (Symbol.isFileRecord()) {
1278 const char *FileName;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001279 error(getSymbolAuxData(Obj, Symbol, I, FileName));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001280
Nico Rieck0ab8e602013-04-22 08:35:11 +00001281 DictScope AS(W, "AuxFileRecord");
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001282
David Majnemer44f51e52014-09-10 12:51:52 +00001283 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
1284 Obj->getSymbolTableEntrySize());
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001285 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
Saleem Abdulrasool3b5e0012014-04-16 04:15:29 +00001286 break;
David Majnemer44f51e52014-09-10 12:51:52 +00001287 } else if (Symbol.isSectionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001288 const coff_aux_section_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001289 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001290
David Majnemer4d571592014-09-15 19:42:42 +00001291 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
1292
Eric Christopher9cad53c2013-04-03 18:31:38 +00001293 DictScope AS(W, "AuxSectionDef");
1294 W.printNumber("Length", Aux->Length);
1295 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
1296 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
1297 W.printHex("Checksum", Aux->CheckSum);
David Majnemer4d571592014-09-15 19:42:42 +00001298 W.printNumber("Number", AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001299 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001300
Nico Riecka711dee2013-04-22 08:34:59 +00001301 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
Eric Christopher9cad53c2013-04-03 18:31:38 +00001302 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
1303 const coff_section *Assoc;
David Majnemer236b0ca2014-11-17 11:17:17 +00001304 StringRef AssocName = "";
1305 std::error_code EC = Obj->getSection(AuxNumber, Assoc);
1306 ErrorOr<StringRef> Res = getSectionName(Obj, AuxNumber, Assoc);
1307 if (Res)
1308 AssocName = *Res;
1309 if (!EC)
1310 EC = Res.getError();
1311 if (EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001312 AssocName = "";
1313 error(EC);
1314 }
1315
David Majnemer4d571592014-09-15 19:42:42 +00001316 W.printNumber("AssocSection", AssocName, AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001317 }
David Majnemer44f51e52014-09-10 12:51:52 +00001318 } else if (Symbol.isCLRToken()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001319 const coff_aux_clr_token *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001320 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001321
David Majnemer44f51e52014-09-10 12:51:52 +00001322 ErrorOr<COFFSymbolRef> ReferredSym =
1323 Obj->getSymbol(Aux->SymbolTableIndex);
Nico Rieck8678acd2014-03-17 01:46:52 +00001324 StringRef ReferredName;
David Majnemer44f51e52014-09-10 12:51:52 +00001325 std::error_code EC = ReferredSym.getError();
1326 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
Nico Rieck8678acd2014-03-17 01:46:52 +00001327 ReferredName = "";
1328 error(EC);
1329 }
1330
Eric Christopher9cad53c2013-04-03 18:31:38 +00001331 DictScope AS(W, "AuxCLRToken");
1332 W.printNumber("AuxType", Aux->AuxType);
1333 W.printNumber("Reserved", Aux->Reserved);
Nico Rieck8678acd2014-03-17 01:46:52 +00001334 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001335
1336 } else {
1337 W.startLine() << "<unhandled auxiliary record>\n";
1338 }
1339 }
1340}
1341
1342void COFFDumper::printUnwindInfo() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001343 ListScope D(W, "UnwindInformation");
David Majnemer44f51e52014-09-10 12:51:52 +00001344 switch (Obj->getMachine()) {
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001345 case COFF::IMAGE_FILE_MACHINE_AMD64: {
1346 Win64EH::Dumper Dumper(W);
Rafael Espindola4453e42942014-06-13 03:07:50 +00001347 Win64EH::Dumper::SymbolResolver
1348 Resolver = [](const object::coff_section *Section, uint64_t Offset,
1349 SymbolRef &Symbol, void *user_data) -> std::error_code {
1350 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
1351 return Dumper->resolveSymbol(Section, Offset, Symbol);
1352 };
Saleem Abdulrasool65dbbb52014-05-25 21:37:59 +00001353 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001354 Dumper.printData(Ctx);
1355 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001356 }
Saleem Abdulrasoole6971ca2014-06-04 15:47:15 +00001357 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
1358 ARM::WinEH::Decoder Decoder(W);
1359 Decoder.dumpProcedureData(*Obj);
1360 break;
1361 }
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001362 default:
David Majnemer44f51e52014-09-10 12:51:52 +00001363 W.printEnum("unsupported Image Machine", Obj->getMachine(),
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001364 makeArrayRef(ImageFileMachineType));
1365 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001366 }
1367}
1368
Rui Ueyama979fb402014-10-09 02:16:38 +00001369void COFFDumper::printImportedSymbols(
1370 iterator_range<imported_symbol_iterator> Range) {
1371 for (const ImportedSymbolRef &I : Range) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001372 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001373 error(I.getSymbolName(Sym));
Rui Ueyama15d99352014-10-03 00:41:58 +00001374 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001375 error(I.getOrdinal(Ordinal));
Rui Ueyama15d99352014-10-03 00:41:58 +00001376 W.printNumber("Symbol", Sym, Ordinal);
1377 }
1378}
1379
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001380void COFFDumper::printDelayImportedSymbols(
1381 const DelayImportDirectoryEntryRef &I,
1382 iterator_range<imported_symbol_iterator> Range) {
1383 int Index = 0;
1384 for (const ImportedSymbolRef &S : Range) {
1385 DictScope Import(W, "Import");
1386 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001387 error(S.getSymbolName(Sym));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001388 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001389 error(S.getOrdinal(Ordinal));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001390 W.printNumber("Symbol", Sym, Ordinal);
1391 uint64_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001392 error(I.getImportAddress(Index++, Addr));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001393 W.printHex("Address", Addr);
1394 }
1395}
1396
Rui Ueyama1e152d52014-10-02 17:02:18 +00001397void COFFDumper::printCOFFImports() {
Rui Ueyama15d99352014-10-03 00:41:58 +00001398 // Regular imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001399 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
Rui Ueyama1e152d52014-10-02 17:02:18 +00001400 DictScope Import(W, "Import");
1401 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001402 error(I.getName(Name));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001403 W.printString("Name", Name);
Shoaib Meenai73754482017-03-26 17:10:11 +00001404 uint32_t ILTAddr;
1405 error(I.getImportLookupTableRVA(ILTAddr));
1406 W.printHex("ImportLookupTableRVA", ILTAddr);
1407 uint32_t IATAddr;
1408 error(I.getImportAddressTableRVA(IATAddr));
1409 W.printHex("ImportAddressTableRVA", IATAddr);
1410 // The import lookup table can be missing with certain older linkers, so
1411 // fall back to the import address table in that case.
1412 if (ILTAddr)
1413 printImportedSymbols(I.lookup_table_symbols());
1414 else
1415 printImportedSymbols(I.imported_symbols());
Rui Ueyama15d99352014-10-03 00:41:58 +00001416 }
1417
1418 // Delay imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001419 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001420 DictScope Import(W, "DelayImport");
1421 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001422 error(I.getName(Name));
Rui Ueyama15d99352014-10-03 00:41:58 +00001423 W.printString("Name", Name);
Rui Ueyama1af08652014-10-03 18:07:18 +00001424 const delay_import_directory_table_entry *Table;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001425 error(I.getDelayImportTable(Table));
Rui Ueyama1af08652014-10-03 18:07:18 +00001426 W.printHex("Attributes", Table->Attributes);
1427 W.printHex("ModuleHandle", Table->ModuleHandle);
1428 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
1429 W.printHex("ImportNameTable", Table->DelayImportNameTable);
1430 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
1431 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001432 printDelayImportedSymbols(I, I.imported_symbols());
Rui Ueyama1e152d52014-10-02 17:02:18 +00001433 }
1434}
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001435
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001436void COFFDumper::printCOFFExports() {
1437 for (const ExportDirectoryEntryRef &E : Obj->export_directories()) {
1438 DictScope Export(W, "Export");
1439
1440 StringRef Name;
1441 uint32_t Ordinal, RVA;
1442
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001443 error(E.getSymbolName(Name));
1444 error(E.getOrdinal(Ordinal));
1445 error(E.getExportRVA(RVA));
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001446
1447 W.printNumber("Ordinal", Ordinal);
1448 W.printString("Name", Name);
1449 W.printHex("RVA", RVA);
1450 }
1451}
1452
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001453void COFFDumper::printCOFFDirectives() {
1454 for (const SectionRef &Section : Obj->sections()) {
1455 StringRef Contents;
1456 StringRef Name;
1457
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001458 error(Section.getName(Name));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001459 if (Name != ".drectve")
1460 continue;
1461
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001462 error(Section.getContents(Contents));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001463
1464 W.printString("Directive(s)", Contents);
1465 }
1466}
Rui Ueyama74e85132014-11-19 00:18:07 +00001467
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001468static StringRef getBaseRelocTypeName(uint8_t Type) {
Rui Ueyama74e85132014-11-19 00:18:07 +00001469 switch (Type) {
1470 case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";
1471 case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";
1472 case COFF::IMAGE_REL_BASED_LOW: return "LOW";
1473 case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";
1474 case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";
Saleem Abdulrasool5a41c372015-01-16 20:16:09 +00001475 case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)";
Rui Ueyama74e85132014-11-19 00:18:07 +00001476 case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";
Colin LeMahieu9fbffee2014-11-19 17:10:39 +00001477 default: return "unknown (" + llvm::utostr(Type) + ")";
Rui Ueyama74e85132014-11-19 00:18:07 +00001478 }
1479}
1480
1481void COFFDumper::printCOFFBaseReloc() {
1482 ListScope D(W, "BaseReloc");
1483 for (const BaseRelocRef &I : Obj->base_relocs()) {
1484 uint8_t Type;
1485 uint32_t RVA;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001486 error(I.getRVA(RVA));
1487 error(I.getType(Type));
Rui Ueyama74e85132014-11-19 00:18:07 +00001488 DictScope Import(W, "Entry");
1489 W.printString("Type", getBaseRelocTypeName(Type));
1490 W.printHex("Address", RVA);
1491 }
1492}
Lang Hames0000afd2015-06-26 23:56:53 +00001493
Zachary Turner8d6396d2017-04-27 19:38:38 +00001494void COFFDumper::printCOFFResources() {
1495 ListScope ResourcesD(W, "Resources");
1496 for (const SectionRef &S : Obj->sections()) {
1497 StringRef Name;
1498 error(S.getName(Name));
1499 if (!Name.startswith(".rsrc"))
1500 continue;
1501
1502 StringRef Ref;
1503 error(S.getContents(Ref));
1504
1505 if ((Name == ".rsrc") || (Name == ".rsrc$01")) {
1506 auto Table =
1507 reinterpret_cast<const coff_resource_dir_table *>(Ref.data());
1508 char FormattedTime[20];
1509 time_t TDS = time_t(Table->TimeDateStamp);
1510 strftime(FormattedTime, sizeof(FormattedTime), "%Y-%m-%d %H:%M:%S",
1511 gmtime(&TDS));
1512 W.printHex("Time/Date Stamp", FormattedTime, Table->TimeDateStamp);
1513 }
1514 W.printBinaryBlock(Name.str() + " Data", Ref);
1515 }
1516}
1517
Lang Hames0000afd2015-06-26 23:56:53 +00001518void COFFDumper::printStackMap() const {
1519 object::SectionRef StackMapSection;
1520 for (auto Sec : Obj->sections()) {
1521 StringRef Name;
1522 Sec.getName(Name);
1523 if (Name == ".llvm_stackmaps") {
1524 StackMapSection = Sec;
1525 break;
1526 }
1527 }
1528
1529 if (StackMapSection == object::SectionRef())
1530 return;
1531
1532 StringRef StackMapContents;
1533 StackMapSection.getContents(StackMapContents);
1534 ArrayRef<uint8_t> StackMapContentsArray(
1535 reinterpret_cast<const uint8_t*>(StackMapContents.data()),
1536 StackMapContents.size());
1537
1538 if (Obj->isLittleEndian())
1539 prettyPrintStackMap(
1540 llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001541 StackMapV2Parser<support::little>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001542 else
1543 prettyPrintStackMap(llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001544 StackMapV2Parser<support::big>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001545}
Reid Kleckner0b269742016-05-14 00:02:53 +00001546
Zachary Turner4efa0a42016-11-08 22:24:53 +00001547void llvm::dumpCodeViewMergedTypes(ScopedPrinter &Writer,
Reid Kleckner5d577522017-03-24 17:26:38 +00001548 llvm::codeview::TypeTableBuilder &IDTable,
Zachary Turner4efa0a42016-11-08 22:24:53 +00001549 llvm::codeview::TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001550 // Flatten it first, then run our dumper on it.
Reid Kleckner5d577522017-03-24 17:26:38 +00001551 SmallString<0> TypeBuf;
Zachary Turner4efa0a42016-11-08 22:24:53 +00001552 CVTypes.ForEachRecord([&](TypeIndex TI, ArrayRef<uint8_t> Record) {
Reid Kleckner5d577522017-03-24 17:26:38 +00001553 TypeBuf.append(Record.begin(), Record.end());
Reid Kleckner0b269742016-05-14 00:02:53 +00001554 });
Zachary Turner629cb7d2017-01-11 23:24:22 +00001555
1556 TypeDatabase TypeDB;
Reid Kleckner5d577522017-03-24 17:26:38 +00001557 {
1558 ListScope S(Writer, "MergedTypeStream");
1559 CVTypeDumper CVTD(TypeDB);
1560 TypeDumpVisitor TDV(TypeDB, &Writer, opts::CodeViewSubsectionBytes);
1561 if (auto EC = CVTD.dump(
1562 {TypeBuf.str().bytes_begin(), TypeBuf.str().bytes_end()}, TDV)) {
1563 Writer.flush();
Reid Klecknerc4b5d792017-04-03 23:58:15 +00001564 error(std::move(EC));
Reid Kleckner5d577522017-03-24 17:26:38 +00001565 }
1566 }
1567
1568 // Flatten the id stream and print it next. The ID stream refers to names from
1569 // the type stream.
1570 SmallString<0> IDBuf;
1571 IDTable.ForEachRecord([&](TypeIndex TI, ArrayRef<uint8_t> Record) {
1572 IDBuf.append(Record.begin(), Record.end());
1573 });
1574
1575 {
1576 ListScope S(Writer, "MergedIDStream");
1577 TypeDatabase IDDB;
1578 CVTypeDumper CVTD(IDDB);
1579 TypeDumpVisitor TDV(TypeDB, &Writer, opts::CodeViewSubsectionBytes);
1580 TDV.setItemDB(IDDB);
1581 if (auto EC = CVTD.dump(
1582 {IDBuf.str().bytes_begin(), IDBuf.str().bytes_end()}, TDV)) {
1583 Writer.flush();
Reid Klecknerc4b5d792017-04-03 23:58:15 +00001584 error(std::move(EC));
Reid Kleckner5d577522017-03-24 17:26:38 +00001585 }
Reid Kleckner0b269742016-05-14 00:02:53 +00001586 }
1587}