blob: 9836c137ed2ca862240315c738538e869a6501cf [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;
Reid Kleckner5d577522017-03-24 17:26:38 +000082 void mergeCodeViewTypes(llvm::codeview::TypeTableBuilder &CVIDs,
83 llvm::codeview::TypeTableBuilder &CVTypes) override;
Lang Hames0000afd2015-06-26 23:56:53 +000084 void printStackMap() const override;
Eric Christopher9cad53c2013-04-03 18:31:38 +000085private:
Alexey Samsonov27dc8392014-03-18 06:53:02 +000086 void printSymbol(const SymbolRef &Sym);
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +000087 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc,
88 uint64_t Bias = 0);
Rui Ueyamaed64342b2013-07-19 23:23:29 +000089 void printDataDirectory(uint32_t Index, const std::string &FieldName);
Eric Christopher9cad53c2013-04-03 18:31:38 +000090
David Majnemer50267222014-11-05 06:24:35 +000091 void printDOSHeader(const dos_header *DH);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +000092 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
93 void printBaseOfDataField(const pe32_header *Hdr);
94 void printBaseOfDataField(const pe32plus_header *Hdr);
95
Reid Kleckner72e2ba72016-01-13 19:32:35 +000096 void printCodeViewSymbolSection(StringRef SectionName, const SectionRef &Section);
97 void printCodeViewTypeSection(StringRef SectionName, const SectionRef &Section);
Reid Kleckner72e2ba72016-01-13 19:32:35 +000098 StringRef getTypeName(TypeIndex Ty);
Reid Kleckner8e7275c2016-01-15 00:11:21 +000099 StringRef getFileNameForFileOffset(uint32_t FileOffset);
100 void printFileNameForOffset(StringRef Label, uint32_t FileOffset);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000101 void printTypeIndex(StringRef FieldName, TypeIndex TI) {
102 // Forward to CVTypeDumper for simplicity.
Zachary Turner629cb7d2017-01-11 23:24:22 +0000103 CVTypeDumper::printTypeIndex(Writer, FieldName, TI, TypeDB);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000104 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000105
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000106 void printCodeViewSymbolsSubsection(StringRef Subsection,
107 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000108 StringRef SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000109
Reid Klecknerc31f5302016-01-15 18:06:25 +0000110 void printCodeViewFileChecksums(StringRef Subsection);
111
Reid Klecknere9ab3492016-01-14 19:20:17 +0000112 void printCodeViewInlineeLines(StringRef Subsection);
113
Reid Kleckner2893fd12016-01-14 17:51:54 +0000114 void printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000115 uint32_t RelocOffset, uint32_t Offset,
116 StringRef *RelocSym = nullptr);
117
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000118 void printBinaryBlockWithRelocs(StringRef Label, const SectionRef &Sec,
119 StringRef SectionContents, StringRef Block);
120
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000121 /// Given a .debug$S section, find the string table and file checksum table.
122 void initializeFileAndStringTables(StringRef Data);
123
Eric Christopher9cad53c2013-04-03 18:31:38 +0000124 void cacheRelocations();
125
Rafael Espindola4453e42942014-06-13 03:07:50 +0000126 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
127 SymbolRef &Sym);
128 std::error_code resolveSymbolName(const coff_section *Section,
129 uint64_t Offset, StringRef &Name);
Reid Kleckner2893fd12016-01-14 17:51:54 +0000130 std::error_code resolveSymbolName(const coff_section *Section,
131 StringRef SectionContents,
132 const void *RelocPtr, StringRef &Name);
Rui Ueyama979fb402014-10-09 02:16:38 +0000133 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +0000134 void printDelayImportedSymbols(
135 const DelayImportDirectoryEntryRef &I,
136 iterator_range<imported_symbol_iterator> Range);
Rui Ueyama15d99352014-10-03 00:41:58 +0000137
Eric Christopher9cad53c2013-04-03 18:31:38 +0000138 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
139
140 const llvm::object::COFFObjectFile *Obj;
Rafael Espindola76d650e2015-07-06 14:26:07 +0000141 bool RelocCached = false;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000142 RelocMapTy RelocMap;
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000143 StringRef CVFileChecksumTable;
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000144 StringRef CVStringTable;
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000145
Zachary Turner629cb7d2017-01-11 23:24:22 +0000146 ScopedPrinter &Writer;
147 TypeDatabase TypeDB;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000148};
149
Zachary Turneraaad5742016-05-23 23:41:13 +0000150class COFFObjectDumpDelegate : public SymbolDumpDelegate {
151public:
152 COFFObjectDumpDelegate(COFFDumper &CD, const SectionRef &SR,
153 const COFFObjectFile *Obj, StringRef SectionContents)
Zachary Turner537014c2016-05-24 03:32:34 +0000154 : CD(CD), SR(SR), SectionContents(SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000155 Sec = Obj->getCOFFSection(SR);
156 }
157
Zachary Turner120faca2017-02-27 22:11:43 +0000158 uint32_t getRecordOffset(BinaryStreamReader Reader) override {
Zachary Turner4d49eb92016-10-20 18:31:19 +0000159 ArrayRef<uint8_t> Data;
160 if (auto EC = Reader.readLongestContiguousChunk(Data)) {
161 llvm::consumeError(std::move(EC));
162 return 0;
163 }
164 return Data.data() - SectionContents.bytes_begin();
Zachary Turneraaad5742016-05-23 23:41:13 +0000165 }
166
167 void printRelocatedField(StringRef Label, uint32_t RelocOffset,
168 uint32_t Offset, StringRef *RelocSym) override {
169 CD.printRelocatedField(Label, Sec, RelocOffset, Offset, RelocSym);
170 }
171
172 void printBinaryBlockWithRelocs(StringRef Label,
173 ArrayRef<uint8_t> Block) override {
174 StringRef SBlock(reinterpret_cast<const char *>(Block.data()),
175 Block.size());
176 if (opts::CodeViewSubsectionBytes)
177 CD.printBinaryBlockWithRelocs(Label, SR, SectionContents, SBlock);
178 }
179
180 StringRef getFileNameForFileOffset(uint32_t FileOffset) override {
181 return CD.getFileNameForFileOffset(FileOffset);
182 }
183
184 StringRef getStringTable() override { return CD.CVStringTable; }
185
186private:
187 COFFDumper &CD;
188 const SectionRef &SR;
Zachary Turneraaad5742016-05-23 23:41:13 +0000189 const coff_section *Sec;
190 StringRef SectionContents;
191};
192
Reid Kleckner4a14bca2016-05-05 00:34:33 +0000193} // end namespace
Eric Christopher9cad53c2013-04-03 18:31:38 +0000194
195namespace llvm {
196
Rafael Espindola4453e42942014-06-13 03:07:50 +0000197std::error_code createCOFFDumper(const object::ObjectFile *Obj,
Zachary Turner88bb1632016-05-03 00:28:04 +0000198 ScopedPrinter &Writer,
Rafael Espindola4453e42942014-06-13 03:07:50 +0000199 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000200 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
201 if (!COFFObj)
202 return readobj_error::unsupported_obj_file_format;
203
204 Result.reset(new COFFDumper(COFFObj, Writer));
205 return readobj_error::success;
206}
207
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000208} // namespace llvm
Eric Christopher9cad53c2013-04-03 18:31:38 +0000209
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000210// Given a a section and an offset into this section the function returns the
211// symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000212std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
213 uint64_t Offset, SymbolRef &Sym) {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000214 cacheRelocations();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000215 const auto &Relocations = RelocMap[Section];
David Majnemer61f17982016-05-29 06:18:08 +0000216 auto SymI = Obj->symbol_end();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000217 for (const auto &Relocation : Relocations) {
Rafael Espindola96d071c2015-06-29 23:29:12 +0000218 uint64_t RelocationOffset = Relocation.getOffset();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000219
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000220 if (RelocationOffset == Offset) {
David Majnemer61f17982016-05-29 06:18:08 +0000221 SymI = Relocation.getSymbol();
222 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000223 }
224 }
David Majnemer61f17982016-05-29 06:18:08 +0000225 if (SymI == Obj->symbol_end())
226 return readobj_error::unknown_symbol;
227 Sym = *SymI;
228 return readobj_error::success;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000229}
230
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000231// Given a section and an offset into this section the function returns the name
232// of the symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000233std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
234 uint64_t Offset,
235 StringRef &Name) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000236 SymbolRef Symbol;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000237 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000238 return EC;
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000239 Expected<StringRef> NameOrErr = Symbol.getName();
240 if (!NameOrErr)
241 return errorToErrorCode(NameOrErr.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000242 Name = *NameOrErr;
Rui Ueyama7d099192015-06-09 15:20:42 +0000243 return std::error_code();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000244}
245
Reid Kleckner2893fd12016-01-14 17:51:54 +0000246// Helper for when you have a pointer to real data and you want to know about
247// relocations against it.
248std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
249 StringRef SectionContents,
250 const void *RelocPtr,
251 StringRef &Name) {
252 assert(SectionContents.data() < RelocPtr &&
253 RelocPtr < SectionContents.data() + SectionContents.size() &&
254 "pointer to relocated object is not in section");
255 uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) -
256 SectionContents.data());
257 return resolveSymbolName(Section, Offset, Name);
258}
259
260void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000261 uint32_t RelocOffset, uint32_t Offset,
262 StringRef *RelocSym) {
263 StringRef SymStorage;
264 StringRef &Symbol = RelocSym ? *RelocSym : SymStorage;
265 if (!resolveSymbolName(Sec, RelocOffset, Symbol))
266 W.printSymbolOffset(Label, Symbol, Offset);
267 else
268 W.printHex(Label, RelocOffset);
269}
270
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000271void COFFDumper::printBinaryBlockWithRelocs(StringRef Label,
272 const SectionRef &Sec,
273 StringRef SectionContents,
274 StringRef Block) {
275 W.printBinaryBlock(Label, Block);
276
277 assert(SectionContents.begin() < Block.begin() &&
278 SectionContents.end() >= Block.end() &&
279 "Block is not contained in SectionContents");
280 uint64_t OffsetStart = Block.data() - SectionContents.data();
281 uint64_t OffsetEnd = OffsetStart + Block.size();
282
Zachary Turneraaad5742016-05-23 23:41:13 +0000283 W.flush();
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000284 cacheRelocations();
285 ListScope D(W, "BlockRelocations");
286 const coff_section *Section = Obj->getCOFFSection(Sec);
287 const auto &Relocations = RelocMap[Section];
288 for (const auto &Relocation : Relocations) {
289 uint64_t RelocationOffset = Relocation.getOffset();
290 if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd)
291 printRelocation(Sec, Relocation, OffsetStart);
292 }
293}
294
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000295static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000296 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
297 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
298 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
299 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
Saleem Abdulrasool5e1780e2014-03-11 03:08:37 +0000300 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000301 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
302 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
303 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
304 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
305 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
306 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
307 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
308 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
309 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
310 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
311 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
312 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
313 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
314 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
315 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
316 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
317};
318
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000319static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000320 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
321 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
322 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
323 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
324 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
325 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
326 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
327 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
328 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
329 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
330 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
331 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
332 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
333 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
334 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
335};
336
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000337static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000338 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
339 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
340 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
341 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
342 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
343 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
344 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
345 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
346 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
347 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
348 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
349};
350
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000351static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
Rui Ueyama06dc5e72014-01-27 04:22:24 +0000352 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000353 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
354 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
355 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
356 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
357 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
358 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000359 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000360 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000361 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000362 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
363};
364
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000365static const EnumEntry<COFF::SectionCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000366ImageSectionCharacteristics[] = {
David Majnemerd3238882015-07-30 16:47:56 +0000367 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000368 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
369 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
370 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
371 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
372 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
373 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
374 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
375 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
376 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
377 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
378 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
379 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
380 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
381 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
382 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
383 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
384 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
385 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
386 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
387 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
388 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
389 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
390 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
391 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
392 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
393 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
394 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
395 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
396 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
397 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
398 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
399 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
400 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
401 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
402 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
403};
404
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000405static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000406 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
407 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
408 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
409 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
410 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
411 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
412 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
413 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
414 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
415 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
416 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
417 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
418 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
419 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
420 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
421 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
422};
423
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000424static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000425 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
426 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
427 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
428 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
429};
430
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000431static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000432 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
433 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
434 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
435 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
436 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
437 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
438 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
439 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
440 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
441 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
442 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
443 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
444 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
445 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
446 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
447 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
448 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
449 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
450 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
451 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
452 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
453 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
454 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
455 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
456 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
457 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
458 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
459};
460
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000461static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000462 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
463 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
464 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
465 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
466 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
467 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
468 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
469};
470
Reid Kleckner2da433e2016-06-02 17:10:43 +0000471static const EnumEntry<COFF::DebugType> ImageDebugType[] = {
472 { "Unknown" , COFF::IMAGE_DEBUG_TYPE_UNKNOWN },
473 { "COFF" , COFF::IMAGE_DEBUG_TYPE_COFF },
474 { "CodeView" , COFF::IMAGE_DEBUG_TYPE_CODEVIEW },
475 { "FPO" , COFF::IMAGE_DEBUG_TYPE_FPO },
476 { "Misc" , COFF::IMAGE_DEBUG_TYPE_MISC },
477 { "Exception" , COFF::IMAGE_DEBUG_TYPE_EXCEPTION },
478 { "Fixup" , COFF::IMAGE_DEBUG_TYPE_FIXUP },
479 { "OmapToSrc" , COFF::IMAGE_DEBUG_TYPE_OMAP_TO_SRC },
480 { "OmapFromSrc", COFF::IMAGE_DEBUG_TYPE_OMAP_FROM_SRC },
481 { "Borland" , COFF::IMAGE_DEBUG_TYPE_BORLAND },
David Majnemera2a2a732016-06-02 17:32:11 +0000482 { "Reserved10" , COFF::IMAGE_DEBUG_TYPE_RESERVED10 },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000483 { "CLSID" , COFF::IMAGE_DEBUG_TYPE_CLSID },
484 { "VCFeature" , COFF::IMAGE_DEBUG_TYPE_VC_FEATURE },
485 { "POGO" , COFF::IMAGE_DEBUG_TYPE_POGO },
486 { "ILTCG" , COFF::IMAGE_DEBUG_TYPE_ILTCG },
487 { "MPX" , COFF::IMAGE_DEBUG_TYPE_MPX },
David Majnemera2a2a732016-06-02 17:32:11 +0000488 { "Repro" , COFF::IMAGE_DEBUG_TYPE_REPRO },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000489};
490
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000491static const EnumEntry<COFF::WeakExternalCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000492WeakExternalCharacteristics[] = {
493 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
494 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
495 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
496};
497
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000498static const EnumEntry<uint32_t> SubSectionTypes[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000499 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Symbols),
500 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Lines),
501 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, StringTable),
502 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FileChecksums),
503 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FrameData),
504 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, InlineeLines),
505 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeImports),
506 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeExports),
507 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, ILLines),
508 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FuncMDTokenMap),
509 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, TypeMDTokenMap),
510 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, MergedAssemblyInput),
511 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CoffSymbolRVA),
512};
513
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000514static const EnumEntry<uint32_t> FrameDataFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000515 LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH),
516 LLVM_READOBJ_ENUM_ENT(FrameData, HasEH),
517 LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart),
518};
519
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000520static const EnumEntry<uint8_t> FileChecksumKindNames[] = {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000521 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, None),
522 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, MD5),
523 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA1),
524 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA256),
525};
526
Rafael Espindola4453e42942014-06-13 03:07:50 +0000527template <typename T>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000528static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
David Majnemer44f51e52014-09-10 12:51:52 +0000529 COFFSymbolRef Symbol,
530 uint8_t AuxSymbolIdx, const T *&Aux) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000531 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
David Majnemer44f51e52014-09-10 12:51:52 +0000532 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000533 Aux = reinterpret_cast<const T*>(AuxData.data());
534 return readobj_error::success;
535}
536
Eric Christopher9cad53c2013-04-03 18:31:38 +0000537void COFFDumper::cacheRelocations() {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000538 if (RelocCached)
539 return;
540 RelocCached = true;
541
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000542 for (const SectionRef &S : Obj->sections()) {
543 const coff_section *Section = Obj->getCOFFSection(S);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000544
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000545 for (const RelocationRef &Reloc : S.relocations())
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000546 RelocMap[Section].push_back(Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000547
548 // Sort relocations by address.
549 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
550 relocAddressLess);
551 }
552}
553
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000554void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
555 const data_directory *Data;
556 if (Obj->getDataDirectory(Index, Data))
557 return;
558 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
559 W.printHex(FieldName + "Size", Data->Size);
560}
561
Eric Christopher9cad53c2013-04-03 18:31:38 +0000562void COFFDumper::printFileHeaders() {
David Majnemer44f51e52014-09-10 12:51:52 +0000563 time_t TDS = Obj->getTimeDateStamp();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000564 char FormattedTime[20] = { };
565 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
566
567 {
568 DictScope D(W, "ImageFileHeader");
David Majnemer44f51e52014-09-10 12:51:52 +0000569 W.printEnum ("Machine", Obj->getMachine(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000570 makeArrayRef(ImageFileMachineType));
David Majnemer44f51e52014-09-10 12:51:52 +0000571 W.printNumber("SectionCount", Obj->getNumberOfSections());
572 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
573 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
574 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
575 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
576 W.printFlags ("Characteristics", Obj->getCharacteristics(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000577 makeArrayRef(ImageFileCharacteristics));
578 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000579
580 // Print PE header. This header does not exist if this is an object file and
581 // not an executable.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000582 const pe32_header *PEHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000583 error(Obj->getPE32Header(PEHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000584 if (PEHeader)
585 printPEHeader<pe32_header>(PEHeader);
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000586
Craig Toppere6cb63e2014-04-25 04:24:47 +0000587 const pe32plus_header *PEPlusHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000588 error(Obj->getPE32PlusHeader(PEPlusHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000589 if (PEPlusHeader)
590 printPEHeader<pe32plus_header>(PEPlusHeader);
David Majnemer50267222014-11-05 06:24:35 +0000591
592 if (const dos_header *DH = Obj->getDOSHeader())
593 printDOSHeader(DH);
594}
595
596void COFFDumper::printDOSHeader(const dos_header *DH) {
597 DictScope D(W, "DOSHeader");
598 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
599 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
600 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
601 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
602 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
603 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
604 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
605 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
606 W.printNumber("InitialSP", DH->InitialSP);
607 W.printNumber("Checksum", DH->Checksum);
608 W.printNumber("InitialIP", DH->InitialIP);
609 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
610 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
611 W.printNumber("OverlayNumber", DH->OverlayNumber);
612 W.printNumber("OEMid", DH->OEMid);
613 W.printNumber("OEMinfo", DH->OEMinfo);
614 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000615}
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000616
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000617template <class PEHeader>
618void COFFDumper::printPEHeader(const PEHeader *Hdr) {
619 DictScope D(W, "ImageOptionalHeader");
620 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
621 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
622 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
623 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
624 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
625 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
626 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
627 printBaseOfDataField(Hdr);
628 W.printHex ("ImageBase", Hdr->ImageBase);
629 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
630 W.printNumber("FileAlignment", Hdr->FileAlignment);
631 W.printNumber("MajorOperatingSystemVersion",
632 Hdr->MajorOperatingSystemVersion);
633 W.printNumber("MinorOperatingSystemVersion",
634 Hdr->MinorOperatingSystemVersion);
635 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
636 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
637 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
638 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
639 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
640 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
641 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
David Majnemer774aadf2014-11-18 02:45:28 +0000642 W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000643 makeArrayRef(PEDLLCharacteristics));
644 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
645 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
646 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
647 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
648 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000649
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000650 if (Hdr->NumberOfRvaAndSize > 0) {
651 DictScope D(W, "DataDirectory");
652 static const char * const directory[] = {
653 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
654 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
655 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
656 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
657 };
658
Reid Kleckner2da433e2016-06-02 17:10:43 +0000659 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i)
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000660 printDataDirectory(i, directory[i]);
Reid Kleckner2da433e2016-06-02 17:10:43 +0000661 }
662}
663
664void COFFDumper::printCOFFDebugDirectory() {
665 ListScope LS(W, "DebugDirectory");
666 for (const debug_directory &D : Obj->debug_directories()) {
667 char FormattedTime[20] = {};
668 time_t TDS = D.TimeDateStamp;
669 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
670 DictScope S(W, "DebugEntry");
671 W.printHex("Characteristics", D.Characteristics);
672 W.printHex("TimeDateStamp", FormattedTime, D.TimeDateStamp);
673 W.printHex("MajorVersion", D.MajorVersion);
674 W.printHex("MinorVersion", D.MinorVersion);
675 W.printEnum("Type", D.Type, makeArrayRef(ImageDebugType));
676 W.printHex("SizeOfData", D.SizeOfData);
677 W.printHex("AddressOfRawData", D.AddressOfRawData);
678 W.printHex("PointerToRawData", D.PointerToRawData);
679 if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW) {
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000680 const codeview::DebugInfo *DebugInfo;
Reid Kleckner2da433e2016-06-02 17:10:43 +0000681 StringRef PDBFileName;
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000682 error(Obj->getDebugPDBInfo(&D, DebugInfo, PDBFileName));
Reid Kleckner2da433e2016-06-02 17:10:43 +0000683 DictScope PDBScope(W, "PDBInfo");
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000684 W.printHex("PDBSignature", DebugInfo->Signature.CVSignature);
685 if (DebugInfo->Signature.CVSignature == OMF::Signature::PDB70) {
686 W.printBinary("PDBGUID", makeArrayRef(DebugInfo->PDB70.Signature));
687 W.printNumber("PDBAge", DebugInfo->PDB70.Age);
688 W.printString("PDBFileName", PDBFileName);
689 }
Reid Kleckner2da433e2016-06-02 17:10:43 +0000690 } else {
691 // FIXME: Type values of 12 and 13 are commonly observed but are not in
692 // the documented type enum. Figure out what they mean.
693 ArrayRef<uint8_t> RawData;
694 error(
695 Obj->getRvaAndSizeAsBytes(D.AddressOfRawData, D.SizeOfData, RawData));
696 W.printBinaryBlock("RawData", RawData);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000697 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000698 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000699}
700
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000701void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
702 W.printHex("BaseOfData", Hdr->BaseOfData);
703}
704
705void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
706
Reid Kleckner83ebad32015-12-16 18:28:12 +0000707void COFFDumper::printCodeViewDebugInfo() {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000708 // Print types first to build CVUDTNames, then print symbols.
Reid Kleckner83ebad32015-12-16 18:28:12 +0000709 for (const SectionRef &S : Obj->sections()) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000710 StringRef SectionName;
711 error(S.getName(SectionName));
712 if (SectionName == ".debug$T")
713 printCodeViewTypeSection(SectionName, S);
714 }
715 for (const SectionRef &S : Obj->sections()) {
716 StringRef SectionName;
717 error(S.getName(SectionName));
718 if (SectionName == ".debug$S")
719 printCodeViewSymbolSection(SectionName, S);
Reid Kleckner83ebad32015-12-16 18:28:12 +0000720 }
721}
722
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000723void COFFDumper::initializeFileAndStringTables(StringRef Data) {
724 while (!Data.empty() && (CVFileChecksumTable.data() == nullptr ||
725 CVStringTable.data() == nullptr)) {
726 // The section consists of a number of subsection in the following format:
727 // |SubSectionType|SubSectionSize|Contents...|
728 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000729 error(consume(Data, SubType));
730 error(consume(Data, SubSectionSize));
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000731 if (SubSectionSize > Data.size())
732 return error(object_error::parse_failed);
733 switch (ModuleSubstreamKind(SubType)) {
734 case ModuleSubstreamKind::FileChecksums:
735 CVFileChecksumTable = Data.substr(0, SubSectionSize);
736 break;
737 case ModuleSubstreamKind::StringTable:
738 CVStringTable = Data.substr(0, SubSectionSize);
739 break;
740 default:
741 break;
742 }
David Majnemerefaaf412016-05-28 20:04:48 +0000743 uint32_t PaddedSize = alignTo(SubSectionSize, 4);
744 if (PaddedSize > Data.size())
745 error(object_error::parse_failed);
746 Data = Data.drop_front(PaddedSize);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000747 }
748}
749
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000750void COFFDumper::printCodeViewSymbolSection(StringRef SectionName,
751 const SectionRef &Section) {
752 StringRef SectionContents;
753 error(Section.getContents(SectionContents));
754 StringRef Data = SectionContents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000755
756 SmallVector<StringRef, 10> FunctionNames;
757 StringMap<StringRef> FunctionLineTables;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000758
Zachary Turner99f02152015-02-18 19:32:05 +0000759 ListScope D(W, "CodeViewDebugInfo");
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000760 // Print the section to allow correlation with printSections.
761 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000762
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000763 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000764 error(consume(Data, Magic));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000765 W.printHex("Magic", Magic);
766 if (Magic != COFF::DEBUG_SECTION_MAGIC)
767 return error(object_error::parse_failed);
768
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000769 initializeFileAndStringTables(Data);
770
Zachary Turnera96cce62016-06-03 03:25:59 +0000771 // TODO: Convert this over to using ModuleSubstreamVisitor.
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000772 while (!Data.empty()) {
773 // The section consists of a number of subsection in the following format:
774 // |SubSectionType|SubSectionSize|Contents...|
775 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000776 error(consume(Data, SubType));
777 error(consume(Data, SubSectionSize));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000778
779 ListScope S(W, "Subsection");
780 W.printEnum("SubSectionType", SubType, makeArrayRef(SubSectionTypes));
781 W.printHex("SubSectionSize", SubSectionSize);
782
783 // Get the contents of the subsection.
784 if (SubSectionSize > Data.size())
785 return error(object_error::parse_failed);
786 StringRef Contents = Data.substr(0, SubSectionSize);
787
788 // Add SubSectionSize to the current offset and align that offset to find
789 // the next subsection.
790 size_t SectionOffset = Data.data() - SectionContents.data();
791 size_t NextOffset = SectionOffset + SubSectionSize;
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000792 NextOffset = alignTo(NextOffset, 4);
David Majnemercab2b462016-05-28 20:04:50 +0000793 if (NextOffset > SectionContents.size())
794 return error(object_error::parse_failed);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000795 Data = SectionContents.drop_front(NextOffset);
796
797 // Optionally print the subsection bytes in case our parsing gets confused
798 // later.
799 if (opts::CodeViewSubsectionBytes)
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000800 printBinaryBlockWithRelocs("SubSectionContents", Section, SectionContents,
801 Contents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000802
803 switch (ModuleSubstreamKind(SubType)) {
804 case ModuleSubstreamKind::Symbols:
Reid Kleckner2893fd12016-01-14 17:51:54 +0000805 printCodeViewSymbolsSubsection(Contents, Section, SectionContents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000806 break;
Reid Klecknere9ab3492016-01-14 19:20:17 +0000807
808 case ModuleSubstreamKind::InlineeLines:
809 printCodeViewInlineeLines(Contents);
810 break;
811
Reid Klecknerc31f5302016-01-15 18:06:25 +0000812 case ModuleSubstreamKind::FileChecksums:
813 printCodeViewFileChecksums(Contents);
814 break;
815
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000816 case ModuleSubstreamKind::Lines: {
817 // Holds a PC to file:line table. Some data to parse this subsection is
818 // stored in the other subsections, so just check sanity and store the
819 // pointers for deferred processing.
820
821 if (SubSectionSize < 12) {
822 // There should be at least three words to store two function
823 // relocations and size of the code.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000824 error(object_error::parse_failed);
825 return;
826 }
827
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000828 StringRef LinkageName;
829 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset,
830 LinkageName));
831 W.printString("LinkageName", LinkageName);
832 if (FunctionLineTables.count(LinkageName) != 0) {
833 // Saw debug info for this function already?
834 error(object_error::parse_failed);
835 return;
Zachary Turner99f02152015-02-18 19:32:05 +0000836 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000837
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000838 FunctionLineTables[LinkageName] = Contents;
839 FunctionNames.push_back(LinkageName);
840 break;
841 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000842 case ModuleSubstreamKind::FrameData: {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000843 // First four bytes is a relocation against the function.
Zachary Turner695ed562017-02-28 00:04:07 +0000844 BinaryByteStream S(Contents, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +0000845 BinaryStreamReader SR(S);
NAKAMURA Takumi05a75e42017-02-25 17:04:23 +0000846 const uint32_t *CodePtr;
847 error(SR.readObject(CodePtr));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000848 StringRef LinkageName;
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000849 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionContents,
NAKAMURA Takumi05a75e42017-02-25 17:04:23 +0000850 CodePtr, LinkageName));
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000851 W.printString("LinkageName", LinkageName);
852
853 // To find the active frame description, search this array for the
854 // smallest PC range that includes the current PC.
Zachary Turner4d49eb92016-10-20 18:31:19 +0000855 while (!SR.empty()) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000856 const FrameData *FD;
Zachary Turner4d49eb92016-10-20 18:31:19 +0000857 error(SR.readObject(FD));
David Majnemera6d93fd2016-05-28 19:45:49 +0000858
859 if (FD->FrameFunc >= CVStringTable.size())
860 error(object_error::parse_failed);
861
862 StringRef FrameFunc =
863 CVStringTable.drop_front(FD->FrameFunc).split('\0').first;
864
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000865 DictScope S(W, "FrameData");
866 W.printHex("RvaStart", FD->RvaStart);
867 W.printHex("CodeSize", FD->CodeSize);
868 W.printHex("LocalSize", FD->LocalSize);
869 W.printHex("ParamsSize", FD->ParamsSize);
870 W.printHex("MaxStackSize", FD->MaxStackSize);
David Majnemera6d93fd2016-05-28 19:45:49 +0000871 W.printString("FrameFunc", FrameFunc);
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000872 W.printHex("PrologSize", FD->PrologSize);
873 W.printHex("SavedRegsSize", FD->SavedRegsSize);
874 W.printFlags("Flags", FD->Flags, makeArrayRef(FrameDataFlags));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000875 }
876 break;
877 }
878
879 // Do nothing for unrecognized subsections.
880 default:
881 break;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000882 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000883 W.flush();
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000884 }
885
886 // Dump the line tables now that we've read all the subsections and know all
887 // the required information.
888 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
889 StringRef Name = FunctionNames[I];
890 ListScope S(W, "FunctionLineTable");
Reid Kleckner7c0c0c02015-12-15 01:23:55 +0000891 W.printString("LinkageName", Name);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000892
893 DataExtractor DE(FunctionLineTables[Name], true, 4);
David Majnemer3f49e662015-07-09 00:19:51 +0000894 uint32_t Offset = 6; // Skip relocations.
895 uint16_t Flags = DE.getU16(&Offset);
896 W.printHex("Flags", Flags);
Reid Kleckner2214ed82016-01-29 00:49:42 +0000897 bool HasColumnInformation = Flags & codeview::LineFlags::HaveColumns;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000898 uint32_t FunctionSize = DE.getU32(&Offset);
899 W.printHex("CodeSize", FunctionSize);
900 while (DE.isValidOffset(Offset)) {
901 // For each range of lines with the same filename, we have a segment
902 // in the line table. The filename string is accessed using double
903 // indirection to the string table subsection using the index subsection.
904 uint32_t OffsetInIndex = DE.getU32(&Offset),
David Majnemer04948362016-01-13 01:05:16 +0000905 NumLines = DE.getU32(&Offset),
David Majnemer0373d532015-07-09 18:14:31 +0000906 FullSegmentSize = DE.getU32(&Offset);
907
David Majnemer04948362016-01-13 01:05:16 +0000908 uint32_t ColumnOffset = Offset + 8 * NumLines;
909 DataExtractor ColumnDE(DE.getData(), true, 4);
910
David Majnemer0373d532015-07-09 18:14:31 +0000911 if (FullSegmentSize !=
David Majnemer04948362016-01-13 01:05:16 +0000912 12 + 8 * NumLines + (HasColumnInformation ? 4 * NumLines : 0)) {
David Majnemer0373d532015-07-09 18:14:31 +0000913 error(object_error::parse_failed);
914 return;
915 }
Justin Bognera1413db2015-07-09 04:27:36 +0000916
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000917 ListScope S(W, "FilenameSegment");
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000918 printFileNameForOffset("Filename", OffsetInIndex);
David Majnemer04948362016-01-13 01:05:16 +0000919 for (unsigned LineIdx = 0;
920 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000921 // Then go the (PC, LineNumber) pairs. The line number is stored in the
922 // least significant 31 bits of the respective word in the table.
David Majnemer04948362016-01-13 01:05:16 +0000923 uint32_t PC = DE.getU32(&Offset), LineData = DE.getU32(&Offset);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000924 if (PC >= FunctionSize) {
925 error(object_error::parse_failed);
926 return;
927 }
928 char Buffer[32];
929 format("+0x%X", PC).snprint(Buffer, 32);
David Majnemer04948362016-01-13 01:05:16 +0000930 ListScope PCScope(W, Buffer);
David Majnemera4859df2016-02-04 17:57:12 +0000931 LineInfo LI(LineData);
932 if (LI.isAlwaysStepInto())
933 W.printString("StepInto", StringRef("Always"));
934 else if (LI.isNeverStepInto())
935 W.printString("StepInto", StringRef("Never"));
936 else
937 W.printNumber("LineNumberStart", LI.getStartLine());
938 W.printNumber("LineNumberEndDelta", LI.getLineDelta());
939 W.printBoolean("IsStatement", LI.isStatement());
David Majnemer04948362016-01-13 01:05:16 +0000940 if (HasColumnInformation &&
941 ColumnDE.isValidOffsetForDataOfSize(ColumnOffset, 4)) {
942 uint16_t ColStart = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +0000943 W.printNumber("ColStart", ColStart);
David Majnemer04948362016-01-13 01:05:16 +0000944 uint16_t ColEnd = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +0000945 W.printNumber("ColEnd", ColEnd);
946 }
947 }
David Majnemer04948362016-01-13 01:05:16 +0000948 // Skip over the column data.
949 if (HasColumnInformation) {
950 for (unsigned LineIdx = 0;
951 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
952 DE.getU32(&Offset);
953 }
954 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000955 }
956 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000957}
958
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000959void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
960 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000961 StringRef SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000962 ArrayRef<uint8_t> BinaryData(Subsection.bytes_begin(),
963 Subsection.bytes_end());
964 auto CODD = llvm::make_unique<COFFObjectDumpDelegate>(*this, Section, Obj,
965 SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000966
Zachary Turner629cb7d2017-01-11 23:24:22 +0000967 CVSymbolDumper CVSD(W, TypeDB, std::move(CODD),
968 opts::CodeViewSubsectionBytes);
Zachary Turner695ed562017-02-28 00:04:07 +0000969 BinaryByteStream Stream(BinaryData, llvm::support::little);
Zachary Turner0d43c1c2016-05-28 05:21:57 +0000970 CVSymbolArray Symbols;
Zachary Turner120faca2017-02-27 22:11:43 +0000971 BinaryStreamReader Reader(Stream);
Zachary Turner0d43c1c2016-05-28 05:21:57 +0000972 if (auto EC = Reader.readArray(Symbols, Reader.getLength())) {
973 consumeError(std::move(EC));
974 W.flush();
975 error(object_error::parse_failed);
976 }
Reid Kleckner2893fd12016-01-14 17:51:54 +0000977
Zachary Turner0d840742016-10-07 21:34:46 +0000978 if (auto EC = CVSD.dump(Symbols)) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000979 W.flush();
Zachary Turner0d840742016-10-07 21:34:46 +0000980 error(std::move(EC));
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000981 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000982 W.flush();
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000983}
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000984
Reid Klecknerc31f5302016-01-15 18:06:25 +0000985void COFFDumper::printCodeViewFileChecksums(StringRef Subsection) {
Zachary Turner695ed562017-02-28 00:04:07 +0000986 BinaryByteStream S(Subsection, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +0000987 BinaryStreamReader SR(S);
Zachary Turner4d49eb92016-10-20 18:31:19 +0000988 while (!SR.empty()) {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000989 DictScope S(W, "FileChecksum");
990 const FileChecksum *FC;
Zachary Turner4d49eb92016-10-20 18:31:19 +0000991 error(SR.readObject(FC));
Reid Klecknerc31f5302016-01-15 18:06:25 +0000992 if (FC->FileNameOffset >= CVStringTable.size())
993 error(object_error::parse_failed);
994 StringRef Filename =
995 CVStringTable.drop_front(FC->FileNameOffset).split('\0').first;
996 W.printHex("Filename", Filename, FC->FileNameOffset);
997 W.printHex("ChecksumSize", FC->ChecksumSize);
998 W.printEnum("ChecksumKind", uint8_t(FC->ChecksumKind),
999 makeArrayRef(FileChecksumKindNames));
Zachary Turner4d49eb92016-10-20 18:31:19 +00001000 if (FC->ChecksumSize >= SR.bytesRemaining())
Reid Klecknerc31f5302016-01-15 18:06:25 +00001001 error(object_error::parse_failed);
Zachary Turner4d49eb92016-10-20 18:31:19 +00001002 ArrayRef<uint8_t> ChecksumBytes;
1003 error(SR.readBytes(ChecksumBytes, FC->ChecksumSize));
Reid Klecknerc31f5302016-01-15 18:06:25 +00001004 W.printBinary("ChecksumBytes", ChecksumBytes);
Rafael Espindolaa79078c2016-01-18 20:55:24 +00001005 unsigned PaddedSize = alignTo(FC->ChecksumSize + sizeof(FileChecksum), 4) -
1006 sizeof(FileChecksum);
Zachary Turner4d49eb92016-10-20 18:31:19 +00001007 PaddedSize -= ChecksumBytes.size();
1008 if (PaddedSize > SR.bytesRemaining())
David Majnemer37dafba2016-05-28 19:45:58 +00001009 error(object_error::parse_failed);
Zachary Turner4d49eb92016-10-20 18:31:19 +00001010 error(SR.skip(PaddedSize));
Reid Klecknerc31f5302016-01-15 18:06:25 +00001011 }
1012}
1013
Reid Klecknere9ab3492016-01-14 19:20:17 +00001014void COFFDumper::printCodeViewInlineeLines(StringRef Subsection) {
Zachary Turner695ed562017-02-28 00:04:07 +00001015 BinaryByteStream S(Subsection, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +00001016 BinaryStreamReader SR(S);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001017 uint32_t Signature;
Zachary Turner695ed562017-02-28 00:04:07 +00001018 error(SR.readInteger(Signature));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001019 bool HasExtraFiles = Signature == unsigned(InlineeLinesSignature::ExtraFiles);
1020
Zachary Turner4d49eb92016-10-20 18:31:19 +00001021 while (!SR.empty()) {
Reid Klecknere9ab3492016-01-14 19:20:17 +00001022 const InlineeSourceLine *ISL;
Zachary Turner4d49eb92016-10-20 18:31:19 +00001023 error(SR.readObject(ISL));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001024 DictScope S(W, "InlineeSourceLine");
1025 printTypeIndex("Inlinee", ISL->Inlinee);
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001026 printFileNameForOffset("FileID", ISL->FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001027 W.printNumber("SourceLineNum", ISL->SourceLineNum);
1028
1029 if (HasExtraFiles) {
1030 uint32_t ExtraFileCount;
Zachary Turner695ed562017-02-28 00:04:07 +00001031 error(SR.readInteger(ExtraFileCount));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001032 W.printNumber("ExtraFileCount", ExtraFileCount);
1033 ListScope ExtraFiles(W, "ExtraFiles");
1034 for (unsigned I = 0; I < ExtraFileCount; ++I) {
1035 uint32_t FileID;
Zachary Turner695ed562017-02-28 00:04:07 +00001036 error(SR.readInteger(FileID));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001037 printFileNameForOffset("FileID", FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001038 }
1039 }
1040 }
1041}
1042
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001043StringRef COFFDumper::getFileNameForFileOffset(uint32_t FileOffset) {
1044 // The file checksum subsection should precede all references to it.
1045 if (!CVFileChecksumTable.data() || !CVStringTable.data())
1046 error(object_error::parse_failed);
1047 // Check if the file checksum table offset is valid.
1048 if (FileOffset >= CVFileChecksumTable.size())
1049 error(object_error::parse_failed);
1050
1051 // The string table offset comes first before the file checksum.
1052 StringRef Data = CVFileChecksumTable.drop_front(FileOffset);
1053 uint32_t StringOffset;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001054 error(consume(Data, StringOffset));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001055
1056 // Check if the string table offset is valid.
1057 if (StringOffset >= CVStringTable.size())
1058 error(object_error::parse_failed);
1059
1060 // Return the null-terminated string.
1061 return CVStringTable.drop_front(StringOffset).split('\0').first;
1062}
1063
1064void COFFDumper::printFileNameForOffset(StringRef Label, uint32_t FileOffset) {
1065 W.printHex(Label, getFileNameForFileOffset(FileOffset), FileOffset);
1066}
1067
Reid Kleckner5d577522017-03-24 17:26:38 +00001068void COFFDumper::mergeCodeViewTypes(TypeTableBuilder &CVIDs,
1069 TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001070 for (const SectionRef &S : Obj->sections()) {
1071 StringRef SectionName;
1072 error(S.getName(SectionName));
1073 if (SectionName == ".debug$T") {
1074 StringRef Data;
1075 error(S.getContents(Data));
David Majnemer78b0d722016-05-28 19:17:48 +00001076 uint32_t Magic;
1077 error(consume(Data, Magic));
Reid Kleckner0b269742016-05-14 00:02:53 +00001078 if (Magic != 4)
1079 error(object_error::parse_failed);
Reid Kleckner0b269742016-05-14 00:02:53 +00001080 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(Data.data()),
1081 Data.size());
Zachary Turner695ed562017-02-28 00:04:07 +00001082 BinaryByteStream Stream(Bytes, llvm::support::little);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001083 CVTypeArray Types;
Zachary Turner120faca2017-02-27 22:11:43 +00001084 BinaryStreamReader Reader(Stream);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001085 if (auto EC = Reader.readArray(Types, Reader.getLength())) {
1086 consumeError(std::move(EC));
1087 W.flush();
1088 error(object_error::parse_failed);
1089 }
1090
Reid Klecknerc4b5d792017-04-03 23:58:15 +00001091 if (auto EC = mergeTypeStreams(CVIDs, CVTypes, nullptr, Types))
1092 return error(std::move(EC));
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);
Shoaib Meenai73754482017-03-26 17:10:11 +00001440 uint32_t ILTAddr;
1441 error(I.getImportLookupTableRVA(ILTAddr));
1442 W.printHex("ImportLookupTableRVA", ILTAddr);
1443 uint32_t IATAddr;
1444 error(I.getImportAddressTableRVA(IATAddr));
1445 W.printHex("ImportAddressTableRVA", IATAddr);
1446 // The import lookup table can be missing with certain older linkers, so
1447 // fall back to the import address table in that case.
1448 if (ILTAddr)
1449 printImportedSymbols(I.lookup_table_symbols());
1450 else
1451 printImportedSymbols(I.imported_symbols());
Rui Ueyama15d99352014-10-03 00:41:58 +00001452 }
1453
1454 // Delay imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001455 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001456 DictScope Import(W, "DelayImport");
1457 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001458 error(I.getName(Name));
Rui Ueyama15d99352014-10-03 00:41:58 +00001459 W.printString("Name", Name);
Rui Ueyama1af08652014-10-03 18:07:18 +00001460 const delay_import_directory_table_entry *Table;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001461 error(I.getDelayImportTable(Table));
Rui Ueyama1af08652014-10-03 18:07:18 +00001462 W.printHex("Attributes", Table->Attributes);
1463 W.printHex("ModuleHandle", Table->ModuleHandle);
1464 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
1465 W.printHex("ImportNameTable", Table->DelayImportNameTable);
1466 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
1467 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001468 printDelayImportedSymbols(I, I.imported_symbols());
Rui Ueyama1e152d52014-10-02 17:02:18 +00001469 }
1470}
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001471
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001472void COFFDumper::printCOFFExports() {
1473 for (const ExportDirectoryEntryRef &E : Obj->export_directories()) {
1474 DictScope Export(W, "Export");
1475
1476 StringRef Name;
1477 uint32_t Ordinal, RVA;
1478
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001479 error(E.getSymbolName(Name));
1480 error(E.getOrdinal(Ordinal));
1481 error(E.getExportRVA(RVA));
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001482
1483 W.printNumber("Ordinal", Ordinal);
1484 W.printString("Name", Name);
1485 W.printHex("RVA", RVA);
1486 }
1487}
1488
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001489void COFFDumper::printCOFFDirectives() {
1490 for (const SectionRef &Section : Obj->sections()) {
1491 StringRef Contents;
1492 StringRef Name;
1493
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001494 error(Section.getName(Name));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001495 if (Name != ".drectve")
1496 continue;
1497
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001498 error(Section.getContents(Contents));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001499
1500 W.printString("Directive(s)", Contents);
1501 }
1502}
Rui Ueyama74e85132014-11-19 00:18:07 +00001503
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001504static StringRef getBaseRelocTypeName(uint8_t Type) {
Rui Ueyama74e85132014-11-19 00:18:07 +00001505 switch (Type) {
1506 case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";
1507 case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";
1508 case COFF::IMAGE_REL_BASED_LOW: return "LOW";
1509 case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";
1510 case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";
Saleem Abdulrasool5a41c372015-01-16 20:16:09 +00001511 case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)";
Rui Ueyama74e85132014-11-19 00:18:07 +00001512 case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";
Colin LeMahieu9fbffee2014-11-19 17:10:39 +00001513 default: return "unknown (" + llvm::utostr(Type) + ")";
Rui Ueyama74e85132014-11-19 00:18:07 +00001514 }
1515}
1516
1517void COFFDumper::printCOFFBaseReloc() {
1518 ListScope D(W, "BaseReloc");
1519 for (const BaseRelocRef &I : Obj->base_relocs()) {
1520 uint8_t Type;
1521 uint32_t RVA;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001522 error(I.getRVA(RVA));
1523 error(I.getType(Type));
Rui Ueyama74e85132014-11-19 00:18:07 +00001524 DictScope Import(W, "Entry");
1525 W.printString("Type", getBaseRelocTypeName(Type));
1526 W.printHex("Address", RVA);
1527 }
1528}
Lang Hames0000afd2015-06-26 23:56:53 +00001529
1530void COFFDumper::printStackMap() const {
1531 object::SectionRef StackMapSection;
1532 for (auto Sec : Obj->sections()) {
1533 StringRef Name;
1534 Sec.getName(Name);
1535 if (Name == ".llvm_stackmaps") {
1536 StackMapSection = Sec;
1537 break;
1538 }
1539 }
1540
1541 if (StackMapSection == object::SectionRef())
1542 return;
1543
1544 StringRef StackMapContents;
1545 StackMapSection.getContents(StackMapContents);
1546 ArrayRef<uint8_t> StackMapContentsArray(
1547 reinterpret_cast<const uint8_t*>(StackMapContents.data()),
1548 StackMapContents.size());
1549
1550 if (Obj->isLittleEndian())
1551 prettyPrintStackMap(
1552 llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001553 StackMapV2Parser<support::little>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001554 else
1555 prettyPrintStackMap(llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001556 StackMapV2Parser<support::big>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001557}
Reid Kleckner0b269742016-05-14 00:02:53 +00001558
Zachary Turner4efa0a42016-11-08 22:24:53 +00001559void llvm::dumpCodeViewMergedTypes(ScopedPrinter &Writer,
Reid Kleckner5d577522017-03-24 17:26:38 +00001560 llvm::codeview::TypeTableBuilder &IDTable,
Zachary Turner4efa0a42016-11-08 22:24:53 +00001561 llvm::codeview::TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001562 // Flatten it first, then run our dumper on it.
Reid Kleckner5d577522017-03-24 17:26:38 +00001563 SmallString<0> TypeBuf;
Zachary Turner4efa0a42016-11-08 22:24:53 +00001564 CVTypes.ForEachRecord([&](TypeIndex TI, ArrayRef<uint8_t> Record) {
Reid Kleckner5d577522017-03-24 17:26:38 +00001565 TypeBuf.append(Record.begin(), Record.end());
Reid Kleckner0b269742016-05-14 00:02:53 +00001566 });
Zachary Turner629cb7d2017-01-11 23:24:22 +00001567
1568 TypeDatabase TypeDB;
Reid Kleckner5d577522017-03-24 17:26:38 +00001569 {
1570 ListScope S(Writer, "MergedTypeStream");
1571 CVTypeDumper CVTD(TypeDB);
1572 TypeDumpVisitor TDV(TypeDB, &Writer, opts::CodeViewSubsectionBytes);
1573 if (auto EC = CVTD.dump(
1574 {TypeBuf.str().bytes_begin(), TypeBuf.str().bytes_end()}, TDV)) {
1575 Writer.flush();
Reid Klecknerc4b5d792017-04-03 23:58:15 +00001576 error(std::move(EC));
Reid Kleckner5d577522017-03-24 17:26:38 +00001577 }
1578 }
1579
1580 // Flatten the id stream and print it next. The ID stream refers to names from
1581 // the type stream.
1582 SmallString<0> IDBuf;
1583 IDTable.ForEachRecord([&](TypeIndex TI, ArrayRef<uint8_t> Record) {
1584 IDBuf.append(Record.begin(), Record.end());
1585 });
1586
1587 {
1588 ListScope S(Writer, "MergedIDStream");
1589 TypeDatabase IDDB;
1590 CVTypeDumper CVTD(IDDB);
1591 TypeDumpVisitor TDV(TypeDB, &Writer, opts::CodeViewSubsectionBytes);
1592 TDV.setItemDB(IDDB);
1593 if (auto EC = CVTD.dump(
1594 {IDBuf.str().bytes_begin(), IDBuf.str().bytes_end()}, TDV)) {
1595 Writer.flush();
Reid Klecknerc4b5d792017-04-03 23:58:15 +00001596 error(std::move(EC));
Reid Kleckner5d577522017-03-24 17:26:38 +00001597 }
Reid Kleckner0b269742016-05-14 00:02:53 +00001598 }
1599}