blob: 7c12f068a82d96b9e83e55977d39af005cb9b75f [file] [log] [blame]
Eric Christopher9cad53c2013-04-03 18:31:38 +00001//===-- COFFDumper.cpp - COFF-specific dumper -------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11/// \brief This file implements the COFF-specific dumper for llvm-readobj.
12///
13//===----------------------------------------------------------------------===//
14
15#include "llvm-readobj.h"
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000016#include "ARMWinEHPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000017#include "Error.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000018#include "ObjDumper.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000019#include "StreamWriter.h"
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +000020#include "Win64EHDumper.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000021#include "llvm/ADT/DenseMap.h"
22#include "llvm/ADT/SmallString.h"
23#include "llvm/Object/COFF.h"
24#include "llvm/Object/ObjectFile.h"
Chandler Carruth07baed52014-01-13 08:04:33 +000025#include "llvm/Support/COFF.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000026#include "llvm/Support/Casting.h"
27#include "llvm/Support/Compiler.h"
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000028#include "llvm/Support/DataExtractor.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000029#include "llvm/Support/Format.h"
30#include "llvm/Support/SourceMgr.h"
31#include "llvm/Support/Win64EH.h"
32#include "llvm/Support/raw_ostream.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000033#include <algorithm>
34#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000035#include <system_error>
Eric Christopher9cad53c2013-04-03 18:31:38 +000036#include <time.h>
37
38using namespace llvm;
39using namespace llvm::object;
40using namespace llvm::Win64EH;
41
42namespace {
43
44class COFFDumper : public ObjDumper {
45public:
46 COFFDumper(const llvm::object::COFFObjectFile *Obj, StreamWriter& Writer)
47 : ObjDumper(Writer)
48 , Obj(Obj) {
49 cacheRelocations();
50 }
51
Craig Topperfd38cbe2014-08-30 16:48:34 +000052 void printFileHeaders() override;
53 void printSections() override;
54 void printRelocations() override;
55 void printSymbols() override;
56 void printDynamicSymbols() override;
57 void printUnwindInfo() override;
Rui Ueyama1e152d52014-10-02 17:02:18 +000058 void printCOFFImports() override;
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +000059 void printCOFFDirectives() override;
Eric Christopher9cad53c2013-04-03 18:31:38 +000060
61private:
Alexey Samsonov27dc8392014-03-18 06:53:02 +000062 void printSymbol(const SymbolRef &Sym);
63 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc);
Rui Ueyamaed64342b2013-07-19 23:23:29 +000064 void printDataDirectory(uint32_t Index, const std::string &FieldName);
Eric Christopher9cad53c2013-04-03 18:31:38 +000065
David Majnemer50267222014-11-05 06:24:35 +000066 void printDOSHeader(const dos_header *DH);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +000067 template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
68 void printBaseOfDataField(const pe32_header *Hdr);
69 void printBaseOfDataField(const pe32plus_header *Hdr);
70
Alexey Samsonov27dc8392014-03-18 06:53:02 +000071 void printCodeViewLineTables(const SectionRef &Section);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +000072
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +000073 void printCodeViewSymbolsSubsection(StringRef Subsection,
74 const SectionRef &Section,
75 uint32_t Offset);
76
Eric Christopher9cad53c2013-04-03 18:31:38 +000077 void cacheRelocations();
78
Rafael Espindola4453e42942014-06-13 03:07:50 +000079 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
80 SymbolRef &Sym);
81 std::error_code resolveSymbolName(const coff_section *Section,
82 uint64_t Offset, StringRef &Name);
Rui Ueyama979fb402014-10-09 02:16:38 +000083 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +000084 void printDelayImportedSymbols(
85 const DelayImportDirectoryEntryRef &I,
86 iterator_range<imported_symbol_iterator> Range);
Rui Ueyama15d99352014-10-03 00:41:58 +000087
Eric Christopher9cad53c2013-04-03 18:31:38 +000088 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
89
90 const llvm::object::COFFObjectFile *Obj;
91 RelocMapTy RelocMap;
Timur Iskhodzhanov11603332014-10-06 16:59:44 +000092 StringRef CVFileIndexToStringOffsetTable;
93 StringRef CVStringTable;
Eric Christopher9cad53c2013-04-03 18:31:38 +000094};
95
96} // namespace
97
98
99namespace llvm {
100
Rafael Espindola4453e42942014-06-13 03:07:50 +0000101std::error_code createCOFFDumper(const object::ObjectFile *Obj,
102 StreamWriter &Writer,
103 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000104 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
105 if (!COFFObj)
106 return readobj_error::unsupported_obj_file_format;
107
108 Result.reset(new COFFDumper(COFFObj, Writer));
109 return readobj_error::success;
110}
111
112} // namespace llvm
113
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000114// Given a a section and an offset into this section the function returns the
115// symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000116std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
117 uint64_t Offset, SymbolRef &Sym) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000118 const auto &Relocations = RelocMap[Section];
119 for (const auto &Relocation : Relocations) {
120 uint64_t RelocationOffset;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000121 if (std::error_code EC = Relocation.getOffset(RelocationOffset))
Eric Christopher9cad53c2013-04-03 18:31:38 +0000122 return EC;
123
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000124 if (RelocationOffset == Offset) {
Saleem Abdulrasool4a6f5832014-05-20 05:18:06 +0000125 Sym = *Relocation.getSymbol();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000126 return readobj_error::success;
127 }
128 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000129 return readobj_error::unknown_symbol;
130}
131
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000132// Given a section and an offset into this section the function returns the name
133// of the symbol used for the relocation at the offset.
Rafael Espindola4453e42942014-06-13 03:07:50 +0000134std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
135 uint64_t Offset,
136 StringRef &Name) {
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000137 SymbolRef Symbol;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000138 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000139 return EC;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000140 if (std::error_code EC = Symbol.getName(Name))
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000141 return EC;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000142 return object_error::success;
143}
144
145static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
146 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),
147 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),
148 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),
149 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),
Saleem Abdulrasool5e1780e2014-03-11 03:08:37 +0000150 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000151 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),
152 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),
153 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),
154 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),
155 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),
156 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),
157 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
158 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),
159 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
160 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),
161 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),
162 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),
163 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),
164 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),
165 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),
166 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
167};
168
169static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
170 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),
171 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),
172 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),
173 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),
174 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),
175 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),
176 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),
177 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),
178 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),
179 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
180 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),
181 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),
182 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),
183 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),
184 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )
185};
186
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000187static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
188 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),
189 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),
190 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),
191 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),
192 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),
193 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),
194 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),
195 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
196 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),
197 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),
198 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),
199};
200
201static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
Rui Ueyama06dc5e72014-01-27 04:22:24 +0000202 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000203 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),
204 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),
205 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),
206 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),
207 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),
208 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000209 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000210 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),
Saleem Abdulrasoold90f86d2014-06-27 03:11:18 +0000211 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000212 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
213};
214
Eric Christopher9cad53c2013-04-03 18:31:38 +0000215static const EnumEntry<COFF::SectionCharacteristics>
216ImageSectionCharacteristics[] = {
217 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),
218 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),
219 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),
220 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
221 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),
222 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),
223 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),
224 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),
225 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),
226 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),
227 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),
228 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),
229 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),
230 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),
231 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),
232 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),
233 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),
234 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),
235 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),
236 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),
237 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),
238 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),
239 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),
240 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),
241 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),
242 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),
243 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),
244 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),
245 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),
246 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),
247 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),
248 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),
249 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),
250 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),
251 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )
252};
253
254static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
255 { "Null" , COFF::IMAGE_SYM_TYPE_NULL },
256 { "Void" , COFF::IMAGE_SYM_TYPE_VOID },
257 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR },
258 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT },
259 { "Int" , COFF::IMAGE_SYM_TYPE_INT },
260 { "Long" , COFF::IMAGE_SYM_TYPE_LONG },
261 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },
262 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
263 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
264 { "Union" , COFF::IMAGE_SYM_TYPE_UNION },
265 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },
266 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE },
267 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },
268 { "Word" , COFF::IMAGE_SYM_TYPE_WORD },
269 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT },
270 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }
271};
272
273static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
274 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL },
275 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },
276 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
277 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }
278};
279
280static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
281 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },
282 { "Null" , COFF::IMAGE_SYM_CLASS_NULL },
283 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },
284 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },
285 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC },
286 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },
287 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },
288 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL },
289 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },
290 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
291 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },
292 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },
293 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },
294 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },
295 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },
296 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
297 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },
298 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },
299 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },
300 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },
301 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },
302 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },
303 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },
304 { "File" , COFF::IMAGE_SYM_CLASS_FILE },
305 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION },
306 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },
307 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }
308};
309
310static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
311 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
312 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },
313 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },
314 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },
315 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },
316 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },
317 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }
318};
319
320static const EnumEntry<COFF::WeakExternalCharacteristics>
321WeakExternalCharacteristics[] = {
322 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
323 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },
324 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS }
325};
326
Rafael Espindola4453e42942014-06-13 03:07:50 +0000327template <typename T>
328static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
David Majnemer44f51e52014-09-10 12:51:52 +0000329 COFFSymbolRef Symbol,
330 uint8_t AuxSymbolIdx, const T *&Aux) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000331 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
David Majnemer44f51e52014-09-10 12:51:52 +0000332 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000333 Aux = reinterpret_cast<const T*>(AuxData.data());
334 return readobj_error::success;
335}
336
Eric Christopher9cad53c2013-04-03 18:31:38 +0000337void COFFDumper::cacheRelocations() {
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000338 for (const SectionRef &S : Obj->sections()) {
339 const coff_section *Section = Obj->getCOFFSection(S);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000340
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000341 for (const RelocationRef &Reloc : S.relocations())
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000342 RelocMap[Section].push_back(Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000343
344 // Sort relocations by address.
345 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
346 relocAddressLess);
347 }
348}
349
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000350void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
351 const data_directory *Data;
352 if (Obj->getDataDirectory(Index, Data))
353 return;
354 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
355 W.printHex(FieldName + "Size", Data->Size);
356}
357
Eric Christopher9cad53c2013-04-03 18:31:38 +0000358void COFFDumper::printFileHeaders() {
David Majnemer44f51e52014-09-10 12:51:52 +0000359 time_t TDS = Obj->getTimeDateStamp();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000360 char FormattedTime[20] = { };
361 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
362
363 {
364 DictScope D(W, "ImageFileHeader");
David Majnemer44f51e52014-09-10 12:51:52 +0000365 W.printEnum ("Machine", Obj->getMachine(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000366 makeArrayRef(ImageFileMachineType));
David Majnemer44f51e52014-09-10 12:51:52 +0000367 W.printNumber("SectionCount", Obj->getNumberOfSections());
368 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
369 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
370 W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
371 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
372 W.printFlags ("Characteristics", Obj->getCharacteristics(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000373 makeArrayRef(ImageFileCharacteristics));
374 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000375
376 // Print PE header. This header does not exist if this is an object file and
377 // not an executable.
Craig Toppere6cb63e2014-04-25 04:24:47 +0000378 const pe32_header *PEHeader = nullptr;
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000379 if (error(Obj->getPE32Header(PEHeader)))
380 return;
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000381 if (PEHeader)
382 printPEHeader<pe32_header>(PEHeader);
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000383
Craig Toppere6cb63e2014-04-25 04:24:47 +0000384 const pe32plus_header *PEPlusHeader = nullptr;
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000385 if (error(Obj->getPE32PlusHeader(PEPlusHeader)))
386 return;
387 if (PEPlusHeader)
388 printPEHeader<pe32plus_header>(PEPlusHeader);
David Majnemer50267222014-11-05 06:24:35 +0000389
390 if (const dos_header *DH = Obj->getDOSHeader())
391 printDOSHeader(DH);
392}
393
394void COFFDumper::printDOSHeader(const dos_header *DH) {
395 DictScope D(W, "DOSHeader");
396 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
397 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
398 W.printNumber("FileSizeInPages", DH->FileSizeInPages);
399 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
400 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
401 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
402 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
403 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
404 W.printNumber("InitialSP", DH->InitialSP);
405 W.printNumber("Checksum", DH->Checksum);
406 W.printNumber("InitialIP", DH->InitialIP);
407 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
408 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
409 W.printNumber("OverlayNumber", DH->OverlayNumber);
410 W.printNumber("OEMid", DH->OEMid);
411 W.printNumber("OEMinfo", DH->OEMinfo);
412 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000413}
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000414
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000415template <class PEHeader>
416void COFFDumper::printPEHeader(const PEHeader *Hdr) {
417 DictScope D(W, "ImageOptionalHeader");
418 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
419 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
420 W.printNumber("SizeOfCode", Hdr->SizeOfCode);
421 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
422 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
423 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
424 W.printHex ("BaseOfCode", Hdr->BaseOfCode);
425 printBaseOfDataField(Hdr);
426 W.printHex ("ImageBase", Hdr->ImageBase);
427 W.printNumber("SectionAlignment", Hdr->SectionAlignment);
428 W.printNumber("FileAlignment", Hdr->FileAlignment);
429 W.printNumber("MajorOperatingSystemVersion",
430 Hdr->MajorOperatingSystemVersion);
431 W.printNumber("MinorOperatingSystemVersion",
432 Hdr->MinorOperatingSystemVersion);
433 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
434 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
435 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
436 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
437 W.printNumber("SizeOfImage", Hdr->SizeOfImage);
438 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
439 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
440 W.printFlags ("Subsystem", Hdr->DLLCharacteristics,
441 makeArrayRef(PEDLLCharacteristics));
442 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
443 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
444 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
445 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
446 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000447
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000448 if (Hdr->NumberOfRvaAndSize > 0) {
449 DictScope D(W, "DataDirectory");
450 static const char * const directory[] = {
451 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
452 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
453 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
454 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
455 };
456
457 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
458 printDataDirectory(i, directory[i]);
Rui Ueyamaed64342b2013-07-19 23:23:29 +0000459 }
Rui Ueyama82ebd8e2013-06-12 19:10:33 +0000460 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000461}
462
Rui Ueyama10ed9dd2014-01-26 04:15:52 +0000463void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
464 W.printHex("BaseOfData", Hdr->BaseOfData);
465}
466
467void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
468
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000469void COFFDumper::printCodeViewLineTables(const SectionRef &Section) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000470 StringRef Data;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000471 if (error(Section.getContents(Data)))
472 return;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000473
474 SmallVector<StringRef, 10> FunctionNames;
475 StringMap<StringRef> FunctionLineTables;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000476
477 ListScope D(W, "CodeViewLineTables");
478 {
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000479 // FIXME: Add more offset correctness checks.
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000480 DataExtractor DE(Data, true, 4);
481 uint32_t Offset = 0,
482 Magic = DE.getU32(&Offset);
483 W.printHex("Magic", Magic);
484 if (Magic != COFF::DEBUG_SECTION_MAGIC) {
485 error(object_error::parse_failed);
486 return;
487 }
488
489 bool Finished = false;
490 while (DE.isValidOffset(Offset) && !Finished) {
491 // The section consists of a number of subsection in the following format:
492 // |Type|PayloadSize|Payload...|
493 uint32_t SubSectionType = DE.getU32(&Offset),
494 PayloadSize = DE.getU32(&Offset);
495 ListScope S(W, "Subsection");
496 W.printHex("Type", SubSectionType);
497 W.printHex("PayloadSize", PayloadSize);
498 if (PayloadSize > Data.size() - Offset) {
499 error(object_error::parse_failed);
500 return;
501 }
502
503 // Print the raw contents to simplify debugging if anything goes wrong
504 // afterwards.
505 StringRef Contents = Data.substr(Offset, PayloadSize);
506 W.printBinaryBlock("Contents", Contents);
507
508 switch (SubSectionType) {
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000509 case COFF::DEBUG_SYMBOL_SUBSECTION:
510 printCodeViewSymbolsSubsection(Contents, Section, Offset);
511 break;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000512 case COFF::DEBUG_LINE_TABLE_SUBSECTION: {
513 // Holds a PC to file:line table. Some data to parse this subsection is
514 // stored in the other subsections, so just check sanity and store the
515 // pointers for deferred processing.
516
517 if (PayloadSize < 12) {
518 // There should be at least three words to store two function
519 // relocations and size of the code.
520 error(object_error::parse_failed);
521 return;
522 }
523
524 StringRef FunctionName;
Saleem Abdulrasool5dd27f42014-05-25 20:26:37 +0000525 if (error(resolveSymbolName(Obj->getCOFFSection(Section), Offset,
526 FunctionName)))
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000527 return;
528 W.printString("FunctionName", FunctionName);
529 if (FunctionLineTables.count(FunctionName) != 0) {
530 // Saw debug info for this function already?
531 error(object_error::parse_failed);
532 return;
533 }
534
535 FunctionLineTables[FunctionName] = Contents;
536 FunctionNames.push_back(FunctionName);
537 break;
538 }
539 case COFF::DEBUG_STRING_TABLE_SUBSECTION:
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000540 if (PayloadSize == 0 || CVStringTable.data() != nullptr ||
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000541 Contents.back() != '\0') {
542 // Empty or duplicate or non-null-terminated subsection.
543 error(object_error::parse_failed);
544 return;
545 }
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000546 CVStringTable = Contents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000547 break;
548 case COFF::DEBUG_INDEX_SUBSECTION:
549 // Holds the translation table from file indices
550 // to offsets in the string table.
551
Craig Toppere6cb63e2014-04-25 04:24:47 +0000552 if (PayloadSize == 0 ||
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000553 CVFileIndexToStringOffsetTable.data() != nullptr) {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000554 // Empty or duplicate subsection.
555 error(object_error::parse_failed);
556 return;
557 }
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000558 CVFileIndexToStringOffsetTable = Contents;
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000559 break;
560 }
561 Offset += PayloadSize;
562
563 // Align the reading pointer by 4.
564 Offset += (-Offset) % 4;
565 }
566 }
567
568 // Dump the line tables now that we've read all the subsections and know all
569 // the required information.
570 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
571 StringRef Name = FunctionNames[I];
572 ListScope S(W, "FunctionLineTable");
573 W.printString("FunctionName", Name);
574
575 DataExtractor DE(FunctionLineTables[Name], true, 4);
576 uint32_t Offset = 8; // Skip relocations.
577 uint32_t FunctionSize = DE.getU32(&Offset);
578 W.printHex("CodeSize", FunctionSize);
579 while (DE.isValidOffset(Offset)) {
580 // For each range of lines with the same filename, we have a segment
581 // in the line table. The filename string is accessed using double
582 // indirection to the string table subsection using the index subsection.
583 uint32_t OffsetInIndex = DE.getU32(&Offset),
584 SegmentLength = DE.getU32(&Offset),
585 FullSegmentSize = DE.getU32(&Offset);
586 if (FullSegmentSize != 12 + 8 * SegmentLength) {
587 error(object_error::parse_failed);
588 return;
589 }
590
591 uint32_t FilenameOffset;
592 {
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000593 DataExtractor SDE(CVFileIndexToStringOffsetTable, true, 4);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000594 uint32_t OffsetInSDE = OffsetInIndex;
595 if (!SDE.isValidOffset(OffsetInSDE)) {
596 error(object_error::parse_failed);
597 return;
598 }
599 FilenameOffset = SDE.getU32(&OffsetInSDE);
600 }
601
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000602 if (FilenameOffset == 0 || FilenameOffset + 1 >= CVStringTable.size() ||
603 CVStringTable.data()[FilenameOffset - 1] != '\0') {
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000604 // Each string in an F3 subsection should be preceded by a null
605 // character.
606 error(object_error::parse_failed);
607 return;
608 }
609
Timur Iskhodzhanov11603332014-10-06 16:59:44 +0000610 StringRef Filename(CVStringTable.data() + FilenameOffset);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000611 ListScope S(W, "FilenameSegment");
612 W.printString("Filename", Filename);
613 for (unsigned J = 0; J != SegmentLength && DE.isValidOffset(Offset);
614 ++J) {
615 // Then go the (PC, LineNumber) pairs. The line number is stored in the
616 // least significant 31 bits of the respective word in the table.
617 uint32_t PC = DE.getU32(&Offset),
618 LineNumber = DE.getU32(&Offset) & 0x7fffffff;
619 if (PC >= FunctionSize) {
620 error(object_error::parse_failed);
621 return;
622 }
623 char Buffer[32];
624 format("+0x%X", PC).snprint(Buffer, 32);
625 W.printNumber(Buffer, LineNumber);
626 }
627 }
628 }
629}
630
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000631void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
632 const SectionRef &Section,
633 uint32_t OffsetInSection) {
634 if (Subsection.size() == 0) {
635 error(object_error::parse_failed);
636 return;
637 }
638 DataExtractor DE(Subsection, true, 4);
639 uint32_t Offset = 0;
640
641 // Function-level subsections have "procedure start" and "procedure end"
642 // commands that should come in pairs and surround relevant info.
643 bool InFunctionScope = false;
644 while (DE.isValidOffset(Offset)) {
645 // Read subsection segments one by one.
646 uint16_t Size = DE.getU16(&Offset);
647 // The section size includes the size of the type identifier.
648 if (Size < 2 || !DE.isValidOffsetForDataOfSize(Offset, Size)) {
649 error(object_error::parse_failed);
650 return;
651 }
652 Size -= 2;
653 uint16_t Type = DE.getU16(&Offset);
654 switch (Type) {
655 case COFF::DEBUG_SYMBOL_TYPE_PROC_START: {
656 DictScope S(W, "ProcStart");
657 if (InFunctionScope || Size < 36) {
658 error(object_error::parse_failed);
659 return;
660 }
661 InFunctionScope = true;
662
663 // We're currently interested in a limited subset of fields in this
664 // segment, just ignore the rest of the fields for now.
665 uint8_t Unused[12];
666 DE.getU8(&Offset, Unused, 12);
667 uint32_t CodeSize = DE.getU32(&Offset);
668 DE.getU8(&Offset, Unused, 12);
669 StringRef SectionName;
670 if (error(resolveSymbolName(Obj->getCOFFSection(Section),
671 OffsetInSection + Offset, SectionName)))
672 return;
673 Offset += 4;
674 DE.getU8(&Offset, Unused, 3);
Timur Iskhodzhanova11b32b2014-11-12 20:10:09 +0000675 StringRef DisplayName = DE.getCStr(&Offset);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000676 if (!DE.isValidOffset(Offset)) {
677 error(object_error::parse_failed);
678 return;
679 }
Timur Iskhodzhanova11b32b2014-11-12 20:10:09 +0000680 W.printString("DisplayName", DisplayName);
Timur Iskhodzhanov56af52f2014-10-23 22:25:31 +0000681 W.printString("Section", SectionName);
682 W.printHex("CodeSize", CodeSize);
683
684 break;
685 }
686 case COFF::DEBUG_SYMBOL_TYPE_PROC_END: {
687 W.startLine() << "ProcEnd\n";
688 if (!InFunctionScope || Size > 0) {
689 error(object_error::parse_failed);
690 return;
691 }
692 InFunctionScope = false;
693 break;
694 }
695 default:
696 Offset += Size;
697 break;
698 }
699 }
700
701 if (InFunctionScope)
702 error(object_error::parse_failed);
703}
704
Eric Christopher9cad53c2013-04-03 18:31:38 +0000705void COFFDumper::printSections() {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000706 ListScope SectionsD(W, "Sections");
707 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000708 for (const SectionRef &Sec : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000709 ++SectionNumber;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000710 const coff_section *Section = Obj->getCOFFSection(Sec);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000711
712 StringRef Name;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000713 if (error(Sec.getName(Name)))
714 Name = "";
Eric Christopher9cad53c2013-04-03 18:31:38 +0000715
716 DictScope D(W, "Section");
717 W.printNumber("Number", SectionNumber);
718 W.printBinary("Name", Name, Section->Name);
719 W.printHex ("VirtualSize", Section->VirtualSize);
720 W.printHex ("VirtualAddress", Section->VirtualAddress);
721 W.printNumber("RawDataSize", Section->SizeOfRawData);
722 W.printHex ("PointerToRawData", Section->PointerToRawData);
723 W.printHex ("PointerToRelocations", Section->PointerToRelocations);
724 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);
725 W.printNumber("RelocationCount", Section->NumberOfRelocations);
726 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
727 W.printFlags ("Characteristics", Section->Characteristics,
728 makeArrayRef(ImageSectionCharacteristics),
729 COFF::SectionCharacteristics(0x00F00000));
730
731 if (opts::SectionRelocations) {
732 ListScope D(W, "Relocations");
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000733 for (const RelocationRef &Reloc : Sec.relocations())
734 printRelocation(Sec, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000735 }
736
737 if (opts::SectionSymbols) {
738 ListScope D(W, "Symbols");
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000739 for (const SymbolRef &Symbol : Obj->symbols()) {
Rafael Espindola80291272014-10-08 15:28:58 +0000740 if (!Sec.containsSymbol(Symbol))
Eric Christopher9cad53c2013-04-03 18:31:38 +0000741 continue;
742
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000743 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000744 }
745 }
746
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000747 if (Name == ".debug$S" && opts::CodeViewLineTables)
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000748 printCodeViewLineTables(Sec);
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000749
David Majnemerdac39852014-09-26 22:32:16 +0000750 if (opts::SectionData &&
751 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000752 StringRef Data;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000753 if (error(Sec.getContents(Data)))
754 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000755
756 W.printBinaryBlock("SectionData", Data);
757 }
758 }
759}
760
761void COFFDumper::printRelocations() {
762 ListScope D(W, "Relocations");
763
Eric Christopher9cad53c2013-04-03 18:31:38 +0000764 int SectionNumber = 0;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000765 for (const SectionRef &Section : Obj->sections()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000766 ++SectionNumber;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000767 StringRef Name;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000768 if (error(Section.getName(Name)))
Eric Christopher9cad53c2013-04-03 18:31:38 +0000769 continue;
770
771 bool PrintedGroup = false;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000772 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000773 if (!PrintedGroup) {
774 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
775 W.indent();
776 PrintedGroup = true;
777 }
778
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000779 printRelocation(Section, Reloc);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000780 }
781
782 if (PrintedGroup) {
783 W.unindent();
784 W.startLine() << "}\n";
785 }
786 }
787}
788
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000789void COFFDumper::printRelocation(const SectionRef &Section,
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000790 const RelocationRef &Reloc) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000791 uint64_t Offset;
792 uint64_t RelocType;
793 SmallString<32> RelocName;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000794 StringRef SymbolName;
795 StringRef Contents;
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000796 if (error(Reloc.getOffset(Offset)))
797 return;
798 if (error(Reloc.getType(RelocType)))
799 return;
800 if (error(Reloc.getTypeName(RelocName)))
801 return;
802 symbol_iterator Symbol = Reloc.getSymbol();
803 if (error(Symbol->getName(SymbolName)))
804 return;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000805 if (error(Section.getContents(Contents)))
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000806 return;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000807
Nico Rieckf3f0b792013-04-12 04:01:52 +0000808 if (opts::ExpandRelocs) {
809 DictScope Group(W, "Relocation");
810 W.printHex("Offset", Offset);
811 W.printNumber("Type", RelocName, RelocType);
812 W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
813 } else {
814 raw_ostream& OS = W.startLine();
815 OS << W.hex(Offset)
816 << " " << RelocName
817 << " " << (SymbolName.size() > 0 ? SymbolName : "-")
818 << "\n";
819 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000820}
821
822void COFFDumper::printSymbols() {
823 ListScope Group(W, "Symbols");
824
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000825 for (const SymbolRef &Symbol : Obj->symbols())
826 printSymbol(Symbol);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000827}
828
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000829void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000830
David Majnemerf4dc4562014-09-20 00:25:06 +0000831static StringRef getSectionName(const llvm::object::COFFObjectFile *Obj,
832 COFFSymbolRef Symbol,
833 const coff_section *Section) {
834 if (Section) {
835 StringRef SectionName;
836 Obj->getSectionName(Section, SectionName);
837 return SectionName;
838 }
839 int32_t SectionNumber = Symbol.getSectionNumber();
840 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
841 return "IMAGE_SYM_DEBUG";
842 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
843 return "IMAGE_SYM_ABSOLUTE";
844 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
845 return "IMAGE_SYM_UNDEFINED";
846 return "";
847}
848
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000849void COFFDumper::printSymbol(const SymbolRef &Sym) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000850 DictScope D(W, "Symbol");
851
David Majnemer44f51e52014-09-10 12:51:52 +0000852 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000853 const coff_section *Section;
David Majnemer44f51e52014-09-10 12:51:52 +0000854 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000855 W.startLine() << "Invalid section number: " << EC.message() << "\n";
856 W.flush();
857 return;
858 }
859
860 StringRef SymbolName;
861 if (Obj->getSymbolName(Symbol, SymbolName))
862 SymbolName = "";
863
David Majnemerf4dc4562014-09-20 00:25:06 +0000864 StringRef SectionName = getSectionName(Obj, Symbol, Section);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000865
866 W.printString("Name", SymbolName);
David Majnemer44f51e52014-09-10 12:51:52 +0000867 W.printNumber("Value", Symbol.getValue());
868 W.printNumber("Section", SectionName, Symbol.getSectionNumber());
869 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
870 W.printEnum ("ComplexType", Symbol.getComplexType(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000871 makeArrayRef(ImageSymDType));
David Majnemer44f51e52014-09-10 12:51:52 +0000872 W.printEnum ("StorageClass", Symbol.getStorageClass(),
Eric Christopher9cad53c2013-04-03 18:31:38 +0000873 makeArrayRef(ImageSymClass));
David Majnemer44f51e52014-09-10 12:51:52 +0000874 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000875
David Majnemer44f51e52014-09-10 12:51:52 +0000876 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
877 if (Symbol.isFunctionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000878 const coff_aux_function_definition *Aux;
David Majnemer44f51e52014-09-10 12:51:52 +0000879 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
Eric Christopher9cad53c2013-04-03 18:31:38 +0000880 break;
881
882 DictScope AS(W, "AuxFunctionDef");
883 W.printNumber("TagIndex", Aux->TagIndex);
884 W.printNumber("TotalSize", Aux->TotalSize);
David Majnemerf3a2af52014-03-19 04:33:27 +0000885 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000886 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000887
David Majnemerc7d7c6f2014-10-31 05:07:00 +0000888 } else if (Symbol.isAnyUndefined()) {
David Majnemerf3a2af52014-03-19 04:33:27 +0000889 const coff_aux_weak_external *Aux;
David Majnemer44f51e52014-09-10 12:51:52 +0000890 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
Eric Christopher9cad53c2013-04-03 18:31:38 +0000891 break;
892
David Majnemer44f51e52014-09-10 12:51:52 +0000893 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000894 StringRef LinkedName;
David Majnemer44f51e52014-09-10 12:51:52 +0000895 std::error_code EC = Linked.getError();
896 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000897 LinkedName = "";
898 error(EC);
899 }
900
901 DictScope AS(W, "AuxWeakExternal");
902 W.printNumber("Linked", LinkedName, Aux->TagIndex);
903 W.printEnum ("Search", Aux->Characteristics,
904 makeArrayRef(WeakExternalCharacteristics));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000905
David Majnemer44f51e52014-09-10 12:51:52 +0000906 } else if (Symbol.isFileRecord()) {
907 const char *FileName;
908 if (error(getSymbolAuxData(Obj, Symbol, I, FileName)))
Eric Christopher9cad53c2013-04-03 18:31:38 +0000909 break;
910
Nico Rieck0ab8e602013-04-22 08:35:11 +0000911 DictScope AS(W, "AuxFileRecord");
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +0000912
David Majnemer44f51e52014-09-10 12:51:52 +0000913 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
914 Obj->getSymbolTableEntrySize());
Saleem Abdulrasoold38c6b12014-04-14 02:37:23 +0000915 W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
Saleem Abdulrasool3b5e0012014-04-16 04:15:29 +0000916 break;
David Majnemer44f51e52014-09-10 12:51:52 +0000917 } else if (Symbol.isSectionDefinition()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000918 const coff_aux_section_definition *Aux;
David Majnemer44f51e52014-09-10 12:51:52 +0000919 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
Eric Christopher9cad53c2013-04-03 18:31:38 +0000920 break;
921
David Majnemer4d571592014-09-15 19:42:42 +0000922 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
923
Eric Christopher9cad53c2013-04-03 18:31:38 +0000924 DictScope AS(W, "AuxSectionDef");
925 W.printNumber("Length", Aux->Length);
926 W.printNumber("RelocationCount", Aux->NumberOfRelocations);
927 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
928 W.printHex("Checksum", Aux->CheckSum);
David Majnemer4d571592014-09-15 19:42:42 +0000929 W.printNumber("Number", AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000930 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000931
Nico Riecka711dee2013-04-22 08:34:59 +0000932 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
Eric Christopher9cad53c2013-04-03 18:31:38 +0000933 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
934 const coff_section *Assoc;
935 StringRef AssocName;
Rafael Espindola4453e42942014-06-13 03:07:50 +0000936 std::error_code EC;
David Majnemer4d571592014-09-15 19:42:42 +0000937 if ((EC = Obj->getSection(AuxNumber, Assoc)) ||
Eric Christopher9cad53c2013-04-03 18:31:38 +0000938 (EC = Obj->getSectionName(Assoc, AssocName))) {
939 AssocName = "";
940 error(EC);
941 }
942
David Majnemer4d571592014-09-15 19:42:42 +0000943 W.printNumber("AssocSection", AssocName, AuxNumber);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000944 }
David Majnemer44f51e52014-09-10 12:51:52 +0000945 } else if (Symbol.isCLRToken()) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000946 const coff_aux_clr_token *Aux;
David Majnemer44f51e52014-09-10 12:51:52 +0000947 if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
Eric Christopher9cad53c2013-04-03 18:31:38 +0000948 break;
949
David Majnemer44f51e52014-09-10 12:51:52 +0000950 ErrorOr<COFFSymbolRef> ReferredSym =
951 Obj->getSymbol(Aux->SymbolTableIndex);
Nico Rieck8678acd2014-03-17 01:46:52 +0000952 StringRef ReferredName;
David Majnemer44f51e52014-09-10 12:51:52 +0000953 std::error_code EC = ReferredSym.getError();
954 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
Nico Rieck8678acd2014-03-17 01:46:52 +0000955 ReferredName = "";
956 error(EC);
957 }
958
Eric Christopher9cad53c2013-04-03 18:31:38 +0000959 DictScope AS(W, "AuxCLRToken");
960 W.printNumber("AuxType", Aux->AuxType);
961 W.printNumber("Reserved", Aux->Reserved);
Nico Rieck8678acd2014-03-17 01:46:52 +0000962 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000963
964 } else {
965 W.startLine() << "<unhandled auxiliary record>\n";
966 }
967 }
968}
969
970void COFFDumper::printUnwindInfo() {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000971 ListScope D(W, "UnwindInformation");
David Majnemer44f51e52014-09-10 12:51:52 +0000972 switch (Obj->getMachine()) {
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +0000973 case COFF::IMAGE_FILE_MACHINE_AMD64: {
974 Win64EH::Dumper Dumper(W);
Rafael Espindola4453e42942014-06-13 03:07:50 +0000975 Win64EH::Dumper::SymbolResolver
976 Resolver = [](const object::coff_section *Section, uint64_t Offset,
977 SymbolRef &Symbol, void *user_data) -> std::error_code {
978 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
979 return Dumper->resolveSymbol(Section, Offset, Symbol);
980 };
Saleem Abdulrasool65dbbb52014-05-25 21:37:59 +0000981 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +0000982 Dumper.printData(Ctx);
983 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000984 }
Saleem Abdulrasoole6971ca2014-06-04 15:47:15 +0000985 case COFF::IMAGE_FILE_MACHINE_ARMNT: {
986 ARM::WinEH::Decoder Decoder(W);
987 Decoder.dumpProcedureData(*Obj);
988 break;
989 }
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +0000990 default:
David Majnemer44f51e52014-09-10 12:51:52 +0000991 W.printEnum("unsupported Image Machine", Obj->getMachine(),
Saleem Abdulrasoole8839a72014-05-25 20:26:45 +0000992 makeArrayRef(ImageFileMachineType));
993 break;
Eric Christopher9cad53c2013-04-03 18:31:38 +0000994 }
995}
996
Rui Ueyama979fb402014-10-09 02:16:38 +0000997void COFFDumper::printImportedSymbols(
998 iterator_range<imported_symbol_iterator> Range) {
999 for (const ImportedSymbolRef &I : Range) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001000 StringRef Sym;
Rui Ueyama979fb402014-10-09 02:16:38 +00001001 if (error(I.getSymbolName(Sym))) return;
Rui Ueyama15d99352014-10-03 00:41:58 +00001002 uint16_t Ordinal;
Rui Ueyama979fb402014-10-09 02:16:38 +00001003 if (error(I.getOrdinal(Ordinal))) return;
Rui Ueyama15d99352014-10-03 00:41:58 +00001004 W.printNumber("Symbol", Sym, Ordinal);
1005 }
1006}
1007
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001008void COFFDumper::printDelayImportedSymbols(
1009 const DelayImportDirectoryEntryRef &I,
1010 iterator_range<imported_symbol_iterator> Range) {
1011 int Index = 0;
1012 for (const ImportedSymbolRef &S : Range) {
1013 DictScope Import(W, "Import");
1014 StringRef Sym;
1015 if (error(S.getSymbolName(Sym))) return;
1016 uint16_t Ordinal;
1017 if (error(S.getOrdinal(Ordinal))) return;
1018 W.printNumber("Symbol", Sym, Ordinal);
1019 uint64_t Addr;
1020 if (error(I.getImportAddress(Index++, Addr))) return;
1021 W.printHex("Address", Addr);
1022 }
1023}
1024
Rui Ueyama1e152d52014-10-02 17:02:18 +00001025void COFFDumper::printCOFFImports() {
Rui Ueyama15d99352014-10-03 00:41:58 +00001026 // Regular imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001027 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
Rui Ueyama1e152d52014-10-02 17:02:18 +00001028 DictScope Import(W, "Import");
1029 StringRef Name;
Rui Ueyama979fb402014-10-09 02:16:38 +00001030 if (error(I.getName(Name))) return;
Rui Ueyama1e152d52014-10-02 17:02:18 +00001031 W.printString("Name", Name);
1032 uint32_t Addr;
Rui Ueyama979fb402014-10-09 02:16:38 +00001033 if (error(I.getImportLookupTableRVA(Addr))) return;
Rui Ueyama1e152d52014-10-02 17:02:18 +00001034 W.printHex("ImportLookupTableRVA", Addr);
Rui Ueyama979fb402014-10-09 02:16:38 +00001035 if (error(I.getImportAddressTableRVA(Addr))) return;
Rui Ueyama1e152d52014-10-02 17:02:18 +00001036 W.printHex("ImportAddressTableRVA", Addr);
Rui Ueyama979fb402014-10-09 02:16:38 +00001037 printImportedSymbols(I.imported_symbols());
Rui Ueyama15d99352014-10-03 00:41:58 +00001038 }
1039
1040 // Delay imports
Rui Ueyama979fb402014-10-09 02:16:38 +00001041 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
Rui Ueyama15d99352014-10-03 00:41:58 +00001042 DictScope Import(W, "DelayImport");
1043 StringRef Name;
Rui Ueyama979fb402014-10-09 02:16:38 +00001044 if (error(I.getName(Name))) return;
Rui Ueyama15d99352014-10-03 00:41:58 +00001045 W.printString("Name", Name);
Rui Ueyama1af08652014-10-03 18:07:18 +00001046 const delay_import_directory_table_entry *Table;
Rui Ueyama979fb402014-10-09 02:16:38 +00001047 if (error(I.getDelayImportTable(Table))) return;
Rui Ueyama1af08652014-10-03 18:07:18 +00001048 W.printHex("Attributes", Table->Attributes);
1049 W.printHex("ModuleHandle", Table->ModuleHandle);
1050 W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
1051 W.printHex("ImportNameTable", Table->DelayImportNameTable);
1052 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
1053 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
Rui Ueyamaffa4ceb2014-11-13 03:22:54 +00001054 printDelayImportedSymbols(I, I.imported_symbols());
Rui Ueyama1e152d52014-10-02 17:02:18 +00001055 }
1056}
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +00001057
1058void COFFDumper::printCOFFDirectives() {
1059 for (const SectionRef &Section : Obj->sections()) {
1060 StringRef Contents;
1061 StringRef Name;
1062
1063 if (error(Section.getName(Name)))
1064 continue;
1065 if (Name != ".drectve")
1066 continue;
1067
1068 if (error(Section.getContents(Contents)))
1069 return;
1070
1071 W.printString("Directive(s)", Contents);
1072 }
1073}