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