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/Debug.h"
  20 #include "llvm/Support/raw_ostream.h"
  21 #include <cctype>
  22
  23 using namespace llvm;
  24 using namespace object;
  25
  26 using support::ulittle8_t;
  27 using support::ulittle16_t;
  28 using support::ulittle32_t;
  29 using support::little16_t;
  30
  31 // Returns false if size is greater than the buffer size. And sets ec.
  32 static bool checkSize(const MemoryBuffer *M, error_code &EC, uint64_t Size) {
  33   if (M->getBufferSize() < Size) {
  34     EC = object_error::unexpected_eof;
  35     return false;
  36   }
  37   return true;
  38 }
  39
  40 // Sets Obj unless any bytes in [addr, addr + size) fall outsize of m.
  41 // Returns unexpected_eof if error.
  42 template<typename T>
  43 static error_code getObject(const T *&Obj, const MemoryBuffer *M,
  44                             const uint8_t *Ptr, const size_t Size = sizeof(T)) {
  45   uintptr_t Addr = uintptr_t(Ptr);
  46   if (Addr + Size < Addr ||
  47       Addr + Size < Size ||
  48       Addr + Size > uintptr_t(M->getBufferEnd())) {
  49     return object_error::unexpected_eof;
  50   }
  51   Obj = reinterpret_cast<const T *>(Addr);
  52   return object_error::success;
  53 }
  54
  55 const coff_symbol *COFFObjectFile::toSymb(DataRefImpl Ref) const {
  56   const coff_symbol *Addr = reinterpret_cast<const coff_symbol*>(Ref.p);
  57
  58 # ifndef NDEBUG
  59   // Verify that the symbol points to a valid entry in the symbol table.
  60   uintptr_t Offset = uintptr_t(Addr) - uintptr_t(base());
  61   if (Offset < COFFHeader->PointerToSymbolTable
  62       || Offset >= COFFHeader->PointerToSymbolTable
  63          + (COFFHeader->NumberOfSymbols * sizeof(coff_symbol)))
  64     report_fatal_error("Symbol was outside of symbol table.");
  65
  66   assert((Offset - COFFHeader->PointerToSymbolTable) % sizeof(coff_symbol)
  67          == 0 && "Symbol did not point to the beginning of a symbol");
  68 # endif
  69
  70   return Addr;
  71 }
  72
  73 const coff_section *COFFObjectFile::toSec(DataRefImpl Ref) const {
  74   const coff_section *Addr = reinterpret_cast<const coff_section*>(Ref.p);
  75
  76 # ifndef NDEBUG
  77   // Verify that the section points to a valid entry in the section table.
  78   if (Addr < SectionTable
  79       || Addr >= (SectionTable + COFFHeader->NumberOfSections))
  80     report_fatal_error("Section was outside of section table.");
  81
  82   uintptr_t Offset = uintptr_t(Addr) - uintptr_t(SectionTable);
  83   assert(Offset % sizeof(coff_section) == 0 &&
  84          "Section did not point to the beginning of a section");
  85 # endif
  86
  87   return Addr;
  88 }
  89
  90 void COFFObjectFile::moveSymbolNext(DataRefImpl &Ref) const {
  91   const coff_symbol *Symb = toSymb(Ref);
  92   Symb += 1 + Symb->NumberOfAuxSymbols;
  93   Ref.p = reinterpret_cast<uintptr_t>(Symb);
  94 }
  95
  96 error_code COFFObjectFile::getSymbolName(DataRefImpl Ref,
  97                                          StringRef &Result) const {
  98   const coff_symbol *Symb = toSymb(Ref);
  99   return getSymbolName(Symb, Result);
 100 }
 101
 102 error_code COFFObjectFile::getSymbolFileOffset(DataRefImpl Ref,
 103                                             uint64_t &Result) const {
 104   const coff_symbol *Symb = toSymb(Ref);
 105   const coff_section *Section = NULL;
 106   if (error_code EC = getSection(Symb->SectionNumber, Section))
 107     return EC;
 108
 109   if (Symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED)
 110     Result = UnknownAddressOrSize;
 111   else if (Section)
 112     Result = Section->PointerToRawData + Symb->Value;
 113   else
 114     Result = Symb->Value;
 115   return object_error::success;
 116 }
 117
 118 error_code COFFObjectFile::getSymbolAddress(DataRefImpl Ref,
 119                                             uint64_t &Result) const {
 120   const coff_symbol *Symb = toSymb(Ref);
 121   const coff_section *Section = NULL;
 122   if (error_code EC = getSection(Symb->SectionNumber, Section))
 123     return EC;
 124
 125   if (Symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED)
 126     Result = UnknownAddressOrSize;
 127   else if (Section)
 128     Result = Section->VirtualAddress + Symb->Value;
 129   else
 130     Result = Symb->Value;
 131   return object_error::success;
 132 }
 133
 134 error_code COFFObjectFile::getSymbolType(DataRefImpl Ref,
 135                                          SymbolRef::Type &Result) const {
 136   const coff_symbol *Symb = toSymb(Ref);
 137   Result = SymbolRef::ST_Other;
 138   if (Symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
 139       Symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED) {
 140     Result = SymbolRef::ST_Unknown;
 141   } else if (Symb->getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION) {
 142     Result = SymbolRef::ST_Function;
 143   } else {
 144     uint32_t Characteristics = 0;
 145     if (Symb->SectionNumber > 0) {
 146       const coff_section *Section = NULL;
 147       if (error_code EC = getSection(Symb->SectionNumber, Section))
 148         return EC;
 149       Characteristics = Section->Characteristics;
 150     }
 151     if (Characteristics & COFF::IMAGE_SCN_MEM_READ &&
 152         ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
 153       Result = SymbolRef::ST_Data;
 154   }
 155   return object_error::success;
 156 }
 157
 158 uint32_t COFFObjectFile::getSymbolFlags(DataRefImpl Ref) const {
 159   const coff_symbol *Symb = toSymb(Ref);
 160   uint32_t Result = SymbolRef::SF_None;
 161
 162   // TODO: Correctly set SF_FormatSpecific, SF_Common
 163
 164   if (Symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED) {
 165     if (Symb->Value == 0)
 166       Result |= SymbolRef::SF_Undefined;
 167     else
 168       Result |= SymbolRef::SF_Common;
 169   }
 170
 171
 172   // TODO: This are certainly too restrictive.
 173   if (Symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL)
 174     Result |= SymbolRef::SF_Global;
 175
 176   if (Symb->StorageClass == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL)
 177     Result |= SymbolRef::SF_Weak;
 178
 179   if (Symb->SectionNumber == COFF::IMAGE_SYM_ABSOLUTE)
 180     Result |= SymbolRef::SF_Absolute;
 181
 182   return Result;
 183 }
 184
 185 error_code COFFObjectFile::getSymbolSize(DataRefImpl Ref,
 186                                          uint64_t &Result) const {
 187   // FIXME: Return the correct size. This requires looking at all the symbols
 188   //        in the same section as this symbol, and looking for either the next
 189   //        symbol, or the end of the section.
 190   const coff_symbol *Symb = toSymb(Ref);
 191   const coff_section *Section = NULL;
 192   if (error_code EC = getSection(Symb->SectionNumber, Section))
 193     return EC;
 194
 195   if (Symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED)
 196     Result = UnknownAddressOrSize;
 197   else if (Section)
 198     Result = Section->SizeOfRawData - Symb->Value;
 199   else
 200     Result = 0;
 201   return object_error::success;
 202 }
 203
 204 error_code COFFObjectFile::getSymbolSection(DataRefImpl Ref,
 205                                             section_iterator &Result) const {
 206   const coff_symbol *Symb = toSymb(Ref);
 207   if (Symb->SectionNumber <= COFF::IMAGE_SYM_UNDEFINED)
 208     Result = section_end();
 209   else {
 210     const coff_section *Sec = 0;
 211     if (error_code EC = getSection(Symb->SectionNumber, Sec)) return EC;
 212     DataRefImpl Ref;
 213     Ref.p = reinterpret_cast<uintptr_t>(Sec);
 214     Result = section_iterator(SectionRef(Ref, this));
 215   }
 216   return object_error::success;
 217 }
 218
 219 error_code COFFObjectFile::getSymbolValue(DataRefImpl Ref,
 220                                           uint64_t &Val) const {
 221   report_fatal_error("getSymbolValue unimplemented in COFFObjectFile");
 222 }
 223
 224 void COFFObjectFile::moveSectionNext(DataRefImpl &Ref) const {
 225   const coff_section *Sec = toSec(Ref);
 226   Sec += 1;
 227   Ref.p = reinterpret_cast<uintptr_t>(Sec);
 228 }
 229
 230 error_code COFFObjectFile::getSectionName(DataRefImpl Ref,
 231                                           StringRef &Result) const {
 232   const coff_section *Sec = toSec(Ref);
 233   return getSectionName(Sec, Result);
 234 }
 235
 236 error_code COFFObjectFile::getSectionAddress(DataRefImpl Ref,
 237                                              uint64_t &Result) const {
 238   const coff_section *Sec = toSec(Ref);
 239   Result = Sec->VirtualAddress;
 240   return object_error::success;
 241 }
 242
 243 error_code COFFObjectFile::getSectionSize(DataRefImpl Ref,
 244                                           uint64_t &Result) const {
 245   const coff_section *Sec = toSec(Ref);
 246   Result = Sec->SizeOfRawData;
 247   return object_error::success;
 248 }
 249
 250 error_code COFFObjectFile::getSectionContents(DataRefImpl Ref,
 251                                               StringRef &Result) const {
 252   const coff_section *Sec = toSec(Ref);
 253   ArrayRef<uint8_t> Res;
 254   error_code EC = getSectionContents(Sec, Res);
 255   Result = StringRef(reinterpret_cast<const char*>(Res.data()), Res.size());
 256   return EC;
 257 }
 258
 259 error_code COFFObjectFile::getSectionAlignment(DataRefImpl Ref,
 260                                                uint64_t &Res) const {
 261   const coff_section *Sec = toSec(Ref);
 262   if (!Sec)
 263     return object_error::parse_failed;
 264   Res = uint64_t(1) << (((Sec->Characteristics & 0x00F00000) >> 20) - 1);
 265   return object_error::success;
 266 }
 267
 268 error_code COFFObjectFile::isSectionText(DataRefImpl Ref,
 269                                          bool &Result) const {
 270   const coff_section *Sec = toSec(Ref);
 271   Result = Sec->Characteristics & COFF::IMAGE_SCN_CNT_CODE;
 272   return object_error::success;
 273 }
 274
 275 error_code COFFObjectFile::isSectionData(DataRefImpl Ref,
 276                                          bool &Result) const {
 277   const coff_section *Sec = toSec(Ref);
 278   Result = Sec->Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA;
 279   return object_error::success;
 280 }
 281
 282 error_code COFFObjectFile::isSectionBSS(DataRefImpl Ref,
 283                                         bool &Result) const {
 284   const coff_section *Sec = toSec(Ref);
 285   Result = Sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
 286   return object_error::success;
 287 }
 288
 289 error_code COFFObjectFile::isSectionRequiredForExecution(DataRefImpl Ref,
 290                                                          bool &Result) const {
 291   // FIXME: Unimplemented
 292   Result = true;
 293   return object_error::success;
 294 }
 295
 296 error_code COFFObjectFile::isSectionVirtual(DataRefImpl Ref,
 297                                            bool &Result) const {
 298   const coff_section *Sec = toSec(Ref);
 299   Result = Sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
 300   return object_error::success;
 301 }
 302
 303 error_code COFFObjectFile::isSectionZeroInit(DataRefImpl Ref,
 304                                              bool &Result) const {
 305   // FIXME: Unimplemented.
 306   Result = false;
 307   return object_error::success;
 308 }
 309
 310 error_code COFFObjectFile::isSectionReadOnlyData(DataRefImpl Ref,
 311                                                 bool &Result) const {
 312   // FIXME: Unimplemented.
 313   Result = false;
 314   return object_error::success;
 315 }
 316
 317 error_code COFFObjectFile::sectionContainsSymbol(DataRefImpl SecRef,
 318                                                  DataRefImpl SymbRef,
 319                                                  bool &Result) const {
 320   const coff_section *Sec = toSec(SecRef);
 321   const coff_symbol *Symb = toSymb(SymbRef);
 322   const coff_section *SymbSec = 0;
 323   if (error_code EC = getSection(Symb->SectionNumber, SymbSec)) return EC;
 324   if (SymbSec == Sec)
 325     Result = true;
 326   else
 327     Result = false;
 328   return object_error::success;
 329 }
 330
 331 relocation_iterator COFFObjectFile::section_rel_begin(DataRefImpl Ref) const {
 332   const coff_section *Sec = toSec(Ref);
 333   DataRefImpl Ret;
 334   if (Sec->NumberOfRelocations == 0)
 335     Ret.p = 0;
 336   else
 337     Ret.p = reinterpret_cast<uintptr_t>(base() + Sec->PointerToRelocations);
 338
 339   return relocation_iterator(RelocationRef(Ret, this));
 340 }
 341
 342 relocation_iterator COFFObjectFile::section_rel_end(DataRefImpl Ref) const {
 343   const coff_section *Sec = toSec(Ref);
 344   DataRefImpl Ret;
 345   if (Sec->NumberOfRelocations == 0)
 346     Ret.p = 0;
 347   else
 348     Ret.p = reinterpret_cast<uintptr_t>(
 349               reinterpret_cast<const coff_relocation*>(
 350                 base() + Sec->PointerToRelocations)
 351               + Sec->NumberOfRelocations);
 352
 353   return relocation_iterator(RelocationRef(Ret, this));
 354 }
 355
 356 // Initialize the pointer to the symbol table.
 357 error_code COFFObjectFile::initSymbolTablePtr() {
 358   if (error_code EC = getObject(
 359           SymbolTable, Data, base() + COFFHeader->PointerToSymbolTable,
 360           COFFHeader->NumberOfSymbols * sizeof(coff_symbol)))
 361     return EC;
 362
 363   // Find string table. The first four byte of the string table contains the
 364   // total size of the string table, including the size field itself. If the
 365   // string table is empty, the value of the first four byte would be 4.
 366   const uint8_t *StringTableAddr =
 367       base() + COFFHeader->PointerToSymbolTable +
 368       COFFHeader->NumberOfSymbols * sizeof(coff_symbol);
 369   const ulittle32_t *StringTableSizePtr;
 370   if (error_code EC = getObject(StringTableSizePtr, Data, StringTableAddr))
 371     return EC;
 372   StringTableSize = *StringTableSizePtr;
 373   if (error_code EC =
 374       getObject(StringTable, Data, StringTableAddr, StringTableSize))
 375     return EC;
 376
 377   // Check that the string table is null terminated if has any in it.
 378   if (StringTableSize < 4 ||
 379       (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0))
 380     return  object_error::parse_failed;
 381   return object_error::success;
 382 }
 383
 384 // Returns the file offset for the given VA.
 385 error_code COFFObjectFile::getVaPtr(uint64_t Addr, uintptr_t &Res) const {
 386   uint64_t ImageBase = PE32Header ? (uint64_t)PE32Header->ImageBase
 387                                   : (uint64_t)PE32PlusHeader->ImageBase;
 388   uint64_t Rva = Addr - ImageBase;
 389   assert(Rva <= UINT32_MAX);
 390   return getRvaPtr((uint32_t)Rva, Res);
 391 }
 392
 393 // Returns the file offset for the given RVA.
 394 error_code COFFObjectFile::getRvaPtr(uint32_t Addr, uintptr_t &Res) const {
 395   for (section_iterator I = section_begin(), E = section_end(); I != E;
 396        ++I) {
 397     const coff_section *Section = getCOFFSection(I);
 398     uint32_t SectionStart = Section->VirtualAddress;
 399     uint32_t SectionEnd = Section->VirtualAddress + Section->VirtualSize;
 400     if (SectionStart <= Addr && Addr < SectionEnd) {
 401       uint32_t Offset = Addr - SectionStart;
 402       Res = uintptr_t(base()) + Section->PointerToRawData + Offset;
 403       return object_error::success;
 404     }
 405   }
 406   return object_error::parse_failed;
 407 }
 408
 409 // Returns hint and name fields, assuming \p Rva is pointing to a Hint/Name
 410 // table entry.
 411 error_code COFFObjectFile::
 412 getHintName(uint32_t Rva, uint16_t &Hint, StringRef &Name) const {
 413   uintptr_t IntPtr = 0;
 414   if (error_code EC = getRvaPtr(Rva, IntPtr))
 415     return EC;
 416   const uint8_t *Ptr = reinterpret_cast<const uint8_t *>(IntPtr);
 417   Hint = *reinterpret_cast<const ulittle16_t *>(Ptr);
 418   Name = StringRef(reinterpret_cast<const char *>(Ptr + 2));
 419   return object_error::success;
 420 }
 421
 422 // Find the import table.
 423 error_code COFFObjectFile::initImportTablePtr() {
 424   // First, we get the RVA of the import table. If the file lacks a pointer to
 425   // the import table, do nothing.
 426   const data_directory *DataEntry;
 427   if (getDataDirectory(COFF::IMPORT_TABLE, DataEntry))
 428     return object_error::success;
 429
 430   // Do nothing if the pointer to import table is NULL.
 431   if (DataEntry->RelativeVirtualAddress == 0)
 432     return object_error::success;
 433
 434   uint32_t ImportTableRva = DataEntry->RelativeVirtualAddress;
 435   NumberOfImportDirectory = DataEntry->Size /
 436       sizeof(import_directory_table_entry);
 437
 438   // Find the section that contains the RVA. This is needed because the RVA is
 439   // the import table's memory address which is different from its file offset.
 440   uintptr_t IntPtr = 0;
 441   if (error_code EC = getRvaPtr(ImportTableRva, IntPtr))
 442     return EC;
 443   ImportDirectory = reinterpret_cast<
 444       const import_directory_table_entry *>(IntPtr);
 445   return object_error::success;
 446 }
 447
 448 // Find the export table.
 449 error_code COFFObjectFile::initExportTablePtr() {
 450   // First, we get the RVA of the export table. If the file lacks a pointer to
 451   // the export table, do nothing.
 452   const data_directory *DataEntry;
 453   if (getDataDirectory(COFF::EXPORT_TABLE, DataEntry))
 454     return object_error::success;
 455
 456   // Do nothing if the pointer to export table is NULL.
 457   if (DataEntry->RelativeVirtualAddress == 0)
 458     return object_error::success;
 459
 460   uint32_t ExportTableRva = DataEntry->RelativeVirtualAddress;
 461   uintptr_t IntPtr = 0;
 462   if (error_code EC = getRvaPtr(ExportTableRva, IntPtr))
 463     return EC;
 464   ExportDirectory =
 465       reinterpret_cast<const export_directory_table_entry *>(IntPtr);
 466   return object_error::success;
 467 }
 468
 469 COFFObjectFile::COFFObjectFile(MemoryBuffer *Object, error_code &EC,
 470                                bool BufferOwned)
 471     : ObjectFile(Binary::ID_COFF, Object, BufferOwned), COFFHeader(0),
 472       PE32Header(0), PE32PlusHeader(0), DataDirectory(0), SectionTable(0),
 473       SymbolTable(0), StringTable(0), StringTableSize(0), ImportDirectory(0),
 474       NumberOfImportDirectory(0), ExportDirectory(0) {
 475   // Check that we at least have enough room for a header.
 476   if (!checkSize(Data, EC, sizeof(coff_file_header))) return;
 477
 478   // The current location in the file where we are looking at.
 479   uint64_t CurPtr = 0;
 480
 481   // PE header is optional and is present only in executables. If it exists,
 482   // it is placed right after COFF header.
 483   bool HasPEHeader = false;
 484
 485   // Check if this is a PE/COFF file.
 486   if (base()[0] == 0x4d && base()[1] == 0x5a) {
 487     // PE/COFF, seek through MS-DOS compatibility stub and 4-byte
 488     // PE signature to find 'normal' COFF header.
 489     if (!checkSize(Data, EC, 0x3c + 8)) return;
 490     CurPtr = *reinterpret_cast<const ulittle16_t *>(base() + 0x3c);
 491     // Check the PE magic bytes. ("PE\0\0")
 492     if (std::memcmp(base() + CurPtr, "PE\0\0", 4) != 0) {
 493       EC = object_error::parse_failed;
 494       return;
 495     }
 496     CurPtr += 4; // Skip the PE magic bytes.
 497     HasPEHeader = true;
 498   }
 499
 500   if ((EC = getObject(COFFHeader, Data, base() + CurPtr)))
 501     return;
 502   CurPtr += sizeof(coff_file_header);
 503
 504   if (HasPEHeader) {
 505     const pe32_header *Header;
 506     if ((EC = getObject(Header, Data, base() + CurPtr)))
 507       return;
 508
 509     const uint8_t *DataDirAddr;
 510     uint64_t DataDirSize;
 511     if (Header->Magic == 0x10b) {
 512       PE32Header = Header;
 513       DataDirAddr = base() + CurPtr + sizeof(pe32_header);
 514       DataDirSize = sizeof(data_directory) * PE32Header->NumberOfRvaAndSize;
 515     } else if (Header->Magic == 0x20b) {
 516       PE32PlusHeader = reinterpret_cast<const pe32plus_header *>(Header);
 517       DataDirAddr = base() + CurPtr + sizeof(pe32plus_header);
 518       DataDirSize = sizeof(data_directory) * PE32PlusHeader->NumberOfRvaAndSize;
 519     } else {
 520       // It's neither PE32 nor PE32+.
 521       EC = object_error::parse_failed;
 522       return;
 523     }
 524     if ((EC = getObject(DataDirectory, Data, DataDirAddr, DataDirSize)))
 525       return;
 526     CurPtr += COFFHeader->SizeOfOptionalHeader;
 527   }
 528
 529   if (COFFHeader->isImportLibrary())
 530     return;
 531
 532   if ((EC = getObject(SectionTable, Data, base() + CurPtr,
 533                       COFFHeader->NumberOfSections * sizeof(coff_section))))
 534     return;
 535
 536   // Initialize the pointer to the symbol table.
 537   if (COFFHeader->PointerToSymbolTable != 0)
 538     if ((EC = initSymbolTablePtr()))
 539       return;
 540
 541   // Initialize the pointer to the beginning of the import table.
 542   if ((EC = initImportTablePtr()))
 543     return;
 544
 545   // Initialize the pointer to the export table.
 546   if ((EC = initExportTablePtr()))
 547     return;
 548
 549   EC = object_error::success;
 550 }
 551
 552 basic_symbol_iterator COFFObjectFile::symbol_begin_impl() const {
 553   DataRefImpl Ret;
 554   Ret.p = reinterpret_cast<uintptr_t>(SymbolTable);
 555   return basic_symbol_iterator(SymbolRef(Ret, this));
 556 }
 557
 558 basic_symbol_iterator COFFObjectFile::symbol_end_impl() const {
 559   // The symbol table ends where the string table begins.
 560   DataRefImpl Ret;
 561   Ret.p = reinterpret_cast<uintptr_t>(StringTable);
 562   return basic_symbol_iterator(SymbolRef(Ret, this));
 563 }
 564
 565 library_iterator COFFObjectFile::needed_library_begin() const {
 566   // TODO: implement
 567   report_fatal_error("Libraries needed unimplemented in COFFObjectFile");
 568 }
 569
 570 library_iterator COFFObjectFile::needed_library_end() const {
 571   // TODO: implement
 572   report_fatal_error("Libraries needed unimplemented in COFFObjectFile");
 573 }
 574
 575 StringRef COFFObjectFile::getLoadName() const {
 576   // COFF does not have this field.
 577   return "";
 578 }
 579
 580 import_directory_iterator COFFObjectFile::import_directory_begin() const {
 581   return import_directory_iterator(
 582       ImportDirectoryEntryRef(ImportDirectory, 0, this));
 583 }
 584
 585 import_directory_iterator COFFObjectFile::import_directory_end() const {
 586   return import_directory_iterator(
 587       ImportDirectoryEntryRef(ImportDirectory, NumberOfImportDirectory, this));
 588 }
 589
 590 export_directory_iterator COFFObjectFile::export_directory_begin() const {
 591   return export_directory_iterator(
 592       ExportDirectoryEntryRef(ExportDirectory, 0, this));
 593 }
 594
 595 export_directory_iterator COFFObjectFile::export_directory_end() const {
 596   if (ExportDirectory == 0)
 597     return export_directory_iterator(ExportDirectoryEntryRef(0, 0, this));
 598   ExportDirectoryEntryRef Ref(ExportDirectory,
 599                               ExportDirectory->AddressTableEntries, this);
 600   return export_directory_iterator(Ref);
 601 }
 602
 603 section_iterator COFFObjectFile::section_begin() const {
 604   DataRefImpl Ret;
 605   Ret.p = reinterpret_cast<uintptr_t>(SectionTable);
 606   return section_iterator(SectionRef(Ret, this));
 607 }
 608
 609 section_iterator COFFObjectFile::section_end() const {
 610   DataRefImpl Ret;
 611   int NumSections = COFFHeader->isImportLibrary()
 612       ? 0 : COFFHeader->NumberOfSections;
 613   Ret.p = reinterpret_cast<uintptr_t>(SectionTable + NumSections);
 614   return section_iterator(SectionRef(Ret, this));
 615 }
 616
 617 uint8_t COFFObjectFile::getBytesInAddress() const {
 618   return getArch() == Triple::x86_64 ? 8 : 4;
 619 }
 620
 621 StringRef COFFObjectFile::getFileFormatName() const {
 622   switch(COFFHeader->Machine) {
 623   case COFF::IMAGE_FILE_MACHINE_I386:
 624     return "COFF-i386";
 625   case COFF::IMAGE_FILE_MACHINE_AMD64:
 626     return "COFF-x86-64";
 627   default:
 628     return "COFF-<unknown arch>";
 629   }
 630 }
 631
 632 unsigned COFFObjectFile::getArch() const {
 633   switch(COFFHeader->Machine) {
 634   case COFF::IMAGE_FILE_MACHINE_I386:
 635     return Triple::x86;
 636   case COFF::IMAGE_FILE_MACHINE_AMD64:
 637     return Triple::x86_64;
 638   default:
 639     return Triple::UnknownArch;
 640   }
 641 }
 642
 643 // This method is kept here because lld uses this. As soon as we make
 644 // lld to use getCOFFHeader, this method will be removed.
 645 error_code COFFObjectFile::getHeader(const coff_file_header *&Res) const {
 646   return getCOFFHeader(Res);
 647 }
 648
 649 error_code COFFObjectFile::getCOFFHeader(const coff_file_header *&Res) const {
 650   Res = COFFHeader;
 651   return object_error::success;
 652 }
 653
 654 error_code COFFObjectFile::getPE32Header(const pe32_header *&Res) const {
 655   Res = PE32Header;
 656   return object_error::success;
 657 }
 658
 659 error_code
 660 COFFObjectFile::getPE32PlusHeader(const pe32plus_header *&Res) const {
 661   Res = PE32PlusHeader;
 662   return object_error::success;
 663 }
 664
 665 error_code COFFObjectFile::getDataDirectory(uint32_t Index,
 666                                             const data_directory *&Res) const {
 667   // Error if if there's no data directory or the index is out of range.
 668   if (!DataDirectory)
 669     return object_error::parse_failed;
 670   assert(PE32Header || PE32PlusHeader);
 671   uint32_t NumEnt = PE32Header ? PE32Header->NumberOfRvaAndSize
 672                                : PE32PlusHeader->NumberOfRvaAndSize;
 673   if (Index > NumEnt)
 674     return object_error::parse_failed;
 675   Res = &DataDirectory[Index];
 676   return object_error::success;
 677 }
 678
 679 error_code COFFObjectFile::getSection(int32_t Index,
 680                                       const coff_section *&Result) const {
 681   // Check for special index values.
 682   if (Index == COFF::IMAGE_SYM_UNDEFINED ||
 683       Index == COFF::IMAGE_SYM_ABSOLUTE ||
 684       Index == COFF::IMAGE_SYM_DEBUG)
 685     Result = NULL;
 686   else if (Index > 0 && Index <= COFFHeader->NumberOfSections)
 687     // We already verified the section table data, so no need to check again.
 688     Result = SectionTable + (Index - 1);
 689   else
 690     return object_error::parse_failed;
 691   return object_error::success;
 692 }
 693
 694 error_code COFFObjectFile::getString(uint32_t Offset,
 695                                      StringRef &Result) const {
 696   if (StringTableSize <= 4)
 697     // Tried to get a string from an empty string table.
 698     return object_error::parse_failed;
 699   if (Offset >= StringTableSize)
 700     return object_error::unexpected_eof;
 701   Result = StringRef(StringTable + Offset);
 702   return object_error::success;
 703 }
 704
 705 error_code COFFObjectFile::getSymbol(uint32_t Index,
 706                                      const coff_symbol *&Result) const {
 707   if (Index < COFFHeader->NumberOfSymbols)
 708     Result = SymbolTable + Index;
 709   else
 710     return object_error::parse_failed;
 711   return object_error::success;
 712 }
 713
 714 error_code COFFObjectFile::getSymbolName(const coff_symbol *Symbol,
 715                                          StringRef &Res) const {
 716   // Check for string table entry. First 4 bytes are 0.
 717   if (Symbol->Name.Offset.Zeroes == 0) {
 718     uint32_t Offset = Symbol->Name.Offset.Offset;
 719     if (error_code EC = getString(Offset, Res))
 720       return EC;
 721     return object_error::success;
 722   }
 723
 724   if (Symbol->Name.ShortName[7] == 0)
 725     // Null terminated, let ::strlen figure out the length.
 726     Res = StringRef(Symbol->Name.ShortName);
 727   else
 728     // Not null terminated, use all 8 bytes.
 729     Res = StringRef(Symbol->Name.ShortName, 8);
 730   return object_error::success;
 731 }
 732
 733 ArrayRef<uint8_t> COFFObjectFile::getSymbolAuxData(
 734                                   const coff_symbol *Symbol) const {
 735   const uint8_t *Aux = NULL;
 736
 737   if (Symbol->NumberOfAuxSymbols > 0) {
 738   // AUX data comes immediately after the symbol in COFF
 739     Aux = reinterpret_cast<const uint8_t *>(Symbol + 1);
 740 # ifndef NDEBUG
 741     // Verify that the Aux symbol points to a valid entry in the symbol table.
 742     uintptr_t Offset = uintptr_t(Aux) - uintptr_t(base());
 743     if (Offset < COFFHeader->PointerToSymbolTable
 744         || Offset >= COFFHeader->PointerToSymbolTable
 745            + (COFFHeader->NumberOfSymbols * sizeof(coff_symbol)))
 746       report_fatal_error("Aux Symbol data was outside of symbol table.");
 747
 748     assert((Offset - COFFHeader->PointerToSymbolTable) % sizeof(coff_symbol)
 749          == 0 && "Aux Symbol data did not point to the beginning of a symbol");
 750 # endif
 751   }
 752   return ArrayRef<uint8_t>(Aux,
 753                            Symbol->NumberOfAuxSymbols * sizeof(coff_symbol));
 754 }
 755
 756 error_code COFFObjectFile::getSectionName(const coff_section *Sec,
 757                                           StringRef &Res) const {
 758   StringRef Name;
 759   if (Sec->Name[7] == 0)
 760     // Null terminated, let ::strlen figure out the length.
 761     Name = Sec->Name;
 762   else
 763     // Not null terminated, use all 8 bytes.
 764     Name = StringRef(Sec->Name, 8);
 765
 766   // Check for string table entry. First byte is '/'.
 767   if (Name[0] == '/') {
 768     uint32_t Offset;
 769     if (Name.substr(1).getAsInteger(10, Offset))
 770       return object_error::parse_failed;
 771     if (error_code EC = getString(Offset, Name))
 772       return EC;
 773   }
 774
 775   Res = Name;
 776   return object_error::success;
 777 }
 778
 779 error_code COFFObjectFile::getSectionContents(const coff_section *Sec,
 780                                               ArrayRef<uint8_t> &Res) const {
 781   // The only thing that we need to verify is that the contents is contained
 782   // within the file bounds. We don't need to make sure it doesn't cover other
 783   // data, as there's nothing that says that is not allowed.
 784   uintptr_t ConStart = uintptr_t(base()) + Sec->PointerToRawData;
 785   uintptr_t ConEnd = ConStart + Sec->SizeOfRawData;
 786   if (ConEnd > uintptr_t(Data->getBufferEnd()))
 787     return object_error::parse_failed;
 788   Res = ArrayRef<uint8_t>(reinterpret_cast<const unsigned char*>(ConStart),
 789                           Sec->SizeOfRawData);
 790   return object_error::success;
 791 }
 792
 793 const coff_relocation *COFFObjectFile::toRel(DataRefImpl Rel) const {
 794   return reinterpret_cast<const coff_relocation*>(Rel.p);
 795 }
 796
 797 void COFFObjectFile::moveRelocationNext(DataRefImpl &Rel) const {
 798   Rel.p = reinterpret_cast<uintptr_t>(
 799             reinterpret_cast<const coff_relocation*>(Rel.p) + 1);
 800 }
 801
 802 error_code COFFObjectFile::getRelocationAddress(DataRefImpl Rel,
 803                                                 uint64_t &Res) const {
 804   report_fatal_error("getRelocationAddress not implemented in COFFObjectFile");
 805 }
 806
 807 error_code COFFObjectFile::getRelocationOffset(DataRefImpl Rel,
 808                                                uint64_t &Res) const {
 809   Res = toRel(Rel)->VirtualAddress;
 810   return object_error::success;
 811 }
 812
 813 symbol_iterator COFFObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
 814   const coff_relocation* R = toRel(Rel);
 815   DataRefImpl Ref;
 816   Ref.p = reinterpret_cast<uintptr_t>(SymbolTable + R->SymbolTableIndex);
 817   return symbol_iterator(SymbolRef(Ref, this));
 818 }
 819
 820 error_code COFFObjectFile::getRelocationType(DataRefImpl Rel,
 821                                              uint64_t &Res) const {
 822   const coff_relocation* R = toRel(Rel);
 823   Res = R->Type;
 824   return object_error::success;
 825 }
 826
 827 const coff_section *COFFObjectFile::getCOFFSection(section_iterator &It) const {
 828   return toSec(It->getRawDataRefImpl());
 829 }
 830
 831 const coff_symbol *COFFObjectFile::getCOFFSymbol(symbol_iterator &It) const {
 832   return toSymb(It->getRawDataRefImpl());
 833 }
 834
 835 const coff_relocation *
 836 COFFObjectFile::getCOFFRelocation(relocation_iterator &It) const {
 837   return toRel(It->getRawDataRefImpl());
 838 }
 839
 840 #define LLVM_COFF_SWITCH_RELOC_TYPE_NAME(enum) \
 841   case COFF::enum: Res = #enum; break;
 842
 843 error_code COFFObjectFile::getRelocationTypeName(DataRefImpl Rel,
 844                                           SmallVectorImpl<char> &Result) const {
 845   const coff_relocation *Reloc = toRel(Rel);
 846   StringRef Res;
 847   switch (COFFHeader->Machine) {
 848   case COFF::IMAGE_FILE_MACHINE_AMD64:
 849     switch (Reloc->Type) {
 850     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ABSOLUTE);
 851     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR64);
 852     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32);
 853     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32NB);
 854     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32);
 855     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_1);
 856     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_2);
 857     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_3);
 858     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_4);
 859     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_5);
 860     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECTION);
 861     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL);
 862     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL7);
 863     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_TOKEN);
 864     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SREL32);
 865     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_PAIR);
 866     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SSPAN32);
 867     default:
 868       Res = "Unknown";
 869     }
 870     break;
 871   case COFF::IMAGE_FILE_MACHINE_I386:
 872     switch (Reloc->Type) {
 873     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_ABSOLUTE);
 874     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR16);
 875     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL16);
 876     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32);
 877     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32NB);
 878     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SEG12);
 879     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECTION);
 880     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL);
 881     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_TOKEN);
 882     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL7);
 883     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL32);
 884     default:
 885       Res = "Unknown";
 886     }
 887     break;
 888   default:
 889     Res = "Unknown";
 890   }
 891   Result.append(Res.begin(), Res.end());
 892   return object_error::success;
 893 }
 894
 895 #undef LLVM_COFF_SWITCH_RELOC_TYPE_NAME
 896
 897 error_code COFFObjectFile::getRelocationValueString(DataRefImpl Rel,
 898                                           SmallVectorImpl<char> &Result) const {
 899   const coff_relocation *Reloc = toRel(Rel);
 900   const coff_symbol *Symb = 0;
 901   if (error_code EC = getSymbol(Reloc->SymbolTableIndex, Symb)) return EC;
 902   DataRefImpl Sym;
 903   Sym.p = reinterpret_cast<uintptr_t>(Symb);
 904   StringRef SymName;
 905   if (error_code EC = getSymbolName(Sym, SymName)) return EC;
 906   Result.append(SymName.begin(), SymName.end());
 907   return object_error::success;
 908 }
 909
 910 error_code COFFObjectFile::getLibraryNext(DataRefImpl LibData,
 911                                           LibraryRef &Result) const {
 912   report_fatal_error("getLibraryNext not implemented in COFFObjectFile");
 913 }
 914
 915 error_code COFFObjectFile::getLibraryPath(DataRefImpl LibData,
 916                                           StringRef &Result) const {
 917   report_fatal_error("getLibraryPath not implemented in COFFObjectFile");
 918 }
 919
 920 bool ImportDirectoryEntryRef::
 921 operator==(const ImportDirectoryEntryRef &Other) const {
 922   return ImportTable == Other.ImportTable && Index == Other.Index;
 923 }
 924
 925 void ImportDirectoryEntryRef::moveNext() {
 926   ++Index;
 927 }
 928
 929 error_code ImportDirectoryEntryRef::
 930 getImportTableEntry(const import_directory_table_entry *&Result) const {
 931   Result = ImportTable;
 932   return object_error::success;
 933 }
 934
 935 error_code ImportDirectoryEntryRef::getName(StringRef &Result) const {
 936   uintptr_t IntPtr = 0;
 937   if (error_code EC = OwningObject->getRvaPtr(ImportTable->NameRVA, IntPtr))
 938     return EC;
 939   Result = StringRef(reinterpret_cast<const char *>(IntPtr));
 940   return object_error::success;
 941 }
 942
 943 error_code ImportDirectoryEntryRef::getImportLookupEntry(
 944     const import_lookup_table_entry32 *&Result) const {
 945   uintptr_t IntPtr = 0;
 946   if (error_code EC =
 947           OwningObject->getRvaPtr(ImportTable->ImportLookupTableRVA, IntPtr))
 948     return EC;
 949   Result = reinterpret_cast<const import_lookup_table_entry32 *>(IntPtr);
 950   return object_error::success;
 951 }
 952
 953 bool ExportDirectoryEntryRef::
 954 operator==(const ExportDirectoryEntryRef &Other) const {
 955   return ExportTable == Other.ExportTable && Index == Other.Index;
 956 }
 957
 958 void ExportDirectoryEntryRef::moveNext() {
 959   ++Index;
 960 }
 961
 962 // Returns the name of the current export symbol. If the symbol is exported only
 963 // by ordinal, the empty string is set as a result.
 964 error_code ExportDirectoryEntryRef::getDllName(StringRef &Result) const {
 965   uintptr_t IntPtr = 0;
 966   if (error_code EC = OwningObject->getRvaPtr(ExportTable->NameRVA, IntPtr))
 967     return EC;
 968   Result = StringRef(reinterpret_cast<const char *>(IntPtr));
 969   return object_error::success;
 970 }
 971
 972 // Returns the starting ordinal number.
 973 error_code ExportDirectoryEntryRef::getOrdinalBase(uint32_t &Result) const {
 974   Result = ExportTable->OrdinalBase;
 975   return object_error::success;
 976 }
 977
 978 // Returns the export ordinal of the current export symbol.
 979 error_code ExportDirectoryEntryRef::getOrdinal(uint32_t &Result) const {
 980   Result = ExportTable->OrdinalBase + Index;
 981   return object_error::success;
 982 }
 983
 984 // Returns the address of the current export symbol.
 985 error_code ExportDirectoryEntryRef::getExportRVA(uint32_t &Result) const {
 986   uintptr_t IntPtr = 0;
 987   if (error_code EC = OwningObject->getRvaPtr(
 988           ExportTable->ExportAddressTableRVA, IntPtr))
 989     return EC;
 990   const export_address_table_entry *entry =
 991       reinterpret_cast<const export_address_table_entry *>(IntPtr);
 992   Result = entry[Index].ExportRVA;
 993   return object_error::success;
 994 }
 995
 996 // Returns the name of the current export symbol. If the symbol is exported only
 997 // by ordinal, the empty string is set as a result.
 998 error_code ExportDirectoryEntryRef::getSymbolName(StringRef &Result) const {
 999   uintptr_t IntPtr = 0;
1000   if (error_code EC = OwningObject->getRvaPtr(
1001           ExportTable->OrdinalTableRVA, IntPtr))
1002     return EC;
1003   const ulittle16_t *Start = reinterpret_cast<const ulittle16_t *>(IntPtr);
1004
1005   uint32_t NumEntries = ExportTable->NumberOfNamePointers;
1006   int Offset = 0;
1007   for (const ulittle16_t *I = Start, *E = Start + NumEntries;
1008        I < E; ++I, ++Offset) {
1009     if (*I != Index)
1010       continue;
1011     if (error_code EC = OwningObject->getRvaPtr(
1012             ExportTable->NamePointerRVA, IntPtr))
1013       return EC;
1014     const ulittle32_t *NamePtr = reinterpret_cast<const ulittle32_t *>(IntPtr);
1015     if (error_code EC = OwningObject->getRvaPtr(NamePtr[Offset], IntPtr))
1016       return EC;
1017     Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1018     return object_error::success;
1019   }
1020   Result = "";
1021   return object_error::success;
1022 }
1023
1024 ErrorOr<ObjectFile *> ObjectFile::createCOFFObjectFile(MemoryBuffer *Object,
1025                                                        bool BufferOwned) {
1026   error_code EC;
1027   OwningPtr<COFFObjectFile> Ret(new COFFObjectFile(Object, EC, BufferOwned));
1028   if (EC)
1029     return EC;
1030   return Ret.take();
1031 }