blob: abe0e8d6965d47a12ecbffe3367830de8cf61b9b [file] [log] [blame]
Eric Christopher9cad53c2013-04-03 18:31:38 +00001//===-- COFFDumper.cpp - COFF-specific dumper -------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11/// \brief This file implements the COFF-specific dumper for llvm-readobj.
12///
13//===----------------------------------------------------------------------===//
14
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000015#include "ARMWinEHPrinter.h"
Reid Kleckner72e2ba72016-01-13 19:32:35 +000016#include "CodeView.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000017#include "Error.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000018#include "ObjDumper.h"
Lang Hames0000afd2015-06-26 23:56:53 +000019#include "StackMapPrinter.h"
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +000020#include "Win64EHDumper.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000021#include "llvm-readobj.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000022#include "llvm/ADT/DenseMap.h"
23#include "llvm/ADT/SmallString.h"
Colin LeMahieu9fbffee2014-11-19 17:10:39 +000024#include "llvm/ADT/StringExtras.h"
Zachary Turnera9054dd2017-01-11 00:35:43 +000025#include "llvm/DebugInfo/CodeView/CVTypeDumper.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000026#include "llvm/DebugInfo/CodeView/CodeView.h"
Reid Klecknere9ab3492016-01-14 19:20:17 +000027#include "llvm/DebugInfo/CodeView/Line.h"
Zachary Turnerc37cb0c2017-04-27 16:12:16 +000028#include "llvm/DebugInfo/CodeView/ModuleDebugFileChecksumFragment.h"
Zachary Turner05bd9f32017-04-28 23:41:36 +000029#include "llvm/DebugInfo/CodeView/ModuleDebugLineFragment.h"
Zachary Turneraaad5742016-05-23 23:41:13 +000030#include "llvm/DebugInfo/CodeView/RecordSerialization.h"
Zachary Turner0d840742016-10-07 21:34:46 +000031#include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
Zachary Turneraaad5742016-05-23 23:41:13 +000032#include "llvm/DebugInfo/CodeView/SymbolDumpDelegate.h"
33#include "llvm/DebugInfo/CodeView/SymbolDumper.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000034#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
Zachary Turner629cb7d2017-01-11 23:24:22 +000035#include "llvm/DebugInfo/CodeView/TypeDumpVisitor.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000036#include "llvm/DebugInfo/CodeView/TypeIndex.h"
37#include "llvm/DebugInfo/CodeView/TypeRecord.h"
Reid Kleckner0b269742016-05-14 00:02:53 +000038#include "llvm/DebugInfo/CodeView/TypeStreamMerger.h"
Zachary Turner4efa0a42016-11-08 22:24:53 +000039#include "llvm/DebugInfo/CodeView/TypeTableBuilder.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000040#include "llvm/Object/COFF.h"
41#include "llvm/Object/ObjectFile.h"
Zachary Turnerd9dc2822017-03-02 20:52:51 +000042#include "llvm/Support/BinaryByteStream.h"
Zachary Turner05bd9f32017-04-28 23:41:36 +000043#include "llvm/Support/BinaryStreamReader.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000044#include "llvm/Support/COFF.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000045#include "llvm/Support/Casting.h"
46#include "llvm/Support/Compiler.h"
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000047#include "llvm/Support/DataExtractor.h"
Zachary Turner05bd9f32017-04-28 23:41:36 +000048#include "llvm/Support/FormatVariadic.h"
Zachary Turner7b327d02017-02-16 23:35:45 +000049#include "llvm/Support/Path.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000050#include "llvm/Support/ScopedPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000051#include "llvm/Support/SourceMgr.h"
52#include "llvm/Support/Win64EH.h"
53#include "llvm/Support/raw_ostream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000054#include <algorithm>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000055#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000056#include <system_error>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000057#include <time.h>
Eric Christopher9cad53c2013-04-03 18:31:38 +000058
59using namespace llvm;
60using namespace llvm::object;
Reid Kleckner72e2ba72016-01-13 19:32:35 +000061using namespace llvm::codeview;
Reid Kleckner6b3faef2016-01-13 23:44:57 +000062using namespace llvm::support;
Eric Christopher9cad53c2013-04-03 18:31:38 +000063using namespace llvm::Win64EH;
64
65namespace {
66
67class COFFDumper : public ObjDumper {
68public:
Zachary Turneraaad5742016-05-23 23:41:13 +000069 friend class COFFObjectDumpDelegate;
Zachary Turner88bb1632016-05-03 00:28:04 +000070 COFFDumper(const llvm::object::COFFObjectFile *Obj, ScopedPrinter &Writer)
Zachary Turner629cb7d2017-01-11 23:24:22 +000071 : ObjDumper(Writer), Obj(Obj), Writer(Writer) {}
Eric Christopher9cad53c2013-04-03 18:31:38 +000072
Craig Topperfd38cbe2014-08-30 16:48:34 +000073 void printFileHeaders() override;
74 void printSections() override;
75 void printRelocations() override;
76 void printSymbols() override;
77 void printDynamicSymbols() override;
78 void printUnwindInfo() override;
Rui Ueyama1e152d52014-10-02 17:02:18 +000079 void printCOFFImports() override;
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +000080 void printCOFFExports() override;
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +000081 void printCOFFDirectives() override;
Rui Ueyama74e85132014-11-19 00:18:07 +000082 void printCOFFBaseReloc() override;
Reid Kleckner2da433e2016-06-02 17:10:43 +000083 void printCOFFDebugDirectory() override;
Zachary Turner8d6396d2017-04-27 19:38:38 +000084 void printCOFFResources() override;
Reid Kleckner83ebad32015-12-16 18:28:12 +000085 void printCodeViewDebugInfo() override;
Reid Kleckner5d577522017-03-24 17:26:38 +000086 void mergeCodeViewTypes(llvm::codeview::TypeTableBuilder &CVIDs,
87 llvm::codeview::TypeTableBuilder &CVTypes) override;
Lang Hames0000afd2015-06-26 23:56:53 +000088 void printStackMap() const override;
Eric Christopher9cad53c2013-04-03 18:31:38 +000089private:
Alexey Samsonov27dc8392014-03-18 06:53:02 +000090 void printSymbol(const SymbolRef &Sym);
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +000091 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc,
92 uint64_t Bias = 0);
Rui Ueyamaed64342b2013-07-19 23:23:29 +000093 void printDataDirectory(uint32_t Index, const std::string &FieldName);
Eric Christopher9cad53c2013-04-03 18:31:38 +000094
David Majnemer50267222014-11-05 06:24:35 +000095 void printDOSHeader(const dos_header *DH);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +000096 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
97 void printBaseOfDataField(const pe32_header *Hdr);
98 void printBaseOfDataField(const pe32plus_header *Hdr);
99
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000100 void printCodeViewSymbolSection(StringRef SectionName, const SectionRef &Section);
101 void printCodeViewTypeSection(StringRef SectionName, const SectionRef &Section);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000102 StringRef getTypeName(TypeIndex Ty);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000103 StringRef getFileNameForFileOffset(uint32_t FileOffset);
104 void printFileNameForOffset(StringRef Label, uint32_t FileOffset);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000105 void printTypeIndex(StringRef FieldName, TypeIndex TI) {
106 // Forward to CVTypeDumper for simplicity.
Zachary Turner629cb7d2017-01-11 23:24:22 +0000107 CVTypeDumper::printTypeIndex(Writer, FieldName, TI, TypeDB);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000108 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000109
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000110 void printCodeViewSymbolsSubsection(StringRef Subsection,
111 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000112 StringRef SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000113
Reid Klecknerc31f5302016-01-15 18:06:25 +0000114 void printCodeViewFileChecksums(StringRef Subsection);
115
Reid Klecknere9ab3492016-01-14 19:20:17 +0000116 void printCodeViewInlineeLines(StringRef Subsection);
117
Reid Kleckner2893fd12016-01-14 17:51:54 +0000118 void printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000119 uint32_t RelocOffset, uint32_t Offset,
120 StringRef *RelocSym = nullptr);
121
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000122 void printBinaryBlockWithRelocs(StringRef Label, const SectionRef &Sec,
123 StringRef SectionContents, StringRef Block);
124
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000125 /// Given a .debug$S section, find the string table and file checksum table.
126 void initializeFileAndStringTables(StringRef Data);
127
Eric Christopher9cad53c2013-04-03 18:31:38 +0000128 void cacheRelocations();
129
Rafael Espindola4453e42942014-06-13 03:07:50 +0000130 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
131 SymbolRef &Sym);
132 std::error_code resolveSymbolName(const coff_section *Section,
133 uint64_t Offset, StringRef &Name);
Reid Kleckner2893fd12016-01-14 17:51:54 +0000134 std::error_code resolveSymbolName(const coff_section *Section,
135 StringRef SectionContents,
136 const void *RelocPtr, StringRef &Name);
Rui Ueyama979fb402014-10-09 02:16:38 +0000137 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +0000138 void printDelayImportedSymbols(
139 const DelayImportDirectoryEntryRef &I,
140 iterator_range<imported_symbol_iterator> Range);
Rui Ueyama15d99352014-10-03 00:41:58 +0000141
Eric Christopher9cad53c2013-04-03 18:31:38 +0000142 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
143
144 const llvm::object::COFFObjectFile *Obj;
Rafael Espindola76d650e2015-07-06 14:26:07 +0000145 bool RelocCached = false;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000146 RelocMapTy RelocMap;
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000147 StringRef CVFileChecksumTable;
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000148 StringRef CVStringTable;
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000149
Zachary Turner629cb7d2017-01-11 23:24:22 +0000150 ScopedPrinter &Writer;
151 TypeDatabase TypeDB;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000152};
153
Zachary Turneraaad5742016-05-23 23:41:13 +0000154class COFFObjectDumpDelegate : public SymbolDumpDelegate {
155public:
156 COFFObjectDumpDelegate(COFFDumper &CD, const SectionRef &SR,
157 const COFFObjectFile *Obj, StringRef SectionContents)
Zachary Turner537014c2016-05-24 03:32:34 +0000158 : CD(CD), SR(SR), SectionContents(SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000159 Sec = Obj->getCOFFSection(SR);
160 }
161
Zachary Turner120faca2017-02-27 22:11:43 +0000162 uint32_t getRecordOffset(BinaryStreamReader Reader) override {
Zachary Turner4d49eb92016-10-20 18:31:19 +0000163 ArrayRef<uint8_t> Data;
164 if (auto EC = Reader.readLongestContiguousChunk(Data)) {
165 llvm::consumeError(std::move(EC));
166 return 0;
167 }
168 return Data.data() - SectionContents.bytes_begin();
Zachary Turneraaad5742016-05-23 23:41:13 +0000169 }
170
171 void printRelocatedField(StringRef Label, uint32_t RelocOffset,
172 uint32_t Offset, StringRef *RelocSym) override {
173 CD.printRelocatedField(Label, Sec, RelocOffset, Offset, RelocSym);
174 }
175
176 void printBinaryBlockWithRelocs(StringRef Label,
177 ArrayRef<uint8_t> Block) override {
178 StringRef SBlock(reinterpret_cast<const char *>(Block.data()),
179 Block.size());
180 if (opts::CodeViewSubsectionBytes)
181 CD.printBinaryBlockWithRelocs(Label, SR, SectionContents, SBlock);
182 }
183
184 StringRef getFileNameForFileOffset(uint32_t FileOffset) override {
185 return CD.getFileNameForFileOffset(FileOffset);
186 }
187
188 StringRef getStringTable() override { return CD.CVStringTable; }
189
190private:
191 COFFDumper &CD;
192 const SectionRef &SR;
Zachary Turneraaad5742016-05-23 23:41:13 +0000193 const coff_section *Sec;
194 StringRef SectionContents;
195};
196
Reid Kleckner4a14bca2016-05-05 00:34:33 +0000197} // end namespace
Eric Christopher9cad53c2013-04-03 18:31:38 +0000198
199namespace llvm {
200
Rafael Espindola4453e42942014-06-13 03:07:50 +0000201std::error_code createCOFFDumper(const object::ObjectFile *Obj,
Zachary Turner88bb1632016-05-03 00:28:04 +0000202 ScopedPrinter &Writer,
Rafael Espindola4453e42942014-06-13 03:07:50 +0000203 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000204 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
205 if (!COFFObj)
206 return readobj_error::unsupported_obj_file_format;
207
208 Result.reset(new COFFDumper(COFFObj, Writer));
209 return readobj_error::success;
210}
211
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000212} // namespace llvm
Eric Christopher9cad53c2013-04-03 18:31:38 +0000213
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000214// Given a a section and an offset into this section the function returns the
215// symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000216std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
217 uint64_t Offset, SymbolRef &Sym) {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000218 cacheRelocations();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000219 const auto &Relocations = RelocMap[Section];
David Majnemer61f17982016-05-29 06:18:08 +0000220 auto SymI = Obj->symbol_end();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000221 for (const auto &Relocation : Relocations) {
Rafael Espindola96d071c2015-06-29 23:29:12 +0000222 uint64_t RelocationOffset = Relocation.getOffset();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000223
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000224 if (RelocationOffset == Offset) {
David Majnemer61f17982016-05-29 06:18:08 +0000225 SymI = Relocation.getSymbol();
226 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000227 }
228 }
David Majnemer61f17982016-05-29 06:18:08 +0000229 if (SymI == Obj->symbol_end())
230 return readobj_error::unknown_symbol;
231 Sym = *SymI;
232 return readobj_error::success;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000233}
234
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000235// Given a section and an offset into this section the function returns the name
236// of the symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000237std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
238 uint64_t Offset,
239 StringRef &Name) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000240 SymbolRef Symbol;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000241 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000242 return EC;
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000243 Expected<StringRef> NameOrErr = Symbol.getName();
244 if (!NameOrErr)
245 return errorToErrorCode(NameOrErr.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000246 Name = *NameOrErr;
Rui Ueyama7d099192015-06-09 15:20:42 +0000247 return std::error_code();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000248}
249
Reid Kleckner2893fd12016-01-14 17:51:54 +0000250// Helper for when you have a pointer to real data and you want to know about
251// relocations against it.
252std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
253 StringRef SectionContents,
254 const void *RelocPtr,
255 StringRef &Name) {
256 assert(SectionContents.data() < RelocPtr &&
257 RelocPtr < SectionContents.data() + SectionContents.size() &&
258 "pointer to relocated object is not in section");
259 uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) -
260 SectionContents.data());
261 return resolveSymbolName(Section, Offset, Name);
262}
263
264void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000265 uint32_t RelocOffset, uint32_t Offset,
266 StringRef *RelocSym) {
267 StringRef SymStorage;
268 StringRef &Symbol = RelocSym ? *RelocSym : SymStorage;
269 if (!resolveSymbolName(Sec, RelocOffset, Symbol))
270 W.printSymbolOffset(Label, Symbol, Offset);
271 else
272 W.printHex(Label, RelocOffset);
273}
274
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000275void COFFDumper::printBinaryBlockWithRelocs(StringRef Label,
276 const SectionRef &Sec,
277 StringRef SectionContents,
278 StringRef Block) {
279 W.printBinaryBlock(Label, Block);
280
281 assert(SectionContents.begin() < Block.begin() &&
282 SectionContents.end() >= Block.end() &&
283 "Block is not contained in SectionContents");
284 uint64_t OffsetStart = Block.data() - SectionContents.data();
285 uint64_t OffsetEnd = OffsetStart + Block.size();
286
Zachary Turneraaad5742016-05-23 23:41:13 +0000287 W.flush();
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000288 cacheRelocations();
289 ListScope D(W, "BlockRelocations");
290 const coff_section *Section = Obj->getCOFFSection(Sec);
291 const auto &Relocations = RelocMap[Section];
292 for (const auto &Relocation : Relocations) {
293 uint64_t RelocationOffset = Relocation.getOffset();
294 if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd)
295 printRelocation(Sec, Relocation, OffsetStart);
296 }
297}
298
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000299static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000300 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
301 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
302 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
303 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
Saleem Abdulrasool5e1780e2014-03-11 03:08:37 +0000304 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000305 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
306 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
307 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
308 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
309 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
310 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
311 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
312 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
313 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
314 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
315 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
316 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
317 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
318 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
319 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
320 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
321};
322
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000323static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000324 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
325 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
326 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
327 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
328 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
329 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
330 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
331 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
332 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
333 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
334 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
335 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
336 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
337 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
338 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
339};
340
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000341static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000342 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
343 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
344 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
345 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
346 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
347 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
348 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
349 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
350 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
351 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
352 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
353};
354
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000355static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
Rui Ueyama06dc5e72014-01-27 04:22:24 +0000356 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000357 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
358 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
359 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
360 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
361 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
362 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000363 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000364 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000365 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000366 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
367};
368
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000369static const EnumEntry<COFF::SectionCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000370ImageSectionCharacteristics[] = {
David Majnemerd3238882015-07-30 16:47:56 +0000371 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000372 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
373 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
374 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
375 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
376 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
377 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
378 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
379 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
380 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
381 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
382 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
383 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
384 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
385 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
386 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
387 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
388 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
389 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
390 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
391 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
392 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
393 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
394 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
395 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
396 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
397 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
398 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
399 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
400 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
401 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
402 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
403 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
404 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
405 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
406 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
407};
408
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000409static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000410 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
411 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
412 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
413 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
414 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
415 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
416 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
417 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
418 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
419 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
420 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
421 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
422 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
423 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
424 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
425 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
426};
427
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000428static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000429 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
430 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
431 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
432 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
433};
434
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000435static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000436 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
437 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
438 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
439 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
440 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
441 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
442 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
443 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
444 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
445 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
446 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
447 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
448 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
449 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
450 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
451 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
452 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
453 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
454 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
455 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
456 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
457 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
458 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
459 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
460 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
461 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
462 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
463};
464
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000465static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000466 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
467 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
468 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
469 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
470 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
471 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
472 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
473};
474
Reid Kleckner2da433e2016-06-02 17:10:43 +0000475static const EnumEntry<COFF::DebugType> ImageDebugType[] = {
476 { "Unknown" , COFF::IMAGE_DEBUG_TYPE_UNKNOWN },
477 { "COFF" , COFF::IMAGE_DEBUG_TYPE_COFF },
478 { "CodeView" , COFF::IMAGE_DEBUG_TYPE_CODEVIEW },
479 { "FPO" , COFF::IMAGE_DEBUG_TYPE_FPO },
480 { "Misc" , COFF::IMAGE_DEBUG_TYPE_MISC },
481 { "Exception" , COFF::IMAGE_DEBUG_TYPE_EXCEPTION },
482 { "Fixup" , COFF::IMAGE_DEBUG_TYPE_FIXUP },
483 { "OmapToSrc" , COFF::IMAGE_DEBUG_TYPE_OMAP_TO_SRC },
484 { "OmapFromSrc", COFF::IMAGE_DEBUG_TYPE_OMAP_FROM_SRC },
485 { "Borland" , COFF::IMAGE_DEBUG_TYPE_BORLAND },
David Majnemera2a2a732016-06-02 17:32:11 +0000486 { "Reserved10" , COFF::IMAGE_DEBUG_TYPE_RESERVED10 },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000487 { "CLSID" , COFF::IMAGE_DEBUG_TYPE_CLSID },
488 { "VCFeature" , COFF::IMAGE_DEBUG_TYPE_VC_FEATURE },
489 { "POGO" , COFF::IMAGE_DEBUG_TYPE_POGO },
490 { "ILTCG" , COFF::IMAGE_DEBUG_TYPE_ILTCG },
491 { "MPX" , COFF::IMAGE_DEBUG_TYPE_MPX },
David Majnemera2a2a732016-06-02 17:32:11 +0000492 { "Repro" , COFF::IMAGE_DEBUG_TYPE_REPRO },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000493};
494
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000495static const EnumEntry<COFF::WeakExternalCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000496WeakExternalCharacteristics[] = {
497 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
498 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
499 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
500};
501
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000502static const EnumEntry<uint32_t> SubSectionTypes[] = {
Zachary Turner67c56012017-04-27 16:11:19 +0000503 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, Symbols),
504 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, Lines),
505 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, StringTable),
506 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, FileChecksums),
507 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, FrameData),
508 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, InlineeLines),
509 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, CrossScopeImports),
510 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, CrossScopeExports),
511 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, ILLines),
512 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, FuncMDTokenMap),
513 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, TypeMDTokenMap),
514 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, MergedAssemblyInput),
515 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleDebugFragmentKind, CoffSymbolRVA),
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000516};
517
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000518static const EnumEntry<uint32_t> FrameDataFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000519 LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH),
520 LLVM_READOBJ_ENUM_ENT(FrameData, HasEH),
521 LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart),
522};
523
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000524static const EnumEntry<uint8_t> FileChecksumKindNames[] = {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000525 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, None),
526 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, MD5),
527 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA1),
528 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA256),
529};
530
Rafael Espindola4453e42942014-06-13 03:07:50 +0000531template <typename T>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000532static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
David Majnemer44f51e52014-09-10 12:51:52 +0000533 COFFSymbolRef Symbol,
534 uint8_t AuxSymbolIdx, const T *&Aux) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000535 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
David Majnemer44f51e52014-09-10 12:51:52 +0000536 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000537 Aux = reinterpret_cast<const T*>(AuxData.data());
538 return readobj_error::success;
539}
540
Eric Christopher9cad53c2013-04-03 18:31:38 +0000541void COFFDumper::cacheRelocations() {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000542 if (RelocCached)
543 return;
544 RelocCached = true;
545
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000546 for (const SectionRef &S : Obj->sections()) {
547 const coff_section *Section = Obj->getCOFFSection(S);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000548
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000549 for (const RelocationRef &Reloc : S.relocations())
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000550 RelocMap[Section].push_back(Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000551
552 // Sort relocations by address.
553 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
554 relocAddressLess);
555 }
556}
557
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000558void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
559 const data_directory *Data;
560 if (Obj->getDataDirectory(Index, Data))
561 return;
562 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
563 W.printHex(FieldName + "Size", Data->Size);
564}
565
Eric Christopher9cad53c2013-04-03 18:31:38 +0000566void COFFDumper::printFileHeaders() {
David Majnemer44f51e52014-09-10 12:51:52 +0000567 time_t TDS = Obj->getTimeDateStamp();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000568 char FormattedTime[20] = { };
569 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
570
571 {
572 DictScope D(W, "ImageFileHeader");
David Majnemer44f51e52014-09-10 12:51:52 +0000573 W.printEnum ("Machine", Obj->getMachine(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000574 makeArrayRef(ImageFileMachineType));
David Majnemer44f51e52014-09-10 12:51:52 +0000575 W.printNumber("SectionCount", Obj->getNumberOfSections());
576 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
577 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
578 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
579 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
580 W.printFlags ("Characteristics", Obj->getCharacteristics(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000581 makeArrayRef(ImageFileCharacteristics));
582 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000583
584 // Print PE header. This header does not exist if this is an object file and
585 // not an executable.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000586 const pe32_header *PEHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000587 error(Obj->getPE32Header(PEHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000588 if (PEHeader)
589 printPEHeader<pe32_header>(PEHeader);
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000590
Craig Toppere6cb63e2014-04-25 04:24:47 +0000591 const pe32plus_header *PEPlusHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000592 error(Obj->getPE32PlusHeader(PEPlusHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000593 if (PEPlusHeader)
594 printPEHeader<pe32plus_header>(PEPlusHeader);
David Majnemer50267222014-11-05 06:24:35 +0000595
596 if (const dos_header *DH = Obj->getDOSHeader())
597 printDOSHeader(DH);
598}
599
600void COFFDumper::printDOSHeader(const dos_header *DH) {
601 DictScope D(W, "DOSHeader");
602 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
603 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
604 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
605 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
606 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
607 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
608 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
609 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
610 W.printNumber("InitialSP", DH->InitialSP);
611 W.printNumber("Checksum", DH->Checksum);
612 W.printNumber("InitialIP", DH->InitialIP);
613 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
614 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
615 W.printNumber("OverlayNumber", DH->OverlayNumber);
616 W.printNumber("OEMid", DH->OEMid);
617 W.printNumber("OEMinfo", DH->OEMinfo);
618 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000619}
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000620
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000621template <class PEHeader>
622void COFFDumper::printPEHeader(const PEHeader *Hdr) {
623 DictScope D(W, "ImageOptionalHeader");
624 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
625 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
626 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
627 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
628 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
629 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
630 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
631 printBaseOfDataField(Hdr);
632 W.printHex ("ImageBase", Hdr->ImageBase);
633 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
634 W.printNumber("FileAlignment", Hdr->FileAlignment);
635 W.printNumber("MajorOperatingSystemVersion",
636 Hdr->MajorOperatingSystemVersion);
637 W.printNumber("MinorOperatingSystemVersion",
638 Hdr->MinorOperatingSystemVersion);
639 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
640 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
641 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
642 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
643 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
644 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
645 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
David Majnemer774aadf2014-11-18 02:45:28 +0000646 W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000647 makeArrayRef(PEDLLCharacteristics));
648 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
649 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
650 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
651 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
652 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000653
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000654 if (Hdr->NumberOfRvaAndSize > 0) {
655 DictScope D(W, "DataDirectory");
656 static const char * const directory[] = {
657 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
658 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
659 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
660 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
661 };
662
Reid Kleckner2da433e2016-06-02 17:10:43 +0000663 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i)
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000664 printDataDirectory(i, directory[i]);
Reid Kleckner2da433e2016-06-02 17:10:43 +0000665 }
666}
667
668void COFFDumper::printCOFFDebugDirectory() {
669 ListScope LS(W, "DebugDirectory");
670 for (const debug_directory &D : Obj->debug_directories()) {
671 char FormattedTime[20] = {};
672 time_t TDS = D.TimeDateStamp;
673 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
674 DictScope S(W, "DebugEntry");
675 W.printHex("Characteristics", D.Characteristics);
676 W.printHex("TimeDateStamp", FormattedTime, D.TimeDateStamp);
677 W.printHex("MajorVersion", D.MajorVersion);
678 W.printHex("MinorVersion", D.MinorVersion);
679 W.printEnum("Type", D.Type, makeArrayRef(ImageDebugType));
680 W.printHex("SizeOfData", D.SizeOfData);
681 W.printHex("AddressOfRawData", D.AddressOfRawData);
682 W.printHex("PointerToRawData", D.PointerToRawData);
683 if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW) {
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000684 const codeview::DebugInfo *DebugInfo;
Reid Kleckner2da433e2016-06-02 17:10:43 +0000685 StringRef PDBFileName;
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000686 error(Obj->getDebugPDBInfo(&D, DebugInfo, PDBFileName));
Reid Kleckner2da433e2016-06-02 17:10:43 +0000687 DictScope PDBScope(W, "PDBInfo");
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000688 W.printHex("PDBSignature", DebugInfo->Signature.CVSignature);
689 if (DebugInfo->Signature.CVSignature == OMF::Signature::PDB70) {
690 W.printBinary("PDBGUID", makeArrayRef(DebugInfo->PDB70.Signature));
691 W.printNumber("PDBAge", DebugInfo->PDB70.Age);
692 W.printString("PDBFileName", PDBFileName);
693 }
Reid Kleckner2da433e2016-06-02 17:10:43 +0000694 } else {
695 // FIXME: Type values of 12 and 13 are commonly observed but are not in
696 // the documented type enum. Figure out what they mean.
697 ArrayRef<uint8_t> RawData;
698 error(
699 Obj->getRvaAndSizeAsBytes(D.AddressOfRawData, D.SizeOfData, RawData));
700 W.printBinaryBlock("RawData", RawData);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000701 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000702 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000703}
704
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000705void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
706 W.printHex("BaseOfData", Hdr->BaseOfData);
707}
708
709void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
710
Reid Kleckner83ebad32015-12-16 18:28:12 +0000711void COFFDumper::printCodeViewDebugInfo() {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000712 // Print types first to build CVUDTNames, then print symbols.
Reid Kleckner83ebad32015-12-16 18:28:12 +0000713 for (const SectionRef &S : Obj->sections()) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000714 StringRef SectionName;
715 error(S.getName(SectionName));
716 if (SectionName == ".debug$T")
717 printCodeViewTypeSection(SectionName, S);
718 }
719 for (const SectionRef &S : Obj->sections()) {
720 StringRef SectionName;
721 error(S.getName(SectionName));
722 if (SectionName == ".debug$S")
723 printCodeViewSymbolSection(SectionName, S);
Reid Kleckner83ebad32015-12-16 18:28:12 +0000724 }
725}
726
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000727void COFFDumper::initializeFileAndStringTables(StringRef Data) {
728 while (!Data.empty() && (CVFileChecksumTable.data() == nullptr ||
729 CVStringTable.data() == nullptr)) {
730 // The section consists of a number of subsection in the following format:
731 // |SubSectionType|SubSectionSize|Contents...|
732 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000733 error(consume(Data, SubType));
734 error(consume(Data, SubSectionSize));
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000735 if (SubSectionSize > Data.size())
736 return error(object_error::parse_failed);
Zachary Turner67c56012017-04-27 16:11:19 +0000737 switch (ModuleDebugFragmentKind(SubType)) {
738 case ModuleDebugFragmentKind::FileChecksums:
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000739 CVFileChecksumTable = Data.substr(0, SubSectionSize);
740 break;
Zachary Turner67c56012017-04-27 16:11:19 +0000741 case ModuleDebugFragmentKind::StringTable:
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000742 CVStringTable = Data.substr(0, SubSectionSize);
743 break;
744 default:
745 break;
746 }
David Majnemerefaaf412016-05-28 20:04:48 +0000747 uint32_t PaddedSize = alignTo(SubSectionSize, 4);
748 if (PaddedSize > Data.size())
749 error(object_error::parse_failed);
750 Data = Data.drop_front(PaddedSize);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000751 }
752}
753
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000754void COFFDumper::printCodeViewSymbolSection(StringRef SectionName,
755 const SectionRef &Section) {
756 StringRef SectionContents;
757 error(Section.getContents(SectionContents));
758 StringRef Data = SectionContents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000759
760 SmallVector<StringRef, 10> FunctionNames;
761 StringMap<StringRef> FunctionLineTables;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000762
Zachary Turner99f02152015-02-18 19:32:05 +0000763 ListScope D(W, "CodeViewDebugInfo");
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000764 // Print the section to allow correlation with printSections.
765 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000766
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000767 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000768 error(consume(Data, Magic));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000769 W.printHex("Magic", Magic);
770 if (Magic != COFF::DEBUG_SECTION_MAGIC)
771 return error(object_error::parse_failed);
772
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000773 initializeFileAndStringTables(Data);
774
Zachary Turnera96cce62016-06-03 03:25:59 +0000775 // TODO: Convert this over to using ModuleSubstreamVisitor.
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000776 while (!Data.empty()) {
777 // The section consists of a number of subsection in the following format:
778 // |SubSectionType|SubSectionSize|Contents...|
779 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000780 error(consume(Data, SubType));
781 error(consume(Data, SubSectionSize));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000782
783 ListScope S(W, "Subsection");
784 W.printEnum("SubSectionType", SubType, makeArrayRef(SubSectionTypes));
785 W.printHex("SubSectionSize", SubSectionSize);
786
787 // Get the contents of the subsection.
788 if (SubSectionSize > Data.size())
789 return error(object_error::parse_failed);
790 StringRef Contents = Data.substr(0, SubSectionSize);
791
792 // Add SubSectionSize to the current offset and align that offset to find
793 // the next subsection.
794 size_t SectionOffset = Data.data() - SectionContents.data();
795 size_t NextOffset = SectionOffset + SubSectionSize;
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000796 NextOffset = alignTo(NextOffset, 4);
David Majnemercab2b462016-05-28 20:04:50 +0000797 if (NextOffset > SectionContents.size())
798 return error(object_error::parse_failed);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000799 Data = SectionContents.drop_front(NextOffset);
800
801 // Optionally print the subsection bytes in case our parsing gets confused
802 // later.
803 if (opts::CodeViewSubsectionBytes)
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000804 printBinaryBlockWithRelocs("SubSectionContents", Section, SectionContents,
805 Contents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000806
Zachary Turner67c56012017-04-27 16:11:19 +0000807 switch (ModuleDebugFragmentKind(SubType)) {
808 case ModuleDebugFragmentKind::Symbols:
Reid Kleckner2893fd12016-01-14 17:51:54 +0000809 printCodeViewSymbolsSubsection(Contents, Section, SectionContents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000810 break;
Reid Klecknere9ab3492016-01-14 19:20:17 +0000811
Zachary Turner67c56012017-04-27 16:11:19 +0000812 case ModuleDebugFragmentKind::InlineeLines:
Reid Klecknere9ab3492016-01-14 19:20:17 +0000813 printCodeViewInlineeLines(Contents);
814 break;
815
Zachary Turner67c56012017-04-27 16:11:19 +0000816 case ModuleDebugFragmentKind::FileChecksums:
Reid Klecknerc31f5302016-01-15 18:06:25 +0000817 printCodeViewFileChecksums(Contents);
818 break;
819
Zachary Turner67c56012017-04-27 16:11:19 +0000820 case ModuleDebugFragmentKind::Lines: {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000821 // Holds a PC to file:line table. Some data to parse this subsection is
822 // stored in the other subsections, so just check sanity and store the
823 // pointers for deferred processing.
824
825 if (SubSectionSize < 12) {
826 // There should be at least three words to store two function
827 // relocations and size of the code.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000828 error(object_error::parse_failed);
829 return;
830 }
831
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000832 StringRef LinkageName;
833 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset,
834 LinkageName));
835 W.printString("LinkageName", LinkageName);
836 if (FunctionLineTables.count(LinkageName) != 0) {
837 // Saw debug info for this function already?
838 error(object_error::parse_failed);
839 return;
Zachary Turner99f02152015-02-18 19:32:05 +0000840 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000841
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000842 FunctionLineTables[LinkageName] = Contents;
843 FunctionNames.push_back(LinkageName);
844 break;
845 }
Zachary Turner67c56012017-04-27 16:11:19 +0000846 case ModuleDebugFragmentKind::FrameData: {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000847 // First four bytes is a relocation against the function.
Zachary Turner695ed562017-02-28 00:04:07 +0000848 BinaryByteStream S(Contents, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +0000849 BinaryStreamReader SR(S);
NAKAMURA Takumi05a75e42017-02-25 17:04:23 +0000850 const uint32_t *CodePtr;
851 error(SR.readObject(CodePtr));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000852 StringRef LinkageName;
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000853 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionContents,
NAKAMURA Takumi05a75e42017-02-25 17:04:23 +0000854 CodePtr, LinkageName));
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000855 W.printString("LinkageName", LinkageName);
856
857 // To find the active frame description, search this array for the
858 // smallest PC range that includes the current PC.
Zachary Turner4d49eb92016-10-20 18:31:19 +0000859 while (!SR.empty()) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000860 const FrameData *FD;
Zachary Turner4d49eb92016-10-20 18:31:19 +0000861 error(SR.readObject(FD));
David Majnemera6d93fd2016-05-28 19:45:49 +0000862
863 if (FD->FrameFunc >= CVStringTable.size())
864 error(object_error::parse_failed);
865
866 StringRef FrameFunc =
867 CVStringTable.drop_front(FD->FrameFunc).split('\0').first;
868
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000869 DictScope S(W, "FrameData");
870 W.printHex("RvaStart", FD->RvaStart);
871 W.printHex("CodeSize", FD->CodeSize);
872 W.printHex("LocalSize", FD->LocalSize);
873 W.printHex("ParamsSize", FD->ParamsSize);
874 W.printHex("MaxStackSize", FD->MaxStackSize);
David Majnemera6d93fd2016-05-28 19:45:49 +0000875 W.printString("FrameFunc", FrameFunc);
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000876 W.printHex("PrologSize", FD->PrologSize);
877 W.printHex("SavedRegsSize", FD->SavedRegsSize);
878 W.printFlags("Flags", FD->Flags, makeArrayRef(FrameDataFlags));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000879 }
880 break;
881 }
882
883 // Do nothing for unrecognized subsections.
884 default:
885 break;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000886 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000887 W.flush();
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000888 }
889
890 // Dump the line tables now that we've read all the subsections and know all
891 // the required information.
892 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
893 StringRef Name = FunctionNames[I];
894 ListScope S(W, "FunctionLineTable");
Reid Kleckner7c0c0c02015-12-15 01:23:55 +0000895 W.printString("LinkageName", Name);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000896
Zachary Turner05bd9f32017-04-28 23:41:36 +0000897 BinaryByteStream LineTableInfo(FunctionLineTables[Name], support::little);
898 BinaryStreamReader Reader(LineTableInfo);
David Majnemer0373d532015-07-09 18:14:31 +0000899
Zachary Turner7cc13e52017-05-01 16:46:39 +0000900 ModuleDebugLineFragmentRef LineInfo;
Zachary Turner05bd9f32017-04-28 23:41:36 +0000901 error(LineInfo.initialize(Reader));
David Majnemer04948362016-01-13 01:05:16 +0000902
Zachary Turner05bd9f32017-04-28 23:41:36 +0000903 W.printHex("Flags", LineInfo.header()->Flags);
904 W.printHex("CodeSize", LineInfo.header()->CodeSize);
905 for (const auto &Entry : LineInfo) {
Justin Bognera1413db2015-07-09 04:27:36 +0000906
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000907 ListScope S(W, "FilenameSegment");
Zachary Turner05bd9f32017-04-28 23:41:36 +0000908 printFileNameForOffset("Filename", Entry.NameIndex);
Zachary Turner4346ae12017-04-29 00:03:32 +0000909 uint32_t ColumnIndex = 0;
Zachary Turner05bd9f32017-04-28 23:41:36 +0000910 for (const auto &Line : Entry.LineNumbers) {
911 if (Line.Offset >= LineInfo.header()->CodeSize) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000912 error(object_error::parse_failed);
913 return;
914 }
Zachary Turner05bd9f32017-04-28 23:41:36 +0000915
916 std::string PC = formatv("+{0:X}", uint32_t(Line.Offset));
917 ListScope PCScope(W, PC);
918 codeview::LineInfo LI(Line.Flags);
919
David Majnemera4859df2016-02-04 17:57:12 +0000920 if (LI.isAlwaysStepInto())
921 W.printString("StepInto", StringRef("Always"));
922 else if (LI.isNeverStepInto())
923 W.printString("StepInto", StringRef("Never"));
924 else
925 W.printNumber("LineNumberStart", LI.getStartLine());
926 W.printNumber("LineNumberEndDelta", LI.getLineDelta());
927 W.printBoolean("IsStatement", LI.isStatement());
Zachary Turner5b6e4e02017-04-29 01:13:21 +0000928 if (LineInfo.hasColumnInfo()) {
Zachary Turner4346ae12017-04-29 00:03:32 +0000929 W.printNumber("ColStart", Entry.Columns[ColumnIndex].StartColumn);
930 W.printNumber("ColEnd", Entry.Columns[ColumnIndex].EndColumn);
931 ++ColumnIndex;
David Majnemer04948362016-01-13 01:05:16 +0000932 }
933 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000934 }
935 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000936}
937
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000938void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
939 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000940 StringRef SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000941 ArrayRef<uint8_t> BinaryData(Subsection.bytes_begin(),
942 Subsection.bytes_end());
943 auto CODD = llvm::make_unique<COFFObjectDumpDelegate>(*this, Section, Obj,
944 SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000945
Zachary Turner629cb7d2017-01-11 23:24:22 +0000946 CVSymbolDumper CVSD(W, TypeDB, std::move(CODD),
947 opts::CodeViewSubsectionBytes);
Zachary Turner695ed562017-02-28 00:04:07 +0000948 BinaryByteStream Stream(BinaryData, llvm::support::little);
Zachary Turner0d43c1c2016-05-28 05:21:57 +0000949 CVSymbolArray Symbols;
Zachary Turner120faca2017-02-27 22:11:43 +0000950 BinaryStreamReader Reader(Stream);
Zachary Turner0d43c1c2016-05-28 05:21:57 +0000951 if (auto EC = Reader.readArray(Symbols, Reader.getLength())) {
952 consumeError(std::move(EC));
953 W.flush();
954 error(object_error::parse_failed);
955 }
Reid Kleckner2893fd12016-01-14 17:51:54 +0000956
Zachary Turner0d840742016-10-07 21:34:46 +0000957 if (auto EC = CVSD.dump(Symbols)) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000958 W.flush();
Zachary Turner0d840742016-10-07 21:34:46 +0000959 error(std::move(EC));
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000960 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000961 W.flush();
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000962}
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000963
Reid Klecknerc31f5302016-01-15 18:06:25 +0000964void COFFDumper::printCodeViewFileChecksums(StringRef Subsection) {
Zachary Turner695ed562017-02-28 00:04:07 +0000965 BinaryByteStream S(Subsection, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +0000966 BinaryStreamReader SR(S);
Zachary Turner7cc13e52017-05-01 16:46:39 +0000967 ModuleDebugFileChecksumFragmentRef Checksums;
Zachary Turnerc37cb0c2017-04-27 16:12:16 +0000968 error(Checksums.initialize(SR));
969
970 for (auto &FC : Checksums) {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000971 DictScope S(W, "FileChecksum");
Zachary Turnerc37cb0c2017-04-27 16:12:16 +0000972
973 if (FC.FileNameOffset >= CVStringTable.size())
Reid Klecknerc31f5302016-01-15 18:06:25 +0000974 error(object_error::parse_failed);
975 StringRef Filename =
Zachary Turnerc37cb0c2017-04-27 16:12:16 +0000976 CVStringTable.drop_front(FC.FileNameOffset).split('\0').first;
977 W.printHex("Filename", Filename, FC.FileNameOffset);
978 W.printHex("ChecksumSize", FC.Checksum.size());
979 W.printEnum("ChecksumKind", uint8_t(FC.Kind),
Reid Klecknerc31f5302016-01-15 18:06:25 +0000980 makeArrayRef(FileChecksumKindNames));
Zachary Turnerc37cb0c2017-04-27 16:12:16 +0000981
982 W.printBinary("ChecksumBytes", FC.Checksum);
Reid Klecknerc31f5302016-01-15 18:06:25 +0000983 }
984}
985
Reid Klecknere9ab3492016-01-14 19:20:17 +0000986void COFFDumper::printCodeViewInlineeLines(StringRef Subsection) {
Zachary Turner695ed562017-02-28 00:04:07 +0000987 BinaryByteStream S(Subsection, llvm::support::little);
Zachary Turner120faca2017-02-27 22:11:43 +0000988 BinaryStreamReader SR(S);
Reid Klecknere9ab3492016-01-14 19:20:17 +0000989 uint32_t Signature;
Zachary Turner695ed562017-02-28 00:04:07 +0000990 error(SR.readInteger(Signature));
Reid Klecknere9ab3492016-01-14 19:20:17 +0000991 bool HasExtraFiles = Signature == unsigned(InlineeLinesSignature::ExtraFiles);
992
Zachary Turner4d49eb92016-10-20 18:31:19 +0000993 while (!SR.empty()) {
Reid Klecknere9ab3492016-01-14 19:20:17 +0000994 const InlineeSourceLine *ISL;
Zachary Turner4d49eb92016-10-20 18:31:19 +0000995 error(SR.readObject(ISL));
Reid Klecknere9ab3492016-01-14 19:20:17 +0000996 DictScope S(W, "InlineeSourceLine");
997 printTypeIndex("Inlinee", ISL->Inlinee);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000998 printFileNameForOffset("FileID", ISL->FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +0000999 W.printNumber("SourceLineNum", ISL->SourceLineNum);
1000
1001 if (HasExtraFiles) {
1002 uint32_t ExtraFileCount;
Zachary Turner695ed562017-02-28 00:04:07 +00001003 error(SR.readInteger(ExtraFileCount));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001004 W.printNumber("ExtraFileCount", ExtraFileCount);
1005 ListScope ExtraFiles(W, "ExtraFiles");
1006 for (unsigned I = 0; I < ExtraFileCount; ++I) {
1007 uint32_t FileID;
Zachary Turner695ed562017-02-28 00:04:07 +00001008 error(SR.readInteger(FileID));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001009 printFileNameForOffset("FileID", FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001010 }
1011 }
1012 }
1013}
1014
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001015StringRef COFFDumper::getFileNameForFileOffset(uint32_t FileOffset) {
1016 // The file checksum subsection should precede all references to it.
1017 if (!CVFileChecksumTable.data() || !CVStringTable.data())
1018 error(object_error::parse_failed);
1019 // Check if the file checksum table offset is valid.
1020 if (FileOffset >= CVFileChecksumTable.size())
1021 error(object_error::parse_failed);
1022
1023 // The string table offset comes first before the file checksum.
1024 StringRef Data = CVFileChecksumTable.drop_front(FileOffset);
1025 uint32_t StringOffset;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001026 error(consume(Data, StringOffset));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001027
1028 // Check if the string table offset is valid.
1029 if (StringOffset >= CVStringTable.size())
1030 error(object_error::parse_failed);
1031
1032 // Return the null-terminated string.
1033 return CVStringTable.drop_front(StringOffset).split('\0').first;
1034}
1035
1036void COFFDumper::printFileNameForOffset(StringRef Label, uint32_t FileOffset) {
1037 W.printHex(Label, getFileNameForFileOffset(FileOffset), FileOffset);
1038}
1039
Reid Kleckner5d577522017-03-24 17:26:38 +00001040void COFFDumper::mergeCodeViewTypes(TypeTableBuilder &CVIDs,
1041 TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001042 for (const SectionRef &S : Obj->sections()) {
1043 StringRef SectionName;
1044 error(S.getName(SectionName));
1045 if (SectionName == ".debug$T") {
1046 StringRef Data;
1047 error(S.getContents(Data));
David Majnemer78b0d722016-05-28 19:17:48 +00001048 uint32_t Magic;
1049 error(consume(Data, Magic));
Reid Kleckner0b269742016-05-14 00:02:53 +00001050 if (Magic != 4)
1051 error(object_error::parse_failed);
Reid Kleckner0b269742016-05-14 00:02:53 +00001052 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(Data.data()),
1053 Data.size());
Zachary Turner695ed562017-02-28 00:04:07 +00001054 BinaryByteStream Stream(Bytes, llvm::support::little);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001055 CVTypeArray Types;
Zachary Turner120faca2017-02-27 22:11:43 +00001056 BinaryStreamReader Reader(Stream);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001057 if (auto EC = Reader.readArray(Types, Reader.getLength())) {
1058 consumeError(std::move(EC));
1059 W.flush();
1060 error(object_error::parse_failed);
1061 }
1062
Reid Klecknerc4b5d792017-04-03 23:58:15 +00001063 if (auto EC = mergeTypeStreams(CVIDs, CVTypes, nullptr, Types))
1064 return error(std::move(EC));
Reid Kleckner0b269742016-05-14 00:02:53 +00001065 }
1066 }
1067}
1068
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001069void COFFDumper::printCodeViewTypeSection(StringRef SectionName,
1070 const SectionRef &Section) {
1071 ListScope D(W, "CodeViewTypes");
1072 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Adrian McCarthy963a3312016-05-02 23:45:03 +00001073
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001074 StringRef Data;
1075 error(Section.getContents(Data));
Reid Klecknerb2bd2812016-05-02 18:10:00 +00001076 if (opts::CodeViewSubsectionBytes)
1077 W.printBinaryBlock("Data", Data);
Reid Kleckner7960de92016-05-04 19:39:28 +00001078
1079 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001080 error(consume(Data, Magic));
Reid Kleckner7960de92016-05-04 19:39:28 +00001081 W.printHex("Magic", Magic);
1082 if (Magic != COFF::DEBUG_SECTION_MAGIC)
1083 return error(object_error::parse_failed);
1084
Zachary Turner629cb7d2017-01-11 23:24:22 +00001085 CVTypeDumper CVTD(TypeDB);
1086 TypeDumpVisitor TDV(TypeDB, &W, opts::CodeViewSubsectionBytes);
1087 if (auto EC = CVTD.dump({Data.bytes_begin(), Data.bytes_end()}, TDV)) {
Reid Kleckner4a14bca2016-05-05 00:34:33 +00001088 W.flush();
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001089 error(llvm::errorToErrorCode(std::move(EC)));
Reid Kleckner7960de92016-05-04 19:39:28 +00001090 }
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001091}
1092
Eric Christopher9cad53c2013-04-03 18:31:38 +00001093void COFFDumper::printSections() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001094 ListScope SectionsD(W, "Sections");
1095 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001096 for (const SectionRef &Sec : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001097 ++SectionNumber;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001098 const coff_section *Section = Obj->getCOFFSection(Sec);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001099
1100 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001101 error(Sec.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001102
1103 DictScope D(W, "Section");
1104 W.printNumber("Number", SectionNumber);
1105 W.printBinary("Name", Name, Section->Name);
1106 W.printHex ("VirtualSize", Section->VirtualSize);
1107 W.printHex ("VirtualAddress", Section->VirtualAddress);
1108 W.printNumber("RawDataSize", Section->SizeOfRawData);
1109 W.printHex ("PointerToRawData", Section->PointerToRawData);
1110 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
1111 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
1112 W.printNumber("RelocationCount", Section->NumberOfRelocations);
1113 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
1114 W.printFlags ("Characteristics", Section->Characteristics,
1115 makeArrayRef(ImageSectionCharacteristics),
1116 COFF::SectionCharacteristics(0x00F00000));
1117
1118 if (opts::SectionRelocations) {
1119 ListScope D(W, "Relocations");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001120 for (const RelocationRef &Reloc : Sec.relocations())
1121 printRelocation(Sec, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001122 }
1123
1124 if (opts::SectionSymbols) {
1125 ListScope D(W, "Symbols");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001126 for (const SymbolRef &Symbol : Obj->symbols()) {
Rafael Espindola80291272014-10-08 15:28:58 +00001127 if (!Sec.containsSymbol(Symbol))
Eric Christopher9cad53c2013-04-03 18:31:38 +00001128 continue;
1129
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001130 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001131 }
1132 }
1133
David Majnemerdac39852014-09-26 22:32:16 +00001134 if (opts::SectionData &&
1135 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001136 StringRef Data;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001137 error(Sec.getContents(Data));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001138
1139 W.printBinaryBlock("SectionData", Data);
1140 }
1141 }
1142}
1143
1144void COFFDumper::printRelocations() {
1145 ListScope D(W, "Relocations");
1146
Eric Christopher9cad53c2013-04-03 18:31:38 +00001147 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001148 for (const SectionRef &Section : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001149 ++SectionNumber;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001150 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001151 error(Section.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001152
1153 bool PrintedGroup = false;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001154 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001155 if (!PrintedGroup) {
1156 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
1157 W.indent();
1158 PrintedGroup = true;
1159 }
1160
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001161 printRelocation(Section, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001162 }
1163
1164 if (PrintedGroup) {
1165 W.unindent();
1166 W.startLine() << "}\n";
1167 }
1168 }
1169}
1170
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001171void COFFDumper::printRelocation(const SectionRef &Section,
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00001172 const RelocationRef &Reloc, uint64_t Bias) {
1173 uint64_t Offset = Reloc.getOffset() - Bias;
Rafael Espindola99c041b2015-06-30 01:53:01 +00001174 uint64_t RelocType = Reloc.getType();
Eric Christopher9cad53c2013-04-03 18:31:38 +00001175 SmallString<32> RelocName;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001176 StringRef SymbolName;
Rafael Espindola41bb4322015-06-30 04:08:37 +00001177 Reloc.getTypeName(RelocName);
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001178 symbol_iterator Symbol = Reloc.getSymbol();
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001179 if (Symbol != Obj->symbol_end()) {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001180 Expected<StringRef> SymbolNameOrErr = Symbol->getName();
1181 error(errorToErrorCode(SymbolNameOrErr.takeError()));
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001182 SymbolName = *SymbolNameOrErr;
1183 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001184
Nico Rieckf3f0b792013-04-12 04:01:52 +00001185 if (opts::ExpandRelocs) {
1186 DictScope Group(W, "Relocation");
1187 W.printHex("Offset", Offset);
1188 W.printNumber("Type", RelocName, RelocType);
David Majnemer1f80b0a2014-11-13 07:42:11 +00001189 W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName);
Nico Rieckf3f0b792013-04-12 04:01:52 +00001190 } else {
1191 raw_ostream& OS = W.startLine();
1192 OS << W.hex(Offset)
1193 << " " << RelocName
David Majnemer1f80b0a2014-11-13 07:42:11 +00001194 << " " << (SymbolName.empty() ? "-" : SymbolName)
Nico Rieckf3f0b792013-04-12 04:01:52 +00001195 << "\n";
1196 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001197}
1198
1199void COFFDumper::printSymbols() {
1200 ListScope Group(W, "Symbols");
1201
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001202 for (const SymbolRef &Symbol : Obj->symbols())
1203 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001204}
1205
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001206void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001207
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001208static ErrorOr<StringRef>
David Majnemer236b0ca2014-11-17 11:17:17 +00001209getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber,
1210 const coff_section *Section) {
David Majnemerf4dc4562014-09-20 00:25:06 +00001211 if (Section) {
1212 StringRef SectionName;
David Majnemer236b0ca2014-11-17 11:17:17 +00001213 if (std::error_code EC = Obj->getSectionName(Section, SectionName))
1214 return EC;
David Majnemerf4dc4562014-09-20 00:25:06 +00001215 return SectionName;
1216 }
David Majnemerf4dc4562014-09-20 00:25:06 +00001217 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
David Majnemer236b0ca2014-11-17 11:17:17 +00001218 return StringRef("IMAGE_SYM_DEBUG");
David Majnemerf4dc4562014-09-20 00:25:06 +00001219 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
David Majnemer236b0ca2014-11-17 11:17:17 +00001220 return StringRef("IMAGE_SYM_ABSOLUTE");
David Majnemerf4dc4562014-09-20 00:25:06 +00001221 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
David Majnemer236b0ca2014-11-17 11:17:17 +00001222 return StringRef("IMAGE_SYM_UNDEFINED");
1223 return StringRef("");
David Majnemerf4dc4562014-09-20 00:25:06 +00001224}
1225
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001226void COFFDumper::printSymbol(const SymbolRef &Sym) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001227 DictScope D(W, "Symbol");
1228
David Majnemer44f51e52014-09-10 12:51:52 +00001229 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001230 const coff_section *Section;
David Majnemer44f51e52014-09-10 12:51:52 +00001231 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001232 W.startLine() << "Invalid section number: " << EC.message() << "\n";
1233 W.flush();
1234 return;
1235 }
1236
1237 StringRef SymbolName;
1238 if (Obj->getSymbolName(Symbol, SymbolName))
1239 SymbolName = "";
1240
David Majnemer236b0ca2014-11-17 11:17:17 +00001241 StringRef SectionName = "";
1242 ErrorOr<StringRef> Res =
1243 getSectionName(Obj, Symbol.getSectionNumber(), Section);
1244 if (Res)
1245 SectionName = *Res;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001246
1247 W.printString("Name", SymbolName);
David Majnemer44f51e52014-09-10 12:51:52 +00001248 W.printNumber("Value", Symbol.getValue());
1249 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
1250 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
1251 W.printEnum ("ComplexType", Symbol.getComplexType(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001252 makeArrayRef(ImageSymDType));
David Majnemer44f51e52014-09-10 12:51:52 +00001253 W.printEnum ("StorageClass", Symbol.getStorageClass(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001254 makeArrayRef(ImageSymClass));
David Majnemer44f51e52014-09-10 12:51:52 +00001255 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
Eric Christopher9cad53c2013-04-03 18:31:38 +00001256
David Majnemer44f51e52014-09-10 12:51:52 +00001257 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
1258 if (Symbol.isFunctionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001259 const coff_aux_function_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001260 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001261
1262 DictScope AS(W, "AuxFunctionDef");
1263 W.printNumber("TagIndex", Aux->TagIndex);
1264 W.printNumber("TotalSize", Aux->TotalSize);
David Majnemerf3a2af52014-03-19 04:33:27 +00001265 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001266 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001267
David Majnemerc7d7c6f2014-10-31 05:07:00 +00001268 } else if (Symbol.isAnyUndefined()) {
David Majnemerf3a2af52014-03-19 04:33:27 +00001269 const coff_aux_weak_external *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001270 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001271
David Majnemer44f51e52014-09-10 12:51:52 +00001272 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001273 StringRef LinkedName;
David Majnemer44f51e52014-09-10 12:51:52 +00001274 std::error_code EC = Linked.getError();
1275 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001276 LinkedName = "";
1277 error(EC);
1278 }
1279
1280 DictScope AS(W, "AuxWeakExternal");
1281 W.printNumber("Linked", LinkedName, Aux->TagIndex);
1282 W.printEnum ("Search", Aux->Characteristics,
1283 makeArrayRef(WeakExternalCharacteristics));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001284
David Majnemer44f51e52014-09-10 12:51:52 +00001285 } else if (Symbol.isFileRecord()) {
1286 const char *FileName;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001287 error(getSymbolAuxData(Obj, Symbol, I, FileName));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001288
Nico Rieck0ab8e602013-04-22 08:35:11 +00001289 DictScope AS(W, "AuxFileRecord");
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001290
David Majnemer44f51e52014-09-10 12:51:52 +00001291 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
1292 Obj->getSymbolTableEntrySize());
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001293 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
Saleem Abdulrasool3b5e0012014-04-16 04:15:29 +00001294 break;
David Majnemer44f51e52014-09-10 12:51:52 +00001295 } else if (Symbol.isSectionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001296 const coff_aux_section_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001297 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001298
David Majnemer4d571592014-09-15 19:42:42 +00001299 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
1300
Eric Christopher9cad53c2013-04-03 18:31:38 +00001301 DictScope AS(W, "AuxSectionDef");
1302 W.printNumber("Length", Aux->Length);
1303 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
1304 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
1305 W.printHex("Checksum", Aux->CheckSum);
David Majnemer4d571592014-09-15 19:42:42 +00001306 W.printNumber("Number", AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001307 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001308
Nico Riecka711dee2013-04-22 08:34:59 +00001309 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
Eric Christopher9cad53c2013-04-03 18:31:38 +00001310 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
1311 const coff_section *Assoc;
David Majnemer236b0ca2014-11-17 11:17:17 +00001312 StringRef AssocName = "";
1313 std::error_code EC = Obj->getSection(AuxNumber, Assoc);
1314 ErrorOr<StringRef> Res = getSectionName(Obj, AuxNumber, Assoc);
1315 if (Res)
1316 AssocName = *Res;
1317 if (!EC)
1318 EC = Res.getError();
1319 if (EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001320 AssocName = "";
1321 error(EC);
1322 }
1323
David Majnemer4d571592014-09-15 19:42:42 +00001324 W.printNumber("AssocSection", AssocName, AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001325 }
David Majnemer44f51e52014-09-10 12:51:52 +00001326 } else if (Symbol.isCLRToken()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001327 const coff_aux_clr_token *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001328 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001329
David Majnemer44f51e52014-09-10 12:51:52 +00001330 ErrorOr<COFFSymbolRef> ReferredSym =
1331 Obj->getSymbol(Aux->SymbolTableIndex);
Nico Rieck8678acd2014-03-17 01:46:52 +00001332 StringRef ReferredName;
David Majnemer44f51e52014-09-10 12:51:52 +00001333 std::error_code EC = ReferredSym.getError();
1334 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
Nico Rieck8678acd2014-03-17 01:46:52 +00001335 ReferredName = "";
1336 error(EC);
1337 }
1338
Eric Christopher9cad53c2013-04-03 18:31:38 +00001339 DictScope AS(W, "AuxCLRToken");
1340 W.printNumber("AuxType", Aux->AuxType);
1341 W.printNumber("Reserved", Aux->Reserved);
Nico Rieck8678acd2014-03-17 01:46:52 +00001342 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001343
1344 } else {
1345 W.startLine() << "<unhandled auxiliary record>\n";
1346 }
1347 }
1348}
1349
1350void COFFDumper::printUnwindInfo() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001351 ListScope D(W, "UnwindInformation");
David Majnemer44f51e52014-09-10 12:51:52 +00001352 switch (Obj->getMachine()) {
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001353 case COFF::IMAGE_FILE_MACHINE_AMD64: {
1354 Win64EH::Dumper Dumper(W);
Rafael Espindola4453e42942014-06-13 03:07:50 +00001355 Win64EH::Dumper::SymbolResolver
1356 Resolver = [](const object::coff_section *Section, uint64_t Offset,
1357 SymbolRef &Symbol, void *user_data) -> std::error_code {
1358 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
1359 return Dumper->resolveSymbol(Section, Offset, Symbol);
1360 };
Saleem Abdulrasool65dbbb52014-05-25 21:37:59 +00001361 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001362 Dumper.printData(Ctx);
1363 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001364 }
Saleem Abdulrasoole6971ca2014-06-04 15:47:15 +00001365 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
1366 ARM::WinEH::Decoder Decoder(W);
1367 Decoder.dumpProcedureData(*Obj);
1368 break;
1369 }
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001370 default:
David Majnemer44f51e52014-09-10 12:51:52 +00001371 W.printEnum("unsupported Image Machine", Obj->getMachine(),
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001372 makeArrayRef(ImageFileMachineType));
1373 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001374 }
1375}
1376
Rui Ueyama979fb402014-10-09 02:16:38 +00001377void COFFDumper::printImportedSymbols(
1378 iterator_range<imported_symbol_iterator> Range) {
1379 for (const ImportedSymbolRef &I : Range) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001380 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001381 error(I.getSymbolName(Sym));
Rui Ueyama15d99352014-10-03 00:41:58 +00001382 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001383 error(I.getOrdinal(Ordinal));
Rui Ueyama15d99352014-10-03 00:41:58 +00001384 W.printNumber("Symbol", Sym, Ordinal);
1385 }
1386}
1387
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001388void COFFDumper::printDelayImportedSymbols(
1389 const DelayImportDirectoryEntryRef &I,
1390 iterator_range<imported_symbol_iterator> Range) {
1391 int Index = 0;
1392 for (const ImportedSymbolRef &S : Range) {
1393 DictScope Import(W, "Import");
1394 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001395 error(S.getSymbolName(Sym));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001396 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001397 error(S.getOrdinal(Ordinal));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001398 W.printNumber("Symbol", Sym, Ordinal);
1399 uint64_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001400 error(I.getImportAddress(Index++, Addr));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001401 W.printHex("Address", Addr);
1402 }
1403}
1404
Rui Ueyama1e152d52014-10-02 17:02:18 +00001405void COFFDumper::printCOFFImports() {
Rui Ueyama15d99352014-10-03 00:41:58 +00001406 // Regular imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001407 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
Rui Ueyama1e152d52014-10-02 17:02:18 +00001408 DictScope Import(W, "Import");
1409 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001410 error(I.getName(Name));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001411 W.printString("Name", Name);
Shoaib Meenai73754482017-03-26 17:10:11 +00001412 uint32_t ILTAddr;
1413 error(I.getImportLookupTableRVA(ILTAddr));
1414 W.printHex("ImportLookupTableRVA", ILTAddr);
1415 uint32_t IATAddr;
1416 error(I.getImportAddressTableRVA(IATAddr));
1417 W.printHex("ImportAddressTableRVA", IATAddr);
1418 // The import lookup table can be missing with certain older linkers, so
1419 // fall back to the import address table in that case.
1420 if (ILTAddr)
1421 printImportedSymbols(I.lookup_table_symbols());
1422 else
1423 printImportedSymbols(I.imported_symbols());
Rui Ueyama15d99352014-10-03 00:41:58 +00001424 }
1425
1426 // Delay imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001427 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001428 DictScope Import(W, "DelayImport");
1429 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001430 error(I.getName(Name));
Rui Ueyama15d99352014-10-03 00:41:58 +00001431 W.printString("Name", Name);
Rui Ueyama1af08652014-10-03 18:07:18 +00001432 const delay_import_directory_table_entry *Table;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001433 error(I.getDelayImportTable(Table));
Rui Ueyama1af08652014-10-03 18:07:18 +00001434 W.printHex("Attributes", Table->Attributes);
1435 W.printHex("ModuleHandle", Table->ModuleHandle);
1436 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
1437 W.printHex("ImportNameTable", Table->DelayImportNameTable);
1438 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
1439 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001440 printDelayImportedSymbols(I, I.imported_symbols());
Rui Ueyama1e152d52014-10-02 17:02:18 +00001441 }
1442}
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001443
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001444void COFFDumper::printCOFFExports() {
1445 for (const ExportDirectoryEntryRef &E : Obj->export_directories()) {
1446 DictScope Export(W, "Export");
1447
1448 StringRef Name;
1449 uint32_t Ordinal, RVA;
1450
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001451 error(E.getSymbolName(Name));
1452 error(E.getOrdinal(Ordinal));
1453 error(E.getExportRVA(RVA));
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001454
1455 W.printNumber("Ordinal", Ordinal);
1456 W.printString("Name", Name);
1457 W.printHex("RVA", RVA);
1458 }
1459}
1460
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001461void COFFDumper::printCOFFDirectives() {
1462 for (const SectionRef &Section : Obj->sections()) {
1463 StringRef Contents;
1464 StringRef Name;
1465
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001466 error(Section.getName(Name));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001467 if (Name != ".drectve")
1468 continue;
1469
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001470 error(Section.getContents(Contents));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001471
1472 W.printString("Directive(s)", Contents);
1473 }
1474}
Rui Ueyama74e85132014-11-19 00:18:07 +00001475
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001476static StringRef getBaseRelocTypeName(uint8_t Type) {
Rui Ueyama74e85132014-11-19 00:18:07 +00001477 switch (Type) {
1478 case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";
1479 case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";
1480 case COFF::IMAGE_REL_BASED_LOW: return "LOW";
1481 case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";
1482 case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";
Saleem Abdulrasool5a41c372015-01-16 20:16:09 +00001483 case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)";
Rui Ueyama74e85132014-11-19 00:18:07 +00001484 case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";
Colin LeMahieu9fbffee2014-11-19 17:10:39 +00001485 default: return "unknown (" + llvm::utostr(Type) + ")";
Rui Ueyama74e85132014-11-19 00:18:07 +00001486 }
1487}
1488
1489void COFFDumper::printCOFFBaseReloc() {
1490 ListScope D(W, "BaseReloc");
1491 for (const BaseRelocRef &I : Obj->base_relocs()) {
1492 uint8_t Type;
1493 uint32_t RVA;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001494 error(I.getRVA(RVA));
1495 error(I.getType(Type));
Rui Ueyama74e85132014-11-19 00:18:07 +00001496 DictScope Import(W, "Entry");
1497 W.printString("Type", getBaseRelocTypeName(Type));
1498 W.printHex("Address", RVA);
1499 }
1500}
Lang Hames0000afd2015-06-26 23:56:53 +00001501
Zachary Turner8d6396d2017-04-27 19:38:38 +00001502void COFFDumper::printCOFFResources() {
1503 ListScope ResourcesD(W, "Resources");
1504 for (const SectionRef &S : Obj->sections()) {
1505 StringRef Name;
1506 error(S.getName(Name));
1507 if (!Name.startswith(".rsrc"))
1508 continue;
1509
1510 StringRef Ref;
1511 error(S.getContents(Ref));
1512
1513 if ((Name == ".rsrc") || (Name == ".rsrc$01")) {
1514 auto Table =
1515 reinterpret_cast<const coff_resource_dir_table *>(Ref.data());
1516 char FormattedTime[20];
1517 time_t TDS = time_t(Table->TimeDateStamp);
1518 strftime(FormattedTime, sizeof(FormattedTime), "%Y-%m-%d %H:%M:%S",
1519 gmtime(&TDS));
1520 W.printHex("Time/Date Stamp", FormattedTime, Table->TimeDateStamp);
1521 }
1522 W.printBinaryBlock(Name.str() + " Data", Ref);
1523 }
1524}
1525
Lang Hames0000afd2015-06-26 23:56:53 +00001526void COFFDumper::printStackMap() const {
1527 object::SectionRef StackMapSection;
1528 for (auto Sec : Obj->sections()) {
1529 StringRef Name;
1530 Sec.getName(Name);
1531 if (Name == ".llvm_stackmaps") {
1532 StackMapSection = Sec;
1533 break;
1534 }
1535 }
1536
1537 if (StackMapSection == object::SectionRef())
1538 return;
1539
1540 StringRef StackMapContents;
1541 StackMapSection.getContents(StackMapContents);
1542 ArrayRef<uint8_t> StackMapContentsArray(
1543 reinterpret_cast<const uint8_t*>(StackMapContents.data()),
1544 StackMapContents.size());
1545
1546 if (Obj->isLittleEndian())
1547 prettyPrintStackMap(
1548 llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001549 StackMapV2Parser<support::little>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001550 else
1551 prettyPrintStackMap(llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001552 StackMapV2Parser<support::big>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001553}
Reid Kleckner0b269742016-05-14 00:02:53 +00001554
Zachary Turner4efa0a42016-11-08 22:24:53 +00001555void llvm::dumpCodeViewMergedTypes(ScopedPrinter &Writer,
Reid Kleckner5d577522017-03-24 17:26:38 +00001556 llvm::codeview::TypeTableBuilder &IDTable,
Zachary Turner4efa0a42016-11-08 22:24:53 +00001557 llvm::codeview::TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001558 // Flatten it first, then run our dumper on it.
Reid Kleckner5d577522017-03-24 17:26:38 +00001559 SmallString<0> TypeBuf;
Zachary Turner4efa0a42016-11-08 22:24:53 +00001560 CVTypes.ForEachRecord([&](TypeIndex TI, ArrayRef<uint8_t> Record) {
Reid Kleckner5d577522017-03-24 17:26:38 +00001561 TypeBuf.append(Record.begin(), Record.end());
Reid Kleckner0b269742016-05-14 00:02:53 +00001562 });
Zachary Turner629cb7d2017-01-11 23:24:22 +00001563
1564 TypeDatabase TypeDB;
Reid Kleckner5d577522017-03-24 17:26:38 +00001565 {
1566 ListScope S(Writer, "MergedTypeStream");
1567 CVTypeDumper CVTD(TypeDB);
1568 TypeDumpVisitor TDV(TypeDB, &Writer, opts::CodeViewSubsectionBytes);
1569 if (auto EC = CVTD.dump(
1570 {TypeBuf.str().bytes_begin(), TypeBuf.str().bytes_end()}, TDV)) {
1571 Writer.flush();
Reid Klecknerc4b5d792017-04-03 23:58:15 +00001572 error(std::move(EC));
Reid Kleckner5d577522017-03-24 17:26:38 +00001573 }
1574 }
1575
1576 // Flatten the id stream and print it next. The ID stream refers to names from
1577 // the type stream.
1578 SmallString<0> IDBuf;
1579 IDTable.ForEachRecord([&](TypeIndex TI, ArrayRef<uint8_t> Record) {
1580 IDBuf.append(Record.begin(), Record.end());
1581 });
1582
1583 {
1584 ListScope S(Writer, "MergedIDStream");
1585 TypeDatabase IDDB;
1586 CVTypeDumper CVTD(IDDB);
1587 TypeDumpVisitor TDV(TypeDB, &Writer, opts::CodeViewSubsectionBytes);
1588 TDV.setItemDB(IDDB);
1589 if (auto EC = CVTD.dump(
1590 {IDBuf.str().bytes_begin(), IDBuf.str().bytes_end()}, TDV)) {
1591 Writer.flush();
Reid Klecknerc4b5d792017-04-03 23:58:15 +00001592 error(std::move(EC));
Reid Kleckner5d577522017-03-24 17:26:38 +00001593 }
Reid Kleckner0b269742016-05-14 00:02:53 +00001594 }
1595}