blob: 263f66617f99c8463cea2cf2316fc57a7d4a3928 [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 Turneraaad5742016-05-23 23:41:13 +000028#include "llvm/DebugInfo/CodeView/RecordSerialization.h"
Zachary Turner0d840742016-10-07 21:34:46 +000029#include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
Zachary Turneraaad5742016-05-23 23:41:13 +000030#include "llvm/DebugInfo/CodeView/SymbolDumpDelegate.h"
31#include "llvm/DebugInfo/CodeView/SymbolDumper.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000032#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
Zachary Turner629cb7d2017-01-11 23:24:22 +000033#include "llvm/DebugInfo/CodeView/TypeDumpVisitor.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000034#include "llvm/DebugInfo/CodeView/TypeIndex.h"
35#include "llvm/DebugInfo/CodeView/TypeRecord.h"
Reid Kleckner0b269742016-05-14 00:02:53 +000036#include "llvm/DebugInfo/CodeView/TypeStreamMerger.h"
Zachary Turner4efa0a42016-11-08 22:24:53 +000037#include "llvm/DebugInfo/CodeView/TypeTableBuilder.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000038#include "llvm/Object/COFF.h"
39#include "llvm/Object/ObjectFile.h"
Zachary Turnerd9dc2822017-03-02 20:52:51 +000040#include "llvm/Support/BinaryByteStream.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000041#include "llvm/Support/COFF.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000042#include "llvm/Support/Casting.h"
43#include "llvm/Support/Compiler.h"
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000044#include "llvm/Support/DataExtractor.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000045#include "llvm/Support/Format.h"
Zachary Turner7b327d02017-02-16 23:35:45 +000046#include "llvm/Support/Path.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000047#include "llvm/Support/ScopedPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000048#include "llvm/Support/SourceMgr.h"
49#include "llvm/Support/Win64EH.h"
50#include "llvm/Support/raw_ostream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000051#include <algorithm>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000052#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000053#include <system_error>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000054#include <time.h>
Eric Christopher9cad53c2013-04-03 18:31:38 +000055
56using namespace llvm;
57using namespace llvm::object;
Reid Kleckner72e2ba72016-01-13 19:32:35 +000058using namespace llvm::codeview;
Reid Kleckner6b3faef2016-01-13 23:44:57 +000059using namespace llvm::support;
Eric Christopher9cad53c2013-04-03 18:31:38 +000060using namespace llvm::Win64EH;
61
62namespace {
63
64class COFFDumper : public ObjDumper {
65public:
Zachary Turneraaad5742016-05-23 23:41:13 +000066 friend class COFFObjectDumpDelegate;
Zachary Turner88bb1632016-05-03 00:28:04 +000067 COFFDumper(const llvm::object::COFFObjectFile *Obj, ScopedPrinter &Writer)
Zachary Turner629cb7d2017-01-11 23:24:22 +000068 : ObjDumper(Writer), Obj(Obj), Writer(Writer) {}
Eric Christopher9cad53c2013-04-03 18:31:38 +000069
Craig Topperfd38cbe2014-08-30 16:48:34 +000070 void printFileHeaders() override;
71 void printSections() override;
72 void printRelocations() override;
73 void printSymbols() override;
74 void printDynamicSymbols() override;
75 void printUnwindInfo() override;
Rui Ueyama1e152d52014-10-02 17:02:18 +000076 void printCOFFImports() override;
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +000077 void printCOFFExports() override;
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +000078 void printCOFFDirectives() override;
Rui Ueyama74e85132014-11-19 00:18:07 +000079 void printCOFFBaseReloc() override;
Reid Kleckner2da433e2016-06-02 17:10:43 +000080 void printCOFFDebugDirectory() override;
Reid Kleckner83ebad32015-12-16 18:28:12 +000081 void printCodeViewDebugInfo() override;
Zachary Turner4efa0a42016-11-08 22:24:53 +000082 void mergeCodeViewTypes(llvm::codeview::TypeTableBuilder &CVTypes) override;
Lang Hames0000afd2015-06-26 23:56:53 +000083 void printStackMap() const override;
Eric Christopher9cad53c2013-04-03 18:31:38 +000084private:
Alexey Samsonov27dc8392014-03-18 06:53:02 +000085 void printSymbol(const SymbolRef &Sym);
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +000086 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc,
87 uint64_t Bias = 0);
Rui Ueyamaed64342b2013-07-19 23:23:29 +000088 void printDataDirectory(uint32_t Index, const std::string &FieldName);
Eric Christopher9cad53c2013-04-03 18:31:38 +000089
David Majnemer50267222014-11-05 06:24:35 +000090 void printDOSHeader(const dos_header *DH);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +000091 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
92 void printBaseOfDataField(const pe32_header *Hdr);
93 void printBaseOfDataField(const pe32plus_header *Hdr);
94
Reid Kleckner72e2ba72016-01-13 19:32:35 +000095 void printCodeViewSymbolSection(StringRef SectionName, const SectionRef &Section);
96 void printCodeViewTypeSection(StringRef SectionName, const SectionRef &Section);
Reid Kleckner72e2ba72016-01-13 19:32:35 +000097 StringRef getTypeName(TypeIndex Ty);
Reid Kleckner8e7275c2016-01-15 00:11:21 +000098 StringRef getFileNameForFileOffset(uint32_t FileOffset);
99 void printFileNameForOffset(StringRef Label, uint32_t FileOffset);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000100 void printTypeIndex(StringRef FieldName, TypeIndex TI) {
101 // Forward to CVTypeDumper for simplicity.
Zachary Turner629cb7d2017-01-11 23:24:22 +0000102 CVTypeDumper::printTypeIndex(Writer, FieldName, TI, TypeDB);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000103 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000104
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000105 void printCodeViewSymbolsSubsection(StringRef Subsection,
106 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000107 StringRef SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000108
Reid Klecknerc31f5302016-01-15 18:06:25 +0000109 void printCodeViewFileChecksums(StringRef Subsection);
110
Reid Klecknere9ab3492016-01-14 19:20:17 +0000111 void printCodeViewInlineeLines(StringRef Subsection);
112
Reid Kleckner2893fd12016-01-14 17:51:54 +0000113 void printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000114 uint32_t RelocOffset, uint32_t Offset,
115 StringRef *RelocSym = nullptr);
116
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000117 void printBinaryBlockWithRelocs(StringRef Label, const SectionRef &Sec,
118 StringRef SectionContents, StringRef Block);
119
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000120 /// Given a .debug$S section, find the string table and file checksum table.
121 void initializeFileAndStringTables(StringRef Data);
122
Eric Christopher9cad53c2013-04-03 18:31:38 +0000123 void cacheRelocations();
124
Rafael Espindola4453e42942014-06-13 03:07:50 +0000125 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
126 SymbolRef &Sym);
127 std::error_code resolveSymbolName(const coff_section *Section,
128 uint64_t Offset, StringRef &Name);
Reid Kleckner2893fd12016-01-14 17:51:54 +0000129 std::error_code resolveSymbolName(const coff_section *Section,
130 StringRef SectionContents,
131 const void *RelocPtr, StringRef &Name);
Rui Ueyama979fb402014-10-09 02:16:38 +0000132 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +0000133 void printDelayImportedSymbols(
134 const DelayImportDirectoryEntryRef &I,
135 iterator_range<imported_symbol_iterator> Range);
Rui Ueyama15d99352014-10-03 00:41:58 +0000136
Eric Christopher9cad53c2013-04-03 18:31:38 +0000137 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
138
139 const llvm::object::COFFObjectFile *Obj;
Rafael Espindola76d650e2015-07-06 14:26:07 +0000140 bool RelocCached = false;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000141 RelocMapTy RelocMap;
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000142 StringRef CVFileChecksumTable;
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000143 StringRef CVStringTable;
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000144
Zachary Turner629cb7d2017-01-11 23:24:22 +0000145 ScopedPrinter &Writer;
146 TypeDatabase TypeDB;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000147};
148
Zachary Turneraaad5742016-05-23 23:41:13 +0000149class COFFObjectDumpDelegate : public SymbolDumpDelegate {
150public:
151 COFFObjectDumpDelegate(COFFDumper &CD, const SectionRef &SR,
152 const COFFObjectFile *Obj, StringRef SectionContents)
Zachary Turner537014c2016-05-24 03:32:34 +0000153 : CD(CD), SR(SR), SectionContents(SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000154 Sec = Obj->getCOFFSection(SR);
155 }
156
Zachary Turner120faca2017-02-27 22:11:43 +0000157 uint32_t getRecordOffset(BinaryStreamReader Reader) override {
Zachary Turner4d49eb92016-10-20 18:31:19 +0000158 ArrayRef<uint8_t> Data;
159 if (auto EC = Reader.readLongestContiguousChunk(Data)) {
160 llvm::consumeError(std::move(EC));
161 return 0;
162 }
163 return Data.data() - SectionContents.bytes_begin();
Zachary Turneraaad5742016-05-23 23:41:13 +0000164 }
165
166 void printRelocatedField(StringRef Label, uint32_t RelocOffset,
167 uint32_t Offset, StringRef *RelocSym) override {
168 CD.printRelocatedField(Label, Sec, RelocOffset, Offset, RelocSym);
169 }
170
171 void printBinaryBlockWithRelocs(StringRef Label,
172 ArrayRef<uint8_t> Block) override {
173 StringRef SBlock(reinterpret_cast<const char *>(Block.data()),
174 Block.size());
175 if (opts::CodeViewSubsectionBytes)
176 CD.printBinaryBlockWithRelocs(Label, SR, SectionContents, SBlock);
177 }
178
179 StringRef getFileNameForFileOffset(uint32_t FileOffset) override {
180 return CD.getFileNameForFileOffset(FileOffset);
181 }
182
183 StringRef getStringTable() override { return CD.CVStringTable; }
184
185private:
186 COFFDumper &CD;
187 const SectionRef &SR;
Zachary Turneraaad5742016-05-23 23:41:13 +0000188 const coff_section *Sec;
189 StringRef SectionContents;
190};
191
Reid Kleckner4a14bca2016-05-05 00:34:33 +0000192} // end namespace
Eric Christopher9cad53c2013-04-03 18:31:38 +0000193
194namespace llvm {
195
Rafael Espindola4453e42942014-06-13 03:07:50 +0000196std::error_code createCOFFDumper(const object::ObjectFile *Obj,
Zachary Turner88bb1632016-05-03 00:28:04 +0000197 ScopedPrinter &Writer,
Rafael Espindola4453e42942014-06-13 03:07:50 +0000198 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000199 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
200 if (!COFFObj)
201 return readobj_error::unsupported_obj_file_format;
202
203 Result.reset(new COFFDumper(COFFObj, Writer));
204 return readobj_error::success;
205}
206
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000207} // namespace llvm
Eric Christopher9cad53c2013-04-03 18:31:38 +0000208
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000209// Given a a section and an offset into this section the function returns the
210// symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000211std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
212 uint64_t Offset, SymbolRef &Sym) {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000213 cacheRelocations();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000214 const auto &Relocations = RelocMap[Section];
David Majnemer61f17982016-05-29 06:18:08 +0000215 auto SymI = Obj->symbol_end();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000216 for (const auto &Relocation : Relocations) {
Rafael Espindola96d071c2015-06-29 23:29:12 +0000217 uint64_t RelocationOffset = Relocation.getOffset();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000218
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000219 if (RelocationOffset == Offset) {
David Majnemer61f17982016-05-29 06:18:08 +0000220 SymI = Relocation.getSymbol();
221 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000222 }
223 }
David Majnemer61f17982016-05-29 06:18:08 +0000224 if (SymI == Obj->symbol_end())
225 return readobj_error::unknown_symbol;
226 Sym = *SymI;
227 return readobj_error::success;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000228}
229
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000230// Given a section and an offset into this section the function returns the name
231// of the symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000232std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
233 uint64_t Offset,
234 StringRef &Name) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000235 SymbolRef Symbol;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000236 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000237 return EC;
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000238 Expected<StringRef> NameOrErr = Symbol.getName();
239 if (!NameOrErr)
240 return errorToErrorCode(NameOrErr.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000241 Name = *NameOrErr;
Rui Ueyama7d099192015-06-09 15:20:42 +0000242 return std::error_code();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000243}
244
Reid Kleckner2893fd12016-01-14 17:51:54 +0000245// Helper for when you have a pointer to real data and you want to know about
246// relocations against it.
247std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
248 StringRef SectionContents,
249 const void *RelocPtr,
250 StringRef &Name) {
251 assert(SectionContents.data() < RelocPtr &&
252 RelocPtr < SectionContents.data() + SectionContents.size() &&
253 "pointer to relocated object is not in section");
254 uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) -
255 SectionContents.data());
256 return resolveSymbolName(Section, Offset, Name);
257}
258
259void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000260 uint32_t RelocOffset, uint32_t Offset,
261 StringRef *RelocSym) {
262 StringRef SymStorage;
263 StringRef &Symbol = RelocSym ? *RelocSym : SymStorage;
264 if (!resolveSymbolName(Sec, RelocOffset, Symbol))
265 W.printSymbolOffset(Label, Symbol, Offset);
266 else
267 W.printHex(Label, RelocOffset);
268}
269
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000270void COFFDumper::printBinaryBlockWithRelocs(StringRef Label,
271 const SectionRef &Sec,
272 StringRef SectionContents,
273 StringRef Block) {
274 W.printBinaryBlock(Label, Block);
275
276 assert(SectionContents.begin() < Block.begin() &&
277 SectionContents.end() >= Block.end() &&
278 "Block is not contained in SectionContents");
279 uint64_t OffsetStart = Block.data() - SectionContents.data();
280 uint64_t OffsetEnd = OffsetStart + Block.size();
281
Zachary Turneraaad5742016-05-23 23:41:13 +0000282 W.flush();
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000283 cacheRelocations();
284 ListScope D(W, "BlockRelocations");
285 const coff_section *Section = Obj->getCOFFSection(Sec);
286 const auto &Relocations = RelocMap[Section];
287 for (const auto &Relocation : Relocations) {
288 uint64_t RelocationOffset = Relocation.getOffset();
289 if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd)
290 printRelocation(Sec, Relocation, OffsetStart);
291 }
292}
293
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000294static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000295 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
296 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
297 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
298 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
Saleem Abdulrasool5e1780e2014-03-11 03:08:37 +0000299 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000300 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
301 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
302 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
303 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
304 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
305 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
306 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
307 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
308 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
309 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
310 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
311 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
312 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
313 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
314 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
315 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
316};
317
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000318static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000319 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
320 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
321 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
322 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
323 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
324 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
325 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
326 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
327 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
328 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
329 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
330 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
331 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
332 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
333 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
334};
335
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000336static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000337 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
338 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
339 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
340 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
341 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
342 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
343 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
344 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
345 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
346 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
347 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
348};
349
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000350static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
Rui Ueyama06dc5e72014-01-27 04:22:24 +0000351 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000352 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
353 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
354 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
355 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
356 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
357 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000358 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000359 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000360 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000361 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
362};
363
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000364static const EnumEntry<COFF::SectionCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000365ImageSectionCharacteristics[] = {
David Majnemerd3238882015-07-30 16:47:56 +0000366 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000367 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
368 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
369 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
370 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
371 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
372 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
373 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
374 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
375 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
376 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
377 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
378 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
379 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
380 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
381 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
382 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
383 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
384 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
385 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
386 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
387 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
388 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
389 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
390 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
391 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
392 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
393 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
394 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
395 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
396 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
397 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
398 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
399 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
400 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
401 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
402};
403
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000404static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000405 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
406 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
407 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
408 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
409 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
410 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
411 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
412 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
413 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
414 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
415 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
416 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
417 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
418 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
419 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
420 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
421};
422
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000423static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000424 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
425 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
426 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
427 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
428};
429
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000430static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000431 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
432 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
433 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
434 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
435 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
436 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
437 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
438 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
439 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
440 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
441 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
442 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
443 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
444 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
445 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
446 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
447 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
448 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
449 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
450 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
451 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
452 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
453 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
454 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
455 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
456 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
457 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
458};
459
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000460static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000461 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
462 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
463 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
464 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
465 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
466 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
467 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
468};
469
Reid Kleckner2da433e2016-06-02 17:10:43 +0000470static const EnumEntry<COFF::DebugType> ImageDebugType[] = {
471 { "Unknown" , COFF::IMAGE_DEBUG_TYPE_UNKNOWN },
472 { "COFF" , COFF::IMAGE_DEBUG_TYPE_COFF },
473 { "CodeView" , COFF::IMAGE_DEBUG_TYPE_CODEVIEW },
474 { "FPO" , COFF::IMAGE_DEBUG_TYPE_FPO },
475 { "Misc" , COFF::IMAGE_DEBUG_TYPE_MISC },
476 { "Exception" , COFF::IMAGE_DEBUG_TYPE_EXCEPTION },
477 { "Fixup" , COFF::IMAGE_DEBUG_TYPE_FIXUP },
478 { "OmapToSrc" , COFF::IMAGE_DEBUG_TYPE_OMAP_TO_SRC },
479 { "OmapFromSrc", COFF::IMAGE_DEBUG_TYPE_OMAP_FROM_SRC },
480 { "Borland" , COFF::IMAGE_DEBUG_TYPE_BORLAND },
David Majnemera2a2a732016-06-02 17:32:11 +0000481 { "Reserved10" , COFF::IMAGE_DEBUG_TYPE_RESERVED10 },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000482 { "CLSID" , COFF::IMAGE_DEBUG_TYPE_CLSID },
483 { "VCFeature" , COFF::IMAGE_DEBUG_TYPE_VC_FEATURE },
484 { "POGO" , COFF::IMAGE_DEBUG_TYPE_POGO },
485 { "ILTCG" , COFF::IMAGE_DEBUG_TYPE_ILTCG },
486 { "MPX" , COFF::IMAGE_DEBUG_TYPE_MPX },
David Majnemera2a2a732016-06-02 17:32:11 +0000487 { "Repro" , COFF::IMAGE_DEBUG_TYPE_REPRO },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000488};
489
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000490static const EnumEntry<COFF::WeakExternalCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000491WeakExternalCharacteristics[] = {
492 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
493 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
494 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
495};
496
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000497static const EnumEntry<uint32_t> SubSectionTypes[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000498 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Symbols),
499 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Lines),
500 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, StringTable),
501 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FileChecksums),
502 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FrameData),
503 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, InlineeLines),
504 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeImports),
505 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeExports),
506 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, ILLines),
507 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FuncMDTokenMap),
508 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, TypeMDTokenMap),
509 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, MergedAssemblyInput),
510 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CoffSymbolRVA),
511};
512
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000513static const EnumEntry<uint32_t> FrameDataFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000514 LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH),
515 LLVM_READOBJ_ENUM_ENT(FrameData, HasEH),
516 LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart),
517};
518
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000519static const EnumEntry<uint8_t> FileChecksumKindNames[] = {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000520 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, None),
521 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, MD5),
522 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA1),
523 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA256),
524};
525
Rafael Espindola4453e42942014-06-13 03:07:50 +0000526template <typename T>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000527static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
David Majnemer44f51e52014-09-10 12:51:52 +0000528 COFFSymbolRef Symbol,
529 uint8_t AuxSymbolIdx, const T *&Aux) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000530 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
David Majnemer44f51e52014-09-10 12:51:52 +0000531 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000532 Aux = reinterpret_cast<const T*>(AuxData.data());
533 return readobj_error::success;
534}
535
Eric Christopher9cad53c2013-04-03 18:31:38 +0000536void COFFDumper::cacheRelocations() {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000537 if (RelocCached)
538 return;
539 RelocCached = true;
540
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000541 for (const SectionRef &S : Obj->sections()) {
542 const coff_section *Section = Obj->getCOFFSection(S);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000543
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000544 for (const RelocationRef &Reloc : S.relocations())
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000545 RelocMap[Section].push_back(Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000546
547 // Sort relocations by address.
548 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
549 relocAddressLess);
550 }
551}
552
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000553void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
554 const data_directory *Data;
555 if (Obj->getDataDirectory(Index, Data))
556 return;
557 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
558 W.printHex(FieldName + "Size", Data->Size);
559}
560
Eric Christopher9cad53c2013-04-03 18:31:38 +0000561void COFFDumper::printFileHeaders() {
David Majnemer44f51e52014-09-10 12:51:52 +0000562 time_t TDS = Obj->getTimeDateStamp();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000563 char FormattedTime[20] = { };
564 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
565
566 {
567 DictScope D(W, "ImageFileHeader");
David Majnemer44f51e52014-09-10 12:51:52 +0000568 W.printEnum ("Machine", Obj->getMachine(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000569 makeArrayRef(ImageFileMachineType));
David Majnemer44f51e52014-09-10 12:51:52 +0000570 W.printNumber("SectionCount", Obj->getNumberOfSections());
571 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
572 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
573 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
574 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
575 W.printFlags ("Characteristics", Obj->getCharacteristics(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000576 makeArrayRef(ImageFileCharacteristics));
577 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000578
579 // Print PE header. This header does not exist if this is an object file and
580 // not an executable.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000581 const pe32_header *PEHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000582 error(Obj->getPE32Header(PEHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000583 if (PEHeader)
584 printPEHeader<pe32_header>(PEHeader);
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000585
Craig Toppere6cb63e2014-04-25 04:24:47 +0000586 const pe32plus_header *PEPlusHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000587 error(Obj->getPE32PlusHeader(PEPlusHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000588 if (PEPlusHeader)
589 printPEHeader<pe32plus_header>(PEPlusHeader);
David Majnemer50267222014-11-05 06:24:35 +0000590
591 if (const dos_header *DH = Obj->getDOSHeader())
592 printDOSHeader(DH);
593}
594
595void COFFDumper::printDOSHeader(const dos_header *DH) {
596 DictScope D(W, "DOSHeader");
597 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
598 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
599 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
600 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
601 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
602 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
603 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
604 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
605 W.printNumber("InitialSP", DH->InitialSP);
606 W.printNumber("Checksum", DH->Checksum);
607 W.printNumber("InitialIP", DH->InitialIP);
608 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
609 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
610 W.printNumber("OverlayNumber", DH->OverlayNumber);
611 W.printNumber("OEMid", DH->OEMid);
612 W.printNumber("OEMinfo", DH->OEMinfo);
613 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000614}
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000615
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000616template <class PEHeader>
617void COFFDumper::printPEHeader(const PEHeader *Hdr) {
618 DictScope D(W, "ImageOptionalHeader");
619 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
620 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
621 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
622 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
623 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
624 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
625 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
626 printBaseOfDataField(Hdr);
627 W.printHex ("ImageBase", Hdr->ImageBase);
628 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
629 W.printNumber("FileAlignment", Hdr->FileAlignment);
630 W.printNumber("MajorOperatingSystemVersion",
631 Hdr->MajorOperatingSystemVersion);
632 W.printNumber("MinorOperatingSystemVersion",
633 Hdr->MinorOperatingSystemVersion);
634 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
635 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
636 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
637 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
638 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
639 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
640 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
David Majnemer774aadf2014-11-18 02:45:28 +0000641 W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000642 makeArrayRef(PEDLLCharacteristics));
643 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
644 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
645 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
646 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
647 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000648
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000649 if (Hdr->NumberOfRvaAndSize > 0) {
650 DictScope D(W, "DataDirectory");
651 static const char * const directory[] = {
652 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
653 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
654 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
655 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
656 };
657
Reid Kleckner2da433e2016-06-02 17:10:43 +0000658 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i)
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000659 printDataDirectory(i, directory[i]);
Reid Kleckner2da433e2016-06-02 17:10:43 +0000660 }
661}
662
663void COFFDumper::printCOFFDebugDirectory() {
664 ListScope LS(W, "DebugDirectory");
665 for (const debug_directory &D : Obj->debug_directories()) {
666 char FormattedTime[20] = {};
667 time_t TDS = D.TimeDateStamp;
668 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
669 DictScope S(W, "DebugEntry");
670 W.printHex("Characteristics", D.Characteristics);
671 W.printHex("TimeDateStamp", FormattedTime, D.TimeDateStamp);
672 W.printHex("MajorVersion", D.MajorVersion);
673 W.printHex("MinorVersion", D.MinorVersion);
674 W.printEnum("Type", D.Type, makeArrayRef(ImageDebugType));
675 W.printHex("SizeOfData", D.SizeOfData);
676 W.printHex("AddressOfRawData", D.AddressOfRawData);
677 W.printHex("PointerToRawData", D.PointerToRawData);
678 if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW) {
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000679 const codeview::DebugInfo *DebugInfo;
Reid Kleckner2da433e2016-06-02 17:10:43 +0000680 StringRef PDBFileName;
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000681 error(Obj->getDebugPDBInfo(&D, DebugInfo, PDBFileName));
Reid Kleckner2da433e2016-06-02 17:10:43 +0000682 DictScope PDBScope(W, "PDBInfo");
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000683 W.printHex("PDBSignature", DebugInfo->Signature.CVSignature);
684 if (DebugInfo->Signature.CVSignature == OMF::Signature::PDB70) {
685 W.printBinary("PDBGUID", makeArrayRef(DebugInfo->PDB70.Signature));
686 W.printNumber("PDBAge", DebugInfo->PDB70.Age);
687 W.printString("PDBFileName", PDBFileName);
688 }
Reid Kleckner2da433e2016-06-02 17:10:43 +0000689 } else {
690 // FIXME: Type values of 12 and 13 are commonly observed but are not in
691 // the documented type enum. Figure out what they mean.
692 ArrayRef<uint8_t> RawData;
693 error(
694 Obj->getRvaAndSizeAsBytes(D.AddressOfRawData, D.SizeOfData, RawData));
695 W.printBinaryBlock("RawData", RawData);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000696 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000697 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000698}
699
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000700void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
701 W.printHex("BaseOfData", Hdr->BaseOfData);
702}
703
704void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
705
Reid Kleckner83ebad32015-12-16 18:28:12 +0000706void COFFDumper::printCodeViewDebugInfo() {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000707 // Print types first to build CVUDTNames, then print symbols.
Reid Kleckner83ebad32015-12-16 18:28:12 +0000708 for (const SectionRef &S : Obj->sections()) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000709 StringRef SectionName;
710 error(S.getName(SectionName));
711 if (SectionName == ".debug$T")
712 printCodeViewTypeSection(SectionName, S);
713 }
714 for (const SectionRef &S : Obj->sections()) {
715 StringRef SectionName;
716 error(S.getName(SectionName));
717 if (SectionName == ".debug$S")
718 printCodeViewSymbolSection(SectionName, S);
Reid Kleckner83ebad32015-12-16 18:28:12 +0000719 }
720}
721
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000722void COFFDumper::initializeFileAndStringTables(StringRef Data) {
723 while (!Data.empty() && (CVFileChecksumTable.data() == nullptr ||
724 CVStringTable.data() == nullptr)) {
725 // The section consists of a number of subsection in the following format:
726 // |SubSectionType|SubSectionSize|Contents...|
727 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000728 error(consume(Data, SubType));
729 error(consume(Data, SubSectionSize));
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000730 if (SubSectionSize > Data.size())
731 return error(object_error::parse_failed);
732 switch (ModuleSubstreamKind(SubType)) {
733 case ModuleSubstreamKind::FileChecksums:
734 CVFileChecksumTable = Data.substr(0, SubSectionSize);
735 break;
736 case ModuleSubstreamKind::StringTable:
737 CVStringTable = Data.substr(0, SubSectionSize);
738 break;
739 default:
740 break;
741 }
David Majnemerefaaf412016-05-28 20:04:48 +0000742 uint32_t PaddedSize = alignTo(SubSectionSize, 4);
743 if (PaddedSize > Data.size())
744 error(object_error::parse_failed);
745 Data = Data.drop_front(PaddedSize);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000746 }
747}
748
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000749void COFFDumper::printCodeViewSymbolSection(StringRef SectionName,
750 const SectionRef &Section) {
751 StringRef SectionContents;
752 error(Section.getContents(SectionContents));
753 StringRef Data = SectionContents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000754
755 SmallVector<StringRef, 10> FunctionNames;
756 StringMap<StringRef> FunctionLineTables;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000757
Zachary Turner99f02152015-02-18 19:32:05 +0000758 ListScope D(W, "CodeViewDebugInfo");
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000759 // Print the section to allow correlation with printSections.
760 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000761
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000762 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000763 error(consume(Data, Magic));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000764 W.printHex("Magic", Magic);
765 if (Magic != COFF::DEBUG_SECTION_MAGIC)
766 return error(object_error::parse_failed);
767
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000768 initializeFileAndStringTables(Data);
769
Zachary Turnera96cce62016-06-03 03:25:59 +0000770 // TODO: Convert this over to using ModuleSubstreamVisitor.
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000771 while (!Data.empty()) {
772 // The section consists of a number of subsection in the following format:
773 // |SubSectionType|SubSectionSize|Contents...|
774 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000775 error(consume(Data, SubType));
776 error(consume(Data, SubSectionSize));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000777
778 ListScope S(W, "Subsection");
779 W.printEnum("SubSectionType", SubType, makeArrayRef(SubSectionTypes));
780 W.printHex("SubSectionSize", SubSectionSize);
781
782 // Get the contents of the subsection.
783 if (SubSectionSize > Data.size())
784 return error(object_error::parse_failed);
785 StringRef Contents = Data.substr(0, SubSectionSize);
786
787 // Add SubSectionSize to the current offset and align that offset to find
788 // the next subsection.
789 size_t SectionOffset = Data.data() - SectionContents.data();
790 size_t NextOffset = SectionOffset + SubSectionSize;
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000791 NextOffset = alignTo(NextOffset, 4);
David Majnemercab2b462016-05-28 20:04:50 +0000792 if (NextOffset > SectionContents.size())
793 return error(object_error::parse_failed);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000794 Data = SectionContents.drop_front(NextOffset);
795
796 // Optionally print the subsection bytes in case our parsing gets confused
797 // later.
798 if (opts::CodeViewSubsectionBytes)
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000799 printBinaryBlockWithRelocs("SubSectionContents", Section, SectionContents,
800 Contents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000801
802 switch (ModuleSubstreamKind(SubType)) {
803 case ModuleSubstreamKind::Symbols:
Reid Kleckner2893fd12016-01-14 17:51:54 +0000804 printCodeViewSymbolsSubsection(Contents, Section, SectionContents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000805 break;
Reid Klecknere9ab3492016-01-14 19:20:17 +0000806
807 case ModuleSubstreamKind::InlineeLines:
808 printCodeViewInlineeLines(Contents);
809 break;
810
Reid Klecknerc31f5302016-01-15 18:06:25 +0000811 case ModuleSubstreamKind::FileChecksums:
812 printCodeViewFileChecksums(Contents);
813 break;
814
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000815 case ModuleSubstreamKind::Lines: {
816 // Holds a PC to file:line table. Some data to parse this subsection is
817 // stored in the other subsections, so just check sanity and store the
818 // pointers for deferred processing.
819
820 if (SubSectionSize < 12) {
821 // There should be at least three words to store two function
822 // relocations and size of the code.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000823 error(object_error::parse_failed);
824 return;
825 }
826
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000827 StringRef LinkageName;
828 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset,
829 LinkageName));
830 W.printString("LinkageName", LinkageName);
831 if (FunctionLineTables.count(LinkageName) != 0) {
832 // Saw debug info for this function already?
833 error(object_error::parse_failed);
834 return;
Zachary Turner99f02152015-02-18 19:32:05 +0000835 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000836
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000837 FunctionLineTables[LinkageName] = Contents;
838 FunctionNames.push_back(LinkageName);
839 break;
840 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000841 case ModuleSubstreamKind::FrameData: {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000842 // First four bytes is a relocation against the function.
Zachary Turner695ed562017-02-28 00:04:07 +0000843 BinaryByteStream S(Contents, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +0000844 BinaryStreamReader SR(S);
NAKAMURA Takumi05a75e42017-02-25 17:04:23 +0000845 const uint32_t *CodePtr;
846 error(SR.readObject(CodePtr));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000847 StringRef LinkageName;
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000848 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionContents,
NAKAMURA Takumi05a75e42017-02-25 17:04:23 +0000849 CodePtr, LinkageName));
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000850 W.printString("LinkageName", LinkageName);
851
852 // To find the active frame description, search this array for the
853 // smallest PC range that includes the current PC.
Zachary Turner4d49eb92016-10-20 18:31:19 +0000854 while (!SR.empty()) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000855 const FrameData *FD;
Zachary Turner4d49eb92016-10-20 18:31:19 +0000856 error(SR.readObject(FD));
David Majnemera6d93fd2016-05-28 19:45:49 +0000857
858 if (FD->FrameFunc >= CVStringTable.size())
859 error(object_error::parse_failed);
860
861 StringRef FrameFunc =
862 CVStringTable.drop_front(FD->FrameFunc).split('\0').first;
863
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000864 DictScope S(W, "FrameData");
865 W.printHex("RvaStart", FD->RvaStart);
866 W.printHex("CodeSize", FD->CodeSize);
867 W.printHex("LocalSize", FD->LocalSize);
868 W.printHex("ParamsSize", FD->ParamsSize);
869 W.printHex("MaxStackSize", FD->MaxStackSize);
David Majnemera6d93fd2016-05-28 19:45:49 +0000870 W.printString("FrameFunc", FrameFunc);
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000871 W.printHex("PrologSize", FD->PrologSize);
872 W.printHex("SavedRegsSize", FD->SavedRegsSize);
873 W.printFlags("Flags", FD->Flags, makeArrayRef(FrameDataFlags));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000874 }
875 break;
876 }
877
878 // Do nothing for unrecognized subsections.
879 default:
880 break;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000881 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000882 W.flush();
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000883 }
884
885 // Dump the line tables now that we've read all the subsections and know all
886 // the required information.
887 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
888 StringRef Name = FunctionNames[I];
889 ListScope S(W, "FunctionLineTable");
Reid Kleckner7c0c0c02015-12-15 01:23:55 +0000890 W.printString("LinkageName", Name);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000891
892 DataExtractor DE(FunctionLineTables[Name], true, 4);
David Majnemer3f49e662015-07-09 00:19:51 +0000893 uint32_t Offset = 6; // Skip relocations.
894 uint16_t Flags = DE.getU16(&Offset);
895 W.printHex("Flags", Flags);
Reid Kleckner2214ed82016-01-29 00:49:42 +0000896 bool HasColumnInformation = Flags & codeview::LineFlags::HaveColumns;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000897 uint32_t FunctionSize = DE.getU32(&Offset);
898 W.printHex("CodeSize", FunctionSize);
899 while (DE.isValidOffset(Offset)) {
900 // For each range of lines with the same filename, we have a segment
901 // in the line table. The filename string is accessed using double
902 // indirection to the string table subsection using the index subsection.
903 uint32_t OffsetInIndex = DE.getU32(&Offset),
David Majnemer04948362016-01-13 01:05:16 +0000904 NumLines = DE.getU32(&Offset),
David Majnemer0373d532015-07-09 18:14:31 +0000905 FullSegmentSize = DE.getU32(&Offset);
906
David Majnemer04948362016-01-13 01:05:16 +0000907 uint32_t ColumnOffset = Offset + 8 * NumLines;
908 DataExtractor ColumnDE(DE.getData(), true, 4);
909
David Majnemer0373d532015-07-09 18:14:31 +0000910 if (FullSegmentSize !=
David Majnemer04948362016-01-13 01:05:16 +0000911 12 + 8 * NumLines + (HasColumnInformation ? 4 * NumLines : 0)) {
David Majnemer0373d532015-07-09 18:14:31 +0000912 error(object_error::parse_failed);
913 return;
914 }
Justin Bognera1413db2015-07-09 04:27:36 +0000915
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000916 ListScope S(W, "FilenameSegment");
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000917 printFileNameForOffset("Filename", OffsetInIndex);
David Majnemer04948362016-01-13 01:05:16 +0000918 for (unsigned LineIdx = 0;
919 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000920 // Then go the (PC, LineNumber) pairs. The line number is stored in the
921 // least significant 31 bits of the respective word in the table.
David Majnemer04948362016-01-13 01:05:16 +0000922 uint32_t PC = DE.getU32(&Offset), LineData = DE.getU32(&Offset);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000923 if (PC >= FunctionSize) {
924 error(object_error::parse_failed);
925 return;
926 }
927 char Buffer[32];
928 format("+0x%X", PC).snprint(Buffer, 32);
David Majnemer04948362016-01-13 01:05:16 +0000929 ListScope PCScope(W, Buffer);
David Majnemera4859df2016-02-04 17:57:12 +0000930 LineInfo LI(LineData);
931 if (LI.isAlwaysStepInto())
932 W.printString("StepInto", StringRef("Always"));
933 else if (LI.isNeverStepInto())
934 W.printString("StepInto", StringRef("Never"));
935 else
936 W.printNumber("LineNumberStart", LI.getStartLine());
937 W.printNumber("LineNumberEndDelta", LI.getLineDelta());
938 W.printBoolean("IsStatement", LI.isStatement());
David Majnemer04948362016-01-13 01:05:16 +0000939 if (HasColumnInformation &&
940 ColumnDE.isValidOffsetForDataOfSize(ColumnOffset, 4)) {
941 uint16_t ColStart = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +0000942 W.printNumber("ColStart", ColStart);
David Majnemer04948362016-01-13 01:05:16 +0000943 uint16_t ColEnd = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +0000944 W.printNumber("ColEnd", ColEnd);
945 }
946 }
David Majnemer04948362016-01-13 01:05:16 +0000947 // Skip over the column data.
948 if (HasColumnInformation) {
949 for (unsigned LineIdx = 0;
950 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
951 DE.getU32(&Offset);
952 }
953 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000954 }
955 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000956}
957
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000958void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
959 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000960 StringRef SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000961 ArrayRef<uint8_t> BinaryData(Subsection.bytes_begin(),
962 Subsection.bytes_end());
963 auto CODD = llvm::make_unique<COFFObjectDumpDelegate>(*this, Section, Obj,
964 SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000965
Zachary Turner629cb7d2017-01-11 23:24:22 +0000966 CVSymbolDumper CVSD(W, TypeDB, std::move(CODD),
967 opts::CodeViewSubsectionBytes);
Zachary Turner695ed562017-02-28 00:04:07 +0000968 BinaryByteStream Stream(BinaryData, llvm::support::little);
Zachary Turner0d43c1c2016-05-28 05:21:57 +0000969 CVSymbolArray Symbols;
Zachary Turner120faca2017-02-27 22:11:43 +0000970 BinaryStreamReader Reader(Stream);
Zachary Turner0d43c1c2016-05-28 05:21:57 +0000971 if (auto EC = Reader.readArray(Symbols, Reader.getLength())) {
972 consumeError(std::move(EC));
973 W.flush();
974 error(object_error::parse_failed);
975 }
Reid Kleckner2893fd12016-01-14 17:51:54 +0000976
Zachary Turner0d840742016-10-07 21:34:46 +0000977 if (auto EC = CVSD.dump(Symbols)) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000978 W.flush();
Zachary Turner0d840742016-10-07 21:34:46 +0000979 error(std::move(EC));
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000980 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000981 W.flush();
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000982}
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000983
Reid Klecknerc31f5302016-01-15 18:06:25 +0000984void COFFDumper::printCodeViewFileChecksums(StringRef Subsection) {
Zachary Turner695ed562017-02-28 00:04:07 +0000985 BinaryByteStream S(Subsection, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +0000986 BinaryStreamReader SR(S);
Zachary Turner4d49eb92016-10-20 18:31:19 +0000987 while (!SR.empty()) {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000988 DictScope S(W, "FileChecksum");
989 const FileChecksum *FC;
Zachary Turner4d49eb92016-10-20 18:31:19 +0000990 error(SR.readObject(FC));
Reid Klecknerc31f5302016-01-15 18:06:25 +0000991 if (FC->FileNameOffset >= CVStringTable.size())
992 error(object_error::parse_failed);
993 StringRef Filename =
994 CVStringTable.drop_front(FC->FileNameOffset).split('\0').first;
995 W.printHex("Filename", Filename, FC->FileNameOffset);
996 W.printHex("ChecksumSize", FC->ChecksumSize);
997 W.printEnum("ChecksumKind", uint8_t(FC->ChecksumKind),
998 makeArrayRef(FileChecksumKindNames));
Zachary Turner4d49eb92016-10-20 18:31:19 +0000999 if (FC->ChecksumSize >= SR.bytesRemaining())
Reid Klecknerc31f5302016-01-15 18:06:25 +00001000 error(object_error::parse_failed);
Zachary Turner4d49eb92016-10-20 18:31:19 +00001001 ArrayRef<uint8_t> ChecksumBytes;
1002 error(SR.readBytes(ChecksumBytes, FC->ChecksumSize));
Reid Klecknerc31f5302016-01-15 18:06:25 +00001003 W.printBinary("ChecksumBytes", ChecksumBytes);
Rafael Espindolaa79078c2016-01-18 20:55:24 +00001004 unsigned PaddedSize = alignTo(FC->ChecksumSize + sizeof(FileChecksum), 4) -
1005 sizeof(FileChecksum);
Zachary Turner4d49eb92016-10-20 18:31:19 +00001006 PaddedSize -= ChecksumBytes.size();
1007 if (PaddedSize > SR.bytesRemaining())
David Majnemer37dafba2016-05-28 19:45:58 +00001008 error(object_error::parse_failed);
Zachary Turner4d49eb92016-10-20 18:31:19 +00001009 error(SR.skip(PaddedSize));
Reid Klecknerc31f5302016-01-15 18:06:25 +00001010 }
1011}
1012
Reid Klecknere9ab3492016-01-14 19:20:17 +00001013void COFFDumper::printCodeViewInlineeLines(StringRef Subsection) {
Zachary Turner695ed562017-02-28 00:04:07 +00001014 BinaryByteStream S(Subsection, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +00001015 BinaryStreamReader SR(S);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001016 uint32_t Signature;
Zachary Turner695ed562017-02-28 00:04:07 +00001017 error(SR.readInteger(Signature));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001018 bool HasExtraFiles = Signature == unsigned(InlineeLinesSignature::ExtraFiles);
1019
Zachary Turner4d49eb92016-10-20 18:31:19 +00001020 while (!SR.empty()) {
Reid Klecknere9ab3492016-01-14 19:20:17 +00001021 const InlineeSourceLine *ISL;
Zachary Turner4d49eb92016-10-20 18:31:19 +00001022 error(SR.readObject(ISL));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001023 DictScope S(W, "InlineeSourceLine");
1024 printTypeIndex("Inlinee", ISL->Inlinee);
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001025 printFileNameForOffset("FileID", ISL->FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001026 W.printNumber("SourceLineNum", ISL->SourceLineNum);
1027
1028 if (HasExtraFiles) {
1029 uint32_t ExtraFileCount;
Zachary Turner695ed562017-02-28 00:04:07 +00001030 error(SR.readInteger(ExtraFileCount));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001031 W.printNumber("ExtraFileCount", ExtraFileCount);
1032 ListScope ExtraFiles(W, "ExtraFiles");
1033 for (unsigned I = 0; I < ExtraFileCount; ++I) {
1034 uint32_t FileID;
Zachary Turner695ed562017-02-28 00:04:07 +00001035 error(SR.readInteger(FileID));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001036 printFileNameForOffset("FileID", FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001037 }
1038 }
1039 }
1040}
1041
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001042StringRef COFFDumper::getFileNameForFileOffset(uint32_t FileOffset) {
1043 // The file checksum subsection should precede all references to it.
1044 if (!CVFileChecksumTable.data() || !CVStringTable.data())
1045 error(object_error::parse_failed);
1046 // Check if the file checksum table offset is valid.
1047 if (FileOffset >= CVFileChecksumTable.size())
1048 error(object_error::parse_failed);
1049
1050 // The string table offset comes first before the file checksum.
1051 StringRef Data = CVFileChecksumTable.drop_front(FileOffset);
1052 uint32_t StringOffset;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001053 error(consume(Data, StringOffset));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001054
1055 // Check if the string table offset is valid.
1056 if (StringOffset >= CVStringTable.size())
1057 error(object_error::parse_failed);
1058
1059 // Return the null-terminated string.
1060 return CVStringTable.drop_front(StringOffset).split('\0').first;
1061}
1062
1063void COFFDumper::printFileNameForOffset(StringRef Label, uint32_t FileOffset) {
1064 W.printHex(Label, getFileNameForFileOffset(FileOffset), FileOffset);
1065}
1066
Zachary Turner4efa0a42016-11-08 22:24:53 +00001067void COFFDumper::mergeCodeViewTypes(TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001068 for (const SectionRef &S : Obj->sections()) {
1069 StringRef SectionName;
1070 error(S.getName(SectionName));
1071 if (SectionName == ".debug$T") {
1072 StringRef Data;
1073 error(S.getContents(Data));
David Majnemer78b0d722016-05-28 19:17:48 +00001074 uint32_t Magic;
1075 error(consume(Data, Magic));
Reid Kleckner0b269742016-05-14 00:02:53 +00001076 if (Magic != 4)
1077 error(object_error::parse_failed);
Reid Kleckner0b269742016-05-14 00:02:53 +00001078 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(Data.data()),
1079 Data.size());
Zachary Turner695ed562017-02-28 00:04:07 +00001080 BinaryByteStream Stream(Bytes, llvm::support::little);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001081 CVTypeArray Types;
Zachary Turner120faca2017-02-27 22:11:43 +00001082 BinaryStreamReader Reader(Stream);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001083 if (auto EC = Reader.readArray(Types, Reader.getLength())) {
1084 consumeError(std::move(EC));
1085 W.flush();
1086 error(object_error::parse_failed);
1087 }
1088
Zachary Turner7b327d02017-02-16 23:35:45 +00001089 if (auto EC = mergeTypeStreams(CVTypes, nullptr, Types)) {
Rui Ueyamaa9b29612017-02-02 00:47:10 +00001090 consumeError(std::move(EC));
Reid Kleckner0b269742016-05-14 00:02:53 +00001091 return error(object_error::parse_failed);
Rui Ueyamaa9b29612017-02-02 00:47:10 +00001092 }
Reid Kleckner0b269742016-05-14 00:02:53 +00001093 }
1094 }
1095}
1096
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001097void COFFDumper::printCodeViewTypeSection(StringRef SectionName,
1098 const SectionRef &Section) {
1099 ListScope D(W, "CodeViewTypes");
1100 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Adrian McCarthy963a3312016-05-02 23:45:03 +00001101
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001102 StringRef Data;
1103 error(Section.getContents(Data));
Reid Klecknerb2bd2812016-05-02 18:10:00 +00001104 if (opts::CodeViewSubsectionBytes)
1105 W.printBinaryBlock("Data", Data);
Reid Kleckner7960de92016-05-04 19:39:28 +00001106
1107 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001108 error(consume(Data, Magic));
Reid Kleckner7960de92016-05-04 19:39:28 +00001109 W.printHex("Magic", Magic);
1110 if (Magic != COFF::DEBUG_SECTION_MAGIC)
1111 return error(object_error::parse_failed);
1112
Zachary Turner629cb7d2017-01-11 23:24:22 +00001113 CVTypeDumper CVTD(TypeDB);
1114 TypeDumpVisitor TDV(TypeDB, &W, opts::CodeViewSubsectionBytes);
1115 if (auto EC = CVTD.dump({Data.bytes_begin(), Data.bytes_end()}, TDV)) {
Reid Kleckner4a14bca2016-05-05 00:34:33 +00001116 W.flush();
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001117 error(llvm::errorToErrorCode(std::move(EC)));
Reid Kleckner7960de92016-05-04 19:39:28 +00001118 }
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001119}
1120
Eric Christopher9cad53c2013-04-03 18:31:38 +00001121void COFFDumper::printSections() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001122 ListScope SectionsD(W, "Sections");
1123 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001124 for (const SectionRef &Sec : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001125 ++SectionNumber;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001126 const coff_section *Section = Obj->getCOFFSection(Sec);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001127
1128 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001129 error(Sec.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001130
1131 DictScope D(W, "Section");
1132 W.printNumber("Number", SectionNumber);
1133 W.printBinary("Name", Name, Section->Name);
1134 W.printHex ("VirtualSize", Section->VirtualSize);
1135 W.printHex ("VirtualAddress", Section->VirtualAddress);
1136 W.printNumber("RawDataSize", Section->SizeOfRawData);
1137 W.printHex ("PointerToRawData", Section->PointerToRawData);
1138 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
1139 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
1140 W.printNumber("RelocationCount", Section->NumberOfRelocations);
1141 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
1142 W.printFlags ("Characteristics", Section->Characteristics,
1143 makeArrayRef(ImageSectionCharacteristics),
1144 COFF::SectionCharacteristics(0x00F00000));
1145
1146 if (opts::SectionRelocations) {
1147 ListScope D(W, "Relocations");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001148 for (const RelocationRef &Reloc : Sec.relocations())
1149 printRelocation(Sec, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001150 }
1151
1152 if (opts::SectionSymbols) {
1153 ListScope D(W, "Symbols");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001154 for (const SymbolRef &Symbol : Obj->symbols()) {
Rafael Espindola80291272014-10-08 15:28:58 +00001155 if (!Sec.containsSymbol(Symbol))
Eric Christopher9cad53c2013-04-03 18:31:38 +00001156 continue;
1157
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001158 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001159 }
1160 }
1161
David Majnemerdac39852014-09-26 22:32:16 +00001162 if (opts::SectionData &&
1163 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001164 StringRef Data;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001165 error(Sec.getContents(Data));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001166
1167 W.printBinaryBlock("SectionData", Data);
1168 }
1169 }
1170}
1171
1172void COFFDumper::printRelocations() {
1173 ListScope D(W, "Relocations");
1174
Eric Christopher9cad53c2013-04-03 18:31:38 +00001175 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001176 for (const SectionRef &Section : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001177 ++SectionNumber;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001178 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001179 error(Section.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001180
1181 bool PrintedGroup = false;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001182 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001183 if (!PrintedGroup) {
1184 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
1185 W.indent();
1186 PrintedGroup = true;
1187 }
1188
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001189 printRelocation(Section, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001190 }
1191
1192 if (PrintedGroup) {
1193 W.unindent();
1194 W.startLine() << "}\n";
1195 }
1196 }
1197}
1198
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001199void COFFDumper::printRelocation(const SectionRef &Section,
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00001200 const RelocationRef &Reloc, uint64_t Bias) {
1201 uint64_t Offset = Reloc.getOffset() - Bias;
Rafael Espindola99c041b2015-06-30 01:53:01 +00001202 uint64_t RelocType = Reloc.getType();
Eric Christopher9cad53c2013-04-03 18:31:38 +00001203 SmallString<32> RelocName;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001204 StringRef SymbolName;
Rafael Espindola41bb4322015-06-30 04:08:37 +00001205 Reloc.getTypeName(RelocName);
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001206 symbol_iterator Symbol = Reloc.getSymbol();
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001207 if (Symbol != Obj->symbol_end()) {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001208 Expected<StringRef> SymbolNameOrErr = Symbol->getName();
1209 error(errorToErrorCode(SymbolNameOrErr.takeError()));
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001210 SymbolName = *SymbolNameOrErr;
1211 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001212
Nico Rieckf3f0b792013-04-12 04:01:52 +00001213 if (opts::ExpandRelocs) {
1214 DictScope Group(W, "Relocation");
1215 W.printHex("Offset", Offset);
1216 W.printNumber("Type", RelocName, RelocType);
David Majnemer1f80b0a2014-11-13 07:42:11 +00001217 W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName);
Nico Rieckf3f0b792013-04-12 04:01:52 +00001218 } else {
1219 raw_ostream& OS = W.startLine();
1220 OS << W.hex(Offset)
1221 << " " << RelocName
David Majnemer1f80b0a2014-11-13 07:42:11 +00001222 << " " << (SymbolName.empty() ? "-" : SymbolName)
Nico Rieckf3f0b792013-04-12 04:01:52 +00001223 << "\n";
1224 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001225}
1226
1227void COFFDumper::printSymbols() {
1228 ListScope Group(W, "Symbols");
1229
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001230 for (const SymbolRef &Symbol : Obj->symbols())
1231 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001232}
1233
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001234void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001235
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001236static ErrorOr<StringRef>
David Majnemer236b0ca2014-11-17 11:17:17 +00001237getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber,
1238 const coff_section *Section) {
David Majnemerf4dc4562014-09-20 00:25:06 +00001239 if (Section) {
1240 StringRef SectionName;
David Majnemer236b0ca2014-11-17 11:17:17 +00001241 if (std::error_code EC = Obj->getSectionName(Section, SectionName))
1242 return EC;
David Majnemerf4dc4562014-09-20 00:25:06 +00001243 return SectionName;
1244 }
David Majnemerf4dc4562014-09-20 00:25:06 +00001245 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
David Majnemer236b0ca2014-11-17 11:17:17 +00001246 return StringRef("IMAGE_SYM_DEBUG");
David Majnemerf4dc4562014-09-20 00:25:06 +00001247 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
David Majnemer236b0ca2014-11-17 11:17:17 +00001248 return StringRef("IMAGE_SYM_ABSOLUTE");
David Majnemerf4dc4562014-09-20 00:25:06 +00001249 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
David Majnemer236b0ca2014-11-17 11:17:17 +00001250 return StringRef("IMAGE_SYM_UNDEFINED");
1251 return StringRef("");
David Majnemerf4dc4562014-09-20 00:25:06 +00001252}
1253
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001254void COFFDumper::printSymbol(const SymbolRef &Sym) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001255 DictScope D(W, "Symbol");
1256
David Majnemer44f51e52014-09-10 12:51:52 +00001257 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001258 const coff_section *Section;
David Majnemer44f51e52014-09-10 12:51:52 +00001259 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001260 W.startLine() << "Invalid section number: " << EC.message() << "\n";
1261 W.flush();
1262 return;
1263 }
1264
1265 StringRef SymbolName;
1266 if (Obj->getSymbolName(Symbol, SymbolName))
1267 SymbolName = "";
1268
David Majnemer236b0ca2014-11-17 11:17:17 +00001269 StringRef SectionName = "";
1270 ErrorOr<StringRef> Res =
1271 getSectionName(Obj, Symbol.getSectionNumber(), Section);
1272 if (Res)
1273 SectionName = *Res;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001274
1275 W.printString("Name", SymbolName);
David Majnemer44f51e52014-09-10 12:51:52 +00001276 W.printNumber("Value", Symbol.getValue());
1277 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
1278 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
1279 W.printEnum ("ComplexType", Symbol.getComplexType(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001280 makeArrayRef(ImageSymDType));
David Majnemer44f51e52014-09-10 12:51:52 +00001281 W.printEnum ("StorageClass", Symbol.getStorageClass(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001282 makeArrayRef(ImageSymClass));
David Majnemer44f51e52014-09-10 12:51:52 +00001283 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
Eric Christopher9cad53c2013-04-03 18:31:38 +00001284
David Majnemer44f51e52014-09-10 12:51:52 +00001285 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
1286 if (Symbol.isFunctionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001287 const coff_aux_function_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001288 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001289
1290 DictScope AS(W, "AuxFunctionDef");
1291 W.printNumber("TagIndex", Aux->TagIndex);
1292 W.printNumber("TotalSize", Aux->TotalSize);
David Majnemerf3a2af52014-03-19 04:33:27 +00001293 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001294 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001295
David Majnemerc7d7c6f2014-10-31 05:07:00 +00001296 } else if (Symbol.isAnyUndefined()) {
David Majnemerf3a2af52014-03-19 04:33:27 +00001297 const coff_aux_weak_external *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001298 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001299
David Majnemer44f51e52014-09-10 12:51:52 +00001300 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001301 StringRef LinkedName;
David Majnemer44f51e52014-09-10 12:51:52 +00001302 std::error_code EC = Linked.getError();
1303 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001304 LinkedName = "";
1305 error(EC);
1306 }
1307
1308 DictScope AS(W, "AuxWeakExternal");
1309 W.printNumber("Linked", LinkedName, Aux->TagIndex);
1310 W.printEnum ("Search", Aux->Characteristics,
1311 makeArrayRef(WeakExternalCharacteristics));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001312
David Majnemer44f51e52014-09-10 12:51:52 +00001313 } else if (Symbol.isFileRecord()) {
1314 const char *FileName;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001315 error(getSymbolAuxData(Obj, Symbol, I, FileName));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001316
Nico Rieck0ab8e602013-04-22 08:35:11 +00001317 DictScope AS(W, "AuxFileRecord");
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001318
David Majnemer44f51e52014-09-10 12:51:52 +00001319 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
1320 Obj->getSymbolTableEntrySize());
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001321 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
Saleem Abdulrasool3b5e0012014-04-16 04:15:29 +00001322 break;
David Majnemer44f51e52014-09-10 12:51:52 +00001323 } else if (Symbol.isSectionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001324 const coff_aux_section_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001325 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001326
David Majnemer4d571592014-09-15 19:42:42 +00001327 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
1328
Eric Christopher9cad53c2013-04-03 18:31:38 +00001329 DictScope AS(W, "AuxSectionDef");
1330 W.printNumber("Length", Aux->Length);
1331 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
1332 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
1333 W.printHex("Checksum", Aux->CheckSum);
David Majnemer4d571592014-09-15 19:42:42 +00001334 W.printNumber("Number", AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001335 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001336
Nico Riecka711dee2013-04-22 08:34:59 +00001337 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
Eric Christopher9cad53c2013-04-03 18:31:38 +00001338 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
1339 const coff_section *Assoc;
David Majnemer236b0ca2014-11-17 11:17:17 +00001340 StringRef AssocName = "";
1341 std::error_code EC = Obj->getSection(AuxNumber, Assoc);
1342 ErrorOr<StringRef> Res = getSectionName(Obj, AuxNumber, Assoc);
1343 if (Res)
1344 AssocName = *Res;
1345 if (!EC)
1346 EC = Res.getError();
1347 if (EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001348 AssocName = "";
1349 error(EC);
1350 }
1351
David Majnemer4d571592014-09-15 19:42:42 +00001352 W.printNumber("AssocSection", AssocName, AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001353 }
David Majnemer44f51e52014-09-10 12:51:52 +00001354 } else if (Symbol.isCLRToken()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001355 const coff_aux_clr_token *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001356 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001357
David Majnemer44f51e52014-09-10 12:51:52 +00001358 ErrorOr<COFFSymbolRef> ReferredSym =
1359 Obj->getSymbol(Aux->SymbolTableIndex);
Nico Rieck8678acd2014-03-17 01:46:52 +00001360 StringRef ReferredName;
David Majnemer44f51e52014-09-10 12:51:52 +00001361 std::error_code EC = ReferredSym.getError();
1362 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
Nico Rieck8678acd2014-03-17 01:46:52 +00001363 ReferredName = "";
1364 error(EC);
1365 }
1366
Eric Christopher9cad53c2013-04-03 18:31:38 +00001367 DictScope AS(W, "AuxCLRToken");
1368 W.printNumber("AuxType", Aux->AuxType);
1369 W.printNumber("Reserved", Aux->Reserved);
Nico Rieck8678acd2014-03-17 01:46:52 +00001370 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001371
1372 } else {
1373 W.startLine() << "<unhandled auxiliary record>\n";
1374 }
1375 }
1376}
1377
1378void COFFDumper::printUnwindInfo() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001379 ListScope D(W, "UnwindInformation");
David Majnemer44f51e52014-09-10 12:51:52 +00001380 switch (Obj->getMachine()) {
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001381 case COFF::IMAGE_FILE_MACHINE_AMD64: {
1382 Win64EH::Dumper Dumper(W);
Rafael Espindola4453e42942014-06-13 03:07:50 +00001383 Win64EH::Dumper::SymbolResolver
1384 Resolver = [](const object::coff_section *Section, uint64_t Offset,
1385 SymbolRef &Symbol, void *user_data) -> std::error_code {
1386 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
1387 return Dumper->resolveSymbol(Section, Offset, Symbol);
1388 };
Saleem Abdulrasool65dbbb52014-05-25 21:37:59 +00001389 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001390 Dumper.printData(Ctx);
1391 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001392 }
Saleem Abdulrasoole6971ca2014-06-04 15:47:15 +00001393 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
1394 ARM::WinEH::Decoder Decoder(W);
1395 Decoder.dumpProcedureData(*Obj);
1396 break;
1397 }
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001398 default:
David Majnemer44f51e52014-09-10 12:51:52 +00001399 W.printEnum("unsupported Image Machine", Obj->getMachine(),
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001400 makeArrayRef(ImageFileMachineType));
1401 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001402 }
1403}
1404
Rui Ueyama979fb402014-10-09 02:16:38 +00001405void COFFDumper::printImportedSymbols(
1406 iterator_range<imported_symbol_iterator> Range) {
1407 for (const ImportedSymbolRef &I : Range) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001408 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001409 error(I.getSymbolName(Sym));
Rui Ueyama15d99352014-10-03 00:41:58 +00001410 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001411 error(I.getOrdinal(Ordinal));
Rui Ueyama15d99352014-10-03 00:41:58 +00001412 W.printNumber("Symbol", Sym, Ordinal);
1413 }
1414}
1415
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001416void COFFDumper::printDelayImportedSymbols(
1417 const DelayImportDirectoryEntryRef &I,
1418 iterator_range<imported_symbol_iterator> Range) {
1419 int Index = 0;
1420 for (const ImportedSymbolRef &S : Range) {
1421 DictScope Import(W, "Import");
1422 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001423 error(S.getSymbolName(Sym));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001424 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001425 error(S.getOrdinal(Ordinal));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001426 W.printNumber("Symbol", Sym, Ordinal);
1427 uint64_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001428 error(I.getImportAddress(Index++, Addr));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001429 W.printHex("Address", Addr);
1430 }
1431}
1432
Rui Ueyama1e152d52014-10-02 17:02:18 +00001433void COFFDumper::printCOFFImports() {
Rui Ueyama15d99352014-10-03 00:41:58 +00001434 // Regular imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001435 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
Rui Ueyama1e152d52014-10-02 17:02:18 +00001436 DictScope Import(W, "Import");
1437 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001438 error(I.getName(Name));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001439 W.printString("Name", Name);
1440 uint32_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001441 error(I.getImportLookupTableRVA(Addr));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001442 W.printHex("ImportLookupTableRVA", Addr);
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001443 error(I.getImportAddressTableRVA(Addr));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001444 W.printHex("ImportAddressTableRVA", Addr);
Rui Ueyama979fb402014-10-09 02:16:38 +00001445 printImportedSymbols(I.imported_symbols());
Rui Ueyama15d99352014-10-03 00:41:58 +00001446 }
1447
1448 // Delay imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001449 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001450 DictScope Import(W, "DelayImport");
1451 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001452 error(I.getName(Name));
Rui Ueyama15d99352014-10-03 00:41:58 +00001453 W.printString("Name", Name);
Rui Ueyama1af08652014-10-03 18:07:18 +00001454 const delay_import_directory_table_entry *Table;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001455 error(I.getDelayImportTable(Table));
Rui Ueyama1af08652014-10-03 18:07:18 +00001456 W.printHex("Attributes", Table->Attributes);
1457 W.printHex("ModuleHandle", Table->ModuleHandle);
1458 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
1459 W.printHex("ImportNameTable", Table->DelayImportNameTable);
1460 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
1461 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001462 printDelayImportedSymbols(I, I.imported_symbols());
Rui Ueyama1e152d52014-10-02 17:02:18 +00001463 }
1464}
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001465
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001466void COFFDumper::printCOFFExports() {
1467 for (const ExportDirectoryEntryRef &E : Obj->export_directories()) {
1468 DictScope Export(W, "Export");
1469
1470 StringRef Name;
1471 uint32_t Ordinal, RVA;
1472
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001473 error(E.getSymbolName(Name));
1474 error(E.getOrdinal(Ordinal));
1475 error(E.getExportRVA(RVA));
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001476
1477 W.printNumber("Ordinal", Ordinal);
1478 W.printString("Name", Name);
1479 W.printHex("RVA", RVA);
1480 }
1481}
1482
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001483void COFFDumper::printCOFFDirectives() {
1484 for (const SectionRef &Section : Obj->sections()) {
1485 StringRef Contents;
1486 StringRef Name;
1487
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001488 error(Section.getName(Name));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001489 if (Name != ".drectve")
1490 continue;
1491
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001492 error(Section.getContents(Contents));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001493
1494 W.printString("Directive(s)", Contents);
1495 }
1496}
Rui Ueyama74e85132014-11-19 00:18:07 +00001497
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001498static StringRef getBaseRelocTypeName(uint8_t Type) {
Rui Ueyama74e85132014-11-19 00:18:07 +00001499 switch (Type) {
1500 case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";
1501 case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";
1502 case COFF::IMAGE_REL_BASED_LOW: return "LOW";
1503 case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";
1504 case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";
Saleem Abdulrasool5a41c372015-01-16 20:16:09 +00001505 case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)";
Rui Ueyama74e85132014-11-19 00:18:07 +00001506 case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";
Colin LeMahieu9fbffee2014-11-19 17:10:39 +00001507 default: return "unknown (" + llvm::utostr(Type) + ")";
Rui Ueyama74e85132014-11-19 00:18:07 +00001508 }
1509}
1510
1511void COFFDumper::printCOFFBaseReloc() {
1512 ListScope D(W, "BaseReloc");
1513 for (const BaseRelocRef &I : Obj->base_relocs()) {
1514 uint8_t Type;
1515 uint32_t RVA;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001516 error(I.getRVA(RVA));
1517 error(I.getType(Type));
Rui Ueyama74e85132014-11-19 00:18:07 +00001518 DictScope Import(W, "Entry");
1519 W.printString("Type", getBaseRelocTypeName(Type));
1520 W.printHex("Address", RVA);
1521 }
1522}
Lang Hames0000afd2015-06-26 23:56:53 +00001523
1524void COFFDumper::printStackMap() const {
1525 object::SectionRef StackMapSection;
1526 for (auto Sec : Obj->sections()) {
1527 StringRef Name;
1528 Sec.getName(Name);
1529 if (Name == ".llvm_stackmaps") {
1530 StackMapSection = Sec;
1531 break;
1532 }
1533 }
1534
1535 if (StackMapSection == object::SectionRef())
1536 return;
1537
1538 StringRef StackMapContents;
1539 StackMapSection.getContents(StackMapContents);
1540 ArrayRef<uint8_t> StackMapContentsArray(
1541 reinterpret_cast<const uint8_t*>(StackMapContents.data()),
1542 StackMapContents.size());
1543
1544 if (Obj->isLittleEndian())
1545 prettyPrintStackMap(
1546 llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001547 StackMapV2Parser<support::little>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001548 else
1549 prettyPrintStackMap(llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001550 StackMapV2Parser<support::big>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001551}
Reid Kleckner0b269742016-05-14 00:02:53 +00001552
Zachary Turner4efa0a42016-11-08 22:24:53 +00001553void llvm::dumpCodeViewMergedTypes(ScopedPrinter &Writer,
1554 llvm::codeview::TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001555 // Flatten it first, then run our dumper on it.
1556 ListScope S(Writer, "MergedTypeStream");
1557 SmallString<0> Buf;
Zachary Turner4efa0a42016-11-08 22:24:53 +00001558 CVTypes.ForEachRecord([&](TypeIndex TI, ArrayRef<uint8_t> Record) {
Reid Klecknerfbdbe9e2016-05-31 18:45:36 +00001559 Buf.append(Record.begin(), Record.end());
Reid Kleckner0b269742016-05-14 00:02:53 +00001560 });
Zachary Turner629cb7d2017-01-11 23:24:22 +00001561
1562 TypeDatabase TypeDB;
1563 CVTypeDumper CVTD(TypeDB);
1564 TypeDumpVisitor TDV(TypeDB, &Writer, opts::CodeViewSubsectionBytes);
1565 if (auto EC =
1566 CVTD.dump({Buf.str().bytes_begin(), Buf.str().bytes_end()}, TDV)) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001567 Writer.flush();
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001568 error(llvm::errorToErrorCode(std::move(EC)));
Reid Kleckner0b269742016-05-14 00:02:53 +00001569 }
1570}