llvm-readobj: fix off-by-one error in COFFDumper
[oota-llvm.git] / tools / llvm-readobj / COFFDumper.cpp
1 //===-- 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"
16 #include "ARMWinEHPrinter.h"
17 #include "Error.h"
18 #include "ObjDumper.h"
19 #include "StreamWriter.h"
20 #include "Win64EHDumper.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/SmallString.h"
23 #include "llvm/Object/COFF.h"
24 #include "llvm/Object/ObjectFile.h"
25 #include "llvm/Support/COFF.h"
26 #include "llvm/Support/Casting.h"
27 #include "llvm/Support/Compiler.h"
28 #include "llvm/Support/DataExtractor.h"
29 #include "llvm/Support/Format.h"
30 #include "llvm/Support/SourceMgr.h"
31 #include "llvm/Support/Win64EH.h"
32 #include "llvm/Support/raw_ostream.h"
33 #include <algorithm>
34 #include <cstring>
35 #include <system_error>
36 #include <time.h>
37
38 using namespace llvm;
39 using namespace llvm::object;
40 using namespace llvm::Win64EH;
41
42 namespace {
43
44 class COFFDumper : public ObjDumper {
45 public:
46   COFFDumper(const llvm::object::COFFObjectFile *Obj, StreamWriter& Writer)
47     : ObjDumper(Writer)
48     , Obj(Obj) {
49     cacheRelocations();
50   }
51
52   void printFileHeaders() override;
53   void printSections() override;
54   void printRelocations() override;
55   void printSymbols() override;
56   void printDynamicSymbols() override;
57   void printUnwindInfo() override;
58   void printCOFFImports() override;
59   void printCOFFDirectives() override;
60   void printCOFFBaseReloc() override;
61
62 private:
63   void printSymbol(const SymbolRef &Sym);
64   void printRelocation(const SectionRef &Section, const RelocationRef &Reloc);
65   void printDataDirectory(uint32_t Index, const std::string &FieldName);
66
67   void printDOSHeader(const dos_header *DH);
68   template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
69   void printBaseOfDataField(const pe32_header *Hdr);
70   void printBaseOfDataField(const pe32plus_header *Hdr);
71
72   void printCodeViewLineTables(const SectionRef &Section);
73
74   void printCodeViewSymbolsSubsection(StringRef Subsection,
75                                       const SectionRef &Section,
76                                       uint32_t Offset);
77
78   void cacheRelocations();
79
80   std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,
81                                 SymbolRef &Sym);
82   std::error_code resolveSymbolName(const coff_section *Section,
83                                     uint64_t Offset, StringRef &Name);
84   void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);
85   void printDelayImportedSymbols(
86       const DelayImportDirectoryEntryRef &I,
87       iterator_range<imported_symbol_iterator> Range);
88
89   typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
90
91   const llvm::object::COFFObjectFile *Obj;
92   RelocMapTy RelocMap;
93   StringRef CVFileIndexToStringOffsetTable;
94   StringRef CVStringTable;
95 };
96
97 } // namespace
98
99
100 namespace llvm {
101
102 std::error_code createCOFFDumper(const object::ObjectFile *Obj,
103                                  StreamWriter &Writer,
104                                  std::unique_ptr<ObjDumper> &Result) {
105   const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
106   if (!COFFObj)
107     return readobj_error::unsupported_obj_file_format;
108
109   Result.reset(new COFFDumper(COFFObj, Writer));
110   return readobj_error::success;
111 }
112
113 } // namespace llvm
114
115 // Given a a section and an offset into this section the function returns the
116 // symbol used for the relocation at the offset.
117 std::error_code COFFDumper::resolveSymbol(const coff_section *Section,
118                                           uint64_t Offset, SymbolRef &Sym) {
119   const auto &Relocations = RelocMap[Section];
120   for (const auto &Relocation : Relocations) {
121     uint64_t RelocationOffset;
122     if (std::error_code EC = Relocation.getOffset(RelocationOffset))
123       return EC;
124
125     if (RelocationOffset == Offset) {
126       Sym = *Relocation.getSymbol();
127       return readobj_error::success;
128     }
129   }
130   return readobj_error::unknown_symbol;
131 }
132
133 // Given a section and an offset into this section the function returns the name
134 // of the symbol used for the relocation at the offset.
135 std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,
136                                               uint64_t Offset,
137                                               StringRef &Name) {
138   SymbolRef Symbol;
139   if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))
140     return EC;
141   if (std::error_code EC = Symbol.getName(Name))
142     return EC;
143   return object_error::success;
144 }
145
146 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
147   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN  ),
148   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33     ),
149   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64    ),
150   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM      ),
151   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT    ),
152   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC      ),
153   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386     ),
154   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64     ),
155   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R     ),
156   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16   ),
157   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU  ),
158   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
159   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC  ),
160   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
161   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000    ),
162   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3      ),
163   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP   ),
164   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4      ),
165   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5      ),
166   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB    ),
167   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
168 };
169
170 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
171   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED        ),
172   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE       ),
173   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED     ),
174   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED    ),
175   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM     ),
176   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE    ),
177   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO      ),
178   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE          ),
179   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED         ),
180   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
181   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP      ),
182   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM                 ),
183   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL                    ),
184   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY         ),
185   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI      )
186 };
187
188 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
189   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN                ),
190   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE                 ),
191   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI            ),
192   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI            ),
193   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI              ),
194   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI         ),
195   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION        ),
196   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
197   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER     ),
198   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM                ),
199   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX                   ),
200 };
201
202 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
203   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA      ),
204   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE         ),
205   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY      ),
206   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT            ),
207   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION         ),
208   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH               ),
209   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND              ),
210   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER         ),
211   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER           ),
212   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF             ),
213   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
214 };
215
216 static const EnumEntry<COFF::SectionCharacteristics>
217 ImageSectionCharacteristics[] = {
218   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD           ),
219   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE              ),
220   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA  ),
221   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
222   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER             ),
223   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO              ),
224   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE            ),
225   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT            ),
226   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL                 ),
227   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE         ),
228   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT             ),
229   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED            ),
230   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD           ),
231   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES          ),
232   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES          ),
233   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES          ),
234   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES          ),
235   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES         ),
236   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES         ),
237   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES         ),
238   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES        ),
239   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES        ),
240   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES        ),
241   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES       ),
242   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES       ),
243   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES       ),
244   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES       ),
245   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL       ),
246   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE       ),
247   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED        ),
248   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED         ),
249   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED            ),
250   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE           ),
251   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ              ),
252   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE             )
253 };
254
255 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
256   { "Null"  , COFF::IMAGE_SYM_TYPE_NULL   },
257   { "Void"  , COFF::IMAGE_SYM_TYPE_VOID   },
258   { "Char"  , COFF::IMAGE_SYM_TYPE_CHAR   },
259   { "Short" , COFF::IMAGE_SYM_TYPE_SHORT  },
260   { "Int"   , COFF::IMAGE_SYM_TYPE_INT    },
261   { "Long"  , COFF::IMAGE_SYM_TYPE_LONG   },
262   { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT  },
263   { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
264   { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
265   { "Union" , COFF::IMAGE_SYM_TYPE_UNION  },
266   { "Enum"  , COFF::IMAGE_SYM_TYPE_ENUM   },
267   { "MOE"   , COFF::IMAGE_SYM_TYPE_MOE    },
268   { "Byte"  , COFF::IMAGE_SYM_TYPE_BYTE   },
269   { "Word"  , COFF::IMAGE_SYM_TYPE_WORD   },
270   { "UInt"  , COFF::IMAGE_SYM_TYPE_UINT   },
271   { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD  }
272 };
273
274 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
275   { "Null"    , COFF::IMAGE_SYM_DTYPE_NULL     },
276   { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER  },
277   { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
278   { "Array"   , COFF::IMAGE_SYM_DTYPE_ARRAY    }
279 };
280
281 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
282   { "EndOfFunction"  , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION  },
283   { "Null"           , COFF::IMAGE_SYM_CLASS_NULL             },
284   { "Automatic"      , COFF::IMAGE_SYM_CLASS_AUTOMATIC        },
285   { "External"       , COFF::IMAGE_SYM_CLASS_EXTERNAL         },
286   { "Static"         , COFF::IMAGE_SYM_CLASS_STATIC           },
287   { "Register"       , COFF::IMAGE_SYM_CLASS_REGISTER         },
288   { "ExternalDef"    , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF     },
289   { "Label"          , COFF::IMAGE_SYM_CLASS_LABEL            },
290   { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL  },
291   { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
292   { "Argument"       , COFF::IMAGE_SYM_CLASS_ARGUMENT         },
293   { "StructTag"      , COFF::IMAGE_SYM_CLASS_STRUCT_TAG       },
294   { "MemberOfUnion"  , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION  },
295   { "UnionTag"       , COFF::IMAGE_SYM_CLASS_UNION_TAG        },
296   { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION  },
297   { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
298   { "EnumTag"        , COFF::IMAGE_SYM_CLASS_ENUM_TAG         },
299   { "MemberOfEnum"   , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM   },
300   { "RegisterParam"  , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM   },
301   { "BitField"       , COFF::IMAGE_SYM_CLASS_BIT_FIELD        },
302   { "Block"          , COFF::IMAGE_SYM_CLASS_BLOCK            },
303   { "Function"       , COFF::IMAGE_SYM_CLASS_FUNCTION         },
304   { "EndOfStruct"    , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT    },
305   { "File"           , COFF::IMAGE_SYM_CLASS_FILE             },
306   { "Section"        , COFF::IMAGE_SYM_CLASS_SECTION          },
307   { "WeakExternal"   , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL    },
308   { "CLRToken"       , COFF::IMAGE_SYM_CLASS_CLR_TOKEN        }
309 };
310
311 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
312   { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
313   { "Any"         , COFF::IMAGE_COMDAT_SELECT_ANY          },
314   { "SameSize"    , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE    },
315   { "ExactMatch"  , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH  },
316   { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE  },
317   { "Largest"     , COFF::IMAGE_COMDAT_SELECT_LARGEST      },
318   { "Newest"      , COFF::IMAGE_COMDAT_SELECT_NEWEST       }
319 };
320
321 static const EnumEntry<COFF::WeakExternalCharacteristics>
322 WeakExternalCharacteristics[] = {
323   { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
324   { "Library"  , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY   },
325   { "Alias"    , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS     }
326 };
327
328 template <typename T>
329 static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,
330                                         COFFSymbolRef Symbol,
331                                         uint8_t AuxSymbolIdx, const T *&Aux) {
332   ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
333   AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());
334   Aux = reinterpret_cast<const T*>(AuxData.data());
335   return readobj_error::success;
336 }
337
338 void COFFDumper::cacheRelocations() {
339   for (const SectionRef &S : Obj->sections()) {
340     const coff_section *Section = Obj->getCOFFSection(S);
341
342     for (const RelocationRef &Reloc : S.relocations())
343       RelocMap[Section].push_back(Reloc);
344
345     // Sort relocations by address.
346     std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
347               relocAddressLess);
348   }
349 }
350
351 void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
352   const data_directory *Data;
353   if (Obj->getDataDirectory(Index, Data))
354     return;
355   W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
356   W.printHex(FieldName + "Size", Data->Size);
357 }
358
359 void COFFDumper::printFileHeaders() {
360   time_t TDS = Obj->getTimeDateStamp();
361   char FormattedTime[20] = { };
362   strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
363
364   {
365     DictScope D(W, "ImageFileHeader");
366     W.printEnum  ("Machine", Obj->getMachine(),
367                     makeArrayRef(ImageFileMachineType));
368     W.printNumber("SectionCount", Obj->getNumberOfSections());
369     W.printHex   ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());
370     W.printHex   ("PointerToSymbolTable", Obj->getPointerToSymbolTable());
371     W.printNumber("SymbolCount", Obj->getNumberOfSymbols());
372     W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());
373     W.printFlags ("Characteristics", Obj->getCharacteristics(),
374                     makeArrayRef(ImageFileCharacteristics));
375   }
376
377   // Print PE header. This header does not exist if this is an object file and
378   // not an executable.
379   const pe32_header *PEHeader = nullptr;
380   if (error(Obj->getPE32Header(PEHeader)))
381     return;
382   if (PEHeader)
383     printPEHeader<pe32_header>(PEHeader);
384
385   const pe32plus_header *PEPlusHeader = nullptr;
386   if (error(Obj->getPE32PlusHeader(PEPlusHeader)))
387     return;
388   if (PEPlusHeader)
389     printPEHeader<pe32plus_header>(PEPlusHeader);
390
391   if (const dos_header *DH = Obj->getDOSHeader())
392     printDOSHeader(DH);
393 }
394
395 void COFFDumper::printDOSHeader(const dos_header *DH) {
396   DictScope D(W, "DOSHeader");
397   W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));
398   W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);
399   W.printNumber("FileSizeInPages", DH->FileSizeInPages);
400   W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);
401   W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);
402   W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);
403   W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);
404   W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);
405   W.printNumber("InitialSP", DH->InitialSP);
406   W.printNumber("Checksum", DH->Checksum);
407   W.printNumber("InitialIP", DH->InitialIP);
408   W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);
409   W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);
410   W.printNumber("OverlayNumber", DH->OverlayNumber);
411   W.printNumber("OEMid", DH->OEMid);
412   W.printNumber("OEMinfo", DH->OEMinfo);
413   W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);
414 }
415
416 template <class PEHeader>
417 void COFFDumper::printPEHeader(const PEHeader *Hdr) {
418   DictScope D(W, "ImageOptionalHeader");
419   W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
420   W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
421   W.printNumber("SizeOfCode", Hdr->SizeOfCode);
422   W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
423   W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
424   W.printHex   ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
425   W.printHex   ("BaseOfCode", Hdr->BaseOfCode);
426   printBaseOfDataField(Hdr);
427   W.printHex   ("ImageBase", Hdr->ImageBase);
428   W.printNumber("SectionAlignment", Hdr->SectionAlignment);
429   W.printNumber("FileAlignment", Hdr->FileAlignment);
430   W.printNumber("MajorOperatingSystemVersion",
431                 Hdr->MajorOperatingSystemVersion);
432   W.printNumber("MinorOperatingSystemVersion",
433                 Hdr->MinorOperatingSystemVersion);
434   W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
435   W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
436   W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
437   W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
438   W.printNumber("SizeOfImage", Hdr->SizeOfImage);
439   W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
440   W.printEnum  ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
441   W.printFlags ("Characteristics", Hdr->DLLCharacteristics,
442                 makeArrayRef(PEDLLCharacteristics));
443   W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
444   W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
445   W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
446   W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
447   W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
448
449   if (Hdr->NumberOfRvaAndSize > 0) {
450     DictScope D(W, "DataDirectory");
451     static const char * const directory[] = {
452       "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
453       "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
454       "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
455       "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
456     };
457
458     for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
459       printDataDirectory(i, directory[i]);
460     }
461   }
462 }
463
464 void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
465   W.printHex("BaseOfData", Hdr->BaseOfData);
466 }
467
468 void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
469
470 void COFFDumper::printCodeViewLineTables(const SectionRef &Section) {
471   StringRef Data;
472   if (error(Section.getContents(Data)))
473     return;
474
475   SmallVector<StringRef, 10> FunctionNames;
476   StringMap<StringRef> FunctionLineTables;
477
478   ListScope D(W, "CodeViewLineTables");
479   {
480     // FIXME: Add more offset correctness checks.
481     DataExtractor DE(Data, true, 4);
482     uint32_t Offset = 0,
483              Magic = DE.getU32(&Offset);
484     W.printHex("Magic", Magic);
485     if (Magic != COFF::DEBUG_SECTION_MAGIC) {
486       error(object_error::parse_failed);
487       return;
488     }
489
490     bool Finished = false;
491     while (DE.isValidOffset(Offset) && !Finished) {
492       // The section consists of a number of subsection in the following format:
493       // |Type|PayloadSize|Payload...|
494       uint32_t SubSectionType = DE.getU32(&Offset),
495                PayloadSize = DE.getU32(&Offset);
496       ListScope S(W, "Subsection");
497       W.printHex("Type", SubSectionType);
498       W.printHex("PayloadSize", PayloadSize);
499       if (PayloadSize > Data.size() - Offset) {
500         error(object_error::parse_failed);
501         return;
502       }
503
504       // Print the raw contents to simplify debugging if anything goes wrong
505       // afterwards.
506       StringRef Contents = Data.substr(Offset, PayloadSize);
507       W.printBinaryBlock("Contents", Contents);
508
509       switch (SubSectionType) {
510       case COFF::DEBUG_SYMBOL_SUBSECTION:
511         printCodeViewSymbolsSubsection(Contents, Section, Offset);
512         break;
513       case COFF::DEBUG_LINE_TABLE_SUBSECTION: {
514         // Holds a PC to file:line table.  Some data to parse this subsection is
515         // stored in the other subsections, so just check sanity and store the
516         // pointers for deferred processing.
517
518         if (PayloadSize < 12) {
519           // There should be at least three words to store two function
520           // relocations and size of the code.
521           error(object_error::parse_failed);
522           return;
523         }
524
525         StringRef FunctionName;
526         if (error(resolveSymbolName(Obj->getCOFFSection(Section), Offset,
527                                     FunctionName)))
528           return;
529         W.printString("FunctionName", FunctionName);
530         if (FunctionLineTables.count(FunctionName) != 0) {
531           // Saw debug info for this function already?
532           error(object_error::parse_failed);
533           return;
534         }
535
536         FunctionLineTables[FunctionName] = Contents;
537         FunctionNames.push_back(FunctionName);
538         break;
539       }
540       case COFF::DEBUG_STRING_TABLE_SUBSECTION:
541         if (PayloadSize == 0 || CVStringTable.data() != nullptr ||
542             Contents.back() != '\0') {
543           // Empty or duplicate or non-null-terminated subsection.
544           error(object_error::parse_failed);
545           return;
546         }
547         CVStringTable = Contents;
548         break;
549       case COFF::DEBUG_INDEX_SUBSECTION:
550         // Holds the translation table from file indices
551         // to offsets in the string table.
552
553         if (PayloadSize == 0 ||
554             CVFileIndexToStringOffsetTable.data() != nullptr) {
555           // Empty or duplicate subsection.
556           error(object_error::parse_failed);
557           return;
558         }
559         CVFileIndexToStringOffsetTable = Contents;
560         break;
561       }
562       Offset += PayloadSize;
563
564       // Align the reading pointer by 4.
565       Offset += (-Offset) % 4;
566     }
567   }
568
569   // Dump the line tables now that we've read all the subsections and know all
570   // the required information.
571   for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
572     StringRef Name = FunctionNames[I];
573     ListScope S(W, "FunctionLineTable");
574     W.printString("FunctionName", Name);
575
576     DataExtractor DE(FunctionLineTables[Name], true, 4);
577     uint32_t Offset = 8;  // Skip relocations.
578     uint32_t FunctionSize = DE.getU32(&Offset);
579     W.printHex("CodeSize", FunctionSize);
580     while (DE.isValidOffset(Offset)) {
581       // For each range of lines with the same filename, we have a segment
582       // in the line table.  The filename string is accessed using double
583       // indirection to the string table subsection using the index subsection.
584       uint32_t OffsetInIndex = DE.getU32(&Offset),
585                SegmentLength   = DE.getU32(&Offset),
586                FullSegmentSize = DE.getU32(&Offset);
587       if (FullSegmentSize != 12 + 8 * SegmentLength) {
588         error(object_error::parse_failed);
589         return;
590       }
591
592       uint32_t FilenameOffset;
593       {
594         DataExtractor SDE(CVFileIndexToStringOffsetTable, true, 4);
595         uint32_t OffsetInSDE = OffsetInIndex;
596         if (!SDE.isValidOffset(OffsetInSDE)) {
597           error(object_error::parse_failed);
598           return;
599         }
600         FilenameOffset = SDE.getU32(&OffsetInSDE);
601       }
602
603       if (FilenameOffset == 0 || FilenameOffset + 1 >= CVStringTable.size() ||
604           CVStringTable.data()[FilenameOffset - 1] != '\0') {
605         // Each string in an F3 subsection should be preceded by a null
606         // character.
607         error(object_error::parse_failed);
608         return;
609       }
610
611       StringRef Filename(CVStringTable.data() + FilenameOffset);
612       ListScope S(W, "FilenameSegment");
613       W.printString("Filename", Filename);
614       for (unsigned J = 0; J != SegmentLength && DE.isValidOffset(Offset);
615            ++J) {
616         // Then go the (PC, LineNumber) pairs.  The line number is stored in the
617         // least significant 31 bits of the respective word in the table.
618         uint32_t PC = DE.getU32(&Offset),
619                  LineNumber = DE.getU32(&Offset) & 0x7fffffff;
620         if (PC >= FunctionSize) {
621           error(object_error::parse_failed);
622           return;
623         }
624         char Buffer[32];
625         format("+0x%X", PC).snprint(Buffer, 32);
626         W.printNumber(Buffer, LineNumber);
627       }
628     }
629   }
630 }
631
632 void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,
633                                                 const SectionRef &Section,
634                                                 uint32_t OffsetInSection) {
635   if (Subsection.size() == 0) {
636     error(object_error::parse_failed);
637     return;
638   }
639   DataExtractor DE(Subsection, true, 4);
640   uint32_t Offset = 0;
641
642   // Function-level subsections have "procedure start" and "procedure end"
643   // commands that should come in pairs and surround relevant info.
644   bool InFunctionScope = false;
645   while (DE.isValidOffset(Offset)) {
646     // Read subsection segments one by one.
647     uint16_t Size = DE.getU16(&Offset);
648     // The section size includes the size of the type identifier.
649     if (Size < 2 || !DE.isValidOffsetForDataOfSize(Offset, Size)) {
650       error(object_error::parse_failed);
651       return;
652     }
653     Size -= 2;
654     uint16_t Type = DE.getU16(&Offset);
655     switch (Type) {
656     case COFF::DEBUG_SYMBOL_TYPE_PROC_START: {
657       DictScope S(W, "ProcStart");
658       if (InFunctionScope || Size < 36) {
659         error(object_error::parse_failed);
660         return;
661       }
662       InFunctionScope = true;
663
664       // We're currently interested in a limited subset of fields in this
665       // segment, just ignore the rest of the fields for now.
666       uint8_t Unused[12];
667       DE.getU8(&Offset, Unused, 12);
668       uint32_t CodeSize = DE.getU32(&Offset);
669       DE.getU8(&Offset, Unused, 12);
670       StringRef SectionName;
671       if (error(resolveSymbolName(Obj->getCOFFSection(Section),
672                                   OffsetInSection + Offset, SectionName)))
673         return;
674       Offset += 4;
675       DE.getU8(&Offset, Unused, 3);
676       StringRef DisplayName = DE.getCStr(&Offset);
677       if (!DE.isValidOffset(Offset)) {
678         error(object_error::parse_failed);
679         return;
680       }
681       W.printString("DisplayName", DisplayName);
682       W.printString("Section", SectionName);
683       W.printHex("CodeSize", CodeSize);
684
685       break;
686     }
687     case COFF::DEBUG_SYMBOL_TYPE_PROC_END: {
688       W.startLine() << "ProcEnd\n";
689       if (!InFunctionScope || Size > 0) {
690         error(object_error::parse_failed);
691         return;
692       }
693       InFunctionScope = false;
694       break;
695     }
696     default:
697       Offset += Size;
698       break;
699     }
700   }
701
702   if (InFunctionScope)
703     error(object_error::parse_failed);
704 }
705
706 void COFFDumper::printSections() {
707   ListScope SectionsD(W, "Sections");
708   int SectionNumber = 0;
709   for (const SectionRef &Sec : Obj->sections()) {
710     ++SectionNumber;
711     const coff_section *Section = Obj->getCOFFSection(Sec);
712
713     StringRef Name;
714     if (error(Sec.getName(Name)))
715       Name = "";
716
717     DictScope D(W, "Section");
718     W.printNumber("Number", SectionNumber);
719     W.printBinary("Name", Name, Section->Name);
720     W.printHex   ("VirtualSize", Section->VirtualSize);
721     W.printHex   ("VirtualAddress", Section->VirtualAddress);
722     W.printNumber("RawDataSize", Section->SizeOfRawData);
723     W.printHex   ("PointerToRawData", Section->PointerToRawData);
724     W.printHex   ("PointerToRelocations", Section->PointerToRelocations);
725     W.printHex   ("PointerToLineNumbers", Section->PointerToLinenumbers);
726     W.printNumber("RelocationCount", Section->NumberOfRelocations);
727     W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
728     W.printFlags ("Characteristics", Section->Characteristics,
729                     makeArrayRef(ImageSectionCharacteristics),
730                     COFF::SectionCharacteristics(0x00F00000));
731
732     if (opts::SectionRelocations) {
733       ListScope D(W, "Relocations");
734       for (const RelocationRef &Reloc : Sec.relocations())
735         printRelocation(Sec, Reloc);
736     }
737
738     if (opts::SectionSymbols) {
739       ListScope D(W, "Symbols");
740       for (const SymbolRef &Symbol : Obj->symbols()) {
741         if (!Sec.containsSymbol(Symbol))
742           continue;
743
744         printSymbol(Symbol);
745       }
746     }
747
748     if (Name == ".debug$S" && opts::CodeViewLineTables)
749       printCodeViewLineTables(Sec);
750
751     if (opts::SectionData &&
752         !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {
753       StringRef Data;
754       if (error(Sec.getContents(Data)))
755         break;
756
757       W.printBinaryBlock("SectionData", Data);
758     }
759   }
760 }
761
762 void COFFDumper::printRelocations() {
763   ListScope D(W, "Relocations");
764
765   int SectionNumber = 0;
766   for (const SectionRef &Section : Obj->sections()) {
767     ++SectionNumber;
768     StringRef Name;
769     if (error(Section.getName(Name)))
770       continue;
771
772     bool PrintedGroup = false;
773     for (const RelocationRef &Reloc : Section.relocations()) {
774       if (!PrintedGroup) {
775         W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
776         W.indent();
777         PrintedGroup = true;
778       }
779
780       printRelocation(Section, Reloc);
781     }
782
783     if (PrintedGroup) {
784       W.unindent();
785       W.startLine() << "}\n";
786     }
787   }
788 }
789
790 void COFFDumper::printRelocation(const SectionRef &Section,
791                                  const RelocationRef &Reloc) {
792   uint64_t Offset;
793   uint64_t RelocType;
794   SmallString<32> RelocName;
795   StringRef SymbolName;
796   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 (Symbol != Obj->symbol_end() && error(Symbol->getName(SymbolName)))
804     return;
805
806   if (opts::ExpandRelocs) {
807     DictScope Group(W, "Relocation");
808     W.printHex("Offset", Offset);
809     W.printNumber("Type", RelocName, RelocType);
810     W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName);
811   } else {
812     raw_ostream& OS = W.startLine();
813     OS << W.hex(Offset)
814        << " " << RelocName
815        << " " << (SymbolName.empty() ? "-" : SymbolName)
816        << "\n";
817   }
818 }
819
820 void COFFDumper::printSymbols() {
821   ListScope Group(W, "Symbols");
822
823   for (const SymbolRef &Symbol : Obj->symbols())
824     printSymbol(Symbol);
825 }
826
827 void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }
828
829 static ErrorOr<StringRef>
830 getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber,
831                const coff_section *Section) {
832   if (Section) {
833     StringRef SectionName;
834     if (std::error_code EC = Obj->getSectionName(Section, SectionName))
835       return EC;
836     return SectionName;
837   }
838   if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)
839     return StringRef("IMAGE_SYM_DEBUG");
840   if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)
841     return StringRef("IMAGE_SYM_ABSOLUTE");
842   if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)
843     return StringRef("IMAGE_SYM_UNDEFINED");
844   return StringRef("");
845 }
846
847 void COFFDumper::printSymbol(const SymbolRef &Sym) {
848   DictScope D(W, "Symbol");
849
850   COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);
851   const coff_section *Section;
852   if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) {
853     W.startLine() << "Invalid section number: " << EC.message() << "\n";
854     W.flush();
855     return;
856   }
857
858   StringRef SymbolName;
859   if (Obj->getSymbolName(Symbol, SymbolName))
860     SymbolName = "";
861
862   StringRef SectionName = "";
863   ErrorOr<StringRef> Res =
864       getSectionName(Obj, Symbol.getSectionNumber(), Section);
865   if (Res)
866     SectionName = *Res;
867
868   W.printString("Name", SymbolName);
869   W.printNumber("Value", Symbol.getValue());
870   W.printNumber("Section", SectionName, Symbol.getSectionNumber());
871   W.printEnum  ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType));
872   W.printEnum  ("ComplexType", Symbol.getComplexType(),
873                                                    makeArrayRef(ImageSymDType));
874   W.printEnum  ("StorageClass", Symbol.getStorageClass(),
875                                                    makeArrayRef(ImageSymClass));
876   W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());
877
878   for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {
879     if (Symbol.isFunctionDefinition()) {
880       const coff_aux_function_definition *Aux;
881       if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
882         break;
883
884       DictScope AS(W, "AuxFunctionDef");
885       W.printNumber("TagIndex", Aux->TagIndex);
886       W.printNumber("TotalSize", Aux->TotalSize);
887       W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);
888       W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
889
890     } else if (Symbol.isAnyUndefined()) {
891       const coff_aux_weak_external *Aux;
892       if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
893         break;
894
895       ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex);
896       StringRef LinkedName;
897       std::error_code EC = Linked.getError();
898       if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) {
899         LinkedName = "";
900         error(EC);
901       }
902
903       DictScope AS(W, "AuxWeakExternal");
904       W.printNumber("Linked", LinkedName, Aux->TagIndex);
905       W.printEnum  ("Search", Aux->Characteristics,
906                     makeArrayRef(WeakExternalCharacteristics));
907
908     } else if (Symbol.isFileRecord()) {
909       const char *FileName;
910       if (error(getSymbolAuxData(Obj, Symbol, I, FileName)))
911         break;
912
913       DictScope AS(W, "AuxFileRecord");
914
915       StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *
916                                    Obj->getSymbolTableEntrySize());
917       W.printString("FileName", Name.rtrim(StringRef("\0", 1)));
918       break;
919     } else if (Symbol.isSectionDefinition()) {
920       const coff_aux_section_definition *Aux;
921       if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
922         break;
923
924       int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());
925
926       DictScope AS(W, "AuxSectionDef");
927       W.printNumber("Length", Aux->Length);
928       W.printNumber("RelocationCount", Aux->NumberOfRelocations);
929       W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
930       W.printHex("Checksum", Aux->CheckSum);
931       W.printNumber("Number", AuxNumber);
932       W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
933
934       if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
935           && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
936         const coff_section *Assoc;
937         StringRef AssocName = "";
938         std::error_code EC = Obj->getSection(AuxNumber, Assoc);
939         ErrorOr<StringRef> Res = getSectionName(Obj, AuxNumber, Assoc);
940         if (Res)
941           AssocName = *Res;
942         if (!EC)
943           EC = Res.getError();
944         if (EC) {
945           AssocName = "";
946           error(EC);
947         }
948
949         W.printNumber("AssocSection", AssocName, AuxNumber);
950       }
951     } else if (Symbol.isCLRToken()) {
952       const coff_aux_clr_token *Aux;
953       if (error(getSymbolAuxData(Obj, Symbol, I, Aux)))
954         break;
955
956       ErrorOr<COFFSymbolRef> ReferredSym =
957           Obj->getSymbol(Aux->SymbolTableIndex);
958       StringRef ReferredName;
959       std::error_code EC = ReferredSym.getError();
960       if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) {
961         ReferredName = "";
962         error(EC);
963       }
964
965       DictScope AS(W, "AuxCLRToken");
966       W.printNumber("AuxType", Aux->AuxType);
967       W.printNumber("Reserved", Aux->Reserved);
968       W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex);
969
970     } else {
971       W.startLine() << "<unhandled auxiliary record>\n";
972     }
973   }
974 }
975
976 void COFFDumper::printUnwindInfo() {
977   ListScope D(W, "UnwindInformation");
978   switch (Obj->getMachine()) {
979   case COFF::IMAGE_FILE_MACHINE_AMD64: {
980     Win64EH::Dumper Dumper(W);
981     Win64EH::Dumper::SymbolResolver
982     Resolver = [](const object::coff_section *Section, uint64_t Offset,
983                   SymbolRef &Symbol, void *user_data) -> std::error_code {
984       COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);
985       return Dumper->resolveSymbol(Section, Offset, Symbol);
986     };
987     Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);
988     Dumper.printData(Ctx);
989     break;
990   }
991   case COFF::IMAGE_FILE_MACHINE_ARMNT: {
992     ARM::WinEH::Decoder Decoder(W);
993     Decoder.dumpProcedureData(*Obj);
994     break;
995   }
996   default:
997     W.printEnum("unsupported Image Machine", Obj->getMachine(),
998                 makeArrayRef(ImageFileMachineType));
999     break;
1000   }
1001 }
1002
1003 void COFFDumper::printImportedSymbols(
1004     iterator_range<imported_symbol_iterator> Range) {
1005   for (const ImportedSymbolRef &I : Range) {
1006     StringRef Sym;
1007     if (error(I.getSymbolName(Sym))) return;
1008     uint16_t Ordinal;
1009     if (error(I.getOrdinal(Ordinal))) return;
1010     W.printNumber("Symbol", Sym, Ordinal);
1011   }
1012 }
1013
1014 void COFFDumper::printDelayImportedSymbols(
1015     const DelayImportDirectoryEntryRef &I,
1016     iterator_range<imported_symbol_iterator> Range) {
1017   int Index = 0;
1018   for (const ImportedSymbolRef &S : Range) {
1019     DictScope Import(W, "Import");
1020     StringRef Sym;
1021     if (error(S.getSymbolName(Sym))) return;
1022     uint16_t Ordinal;
1023     if (error(S.getOrdinal(Ordinal))) return;
1024     W.printNumber("Symbol", Sym, Ordinal);
1025     uint64_t Addr;
1026     if (error(I.getImportAddress(Index++, Addr))) return;
1027     W.printHex("Address", Addr);
1028   }
1029 }
1030
1031 void COFFDumper::printCOFFImports() {
1032   // Regular imports
1033   for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {
1034     DictScope Import(W, "Import");
1035     StringRef Name;
1036     if (error(I.getName(Name))) return;
1037     W.printString("Name", Name);
1038     uint32_t Addr;
1039     if (error(I.getImportLookupTableRVA(Addr))) return;
1040     W.printHex("ImportLookupTableRVA", Addr);
1041     if (error(I.getImportAddressTableRVA(Addr))) return;
1042     W.printHex("ImportAddressTableRVA", Addr);
1043     printImportedSymbols(I.imported_symbols());
1044   }
1045
1046   // Delay imports
1047   for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {
1048     DictScope Import(W, "DelayImport");
1049     StringRef Name;
1050     if (error(I.getName(Name))) return;
1051     W.printString("Name", Name);
1052     const delay_import_directory_table_entry *Table;
1053     if (error(I.getDelayImportTable(Table))) return;
1054     W.printHex("Attributes", Table->Attributes);
1055     W.printHex("ModuleHandle", Table->ModuleHandle);
1056     W.printHex("ImportAddressTable", Table->DelayImportAddressTable);
1057     W.printHex("ImportNameTable", Table->DelayImportNameTable);
1058     W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);
1059     W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);
1060     printDelayImportedSymbols(I, I.imported_symbols());
1061   }
1062 }
1063
1064 void COFFDumper::printCOFFDirectives() {
1065   for (const SectionRef &Section : Obj->sections()) {
1066     StringRef Contents;
1067     StringRef Name;
1068
1069     if (error(Section.getName(Name)))
1070       continue;
1071     if (Name != ".drectve")
1072       continue;
1073
1074     if (error(Section.getContents(Contents)))
1075       return;
1076
1077     W.printString("Directive(s)", Contents);
1078   }
1079 }
1080
1081 static StringRef getBaseRelocTypeName(uint8_t Type) {
1082   switch (Type) {
1083   case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";
1084   case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";
1085   case COFF::IMAGE_REL_BASED_LOW: return "LOW";
1086   case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";
1087   case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";
1088   case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";
1089   default: return "unknown (" + std::to_string(Type) + ")";
1090   }
1091 }
1092
1093 void COFFDumper::printCOFFBaseReloc() {
1094   ListScope D(W, "BaseReloc");
1095   for (const BaseRelocRef &I : Obj->base_relocs()) {
1096     uint8_t Type;
1097     uint32_t RVA;
1098     if (error(I.getRVA(RVA)))
1099       continue;
1100     if (error(I.getType(Type)))
1101       continue;
1102     DictScope Import(W, "Entry");
1103     W.printString("Type", getBaseRelocTypeName(Type));
1104     W.printHex("Address", RVA);
1105   }
1106 }