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