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