blob: 816fa16e99e45e815fdf486eebb2957a61dfa8fb [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
15#include "llvm-readobj.h"
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000016#include "ARMWinEHPrinter.h"
Reid Kleckner72e2ba72016-01-13 19:32:35 +000017#include "CodeView.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000018#include "Error.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000019#include "ObjDumper.h"
Lang Hames0000afd2015-06-26 23:56:53 +000020#include "StackMapPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000021#include "StreamWriter.h"
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +000022#include "Win64EHDumper.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000023#include "llvm/ADT/DenseMap.h"
24#include "llvm/ADT/SmallString.h"
Colin LeMahieu9fbffee2014-11-19 17:10:39 +000025#include "llvm/ADT/StringExtras.h"
Reid Kleckner72e2ba72016-01-13 19:32:35 +000026#include "llvm/ADT/StringSet.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000027#include "llvm/DebugInfo/CodeView/CodeView.h"
28#include "llvm/DebugInfo/CodeView/TypeIndex.h"
29#include "llvm/DebugInfo/CodeView/TypeRecord.h"
30#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000031#include "llvm/Object/COFF.h"
32#include "llvm/Object/ObjectFile.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000033#include "llvm/Support/COFF.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000034#include "llvm/Support/Casting.h"
35#include "llvm/Support/Compiler.h"
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000036#include "llvm/Support/DataExtractor.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000037#include "llvm/Support/Format.h"
38#include "llvm/Support/SourceMgr.h"
39#include "llvm/Support/Win64EH.h"
40#include "llvm/Support/raw_ostream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000041#include <algorithm>
42#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000043#include <system_error>
Eric Christopher9cad53c2013-04-03 18:31:38 +000044#include <time.h>
45
46using namespace llvm;
47using namespace llvm::object;
Reid Kleckner72e2ba72016-01-13 19:32:35 +000048using namespace llvm::codeview;
Reid Kleckner6b3faef2016-01-13 23:44:57 +000049using namespace llvm::support;
Eric Christopher9cad53c2013-04-03 18:31:38 +000050using namespace llvm::Win64EH;
51
52namespace {
53
54class COFFDumper : public ObjDumper {
55public:
56 COFFDumper(const llvm::object::COFFObjectFile *Obj, StreamWriter& Writer)
57 : ObjDumper(Writer)
58 , Obj(Obj) {
Eric Christopher9cad53c2013-04-03 18:31:38 +000059 }
60
Craig Topperfd38cbe2014-08-30 16:48:34 +000061 void printFileHeaders() override;
62 void printSections() override;
63 void printRelocations() override;
64 void printSymbols() override;
65 void printDynamicSymbols() override;
66 void printUnwindInfo() override;
Rui Ueyama1e152d52014-10-02 17:02:18 +000067 void printCOFFImports() override;
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +000068 void printCOFFExports() override;
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +000069 void printCOFFDirectives() override;
Rui Ueyama74e85132014-11-19 00:18:07 +000070 void printCOFFBaseReloc() override;
Reid Kleckner83ebad32015-12-16 18:28:12 +000071 void printCodeViewDebugInfo() override;
Lang Hames0000afd2015-06-26 23:56:53 +000072 void printStackMap() const override;
Eric Christopher9cad53c2013-04-03 18:31:38 +000073private:
Alexey Samsonov27dc8392014-03-18 06:53:02 +000074 void printSymbol(const SymbolRef &Sym);
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +000075 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc,
76 uint64_t Bias = 0);
Rui Ueyamaed64342b2013-07-19 23:23:29 +000077 void printDataDirectory(uint32_t Index, const std::string &FieldName);
Eric Christopher9cad53c2013-04-03 18:31:38 +000078
David Majnemer50267222014-11-05 06:24:35 +000079 void printDOSHeader(const dos_header *DH);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +000080 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
81 void printBaseOfDataField(const pe32_header *Hdr);
82 void printBaseOfDataField(const pe32plus_header *Hdr);
83
Reid Kleckner72e2ba72016-01-13 19:32:35 +000084 void printCodeViewSymbolSection(StringRef SectionName, const SectionRef &Section);
85 void printCodeViewTypeSection(StringRef SectionName, const SectionRef &Section);
86 void printCodeViewFieldList(StringRef FieldData);
87 StringRef getTypeName(TypeIndex Ty);
88 void printTypeIndex(StringRef FieldName, TypeIndex TI);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000089
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +000090 void printCodeViewSymbolsSubsection(StringRef Subsection,
91 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +000092 StringRef SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +000093
Reid Kleckner72e2ba72016-01-13 19:32:35 +000094 void printMemberAttributes(MemberAttributes Attrs);
95
Reid Kleckner2893fd12016-01-14 17:51:54 +000096 void printRelocatedField(StringRef Label, const coff_section *Sec,
97 StringRef SectionContents, const ulittle32_t *Field,
98 StringRef *RelocSym = nullptr);
99
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000100 void printBinaryBlockWithRelocs(StringRef Label, const SectionRef &Sec,
101 StringRef SectionContents, StringRef Block);
102
Eric Christopher9cad53c2013-04-03 18:31:38 +0000103 void cacheRelocations();
104
Rafael Espindola4453e42942014-06-13 03:07:50 +0000105 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
106 SymbolRef &Sym);
107 std::error_code resolveSymbolName(const coff_section *Section,
108 uint64_t Offset, StringRef &Name);
Reid Kleckner2893fd12016-01-14 17:51:54 +0000109 std::error_code resolveSymbolName(const coff_section *Section,
110 StringRef SectionContents,
111 const void *RelocPtr, StringRef &Name);
Rui Ueyama979fb402014-10-09 02:16:38 +0000112 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +0000113 void printDelayImportedSymbols(
114 const DelayImportDirectoryEntryRef &I,
115 iterator_range<imported_symbol_iterator> Range);
Rui Ueyama15d99352014-10-03 00:41:58 +0000116
Eric Christopher9cad53c2013-04-03 18:31:38 +0000117 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
118
119 const llvm::object::COFFObjectFile *Obj;
Rafael Espindola76d650e2015-07-06 14:26:07 +0000120 bool RelocCached = false;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000121 RelocMapTy RelocMap;
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000122 StringRef CVFileIndexToStringOffsetTable;
123 StringRef CVStringTable;
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000124
125 /// All user defined type records in .debug$T live in here. Type indices
126 /// greater than 0x1000 are user defined. Subtract 0x1000 from the index to
127 /// index into this vector.
128 SmallVector<StringRef, 10> CVUDTNames;
129
130 StringSet<> TypeNames;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000131};
132
133} // namespace
134
135
136namespace llvm {
137
Rafael Espindola4453e42942014-06-13 03:07:50 +0000138std::error_code createCOFFDumper(const object::ObjectFile *Obj,
139 StreamWriter &Writer,
140 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000141 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
142 if (!COFFObj)
143 return readobj_error::unsupported_obj_file_format;
144
145 Result.reset(new COFFDumper(COFFObj, Writer));
146 return readobj_error::success;
147}
148
149} // namespace llvm
150
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000151// Given a a section and an offset into this section the function returns the
152// symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000153std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
154 uint64_t Offset, SymbolRef &Sym) {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000155 cacheRelocations();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000156 const auto &Relocations = RelocMap[Section];
157 for (const auto &Relocation : Relocations) {
Rafael Espindola96d071c2015-06-29 23:29:12 +0000158 uint64_t RelocationOffset = Relocation.getOffset();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000159
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000160 if (RelocationOffset == Offset) {
Saleem Abdulrasool4a6f5832014-05-20 05:18:06 +0000161 Sym = *Relocation.getSymbol();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000162 return readobj_error::success;
163 }
164 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000165 return readobj_error::unknown_symbol;
166}
167
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000168// Given a section and an offset into this section the function returns the name
169// of the symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000170std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
171 uint64_t Offset,
172 StringRef &Name) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000173 SymbolRef Symbol;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000174 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000175 return EC;
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000176 ErrorOr<StringRef> NameOrErr = Symbol.getName();
177 if (std::error_code EC = NameOrErr.getError())
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000178 return EC;
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000179 Name = *NameOrErr;
Rui Ueyama7d099192015-06-09 15:20:42 +0000180 return std::error_code();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000181}
182
Reid Kleckner2893fd12016-01-14 17:51:54 +0000183// Helper for when you have a pointer to real data and you want to know about
184// relocations against it.
185std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
186 StringRef SectionContents,
187 const void *RelocPtr,
188 StringRef &Name) {
189 assert(SectionContents.data() < RelocPtr &&
190 RelocPtr < SectionContents.data() + SectionContents.size() &&
191 "pointer to relocated object is not in section");
192 uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) -
193 SectionContents.data());
194 return resolveSymbolName(Section, Offset, Name);
195}
196
197void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec,
198 StringRef SectionContents,
199 const ulittle32_t *Field,
200 StringRef *RelocSym) {
201 StringRef SymStorage;
202 StringRef &Symbol = RelocSym ? *RelocSym : SymStorage;
203 if (!resolveSymbolName(Sec, SectionContents, Field, Symbol))
204 W.printSymbolOffset(Label, Symbol, *Field);
205 else
206 W.printHex(Label, *Field);
207}
208
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000209void COFFDumper::printBinaryBlockWithRelocs(StringRef Label,
210 const SectionRef &Sec,
211 StringRef SectionContents,
212 StringRef Block) {
213 W.printBinaryBlock(Label, Block);
214
215 assert(SectionContents.begin() < Block.begin() &&
216 SectionContents.end() >= Block.end() &&
217 "Block is not contained in SectionContents");
218 uint64_t OffsetStart = Block.data() - SectionContents.data();
219 uint64_t OffsetEnd = OffsetStart + Block.size();
220
221 cacheRelocations();
222 ListScope D(W, "BlockRelocations");
223 const coff_section *Section = Obj->getCOFFSection(Sec);
224 const auto &Relocations = RelocMap[Section];
225 for (const auto &Relocation : Relocations) {
226 uint64_t RelocationOffset = Relocation.getOffset();
227 if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd)
228 printRelocation(Sec, Relocation, OffsetStart);
229 }
230}
231
Eric Christopher9cad53c2013-04-03 18:31:38 +0000232static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
233 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
234 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
235 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
236 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
Saleem Abdulrasool5e1780e2014-03-11 03:08:37 +0000237 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000238 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
239 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
240 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
241 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
242 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
243 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
244 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
245 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
246 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
247 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
248 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
249 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
250 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
251 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
252 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
253 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
254};
255
256static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
257 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
258 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
259 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
260 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
261 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
262 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
263 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
264 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
265 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
266 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
267 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
268 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
269 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
270 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
271 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
272};
273
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000274static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
275 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
276 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
277 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
278 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
279 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
280 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
281 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
282 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
283 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
284 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
285 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
286};
287
288static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
Rui Ueyama06dc5e72014-01-27 04:22:24 +0000289 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000290 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
291 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
292 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
293 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
294 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
295 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000296 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000297 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000298 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000299 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
300};
301
Eric Christopher9cad53c2013-04-03 18:31:38 +0000302static const EnumEntry<COFF::SectionCharacteristics>
303ImageSectionCharacteristics[] = {
David Majnemerd3238882015-07-30 16:47:56 +0000304 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000305 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
306 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
307 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
308 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
309 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
310 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
311 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
312 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
313 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
314 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
315 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
316 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
317 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
318 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
319 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
320 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
321 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
322 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
323 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
324 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
325 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
326 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
327 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
328 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
329 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
330 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
331 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
332 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
333 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
334 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
335 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
336 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
337 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
338 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
339 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
340};
341
342static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
343 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
344 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
345 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
346 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
347 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
348 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
349 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
350 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
351 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
352 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
353 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
354 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
355 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
356 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
357 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
358 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
359};
360
361static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
362 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
363 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
364 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
365 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
366};
367
368static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
369 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
370 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
371 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
372 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
373 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
374 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
375 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
376 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
377 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
378 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
379 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
380 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
381 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
382 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
383 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
384 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
385 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
386 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
387 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
388 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
389 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
390 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
391 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
392 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
393 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
394 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
395 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
396};
397
398static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
399 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
400 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
401 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
402 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
403 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
404 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
405 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
406};
407
408static const EnumEntry<COFF::WeakExternalCharacteristics>
409WeakExternalCharacteristics[] = {
410 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
411 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
412 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
413};
414
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000415static const EnumEntry<CompileSym3::Flags> CompileSym3Flags[] = {
416 LLVM_READOBJ_ENUM_ENT(CompileSym3, EC),
417 LLVM_READOBJ_ENUM_ENT(CompileSym3, NoDbgInfo),
418 LLVM_READOBJ_ENUM_ENT(CompileSym3, LTCG),
419 LLVM_READOBJ_ENUM_ENT(CompileSym3, NoDataAlign),
420 LLVM_READOBJ_ENUM_ENT(CompileSym3, ManagedPresent),
421 LLVM_READOBJ_ENUM_ENT(CompileSym3, SecurityChecks),
422 LLVM_READOBJ_ENUM_ENT(CompileSym3, HotPatch),
423 LLVM_READOBJ_ENUM_ENT(CompileSym3, CVTCIL),
424 LLVM_READOBJ_ENUM_ENT(CompileSym3, MSILModule),
425 LLVM_READOBJ_ENUM_ENT(CompileSym3, Sdl),
426 LLVM_READOBJ_ENUM_ENT(CompileSym3, PGO),
427 LLVM_READOBJ_ENUM_ENT(CompileSym3, Exp),
428};
429
430static const EnumEntry<codeview::SourceLanguage> SourceLanguages[] = {
431 LLVM_READOBJ_ENUM_ENT(SourceLanguage, C),
432 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Cpp),
433 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Fortran),
434 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Masm),
435 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Pascal),
436 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Basic),
437 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Cobol),
438 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Link),
439 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Cvtres),
440 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Cvtpgd),
441 LLVM_READOBJ_ENUM_ENT(SourceLanguage, CSharp),
442 LLVM_READOBJ_ENUM_ENT(SourceLanguage, VB),
443 LLVM_READOBJ_ENUM_ENT(SourceLanguage, ILAsm),
444 LLVM_READOBJ_ENUM_ENT(SourceLanguage, Java),
445 LLVM_READOBJ_ENUM_ENT(SourceLanguage, JScript),
446 LLVM_READOBJ_ENUM_ENT(SourceLanguage, MSIL),
447 LLVM_READOBJ_ENUM_ENT(SourceLanguage, HLSL),
448};
449
450static const EnumEntry<uint32_t> SubSectionTypes[] = {
451 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Symbols),
452 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, Lines),
453 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, StringTable),
454 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FileChecksums),
455 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FrameData),
456 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, InlineeLines),
457 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeImports),
458 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CrossScopeExports),
459 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, ILLines),
460 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, FuncMDTokenMap),
461 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, TypeMDTokenMap),
462 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, MergedAssemblyInput),
463 LLVM_READOBJ_ENUM_CLASS_ENT(ModuleSubstreamKind, CoffSymbolRVA),
464};
465
466static const EnumEntry<unsigned> CPUTypeNames[] = {
467 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Intel8080),
468 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Intel8086),
469 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Intel80286),
470 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Intel80386),
471 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Intel80486),
472 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Pentium),
473 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PentiumPro),
474 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Pentium3),
475 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPS),
476 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPS16),
477 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPS32),
478 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPS64),
479 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPSI),
480 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPSII),
481 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPSIII),
482 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPSIV),
483 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, MIPSV),
484 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M68000),
485 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M68010),
486 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M68020),
487 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M68030),
488 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M68040),
489 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Alpha),
490 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Alpha21164),
491 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Alpha21164A),
492 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Alpha21264),
493 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Alpha21364),
494 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPC601),
495 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPC603),
496 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPC604),
497 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPC620),
498 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPCFP),
499 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, PPCBE),
500 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, SH3),
501 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, SH3E),
502 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, SH3DSP),
503 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, SH4),
504 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, SHMedia),
505 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM3),
506 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM4),
507 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM4T),
508 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM5),
509 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM5T),
510 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM6),
511 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM_XMAC),
512 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM_WMMX),
513 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARM7),
514 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Omni),
515 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Ia64),
516 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Ia64_2),
517 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, CEE),
518 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, AM33),
519 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, M32R),
520 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, TriCore),
521 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, X64),
522 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, EBC),
523 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, Thumb),
524 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, ARMNT),
525 LLVM_READOBJ_ENUM_CLASS_ENT(CPUType, D3D11_Shader),
526};
527
528static const EnumEntry<uint8_t> ProcSymFlags[] = {
529 LLVM_READOBJ_ENUM_ENT(ProcFlags, HasFP),
530 LLVM_READOBJ_ENUM_ENT(ProcFlags, HasIRET),
531 LLVM_READOBJ_ENUM_ENT(ProcFlags, HasFRET),
532 LLVM_READOBJ_ENUM_ENT(ProcFlags, IsNoReturn),
533 LLVM_READOBJ_ENUM_ENT(ProcFlags, IsUnreachable),
534 LLVM_READOBJ_ENUM_ENT(ProcFlags, HasCustomCallingConv),
535 LLVM_READOBJ_ENUM_ENT(ProcFlags, IsNoInline),
536 LLVM_READOBJ_ENUM_ENT(ProcFlags, HasOptimizedDebugInfo),
537};
538
539static const EnumEntry<uint32_t> FrameProcSymFlags[] = {
540 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, HasAlloca),
541 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, HasSetJmp),
542 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, HasLongJmp),
543 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, HasInlineAssembly),
544 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, HasExceptionHandling),
545 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, MarkedInline),
546 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions,
547 HasStructuredExceptionHandling),
548 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, Naked),
549 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, SecurityChecks),
550 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions,
551 AsynchronousExceptionHandling),
552 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions,
553 NoStackOrderingForSecurityChecks),
554 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, Inlined),
555 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, StrictSecurityChecks),
556 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, SafeBuffers),
557 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions,
558 ProfileGuidedOptimization),
559 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, ValidProfileCounts),
560 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, OptimizedForSpeed),
561 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, GuardCfg),
562 LLVM_READOBJ_ENUM_CLASS_ENT(FrameProcedureOptions, GuardCfw),
563};
564
565static const EnumEntry<uint32_t> FrameDataFlags[] = {
566 LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH),
567 LLVM_READOBJ_ENUM_ENT(FrameData, HasEH),
568 LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart),
569};
570
571static const EnumEntry<uint16_t> LocalFlags[] = {
572 LLVM_READOBJ_ENUM_ENT(LocalSym, IsParameter),
573 LLVM_READOBJ_ENUM_ENT(LocalSym, IsAddressTaken),
574 LLVM_READOBJ_ENUM_ENT(LocalSym, IsCompilerGenerated),
575 LLVM_READOBJ_ENUM_ENT(LocalSym, IsAggregate),
576 LLVM_READOBJ_ENUM_ENT(LocalSym, IsAggregated),
577 LLVM_READOBJ_ENUM_ENT(LocalSym, IsAliased),
578 LLVM_READOBJ_ENUM_ENT(LocalSym, IsAlias),
579 LLVM_READOBJ_ENUM_ENT(LocalSym, IsReturnValue),
580 LLVM_READOBJ_ENUM_ENT(LocalSym, IsOptimizedOut),
581 LLVM_READOBJ_ENUM_ENT(LocalSym, IsEnregisteredGlobal),
582 LLVM_READOBJ_ENUM_ENT(LocalSym, IsEnregisteredStatic),
583};
584
585static const EnumEntry<uint16_t> FrameCookieKinds[] = {
586 LLVM_READOBJ_ENUM_ENT(FrameCookieSym, Copy),
587 LLVM_READOBJ_ENUM_ENT(FrameCookieSym, XorStackPointer),
588 LLVM_READOBJ_ENUM_ENT(FrameCookieSym, XorFramePointer),
589 LLVM_READOBJ_ENUM_ENT(FrameCookieSym, XorR13),
590};
591
592static const EnumEntry<uint16_t> ClassOptionNames[] = {
593 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, Packed),
594 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, HasConstructorOrDestructor),
595 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, HasOverloadedOperator),
596 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, Nested),
597 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, ContainsNestedClass),
598 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, HasOverloadedAssignmentOperator),
599 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, HasConversionOperator),
600 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, ForwardReference),
601 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, Scoped),
602 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, HasUniqueName),
603 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, Sealed),
604 LLVM_READOBJ_ENUM_CLASS_ENT(ClassOptions, Intrinsic),
605};
606
607static const EnumEntry<uint8_t> MemberAccessNames[] = {
608 LLVM_READOBJ_ENUM_CLASS_ENT(MemberAccess, None),
609 LLVM_READOBJ_ENUM_CLASS_ENT(MemberAccess, Private),
610 LLVM_READOBJ_ENUM_CLASS_ENT(MemberAccess, Protected),
611 LLVM_READOBJ_ENUM_CLASS_ENT(MemberAccess, Public),
612};
613
614static const EnumEntry<uint16_t> MethodOptionNames[] = {
615 LLVM_READOBJ_ENUM_CLASS_ENT(MethodOptions, Pseudo),
616 LLVM_READOBJ_ENUM_CLASS_ENT(MethodOptions, NoInherit),
617 LLVM_READOBJ_ENUM_CLASS_ENT(MethodOptions, NoConstruct),
618 LLVM_READOBJ_ENUM_CLASS_ENT(MethodOptions, CompilerGenerated),
619 LLVM_READOBJ_ENUM_CLASS_ENT(MethodOptions, Sealed),
620};
621
622static const EnumEntry<uint16_t> MemberKindNames[] = {
623 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, Vanilla),
624 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, Virtual),
625 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, Static),
626 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, Friend),
627 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, IntroducingVirtual),
628 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, PureVirtual),
629 LLVM_READOBJ_ENUM_CLASS_ENT(MethodKind, PureIntroducingVirtual),
630};
631
632/// The names here all end in "*". If the simple type is a pointer type, we
633/// return the whole name. Otherwise we lop off the last character in our
634/// StringRef.
635static const EnumEntry<SimpleTypeKind> SimpleTypeNames[] = {
636 {"void*", SimpleTypeKind::Void},
637 {"<not translated>*", SimpleTypeKind::NotTranslated},
638 {"HRESULT*", SimpleTypeKind::HResult},
639 {"signed char*", SimpleTypeKind::SignedCharacter},
640 {"unsigned char*", SimpleTypeKind::UnsignedCharacter},
641 {"char*", SimpleTypeKind::NarrowCharacter},
642 {"wchar_t*", SimpleTypeKind::WideCharacter},
643 {"__int8*", SimpleTypeKind::SByte},
644 {"unsigned __int8*", SimpleTypeKind::Byte},
645 {"short*", SimpleTypeKind::Int16Short},
646 {"unsigned short*", SimpleTypeKind::UInt16Short},
647 {"__int16*", SimpleTypeKind::Int16},
648 {"unsigned __int16*", SimpleTypeKind::UInt16},
649 {"long*", SimpleTypeKind::Int32Long},
650 {"unsigned long*", SimpleTypeKind::UInt32Long},
651 {"int*", SimpleTypeKind::Int32},
652 {"unsigned*", SimpleTypeKind::UInt32},
653 {"__int64*", SimpleTypeKind::Int64Quad},
654 {"unsigned __int64*", SimpleTypeKind::UInt64Quad},
655 {"__int64*", SimpleTypeKind::Int64},
656 {"unsigned __int64*", SimpleTypeKind::UInt64},
657 {"__int128*", SimpleTypeKind::Int128},
658 {"unsigned __int128*", SimpleTypeKind::UInt128},
659 {"__half*", SimpleTypeKind::Float16},
660 {"float*", SimpleTypeKind::Float32},
661 {"float*", SimpleTypeKind::Float32PartialPrecision},
662 {"__float48*", SimpleTypeKind::Float48},
663 {"double*", SimpleTypeKind::Float64},
664 {"long double*", SimpleTypeKind::Float80},
665 {"__float128*", SimpleTypeKind::Float128},
666 {"_Complex float*", SimpleTypeKind::Complex32},
667 {"_Complex double*", SimpleTypeKind::Complex64},
668 {"_Complex long double*", SimpleTypeKind::Complex80},
669 {"_Complex __float128*", SimpleTypeKind::Complex128},
670 {"bool*", SimpleTypeKind::Boolean8},
671 {"__bool16*", SimpleTypeKind::Boolean16},
672 {"__bool32*", SimpleTypeKind::Boolean32},
673 {"__bool64*", SimpleTypeKind::Boolean64},
674};
675
Reid Kleckner6b3faef2016-01-13 23:44:57 +0000676static const EnumEntry<TypeLeafKind> LeafTypeNames[] = {
677#define LEAF_TYPE(name, val) LLVM_READOBJ_ENUM_ENT(TypeLeafKind, name),
678#include "llvm/DebugInfo/CodeView/CVLeafTypes.def"
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000679};
680
681static const EnumEntry<uint8_t> PtrKindNames[] = {
682 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Near16),
683 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Far16),
684 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Huge16),
685 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnSegment),
686 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnValue),
687 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnSegmentValue),
688 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnAddress),
689 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnSegmentAddress),
690 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnType),
691 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, BasedOnSelf),
692 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Near32),
693 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Far32),
694 LLVM_READOBJ_ENUM_CLASS_ENT(PointerKind, Near64),
695};
696
697static const EnumEntry<uint8_t> PtrModeNames[] = {
698 LLVM_READOBJ_ENUM_CLASS_ENT(PointerMode, Pointer),
699 LLVM_READOBJ_ENUM_CLASS_ENT(PointerMode, LValueReference),
700 LLVM_READOBJ_ENUM_CLASS_ENT(PointerMode, PointerToDataMember),
701 LLVM_READOBJ_ENUM_CLASS_ENT(PointerMode, PointerToMemberFunction),
702 LLVM_READOBJ_ENUM_CLASS_ENT(PointerMode, RValueReference),
703};
704
705static const EnumEntry<uint16_t> PtrMemberRepNames[] = {
706 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation, Unknown),
707 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
708 SingleInheritanceData),
709 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
710 MultipleInheritanceData),
711 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
712 VirtualInheritanceData),
713 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation, GeneralData),
714 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
715 SingleInheritanceFunction),
716 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
717 MultipleInheritanceFunction),
718 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation,
719 VirtualInheritanceFunction),
720 LLVM_READOBJ_ENUM_CLASS_ENT(PointerToMemberRepresentation, GeneralFunction),
721};
722
723static const EnumEntry<uint16_t> TypeModifierNames[] = {
724 LLVM_READOBJ_ENUM_CLASS_ENT(ModifierOptions, Const),
725 LLVM_READOBJ_ENUM_CLASS_ENT(ModifierOptions, Volatile),
726 LLVM_READOBJ_ENUM_CLASS_ENT(ModifierOptions, Unaligned),
727};
728
729static const EnumEntry<uint8_t> CallingConventions[] = {
730 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearC),
731 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, FarC),
732 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearPascal),
733 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, FarPascal),
734 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearFast),
735 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, FarFast),
736 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearStdCall),
737 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, FarStdCall),
738 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearSysCall),
739 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, FarSysCall),
740 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, ThisCall),
741 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, MipsCall),
742 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, Generic),
743 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, AlphaCall),
744 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, PpcCall),
745 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, SHCall),
746 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, ArmCall),
747 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, AM33Call),
748 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, TriCall),
749 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, SH5Call),
750 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, M32RCall),
751 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, ClrCall),
752 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, Inline),
753 LLVM_READOBJ_ENUM_CLASS_ENT(CallingConvention, NearVector),
754};
755
756static const EnumEntry<uint8_t> FunctionOptionEnum[] = {
757 LLVM_READOBJ_ENUM_CLASS_ENT(FunctionOptions, CxxReturnUdt),
758 LLVM_READOBJ_ENUM_CLASS_ENT(FunctionOptions, Constructor),
759 LLVM_READOBJ_ENUM_CLASS_ENT(FunctionOptions, ConstructorWithVirtualBases),
760};
761
Rafael Espindola4453e42942014-06-13 03:07:50 +0000762template <typename T>
763static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
David Majnemer44f51e52014-09-10 12:51:52 +0000764 COFFSymbolRef Symbol,
765 uint8_t AuxSymbolIdx, const T *&Aux) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000766 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
David Majnemer44f51e52014-09-10 12:51:52 +0000767 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000768 Aux = reinterpret_cast<const T*>(AuxData.data());
769 return readobj_error::success;
770}
771
Eric Christopher9cad53c2013-04-03 18:31:38 +0000772void COFFDumper::cacheRelocations() {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000773 if (RelocCached)
774 return;
775 RelocCached = true;
776
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000777 for (const SectionRef &S : Obj->sections()) {
778 const coff_section *Section = Obj->getCOFFSection(S);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000779
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000780 for (const RelocationRef &Reloc : S.relocations())
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000781 RelocMap[Section].push_back(Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000782
783 // Sort relocations by address.
784 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
785 relocAddressLess);
786 }
787}
788
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000789void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
790 const data_directory *Data;
791 if (Obj->getDataDirectory(Index, Data))
792 return;
793 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
794 W.printHex(FieldName + "Size", Data->Size);
795}
796
Eric Christopher9cad53c2013-04-03 18:31:38 +0000797void COFFDumper::printFileHeaders() {
David Majnemer44f51e52014-09-10 12:51:52 +0000798 time_t TDS = Obj->getTimeDateStamp();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000799 char FormattedTime[20] = { };
800 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
801
802 {
803 DictScope D(W, "ImageFileHeader");
David Majnemer44f51e52014-09-10 12:51:52 +0000804 W.printEnum ("Machine", Obj->getMachine(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000805 makeArrayRef(ImageFileMachineType));
David Majnemer44f51e52014-09-10 12:51:52 +0000806 W.printNumber("SectionCount", Obj->getNumberOfSections());
807 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
808 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
809 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
810 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
811 W.printFlags ("Characteristics", Obj->getCharacteristics(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000812 makeArrayRef(ImageFileCharacteristics));
813 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000814
815 // Print PE header. This header does not exist if this is an object file and
816 // not an executable.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000817 const pe32_header *PEHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000818 error(Obj->getPE32Header(PEHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000819 if (PEHeader)
820 printPEHeader<pe32_header>(PEHeader);
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000821
Craig Toppere6cb63e2014-04-25 04:24:47 +0000822 const pe32plus_header *PEPlusHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000823 error(Obj->getPE32PlusHeader(PEPlusHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000824 if (PEPlusHeader)
825 printPEHeader<pe32plus_header>(PEPlusHeader);
David Majnemer50267222014-11-05 06:24:35 +0000826
827 if (const dos_header *DH = Obj->getDOSHeader())
828 printDOSHeader(DH);
829}
830
831void COFFDumper::printDOSHeader(const dos_header *DH) {
832 DictScope D(W, "DOSHeader");
833 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
834 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
835 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
836 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
837 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
838 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
839 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
840 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
841 W.printNumber("InitialSP", DH->InitialSP);
842 W.printNumber("Checksum", DH->Checksum);
843 W.printNumber("InitialIP", DH->InitialIP);
844 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
845 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
846 W.printNumber("OverlayNumber", DH->OverlayNumber);
847 W.printNumber("OEMid", DH->OEMid);
848 W.printNumber("OEMinfo", DH->OEMinfo);
849 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000850}
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000851
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000852template <class PEHeader>
853void COFFDumper::printPEHeader(const PEHeader *Hdr) {
854 DictScope D(W, "ImageOptionalHeader");
855 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
856 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
857 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
858 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
859 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
860 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
861 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
862 printBaseOfDataField(Hdr);
863 W.printHex ("ImageBase", Hdr->ImageBase);
864 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
865 W.printNumber("FileAlignment", Hdr->FileAlignment);
866 W.printNumber("MajorOperatingSystemVersion",
867 Hdr->MajorOperatingSystemVersion);
868 W.printNumber("MinorOperatingSystemVersion",
869 Hdr->MinorOperatingSystemVersion);
870 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
871 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
872 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
873 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
874 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
875 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
876 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
David Majnemer774aadf2014-11-18 02:45:28 +0000877 W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000878 makeArrayRef(PEDLLCharacteristics));
879 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
880 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
881 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
882 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
883 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000884
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000885 if (Hdr->NumberOfRvaAndSize > 0) {
886 DictScope D(W, "DataDirectory");
887 static const char * const directory[] = {
888 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
889 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
890 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
891 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
892 };
893
894 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
895 printDataDirectory(i, directory[i]);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000896 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000897 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000898}
899
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000900void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
901 W.printHex("BaseOfData", Hdr->BaseOfData);
902}
903
904void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
905
Reid Kleckner83ebad32015-12-16 18:28:12 +0000906void COFFDumper::printCodeViewDebugInfo() {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000907 // Print types first to build CVUDTNames, then print symbols.
Reid Kleckner83ebad32015-12-16 18:28:12 +0000908 for (const SectionRef &S : Obj->sections()) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000909 StringRef SectionName;
910 error(S.getName(SectionName));
911 if (SectionName == ".debug$T")
912 printCodeViewTypeSection(SectionName, S);
913 }
914 for (const SectionRef &S : Obj->sections()) {
915 StringRef SectionName;
916 error(S.getName(SectionName));
917 if (SectionName == ".debug$S")
918 printCodeViewSymbolSection(SectionName, S);
Reid Kleckner83ebad32015-12-16 18:28:12 +0000919 }
920}
921
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000922/// Consumes sizeof(T) bytes from the given byte sequence. Returns an error if
923/// there are not enough bytes remaining. Reinterprets the consumed bytes as a
924/// T object and points 'Res' at them.
925template <typename T>
926static std::error_code consumeObject(StringRef &Data, const T *&Res) {
927 if (Data.size() < sizeof(*Res))
928 return object_error::parse_failed;
929 Res = reinterpret_cast<const T *>(Data.data());
930 Data = Data.drop_front(sizeof(*Res));
931 return std::error_code();
932}
933
934static std::error_code consumeUInt32(StringRef &Data, uint32_t &Res) {
935 const ulittle32_t *IntPtr;
936 if (auto EC = consumeObject(Data, IntPtr))
937 return EC;
938 Res = *IntPtr;
939 return std::error_code();
940}
941
942void COFFDumper::printCodeViewSymbolSection(StringRef SectionName,
943 const SectionRef &Section) {
944 StringRef SectionContents;
945 error(Section.getContents(SectionContents));
946 StringRef Data = SectionContents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000947
948 SmallVector<StringRef, 10> FunctionNames;
949 StringMap<StringRef> FunctionLineTables;
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000950 std::map<StringRef, const FrameData *> FunctionFrameData;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000951
Zachary Turner99f02152015-02-18 19:32:05 +0000952 ListScope D(W, "CodeViewDebugInfo");
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000953 // Print the section to allow correlation with printSections.
954 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000955
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000956 uint32_t Magic;
957 error(consumeUInt32(Data, Magic));
958 W.printHex("Magic", Magic);
959 if (Magic != COFF::DEBUG_SECTION_MAGIC)
960 return error(object_error::parse_failed);
961
962 while (!Data.empty()) {
963 // The section consists of a number of subsection in the following format:
964 // |SubSectionType|SubSectionSize|Contents...|
965 uint32_t SubType, SubSectionSize;
966 error(consumeUInt32(Data, SubType));
967 error(consumeUInt32(Data, SubSectionSize));
968
969 ListScope S(W, "Subsection");
970 W.printEnum("SubSectionType", SubType, makeArrayRef(SubSectionTypes));
971 W.printHex("SubSectionSize", SubSectionSize);
972
973 // Get the contents of the subsection.
974 if (SubSectionSize > Data.size())
975 return error(object_error::parse_failed);
976 StringRef Contents = Data.substr(0, SubSectionSize);
977
978 // Add SubSectionSize to the current offset and align that offset to find
979 // the next subsection.
980 size_t SectionOffset = Data.data() - SectionContents.data();
981 size_t NextOffset = SectionOffset + SubSectionSize;
982 NextOffset = RoundUpToAlignment(NextOffset, 4);
983 Data = SectionContents.drop_front(NextOffset);
984
985 // Optionally print the subsection bytes in case our parsing gets confused
986 // later.
987 if (opts::CodeViewSubsectionBytes)
988 W.printBinaryBlock("SubSectionContents", Contents);
989
990 switch (ModuleSubstreamKind(SubType)) {
991 case ModuleSubstreamKind::Symbols:
Reid Kleckner2893fd12016-01-14 17:51:54 +0000992 printCodeViewSymbolsSubsection(Contents, Section, SectionContents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000993 break;
994 case ModuleSubstreamKind::Lines: {
995 // Holds a PC to file:line table. Some data to parse this subsection is
996 // stored in the other subsections, so just check sanity and store the
997 // pointers for deferred processing.
998
999 if (SubSectionSize < 12) {
1000 // There should be at least three words to store two function
1001 // relocations and size of the code.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001002 error(object_error::parse_failed);
1003 return;
1004 }
1005
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001006 StringRef LinkageName;
1007 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset,
1008 LinkageName));
1009 W.printString("LinkageName", LinkageName);
1010 if (FunctionLineTables.count(LinkageName) != 0) {
1011 // Saw debug info for this function already?
1012 error(object_error::parse_failed);
1013 return;
Zachary Turner99f02152015-02-18 19:32:05 +00001014 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001015
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001016 FunctionLineTables[LinkageName] = Contents;
1017 FunctionNames.push_back(LinkageName);
1018 break;
1019 }
1020 case ModuleSubstreamKind::StringTable:
1021 if (SubSectionSize == 0 || CVStringTable.data() != nullptr ||
1022 Contents.back() != '\0') {
1023 // Empty or duplicate or non-null-terminated subsection.
1024 error(object_error::parse_failed);
1025 return;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001026 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001027 CVStringTable = Contents;
1028 break;
1029 case ModuleSubstreamKind::FileChecksums:
1030 // Holds the translation table from file indices
1031 // to offsets in the string table.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001032
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001033 if (SubSectionSize == 0 ||
1034 CVFileIndexToStringOffsetTable.data() != nullptr) {
1035 // Empty or duplicate subsection.
1036 error(object_error::parse_failed);
1037 return;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001038 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001039 CVFileIndexToStringOffsetTable = Contents;
1040 break;
1041 case ModuleSubstreamKind::FrameData: {
1042 const size_t RelocationSize = 4;
1043 if (SubSectionSize != sizeof(FrameData) + RelocationSize) {
1044 // There should be exactly one relocation followed by the FrameData
1045 // contents.
1046 error(object_error::parse_failed);
1047 return;
1048 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001049
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001050 const auto *FD = reinterpret_cast<const FrameData *>(
1051 Contents.drop_front(RelocationSize).data());
1052
1053 StringRef LinkageName;
1054 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset,
1055 LinkageName));
1056 if (!FunctionFrameData.emplace(LinkageName, FD).second) {
1057 error(object_error::parse_failed);
1058 return;
1059 }
1060 break;
1061 }
1062
1063 // Do nothing for unrecognized subsections.
1064 default:
1065 break;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001066 }
1067 }
1068
1069 // Dump the line tables now that we've read all the subsections and know all
1070 // the required information.
1071 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
1072 StringRef Name = FunctionNames[I];
1073 ListScope S(W, "FunctionLineTable");
Reid Kleckner7c0c0c02015-12-15 01:23:55 +00001074 W.printString("LinkageName", Name);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001075
1076 DataExtractor DE(FunctionLineTables[Name], true, 4);
David Majnemer3f49e662015-07-09 00:19:51 +00001077 uint32_t Offset = 6; // Skip relocations.
1078 uint16_t Flags = DE.getU16(&Offset);
1079 W.printHex("Flags", Flags);
1080 bool HasColumnInformation =
1081 Flags & COFF::DEBUG_LINE_TABLES_HAVE_COLUMN_RECORDS;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001082 uint32_t FunctionSize = DE.getU32(&Offset);
1083 W.printHex("CodeSize", FunctionSize);
1084 while (DE.isValidOffset(Offset)) {
1085 // For each range of lines with the same filename, we have a segment
1086 // in the line table. The filename string is accessed using double
1087 // indirection to the string table subsection using the index subsection.
1088 uint32_t OffsetInIndex = DE.getU32(&Offset),
David Majnemer04948362016-01-13 01:05:16 +00001089 NumLines = DE.getU32(&Offset),
David Majnemer0373d532015-07-09 18:14:31 +00001090 FullSegmentSize = DE.getU32(&Offset);
1091
David Majnemer04948362016-01-13 01:05:16 +00001092 uint32_t ColumnOffset = Offset + 8 * NumLines;
1093 DataExtractor ColumnDE(DE.getData(), true, 4);
1094
David Majnemer0373d532015-07-09 18:14:31 +00001095 if (FullSegmentSize !=
David Majnemer04948362016-01-13 01:05:16 +00001096 12 + 8 * NumLines + (HasColumnInformation ? 4 * NumLines : 0)) {
David Majnemer0373d532015-07-09 18:14:31 +00001097 error(object_error::parse_failed);
1098 return;
1099 }
Justin Bognera1413db2015-07-09 04:27:36 +00001100
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001101 uint32_t FilenameOffset;
1102 {
Timur Iskhodzhanov11603332014-10-06 16:59:44 +00001103 DataExtractor SDE(CVFileIndexToStringOffsetTable, true, 4);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001104 uint32_t OffsetInSDE = OffsetInIndex;
1105 if (!SDE.isValidOffset(OffsetInSDE)) {
1106 error(object_error::parse_failed);
1107 return;
1108 }
1109 FilenameOffset = SDE.getU32(&OffsetInSDE);
1110 }
1111
Timur Iskhodzhanov11603332014-10-06 16:59:44 +00001112 if (FilenameOffset == 0 || FilenameOffset + 1 >= CVStringTable.size() ||
1113 CVStringTable.data()[FilenameOffset - 1] != '\0') {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001114 // Each string in an F3 subsection should be preceded by a null
1115 // character.
1116 error(object_error::parse_failed);
1117 return;
1118 }
1119
Timur Iskhodzhanov11603332014-10-06 16:59:44 +00001120 StringRef Filename(CVStringTable.data() + FilenameOffset);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001121 ListScope S(W, "FilenameSegment");
1122 W.printString("Filename", Filename);
David Majnemer04948362016-01-13 01:05:16 +00001123 for (unsigned LineIdx = 0;
1124 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001125 // Then go the (PC, LineNumber) pairs. The line number is stored in the
1126 // least significant 31 bits of the respective word in the table.
David Majnemer04948362016-01-13 01:05:16 +00001127 uint32_t PC = DE.getU32(&Offset), LineData = DE.getU32(&Offset);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001128 if (PC >= FunctionSize) {
1129 error(object_error::parse_failed);
1130 return;
1131 }
1132 char Buffer[32];
1133 format("+0x%X", PC).snprint(Buffer, 32);
David Majnemer04948362016-01-13 01:05:16 +00001134 ListScope PCScope(W, Buffer);
1135 uint32_t LineNumberStart = LineData & COFF::CVL_MaxLineNumber;
1136 uint32_t LineNumberEndDelta =
1137 (LineData >> COFF::CVL_LineNumberStartBits) &
1138 COFF::CVL_LineNumberEndDeltaMask;
1139 bool IsStatement = LineData & COFF::CVL_IsStatement;
1140 W.printNumber("LineNumberStart", LineNumberStart);
1141 W.printNumber("LineNumberEndDelta", LineNumberEndDelta);
1142 W.printBoolean("IsStatement", IsStatement);
1143 if (HasColumnInformation &&
1144 ColumnDE.isValidOffsetForDataOfSize(ColumnOffset, 4)) {
1145 uint16_t ColStart = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +00001146 W.printNumber("ColStart", ColStart);
David Majnemer04948362016-01-13 01:05:16 +00001147 uint16_t ColEnd = ColumnDE.getU16(&ColumnOffset);
David Majnemer3f49e662015-07-09 00:19:51 +00001148 W.printNumber("ColEnd", ColEnd);
1149 }
1150 }
David Majnemer04948362016-01-13 01:05:16 +00001151 // Skip over the column data.
1152 if (HasColumnInformation) {
1153 for (unsigned LineIdx = 0;
1154 LineIdx != NumLines && DE.isValidOffset(Offset); ++LineIdx) {
1155 DE.getU32(&Offset);
1156 }
1157 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001158 }
1159 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001160
1161 for (auto FrameDataPair : FunctionFrameData) {
1162 StringRef LinkageName = FrameDataPair.first;
1163 const FrameData *FD = FrameDataPair.second;
1164 ListScope S(W, "FunctionFrameData");
1165 W.printString("LinkageName", LinkageName);
1166 W.printHex("RvaStart", FD->RvaStart);
1167 W.printHex("CodeSize", FD->CodeSize);
1168 W.printHex("LocalSize", FD->LocalSize);
1169 W.printHex("ParamsSize", FD->ParamsSize);
1170 W.printHex("MaxStackSize", FD->MaxStackSize);
1171 W.printString("FrameFunc", StringRef(CVStringTable.data() + FD->FrameFunc));
1172 W.printHex("PrologSize", FD->PrologSize);
1173 W.printHex("SavedRegsSize", FD->SavedRegsSize);
1174 W.printFlags("Flags", FD->Flags, makeArrayRef(FrameDataFlags));
1175 }
1176}
1177
1178static std::error_code decodeNumerictLeaf(StringRef &Data, APSInt &Num) {
1179 // Used to avoid overload ambiguity on APInt construtor.
1180 bool FalseVal = false;
1181 if (Data.size() < 2)
1182 return object_error::parse_failed;
1183 uint16_t Short = *reinterpret_cast<const ulittle16_t *>(Data.data());
1184 Data = Data.drop_front(2);
1185 if (Short < LF_NUMERIC) {
1186 Num = APSInt(APInt(/*numBits=*/16, Short, /*isSigned=*/false),
1187 /*isUnsigned=*/true);
1188 return std::error_code();
1189 }
1190 switch (Short) {
1191 case LF_CHAR:
1192 Num = APSInt(APInt(/*numBits=*/8,
1193 *reinterpret_cast<const int8_t *>(Data.data()),
1194 /*isSigned=*/true),
1195 /*isUnsigned=*/false);
1196 Data = Data.drop_front(1);
1197 return std::error_code();
1198 case LF_SHORT:
1199 Num = APSInt(APInt(/*numBits=*/16,
1200 *reinterpret_cast<const little16_t *>(Data.data()),
1201 /*isSigned=*/true),
1202 /*isUnsigned=*/false);
1203 Data = Data.drop_front(2);
1204 return std::error_code();
1205 case LF_USHORT:
1206 Num = APSInt(APInt(/*numBits=*/16,
1207 *reinterpret_cast<const ulittle16_t *>(Data.data()),
1208 /*isSigned=*/false),
1209 /*isUnsigned=*/true);
1210 Data = Data.drop_front(2);
1211 return std::error_code();
1212 case LF_LONG:
1213 Num = APSInt(APInt(/*numBits=*/32,
1214 *reinterpret_cast<const little32_t *>(Data.data()),
1215 /*isSigned=*/true),
1216 /*isUnsigned=*/false);
1217 Data = Data.drop_front(4);
1218 return std::error_code();
1219 case LF_ULONG:
1220 Num = APSInt(APInt(/*numBits=*/32,
1221 *reinterpret_cast<const ulittle32_t *>(Data.data()),
1222 /*isSigned=*/FalseVal),
1223 /*isUnsigned=*/true);
1224 Data = Data.drop_front(4);
1225 return std::error_code();
1226 case LF_QUADWORD:
1227 Num = APSInt(APInt(/*numBits=*/64,
1228 *reinterpret_cast<const little64_t *>(Data.data()),
1229 /*isSigned=*/true),
1230 /*isUnsigned=*/false);
1231 Data = Data.drop_front(8);
1232 return std::error_code();
1233 case LF_UQUADWORD:
1234 Num = APSInt(APInt(/*numBits=*/64,
1235 *reinterpret_cast<const ulittle64_t *>(Data.data()),
1236 /*isSigned=*/false),
1237 /*isUnsigned=*/true);
1238 Data = Data.drop_front(8);
1239 return std::error_code();
1240 }
1241 return object_error::parse_failed;
1242}
1243
1244/// Decode an unsigned integer numeric leaf value.
1245std::error_code decodeUIntLeaf(StringRef &Data, uint64_t &Num) {
1246 APSInt N;
1247 if (std::error_code err = decodeNumerictLeaf(Data, N))
1248 return err;
1249 if (N.isSigned() || !N.isIntN(64))
1250 return object_error::parse_failed;
1251 Num = N.getLimitedValue();
1252 return std::error_code();
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001253}
1254
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001255void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
1256 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +00001257 StringRef SectionContents) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001258 if (Subsection.size() < sizeof(SymRecord))
1259 return error(object_error::parse_failed);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001260
Reid Kleckner2893fd12016-01-14 17:51:54 +00001261 const coff_section *Sec = Obj->getCOFFSection(Section);
1262
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001263 // This holds the remaining data to parse.
1264 StringRef Data = Subsection;
1265
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001266 bool InFunctionScope = false;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001267 while (!Data.empty()) {
1268 const SymRecord *Rec;
1269 error(consumeObject(Data, Rec));
1270
1271 StringRef SymData = Data.substr(0, Rec->RecordLength - 2);
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00001272 StringRef OrigSymData = SymData;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001273
1274 Data = Data.drop_front(Rec->RecordLength - 2);
1275
Reid Kleckner6b3faef2016-01-13 23:44:57 +00001276 SymbolRecordKind Kind = Rec->getKind();
1277 switch (Kind) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001278 case S_LPROC32:
1279 case S_GPROC32:
1280 case S_GPROC32_ID:
1281 case S_LPROC32_ID:
1282 case S_LPROC32_DPC:
1283 case S_LPROC32_DPC_ID: {
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001284 DictScope S(W, "ProcStart");
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001285 const ProcSym *Proc;
1286 error(consumeObject(SymData, Proc));
1287 if (InFunctionScope)
1288 return error(object_error::parse_failed);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001289 InFunctionScope = true;
1290
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001291 StringRef LinkageName;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001292 StringRef DisplayName = SymData.split('\0').first;
1293 W.printHex("PtrParent", Proc->PtrParent);
1294 W.printHex("PtrEnd", Proc->PtrEnd);
1295 W.printHex("PtrNext", Proc->PtrNext);
1296 W.printHex("CodeSize", Proc->CodeSize);
1297 W.printHex("DbgStart", Proc->DbgStart);
1298 W.printHex("DbgEnd", Proc->DbgEnd);
1299 printTypeIndex("FunctionType", Proc->FunctionType);
Reid Kleckner2893fd12016-01-14 17:51:54 +00001300 printRelocatedField("CodeOffset", Sec, SectionContents, &Proc->CodeOffset,
1301 &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001302 W.printHex("Segment", Proc->Segment);
1303 W.printFlags("Flags", Proc->Flags, makeArrayRef(ProcSymFlags));
1304 W.printString("DisplayName", DisplayName);
1305 W.printString("LinkageName", LinkageName);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001306 break;
1307 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001308
1309 case S_PROC_ID_END: {
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001310 W.startLine() << "ProcEnd\n";
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001311 InFunctionScope = false;
1312 break;
1313 }
Zachary Turner99f02152015-02-18 19:32:05 +00001314
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001315 case S_BLOCK32: {
1316 DictScope S(W, "BlockStart");
1317 const BlockSym *Block;
1318 error(consumeObject(SymData, Block));
1319
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001320 StringRef BlockName = SymData.split('\0').first;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001321 StringRef LinkageName;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001322 W.printHex("PtrParent", Block->PtrParent);
1323 W.printHex("PtrEnd", Block->PtrEnd);
1324 W.printHex("CodeSize", Block->CodeSize);
Reid Kleckner2893fd12016-01-14 17:51:54 +00001325 printRelocatedField("CodeOffset", Sec, SectionContents,
1326 &Block->CodeOffset, &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001327 W.printHex("Segment", Block->Segment);
1328 W.printString("BlockName", BlockName);
1329 W.printString("LinkageName", LinkageName);
1330 break;
1331 }
1332
1333 case S_END: {
1334 W.startLine() << "BlockEnd\n";
1335 InFunctionScope = false;
1336 break;
1337 }
1338
1339 case S_LABEL32: {
1340 DictScope S(W, "Label");
1341 const LabelSym *Label;
1342 error(consumeObject(SymData, Label));
1343
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001344 StringRef DisplayName = SymData.split('\0').first;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001345 StringRef LinkageName;
1346 printRelocatedField("CodeOffset", Sec, SectionContents,
1347 &Label->CodeOffset, &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001348 W.printHex("Segment", Label->Segment);
1349 W.printHex("Flags", Label->Flags);
1350 W.printFlags("Flags", Label->Flags, makeArrayRef(ProcSymFlags));
1351 W.printString("DisplayName", DisplayName);
1352 W.printString("LinkageName", LinkageName);
1353 break;
1354 }
1355
1356 case S_INLINESITE: {
1357 DictScope S(W, "InlineSite");
1358 const InlineSiteSym *InlineSite;
1359 error(consumeObject(SymData, InlineSite));
1360 W.printHex("PtrParent", InlineSite->PtrParent);
1361 W.printHex("PtrEnd", InlineSite->PtrEnd);
1362 printTypeIndex("Inlinee", InlineSite->Inlinee);
David Majnemere21e9092016-01-14 06:12:30 +00001363
1364 auto GetCompressedAnnotation = [&]() -> uint32_t {
1365 if (SymData.empty())
1366 return -1;
1367
1368 uint8_t FirstByte = SymData.front();
1369 SymData = SymData.drop_front();
1370
1371 if ((FirstByte & 0x80) == 0x00)
1372 return FirstByte;
1373
1374 if (SymData.empty())
1375 return -1;
1376
1377 uint8_t SecondByte = SymData.front();
1378 SymData = SymData.drop_front();
1379
1380 if ((FirstByte & 0xC0) == 0x80)
1381 return ((FirstByte & 0x3F) << 8) | SecondByte;
1382
1383 if (SymData.empty())
1384 return -1;
1385
1386 uint8_t ThirdByte = SymData.front();
1387 SymData = SymData.drop_front();
1388
1389 if (SymData.empty())
1390 return -1;
1391
1392 uint8_t FourthByte = SymData.front();
1393 SymData = SymData.drop_front();
1394
1395 if ((FirstByte & 0xE0) == 0xC0)
1396 return ((FirstByte & 0x1F) << 24) | (SecondByte << 16) |
1397 (ThirdByte << 8) | FourthByte;
1398
1399 return -1;
1400 };
1401 auto DecodeSignedOperand = [](uint32_t Operand) -> int32_t {
1402 if (Operand & 1)
1403 return -(Operand >> 1);
1404 return Operand >> 1;
1405 };
1406
1407 ListScope BinaryAnnotations(W, "BinaryAnnotations");
1408 while (!SymData.empty()) {
1409 uint32_t OpCode = GetCompressedAnnotation();
1410 switch (OpCode) {
1411 default:
1412 case Invalid:
1413 return error(object_error::parse_failed);
1414 case CodeOffset:
1415 W.printNumber("CodeOffset", GetCompressedAnnotation());
1416 break;
1417 case ChangeCodeOffsetBase:
1418 W.printNumber("ChangeCodeOffsetBase", GetCompressedAnnotation());
1419 break;
1420 case ChangeCodeOffset:
1421 W.printNumber("ChangeCodeOffset", GetCompressedAnnotation());
1422 break;
1423 case ChangeCodeLength:
1424 W.printNumber("ChangeCodeLength", GetCompressedAnnotation());
1425 break;
1426 case ChangeFile:
1427 W.printNumber("ChangeFile", GetCompressedAnnotation());
1428 break;
1429 case ChangeLineOffset:
1430 W.printNumber("ChangeLineOffset",
1431 DecodeSignedOperand(GetCompressedAnnotation()));
1432 break;
1433 case ChangeLineEndDelta:
1434 W.printNumber("ChangeLineEndDelta", GetCompressedAnnotation());
1435 break;
1436 case ChangeRangeKind:
1437 W.printNumber("ChangeRangeKind", GetCompressedAnnotation());
1438 break;
1439 case ChangeColumnStart:
1440 W.printNumber("ChangeColumnStart", GetCompressedAnnotation());
1441 break;
1442 case ChangeColumnEndDelta:
1443 W.printNumber("ChangeColumnEndDelta",
1444 DecodeSignedOperand(GetCompressedAnnotation()));
1445 break;
1446 case ChangeCodeOffsetAndLineOffset: {
1447 uint32_t Annotation = GetCompressedAnnotation();
1448 uint32_t Operands[] = {Annotation >> 4, Annotation & 0xf};
1449 W.printList("ChangeCodeOffsetAndLineOffset", Operands);
1450 break;
1451 }
1452 case ChangeCodeLengthAndCodeOffset: {
1453 uint32_t Operands[] = {GetCompressedAnnotation(),
1454 GetCompressedAnnotation()};
1455 W.printList("ChangeCodeLengthAndCodeOffset", Operands);
1456 break;
1457 }
1458 case ChangeColumnEnd:
1459 W.printNumber("ChangeColumnEnd", GetCompressedAnnotation());
1460 break;
1461 }
1462 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001463 break;
1464 }
1465
1466 case S_INLINESITE_END: {
1467 DictScope S(W, "InlineSiteEnd");
1468 break;
1469 }
1470
1471 case S_LOCAL: {
1472 DictScope S(W, "Local");
1473 const LocalSym *Local;
1474 error(consumeObject(SymData, Local));
1475 printTypeIndex("Type", Local->Type);
1476 W.printFlags("Flags", uint16_t(Local->Flags), makeArrayRef(LocalFlags));
1477 StringRef VarName = SymData.split('\0').first;
1478 W.printString("VarName", VarName);
1479 break;
1480 }
1481
1482 case S_CALLSITEINFO: {
1483 DictScope S(W, "CallSiteInfo");
1484 const CallSiteInfoSym *CallSiteInfo;
1485 error(consumeObject(SymData, CallSiteInfo));
1486
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001487 StringRef LinkageName;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001488 printRelocatedField("CodeOffset", Sec, SectionContents,
1489 &CallSiteInfo->CodeOffset, &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001490 W.printHex("Segment", CallSiteInfo->Segment);
1491 W.printHex("Reserved", CallSiteInfo->Reserved);
1492 printTypeIndex("Type", CallSiteInfo->Type);
1493 W.printString("LinkageName", LinkageName);
1494 break;
1495 }
1496
1497 case S_HEAPALLOCSITE: {
1498 DictScope S(W, "HeapAllocationSite");
1499 const HeapAllocationSiteSym *HeapAllocationSite;
1500 error(consumeObject(SymData, HeapAllocationSite));
1501
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001502 StringRef LinkageName;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001503 printRelocatedField("CodeOffset", Sec, SectionContents,
1504 &HeapAllocationSite->CodeOffset, &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001505 W.printHex("Segment", HeapAllocationSite->Segment);
1506 W.printHex("CallInstructionSize",
1507 HeapAllocationSite->CallInstructionSize);
1508 printTypeIndex("Type", HeapAllocationSite->Type);
1509 W.printString("LinkageName", LinkageName);
1510 break;
1511 }
1512
1513 case S_FRAMECOOKIE: {
1514 DictScope S(W, "FrameCookie");
1515 const FrameCookieSym *FrameCookie;
1516 error(consumeObject(SymData, FrameCookie));
Reid Kleckner2893fd12016-01-14 17:51:54 +00001517
1518 StringRef LinkageName;
1519 printRelocatedField("CodeOffset", Sec, SectionContents,
1520 &FrameCookie->CodeOffset, &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001521 W.printHex("Register", FrameCookie->Register);
1522 W.printEnum("CookieKind", uint16_t(FrameCookie->CookieKind),
1523 makeArrayRef(FrameCookieKinds));
1524 break;
1525 }
1526
1527 case S_LDATA32:
1528 case S_GDATA32:
1529 case S_LMANDATA:
1530 case S_GMANDATA: {
1531 DictScope S(W, "DataSym");
1532 const DataSym *Data;
1533 error(consumeObject(SymData, Data));
1534
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001535 StringRef DisplayName = SymData.split('\0').first;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001536 StringRef LinkageName;
1537 printRelocatedField("DataOffset", Sec, SectionContents, &Data->DataOffset,
1538 &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001539 printTypeIndex("Type", Data->Type);
1540 W.printString("DisplayName", DisplayName);
1541 W.printString("LinkageName", LinkageName);
1542 break;
1543 }
Reid Kleckner2893fd12016-01-14 17:51:54 +00001544
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001545 case S_LTHREAD32:
1546 case S_GTHREAD32: {
1547 DictScope S(W, "ThreadLocalDataSym");
Reid Kleckner2893fd12016-01-14 17:51:54 +00001548 const ThreadLocalDataSym *Data;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001549 error(consumeObject(SymData, Data));
1550
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001551 StringRef DisplayName = SymData.split('\0').first;
Reid Kleckner2893fd12016-01-14 17:51:54 +00001552 StringRef LinkageName;
1553 printRelocatedField("DataOffset", Sec, SectionContents, &Data->DataOffset,
1554 &LinkageName);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001555 printTypeIndex("Type", Data->Type);
1556 W.printString("DisplayName", DisplayName);
1557 W.printString("LinkageName", LinkageName);
1558 break;
1559 }
1560
1561 case S_OBJNAME: {
1562 DictScope S(W, "ObjectName");
1563 const ObjNameSym *ObjName;
1564 error(consumeObject(SymData, ObjName));
1565 W.printHex("Signature", ObjName->Signature);
1566 StringRef ObjectName = SymData.split('\0').first;
1567 W.printString("ObjectName", ObjectName);
1568 break;
1569 }
1570
1571 case S_COMPILE3: {
1572 DictScope S(W, "CompilerFlags");
1573 const CompileSym3 *CompFlags;
1574 error(consumeObject(SymData, CompFlags));
1575 W.printEnum("Language", CompFlags->getLanguage(),
1576 makeArrayRef(SourceLanguages));
1577 W.printFlags("Flags", CompFlags->flags & ~0xff,
1578 makeArrayRef(CompileSym3Flags));
1579 W.printEnum("Machine", unsigned(CompFlags->Machine),
1580 makeArrayRef(CPUTypeNames));
1581 std::string FrontendVersion;
1582 {
1583 raw_string_ostream Out(FrontendVersion);
1584 Out << CompFlags->VersionFrontendMajor << '.'
1585 << CompFlags->VersionFrontendMinor << '.'
1586 << CompFlags->VersionFrontendBuild << '.'
1587 << CompFlags->VersionFrontendQFE;
Zachary Turner99f02152015-02-18 19:32:05 +00001588 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001589 std::string BackendVersion;
1590 {
1591 raw_string_ostream Out(BackendVersion);
1592 Out << CompFlags->VersionBackendMajor << '.'
1593 << CompFlags->VersionBackendMinor << '.'
1594 << CompFlags->VersionBackendBuild << '.'
1595 << CompFlags->VersionBackendQFE;
1596 }
1597 W.printString("FrontendVersion", FrontendVersion);
1598 W.printString("BackendVersion", BackendVersion);
1599 StringRef VersionName = SymData.split('\0').first;
1600 W.printString("VersionName", VersionName);
1601 break;
1602 }
Zachary Turner99f02152015-02-18 19:32:05 +00001603
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001604 case S_FRAMEPROC: {
1605 DictScope S(W, "FrameProc");
1606 const FrameProcSym *FrameProc;
1607 error(consumeObject(SymData, FrameProc));
1608 W.printHex("TotalFrameBytes", FrameProc->TotalFrameBytes);
1609 W.printHex("PaddingFrameBytes", FrameProc->PaddingFrameBytes);
1610 W.printHex("OffsetToPadding", FrameProc->OffsetToPadding);
1611 W.printHex("BytesOfCalleeSavedRegisters", FrameProc->BytesOfCalleeSavedRegisters);
1612 W.printHex("OffsetOfExceptionHandler", FrameProc->OffsetOfExceptionHandler);
1613 W.printHex("SectionIdOfExceptionHandler", FrameProc->SectionIdOfExceptionHandler);
1614 W.printFlags("Flags", FrameProc->Flags, makeArrayRef(FrameProcSymFlags));
1615 break;
1616 }
1617
1618 case S_UDT:
1619 case S_COBOLUDT: {
1620 DictScope S(W, "UDT");
1621 const UDTSym *UDT;
1622 error(consumeObject(SymData, UDT));
1623 printTypeIndex("Type", UDT->Type);
1624 StringRef UDTName = SymData.split('\0').first;
1625 W.printString("UDTName", UDTName);
1626 break;
1627 }
1628
1629 case S_BPREL32: {
1630 DictScope S(W, "BPRelativeSym");
1631 const BPRelativeSym *BPRel;
1632 error(consumeObject(SymData, BPRel));
1633 W.printHex("Offset", BPRel->Offset);
1634 printTypeIndex("Type", BPRel->Type);
1635 StringRef VarName = SymData.split('\0').first;
1636 W.printString("VarName", VarName);
1637 break;
1638 }
1639
1640 case S_REGREL32: {
1641 DictScope S(W, "RegRelativeSym");
1642 const RegRelativeSym *RegRel;
1643 error(consumeObject(SymData, RegRel));
1644 W.printHex("Offset", RegRel->Offset);
1645 printTypeIndex("Type", RegRel->Type);
1646 W.printHex("Register", RegRel->Register);
1647 StringRef VarName = SymData.split('\0').first;
1648 W.printString("VarName", VarName);
1649 break;
1650 }
1651
1652 case S_BUILDINFO: {
1653 DictScope S(W, "BuildInfo");
1654 const BuildInfoSym *BuildInfo;
1655 error(consumeObject(SymData, BuildInfo));
1656 W.printNumber("BuildId", BuildInfo->BuildId);
1657 break;
1658 }
1659
1660 case S_CONSTANT:
1661 case S_MANCONSTANT: {
1662 DictScope S(W, "Constant");
1663 const ConstantSym *Constant;
1664 error(consumeObject(SymData, Constant));
1665 printTypeIndex("Type", Constant->Type);
1666 APSInt Value;
1667 error(decodeNumerictLeaf(SymData, Value));
1668 W.printNumber("Value", Value);
1669 StringRef Name = SymData.split('\0').first;
1670 W.printString("Name", Name);
1671 break;
1672 }
1673
1674 default: {
1675 DictScope S(W, "UnknownSym");
Reid Kleckner6b3faef2016-01-13 23:44:57 +00001676 W.printHex("Kind", unsigned(Kind));
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001677 W.printHex("Size", Rec->RecordLength);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001678 break;
1679 }
Zachary Turner99f02152015-02-18 19:32:05 +00001680 }
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00001681
1682 if (opts::CodeViewSubsectionBytes)
1683 printBinaryBlockWithRelocs("SymData", Section, SectionContents,
1684 OrigSymData);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001685 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001686}
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001687
Reid Kleckner6b3faef2016-01-13 23:44:57 +00001688StringRef getRemainingTypeBytes(const TypeRecordPrefix *Rec, const char *Start) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001689 ptrdiff_t StartOffset = Start - reinterpret_cast<const char *>(Rec);
1690 size_t RecSize = Rec->Len + 2;
1691 assert(StartOffset >= 0 && "negative start-offset!");
1692 assert(static_cast<size_t>(StartOffset) <= RecSize &&
1693 "Start beyond the end of Rec");
1694 return StringRef(Start, RecSize - StartOffset);
1695}
1696
Reid Kleckner6b3faef2016-01-13 23:44:57 +00001697StringRef getRemainingBytesAsString(const TypeRecordPrefix *Rec, const char *Start) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001698 StringRef Remaining = getRemainingTypeBytes(Rec, Start);
1699 StringRef Leading, Trailing;
1700 std::tie(Leading, Trailing) = Remaining.split('\0');
1701 return Leading;
1702}
1703
1704StringRef COFFDumper::getTypeName(TypeIndex TI) {
1705 if (TI.isNoType())
1706 return "<no type>";
1707
1708 if (TI.isSimple()) {
1709 // This is a simple type.
1710 for (const auto &SimpleTypeName : SimpleTypeNames) {
1711 if (SimpleTypeName.Value == TI.getSimpleKind()) {
1712 if (TI.getSimpleMode() == SimpleTypeMode::Direct)
1713 return SimpleTypeName.Name.drop_back(1);
1714 // Otherwise, this is a pointer type. We gloss over the distinction
1715 // between near, far, 64, 32, etc, and just give a pointer type.
1716 return SimpleTypeName.Name;
1717 }
1718 }
1719 return "<unknown simple type>";
1720 }
1721
1722 // User-defined type.
1723 StringRef UDTName;
1724 unsigned UDTIndex = TI.getIndex() - 0x1000;
1725 if (UDTIndex < CVUDTNames.size())
1726 return CVUDTNames[UDTIndex];
1727
1728 return "<unknown UDT>";
1729}
1730
1731void COFFDumper::printTypeIndex(StringRef FieldName, TypeIndex TI) {
1732 StringRef TypeName;
1733 if (!TI.isNoType())
1734 TypeName = getTypeName(TI);
1735 if (!TypeName.empty())
1736 W.printHex(FieldName, TypeName, TI.getIndex());
1737 else
1738 W.printHex(FieldName, TI.getIndex());
1739}
1740
Reid Kleckner6b3faef2016-01-13 23:44:57 +00001741static StringRef getLeafTypeName(TypeLeafKind LT) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001742 switch (LT) {
1743 case LF_STRING_ID: return "StringId";
1744 case LF_FIELDLIST: return "FieldList";
1745 case LF_ARGLIST:
1746 case LF_SUBSTR_LIST: return "ArgList";
1747 case LF_CLASS:
1748 case LF_STRUCTURE:
1749 case LF_INTERFACE: return "ClassType";
1750 case LF_UNION: return "UnionType";
1751 case LF_ENUM: return "EnumType";
1752 case LF_ARRAY: return "ArrayType";
1753 case LF_VFTABLE: return "VFTableType";
1754 case LF_MFUNC_ID: return "MemberFuncId";
1755 case LF_PROCEDURE: return "ProcedureType";
1756 case LF_MFUNCTION: return "MemberFunctionType";
1757 case LF_METHODLIST: return "MethodListEntry";
1758 case LF_FUNC_ID: return "FuncId";
1759 case LF_TYPESERVER2: return "TypeServer2";
1760 case LF_POINTER: return "PointerType";
1761 case LF_MODIFIER: return "TypeModifier";
1762 case LF_VTSHAPE: return "VTableShape";
1763 case LF_UDT_SRC_LINE: return "UDTSrcLine";
1764 case LF_BUILDINFO: return "BuildInfo";
1765 default: break;
1766 }
1767 return "UnknownLeaf";
1768}
1769
1770void COFFDumper::printCodeViewTypeSection(StringRef SectionName,
1771 const SectionRef &Section) {
1772 ListScope D(W, "CodeViewTypes");
1773 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
1774 StringRef Data;
1775 error(Section.getContents(Data));
1776 W.printBinaryBlock("Data", Data);
1777
1778 unsigned Magic = *reinterpret_cast<const ulittle32_t *>(Data.data());
1779 W.printHex("Magic", Magic);
1780
1781 Data = Data.drop_front(4);
1782
1783 while (!Data.empty()) {
Reid Kleckner6b3faef2016-01-13 23:44:57 +00001784 const TypeRecordPrefix *Rec;
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001785 error(consumeObject(Data, Rec));
Reid Kleckner6b3faef2016-01-13 23:44:57 +00001786 auto Leaf = static_cast<TypeLeafKind>(uint16_t(Rec->Leaf));
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001787
1788 // This record is 'Len - 2' bytes, and the next one starts immediately
1789 // afterwards.
1790 StringRef LeafData = Data.substr(0, Rec->Len - 2);
1791 StringRef RemainingData = Data.drop_front(LeafData.size());
1792
1793 // Find the name of this leaf type.
1794 StringRef LeafName = getLeafTypeName(Leaf);
1795 DictScope S(W, LeafName);
1796 unsigned NextTypeIndex = 0x1000 + CVUDTNames.size();
Reid Kleckner6b3faef2016-01-13 23:44:57 +00001797 W.printEnum("TypeLeafKind", unsigned(Leaf), makeArrayRef(LeafTypeNames));
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001798 W.printHex("TypeIndex", NextTypeIndex);
1799
1800 // Fill this in inside the switch to get something in CVUDTNames.
1801 StringRef Name;
1802
1803 switch (Leaf) {
1804 default: {
1805 W.printHex("Size", Rec->Len);
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001806 break;
1807 }
1808
1809 case LF_STRING_ID: {
1810 const StringId *String;
1811 error(consumeObject(LeafData, String));
1812 W.printHex("Id", String->id.getIndex());
1813 StringRef StringData = getRemainingBytesAsString(Rec, LeafData.data());
1814 W.printString("StringData", StringData);
1815 // Put this in CVUDTNames so it gets printed with LF_UDT_SRC_LINE.
1816 Name = StringData;
1817 break;
1818 }
1819
1820 case LF_FIELDLIST: {
1821 W.printHex("Size", Rec->Len);
1822 // FieldList has no fixed prefix that can be described with a struct. All
1823 // the bytes must be interpreted as more records.
1824 printCodeViewFieldList(LeafData);
1825 break;
1826 }
1827
1828 case LF_ARGLIST:
1829 case LF_SUBSTR_LIST: {
1830 const ArgList *Args;
1831 error(consumeObject(LeafData, Args));
1832 W.printNumber("NumArgs", Args->NumArgs);
1833 ListScope Arguments(W, "Arguments");
1834 SmallString<256> TypeName("(");
1835 for (uint32_t ArgI = 0; ArgI != Args->NumArgs; ++ArgI) {
1836 const TypeIndex *Type;
1837 error(consumeObject(LeafData, Type));
1838 printTypeIndex("ArgType", *Type);
1839 StringRef ArgTypeName = getTypeName(*Type);
1840 TypeName.append(ArgTypeName);
1841 if (ArgI + 1 != Args->NumArgs)
1842 TypeName.append(", ");
1843 }
1844 TypeName.push_back(')');
1845 Name = TypeNames.insert(TypeName).first->getKey();
1846 break;
1847 }
1848
1849 case LF_CLASS:
1850 case LF_STRUCTURE:
1851 case LF_INTERFACE: {
1852 const ClassType *Class;
1853 error(consumeObject(LeafData, Class));
1854 W.printNumber("MemberCount", Class->MemberCount);
1855 uint16_t Props = Class->Properties;
1856 W.printFlags("Properties", Props, makeArrayRef(ClassOptionNames));
1857 printTypeIndex("FieldList", Class->FieldList);
1858 printTypeIndex("DerivedFrom", Class->DerivedFrom);
1859 printTypeIndex("VShape", Class->VShape);
1860 uint64_t SizeOf;
1861 error(decodeUIntLeaf(LeafData, SizeOf));
1862 W.printNumber("SizeOf", SizeOf);
1863 StringRef LinkageName;
1864 std::tie(Name, LinkageName) = LeafData.split('\0');
1865 W.printString("Name", Name);
1866 if (Props & uint16_t(ClassOptions::HasUniqueName)) {
1867 LinkageName = getRemainingBytesAsString(Rec, LinkageName.data());
1868 if (LinkageName.empty())
1869 return error(object_error::parse_failed);
1870 W.printString("LinkageName", LinkageName);
1871 }
1872 break;
1873 }
1874
1875 case LF_UNION: {
1876 const UnionType *Union;
1877 error(consumeObject(LeafData, Union));
1878 W.printNumber("MemberCount", Union->MemberCount);
1879 uint16_t Props = Union->Properties;
1880 W.printFlags("Properties", Props, makeArrayRef(ClassOptionNames));
1881 printTypeIndex("FieldList", Union->FieldList);
1882 uint64_t SizeOf;
1883 error(decodeUIntLeaf(LeafData, SizeOf));
1884 W.printNumber("SizeOf", SizeOf);
1885 StringRef LinkageName;
1886 std::tie(Name, LinkageName) = LeafData.split('\0');
1887 W.printString("Name", Name);
1888 if (Props & uint16_t(ClassOptions::HasUniqueName)) {
1889 LinkageName = getRemainingBytesAsString(Rec, LinkageName.data());
1890 if (LinkageName.empty())
1891 return error(object_error::parse_failed);
1892 W.printString("LinkageName", LinkageName);
1893 }
1894 break;
1895 }
1896
1897 case LF_ENUM: {
1898 const EnumType *Enum;
1899 error(consumeObject(LeafData, Enum));
1900 W.printNumber("NumEnumerators", Enum->NumEnumerators);
1901 W.printFlags("Properties", uint16_t(Enum->Properties),
1902 makeArrayRef(ClassOptionNames));
1903 printTypeIndex("UnderlyingType", Enum->UnderlyingType);
1904 printTypeIndex("FieldListType", Enum->FieldListType);
1905 Name = LeafData.split('\0').first;
1906 W.printString("Name", Name);
1907 break;
1908 }
1909
1910 case LF_ARRAY: {
1911 const ArrayType *AT;
1912 error(consumeObject(LeafData, AT));
1913 printTypeIndex("ElementType", AT->ElementType);
1914 printTypeIndex("IndexType", AT->IndexType);
1915 uint64_t SizeOf;
1916 error(decodeUIntLeaf(LeafData, SizeOf));
1917 W.printNumber("SizeOf", SizeOf);
1918 Name = LeafData.split('\0').first;
1919 W.printString("Name", Name);
1920 break;
1921 }
1922
1923 case LF_VFTABLE: {
1924 const VFTableType *VFT;
1925 error(consumeObject(LeafData, VFT));
1926 printTypeIndex("CompleteClass", VFT->CompleteClass);
1927 printTypeIndex("OverriddenVFTable", VFT->OverriddenVFTable);
1928 W.printHex("VFPtrOffset", VFT->VFPtrOffset);
1929 StringRef NamesData = LeafData.substr(0, VFT->NamesLen);
1930 std::tie(Name, NamesData) = NamesData.split('\0');
1931 W.printString("VFTableName", Name);
1932 while (!NamesData.empty()) {
1933 StringRef MethodName;
1934 std::tie(MethodName, NamesData) = NamesData.split('\0');
1935 W.printString("MethodName", MethodName);
1936 }
1937 break;
1938 }
1939
1940 case LF_MFUNC_ID: {
1941 const MemberFuncId *Id;
1942 error(consumeObject(LeafData, Id));
1943 printTypeIndex("ClassType", Id->ClassType);
1944 printTypeIndex("FunctionType", Id->FunctionType);
1945 Name = LeafData.split('\0').first;
1946 W.printString("Name", Name);
1947 break;
1948 }
1949
1950 case LF_PROCEDURE: {
1951 const ProcedureType *Proc;
1952 error(consumeObject(LeafData, Proc));
1953 printTypeIndex("ReturnType", Proc->ReturnType);
1954 W.printEnum("CallingConvention", uint8_t(Proc->CallConv),
1955 makeArrayRef(CallingConventions));
1956 W.printFlags("FunctionOptions", uint8_t(Proc->Options),
1957 makeArrayRef(FunctionOptionEnum));
1958 W.printNumber("NumParameters", Proc->NumParameters);
1959 printTypeIndex("ArgListType", Proc->ArgListType);
1960
1961 StringRef ReturnTypeName = getTypeName(Proc->ReturnType);
1962 StringRef ArgListTypeName = getTypeName(Proc->ArgListType);
1963 SmallString<256> TypeName(ReturnTypeName);
1964 TypeName.push_back(' ');
1965 TypeName.append(ArgListTypeName);
1966 Name = TypeNames.insert(TypeName).first->getKey();
1967 break;
1968 }
1969
1970 case LF_MFUNCTION: {
1971 const MemberFunctionType *MemberFunc;
1972 error(consumeObject(LeafData, MemberFunc));
1973 printTypeIndex("ReturnType", MemberFunc->ReturnType);
1974 printTypeIndex("ClassType", MemberFunc->ClassType);
1975 printTypeIndex("ThisType", MemberFunc->ThisType);
1976 W.printEnum("CallingConvention", uint8_t(MemberFunc->CallConv),
1977 makeArrayRef(CallingConventions));
1978 W.printFlags("FunctionOptions", uint8_t(MemberFunc->Options),
1979 makeArrayRef(FunctionOptionEnum));
1980 W.printNumber("NumParameters", MemberFunc->NumParameters);
1981 printTypeIndex("ArgListType", MemberFunc->ArgListType);
1982 W.printNumber("ThisAdjustment", MemberFunc->ThisAdjustment);
1983
1984 StringRef ReturnTypeName = getTypeName(MemberFunc->ReturnType);
1985 StringRef ClassTypeName = getTypeName(MemberFunc->ClassType);
1986 StringRef ArgListTypeName = getTypeName(MemberFunc->ArgListType);
1987 SmallString<256> TypeName(ReturnTypeName);
1988 TypeName.push_back(' ');
1989 TypeName.append(ClassTypeName);
1990 TypeName.append("::");
1991 TypeName.append(ArgListTypeName);
1992 Name = TypeNames.insert(TypeName).first->getKey();
1993 break;
1994 }
1995
1996 case LF_METHODLIST: {
1997 while (!LeafData.empty()) {
1998 const MethodListEntry *Method;
1999 error(consumeObject(LeafData, Method));
2000 ListScope S(W, "Method");
2001 printMemberAttributes(Method->Attrs);
2002 printTypeIndex("Type", Method->Type);
2003 if (Method->isIntroducedVirtual()) {
2004 const little32_t *VFTOffsetPtr;
2005 error(consumeObject(LeafData, VFTOffsetPtr));
2006 W.printHex("VFTableOffset", *VFTOffsetPtr);
2007 }
2008 }
2009 break;
2010 }
2011
2012 case LF_FUNC_ID: {
2013 const FuncId *Func;
2014 error(consumeObject(LeafData, Func));
2015 printTypeIndex("ParentScope", Func->ParentScope);
2016 printTypeIndex("FunctionType", Func->FunctionType);
2017 StringRef Name, Null;
2018 std::tie(Name, Null) = LeafData.split('\0');
2019 W.printString("Name", Name);
2020 break;
2021 }
2022
2023 case LF_TYPESERVER2: {
2024 const TypeServer2 *TypeServer;
2025 error(consumeObject(LeafData, TypeServer));
2026 W.printBinary("Signature", StringRef(TypeServer->Signature, 16));
2027 W.printNumber("Age", TypeServer->Age);
2028 Name = LeafData.split('\0').first;
2029 W.printString("Name", Name);
2030 break;
2031 }
2032
2033 case LF_POINTER: {
2034 const PointerType *Ptr;
2035 error(consumeObject(LeafData, Ptr));
2036 printTypeIndex("PointeeType", Ptr->PointeeType);
2037 W.printHex("PointerAttributes", Ptr->Attrs);
2038 W.printEnum("PtrType", unsigned(Ptr->getPtrKind()),
2039 makeArrayRef(PtrKindNames));
2040 W.printEnum("PtrMode", unsigned(Ptr->getPtrMode()),
2041 makeArrayRef(PtrModeNames));
2042 W.printNumber("IsFlat", Ptr->isFlat());
2043 W.printNumber("IsConst", Ptr->isConst());
2044 W.printNumber("IsVolatile", Ptr->isVolatile());
2045 W.printNumber("IsUnaligned", Ptr->isUnaligned());
2046
2047 if (Ptr->isPointerToMember()) {
2048 const PointerToMemberTail *PMT;
2049 error(consumeObject(LeafData, PMT));
2050 printTypeIndex("ClassType", PMT->ClassType);
2051 W.printEnum("Representation", PMT->Representation,
2052 makeArrayRef(PtrMemberRepNames));
2053
2054 StringRef PointeeName = getTypeName(Ptr->PointeeType);
2055 StringRef ClassName = getTypeName(PMT->ClassType);
2056 SmallString<256> TypeName(PointeeName);
2057 TypeName.push_back(' ');
2058 TypeName.append(ClassName);
2059 TypeName.append("::*");
2060 Name = TypeNames.insert(TypeName).first->getKey();
2061 } else {
2062 W.printBinaryBlock("TailData", LeafData);
2063
2064 SmallString<256> TypeName;
2065 if (Ptr->isConst())
2066 TypeName.append("const ");
2067 if (Ptr->isVolatile())
2068 TypeName.append("volatile ");
2069 if (Ptr->isUnaligned())
2070 TypeName.append("__unaligned ");
2071
2072 TypeName.append(getTypeName(Ptr->PointeeType));
2073
2074 if (Ptr->getPtrMode() == PointerMode::LValueReference)
2075 TypeName.append("&");
2076 else if (Ptr->getPtrMode() == PointerMode::RValueReference)
2077 TypeName.append("&&");
2078 else if (Ptr->getPtrMode() == PointerMode::Pointer)
2079 TypeName.append("*");
2080
2081 Name = TypeNames.insert(TypeName).first->getKey();
2082 }
2083 break;
2084 }
2085
2086 case LF_MODIFIER: {
2087 const TypeModifier *Mod;
2088 error(consumeObject(LeafData, Mod));
2089 printTypeIndex("ModifiedType", Mod->ModifiedType);
2090 W.printFlags("Modifiers", Mod->Modifiers,
2091 makeArrayRef(TypeModifierNames));
2092
2093 StringRef ModifiedName = getTypeName(Mod->ModifiedType);
2094 SmallString<256> TypeName;
2095 if (Mod->Modifiers & uint16_t(ModifierOptions::Const))
2096 TypeName.append("const ");
2097 if (Mod->Modifiers & uint16_t(ModifierOptions::Volatile))
2098 TypeName.append("volatile ");
2099 if (Mod->Modifiers & uint16_t(ModifierOptions::Unaligned))
2100 TypeName.append("__unaligned ");
2101 TypeName.append(ModifiedName);
2102 Name = TypeNames.insert(TypeName).first->getKey();
2103 break;
2104 }
2105
2106 case LF_VTSHAPE: {
2107 const VTableShape *Shape;
2108 error(consumeObject(LeafData, Shape));
2109 unsigned VFEntryCount = Shape->VFEntryCount;
2110 W.printNumber("VFEntryCount", VFEntryCount);
2111 // We could print out whether the methods are near or far, but in practice
2112 // today everything is CV_VTS_near32, so it's just noise.
2113 break;
2114 }
2115
2116 case LF_UDT_SRC_LINE: {
2117 const UDTSrcLine *Line;
2118 error(consumeObject(LeafData, Line));
2119 printTypeIndex("UDT", Line->UDT);
2120 printTypeIndex("SourceFile", Line->SourceFile);
2121 W.printNumber("LineNumber", Line->LineNumber);
2122 break;
2123 }
2124
2125 case LF_BUILDINFO: {
2126 const BuildInfo *Args;
2127 error(consumeObject(LeafData, Args));
2128 W.printNumber("NumArgs", Args->NumArgs);
2129
2130 ListScope Arguments(W, "Arguments");
2131 for (uint32_t ArgI = 0; ArgI != Args->NumArgs; ++ArgI) {
2132 const TypeIndex *Type;
2133 error(consumeObject(LeafData, Type));
2134 printTypeIndex("ArgType", *Type);
2135 }
2136 break;
2137 }
2138 }
2139
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00002140 if (opts::CodeViewSubsectionBytes)
2141 W.printBinaryBlock("LeafData", LeafData);
2142
Reid Kleckner72e2ba72016-01-13 19:32:35 +00002143 CVUDTNames.push_back(Name);
2144
2145 Data = RemainingData;
2146 // FIXME: The stream contains LF_PAD bytes that we need to ignore, but those
2147 // are typically included in LeafData. We may need to call skipPadding() if
2148 // we ever find a record that doesn't count those bytes.
2149 }
2150}
2151
2152static StringRef skipPadding(StringRef Data) {
2153 if (Data.empty())
2154 return Data;
2155 uint8_t Leaf = Data.front();
2156 if (Leaf < LF_PAD0)
2157 return Data;
2158 // Leaf is greater than 0xf0. We should advance by the number of bytes in the
2159 // low 4 bits.
2160 return Data.drop_front(Leaf & 0x0F);
2161}
2162
2163void COFFDumper::printMemberAttributes(MemberAttributes Attrs) {
2164 W.printEnum("AccessSpecifier", uint8_t(Attrs.getAccess()),
2165 makeArrayRef(MemberAccessNames));
2166 auto MK = Attrs.getMethodKind();
2167 // Data members will be vanilla. Don't try to print a method kind for them.
2168 if (MK != MethodKind::Vanilla)
2169 W.printEnum("MethodKind", unsigned(MK), makeArrayRef(MemberKindNames));
2170 if (Attrs.getFlags() != MethodOptions::None) {
2171 W.printFlags("MethodOptions", unsigned(Attrs.getFlags()),
2172 makeArrayRef(MethodOptionNames));
2173 }
2174}
2175
2176void COFFDumper::printCodeViewFieldList(StringRef FieldData) {
2177 while (!FieldData.empty()) {
2178 const ulittle16_t *LeafPtr;
2179 error(consumeObject(FieldData, LeafPtr));
2180 uint16_t Leaf = *LeafPtr;
2181 switch (Leaf) {
2182 default:
2183 W.printHex("UnknownMember", Leaf);
2184 // We can't advance once we hit an unknown field. The size is not encoded.
2185 return;
2186
2187 case LF_NESTTYPE: {
2188 const NestedType *Nested;
2189 error(consumeObject(FieldData, Nested));
2190 DictScope S(W, "NestedType");
2191 printTypeIndex("Type", Nested->Type);
2192 StringRef Name;
2193 std::tie(Name, FieldData) = FieldData.split('\0');
2194 W.printString("Name", Name);
2195 break;
2196 }
2197
2198 case LF_ONEMETHOD: {
2199 const OneMethod *Method;
2200 error(consumeObject(FieldData, Method));
2201 DictScope S(W, "OneMethod");
2202 printMemberAttributes(Method->Attrs);
2203 printTypeIndex("Type", Method->Type);
2204 // If virtual, then read the vftable offset.
2205 if (Method->isIntroducedVirtual()) {
2206 const little32_t *VFTOffsetPtr;
2207 error(consumeObject(FieldData, VFTOffsetPtr));
2208 W.printHex("VFTableOffset", *VFTOffsetPtr);
2209 }
2210 StringRef Name;
2211 std::tie(Name, FieldData) = FieldData.split('\0');
2212 W.printString("Name", Name);
2213 break;
2214 }
2215
2216 case LF_METHOD: {
2217 const OverloadedMethod *Method;
2218 error(consumeObject(FieldData, Method));
2219 DictScope S(W, "OverloadedMethod");
2220 W.printHex("MethodCount", Method->MethodCount);
2221 W.printHex("MethodListIndex", Method->MethList.getIndex());
2222 StringRef Name;
2223 std::tie(Name, FieldData) = FieldData.split('\0');
2224 W.printString("Name", Name);
2225 break;
2226 }
2227
2228 case LF_MEMBER: {
2229 const DataMember *Field;
2230 error(consumeObject(FieldData, Field));
2231 DictScope S(W, "DataMember");
2232 printMemberAttributes(Field->Attrs);
2233 printTypeIndex("Type", Field->Type);
2234 uint64_t FieldOffset;
2235 error(decodeUIntLeaf(FieldData, FieldOffset));
2236 W.printHex("FieldOffset", FieldOffset);
2237 StringRef Name;
2238 std::tie(Name, FieldData) = FieldData.split('\0');
2239 W.printString("Name", Name);
2240 break;
2241 }
2242
2243 case LF_STMEMBER: {
2244 const StaticDataMember *Field;
2245 error(consumeObject(FieldData, Field));
2246 DictScope S(W, "StaticDataMember");
2247 printMemberAttributes(Field->Attrs);
2248 printTypeIndex("Type", Field->Type);
2249 StringRef Name;
2250 std::tie(Name, FieldData) = FieldData.split('\0');
2251 W.printString("Name", Name);
2252 break;
2253 }
2254
2255 case LF_VFUNCTAB: {
2256 const VirtualFunctionPointer *VFTable;
2257 error(consumeObject(FieldData, VFTable));
2258 DictScope S(W, "VirtualFunctionPointer");
2259 printTypeIndex("Type", VFTable->Type);
2260 break;
2261 }
2262
2263 case LF_ENUMERATE: {
2264 const Enumerator *Enum;
2265 error(consumeObject(FieldData, Enum));
2266 DictScope S(W, "Enumerator");
2267 printMemberAttributes(Enum->Attrs);
2268 APSInt EnumValue;
2269 error(decodeNumerictLeaf(FieldData, EnumValue));
2270 W.printNumber("EnumValue", EnumValue);
2271 StringRef Name;
2272 std::tie(Name, FieldData) = FieldData.split('\0');
2273 W.printString("Name", Name);
2274 break;
2275 }
2276
2277 case LF_BCLASS:
2278 case LF_BINTERFACE: {
2279 const BaseClass *Base;
2280 error(consumeObject(FieldData, Base));
2281 DictScope S(W, "BaseClass");
2282 printMemberAttributes(Base->Attrs);
2283 printTypeIndex("BaseType", Base->BaseType);
2284 uint64_t BaseOffset;
2285 error(decodeUIntLeaf(FieldData, BaseOffset));
2286 W.printHex("BaseOffset", BaseOffset);
2287 break;
2288 }
2289
2290 case LF_VBCLASS:
2291 case LF_IVBCLASS: {
2292 const VirtualBaseClass *Base;
2293 error(consumeObject(FieldData, Base));
2294 DictScope S(W, "VirtualBaseClass");
2295 printMemberAttributes(Base->Attrs);
2296 printTypeIndex("BaseType", Base->BaseType);
2297 printTypeIndex("VBPtrType", Base->VBPtrType);
2298 uint64_t VBPtrOffset, VBTableIndex;
2299 error(decodeUIntLeaf(FieldData, VBPtrOffset));
2300 error(decodeUIntLeaf(FieldData, VBTableIndex));
2301 W.printHex("VBPtrOffset", VBPtrOffset);
2302 W.printHex("VBTableIndex", VBTableIndex);
2303 break;
2304 }
2305 }
2306
2307 // Handle padding.
2308 FieldData = skipPadding(FieldData);
2309 }
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00002310}
2311
Eric Christopher9cad53c2013-04-03 18:31:38 +00002312void COFFDumper::printSections() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002313 ListScope SectionsD(W, "Sections");
2314 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002315 for (const SectionRef &Sec : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002316 ++SectionNumber;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002317 const coff_section *Section = Obj->getCOFFSection(Sec);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002318
2319 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002320 error(Sec.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002321
2322 DictScope D(W, "Section");
2323 W.printNumber("Number", SectionNumber);
2324 W.printBinary("Name", Name, Section->Name);
2325 W.printHex ("VirtualSize", Section->VirtualSize);
2326 W.printHex ("VirtualAddress", Section->VirtualAddress);
2327 W.printNumber("RawDataSize", Section->SizeOfRawData);
2328 W.printHex ("PointerToRawData", Section->PointerToRawData);
2329 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
2330 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
2331 W.printNumber("RelocationCount", Section->NumberOfRelocations);
2332 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
2333 W.printFlags ("Characteristics", Section->Characteristics,
2334 makeArrayRef(ImageSectionCharacteristics),
2335 COFF::SectionCharacteristics(0x00F00000));
2336
2337 if (opts::SectionRelocations) {
2338 ListScope D(W, "Relocations");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002339 for (const RelocationRef &Reloc : Sec.relocations())
2340 printRelocation(Sec, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002341 }
2342
2343 if (opts::SectionSymbols) {
2344 ListScope D(W, "Symbols");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002345 for (const SymbolRef &Symbol : Obj->symbols()) {
Rafael Espindola80291272014-10-08 15:28:58 +00002346 if (!Sec.containsSymbol(Symbol))
Eric Christopher9cad53c2013-04-03 18:31:38 +00002347 continue;
2348
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002349 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002350 }
2351 }
2352
David Majnemerdac39852014-09-26 22:32:16 +00002353 if (opts::SectionData &&
2354 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002355 StringRef Data;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002356 error(Sec.getContents(Data));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002357
2358 W.printBinaryBlock("SectionData", Data);
2359 }
2360 }
2361}
2362
2363void COFFDumper::printRelocations() {
2364 ListScope D(W, "Relocations");
2365
Eric Christopher9cad53c2013-04-03 18:31:38 +00002366 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002367 for (const SectionRef &Section : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002368 ++SectionNumber;
Eric Christopher9cad53c2013-04-03 18:31:38 +00002369 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002370 error(Section.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002371
2372 bool PrintedGroup = false;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002373 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002374 if (!PrintedGroup) {
2375 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
2376 W.indent();
2377 PrintedGroup = true;
2378 }
2379
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002380 printRelocation(Section, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002381 }
2382
2383 if (PrintedGroup) {
2384 W.unindent();
2385 W.startLine() << "}\n";
2386 }
2387 }
2388}
2389
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002390void COFFDumper::printRelocation(const SectionRef &Section,
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00002391 const RelocationRef &Reloc, uint64_t Bias) {
2392 uint64_t Offset = Reloc.getOffset() - Bias;
Rafael Espindola99c041b2015-06-30 01:53:01 +00002393 uint64_t RelocType = Reloc.getType();
Eric Christopher9cad53c2013-04-03 18:31:38 +00002394 SmallString<32> RelocName;
Eric Christopher9cad53c2013-04-03 18:31:38 +00002395 StringRef SymbolName;
Rafael Espindola41bb4322015-06-30 04:08:37 +00002396 Reloc.getTypeName(RelocName);
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00002397 symbol_iterator Symbol = Reloc.getSymbol();
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00002398 if (Symbol != Obj->symbol_end()) {
2399 ErrorOr<StringRef> SymbolNameOrErr = Symbol->getName();
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002400 error(SymbolNameOrErr.getError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00002401 SymbolName = *SymbolNameOrErr;
2402 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00002403
Nico Rieckf3f0b792013-04-12 04:01:52 +00002404 if (opts::ExpandRelocs) {
2405 DictScope Group(W, "Relocation");
2406 W.printHex("Offset", Offset);
2407 W.printNumber("Type", RelocName, RelocType);
David Majnemer1f80b0a2014-11-13 07:42:11 +00002408 W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName);
Nico Rieckf3f0b792013-04-12 04:01:52 +00002409 } else {
2410 raw_ostream& OS = W.startLine();
2411 OS << W.hex(Offset)
2412 << " " << RelocName
David Majnemer1f80b0a2014-11-13 07:42:11 +00002413 << " " << (SymbolName.empty() ? "-" : SymbolName)
Nico Rieckf3f0b792013-04-12 04:01:52 +00002414 << "\n";
2415 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00002416}
2417
2418void COFFDumper::printSymbols() {
2419 ListScope Group(W, "Symbols");
2420
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002421 for (const SymbolRef &Symbol : Obj->symbols())
2422 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002423}
2424
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002425void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
Eric Christopher9cad53c2013-04-03 18:31:38 +00002426
David Majnemer236b0ca2014-11-17 11:17:17 +00002427static ErrorOr<StringRef>
2428getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber,
2429 const coff_section *Section) {
David Majnemerf4dc4562014-09-20 00:25:06 +00002430 if (Section) {
2431 StringRef SectionName;
David Majnemer236b0ca2014-11-17 11:17:17 +00002432 if (std::error_code EC = Obj->getSectionName(Section, SectionName))
2433 return EC;
David Majnemerf4dc4562014-09-20 00:25:06 +00002434 return SectionName;
2435 }
David Majnemerf4dc4562014-09-20 00:25:06 +00002436 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
David Majnemer236b0ca2014-11-17 11:17:17 +00002437 return StringRef("IMAGE_SYM_DEBUG");
David Majnemerf4dc4562014-09-20 00:25:06 +00002438 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
David Majnemer236b0ca2014-11-17 11:17:17 +00002439 return StringRef("IMAGE_SYM_ABSOLUTE");
David Majnemerf4dc4562014-09-20 00:25:06 +00002440 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
David Majnemer236b0ca2014-11-17 11:17:17 +00002441 return StringRef("IMAGE_SYM_UNDEFINED");
2442 return StringRef("");
David Majnemerf4dc4562014-09-20 00:25:06 +00002443}
2444
Alexey Samsonov27dc8392014-03-18 06:53:02 +00002445void COFFDumper::printSymbol(const SymbolRef &Sym) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002446 DictScope D(W, "Symbol");
2447
David Majnemer44f51e52014-09-10 12:51:52 +00002448 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002449 const coff_section *Section;
David Majnemer44f51e52014-09-10 12:51:52 +00002450 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002451 W.startLine() << "Invalid section number: " << EC.message() << "\n";
2452 W.flush();
2453 return;
2454 }
2455
2456 StringRef SymbolName;
2457 if (Obj->getSymbolName(Symbol, SymbolName))
2458 SymbolName = "";
2459
David Majnemer236b0ca2014-11-17 11:17:17 +00002460 StringRef SectionName = "";
2461 ErrorOr<StringRef> Res =
2462 getSectionName(Obj, Symbol.getSectionNumber(), Section);
2463 if (Res)
2464 SectionName = *Res;
Eric Christopher9cad53c2013-04-03 18:31:38 +00002465
2466 W.printString("Name", SymbolName);
David Majnemer44f51e52014-09-10 12:51:52 +00002467 W.printNumber("Value", Symbol.getValue());
2468 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
2469 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
2470 W.printEnum ("ComplexType", Symbol.getComplexType(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00002471 makeArrayRef(ImageSymDType));
David Majnemer44f51e52014-09-10 12:51:52 +00002472 W.printEnum ("StorageClass", Symbol.getStorageClass(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00002473 makeArrayRef(ImageSymClass));
David Majnemer44f51e52014-09-10 12:51:52 +00002474 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
Eric Christopher9cad53c2013-04-03 18:31:38 +00002475
David Majnemer44f51e52014-09-10 12:51:52 +00002476 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
2477 if (Symbol.isFunctionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002478 const coff_aux_function_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002479 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002480
2481 DictScope AS(W, "AuxFunctionDef");
2482 W.printNumber("TagIndex", Aux->TagIndex);
2483 W.printNumber("TotalSize", Aux->TotalSize);
David Majnemerf3a2af52014-03-19 04:33:27 +00002484 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002485 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002486
David Majnemerc7d7c6f2014-10-31 05:07:00 +00002487 } else if (Symbol.isAnyUndefined()) {
David Majnemerf3a2af52014-03-19 04:33:27 +00002488 const coff_aux_weak_external *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002489 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002490
David Majnemer44f51e52014-09-10 12:51:52 +00002491 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002492 StringRef LinkedName;
David Majnemer44f51e52014-09-10 12:51:52 +00002493 std::error_code EC = Linked.getError();
2494 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002495 LinkedName = "";
2496 error(EC);
2497 }
2498
2499 DictScope AS(W, "AuxWeakExternal");
2500 W.printNumber("Linked", LinkedName, Aux->TagIndex);
2501 W.printEnum ("Search", Aux->Characteristics,
2502 makeArrayRef(WeakExternalCharacteristics));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002503
David Majnemer44f51e52014-09-10 12:51:52 +00002504 } else if (Symbol.isFileRecord()) {
2505 const char *FileName;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002506 error(getSymbolAuxData(Obj, Symbol, I, FileName));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002507
Nico Rieck0ab8e602013-04-22 08:35:11 +00002508 DictScope AS(W, "AuxFileRecord");
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00002509
David Majnemer44f51e52014-09-10 12:51:52 +00002510 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
2511 Obj->getSymbolTableEntrySize());
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00002512 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
Saleem Abdulrasool3b5e0012014-04-16 04:15:29 +00002513 break;
David Majnemer44f51e52014-09-10 12:51:52 +00002514 } else if (Symbol.isSectionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002515 const coff_aux_section_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002516 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002517
David Majnemer4d571592014-09-15 19:42:42 +00002518 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
2519
Eric Christopher9cad53c2013-04-03 18:31:38 +00002520 DictScope AS(W, "AuxSectionDef");
2521 W.printNumber("Length", Aux->Length);
2522 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
2523 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
2524 W.printHex("Checksum", Aux->CheckSum);
David Majnemer4d571592014-09-15 19:42:42 +00002525 W.printNumber("Number", AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002526 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002527
Nico Riecka711dee2013-04-22 08:34:59 +00002528 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
Eric Christopher9cad53c2013-04-03 18:31:38 +00002529 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
2530 const coff_section *Assoc;
David Majnemer236b0ca2014-11-17 11:17:17 +00002531 StringRef AssocName = "";
2532 std::error_code EC = Obj->getSection(AuxNumber, Assoc);
2533 ErrorOr<StringRef> Res = getSectionName(Obj, AuxNumber, Assoc);
2534 if (Res)
2535 AssocName = *Res;
2536 if (!EC)
2537 EC = Res.getError();
2538 if (EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002539 AssocName = "";
2540 error(EC);
2541 }
2542
David Majnemer4d571592014-09-15 19:42:42 +00002543 W.printNumber("AssocSection", AssocName, AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002544 }
David Majnemer44f51e52014-09-10 12:51:52 +00002545 } else if (Symbol.isCLRToken()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002546 const coff_aux_clr_token *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002547 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00002548
David Majnemer44f51e52014-09-10 12:51:52 +00002549 ErrorOr<COFFSymbolRef> ReferredSym =
2550 Obj->getSymbol(Aux->SymbolTableIndex);
Nico Rieck8678acd2014-03-17 01:46:52 +00002551 StringRef ReferredName;
David Majnemer44f51e52014-09-10 12:51:52 +00002552 std::error_code EC = ReferredSym.getError();
2553 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
Nico Rieck8678acd2014-03-17 01:46:52 +00002554 ReferredName = "";
2555 error(EC);
2556 }
2557
Eric Christopher9cad53c2013-04-03 18:31:38 +00002558 DictScope AS(W, "AuxCLRToken");
2559 W.printNumber("AuxType", Aux->AuxType);
2560 W.printNumber("Reserved", Aux->Reserved);
Nico Rieck8678acd2014-03-17 01:46:52 +00002561 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00002562
2563 } else {
2564 W.startLine() << "<unhandled auxiliary record>\n";
2565 }
2566 }
2567}
2568
2569void COFFDumper::printUnwindInfo() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00002570 ListScope D(W, "UnwindInformation");
David Majnemer44f51e52014-09-10 12:51:52 +00002571 switch (Obj->getMachine()) {
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00002572 case COFF::IMAGE_FILE_MACHINE_AMD64: {
2573 Win64EH::Dumper Dumper(W);
Rafael Espindola4453e42942014-06-13 03:07:50 +00002574 Win64EH::Dumper::SymbolResolver
2575 Resolver = [](const object::coff_section *Section, uint64_t Offset,
2576 SymbolRef &Symbol, void *user_data) -> std::error_code {
2577 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
2578 return Dumper->resolveSymbol(Section, Offset, Symbol);
2579 };
Saleem Abdulrasool65dbbb52014-05-25 21:37:59 +00002580 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00002581 Dumper.printData(Ctx);
2582 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00002583 }
Saleem Abdulrasoole6971ca2014-06-04 15:47:15 +00002584 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
2585 ARM::WinEH::Decoder Decoder(W);
2586 Decoder.dumpProcedureData(*Obj);
2587 break;
2588 }
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00002589 default:
David Majnemer44f51e52014-09-10 12:51:52 +00002590 W.printEnum("unsupported Image Machine", Obj->getMachine(),
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00002591 makeArrayRef(ImageFileMachineType));
2592 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00002593 }
2594}
2595
Rui Ueyama979fb402014-10-09 02:16:38 +00002596void COFFDumper::printImportedSymbols(
2597 iterator_range<imported_symbol_iterator> Range) {
2598 for (const ImportedSymbolRef &I : Range) {
Rui Ueyama15d99352014-10-03 00:41:58 +00002599 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002600 error(I.getSymbolName(Sym));
Rui Ueyama15d99352014-10-03 00:41:58 +00002601 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002602 error(I.getOrdinal(Ordinal));
Rui Ueyama15d99352014-10-03 00:41:58 +00002603 W.printNumber("Symbol", Sym, Ordinal);
2604 }
2605}
2606
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00002607void COFFDumper::printDelayImportedSymbols(
2608 const DelayImportDirectoryEntryRef &I,
2609 iterator_range<imported_symbol_iterator> Range) {
2610 int Index = 0;
2611 for (const ImportedSymbolRef &S : Range) {
2612 DictScope Import(W, "Import");
2613 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002614 error(S.getSymbolName(Sym));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00002615 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002616 error(S.getOrdinal(Ordinal));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00002617 W.printNumber("Symbol", Sym, Ordinal);
2618 uint64_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002619 error(I.getImportAddress(Index++, Addr));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00002620 W.printHex("Address", Addr);
2621 }
2622}
2623
Rui Ueyama1e152d52014-10-02 17:02:18 +00002624void COFFDumper::printCOFFImports() {
Rui Ueyama15d99352014-10-03 00:41:58 +00002625 // Regular imports
Rui Ueyama979fb402014-10-09 02:16:38 +00002626 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
Rui Ueyama1e152d52014-10-02 17:02:18 +00002627 DictScope Import(W, "Import");
2628 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002629 error(I.getName(Name));
Rui Ueyama1e152d52014-10-02 17:02:18 +00002630 W.printString("Name", Name);
2631 uint32_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002632 error(I.getImportLookupTableRVA(Addr));
Rui Ueyama1e152d52014-10-02 17:02:18 +00002633 W.printHex("ImportLookupTableRVA", Addr);
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002634 error(I.getImportAddressTableRVA(Addr));
Rui Ueyama1e152d52014-10-02 17:02:18 +00002635 W.printHex("ImportAddressTableRVA", Addr);
Rui Ueyama979fb402014-10-09 02:16:38 +00002636 printImportedSymbols(I.imported_symbols());
Rui Ueyama15d99352014-10-03 00:41:58 +00002637 }
2638
2639 // Delay imports
Rui Ueyama979fb402014-10-09 02:16:38 +00002640 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
Rui Ueyama15d99352014-10-03 00:41:58 +00002641 DictScope Import(W, "DelayImport");
2642 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002643 error(I.getName(Name));
Rui Ueyama15d99352014-10-03 00:41:58 +00002644 W.printString("Name", Name);
Rui Ueyama1af08652014-10-03 18:07:18 +00002645 const delay_import_directory_table_entry *Table;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002646 error(I.getDelayImportTable(Table));
Rui Ueyama1af08652014-10-03 18:07:18 +00002647 W.printHex("Attributes", Table->Attributes);
2648 W.printHex("ModuleHandle", Table->ModuleHandle);
2649 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
2650 W.printHex("ImportNameTable", Table->DelayImportNameTable);
2651 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
2652 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00002653 printDelayImportedSymbols(I, I.imported_symbols());
Rui Ueyama1e152d52014-10-02 17:02:18 +00002654 }
2655}
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00002656
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00002657void COFFDumper::printCOFFExports() {
2658 for (const ExportDirectoryEntryRef &E : Obj->export_directories()) {
2659 DictScope Export(W, "Export");
2660
2661 StringRef Name;
2662 uint32_t Ordinal, RVA;
2663
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002664 error(E.getSymbolName(Name));
2665 error(E.getOrdinal(Ordinal));
2666 error(E.getExportRVA(RVA));
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00002667
2668 W.printNumber("Ordinal", Ordinal);
2669 W.printString("Name", Name);
2670 W.printHex("RVA", RVA);
2671 }
2672}
2673
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00002674void COFFDumper::printCOFFDirectives() {
2675 for (const SectionRef &Section : Obj->sections()) {
2676 StringRef Contents;
2677 StringRef Name;
2678
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002679 error(Section.getName(Name));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00002680 if (Name != ".drectve")
2681 continue;
2682
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002683 error(Section.getContents(Contents));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00002684
2685 W.printString("Directive(s)", Contents);
2686 }
2687}
Rui Ueyama74e85132014-11-19 00:18:07 +00002688
2689static StringRef getBaseRelocTypeName(uint8_t Type) {
2690 switch (Type) {
2691 case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";
2692 case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";
2693 case COFF::IMAGE_REL_BASED_LOW: return "LOW";
2694 case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";
2695 case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";
Saleem Abdulrasool5a41c372015-01-16 20:16:09 +00002696 case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)";
Rui Ueyama74e85132014-11-19 00:18:07 +00002697 case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";
Colin LeMahieu9fbffee2014-11-19 17:10:39 +00002698 default: return "unknown (" + llvm::utostr(Type) + ")";
Rui Ueyama74e85132014-11-19 00:18:07 +00002699 }
2700}
2701
2702void COFFDumper::printCOFFBaseReloc() {
2703 ListScope D(W, "BaseReloc");
2704 for (const BaseRelocRef &I : Obj->base_relocs()) {
2705 uint8_t Type;
2706 uint32_t RVA;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00002707 error(I.getRVA(RVA));
2708 error(I.getType(Type));
Rui Ueyama74e85132014-11-19 00:18:07 +00002709 DictScope Import(W, "Entry");
2710 W.printString("Type", getBaseRelocTypeName(Type));
2711 W.printHex("Address", RVA);
2712 }
2713}
Lang Hames0000afd2015-06-26 23:56:53 +00002714
2715void COFFDumper::printStackMap() const {
2716 object::SectionRef StackMapSection;
2717 for (auto Sec : Obj->sections()) {
2718 StringRef Name;
2719 Sec.getName(Name);
2720 if (Name == ".llvm_stackmaps") {
2721 StackMapSection = Sec;
2722 break;
2723 }
2724 }
2725
2726 if (StackMapSection == object::SectionRef())
2727 return;
2728
2729 StringRef StackMapContents;
2730 StackMapSection.getContents(StackMapContents);
2731 ArrayRef<uint8_t> StackMapContentsArray(
2732 reinterpret_cast<const uint8_t*>(StackMapContents.data()),
2733 StackMapContents.size());
2734
2735 if (Obj->isLittleEndian())
2736 prettyPrintStackMap(
2737 llvm::outs(),
2738 StackMapV1Parser<support::little>(StackMapContentsArray));
2739 else
2740 prettyPrintStackMap(llvm::outs(),
2741 StackMapV1Parser<support::big>(StackMapContentsArray));
2742}