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 "Error.h"
  17 #include "ObjDumper.h"
  18 #include "StreamWriter.h"
  19 #include "llvm/ADT/DenseMap.h"
  20 #include "llvm/ADT/SmallString.h"
  21 #include "llvm/Object/COFF.h"
  22 #include "llvm/Object/ObjectFile.h"
  23 #include "llvm/Support/COFF.h"
  24 #include "llvm/Support/Casting.h"
  25 #include "llvm/Support/Compiler.h"
  26 #include "llvm/Support/DataExtractor.h"
  27 #include "llvm/Support/Format.h"
  28 #include "llvm/Support/SourceMgr.h"
  29 #include "llvm/Support/Win64EH.h"
  30 #include "llvm/Support/raw_ostream.h"
  31 #include "llvm/Support/system_error.h"
  32 #include <algorithm>
  33 #include <cstring>
  34 #include <time.h>
  35
  36 using namespace llvm;
  37 using namespace llvm::object;
  38 using namespace llvm::Win64EH;
  39
  40 namespace {
  41
  42 class COFFDumper : public ObjDumper {
  43 public:
  44   COFFDumper(const llvm::object::COFFObjectFile *Obj, StreamWriter& Writer)
  45     : ObjDumper(Writer)
  46     , Obj(Obj) {
  47     cacheRelocations();
  48   }
  49
  50   virtual void printFileHeaders() override;
  51   virtual void printSections() override;
  52   virtual void printRelocations() override;
  53   virtual void printSymbols() override;
  54   virtual void printDynamicSymbols() override;
  55   virtual void printUnwindInfo() override;
  56
  57 private:
  58   void printSymbol(symbol_iterator SymI);
  59   void printRelocation(section_iterator SecI, relocation_iterator RelI);
  60   void printDataDirectory(uint32_t Index, const std::string &FieldName);
  61   void printX64UnwindInfo();
  62
  63   template <class PEHeader> void printPEHeader(const PEHeader *Hdr);
  64   void printBaseOfDataField(const pe32_header *Hdr);
  65   void printBaseOfDataField(const pe32plus_header *Hdr);
  66
  67   void printRuntimeFunction(
  68     const RuntimeFunction& RTF,
  69     uint64_t OffsetInSection,
  70     const std::vector<RelocationRef> &Rels);
  71
  72   void printUnwindInfo(
  73     const Win64EH::UnwindInfo& UI,
  74     uint64_t OffsetInSection,
  75     const std::vector<RelocationRef> &Rels);
  76
  77   void printUnwindCode(const Win64EH::UnwindInfo& UI, ArrayRef<UnwindCode> UCs);
  78
  79   void printCodeViewLineTables(section_iterator SecI);
  80
  81   void cacheRelocations();
  82
  83   error_code getSectionContents(
  84     const std::vector<RelocationRef> &Rels,
  85     uint64_t Offset,
  86     ArrayRef<uint8_t> &Contents,
  87     uint64_t &Addr);
  88
  89   error_code getSection(
  90     const std::vector<RelocationRef> &Rels,
  91     uint64_t Offset,
  92     const coff_section **Section,
  93     uint64_t *AddrPtr);
  94
  95   typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;
  96
  97   const llvm::object::COFFObjectFile *Obj;
  98   RelocMapTy RelocMap;
  99   std::vector<RelocationRef> EmptyRelocs;
 100 };
 101
 102 } // namespace
 103
 104
 105 namespace llvm {
 106
 107 error_code createCOFFDumper(const object::ObjectFile *Obj, StreamWriter &Writer,
 108                             std::unique_ptr<ObjDumper> &Result) {
 109   const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj);
 110   if (!COFFObj)
 111     return readobj_error::unsupported_obj_file_format;
 112
 113   Result.reset(new COFFDumper(COFFObj, Writer));
 114   return readobj_error::success;
 115 }
 116
 117 } // namespace llvm
 118
 119
 120 // Returns the name of the unwind code.
 121 static StringRef getUnwindCodeTypeName(uint8_t Code) {
 122   switch(Code) {
 123   default: llvm_unreachable("Invalid unwind code");
 124   case UOP_PushNonVol: return "PUSH_NONVOL";
 125   case UOP_AllocLarge: return "ALLOC_LARGE";
 126   case UOP_AllocSmall: return "ALLOC_SMALL";
 127   case UOP_SetFPReg: return "SET_FPREG";
 128   case UOP_SaveNonVol: return "SAVE_NONVOL";
 129   case UOP_SaveNonVolBig: return "SAVE_NONVOL_FAR";
 130   case UOP_SaveXMM128: return "SAVE_XMM128";
 131   case UOP_SaveXMM128Big: return "SAVE_XMM128_FAR";
 132   case UOP_PushMachFrame: return "PUSH_MACHFRAME";
 133   }
 134 }
 135
 136 // Returns the name of a referenced register.
 137 static StringRef getUnwindRegisterName(uint8_t Reg) {
 138   switch(Reg) {
 139   default: llvm_unreachable("Invalid register");
 140   case 0: return "RAX";
 141   case 1: return "RCX";
 142   case 2: return "RDX";
 143   case 3: return "RBX";
 144   case 4: return "RSP";
 145   case 5: return "RBP";
 146   case 6: return "RSI";
 147   case 7: return "RDI";
 148   case 8: return "R8";
 149   case 9: return "R9";
 150   case 10: return "R10";
 151   case 11: return "R11";
 152   case 12: return "R12";
 153   case 13: return "R13";
 154   case 14: return "R14";
 155   case 15: return "R15";
 156   }
 157 }
 158
 159 // Calculates the number of array slots required for the unwind code.
 160 static unsigned getNumUsedSlots(const UnwindCode &UnwindCode) {
 161   switch (UnwindCode.getUnwindOp()) {
 162   default: llvm_unreachable("Invalid unwind code");
 163   case UOP_PushNonVol:
 164   case UOP_AllocSmall:
 165   case UOP_SetFPReg:
 166   case UOP_PushMachFrame:
 167     return 1;
 168   case UOP_SaveNonVol:
 169   case UOP_SaveXMM128:
 170     return 2;
 171   case UOP_SaveNonVolBig:
 172   case UOP_SaveXMM128Big:
 173     return 3;
 174   case UOP_AllocLarge:
 175     return (UnwindCode.getOpInfo() == 0) ? 2 : 3;
 176   }
 177 }
 178
 179 // Given a symbol sym this functions returns the address and section of it.
 180 static error_code resolveSectionAndAddress(const COFFObjectFile *Obj,
 181                                            const SymbolRef &Sym,
 182                                            const coff_section *&ResolvedSection,
 183                                            uint64_t &ResolvedAddr) {
 184   if (error_code EC = Sym.getAddress(ResolvedAddr))
 185     return EC;
 186
 187   section_iterator iter(Obj->section_begin());
 188   if (error_code EC = Sym.getSection(iter))
 189     return EC;
 190
 191   ResolvedSection = Obj->getCOFFSection(iter);
 192   return object_error::success;
 193 }
 194
 195 // Given a vector of relocations for a section and an offset into this section
 196 // the function returns the symbol used for the relocation at the offset.
 197 static error_code resolveSymbol(const std::vector<RelocationRef> &Rels,
 198                                 uint64_t Offset, SymbolRef &Sym) {
 199   for (std::vector<RelocationRef>::const_iterator RelI = Rels.begin(),
 200                                                   RelE = Rels.end();
 201                                                   RelI != RelE; ++RelI) {
 202     uint64_t Ofs;
 203     if (error_code EC = RelI->getOffset(Ofs))
 204       return EC;
 205
 206     if (Ofs == Offset) {
 207       Sym = *RelI->getSymbol();
 208       return readobj_error::success;
 209     }
 210   }
 211
 212   return readobj_error::unknown_symbol;
 213 }
 214
 215 // Given a vector of relocations for a section and an offset into this section
 216 // the function returns the name of the symbol used for the relocation at the
 217 // offset.
 218 static error_code resolveSymbolName(const std::vector<RelocationRef> &Rels,
 219                                     uint64_t Offset, StringRef &Name) {
 220   SymbolRef Sym;
 221   if (error_code EC = resolveSymbol(Rels, Offset, Sym)) return EC;
 222   if (error_code EC = Sym.getName(Name)) return EC;
 223   return object_error::success;
 224 }
 225
 226 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {
 227   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN  ),
 228   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33     ),
 229   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64    ),
 230   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM      ),
 231   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMV7    ),
 232   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC      ),
 233   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386     ),
 234   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64     ),
 235   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R     ),
 236   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16   ),
 237   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU  ),
 238   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),
 239   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC  ),
 240   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),
 241   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000    ),
 242   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3      ),
 243   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP   ),
 244   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4      ),
 245   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5      ),
 246   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB    ),
 247   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)
 248 };
 249
 250 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {
 251   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED        ),
 252   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE       ),
 253   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED     ),
 254   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED    ),
 255   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM     ),
 256   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE    ),
 257   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO      ),
 258   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE          ),
 259   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED         ),
 260   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),
 261   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP      ),
 262   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM                 ),
 263   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL                    ),
 264   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY         ),
 265   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI      )
 266 };
 267
 268 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {
 269   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN                ),
 270   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE                 ),
 271   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI            ),
 272   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI            ),
 273   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI              ),
 274   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI         ),
 275   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION        ),
 276   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),
 277   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER     ),
 278   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM                ),
 279   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX                   ),
 280 };
 281
 282 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {
 283   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA      ),
 284   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE         ),
 285   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY      ),
 286   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT            ),
 287   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION         ),
 288   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH               ),
 289   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND              ),
 290   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER           ),
 291   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),
 292 };
 293
 294 static const EnumEntry<COFF::SectionCharacteristics>
 295 ImageSectionCharacteristics[] = {
 296   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD           ),
 297   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE              ),
 298   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA  ),
 299   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),
 300   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER             ),
 301   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO              ),
 302   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE            ),
 303   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT            ),
 304   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL                 ),
 305   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE         ),
 306   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT             ),
 307   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED            ),
 308   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD           ),
 309   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES          ),
 310   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES          ),
 311   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES          ),
 312   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES          ),
 313   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES         ),
 314   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES         ),
 315   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES         ),
 316   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES        ),
 317   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES        ),
 318   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES        ),
 319   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES       ),
 320   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES       ),
 321   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES       ),
 322   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES       ),
 323   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL       ),
 324   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE       ),
 325   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED        ),
 326   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED         ),
 327   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED            ),
 328   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE           ),
 329   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ              ),
 330   LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE             )
 331 };
 332
 333 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {
 334   { "Null"  , COFF::IMAGE_SYM_TYPE_NULL   },
 335   { "Void"  , COFF::IMAGE_SYM_TYPE_VOID   },
 336   { "Char"  , COFF::IMAGE_SYM_TYPE_CHAR   },
 337   { "Short" , COFF::IMAGE_SYM_TYPE_SHORT  },
 338   { "Int"   , COFF::IMAGE_SYM_TYPE_INT    },
 339   { "Long"  , COFF::IMAGE_SYM_TYPE_LONG   },
 340   { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT  },
 341   { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },
 342   { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },
 343   { "Union" , COFF::IMAGE_SYM_TYPE_UNION  },
 344   { "Enum"  , COFF::IMAGE_SYM_TYPE_ENUM   },
 345   { "MOE"   , COFF::IMAGE_SYM_TYPE_MOE    },
 346   { "Byte"  , COFF::IMAGE_SYM_TYPE_BYTE   },
 347   { "Word"  , COFF::IMAGE_SYM_TYPE_WORD   },
 348   { "UInt"  , COFF::IMAGE_SYM_TYPE_UINT   },
 349   { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD  }
 350 };
 351
 352 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {
 353   { "Null"    , COFF::IMAGE_SYM_DTYPE_NULL     },
 354   { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER  },
 355   { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },
 356   { "Array"   , COFF::IMAGE_SYM_DTYPE_ARRAY    }
 357 };
 358
 359 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {
 360   { "EndOfFunction"  , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION  },
 361   { "Null"           , COFF::IMAGE_SYM_CLASS_NULL             },
 362   { "Automatic"      , COFF::IMAGE_SYM_CLASS_AUTOMATIC        },
 363   { "External"       , COFF::IMAGE_SYM_CLASS_EXTERNAL         },
 364   { "Static"         , COFF::IMAGE_SYM_CLASS_STATIC           },
 365   { "Register"       , COFF::IMAGE_SYM_CLASS_REGISTER         },
 366   { "ExternalDef"    , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF     },
 367   { "Label"          , COFF::IMAGE_SYM_CLASS_LABEL            },
 368   { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL  },
 369   { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },
 370   { "Argument"       , COFF::IMAGE_SYM_CLASS_ARGUMENT         },
 371   { "StructTag"      , COFF::IMAGE_SYM_CLASS_STRUCT_TAG       },
 372   { "MemberOfUnion"  , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION  },
 373   { "UnionTag"       , COFF::IMAGE_SYM_CLASS_UNION_TAG        },
 374   { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION  },
 375   { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },
 376   { "EnumTag"        , COFF::IMAGE_SYM_CLASS_ENUM_TAG         },
 377   { "MemberOfEnum"   , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM   },
 378   { "RegisterParam"  , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM   },
 379   { "BitField"       , COFF::IMAGE_SYM_CLASS_BIT_FIELD        },
 380   { "Block"          , COFF::IMAGE_SYM_CLASS_BLOCK            },
 381   { "Function"       , COFF::IMAGE_SYM_CLASS_FUNCTION         },
 382   { "EndOfStruct"    , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT    },
 383   { "File"           , COFF::IMAGE_SYM_CLASS_FILE             },
 384   { "Section"        , COFF::IMAGE_SYM_CLASS_SECTION          },
 385   { "WeakExternal"   , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL    },
 386   { "CLRToken"       , COFF::IMAGE_SYM_CLASS_CLR_TOKEN        }
 387 };
 388
 389 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {
 390   { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },
 391   { "Any"         , COFF::IMAGE_COMDAT_SELECT_ANY          },
 392   { "SameSize"    , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE    },
 393   { "ExactMatch"  , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH  },
 394   { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE  },
 395   { "Largest"     , COFF::IMAGE_COMDAT_SELECT_LARGEST      },
 396   { "Newest"      , COFF::IMAGE_COMDAT_SELECT_NEWEST       }
 397 };
 398
 399 static const EnumEntry<COFF::WeakExternalCharacteristics>
 400 WeakExternalCharacteristics[] = {
 401   { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },
 402   { "Library"  , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY   },
 403   { "Alias"    , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS     }
 404 };
 405
 406 static const EnumEntry<unsigned> UnwindFlags[] = {
 407   { "ExceptionHandler", Win64EH::UNW_ExceptionHandler },
 408   { "TerminateHandler", Win64EH::UNW_TerminateHandler },
 409   { "ChainInfo"       , Win64EH::UNW_ChainInfo        }
 410 };
 411
 412 static const EnumEntry<unsigned> UnwindOpInfo[] = {
 413   { "RAX",  0 },
 414   { "RCX",  1 },
 415   { "RDX",  2 },
 416   { "RBX",  3 },
 417   { "RSP",  4 },
 418   { "RBP",  5 },
 419   { "RSI",  6 },
 420   { "RDI",  7 },
 421   { "R8",   8 },
 422   { "R9",   9 },
 423   { "R10", 10 },
 424   { "R11", 11 },
 425   { "R12", 12 },
 426   { "R13", 13 },
 427   { "R14", 14 },
 428   { "R15", 15 }
 429 };
 430
 431 // Some additional COFF structures not defined by llvm::object.
 432 namespace {
 433   struct coff_aux_function_definition {
 434     support::ulittle32_t TagIndex;
 435     support::ulittle32_t TotalSize;
 436     support::ulittle32_t PointerToLineNumber;
 437     support::ulittle32_t PointerToNextFunction;
 438     uint8_t Unused[2];
 439   };
 440
 441   struct coff_aux_weak_external_definition {
 442     support::ulittle32_t TagIndex;
 443     support::ulittle32_t Characteristics;
 444     uint8_t Unused[10];
 445   };
 446
 447   struct coff_aux_file_record {
 448     char FileName[18];
 449   };
 450
 451   struct coff_aux_clr_token {
 452     support::ulittle8_t AuxType;
 453     support::ulittle8_t Reserved;
 454     support::ulittle32_t SymbolTableIndex;
 455     uint8_t Unused[12];
 456   };
 457 } // namespace
 458
 459 static uint64_t getOffsetOfLSDA(const Win64EH::UnwindInfo& UI) {
 460   return static_cast<const char*>(UI.getLanguageSpecificData())
 461          - reinterpret_cast<const char*>(&UI);
 462 }
 463
 464 static uint32_t getLargeSlotValue(ArrayRef<UnwindCode> UCs) {
 465   if (UCs.size() < 3)
 466     return 0;
 467
 468   return UCs[1].FrameOffset + (static_cast<uint32_t>(UCs[2].FrameOffset) << 16);
 469 }
 470
 471 template<typename T>
 472 static error_code getSymbolAuxData(const COFFObjectFile *Obj,
 473                                    const coff_symbol *Symbol, const T* &Aux) {
 474   ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);
 475   Aux = reinterpret_cast<const T*>(AuxData.data());
 476   return readobj_error::success;
 477 }
 478
 479 static std::string formatSymbol(const std::vector<RelocationRef> &Rels,
 480                                 uint64_t Offset, uint32_t Disp) {
 481   std::string Buffer;
 482   raw_string_ostream Str(Buffer);
 483
 484   StringRef Sym;
 485   if (resolveSymbolName(Rels, Offset, Sym)) {
 486     Str << format(" (0x%" PRIX64 ")", Offset);
 487     return Str.str();
 488   }
 489
 490   Str << Sym;
 491   if (Disp > 0) {
 492     Str << format(" +0x%X (0x%" PRIX64 ")", Disp, Offset);
 493   } else {
 494     Str << format(" (0x%" PRIX64 ")", Offset);
 495   }
 496
 497   return Str.str();
 498 }
 499
 500 // Given a vector of relocations for a section and an offset into this section
 501 // the function resolves the symbol used for the relocation at the offset and
 502 // returns the section content and the address inside the content pointed to
 503 // by the symbol.
 504 error_code COFFDumper::getSectionContents(
 505     const std::vector<RelocationRef> &Rels, uint64_t Offset,
 506     ArrayRef<uint8_t> &Contents, uint64_t &Addr) {
 507
 508   SymbolRef Sym;
 509   const coff_section *Section;
 510
 511   if (error_code EC = resolveSymbol(Rels, Offset, Sym))
 512     return EC;
 513   if (error_code EC = resolveSectionAndAddress(Obj, Sym, Section, Addr))
 514     return EC;
 515   if (error_code EC = Obj->getSectionContents(Section, Contents))
 516     return EC;
 517
 518   return object_error::success;
 519 }
 520
 521 error_code COFFDumper::getSection(
 522     const std::vector<RelocationRef> &Rels, uint64_t Offset,
 523     const coff_section **SectionPtr, uint64_t *AddrPtr) {
 524
 525   SymbolRef Sym;
 526   if (error_code EC = resolveSymbol(Rels, Offset, Sym))
 527     return EC;
 528
 529   const coff_section *Section;
 530   uint64_t Addr;
 531   if (error_code EC = resolveSectionAndAddress(Obj, Sym, Section, Addr))
 532     return EC;
 533
 534   if (SectionPtr)
 535     *SectionPtr = Section;
 536   if (AddrPtr)
 537     *AddrPtr = Addr;
 538
 539   return object_error::success;
 540 }
 541
 542 void COFFDumper::cacheRelocations() {
 543   for (section_iterator SecI = Obj->section_begin(),
 544                         SecE = Obj->section_end();
 545        SecI != SecE; ++SecI) {
 546     const coff_section *Section = Obj->getCOFFSection(SecI);
 547
 548     for (relocation_iterator RelI = SecI->relocation_begin(),
 549                              RelE = SecI->relocation_end();
 550          RelI != RelE; ++RelI)
 551       RelocMap[Section].push_back(*RelI);
 552
 553     // Sort relocations by address.
 554     std::sort(RelocMap[Section].begin(), RelocMap[Section].end(),
 555               relocAddressLess);
 556   }
 557 }
 558
 559 void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) {
 560   const data_directory *Data;
 561   if (Obj->getDataDirectory(Index, Data))
 562     return;
 563   W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);
 564   W.printHex(FieldName + "Size", Data->Size);
 565 }
 566
 567 void COFFDumper::printFileHeaders() {
 568   // Print COFF header
 569   const coff_file_header *COFFHeader = 0;
 570   if (error(Obj->getCOFFHeader(COFFHeader)))
 571     return;
 572
 573   time_t TDS = COFFHeader->TimeDateStamp;
 574   char FormattedTime[20] = { };
 575   strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));
 576
 577   {
 578     DictScope D(W, "ImageFileHeader");
 579     W.printEnum  ("Machine", COFFHeader->Machine,
 580                     makeArrayRef(ImageFileMachineType));
 581     W.printNumber("SectionCount", COFFHeader->NumberOfSections);
 582     W.printHex   ("TimeDateStamp", FormattedTime, COFFHeader->TimeDateStamp);
 583     W.printHex   ("PointerToSymbolTable", COFFHeader->PointerToSymbolTable);
 584     W.printNumber("SymbolCount", COFFHeader->NumberOfSymbols);
 585     W.printNumber("OptionalHeaderSize", COFFHeader->SizeOfOptionalHeader);
 586     W.printFlags ("Characteristics", COFFHeader->Characteristics,
 587                     makeArrayRef(ImageFileCharacteristics));
 588   }
 589
 590   // Print PE header. This header does not exist if this is an object file and
 591   // not an executable.
 592   const pe32_header *PEHeader = 0;
 593   if (error(Obj->getPE32Header(PEHeader)))
 594     return;
 595   if (PEHeader)
 596     printPEHeader<pe32_header>(PEHeader);
 597
 598   const pe32plus_header *PEPlusHeader = 0;
 599   if (error(Obj->getPE32PlusHeader(PEPlusHeader)))
 600     return;
 601   if (PEPlusHeader)
 602     printPEHeader<pe32plus_header>(PEPlusHeader);
 603 }
 604
 605 template <class PEHeader>
 606 void COFFDumper::printPEHeader(const PEHeader *Hdr) {
 607   DictScope D(W, "ImageOptionalHeader");
 608   W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);
 609   W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);
 610   W.printNumber("SizeOfCode", Hdr->SizeOfCode);
 611   W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);
 612   W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);
 613   W.printHex   ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);
 614   W.printHex   ("BaseOfCode", Hdr->BaseOfCode);
 615   printBaseOfDataField(Hdr);
 616   W.printHex   ("ImageBase", Hdr->ImageBase);
 617   W.printNumber("SectionAlignment", Hdr->SectionAlignment);
 618   W.printNumber("FileAlignment", Hdr->FileAlignment);
 619   W.printNumber("MajorOperatingSystemVersion",
 620                 Hdr->MajorOperatingSystemVersion);
 621   W.printNumber("MinorOperatingSystemVersion",
 622                 Hdr->MinorOperatingSystemVersion);
 623   W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);
 624   W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);
 625   W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);
 626   W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);
 627   W.printNumber("SizeOfImage", Hdr->SizeOfImage);
 628   W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);
 629   W.printEnum  ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem));
 630   W.printFlags ("Subsystem", Hdr->DLLCharacteristics,
 631                 makeArrayRef(PEDLLCharacteristics));
 632   W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);
 633   W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);
 634   W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);
 635   W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);
 636   W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);
 637
 638   if (Hdr->NumberOfRvaAndSize > 0) {
 639     DictScope D(W, "DataDirectory");
 640     static const char * const directory[] = {
 641       "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",
 642       "CertificateTable", "BaseRelocationTable", "Debug", "Architecture",
 643       "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",
 644       "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"
 645     };
 646
 647     for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) {
 648       printDataDirectory(i, directory[i]);
 649     }
 650   }
 651 }
 652
 653 void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {
 654   W.printHex("BaseOfData", Hdr->BaseOfData);
 655 }
 656
 657 void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}
 658
 659 void COFFDumper::printCodeViewLineTables(section_iterator SecI) {
 660   StringRef Data;
 661   if (error(SecI->getContents(Data))) return;
 662
 663   SmallVector<StringRef, 10> FunctionNames;
 664   StringMap<StringRef> FunctionLineTables;
 665   StringRef FileIndexToStringOffsetTable;
 666   StringRef StringTable;
 667
 668   ListScope D(W, "CodeViewLineTables");
 669   {
 670     DataExtractor DE(Data, true, 4);
 671     uint32_t Offset = 0,
 672              Magic = DE.getU32(&Offset);
 673     W.printHex("Magic", Magic);
 674     if (Magic != COFF::DEBUG_SECTION_MAGIC) {
 675       error(object_error::parse_failed);
 676       return;
 677     }
 678
 679     bool Finished = false;
 680     while (DE.isValidOffset(Offset) && !Finished) {
 681       // The section consists of a number of subsection in the following format:
 682       // |Type|PayloadSize|Payload...|
 683       uint32_t SubSectionType = DE.getU32(&Offset),
 684                PayloadSize = DE.getU32(&Offset);
 685       ListScope S(W, "Subsection");
 686       W.printHex("Type", SubSectionType);
 687       W.printHex("PayloadSize", PayloadSize);
 688       if (PayloadSize > Data.size() - Offset) {
 689         error(object_error::parse_failed);
 690         return;
 691       }
 692
 693       // Print the raw contents to simplify debugging if anything goes wrong
 694       // afterwards.
 695       StringRef Contents = Data.substr(Offset, PayloadSize);
 696       W.printBinaryBlock("Contents", Contents);
 697
 698       switch (SubSectionType) {
 699       case COFF::DEBUG_LINE_TABLE_SUBSECTION: {
 700         // Holds a PC to file:line table.  Some data to parse this subsection is
 701         // stored in the other subsections, so just check sanity and store the
 702         // pointers for deferred processing.
 703
 704         if (PayloadSize < 12) {
 705           // There should be at least three words to store two function
 706           // relocations and size of the code.
 707           error(object_error::parse_failed);
 708           return;
 709         }
 710
 711         StringRef FunctionName;
 712         if (error(resolveSymbolName(RelocMap[Obj->getCOFFSection(SecI)], Offset,
 713                                     FunctionName)))
 714           return;
 715         W.printString("FunctionName", FunctionName);
 716         if (FunctionLineTables.count(FunctionName) != 0) {
 717           // Saw debug info for this function already?
 718           error(object_error::parse_failed);
 719           return;
 720         }
 721
 722         FunctionLineTables[FunctionName] = Contents;
 723         FunctionNames.push_back(FunctionName);
 724         break;
 725       }
 726       case COFF::DEBUG_STRING_TABLE_SUBSECTION:
 727         if (PayloadSize == 0 || StringTable.data() != 0 ||
 728             Contents.back() != '\0') {
 729           // Empty or duplicate or non-null-terminated subsection.
 730           error(object_error::parse_failed);
 731           return;
 732         }
 733         StringTable = Contents;
 734         break;
 735       case COFF::DEBUG_INDEX_SUBSECTION:
 736         // Holds the translation table from file indices
 737         // to offsets in the string table.
 738
 739         if (PayloadSize == 0 || FileIndexToStringOffsetTable.data() != 0) {
 740           // Empty or duplicate subsection.
 741           error(object_error::parse_failed);
 742           return;
 743         }
 744         FileIndexToStringOffsetTable = Contents;
 745         break;
 746       }
 747       Offset += PayloadSize;
 748
 749       // Align the reading pointer by 4.
 750       Offset += (-Offset) % 4;
 751     }
 752   }
 753
 754   // Dump the line tables now that we've read all the subsections and know all
 755   // the required information.
 756   for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {
 757     StringRef Name = FunctionNames[I];
 758     ListScope S(W, "FunctionLineTable");
 759     W.printString("FunctionName", Name);
 760
 761     DataExtractor DE(FunctionLineTables[Name], true, 4);
 762     uint32_t Offset = 8;  // Skip relocations.
 763     uint32_t FunctionSize = DE.getU32(&Offset);
 764     W.printHex("CodeSize", FunctionSize);
 765     while (DE.isValidOffset(Offset)) {
 766       // For each range of lines with the same filename, we have a segment
 767       // in the line table.  The filename string is accessed using double
 768       // indirection to the string table subsection using the index subsection.
 769       uint32_t OffsetInIndex = DE.getU32(&Offset),
 770                SegmentLength   = DE.getU32(&Offset),
 771                FullSegmentSize = DE.getU32(&Offset);
 772       if (FullSegmentSize != 12 + 8 * SegmentLength) {
 773         error(object_error::parse_failed);
 774         return;
 775       }
 776
 777       uint32_t FilenameOffset;
 778       {
 779         DataExtractor SDE(FileIndexToStringOffsetTable, true, 4);
 780         uint32_t OffsetInSDE = OffsetInIndex;
 781         if (!SDE.isValidOffset(OffsetInSDE)) {
 782           error(object_error::parse_failed);
 783           return;
 784         }
 785         FilenameOffset = SDE.getU32(&OffsetInSDE);
 786       }
 787
 788       if (FilenameOffset == 0 || FilenameOffset + 1 >= StringTable.size() ||
 789           StringTable.data()[FilenameOffset - 1] != '\0') {
 790         // Each string in an F3 subsection should be preceded by a null
 791         // character.
 792         error(object_error::parse_failed);
 793         return;
 794       }
 795
 796       StringRef Filename(StringTable.data() + FilenameOffset);
 797       ListScope S(W, "FilenameSegment");
 798       W.printString("Filename", Filename);
 799       for (unsigned J = 0; J != SegmentLength && DE.isValidOffset(Offset);
 800            ++J) {
 801         // Then go the (PC, LineNumber) pairs.  The line number is stored in the
 802         // least significant 31 bits of the respective word in the table.
 803         uint32_t PC = DE.getU32(&Offset),
 804                  LineNumber = DE.getU32(&Offset) & 0x7fffffff;
 805         if (PC >= FunctionSize) {
 806           error(object_error::parse_failed);
 807           return;
 808         }
 809         char Buffer[32];
 810         format("+0x%X", PC).snprint(Buffer, 32);
 811         W.printNumber(Buffer, LineNumber);
 812       }
 813     }
 814   }
 815 }
 816
 817 void COFFDumper::printSections() {
 818   ListScope SectionsD(W, "Sections");
 819   int SectionNumber = 0;
 820   for (section_iterator SecI = Obj->section_begin(),
 821                         SecE = Obj->section_end();
 822        SecI != SecE; ++SecI) {
 823     ++SectionNumber;
 824     const coff_section *Section = Obj->getCOFFSection(SecI);
 825
 826     StringRef Name;
 827     if (error(SecI->getName(Name)))
 828         Name = "";
 829
 830     DictScope D(W, "Section");
 831     W.printNumber("Number", SectionNumber);
 832     W.printBinary("Name", Name, Section->Name);
 833     W.printHex   ("VirtualSize", Section->VirtualSize);
 834     W.printHex   ("VirtualAddress", Section->VirtualAddress);
 835     W.printNumber("RawDataSize", Section->SizeOfRawData);
 836     W.printHex   ("PointerToRawData", Section->PointerToRawData);
 837     W.printHex   ("PointerToRelocations", Section->PointerToRelocations);
 838     W.printHex   ("PointerToLineNumbers", Section->PointerToLinenumbers);
 839     W.printNumber("RelocationCount", Section->NumberOfRelocations);
 840     W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);
 841     W.printFlags ("Characteristics", Section->Characteristics,
 842                     makeArrayRef(ImageSectionCharacteristics),
 843                     COFF::SectionCharacteristics(0x00F00000));
 844
 845     if (opts::SectionRelocations) {
 846       ListScope D(W, "Relocations");
 847       for (relocation_iterator RelI = SecI->relocation_begin(),
 848                                RelE = SecI->relocation_end();
 849            RelI != RelE; ++RelI)
 850         printRelocation(SecI, RelI);
 851     }
 852
 853     if (opts::SectionSymbols) {
 854       ListScope D(W, "Symbols");
 855       for (symbol_iterator SymI = Obj->symbol_begin(),
 856                            SymE = Obj->symbol_end();
 857            SymI != SymE; ++SymI) {
 858         bool Contained = false;
 859         if (SecI->containsSymbol(*SymI, Contained) || !Contained)
 860           continue;
 861
 862         printSymbol(SymI);
 863       }
 864     }
 865
 866     if (Name == ".debug$S" && opts::CodeViewLineTables)
 867       printCodeViewLineTables(SecI);
 868
 869     if (opts::SectionData) {
 870       StringRef Data;
 871       if (error(SecI->getContents(Data))) break;
 872
 873       W.printBinaryBlock("SectionData", Data);
 874     }
 875   }
 876 }
 877
 878 void COFFDumper::printRelocations() {
 879   ListScope D(W, "Relocations");
 880
 881   int SectionNumber = 0;
 882   for (section_iterator SecI = Obj->section_begin(),
 883                         SecE = Obj->section_end();
 884                         SecI != SecE; ++SecI) {
 885     ++SectionNumber;
 886     StringRef Name;
 887     if (error(SecI->getName(Name)))
 888       continue;
 889
 890     bool PrintedGroup = false;
 891     for (relocation_iterator RelI = SecI->relocation_begin(),
 892                              RelE = SecI->relocation_end();
 893          RelI != RelE; ++RelI) {
 894       if (!PrintedGroup) {
 895         W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
 896         W.indent();
 897         PrintedGroup = true;
 898       }
 899
 900       printRelocation(SecI, RelI);
 901     }
 902
 903     if (PrintedGroup) {
 904       W.unindent();
 905       W.startLine() << "}\n";
 906     }
 907   }
 908 }
 909
 910 void COFFDumper::printRelocation(section_iterator SecI,
 911                                  relocation_iterator RelI) {
 912   uint64_t Offset;
 913   uint64_t RelocType;
 914   SmallString<32> RelocName;
 915   StringRef SymbolName;
 916   StringRef Contents;
 917   if (error(RelI->getOffset(Offset))) return;
 918   if (error(RelI->getType(RelocType))) return;
 919   if (error(RelI->getTypeName(RelocName))) return;
 920   symbol_iterator Symbol = RelI->getSymbol();
 921   if (error(Symbol->getName(SymbolName))) return;
 922   if (error(SecI->getContents(Contents))) return;
 923
 924   if (opts::ExpandRelocs) {
 925     DictScope Group(W, "Relocation");
 926     W.printHex("Offset", Offset);
 927     W.printNumber("Type", RelocName, RelocType);
 928     W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
 929   } else {
 930     raw_ostream& OS = W.startLine();
 931     OS << W.hex(Offset)
 932        << " " << RelocName
 933        << " " << (SymbolName.size() > 0 ? SymbolName : "-")
 934        << "\n";
 935   }
 936 }
 937
 938 void COFFDumper::printSymbols() {
 939   ListScope Group(W, "Symbols");
 940
 941   for (symbol_iterator SymI = Obj->symbol_begin(), SymE = Obj->symbol_end();
 942        SymI != SymE; ++SymI)
 943     printSymbol(SymI);
 944 }
 945
 946 void COFFDumper::printDynamicSymbols() {
 947   ListScope Group(W, "DynamicSymbols");
 948 }
 949
 950 void COFFDumper::printSymbol(symbol_iterator SymI) {
 951   DictScope D(W, "Symbol");
 952
 953   const coff_symbol *Symbol = Obj->getCOFFSymbol(SymI);
 954   const coff_section *Section;
 955   if (error_code EC = Obj->getSection(Symbol->SectionNumber, Section)) {
 956     W.startLine() << "Invalid section number: " << EC.message() << "\n";
 957     W.flush();
 958     return;
 959   }
 960
 961   StringRef SymbolName;
 962   if (Obj->getSymbolName(Symbol, SymbolName))
 963     SymbolName = "";
 964
 965   StringRef SectionName = "";
 966   if (Section)
 967     Obj->getSectionName(Section, SectionName);
 968
 969   W.printString("Name", SymbolName);
 970   W.printNumber("Value", Symbol->Value);
 971   W.printNumber("Section", SectionName, Symbol->SectionNumber);
 972   W.printEnum  ("BaseType", Symbol->getBaseType(), makeArrayRef(ImageSymType));
 973   W.printEnum  ("ComplexType", Symbol->getComplexType(),
 974                                                    makeArrayRef(ImageSymDType));
 975   W.printEnum  ("StorageClass", Symbol->StorageClass,
 976                                                    makeArrayRef(ImageSymClass));
 977   W.printNumber("AuxSymbolCount", Symbol->NumberOfAuxSymbols);
 978
 979   for (unsigned I = 0; I < Symbol->NumberOfAuxSymbols; ++I) {
 980     if (Symbol->StorageClass     == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
 981         Symbol->getBaseType()    == COFF::IMAGE_SYM_TYPE_NULL &&
 982         Symbol->getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION &&
 983         Symbol->SectionNumber > 0) {
 984       const coff_aux_function_definition *Aux;
 985       if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
 986         break;
 987
 988       DictScope AS(W, "AuxFunctionDef");
 989       W.printNumber("TagIndex", Aux->TagIndex);
 990       W.printNumber("TotalSize", Aux->TotalSize);
 991       W.printHex("PointerToLineNumber", Aux->PointerToLineNumber);
 992       W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);
 993       W.printBinary("Unused", makeArrayRef(Aux->Unused));
 994
 995     } else if (
 996         Symbol->StorageClass   == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL ||
 997         (Symbol->StorageClass  == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
 998          Symbol->SectionNumber == 0 &&
 999          Symbol->Value         == 0)) {
1000       const coff_aux_weak_external_definition *Aux;
1001       if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
1002         break;
1003
1004       const coff_symbol *Linked;
1005       StringRef LinkedName;
1006       error_code EC;
1007       if ((EC = Obj->getSymbol(Aux->TagIndex, Linked)) ||
1008           (EC = Obj->getSymbolName(Linked, LinkedName))) {
1009         LinkedName = "";
1010         error(EC);
1011       }
1012
1013       DictScope AS(W, "AuxWeakExternal");
1014       W.printNumber("Linked", LinkedName, Aux->TagIndex);
1015       W.printEnum  ("Search", Aux->Characteristics,
1016                     makeArrayRef(WeakExternalCharacteristics));
1017       W.printBinary("Unused", Aux->Unused);
1018
1019     } else if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_FILE) {
1020       const coff_aux_file_record *Aux;
1021       if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
1022         break;
1023
1024       DictScope AS(W, "AuxFileRecord");
1025       W.printString("FileName", StringRef(Aux->FileName));
1026
1027     } else if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_STATIC ||
1028                (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
1029                 Symbol->SectionNumber != COFF::IMAGE_SYM_UNDEFINED)) {
1030       const coff_aux_section_definition *Aux;
1031       if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
1032         break;
1033
1034       DictScope AS(W, "AuxSectionDef");
1035       W.printNumber("Length", Aux->Length);
1036       W.printNumber("RelocationCount", Aux->NumberOfRelocations);
1037       W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);
1038       W.printHex("Checksum", Aux->CheckSum);
1039       W.printNumber("Number", Aux->Number);
1040       W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect));
1041       W.printBinary("Unused", makeArrayRef(Aux->Unused));
1042
1043       if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT
1044           && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
1045         const coff_section *Assoc;
1046         StringRef AssocName;
1047         error_code EC;
1048         if ((EC = Obj->getSection(Aux->Number, Assoc)) ||
1049             (EC = Obj->getSectionName(Assoc, AssocName))) {
1050           AssocName = "";
1051           error(EC);
1052         }
1053
1054         W.printNumber("AssocSection", AssocName, Aux->Number);
1055       }
1056     } else if (Symbol->StorageClass == COFF::IMAGE_SYM_CLASS_CLR_TOKEN) {
1057       const coff_aux_clr_token *Aux;
1058       if (error(getSymbolAuxData(Obj, Symbol + I, Aux)))
1059         break;
1060
1061       DictScope AS(W, "AuxCLRToken");
1062       W.printNumber("AuxType", Aux->AuxType);
1063       W.printNumber("Reserved", Aux->Reserved);
1064       W.printNumber("SymbolTableIndex", Aux->SymbolTableIndex);
1065       W.printBinary("Unused", Aux->Unused);
1066
1067     } else {
1068       W.startLine() << "<unhandled auxiliary record>\n";
1069     }
1070   }
1071 }
1072
1073 void COFFDumper::printUnwindInfo() {
1074   const coff_file_header *Header;
1075   if (error(Obj->getCOFFHeader(Header)))
1076     return;
1077
1078   ListScope D(W, "UnwindInformation");
1079   if (Header->Machine != COFF::IMAGE_FILE_MACHINE_AMD64) {
1080     W.startLine() << "Unsupported image machine type "
1081               "(currently only AMD64 is supported).\n";
1082     return;
1083   }
1084
1085   printX64UnwindInfo();
1086 }
1087
1088 void COFFDumper::printX64UnwindInfo() {
1089   for (section_iterator SecI = Obj->section_begin(),
1090                         SecE = Obj->section_end();
1091        SecI != SecE; ++SecI) {
1092     StringRef Name;
1093     if (error(SecI->getName(Name)))
1094       continue;
1095     if (Name != ".pdata" && !Name.startswith(".pdata$"))
1096       continue;
1097
1098     const coff_section *PData = Obj->getCOFFSection(SecI);
1099
1100     ArrayRef<uint8_t> Contents;
1101     if (error(Obj->getSectionContents(PData, Contents)) ||
1102         Contents.empty())
1103       continue;
1104
1105     ArrayRef<RuntimeFunction> RFs(
1106       reinterpret_cast<const RuntimeFunction *>(Contents.data()),
1107       Contents.size() / sizeof(RuntimeFunction));
1108
1109     for (const RuntimeFunction *I = RFs.begin(), *E = RFs.end(); I < E; ++I) {
1110       const uint64_t OffsetInSection = std::distance(RFs.begin(), I)
1111                                      * sizeof(RuntimeFunction);
1112
1113       printRuntimeFunction(*I, OffsetInSection, RelocMap[PData]);
1114     }
1115   }
1116 }
1117
1118 void COFFDumper::printRuntimeFunction(
1119     const RuntimeFunction& RTF,
1120     uint64_t OffsetInSection,
1121     const std::vector<RelocationRef> &Rels) {
1122
1123   DictScope D(W, "RuntimeFunction");
1124   W.printString("StartAddress",
1125                 formatSymbol(Rels, OffsetInSection + 0, RTF.StartAddress));
1126   W.printString("EndAddress",
1127                 formatSymbol(Rels, OffsetInSection + 4, RTF.EndAddress));
1128   W.printString("UnwindInfoAddress",
1129                 formatSymbol(Rels, OffsetInSection + 8, RTF.UnwindInfoOffset));
1130
1131   const coff_section* XData = 0;
1132   uint64_t UnwindInfoOffset = 0;
1133   if (error(getSection(Rels, OffsetInSection + 8, &XData, &UnwindInfoOffset)))
1134     return;
1135
1136   ArrayRef<uint8_t> XContents;
1137   if (error(Obj->getSectionContents(XData, XContents)) || XContents.empty())
1138     return;
1139
1140   UnwindInfoOffset += RTF.UnwindInfoOffset;
1141   if (UnwindInfoOffset > XContents.size())
1142     return;
1143
1144   const Win64EH::UnwindInfo *UI =
1145     reinterpret_cast<const Win64EH::UnwindInfo *>(
1146       XContents.data() + UnwindInfoOffset);
1147
1148   printUnwindInfo(*UI, UnwindInfoOffset, RelocMap[XData]);
1149 }
1150
1151 void COFFDumper::printUnwindInfo(
1152     const Win64EH::UnwindInfo& UI,
1153     uint64_t OffsetInSection,
1154     const std::vector<RelocationRef> &Rels) {
1155   DictScope D(W, "UnwindInfo");
1156   W.printNumber("Version", UI.getVersion());
1157   W.printFlags("Flags", UI.getFlags(), makeArrayRef(UnwindFlags));
1158   W.printNumber("PrologSize", UI.PrologSize);
1159   if (UI.getFrameRegister() != 0) {
1160     W.printEnum("FrameRegister", UI.getFrameRegister(),
1161                 makeArrayRef(UnwindOpInfo));
1162     W.printHex("FrameOffset", UI.getFrameOffset());
1163   } else {
1164     W.printString("FrameRegister", StringRef("-"));
1165     W.printString("FrameOffset", StringRef("-"));
1166   }
1167
1168   W.printNumber("UnwindCodeCount", UI.NumCodes);
1169   {
1170     ListScope CodesD(W, "UnwindCodes");
1171     ArrayRef<UnwindCode> UCs(&UI.UnwindCodes[0], UI.NumCodes);
1172     for (const UnwindCode *I = UCs.begin(), *E = UCs.end(); I < E; ++I) {
1173       unsigned UsedSlots = getNumUsedSlots(*I);
1174       if (UsedSlots > UCs.size()) {
1175         errs() << "Corrupt unwind data";
1176         return;
1177       }
1178       printUnwindCode(UI, ArrayRef<UnwindCode>(I, E));
1179       I += UsedSlots - 1;
1180     }
1181   }
1182
1183   uint64_t LSDAOffset = OffsetInSection + getOffsetOfLSDA(UI);
1184   if (UI.getFlags() & (UNW_ExceptionHandler | UNW_TerminateHandler)) {
1185     W.printString("Handler", formatSymbol(Rels, LSDAOffset,
1186                                         UI.getLanguageSpecificHandlerOffset()));
1187   } else if (UI.getFlags() & UNW_ChainInfo) {
1188     const RuntimeFunction *Chained = UI.getChainedFunctionEntry();
1189     if (Chained) {
1190       DictScope D(W, "Chained");
1191       W.printString("StartAddress", formatSymbol(Rels, LSDAOffset + 0,
1192                                                         Chained->StartAddress));
1193       W.printString("EndAddress", formatSymbol(Rels, LSDAOffset + 4,
1194                                                           Chained->EndAddress));
1195       W.printString("UnwindInfoAddress", formatSymbol(Rels, LSDAOffset + 8,
1196                                                     Chained->UnwindInfoOffset));
1197     }
1198   }
1199 }
1200
1201 // Prints one unwind code. Because an unwind code can occupy up to 3 slots in
1202 // the unwind codes array, this function requires that the correct number of
1203 // slots is provided.
1204 void COFFDumper::printUnwindCode(const Win64EH::UnwindInfo& UI,
1205                                  ArrayRef<UnwindCode> UCs) {
1206   assert(UCs.size() >= getNumUsedSlots(UCs[0]));
1207
1208   W.startLine() << format("0x%02X: ", unsigned(UCs[0].u.CodeOffset))
1209                 << getUnwindCodeTypeName(UCs[0].getUnwindOp());
1210
1211   uint32_t AllocSize = 0;
1212
1213   switch (UCs[0].getUnwindOp()) {
1214   case UOP_PushNonVol:
1215     outs() << " reg=" << getUnwindRegisterName(UCs[0].getOpInfo());
1216     break;
1217
1218   case UOP_AllocLarge:
1219     if (UCs[0].getOpInfo() == 0) {
1220       AllocSize = UCs[1].FrameOffset * 8;
1221     } else {
1222       AllocSize = getLargeSlotValue(UCs);
1223     }
1224     outs() << " size=" << AllocSize;
1225     break;
1226   case UOP_AllocSmall:
1227     outs() << " size=" << ((UCs[0].getOpInfo() + 1) * 8);
1228     break;
1229   case UOP_SetFPReg:
1230     if (UI.getFrameRegister() == 0) {
1231       outs() << " reg=<invalid>";
1232     } else {
1233       outs() << " reg=" << getUnwindRegisterName(UI.getFrameRegister())
1234              << format(", offset=0x%X", UI.getFrameOffset() * 16);
1235     }
1236     break;
1237   case UOP_SaveNonVol:
1238     outs() << " reg=" << getUnwindRegisterName(UCs[0].getOpInfo())
1239            << format(", offset=0x%X", UCs[1].FrameOffset * 8);
1240     break;
1241   case UOP_SaveNonVolBig:
1242     outs() << " reg=" << getUnwindRegisterName(UCs[0].getOpInfo())
1243            << format(", offset=0x%X", getLargeSlotValue(UCs));
1244     break;
1245   case UOP_SaveXMM128:
1246     outs() << " reg=XMM" << static_cast<uint32_t>(UCs[0].getOpInfo())
1247            << format(", offset=0x%X", UCs[1].FrameOffset * 16);
1248     break;
1249   case UOP_SaveXMM128Big:
1250     outs() << " reg=XMM" << static_cast<uint32_t>(UCs[0].getOpInfo())
1251            << format(", offset=0x%X", getLargeSlotValue(UCs));
1252     break;
1253   case UOP_PushMachFrame:
1254     outs() << " errcode=" << (UCs[0].getOpInfo() == 0 ? "no" : "yes");
1255     break;
1256   }
1257
1258   outs() << "\n";
1259 }