blob: 2b45d1de1434a1b968884dc5f91ffbef73906d93 [file] [log] [blame]
Eric Christopher9cad53c2013-04-03 18:31:38 +00001//===-- COFFDumper.cpp - COFF-specific dumper -------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11/// \brief This file implements the COFF-specific dumper for llvm-readobj.
12///
13//===----------------------------------------------------------------------===//
14
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000015#include "ARMWinEHPrinter.h"
Reid Kleckner72e2ba72016-01-13 19:32:35 +000016#include "CodeView.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000017#include "Error.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000018#include "ObjDumper.h"
Lang Hames0000afd2015-06-26 23:56:53 +000019#include "StackMapPrinter.h"
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +000020#include "Win64EHDumper.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000021#include "llvm-readobj.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000022#include "llvm/ADT/DenseMap.h"
23#include "llvm/ADT/SmallString.h"
Colin LeMahieu9fbffee2014-11-19 17:10:39 +000024#include "llvm/ADT/StringExtras.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000025#include "llvm/DebugInfo/CodeView/CodeView.h"
Reid Klecknere9ab3492016-01-14 19:20:17 +000026#include "llvm/DebugInfo/CodeView/Line.h"
Reid Kleckner0b269742016-05-14 00:02:53 +000027#include "llvm/DebugInfo/CodeView/MemoryTypeTableBuilder.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"
Reid Kleckner4a14bca2016-05-05 00:34:33 +000033#include "llvm/DebugInfo/CodeView/TypeDumper.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 Turnera3225b02016-07-29 20:56:36 +000037#include "llvm/DebugInfo/MSF/ByteStream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000038#include "llvm/Object/COFF.h"
39#include "llvm/Object/ObjectFile.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000040#include "llvm/Support/COFF.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000041#include "llvm/Support/Casting.h"
42#include "llvm/Support/Compiler.h"
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000043#include "llvm/Support/DataExtractor.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000044#include "llvm/Support/Format.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000045#include "llvm/Support/ScopedPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000046#include "llvm/Support/SourceMgr.h"
47#include "llvm/Support/Win64EH.h"
48#include "llvm/Support/raw_ostream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000049#include <algorithm>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000050#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000051#include <system_error>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000052#include <time.h>
Eric Christopher9cad53c2013-04-03 18:31:38 +000053
54using namespace llvm;
55using namespace llvm::object;
Reid Kleckner72e2ba72016-01-13 19:32:35 +000056using namespace llvm::codeview;
Zachary Turnerbac69d32016-07-22 19:56:05 +000057using namespace llvm::msf;
Reid Kleckner6b3faef2016-01-13 23:44:57 +000058using namespace llvm::support;
Eric Christopher9cad53c2013-04-03 18:31:38 +000059using namespace llvm::Win64EH;
60
61namespace {
62
63class COFFDumper : public ObjDumper {
64public:
Zachary Turneraaad5742016-05-23 23:41:13 +000065 friend class COFFObjectDumpDelegate;
Zachary Turner88bb1632016-05-03 00:28:04 +000066 COFFDumper(const llvm::object::COFFObjectFile *Obj, ScopedPrinter &Writer)
Reid Kleckner4a14bca2016-05-05 00:34:33 +000067 : ObjDumper(Writer), Obj(Obj),
Reid Klecknerfbdbe9e2016-05-31 18:45:36 +000068 CVTD(&Writer, opts::CodeViewSubsectionBytes) {}
Eric Christopher9cad53c2013-04-03 18:31:38 +000069
Craig Topperfd38cbe2014-08-30 16:48:34 +000070 void printFileHeaders() override;
71 void printSections() override;
72 void printRelocations() override;
73 void printSymbols() override;
74 void printDynamicSymbols() override;
75 void printUnwindInfo() override;
Rui Ueyama1e152d52014-10-02 17:02:18 +000076 void printCOFFImports() override;
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +000077 void printCOFFExports() override;
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +000078 void printCOFFDirectives() override;
Rui Ueyama74e85132014-11-19 00:18:07 +000079 void printCOFFBaseReloc() override;
Reid Kleckner2da433e2016-06-02 17:10:43 +000080 void printCOFFDebugDirectory() override;
Reid Kleckner83ebad32015-12-16 18:28:12 +000081 void printCodeViewDebugInfo() override;
Reid Kleckner0b269742016-05-14 00:02:53 +000082 void
83 mergeCodeViewTypes(llvm::codeview::MemoryTypeTableBuilder &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.
103 CVTD.printTypeIndex(FieldName, TI);
104 }
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
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000146 CVTypeDumper CVTD;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000147};
148
Zachary Turneraaad5742016-05-23 23:41:13 +0000149class COFFObjectDumpDelegate : public SymbolDumpDelegate {
150public:
151 COFFObjectDumpDelegate(COFFDumper &CD, const SectionRef &SR,
152 const COFFObjectFile *Obj, StringRef SectionContents)
Zachary Turner537014c2016-05-24 03:32:34 +0000153 : CD(CD), SR(SR), SectionContents(SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000154 Sec = Obj->getCOFFSection(SR);
155 }
156
157 uint32_t getRecordOffset(ArrayRef<uint8_t> Record) override {
158 return Record.data() - SectionContents.bytes_begin();
159 }
160
161 void printRelocatedField(StringRef Label, uint32_t RelocOffset,
162 uint32_t Offset, StringRef *RelocSym) override {
163 CD.printRelocatedField(Label, Sec, RelocOffset, Offset, RelocSym);
164 }
165
166 void printBinaryBlockWithRelocs(StringRef Label,
167 ArrayRef<uint8_t> Block) override {
168 StringRef SBlock(reinterpret_cast<const char *>(Block.data()),
169 Block.size());
170 if (opts::CodeViewSubsectionBytes)
171 CD.printBinaryBlockWithRelocs(Label, SR, SectionContents, SBlock);
172 }
173
174 StringRef getFileNameForFileOffset(uint32_t FileOffset) override {
175 return CD.getFileNameForFileOffset(FileOffset);
176 }
177
178 StringRef getStringTable() override { return CD.CVStringTable; }
179
180private:
181 COFFDumper &CD;
182 const SectionRef &SR;
Zachary Turneraaad5742016-05-23 23:41:13 +0000183 const coff_section *Sec;
184 StringRef SectionContents;
185};
186
Reid Kleckner4a14bca2016-05-05 00:34:33 +0000187} // end namespace
Eric Christopher9cad53c2013-04-03 18:31:38 +0000188
189namespace llvm {
190
Rafael Espindola4453e42942014-06-13 03:07:50 +0000191std::error_code createCOFFDumper(const object::ObjectFile *Obj,
Zachary Turner88bb1632016-05-03 00:28:04 +0000192 ScopedPrinter &Writer,
Rafael Espindola4453e42942014-06-13 03:07:50 +0000193 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000194 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
195 if (!COFFObj)
196 return readobj_error::unsupported_obj_file_format;
197
198 Result.reset(new COFFDumper(COFFObj, Writer));
199 return readobj_error::success;
200}
201
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000202} // namespace llvm
Eric Christopher9cad53c2013-04-03 18:31:38 +0000203
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000204// Given a a section and an offset into this section the function returns the
205// symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000206std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
207 uint64_t Offset, SymbolRef &Sym) {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000208 cacheRelocations();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000209 const auto &Relocations = RelocMap[Section];
David Majnemer61f17982016-05-29 06:18:08 +0000210 auto SymI = Obj->symbol_end();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000211 for (const auto &Relocation : Relocations) {
Rafael Espindola96d071c2015-06-29 23:29:12 +0000212 uint64_t RelocationOffset = Relocation.getOffset();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000213
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000214 if (RelocationOffset == Offset) {
David Majnemer61f17982016-05-29 06:18:08 +0000215 SymI = Relocation.getSymbol();
216 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000217 }
218 }
David Majnemer61f17982016-05-29 06:18:08 +0000219 if (SymI == Obj->symbol_end())
220 return readobj_error::unknown_symbol;
221 Sym = *SymI;
222 return readobj_error::success;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000223}
224
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000225// Given a section and an offset into this section the function returns the name
226// of the symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000227std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
228 uint64_t Offset,
229 StringRef &Name) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000230 SymbolRef Symbol;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000231 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000232 return EC;
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000233 Expected<StringRef> NameOrErr = Symbol.getName();
234 if (!NameOrErr)
235 return errorToErrorCode(NameOrErr.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000236 Name = *NameOrErr;
Rui Ueyama7d099192015-06-09 15:20:42 +0000237 return std::error_code();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000238}
239
Reid Kleckner2893fd12016-01-14 17:51:54 +0000240// Helper for when you have a pointer to real data and you want to know about
241// relocations against it.
242std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
243 StringRef SectionContents,
244 const void *RelocPtr,
245 StringRef &Name) {
246 assert(SectionContents.data() < RelocPtr &&
247 RelocPtr < SectionContents.data() + SectionContents.size() &&
248 "pointer to relocated object is not in section");
249 uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) -
250 SectionContents.data());
251 return resolveSymbolName(Section, Offset, Name);
252}
253
254void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000255 uint32_t RelocOffset, uint32_t Offset,
256 StringRef *RelocSym) {
257 StringRef SymStorage;
258 StringRef &Symbol = RelocSym ? *RelocSym : SymStorage;
259 if (!resolveSymbolName(Sec, RelocOffset, Symbol))
260 W.printSymbolOffset(Label, Symbol, Offset);
261 else
262 W.printHex(Label, RelocOffset);
263}
264
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000265void COFFDumper::printBinaryBlockWithRelocs(StringRef Label,
266 const SectionRef &Sec,
267 StringRef SectionContents,
268 StringRef Block) {
269 W.printBinaryBlock(Label, Block);
270
271 assert(SectionContents.begin() < Block.begin() &&
272 SectionContents.end() >= Block.end() &&
273 "Block is not contained in SectionContents");
274 uint64_t OffsetStart = Block.data() - SectionContents.data();
275 uint64_t OffsetEnd = OffsetStart + Block.size();
276
Zachary Turneraaad5742016-05-23 23:41:13 +0000277 W.flush();
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000278 cacheRelocations();
279 ListScope D(W, "BlockRelocations");
280 const coff_section *Section = Obj->getCOFFSection(Sec);
281 const auto &Relocations = RelocMap[Section];
282 for (const auto &Relocation : Relocations) {
283 uint64_t RelocationOffset = Relocation.getOffset();
284 if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd)
285 printRelocation(Sec, Relocation, OffsetStart);
286 }
287}
288
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000289static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000290 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
291 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
292 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
293 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
Saleem Abdulrasool5e1780e2014-03-11 03:08:37 +0000294 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000295 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
296 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
297 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
298 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
299 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
300 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
301 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
302 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
303 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
304 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
305 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
306 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
307 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
308 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
309 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
310 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
311};
312
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000313static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000314 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
315 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
316 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
317 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
318 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
319 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
320 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
321 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
322 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
323 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
324 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
325 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
326 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
327 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
328 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
329};
330
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000331static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000332 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
333 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
334 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
335 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
336 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
337 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
338 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
339 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
340 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
341 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
342 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
343};
344
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000345static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
Rui Ueyama06dc5e72014-01-27 04:22:24 +0000346 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000347 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
348 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
349 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
350 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
351 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
352 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000353 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000354 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000355 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000356 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
357};
358
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000359static const EnumEntry<COFF::SectionCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000360ImageSectionCharacteristics[] = {
David Majnemerd3238882015-07-30 16:47:56 +0000361 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000362 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
363 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
364 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
365 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
366 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
367 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
368 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
369 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
370 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
371 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
372 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
373 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
374 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
375 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
376 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
377 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
378 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
379 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
380 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
381 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
382 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
383 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
384 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
385 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
386 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
387 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
388 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
389 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
390 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
391 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
392 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
393 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
394 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
395 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
396 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
397};
398
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000399static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000400 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
401 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
402 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
403 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
404 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
405 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
406 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
407 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
408 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
409 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
410 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
411 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
412 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
413 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
414 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
415 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
416};
417
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000418static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000419 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
420 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
421 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
422 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
423};
424
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000425static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000426 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
427 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
428 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
429 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
430 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
431 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
432 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
433 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
434 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
435 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
436 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
437 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
438 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
439 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
440 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
441 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
442 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
443 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
444 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
445 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
446 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
447 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
448 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
449 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
450 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
451 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
452 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
453};
454
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000455static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000456 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
457 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
458 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
459 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
460 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
461 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
462 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
463};
464
Reid Kleckner2da433e2016-06-02 17:10:43 +0000465static const EnumEntry<COFF::DebugType> ImageDebugType[] = {
466 { "Unknown" , COFF::IMAGE_DEBUG_TYPE_UNKNOWN },
467 { "COFF" , COFF::IMAGE_DEBUG_TYPE_COFF },
468 { "CodeView" , COFF::IMAGE_DEBUG_TYPE_CODEVIEW },
469 { "FPO" , COFF::IMAGE_DEBUG_TYPE_FPO },
470 { "Misc" , COFF::IMAGE_DEBUG_TYPE_MISC },
471 { "Exception" , COFF::IMAGE_DEBUG_TYPE_EXCEPTION },
472 { "Fixup" , COFF::IMAGE_DEBUG_TYPE_FIXUP },
473 { "OmapToSrc" , COFF::IMAGE_DEBUG_TYPE_OMAP_TO_SRC },
474 { "OmapFromSrc", COFF::IMAGE_DEBUG_TYPE_OMAP_FROM_SRC },
475 { "Borland" , COFF::IMAGE_DEBUG_TYPE_BORLAND },
David Majnemera2a2a732016-06-02 17:32:11 +0000476 { "Reserved10" , COFF::IMAGE_DEBUG_TYPE_RESERVED10 },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000477 { "CLSID" , COFF::IMAGE_DEBUG_TYPE_CLSID },
478 { "VCFeature" , COFF::IMAGE_DEBUG_TYPE_VC_FEATURE },
479 { "POGO" , COFF::IMAGE_DEBUG_TYPE_POGO },
480 { "ILTCG" , COFF::IMAGE_DEBUG_TYPE_ILTCG },
481 { "MPX" , COFF::IMAGE_DEBUG_TYPE_MPX },
David Majnemera2a2a732016-06-02 17:32:11 +0000482 { "Repro" , COFF::IMAGE_DEBUG_TYPE_REPRO },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000483};
484
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000485static const EnumEntry<COFF::WeakExternalCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000486WeakExternalCharacteristics[] = {
487 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
488 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
489 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
490};
491
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000492static const EnumEntry<uint32_t> SubSectionTypes[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000493 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Symbols),
494 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Lines),
495 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, StringTable),
496 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FileChecksums),
497 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FrameData),
498 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, InlineeLines),
499 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeImports),
500 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeExports),
501 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, ILLines),
502 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FuncMDTokenMap),
503 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, TypeMDTokenMap),
504 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, MergedAssemblyInput),
505 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CoffSymbolRVA),
506};
507
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000508static const EnumEntry<uint32_t> FrameDataFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000509 LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH),
510 LLVM_READOBJ_ENUM_ENT(FrameData, HasEH),
511 LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart),
512};
513
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000514static const EnumEntry<uint8_t> FileChecksumKindNames[] = {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000515 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, None),
516 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, MD5),
517 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA1),
518 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA256),
519};
520
Rafael Espindola4453e42942014-06-13 03:07:50 +0000521template <typename T>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000522static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
David Majnemer44f51e52014-09-10 12:51:52 +0000523 COFFSymbolRef Symbol,
524 uint8_t AuxSymbolIdx, const T *&Aux) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000525 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
David Majnemer44f51e52014-09-10 12:51:52 +0000526 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000527 Aux = reinterpret_cast<const T*>(AuxData.data());
528 return readobj_error::success;
529}
530
Eric Christopher9cad53c2013-04-03 18:31:38 +0000531void COFFDumper::cacheRelocations() {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000532 if (RelocCached)
533 return;
534 RelocCached = true;
535
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000536 for (const SectionRef &S : Obj->sections()) {
537 const coff_section *Section = Obj->getCOFFSection(S);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000538
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000539 for (const RelocationRef &Reloc : S.relocations())
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000540 RelocMap[Section].push_back(Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000541
542 // Sort relocations by address.
543 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
544 relocAddressLess);
545 }
546}
547
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000548void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
549 const data_directory *Data;
550 if (Obj->getDataDirectory(Index, Data))
551 return;
552 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
553 W.printHex(FieldName + "Size", Data->Size);
554}
555
Eric Christopher9cad53c2013-04-03 18:31:38 +0000556void COFFDumper::printFileHeaders() {
David Majnemer44f51e52014-09-10 12:51:52 +0000557 time_t TDS = Obj->getTimeDateStamp();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000558 char FormattedTime[20] = { };
559 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
560
561 {
562 DictScope D(W, "ImageFileHeader");
David Majnemer44f51e52014-09-10 12:51:52 +0000563 W.printEnum ("Machine", Obj->getMachine(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000564 makeArrayRef(ImageFileMachineType));
David Majnemer44f51e52014-09-10 12:51:52 +0000565 W.printNumber("SectionCount", Obj->getNumberOfSections());
566 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
567 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
568 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
569 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
570 W.printFlags ("Characteristics", Obj->getCharacteristics(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000571 makeArrayRef(ImageFileCharacteristics));
572 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000573
574 // Print PE header. This header does not exist if this is an object file and
575 // not an executable.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000576 const pe32_header *PEHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000577 error(Obj->getPE32Header(PEHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000578 if (PEHeader)
579 printPEHeader<pe32_header>(PEHeader);
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000580
Craig Toppere6cb63e2014-04-25 04:24:47 +0000581 const pe32plus_header *PEPlusHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000582 error(Obj->getPE32PlusHeader(PEPlusHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000583 if (PEPlusHeader)
584 printPEHeader<pe32plus_header>(PEPlusHeader);
David Majnemer50267222014-11-05 06:24:35 +0000585
586 if (const dos_header *DH = Obj->getDOSHeader())
587 printDOSHeader(DH);
588}
589
590void COFFDumper::printDOSHeader(const dos_header *DH) {
591 DictScope D(W, "DOSHeader");
592 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
593 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
594 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
595 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
596 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
597 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
598 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
599 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
600 W.printNumber("InitialSP", DH->InitialSP);
601 W.printNumber("Checksum", DH->Checksum);
602 W.printNumber("InitialIP", DH->InitialIP);
603 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
604 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
605 W.printNumber("OverlayNumber", DH->OverlayNumber);
606 W.printNumber("OEMid", DH->OEMid);
607 W.printNumber("OEMinfo", DH->OEMinfo);
608 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000609}
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000610
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000611template <class PEHeader>
612void COFFDumper::printPEHeader(const PEHeader *Hdr) {
613 DictScope D(W, "ImageOptionalHeader");
614 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
615 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
616 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
617 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
618 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
619 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
620 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
621 printBaseOfDataField(Hdr);
622 W.printHex ("ImageBase", Hdr->ImageBase);
623 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
624 W.printNumber("FileAlignment", Hdr->FileAlignment);
625 W.printNumber("MajorOperatingSystemVersion",
626 Hdr->MajorOperatingSystemVersion);
627 W.printNumber("MinorOperatingSystemVersion",
628 Hdr->MinorOperatingSystemVersion);
629 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
630 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
631 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
632 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
633 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
634 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
635 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
David Majnemer774aadf2014-11-18 02:45:28 +0000636 W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000637 makeArrayRef(PEDLLCharacteristics));
638 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
639 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
640 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
641 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
642 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000643
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000644 if (Hdr->NumberOfRvaAndSize > 0) {
645 DictScope D(W, "DataDirectory");
646 static const char * const directory[] = {
647 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
648 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
649 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
650 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
651 };
652
Reid Kleckner2da433e2016-06-02 17:10:43 +0000653 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i)
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000654 printDataDirectory(i, directory[i]);
Reid Kleckner2da433e2016-06-02 17:10:43 +0000655 }
656}
657
658void COFFDumper::printCOFFDebugDirectory() {
659 ListScope LS(W, "DebugDirectory");
660 for (const debug_directory &D : Obj->debug_directories()) {
661 char FormattedTime[20] = {};
662 time_t TDS = D.TimeDateStamp;
663 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
664 DictScope S(W, "DebugEntry");
665 W.printHex("Characteristics", D.Characteristics);
666 W.printHex("TimeDateStamp", FormattedTime, D.TimeDateStamp);
667 W.printHex("MajorVersion", D.MajorVersion);
668 W.printHex("MinorVersion", D.MinorVersion);
669 W.printEnum("Type", D.Type, makeArrayRef(ImageDebugType));
670 W.printHex("SizeOfData", D.SizeOfData);
671 W.printHex("AddressOfRawData", D.AddressOfRawData);
672 W.printHex("PointerToRawData", D.PointerToRawData);
673 if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW) {
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000674 const codeview::DebugInfo *DebugInfo;
Reid Kleckner2da433e2016-06-02 17:10:43 +0000675 StringRef PDBFileName;
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000676 error(Obj->getDebugPDBInfo(&D, DebugInfo, PDBFileName));
Reid Kleckner2da433e2016-06-02 17:10:43 +0000677 DictScope PDBScope(W, "PDBInfo");
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000678 W.printHex("PDBSignature", DebugInfo->Signature.CVSignature);
679 if (DebugInfo->Signature.CVSignature == OMF::Signature::PDB70) {
680 W.printBinary("PDBGUID", makeArrayRef(DebugInfo->PDB70.Signature));
681 W.printNumber("PDBAge", DebugInfo->PDB70.Age);
682 W.printString("PDBFileName", PDBFileName);
683 }
Reid Kleckner2da433e2016-06-02 17:10:43 +0000684 } else {
685 // FIXME: Type values of 12 and 13 are commonly observed but are not in
686 // the documented type enum. Figure out what they mean.
687 ArrayRef<uint8_t> RawData;
688 error(
689 Obj->getRvaAndSizeAsBytes(D.AddressOfRawData, D.SizeOfData, RawData));
690 W.printBinaryBlock("RawData", RawData);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000691 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000692 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000693}
694
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000695void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
696 W.printHex("BaseOfData", Hdr->BaseOfData);
697}
698
699void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
700
Reid Kleckner83ebad32015-12-16 18:28:12 +0000701void COFFDumper::printCodeViewDebugInfo() {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000702 // Print types first to build CVUDTNames, then print symbols.
Reid Kleckner83ebad32015-12-16 18:28:12 +0000703 for (const SectionRef &S : Obj->sections()) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000704 StringRef SectionName;
705 error(S.getName(SectionName));
706 if (SectionName == ".debug$T")
707 printCodeViewTypeSection(SectionName, S);
708 }
709 for (const SectionRef &S : Obj->sections()) {
710 StringRef SectionName;
711 error(S.getName(SectionName));
712 if (SectionName == ".debug$S")
713 printCodeViewSymbolSection(SectionName, S);
Reid Kleckner83ebad32015-12-16 18:28:12 +0000714 }
715}
716
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000717void COFFDumper::initializeFileAndStringTables(StringRef Data) {
718 while (!Data.empty() && (CVFileChecksumTable.data() == nullptr ||
719 CVStringTable.data() == nullptr)) {
720 // The section consists of a number of subsection in the following format:
721 // |SubSectionType|SubSectionSize|Contents...|
722 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000723 error(consume(Data, SubType));
724 error(consume(Data, SubSectionSize));
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000725 if (SubSectionSize > Data.size())
726 return error(object_error::parse_failed);
727 switch (ModuleSubstreamKind(SubType)) {
728 case ModuleSubstreamKind::FileChecksums:
729 CVFileChecksumTable = Data.substr(0, SubSectionSize);
730 break;
731 case ModuleSubstreamKind::StringTable:
732 CVStringTable = Data.substr(0, SubSectionSize);
733 break;
734 default:
735 break;
736 }
David Majnemerefaaf412016-05-28 20:04:48 +0000737 uint32_t PaddedSize = alignTo(SubSectionSize, 4);
738 if (PaddedSize > Data.size())
739 error(object_error::parse_failed);
740 Data = Data.drop_front(PaddedSize);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000741 }
742}
743
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000744void COFFDumper::printCodeViewSymbolSection(StringRef SectionName,
745 const SectionRef &Section) {
746 StringRef SectionContents;
747 error(Section.getContents(SectionContents));
748 StringRef Data = SectionContents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000749
750 SmallVector<StringRef, 10> FunctionNames;
751 StringMap<StringRef> FunctionLineTables;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000752
Zachary Turner99f02152015-02-18 19:32:05 +0000753 ListScope D(W, "CodeViewDebugInfo");
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000754 // Print the section to allow correlation with printSections.
755 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000756
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000757 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000758 error(consume(Data, Magic));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000759 W.printHex("Magic", Magic);
760 if (Magic != COFF::DEBUG_SECTION_MAGIC)
761 return error(object_error::parse_failed);
762
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000763 initializeFileAndStringTables(Data);
764
Zachary Turnera96cce62016-06-03 03:25:59 +0000765 // TODO: Convert this over to using ModuleSubstreamVisitor.
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000766 while (!Data.empty()) {
767 // The section consists of a number of subsection in the following format:
768 // |SubSectionType|SubSectionSize|Contents...|
769 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000770 error(consume(Data, SubType));
771 error(consume(Data, SubSectionSize));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000772
773 ListScope S(W, "Subsection");
774 W.printEnum("SubSectionType", SubType, makeArrayRef(SubSectionTypes));
775 W.printHex("SubSectionSize", SubSectionSize);
776
777 // Get the contents of the subsection.
778 if (SubSectionSize > Data.size())
779 return error(object_error::parse_failed);
780 StringRef Contents = Data.substr(0, SubSectionSize);
781
782 // Add SubSectionSize to the current offset and align that offset to find
783 // the next subsection.
784 size_t SectionOffset = Data.data() - SectionContents.data();
785 size_t NextOffset = SectionOffset + SubSectionSize;
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000786 NextOffset = alignTo(NextOffset, 4);
David Majnemercab2b462016-05-28 20:04:50 +0000787 if (NextOffset > SectionContents.size())
788 return error(object_error::parse_failed);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000789 Data = SectionContents.drop_front(NextOffset);
790
791 // Optionally print the subsection bytes in case our parsing gets confused
792 // later.
793 if (opts::CodeViewSubsectionBytes)
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000794 printBinaryBlockWithRelocs("SubSectionContents", Section, SectionContents,
795 Contents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000796
797 switch (ModuleSubstreamKind(SubType)) {
798 case ModuleSubstreamKind::Symbols:
Reid Kleckner2893fd12016-01-14 17:51:54 +0000799 printCodeViewSymbolsSubsection(Contents, Section, SectionContents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000800 break;
Reid Klecknere9ab3492016-01-14 19:20:17 +0000801
802 case ModuleSubstreamKind::InlineeLines:
803 printCodeViewInlineeLines(Contents);
804 break;
805
Reid Klecknerc31f5302016-01-15 18:06:25 +0000806 case ModuleSubstreamKind::FileChecksums:
807 printCodeViewFileChecksums(Contents);
808 break;
809
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000810 case ModuleSubstreamKind::Lines: {
811 // Holds a PC to file:line table. Some data to parse this subsection is
812 // stored in the other subsections, so just check sanity and store the
813 // pointers for deferred processing.
814
815 if (SubSectionSize < 12) {
816 // There should be at least three words to store two function
817 // relocations and size of the code.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000818 error(object_error::parse_failed);
819 return;
820 }
821
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000822 StringRef LinkageName;
823 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset,
824 LinkageName));
825 W.printString("LinkageName", LinkageName);
826 if (FunctionLineTables.count(LinkageName) != 0) {
827 // Saw debug info for this function already?
828 error(object_error::parse_failed);
829 return;
Zachary Turner99f02152015-02-18 19:32:05 +0000830 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000831
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000832 FunctionLineTables[LinkageName] = Contents;
833 FunctionNames.push_back(LinkageName);
834 break;
835 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000836 case ModuleSubstreamKind::FrameData: {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000837 // First four bytes is a relocation against the function.
838 const uint32_t *CodePtr;
839 error(consumeObject(Contents, CodePtr));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000840 StringRef LinkageName;
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000841 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionContents,
842 CodePtr, LinkageName));
843 W.printString("LinkageName", LinkageName);
844
845 // To find the active frame description, search this array for the
846 // smallest PC range that includes the current PC.
847 while (!Contents.empty()) {
848 const FrameData *FD;
849 error(consumeObject(Contents, FD));
David Majnemera6d93fd2016-05-28 19:45:49 +0000850
851 if (FD->FrameFunc >= CVStringTable.size())
852 error(object_error::parse_failed);
853
854 StringRef FrameFunc =
855 CVStringTable.drop_front(FD->FrameFunc).split('\0').first;
856
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000857 DictScope S(W, "FrameData");
858 W.printHex("RvaStart", FD->RvaStart);
859 W.printHex("CodeSize", FD->CodeSize);
860 W.printHex("LocalSize", FD->LocalSize);
861 W.printHex("ParamsSize", FD->ParamsSize);
862 W.printHex("MaxStackSize", FD->MaxStackSize);
David Majnemera6d93fd2016-05-28 19:45:49 +0000863 W.printString("FrameFunc", FrameFunc);
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000864 W.printHex("PrologSize", FD->PrologSize);
865 W.printHex("SavedRegsSize", FD->SavedRegsSize);
866 W.printFlags("Flags", FD->Flags, makeArrayRef(FrameDataFlags));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000867 }
868 break;
869 }
870
871 // Do nothing for unrecognized subsections.
872 default:
873 break;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000874 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000875 W.flush();
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000876 }
877
878 // Dump the line tables now that we've read all the subsections and know all
879 // the required information.
880 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
881 StringRef Name = FunctionNames[I];
882 ListScope S(W, "FunctionLineTable");
Reid Kleckner7c0c0c02015-12-15 01:23:55 +0000883 W.printString("LinkageName", Name);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000884
885 DataExtractor DE(FunctionLineTables[Name], true, 4);
David Majnemer3f49e662015-07-09 00:19:51 +0000886 uint32_t Offset = 6; // Skip relocations.
887 uint16_t Flags = DE.getU16(&Offset);
888 W.printHex("Flags", Flags);
Reid Kleckner2214ed82016-01-29 00:49:42 +0000889 bool HasColumnInformation = Flags & codeview::LineFlags::HaveColumns;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000890 uint32_t FunctionSize = DE.getU32(&Offset);
891 W.printHex("CodeSize", FunctionSize);
892 while (DE.isValidOffset(Offset)) {
893 // For each range of lines with the same filename, we have a segment
894 // in the line table. The filename string is accessed using double
895 // indirection to the string table subsection using the index subsection.
896 uint32_t OffsetInIndex = DE.getU32(&Offset),
David Majnemer04948362016-01-13 01:05:16 +0000897 NumLines = DE.getU32(&Offset),
David Majnemer0373d532015-07-09 18:14:31 +0000898 FullSegmentSize = DE.getU32(&Offset);
899
David Majnemer04948362016-01-13 01:05:16 +0000900 uint32_t ColumnOffset = Offset + 8 * NumLines;
901 DataExtractor ColumnDE(DE.getData(), true, 4);
902
David Majnemer0373d532015-07-09 18:14:31 +0000903 if (FullSegmentSize !=
David Majnemer04948362016-01-13 01:05:16 +0000904 12 + 8 * NumLines + (HasColumnInformation ? 4 * NumLines : 0)) {
David Majnemer0373d532015-07-09 18:14:31 +0000905 error(object_error::parse_failed);
906 return;
907 }
Justin Bognera1413db2015-07-09 04:27:36 +0000908
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000909 ListScope S(W, "FilenameSegment");
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000910 printFileNameForOffset("Filename", OffsetInIndex);
David Majnemer04948362016-01-13 01:05:16 +0000911 for (unsigned LineIdx = 0;
912 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000913 // Then go the (PC, LineNumber) pairs. The line number is stored in the
914 // least significant 31 bits of the respective word in the table.
David Majnemer04948362016-01-13 01:05:16 +0000915 uint32_t PC = DE.getU32(&Offset), LineData = DE.getU32(&Offset);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000916 if (PC >= FunctionSize) {
917 error(object_error::parse_failed);
918 return;
919 }
920 char Buffer[32];
921 format("+0x%X", PC).snprint(Buffer, 32);
David Majnemer04948362016-01-13 01:05:16 +0000922 ListScope PCScope(W, Buffer);
David Majnemera4859df2016-02-04 17:57:12 +0000923 LineInfo LI(LineData);
924 if (LI.isAlwaysStepInto())
925 W.printString("StepInto", StringRef("Always"));
926 else if (LI.isNeverStepInto())
927 W.printString("StepInto", StringRef("Never"));
928 else
929 W.printNumber("LineNumberStart", LI.getStartLine());
930 W.printNumber("LineNumberEndDelta", LI.getLineDelta());
931 W.printBoolean("IsStatement", LI.isStatement());
David Majnemer04948362016-01-13 01:05:16 +0000932 if (HasColumnInformation &&
933 ColumnDE.isValidOffsetForDataOfSize(ColumnOffset, 4)) {
934 uint16_t ColStart = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +0000935 W.printNumber("ColStart", ColStart);
David Majnemer04948362016-01-13 01:05:16 +0000936 uint16_t ColEnd = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +0000937 W.printNumber("ColEnd", ColEnd);
938 }
939 }
David Majnemer04948362016-01-13 01:05:16 +0000940 // Skip over the column data.
941 if (HasColumnInformation) {
942 for (unsigned LineIdx = 0;
943 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
944 DE.getU32(&Offset);
945 }
946 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000947 }
948 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000949}
950
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000951void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
952 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000953 StringRef SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000954 ArrayRef<uint8_t> BinaryData(Subsection.bytes_begin(),
955 Subsection.bytes_end());
956 auto CODD = llvm::make_unique<COFFObjectDumpDelegate>(*this, Section, Obj,
957 SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000958
Zachary Turneraaad5742016-05-23 23:41:13 +0000959 CVSymbolDumper CVSD(W, CVTD, std::move(CODD), opts::CodeViewSubsectionBytes);
Zachary Turnerd66889c2016-07-28 19:12:28 +0000960 ByteStream Stream(BinaryData);
Zachary Turner0d43c1c2016-05-28 05:21:57 +0000961 CVSymbolArray Symbols;
962 StreamReader Reader(Stream);
963 if (auto EC = Reader.readArray(Symbols, Reader.getLength())) {
964 consumeError(std::move(EC));
965 W.flush();
966 error(object_error::parse_failed);
967 }
Reid Kleckner2893fd12016-01-14 17:51:54 +0000968
Zachary Turner0d840742016-10-07 21:34:46 +0000969 if (auto EC = CVSD.dump(Symbols)) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000970 W.flush();
Zachary Turner0d840742016-10-07 21:34:46 +0000971 error(std::move(EC));
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000972 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000973 W.flush();
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000974}
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000975
Reid Klecknerc31f5302016-01-15 18:06:25 +0000976void COFFDumper::printCodeViewFileChecksums(StringRef Subsection) {
977 StringRef Data = Subsection;
978 while (!Data.empty()) {
979 DictScope S(W, "FileChecksum");
980 const FileChecksum *FC;
981 error(consumeObject(Data, FC));
982 if (FC->FileNameOffset >= CVStringTable.size())
983 error(object_error::parse_failed);
984 StringRef Filename =
985 CVStringTable.drop_front(FC->FileNameOffset).split('\0').first;
986 W.printHex("Filename", Filename, FC->FileNameOffset);
987 W.printHex("ChecksumSize", FC->ChecksumSize);
988 W.printEnum("ChecksumKind", uint8_t(FC->ChecksumKind),
989 makeArrayRef(FileChecksumKindNames));
990 if (FC->ChecksumSize >= Data.size())
991 error(object_error::parse_failed);
992 StringRef ChecksumBytes = Data.substr(0, FC->ChecksumSize);
993 W.printBinary("ChecksumBytes", ChecksumBytes);
Rafael Espindolaa79078c2016-01-18 20:55:24 +0000994 unsigned PaddedSize = alignTo(FC->ChecksumSize + sizeof(FileChecksum), 4) -
995 sizeof(FileChecksum);
David Majnemer37dafba2016-05-28 19:45:58 +0000996 if (PaddedSize > Data.size())
997 error(object_error::parse_failed);
Reid Klecknerc31f5302016-01-15 18:06:25 +0000998 Data = Data.drop_front(PaddedSize);
999 }
1000}
1001
Reid Klecknere9ab3492016-01-14 19:20:17 +00001002void COFFDumper::printCodeViewInlineeLines(StringRef Subsection) {
1003 StringRef Data = Subsection;
1004 uint32_t Signature;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001005 error(consume(Data, Signature));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001006 bool HasExtraFiles = Signature == unsigned(InlineeLinesSignature::ExtraFiles);
1007
1008 while (!Data.empty()) {
1009 const InlineeSourceLine *ISL;
1010 error(consumeObject(Data, ISL));
1011 DictScope S(W, "InlineeSourceLine");
1012 printTypeIndex("Inlinee", ISL->Inlinee);
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001013 printFileNameForOffset("FileID", ISL->FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001014 W.printNumber("SourceLineNum", ISL->SourceLineNum);
1015
1016 if (HasExtraFiles) {
1017 uint32_t ExtraFileCount;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001018 error(consume(Data, ExtraFileCount));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001019 W.printNumber("ExtraFileCount", ExtraFileCount);
1020 ListScope ExtraFiles(W, "ExtraFiles");
1021 for (unsigned I = 0; I < ExtraFileCount; ++I) {
1022 uint32_t FileID;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001023 error(consume(Data, FileID));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001024 printFileNameForOffset("FileID", FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001025 }
1026 }
1027 }
1028}
1029
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001030StringRef COFFDumper::getFileNameForFileOffset(uint32_t FileOffset) {
1031 // The file checksum subsection should precede all references to it.
1032 if (!CVFileChecksumTable.data() || !CVStringTable.data())
1033 error(object_error::parse_failed);
1034 // Check if the file checksum table offset is valid.
1035 if (FileOffset >= CVFileChecksumTable.size())
1036 error(object_error::parse_failed);
1037
1038 // The string table offset comes first before the file checksum.
1039 StringRef Data = CVFileChecksumTable.drop_front(FileOffset);
1040 uint32_t StringOffset;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001041 error(consume(Data, StringOffset));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001042
1043 // Check if the string table offset is valid.
1044 if (StringOffset >= CVStringTable.size())
1045 error(object_error::parse_failed);
1046
1047 // Return the null-terminated string.
1048 return CVStringTable.drop_front(StringOffset).split('\0').first;
1049}
1050
1051void COFFDumper::printFileNameForOffset(StringRef Label, uint32_t FileOffset) {
1052 W.printHex(Label, getFileNameForFileOffset(FileOffset), FileOffset);
1053}
1054
Reid Kleckner0b269742016-05-14 00:02:53 +00001055void COFFDumper::mergeCodeViewTypes(MemoryTypeTableBuilder &CVTypes) {
1056 for (const SectionRef &S : Obj->sections()) {
1057 StringRef SectionName;
1058 error(S.getName(SectionName));
1059 if (SectionName == ".debug$T") {
1060 StringRef Data;
1061 error(S.getContents(Data));
David Majnemer78b0d722016-05-28 19:17:48 +00001062 uint32_t Magic;
1063 error(consume(Data, Magic));
Reid Kleckner0b269742016-05-14 00:02:53 +00001064 if (Magic != 4)
1065 error(object_error::parse_failed);
Reid Kleckner0b269742016-05-14 00:02:53 +00001066 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(Data.data()),
1067 Data.size());
Zachary Turnerd66889c2016-07-28 19:12:28 +00001068 ByteStream Stream(Bytes);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001069 CVTypeArray Types;
1070 StreamReader Reader(Stream);
1071 if (auto EC = Reader.readArray(Types, Reader.getLength())) {
1072 consumeError(std::move(EC));
1073 W.flush();
1074 error(object_error::parse_failed);
1075 }
1076
1077 if (!mergeTypeStreams(CVTypes, Types))
Reid Kleckner0b269742016-05-14 00:02:53 +00001078 return error(object_error::parse_failed);
1079 }
1080 }
1081}
1082
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001083void COFFDumper::printCodeViewTypeSection(StringRef SectionName,
1084 const SectionRef &Section) {
1085 ListScope D(W, "CodeViewTypes");
1086 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Adrian McCarthy963a3312016-05-02 23:45:03 +00001087
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001088 StringRef Data;
1089 error(Section.getContents(Data));
Reid Klecknerb2bd2812016-05-02 18:10:00 +00001090 if (opts::CodeViewSubsectionBytes)
1091 W.printBinaryBlock("Data", Data);
Reid Kleckner7960de92016-05-04 19:39:28 +00001092
1093 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001094 error(consume(Data, Magic));
Reid Kleckner7960de92016-05-04 19:39:28 +00001095 W.printHex("Magic", Magic);
1096 if (Magic != COFF::DEBUG_SECTION_MAGIC)
1097 return error(object_error::parse_failed);
1098
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001099 if (auto EC = CVTD.dump({Data.bytes_begin(), Data.bytes_end()})) {
Reid Kleckner4a14bca2016-05-05 00:34:33 +00001100 W.flush();
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001101 error(llvm::errorToErrorCode(std::move(EC)));
Reid Kleckner7960de92016-05-04 19:39:28 +00001102 }
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001103}
1104
Eric Christopher9cad53c2013-04-03 18:31:38 +00001105void COFFDumper::printSections() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001106 ListScope SectionsD(W, "Sections");
1107 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001108 for (const SectionRef &Sec : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001109 ++SectionNumber;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001110 const coff_section *Section = Obj->getCOFFSection(Sec);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001111
1112 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001113 error(Sec.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001114
1115 DictScope D(W, "Section");
1116 W.printNumber("Number", SectionNumber);
1117 W.printBinary("Name", Name, Section->Name);
1118 W.printHex ("VirtualSize", Section->VirtualSize);
1119 W.printHex ("VirtualAddress", Section->VirtualAddress);
1120 W.printNumber("RawDataSize", Section->SizeOfRawData);
1121 W.printHex ("PointerToRawData", Section->PointerToRawData);
1122 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
1123 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
1124 W.printNumber("RelocationCount", Section->NumberOfRelocations);
1125 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
1126 W.printFlags ("Characteristics", Section->Characteristics,
1127 makeArrayRef(ImageSectionCharacteristics),
1128 COFF::SectionCharacteristics(0x00F00000));
1129
1130 if (opts::SectionRelocations) {
1131 ListScope D(W, "Relocations");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001132 for (const RelocationRef &Reloc : Sec.relocations())
1133 printRelocation(Sec, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001134 }
1135
1136 if (opts::SectionSymbols) {
1137 ListScope D(W, "Symbols");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001138 for (const SymbolRef &Symbol : Obj->symbols()) {
Rafael Espindola80291272014-10-08 15:28:58 +00001139 if (!Sec.containsSymbol(Symbol))
Eric Christopher9cad53c2013-04-03 18:31:38 +00001140 continue;
1141
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001142 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001143 }
1144 }
1145
David Majnemerdac39852014-09-26 22:32:16 +00001146 if (opts::SectionData &&
1147 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001148 StringRef Data;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001149 error(Sec.getContents(Data));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001150
1151 W.printBinaryBlock("SectionData", Data);
1152 }
1153 }
1154}
1155
1156void COFFDumper::printRelocations() {
1157 ListScope D(W, "Relocations");
1158
Eric Christopher9cad53c2013-04-03 18:31:38 +00001159 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001160 for (const SectionRef &Section : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001161 ++SectionNumber;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001162 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001163 error(Section.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001164
1165 bool PrintedGroup = false;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001166 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001167 if (!PrintedGroup) {
1168 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
1169 W.indent();
1170 PrintedGroup = true;
1171 }
1172
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001173 printRelocation(Section, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001174 }
1175
1176 if (PrintedGroup) {
1177 W.unindent();
1178 W.startLine() << "}\n";
1179 }
1180 }
1181}
1182
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001183void COFFDumper::printRelocation(const SectionRef &Section,
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00001184 const RelocationRef &Reloc, uint64_t Bias) {
1185 uint64_t Offset = Reloc.getOffset() - Bias;
Rafael Espindola99c041b2015-06-30 01:53:01 +00001186 uint64_t RelocType = Reloc.getType();
Eric Christopher9cad53c2013-04-03 18:31:38 +00001187 SmallString<32> RelocName;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001188 StringRef SymbolName;
Rafael Espindola41bb4322015-06-30 04:08:37 +00001189 Reloc.getTypeName(RelocName);
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001190 symbol_iterator Symbol = Reloc.getSymbol();
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001191 if (Symbol != Obj->symbol_end()) {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001192 Expected<StringRef> SymbolNameOrErr = Symbol->getName();
1193 error(errorToErrorCode(SymbolNameOrErr.takeError()));
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001194 SymbolName = *SymbolNameOrErr;
1195 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001196
Nico Rieckf3f0b792013-04-12 04:01:52 +00001197 if (opts::ExpandRelocs) {
1198 DictScope Group(W, "Relocation");
1199 W.printHex("Offset", Offset);
1200 W.printNumber("Type", RelocName, RelocType);
David Majnemer1f80b0a2014-11-13 07:42:11 +00001201 W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName);
Nico Rieckf3f0b792013-04-12 04:01:52 +00001202 } else {
1203 raw_ostream& OS = W.startLine();
1204 OS << W.hex(Offset)
1205 << " " << RelocName
David Majnemer1f80b0a2014-11-13 07:42:11 +00001206 << " " << (SymbolName.empty() ? "-" : SymbolName)
Nico Rieckf3f0b792013-04-12 04:01:52 +00001207 << "\n";
1208 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001209}
1210
1211void COFFDumper::printSymbols() {
1212 ListScope Group(W, "Symbols");
1213
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001214 for (const SymbolRef &Symbol : Obj->symbols())
1215 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001216}
1217
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001218void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001219
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001220static ErrorOr<StringRef>
David Majnemer236b0ca2014-11-17 11:17:17 +00001221getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber,
1222 const coff_section *Section) {
David Majnemerf4dc4562014-09-20 00:25:06 +00001223 if (Section) {
1224 StringRef SectionName;
David Majnemer236b0ca2014-11-17 11:17:17 +00001225 if (std::error_code EC = Obj->getSectionName(Section, SectionName))
1226 return EC;
David Majnemerf4dc4562014-09-20 00:25:06 +00001227 return SectionName;
1228 }
David Majnemerf4dc4562014-09-20 00:25:06 +00001229 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
David Majnemer236b0ca2014-11-17 11:17:17 +00001230 return StringRef("IMAGE_SYM_DEBUG");
David Majnemerf4dc4562014-09-20 00:25:06 +00001231 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
David Majnemer236b0ca2014-11-17 11:17:17 +00001232 return StringRef("IMAGE_SYM_ABSOLUTE");
David Majnemerf4dc4562014-09-20 00:25:06 +00001233 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
David Majnemer236b0ca2014-11-17 11:17:17 +00001234 return StringRef("IMAGE_SYM_UNDEFINED");
1235 return StringRef("");
David Majnemerf4dc4562014-09-20 00:25:06 +00001236}
1237
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001238void COFFDumper::printSymbol(const SymbolRef &Sym) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001239 DictScope D(W, "Symbol");
1240
David Majnemer44f51e52014-09-10 12:51:52 +00001241 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001242 const coff_section *Section;
David Majnemer44f51e52014-09-10 12:51:52 +00001243 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001244 W.startLine() << "Invalid section number: " << EC.message() << "\n";
1245 W.flush();
1246 return;
1247 }
1248
1249 StringRef SymbolName;
1250 if (Obj->getSymbolName(Symbol, SymbolName))
1251 SymbolName = "";
1252
David Majnemer236b0ca2014-11-17 11:17:17 +00001253 StringRef SectionName = "";
1254 ErrorOr<StringRef> Res =
1255 getSectionName(Obj, Symbol.getSectionNumber(), Section);
1256 if (Res)
1257 SectionName = *Res;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001258
1259 W.printString("Name", SymbolName);
David Majnemer44f51e52014-09-10 12:51:52 +00001260 W.printNumber("Value", Symbol.getValue());
1261 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
1262 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
1263 W.printEnum ("ComplexType", Symbol.getComplexType(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001264 makeArrayRef(ImageSymDType));
David Majnemer44f51e52014-09-10 12:51:52 +00001265 W.printEnum ("StorageClass", Symbol.getStorageClass(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001266 makeArrayRef(ImageSymClass));
David Majnemer44f51e52014-09-10 12:51:52 +00001267 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
Eric Christopher9cad53c2013-04-03 18:31:38 +00001268
David Majnemer44f51e52014-09-10 12:51:52 +00001269 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
1270 if (Symbol.isFunctionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001271 const coff_aux_function_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001272 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001273
1274 DictScope AS(W, "AuxFunctionDef");
1275 W.printNumber("TagIndex", Aux->TagIndex);
1276 W.printNumber("TotalSize", Aux->TotalSize);
David Majnemerf3a2af52014-03-19 04:33:27 +00001277 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001278 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001279
David Majnemerc7d7c6f2014-10-31 05:07:00 +00001280 } else if (Symbol.isAnyUndefined()) {
David Majnemerf3a2af52014-03-19 04:33:27 +00001281 const coff_aux_weak_external *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001282 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001283
David Majnemer44f51e52014-09-10 12:51:52 +00001284 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001285 StringRef LinkedName;
David Majnemer44f51e52014-09-10 12:51:52 +00001286 std::error_code EC = Linked.getError();
1287 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001288 LinkedName = "";
1289 error(EC);
1290 }
1291
1292 DictScope AS(W, "AuxWeakExternal");
1293 W.printNumber("Linked", LinkedName, Aux->TagIndex);
1294 W.printEnum ("Search", Aux->Characteristics,
1295 makeArrayRef(WeakExternalCharacteristics));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001296
David Majnemer44f51e52014-09-10 12:51:52 +00001297 } else if (Symbol.isFileRecord()) {
1298 const char *FileName;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001299 error(getSymbolAuxData(Obj, Symbol, I, FileName));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001300
Nico Rieck0ab8e602013-04-22 08:35:11 +00001301 DictScope AS(W, "AuxFileRecord");
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001302
David Majnemer44f51e52014-09-10 12:51:52 +00001303 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
1304 Obj->getSymbolTableEntrySize());
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001305 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
Saleem Abdulrasool3b5e0012014-04-16 04:15:29 +00001306 break;
David Majnemer44f51e52014-09-10 12:51:52 +00001307 } else if (Symbol.isSectionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001308 const coff_aux_section_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001309 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001310
David Majnemer4d571592014-09-15 19:42:42 +00001311 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
1312
Eric Christopher9cad53c2013-04-03 18:31:38 +00001313 DictScope AS(W, "AuxSectionDef");
1314 W.printNumber("Length", Aux->Length);
1315 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
1316 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
1317 W.printHex("Checksum", Aux->CheckSum);
David Majnemer4d571592014-09-15 19:42:42 +00001318 W.printNumber("Number", AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001319 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001320
Nico Riecka711dee2013-04-22 08:34:59 +00001321 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
Eric Christopher9cad53c2013-04-03 18:31:38 +00001322 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
1323 const coff_section *Assoc;
David Majnemer236b0ca2014-11-17 11:17:17 +00001324 StringRef AssocName = "";
1325 std::error_code EC = Obj->getSection(AuxNumber, Assoc);
1326 ErrorOr<StringRef> Res = getSectionName(Obj, AuxNumber, Assoc);
1327 if (Res)
1328 AssocName = *Res;
1329 if (!EC)
1330 EC = Res.getError();
1331 if (EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001332 AssocName = "";
1333 error(EC);
1334 }
1335
David Majnemer4d571592014-09-15 19:42:42 +00001336 W.printNumber("AssocSection", AssocName, AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001337 }
David Majnemer44f51e52014-09-10 12:51:52 +00001338 } else if (Symbol.isCLRToken()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001339 const coff_aux_clr_token *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001340 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001341
David Majnemer44f51e52014-09-10 12:51:52 +00001342 ErrorOr<COFFSymbolRef> ReferredSym =
1343 Obj->getSymbol(Aux->SymbolTableIndex);
Nico Rieck8678acd2014-03-17 01:46:52 +00001344 StringRef ReferredName;
David Majnemer44f51e52014-09-10 12:51:52 +00001345 std::error_code EC = ReferredSym.getError();
1346 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
Nico Rieck8678acd2014-03-17 01:46:52 +00001347 ReferredName = "";
1348 error(EC);
1349 }
1350
Eric Christopher9cad53c2013-04-03 18:31:38 +00001351 DictScope AS(W, "AuxCLRToken");
1352 W.printNumber("AuxType", Aux->AuxType);
1353 W.printNumber("Reserved", Aux->Reserved);
Nico Rieck8678acd2014-03-17 01:46:52 +00001354 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001355
1356 } else {
1357 W.startLine() << "<unhandled auxiliary record>\n";
1358 }
1359 }
1360}
1361
1362void COFFDumper::printUnwindInfo() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001363 ListScope D(W, "UnwindInformation");
David Majnemer44f51e52014-09-10 12:51:52 +00001364 switch (Obj->getMachine()) {
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001365 case COFF::IMAGE_FILE_MACHINE_AMD64: {
1366 Win64EH::Dumper Dumper(W);
Rafael Espindola4453e42942014-06-13 03:07:50 +00001367 Win64EH::Dumper::SymbolResolver
1368 Resolver = [](const object::coff_section *Section, uint64_t Offset,
1369 SymbolRef &Symbol, void *user_data) -> std::error_code {
1370 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
1371 return Dumper->resolveSymbol(Section, Offset, Symbol);
1372 };
Saleem Abdulrasool65dbbb52014-05-25 21:37:59 +00001373 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001374 Dumper.printData(Ctx);
1375 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001376 }
Saleem Abdulrasoole6971ca2014-06-04 15:47:15 +00001377 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
1378 ARM::WinEH::Decoder Decoder(W);
1379 Decoder.dumpProcedureData(*Obj);
1380 break;
1381 }
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001382 default:
David Majnemer44f51e52014-09-10 12:51:52 +00001383 W.printEnum("unsupported Image Machine", Obj->getMachine(),
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001384 makeArrayRef(ImageFileMachineType));
1385 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001386 }
1387}
1388
Rui Ueyama979fb402014-10-09 02:16:38 +00001389void COFFDumper::printImportedSymbols(
1390 iterator_range<imported_symbol_iterator> Range) {
1391 for (const ImportedSymbolRef &I : Range) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001392 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001393 error(I.getSymbolName(Sym));
Rui Ueyama15d99352014-10-03 00:41:58 +00001394 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001395 error(I.getOrdinal(Ordinal));
Rui Ueyama15d99352014-10-03 00:41:58 +00001396 W.printNumber("Symbol", Sym, Ordinal);
1397 }
1398}
1399
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001400void COFFDumper::printDelayImportedSymbols(
1401 const DelayImportDirectoryEntryRef &I,
1402 iterator_range<imported_symbol_iterator> Range) {
1403 int Index = 0;
1404 for (const ImportedSymbolRef &S : Range) {
1405 DictScope Import(W, "Import");
1406 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001407 error(S.getSymbolName(Sym));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001408 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001409 error(S.getOrdinal(Ordinal));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001410 W.printNumber("Symbol", Sym, Ordinal);
1411 uint64_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001412 error(I.getImportAddress(Index++, Addr));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001413 W.printHex("Address", Addr);
1414 }
1415}
1416
Rui Ueyama1e152d52014-10-02 17:02:18 +00001417void COFFDumper::printCOFFImports() {
Rui Ueyama15d99352014-10-03 00:41:58 +00001418 // Regular imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001419 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
Rui Ueyama1e152d52014-10-02 17:02:18 +00001420 DictScope Import(W, "Import");
1421 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001422 error(I.getName(Name));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001423 W.printString("Name", Name);
1424 uint32_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001425 error(I.getImportLookupTableRVA(Addr));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001426 W.printHex("ImportLookupTableRVA", Addr);
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001427 error(I.getImportAddressTableRVA(Addr));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001428 W.printHex("ImportAddressTableRVA", Addr);
Rui Ueyama979fb402014-10-09 02:16:38 +00001429 printImportedSymbols(I.imported_symbols());
Rui Ueyama15d99352014-10-03 00:41:58 +00001430 }
1431
1432 // Delay imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001433 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001434 DictScope Import(W, "DelayImport");
1435 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001436 error(I.getName(Name));
Rui Ueyama15d99352014-10-03 00:41:58 +00001437 W.printString("Name", Name);
Rui Ueyama1af08652014-10-03 18:07:18 +00001438 const delay_import_directory_table_entry *Table;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001439 error(I.getDelayImportTable(Table));
Rui Ueyama1af08652014-10-03 18:07:18 +00001440 W.printHex("Attributes", Table->Attributes);
1441 W.printHex("ModuleHandle", Table->ModuleHandle);
1442 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
1443 W.printHex("ImportNameTable", Table->DelayImportNameTable);
1444 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
1445 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001446 printDelayImportedSymbols(I, I.imported_symbols());
Rui Ueyama1e152d52014-10-02 17:02:18 +00001447 }
1448}
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001449
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001450void COFFDumper::printCOFFExports() {
1451 for (const ExportDirectoryEntryRef &E : Obj->export_directories()) {
1452 DictScope Export(W, "Export");
1453
1454 StringRef Name;
1455 uint32_t Ordinal, RVA;
1456
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001457 error(E.getSymbolName(Name));
1458 error(E.getOrdinal(Ordinal));
1459 error(E.getExportRVA(RVA));
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001460
1461 W.printNumber("Ordinal", Ordinal);
1462 W.printString("Name", Name);
1463 W.printHex("RVA", RVA);
1464 }
1465}
1466
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001467void COFFDumper::printCOFFDirectives() {
1468 for (const SectionRef &Section : Obj->sections()) {
1469 StringRef Contents;
1470 StringRef Name;
1471
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001472 error(Section.getName(Name));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001473 if (Name != ".drectve")
1474 continue;
1475
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001476 error(Section.getContents(Contents));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001477
1478 W.printString("Directive(s)", Contents);
1479 }
1480}
Rui Ueyama74e85132014-11-19 00:18:07 +00001481
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001482static StringRef getBaseRelocTypeName(uint8_t Type) {
Rui Ueyama74e85132014-11-19 00:18:07 +00001483 switch (Type) {
1484 case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";
1485 case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";
1486 case COFF::IMAGE_REL_BASED_LOW: return "LOW";
1487 case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";
1488 case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";
Saleem Abdulrasool5a41c372015-01-16 20:16:09 +00001489 case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)";
Rui Ueyama74e85132014-11-19 00:18:07 +00001490 case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";
Colin LeMahieu9fbffee2014-11-19 17:10:39 +00001491 default: return "unknown (" + llvm::utostr(Type) + ")";
Rui Ueyama74e85132014-11-19 00:18:07 +00001492 }
1493}
1494
1495void COFFDumper::printCOFFBaseReloc() {
1496 ListScope D(W, "BaseReloc");
1497 for (const BaseRelocRef &I : Obj->base_relocs()) {
1498 uint8_t Type;
1499 uint32_t RVA;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001500 error(I.getRVA(RVA));
1501 error(I.getType(Type));
Rui Ueyama74e85132014-11-19 00:18:07 +00001502 DictScope Import(W, "Entry");
1503 W.printString("Type", getBaseRelocTypeName(Type));
1504 W.printHex("Address", RVA);
1505 }
1506}
Lang Hames0000afd2015-06-26 23:56:53 +00001507
1508void COFFDumper::printStackMap() const {
1509 object::SectionRef StackMapSection;
1510 for (auto Sec : Obj->sections()) {
1511 StringRef Name;
1512 Sec.getName(Name);
1513 if (Name == ".llvm_stackmaps") {
1514 StackMapSection = Sec;
1515 break;
1516 }
1517 }
1518
1519 if (StackMapSection == object::SectionRef())
1520 return;
1521
1522 StringRef StackMapContents;
1523 StackMapSection.getContents(StackMapContents);
1524 ArrayRef<uint8_t> StackMapContentsArray(
1525 reinterpret_cast<const uint8_t*>(StackMapContents.data()),
1526 StackMapContents.size());
1527
1528 if (Obj->isLittleEndian())
1529 prettyPrintStackMap(
1530 llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001531 StackMapV2Parser<support::little>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001532 else
1533 prettyPrintStackMap(llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001534 StackMapV2Parser<support::big>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001535}
Reid Kleckner0b269742016-05-14 00:02:53 +00001536
1537void llvm::dumpCodeViewMergedTypes(
1538 ScopedPrinter &Writer, llvm::codeview::MemoryTypeTableBuilder &CVTypes) {
1539 // Flatten it first, then run our dumper on it.
1540 ListScope S(Writer, "MergedTypeStream");
1541 SmallString<0> Buf;
Reid Klecknerfbdbe9e2016-05-31 18:45:36 +00001542 CVTypes.ForEachRecord([&](TypeIndex TI, StringRef Record) {
1543 Buf.append(Record.begin(), Record.end());
Reid Kleckner0b269742016-05-14 00:02:53 +00001544 });
Reid Klecknerfbdbe9e2016-05-31 18:45:36 +00001545 CVTypeDumper CVTD(&Writer, opts::CodeViewSubsectionBytes);
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001546 if (auto EC = CVTD.dump({Buf.str().bytes_begin(), Buf.str().bytes_end()})) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001547 Writer.flush();
Zachary Turner01ee3dae2016-06-16 18:22:27 +00001548 error(llvm::errorToErrorCode(std::move(EC)));
Reid Kleckner0b269742016-05-14 00:02:53 +00001549 }
1550}