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