blob: 8e6d2276e0d262575e0fa125d2d394b9e887af1e [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 Kleckner72e2ba72016-01-13 19:32:35 +000025#include "llvm/ADT/StringSet.h"
Reid Kleckner7960de92016-05-04 19:39:28 +000026#include "llvm/DebugInfo/CodeView/CVTypeVisitor.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000027#include "llvm/DebugInfo/CodeView/CodeView.h"
Reid Klecknere9ab3492016-01-14 19:20:17 +000028#include "llvm/DebugInfo/CodeView/Line.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000029#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000030#include "llvm/DebugInfo/CodeView/TypeIndex.h"
31#include "llvm/DebugInfo/CodeView/TypeRecord.h"
Zachary Turner2d02cee2016-05-03 22:18:17 +000032#include "llvm/DebugInfo/CodeView/TypeStream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000033#include "llvm/Object/COFF.h"
34#include "llvm/Object/ObjectFile.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000035#include "llvm/Support/COFF.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000036#include "llvm/Support/Casting.h"
37#include "llvm/Support/Compiler.h"
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000038#include "llvm/Support/DataExtractor.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000039#include "llvm/Support/Format.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000040#include "llvm/Support/ScopedPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000041#include "llvm/Support/SourceMgr.h"
42#include "llvm/Support/Win64EH.h"
43#include "llvm/Support/raw_ostream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000044#include <algorithm>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000045#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000046#include <system_error>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000047#include <time.h>
Eric Christopher9cad53c2013-04-03 18:31:38 +000048
49using namespace llvm;
50using namespace llvm::object;
Reid Kleckner72e2ba72016-01-13 19:32:35 +000051using namespace llvm::codeview;
Reid Kleckner6b3faef2016-01-13 23:44:57 +000052using namespace llvm::support;
Eric Christopher9cad53c2013-04-03 18:31:38 +000053using namespace llvm::Win64EH;
54
55namespace {
56
Reid Kleckner7960de92016-05-04 19:39:28 +000057class CVTypeDumper : public CVTypeVisitor<CVTypeDumper> {
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +000058public:
Zachary Turner88bb1632016-05-03 00:28:04 +000059 CVTypeDumper(ScopedPrinter &W) : W(W) {}
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +000060
61 StringRef getTypeName(TypeIndex TI);
62 void printTypeIndex(StringRef FieldName, TypeIndex TI);
63
Reid Kleckner7960de92016-05-04 19:39:28 +000064 void dump(ArrayRef<uint8_t> Data);
65
66 /// CVTypeVisitor overrides.
67#define TYPE_RECORD(ClassName, LeafEnum) \
68 void visit##ClassName(TypeLeafKind LeafType, const ClassName *Record, \
69 ArrayRef<uint8_t> LeafData);
70#define TYPE_RECORD_ALIAS(ClassName, LeafEnum)
71#define MEMBER_RECORD(ClassName, LeafEnum) \
72 void visit##ClassName(TypeLeafKind LeafType, const ClassName *Record, \
73 ArrayRef<uint8_t> &FieldData);
74#define MEMBER_RECORD_ALIAS(ClassName, LeafEnum)
75#include "llvm/DebugInfo/CodeView/TypeRecords.def"
76
77 /// Method overload lists are a special case.
78 void visitMethodList(TypeLeafKind Leaf, ArrayRef<uint8_t> LeafData);
79
80 void visitUnknownMember(TypeLeafKind Leaf);
81
82 void visitTypeBegin(TypeLeafKind Leaf, ArrayRef<uint8_t> LeafData);
83 void visitTypeEnd(TypeLeafKind Leaf, ArrayRef<uint8_t> LeafData);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +000084
85private:
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +000086 void printMemberAttributes(MemberAttributes Attrs);
87
Reid Kleckner7960de92016-05-04 19:39:28 +000088 /// Reinterpret a byte array as an array of characters. Does not interpret as
89 /// a C string, as StringRef has several helpers (split) that make that easy.
90 static StringRef getBytesAsCharacters(ArrayRef<uint8_t> LeafData) {
91 return StringRef(reinterpret_cast<const char *>(LeafData.data()),
92 LeafData.size());
93 }
94
95 static StringRef getBytesAsCString(ArrayRef<uint8_t> LeafData) {
96 return getBytesAsCharacters(LeafData).split('\0').first;
97 }
98
Zachary Turner88bb1632016-05-03 00:28:04 +000099 ScopedPrinter &W;
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000100
Reid Kleckner7960de92016-05-04 19:39:28 +0000101 /// Name of the current type. Only valid before visitTypeEnd.
102 StringRef Name;
103
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000104 /// All user defined type records in .debug$T live in here. Type indices
105 /// greater than 0x1000 are user defined. Subtract 0x1000 from the index to
106 /// index into this vector.
107 SmallVector<StringRef, 10> CVUDTNames;
108
109 StringSet<> TypeNames;
110};
111
Eric Christopher9cad53c2013-04-03 18:31:38 +0000112class COFFDumper : public ObjDumper {
113public:
Zachary Turner88bb1632016-05-03 00:28:04 +0000114 COFFDumper(const llvm::object::COFFObjectFile *Obj, ScopedPrinter &Writer)
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000115 : ObjDumper(Writer), Obj(Obj), CVTD(Writer) {}
Eric Christopher9cad53c2013-04-03 18:31:38 +0000116
Craig Topperfd38cbe2014-08-30 16:48:34 +0000117 void printFileHeaders() override;
118 void printSections() override;
119 void printRelocations() override;
120 void printSymbols() override;
121 void printDynamicSymbols() override;
122 void printUnwindInfo() override;
Rui Ueyama1e152d52014-10-02 17:02:18 +0000123 void printCOFFImports() override;
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +0000124 void printCOFFExports() override;
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +0000125 void printCOFFDirectives() override;
Rui Ueyama74e85132014-11-19 00:18:07 +0000126 void printCOFFBaseReloc() override;
Reid Kleckner83ebad32015-12-16 18:28:12 +0000127 void printCodeViewDebugInfo() override;
Lang Hames0000afd2015-06-26 23:56:53 +0000128 void printStackMap() const override;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000129private:
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000130 void printSymbol(const SymbolRef &Sym);
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000131 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc,
132 uint64_t Bias = 0);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000133 void printDataDirectory(uint32_t Index, const std::string &FieldName);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000134
David Majnemer50267222014-11-05 06:24:35 +0000135 void printDOSHeader(const dos_header *DH);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000136 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
137 void printBaseOfDataField(const pe32_header *Hdr);
138 void printBaseOfDataField(const pe32plus_header *Hdr);
139
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000140 void printCodeViewSymbolSection(StringRef SectionName, const SectionRef &Section);
141 void printCodeViewTypeSection(StringRef SectionName, const SectionRef &Section);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000142 StringRef getTypeName(TypeIndex Ty);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000143 StringRef getFileNameForFileOffset(uint32_t FileOffset);
144 void printFileNameForOffset(StringRef Label, uint32_t FileOffset);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000145 void printTypeIndex(StringRef FieldName, TypeIndex TI) {
146 // Forward to CVTypeDumper for simplicity.
147 CVTD.printTypeIndex(FieldName, TI);
148 }
David Majnemerd74490f2016-02-03 22:45:21 +0000149 void printLocalVariableAddrRange(const LocalVariableAddrRange &Range,
150 const coff_section *Sec,
151 StringRef SectionContents);
David Majnemer4d123512016-02-04 17:37:30 +0000152 void printLocalVariableAddrGap(StringRef &SymData);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000153
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000154 void printCodeViewSymbolsSubsection(StringRef Subsection,
155 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000156 StringRef SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000157
Reid Klecknerc31f5302016-01-15 18:06:25 +0000158 void printCodeViewFileChecksums(StringRef Subsection);
159
Reid Klecknere9ab3492016-01-14 19:20:17 +0000160 void printCodeViewInlineeLines(StringRef Subsection);
161
Reid Kleckner2893fd12016-01-14 17:51:54 +0000162 void printRelocatedField(StringRef Label, const coff_section *Sec,
163 StringRef SectionContents, const ulittle32_t *Field,
164 StringRef *RelocSym = nullptr);
165
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000166 void printBinaryBlockWithRelocs(StringRef Label, const SectionRef &Sec,
167 StringRef SectionContents, StringRef Block);
168
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000169 /// Given a .debug$S section, find the string table and file checksum table.
170 void initializeFileAndStringTables(StringRef Data);
171
Eric Christopher9cad53c2013-04-03 18:31:38 +0000172 void cacheRelocations();
173
Rafael Espindola4453e42942014-06-13 03:07:50 +0000174 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
175 SymbolRef &Sym);
176 std::error_code resolveSymbolName(const coff_section *Section,
177 uint64_t Offset, StringRef &Name);
Reid Kleckner2893fd12016-01-14 17:51:54 +0000178 std::error_code resolveSymbolName(const coff_section *Section,
179 StringRef SectionContents,
180 const void *RelocPtr, StringRef &Name);
Rui Ueyama979fb402014-10-09 02:16:38 +0000181 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +0000182 void printDelayImportedSymbols(
183 const DelayImportDirectoryEntryRef &I,
184 iterator_range<imported_symbol_iterator> Range);
Rui Ueyama15d99352014-10-03 00:41:58 +0000185
Eric Christopher9cad53c2013-04-03 18:31:38 +0000186 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
187
188 const llvm::object::COFFObjectFile *Obj;
Rafael Espindola76d650e2015-07-06 14:26:07 +0000189 bool RelocCached = false;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000190 RelocMapTy RelocMap;
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000191 StringRef CVFileChecksumTable;
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000192 StringRef CVStringTable;
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000193
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000194 CVTypeDumper CVTD;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000195};
196
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000197} // namespace
198
Eric Christopher9cad53c2013-04-03 18:31:38 +0000199
200namespace llvm {
201
Rafael Espindola4453e42942014-06-13 03:07:50 +0000202std::error_code createCOFFDumper(const object::ObjectFile *Obj,
Zachary Turner88bb1632016-05-03 00:28:04 +0000203 ScopedPrinter &Writer,
Rafael Espindola4453e42942014-06-13 03:07:50 +0000204 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000205 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
206 if (!COFFObj)
207 return readobj_error::unsupported_obj_file_format;
208
209 Result.reset(new COFFDumper(COFFObj, Writer));
210 return readobj_error::success;
211}
212
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000213} // namespace llvm
Eric Christopher9cad53c2013-04-03 18:31:38 +0000214
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000215// Given a a section and an offset into this section the function returns the
216// symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000217std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
218 uint64_t Offset, SymbolRef &Sym) {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000219 cacheRelocations();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000220 const auto &Relocations = RelocMap[Section];
221 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) {
Saleem Abdulrasool4a6f5832014-05-20 05:18:06 +0000225 Sym = *Relocation.getSymbol();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000226 return readobj_error::success;
227 }
228 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000229 return readobj_error::unknown_symbol;
230}
231
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000232// Given a section and an offset into this section the function returns the name
233// of the symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000234std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
235 uint64_t Offset,
236 StringRef &Name) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000237 SymbolRef Symbol;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000238 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000239 return EC;
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000240 Expected<StringRef> NameOrErr = Symbol.getName();
241 if (!NameOrErr)
242 return errorToErrorCode(NameOrErr.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000243 Name = *NameOrErr;
Rui Ueyama7d099192015-06-09 15:20:42 +0000244 return std::error_code();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000245}
246
Reid Kleckner2893fd12016-01-14 17:51:54 +0000247// Helper for when you have a pointer to real data and you want to know about
248// relocations against it.
249std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
250 StringRef SectionContents,
251 const void *RelocPtr,
252 StringRef &Name) {
253 assert(SectionContents.data() < RelocPtr &&
254 RelocPtr < SectionContents.data() + SectionContents.size() &&
255 "pointer to relocated object is not in section");
256 uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) -
257 SectionContents.data());
258 return resolveSymbolName(Section, Offset, Name);
259}
260
261void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec,
262 StringRef SectionContents,
263 const ulittle32_t *Field,
264 StringRef *RelocSym) {
265 StringRef SymStorage;
266 StringRef &Symbol = RelocSym ? *RelocSym : SymStorage;
267 if (!resolveSymbolName(Sec, SectionContents, Field, Symbol))
268 W.printSymbolOffset(Label, Symbol, *Field);
269 else
270 W.printHex(Label, *Field);
271}
272
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000273void COFFDumper::printBinaryBlockWithRelocs(StringRef Label,
274 const SectionRef &Sec,
275 StringRef SectionContents,
276 StringRef Block) {
277 W.printBinaryBlock(Label, Block);
278
279 assert(SectionContents.begin() < Block.begin() &&
280 SectionContents.end() >= Block.end() &&
281 "Block is not contained in SectionContents");
282 uint64_t OffsetStart = Block.data() - SectionContents.data();
283 uint64_t OffsetEnd = OffsetStart + Block.size();
284
285 cacheRelocations();
286 ListScope D(W, "BlockRelocations");
287 const coff_section *Section = Obj->getCOFFSection(Sec);
288 const auto &Relocations = RelocMap[Section];
289 for (const auto &Relocation : Relocations) {
290 uint64_t RelocationOffset = Relocation.getOffset();
291 if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd)
292 printRelocation(Sec, Relocation, OffsetStart);
293 }
294}
295
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000296static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000297 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
298 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
299 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
300 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
Saleem Abdulrasool5e1780e2014-03-11 03:08:37 +0000301 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000302 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
303 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
304 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
305 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
306 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
307 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
308 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
309 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
310 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
311 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
312 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
313 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
314 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
315 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
316 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
317 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
318};
319
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000320static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000321 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
322 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
323 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
324 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
325 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
326 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
327 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
328 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
329 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
330 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
331 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
332 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
333 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
334 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
335 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
336};
337
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000338static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000339 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
340 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
341 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
342 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
343 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
344 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
345 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
346 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
347 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
348 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
349 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
350};
351
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000352static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
Rui Ueyama06dc5e72014-01-27 04:22:24 +0000353 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000354 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
355 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
356 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
357 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
358 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
359 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000360 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000361 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000362 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000363 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
364};
365
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000366static const EnumEntry<COFF::SectionCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000367ImageSectionCharacteristics[] = {
David Majnemerd3238882015-07-30 16:47:56 +0000368 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000369 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
370 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
371 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
372 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
373 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
374 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
375 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
376 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
377 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
378 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
379 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
380 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
381 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
382 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
383 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
384 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
385 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
386 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
387 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
388 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
389 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
390 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
391 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
392 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
393 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
394 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
395 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
396 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
397 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
398 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
399 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
400 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
401 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
402 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
403 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
404};
405
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000406static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000407 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
408 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
409 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
410 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
411 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
412 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
413 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
414 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
415 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
416 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
417 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
418 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
419 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
420 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
421 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
422 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
423};
424
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000425static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000426 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
427 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
428 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
429 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
430};
431
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000432static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000433 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
434 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
435 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
436 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
437 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
438 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
439 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
440 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
441 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
442 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
443 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
444 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
445 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
446 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
447 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
448 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
449 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
450 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
451 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
452 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
453 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
454 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
455 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
456 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
457 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
458 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
459 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
460};
461
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000462static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000463 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
464 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
465 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
466 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
467 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
468 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
469 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
470};
471
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000472static const EnumEntry<COFF::WeakExternalCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000473WeakExternalCharacteristics[] = {
474 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
475 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
476 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
477};
478
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000479static const EnumEntry<CompileSym3::Flags> CompileSym3Flags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000480 LLVM_READOBJ_ENUM_ENT(CompileSym3, EC),
481 LLVM_READOBJ_ENUM_ENT(CompileSym3, NoDbgInfo),
482 LLVM_READOBJ_ENUM_ENT(CompileSym3, LTCG),
483 LLVM_READOBJ_ENUM_ENT(CompileSym3, NoDataAlign),
484 LLVM_READOBJ_ENUM_ENT(CompileSym3, ManagedPresent),
485 LLVM_READOBJ_ENUM_ENT(CompileSym3, SecurityChecks),
486 LLVM_READOBJ_ENUM_ENT(CompileSym3, HotPatch),
487 LLVM_READOBJ_ENUM_ENT(CompileSym3, CVTCIL),
488 LLVM_READOBJ_ENUM_ENT(CompileSym3, MSILModule),
489 LLVM_READOBJ_ENUM_ENT(CompileSym3, Sdl),
490 LLVM_READOBJ_ENUM_ENT(CompileSym3, PGO),
491 LLVM_READOBJ_ENUM_ENT(CompileSym3, Exp),
492};
493
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000494static const EnumEntry<codeview::SourceLanguage> SourceLanguages[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000495 LLVM_READOBJ_ENUM_ENT(SourceLanguage, C),
496 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Cpp),
497 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Fortran),
498 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Masm),
499 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Pascal),
500 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Basic),
501 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Cobol),
502 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Link),
503 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Cvtres),
504 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Cvtpgd),
505 LLVM_READOBJ_ENUM_ENT(SourceLanguage, CSharp),
506 LLVM_READOBJ_ENUM_ENT(SourceLanguage, VB),
507 LLVM_READOBJ_ENUM_ENT(SourceLanguage, ILAsm),
508 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Java),
509 LLVM_READOBJ_ENUM_ENT(SourceLanguage, JScript),
510 LLVM_READOBJ_ENUM_ENT(SourceLanguage, MSIL),
511 LLVM_READOBJ_ENUM_ENT(SourceLanguage, HLSL),
512};
513
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000514static const EnumEntry<uint32_t> SubSectionTypes[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000515 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Symbols),
516 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Lines),
517 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, StringTable),
518 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FileChecksums),
519 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FrameData),
520 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, InlineeLines),
521 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeImports),
522 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeExports),
523 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, ILLines),
524 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FuncMDTokenMap),
525 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, TypeMDTokenMap),
526 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, MergedAssemblyInput),
527 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CoffSymbolRVA),
528};
529
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000530static const EnumEntry<unsigned> CPUTypeNames[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000531 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Intel8080),
532 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Intel8086),
533 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Intel80286),
534 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Intel80386),
535 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Intel80486),
536 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Pentium),
537 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PentiumPro),
538 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Pentium3),
539 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPS),
540 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPS16),
541 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPS32),
542 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPS64),
543 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPSI),
544 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPSII),
545 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPSIII),
546 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPSIV),
547 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPSV),
548 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M68000),
549 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M68010),
550 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M68020),
551 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M68030),
552 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M68040),
553 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Alpha),
554 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Alpha21164),
555 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Alpha21164A),
556 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Alpha21264),
557 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Alpha21364),
558 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPC601),
559 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPC603),
560 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPC604),
561 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPC620),
562 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPCFP),
563 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPCBE),
564 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, SH3),
565 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, SH3E),
566 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, SH3DSP),
567 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, SH4),
568 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, SHMedia),
569 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM3),
570 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM4),
571 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM4T),
572 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM5),
573 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM5T),
574 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM6),
575 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM_XMAC),
576 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM_WMMX),
577 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM7),
578 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Omni),
579 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Ia64),
580 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Ia64_2),
581 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, CEE),
582 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, AM33),
583 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M32R),
584 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, TriCore),
585 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, X64),
586 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, EBC),
587 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Thumb),
588 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARMNT),
589 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, D3D11_Shader),
590};
591
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000592static const EnumEntry<uint8_t> ProcSymFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000593 LLVM_READOBJ_ENUM_ENT(ProcFlags, HasFP),
594 LLVM_READOBJ_ENUM_ENT(ProcFlags, HasIRET),
595 LLVM_READOBJ_ENUM_ENT(ProcFlags, HasFRET),
596 LLVM_READOBJ_ENUM_ENT(ProcFlags, IsNoReturn),
597 LLVM_READOBJ_ENUM_ENT(ProcFlags, IsUnreachable),
598 LLVM_READOBJ_ENUM_ENT(ProcFlags, HasCustomCallingConv),
599 LLVM_READOBJ_ENUM_ENT(ProcFlags, IsNoInline),
600 LLVM_READOBJ_ENUM_ENT(ProcFlags, HasOptimizedDebugInfo),
601};
602
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000603static const EnumEntry<uint32_t> FrameProcSymFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000604 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, HasAlloca),
605 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, HasSetJmp),
606 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, HasLongJmp),
607 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, HasInlineAssembly),
608 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, HasExceptionHandling),
609 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, MarkedInline),
610 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions,
611 HasStructuredExceptionHandling),
612 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, Naked),
613 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, SecurityChecks),
614 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions,
615 AsynchronousExceptionHandling),
616 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions,
617 NoStackOrderingForSecurityChecks),
618 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, Inlined),
619 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, StrictSecurityChecks),
620 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, SafeBuffers),
621 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions,
622 ProfileGuidedOptimization),
623 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, ValidProfileCounts),
624 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, OptimizedForSpeed),
625 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, GuardCfg),
626 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, GuardCfw),
627};
628
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000629static const EnumEntry<uint32_t> FrameDataFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000630 LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH),
631 LLVM_READOBJ_ENUM_ENT(FrameData, HasEH),
632 LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart),
633};
634
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000635static const EnumEntry<uint16_t> LocalFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000636 LLVM_READOBJ_ENUM_ENT(LocalSym, IsParameter),
637 LLVM_READOBJ_ENUM_ENT(LocalSym, IsAddressTaken),
638 LLVM_READOBJ_ENUM_ENT(LocalSym, IsCompilerGenerated),
639 LLVM_READOBJ_ENUM_ENT(LocalSym, IsAggregate),
640 LLVM_READOBJ_ENUM_ENT(LocalSym, IsAggregated),
641 LLVM_READOBJ_ENUM_ENT(LocalSym, IsAliased),
642 LLVM_READOBJ_ENUM_ENT(LocalSym, IsAlias),
643 LLVM_READOBJ_ENUM_ENT(LocalSym, IsReturnValue),
644 LLVM_READOBJ_ENUM_ENT(LocalSym, IsOptimizedOut),
645 LLVM_READOBJ_ENUM_ENT(LocalSym, IsEnregisteredGlobal),
646 LLVM_READOBJ_ENUM_ENT(LocalSym, IsEnregisteredStatic),
647};
648
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000649static const EnumEntry<uint16_t> FrameCookieKinds[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000650 LLVM_READOBJ_ENUM_ENT(FrameCookieSym, Copy),
651 LLVM_READOBJ_ENUM_ENT(FrameCookieSym, XorStackPointer),
652 LLVM_READOBJ_ENUM_ENT(FrameCookieSym, XorFramePointer),
653 LLVM_READOBJ_ENUM_ENT(FrameCookieSym, XorR13),
654};
655
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000656static const EnumEntry<uint16_t> ClassOptionNames[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000657 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, Packed),
658 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, HasConstructorOrDestructor),
659 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, HasOverloadedOperator),
660 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, Nested),
661 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, ContainsNestedClass),
662 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, HasOverloadedAssignmentOperator),
663 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, HasConversionOperator),
664 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, ForwardReference),
665 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, Scoped),
666 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, HasUniqueName),
667 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, Sealed),
668 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, Intrinsic),
669};
670
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000671static const EnumEntry<uint8_t> MemberAccessNames[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000672 LLVM_READOBJ_ENUM_CLASS_ENT(MemberAccess, None),
673 LLVM_READOBJ_ENUM_CLASS_ENT(MemberAccess, Private),
674 LLVM_READOBJ_ENUM_CLASS_ENT(MemberAccess, Protected),
675 LLVM_READOBJ_ENUM_CLASS_ENT(MemberAccess, Public),
676};
677
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000678static const EnumEntry<uint16_t> MethodOptionNames[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000679 LLVM_READOBJ_ENUM_CLASS_ENT(MethodOptions, Pseudo),
680 LLVM_READOBJ_ENUM_CLASS_ENT(MethodOptions, NoInherit),
681 LLVM_READOBJ_ENUM_CLASS_ENT(MethodOptions, NoConstruct),
682 LLVM_READOBJ_ENUM_CLASS_ENT(MethodOptions, CompilerGenerated),
683 LLVM_READOBJ_ENUM_CLASS_ENT(MethodOptions, Sealed),
684};
685
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000686static const EnumEntry<uint16_t> MemberKindNames[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000687 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, Vanilla),
688 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, Virtual),
689 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, Static),
690 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, Friend),
691 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, IntroducingVirtual),
692 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, PureVirtual),
693 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, PureIntroducingVirtual),
694};
695
696/// The names here all end in "*". If the simple type is a pointer type, we
697/// return the whole name. Otherwise we lop off the last character in our
698/// StringRef.
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000699static const EnumEntry<SimpleTypeKind> SimpleTypeNames[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000700 {"void*", SimpleTypeKind::Void},
701 {"<not translated>*", SimpleTypeKind::NotTranslated},
702 {"HRESULT*", SimpleTypeKind::HResult},
703 {"signed char*", SimpleTypeKind::SignedCharacter},
704 {"unsigned char*", SimpleTypeKind::UnsignedCharacter},
705 {"char*", SimpleTypeKind::NarrowCharacter},
706 {"wchar_t*", SimpleTypeKind::WideCharacter},
Reid Klecknerf9f1c562016-04-15 18:26:45 +0000707 {"char16_t*", SimpleTypeKind::Character16},
708 {"char32_t*", SimpleTypeKind::Character32},
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000709 {"__int8*", SimpleTypeKind::SByte},
710 {"unsigned __int8*", SimpleTypeKind::Byte},
711 {"short*", SimpleTypeKind::Int16Short},
712 {"unsigned short*", SimpleTypeKind::UInt16Short},
713 {"__int16*", SimpleTypeKind::Int16},
714 {"unsigned __int16*", SimpleTypeKind::UInt16},
715 {"long*", SimpleTypeKind::Int32Long},
716 {"unsigned long*", SimpleTypeKind::UInt32Long},
717 {"int*", SimpleTypeKind::Int32},
718 {"unsigned*", SimpleTypeKind::UInt32},
719 {"__int64*", SimpleTypeKind::Int64Quad},
720 {"unsigned __int64*", SimpleTypeKind::UInt64Quad},
721 {"__int64*", SimpleTypeKind::Int64},
722 {"unsigned __int64*", SimpleTypeKind::UInt64},
723 {"__int128*", SimpleTypeKind::Int128},
724 {"unsigned __int128*", SimpleTypeKind::UInt128},
725 {"__half*", SimpleTypeKind::Float16},
726 {"float*", SimpleTypeKind::Float32},
727 {"float*", SimpleTypeKind::Float32PartialPrecision},
728 {"__float48*", SimpleTypeKind::Float48},
729 {"double*", SimpleTypeKind::Float64},
730 {"long double*", SimpleTypeKind::Float80},
731 {"__float128*", SimpleTypeKind::Float128},
732 {"_Complex float*", SimpleTypeKind::Complex32},
733 {"_Complex double*", SimpleTypeKind::Complex64},
734 {"_Complex long double*", SimpleTypeKind::Complex80},
735 {"_Complex __float128*", SimpleTypeKind::Complex128},
736 {"bool*", SimpleTypeKind::Boolean8},
737 {"__bool16*", SimpleTypeKind::Boolean16},
738 {"__bool32*", SimpleTypeKind::Boolean32},
739 {"__bool64*", SimpleTypeKind::Boolean64},
740};
741
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000742static const EnumEntry<TypeLeafKind> LeafTypeNames[] = {
Reid Kleckner6b3faef2016-01-13 23:44:57 +0000743#define LEAF_TYPE(name, val) LLVM_READOBJ_ENUM_ENT(TypeLeafKind, name),
744#include "llvm/DebugInfo/CodeView/CVLeafTypes.def"
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000745};
746
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000747static const EnumEntry<uint8_t> PtrKindNames[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000748 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Near16),
749 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Far16),
750 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Huge16),
751 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnSegment),
752 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnValue),
753 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnSegmentValue),
754 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnAddress),
755 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnSegmentAddress),
756 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnType),
757 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnSelf),
758 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Near32),
759 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Far32),
760 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Near64),
761};
762
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000763static const EnumEntry<uint8_t> PtrModeNames[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000764 LLVM_READOBJ_ENUM_CLASS_ENT(PointerMode, Pointer),
765 LLVM_READOBJ_ENUM_CLASS_ENT(PointerMode, LValueReference),
766 LLVM_READOBJ_ENUM_CLASS_ENT(PointerMode, PointerToDataMember),
767 LLVM_READOBJ_ENUM_CLASS_ENT(PointerMode, PointerToMemberFunction),
768 LLVM_READOBJ_ENUM_CLASS_ENT(PointerMode, RValueReference),
769};
770
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000771static const EnumEntry<uint16_t> PtrMemberRepNames[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000772 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation, Unknown),
773 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
774 SingleInheritanceData),
775 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
776 MultipleInheritanceData),
777 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
778 VirtualInheritanceData),
779 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation, GeneralData),
780 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
781 SingleInheritanceFunction),
782 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
783 MultipleInheritanceFunction),
784 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
785 VirtualInheritanceFunction),
786 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation, GeneralFunction),
787};
788
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000789static const EnumEntry<uint16_t> TypeModifierNames[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000790 LLVM_READOBJ_ENUM_CLASS_ENT(ModifierOptions, Const),
791 LLVM_READOBJ_ENUM_CLASS_ENT(ModifierOptions, Volatile),
792 LLVM_READOBJ_ENUM_CLASS_ENT(ModifierOptions, Unaligned),
793};
794
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000795static const EnumEntry<uint8_t> CallingConventions[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000796 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearC),
797 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, FarC),
798 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearPascal),
799 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, FarPascal),
800 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearFast),
801 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, FarFast),
802 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearStdCall),
803 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, FarStdCall),
804 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearSysCall),
805 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, FarSysCall),
806 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, ThisCall),
807 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, MipsCall),
808 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, Generic),
809 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, AlphaCall),
810 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, PpcCall),
811 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, SHCall),
812 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, ArmCall),
813 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, AM33Call),
814 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, TriCall),
815 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, SH5Call),
816 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, M32RCall),
817 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, ClrCall),
818 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, Inline),
819 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearVector),
820};
821
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000822static const EnumEntry<uint8_t> FunctionOptionEnum[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000823 LLVM_READOBJ_ENUM_CLASS_ENT(FunctionOptions, CxxReturnUdt),
824 LLVM_READOBJ_ENUM_CLASS_ENT(FunctionOptions, Constructor),
825 LLVM_READOBJ_ENUM_CLASS_ENT(FunctionOptions, ConstructorWithVirtualBases),
826};
827
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000828static const EnumEntry<uint8_t> FileChecksumKindNames[] = {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000829 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, None),
830 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, MD5),
831 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA1),
832 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA256),
833};
834
Rafael Espindola4453e42942014-06-13 03:07:50 +0000835template <typename T>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000836static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
David Majnemer44f51e52014-09-10 12:51:52 +0000837 COFFSymbolRef Symbol,
838 uint8_t AuxSymbolIdx, const T *&Aux) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000839 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
David Majnemer44f51e52014-09-10 12:51:52 +0000840 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000841 Aux = reinterpret_cast<const T*>(AuxData.data());
842 return readobj_error::success;
843}
844
Eric Christopher9cad53c2013-04-03 18:31:38 +0000845void COFFDumper::cacheRelocations() {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000846 if (RelocCached)
847 return;
848 RelocCached = true;
849
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000850 for (const SectionRef &S : Obj->sections()) {
851 const coff_section *Section = Obj->getCOFFSection(S);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000852
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000853 for (const RelocationRef &Reloc : S.relocations())
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000854 RelocMap[Section].push_back(Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000855
856 // Sort relocations by address.
857 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
858 relocAddressLess);
859 }
860}
861
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000862void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
863 const data_directory *Data;
864 if (Obj->getDataDirectory(Index, Data))
865 return;
866 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
867 W.printHex(FieldName + "Size", Data->Size);
868}
869
Eric Christopher9cad53c2013-04-03 18:31:38 +0000870void COFFDumper::printFileHeaders() {
David Majnemer44f51e52014-09-10 12:51:52 +0000871 time_t TDS = Obj->getTimeDateStamp();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000872 char FormattedTime[20] = { };
873 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
874
875 {
876 DictScope D(W, "ImageFileHeader");
David Majnemer44f51e52014-09-10 12:51:52 +0000877 W.printEnum ("Machine", Obj->getMachine(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000878 makeArrayRef(ImageFileMachineType));
David Majnemer44f51e52014-09-10 12:51:52 +0000879 W.printNumber("SectionCount", Obj->getNumberOfSections());
880 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
881 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
882 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
883 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
884 W.printFlags ("Characteristics", Obj->getCharacteristics(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000885 makeArrayRef(ImageFileCharacteristics));
886 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000887
888 // Print PE header. This header does not exist if this is an object file and
889 // not an executable.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000890 const pe32_header *PEHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000891 error(Obj->getPE32Header(PEHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000892 if (PEHeader)
893 printPEHeader<pe32_header>(PEHeader);
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000894
Craig Toppere6cb63e2014-04-25 04:24:47 +0000895 const pe32plus_header *PEPlusHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000896 error(Obj->getPE32PlusHeader(PEPlusHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000897 if (PEPlusHeader)
898 printPEHeader<pe32plus_header>(PEPlusHeader);
David Majnemer50267222014-11-05 06:24:35 +0000899
900 if (const dos_header *DH = Obj->getDOSHeader())
901 printDOSHeader(DH);
902}
903
904void COFFDumper::printDOSHeader(const dos_header *DH) {
905 DictScope D(W, "DOSHeader");
906 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
907 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
908 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
909 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
910 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
911 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
912 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
913 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
914 W.printNumber("InitialSP", DH->InitialSP);
915 W.printNumber("Checksum", DH->Checksum);
916 W.printNumber("InitialIP", DH->InitialIP);
917 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
918 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
919 W.printNumber("OverlayNumber", DH->OverlayNumber);
920 W.printNumber("OEMid", DH->OEMid);
921 W.printNumber("OEMinfo", DH->OEMinfo);
922 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000923}
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000924
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000925template <class PEHeader>
926void COFFDumper::printPEHeader(const PEHeader *Hdr) {
927 DictScope D(W, "ImageOptionalHeader");
928 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
929 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
930 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
931 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
932 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
933 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
934 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
935 printBaseOfDataField(Hdr);
936 W.printHex ("ImageBase", Hdr->ImageBase);
937 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
938 W.printNumber("FileAlignment", Hdr->FileAlignment);
939 W.printNumber("MajorOperatingSystemVersion",
940 Hdr->MajorOperatingSystemVersion);
941 W.printNumber("MinorOperatingSystemVersion",
942 Hdr->MinorOperatingSystemVersion);
943 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
944 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
945 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
946 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
947 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
948 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
949 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
David Majnemer774aadf2014-11-18 02:45:28 +0000950 W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000951 makeArrayRef(PEDLLCharacteristics));
952 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
953 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
954 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
955 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
956 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000957
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000958 if (Hdr->NumberOfRvaAndSize > 0) {
959 DictScope D(W, "DataDirectory");
960 static const char * const directory[] = {
961 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
962 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
963 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
964 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
965 };
966
967 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
968 printDataDirectory(i, directory[i]);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000969 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000970 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000971}
972
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000973void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
974 W.printHex("BaseOfData", Hdr->BaseOfData);
975}
976
977void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
978
Reid Kleckner83ebad32015-12-16 18:28:12 +0000979void COFFDumper::printCodeViewDebugInfo() {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000980 // Print types first to build CVUDTNames, then print symbols.
Reid Kleckner83ebad32015-12-16 18:28:12 +0000981 for (const SectionRef &S : Obj->sections()) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000982 StringRef SectionName;
983 error(S.getName(SectionName));
984 if (SectionName == ".debug$T")
985 printCodeViewTypeSection(SectionName, S);
986 }
987 for (const SectionRef &S : Obj->sections()) {
988 StringRef SectionName;
989 error(S.getName(SectionName));
990 if (SectionName == ".debug$S")
991 printCodeViewSymbolSection(SectionName, S);
Reid Kleckner83ebad32015-12-16 18:28:12 +0000992 }
993}
994
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000995void COFFDumper::initializeFileAndStringTables(StringRef Data) {
996 while (!Data.empty() && (CVFileChecksumTable.data() == nullptr ||
997 CVStringTable.data() == nullptr)) {
998 // The section consists of a number of subsection in the following format:
999 // |SubSectionType|SubSectionSize|Contents...|
1000 uint32_t SubType, SubSectionSize;
1001 error(consumeUInt32(Data, SubType));
1002 error(consumeUInt32(Data, SubSectionSize));
1003 if (SubSectionSize > Data.size())
1004 return error(object_error::parse_failed);
1005 switch (ModuleSubstreamKind(SubType)) {
1006 case ModuleSubstreamKind::FileChecksums:
1007 CVFileChecksumTable = Data.substr(0, SubSectionSize);
1008 break;
1009 case ModuleSubstreamKind::StringTable:
1010 CVStringTable = Data.substr(0, SubSectionSize);
1011 break;
1012 default:
1013 break;
1014 }
1015 Data = Data.drop_front(alignTo(SubSectionSize, 4));
1016 }
1017}
1018
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001019void COFFDumper::printCodeViewSymbolSection(StringRef SectionName,
1020 const SectionRef &Section) {
1021 StringRef SectionContents;
1022 error(Section.getContents(SectionContents));
1023 StringRef Data = SectionContents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001024
1025 SmallVector<StringRef, 10> FunctionNames;
1026 StringMap<StringRef> FunctionLineTables;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001027
Zachary Turner99f02152015-02-18 19:32:05 +00001028 ListScope D(W, "CodeViewDebugInfo");
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001029 // Print the section to allow correlation with printSections.
1030 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001031
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001032 uint32_t Magic;
1033 error(consumeUInt32(Data, Magic));
1034 W.printHex("Magic", Magic);
1035 if (Magic != COFF::DEBUG_SECTION_MAGIC)
1036 return error(object_error::parse_failed);
1037
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001038 initializeFileAndStringTables(Data);
1039
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001040 while (!Data.empty()) {
1041 // The section consists of a number of subsection in the following format:
1042 // |SubSectionType|SubSectionSize|Contents...|
1043 uint32_t SubType, SubSectionSize;
1044 error(consumeUInt32(Data, SubType));
1045 error(consumeUInt32(Data, SubSectionSize));
1046
1047 ListScope S(W, "Subsection");
1048 W.printEnum("SubSectionType", SubType, makeArrayRef(SubSectionTypes));
1049 W.printHex("SubSectionSize", SubSectionSize);
1050
1051 // Get the contents of the subsection.
1052 if (SubSectionSize > Data.size())
1053 return error(object_error::parse_failed);
1054 StringRef Contents = Data.substr(0, SubSectionSize);
1055
1056 // Add SubSectionSize to the current offset and align that offset to find
1057 // the next subsection.
1058 size_t SectionOffset = Data.data() - SectionContents.data();
1059 size_t NextOffset = SectionOffset + SubSectionSize;
Rui Ueyamada00f2f2016-01-14 21:06:47 +00001060 NextOffset = alignTo(NextOffset, 4);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001061 Data = SectionContents.drop_front(NextOffset);
1062
1063 // Optionally print the subsection bytes in case our parsing gets confused
1064 // later.
1065 if (opts::CodeViewSubsectionBytes)
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001066 printBinaryBlockWithRelocs("SubSectionContents", Section, SectionContents,
1067 Contents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001068
1069 switch (ModuleSubstreamKind(SubType)) {
1070 case ModuleSubstreamKind::Symbols:
Reid Kleckner2893fd12016-01-14 17:51:54 +00001071 printCodeViewSymbolsSubsection(Contents, Section, SectionContents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001072 break;
Reid Klecknere9ab3492016-01-14 19:20:17 +00001073
1074 case ModuleSubstreamKind::InlineeLines:
1075 printCodeViewInlineeLines(Contents);
1076 break;
1077
Reid Klecknerc31f5302016-01-15 18:06:25 +00001078 case ModuleSubstreamKind::FileChecksums:
1079 printCodeViewFileChecksums(Contents);
1080 break;
1081
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001082 case ModuleSubstreamKind::Lines: {
1083 // Holds a PC to file:line table. Some data to parse this subsection is
1084 // stored in the other subsections, so just check sanity and store the
1085 // pointers for deferred processing.
1086
1087 if (SubSectionSize < 12) {
1088 // There should be at least three words to store two function
1089 // relocations and size of the code.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001090 error(object_error::parse_failed);
1091 return;
1092 }
1093
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001094 StringRef LinkageName;
1095 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset,
1096 LinkageName));
1097 W.printString("LinkageName", LinkageName);
1098 if (FunctionLineTables.count(LinkageName) != 0) {
1099 // Saw debug info for this function already?
1100 error(object_error::parse_failed);
1101 return;
Zachary Turner99f02152015-02-18 19:32:05 +00001102 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001103
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001104 FunctionLineTables[LinkageName] = Contents;
1105 FunctionNames.push_back(LinkageName);
1106 break;
1107 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001108 case ModuleSubstreamKind::FrameData: {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001109 // First four bytes is a relocation against the function.
1110 const uint32_t *CodePtr;
1111 error(consumeObject(Contents, CodePtr));
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001112 StringRef LinkageName;
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001113 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionContents,
1114 CodePtr, LinkageName));
1115 W.printString("LinkageName", LinkageName);
1116
1117 // To find the active frame description, search this array for the
1118 // smallest PC range that includes the current PC.
1119 while (!Contents.empty()) {
1120 const FrameData *FD;
1121 error(consumeObject(Contents, FD));
1122 DictScope S(W, "FrameData");
1123 W.printHex("RvaStart", FD->RvaStart);
1124 W.printHex("CodeSize", FD->CodeSize);
1125 W.printHex("LocalSize", FD->LocalSize);
1126 W.printHex("ParamsSize", FD->ParamsSize);
1127 W.printHex("MaxStackSize", FD->MaxStackSize);
1128 W.printString("FrameFunc",
1129 CVStringTable.drop_front(FD->FrameFunc).split('\0').first);
1130 W.printHex("PrologSize", FD->PrologSize);
1131 W.printHex("SavedRegsSize", FD->SavedRegsSize);
1132 W.printFlags("Flags", FD->Flags, makeArrayRef(FrameDataFlags));
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001133 }
1134 break;
1135 }
1136
1137 // Do nothing for unrecognized subsections.
1138 default:
1139 break;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001140 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001141 W.flush();
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001142 }
1143
1144 // Dump the line tables now that we've read all the subsections and know all
1145 // the required information.
1146 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
1147 StringRef Name = FunctionNames[I];
1148 ListScope S(W, "FunctionLineTable");
Reid Kleckner7c0c0c02015-12-15 01:23:55 +00001149 W.printString("LinkageName", Name);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001150
1151 DataExtractor DE(FunctionLineTables[Name], true, 4);
David Majnemer3f49e662015-07-09 00:19:51 +00001152 uint32_t Offset = 6; // Skip relocations.
1153 uint16_t Flags = DE.getU16(&Offset);
1154 W.printHex("Flags", Flags);
Reid Kleckner2214ed82016-01-29 00:49:42 +00001155 bool HasColumnInformation = Flags & codeview::LineFlags::HaveColumns;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001156 uint32_t FunctionSize = DE.getU32(&Offset);
1157 W.printHex("CodeSize", FunctionSize);
1158 while (DE.isValidOffset(Offset)) {
1159 // For each range of lines with the same filename, we have a segment
1160 // in the line table. The filename string is accessed using double
1161 // indirection to the string table subsection using the index subsection.
1162 uint32_t OffsetInIndex = DE.getU32(&Offset),
David Majnemer04948362016-01-13 01:05:16 +00001163 NumLines = DE.getU32(&Offset),
David Majnemer0373d532015-07-09 18:14:31 +00001164 FullSegmentSize = DE.getU32(&Offset);
1165
David Majnemer04948362016-01-13 01:05:16 +00001166 uint32_t ColumnOffset = Offset + 8 * NumLines;
1167 DataExtractor ColumnDE(DE.getData(), true, 4);
1168
David Majnemer0373d532015-07-09 18:14:31 +00001169 if (FullSegmentSize !=
David Majnemer04948362016-01-13 01:05:16 +00001170 12 + 8 * NumLines + (HasColumnInformation ? 4 * NumLines : 0)) {
David Majnemer0373d532015-07-09 18:14:31 +00001171 error(object_error::parse_failed);
1172 return;
1173 }
Justin Bognera1413db2015-07-09 04:27:36 +00001174
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001175 ListScope S(W, "FilenameSegment");
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001176 printFileNameForOffset("Filename", OffsetInIndex);
David Majnemer04948362016-01-13 01:05:16 +00001177 for (unsigned LineIdx = 0;
1178 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001179 // Then go the (PC, LineNumber) pairs. The line number is stored in the
1180 // least significant 31 bits of the respective word in the table.
David Majnemer04948362016-01-13 01:05:16 +00001181 uint32_t PC = DE.getU32(&Offset), LineData = DE.getU32(&Offset);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001182 if (PC >= FunctionSize) {
1183 error(object_error::parse_failed);
1184 return;
1185 }
1186 char Buffer[32];
1187 format("+0x%X", PC).snprint(Buffer, 32);
David Majnemer04948362016-01-13 01:05:16 +00001188 ListScope PCScope(W, Buffer);
David Majnemera4859df2016-02-04 17:57:12 +00001189 LineInfo LI(LineData);
1190 if (LI.isAlwaysStepInto())
1191 W.printString("StepInto", StringRef("Always"));
1192 else if (LI.isNeverStepInto())
1193 W.printString("StepInto", StringRef("Never"));
1194 else
1195 W.printNumber("LineNumberStart", LI.getStartLine());
1196 W.printNumber("LineNumberEndDelta", LI.getLineDelta());
1197 W.printBoolean("IsStatement", LI.isStatement());
David Majnemer04948362016-01-13 01:05:16 +00001198 if (HasColumnInformation &&
1199 ColumnDE.isValidOffsetForDataOfSize(ColumnOffset, 4)) {
1200 uint16_t ColStart = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +00001201 W.printNumber("ColStart", ColStart);
David Majnemer04948362016-01-13 01:05:16 +00001202 uint16_t ColEnd = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +00001203 W.printNumber("ColEnd", ColEnd);
1204 }
1205 }
David Majnemer04948362016-01-13 01:05:16 +00001206 // Skip over the column data.
1207 if (HasColumnInformation) {
1208 for (unsigned LineIdx = 0;
1209 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
1210 DE.getU32(&Offset);
1211 }
1212 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001213 }
1214 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001215}
1216
Reid Kleckner7960de92016-05-04 19:39:28 +00001217static std::error_code decodeNumerictLeaf(ArrayRef<uint8_t> &Data,
1218 APSInt &Num) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001219 // Used to avoid overload ambiguity on APInt construtor.
1220 bool FalseVal = false;
1221 if (Data.size() < 2)
1222 return object_error::parse_failed;
1223 uint16_t Short = *reinterpret_cast<const ulittle16_t *>(Data.data());
1224 Data = Data.drop_front(2);
1225 if (Short < LF_NUMERIC) {
1226 Num = APSInt(APInt(/*numBits=*/16, Short, /*isSigned=*/false),
1227 /*isUnsigned=*/true);
1228 return std::error_code();
1229 }
1230 switch (Short) {
1231 case LF_CHAR:
1232 Num = APSInt(APInt(/*numBits=*/8,
1233 *reinterpret_cast<const int8_t *>(Data.data()),
1234 /*isSigned=*/true),
1235 /*isUnsigned=*/false);
1236 Data = Data.drop_front(1);
1237 return std::error_code();
1238 case LF_SHORT:
1239 Num = APSInt(APInt(/*numBits=*/16,
1240 *reinterpret_cast<const little16_t *>(Data.data()),
1241 /*isSigned=*/true),
1242 /*isUnsigned=*/false);
1243 Data = Data.drop_front(2);
1244 return std::error_code();
1245 case LF_USHORT:
1246 Num = APSInt(APInt(/*numBits=*/16,
1247 *reinterpret_cast<const ulittle16_t *>(Data.data()),
1248 /*isSigned=*/false),
1249 /*isUnsigned=*/true);
1250 Data = Data.drop_front(2);
1251 return std::error_code();
1252 case LF_LONG:
1253 Num = APSInt(APInt(/*numBits=*/32,
1254 *reinterpret_cast<const little32_t *>(Data.data()),
1255 /*isSigned=*/true),
1256 /*isUnsigned=*/false);
1257 Data = Data.drop_front(4);
1258 return std::error_code();
1259 case LF_ULONG:
1260 Num = APSInt(APInt(/*numBits=*/32,
1261 *reinterpret_cast<const ulittle32_t *>(Data.data()),
1262 /*isSigned=*/FalseVal),
1263 /*isUnsigned=*/true);
1264 Data = Data.drop_front(4);
1265 return std::error_code();
1266 case LF_QUADWORD:
1267 Num = APSInt(APInt(/*numBits=*/64,
1268 *reinterpret_cast<const little64_t *>(Data.data()),
1269 /*isSigned=*/true),
1270 /*isUnsigned=*/false);
1271 Data = Data.drop_front(8);
1272 return std::error_code();
1273 case LF_UQUADWORD:
1274 Num = APSInt(APInt(/*numBits=*/64,
1275 *reinterpret_cast<const ulittle64_t *>(Data.data()),
1276 /*isSigned=*/false),
1277 /*isUnsigned=*/true);
1278 Data = Data.drop_front(8);
1279 return std::error_code();
1280 }
1281 return object_error::parse_failed;
1282}
1283
Reid Kleckner7960de92016-05-04 19:39:28 +00001284static std::error_code decodeNumerictLeaf(StringRef &Data, APSInt &Num) {
1285 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(Data.data()),
1286 Data.size());
1287 auto EC = decodeNumerictLeaf(Bytes, Num);
1288 Data = StringRef(reinterpret_cast<const char *>(Bytes.data()), Bytes.size());
1289 return EC;
1290}
1291
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001292/// Decode an unsigned integer numeric leaf value.
Reid Kleckner7960de92016-05-04 19:39:28 +00001293std::error_code decodeUIntLeaf(ArrayRef<uint8_t> &Data, uint64_t &Num) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001294 APSInt N;
1295 if (std::error_code err = decodeNumerictLeaf(Data, N))
1296 return err;
1297 if (N.isSigned() || !N.isIntN(64))
1298 return object_error::parse_failed;
1299 Num = N.getLimitedValue();
1300 return std::error_code();
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001301}
1302
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001303void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
1304 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +00001305 StringRef SectionContents) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001306 if (Subsection.size() < sizeof(SymRecord))
1307 return error(object_error::parse_failed);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001308
Reid Kleckner2893fd12016-01-14 17:51:54 +00001309 const coff_section *Sec = Obj->getCOFFSection(Section);
1310
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001311 // This holds the remaining data to parse.
1312 StringRef Data = Subsection;
1313
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001314 bool InFunctionScope = false;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001315 while (!Data.empty()) {
1316 const SymRecord *Rec;
1317 error(consumeObject(Data, Rec));
1318
1319 StringRef SymData = Data.substr(0, Rec->RecordLength - 2);
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00001320 StringRef OrigSymData = SymData;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001321
1322 Data = Data.drop_front(Rec->RecordLength - 2);
1323
Reid Kleckner6b3faef2016-01-13 23:44:57 +00001324 SymbolRecordKind Kind = Rec->getKind();
1325 switch (Kind) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001326 case S_LPROC32:
1327 case S_GPROC32:
1328 case S_GPROC32_ID:
1329 case S_LPROC32_ID:
1330 case S_LPROC32_DPC:
1331 case S_LPROC32_DPC_ID: {
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001332 DictScope S(W, "ProcStart");
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001333 const ProcSym *Proc;
1334 error(consumeObject(SymData, Proc));
1335 if (InFunctionScope)
1336 return error(object_error::parse_failed);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001337 InFunctionScope = true;
1338
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001339 StringRef LinkageName;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001340 StringRef DisplayName = SymData.split('\0').first;
1341 W.printHex("PtrParent", Proc->PtrParent);
1342 W.printHex("PtrEnd", Proc->PtrEnd);
1343 W.printHex("PtrNext", Proc->PtrNext);
1344 W.printHex("CodeSize", Proc->CodeSize);
1345 W.printHex("DbgStart", Proc->DbgStart);
1346 W.printHex("DbgEnd", Proc->DbgEnd);
1347 printTypeIndex("FunctionType", Proc->FunctionType);
Reid Kleckner2893fd12016-01-14 17:51:54 +00001348 printRelocatedField("CodeOffset", Sec, SectionContents, &Proc->CodeOffset,
1349 &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001350 W.printHex("Segment", Proc->Segment);
1351 W.printFlags("Flags", Proc->Flags, makeArrayRef(ProcSymFlags));
1352 W.printString("DisplayName", DisplayName);
1353 W.printString("LinkageName", LinkageName);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001354 break;
1355 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001356
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001357 case S_PROC_ID_END: {
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001358 W.startLine() << "ProcEnd\n";
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001359 InFunctionScope = false;
1360 break;
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001361 }
Zachary Turner99f02152015-02-18 19:32:05 +00001362
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001363 case S_BLOCK32: {
1364 DictScope S(W, "BlockStart");
1365 const BlockSym *Block;
1366 error(consumeObject(SymData, Block));
1367
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001368 StringRef BlockName = SymData.split('\0').first;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001369 StringRef LinkageName;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001370 W.printHex("PtrParent", Block->PtrParent);
1371 W.printHex("PtrEnd", Block->PtrEnd);
1372 W.printHex("CodeSize", Block->CodeSize);
Reid Kleckner2893fd12016-01-14 17:51:54 +00001373 printRelocatedField("CodeOffset", Sec, SectionContents,
1374 &Block->CodeOffset, &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001375 W.printHex("Segment", Block->Segment);
1376 W.printString("BlockName", BlockName);
1377 W.printString("LinkageName", LinkageName);
1378 break;
1379 }
1380
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001381 case S_END: {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001382 W.startLine() << "BlockEnd\n";
1383 InFunctionScope = false;
1384 break;
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001385 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001386
1387 case S_LABEL32: {
1388 DictScope S(W, "Label");
1389 const LabelSym *Label;
1390 error(consumeObject(SymData, Label));
1391
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001392 StringRef DisplayName = SymData.split('\0').first;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001393 StringRef LinkageName;
1394 printRelocatedField("CodeOffset", Sec, SectionContents,
1395 &Label->CodeOffset, &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001396 W.printHex("Segment", Label->Segment);
1397 W.printHex("Flags", Label->Flags);
1398 W.printFlags("Flags", Label->Flags, makeArrayRef(ProcSymFlags));
1399 W.printString("DisplayName", DisplayName);
1400 W.printString("LinkageName", LinkageName);
1401 break;
1402 }
1403
1404 case S_INLINESITE: {
1405 DictScope S(W, "InlineSite");
1406 const InlineSiteSym *InlineSite;
1407 error(consumeObject(SymData, InlineSite));
1408 W.printHex("PtrParent", InlineSite->PtrParent);
1409 W.printHex("PtrEnd", InlineSite->PtrEnd);
1410 printTypeIndex("Inlinee", InlineSite->Inlinee);
David Majnemere21e9092016-01-14 06:12:30 +00001411
1412 auto GetCompressedAnnotation = [&]() -> uint32_t {
1413 if (SymData.empty())
1414 return -1;
1415
1416 uint8_t FirstByte = SymData.front();
1417 SymData = SymData.drop_front();
1418
1419 if ((FirstByte & 0x80) == 0x00)
1420 return FirstByte;
1421
1422 if (SymData.empty())
1423 return -1;
1424
1425 uint8_t SecondByte = SymData.front();
1426 SymData = SymData.drop_front();
1427
1428 if ((FirstByte & 0xC0) == 0x80)
1429 return ((FirstByte & 0x3F) << 8) | SecondByte;
1430
1431 if (SymData.empty())
1432 return -1;
1433
1434 uint8_t ThirdByte = SymData.front();
1435 SymData = SymData.drop_front();
1436
1437 if (SymData.empty())
1438 return -1;
1439
1440 uint8_t FourthByte = SymData.front();
1441 SymData = SymData.drop_front();
1442
1443 if ((FirstByte & 0xE0) == 0xC0)
1444 return ((FirstByte & 0x1F) << 24) | (SecondByte << 16) |
1445 (ThirdByte << 8) | FourthByte;
1446
1447 return -1;
1448 };
1449 auto DecodeSignedOperand = [](uint32_t Operand) -> int32_t {
1450 if (Operand & 1)
1451 return -(Operand >> 1);
1452 return Operand >> 1;
1453 };
1454
1455 ListScope BinaryAnnotations(W, "BinaryAnnotations");
1456 while (!SymData.empty()) {
1457 uint32_t OpCode = GetCompressedAnnotation();
1458 switch (OpCode) {
1459 default:
1460 case Invalid:
1461 return error(object_error::parse_failed);
1462 case CodeOffset:
Reid Kleckner43842b52016-01-14 21:50:05 +00001463 W.printHex("CodeOffset", GetCompressedAnnotation());
David Majnemere21e9092016-01-14 06:12:30 +00001464 break;
1465 case ChangeCodeOffsetBase:
1466 W.printNumber("ChangeCodeOffsetBase", GetCompressedAnnotation());
1467 break;
1468 case ChangeCodeOffset:
Reid Kleckner43842b52016-01-14 21:50:05 +00001469 W.printHex("ChangeCodeOffset", GetCompressedAnnotation());
David Majnemere21e9092016-01-14 06:12:30 +00001470 break;
1471 case ChangeCodeLength:
Reid Kleckner1fcd6102016-02-02 17:41:18 +00001472 W.printHex("ChangeCodeLength", GetCompressedAnnotation());
David Majnemere21e9092016-01-14 06:12:30 +00001473 break;
1474 case ChangeFile:
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001475 printFileNameForOffset("ChangeFile", GetCompressedAnnotation());
David Majnemere21e9092016-01-14 06:12:30 +00001476 break;
1477 case ChangeLineOffset:
1478 W.printNumber("ChangeLineOffset",
1479 DecodeSignedOperand(GetCompressedAnnotation()));
1480 break;
1481 case ChangeLineEndDelta:
1482 W.printNumber("ChangeLineEndDelta", GetCompressedAnnotation());
1483 break;
1484 case ChangeRangeKind:
1485 W.printNumber("ChangeRangeKind", GetCompressedAnnotation());
1486 break;
1487 case ChangeColumnStart:
1488 W.printNumber("ChangeColumnStart", GetCompressedAnnotation());
1489 break;
1490 case ChangeColumnEndDelta:
1491 W.printNumber("ChangeColumnEndDelta",
1492 DecodeSignedOperand(GetCompressedAnnotation()));
1493 break;
1494 case ChangeCodeOffsetAndLineOffset: {
1495 uint32_t Annotation = GetCompressedAnnotation();
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001496 int32_t LineOffset = DecodeSignedOperand(Annotation >> 4);
Reid Kleckner43842b52016-01-14 21:50:05 +00001497 uint32_t CodeOffset = Annotation & 0xf;
Reid Kleckner400f3932016-01-20 23:21:14 +00001498 W.startLine() << "ChangeCodeOffsetAndLineOffset: {CodeOffset: "
1499 << W.hex(CodeOffset) << ", LineOffset: " << LineOffset
Reid Kleckner43842b52016-01-14 21:50:05 +00001500 << "}\n";
David Majnemere21e9092016-01-14 06:12:30 +00001501 break;
1502 }
1503 case ChangeCodeLengthAndCodeOffset: {
Reid Kleckner43842b52016-01-14 21:50:05 +00001504 uint32_t Length = GetCompressedAnnotation();
1505 uint32_t CodeOffset = GetCompressedAnnotation();
Reid Kleckner400f3932016-01-20 23:21:14 +00001506 W.startLine() << "ChangeCodeLengthAndCodeOffset: {CodeOffset: "
1507 << W.hex(CodeOffset) << ", Length: " << W.hex(Length)
1508 << "}\n";
David Majnemere21e9092016-01-14 06:12:30 +00001509 break;
1510 }
1511 case ChangeColumnEnd:
1512 W.printNumber("ChangeColumnEnd", GetCompressedAnnotation());
1513 break;
1514 }
1515 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001516 break;
1517 }
1518
1519 case S_INLINESITE_END: {
1520 DictScope S(W, "InlineSiteEnd");
1521 break;
1522 }
1523
Reid Kleckner43842b52016-01-14 21:50:05 +00001524 case S_CALLERS:
1525 case S_CALLEES: {
1526 ListScope S(W, Kind == S_CALLEES ? "Callees" : "Callers");
1527 uint32_t Count;
1528 error(consumeUInt32(SymData, Count));
1529 for (uint32_t I = 0; I < Count; ++I) {
1530 const TypeIndex *FuncID;
1531 error(consumeObject(SymData, FuncID));
1532 printTypeIndex("FuncID", *FuncID);
1533 }
1534 break;
1535 }
1536
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001537 case S_LOCAL: {
1538 DictScope S(W, "Local");
1539 const LocalSym *Local;
1540 error(consumeObject(SymData, Local));
1541 printTypeIndex("Type", Local->Type);
1542 W.printFlags("Flags", uint16_t(Local->Flags), makeArrayRef(LocalFlags));
1543 StringRef VarName = SymData.split('\0').first;
1544 W.printString("VarName", VarName);
1545 break;
1546 }
1547
David Majnemer4d123512016-02-04 17:37:30 +00001548 case S_DEFRANGE: {
1549 DictScope S(W, "DefRange");
1550 const DefRangeSym *DefRange;
1551 error(consumeObject(SymData, DefRange));
1552 W.printString(
1553 "Program",
1554 CVStringTable.drop_front(DefRange->Program).split('\0').first);
1555 printLocalVariableAddrRange(DefRange->Range, Sec, SectionContents);
1556 printLocalVariableAddrGap(SymData);
1557 break;
1558 }
1559 case S_DEFRANGE_SUBFIELD: {
1560 DictScope S(W, "DefRangeSubfield");
1561 const DefRangeSubfieldSym *DefRangeSubfield;
1562 error(consumeObject(SymData, DefRangeSubfield));
1563 W.printString("Program",
1564 CVStringTable.drop_front(DefRangeSubfield->Program)
1565 .split('\0')
1566 .first);
1567 W.printNumber("OffsetInParent", DefRangeSubfield->OffsetInParent);
1568 printLocalVariableAddrRange(DefRangeSubfield->Range, Sec,
1569 SectionContents);
1570 printLocalVariableAddrGap(SymData);
1571 break;
1572 }
David Majnemerac10cfd2016-02-03 22:36:46 +00001573 case S_DEFRANGE_REGISTER: {
1574 DictScope S(W, "DefRangeRegister");
1575 const DefRangeRegisterSym *DefRangeRegister;
1576 error(consumeObject(SymData, DefRangeRegister));
1577 W.printNumber("Register", DefRangeRegister->Register);
1578 W.printNumber("MayHaveNoName", DefRangeRegister->MayHaveNoName);
David Majnemerd74490f2016-02-03 22:45:21 +00001579 printLocalVariableAddrRange(DefRangeRegister->Range, Sec,
1580 SectionContents);
David Majnemer6f01e052016-02-04 17:29:13 +00001581 printLocalVariableAddrGap(SymData);
David Majnemerac10cfd2016-02-03 22:36:46 +00001582 break;
1583 }
1584 case S_DEFRANGE_SUBFIELD_REGISTER: {
1585 DictScope S(W, "DefRangeSubfieldRegister");
1586 const DefRangeSubfieldRegisterSym *DefRangeSubfieldRegisterSym;
1587 error(consumeObject(SymData, DefRangeSubfieldRegisterSym));
1588 W.printNumber("Register", DefRangeSubfieldRegisterSym->Register);
1589 W.printNumber("MayHaveNoName",
1590 DefRangeSubfieldRegisterSym->MayHaveNoName);
1591 W.printNumber("OffsetInParent",
1592 DefRangeSubfieldRegisterSym->OffsetInParent);
David Majnemerd74490f2016-02-03 22:45:21 +00001593 printLocalVariableAddrRange(DefRangeSubfieldRegisterSym->Range, Sec,
1594 SectionContents);
David Majnemer6f01e052016-02-04 17:29:13 +00001595 printLocalVariableAddrGap(SymData);
David Majnemerac10cfd2016-02-03 22:36:46 +00001596 break;
1597 }
1598 case S_DEFRANGE_FRAMEPOINTER_REL: {
1599 DictScope S(W, "DefRangeFramePointerRel");
1600 const DefRangeFramePointerRelSym *DefRangeFramePointerRel;
1601 error(consumeObject(SymData, DefRangeFramePointerRel));
1602 W.printNumber("Offset", DefRangeFramePointerRel->Offset);
David Majnemerd74490f2016-02-03 22:45:21 +00001603 printLocalVariableAddrRange(DefRangeFramePointerRel->Range, Sec,
1604 SectionContents);
David Majnemer6f01e052016-02-04 17:29:13 +00001605 printLocalVariableAddrGap(SymData);
David Majnemerac10cfd2016-02-03 22:36:46 +00001606 break;
1607 }
1608 case S_DEFRANGE_FRAMEPOINTER_REL_FULL_SCOPE: {
1609 DictScope S(W, "DefRangeFramePointerRelFullScope");
1610 const DefRangeFramePointerRelFullScopeSym
1611 *DefRangeFramePointerRelFullScope;
1612 error(consumeObject(SymData, DefRangeFramePointerRelFullScope));
1613 W.printNumber("Offset", DefRangeFramePointerRelFullScope->Offset);
1614 break;
1615 }
1616 case S_DEFRANGE_REGISTER_REL: {
1617 DictScope S(W, "DefRangeRegisterRel");
1618 const DefRangeRegisterRelSym *DefRangeRegisterRel;
1619 error(consumeObject(SymData, DefRangeRegisterRel));
1620 W.printNumber("BaseRegister", DefRangeRegisterRel->BaseRegister);
1621 W.printBoolean("HasSpilledUDTMember",
1622 DefRangeRegisterRel->hasSpilledUDTMember());
1623 W.printNumber("OffsetInParent", DefRangeRegisterRel->offsetInParent());
Reid Kleckner98762d22016-02-05 19:15:45 +00001624 W.printNumber("BasePointerOffset",
1625 DefRangeRegisterRel->BasePointerOffset);
David Majnemerd74490f2016-02-03 22:45:21 +00001626 printLocalVariableAddrRange(DefRangeRegisterRel->Range, Sec,
1627 SectionContents);
David Majnemer6f01e052016-02-04 17:29:13 +00001628 printLocalVariableAddrGap(SymData);
David Majnemerac10cfd2016-02-03 22:36:46 +00001629 break;
1630 }
1631
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001632 case S_CALLSITEINFO: {
1633 DictScope S(W, "CallSiteInfo");
1634 const CallSiteInfoSym *CallSiteInfo;
1635 error(consumeObject(SymData, CallSiteInfo));
1636
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001637 StringRef LinkageName;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001638 printRelocatedField("CodeOffset", Sec, SectionContents,
1639 &CallSiteInfo->CodeOffset, &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001640 W.printHex("Segment", CallSiteInfo->Segment);
1641 W.printHex("Reserved", CallSiteInfo->Reserved);
1642 printTypeIndex("Type", CallSiteInfo->Type);
1643 W.printString("LinkageName", LinkageName);
1644 break;
1645 }
1646
1647 case S_HEAPALLOCSITE: {
1648 DictScope S(W, "HeapAllocationSite");
1649 const HeapAllocationSiteSym *HeapAllocationSite;
1650 error(consumeObject(SymData, HeapAllocationSite));
1651
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001652 StringRef LinkageName;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001653 printRelocatedField("CodeOffset", Sec, SectionContents,
1654 &HeapAllocationSite->CodeOffset, &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001655 W.printHex("Segment", HeapAllocationSite->Segment);
1656 W.printHex("CallInstructionSize",
1657 HeapAllocationSite->CallInstructionSize);
1658 printTypeIndex("Type", HeapAllocationSite->Type);
1659 W.printString("LinkageName", LinkageName);
1660 break;
1661 }
1662
1663 case S_FRAMECOOKIE: {
1664 DictScope S(W, "FrameCookie");
1665 const FrameCookieSym *FrameCookie;
1666 error(consumeObject(SymData, FrameCookie));
Reid Kleckner2893fd12016-01-14 17:51:54 +00001667
1668 StringRef LinkageName;
1669 printRelocatedField("CodeOffset", Sec, SectionContents,
1670 &FrameCookie->CodeOffset, &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001671 W.printHex("Register", FrameCookie->Register);
1672 W.printEnum("CookieKind", uint16_t(FrameCookie->CookieKind),
1673 makeArrayRef(FrameCookieKinds));
1674 break;
1675 }
1676
1677 case S_LDATA32:
1678 case S_GDATA32:
1679 case S_LMANDATA:
1680 case S_GMANDATA: {
1681 DictScope S(W, "DataSym");
1682 const DataSym *Data;
1683 error(consumeObject(SymData, Data));
1684
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001685 StringRef DisplayName = SymData.split('\0').first;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001686 StringRef LinkageName;
1687 printRelocatedField("DataOffset", Sec, SectionContents, &Data->DataOffset,
1688 &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001689 printTypeIndex("Type", Data->Type);
1690 W.printString("DisplayName", DisplayName);
1691 W.printString("LinkageName", LinkageName);
1692 break;
1693 }
Reid Kleckner2893fd12016-01-14 17:51:54 +00001694
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001695 case S_LTHREAD32:
1696 case S_GTHREAD32: {
1697 DictScope S(W, "ThreadLocalDataSym");
Reid Kleckner2893fd12016-01-14 17:51:54 +00001698 const ThreadLocalDataSym *Data;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001699 error(consumeObject(SymData, Data));
1700
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001701 StringRef DisplayName = SymData.split('\0').first;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001702 StringRef LinkageName;
1703 printRelocatedField("DataOffset", Sec, SectionContents, &Data->DataOffset,
1704 &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001705 printTypeIndex("Type", Data->Type);
1706 W.printString("DisplayName", DisplayName);
1707 W.printString("LinkageName", LinkageName);
1708 break;
1709 }
1710
1711 case S_OBJNAME: {
1712 DictScope S(W, "ObjectName");
1713 const ObjNameSym *ObjName;
1714 error(consumeObject(SymData, ObjName));
1715 W.printHex("Signature", ObjName->Signature);
1716 StringRef ObjectName = SymData.split('\0').first;
1717 W.printString("ObjectName", ObjectName);
1718 break;
1719 }
1720
1721 case S_COMPILE3: {
1722 DictScope S(W, "CompilerFlags");
1723 const CompileSym3 *CompFlags;
1724 error(consumeObject(SymData, CompFlags));
1725 W.printEnum("Language", CompFlags->getLanguage(),
1726 makeArrayRef(SourceLanguages));
1727 W.printFlags("Flags", CompFlags->flags & ~0xff,
1728 makeArrayRef(CompileSym3Flags));
1729 W.printEnum("Machine", unsigned(CompFlags->Machine),
1730 makeArrayRef(CPUTypeNames));
1731 std::string FrontendVersion;
1732 {
1733 raw_string_ostream Out(FrontendVersion);
1734 Out << CompFlags->VersionFrontendMajor << '.'
1735 << CompFlags->VersionFrontendMinor << '.'
1736 << CompFlags->VersionFrontendBuild << '.'
1737 << CompFlags->VersionFrontendQFE;
Zachary Turner99f02152015-02-18 19:32:05 +00001738 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001739 std::string BackendVersion;
1740 {
1741 raw_string_ostream Out(BackendVersion);
1742 Out << CompFlags->VersionBackendMajor << '.'
1743 << CompFlags->VersionBackendMinor << '.'
1744 << CompFlags->VersionBackendBuild << '.'
1745 << CompFlags->VersionBackendQFE;
1746 }
1747 W.printString("FrontendVersion", FrontendVersion);
1748 W.printString("BackendVersion", BackendVersion);
1749 StringRef VersionName = SymData.split('\0').first;
1750 W.printString("VersionName", VersionName);
1751 break;
1752 }
Zachary Turner99f02152015-02-18 19:32:05 +00001753
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001754 case S_FRAMEPROC: {
1755 DictScope S(W, "FrameProc");
1756 const FrameProcSym *FrameProc;
1757 error(consumeObject(SymData, FrameProc));
1758 W.printHex("TotalFrameBytes", FrameProc->TotalFrameBytes);
1759 W.printHex("PaddingFrameBytes", FrameProc->PaddingFrameBytes);
1760 W.printHex("OffsetToPadding", FrameProc->OffsetToPadding);
1761 W.printHex("BytesOfCalleeSavedRegisters", FrameProc->BytesOfCalleeSavedRegisters);
1762 W.printHex("OffsetOfExceptionHandler", FrameProc->OffsetOfExceptionHandler);
1763 W.printHex("SectionIdOfExceptionHandler", FrameProc->SectionIdOfExceptionHandler);
1764 W.printFlags("Flags", FrameProc->Flags, makeArrayRef(FrameProcSymFlags));
1765 break;
1766 }
1767
1768 case S_UDT:
1769 case S_COBOLUDT: {
1770 DictScope S(W, "UDT");
1771 const UDTSym *UDT;
1772 error(consumeObject(SymData, UDT));
1773 printTypeIndex("Type", UDT->Type);
1774 StringRef UDTName = SymData.split('\0').first;
1775 W.printString("UDTName", UDTName);
1776 break;
1777 }
1778
1779 case S_BPREL32: {
1780 DictScope S(W, "BPRelativeSym");
1781 const BPRelativeSym *BPRel;
1782 error(consumeObject(SymData, BPRel));
David Majnemerac10cfd2016-02-03 22:36:46 +00001783 W.printNumber("Offset", BPRel->Offset);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001784 printTypeIndex("Type", BPRel->Type);
1785 StringRef VarName = SymData.split('\0').first;
1786 W.printString("VarName", VarName);
1787 break;
1788 }
1789
1790 case S_REGREL32: {
1791 DictScope S(W, "RegRelativeSym");
1792 const RegRelativeSym *RegRel;
1793 error(consumeObject(SymData, RegRel));
1794 W.printHex("Offset", RegRel->Offset);
1795 printTypeIndex("Type", RegRel->Type);
1796 W.printHex("Register", RegRel->Register);
1797 StringRef VarName = SymData.split('\0').first;
1798 W.printString("VarName", VarName);
1799 break;
1800 }
1801
1802 case S_BUILDINFO: {
1803 DictScope S(W, "BuildInfo");
1804 const BuildInfoSym *BuildInfo;
1805 error(consumeObject(SymData, BuildInfo));
1806 W.printNumber("BuildId", BuildInfo->BuildId);
1807 break;
1808 }
1809
1810 case S_CONSTANT:
1811 case S_MANCONSTANT: {
1812 DictScope S(W, "Constant");
1813 const ConstantSym *Constant;
1814 error(consumeObject(SymData, Constant));
1815 printTypeIndex("Type", Constant->Type);
1816 APSInt Value;
1817 error(decodeNumerictLeaf(SymData, Value));
1818 W.printNumber("Value", Value);
1819 StringRef Name = SymData.split('\0').first;
1820 W.printString("Name", Name);
1821 break;
1822 }
1823
1824 default: {
1825 DictScope S(W, "UnknownSym");
Reid Kleckner6b3faef2016-01-13 23:44:57 +00001826 W.printHex("Kind", unsigned(Kind));
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001827 W.printHex("Size", Rec->RecordLength);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001828 break;
1829 }
Zachary Turner99f02152015-02-18 19:32:05 +00001830 }
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00001831
1832 if (opts::CodeViewSubsectionBytes)
1833 printBinaryBlockWithRelocs("SymData", Section, SectionContents,
1834 OrigSymData);
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001835 W.flush();
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001836 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001837 W.flush();
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001838}
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001839
Reid Klecknerc31f5302016-01-15 18:06:25 +00001840void COFFDumper::printCodeViewFileChecksums(StringRef Subsection) {
1841 StringRef Data = Subsection;
1842 while (!Data.empty()) {
1843 DictScope S(W, "FileChecksum");
1844 const FileChecksum *FC;
1845 error(consumeObject(Data, FC));
1846 if (FC->FileNameOffset >= CVStringTable.size())
1847 error(object_error::parse_failed);
1848 StringRef Filename =
1849 CVStringTable.drop_front(FC->FileNameOffset).split('\0').first;
1850 W.printHex("Filename", Filename, FC->FileNameOffset);
1851 W.printHex("ChecksumSize", FC->ChecksumSize);
1852 W.printEnum("ChecksumKind", uint8_t(FC->ChecksumKind),
1853 makeArrayRef(FileChecksumKindNames));
1854 if (FC->ChecksumSize >= Data.size())
1855 error(object_error::parse_failed);
1856 StringRef ChecksumBytes = Data.substr(0, FC->ChecksumSize);
1857 W.printBinary("ChecksumBytes", ChecksumBytes);
Rafael Espindolaa79078c2016-01-18 20:55:24 +00001858 unsigned PaddedSize = alignTo(FC->ChecksumSize + sizeof(FileChecksum), 4) -
1859 sizeof(FileChecksum);
Reid Klecknerc31f5302016-01-15 18:06:25 +00001860 Data = Data.drop_front(PaddedSize);
1861 }
1862}
1863
Reid Klecknere9ab3492016-01-14 19:20:17 +00001864void COFFDumper::printCodeViewInlineeLines(StringRef Subsection) {
1865 StringRef Data = Subsection;
1866 uint32_t Signature;
1867 error(consumeUInt32(Data, Signature));
1868 bool HasExtraFiles = Signature == unsigned(InlineeLinesSignature::ExtraFiles);
1869
1870 while (!Data.empty()) {
1871 const InlineeSourceLine *ISL;
1872 error(consumeObject(Data, ISL));
1873 DictScope S(W, "InlineeSourceLine");
1874 printTypeIndex("Inlinee", ISL->Inlinee);
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001875 printFileNameForOffset("FileID", ISL->FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001876 W.printNumber("SourceLineNum", ISL->SourceLineNum);
1877
1878 if (HasExtraFiles) {
1879 uint32_t ExtraFileCount;
1880 error(consumeUInt32(Data, ExtraFileCount));
1881 W.printNumber("ExtraFileCount", ExtraFileCount);
1882 ListScope ExtraFiles(W, "ExtraFiles");
1883 for (unsigned I = 0; I < ExtraFileCount; ++I) {
1884 uint32_t FileID;
1885 error(consumeUInt32(Data, FileID));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001886 printFileNameForOffset("FileID", FileID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001887 }
1888 }
1889 }
1890}
1891
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +00001892StringRef CVTypeDumper::getTypeName(TypeIndex TI) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001893 if (TI.isNoType())
1894 return "<no type>";
1895
1896 if (TI.isSimple()) {
1897 // This is a simple type.
1898 for (const auto &SimpleTypeName : SimpleTypeNames) {
1899 if (SimpleTypeName.Value == TI.getSimpleKind()) {
1900 if (TI.getSimpleMode() == SimpleTypeMode::Direct)
1901 return SimpleTypeName.Name.drop_back(1);
1902 // Otherwise, this is a pointer type. We gloss over the distinction
1903 // between near, far, 64, 32, etc, and just give a pointer type.
1904 return SimpleTypeName.Name;
1905 }
1906 }
1907 return "<unknown simple type>";
1908 }
1909
1910 // User-defined type.
1911 StringRef UDTName;
1912 unsigned UDTIndex = TI.getIndex() - 0x1000;
1913 if (UDTIndex < CVUDTNames.size())
1914 return CVUDTNames[UDTIndex];
1915
1916 return "<unknown UDT>";
1917}
1918
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +00001919void CVTypeDumper::printTypeIndex(StringRef FieldName, TypeIndex TI) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001920 StringRef TypeName;
1921 if (!TI.isNoType())
1922 TypeName = getTypeName(TI);
1923 if (!TypeName.empty())
1924 W.printHex(FieldName, TypeName, TI.getIndex());
1925 else
1926 W.printHex(FieldName, TI.getIndex());
1927}
1928
David Majnemerac10cfd2016-02-03 22:36:46 +00001929void COFFDumper::printLocalVariableAddrRange(
David Majnemerd74490f2016-02-03 22:45:21 +00001930 const LocalVariableAddrRange &Range, const coff_section *Sec,
1931 StringRef SectionContents) {
David Majnemer6f01e052016-02-04 17:29:13 +00001932 DictScope S(W, "LocalVariableAddrRange");
David Majnemerd74490f2016-02-03 22:45:21 +00001933 printRelocatedField("OffsetStart", Sec, SectionContents, &Range.OffsetStart);
1934 W.printHex("ISectStart", Range.ISectStart);
Reid Kleckner4ab992d2016-02-11 23:40:14 +00001935 W.printHex("Range", Range.Range);
David Majnemerac10cfd2016-02-03 22:36:46 +00001936}
1937
David Majnemer4d123512016-02-04 17:37:30 +00001938void COFFDumper::printLocalVariableAddrGap(StringRef &SymData) {
David Majnemer6f01e052016-02-04 17:29:13 +00001939 while (!SymData.empty()) {
1940 const LocalVariableAddrGap *Gap;
1941 error(consumeObject(SymData, Gap));
1942 ListScope S(W, "LocalVariableAddrGap");
Reid Kleckner4ab992d2016-02-11 23:40:14 +00001943 W.printHex("GapStartOffset", Gap->GapStartOffset);
1944 W.printHex("Range", Gap->Range);
David Majnemer6f01e052016-02-04 17:29:13 +00001945 }
David Majnemerac10cfd2016-02-03 22:36:46 +00001946}
1947
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001948StringRef COFFDumper::getFileNameForFileOffset(uint32_t FileOffset) {
1949 // The file checksum subsection should precede all references to it.
1950 if (!CVFileChecksumTable.data() || !CVStringTable.data())
1951 error(object_error::parse_failed);
1952 // Check if the file checksum table offset is valid.
1953 if (FileOffset >= CVFileChecksumTable.size())
1954 error(object_error::parse_failed);
1955
1956 // The string table offset comes first before the file checksum.
1957 StringRef Data = CVFileChecksumTable.drop_front(FileOffset);
1958 uint32_t StringOffset;
1959 error(consumeUInt32(Data, StringOffset));
1960
1961 // Check if the string table offset is valid.
1962 if (StringOffset >= CVStringTable.size())
1963 error(object_error::parse_failed);
1964
1965 // Return the null-terminated string.
1966 return CVStringTable.drop_front(StringOffset).split('\0').first;
1967}
1968
1969void COFFDumper::printFileNameForOffset(StringRef Label, uint32_t FileOffset) {
1970 W.printHex(Label, getFileNameForFileOffset(FileOffset), FileOffset);
1971}
1972
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001973static StringRef getLeafTypeName(TypeLeafKind LT) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001974 switch (LT) {
Reid Klecknerbc041b82016-05-03 00:45:14 +00001975#define KNOWN_TYPE(LeafName, Value, ClassName) \
1976 case LeafName: return #ClassName;
1977#include "llvm/DebugInfo/CodeView/CVLeafTypes.def"
1978 default:
1979 break;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001980 }
1981 return "UnknownLeaf";
1982}
1983
1984void COFFDumper::printCodeViewTypeSection(StringRef SectionName,
1985 const SectionRef &Section) {
1986 ListScope D(W, "CodeViewTypes");
1987 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Adrian McCarthy963a3312016-05-02 23:45:03 +00001988
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001989 StringRef Data;
1990 error(Section.getContents(Data));
Reid Klecknerb2bd2812016-05-02 18:10:00 +00001991 if (opts::CodeViewSubsectionBytes)
1992 W.printBinaryBlock("Data", Data);
Reid Kleckner7960de92016-05-04 19:39:28 +00001993
1994 uint32_t Magic;
1995 error(consumeUInt32(Data, Magic));
1996 W.printHex("Magic", Magic);
1997 if (Magic != COFF::DEBUG_SECTION_MAGIC)
1998 return error(object_error::parse_failed);
1999
2000 ArrayRef<uint8_t> BinaryData(reinterpret_cast<const uint8_t *>(Data.data()),
2001 Data.size());
2002 CVTD.dump(BinaryData);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +00002003}
2004
Reid Kleckner7960de92016-05-04 19:39:28 +00002005void CVTypeDumper::dump(ArrayRef<uint8_t> Data) {
2006 visitTypeStream(Data);
2007 if (hadError())
2008 error(object_error::parse_failed);
2009}
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002010
Reid Kleckner7960de92016-05-04 19:39:28 +00002011void CVTypeDumper::visitTypeBegin(TypeLeafKind Leaf, ArrayRef<uint8_t> LeafData) {
2012 // Reset Name to the empty string. If the visitor sets it, we know it.
2013 Name = "";
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002014
Reid Kleckner7960de92016-05-04 19:39:28 +00002015 W.startLine() << getLeafTypeName(Leaf) << " {\n";
2016 W.indent();
2017 unsigned NextTypeIndex = 0x1000 + CVUDTNames.size();
2018 W.printEnum("TypeLeafKind", unsigned(Leaf), makeArrayRef(LeafTypeNames));
2019 W.printHex("TypeIndex", NextTypeIndex);
2020 W.flush();
2021}
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002022
Reid Kleckner7960de92016-05-04 19:39:28 +00002023void CVTypeDumper::visitTypeEnd(TypeLeafKind Leaf, ArrayRef<uint8_t> LeafData) {
2024 // Always record some name for every type, even if Name is empty, since
2025 // CVUDTNames is indexed by TypeIndex.
2026 CVUDTNames.push_back(Name);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002027
Reid Kleckner7960de92016-05-04 19:39:28 +00002028 if (opts::CodeViewSubsectionBytes)
2029 W.printBinaryBlock("LeafData", getBytesAsCharacters(LeafData));
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002030
Reid Kleckner7960de92016-05-04 19:39:28 +00002031 W.unindent();
2032 W.startLine() << "}\n";
2033 W.flush();
2034}
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002035
Reid Kleckner7960de92016-05-04 19:39:28 +00002036void CVTypeDumper::visitStringId(TypeLeafKind Leaf, const StringId *String,
2037 ArrayRef<uint8_t> LeafData) {
2038 W.printHex("Id", String->id.getIndex());
2039 StringRef StringData = getBytesAsCString(LeafData);
2040 W.printString("StringData", StringData);
2041 // Put this in CVUDTNames so it gets printed with LF_UDT_SRC_LINE.
2042 Name = StringData;
2043}
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002044
Reid Kleckner7960de92016-05-04 19:39:28 +00002045void CVTypeDumper::visitArgList(TypeLeafKind Leaf, const ArgList *Args,
2046 ArrayRef<uint8_t> LeafData) {
2047 W.printNumber("NumArgs", Args->NumArgs);
2048 ListScope Arguments(W, "Arguments");
2049 SmallString<256> TypeName("(");
2050 for (uint32_t ArgI = 0; ArgI != Args->NumArgs; ++ArgI) {
2051 const TypeIndex *Type;
2052 if (!consumeObject(LeafData, Type))
2053 return;
2054 printTypeIndex("ArgType", *Type);
2055 StringRef ArgTypeName = getTypeName(*Type);
2056 TypeName.append(ArgTypeName);
2057 if (ArgI + 1 != Args->NumArgs)
2058 TypeName.append(", ");
2059 }
2060 TypeName.push_back(')');
2061 Name = TypeNames.insert(TypeName).first->getKey();
2062}
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002063
Reid Kleckner7960de92016-05-04 19:39:28 +00002064void CVTypeDumper::visitClassType(TypeLeafKind Leaf, const ClassType *Class,
2065 ArrayRef<uint8_t> LeafData) {
2066 W.printNumber("MemberCount", Class->MemberCount);
2067 uint16_t Props = Class->Properties;
2068 W.printFlags("Properties", Props, makeArrayRef(ClassOptionNames));
2069 printTypeIndex("FieldList", Class->FieldList);
2070 printTypeIndex("DerivedFrom", Class->DerivedFrom);
2071 printTypeIndex("VShape", Class->VShape);
2072 uint64_t SizeOf;
2073 error(decodeUIntLeaf(LeafData, SizeOf));
2074 W.printNumber("SizeOf", SizeOf);
2075 StringRef LeafChars = getBytesAsCharacters(LeafData);
2076 StringRef LinkageName;
2077 std::tie(Name, LinkageName) = LeafChars.split('\0');
2078 W.printString("Name", Name);
2079 if (Props & uint16_t(ClassOptions::HasUniqueName)) {
2080 LinkageName = LinkageName.split('\0').first;
2081 if (LinkageName.empty())
2082 return error(object_error::parse_failed);
2083 W.printString("LinkageName", LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002084 }
2085}
2086
Reid Kleckner7960de92016-05-04 19:39:28 +00002087void CVTypeDumper::visitUnionType(TypeLeafKind Leaf, const UnionType *Union,
2088 ArrayRef<uint8_t> LeafData) {
2089 W.printNumber("MemberCount", Union->MemberCount);
2090 uint16_t Props = Union->Properties;
2091 W.printFlags("Properties", Props, makeArrayRef(ClassOptionNames));
2092 printTypeIndex("FieldList", Union->FieldList);
2093 uint64_t SizeOf;
2094 error(decodeUIntLeaf(LeafData, SizeOf));
2095 W.printNumber("SizeOf", SizeOf);
2096 StringRef LeafChars = getBytesAsCharacters(LeafData);
2097 StringRef LinkageName;
2098 std::tie(Name, LinkageName) = LeafChars.split('\0');
2099 W.printString("Name", Name);
2100 if (Props & uint16_t(ClassOptions::HasUniqueName)) {
2101 LinkageName = LinkageName.split('\0').first;
2102 if (LinkageName.empty())
2103 return error(object_error::parse_failed);
2104 W.printString("LinkageName", LinkageName);
2105 }
2106}
2107
2108void CVTypeDumper::visitEnumType(TypeLeafKind Leaf, const EnumType *Enum,
2109 ArrayRef<uint8_t> LeafData) {
2110 W.printNumber("NumEnumerators", Enum->NumEnumerators);
2111 W.printFlags("Properties", uint16_t(Enum->Properties),
2112 makeArrayRef(ClassOptionNames));
2113 printTypeIndex("UnderlyingType", Enum->UnderlyingType);
2114 printTypeIndex("FieldListType", Enum->FieldListType);
2115 Name = getBytesAsCString(LeafData);
2116 W.printString("Name", Name);
2117}
2118
2119void CVTypeDumper::visitArrayType(TypeLeafKind Leaf, const ArrayType *AT,
2120 ArrayRef<uint8_t> LeafData) {
2121 printTypeIndex("ElementType", AT->ElementType);
2122 printTypeIndex("IndexType", AT->IndexType);
2123 uint64_t SizeOf;
2124 error(decodeUIntLeaf(LeafData, SizeOf));
2125 W.printNumber("SizeOf", SizeOf);
2126 Name = getBytesAsCString(LeafData);
2127 W.printString("Name", Name);
2128}
2129
2130void CVTypeDumper::visitVFTableType(TypeLeafKind Leaf, const VFTableType *VFT,
2131 ArrayRef<uint8_t> LeafData) {
2132 printTypeIndex("CompleteClass", VFT->CompleteClass);
2133 printTypeIndex("OverriddenVFTable", VFT->OverriddenVFTable);
2134 W.printHex("VFPtrOffset", VFT->VFPtrOffset);
2135 StringRef NamesData = getBytesAsCharacters(LeafData.slice(0, VFT->NamesLen));
2136 std::tie(Name, NamesData) = NamesData.split('\0');
2137 W.printString("VFTableName", Name);
2138 while (!NamesData.empty()) {
2139 StringRef MethodName;
2140 std::tie(MethodName, NamesData) = NamesData.split('\0');
2141 W.printString("MethodName", MethodName);
2142 }
2143}
2144
2145void CVTypeDumper::visitMemberFuncId(TypeLeafKind Leaf, const MemberFuncId *Id,
2146 ArrayRef<uint8_t> LeafData) {
2147 printTypeIndex("ClassType", Id->ClassType);
2148 printTypeIndex("FunctionType", Id->FunctionType);
2149 Name = getBytesAsCString(LeafData);
2150 W.printString("Name", Name);
2151}
2152
2153void CVTypeDumper::visitProcedureType(TypeLeafKind Leaf,
2154 const ProcedureType *Proc,
2155 ArrayRef<uint8_t> LeafData) {
2156 printTypeIndex("ReturnType", Proc->ReturnType);
2157 W.printEnum("CallingConvention", uint8_t(Proc->CallConv),
2158 makeArrayRef(CallingConventions));
2159 W.printFlags("FunctionOptions", uint8_t(Proc->Options),
2160 makeArrayRef(FunctionOptionEnum));
2161 W.printNumber("NumParameters", Proc->NumParameters);
2162 printTypeIndex("ArgListType", Proc->ArgListType);
2163
2164 StringRef ReturnTypeName = getTypeName(Proc->ReturnType);
2165 StringRef ArgListTypeName = getTypeName(Proc->ArgListType);
2166 SmallString<256> TypeName(ReturnTypeName);
2167 TypeName.push_back(' ');
2168 TypeName.append(ArgListTypeName);
2169 Name = TypeNames.insert(TypeName).first->getKey();
2170}
2171
2172void CVTypeDumper::visitMemberFunctionType(TypeLeafKind Leaf,
2173 const MemberFunctionType *MemberFunc,
2174 ArrayRef<uint8_t> LeafData) {
2175 printTypeIndex("ReturnType", MemberFunc->ReturnType);
2176 printTypeIndex("ClassType", MemberFunc->ClassType);
2177 printTypeIndex("ThisType", MemberFunc->ThisType);
2178 W.printEnum("CallingConvention", uint8_t(MemberFunc->CallConv),
2179 makeArrayRef(CallingConventions));
2180 W.printFlags("FunctionOptions", uint8_t(MemberFunc->Options),
2181 makeArrayRef(FunctionOptionEnum));
2182 W.printNumber("NumParameters", MemberFunc->NumParameters);
2183 printTypeIndex("ArgListType", MemberFunc->ArgListType);
2184 W.printNumber("ThisAdjustment", MemberFunc->ThisAdjustment);
2185
2186 StringRef ReturnTypeName = getTypeName(MemberFunc->ReturnType);
2187 StringRef ClassTypeName = getTypeName(MemberFunc->ClassType);
2188 StringRef ArgListTypeName = getTypeName(MemberFunc->ArgListType);
2189 SmallString<256> TypeName(ReturnTypeName);
2190 TypeName.push_back(' ');
2191 TypeName.append(ClassTypeName);
2192 TypeName.append("::");
2193 TypeName.append(ArgListTypeName);
2194 Name = TypeNames.insert(TypeName).first->getKey();
2195}
2196
2197void CVTypeDumper::visitMethodList(TypeLeafKind Leaf,
2198 ArrayRef<uint8_t> LeafData) {
2199 while (!LeafData.empty()) {
2200 const MethodListEntry *Method;
2201 if (!consumeObject(LeafData, Method))
2202 return;
2203 ListScope S(W, "Method");
2204 printMemberAttributes(Method->Attrs);
2205 printTypeIndex("Type", Method->Type);
2206 if (Method->isIntroducedVirtual()) {
2207 const little32_t *VFTOffsetPtr;
2208 if (!consumeObject(LeafData, VFTOffsetPtr))
2209 return;
2210 W.printHex("VFTableOffset", *VFTOffsetPtr);
2211 }
2212 }
2213}
2214
2215void CVTypeDumper::visitFuncId(TypeLeafKind Leaf, const FuncId *Func,
2216 ArrayRef<uint8_t> LeafData) {
2217 printTypeIndex("ParentScope", Func->ParentScope);
2218 printTypeIndex("FunctionType", Func->FunctionType);
2219 Name = getBytesAsCString(LeafData);
2220 W.printString("Name", Name);
2221}
2222
2223void CVTypeDumper::visitTypeServer2(TypeLeafKind Leaf,
2224 const TypeServer2 *TypeServer,
2225 ArrayRef<uint8_t> LeafData) {
2226 W.printBinary("Signature", StringRef(TypeServer->Signature, 16));
2227 W.printNumber("Age", TypeServer->Age);
2228 Name = getBytesAsCString(LeafData);
2229 W.printString("Name", Name);
2230}
2231
2232void CVTypeDumper::visitPointerType(TypeLeafKind Leaf, const PointerType *Ptr,
2233 ArrayRef<uint8_t> LeafData) {
2234 printTypeIndex("PointeeType", Ptr->PointeeType);
2235 W.printHex("PointerAttributes", Ptr->Attrs);
2236 W.printEnum("PtrType", unsigned(Ptr->getPtrKind()),
2237 makeArrayRef(PtrKindNames));
2238 W.printEnum("PtrMode", unsigned(Ptr->getPtrMode()),
2239 makeArrayRef(PtrModeNames));
2240 W.printNumber("IsFlat", Ptr->isFlat());
2241 W.printNumber("IsConst", Ptr->isConst());
2242 W.printNumber("IsVolatile", Ptr->isVolatile());
2243 W.printNumber("IsUnaligned", Ptr->isUnaligned());
2244
2245 if (Ptr->isPointerToMember()) {
2246 const PointerToMemberTail *PMT;
2247 if (!consumeObject(LeafData, PMT))
2248 return;
2249 printTypeIndex("ClassType", PMT->ClassType);
2250 W.printEnum("Representation", PMT->Representation,
2251 makeArrayRef(PtrMemberRepNames));
2252
2253 StringRef PointeeName = getTypeName(Ptr->PointeeType);
2254 StringRef ClassName = getTypeName(PMT->ClassType);
2255 SmallString<256> TypeName(PointeeName);
2256 TypeName.push_back(' ');
2257 TypeName.append(ClassName);
2258 TypeName.append("::*");
2259 Name = TypeNames.insert(TypeName).first->getKey();
2260 } else {
2261 W.printBinaryBlock("TailData", getBytesAsCharacters(LeafData));
2262
2263 SmallString<256> TypeName;
2264 if (Ptr->isConst())
2265 TypeName.append("const ");
2266 if (Ptr->isVolatile())
2267 TypeName.append("volatile ");
2268 if (Ptr->isUnaligned())
2269 TypeName.append("__unaligned ");
2270
2271 TypeName.append(getTypeName(Ptr->PointeeType));
2272
2273 if (Ptr->getPtrMode() == PointerMode::LValueReference)
2274 TypeName.append("&");
2275 else if (Ptr->getPtrMode() == PointerMode::RValueReference)
2276 TypeName.append("&&");
2277 else if (Ptr->getPtrMode() == PointerMode::Pointer)
2278 TypeName.append("*");
2279
2280 Name = TypeNames.insert(TypeName).first->getKey();
2281 }
2282}
2283
2284void CVTypeDumper::visitTypeModifier(TypeLeafKind Leaf, const TypeModifier *Mod,
2285 ArrayRef<uint8_t> LeafData) {
2286 printTypeIndex("ModifiedType", Mod->ModifiedType);
2287 W.printFlags("Modifiers", Mod->Modifiers, makeArrayRef(TypeModifierNames));
2288
2289 StringRef ModifiedName = getTypeName(Mod->ModifiedType);
2290 SmallString<256> TypeName;
2291 if (Mod->Modifiers & uint16_t(ModifierOptions::Const))
2292 TypeName.append("const ");
2293 if (Mod->Modifiers & uint16_t(ModifierOptions::Volatile))
2294 TypeName.append("volatile ");
2295 if (Mod->Modifiers & uint16_t(ModifierOptions::Unaligned))
2296 TypeName.append("__unaligned ");
2297 TypeName.append(ModifiedName);
2298 Name = TypeNames.insert(TypeName).first->getKey();
2299}
2300
2301void CVTypeDumper::visitVTableShape(TypeLeafKind Leaf, const VTableShape *Shape,
2302 ArrayRef<uint8_t> LeafData) {
2303 unsigned VFEntryCount = Shape->VFEntryCount;
2304 W.printNumber("VFEntryCount", VFEntryCount);
2305 // We could print out whether the methods are near or far, but in practice
2306 // today everything is CV_VTS_near32, so it's just noise.
2307}
2308
2309void CVTypeDumper::visitUDTSrcLine(TypeLeafKind Leaf, const UDTSrcLine *Line,
2310 ArrayRef<uint8_t> LeafData) {
2311 printTypeIndex("UDT", Line->UDT);
2312 printTypeIndex("SourceFile", Line->SourceFile);
2313 W.printNumber("LineNumber", Line->LineNumber);
2314}
2315
2316void CVTypeDumper::visitBuildInfo(TypeLeafKind Leaf, const BuildInfo *Args,
2317 ArrayRef<uint8_t> LeafData) {
2318 W.printNumber("NumArgs", Args->NumArgs);
2319
2320 ListScope Arguments(W, "Arguments");
2321 for (uint32_t ArgI = 0; ArgI != Args->NumArgs; ++ArgI) {
2322 const TypeIndex *Type;
2323 if (!consumeObject(LeafData, Type))
2324 return;
2325 printTypeIndex("ArgType", *Type);
2326 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002327}
2328
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +00002329void CVTypeDumper::printMemberAttributes(MemberAttributes Attrs) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002330 W.printEnum("AccessSpecifier", uint8_t(Attrs.getAccess()),
2331 makeArrayRef(MemberAccessNames));
2332 auto MK = Attrs.getMethodKind();
2333 // Data members will be vanilla. Don't try to print a method kind for them.
2334 if (MK != MethodKind::Vanilla)
2335 W.printEnum("MethodKind", unsigned(MK), makeArrayRef(MemberKindNames));
2336 if (Attrs.getFlags() != MethodOptions::None) {
2337 W.printFlags("MethodOptions", unsigned(Attrs.getFlags()),
2338 makeArrayRef(MethodOptionNames));
2339 }
2340}
2341
Reid Kleckner7960de92016-05-04 19:39:28 +00002342void CVTypeDumper::visitUnknownMember(TypeLeafKind Leaf) {
2343 W.printHex("UnknownMember", unsigned(Leaf));
2344}
2345
2346void CVTypeDumper::visitNestedType(TypeLeafKind Leaf, const NestedType *Nested,
2347 ArrayRef<uint8_t> &FieldData) {
2348 DictScope S(W, "NestedType");
2349 printTypeIndex("Type", Nested->Type);
2350 StringRef Name = getBytesAsCString(FieldData);
2351 FieldData = FieldData.drop_front(Name.size() + 1);
2352 W.printString("Name", Name);
2353}
2354
2355void CVTypeDumper::visitOneMethod(TypeLeafKind Leaf, const OneMethod *Method,
2356 ArrayRef<uint8_t> &FieldData) {
2357 DictScope S(W, "OneMethod");
2358 printMemberAttributes(Method->Attrs);
2359 printTypeIndex("Type", Method->Type);
2360 // If virtual, then read the vftable offset.
2361 if (Method->isIntroducedVirtual()) {
2362 const little32_t *VFTOffsetPtr;
2363 if (!consumeObject(FieldData, VFTOffsetPtr))
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002364 return;
Reid Kleckner7960de92016-05-04 19:39:28 +00002365 W.printHex("VFTableOffset", *VFTOffsetPtr);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002366 }
Reid Kleckner7960de92016-05-04 19:39:28 +00002367 StringRef Name = getBytesAsCString(FieldData);
2368 FieldData = FieldData.drop_front(Name.size() + 1);
2369 W.printString("Name", Name);
2370}
2371
2372void CVTypeDumper::visitOverloadedMethod(TypeLeafKind Leaf,
2373 const OverloadedMethod *Method,
2374 ArrayRef<uint8_t> &FieldData) {
2375 DictScope S(W, "OverloadedMethod");
2376 W.printHex("MethodCount", Method->MethodCount);
2377 W.printHex("MethodListIndex", Method->MethList.getIndex());
2378 StringRef Name = getBytesAsCString(FieldData);
2379 FieldData = FieldData.drop_front(Name.size() + 1);
2380 W.printString("Name", Name);
2381}
2382
2383void CVTypeDumper::visitDataMember(TypeLeafKind Leaf, const DataMember *Field,
2384 ArrayRef<uint8_t> &FieldData) {
2385 DictScope S(W, "DataMember");
2386 printMemberAttributes(Field->Attrs);
2387 printTypeIndex("Type", Field->Type);
2388 uint64_t FieldOffset;
2389 error(decodeUIntLeaf(FieldData, FieldOffset));
2390 W.printHex("FieldOffset", FieldOffset);
2391 StringRef Name = getBytesAsCString(FieldData);
2392 FieldData = FieldData.drop_front(Name.size() + 1);
2393 W.printString("Name", Name);
2394}
2395
2396void CVTypeDumper::visitStaticDataMember(TypeLeafKind Leaf,
2397 const StaticDataMember *Field,
2398 ArrayRef<uint8_t> &FieldData) {
2399 DictScope S(W, "StaticDataMember");
2400 printMemberAttributes(Field->Attrs);
2401 printTypeIndex("Type", Field->Type);
2402 StringRef Name = getBytesAsCString(FieldData);
2403 FieldData = FieldData.drop_front(Name.size() + 1);
2404 W.printString("Name", Name);
2405}
2406
2407void CVTypeDumper::visitVirtualFunctionPointer(
2408 TypeLeafKind Leaf, const VirtualFunctionPointer *VFTable,
2409 ArrayRef<uint8_t> &FieldData) {
2410 DictScope S(W, "VirtualFunctionPointer");
2411 printTypeIndex("Type", VFTable->Type);
2412}
2413
2414void CVTypeDumper::visitEnumerator(TypeLeafKind Leaf, const Enumerator *Enum,
2415 ArrayRef<uint8_t> &FieldData) {
2416 DictScope S(W, "Enumerator");
2417 printMemberAttributes(Enum->Attrs);
2418 APSInt EnumValue;
2419 error(decodeNumerictLeaf(FieldData, EnumValue));
2420 W.printNumber("EnumValue", EnumValue);
2421 StringRef Name = getBytesAsCString(FieldData);
2422 FieldData = FieldData.drop_front(Name.size() + 1);
2423 W.printString("Name", Name);
2424}
2425
2426void CVTypeDumper::visitBaseClass(TypeLeafKind Leaf, const BaseClass *Base,
2427 ArrayRef<uint8_t> &FieldData) {
2428 DictScope S(W, "BaseClass");
2429 printMemberAttributes(Base->Attrs);
2430 printTypeIndex("BaseType", Base->BaseType);
2431 uint64_t BaseOffset;
2432 error(decodeUIntLeaf(FieldData, BaseOffset));
2433 W.printHex("BaseOffset", BaseOffset);
2434}
2435
2436void CVTypeDumper::visitVirtualBaseClass(TypeLeafKind Leaf,
2437 const VirtualBaseClass *Base,
2438 ArrayRef<uint8_t> &FieldData) {
2439 DictScope S(W, "VirtualBaseClass");
2440 printMemberAttributes(Base->Attrs);
2441 printTypeIndex("BaseType", Base->BaseType);
2442 printTypeIndex("VBPtrType", Base->VBPtrType);
2443 uint64_t VBPtrOffset, VBTableIndex;
2444 error(decodeUIntLeaf(FieldData, VBPtrOffset));
2445 error(decodeUIntLeaf(FieldData, VBTableIndex));
2446 W.printHex("VBPtrOffset", VBPtrOffset);
2447 W.printHex("VBTableIndex", VBTableIndex);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00002448}
2449
Eric Christopher9cad53c2013-04-03 18:31:38 +00002450void COFFDumper::printSections() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002451 ListScope SectionsD(W, "Sections");
2452 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002453 for (const SectionRef &Sec : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002454 ++SectionNumber;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002455 const coff_section *Section = Obj->getCOFFSection(Sec);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002456
2457 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002458 error(Sec.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002459
2460 DictScope D(W, "Section");
2461 W.printNumber("Number", SectionNumber);
2462 W.printBinary("Name", Name, Section->Name);
2463 W.printHex ("VirtualSize", Section->VirtualSize);
2464 W.printHex ("VirtualAddress", Section->VirtualAddress);
2465 W.printNumber("RawDataSize", Section->SizeOfRawData);
2466 W.printHex ("PointerToRawData", Section->PointerToRawData);
2467 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
2468 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
2469 W.printNumber("RelocationCount", Section->NumberOfRelocations);
2470 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
2471 W.printFlags ("Characteristics", Section->Characteristics,
2472 makeArrayRef(ImageSectionCharacteristics),
2473 COFF::SectionCharacteristics(0x00F00000));
2474
2475 if (opts::SectionRelocations) {
2476 ListScope D(W, "Relocations");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002477 for (const RelocationRef &Reloc : Sec.relocations())
2478 printRelocation(Sec, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002479 }
2480
2481 if (opts::SectionSymbols) {
2482 ListScope D(W, "Symbols");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002483 for (const SymbolRef &Symbol : Obj->symbols()) {
Rafael Espindola80291272014-10-08 15:28:58 +00002484 if (!Sec.containsSymbol(Symbol))
Eric Christopher9cad53c2013-04-03 18:31:38 +00002485 continue;
2486
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002487 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002488 }
2489 }
2490
David Majnemerdac39852014-09-26 22:32:16 +00002491 if (opts::SectionData &&
2492 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002493 StringRef Data;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002494 error(Sec.getContents(Data));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002495
2496 W.printBinaryBlock("SectionData", Data);
2497 }
2498 }
2499}
2500
2501void COFFDumper::printRelocations() {
2502 ListScope D(W, "Relocations");
2503
Eric Christopher9cad53c2013-04-03 18:31:38 +00002504 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002505 for (const SectionRef &Section : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002506 ++SectionNumber;
Eric Christopher9cad53c2013-04-03 18:31:38 +00002507 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002508 error(Section.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002509
2510 bool PrintedGroup = false;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002511 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002512 if (!PrintedGroup) {
2513 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
2514 W.indent();
2515 PrintedGroup = true;
2516 }
2517
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002518 printRelocation(Section, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002519 }
2520
2521 if (PrintedGroup) {
2522 W.unindent();
2523 W.startLine() << "}\n";
2524 }
2525 }
2526}
2527
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002528void COFFDumper::printRelocation(const SectionRef &Section,
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00002529 const RelocationRef &Reloc, uint64_t Bias) {
2530 uint64_t Offset = Reloc.getOffset() - Bias;
Rafael Espindola99c041b2015-06-30 01:53:01 +00002531 uint64_t RelocType = Reloc.getType();
Eric Christopher9cad53c2013-04-03 18:31:38 +00002532 SmallString<32> RelocName;
Eric Christopher9cad53c2013-04-03 18:31:38 +00002533 StringRef SymbolName;
Rafael Espindola41bb4322015-06-30 04:08:37 +00002534 Reloc.getTypeName(RelocName);
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00002535 symbol_iterator Symbol = Reloc.getSymbol();
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00002536 if (Symbol != Obj->symbol_end()) {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00002537 Expected<StringRef> SymbolNameOrErr = Symbol->getName();
2538 error(errorToErrorCode(SymbolNameOrErr.takeError()));
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00002539 SymbolName = *SymbolNameOrErr;
2540 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00002541
Nico Rieckf3f0b792013-04-12 04:01:52 +00002542 if (opts::ExpandRelocs) {
2543 DictScope Group(W, "Relocation");
2544 W.printHex("Offset", Offset);
2545 W.printNumber("Type", RelocName, RelocType);
David Majnemer1f80b0a2014-11-13 07:42:11 +00002546 W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName);
Nico Rieckf3f0b792013-04-12 04:01:52 +00002547 } else {
2548 raw_ostream& OS = W.startLine();
2549 OS << W.hex(Offset)
2550 << " " << RelocName
David Majnemer1f80b0a2014-11-13 07:42:11 +00002551 << " " << (SymbolName.empty() ? "-" : SymbolName)
Nico Rieckf3f0b792013-04-12 04:01:52 +00002552 << "\n";
2553 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00002554}
2555
2556void COFFDumper::printSymbols() {
2557 ListScope Group(W, "Symbols");
2558
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002559 for (const SymbolRef &Symbol : Obj->symbols())
2560 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002561}
2562
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002563void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
Eric Christopher9cad53c2013-04-03 18:31:38 +00002564
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00002565static ErrorOr<StringRef>
David Majnemer236b0ca2014-11-17 11:17:17 +00002566getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber,
2567 const coff_section *Section) {
David Majnemerf4dc4562014-09-20 00:25:06 +00002568 if (Section) {
2569 StringRef SectionName;
David Majnemer236b0ca2014-11-17 11:17:17 +00002570 if (std::error_code EC = Obj->getSectionName(Section, SectionName))
2571 return EC;
David Majnemerf4dc4562014-09-20 00:25:06 +00002572 return SectionName;
2573 }
David Majnemerf4dc4562014-09-20 00:25:06 +00002574 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
David Majnemer236b0ca2014-11-17 11:17:17 +00002575 return StringRef("IMAGE_SYM_DEBUG");
David Majnemerf4dc4562014-09-20 00:25:06 +00002576 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
David Majnemer236b0ca2014-11-17 11:17:17 +00002577 return StringRef("IMAGE_SYM_ABSOLUTE");
David Majnemerf4dc4562014-09-20 00:25:06 +00002578 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
David Majnemer236b0ca2014-11-17 11:17:17 +00002579 return StringRef("IMAGE_SYM_UNDEFINED");
2580 return StringRef("");
David Majnemerf4dc4562014-09-20 00:25:06 +00002581}
2582
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002583void COFFDumper::printSymbol(const SymbolRef &Sym) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002584 DictScope D(W, "Symbol");
2585
David Majnemer44f51e52014-09-10 12:51:52 +00002586 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002587 const coff_section *Section;
David Majnemer44f51e52014-09-10 12:51:52 +00002588 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002589 W.startLine() << "Invalid section number: " << EC.message() << "\n";
2590 W.flush();
2591 return;
2592 }
2593
2594 StringRef SymbolName;
2595 if (Obj->getSymbolName(Symbol, SymbolName))
2596 SymbolName = "";
2597
David Majnemer236b0ca2014-11-17 11:17:17 +00002598 StringRef SectionName = "";
2599 ErrorOr<StringRef> Res =
2600 getSectionName(Obj, Symbol.getSectionNumber(), Section);
2601 if (Res)
2602 SectionName = *Res;
Eric Christopher9cad53c2013-04-03 18:31:38 +00002603
2604 W.printString("Name", SymbolName);
David Majnemer44f51e52014-09-10 12:51:52 +00002605 W.printNumber("Value", Symbol.getValue());
2606 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
2607 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
2608 W.printEnum ("ComplexType", Symbol.getComplexType(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00002609 makeArrayRef(ImageSymDType));
David Majnemer44f51e52014-09-10 12:51:52 +00002610 W.printEnum ("StorageClass", Symbol.getStorageClass(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00002611 makeArrayRef(ImageSymClass));
David Majnemer44f51e52014-09-10 12:51:52 +00002612 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
Eric Christopher9cad53c2013-04-03 18:31:38 +00002613
David Majnemer44f51e52014-09-10 12:51:52 +00002614 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
2615 if (Symbol.isFunctionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002616 const coff_aux_function_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002617 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002618
2619 DictScope AS(W, "AuxFunctionDef");
2620 W.printNumber("TagIndex", Aux->TagIndex);
2621 W.printNumber("TotalSize", Aux->TotalSize);
David Majnemerf3a2af52014-03-19 04:33:27 +00002622 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002623 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002624
David Majnemerc7d7c6f2014-10-31 05:07:00 +00002625 } else if (Symbol.isAnyUndefined()) {
David Majnemerf3a2af52014-03-19 04:33:27 +00002626 const coff_aux_weak_external *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002627 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002628
David Majnemer44f51e52014-09-10 12:51:52 +00002629 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002630 StringRef LinkedName;
David Majnemer44f51e52014-09-10 12:51:52 +00002631 std::error_code EC = Linked.getError();
2632 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002633 LinkedName = "";
2634 error(EC);
2635 }
2636
2637 DictScope AS(W, "AuxWeakExternal");
2638 W.printNumber("Linked", LinkedName, Aux->TagIndex);
2639 W.printEnum ("Search", Aux->Characteristics,
2640 makeArrayRef(WeakExternalCharacteristics));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002641
David Majnemer44f51e52014-09-10 12:51:52 +00002642 } else if (Symbol.isFileRecord()) {
2643 const char *FileName;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002644 error(getSymbolAuxData(Obj, Symbol, I, FileName));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002645
Nico Rieck0ab8e602013-04-22 08:35:11 +00002646 DictScope AS(W, "AuxFileRecord");
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00002647
David Majnemer44f51e52014-09-10 12:51:52 +00002648 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
2649 Obj->getSymbolTableEntrySize());
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00002650 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
Saleem Abdulrasool3b5e0012014-04-16 04:15:29 +00002651 break;
David Majnemer44f51e52014-09-10 12:51:52 +00002652 } else if (Symbol.isSectionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002653 const coff_aux_section_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002654 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002655
David Majnemer4d571592014-09-15 19:42:42 +00002656 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
2657
Eric Christopher9cad53c2013-04-03 18:31:38 +00002658 DictScope AS(W, "AuxSectionDef");
2659 W.printNumber("Length", Aux->Length);
2660 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
2661 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
2662 W.printHex("Checksum", Aux->CheckSum);
David Majnemer4d571592014-09-15 19:42:42 +00002663 W.printNumber("Number", AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002664 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002665
Nico Riecka711dee2013-04-22 08:34:59 +00002666 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
Eric Christopher9cad53c2013-04-03 18:31:38 +00002667 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
2668 const coff_section *Assoc;
David Majnemer236b0ca2014-11-17 11:17:17 +00002669 StringRef AssocName = "";
2670 std::error_code EC = Obj->getSection(AuxNumber, Assoc);
2671 ErrorOr<StringRef> Res = getSectionName(Obj, AuxNumber, Assoc);
2672 if (Res)
2673 AssocName = *Res;
2674 if (!EC)
2675 EC = Res.getError();
2676 if (EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002677 AssocName = "";
2678 error(EC);
2679 }
2680
David Majnemer4d571592014-09-15 19:42:42 +00002681 W.printNumber("AssocSection", AssocName, AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002682 }
David Majnemer44f51e52014-09-10 12:51:52 +00002683 } else if (Symbol.isCLRToken()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002684 const coff_aux_clr_token *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002685 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002686
David Majnemer44f51e52014-09-10 12:51:52 +00002687 ErrorOr<COFFSymbolRef> ReferredSym =
2688 Obj->getSymbol(Aux->SymbolTableIndex);
Nico Rieck8678acd2014-03-17 01:46:52 +00002689 StringRef ReferredName;
David Majnemer44f51e52014-09-10 12:51:52 +00002690 std::error_code EC = ReferredSym.getError();
2691 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
Nico Rieck8678acd2014-03-17 01:46:52 +00002692 ReferredName = "";
2693 error(EC);
2694 }
2695
Eric Christopher9cad53c2013-04-03 18:31:38 +00002696 DictScope AS(W, "AuxCLRToken");
2697 W.printNumber("AuxType", Aux->AuxType);
2698 W.printNumber("Reserved", Aux->Reserved);
Nico Rieck8678acd2014-03-17 01:46:52 +00002699 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002700
2701 } else {
2702 W.startLine() << "<unhandled auxiliary record>\n";
2703 }
2704 }
2705}
2706
2707void COFFDumper::printUnwindInfo() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002708 ListScope D(W, "UnwindInformation");
David Majnemer44f51e52014-09-10 12:51:52 +00002709 switch (Obj->getMachine()) {
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00002710 case COFF::IMAGE_FILE_MACHINE_AMD64: {
2711 Win64EH::Dumper Dumper(W);
Rafael Espindola4453e42942014-06-13 03:07:50 +00002712 Win64EH::Dumper::SymbolResolver
2713 Resolver = [](const object::coff_section *Section, uint64_t Offset,
2714 SymbolRef &Symbol, void *user_data) -> std::error_code {
2715 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
2716 return Dumper->resolveSymbol(Section, Offset, Symbol);
2717 };
Saleem Abdulrasool65dbbb52014-05-25 21:37:59 +00002718 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00002719 Dumper.printData(Ctx);
2720 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00002721 }
Saleem Abdulrasoole6971ca2014-06-04 15:47:15 +00002722 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
2723 ARM::WinEH::Decoder Decoder(W);
2724 Decoder.dumpProcedureData(*Obj);
2725 break;
2726 }
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00002727 default:
David Majnemer44f51e52014-09-10 12:51:52 +00002728 W.printEnum("unsupported Image Machine", Obj->getMachine(),
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00002729 makeArrayRef(ImageFileMachineType));
2730 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00002731 }
2732}
2733
Rui Ueyama979fb402014-10-09 02:16:38 +00002734void COFFDumper::printImportedSymbols(
2735 iterator_range<imported_symbol_iterator> Range) {
2736 for (const ImportedSymbolRef &I : Range) {
Rui Ueyama15d99352014-10-03 00:41:58 +00002737 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002738 error(I.getSymbolName(Sym));
Rui Ueyama15d99352014-10-03 00:41:58 +00002739 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002740 error(I.getOrdinal(Ordinal));
Rui Ueyama15d99352014-10-03 00:41:58 +00002741 W.printNumber("Symbol", Sym, Ordinal);
2742 }
2743}
2744
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00002745void COFFDumper::printDelayImportedSymbols(
2746 const DelayImportDirectoryEntryRef &I,
2747 iterator_range<imported_symbol_iterator> Range) {
2748 int Index = 0;
2749 for (const ImportedSymbolRef &S : Range) {
2750 DictScope Import(W, "Import");
2751 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002752 error(S.getSymbolName(Sym));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00002753 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002754 error(S.getOrdinal(Ordinal));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00002755 W.printNumber("Symbol", Sym, Ordinal);
2756 uint64_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002757 error(I.getImportAddress(Index++, Addr));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00002758 W.printHex("Address", Addr);
2759 }
2760}
2761
Rui Ueyama1e152d52014-10-02 17:02:18 +00002762void COFFDumper::printCOFFImports() {
Rui Ueyama15d99352014-10-03 00:41:58 +00002763 // Regular imports
Rui Ueyama979fb402014-10-09 02:16:38 +00002764 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
Rui Ueyama1e152d52014-10-02 17:02:18 +00002765 DictScope Import(W, "Import");
2766 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002767 error(I.getName(Name));
Rui Ueyama1e152d52014-10-02 17:02:18 +00002768 W.printString("Name", Name);
2769 uint32_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002770 error(I.getImportLookupTableRVA(Addr));
Rui Ueyama1e152d52014-10-02 17:02:18 +00002771 W.printHex("ImportLookupTableRVA", Addr);
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002772 error(I.getImportAddressTableRVA(Addr));
Rui Ueyama1e152d52014-10-02 17:02:18 +00002773 W.printHex("ImportAddressTableRVA", Addr);
Rui Ueyama979fb402014-10-09 02:16:38 +00002774 printImportedSymbols(I.imported_symbols());
Rui Ueyama15d99352014-10-03 00:41:58 +00002775 }
2776
2777 // Delay imports
Rui Ueyama979fb402014-10-09 02:16:38 +00002778 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
Rui Ueyama15d99352014-10-03 00:41:58 +00002779 DictScope Import(W, "DelayImport");
2780 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002781 error(I.getName(Name));
Rui Ueyama15d99352014-10-03 00:41:58 +00002782 W.printString("Name", Name);
Rui Ueyama1af08652014-10-03 18:07:18 +00002783 const delay_import_directory_table_entry *Table;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002784 error(I.getDelayImportTable(Table));
Rui Ueyama1af08652014-10-03 18:07:18 +00002785 W.printHex("Attributes", Table->Attributes);
2786 W.printHex("ModuleHandle", Table->ModuleHandle);
2787 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
2788 W.printHex("ImportNameTable", Table->DelayImportNameTable);
2789 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
2790 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00002791 printDelayImportedSymbols(I, I.imported_symbols());
Rui Ueyama1e152d52014-10-02 17:02:18 +00002792 }
2793}
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00002794
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00002795void COFFDumper::printCOFFExports() {
2796 for (const ExportDirectoryEntryRef &E : Obj->export_directories()) {
2797 DictScope Export(W, "Export");
2798
2799 StringRef Name;
2800 uint32_t Ordinal, RVA;
2801
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002802 error(E.getSymbolName(Name));
2803 error(E.getOrdinal(Ordinal));
2804 error(E.getExportRVA(RVA));
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00002805
2806 W.printNumber("Ordinal", Ordinal);
2807 W.printString("Name", Name);
2808 W.printHex("RVA", RVA);
2809 }
2810}
2811
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00002812void COFFDumper::printCOFFDirectives() {
2813 for (const SectionRef &Section : Obj->sections()) {
2814 StringRef Contents;
2815 StringRef Name;
2816
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002817 error(Section.getName(Name));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00002818 if (Name != ".drectve")
2819 continue;
2820
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002821 error(Section.getContents(Contents));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00002822
2823 W.printString("Directive(s)", Contents);
2824 }
2825}
Rui Ueyama74e85132014-11-19 00:18:07 +00002826
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00002827static StringRef getBaseRelocTypeName(uint8_t Type) {
Rui Ueyama74e85132014-11-19 00:18:07 +00002828 switch (Type) {
2829 case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";
2830 case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";
2831 case COFF::IMAGE_REL_BASED_LOW: return "LOW";
2832 case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";
2833 case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";
Saleem Abdulrasool5a41c372015-01-16 20:16:09 +00002834 case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)";
Rui Ueyama74e85132014-11-19 00:18:07 +00002835 case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";
Colin LeMahieu9fbffee2014-11-19 17:10:39 +00002836 default: return "unknown (" + llvm::utostr(Type) + ")";
Rui Ueyama74e85132014-11-19 00:18:07 +00002837 }
2838}
2839
2840void COFFDumper::printCOFFBaseReloc() {
2841 ListScope D(W, "BaseReloc");
2842 for (const BaseRelocRef &I : Obj->base_relocs()) {
2843 uint8_t Type;
2844 uint32_t RVA;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002845 error(I.getRVA(RVA));
2846 error(I.getType(Type));
Rui Ueyama74e85132014-11-19 00:18:07 +00002847 DictScope Import(W, "Entry");
2848 W.printString("Type", getBaseRelocTypeName(Type));
2849 W.printHex("Address", RVA);
2850 }
2851}
Lang Hames0000afd2015-06-26 23:56:53 +00002852
2853void COFFDumper::printStackMap() const {
2854 object::SectionRef StackMapSection;
2855 for (auto Sec : Obj->sections()) {
2856 StringRef Name;
2857 Sec.getName(Name);
2858 if (Name == ".llvm_stackmaps") {
2859 StackMapSection = Sec;
2860 break;
2861 }
2862 }
2863
2864 if (StackMapSection == object::SectionRef())
2865 return;
2866
2867 StringRef StackMapContents;
2868 StackMapSection.getContents(StackMapContents);
2869 ArrayRef<uint8_t> StackMapContentsArray(
2870 reinterpret_cast<const uint8_t*>(StackMapContents.data()),
2871 StackMapContents.size());
2872
2873 if (Obj->isLittleEndian())
2874 prettyPrintStackMap(
2875 llvm::outs(),
2876 StackMapV1Parser<support::little>(StackMapContentsArray));
2877 else
2878 prettyPrintStackMap(llvm::outs(),
2879 StackMapV1Parser<support::big>(StackMapContentsArray));
2880}