blob: 0ca186519cd24290db474bcf12f67c6cb68fcbae [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"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000025#include "llvm/DebugInfo/CodeView/CodeView.h"
Reid Klecknere9ab3492016-01-14 19:20:17 +000026#include "llvm/DebugInfo/CodeView/Line.h"
Zachary Turneraaad5742016-05-23 23:41:13 +000027#include "llvm/DebugInfo/CodeView/RecordSerialization.h"
Zachary Turner0d840742016-10-07 21:34:46 +000028#include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
Zachary Turneraaad5742016-05-23 23:41:13 +000029#include "llvm/DebugInfo/CodeView/SymbolDumpDelegate.h"
30#include "llvm/DebugInfo/CodeView/SymbolDumper.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000031#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
Reid Kleckner4a14bca2016-05-05 00:34:33 +000032#include "llvm/DebugInfo/CodeView/TypeDumper.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000033#include "llvm/DebugInfo/CodeView/TypeIndex.h"
34#include "llvm/DebugInfo/CodeView/TypeRecord.h"
Reid Kleckner0b269742016-05-14 00:02:53 +000035#include "llvm/DebugInfo/CodeView/TypeStreamMerger.h"
Zachary Turner4efa0a42016-11-08 22:24:53 +000036#include "llvm/DebugInfo/CodeView/TypeTableBuilder.h"
Zachary Turnera3225b02016-07-29 20:56:36 +000037#include "llvm/DebugInfo/MSF/ByteStream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000038#include "llvm/Object/COFF.h"
39#include "llvm/Object/ObjectFile.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000040#include "llvm/Support/COFF.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000041#include "llvm/Support/Casting.h"
42#include "llvm/Support/Compiler.h"
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000043#include "llvm/Support/DataExtractor.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000044#include "llvm/Support/Format.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000045#include "llvm/Support/ScopedPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000046#include "llvm/Support/SourceMgr.h"
47#include "llvm/Support/Win64EH.h"
48#include "llvm/Support/raw_ostream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000049#include <algorithm>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000050#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000051#include <system_error>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000052#include <time.h>
Eric Christopher9cad53c2013-04-03 18:31:38 +000053
54using namespace llvm;
55using namespace llvm::object;
Reid Kleckner72e2ba72016-01-13 19:32:35 +000056using namespace llvm::codeview;
Zachary Turnerbac69d32016-07-22 19:56:05 +000057using namespace llvm::msf;
Reid Kleckner6b3faef2016-01-13 23:44:57 +000058using namespace llvm::support;
Eric Christopher9cad53c2013-04-03 18:31:38 +000059using namespace llvm::Win64EH;
60
61namespace {
62
63class COFFDumper : public ObjDumper {
64public:
Zachary Turneraaad5742016-05-23 23:41:13 +000065 friend class COFFObjectDumpDelegate;
Zachary Turner88bb1632016-05-03 00:28:04 +000066 COFFDumper(const llvm::object::COFFObjectFile *Obj, ScopedPrinter &Writer)
Reid Kleckner4a14bca2016-05-05 00:34:33 +000067 : ObjDumper(Writer), Obj(Obj),
Reid Klecknerfbdbe9e2016-05-31 18:45:36 +000068 CVTD(&Writer, opts::CodeViewSubsectionBytes) {}
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.
102 CVTD.printTypeIndex(FieldName, TI);
103 }
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
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000145 CVTypeDumper CVTD;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000146};
147
Zachary Turneraaad5742016-05-23 23:41:13 +0000148class COFFObjectDumpDelegate : public SymbolDumpDelegate {
149public:
150 COFFObjectDumpDelegate(COFFDumper &CD, const SectionRef &SR,
151 const COFFObjectFile *Obj, StringRef SectionContents)
Zachary Turner537014c2016-05-24 03:32:34 +0000152 : CD(CD), SR(SR), SectionContents(SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000153 Sec = Obj->getCOFFSection(SR);
154 }
155
Zachary Turner4d49eb92016-10-20 18:31:19 +0000156 uint32_t getRecordOffset(msf::StreamReader Reader) override {
157 ArrayRef<uint8_t> Data;
158 if (auto EC = Reader.readLongestContiguousChunk(Data)) {
159 llvm::consumeError(std::move(EC));
160 return 0;
161 }
162 return Data.data() - SectionContents.bytes_begin();
Zachary Turneraaad5742016-05-23 23:41:13 +0000163 }
164
165 void printRelocatedField(StringRef Label, uint32_t RelocOffset,
166 uint32_t Offset, StringRef *RelocSym) override {
167 CD.printRelocatedField(Label, Sec, RelocOffset, Offset, RelocSym);
168 }
169
170 void printBinaryBlockWithRelocs(StringRef Label,
171 ArrayRef<uint8_t> Block) override {
172 StringRef SBlock(reinterpret_cast<const char *>(Block.data()),
173 Block.size());
174 if (opts::CodeViewSubsectionBytes)
175 CD.printBinaryBlockWithRelocs(Label, SR, SectionContents, SBlock);
176 }
177
178 StringRef getFileNameForFileOffset(uint32_t FileOffset) override {
179 return CD.getFileNameForFileOffset(FileOffset);
180 }
181
182 StringRef getStringTable() override { return CD.CVStringTable; }
183
184private:
185 COFFDumper &CD;
186 const SectionRef &SR;
Zachary Turneraaad5742016-05-23 23:41:13 +0000187 const coff_section *Sec;
188 StringRef SectionContents;
189};
190
Reid Kleckner4a14bca2016-05-05 00:34:33 +0000191} // end namespace
Eric Christopher9cad53c2013-04-03 18:31:38 +0000192
193namespace llvm {
194
Rafael Espindola4453e42942014-06-13 03:07:50 +0000195std::error_code createCOFFDumper(const object::ObjectFile *Obj,
Zachary Turner88bb1632016-05-03 00:28:04 +0000196 ScopedPrinter &Writer,
Rafael Espindola4453e42942014-06-13 03:07:50 +0000197 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000198 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
199 if (!COFFObj)
200 return readobj_error::unsupported_obj_file_format;
201
202 Result.reset(new COFFDumper(COFFObj, Writer));
203 return readobj_error::success;
204}
205
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000206} // namespace llvm
Eric Christopher9cad53c2013-04-03 18:31:38 +0000207
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000208// Given a a section and an offset into this section the function returns the
209// symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000210std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
211 uint64_t Offset, SymbolRef &Sym) {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000212 cacheRelocations();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000213 const auto &Relocations = RelocMap[Section];
David Majnemer61f17982016-05-29 06:18:08 +0000214 auto SymI = Obj->symbol_end();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000215 for (const auto &Relocation : Relocations) {
Rafael Espindola96d071c2015-06-29 23:29:12 +0000216 uint64_t RelocationOffset = Relocation.getOffset();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000217
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000218 if (RelocationOffset == Offset) {
David Majnemer61f17982016-05-29 06:18:08 +0000219 SymI = Relocation.getSymbol();
220 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000221 }
222 }
David Majnemer61f17982016-05-29 06:18:08 +0000223 if (SymI == Obj->symbol_end())
224 return readobj_error::unknown_symbol;
225 Sym = *SymI;
226 return readobj_error::success;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000227}
228
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000229// Given a section and an offset into this section the function returns the name
230// of the symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000231std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
232 uint64_t Offset,
233 StringRef &Name) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000234 SymbolRef Symbol;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000235 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000236 return EC;
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000237 Expected<StringRef> NameOrErr = Symbol.getName();
238 if (!NameOrErr)
239 return errorToErrorCode(NameOrErr.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000240 Name = *NameOrErr;
Rui Ueyama7d099192015-06-09 15:20:42 +0000241 return std::error_code();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000242}
243
Reid Kleckner2893fd12016-01-14 17:51:54 +0000244// Helper for when you have a pointer to real data and you want to know about
245// relocations against it.
246std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
247 StringRef SectionContents,
248 const void *RelocPtr,
249 StringRef &Name) {
250 assert(SectionContents.data() < RelocPtr &&
251 RelocPtr < SectionContents.data() + SectionContents.size() &&
252 "pointer to relocated object is not in section");
253 uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) -
254 SectionContents.data());
255 return resolveSymbolName(Section, Offset, Name);
256}
257
258void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000259 uint32_t RelocOffset, uint32_t Offset,
260 StringRef *RelocSym) {
261 StringRef SymStorage;
262 StringRef &Symbol = RelocSym ? *RelocSym : SymStorage;
263 if (!resolveSymbolName(Sec, RelocOffset, Symbol))
264 W.printSymbolOffset(Label, Symbol, Offset);
265 else
266 W.printHex(Label, RelocOffset);
267}
268
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000269void COFFDumper::printBinaryBlockWithRelocs(StringRef Label,
270 const SectionRef &Sec,
271 StringRef SectionContents,
272 StringRef Block) {
273 W.printBinaryBlock(Label, Block);
274
275 assert(SectionContents.begin() < Block.begin() &&
276 SectionContents.end() >= Block.end() &&
277 "Block is not contained in SectionContents");
278 uint64_t OffsetStart = Block.data() - SectionContents.data();
279 uint64_t OffsetEnd = OffsetStart + Block.size();
280
Zachary Turneraaad5742016-05-23 23:41:13 +0000281 W.flush();
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000282 cacheRelocations();
283 ListScope D(W, "BlockRelocations");
284 const coff_section *Section = Obj->getCOFFSection(Sec);
285 const auto &Relocations = RelocMap[Section];
286 for (const auto &Relocation : Relocations) {
287 uint64_t RelocationOffset = Relocation.getOffset();
288 if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd)
289 printRelocation(Sec, Relocation, OffsetStart);
290 }
291}
292
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000293static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000294 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
295 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
296 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
297 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
Saleem Abdulrasool5e1780e2014-03-11 03:08:37 +0000298 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000299 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
300 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
301 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
302 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
303 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
304 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
305 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
306 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
307 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
308 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
309 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
310 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
311 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
312 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
313 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
314 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
315};
316
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000317static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000318 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
319 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
320 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
321 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
322 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
323 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
324 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
325 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
326 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
327 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
328 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
329 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
330 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
331 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
332 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
333};
334
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000335static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000336 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
337 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
338 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
339 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
340 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
341 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
342 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
343 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
344 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
345 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
346 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
347};
348
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000349static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
Rui Ueyama06dc5e72014-01-27 04:22:24 +0000350 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000351 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
352 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
353 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
354 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
355 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
356 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000357 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000358 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000359 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000360 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
361};
362
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000363static const EnumEntry<COFF::SectionCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000364ImageSectionCharacteristics[] = {
David Majnemerd3238882015-07-30 16:47:56 +0000365 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000366 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
367 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
368 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
369 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
370 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
371 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
372 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
373 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
374 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
375 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
376 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
377 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
378 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
379 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
380 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
381 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
382 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
383 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
384 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
385 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
386 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
387 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
388 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
389 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
390 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
391 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
392 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
393 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
394 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
395 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
396 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
397 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
398 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
399 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
400 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
401};
402
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000403static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000404 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
405 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
406 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
407 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
408 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
409 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
410 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
411 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
412 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
413 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
414 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
415 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
416 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
417 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
418 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
419 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
420};
421
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000422static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000423 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
424 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
425 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
426 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
427};
428
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000429static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000430 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
431 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
432 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
433 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
434 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
435 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
436 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
437 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
438 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
439 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
440 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
441 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
442 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
443 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
444 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
445 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
446 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
447 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
448 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
449 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
450 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
451 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
452 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
453 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
454 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
455 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
456 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
457};
458
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000459static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000460 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
461 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
462 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
463 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
464 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
465 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
466 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
467};
468
Reid Kleckner2da433e2016-06-02 17:10:43 +0000469static const EnumEntry<COFF::DebugType> ImageDebugType[] = {
470 { "Unknown" , COFF::IMAGE_DEBUG_TYPE_UNKNOWN },
471 { "COFF" , COFF::IMAGE_DEBUG_TYPE_COFF },
472 { "CodeView" , COFF::IMAGE_DEBUG_TYPE_CODEVIEW },
473 { "FPO" , COFF::IMAGE_DEBUG_TYPE_FPO },
474 { "Misc" , COFF::IMAGE_DEBUG_TYPE_MISC },
475 { "Exception" , COFF::IMAGE_DEBUG_TYPE_EXCEPTION },
476 { "Fixup" , COFF::IMAGE_DEBUG_TYPE_FIXUP },
477 { "OmapToSrc" , COFF::IMAGE_DEBUG_TYPE_OMAP_TO_SRC },
478 { "OmapFromSrc", COFF::IMAGE_DEBUG_TYPE_OMAP_FROM_SRC },
479 { "Borland" , COFF::IMAGE_DEBUG_TYPE_BORLAND },
David Majnemera2a2a732016-06-02 17:32:11 +0000480 { "Reserved10" , COFF::IMAGE_DEBUG_TYPE_RESERVED10 },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000481 { "CLSID" , COFF::IMAGE_DEBUG_TYPE_CLSID },
482 { "VCFeature" , COFF::IMAGE_DEBUG_TYPE_VC_FEATURE },
483 { "POGO" , COFF::IMAGE_DEBUG_TYPE_POGO },
484 { "ILTCG" , COFF::IMAGE_DEBUG_TYPE_ILTCG },
485 { "MPX" , COFF::IMAGE_DEBUG_TYPE_MPX },
David Majnemera2a2a732016-06-02 17:32:11 +0000486 { "Repro" , COFF::IMAGE_DEBUG_TYPE_REPRO },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000487};
488
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000489static const EnumEntry<COFF::WeakExternalCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000490WeakExternalCharacteristics[] = {
491 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
492 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
493 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
494};
495
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000496static const EnumEntry<uint32_t> SubSectionTypes[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000497 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Symbols),
498 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Lines),
499 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, StringTable),
500 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FileChecksums),
501 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FrameData),
502 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, InlineeLines),
503 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeImports),
504 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeExports),
505 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, ILLines),
506 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FuncMDTokenMap),
507 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, TypeMDTokenMap),
508 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, MergedAssemblyInput),
509 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CoffSymbolRVA),
510};
511
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000512static const EnumEntry<uint32_t> FrameDataFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000513 LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH),
514 LLVM_READOBJ_ENUM_ENT(FrameData, HasEH),
515 LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart),
516};
517
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000518static const EnumEntry<uint8_t> FileChecksumKindNames[] = {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000519 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, None),
520 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, MD5),
521 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA1),
522 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA256),
523};
524
Rafael Espindola4453e42942014-06-13 03:07:50 +0000525template <typename T>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000526static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
David Majnemer44f51e52014-09-10 12:51:52 +0000527 COFFSymbolRef Symbol,
528 uint8_t AuxSymbolIdx, const T *&Aux) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000529 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
David Majnemer44f51e52014-09-10 12:51:52 +0000530 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000531 Aux = reinterpret_cast<const T*>(AuxData.data());
532 return readobj_error::success;
533}
534
Eric Christopher9cad53c2013-04-03 18:31:38 +0000535void COFFDumper::cacheRelocations() {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000536 if (RelocCached)
537 return;
538 RelocCached = true;
539
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000540 for (const SectionRef &S : Obj->sections()) {
541 const coff_section *Section = Obj->getCOFFSection(S);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000542
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000543 for (const RelocationRef &Reloc : S.relocations())
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000544 RelocMap[Section].push_back(Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000545
546 // Sort relocations by address.
547 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
548 relocAddressLess);
549 }
550}
551
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000552void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
553 const data_directory *Data;
554 if (Obj->getDataDirectory(Index, Data))
555 return;
556 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
557 W.printHex(FieldName + "Size", Data->Size);
558}
559
Eric Christopher9cad53c2013-04-03 18:31:38 +0000560void COFFDumper::printFileHeaders() {
David Majnemer44f51e52014-09-10 12:51:52 +0000561 time_t TDS = Obj->getTimeDateStamp();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000562 char FormattedTime[20] = { };
563 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
564
565 {
566 DictScope D(W, "ImageFileHeader");
David Majnemer44f51e52014-09-10 12:51:52 +0000567 W.printEnum ("Machine", Obj->getMachine(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000568 makeArrayRef(ImageFileMachineType));
David Majnemer44f51e52014-09-10 12:51:52 +0000569 W.printNumber("SectionCount", Obj->getNumberOfSections());
570 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
571 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
572 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
573 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
574 W.printFlags ("Characteristics", Obj->getCharacteristics(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000575 makeArrayRef(ImageFileCharacteristics));
576 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000577
578 // Print PE header. This header does not exist if this is an object file and
579 // not an executable.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000580 const pe32_header *PEHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000581 error(Obj->getPE32Header(PEHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000582 if (PEHeader)
583 printPEHeader<pe32_header>(PEHeader);
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000584
Craig Toppere6cb63e2014-04-25 04:24:47 +0000585 const pe32plus_header *PEPlusHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000586 error(Obj->getPE32PlusHeader(PEPlusHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000587 if (PEPlusHeader)
588 printPEHeader<pe32plus_header>(PEPlusHeader);
David Majnemer50267222014-11-05 06:24:35 +0000589
590 if (const dos_header *DH = Obj->getDOSHeader())
591 printDOSHeader(DH);
592}
593
594void COFFDumper::printDOSHeader(const dos_header *DH) {
595 DictScope D(W, "DOSHeader");
596 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
597 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
598 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
599 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
600 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
601 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
602 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
603 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
604 W.printNumber("InitialSP", DH->InitialSP);
605 W.printNumber("Checksum", DH->Checksum);
606 W.printNumber("InitialIP", DH->InitialIP);
607 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
608 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
609 W.printNumber("OverlayNumber", DH->OverlayNumber);
610 W.printNumber("OEMid", DH->OEMid);
611 W.printNumber("OEMinfo", DH->OEMinfo);
612 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000613}
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000614
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000615template <class PEHeader>
616void COFFDumper::printPEHeader(const PEHeader *Hdr) {
617 DictScope D(W, "ImageOptionalHeader");
618 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
619 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
620 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
621 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
622 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
623 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
624 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
625 printBaseOfDataField(Hdr);
626 W.printHex ("ImageBase", Hdr->ImageBase);
627 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
628 W.printNumber("FileAlignment", Hdr->FileAlignment);
629 W.printNumber("MajorOperatingSystemVersion",
630 Hdr->MajorOperatingSystemVersion);
631 W.printNumber("MinorOperatingSystemVersion",
632 Hdr->MinorOperatingSystemVersion);
633 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
634 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
635 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
636 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
637 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
638 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
639 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
David Majnemer774aadf2014-11-18 02:45:28 +0000640 W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000641 makeArrayRef(PEDLLCharacteristics));
642 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
643 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
644 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
645 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
646 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000647
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000648 if (Hdr->NumberOfRvaAndSize > 0) {
649 DictScope D(W, "DataDirectory");
650 static const char * const directory[] = {
651 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
652 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
653 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
654 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
655 };
656
Reid Kleckner2da433e2016-06-02 17:10:43 +0000657 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i)
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000658 printDataDirectory(i, directory[i]);
Reid Kleckner2da433e2016-06-02 17:10:43 +0000659 }
660}
661
662void COFFDumper::printCOFFDebugDirectory() {
663 ListScope LS(W, "DebugDirectory");
664 for (const debug_directory &D : Obj->debug_directories()) {
665 char FormattedTime[20] = {};
666 time_t TDS = D.TimeDateStamp;
667 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
668 DictScope S(W, "DebugEntry");
669 W.printHex("Characteristics", D.Characteristics);
670 W.printHex("TimeDateStamp", FormattedTime, D.TimeDateStamp);
671 W.printHex("MajorVersion", D.MajorVersion);
672 W.printHex("MinorVersion", D.MinorVersion);
673 W.printEnum("Type", D.Type, makeArrayRef(ImageDebugType));
674 W.printHex("SizeOfData", D.SizeOfData);
675 W.printHex("AddressOfRawData", D.AddressOfRawData);
676 W.printHex("PointerToRawData", D.PointerToRawData);
677 if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW) {
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000678 const codeview::DebugInfo *DebugInfo;
Reid Kleckner2da433e2016-06-02 17:10:43 +0000679 StringRef PDBFileName;
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000680 error(Obj->getDebugPDBInfo(&D, DebugInfo, PDBFileName));
Reid Kleckner2da433e2016-06-02 17:10:43 +0000681 DictScope PDBScope(W, "PDBInfo");
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000682 W.printHex("PDBSignature", DebugInfo->Signature.CVSignature);
683 if (DebugInfo->Signature.CVSignature == OMF::Signature::PDB70) {
684 W.printBinary("PDBGUID", makeArrayRef(DebugInfo->PDB70.Signature));
685 W.printNumber("PDBAge", DebugInfo->PDB70.Age);
686 W.printString("PDBFileName", PDBFileName);
687 }
Reid Kleckner2da433e2016-06-02 17:10:43 +0000688 } else {
689 // FIXME: Type values of 12 and 13 are commonly observed but are not in
690 // the documented type enum. Figure out what they mean.
691 ArrayRef<uint8_t> RawData;
692 error(
693 Obj->getRvaAndSizeAsBytes(D.AddressOfRawData, D.SizeOfData, RawData));
694 W.printBinaryBlock("RawData", RawData);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000695 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000696 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000697}
698
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000699void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
700 W.printHex("BaseOfData", Hdr->BaseOfData);
701}
702
703void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
704
Reid Kleckner83ebad32015-12-16 18:28:12 +0000705void COFFDumper::printCodeViewDebugInfo() {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000706 // Print types first to build CVUDTNames, then print symbols.
Reid Kleckner83ebad32015-12-16 18:28:12 +0000707 for (const SectionRef &S : Obj->sections()) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000708 StringRef SectionName;
709 error(S.getName(SectionName));
710 if (SectionName == ".debug$T")
711 printCodeViewTypeSection(SectionName, S);
712 }
713 for (const SectionRef &S : Obj->sections()) {
714 StringRef SectionName;
715 error(S.getName(SectionName));
716 if (SectionName == ".debug$S")
717 printCodeViewSymbolSection(SectionName, S);
Reid Kleckner83ebad32015-12-16 18:28:12 +0000718 }
719}
720
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000721void COFFDumper::initializeFileAndStringTables(StringRef Data) {
722 while (!Data.empty() && (CVFileChecksumTable.data() == nullptr ||
723 CVStringTable.data() == nullptr)) {
724 // The section consists of a number of subsection in the following format:
725 // |SubSectionType|SubSectionSize|Contents...|
726 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000727 error(consume(Data, SubType));
728 error(consume(Data, SubSectionSize));
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000729 if (SubSectionSize > Data.size())
730 return error(object_error::parse_failed);
731 switch (ModuleSubstreamKind(SubType)) {
732 case ModuleSubstreamKind::FileChecksums:
733 CVFileChecksumTable = Data.substr(0, SubSectionSize);
734 break;
735 case ModuleSubstreamKind::StringTable:
736 CVStringTable = Data.substr(0, SubSectionSize);
737 break;
738 default:
739 break;
740 }
David Majnemerefaaf412016-05-28 20:04:48 +0000741 uint32_t PaddedSize = alignTo(SubSectionSize, 4);
742 if (PaddedSize > Data.size())
743 error(object_error::parse_failed);
744 Data = Data.drop_front(PaddedSize);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000745 }
746}
747
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000748void COFFDumper::printCodeViewSymbolSection(StringRef SectionName,
749 const SectionRef &Section) {
750 StringRef SectionContents;
751 error(Section.getContents(SectionContents));
752 StringRef Data = SectionContents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000753
754 SmallVector<StringRef, 10> FunctionNames;
755 StringMap<StringRef> FunctionLineTables;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000756
Zachary Turner99f02152015-02-18 19:32:05 +0000757 ListScope D(W, "CodeViewDebugInfo");
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000758 // Print the section to allow correlation with printSections.
759 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000760
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000761 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000762 error(consume(Data, Magic));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000763 W.printHex("Magic", Magic);
764 if (Magic != COFF::DEBUG_SECTION_MAGIC)
765 return error(object_error::parse_failed);
766
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000767 initializeFileAndStringTables(Data);
768
Zachary Turnera96cce62016-06-03 03:25:59 +0000769 // TODO: Convert this over to using ModuleSubstreamVisitor.
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000770 while (!Data.empty()) {
771 // The section consists of a number of subsection in the following format:
772 // |SubSectionType|SubSectionSize|Contents...|
773 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000774 error(consume(Data, SubType));
775 error(consume(Data, SubSectionSize));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000776
777 ListScope S(W, "Subsection");
778 W.printEnum("SubSectionType", SubType, makeArrayRef(SubSectionTypes));
779 W.printHex("SubSectionSize", SubSectionSize);
780
781 // Get the contents of the subsection.
782 if (SubSectionSize > Data.size())
783 return error(object_error::parse_failed);
784 StringRef Contents = Data.substr(0, SubSectionSize);
785
786 // Add SubSectionSize to the current offset and align that offset to find
787 // the next subsection.
788 size_t SectionOffset = Data.data() - SectionContents.data();
789 size_t NextOffset = SectionOffset + SubSectionSize;
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000790 NextOffset = alignTo(NextOffset, 4);
David Majnemercab2b462016-05-28 20:04:50 +0000791 if (NextOffset > SectionContents.size())
792 return error(object_error::parse_failed);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000793 Data = SectionContents.drop_front(NextOffset);
794
795 // Optionally print the subsection bytes in case our parsing gets confused
796 // later.
797 if (opts::CodeViewSubsectionBytes)
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000798 printBinaryBlockWithRelocs("SubSectionContents", Section, SectionContents,
799 Contents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000800
801 switch (ModuleSubstreamKind(SubType)) {
802 case ModuleSubstreamKind::Symbols:
Reid Kleckner2893fd12016-01-14 17:51:54 +0000803 printCodeViewSymbolsSubsection(Contents, Section, SectionContents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000804 break;
Reid Klecknere9ab3492016-01-14 19:20:17 +0000805
806 case ModuleSubstreamKind::InlineeLines:
807 printCodeViewInlineeLines(Contents);
808 break;
809
Reid Klecknerc31f5302016-01-15 18:06:25 +0000810 case ModuleSubstreamKind::FileChecksums:
811 printCodeViewFileChecksums(Contents);
812 break;
813
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000814 case ModuleSubstreamKind::Lines: {
815 // Holds a PC to file:line table. Some data to parse this subsection is
816 // stored in the other subsections, so just check sanity and store the
817 // pointers for deferred processing.
818
819 if (SubSectionSize < 12) {
820 // There should be at least three words to store two function
821 // relocations and size of the code.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000822 error(object_error::parse_failed);
823 return;
824 }
825
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000826 StringRef LinkageName;
827 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset,
828 LinkageName));
829 W.printString("LinkageName", LinkageName);
830 if (FunctionLineTables.count(LinkageName) != 0) {
831 // Saw debug info for this function already?
832 error(object_error::parse_failed);
833 return;
Zachary Turner99f02152015-02-18 19:32:05 +0000834 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000835
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000836 FunctionLineTables[LinkageName] = Contents;
837 FunctionNames.push_back(LinkageName);
838 break;
839 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000840 case ModuleSubstreamKind::FrameData: {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000841 // First four bytes is a relocation against the function.
Zachary Turner4d49eb92016-10-20 18:31:19 +0000842 msf::ByteStream S(Contents);
843 msf::StreamReader SR(S);
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000844 const uint32_t *CodePtr;
Zachary Turner4d49eb92016-10-20 18:31:19 +0000845 error(SR.readObject(CodePtr));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000846 StringRef LinkageName;
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000847 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionContents,
848 CodePtr, LinkageName));
849 W.printString("LinkageName", LinkageName);
850
851 // To find the active frame description, search this array for the
852 // smallest PC range that includes the current PC.
Zachary Turner4d49eb92016-10-20 18:31:19 +0000853 while (!SR.empty()) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000854 const FrameData *FD;
Zachary Turner4d49eb92016-10-20 18:31:19 +0000855 error(SR.readObject(FD));
David Majnemera6d93fd2016-05-28 19:45:49 +0000856
857 if (FD->FrameFunc >= CVStringTable.size())
858 error(object_error::parse_failed);
859
860 StringRef FrameFunc =
861 CVStringTable.drop_front(FD->FrameFunc).split('\0').first;
862
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000863 DictScope S(W, "FrameData");
864 W.printHex("RvaStart", FD->RvaStart);
865 W.printHex("CodeSize", FD->CodeSize);
866 W.printHex("LocalSize", FD->LocalSize);
867 W.printHex("ParamsSize", FD->ParamsSize);
868 W.printHex("MaxStackSize", FD->MaxStackSize);
David Majnemera6d93fd2016-05-28 19:45:49 +0000869 W.printString("FrameFunc", FrameFunc);
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000870 W.printHex("PrologSize", FD->PrologSize);
871 W.printHex("SavedRegsSize", FD->SavedRegsSize);
872 W.printFlags("Flags", FD->Flags, makeArrayRef(FrameDataFlags));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000873 }
874 break;
875 }
876
877 // Do nothing for unrecognized subsections.
878 default:
879 break;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000880 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000881 W.flush();
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000882 }
883
884 // Dump the line tables now that we've read all the subsections and know all
885 // the required information.
886 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
887 StringRef Name = FunctionNames[I];
888 ListScope S(W, "FunctionLineTable");
Reid Kleckner7c0c0c02015-12-15 01:23:55 +0000889 W.printString("LinkageName", Name);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000890
891 DataExtractor DE(FunctionLineTables[Name], true, 4);
David Majnemer3f49e662015-07-09 00:19:51 +0000892 uint32_t Offset = 6; // Skip relocations.
893 uint16_t Flags = DE.getU16(&Offset);
894 W.printHex("Flags", Flags);
Reid Kleckner2214ed82016-01-29 00:49:42 +0000895 bool HasColumnInformation = Flags & codeview::LineFlags::HaveColumns;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000896 uint32_t FunctionSize = DE.getU32(&Offset);
897 W.printHex("CodeSize", FunctionSize);
898 while (DE.isValidOffset(Offset)) {
899 // For each range of lines with the same filename, we have a segment
900 // in the line table. The filename string is accessed using double
901 // indirection to the string table subsection using the index subsection.
902 uint32_t OffsetInIndex = DE.getU32(&Offset),
David Majnemer04948362016-01-13 01:05:16 +0000903 NumLines = DE.getU32(&Offset),
David Majnemer0373d532015-07-09 18:14:31 +0000904 FullSegmentSize = DE.getU32(&Offset);
905
David Majnemer04948362016-01-13 01:05:16 +0000906 uint32_t ColumnOffset = Offset + 8 * NumLines;
907 DataExtractor ColumnDE(DE.getData(), true, 4);
908
David Majnemer0373d532015-07-09 18:14:31 +0000909 if (FullSegmentSize !=
David Majnemer04948362016-01-13 01:05:16 +0000910 12 + 8 * NumLines + (HasColumnInformation ? 4 * NumLines : 0)) {
David Majnemer0373d532015-07-09 18:14:31 +0000911 error(object_error::parse_failed);
912 return;
913 }
Justin Bognera1413db2015-07-09 04:27:36 +0000914
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000915 ListScope S(W, "FilenameSegment");
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000916 printFileNameForOffset("Filename", OffsetInIndex);
David Majnemer04948362016-01-13 01:05:16 +0000917 for (unsigned LineIdx = 0;
918 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000919 // Then go the (PC, LineNumber) pairs. The line number is stored in the
920 // least significant 31 bits of the respective word in the table.
David Majnemer04948362016-01-13 01:05:16 +0000921 uint32_t PC = DE.getU32(&Offset), LineData = DE.getU32(&Offset);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000922 if (PC >= FunctionSize) {
923 error(object_error::parse_failed);
924 return;
925 }
926 char Buffer[32];
927 format("+0x%X", PC).snprint(Buffer, 32);
David Majnemer04948362016-01-13 01:05:16 +0000928 ListScope PCScope(W, Buffer);
David Majnemera4859df2016-02-04 17:57:12 +0000929 LineInfo LI(LineData);
930 if (LI.isAlwaysStepInto())
931 W.printString("StepInto", StringRef("Always"));
932 else if (LI.isNeverStepInto())
933 W.printString("StepInto", StringRef("Never"));
934 else
935 W.printNumber("LineNumberStart", LI.getStartLine());
936 W.printNumber("LineNumberEndDelta", LI.getLineDelta());
937 W.printBoolean("IsStatement", LI.isStatement());
David Majnemer04948362016-01-13 01:05:16 +0000938 if (HasColumnInformation &&
939 ColumnDE.isValidOffsetForDataOfSize(ColumnOffset, 4)) {
940 uint16_t ColStart = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +0000941 W.printNumber("ColStart", ColStart);
David Majnemer04948362016-01-13 01:05:16 +0000942 uint16_t ColEnd = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +0000943 W.printNumber("ColEnd", ColEnd);
944 }
945 }
David Majnemer04948362016-01-13 01:05:16 +0000946 // Skip over the column data.
947 if (HasColumnInformation) {
948 for (unsigned LineIdx = 0;
949 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
950 DE.getU32(&Offset);
951 }
952 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000953 }
954 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000955}
956
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000957void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
958 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000959 StringRef SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000960 ArrayRef<uint8_t> BinaryData(Subsection.bytes_begin(),
961 Subsection.bytes_end());
962 auto CODD = llvm::make_unique<COFFObjectDumpDelegate>(*this, Section, Obj,
963 SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000964
Zachary Turneraaad5742016-05-23 23:41:13 +0000965 CVSymbolDumper CVSD(W, CVTD, std::move(CODD), opts::CodeViewSubsectionBytes);
Zachary Turnerd66889c2016-07-28 19:12:28 +0000966 ByteStream Stream(BinaryData);
Zachary Turner0d43c1c2016-05-28 05:21:57 +0000967 CVSymbolArray Symbols;
968 StreamReader Reader(Stream);
969 if (auto EC = Reader.readArray(Symbols, Reader.getLength())) {
970 consumeError(std::move(EC));
971 W.flush();
972 error(object_error::parse_failed);
973 }
Reid Kleckner2893fd12016-01-14 17:51:54 +0000974
Zachary Turner0d840742016-10-07 21:34:46 +0000975 if (auto EC = CVSD.dump(Symbols)) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000976 W.flush();
Zachary Turner0d840742016-10-07 21:34:46 +0000977 error(std::move(EC));
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000978 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000979 W.flush();
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000980}
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000981
Reid Klecknerc31f5302016-01-15 18:06:25 +0000982void COFFDumper::printCodeViewFileChecksums(StringRef Subsection) {
Zachary Turner4d49eb92016-10-20 18:31:19 +0000983 msf::ByteStream S(Subsection);
984 msf::StreamReader SR(S);
985 while (!SR.empty()) {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000986 DictScope S(W, "FileChecksum");
987 const FileChecksum *FC;
Zachary Turner4d49eb92016-10-20 18:31:19 +0000988 error(SR.readObject(FC));
Reid Klecknerc31f5302016-01-15 18:06:25 +0000989 if (FC->FileNameOffset >= CVStringTable.size())
990 error(object_error::parse_failed);
991 StringRef Filename =
992 CVStringTable.drop_front(FC->FileNameOffset).split('\0').first;
993 W.printHex("Filename", Filename, FC->FileNameOffset);
994 W.printHex("ChecksumSize", FC->ChecksumSize);
995 W.printEnum("ChecksumKind", uint8_t(FC->ChecksumKind),
996 makeArrayRef(FileChecksumKindNames));
Zachary Turner4d49eb92016-10-20 18:31:19 +0000997 if (FC->ChecksumSize >= SR.bytesRemaining())
Reid Klecknerc31f5302016-01-15 18:06:25 +0000998 error(object_error::parse_failed);
Zachary Turner4d49eb92016-10-20 18:31:19 +0000999 ArrayRef<uint8_t> ChecksumBytes;
1000 error(SR.readBytes(ChecksumBytes, FC->ChecksumSize));
Reid Klecknerc31f5302016-01-15 18:06:25 +00001001 W.printBinary("ChecksumBytes", ChecksumBytes);
Rafael Espindolaa79078c2016-01-18 20:55:24 +00001002 unsigned PaddedSize = alignTo(FC->ChecksumSize + sizeof(FileChecksum), 4) -
1003 sizeof(FileChecksum);
Zachary Turner4d49eb92016-10-20 18:31:19 +00001004 PaddedSize -= ChecksumBytes.size();
1005 if (PaddedSize > SR.bytesRemaining())
David Majnemer37dafba2016-05-28 19:45:58 +00001006 error(object_error::parse_failed);
Zachary Turner4d49eb92016-10-20 18:31:19 +00001007 error(SR.skip(PaddedSize));
Reid Klecknerc31f5302016-01-15 18:06:25 +00001008 }
1009}
1010
Reid Klecknere9ab3492016-01-14 19:20:17 +00001011void COFFDumper::printCodeViewInlineeLines(StringRef Subsection) {
Zachary Turner4d49eb92016-10-20 18:31:19 +00001012 msf::ByteStream S(Subsection);
1013 msf::StreamReader SR(S);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001014 uint32_t Signature;
Zachary Turner4d49eb92016-10-20 18:31:19 +00001015 error(SR.readInteger(Signature));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001016 bool HasExtraFiles = Signature == unsigned(InlineeLinesSignature::ExtraFiles);
1017
Zachary Turner4d49eb92016-10-20 18:31:19 +00001018 while (!SR.empty()) {
Reid Klecknere9ab3492016-01-14 19:20:17 +00001019 const InlineeSourceLine *ISL;
Zachary Turner4d49eb92016-10-20 18:31:19 +00001020 error(SR.readObject(ISL));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001021 DictScope S(W, "InlineeSourceLine");
1022 printTypeIndex("Inlinee", ISL->Inlinee);
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001023 printFileNameForOffset("FileID", ISL->FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001024 W.printNumber("SourceLineNum", ISL->SourceLineNum);
1025
1026 if (HasExtraFiles) {
1027 uint32_t ExtraFileCount;
Zachary Turner4d49eb92016-10-20 18:31:19 +00001028 error(SR.readInteger(ExtraFileCount));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001029 W.printNumber("ExtraFileCount", ExtraFileCount);
1030 ListScope ExtraFiles(W, "ExtraFiles");
1031 for (unsigned I = 0; I < ExtraFileCount; ++I) {
1032 uint32_t FileID;
Zachary Turner4d49eb92016-10-20 18:31:19 +00001033 error(SR.readInteger(FileID));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001034 printFileNameForOffset("FileID", FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001035 }
1036 }
1037 }
1038}
1039
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001040StringRef COFFDumper::getFileNameForFileOffset(uint32_t FileOffset) {
1041 // The file checksum subsection should precede all references to it.
1042 if (!CVFileChecksumTable.data() || !CVStringTable.data())
1043 error(object_error::parse_failed);
1044 // Check if the file checksum table offset is valid.
1045 if (FileOffset >= CVFileChecksumTable.size())
1046 error(object_error::parse_failed);
1047
1048 // The string table offset comes first before the file checksum.
1049 StringRef Data = CVFileChecksumTable.drop_front(FileOffset);
1050 uint32_t StringOffset;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001051 error(consume(Data, StringOffset));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001052
1053 // Check if the string table offset is valid.
1054 if (StringOffset >= CVStringTable.size())
1055 error(object_error::parse_failed);
1056
1057 // Return the null-terminated string.
1058 return CVStringTable.drop_front(StringOffset).split('\0').first;
1059}
1060
1061void COFFDumper::printFileNameForOffset(StringRef Label, uint32_t FileOffset) {
1062 W.printHex(Label, getFileNameForFileOffset(FileOffset), FileOffset);
1063}
1064
Zachary Turner4efa0a42016-11-08 22:24:53 +00001065void COFFDumper::mergeCodeViewTypes(TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001066 for (const SectionRef &S : Obj->sections()) {
1067 StringRef SectionName;
1068 error(S.getName(SectionName));
1069 if (SectionName == ".debug$T") {
1070 StringRef Data;
1071 error(S.getContents(Data));
David Majnemer78b0d722016-05-28 19:17:48 +00001072 uint32_t Magic;
1073 error(consume(Data, Magic));
Reid Kleckner0b269742016-05-14 00:02:53 +00001074 if (Magic != 4)
1075 error(object_error::parse_failed);
Reid Kleckner0b269742016-05-14 00:02:53 +00001076 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(Data.data()),
1077 Data.size());
Zachary Turnerd66889c2016-07-28 19:12:28 +00001078 ByteStream Stream(Bytes);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001079 CVTypeArray Types;
1080 StreamReader Reader(Stream);
1081 if (auto EC = Reader.readArray(Types, Reader.getLength())) {
1082 consumeError(std::move(EC));
1083 W.flush();
1084 error(object_error::parse_failed);
1085 }
1086
1087 if (!mergeTypeStreams(CVTypes, Types))
Reid Kleckner0b269742016-05-14 00:02:53 +00001088 return error(object_error::parse_failed);
1089 }
1090 }
1091}
1092
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001093void COFFDumper::printCodeViewTypeSection(StringRef SectionName,
1094 const SectionRef &Section) {
1095 ListScope D(W, "CodeViewTypes");
1096 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Adrian McCarthy963a3312016-05-02 23:45:03 +00001097
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001098 StringRef Data;
1099 error(Section.getContents(Data));
Reid Klecknerb2bd2812016-05-02 18:10:00 +00001100 if (opts::CodeViewSubsectionBytes)
1101 W.printBinaryBlock("Data", Data);
Reid Kleckner7960de92016-05-04 19:39:28 +00001102
1103 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001104 error(consume(Data, Magic));
Reid Kleckner7960de92016-05-04 19:39:28 +00001105 W.printHex("Magic", Magic);
1106 if (Magic != COFF::DEBUG_SECTION_MAGIC)
1107 return error(object_error::parse_failed);
1108
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001109 if (auto EC = CVTD.dump({Data.bytes_begin(), Data.bytes_end()})) {
Reid Kleckner4a14bca2016-05-05 00:34:33 +00001110 W.flush();
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001111 error(llvm::errorToErrorCode(std::move(EC)));
Reid Kleckner7960de92016-05-04 19:39:28 +00001112 }
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001113}
1114
Eric Christopher9cad53c2013-04-03 18:31:38 +00001115void COFFDumper::printSections() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001116 ListScope SectionsD(W, "Sections");
1117 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001118 for (const SectionRef &Sec : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001119 ++SectionNumber;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001120 const coff_section *Section = Obj->getCOFFSection(Sec);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001121
1122 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001123 error(Sec.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001124
1125 DictScope D(W, "Section");
1126 W.printNumber("Number", SectionNumber);
1127 W.printBinary("Name", Name, Section->Name);
1128 W.printHex ("VirtualSize", Section->VirtualSize);
1129 W.printHex ("VirtualAddress", Section->VirtualAddress);
1130 W.printNumber("RawDataSize", Section->SizeOfRawData);
1131 W.printHex ("PointerToRawData", Section->PointerToRawData);
1132 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
1133 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
1134 W.printNumber("RelocationCount", Section->NumberOfRelocations);
1135 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
1136 W.printFlags ("Characteristics", Section->Characteristics,
1137 makeArrayRef(ImageSectionCharacteristics),
1138 COFF::SectionCharacteristics(0x00F00000));
1139
1140 if (opts::SectionRelocations) {
1141 ListScope D(W, "Relocations");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001142 for (const RelocationRef &Reloc : Sec.relocations())
1143 printRelocation(Sec, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001144 }
1145
1146 if (opts::SectionSymbols) {
1147 ListScope D(W, "Symbols");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001148 for (const SymbolRef &Symbol : Obj->symbols()) {
Rafael Espindola80291272014-10-08 15:28:58 +00001149 if (!Sec.containsSymbol(Symbol))
Eric Christopher9cad53c2013-04-03 18:31:38 +00001150 continue;
1151
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001152 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001153 }
1154 }
1155
David Majnemerdac39852014-09-26 22:32:16 +00001156 if (opts::SectionData &&
1157 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001158 StringRef Data;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001159 error(Sec.getContents(Data));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001160
1161 W.printBinaryBlock("SectionData", Data);
1162 }
1163 }
1164}
1165
1166void COFFDumper::printRelocations() {
1167 ListScope D(W, "Relocations");
1168
Eric Christopher9cad53c2013-04-03 18:31:38 +00001169 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001170 for (const SectionRef &Section : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001171 ++SectionNumber;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001172 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001173 error(Section.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001174
1175 bool PrintedGroup = false;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001176 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001177 if (!PrintedGroup) {
1178 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
1179 W.indent();
1180 PrintedGroup = true;
1181 }
1182
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001183 printRelocation(Section, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001184 }
1185
1186 if (PrintedGroup) {
1187 W.unindent();
1188 W.startLine() << "}\n";
1189 }
1190 }
1191}
1192
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001193void COFFDumper::printRelocation(const SectionRef &Section,
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00001194 const RelocationRef &Reloc, uint64_t Bias) {
1195 uint64_t Offset = Reloc.getOffset() - Bias;
Rafael Espindola99c041b2015-06-30 01:53:01 +00001196 uint64_t RelocType = Reloc.getType();
Eric Christopher9cad53c2013-04-03 18:31:38 +00001197 SmallString<32> RelocName;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001198 StringRef SymbolName;
Rafael Espindola41bb4322015-06-30 04:08:37 +00001199 Reloc.getTypeName(RelocName);
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001200 symbol_iterator Symbol = Reloc.getSymbol();
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001201 if (Symbol != Obj->symbol_end()) {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001202 Expected<StringRef> SymbolNameOrErr = Symbol->getName();
1203 error(errorToErrorCode(SymbolNameOrErr.takeError()));
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001204 SymbolName = *SymbolNameOrErr;
1205 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001206
Nico Rieckf3f0b792013-04-12 04:01:52 +00001207 if (opts::ExpandRelocs) {
1208 DictScope Group(W, "Relocation");
1209 W.printHex("Offset", Offset);
1210 W.printNumber("Type", RelocName, RelocType);
David Majnemer1f80b0a2014-11-13 07:42:11 +00001211 W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName);
Nico Rieckf3f0b792013-04-12 04:01:52 +00001212 } else {
1213 raw_ostream& OS = W.startLine();
1214 OS << W.hex(Offset)
1215 << " " << RelocName
David Majnemer1f80b0a2014-11-13 07:42:11 +00001216 << " " << (SymbolName.empty() ? "-" : SymbolName)
Nico Rieckf3f0b792013-04-12 04:01:52 +00001217 << "\n";
1218 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001219}
1220
1221void COFFDumper::printSymbols() {
1222 ListScope Group(W, "Symbols");
1223
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001224 for (const SymbolRef &Symbol : Obj->symbols())
1225 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001226}
1227
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001228void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001229
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001230static ErrorOr<StringRef>
David Majnemer236b0ca2014-11-17 11:17:17 +00001231getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber,
1232 const coff_section *Section) {
David Majnemerf4dc4562014-09-20 00:25:06 +00001233 if (Section) {
1234 StringRef SectionName;
David Majnemer236b0ca2014-11-17 11:17:17 +00001235 if (std::error_code EC = Obj->getSectionName(Section, SectionName))
1236 return EC;
David Majnemerf4dc4562014-09-20 00:25:06 +00001237 return SectionName;
1238 }
David Majnemerf4dc4562014-09-20 00:25:06 +00001239 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
David Majnemer236b0ca2014-11-17 11:17:17 +00001240 return StringRef("IMAGE_SYM_DEBUG");
David Majnemerf4dc4562014-09-20 00:25:06 +00001241 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
David Majnemer236b0ca2014-11-17 11:17:17 +00001242 return StringRef("IMAGE_SYM_ABSOLUTE");
David Majnemerf4dc4562014-09-20 00:25:06 +00001243 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
David Majnemer236b0ca2014-11-17 11:17:17 +00001244 return StringRef("IMAGE_SYM_UNDEFINED");
1245 return StringRef("");
David Majnemerf4dc4562014-09-20 00:25:06 +00001246}
1247
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001248void COFFDumper::printSymbol(const SymbolRef &Sym) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001249 DictScope D(W, "Symbol");
1250
David Majnemer44f51e52014-09-10 12:51:52 +00001251 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001252 const coff_section *Section;
David Majnemer44f51e52014-09-10 12:51:52 +00001253 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001254 W.startLine() << "Invalid section number: " << EC.message() << "\n";
1255 W.flush();
1256 return;
1257 }
1258
1259 StringRef SymbolName;
1260 if (Obj->getSymbolName(Symbol, SymbolName))
1261 SymbolName = "";
1262
David Majnemer236b0ca2014-11-17 11:17:17 +00001263 StringRef SectionName = "";
1264 ErrorOr<StringRef> Res =
1265 getSectionName(Obj, Symbol.getSectionNumber(), Section);
1266 if (Res)
1267 SectionName = *Res;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001268
1269 W.printString("Name", SymbolName);
David Majnemer44f51e52014-09-10 12:51:52 +00001270 W.printNumber("Value", Symbol.getValue());
1271 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
1272 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
1273 W.printEnum ("ComplexType", Symbol.getComplexType(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001274 makeArrayRef(ImageSymDType));
David Majnemer44f51e52014-09-10 12:51:52 +00001275 W.printEnum ("StorageClass", Symbol.getStorageClass(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001276 makeArrayRef(ImageSymClass));
David Majnemer44f51e52014-09-10 12:51:52 +00001277 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
Eric Christopher9cad53c2013-04-03 18:31:38 +00001278
David Majnemer44f51e52014-09-10 12:51:52 +00001279 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
1280 if (Symbol.isFunctionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001281 const coff_aux_function_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001282 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001283
1284 DictScope AS(W, "AuxFunctionDef");
1285 W.printNumber("TagIndex", Aux->TagIndex);
1286 W.printNumber("TotalSize", Aux->TotalSize);
David Majnemerf3a2af52014-03-19 04:33:27 +00001287 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001288 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001289
David Majnemerc7d7c6f2014-10-31 05:07:00 +00001290 } else if (Symbol.isAnyUndefined()) {
David Majnemerf3a2af52014-03-19 04:33:27 +00001291 const coff_aux_weak_external *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001292 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001293
David Majnemer44f51e52014-09-10 12:51:52 +00001294 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001295 StringRef LinkedName;
David Majnemer44f51e52014-09-10 12:51:52 +00001296 std::error_code EC = Linked.getError();
1297 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001298 LinkedName = "";
1299 error(EC);
1300 }
1301
1302 DictScope AS(W, "AuxWeakExternal");
1303 W.printNumber("Linked", LinkedName, Aux->TagIndex);
1304 W.printEnum ("Search", Aux->Characteristics,
1305 makeArrayRef(WeakExternalCharacteristics));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001306
David Majnemer44f51e52014-09-10 12:51:52 +00001307 } else if (Symbol.isFileRecord()) {
1308 const char *FileName;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001309 error(getSymbolAuxData(Obj, Symbol, I, FileName));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001310
Nico Rieck0ab8e602013-04-22 08:35:11 +00001311 DictScope AS(W, "AuxFileRecord");
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001312
David Majnemer44f51e52014-09-10 12:51:52 +00001313 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
1314 Obj->getSymbolTableEntrySize());
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001315 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
Saleem Abdulrasool3b5e0012014-04-16 04:15:29 +00001316 break;
David Majnemer44f51e52014-09-10 12:51:52 +00001317 } else if (Symbol.isSectionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001318 const coff_aux_section_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001319 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001320
David Majnemer4d571592014-09-15 19:42:42 +00001321 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
1322
Eric Christopher9cad53c2013-04-03 18:31:38 +00001323 DictScope AS(W, "AuxSectionDef");
1324 W.printNumber("Length", Aux->Length);
1325 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
1326 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
1327 W.printHex("Checksum", Aux->CheckSum);
David Majnemer4d571592014-09-15 19:42:42 +00001328 W.printNumber("Number", AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001329 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001330
Nico Riecka711dee2013-04-22 08:34:59 +00001331 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
Eric Christopher9cad53c2013-04-03 18:31:38 +00001332 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
1333 const coff_section *Assoc;
David Majnemer236b0ca2014-11-17 11:17:17 +00001334 StringRef AssocName = "";
1335 std::error_code EC = Obj->getSection(AuxNumber, Assoc);
1336 ErrorOr<StringRef> Res = getSectionName(Obj, AuxNumber, Assoc);
1337 if (Res)
1338 AssocName = *Res;
1339 if (!EC)
1340 EC = Res.getError();
1341 if (EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001342 AssocName = "";
1343 error(EC);
1344 }
1345
David Majnemer4d571592014-09-15 19:42:42 +00001346 W.printNumber("AssocSection", AssocName, AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001347 }
David Majnemer44f51e52014-09-10 12:51:52 +00001348 } else if (Symbol.isCLRToken()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001349 const coff_aux_clr_token *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001350 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001351
David Majnemer44f51e52014-09-10 12:51:52 +00001352 ErrorOr<COFFSymbolRef> ReferredSym =
1353 Obj->getSymbol(Aux->SymbolTableIndex);
Nico Rieck8678acd2014-03-17 01:46:52 +00001354 StringRef ReferredName;
David Majnemer44f51e52014-09-10 12:51:52 +00001355 std::error_code EC = ReferredSym.getError();
1356 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
Nico Rieck8678acd2014-03-17 01:46:52 +00001357 ReferredName = "";
1358 error(EC);
1359 }
1360
Eric Christopher9cad53c2013-04-03 18:31:38 +00001361 DictScope AS(W, "AuxCLRToken");
1362 W.printNumber("AuxType", Aux->AuxType);
1363 W.printNumber("Reserved", Aux->Reserved);
Nico Rieck8678acd2014-03-17 01:46:52 +00001364 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001365
1366 } else {
1367 W.startLine() << "<unhandled auxiliary record>\n";
1368 }
1369 }
1370}
1371
1372void COFFDumper::printUnwindInfo() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001373 ListScope D(W, "UnwindInformation");
David Majnemer44f51e52014-09-10 12:51:52 +00001374 switch (Obj->getMachine()) {
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001375 case COFF::IMAGE_FILE_MACHINE_AMD64: {
1376 Win64EH::Dumper Dumper(W);
Rafael Espindola4453e42942014-06-13 03:07:50 +00001377 Win64EH::Dumper::SymbolResolver
1378 Resolver = [](const object::coff_section *Section, uint64_t Offset,
1379 SymbolRef &Symbol, void *user_data) -> std::error_code {
1380 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
1381 return Dumper->resolveSymbol(Section, Offset, Symbol);
1382 };
Saleem Abdulrasool65dbbb52014-05-25 21:37:59 +00001383 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001384 Dumper.printData(Ctx);
1385 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001386 }
Saleem Abdulrasoole6971ca2014-06-04 15:47:15 +00001387 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
1388 ARM::WinEH::Decoder Decoder(W);
1389 Decoder.dumpProcedureData(*Obj);
1390 break;
1391 }
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001392 default:
David Majnemer44f51e52014-09-10 12:51:52 +00001393 W.printEnum("unsupported Image Machine", Obj->getMachine(),
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001394 makeArrayRef(ImageFileMachineType));
1395 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001396 }
1397}
1398
Rui Ueyama979fb402014-10-09 02:16:38 +00001399void COFFDumper::printImportedSymbols(
1400 iterator_range<imported_symbol_iterator> Range) {
1401 for (const ImportedSymbolRef &I : Range) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001402 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001403 error(I.getSymbolName(Sym));
Rui Ueyama15d99352014-10-03 00:41:58 +00001404 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001405 error(I.getOrdinal(Ordinal));
Rui Ueyama15d99352014-10-03 00:41:58 +00001406 W.printNumber("Symbol", Sym, Ordinal);
1407 }
1408}
1409
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001410void COFFDumper::printDelayImportedSymbols(
1411 const DelayImportDirectoryEntryRef &I,
1412 iterator_range<imported_symbol_iterator> Range) {
1413 int Index = 0;
1414 for (const ImportedSymbolRef &S : Range) {
1415 DictScope Import(W, "Import");
1416 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001417 error(S.getSymbolName(Sym));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001418 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001419 error(S.getOrdinal(Ordinal));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001420 W.printNumber("Symbol", Sym, Ordinal);
1421 uint64_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001422 error(I.getImportAddress(Index++, Addr));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001423 W.printHex("Address", Addr);
1424 }
1425}
1426
Rui Ueyama1e152d52014-10-02 17:02:18 +00001427void COFFDumper::printCOFFImports() {
Rui Ueyama15d99352014-10-03 00:41:58 +00001428 // Regular imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001429 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
Rui Ueyama1e152d52014-10-02 17:02:18 +00001430 DictScope Import(W, "Import");
1431 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001432 error(I.getName(Name));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001433 W.printString("Name", Name);
1434 uint32_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001435 error(I.getImportLookupTableRVA(Addr));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001436 W.printHex("ImportLookupTableRVA", Addr);
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001437 error(I.getImportAddressTableRVA(Addr));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001438 W.printHex("ImportAddressTableRVA", Addr);
Rui Ueyama979fb402014-10-09 02:16:38 +00001439 printImportedSymbols(I.imported_symbols());
Rui Ueyama15d99352014-10-03 00:41:58 +00001440 }
1441
1442 // Delay imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001443 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001444 DictScope Import(W, "DelayImport");
1445 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001446 error(I.getName(Name));
Rui Ueyama15d99352014-10-03 00:41:58 +00001447 W.printString("Name", Name);
Rui Ueyama1af08652014-10-03 18:07:18 +00001448 const delay_import_directory_table_entry *Table;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001449 error(I.getDelayImportTable(Table));
Rui Ueyama1af08652014-10-03 18:07:18 +00001450 W.printHex("Attributes", Table->Attributes);
1451 W.printHex("ModuleHandle", Table->ModuleHandle);
1452 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
1453 W.printHex("ImportNameTable", Table->DelayImportNameTable);
1454 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
1455 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001456 printDelayImportedSymbols(I, I.imported_symbols());
Rui Ueyama1e152d52014-10-02 17:02:18 +00001457 }
1458}
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001459
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001460void COFFDumper::printCOFFExports() {
1461 for (const ExportDirectoryEntryRef &E : Obj->export_directories()) {
1462 DictScope Export(W, "Export");
1463
1464 StringRef Name;
1465 uint32_t Ordinal, RVA;
1466
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001467 error(E.getSymbolName(Name));
1468 error(E.getOrdinal(Ordinal));
1469 error(E.getExportRVA(RVA));
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001470
1471 W.printNumber("Ordinal", Ordinal);
1472 W.printString("Name", Name);
1473 W.printHex("RVA", RVA);
1474 }
1475}
1476
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001477void COFFDumper::printCOFFDirectives() {
1478 for (const SectionRef &Section : Obj->sections()) {
1479 StringRef Contents;
1480 StringRef Name;
1481
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001482 error(Section.getName(Name));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001483 if (Name != ".drectve")
1484 continue;
1485
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001486 error(Section.getContents(Contents));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001487
1488 W.printString("Directive(s)", Contents);
1489 }
1490}
Rui Ueyama74e85132014-11-19 00:18:07 +00001491
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001492static StringRef getBaseRelocTypeName(uint8_t Type) {
Rui Ueyama74e85132014-11-19 00:18:07 +00001493 switch (Type) {
1494 case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";
1495 case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";
1496 case COFF::IMAGE_REL_BASED_LOW: return "LOW";
1497 case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";
1498 case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";
Saleem Abdulrasool5a41c372015-01-16 20:16:09 +00001499 case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)";
Rui Ueyama74e85132014-11-19 00:18:07 +00001500 case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";
Colin LeMahieu9fbffee2014-11-19 17:10:39 +00001501 default: return "unknown (" + llvm::utostr(Type) + ")";
Rui Ueyama74e85132014-11-19 00:18:07 +00001502 }
1503}
1504
1505void COFFDumper::printCOFFBaseReloc() {
1506 ListScope D(W, "BaseReloc");
1507 for (const BaseRelocRef &I : Obj->base_relocs()) {
1508 uint8_t Type;
1509 uint32_t RVA;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001510 error(I.getRVA(RVA));
1511 error(I.getType(Type));
Rui Ueyama74e85132014-11-19 00:18:07 +00001512 DictScope Import(W, "Entry");
1513 W.printString("Type", getBaseRelocTypeName(Type));
1514 W.printHex("Address", RVA);
1515 }
1516}
Lang Hames0000afd2015-06-26 23:56:53 +00001517
1518void 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,
1548 llvm::codeview::TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001549 // Flatten it first, then run our dumper on it.
1550 ListScope S(Writer, "MergedTypeStream");
1551 SmallString<0> Buf;
Zachary Turner4efa0a42016-11-08 22:24:53 +00001552 CVTypes.ForEachRecord([&](TypeIndex TI, ArrayRef<uint8_t> Record) {
Reid Klecknerfbdbe9e2016-05-31 18:45:36 +00001553 Buf.append(Record.begin(), Record.end());
Reid Kleckner0b269742016-05-14 00:02:53 +00001554 });
Reid Klecknerfbdbe9e2016-05-31 18:45:36 +00001555 CVTypeDumper CVTD(&Writer, opts::CodeViewSubsectionBytes);
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001556 if (auto EC = CVTD.dump({Buf.str().bytes_begin(), Buf.str().bytes_end()})) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001557 Writer.flush();
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001558 error(llvm::errorToErrorCode(std::move(EC)));
Reid Kleckner0b269742016-05-14 00:02:53 +00001559 }
1560}