lib/Object/COFFObjectFile.cpp

   1 //===- COFFObjectFile.cpp - COFF object file implementation -----*- 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 // This file declares the COFFObjectFile class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Object/COFF.h"
  15 #include "llvm/ADT/ArrayRef.h"
  16 #include "llvm/ADT/SmallString.h"
  17 #include "llvm/ADT/StringSwitch.h"
  18 #include "llvm/ADT/Triple.h"
  19 #include "llvm/ADT/iterator_range.h"
  20 #include "llvm/Support/COFF.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 #include <cctype>
  24 #include <limits>
  25
  26 using namespace llvm;
  27 using namespace object;
  28
  29 using support::ulittle16_t;
  30 using support::ulittle32_t;
  31 using support::ulittle64_t;
  32 using support::little16_t;
  33
  34 // Returns false if size is greater than the buffer size. And sets ec.
  35 static bool checkSize(MemoryBufferRef M, std::error_code &EC, uint64_t Size) {
  36   if (M.getBufferSize() < Size) {
  37     EC = object_error::unexpected_eof;
  38     return false;
  39   }
  40   return true;
  41 }
  42
  43 static std::error_code checkOffset(MemoryBufferRef M, uintptr_t Addr,
  44                                    const uint64_t Size) {
  45   if (Addr + Size < Addr || Addr + Size < Size ||
  46       Addr + Size > uintptr_t(M.getBufferEnd()) ||
  47       Addr < uintptr_t(M.getBufferStart())) {
  48     return object_error::unexpected_eof;
  49   }
  50   return std::error_code();
  51 }
  52
  53 // Sets Obj unless any bytes in [addr, addr + size) fall outsize of m.
  54 // Returns unexpected_eof if error.
  55 template <typename T>
  56 static std::error_code getObject(const T *&Obj, MemoryBufferRef M,
  57                                  const void *Ptr,
  58                                  const uint64_t Size = sizeof(T)) {
  59   uintptr_t Addr = uintptr_t(Ptr);
  60   if (std::error_code EC = checkOffset(M, Addr, Size))
  61     return EC;
  62   Obj = reinterpret_cast<const T *>(Addr);
  63   return std::error_code();
  64 }
  65
  66 // Decode a string table entry in base 64 (//AAAAAA). Expects \arg Str without
  67 // prefixed slashes.
  68 static bool decodeBase64StringEntry(StringRef Str, uint32_t &Result) {
  69   assert(Str.size() <= 6 && "String too long, possible overflow.");
  70   if (Str.size() > 6)
  71     return true;
  72
  73   uint64_t Value = 0;
  74   while (!Str.empty()) {
  75     unsigned CharVal;
  76     if (Str[0] >= 'A' && Str[0] <= 'Z') // 0..25
  77       CharVal = Str[0] - 'A';
  78     else if (Str[0] >= 'a' && Str[0] <= 'z') // 26..51
  79       CharVal = Str[0] - 'a' + 26;
  80     else if (Str[0] >= '0' && Str[0] <= '9') // 52..61
  81       CharVal = Str[0] - '0' + 52;
  82     else if (Str[0] == '+') // 62
  83       CharVal = 62;
  84     else if (Str[0] == '/') // 63
  85       CharVal = 63;
  86     else
  87       return true;
  88
  89     Value = (Value * 64) + CharVal;
  90     Str = Str.substr(1);
  91   }
  92
  93   if (Value > std::numeric_limits<uint32_t>::max())
  94     return true;
  95
  96   Result = static_cast<uint32_t>(Value);
  97   return false;
  98 }
  99
 100 template <typename coff_symbol_type>
 101 const coff_symbol_type *COFFObjectFile::toSymb(DataRefImpl Ref) const {
 102   const coff_symbol_type *Addr =
 103       reinterpret_cast<const coff_symbol_type *>(Ref.p);
 104
 105   assert(!checkOffset(Data, uintptr_t(Addr), sizeof(*Addr)));
 106 #ifndef NDEBUG
 107   // Verify that the symbol points to a valid entry in the symbol table.
 108   uintptr_t Offset = uintptr_t(Addr) - uintptr_t(base());
 109
 110   assert((Offset - getPointerToSymbolTable()) % sizeof(coff_symbol_type) == 0 &&
 111          "Symbol did not point to the beginning of a symbol");
 112 #endif
 113
 114   return Addr;
 115 }
 116
 117 const coff_section *COFFObjectFile::toSec(DataRefImpl Ref) const {
 118   const coff_section *Addr = reinterpret_cast<const coff_section*>(Ref.p);
 119
 120 # ifndef NDEBUG
 121   // Verify that the section points to a valid entry in the section table.
 122   if (Addr < SectionTable || Addr >= (SectionTable + getNumberOfSections()))
 123     report_fatal_error("Section was outside of section table.");
 124
 125   uintptr_t Offset = uintptr_t(Addr) - uintptr_t(SectionTable);
 126   assert(Offset % sizeof(coff_section) == 0 &&
 127          "Section did not point to the beginning of a section");
 128 # endif
 129
 130   return Addr;
 131 }
 132
 133 void COFFObjectFile::moveSymbolNext(DataRefImpl &Ref) const {
 134   auto End = reinterpret_cast<uintptr_t>(StringTable);
 135   if (SymbolTable16) {
 136     const coff_symbol16 *Symb = toSymb<coff_symbol16>(Ref);
 137     Symb += 1 + Symb->NumberOfAuxSymbols;
 138     Ref.p = std::min(reinterpret_cast<uintptr_t>(Symb), End);
 139   } else if (SymbolTable32) {
 140     const coff_symbol32 *Symb = toSymb<coff_symbol32>(Ref);
 141     Symb += 1 + Symb->NumberOfAuxSymbols;
 142     Ref.p = std::min(reinterpret_cast<uintptr_t>(Symb), End);
 143   } else {
 144     llvm_unreachable("no symbol table pointer!");
 145   }
 146 }
 147
 148 ErrorOr<StringRef> COFFObjectFile::getSymbolName(DataRefImpl Ref) const {
 149   COFFSymbolRef Symb = getCOFFSymbol(Ref);
 150   StringRef Result;
 151   std::error_code EC = getSymbolName(Symb, Result);
 152   if (EC)
 153     return EC;
 154   return Result;
 155 }
 156
 157 uint64_t COFFObjectFile::getSymbolValueImpl(DataRefImpl Ref) const {
 158   return getCOFFSymbol(Ref).getValue();
 159 }
 160
 161 ErrorOr<uint64_t> COFFObjectFile::getSymbolAddress(DataRefImpl Ref) const {
 162   uint64_t Result = getSymbolValue(Ref);
 163   COFFSymbolRef Symb = getCOFFSymbol(Ref);
 164   int32_t SectionNumber = Symb.getSectionNumber();
 165
 166   if (Symb.isAnyUndefined() || Symb.isCommon() ||
 167       COFF::isReservedSectionNumber(SectionNumber))
 168     return Result;
 169
 170   const coff_section *Section = nullptr;
 171   if (std::error_code EC = getSection(SectionNumber, Section))
 172     return EC;
 173   Result += Section->VirtualAddress;
 174
 175   // The section VirtualAddress does not include ImageBase, and we want to
 176   // return virtual addresses.
 177   if (PE32Header)
 178     Result += PE32Header->ImageBase;
 179   else if (PE32PlusHeader)
 180     Result += PE32Header->ImageBase;
 181
 182   return Result;
 183 }
 184
 185 SymbolRef::Type COFFObjectFile::getSymbolType(DataRefImpl Ref) const {
 186   COFFSymbolRef Symb = getCOFFSymbol(Ref);
 187   int32_t SectionNumber = Symb.getSectionNumber();
 188
 189   if (Symb.isAnyUndefined())
 190     return SymbolRef::ST_Unknown;
 191   if (Symb.isFunctionDefinition())
 192     return SymbolRef::ST_Function;
 193   if (Symb.isCommon())
 194     return SymbolRef::ST_Data;
 195   if (Symb.isFileRecord())
 196     return SymbolRef::ST_File;
 197
 198   // TODO: perhaps we need a new symbol type ST_Section.
 199   if (SectionNumber == COFF::IMAGE_SYM_DEBUG || Symb.isSectionDefinition())
 200     return SymbolRef::ST_Debug;
 201
 202   if (!COFF::isReservedSectionNumber(SectionNumber))
 203     return SymbolRef::ST_Data;
 204
 205   return SymbolRef::ST_Other;
 206 }
 207
 208 uint32_t COFFObjectFile::getSymbolFlags(DataRefImpl Ref) const {
 209   COFFSymbolRef Symb = getCOFFSymbol(Ref);
 210   uint32_t Result = SymbolRef::SF_None;
 211
 212   if (Symb.isExternal() || Symb.isWeakExternal())
 213     Result |= SymbolRef::SF_Global;
 214
 215   if (Symb.isWeakExternal())
 216     Result |= SymbolRef::SF_Weak;
 217
 218   if (Symb.getSectionNumber() == COFF::IMAGE_SYM_ABSOLUTE)
 219     Result |= SymbolRef::SF_Absolute;
 220
 221   if (Symb.isFileRecord())
 222     Result |= SymbolRef::SF_FormatSpecific;
 223
 224   if (Symb.isSectionDefinition())
 225     Result |= SymbolRef::SF_FormatSpecific;
 226
 227   if (Symb.isCommon())
 228     Result |= SymbolRef::SF_Common;
 229
 230   if (Symb.isAnyUndefined())
 231     Result |= SymbolRef::SF_Undefined;
 232
 233   return Result;
 234 }
 235
 236 uint64_t COFFObjectFile::getCommonSymbolSizeImpl(DataRefImpl Ref) const {
 237   COFFSymbolRef Symb = getCOFFSymbol(Ref);
 238   return Symb.getValue();
 239 }
 240
 241 std::error_code
 242 COFFObjectFile::getSymbolSection(DataRefImpl Ref,
 243                                  section_iterator &Result) const {
 244   COFFSymbolRef Symb = getCOFFSymbol(Ref);
 245   if (COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
 246     Result = section_end();
 247   } else {
 248     const coff_section *Sec = nullptr;
 249     if (std::error_code EC = getSection(Symb.getSectionNumber(), Sec))
 250       return EC;
 251     DataRefImpl Ref;
 252     Ref.p = reinterpret_cast<uintptr_t>(Sec);
 253     Result = section_iterator(SectionRef(Ref, this));
 254   }
 255   return std::error_code();
 256 }
 257
 258 unsigned COFFObjectFile::getSymbolSectionID(SymbolRef Sym) const {
 259   COFFSymbolRef Symb = getCOFFSymbol(Sym.getRawDataRefImpl());
 260   return Symb.getSectionNumber();
 261 }
 262
 263 void COFFObjectFile::moveSectionNext(DataRefImpl &Ref) const {
 264   const coff_section *Sec = toSec(Ref);
 265   Sec += 1;
 266   Ref.p = reinterpret_cast<uintptr_t>(Sec);
 267 }
 268
 269 std::error_code COFFObjectFile::getSectionName(DataRefImpl Ref,
 270                                                StringRef &Result) const {
 271   const coff_section *Sec = toSec(Ref);
 272   return getSectionName(Sec, Result);
 273 }
 274
 275 uint64_t COFFObjectFile::getSectionAddress(DataRefImpl Ref) const {
 276   const coff_section *Sec = toSec(Ref);
 277   return Sec->VirtualAddress;
 278 }
 279
 280 uint64_t COFFObjectFile::getSectionSize(DataRefImpl Ref) const {
 281   return getSectionSize(toSec(Ref));
 282 }
 283
 284 std::error_code COFFObjectFile::getSectionContents(DataRefImpl Ref,
 285                                                    StringRef &Result) const {
 286   const coff_section *Sec = toSec(Ref);
 287   ArrayRef<uint8_t> Res;
 288   std::error_code EC = getSectionContents(Sec, Res);
 289   Result = StringRef(reinterpret_cast<const char*>(Res.data()), Res.size());
 290   return EC;
 291 }
 292
 293 uint64_t COFFObjectFile::getSectionAlignment(DataRefImpl Ref) const {
 294   const coff_section *Sec = toSec(Ref);
 295   return uint64_t(1) << (((Sec->Characteristics & 0x00F00000) >> 20) - 1);
 296 }
 297
 298 bool COFFObjectFile::isSectionText(DataRefImpl Ref) const {
 299   const coff_section *Sec = toSec(Ref);
 300   return Sec->Characteristics & COFF::IMAGE_SCN_CNT_CODE;
 301 }
 302
 303 bool COFFObjectFile::isSectionData(DataRefImpl Ref) const {
 304   const coff_section *Sec = toSec(Ref);
 305   return Sec->Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA;
 306 }
 307
 308 bool COFFObjectFile::isSectionBSS(DataRefImpl Ref) const {
 309   const coff_section *Sec = toSec(Ref);
 310   const uint32_t BssFlags = COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA |
 311                             COFF::IMAGE_SCN_MEM_READ |
 312                             COFF::IMAGE_SCN_MEM_WRITE;
 313   return (Sec->Characteristics & BssFlags) == BssFlags;
 314 }
 315
 316 unsigned COFFObjectFile::getSectionID(SectionRef Sec) const {
 317   uintptr_t Offset =
 318       uintptr_t(Sec.getRawDataRefImpl().p) - uintptr_t(SectionTable);
 319   assert((Offset % sizeof(coff_section)) == 0);
 320   return (Offset / sizeof(coff_section)) + 1;
 321 }
 322
 323 bool COFFObjectFile::isSectionVirtual(DataRefImpl Ref) const {
 324   const coff_section *Sec = toSec(Ref);
 325   // In COFF, a virtual section won't have any in-file
 326   // content, so the file pointer to the content will be zero.
 327   return Sec->PointerToRawData == 0;
 328 }
 329
 330 static uint32_t getNumberOfRelocations(const coff_section *Sec,
 331                                        MemoryBufferRef M, const uint8_t *base) {
 332   // The field for the number of relocations in COFF section table is only
 333   // 16-bit wide. If a section has more than 65535 relocations, 0xFFFF is set to
 334   // NumberOfRelocations field, and the actual relocation count is stored in the
 335   // VirtualAddress field in the first relocation entry.
 336   if (Sec->hasExtendedRelocations()) {
 337     const coff_relocation *FirstReloc;
 338     if (getObject(FirstReloc, M, reinterpret_cast<const coff_relocation*>(
 339         base + Sec->PointerToRelocations)))
 340       return 0;
 341     // -1 to exclude this first relocation entry.
 342     return FirstReloc->VirtualAddress - 1;
 343   }
 344   return Sec->NumberOfRelocations;
 345 }
 346
 347 static const coff_relocation *
 348 getFirstReloc(const coff_section *Sec, MemoryBufferRef M, const uint8_t *Base) {
 349   uint64_t NumRelocs = getNumberOfRelocations(Sec, M, Base);
 350   if (!NumRelocs)
 351     return nullptr;
 352   auto begin = reinterpret_cast<const coff_relocation *>(
 353       Base + Sec->PointerToRelocations);
 354   if (Sec->hasExtendedRelocations()) {
 355     // Skip the first relocation entry repurposed to store the number of
 356     // relocations.
 357     begin++;
 358   }
 359   if (checkOffset(M, uintptr_t(begin), sizeof(coff_relocation) * NumRelocs))
 360     return nullptr;
 361   return begin;
 362 }
 363
 364 relocation_iterator COFFObjectFile::section_rel_begin(DataRefImpl Ref) const {
 365   const coff_section *Sec = toSec(Ref);
 366   const coff_relocation *begin = getFirstReloc(Sec, Data, base());
 367   if (begin && Sec->VirtualAddress != 0)
 368     report_fatal_error("Sections with relocations should have an address of 0");
 369   DataRefImpl Ret;
 370   Ret.p = reinterpret_cast<uintptr_t>(begin);
 371   return relocation_iterator(RelocationRef(Ret, this));
 372 }
 373
 374 relocation_iterator COFFObjectFile::section_rel_end(DataRefImpl Ref) const {
 375   const coff_section *Sec = toSec(Ref);
 376   const coff_relocation *I = getFirstReloc(Sec, Data, base());
 377   if (I)
 378     I += getNumberOfRelocations(Sec, Data, base());
 379   DataRefImpl Ret;
 380   Ret.p = reinterpret_cast<uintptr_t>(I);
 381   return relocation_iterator(RelocationRef(Ret, this));
 382 }
 383
 384 // Initialize the pointer to the symbol table.
 385 std::error_code COFFObjectFile::initSymbolTablePtr() {
 386   if (COFFHeader)
 387     if (std::error_code EC = getObject(
 388             SymbolTable16, Data, base() + getPointerToSymbolTable(),
 389             (uint64_t)getNumberOfSymbols() * getSymbolTableEntrySize()))
 390       return EC;
 391
 392   if (COFFBigObjHeader)
 393     if (std::error_code EC = getObject(
 394             SymbolTable32, Data, base() + getPointerToSymbolTable(),
 395             (uint64_t)getNumberOfSymbols() * getSymbolTableEntrySize()))
 396       return EC;
 397
 398   // Find string table. The first four byte of the string table contains the
 399   // total size of the string table, including the size field itself. If the
 400   // string table is empty, the value of the first four byte would be 4.
 401   uint32_t StringTableOffset = getPointerToSymbolTable() +
 402                                getNumberOfSymbols() * getSymbolTableEntrySize();
 403   const uint8_t *StringTableAddr = base() + StringTableOffset;
 404   const ulittle32_t *StringTableSizePtr;
 405   if (std::error_code EC = getObject(StringTableSizePtr, Data, StringTableAddr))
 406     return EC;
 407   StringTableSize = *StringTableSizePtr;
 408   if (std::error_code EC =
 409           getObject(StringTable, Data, StringTableAddr, StringTableSize))
 410     return EC;
 411
 412   // Treat table sizes < 4 as empty because contrary to the PECOFF spec, some
 413   // tools like cvtres write a size of 0 for an empty table instead of 4.
 414   if (StringTableSize < 4)
 415       StringTableSize = 4;
 416
 417   // Check that the string table is null terminated if has any in it.
 418   if (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0)
 419     return  object_error::parse_failed;
 420   return std::error_code();
 421 }
 422
 423 // Returns the file offset for the given VA.
 424 std::error_code COFFObjectFile::getVaPtr(uint64_t Addr, uintptr_t &Res) const {
 425   uint64_t ImageBase = PE32Header ? (uint64_t)PE32Header->ImageBase
 426                                   : (uint64_t)PE32PlusHeader->ImageBase;
 427   uint64_t Rva = Addr - ImageBase;
 428   assert(Rva <= UINT32_MAX);
 429   return getRvaPtr((uint32_t)Rva, Res);
 430 }
 431
 432 // Returns the file offset for the given RVA.
 433 std::error_code COFFObjectFile::getRvaPtr(uint32_t Addr, uintptr_t &Res) const {
 434   for (const SectionRef &S : sections()) {
 435     const coff_section *Section = getCOFFSection(S);
 436     uint32_t SectionStart = Section->VirtualAddress;
 437     uint32_t SectionEnd = Section->VirtualAddress + Section->VirtualSize;
 438     if (SectionStart <= Addr && Addr < SectionEnd) {
 439       uint32_t Offset = Addr - SectionStart;
 440       Res = uintptr_t(base()) + Section->PointerToRawData + Offset;
 441       return std::error_code();
 442     }
 443   }
 444   return object_error::parse_failed;
 445 }
 446
 447 // Returns hint and name fields, assuming \p Rva is pointing to a Hint/Name
 448 // table entry.
 449 std::error_code COFFObjectFile::getHintName(uint32_t Rva, uint16_t &Hint,
 450                                             StringRef &Name) const {
 451   uintptr_t IntPtr = 0;
 452   if (std::error_code EC = getRvaPtr(Rva, IntPtr))
 453     return EC;
 454   const uint8_t *Ptr = reinterpret_cast<const uint8_t *>(IntPtr);
 455   Hint = *reinterpret_cast<const ulittle16_t *>(Ptr);
 456   Name = StringRef(reinterpret_cast<const char *>(Ptr + 2));
 457   return std::error_code();
 458 }
 459
 460 // Find the import table.
 461 std::error_code COFFObjectFile::initImportTablePtr() {
 462   // First, we get the RVA of the import table. If the file lacks a pointer to
 463   // the import table, do nothing.
 464   const data_directory *DataEntry;
 465   if (getDataDirectory(COFF::IMPORT_TABLE, DataEntry))
 466     return std::error_code();
 467
 468   // Do nothing if the pointer to import table is NULL.
 469   if (DataEntry->RelativeVirtualAddress == 0)
 470     return std::error_code();
 471
 472   uint32_t ImportTableRva = DataEntry->RelativeVirtualAddress;
 473   // -1 because the last entry is the null entry.
 474   NumberOfImportDirectory = DataEntry->Size /
 475       sizeof(import_directory_table_entry) - 1;
 476
 477   // Find the section that contains the RVA. This is needed because the RVA is
 478   // the import table's memory address which is different from its file offset.
 479   uintptr_t IntPtr = 0;
 480   if (std::error_code EC = getRvaPtr(ImportTableRva, IntPtr))
 481     return EC;
 482   ImportDirectory = reinterpret_cast<
 483       const import_directory_table_entry *>(IntPtr);
 484   return std::error_code();
 485 }
 486
 487 // Initializes DelayImportDirectory and NumberOfDelayImportDirectory.
 488 std::error_code COFFObjectFile::initDelayImportTablePtr() {
 489   const data_directory *DataEntry;
 490   if (getDataDirectory(COFF::DELAY_IMPORT_DESCRIPTOR, DataEntry))
 491     return std::error_code();
 492   if (DataEntry->RelativeVirtualAddress == 0)
 493     return std::error_code();
 494
 495   uint32_t RVA = DataEntry->RelativeVirtualAddress;
 496   NumberOfDelayImportDirectory = DataEntry->Size /
 497       sizeof(delay_import_directory_table_entry) - 1;
 498
 499   uintptr_t IntPtr = 0;
 500   if (std::error_code EC = getRvaPtr(RVA, IntPtr))
 501     return EC;
 502   DelayImportDirectory = reinterpret_cast<
 503       const delay_import_directory_table_entry *>(IntPtr);
 504   return std::error_code();
 505 }
 506
 507 // Find the export table.
 508 std::error_code COFFObjectFile::initExportTablePtr() {
 509   // First, we get the RVA of the export table. If the file lacks a pointer to
 510   // the export table, do nothing.
 511   const data_directory *DataEntry;
 512   if (getDataDirectory(COFF::EXPORT_TABLE, DataEntry))
 513     return std::error_code();
 514
 515   // Do nothing if the pointer to export table is NULL.
 516   if (DataEntry->RelativeVirtualAddress == 0)
 517     return std::error_code();
 518
 519   uint32_t ExportTableRva = DataEntry->RelativeVirtualAddress;
 520   uintptr_t IntPtr = 0;
 521   if (std::error_code EC = getRvaPtr(ExportTableRva, IntPtr))
 522     return EC;
 523   ExportDirectory =
 524       reinterpret_cast<const export_directory_table_entry *>(IntPtr);
 525   return std::error_code();
 526 }
 527
 528 std::error_code COFFObjectFile::initBaseRelocPtr() {
 529   const data_directory *DataEntry;
 530   if (getDataDirectory(COFF::BASE_RELOCATION_TABLE, DataEntry))
 531     return std::error_code();
 532   if (DataEntry->RelativeVirtualAddress == 0)
 533     return std::error_code();
 534
 535   uintptr_t IntPtr = 0;
 536   if (std::error_code EC = getRvaPtr(DataEntry->RelativeVirtualAddress, IntPtr))
 537     return EC;
 538   BaseRelocHeader = reinterpret_cast<const coff_base_reloc_block_header *>(
 539       IntPtr);
 540   BaseRelocEnd = reinterpret_cast<coff_base_reloc_block_header *>(
 541       IntPtr + DataEntry->Size);
 542   return std::error_code();
 543 }
 544
 545 COFFObjectFile::COFFObjectFile(MemoryBufferRef Object, std::error_code &EC)
 546     : ObjectFile(Binary::ID_COFF, Object), COFFHeader(nullptr),
 547       COFFBigObjHeader(nullptr), PE32Header(nullptr), PE32PlusHeader(nullptr),
 548       DataDirectory(nullptr), SectionTable(nullptr), SymbolTable16(nullptr),
 549       SymbolTable32(nullptr), StringTable(nullptr), StringTableSize(0),
 550       ImportDirectory(nullptr), NumberOfImportDirectory(0),
 551       DelayImportDirectory(nullptr), NumberOfDelayImportDirectory(0),
 552       ExportDirectory(nullptr), BaseRelocHeader(nullptr),
 553       BaseRelocEnd(nullptr) {
 554   // Check that we at least have enough room for a header.
 555   if (!checkSize(Data, EC, sizeof(coff_file_header)))
 556     return;
 557
 558   // The current location in the file where we are looking at.
 559   uint64_t CurPtr = 0;
 560
 561   // PE header is optional and is present only in executables. If it exists,
 562   // it is placed right after COFF header.
 563   bool HasPEHeader = false;
 564
 565   // Check if this is a PE/COFF file.
 566   if (checkSize(Data, EC, sizeof(dos_header) + sizeof(COFF::PEMagic))) {
 567     // PE/COFF, seek through MS-DOS compatibility stub and 4-byte
 568     // PE signature to find 'normal' COFF header.
 569     const auto *DH = reinterpret_cast<const dos_header *>(base());
 570     if (DH->Magic[0] == 'M' && DH->Magic[1] == 'Z') {
 571       CurPtr = DH->AddressOfNewExeHeader;
 572       // Check the PE magic bytes. ("PE\0\0")
 573       if (memcmp(base() + CurPtr, COFF::PEMagic, sizeof(COFF::PEMagic)) != 0) {
 574         EC = object_error::parse_failed;
 575         return;
 576       }
 577       CurPtr += sizeof(COFF::PEMagic); // Skip the PE magic bytes.
 578       HasPEHeader = true;
 579     }
 580   }
 581
 582   if ((EC = getObject(COFFHeader, Data, base() + CurPtr)))
 583     return;
 584
 585   // It might be a bigobj file, let's check.  Note that COFF bigobj and COFF
 586   // import libraries share a common prefix but bigobj is more restrictive.
 587   if (!HasPEHeader && COFFHeader->Machine == COFF::IMAGE_FILE_MACHINE_UNKNOWN &&
 588       COFFHeader->NumberOfSections == uint16_t(0xffff) &&
 589       checkSize(Data, EC, sizeof(coff_bigobj_file_header))) {
 590     if ((EC = getObject(COFFBigObjHeader, Data, base() + CurPtr)))
 591       return;
 592
 593     // Verify that we are dealing with bigobj.
 594     if (COFFBigObjHeader->Version >= COFF::BigObjHeader::MinBigObjectVersion &&
 595         std::memcmp(COFFBigObjHeader->UUID, COFF::BigObjMagic,
 596                     sizeof(COFF::BigObjMagic)) == 0) {
 597       COFFHeader = nullptr;
 598       CurPtr += sizeof(coff_bigobj_file_header);
 599     } else {
 600       // It's not a bigobj.
 601       COFFBigObjHeader = nullptr;
 602     }
 603   }
 604   if (COFFHeader) {
 605     // The prior checkSize call may have failed.  This isn't a hard error
 606     // because we were just trying to sniff out bigobj.
 607     EC = std::error_code();
 608     CurPtr += sizeof(coff_file_header);
 609
 610     if (COFFHeader->isImportLibrary())
 611       return;
 612   }
 613
 614   if (HasPEHeader) {
 615     const pe32_header *Header;
 616     if ((EC = getObject(Header, Data, base() + CurPtr)))
 617       return;
 618
 619     const uint8_t *DataDirAddr;
 620     uint64_t DataDirSize;
 621     if (Header->Magic == COFF::PE32Header::PE32) {
 622       PE32Header = Header;
 623       DataDirAddr = base() + CurPtr + sizeof(pe32_header);
 624       DataDirSize = sizeof(data_directory) * PE32Header->NumberOfRvaAndSize;
 625     } else if (Header->Magic == COFF::PE32Header::PE32_PLUS) {
 626       PE32PlusHeader = reinterpret_cast<const pe32plus_header *>(Header);
 627       DataDirAddr = base() + CurPtr + sizeof(pe32plus_header);
 628       DataDirSize = sizeof(data_directory) * PE32PlusHeader->NumberOfRvaAndSize;
 629     } else {
 630       // It's neither PE32 nor PE32+.
 631       EC = object_error::parse_failed;
 632       return;
 633     }
 634     if ((EC = getObject(DataDirectory, Data, DataDirAddr, DataDirSize)))
 635       return;
 636     CurPtr += COFFHeader->SizeOfOptionalHeader;
 637   }
 638
 639   if ((EC = getObject(SectionTable, Data, base() + CurPtr,
 640                       (uint64_t)getNumberOfSections() * sizeof(coff_section))))
 641     return;
 642
 643   // Initialize the pointer to the symbol table.
 644   if (getPointerToSymbolTable() != 0) {
 645     if ((EC = initSymbolTablePtr()))
 646       return;
 647   } else {
 648     // We had better not have any symbols if we don't have a symbol table.
 649     if (getNumberOfSymbols() != 0) {
 650       EC = object_error::parse_failed;
 651       return;
 652     }
 653   }
 654
 655   // Initialize the pointer to the beginning of the import table.
 656   if ((EC = initImportTablePtr()))
 657     return;
 658   if ((EC = initDelayImportTablePtr()))
 659     return;
 660
 661   // Initialize the pointer to the export table.
 662   if ((EC = initExportTablePtr()))
 663     return;
 664
 665   // Initialize the pointer to the base relocation table.
 666   if ((EC = initBaseRelocPtr()))
 667     return;
 668
 669   EC = std::error_code();
 670 }
 671
 672 basic_symbol_iterator COFFObjectFile::symbol_begin_impl() const {
 673   DataRefImpl Ret;
 674   Ret.p = getSymbolTable();
 675   return basic_symbol_iterator(SymbolRef(Ret, this));
 676 }
 677
 678 basic_symbol_iterator COFFObjectFile::symbol_end_impl() const {
 679   // The symbol table ends where the string table begins.
 680   DataRefImpl Ret;
 681   Ret.p = reinterpret_cast<uintptr_t>(StringTable);
 682   return basic_symbol_iterator(SymbolRef(Ret, this));
 683 }
 684
 685 import_directory_iterator COFFObjectFile::import_directory_begin() const {
 686   return import_directory_iterator(
 687       ImportDirectoryEntryRef(ImportDirectory, 0, this));
 688 }
 689
 690 import_directory_iterator COFFObjectFile::import_directory_end() const {
 691   return import_directory_iterator(
 692       ImportDirectoryEntryRef(ImportDirectory, NumberOfImportDirectory, this));
 693 }
 694
 695 delay_import_directory_iterator
 696 COFFObjectFile::delay_import_directory_begin() const {
 697   return delay_import_directory_iterator(
 698       DelayImportDirectoryEntryRef(DelayImportDirectory, 0, this));
 699 }
 700
 701 delay_import_directory_iterator
 702 COFFObjectFile::delay_import_directory_end() const {
 703   return delay_import_directory_iterator(
 704       DelayImportDirectoryEntryRef(
 705           DelayImportDirectory, NumberOfDelayImportDirectory, this));
 706 }
 707
 708 export_directory_iterator COFFObjectFile::export_directory_begin() const {
 709   return export_directory_iterator(
 710       ExportDirectoryEntryRef(ExportDirectory, 0, this));
 711 }
 712
 713 export_directory_iterator COFFObjectFile::export_directory_end() const {
 714   if (!ExportDirectory)
 715     return export_directory_iterator(ExportDirectoryEntryRef(nullptr, 0, this));
 716   ExportDirectoryEntryRef Ref(ExportDirectory,
 717                               ExportDirectory->AddressTableEntries, this);
 718   return export_directory_iterator(Ref);
 719 }
 720
 721 section_iterator COFFObjectFile::section_begin() const {
 722   DataRefImpl Ret;
 723   Ret.p = reinterpret_cast<uintptr_t>(SectionTable);
 724   return section_iterator(SectionRef(Ret, this));
 725 }
 726
 727 section_iterator COFFObjectFile::section_end() const {
 728   DataRefImpl Ret;
 729   int NumSections =
 730       COFFHeader && COFFHeader->isImportLibrary() ? 0 : getNumberOfSections();
 731   Ret.p = reinterpret_cast<uintptr_t>(SectionTable + NumSections);
 732   return section_iterator(SectionRef(Ret, this));
 733 }
 734
 735 base_reloc_iterator COFFObjectFile::base_reloc_begin() const {
 736   return base_reloc_iterator(BaseRelocRef(BaseRelocHeader, this));
 737 }
 738
 739 base_reloc_iterator COFFObjectFile::base_reloc_end() const {
 740   return base_reloc_iterator(BaseRelocRef(BaseRelocEnd, this));
 741 }
 742
 743 uint8_t COFFObjectFile::getBytesInAddress() const {
 744   return getArch() == Triple::x86_64 ? 8 : 4;
 745 }
 746
 747 StringRef COFFObjectFile::getFileFormatName() const {
 748   switch(getMachine()) {
 749   case COFF::IMAGE_FILE_MACHINE_I386:
 750     return "COFF-i386";
 751   case COFF::IMAGE_FILE_MACHINE_AMD64:
 752     return "COFF-x86-64";
 753   case COFF::IMAGE_FILE_MACHINE_ARMNT:
 754     return "COFF-ARM";
 755   case COFF::IMAGE_FILE_MACHINE_ARM64:
 756     return "COFF-ARM64";
 757   default:
 758     return "COFF-<unknown arch>";
 759   }
 760 }
 761
 762 unsigned COFFObjectFile::getArch() const {
 763   switch (getMachine()) {
 764   case COFF::IMAGE_FILE_MACHINE_I386:
 765     return Triple::x86;
 766   case COFF::IMAGE_FILE_MACHINE_AMD64:
 767     return Triple::x86_64;
 768   case COFF::IMAGE_FILE_MACHINE_ARMNT:
 769     return Triple::thumb;
 770   case COFF::IMAGE_FILE_MACHINE_ARM64:
 771     return Triple::aarch64;
 772   default:
 773     return Triple::UnknownArch;
 774   }
 775 }
 776
 777 iterator_range<import_directory_iterator>
 778 COFFObjectFile::import_directories() const {
 779   return make_range(import_directory_begin(), import_directory_end());
 780 }
 781
 782 iterator_range<delay_import_directory_iterator>
 783 COFFObjectFile::delay_import_directories() const {
 784   return make_range(delay_import_directory_begin(),
 785                     delay_import_directory_end());
 786 }
 787
 788 iterator_range<export_directory_iterator>
 789 COFFObjectFile::export_directories() const {
 790   return make_range(export_directory_begin(), export_directory_end());
 791 }
 792
 793 iterator_range<base_reloc_iterator> COFFObjectFile::base_relocs() const {
 794   return make_range(base_reloc_begin(), base_reloc_end());
 795 }
 796
 797 std::error_code COFFObjectFile::getPE32Header(const pe32_header *&Res) const {
 798   Res = PE32Header;
 799   return std::error_code();
 800 }
 801
 802 std::error_code
 803 COFFObjectFile::getPE32PlusHeader(const pe32plus_header *&Res) const {
 804   Res = PE32PlusHeader;
 805   return std::error_code();
 806 }
 807
 808 std::error_code
 809 COFFObjectFile::getDataDirectory(uint32_t Index,
 810                                  const data_directory *&Res) const {
 811   // Error if if there's no data directory or the index is out of range.
 812   if (!DataDirectory) {
 813     Res = nullptr;
 814     return object_error::parse_failed;
 815   }
 816   assert(PE32Header || PE32PlusHeader);
 817   uint32_t NumEnt = PE32Header ? PE32Header->NumberOfRvaAndSize
 818                                : PE32PlusHeader->NumberOfRvaAndSize;
 819   if (Index >= NumEnt) {
 820     Res = nullptr;
 821     return object_error::parse_failed;
 822   }
 823   Res = &DataDirectory[Index];
 824   return std::error_code();
 825 }
 826
 827 std::error_code COFFObjectFile::getSection(int32_t Index,
 828                                            const coff_section *&Result) const {
 829   Result = nullptr;
 830   if (COFF::isReservedSectionNumber(Index))
 831     return std::error_code();
 832   if (static_cast<uint32_t>(Index) <= getNumberOfSections()) {
 833     // We already verified the section table data, so no need to check again.
 834     Result = SectionTable + (Index - 1);
 835     return std::error_code();
 836   }
 837   return object_error::parse_failed;
 838 }
 839
 840 std::error_code COFFObjectFile::getString(uint32_t Offset,
 841                                           StringRef &Result) const {
 842   if (StringTableSize <= 4)
 843     // Tried to get a string from an empty string table.
 844     return object_error::parse_failed;
 845   if (Offset >= StringTableSize)
 846     return object_error::unexpected_eof;
 847   Result = StringRef(StringTable + Offset);
 848   return std::error_code();
 849 }
 850
 851 std::error_code COFFObjectFile::getSymbolName(COFFSymbolRef Symbol,
 852                                               StringRef &Res) const {
 853   return getSymbolName(Symbol.getGeneric(), Res);
 854 }
 855
 856 std::error_code COFFObjectFile::getSymbolName(const coff_symbol_generic *Symbol,
 857                                               StringRef &Res) const {
 858   // Check for string table entry. First 4 bytes are 0.
 859   if (Symbol->Name.Offset.Zeroes == 0) {
 860     if (std::error_code EC = getString(Symbol->Name.Offset.Offset, Res))
 861       return EC;
 862     return std::error_code();
 863   }
 864
 865   if (Symbol->Name.ShortName[COFF::NameSize - 1] == 0)
 866     // Null terminated, let ::strlen figure out the length.
 867     Res = StringRef(Symbol->Name.ShortName);
 868   else
 869     // Not null terminated, use all 8 bytes.
 870     Res = StringRef(Symbol->Name.ShortName, COFF::NameSize);
 871   return std::error_code();
 872 }
 873
 874 ArrayRef<uint8_t>
 875 COFFObjectFile::getSymbolAuxData(COFFSymbolRef Symbol) const {
 876   const uint8_t *Aux = nullptr;
 877
 878   size_t SymbolSize = getSymbolTableEntrySize();
 879   if (Symbol.getNumberOfAuxSymbols() > 0) {
 880     // AUX data comes immediately after the symbol in COFF
 881     Aux = reinterpret_cast<const uint8_t *>(Symbol.getRawPtr()) + SymbolSize;
 882 # ifndef NDEBUG
 883     // Verify that the Aux symbol points to a valid entry in the symbol table.
 884     uintptr_t Offset = uintptr_t(Aux) - uintptr_t(base());
 885     if (Offset < getPointerToSymbolTable() ||
 886         Offset >=
 887             getPointerToSymbolTable() + (getNumberOfSymbols() * SymbolSize))
 888       report_fatal_error("Aux Symbol data was outside of symbol table.");
 889
 890     assert((Offset - getPointerToSymbolTable()) % SymbolSize == 0 &&
 891            "Aux Symbol data did not point to the beginning of a symbol");
 892 # endif
 893   }
 894   return makeArrayRef(Aux, Symbol.getNumberOfAuxSymbols() * SymbolSize);
 895 }
 896
 897 std::error_code COFFObjectFile::getSectionName(const coff_section *Sec,
 898                                                StringRef &Res) const {
 899   StringRef Name;
 900   if (Sec->Name[COFF::NameSize - 1] == 0)
 901     // Null terminated, let ::strlen figure out the length.
 902     Name = Sec->Name;
 903   else
 904     // Not null terminated, use all 8 bytes.
 905     Name = StringRef(Sec->Name, COFF::NameSize);
 906
 907   // Check for string table entry. First byte is '/'.
 908   if (Name.startswith("/")) {
 909     uint32_t Offset;
 910     if (Name.startswith("//")) {
 911       if (decodeBase64StringEntry(Name.substr(2), Offset))
 912         return object_error::parse_failed;
 913     } else {
 914       if (Name.substr(1).getAsInteger(10, Offset))
 915         return object_error::parse_failed;
 916     }
 917     if (std::error_code EC = getString(Offset, Name))
 918       return EC;
 919   }
 920
 921   Res = Name;
 922   return std::error_code();
 923 }
 924
 925 uint64_t COFFObjectFile::getSectionSize(const coff_section *Sec) const {
 926   // SizeOfRawData and VirtualSize change what they represent depending on
 927   // whether or not we have an executable image.
 928   //
 929   // For object files, SizeOfRawData contains the size of section's data;
 930   // VirtualSize should be zero but isn't due to buggy COFF writers.
 931   //
 932   // For executables, SizeOfRawData *must* be a multiple of FileAlignment; the
 933   // actual section size is in VirtualSize.  It is possible for VirtualSize to
 934   // be greater than SizeOfRawData; the contents past that point should be
 935   // considered to be zero.
 936   if (getDOSHeader())
 937     return std::min(Sec->VirtualSize, Sec->SizeOfRawData);
 938   return Sec->SizeOfRawData;
 939 }
 940
 941 std::error_code
 942 COFFObjectFile::getSectionContents(const coff_section *Sec,
 943                                    ArrayRef<uint8_t> &Res) const {
 944   // PointerToRawData and SizeOfRawData won't make sense for BSS sections,
 945   // don't do anything interesting for them.
 946   assert((Sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) == 0 &&
 947          "BSS sections don't have contents!");
 948   // The only thing that we need to verify is that the contents is contained
 949   // within the file bounds. We don't need to make sure it doesn't cover other
 950   // data, as there's nothing that says that is not allowed.
 951   uintptr_t ConStart = uintptr_t(base()) + Sec->PointerToRawData;
 952   uint32_t SectionSize = getSectionSize(Sec);
 953   if (checkOffset(Data, ConStart, SectionSize))
 954     return object_error::parse_failed;
 955   Res = makeArrayRef(reinterpret_cast<const uint8_t *>(ConStart), SectionSize);
 956   return std::error_code();
 957 }
 958
 959 const coff_relocation *COFFObjectFile::toRel(DataRefImpl Rel) const {
 960   return reinterpret_cast<const coff_relocation*>(Rel.p);
 961 }
 962
 963 void COFFObjectFile::moveRelocationNext(DataRefImpl &Rel) const {
 964   Rel.p = reinterpret_cast<uintptr_t>(
 965             reinterpret_cast<const coff_relocation*>(Rel.p) + 1);
 966 }
 967
 968 uint64_t COFFObjectFile::getRelocationOffset(DataRefImpl Rel) const {
 969   const coff_relocation *R = toRel(Rel);
 970   return R->VirtualAddress;
 971 }
 972
 973 symbol_iterator COFFObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
 974   const coff_relocation *R = toRel(Rel);
 975   DataRefImpl Ref;
 976   if (R->SymbolTableIndex >= getNumberOfSymbols())
 977     return symbol_end();
 978   if (SymbolTable16)
 979     Ref.p = reinterpret_cast<uintptr_t>(SymbolTable16 + R->SymbolTableIndex);
 980   else if (SymbolTable32)
 981     Ref.p = reinterpret_cast<uintptr_t>(SymbolTable32 + R->SymbolTableIndex);
 982   else
 983     llvm_unreachable("no symbol table pointer!");
 984   return symbol_iterator(SymbolRef(Ref, this));
 985 }
 986
 987 uint64_t COFFObjectFile::getRelocationType(DataRefImpl Rel) const {
 988   const coff_relocation* R = toRel(Rel);
 989   return R->Type;
 990 }
 991
 992 const coff_section *
 993 COFFObjectFile::getCOFFSection(const SectionRef &Section) const {
 994   return toSec(Section.getRawDataRefImpl());
 995 }
 996
 997 COFFSymbolRef COFFObjectFile::getCOFFSymbol(const DataRefImpl &Ref) const {
 998   if (SymbolTable16)
 999     return toSymb<coff_symbol16>(Ref);
1000   if (SymbolTable32)
1001     return toSymb<coff_symbol32>(Ref);
1002   llvm_unreachable("no symbol table pointer!");
1003 }
1004
1005 COFFSymbolRef COFFObjectFile::getCOFFSymbol(const SymbolRef &Symbol) const {
1006   return getCOFFSymbol(Symbol.getRawDataRefImpl());
1007 }
1008
1009 const coff_relocation *
1010 COFFObjectFile::getCOFFRelocation(const RelocationRef &Reloc) const {
1011   return toRel(Reloc.getRawDataRefImpl());
1012 }
1013
1014 iterator_range<const coff_relocation *>
1015 COFFObjectFile::getRelocations(const coff_section *Sec) const {
1016   const coff_relocation *I = getFirstReloc(Sec, Data, base());
1017   const coff_relocation *E = I;
1018   if (I)
1019     E += getNumberOfRelocations(Sec, Data, base());
1020   return make_range(I, E);
1021 }
1022
1023 #define LLVM_COFF_SWITCH_RELOC_TYPE_NAME(reloc_type)                           \
1024   case COFF::reloc_type:                                                       \
1025     Res = #reloc_type;                                                         \
1026     break;
1027
1028 void COFFObjectFile::getRelocationTypeName(
1029     DataRefImpl Rel, SmallVectorImpl<char> &Result) const {
1030   const coff_relocation *Reloc = toRel(Rel);
1031   StringRef Res;
1032   switch (getMachine()) {
1033   case COFF::IMAGE_FILE_MACHINE_AMD64:
1034     switch (Reloc->Type) {
1035     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ABSOLUTE);
1036     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR64);
1037     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32);
1038     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32NB);
1039     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32);
1040     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_1);
1041     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_2);
1042     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_3);
1043     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_4);
1044     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_5);
1045     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECTION);
1046     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL);
1047     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL7);
1048     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_TOKEN);
1049     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SREL32);
1050     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_PAIR);
1051     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SSPAN32);
1052     default:
1053       Res = "Unknown";
1054     }
1055     break;
1056   case COFF::IMAGE_FILE_MACHINE_ARMNT:
1057     switch (Reloc->Type) {
1058     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ABSOLUTE);
1059     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ADDR32);
1060     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ADDR32NB);
1061     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH24);
1062     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH11);
1063     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_TOKEN);
1064     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX24);
1065     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX11);
1066     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_SECTION);
1067     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_SECREL);
1068     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_MOV32A);
1069     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_MOV32T);
1070     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH20T);
1071     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH24T);
1072     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX23T);
1073     default:
1074       Res = "Unknown";
1075     }
1076     break;
1077   case COFF::IMAGE_FILE_MACHINE_I386:
1078     switch (Reloc->Type) {
1079     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_ABSOLUTE);
1080     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR16);
1081     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL16);
1082     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32);
1083     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32NB);
1084     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SEG12);
1085     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECTION);
1086     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL);
1087     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_TOKEN);
1088     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL7);
1089     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL32);
1090     default:
1091       Res = "Unknown";
1092     }
1093     break;
1094   default:
1095     Res = "Unknown";
1096   }
1097   Result.append(Res.begin(), Res.end());
1098 }
1099
1100 #undef LLVM_COFF_SWITCH_RELOC_TYPE_NAME
1101
1102 bool COFFObjectFile::isRelocatableObject() const {
1103   return !DataDirectory;
1104 }
1105
1106 bool ImportDirectoryEntryRef::
1107 operator==(const ImportDirectoryEntryRef &Other) const {
1108   return ImportTable == Other.ImportTable && Index == Other.Index;
1109 }
1110
1111 void ImportDirectoryEntryRef::moveNext() {
1112   ++Index;
1113 }
1114
1115 std::error_code ImportDirectoryEntryRef::getImportTableEntry(
1116     const import_directory_table_entry *&Result) const {
1117   Result = ImportTable + Index;
1118   return std::error_code();
1119 }
1120
1121 static imported_symbol_iterator
1122 makeImportedSymbolIterator(const COFFObjectFile *Object,
1123                            uintptr_t Ptr, int Index) {
1124   if (Object->getBytesInAddress() == 4) {
1125     auto *P = reinterpret_cast<const import_lookup_table_entry32 *>(Ptr);
1126     return imported_symbol_iterator(ImportedSymbolRef(P, Index, Object));
1127   }
1128   auto *P = reinterpret_cast<const import_lookup_table_entry64 *>(Ptr);
1129   return imported_symbol_iterator(ImportedSymbolRef(P, Index, Object));
1130 }
1131
1132 static imported_symbol_iterator
1133 importedSymbolBegin(uint32_t RVA, const COFFObjectFile *Object) {
1134   uintptr_t IntPtr = 0;
1135   Object->getRvaPtr(RVA, IntPtr);
1136   return makeImportedSymbolIterator(Object, IntPtr, 0);
1137 }
1138
1139 static imported_symbol_iterator
1140 importedSymbolEnd(uint32_t RVA, const COFFObjectFile *Object) {
1141   uintptr_t IntPtr = 0;
1142   Object->getRvaPtr(RVA, IntPtr);
1143   // Forward the pointer to the last entry which is null.
1144   int Index = 0;
1145   if (Object->getBytesInAddress() == 4) {
1146     auto *Entry = reinterpret_cast<ulittle32_t *>(IntPtr);
1147     while (*Entry++)
1148       ++Index;
1149   } else {
1150     auto *Entry = reinterpret_cast<ulittle64_t *>(IntPtr);
1151     while (*Entry++)
1152       ++Index;
1153   }
1154   return makeImportedSymbolIterator(Object, IntPtr, Index);
1155 }
1156
1157 imported_symbol_iterator
1158 ImportDirectoryEntryRef::imported_symbol_begin() const {
1159   return importedSymbolBegin(ImportTable[Index].ImportLookupTableRVA,
1160                              OwningObject);
1161 }
1162
1163 imported_symbol_iterator
1164 ImportDirectoryEntryRef::imported_symbol_end() const {
1165   return importedSymbolEnd(ImportTable[Index].ImportLookupTableRVA,
1166                            OwningObject);
1167 }
1168
1169 iterator_range<imported_symbol_iterator>
1170 ImportDirectoryEntryRef::imported_symbols() const {
1171   return make_range(imported_symbol_begin(), imported_symbol_end());
1172 }
1173
1174 std::error_code ImportDirectoryEntryRef::getName(StringRef &Result) const {
1175   uintptr_t IntPtr = 0;
1176   if (std::error_code EC =
1177           OwningObject->getRvaPtr(ImportTable[Index].NameRVA, IntPtr))
1178     return EC;
1179   Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1180   return std::error_code();
1181 }
1182
1183 std::error_code
1184 ImportDirectoryEntryRef::getImportLookupTableRVA(uint32_t  &Result) const {
1185   Result = ImportTable[Index].ImportLookupTableRVA;
1186   return std::error_code();
1187 }
1188
1189 std::error_code
1190 ImportDirectoryEntryRef::getImportAddressTableRVA(uint32_t &Result) const {
1191   Result = ImportTable[Index].ImportAddressTableRVA;
1192   return std::error_code();
1193 }
1194
1195 std::error_code ImportDirectoryEntryRef::getImportLookupEntry(
1196     const import_lookup_table_entry32 *&Result) const {
1197   uintptr_t IntPtr = 0;
1198   uint32_t RVA = ImportTable[Index].ImportLookupTableRVA;
1199   if (std::error_code EC = OwningObject->getRvaPtr(RVA, IntPtr))
1200     return EC;
1201   Result = reinterpret_cast<const import_lookup_table_entry32 *>(IntPtr);
1202   return std::error_code();
1203 }
1204
1205 bool DelayImportDirectoryEntryRef::
1206 operator==(const DelayImportDirectoryEntryRef &Other) const {
1207   return Table == Other.Table && Index == Other.Index;
1208 }
1209
1210 void DelayImportDirectoryEntryRef::moveNext() {
1211   ++Index;
1212 }
1213
1214 imported_symbol_iterator
1215 DelayImportDirectoryEntryRef::imported_symbol_begin() const {
1216   return importedSymbolBegin(Table[Index].DelayImportNameTable,
1217                              OwningObject);
1218 }
1219
1220 imported_symbol_iterator
1221 DelayImportDirectoryEntryRef::imported_symbol_end() const {
1222   return importedSymbolEnd(Table[Index].DelayImportNameTable,
1223                            OwningObject);
1224 }
1225
1226 iterator_range<imported_symbol_iterator>
1227 DelayImportDirectoryEntryRef::imported_symbols() const {
1228   return make_range(imported_symbol_begin(), imported_symbol_end());
1229 }
1230
1231 std::error_code DelayImportDirectoryEntryRef::getName(StringRef &Result) const {
1232   uintptr_t IntPtr = 0;
1233   if (std::error_code EC = OwningObject->getRvaPtr(Table[Index].Name, IntPtr))
1234     return EC;
1235   Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1236   return std::error_code();
1237 }
1238
1239 std::error_code DelayImportDirectoryEntryRef::
1240 getDelayImportTable(const delay_import_directory_table_entry *&Result) const {
1241   Result = Table;
1242   return std::error_code();
1243 }
1244
1245 std::error_code DelayImportDirectoryEntryRef::
1246 getImportAddress(int AddrIndex, uint64_t &Result) const {
1247   uint32_t RVA = Table[Index].DelayImportAddressTable +
1248       AddrIndex * (OwningObject->is64() ? 8 : 4);
1249   uintptr_t IntPtr = 0;
1250   if (std::error_code EC = OwningObject->getRvaPtr(RVA, IntPtr))
1251     return EC;
1252   if (OwningObject->is64())
1253     Result = *reinterpret_cast<const ulittle64_t *>(IntPtr);
1254   else
1255     Result = *reinterpret_cast<const ulittle32_t *>(IntPtr);
1256   return std::error_code();
1257 }
1258
1259 bool ExportDirectoryEntryRef::
1260 operator==(const ExportDirectoryEntryRef &Other) const {
1261   return ExportTable == Other.ExportTable && Index == Other.Index;
1262 }
1263
1264 void ExportDirectoryEntryRef::moveNext() {
1265   ++Index;
1266 }
1267
1268 // Returns the name of the current export symbol. If the symbol is exported only
1269 // by ordinal, the empty string is set as a result.
1270 std::error_code ExportDirectoryEntryRef::getDllName(StringRef &Result) const {
1271   uintptr_t IntPtr = 0;
1272   if (std::error_code EC =
1273           OwningObject->getRvaPtr(ExportTable->NameRVA, IntPtr))
1274     return EC;
1275   Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1276   return std::error_code();
1277 }
1278
1279 // Returns the starting ordinal number.
1280 std::error_code
1281 ExportDirectoryEntryRef::getOrdinalBase(uint32_t &Result) const {
1282   Result = ExportTable->OrdinalBase;
1283   return std::error_code();
1284 }
1285
1286 // Returns the export ordinal of the current export symbol.
1287 std::error_code ExportDirectoryEntryRef::getOrdinal(uint32_t &Result) const {
1288   Result = ExportTable->OrdinalBase + Index;
1289   return std::error_code();
1290 }
1291
1292 // Returns the address of the current export symbol.
1293 std::error_code ExportDirectoryEntryRef::getExportRVA(uint32_t &Result) const {
1294   uintptr_t IntPtr = 0;
1295   if (std::error_code EC =
1296           OwningObject->getRvaPtr(ExportTable->ExportAddressTableRVA, IntPtr))
1297     return EC;
1298   const export_address_table_entry *entry =
1299       reinterpret_cast<const export_address_table_entry *>(IntPtr);
1300   Result = entry[Index].ExportRVA;
1301   return std::error_code();
1302 }
1303
1304 // Returns the name of the current export symbol. If the symbol is exported only
1305 // by ordinal, the empty string is set as a result.
1306 std::error_code
1307 ExportDirectoryEntryRef::getSymbolName(StringRef &Result) const {
1308   uintptr_t IntPtr = 0;
1309   if (std::error_code EC =
1310           OwningObject->getRvaPtr(ExportTable->OrdinalTableRVA, IntPtr))
1311     return EC;
1312   const ulittle16_t *Start = reinterpret_cast<const ulittle16_t *>(IntPtr);
1313
1314   uint32_t NumEntries = ExportTable->NumberOfNamePointers;
1315   int Offset = 0;
1316   for (const ulittle16_t *I = Start, *E = Start + NumEntries;
1317        I < E; ++I, ++Offset) {
1318     if (*I != Index)
1319       continue;
1320     if (std::error_code EC =
1321             OwningObject->getRvaPtr(ExportTable->NamePointerRVA, IntPtr))
1322       return EC;
1323     const ulittle32_t *NamePtr = reinterpret_cast<const ulittle32_t *>(IntPtr);
1324     if (std::error_code EC = OwningObject->getRvaPtr(NamePtr[Offset], IntPtr))
1325       return EC;
1326     Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1327     return std::error_code();
1328   }
1329   Result = "";
1330   return std::error_code();
1331 }
1332
1333 bool ImportedSymbolRef::
1334 operator==(const ImportedSymbolRef &Other) const {
1335   return Entry32 == Other.Entry32 && Entry64 == Other.Entry64
1336       && Index == Other.Index;
1337 }
1338
1339 void ImportedSymbolRef::moveNext() {
1340   ++Index;
1341 }
1342
1343 std::error_code
1344 ImportedSymbolRef::getSymbolName(StringRef &Result) const {
1345   uint32_t RVA;
1346   if (Entry32) {
1347     // If a symbol is imported only by ordinal, it has no name.
1348     if (Entry32[Index].isOrdinal())
1349       return std::error_code();
1350     RVA = Entry32[Index].getHintNameRVA();
1351   } else {
1352     if (Entry64[Index].isOrdinal())
1353       return std::error_code();
1354     RVA = Entry64[Index].getHintNameRVA();
1355   }
1356   uintptr_t IntPtr = 0;
1357   if (std::error_code EC = OwningObject->getRvaPtr(RVA, IntPtr))
1358     return EC;
1359   // +2 because the first two bytes is hint.
1360   Result = StringRef(reinterpret_cast<const char *>(IntPtr + 2));
1361   return std::error_code();
1362 }
1363
1364 std::error_code ImportedSymbolRef::getOrdinal(uint16_t &Result) const {
1365   uint32_t RVA;
1366   if (Entry32) {
1367     if (Entry32[Index].isOrdinal()) {
1368       Result = Entry32[Index].getOrdinal();
1369       return std::error_code();
1370     }
1371     RVA = Entry32[Index].getHintNameRVA();
1372   } else {
1373     if (Entry64[Index].isOrdinal()) {
1374       Result = Entry64[Index].getOrdinal();
1375       return std::error_code();
1376     }
1377     RVA = Entry64[Index].getHintNameRVA();
1378   }
1379   uintptr_t IntPtr = 0;
1380   if (std::error_code EC = OwningObject->getRvaPtr(RVA, IntPtr))
1381     return EC;
1382   Result = *reinterpret_cast<const ulittle16_t *>(IntPtr);
1383   return std::error_code();
1384 }
1385
1386 ErrorOr<std::unique_ptr<COFFObjectFile>>
1387 ObjectFile::createCOFFObjectFile(MemoryBufferRef Object) {
1388   std::error_code EC;
1389   std::unique_ptr<COFFObjectFile> Ret(new COFFObjectFile(Object, EC));
1390   if (EC)
1391     return EC;
1392   return std::move(Ret);
1393 }
1394
1395 bool BaseRelocRef::operator==(const BaseRelocRef &Other) const {
1396   return Header == Other.Header && Index == Other.Index;
1397 }
1398
1399 void BaseRelocRef::moveNext() {
1400   // Header->BlockSize is the size of the current block, including the
1401   // size of the header itself.
1402   uint32_t Size = sizeof(*Header) +
1403       sizeof(coff_base_reloc_block_entry) * (Index + 1);
1404   if (Size == Header->BlockSize) {
1405     // .reloc contains a list of base relocation blocks. Each block
1406     // consists of the header followed by entries. The header contains
1407     // how many entories will follow. When we reach the end of the
1408     // current block, proceed to the next block.
1409     Header = reinterpret_cast<const coff_base_reloc_block_header *>(
1410         reinterpret_cast<const uint8_t *>(Header) + Size);
1411     Index = 0;
1412   } else {
1413     ++Index;
1414   }
1415 }
1416
1417 std::error_code BaseRelocRef::getType(uint8_t &Type) const {
1418   auto *Entry = reinterpret_cast<const coff_base_reloc_block_entry *>(Header + 1);
1419   Type = Entry[Index].getType();
1420   return std::error_code();
1421 }
1422
1423 std::error_code BaseRelocRef::getRVA(uint32_t &Result) const {
1424   auto *Entry = reinterpret_cast<const coff_base_reloc_block_entry *>(Header + 1);
1425   Result = Header->PageRVA + Entry[Index].getOffset();
1426   return std::error_code();
1427 }