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