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