blob: 74c44116b1270b213ef6d0aa22d589ddc31cc0f4 [file] [log] [blame]
Eric Christopher9cad53c2013-04-03 18:31:38 +00001//===-- COFFDumper.cpp - COFF-specific dumper -------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11/// \brief This file implements the COFF-specific dumper for llvm-readobj.
12///
13//===----------------------------------------------------------------------===//
14
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000015#include "ARMWinEHPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000016#include "Error.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000017#include "ObjDumper.h"
Lang Hames0000afd2015-06-26 23:56:53 +000018#include "StackMapPrinter.h"
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +000019#include "Win64EHDumper.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000020#include "llvm-readobj.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000021#include "llvm/ADT/DenseMap.h"
22#include "llvm/ADT/SmallString.h"
Colin LeMahieu9fbffee2014-11-19 17:10:39 +000023#include "llvm/ADT/StringExtras.h"
Zachary Turner264b5d92017-06-07 03:48:56 +000024#include "llvm/BinaryFormat/COFF.h"
Zachary Turner526f4f22017-05-19 19:26:58 +000025#include "llvm/DebugInfo/CodeView/CVTypeVisitor.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000026#include "llvm/DebugInfo/CodeView/CodeView.h"
Zachary Turner8c099fe2017-05-30 16:36:15 +000027#include "llvm/DebugInfo/CodeView/DebugChecksumsSubsection.h"
Zachary Turner591312c2017-05-30 17:13:33 +000028#include "llvm/DebugInfo/CodeView/DebugFrameDataSubsection.h"
Zachary Turner8c099fe2017-05-30 16:36:15 +000029#include "llvm/DebugInfo/CodeView/DebugInlineeLinesSubsection.h"
30#include "llvm/DebugInfo/CodeView/DebugLinesSubsection.h"
Zachary Turner591312c2017-05-30 17:13:33 +000031#include "llvm/DebugInfo/CodeView/DebugStringTableSubsection.h"
Zachary Turner526f4f22017-05-19 19:26:58 +000032#include "llvm/DebugInfo/CodeView/LazyRandomTypeCollection.h"
Reid Klecknere9ab3492016-01-14 19:20:17 +000033#include "llvm/DebugInfo/CodeView/Line.h"
Zachary Turneraaad5742016-05-23 23:41:13 +000034#include "llvm/DebugInfo/CodeView/RecordSerialization.h"
Zachary Turner0d840742016-10-07 21:34:46 +000035#include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
Zachary Turneraaad5742016-05-23 23:41:13 +000036#include "llvm/DebugInfo/CodeView/SymbolDumpDelegate.h"
37#include "llvm/DebugInfo/CodeView/SymbolDumper.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000038#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
Zachary Turner629cb7d2017-01-11 23:24:22 +000039#include "llvm/DebugInfo/CodeView/TypeDumpVisitor.h"
Reid Kleckner6b3faef2016-01-13 23:44:57 +000040#include "llvm/DebugInfo/CodeView/TypeIndex.h"
41#include "llvm/DebugInfo/CodeView/TypeRecord.h"
Reid Kleckner0b269742016-05-14 00:02:53 +000042#include "llvm/DebugInfo/CodeView/TypeStreamMerger.h"
Zachary Turner4efa0a42016-11-08 22:24:53 +000043#include "llvm/DebugInfo/CodeView/TypeTableBuilder.h"
Zachary Turner526f4f22017-05-19 19:26:58 +000044#include "llvm/DebugInfo/CodeView/TypeTableCollection.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000045#include "llvm/Object/COFF.h"
46#include "llvm/Object/ObjectFile.h"
Zachary Turner05bd9f32017-04-28 23:41:36 +000047#include "llvm/Support/BinaryStreamReader.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000048#include "llvm/Support/Casting.h"
49#include "llvm/Support/Compiler.h"
Zachary Turner0c60f262017-05-18 23:03:06 +000050#include "llvm/Support/ConvertUTF.h"
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000051#include "llvm/Support/DataExtractor.h"
Zachary Turner05bd9f32017-04-28 23:41:36 +000052#include "llvm/Support/FormatVariadic.h"
Zachary Turner7b327d02017-02-16 23:35:45 +000053#include "llvm/Support/Path.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000054#include "llvm/Support/ScopedPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000055#include "llvm/Support/SourceMgr.h"
56#include "llvm/Support/Win64EH.h"
57#include "llvm/Support/raw_ostream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000058#include <algorithm>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000059#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000060#include <system_error>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +000061#include <time.h>
Eric Christopher9cad53c2013-04-03 18:31:38 +000062
63using namespace llvm;
64using namespace llvm::object;
Reid Kleckner72e2ba72016-01-13 19:32:35 +000065using namespace llvm::codeview;
Reid Kleckner6b3faef2016-01-13 23:44:57 +000066using namespace llvm::support;
Eric Christopher9cad53c2013-04-03 18:31:38 +000067using namespace llvm::Win64EH;
68
69namespace {
70
Reid Klecknerb7d716c2017-06-22 01:10:29 +000071struct LoadConfigTables {
72 uint64_t SEHTableVA = 0;
73 uint64_t SEHTableCount = 0;
74 uint32_t GuardFlags = 0;
75 uint64_t GuardFidTableVA = 0;
76 uint64_t GuardFidTableCount = 0;
77};
78
Eric Christopher9cad53c2013-04-03 18:31:38 +000079class COFFDumper : public ObjDumper {
80public:
Zachary Turneraaad5742016-05-23 23:41:13 +000081 friend class COFFObjectDumpDelegate;
Zachary Turner88bb1632016-05-03 00:28:04 +000082 COFFDumper(const llvm::object::COFFObjectFile *Obj, ScopedPrinter &Writer)
Zachary Turner526f4f22017-05-19 19:26:58 +000083 : ObjDumper(Writer), Obj(Obj), Writer(Writer), Types(100) {}
Eric Christopher9cad53c2013-04-03 18:31:38 +000084
Craig Topperfd38cbe2014-08-30 16:48:34 +000085 void printFileHeaders() override;
86 void printSections() override;
87 void printRelocations() override;
88 void printSymbols() override;
89 void printDynamicSymbols() override;
90 void printUnwindInfo() override;
Rui Ueyama1e152d52014-10-02 17:02:18 +000091 void printCOFFImports() override;
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +000092 void printCOFFExports() override;
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +000093 void printCOFFDirectives() override;
Rui Ueyama74e85132014-11-19 00:18:07 +000094 void printCOFFBaseReloc() override;
Reid Kleckner2da433e2016-06-02 17:10:43 +000095 void printCOFFDebugDirectory() override;
Zachary Turner8d6396d2017-04-27 19:38:38 +000096 void printCOFFResources() override;
Reid Klecknerb7d716c2017-06-22 01:10:29 +000097 void printCOFFLoadConfig() override;
Reid Kleckner83ebad32015-12-16 18:28:12 +000098 void printCodeViewDebugInfo() override;
Reid Kleckner5d577522017-03-24 17:26:38 +000099 void mergeCodeViewTypes(llvm::codeview::TypeTableBuilder &CVIDs,
100 llvm::codeview::TypeTableBuilder &CVTypes) override;
Lang Hames0000afd2015-06-26 23:56:53 +0000101 void printStackMap() const override;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000102private:
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000103 void printSymbol(const SymbolRef &Sym);
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000104 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc,
105 uint64_t Bias = 0);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000106 void printDataDirectory(uint32_t Index, const std::string &FieldName);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000107
David Majnemer50267222014-11-05 06:24:35 +0000108 void printDOSHeader(const dos_header *DH);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000109 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
110 void printBaseOfDataField(const pe32_header *Hdr);
111 void printBaseOfDataField(const pe32plus_header *Hdr);
Reid Klecknerb7d716c2017-06-22 01:10:29 +0000112 template <typename T>
113 void printCOFFLoadConfig(const T *Conf, LoadConfigTables &Tables);
114 typedef void (*PrintExtraCB)(raw_ostream &, const uint8_t *);
115 void printRVATable(uint64_t TableVA, uint64_t Count, uint64_t EntrySize,
116 PrintExtraCB PrintExtra = 0);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000117
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000118 void printCodeViewSymbolSection(StringRef SectionName, const SectionRef &Section);
119 void printCodeViewTypeSection(StringRef SectionName, const SectionRef &Section);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000120 StringRef getTypeName(TypeIndex Ty);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000121 StringRef getFileNameForFileOffset(uint32_t FileOffset);
122 void printFileNameForOffset(StringRef Label, uint32_t FileOffset);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000123 void printTypeIndex(StringRef FieldName, TypeIndex TI) {
124 // Forward to CVTypeDumper for simplicity.
Zachary Turner526f4f22017-05-19 19:26:58 +0000125 codeview::printTypeIndex(Writer, FieldName, TI, Types);
Reid Kleckner5cb2b6b2016-05-02 20:30:47 +0000126 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000127
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000128 void printCodeViewSymbolsSubsection(StringRef Subsection,
129 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +0000130 StringRef SectionContents);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000131
Reid Klecknerc31f5302016-01-15 18:06:25 +0000132 void printCodeViewFileChecksums(StringRef Subsection);
133
Reid Klecknere9ab3492016-01-14 19:20:17 +0000134 void printCodeViewInlineeLines(StringRef Subsection);
135
Reid Kleckner2893fd12016-01-14 17:51:54 +0000136 void printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000137 uint32_t RelocOffset, uint32_t Offset,
138 StringRef *RelocSym = nullptr);
139
Eric Beckmann13017592017-06-13 00:16:32 +0000140 uint32_t countTotalTableEntries(ResourceSectionRef RSF,
141 const coff_resource_dir_table &Table,
142 StringRef Level);
143
Eric Beckmannefef15a2017-05-08 02:47:07 +0000144 void printResourceDirectoryTable(ResourceSectionRef RSF,
145 const coff_resource_dir_table &Table,
146 StringRef Level);
147
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000148 void printBinaryBlockWithRelocs(StringRef Label, const SectionRef &Sec,
149 StringRef SectionContents, StringRef Block);
150
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000151 /// Given a .debug$S section, find the string table and file checksum table.
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000152 void initializeFileAndStringTables(BinaryStreamReader &Reader);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000153
Eric Christopher9cad53c2013-04-03 18:31:38 +0000154 void cacheRelocations();
155
Rafael Espindola4453e42942014-06-13 03:07:50 +0000156 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
157 SymbolRef &Sym);
158 std::error_code resolveSymbolName(const coff_section *Section,
159 uint64_t Offset, StringRef &Name);
Reid Kleckner2893fd12016-01-14 17:51:54 +0000160 std::error_code resolveSymbolName(const coff_section *Section,
161 StringRef SectionContents,
162 const void *RelocPtr, StringRef &Name);
Rui Ueyama979fb402014-10-09 02:16:38 +0000163 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +0000164 void printDelayImportedSymbols(
165 const DelayImportDirectoryEntryRef &I,
166 iterator_range<imported_symbol_iterator> Range);
Eric Beckmannefef15a2017-05-08 02:47:07 +0000167 ErrorOr<const coff_resource_dir_entry &>
168 getResourceDirectoryTableEntry(const coff_resource_dir_table &Table,
169 uint32_t Index);
Rui Ueyama15d99352014-10-03 00:41:58 +0000170
Eric Christopher9cad53c2013-04-03 18:31:38 +0000171 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
172
173 const llvm::object::COFFObjectFile *Obj;
Rafael Espindola76d650e2015-07-06 14:26:07 +0000174 bool RelocCached = false;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000175 RelocMapTy RelocMap;
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000176
Zachary Turner591312c2017-05-30 17:13:33 +0000177 DebugChecksumsSubsectionRef CVFileChecksumTable;
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000178
Zachary Turner591312c2017-05-30 17:13:33 +0000179 DebugStringTableSubsectionRef CVStringTable;
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000180
Zachary Turner629cb7d2017-01-11 23:24:22 +0000181 ScopedPrinter &Writer;
Zachary Turner526f4f22017-05-19 19:26:58 +0000182 BinaryByteStream TypeContents;
183 LazyRandomTypeCollection Types;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000184};
185
Zachary Turneraaad5742016-05-23 23:41:13 +0000186class COFFObjectDumpDelegate : public SymbolDumpDelegate {
187public:
188 COFFObjectDumpDelegate(COFFDumper &CD, const SectionRef &SR,
189 const COFFObjectFile *Obj, StringRef SectionContents)
Zachary Turner537014c2016-05-24 03:32:34 +0000190 : CD(CD), SR(SR), SectionContents(SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +0000191 Sec = Obj->getCOFFSection(SR);
192 }
193
Zachary Turner120faca2017-02-27 22:11:43 +0000194 uint32_t getRecordOffset(BinaryStreamReader Reader) override {
Zachary Turner4d49eb92016-10-20 18:31:19 +0000195 ArrayRef<uint8_t> Data;
196 if (auto EC = Reader.readLongestContiguousChunk(Data)) {
197 llvm::consumeError(std::move(EC));
198 return 0;
199 }
200 return Data.data() - SectionContents.bytes_begin();
Zachary Turneraaad5742016-05-23 23:41:13 +0000201 }
202
203 void printRelocatedField(StringRef Label, uint32_t RelocOffset,
204 uint32_t Offset, StringRef *RelocSym) override {
205 CD.printRelocatedField(Label, Sec, RelocOffset, Offset, RelocSym);
206 }
207
208 void printBinaryBlockWithRelocs(StringRef Label,
209 ArrayRef<uint8_t> Block) override {
210 StringRef SBlock(reinterpret_cast<const char *>(Block.data()),
211 Block.size());
212 if (opts::CodeViewSubsectionBytes)
213 CD.printBinaryBlockWithRelocs(Label, SR, SectionContents, SBlock);
214 }
215
216 StringRef getFileNameForFileOffset(uint32_t FileOffset) override {
217 return CD.getFileNameForFileOffset(FileOffset);
218 }
219
Zachary Turner591312c2017-05-30 17:13:33 +0000220 DebugStringTableSubsectionRef getStringTable() override {
221 return CD.CVStringTable;
222 }
Zachary Turneraaad5742016-05-23 23:41:13 +0000223
224private:
225 COFFDumper &CD;
226 const SectionRef &SR;
Zachary Turneraaad5742016-05-23 23:41:13 +0000227 const coff_section *Sec;
228 StringRef SectionContents;
229};
230
Reid Kleckner4a14bca2016-05-05 00:34:33 +0000231} // end namespace
Eric Christopher9cad53c2013-04-03 18:31:38 +0000232
233namespace llvm {
234
Rafael Espindola4453e42942014-06-13 03:07:50 +0000235std::error_code createCOFFDumper(const object::ObjectFile *Obj,
Zachary Turner88bb1632016-05-03 00:28:04 +0000236 ScopedPrinter &Writer,
Rafael Espindola4453e42942014-06-13 03:07:50 +0000237 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000238 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
239 if (!COFFObj)
240 return readobj_error::unsupported_obj_file_format;
241
242 Result.reset(new COFFDumper(COFFObj, Writer));
243 return readobj_error::success;
244}
245
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000246} // namespace llvm
Eric Christopher9cad53c2013-04-03 18:31:38 +0000247
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000248// Given a a section and an offset into this section the function returns the
249// symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000250std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
251 uint64_t Offset, SymbolRef &Sym) {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000252 cacheRelocations();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000253 const auto &Relocations = RelocMap[Section];
David Majnemer61f17982016-05-29 06:18:08 +0000254 auto SymI = Obj->symbol_end();
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000255 for (const auto &Relocation : Relocations) {
Rafael Espindola96d071c2015-06-29 23:29:12 +0000256 uint64_t RelocationOffset = Relocation.getOffset();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000257
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000258 if (RelocationOffset == Offset) {
David Majnemer61f17982016-05-29 06:18:08 +0000259 SymI = Relocation.getSymbol();
260 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000261 }
262 }
David Majnemer61f17982016-05-29 06:18:08 +0000263 if (SymI == Obj->symbol_end())
264 return readobj_error::unknown_symbol;
265 Sym = *SymI;
266 return readobj_error::success;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000267}
268
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000269// Given a section and an offset into this section the function returns the name
270// of the symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000271std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
272 uint64_t Offset,
273 StringRef &Name) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000274 SymbolRef Symbol;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000275 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000276 return EC;
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000277 Expected<StringRef> NameOrErr = Symbol.getName();
278 if (!NameOrErr)
279 return errorToErrorCode(NameOrErr.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000280 Name = *NameOrErr;
Rui Ueyama7d099192015-06-09 15:20:42 +0000281 return std::error_code();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000282}
283
Reid Kleckner2893fd12016-01-14 17:51:54 +0000284// Helper for when you have a pointer to real data and you want to know about
285// relocations against it.
286std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
287 StringRef SectionContents,
288 const void *RelocPtr,
289 StringRef &Name) {
290 assert(SectionContents.data() < RelocPtr &&
291 RelocPtr < SectionContents.data() + SectionContents.size() &&
292 "pointer to relocated object is not in section");
293 uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) -
294 SectionContents.data());
295 return resolveSymbolName(Section, Offset, Name);
296}
297
298void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec,
Zachary Turnera78ecd12016-05-23 18:49:06 +0000299 uint32_t RelocOffset, uint32_t Offset,
300 StringRef *RelocSym) {
301 StringRef SymStorage;
302 StringRef &Symbol = RelocSym ? *RelocSym : SymStorage;
303 if (!resolveSymbolName(Sec, RelocOffset, Symbol))
304 W.printSymbolOffset(Label, Symbol, Offset);
305 else
306 W.printHex(Label, RelocOffset);
307}
308
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000309void COFFDumper::printBinaryBlockWithRelocs(StringRef Label,
310 const SectionRef &Sec,
311 StringRef SectionContents,
312 StringRef Block) {
313 W.printBinaryBlock(Label, Block);
314
315 assert(SectionContents.begin() < Block.begin() &&
316 SectionContents.end() >= Block.end() &&
317 "Block is not contained in SectionContents");
318 uint64_t OffsetStart = Block.data() - SectionContents.data();
319 uint64_t OffsetEnd = OffsetStart + Block.size();
320
Zachary Turneraaad5742016-05-23 23:41:13 +0000321 W.flush();
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +0000322 cacheRelocations();
323 ListScope D(W, "BlockRelocations");
324 const coff_section *Section = Obj->getCOFFSection(Sec);
325 const auto &Relocations = RelocMap[Section];
326 for (const auto &Relocation : Relocations) {
327 uint64_t RelocationOffset = Relocation.getOffset();
328 if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd)
329 printRelocation(Sec, Relocation, OffsetStart);
330 }
331}
332
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000333static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000334 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
335 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
336 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
337 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
Martin Storsjo43c85452017-06-30 07:02:13 +0000338 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM64 ),
Saleem Abdulrasool5e1780e2014-03-11 03:08:37 +0000339 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000340 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
341 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
342 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
343 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
344 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
345 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
346 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
347 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
348 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
349 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
350 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
351 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
352 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
353 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
354 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
355 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
356};
357
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000358static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000359 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
360 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
361 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
362 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
363 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
364 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
365 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
366 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
367 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
368 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
369 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
370 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
371 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
372 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
373 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
374};
375
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000376static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000377 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
378 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
379 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
380 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
381 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
382 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
383 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
384 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
385 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
386 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
387 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
388};
389
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000390static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
Rui Ueyama06dc5e72014-01-27 04:22:24 +0000391 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000392 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
393 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
394 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
395 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
396 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
397 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000398 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000399 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000400 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000401 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
402};
403
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000404static const EnumEntry<COFF::SectionCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000405ImageSectionCharacteristics[] = {
David Majnemerd3238882015-07-30 16:47:56 +0000406 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000407 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
408 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
409 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
410 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
411 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
412 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
413 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
414 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
415 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
416 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
417 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
418 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
419 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
420 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
421 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
422 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
423 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
424 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
425 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
426 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
427 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
428 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
429 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
430 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
431 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
432 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
433 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
434 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
435 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
436 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
437 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
438 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
439 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
440 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
441 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
442};
443
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000444static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000445 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
446 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
447 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
448 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
449 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
450 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
451 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
452 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
453 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
454 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
455 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
456 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
457 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
458 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
459 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
460 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
461};
462
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000463static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000464 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
465 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
466 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
467 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
468};
469
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000470static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000471 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
472 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
473 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
474 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
475 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
476 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
477 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
478 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
479 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
480 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
481 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
482 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
483 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
484 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
485 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
486 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
487 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
488 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
489 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
490 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
491 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
492 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
493 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
494 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
495 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
496 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
497 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
498};
499
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000500static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000501 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
502 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
503 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
504 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
505 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
506 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
507 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
508};
509
Reid Kleckner2da433e2016-06-02 17:10:43 +0000510static const EnumEntry<COFF::DebugType> ImageDebugType[] = {
511 { "Unknown" , COFF::IMAGE_DEBUG_TYPE_UNKNOWN },
512 { "COFF" , COFF::IMAGE_DEBUG_TYPE_COFF },
513 { "CodeView" , COFF::IMAGE_DEBUG_TYPE_CODEVIEW },
514 { "FPO" , COFF::IMAGE_DEBUG_TYPE_FPO },
515 { "Misc" , COFF::IMAGE_DEBUG_TYPE_MISC },
516 { "Exception" , COFF::IMAGE_DEBUG_TYPE_EXCEPTION },
517 { "Fixup" , COFF::IMAGE_DEBUG_TYPE_FIXUP },
518 { "OmapToSrc" , COFF::IMAGE_DEBUG_TYPE_OMAP_TO_SRC },
519 { "OmapFromSrc", COFF::IMAGE_DEBUG_TYPE_OMAP_FROM_SRC },
520 { "Borland" , COFF::IMAGE_DEBUG_TYPE_BORLAND },
David Majnemera2a2a732016-06-02 17:32:11 +0000521 { "Reserved10" , COFF::IMAGE_DEBUG_TYPE_RESERVED10 },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000522 { "CLSID" , COFF::IMAGE_DEBUG_TYPE_CLSID },
523 { "VCFeature" , COFF::IMAGE_DEBUG_TYPE_VC_FEATURE },
524 { "POGO" , COFF::IMAGE_DEBUG_TYPE_POGO },
525 { "ILTCG" , COFF::IMAGE_DEBUG_TYPE_ILTCG },
526 { "MPX" , COFF::IMAGE_DEBUG_TYPE_MPX },
David Majnemera2a2a732016-06-02 17:32:11 +0000527 { "Repro" , COFF::IMAGE_DEBUG_TYPE_REPRO },
Reid Kleckner2da433e2016-06-02 17:10:43 +0000528};
529
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000530static const EnumEntry<COFF::WeakExternalCharacteristics>
Eric Christopher9cad53c2013-04-03 18:31:38 +0000531WeakExternalCharacteristics[] = {
532 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
533 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
534 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
535};
536
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000537static const EnumEntry<uint32_t> SubSectionTypes[] = {
Zachary Turner8c099fe2017-05-30 16:36:15 +0000538 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, Symbols),
539 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, Lines),
540 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, StringTable),
541 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, FileChecksums),
542 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, FrameData),
543 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, InlineeLines),
544 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, CrossScopeImports),
545 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, CrossScopeExports),
546 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, ILLines),
547 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, FuncMDTokenMap),
548 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, TypeMDTokenMap),
549 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, MergedAssemblyInput),
550 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, CoffSymbolRVA),
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000551};
552
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000553static const EnumEntry<uint32_t> FrameDataFlags[] = {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000554 LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH),
555 LLVM_READOBJ_ENUM_ENT(FrameData, HasEH),
556 LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart),
557};
558
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000559static const EnumEntry<uint8_t> FileChecksumKindNames[] = {
Reid Klecknerc31f5302016-01-15 18:06:25 +0000560 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, None),
561 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, MD5),
562 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA1),
563 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA256),
564};
565
Eric Beckmannefef15a2017-05-08 02:47:07 +0000566static const EnumEntry<COFF::ResourceTypeID> ResourceTypeNames[]{
567 {"kRT_CURSOR (ID 1)", COFF::RID_Cursor},
568 {"kRT_BITMAP (ID 2)", COFF::RID_Bitmap},
569 {"kRT_ICON (ID 3)", COFF::RID_Icon},
570 {"kRT_MENU (ID 4)", COFF::RID_Menu},
571 {"kRT_DIALOG (ID 5)", COFF::RID_Dialog},
572 {"kRT_STRING (ID 6)", COFF::RID_String},
573 {"kRT_FONTDIR (ID 7)", COFF::RID_FontDir},
574 {"kRT_FONT (ID 8)", COFF::RID_Font},
575 {"kRT_ACCELERATOR (ID 9)", COFF::RID_Accelerator},
576 {"kRT_RCDATA (ID 10)", COFF::RID_RCData},
577 {"kRT_MESSAGETABLE (ID 11)", COFF::RID_MessageTable},
578 {"kRT_GROUP_CURSOR (ID 12)", COFF::RID_Group_Cursor},
579 {"kRT_GROUP_ICON (ID 14)", COFF::RID_Group_Icon},
580 {"kRT_VERSION (ID 16)", COFF::RID_Version},
581 {"kRT_DLGINCLUDE (ID 17)", COFF::RID_DLGInclude},
582 {"kRT_PLUGPLAY (ID 19)", COFF::RID_PlugPlay},
583 {"kRT_VXD (ID 20)", COFF::RID_VXD},
584 {"kRT_ANICURSOR (ID 21)", COFF::RID_AniCursor},
585 {"kRT_ANIICON (ID 22)", COFF::RID_AniIcon},
586 {"kRT_HTML (ID 23)", COFF::RID_HTML},
587 {"kRT_MANIFEST (ID 24)", COFF::RID_Manifest}};
588
Rafael Espindola4453e42942014-06-13 03:07:50 +0000589template <typename T>
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +0000590static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
David Majnemer44f51e52014-09-10 12:51:52 +0000591 COFFSymbolRef Symbol,
592 uint8_t AuxSymbolIdx, const T *&Aux) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000593 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
David Majnemer44f51e52014-09-10 12:51:52 +0000594 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000595 Aux = reinterpret_cast<const T*>(AuxData.data());
596 return readobj_error::success;
597}
598
Eric Christopher9cad53c2013-04-03 18:31:38 +0000599void COFFDumper::cacheRelocations() {
Rafael Espindola76d650e2015-07-06 14:26:07 +0000600 if (RelocCached)
601 return;
602 RelocCached = true;
603
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000604 for (const SectionRef &S : Obj->sections()) {
605 const coff_section *Section = Obj->getCOFFSection(S);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000606
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000607 for (const RelocationRef &Reloc : S.relocations())
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000608 RelocMap[Section].push_back(Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000609
610 // Sort relocations by address.
611 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
612 relocAddressLess);
613 }
614}
615
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000616void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
617 const data_directory *Data;
618 if (Obj->getDataDirectory(Index, Data))
619 return;
620 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
621 W.printHex(FieldName + "Size", Data->Size);
622}
623
Eric Christopher9cad53c2013-04-03 18:31:38 +0000624void COFFDumper::printFileHeaders() {
David Majnemer44f51e52014-09-10 12:51:52 +0000625 time_t TDS = Obj->getTimeDateStamp();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000626 char FormattedTime[20] = { };
627 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
628
629 {
630 DictScope D(W, "ImageFileHeader");
David Majnemer44f51e52014-09-10 12:51:52 +0000631 W.printEnum ("Machine", Obj->getMachine(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000632 makeArrayRef(ImageFileMachineType));
David Majnemer44f51e52014-09-10 12:51:52 +0000633 W.printNumber("SectionCount", Obj->getNumberOfSections());
634 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
635 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
636 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
637 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
638 W.printFlags ("Characteristics", Obj->getCharacteristics(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000639 makeArrayRef(ImageFileCharacteristics));
640 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000641
642 // Print PE header. This header does not exist if this is an object file and
643 // not an executable.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000644 const pe32_header *PEHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000645 error(Obj->getPE32Header(PEHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000646 if (PEHeader)
647 printPEHeader<pe32_header>(PEHeader);
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000648
Craig Toppere6cb63e2014-04-25 04:24:47 +0000649 const pe32plus_header *PEPlusHeader = nullptr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000650 error(Obj->getPE32PlusHeader(PEPlusHeader));
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000651 if (PEPlusHeader)
652 printPEHeader<pe32plus_header>(PEPlusHeader);
David Majnemer50267222014-11-05 06:24:35 +0000653
654 if (const dos_header *DH = Obj->getDOSHeader())
655 printDOSHeader(DH);
656}
657
658void COFFDumper::printDOSHeader(const dos_header *DH) {
659 DictScope D(W, "DOSHeader");
660 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
661 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
662 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
663 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
664 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
665 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
666 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
667 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
668 W.printNumber("InitialSP", DH->InitialSP);
669 W.printNumber("Checksum", DH->Checksum);
670 W.printNumber("InitialIP", DH->InitialIP);
671 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
672 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
673 W.printNumber("OverlayNumber", DH->OverlayNumber);
674 W.printNumber("OEMid", DH->OEMid);
675 W.printNumber("OEMinfo", DH->OEMinfo);
676 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000677}
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000678
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000679template <class PEHeader>
680void COFFDumper::printPEHeader(const PEHeader *Hdr) {
681 DictScope D(W, "ImageOptionalHeader");
Martin Storsjo8ae07ac2017-06-30 07:02:04 +0000682 W.printHex ("Magic", Hdr->Magic);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000683 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
684 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
685 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
686 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
687 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
688 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
689 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
690 printBaseOfDataField(Hdr);
691 W.printHex ("ImageBase", Hdr->ImageBase);
692 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
693 W.printNumber("FileAlignment", Hdr->FileAlignment);
694 W.printNumber("MajorOperatingSystemVersion",
695 Hdr->MajorOperatingSystemVersion);
696 W.printNumber("MinorOperatingSystemVersion",
697 Hdr->MinorOperatingSystemVersion);
698 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
699 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
700 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
701 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
702 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
703 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
704 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
David Majnemer774aadf2014-11-18 02:45:28 +0000705 W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000706 makeArrayRef(PEDLLCharacteristics));
707 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
708 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
709 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
710 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
711 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000712
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000713 if (Hdr->NumberOfRvaAndSize > 0) {
714 DictScope D(W, "DataDirectory");
715 static const char * const directory[] = {
716 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
717 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
718 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
719 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
720 };
721
Reid Kleckner2da433e2016-06-02 17:10:43 +0000722 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i)
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000723 printDataDirectory(i, directory[i]);
Reid Kleckner2da433e2016-06-02 17:10:43 +0000724 }
725}
726
727void COFFDumper::printCOFFDebugDirectory() {
728 ListScope LS(W, "DebugDirectory");
729 for (const debug_directory &D : Obj->debug_directories()) {
730 char FormattedTime[20] = {};
731 time_t TDS = D.TimeDateStamp;
732 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
733 DictScope S(W, "DebugEntry");
734 W.printHex("Characteristics", D.Characteristics);
735 W.printHex("TimeDateStamp", FormattedTime, D.TimeDateStamp);
736 W.printHex("MajorVersion", D.MajorVersion);
737 W.printHex("MinorVersion", D.MinorVersion);
738 W.printEnum("Type", D.Type, makeArrayRef(ImageDebugType));
739 W.printHex("SizeOfData", D.SizeOfData);
740 W.printHex("AddressOfRawData", D.AddressOfRawData);
741 W.printHex("PointerToRawData", D.PointerToRawData);
742 if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW) {
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000743 const codeview::DebugInfo *DebugInfo;
Reid Kleckner2da433e2016-06-02 17:10:43 +0000744 StringRef PDBFileName;
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000745 error(Obj->getDebugPDBInfo(&D, DebugInfo, PDBFileName));
Reid Kleckner2da433e2016-06-02 17:10:43 +0000746 DictScope PDBScope(W, "PDBInfo");
Saleem Abdulrasool01528022016-08-09 00:25:12 +0000747 W.printHex("PDBSignature", DebugInfo->Signature.CVSignature);
748 if (DebugInfo->Signature.CVSignature == OMF::Signature::PDB70) {
749 W.printBinary("PDBGUID", makeArrayRef(DebugInfo->PDB70.Signature));
750 W.printNumber("PDBAge", DebugInfo->PDB70.Age);
751 W.printString("PDBFileName", PDBFileName);
752 }
Reid Kleckner2da433e2016-06-02 17:10:43 +0000753 } else {
754 // FIXME: Type values of 12 and 13 are commonly observed but are not in
755 // the documented type enum. Figure out what they mean.
756 ArrayRef<uint8_t> RawData;
757 error(
758 Obj->getRvaAndSizeAsBytes(D.AddressOfRawData, D.SizeOfData, RawData));
759 W.printBinaryBlock("RawData", RawData);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000760 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000761 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000762}
763
Reid Klecknerb7d716c2017-06-22 01:10:29 +0000764void COFFDumper::printRVATable(uint64_t TableVA, uint64_t Count,
765 uint64_t EntrySize, PrintExtraCB PrintExtra) {
766 uintptr_t TableStart, TableEnd;
767 error(Obj->getVaPtr(TableVA, TableStart));
Reid Kleckner45cb4fe2017-06-23 22:12:11 +0000768 error(Obj->getVaPtr(TableVA + Count * EntrySize - 1, TableEnd));
769 TableEnd++;
Reid Klecknerb7d716c2017-06-22 01:10:29 +0000770 for (uintptr_t I = TableStart; I < TableEnd; I += EntrySize) {
771 uint32_t RVA = *reinterpret_cast<const ulittle32_t *>(I);
772 raw_ostream &OS = W.startLine();
773 OS << "0x" << utohexstr(Obj->getImageBase() + RVA);
774 if (PrintExtra)
775 PrintExtra(OS, reinterpret_cast<const uint8_t *>(I));
776 OS << '\n';
777 }
778}
779
780void COFFDumper::printCOFFLoadConfig() {
781 LoadConfigTables Tables;
782 if (Obj->is64())
783 printCOFFLoadConfig(Obj->getLoadConfig64(), Tables);
784 else
785 printCOFFLoadConfig(Obj->getLoadConfig32(), Tables);
786
787 if (Tables.SEHTableVA) {
788 ListScope LS(W, "SEHTable");
789 printRVATable(Tables.SEHTableVA, Tables.SEHTableCount, 4);
790 }
791
792 if (Tables.GuardFidTableVA) {
793 ListScope LS(W, "GuardFidTable");
794 if (Tables.GuardFlags & uint32_t(coff_guard_flags::FidTableHasFlags)) {
795 auto PrintGuardFlags = [](raw_ostream &OS, const uint8_t *Entry) {
796 uint8_t Flags = *reinterpret_cast<const uint8_t *>(Entry + 4);
797 if (Flags)
798 OS << " flags " << utohexstr(Flags);
799 };
800 printRVATable(Tables.GuardFidTableVA, Tables.GuardFidTableCount, 5,
801 PrintGuardFlags);
802 } else {
803 printRVATable(Tables.GuardFidTableVA, Tables.GuardFidTableCount, 4);
804 }
805 }
806}
807
808template <typename T>
809void COFFDumper::printCOFFLoadConfig(const T *Conf, LoadConfigTables &Tables) {
Reid Kleckner45cb4fe2017-06-23 22:12:11 +0000810 if (!Conf)
811 return;
812
Reid Klecknerb7d716c2017-06-22 01:10:29 +0000813 ListScope LS(W, "LoadConfig");
814 char FormattedTime[20] = {};
815 time_t TDS = Conf->TimeDateStamp;
816 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
817 W.printHex("Size", Conf->Size);
818
819 // Print everything before SecurityCookie. The vast majority of images today
820 // have all these fields.
821 if (Conf->Size < offsetof(T, SEHandlerTable))
822 return;
823 W.printHex("TimeDateStamp", FormattedTime, TDS);
824 W.printHex("MajorVersion", Conf->MajorVersion);
825 W.printHex("MinorVersion", Conf->MinorVersion);
826 W.printHex("GlobalFlagsClear", Conf->GlobalFlagsClear);
827 W.printHex("GlobalFlagsSet", Conf->GlobalFlagsSet);
828 W.printHex("CriticalSectionDefaultTimeout",
829 Conf->CriticalSectionDefaultTimeout);
830 W.printHex("DeCommitFreeBlockThreshold", Conf->DeCommitFreeBlockThreshold);
831 W.printHex("DeCommitTotalFreeThreshold", Conf->DeCommitTotalFreeThreshold);
832 W.printHex("LockPrefixTable", Conf->LockPrefixTable);
833 W.printHex("MaximumAllocationSize", Conf->MaximumAllocationSize);
834 W.printHex("VirtualMemoryThreshold", Conf->VirtualMemoryThreshold);
835 W.printHex("ProcessHeapFlags", Conf->ProcessHeapFlags);
836 W.printHex("ProcessAffinityMask", Conf->ProcessAffinityMask);
837 W.printHex("CSDVersion", Conf->CSDVersion);
838 W.printHex("DependentLoadFlags", Conf->DependentLoadFlags);
839 W.printHex("EditList", Conf->EditList);
840 W.printHex("SecurityCookie", Conf->SecurityCookie);
841
842 // Print the safe SEH table if present.
843 if (Conf->Size < offsetof(coff_load_configuration32, GuardCFCheckFunction))
844 return;
845 W.printHex("SEHandlerTable", Conf->SEHandlerTable);
846 W.printNumber("SEHandlerCount", Conf->SEHandlerCount);
847
848 Tables.SEHTableVA = Conf->SEHandlerTable;
849 Tables.SEHTableCount = Conf->SEHandlerCount;
850
851 // Print everything before CodeIntegrity. (2015)
852 if (Conf->Size < offsetof(T, CodeIntegrity))
853 return;
854 W.printHex("GuardCFCheckFunction", Conf->GuardCFCheckFunction);
855 W.printHex("GuardCFCheckDispatch", Conf->GuardCFCheckDispatch);
856 W.printHex("GuardCFFunctionTable", Conf->GuardCFFunctionTable);
857 W.printNumber("GuardCFFunctionCount", Conf->GuardCFFunctionCount);
858 W.printHex("GuardFlags", Conf->GuardFlags);
859
860 Tables.GuardFidTableVA = Conf->GuardCFFunctionTable;
861 Tables.GuardFidTableCount = Conf->GuardCFFunctionCount;
862 Tables.GuardFlags = Conf->GuardFlags;
863
864 // Print the rest. (2017)
865 if (Conf->Size < sizeof(T))
866 return;
867 W.printHex("GuardAddressTakenIatEntryTable",
868 Conf->GuardAddressTakenIatEntryTable);
869 W.printNumber("GuardAddressTakenIatEntryCount",
870 Conf->GuardAddressTakenIatEntryCount);
871 W.printHex("GuardLongJumpTargetTable", Conf->GuardLongJumpTargetTable);
872 W.printNumber("GuardLongJumpTargetCount", Conf->GuardLongJumpTargetCount);
873 W.printHex("DynamicValueRelocTable", Conf->DynamicValueRelocTable);
874 W.printHex("CHPEMetadataPointer", Conf->CHPEMetadataPointer);
875 W.printHex("GuardRFFailureRoutine", Conf->GuardRFFailureRoutine);
876 W.printHex("GuardRFFailureRoutineFunctionPointer",
877 Conf->GuardRFFailureRoutineFunctionPointer);
878 W.printHex("DynamicValueRelocTableOffset",
879 Conf->DynamicValueRelocTableOffset);
880 W.printNumber("DynamicValueRelocTableSection",
881 Conf->DynamicValueRelocTableSection);
882 W.printHex("GuardRFVerifyStackPointerFunctionPointer",
883 Conf->GuardRFVerifyStackPointerFunctionPointer);
884 W.printHex("HotPatchTableOffset", Conf->HotPatchTableOffset);
885}
886
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000887void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
888 W.printHex("BaseOfData", Hdr->BaseOfData);
889}
890
891void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
892
Reid Kleckner83ebad32015-12-16 18:28:12 +0000893void COFFDumper::printCodeViewDebugInfo() {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000894 // Print types first to build CVUDTNames, then print symbols.
Reid Kleckner83ebad32015-12-16 18:28:12 +0000895 for (const SectionRef &S : Obj->sections()) {
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000896 StringRef SectionName;
897 error(S.getName(SectionName));
898 if (SectionName == ".debug$T")
899 printCodeViewTypeSection(SectionName, S);
900 }
901 for (const SectionRef &S : Obj->sections()) {
902 StringRef SectionName;
903 error(S.getName(SectionName));
904 if (SectionName == ".debug$S")
905 printCodeViewSymbolSection(SectionName, S);
Reid Kleckner83ebad32015-12-16 18:28:12 +0000906 }
907}
908
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000909void COFFDumper::initializeFileAndStringTables(BinaryStreamReader &Reader) {
910 while (Reader.bytesRemaining() > 0 &&
911 (!CVFileChecksumTable.valid() || !CVStringTable.valid())) {
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000912 // The section consists of a number of subsection in the following format:
913 // |SubSectionType|SubSectionSize|Contents...|
914 uint32_t SubType, SubSectionSize;
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000915 error(Reader.readInteger(SubType));
916 error(Reader.readInteger(SubSectionSize));
917
918 StringRef Contents;
919 error(Reader.readFixedString(Contents, SubSectionSize));
920
Zachary Turner591312c2017-05-30 17:13:33 +0000921 BinaryStreamRef ST(Contents, support::little);
Zachary Turner8c099fe2017-05-30 16:36:15 +0000922 switch (DebugSubsectionKind(SubType)) {
Zachary Turner591312c2017-05-30 17:13:33 +0000923 case DebugSubsectionKind::FileChecksums:
924 error(CVFileChecksumTable.initialize(ST));
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000925 break;
Zachary Turner591312c2017-05-30 17:13:33 +0000926 case DebugSubsectionKind::StringTable:
Zachary Turnerd9a62632017-05-17 20:23:31 +0000927 error(CVStringTable.initialize(ST));
Zachary Turner591312c2017-05-30 17:13:33 +0000928 break;
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000929 default:
930 break;
931 }
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000932
David Majnemerefaaf412016-05-28 20:04:48 +0000933 uint32_t PaddedSize = alignTo(SubSectionSize, 4);
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000934 error(Reader.skip(PaddedSize - SubSectionSize));
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000935 }
936}
937
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000938void COFFDumper::printCodeViewSymbolSection(StringRef SectionName,
939 const SectionRef &Section) {
940 StringRef SectionContents;
941 error(Section.getContents(SectionContents));
942 StringRef Data = SectionContents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000943
944 SmallVector<StringRef, 10> FunctionNames;
945 StringMap<StringRef> FunctionLineTables;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000946
Zachary Turner99f02152015-02-18 19:32:05 +0000947 ListScope D(W, "CodeViewDebugInfo");
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000948 // Print the section to allow correlation with printSections.
949 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000950
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000951 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000952 error(consume(Data, Magic));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000953 W.printHex("Magic", Magic);
954 if (Magic != COFF::DEBUG_SECTION_MAGIC)
955 return error(object_error::parse_failed);
956
Zachary Turnerd9a62632017-05-17 20:23:31 +0000957 BinaryStreamReader FSReader(Data, support::little);
Zachary Turner2d5c2cd2017-05-03 17:11:11 +0000958 initializeFileAndStringTables(FSReader);
Reid Kleckner8e7275c2016-01-15 00:11:21 +0000959
Zachary Turnera96cce62016-06-03 03:25:59 +0000960 // TODO: Convert this over to using ModuleSubstreamVisitor.
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000961 while (!Data.empty()) {
962 // The section consists of a number of subsection in the following format:
963 // |SubSectionType|SubSectionSize|Contents...|
964 uint32_t SubType, SubSectionSize;
Zachary Turner38cc8b32016-05-12 17:45:44 +0000965 error(consume(Data, SubType));
966 error(consume(Data, SubSectionSize));
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000967
968 ListScope S(W, "Subsection");
969 W.printEnum("SubSectionType", SubType, makeArrayRef(SubSectionTypes));
970 W.printHex("SubSectionSize", SubSectionSize);
971
972 // Get the contents of the subsection.
973 if (SubSectionSize > Data.size())
974 return error(object_error::parse_failed);
975 StringRef Contents = Data.substr(0, SubSectionSize);
976
977 // Add SubSectionSize to the current offset and align that offset to find
978 // the next subsection.
979 size_t SectionOffset = Data.data() - SectionContents.data();
980 size_t NextOffset = SectionOffset + SubSectionSize;
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000981 NextOffset = alignTo(NextOffset, 4);
David Majnemercab2b462016-05-28 20:04:50 +0000982 if (NextOffset > SectionContents.size())
983 return error(object_error::parse_failed);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000984 Data = SectionContents.drop_front(NextOffset);
985
986 // Optionally print the subsection bytes in case our parsing gets confused
987 // later.
988 if (opts::CodeViewSubsectionBytes)
Reid Kleckneraf49ecb2016-01-15 22:09:13 +0000989 printBinaryBlockWithRelocs("SubSectionContents", Section, SectionContents,
990 Contents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000991
Zachary Turner8c099fe2017-05-30 16:36:15 +0000992 switch (DebugSubsectionKind(SubType)) {
993 case DebugSubsectionKind::Symbols:
Reid Kleckner2893fd12016-01-14 17:51:54 +0000994 printCodeViewSymbolsSubsection(Contents, Section, SectionContents);
Reid Kleckner72e2ba72016-01-13 19:32:35 +0000995 break;
Reid Klecknere9ab3492016-01-14 19:20:17 +0000996
Zachary Turner8c099fe2017-05-30 16:36:15 +0000997 case DebugSubsectionKind::InlineeLines:
Reid Klecknere9ab3492016-01-14 19:20:17 +0000998 printCodeViewInlineeLines(Contents);
999 break;
1000
Zachary Turner8c099fe2017-05-30 16:36:15 +00001001 case DebugSubsectionKind::FileChecksums:
Reid Klecknerc31f5302016-01-15 18:06:25 +00001002 printCodeViewFileChecksums(Contents);
1003 break;
1004
Zachary Turner8c099fe2017-05-30 16:36:15 +00001005 case DebugSubsectionKind::Lines: {
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001006 // Holds a PC to file:line table. Some data to parse this subsection is
1007 // stored in the other subsections, so just check sanity and store the
1008 // pointers for deferred processing.
1009
1010 if (SubSectionSize < 12) {
1011 // There should be at least three words to store two function
1012 // relocations and size of the code.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001013 error(object_error::parse_failed);
1014 return;
1015 }
1016
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001017 StringRef LinkageName;
1018 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset,
1019 LinkageName));
1020 W.printString("LinkageName", LinkageName);
1021 if (FunctionLineTables.count(LinkageName) != 0) {
1022 // Saw debug info for this function already?
1023 error(object_error::parse_failed);
1024 return;
Zachary Turner99f02152015-02-18 19:32:05 +00001025 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001026
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001027 FunctionLineTables[LinkageName] = Contents;
1028 FunctionNames.push_back(LinkageName);
1029 break;
1030 }
Zachary Turner8c099fe2017-05-30 16:36:15 +00001031 case DebugSubsectionKind::FrameData: {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001032 // First four bytes is a relocation against the function.
Zachary Turnerd9a62632017-05-17 20:23:31 +00001033 BinaryStreamReader SR(Contents, llvm::support::little);
Zachary Turner591312c2017-05-30 17:13:33 +00001034
1035 DebugFrameDataSubsectionRef FrameData;
1036 error(FrameData.initialize(SR));
1037
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001038 StringRef LinkageName;
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001039 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionContents,
Zachary Turner591312c2017-05-30 17:13:33 +00001040 FrameData.getRelocPtr(), LinkageName));
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001041 W.printString("LinkageName", LinkageName);
1042
1043 // To find the active frame description, search this array for the
1044 // smallest PC range that includes the current PC.
Zachary Turner591312c2017-05-30 17:13:33 +00001045 for (const auto &FD : FrameData) {
1046 StringRef FrameFunc = error(CVStringTable.getString(FD.FrameFunc));
David Majnemera6d93fd2016-05-28 19:45:49 +00001047
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001048 DictScope S(W, "FrameData");
Zachary Turner591312c2017-05-30 17:13:33 +00001049 W.printHex("RvaStart", FD.RvaStart);
1050 W.printHex("CodeSize", FD.CodeSize);
1051 W.printHex("LocalSize", FD.LocalSize);
1052 W.printHex("ParamsSize", FD.ParamsSize);
1053 W.printHex("MaxStackSize", FD.MaxStackSize);
David Majnemera6d93fd2016-05-28 19:45:49 +00001054 W.printString("FrameFunc", FrameFunc);
Zachary Turner591312c2017-05-30 17:13:33 +00001055 W.printHex("PrologSize", FD.PrologSize);
1056 W.printHex("SavedRegsSize", FD.SavedRegsSize);
1057 W.printFlags("Flags", FD.Flags, makeArrayRef(FrameDataFlags));
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001058 }
1059 break;
1060 }
1061
1062 // Do nothing for unrecognized subsections.
1063 default:
1064 break;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001065 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001066 W.flush();
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001067 }
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
Zachary Turnerd9a62632017-05-17 20:23:31 +00001076 BinaryStreamReader Reader(FunctionLineTables[Name], support::little);
David Majnemer0373d532015-07-09 18:14:31 +00001077
Zachary Turner8c099fe2017-05-30 16:36:15 +00001078 DebugLinesSubsectionRef LineInfo;
Zachary Turner05bd9f32017-04-28 23:41:36 +00001079 error(LineInfo.initialize(Reader));
David Majnemer04948362016-01-13 01:05:16 +00001080
Zachary Turner05bd9f32017-04-28 23:41:36 +00001081 W.printHex("Flags", LineInfo.header()->Flags);
1082 W.printHex("CodeSize", LineInfo.header()->CodeSize);
1083 for (const auto &Entry : LineInfo) {
Justin Bognera1413db2015-07-09 04:27:36 +00001084
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001085 ListScope S(W, "FilenameSegment");
Zachary Turner05bd9f32017-04-28 23:41:36 +00001086 printFileNameForOffset("Filename", Entry.NameIndex);
Zachary Turner4346ae12017-04-29 00:03:32 +00001087 uint32_t ColumnIndex = 0;
Zachary Turner05bd9f32017-04-28 23:41:36 +00001088 for (const auto &Line : Entry.LineNumbers) {
1089 if (Line.Offset >= LineInfo.header()->CodeSize) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001090 error(object_error::parse_failed);
1091 return;
1092 }
Zachary Turner05bd9f32017-04-28 23:41:36 +00001093
1094 std::string PC = formatv("+{0:X}", uint32_t(Line.Offset));
1095 ListScope PCScope(W, PC);
1096 codeview::LineInfo LI(Line.Flags);
1097
David Majnemera4859df2016-02-04 17:57:12 +00001098 if (LI.isAlwaysStepInto())
1099 W.printString("StepInto", StringRef("Always"));
1100 else if (LI.isNeverStepInto())
1101 W.printString("StepInto", StringRef("Never"));
1102 else
1103 W.printNumber("LineNumberStart", LI.getStartLine());
1104 W.printNumber("LineNumberEndDelta", LI.getLineDelta());
1105 W.printBoolean("IsStatement", LI.isStatement());
Zachary Turner5b6e4e02017-04-29 01:13:21 +00001106 if (LineInfo.hasColumnInfo()) {
Zachary Turner4346ae12017-04-29 00:03:32 +00001107 W.printNumber("ColStart", Entry.Columns[ColumnIndex].StartColumn);
1108 W.printNumber("ColEnd", Entry.Columns[ColumnIndex].EndColumn);
1109 ++ColumnIndex;
David Majnemer04948362016-01-13 01:05:16 +00001110 }
1111 }
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +00001112 }
1113 }
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001114}
1115
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001116void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
1117 const SectionRef &Section,
Reid Kleckner2893fd12016-01-14 17:51:54 +00001118 StringRef SectionContents) {
Zachary Turneraaad5742016-05-23 23:41:13 +00001119 ArrayRef<uint8_t> BinaryData(Subsection.bytes_begin(),
1120 Subsection.bytes_end());
1121 auto CODD = llvm::make_unique<COFFObjectDumpDelegate>(*this, Section, Obj,
1122 SectionContents);
Zachary Turnerebd3ae82017-06-01 21:52:41 +00001123 CVSymbolDumper CVSD(W, Types, CodeViewContainer::ObjectFile, std::move(CODD),
1124 opts::CodeViewSubsectionBytes);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001125 CVSymbolArray Symbols;
Zachary Turnerd9a62632017-05-17 20:23:31 +00001126 BinaryStreamReader Reader(BinaryData, llvm::support::little);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001127 if (auto EC = Reader.readArray(Symbols, Reader.getLength())) {
1128 consumeError(std::move(EC));
1129 W.flush();
1130 error(object_error::parse_failed);
1131 }
Reid Kleckner2893fd12016-01-14 17:51:54 +00001132
Zachary Turner0d840742016-10-07 21:34:46 +00001133 if (auto EC = CVSD.dump(Symbols)) {
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001134 W.flush();
Zachary Turner0d840742016-10-07 21:34:46 +00001135 error(std::move(EC));
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001136 }
Reid Kleckneraf49ecb2016-01-15 22:09:13 +00001137 W.flush();
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001138}
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001139
Reid Klecknerc31f5302016-01-15 18:06:25 +00001140void COFFDumper::printCodeViewFileChecksums(StringRef Subsection) {
Zachary Turner591312c2017-05-30 17:13:33 +00001141 BinaryStreamRef Stream(Subsection, llvm::support::little);
Zachary Turner8c099fe2017-05-30 16:36:15 +00001142 DebugChecksumsSubsectionRef Checksums;
Zachary Turner591312c2017-05-30 17:13:33 +00001143 error(Checksums.initialize(Stream));
Zachary Turnerc37cb0c2017-04-27 16:12:16 +00001144
1145 for (auto &FC : Checksums) {
Reid Klecknerc31f5302016-01-15 18:06:25 +00001146 DictScope S(W, "FileChecksum");
Zachary Turnerc37cb0c2017-04-27 16:12:16 +00001147
Zachary Turner2d5c2cd2017-05-03 17:11:11 +00001148 StringRef Filename = error(CVStringTable.getString(FC.FileNameOffset));
Zachary Turnerc37cb0c2017-04-27 16:12:16 +00001149 W.printHex("Filename", Filename, FC.FileNameOffset);
1150 W.printHex("ChecksumSize", FC.Checksum.size());
1151 W.printEnum("ChecksumKind", uint8_t(FC.Kind),
Reid Klecknerc31f5302016-01-15 18:06:25 +00001152 makeArrayRef(FileChecksumKindNames));
Zachary Turnerc37cb0c2017-04-27 16:12:16 +00001153
1154 W.printBinary("ChecksumBytes", FC.Checksum);
Reid Klecknerc31f5302016-01-15 18:06:25 +00001155 }
1156}
1157
Reid Klecknere9ab3492016-01-14 19:20:17 +00001158void COFFDumper::printCodeViewInlineeLines(StringRef Subsection) {
Zachary Turnerd9a62632017-05-17 20:23:31 +00001159 BinaryStreamReader SR(Subsection, llvm::support::little);
Zachary Turner8c099fe2017-05-30 16:36:15 +00001160 DebugInlineeLinesSubsectionRef Lines;
Zachary Turneredef1452017-05-02 16:56:09 +00001161 error(Lines.initialize(SR));
Reid Klecknere9ab3492016-01-14 19:20:17 +00001162
Zachary Turneredef1452017-05-02 16:56:09 +00001163 for (auto &Line : Lines) {
Reid Klecknere9ab3492016-01-14 19:20:17 +00001164 DictScope S(W, "InlineeSourceLine");
Zachary Turneredef1452017-05-02 16:56:09 +00001165 printTypeIndex("Inlinee", Line.Header->Inlinee);
1166 printFileNameForOffset("FileID", Line.Header->FileID);
1167 W.printNumber("SourceLineNum", Line.Header->SourceLineNum);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001168
Zachary Turneredef1452017-05-02 16:56:09 +00001169 if (Lines.hasExtraFiles()) {
1170 W.printNumber("ExtraFileCount", Line.ExtraFiles.size());
Reid Klecknere9ab3492016-01-14 19:20:17 +00001171 ListScope ExtraFiles(W, "ExtraFiles");
Zachary Turneredef1452017-05-02 16:56:09 +00001172 for (const auto &FID : Line.ExtraFiles) {
1173 printFileNameForOffset("FileID", FID);
Reid Klecknere9ab3492016-01-14 19:20:17 +00001174 }
1175 }
1176 }
1177}
1178
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001179StringRef COFFDumper::getFileNameForFileOffset(uint32_t FileOffset) {
1180 // The file checksum subsection should precede all references to it.
Zachary Turner2d5c2cd2017-05-03 17:11:11 +00001181 if (!CVFileChecksumTable.valid() || !CVStringTable.valid())
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001182 error(object_error::parse_failed);
Zachary Turner2d5c2cd2017-05-03 17:11:11 +00001183
Zachary Turner591312c2017-05-30 17:13:33 +00001184 auto Iter = CVFileChecksumTable.getArray().at(FileOffset);
Zachary Turner2d5c2cd2017-05-03 17:11:11 +00001185
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001186 // Check if the file checksum table offset is valid.
Zachary Turner2d5c2cd2017-05-03 17:11:11 +00001187 if (Iter == CVFileChecksumTable.end())
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001188 error(object_error::parse_failed);
1189
Zachary Turner2d5c2cd2017-05-03 17:11:11 +00001190 return error(CVStringTable.getString(Iter->FileNameOffset));
Reid Kleckner8e7275c2016-01-15 00:11:21 +00001191}
1192
1193void COFFDumper::printFileNameForOffset(StringRef Label, uint32_t FileOffset) {
1194 W.printHex(Label, getFileNameForFileOffset(FileOffset), FileOffset);
1195}
1196
Reid Kleckner5d577522017-03-24 17:26:38 +00001197void COFFDumper::mergeCodeViewTypes(TypeTableBuilder &CVIDs,
1198 TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001199 for (const SectionRef &S : Obj->sections()) {
1200 StringRef SectionName;
1201 error(S.getName(SectionName));
1202 if (SectionName == ".debug$T") {
1203 StringRef Data;
1204 error(S.getContents(Data));
David Majnemer78b0d722016-05-28 19:17:48 +00001205 uint32_t Magic;
1206 error(consume(Data, Magic));
Reid Kleckner0b269742016-05-14 00:02:53 +00001207 if (Magic != 4)
1208 error(object_error::parse_failed);
Zachary Turnerd9a62632017-05-17 20:23:31 +00001209
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001210 CVTypeArray Types;
Zachary Turnerd9a62632017-05-17 20:23:31 +00001211 BinaryStreamReader Reader(Data, llvm::support::little);
Zachary Turner0d43c1c2016-05-28 05:21:57 +00001212 if (auto EC = Reader.readArray(Types, Reader.getLength())) {
1213 consumeError(std::move(EC));
1214 W.flush();
1215 error(object_error::parse_failed);
1216 }
Zachary Turnerb32ec022017-05-18 23:04:08 +00001217 SmallVector<TypeIndex, 128> SourceToDest;
Reid Klecknera842cd72017-07-17 20:28:06 +00001218 if (auto EC = mergeTypeAndIdRecords(CVIDs, CVTypes, SourceToDest, Types))
Reid Klecknerc4b5d792017-04-03 23:58:15 +00001219 return error(std::move(EC));
Reid Kleckner0b269742016-05-14 00:02:53 +00001220 }
1221 }
1222}
1223
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001224void COFFDumper::printCodeViewTypeSection(StringRef SectionName,
1225 const SectionRef &Section) {
1226 ListScope D(W, "CodeViewTypes");
1227 W.printNumber("Section", SectionName, Obj->getSectionID(Section));
Adrian McCarthy963a3312016-05-02 23:45:03 +00001228
Reid Kleckner72e2ba72016-01-13 19:32:35 +00001229 StringRef Data;
1230 error(Section.getContents(Data));
Reid Klecknerb2bd2812016-05-02 18:10:00 +00001231 if (opts::CodeViewSubsectionBytes)
1232 W.printBinaryBlock("Data", Data);
Reid Kleckner7960de92016-05-04 19:39:28 +00001233
1234 uint32_t Magic;
Zachary Turner38cc8b32016-05-12 17:45:44 +00001235 error(consume(Data, Magic));
Reid Kleckner7960de92016-05-04 19:39:28 +00001236 W.printHex("Magic", Magic);
1237 if (Magic != COFF::DEBUG_SECTION_MAGIC)
1238 return error(object_error::parse_failed);
1239
Zachary Turner26dbc542017-06-18 20:52:45 +00001240 Types.reset(Data, 100);
Zachary Turner526f4f22017-05-19 19:26:58 +00001241
1242 TypeDumpVisitor TDV(Types, &W, opts::CodeViewSubsectionBytes);
1243 error(codeview::visitTypeStream(Types, TDV));
1244 W.flush();
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +00001245}
1246
Eric Christopher9cad53c2013-04-03 18:31:38 +00001247void COFFDumper::printSections() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001248 ListScope SectionsD(W, "Sections");
1249 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001250 for (const SectionRef &Sec : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001251 ++SectionNumber;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001252 const coff_section *Section = Obj->getCOFFSection(Sec);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001253
1254 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001255 error(Sec.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001256
1257 DictScope D(W, "Section");
1258 W.printNumber("Number", SectionNumber);
1259 W.printBinary("Name", Name, Section->Name);
1260 W.printHex ("VirtualSize", Section->VirtualSize);
1261 W.printHex ("VirtualAddress", Section->VirtualAddress);
1262 W.printNumber("RawDataSize", Section->SizeOfRawData);
1263 W.printHex ("PointerToRawData", Section->PointerToRawData);
1264 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
1265 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
1266 W.printNumber("RelocationCount", Section->NumberOfRelocations);
1267 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
1268 W.printFlags ("Characteristics", Section->Characteristics,
1269 makeArrayRef(ImageSectionCharacteristics),
1270 COFF::SectionCharacteristics(0x00F00000));
1271
1272 if (opts::SectionRelocations) {
1273 ListScope D(W, "Relocations");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001274 for (const RelocationRef &Reloc : Sec.relocations())
1275 printRelocation(Sec, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001276 }
1277
1278 if (opts::SectionSymbols) {
1279 ListScope D(W, "Symbols");
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001280 for (const SymbolRef &Symbol : Obj->symbols()) {
Rafael Espindola80291272014-10-08 15:28:58 +00001281 if (!Sec.containsSymbol(Symbol))
Eric Christopher9cad53c2013-04-03 18:31:38 +00001282 continue;
1283
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001284 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001285 }
1286 }
1287
David Majnemerdac39852014-09-26 22:32:16 +00001288 if (opts::SectionData &&
1289 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001290 StringRef Data;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001291 error(Sec.getContents(Data));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001292
1293 W.printBinaryBlock("SectionData", Data);
1294 }
1295 }
1296}
1297
1298void COFFDumper::printRelocations() {
1299 ListScope D(W, "Relocations");
1300
Eric Christopher9cad53c2013-04-03 18:31:38 +00001301 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001302 for (const SectionRef &Section : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001303 ++SectionNumber;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001304 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001305 error(Section.getName(Name));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001306
1307 bool PrintedGroup = false;
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001308 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001309 if (!PrintedGroup) {
1310 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
1311 W.indent();
1312 PrintedGroup = true;
1313 }
1314
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001315 printRelocation(Section, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001316 }
1317
1318 if (PrintedGroup) {
1319 W.unindent();
1320 W.startLine() << "}\n";
1321 }
1322 }
1323}
1324
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001325void COFFDumper::printRelocation(const SectionRef &Section,
Reid Kleckner1c7a9cd2016-01-14 17:51:57 +00001326 const RelocationRef &Reloc, uint64_t Bias) {
1327 uint64_t Offset = Reloc.getOffset() - Bias;
Rafael Espindola99c041b2015-06-30 01:53:01 +00001328 uint64_t RelocType = Reloc.getType();
Eric Christopher9cad53c2013-04-03 18:31:38 +00001329 SmallString<32> RelocName;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001330 StringRef SymbolName;
Rafael Espindola41bb4322015-06-30 04:08:37 +00001331 Reloc.getTypeName(RelocName);
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001332 symbol_iterator Symbol = Reloc.getSymbol();
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001333 if (Symbol != Obj->symbol_end()) {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001334 Expected<StringRef> SymbolNameOrErr = Symbol->getName();
1335 error(errorToErrorCode(SymbolNameOrErr.takeError()));
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001336 SymbolName = *SymbolNameOrErr;
1337 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001338
Nico Rieckf3f0b792013-04-12 04:01:52 +00001339 if (opts::ExpandRelocs) {
1340 DictScope Group(W, "Relocation");
1341 W.printHex("Offset", Offset);
1342 W.printNumber("Type", RelocName, RelocType);
David Majnemer1f80b0a2014-11-13 07:42:11 +00001343 W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName);
Nico Rieckf3f0b792013-04-12 04:01:52 +00001344 } else {
1345 raw_ostream& OS = W.startLine();
1346 OS << W.hex(Offset)
1347 << " " << RelocName
David Majnemer1f80b0a2014-11-13 07:42:11 +00001348 << " " << (SymbolName.empty() ? "-" : SymbolName)
Nico Rieckf3f0b792013-04-12 04:01:52 +00001349 << "\n";
1350 }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001351}
1352
1353void COFFDumper::printSymbols() {
1354 ListScope Group(W, "Symbols");
1355
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001356 for (const SymbolRef &Symbol : Obj->symbols())
1357 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001358}
1359
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001360void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
Eric Christopher9cad53c2013-04-03 18:31:38 +00001361
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001362static ErrorOr<StringRef>
David Majnemer236b0ca2014-11-17 11:17:17 +00001363getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber,
1364 const coff_section *Section) {
David Majnemerf4dc4562014-09-20 00:25:06 +00001365 if (Section) {
1366 StringRef SectionName;
David Majnemer236b0ca2014-11-17 11:17:17 +00001367 if (std::error_code EC = Obj->getSectionName(Section, SectionName))
1368 return EC;
David Majnemerf4dc4562014-09-20 00:25:06 +00001369 return SectionName;
1370 }
David Majnemerf4dc4562014-09-20 00:25:06 +00001371 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
David Majnemer236b0ca2014-11-17 11:17:17 +00001372 return StringRef("IMAGE_SYM_DEBUG");
David Majnemerf4dc4562014-09-20 00:25:06 +00001373 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
David Majnemer236b0ca2014-11-17 11:17:17 +00001374 return StringRef("IMAGE_SYM_ABSOLUTE");
David Majnemerf4dc4562014-09-20 00:25:06 +00001375 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
David Majnemer236b0ca2014-11-17 11:17:17 +00001376 return StringRef("IMAGE_SYM_UNDEFINED");
1377 return StringRef("");
David Majnemerf4dc4562014-09-20 00:25:06 +00001378}
1379
Alexey Samsonov27dc8392014-03-18 06:53:02 +00001380void COFFDumper::printSymbol(const SymbolRef &Sym) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001381 DictScope D(W, "Symbol");
1382
David Majnemer44f51e52014-09-10 12:51:52 +00001383 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001384 const coff_section *Section;
David Majnemer44f51e52014-09-10 12:51:52 +00001385 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001386 W.startLine() << "Invalid section number: " << EC.message() << "\n";
1387 W.flush();
1388 return;
1389 }
1390
1391 StringRef SymbolName;
1392 if (Obj->getSymbolName(Symbol, SymbolName))
1393 SymbolName = "";
1394
David Majnemer236b0ca2014-11-17 11:17:17 +00001395 StringRef SectionName = "";
1396 ErrorOr<StringRef> Res =
1397 getSectionName(Obj, Symbol.getSectionNumber(), Section);
1398 if (Res)
1399 SectionName = *Res;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001400
1401 W.printString("Name", SymbolName);
David Majnemer44f51e52014-09-10 12:51:52 +00001402 W.printNumber("Value", Symbol.getValue());
1403 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
1404 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
1405 W.printEnum ("ComplexType", Symbol.getComplexType(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001406 makeArrayRef(ImageSymDType));
David Majnemer44f51e52014-09-10 12:51:52 +00001407 W.printEnum ("StorageClass", Symbol.getStorageClass(),
Eric Christopher9cad53c2013-04-03 18:31:38 +00001408 makeArrayRef(ImageSymClass));
David Majnemer44f51e52014-09-10 12:51:52 +00001409 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
Eric Christopher9cad53c2013-04-03 18:31:38 +00001410
David Majnemer44f51e52014-09-10 12:51:52 +00001411 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
1412 if (Symbol.isFunctionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001413 const coff_aux_function_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001414 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001415
1416 DictScope AS(W, "AuxFunctionDef");
1417 W.printNumber("TagIndex", Aux->TagIndex);
1418 W.printNumber("TotalSize", Aux->TotalSize);
David Majnemerf3a2af52014-03-19 04:33:27 +00001419 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001420 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001421
David Majnemerc7d7c6f2014-10-31 05:07:00 +00001422 } else if (Symbol.isAnyUndefined()) {
David Majnemerf3a2af52014-03-19 04:33:27 +00001423 const coff_aux_weak_external *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001424 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001425
David Majnemer44f51e52014-09-10 12:51:52 +00001426 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001427 StringRef LinkedName;
David Majnemer44f51e52014-09-10 12:51:52 +00001428 std::error_code EC = Linked.getError();
1429 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001430 LinkedName = "";
1431 error(EC);
1432 }
1433
1434 DictScope AS(W, "AuxWeakExternal");
1435 W.printNumber("Linked", LinkedName, Aux->TagIndex);
1436 W.printEnum ("Search", Aux->Characteristics,
1437 makeArrayRef(WeakExternalCharacteristics));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001438
David Majnemer44f51e52014-09-10 12:51:52 +00001439 } else if (Symbol.isFileRecord()) {
1440 const char *FileName;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001441 error(getSymbolAuxData(Obj, Symbol, I, FileName));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001442
Nico Rieck0ab8e602013-04-22 08:35:11 +00001443 DictScope AS(W, "AuxFileRecord");
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001444
David Majnemer44f51e52014-09-10 12:51:52 +00001445 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
1446 Obj->getSymbolTableEntrySize());
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +00001447 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
Saleem Abdulrasool3b5e0012014-04-16 04:15:29 +00001448 break;
David Majnemer44f51e52014-09-10 12:51:52 +00001449 } else if (Symbol.isSectionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001450 const coff_aux_section_definition *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001451 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001452
David Majnemer4d571592014-09-15 19:42:42 +00001453 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
1454
Eric Christopher9cad53c2013-04-03 18:31:38 +00001455 DictScope AS(W, "AuxSectionDef");
1456 W.printNumber("Length", Aux->Length);
1457 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
1458 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
1459 W.printHex("Checksum", Aux->CheckSum);
David Majnemer4d571592014-09-15 19:42:42 +00001460 W.printNumber("Number", AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001461 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001462
Nico Riecka711dee2013-04-22 08:34:59 +00001463 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
Eric Christopher9cad53c2013-04-03 18:31:38 +00001464 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
1465 const coff_section *Assoc;
David Majnemer236b0ca2014-11-17 11:17:17 +00001466 StringRef AssocName = "";
1467 std::error_code EC = Obj->getSection(AuxNumber, Assoc);
1468 ErrorOr<StringRef> Res = getSectionName(Obj, AuxNumber, Assoc);
1469 if (Res)
1470 AssocName = *Res;
1471 if (!EC)
1472 EC = Res.getError();
1473 if (EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001474 AssocName = "";
1475 error(EC);
1476 }
1477
David Majnemer4d571592014-09-15 19:42:42 +00001478 W.printNumber("AssocSection", AssocName, AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001479 }
David Majnemer44f51e52014-09-10 12:51:52 +00001480 } else if (Symbol.isCLRToken()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001481 const coff_aux_clr_token *Aux;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001482 error(getSymbolAuxData(Obj, Symbol, I, Aux));
Eric Christopher9cad53c2013-04-03 18:31:38 +00001483
David Majnemer44f51e52014-09-10 12:51:52 +00001484 ErrorOr<COFFSymbolRef> ReferredSym =
1485 Obj->getSymbol(Aux->SymbolTableIndex);
Nico Rieck8678acd2014-03-17 01:46:52 +00001486 StringRef ReferredName;
David Majnemer44f51e52014-09-10 12:51:52 +00001487 std::error_code EC = ReferredSym.getError();
1488 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
Nico Rieck8678acd2014-03-17 01:46:52 +00001489 ReferredName = "";
1490 error(EC);
1491 }
1492
Eric Christopher9cad53c2013-04-03 18:31:38 +00001493 DictScope AS(W, "AuxCLRToken");
1494 W.printNumber("AuxType", Aux->AuxType);
1495 W.printNumber("Reserved", Aux->Reserved);
Nico Rieck8678acd2014-03-17 01:46:52 +00001496 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +00001497
1498 } else {
1499 W.startLine() << "<unhandled auxiliary record>\n";
1500 }
1501 }
1502}
1503
1504void COFFDumper::printUnwindInfo() {
Eric Christopher9cad53c2013-04-03 18:31:38 +00001505 ListScope D(W, "UnwindInformation");
David Majnemer44f51e52014-09-10 12:51:52 +00001506 switch (Obj->getMachine()) {
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001507 case COFF::IMAGE_FILE_MACHINE_AMD64: {
1508 Win64EH::Dumper Dumper(W);
Rafael Espindola4453e42942014-06-13 03:07:50 +00001509 Win64EH::Dumper::SymbolResolver
1510 Resolver = [](const object::coff_section *Section, uint64_t Offset,
1511 SymbolRef &Symbol, void *user_data) -> std::error_code {
1512 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
1513 return Dumper->resolveSymbol(Section, Offset, Symbol);
1514 };
Saleem Abdulrasool65dbbb52014-05-25 21:37:59 +00001515 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001516 Dumper.printData(Ctx);
1517 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001518 }
Saleem Abdulrasoole6971ca2014-06-04 15:47:15 +00001519 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
1520 ARM::WinEH::Decoder Decoder(W);
1521 Decoder.dumpProcedureData(*Obj);
1522 break;
1523 }
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001524 default:
David Majnemer44f51e52014-09-10 12:51:52 +00001525 W.printEnum("unsupported Image Machine", Obj->getMachine(),
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +00001526 makeArrayRef(ImageFileMachineType));
1527 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +00001528 }
1529}
1530
Rui Ueyama979fb402014-10-09 02:16:38 +00001531void COFFDumper::printImportedSymbols(
1532 iterator_range<imported_symbol_iterator> Range) {
1533 for (const ImportedSymbolRef &I : Range) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001534 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001535 error(I.getSymbolName(Sym));
Rui Ueyama15d99352014-10-03 00:41:58 +00001536 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001537 error(I.getOrdinal(Ordinal));
Rui Ueyama15d99352014-10-03 00:41:58 +00001538 W.printNumber("Symbol", Sym, Ordinal);
1539 }
1540}
1541
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001542void COFFDumper::printDelayImportedSymbols(
1543 const DelayImportDirectoryEntryRef &I,
1544 iterator_range<imported_symbol_iterator> Range) {
1545 int Index = 0;
1546 for (const ImportedSymbolRef &S : Range) {
1547 DictScope Import(W, "Import");
1548 StringRef Sym;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001549 error(S.getSymbolName(Sym));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001550 uint16_t Ordinal;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001551 error(S.getOrdinal(Ordinal));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001552 W.printNumber("Symbol", Sym, Ordinal);
1553 uint64_t Addr;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001554 error(I.getImportAddress(Index++, Addr));
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001555 W.printHex("Address", Addr);
1556 }
1557}
1558
Rui Ueyama1e152d52014-10-02 17:02:18 +00001559void COFFDumper::printCOFFImports() {
Rui Ueyama15d99352014-10-03 00:41:58 +00001560 // Regular imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001561 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
Rui Ueyama1e152d52014-10-02 17:02:18 +00001562 DictScope Import(W, "Import");
1563 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001564 error(I.getName(Name));
Rui Ueyama1e152d52014-10-02 17:02:18 +00001565 W.printString("Name", Name);
Shoaib Meenai73754482017-03-26 17:10:11 +00001566 uint32_t ILTAddr;
1567 error(I.getImportLookupTableRVA(ILTAddr));
1568 W.printHex("ImportLookupTableRVA", ILTAddr);
1569 uint32_t IATAddr;
1570 error(I.getImportAddressTableRVA(IATAddr));
1571 W.printHex("ImportAddressTableRVA", IATAddr);
1572 // The import lookup table can be missing with certain older linkers, so
1573 // fall back to the import address table in that case.
1574 if (ILTAddr)
1575 printImportedSymbols(I.lookup_table_symbols());
1576 else
1577 printImportedSymbols(I.imported_symbols());
Rui Ueyama15d99352014-10-03 00:41:58 +00001578 }
1579
1580 // Delay imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001581 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001582 DictScope Import(W, "DelayImport");
1583 StringRef Name;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001584 error(I.getName(Name));
Rui Ueyama15d99352014-10-03 00:41:58 +00001585 W.printString("Name", Name);
Rui Ueyama1af08652014-10-03 18:07:18 +00001586 const delay_import_directory_table_entry *Table;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001587 error(I.getDelayImportTable(Table));
Rui Ueyama1af08652014-10-03 18:07:18 +00001588 W.printHex("Attributes", Table->Attributes);
1589 W.printHex("ModuleHandle", Table->ModuleHandle);
1590 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
1591 W.printHex("ImportNameTable", Table->DelayImportNameTable);
1592 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
1593 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001594 printDelayImportedSymbols(I, I.imported_symbols());
Rui Ueyama1e152d52014-10-02 17:02:18 +00001595 }
1596}
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001597
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001598void COFFDumper::printCOFFExports() {
1599 for (const ExportDirectoryEntryRef &E : Obj->export_directories()) {
1600 DictScope Export(W, "Export");
1601
1602 StringRef Name;
1603 uint32_t Ordinal, RVA;
1604
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001605 error(E.getSymbolName(Name));
1606 error(E.getOrdinal(Ordinal));
1607 error(E.getExportRVA(RVA));
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +00001608
1609 W.printNumber("Ordinal", Ordinal);
1610 W.printString("Name", Name);
1611 W.printHex("RVA", RVA);
1612 }
1613}
1614
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001615void COFFDumper::printCOFFDirectives() {
1616 for (const SectionRef &Section : Obj->sections()) {
1617 StringRef Contents;
1618 StringRef Name;
1619
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001620 error(Section.getName(Name));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001621 if (Name != ".drectve")
1622 continue;
1623
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001624 error(Section.getContents(Contents));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001625
1626 W.printString("Directive(s)", Contents);
1627 }
1628}
Rui Ueyama74e85132014-11-19 00:18:07 +00001629
Duncan P. N. Exon Smith91d3cfe2016-04-05 20:45:04 +00001630static StringRef getBaseRelocTypeName(uint8_t Type) {
Rui Ueyama74e85132014-11-19 00:18:07 +00001631 switch (Type) {
1632 case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";
1633 case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";
1634 case COFF::IMAGE_REL_BASED_LOW: return "LOW";
1635 case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";
1636 case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";
Saleem Abdulrasool5a41c372015-01-16 20:16:09 +00001637 case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)";
Rui Ueyama74e85132014-11-19 00:18:07 +00001638 case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";
Alexander Kornienko656466e2017-07-04 15:13:02 +00001639 default: {
1640 static std::string Result;
1641 Result = "unknown (" + llvm::utostr(Type) + ")";
1642 return Result;
1643 }
Rui Ueyama74e85132014-11-19 00:18:07 +00001644 }
1645}
1646
1647void COFFDumper::printCOFFBaseReloc() {
1648 ListScope D(W, "BaseReloc");
1649 for (const BaseRelocRef &I : Obj->base_relocs()) {
1650 uint8_t Type;
1651 uint32_t RVA;
Rafael Espindolafb3acd62015-07-20 03:23:55 +00001652 error(I.getRVA(RVA));
1653 error(I.getType(Type));
Rui Ueyama74e85132014-11-19 00:18:07 +00001654 DictScope Import(W, "Entry");
1655 W.printString("Type", getBaseRelocTypeName(Type));
1656 W.printHex("Address", RVA);
1657 }
1658}
Lang Hames0000afd2015-06-26 23:56:53 +00001659
Zachary Turner8d6396d2017-04-27 19:38:38 +00001660void COFFDumper::printCOFFResources() {
1661 ListScope ResourcesD(W, "Resources");
1662 for (const SectionRef &S : Obj->sections()) {
1663 StringRef Name;
1664 error(S.getName(Name));
1665 if (!Name.startswith(".rsrc"))
1666 continue;
1667
1668 StringRef Ref;
1669 error(S.getContents(Ref));
1670
1671 if ((Name == ".rsrc") || (Name == ".rsrc$01")) {
Eric Beckmannefef15a2017-05-08 02:47:07 +00001672 ResourceSectionRef RSF(Ref);
1673 auto &BaseTable = unwrapOrError(RSF.getBaseTable());
Eric Beckmann13017592017-06-13 00:16:32 +00001674 W.printNumber("Total Number of Resources",
1675 countTotalTableEntries(RSF, BaseTable, "Type"));
1676 W.printHex("Base Table Address",
1677 Obj->getCOFFSection(S)->PointerToRawData);
1678 W.startLine() << "\n";
Eric Beckmannefef15a2017-05-08 02:47:07 +00001679 printResourceDirectoryTable(RSF, BaseTable, "Type");
Zachary Turner8d6396d2017-04-27 19:38:38 +00001680 }
Eric Beckmannefef15a2017-05-08 02:47:07 +00001681 if (opts::SectionData)
1682 W.printBinaryBlock(Name.str() + " Data", Ref);
Zachary Turner8d6396d2017-04-27 19:38:38 +00001683 }
1684}
1685
Eric Beckmann13017592017-06-13 00:16:32 +00001686uint32_t
1687COFFDumper::countTotalTableEntries(ResourceSectionRef RSF,
1688 const coff_resource_dir_table &Table,
1689 StringRef Level) {
1690 uint32_t TotalEntries = 0;
1691 for (int i = 0; i < Table.NumberOfNameEntries + Table.NumberOfIDEntries;
1692 i++) {
1693 auto Entry = unwrapOrError(getResourceDirectoryTableEntry(Table, i));
1694 if (Entry.Offset.isSubDir()) {
1695 StringRef NextLevel;
1696 if (Level == "Name")
1697 NextLevel = "Language";
1698 else
1699 NextLevel = "Name";
1700 auto &NextTable = unwrapOrError(RSF.getEntrySubDir(Entry));
1701 TotalEntries += countTotalTableEntries(RSF, NextTable, NextLevel);
1702 } else {
1703 TotalEntries += 1;
1704 }
1705 }
1706 return TotalEntries;
1707}
1708
Eric Beckmannefef15a2017-05-08 02:47:07 +00001709void COFFDumper::printResourceDirectoryTable(
1710 ResourceSectionRef RSF, const coff_resource_dir_table &Table,
1711 StringRef Level) {
Eric Beckmannefef15a2017-05-08 02:47:07 +00001712
Eric Beckmann13017592017-06-13 00:16:32 +00001713 W.printNumber("Number of String Entries", Table.NumberOfNameEntries);
1714 W.printNumber("Number of ID Entries", Table.NumberOfIDEntries);
Eric Beckmannefef15a2017-05-08 02:47:07 +00001715
1716 // Iterate through level in resource directory tree.
1717 for (int i = 0; i < Table.NumberOfNameEntries + Table.NumberOfIDEntries;
1718 i++) {
1719 auto Entry = unwrapOrError(getResourceDirectoryTableEntry(Table, i));
1720 StringRef Name;
1721 SmallString<20> IDStr;
1722 raw_svector_ostream OS(IDStr);
1723 if (i < Table.NumberOfNameEntries) {
Eric Beckmanncd704cb2017-05-08 02:47:42 +00001724 ArrayRef<UTF16> RawEntryNameString = unwrapOrError(RSF.getEntryNameString(Entry));
Eric Beckmann674deed2017-05-09 19:35:45 +00001725 std::vector<UTF16> EndianCorrectedNameString;
1726 if (llvm::sys::IsBigEndianHost) {
1727 EndianCorrectedNameString.resize(RawEntryNameString.size() + 1);
1728 std::copy(RawEntryNameString.begin(), RawEntryNameString.end(),
1729 EndianCorrectedNameString.begin() + 1);
1730 EndianCorrectedNameString[0] = UNI_UTF16_BYTE_ORDER_MARK_SWAPPED;
1731 RawEntryNameString = makeArrayRef(EndianCorrectedNameString);
1732 }
Eric Beckmanncd704cb2017-05-08 02:47:42 +00001733 std::string EntryNameString;
1734 if (!llvm::convertUTF16ToUTF8String(RawEntryNameString, EntryNameString))
1735 error(object_error::parse_failed);
Eric Beckmannefef15a2017-05-08 02:47:07 +00001736 OS << ": ";
Eric Beckmanncd704cb2017-05-08 02:47:42 +00001737 OS << EntryNameString;
Eric Beckmannefef15a2017-05-08 02:47:07 +00001738 } else {
1739 if (Level == "Type") {
1740 ScopedPrinter Printer(OS);
1741 Printer.printEnum("", Entry.Identifier.ID,
1742 makeArrayRef(ResourceTypeNames));
1743 IDStr = IDStr.slice(0, IDStr.find_first_of(")", 0) + 1);
1744 } else {
1745 OS << ": (ID " << Entry.Identifier.ID << ")";
1746 }
1747 }
1748 Name = StringRef(IDStr);
1749 ListScope ResourceType(W, Level.str() + Name.str());
1750 if (Entry.Offset.isSubDir()) {
Eric Beckmann13017592017-06-13 00:16:32 +00001751 W.printHex("Table Offset", Entry.Offset.value());
Eric Beckmannefef15a2017-05-08 02:47:07 +00001752 StringRef NextLevel;
1753 if (Level == "Name")
1754 NextLevel = "Language";
1755 else
1756 NextLevel = "Name";
1757 auto &NextTable = unwrapOrError(RSF.getEntrySubDir(Entry));
1758 printResourceDirectoryTable(RSF, NextTable, NextLevel);
1759 } else {
Eric Beckmann13017592017-06-13 00:16:32 +00001760 W.printHex("Entry Offset", Entry.Offset.value());
1761 char FormattedTime[20] = {};
1762 time_t TDS = time_t(Table.TimeDateStamp);
1763 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
Eric Beckmannefef15a2017-05-08 02:47:07 +00001764 W.printHex("Time/Date Stamp", FormattedTime, Table.TimeDateStamp);
1765 W.printNumber("Major Version", Table.MajorVersion);
1766 W.printNumber("Minor Version", Table.MinorVersion);
Eric Beckmann13017592017-06-13 00:16:32 +00001767 W.printNumber("Characteristics", Table.Characteristics);
Eric Beckmannefef15a2017-05-08 02:47:07 +00001768 }
1769 }
1770}
1771
1772ErrorOr<const coff_resource_dir_entry &>
1773COFFDumper::getResourceDirectoryTableEntry(const coff_resource_dir_table &Table,
1774 uint32_t Index) {
Eric Beckmanncd704cb2017-05-08 02:47:42 +00001775 if (Index >= (uint32_t)(Table.NumberOfNameEntries + Table.NumberOfIDEntries))
Eric Beckmannefef15a2017-05-08 02:47:07 +00001776 return object_error::parse_failed;
1777 auto TablePtr = reinterpret_cast<const coff_resource_dir_entry *>(&Table + 1);
1778 return TablePtr[Index];
1779}
1780
Lang Hames0000afd2015-06-26 23:56:53 +00001781void COFFDumper::printStackMap() const {
1782 object::SectionRef StackMapSection;
1783 for (auto Sec : Obj->sections()) {
1784 StringRef Name;
1785 Sec.getName(Name);
1786 if (Name == ".llvm_stackmaps") {
1787 StackMapSection = Sec;
1788 break;
1789 }
1790 }
1791
1792 if (StackMapSection == object::SectionRef())
1793 return;
1794
1795 StringRef StackMapContents;
1796 StackMapSection.getContents(StackMapContents);
1797 ArrayRef<uint8_t> StackMapContentsArray(
1798 reinterpret_cast<const uint8_t*>(StackMapContents.data()),
1799 StackMapContents.size());
1800
1801 if (Obj->isLittleEndian())
1802 prettyPrintStackMap(
1803 llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001804 StackMapV2Parser<support::little>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001805 else
1806 prettyPrintStackMap(llvm::outs(),
Sanjoy Das23f06e52016-09-14 20:22:03 +00001807 StackMapV2Parser<support::big>(StackMapContentsArray));
Lang Hames0000afd2015-06-26 23:56:53 +00001808}
Reid Kleckner0b269742016-05-14 00:02:53 +00001809
Zachary Turner4efa0a42016-11-08 22:24:53 +00001810void llvm::dumpCodeViewMergedTypes(ScopedPrinter &Writer,
Reid Kleckner5d577522017-03-24 17:26:38 +00001811 llvm::codeview::TypeTableBuilder &IDTable,
Zachary Turner4efa0a42016-11-08 22:24:53 +00001812 llvm::codeview::TypeTableBuilder &CVTypes) {
Reid Kleckner0b269742016-05-14 00:02:53 +00001813 // Flatten it first, then run our dumper on it.
Reid Kleckner5d577522017-03-24 17:26:38 +00001814 SmallString<0> TypeBuf;
Zachary Turner4efa0a42016-11-08 22:24:53 +00001815 CVTypes.ForEachRecord([&](TypeIndex TI, ArrayRef<uint8_t> Record) {
Reid Kleckner5d577522017-03-24 17:26:38 +00001816 TypeBuf.append(Record.begin(), Record.end());
Reid Kleckner0b269742016-05-14 00:02:53 +00001817 });
Zachary Turner629cb7d2017-01-11 23:24:22 +00001818
Zachary Turner526f4f22017-05-19 19:26:58 +00001819 TypeTableCollection TpiTypes(CVTypes.records());
Reid Kleckner5d577522017-03-24 17:26:38 +00001820 {
1821 ListScope S(Writer, "MergedTypeStream");
Zachary Turner526f4f22017-05-19 19:26:58 +00001822 TypeDumpVisitor TDV(TpiTypes, &Writer, opts::CodeViewSubsectionBytes);
1823 error(codeview::visitTypeStream(TpiTypes, TDV));
1824 Writer.flush();
Reid Kleckner5d577522017-03-24 17:26:38 +00001825 }
1826
1827 // Flatten the id stream and print it next. The ID stream refers to names from
1828 // the type stream.
Zachary Turner526f4f22017-05-19 19:26:58 +00001829 TypeTableCollection IpiTypes(IDTable.records());
Reid Kleckner5d577522017-03-24 17:26:38 +00001830 {
1831 ListScope S(Writer, "MergedIDStream");
Zachary Turner526f4f22017-05-19 19:26:58 +00001832 TypeDumpVisitor TDV(TpiTypes, &Writer, opts::CodeViewSubsectionBytes);
1833 TDV.setIpiTypes(IpiTypes);
1834 error(codeview::visitTypeStream(IpiTypes, TDV));
1835 Writer.flush();
Reid Kleckner0b269742016-05-14 00:02:53 +00001836 }
1837}