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 = reinterpret_cast<const export_directory_table_entry *>(IntPtr);
 462   return object_error::success;
 463 }
 464
 465 COFFObjectFile::COFFObjectFile(MemoryBuffer *Object, error_code &EC)
 466   : ObjectFile(Binary::ID_COFF, Object), COFFHeader(0), PE32Header(0),
 467     DataDirectory(0), SectionTable(0), SymbolTable(0), StringTable(0),
 468     StringTableSize(0), ImportDirectory(0), NumberOfImportDirectory(0),
 469     ExportDirectory(0) {
 470   // Check that we at least have enough room for a header.
 471   if (!checkSize(Data, EC, sizeof(coff_file_header))) return;
 472
 473   // The current location in the file where we are looking at.
 474   uint64_t CurPtr = 0;
 475
 476   // PE header is optional and is present only in executables. If it exists,
 477   // it is placed right after COFF header.
 478   bool HasPEHeader = false;
 479
 480   // Check if this is a PE/COFF file.
 481   if (base()[0] == 0x4d && base()[1] == 0x5a) {
 482     // PE/COFF, seek through MS-DOS compatibility stub and 4-byte
 483     // PE signature to find 'normal' COFF header.
 484     if (!checkSize(Data, EC, 0x3c + 8)) return;
 485     CurPtr = *reinterpret_cast<const ulittle16_t *>(base() + 0x3c);
 486     // Check the PE magic bytes. ("PE\0\0")
 487     if (std::memcmp(base() + CurPtr, "PE\0\0", 4) != 0) {
 488       EC = object_error::parse_failed;
 489       return;
 490     }
 491     CurPtr += 4; // Skip the PE magic bytes.
 492     HasPEHeader = true;
 493   }
 494
 495   if ((EC = getObject(COFFHeader, Data, base() + CurPtr)))
 496     return;
 497   CurPtr += sizeof(coff_file_header);
 498
 499   if (HasPEHeader) {
 500     if ((EC = getObject(PE32Header, Data, base() + CurPtr)))
 501       return;
 502     if (PE32Header->Magic != 0x10b) {
 503       // We only support PE32. If this is PE32 (not PE32+), the magic byte
 504       // should be 0x10b. If this is not PE32, continue as if there's no PE
 505       // header in this file.
 506       PE32Header = 0;
 507     } else if (PE32Header->NumberOfRvaAndSize > 0) {
 508       const uint8_t *Addr = base() + CurPtr + sizeof(pe32_header);
 509       uint64_t size = sizeof(data_directory) * PE32Header->NumberOfRvaAndSize;
 510       if ((EC = getObject(DataDirectory, Data, Addr, size)))
 511         return;
 512     }
 513     CurPtr += COFFHeader->SizeOfOptionalHeader;
 514   }
 515
 516   if (!COFFHeader->isImportLibrary())
 517     if ((EC = getObject(SectionTable, Data, base() + CurPtr,
 518                         COFFHeader->NumberOfSections * sizeof(coff_section))))
 519       return;
 520
 521   // Initialize the pointer to the symbol table.
 522   if (COFFHeader->PointerToSymbolTable != 0)
 523     if ((EC = initSymbolTablePtr()))
 524       return;
 525
 526   // Initialize the pointer to the beginning of the import table.
 527   if ((EC = initImportTablePtr()))
 528     return;
 529
 530   // Initialize the pointer to the export table.
 531   if ((EC = initExportTablePtr()))
 532     return;
 533
 534   EC = object_error::success;
 535 }
 536
 537 symbol_iterator COFFObjectFile::begin_symbols() const {
 538   DataRefImpl Ret;
 539   Ret.p = reinterpret_cast<uintptr_t>(SymbolTable);
 540   return symbol_iterator(SymbolRef(Ret, this));
 541 }
 542
 543 symbol_iterator COFFObjectFile::end_symbols() const {
 544   // The symbol table ends where the string table begins.
 545   DataRefImpl Ret;
 546   Ret.p = reinterpret_cast<uintptr_t>(StringTable);
 547   return symbol_iterator(SymbolRef(Ret, this));
 548 }
 549
 550 symbol_iterator COFFObjectFile::begin_dynamic_symbols() const {
 551   // TODO: implement
 552   report_fatal_error("Dynamic symbols unimplemented in COFFObjectFile");
 553 }
 554
 555 symbol_iterator COFFObjectFile::end_dynamic_symbols() const {
 556   // TODO: implement
 557   report_fatal_error("Dynamic symbols unimplemented in COFFObjectFile");
 558 }
 559
 560 library_iterator COFFObjectFile::begin_libraries_needed() const {
 561   // TODO: implement
 562   report_fatal_error("Libraries needed unimplemented in COFFObjectFile");
 563 }
 564
 565 library_iterator COFFObjectFile::end_libraries_needed() const {
 566   // TODO: implement
 567   report_fatal_error("Libraries needed unimplemented in COFFObjectFile");
 568 }
 569
 570 StringRef COFFObjectFile::getLoadName() const {
 571   // COFF does not have this field.
 572   return "";
 573 }
 574
 575 import_directory_iterator COFFObjectFile::import_directory_begin() const {
 576   return import_directory_iterator(
 577       ImportDirectoryEntryRef(ImportDirectory, 0, this));
 578 }
 579
 580 import_directory_iterator COFFObjectFile::import_directory_end() const {
 581   return import_directory_iterator(
 582       ImportDirectoryEntryRef(ImportDirectory, NumberOfImportDirectory, this));
 583 }
 584
 585 export_directory_iterator COFFObjectFile::export_directory_begin() const {
 586   return export_directory_iterator(
 587       ExportDirectoryEntryRef(ExportDirectory, 0, this));
 588 }
 589
 590 export_directory_iterator COFFObjectFile::export_directory_end() const {
 591   if (ExportDirectory == 0)
 592     return export_directory_iterator(ExportDirectoryEntryRef(0, 0, this));
 593   ExportDirectoryEntryRef Ref(ExportDirectory,
 594                               ExportDirectory->AddressTableEntries, this);
 595   return export_directory_iterator(Ref);
 596 }
 597
 598 section_iterator COFFObjectFile::begin_sections() const {
 599   DataRefImpl Ret;
 600   Ret.p = reinterpret_cast<uintptr_t>(SectionTable);
 601   return section_iterator(SectionRef(Ret, this));
 602 }
 603
 604 section_iterator COFFObjectFile::end_sections() const {
 605   DataRefImpl Ret;
 606   int NumSections = COFFHeader->isImportLibrary()
 607       ? 0 : COFFHeader->NumberOfSections;
 608   Ret.p = reinterpret_cast<uintptr_t>(SectionTable + NumSections);
 609   return section_iterator(SectionRef(Ret, this));
 610 }
 611
 612 uint8_t COFFObjectFile::getBytesInAddress() const {
 613   return getArch() == Triple::x86_64 ? 8 : 4;
 614 }
 615
 616 StringRef COFFObjectFile::getFileFormatName() const {
 617   switch(COFFHeader->Machine) {
 618   case COFF::IMAGE_FILE_MACHINE_I386:
 619     return "COFF-i386";
 620   case COFF::IMAGE_FILE_MACHINE_AMD64:
 621     return "COFF-x86-64";
 622   default:
 623     return "COFF-<unknown arch>";
 624   }
 625 }
 626
 627 unsigned COFFObjectFile::getArch() const {
 628   switch(COFFHeader->Machine) {
 629   case COFF::IMAGE_FILE_MACHINE_I386:
 630     return Triple::x86;
 631   case COFF::IMAGE_FILE_MACHINE_AMD64:
 632     return Triple::x86_64;
 633   default:
 634     return Triple::UnknownArch;
 635   }
 636 }
 637
 638 // This method is kept here because lld uses this. As soon as we make
 639 // lld to use getCOFFHeader, this method will be removed.
 640 error_code COFFObjectFile::getHeader(const coff_file_header *&Res) const {
 641   return getCOFFHeader(Res);
 642 }
 643
 644 error_code COFFObjectFile::getCOFFHeader(const coff_file_header *&Res) const {
 645   Res = COFFHeader;
 646   return object_error::success;
 647 }
 648
 649 error_code COFFObjectFile::getPE32Header(const pe32_header *&Res) const {
 650   Res = PE32Header;
 651   return object_error::success;
 652 }
 653
 654 error_code COFFObjectFile::getDataDirectory(uint32_t Index,
 655                                             const data_directory *&Res) const {
 656   // Error if if there's no data directory or the index is out of range.
 657   if (!DataDirectory || Index > PE32Header->NumberOfRvaAndSize)
 658     return object_error::parse_failed;
 659   Res = &DataDirectory[Index];
 660   return object_error::success;
 661 }
 662
 663 error_code COFFObjectFile::getSection(int32_t Index,
 664                                       const coff_section *&Result) const {
 665   // Check for special index values.
 666   if (Index == COFF::IMAGE_SYM_UNDEFINED ||
 667       Index == COFF::IMAGE_SYM_ABSOLUTE ||
 668       Index == COFF::IMAGE_SYM_DEBUG)
 669     Result = NULL;
 670   else if (Index > 0 && Index <= COFFHeader->NumberOfSections)
 671     // We already verified the section table data, so no need to check again.
 672     Result = SectionTable + (Index - 1);
 673   else
 674     return object_error::parse_failed;
 675   return object_error::success;
 676 }
 677
 678 error_code COFFObjectFile::getString(uint32_t Offset,
 679                                      StringRef &Result) const {
 680   if (StringTableSize <= 4)
 681     // Tried to get a string from an empty string table.
 682     return object_error::parse_failed;
 683   if (Offset >= StringTableSize)
 684     return object_error::unexpected_eof;
 685   Result = StringRef(StringTable + Offset);
 686   return object_error::success;
 687 }
 688
 689 error_code COFFObjectFile::getSymbol(uint32_t Index,
 690                                      const coff_symbol *&Result) const {
 691   if (Index < COFFHeader->NumberOfSymbols)
 692     Result = SymbolTable + Index;
 693   else
 694     return object_error::parse_failed;
 695   return object_error::success;
 696 }
 697
 698 error_code COFFObjectFile::getSymbolName(const coff_symbol *Symbol,
 699                                          StringRef &Res) const {
 700   // Check for string table entry. First 4 bytes are 0.
 701   if (Symbol->Name.Offset.Zeroes == 0) {
 702     uint32_t Offset = Symbol->Name.Offset.Offset;
 703     if (error_code EC = getString(Offset, Res))
 704       return EC;
 705     return object_error::success;
 706   }
 707
 708   if (Symbol->Name.ShortName[7] == 0)
 709     // Null terminated, let ::strlen figure out the length.
 710     Res = StringRef(Symbol->Name.ShortName);
 711   else
 712     // Not null terminated, use all 8 bytes.
 713     Res = StringRef(Symbol->Name.ShortName, 8);
 714   return object_error::success;
 715 }
 716
 717 ArrayRef<uint8_t> COFFObjectFile::getSymbolAuxData(
 718                                   const coff_symbol *Symbol) const {
 719   const uint8_t *Aux = NULL;
 720
 721   if (Symbol->NumberOfAuxSymbols > 0) {
 722   // AUX data comes immediately after the symbol in COFF
 723     Aux = reinterpret_cast<const uint8_t *>(Symbol + 1);
 724 # ifndef NDEBUG
 725     // Verify that the Aux symbol points to a valid entry in the symbol table.
 726     uintptr_t Offset = uintptr_t(Aux) - uintptr_t(base());
 727     if (Offset < COFFHeader->PointerToSymbolTable
 728         || Offset >= COFFHeader->PointerToSymbolTable
 729            + (COFFHeader->NumberOfSymbols * sizeof(coff_symbol)))
 730       report_fatal_error("Aux Symbol data was outside of symbol table.");
 731
 732     assert((Offset - COFFHeader->PointerToSymbolTable) % sizeof(coff_symbol)
 733          == 0 && "Aux Symbol data did not point to the beginning of a symbol");
 734 # endif
 735   }
 736   return ArrayRef<uint8_t>(Aux, Symbol->NumberOfAuxSymbols * sizeof(coff_symbol));
 737 }
 738
 739 error_code COFFObjectFile::getSectionName(const coff_section *Sec,
 740                                           StringRef &Res) const {
 741   StringRef Name;
 742   if (Sec->Name[7] == 0)
 743     // Null terminated, let ::strlen figure out the length.
 744     Name = Sec->Name;
 745   else
 746     // Not null terminated, use all 8 bytes.
 747     Name = StringRef(Sec->Name, 8);
 748
 749   // Check for string table entry. First byte is '/'.
 750   if (Name[0] == '/') {
 751     uint32_t Offset;
 752     if (Name.substr(1).getAsInteger(10, Offset))
 753       return object_error::parse_failed;
 754     if (error_code EC = getString(Offset, Name))
 755       return EC;
 756   }
 757
 758   Res = Name;
 759   return object_error::success;
 760 }
 761
 762 error_code COFFObjectFile::getSectionContents(const coff_section *Sec,
 763                                               ArrayRef<uint8_t> &Res) const {
 764   // The only thing that we need to verify is that the contents is contained
 765   // within the file bounds. We don't need to make sure it doesn't cover other
 766   // data, as there's nothing that says that is not allowed.
 767   uintptr_t ConStart = uintptr_t(base()) + Sec->PointerToRawData;
 768   uintptr_t ConEnd = ConStart + Sec->SizeOfRawData;
 769   if (ConEnd > uintptr_t(Data->getBufferEnd()))
 770     return object_error::parse_failed;
 771   Res = ArrayRef<uint8_t>(reinterpret_cast<const unsigned char*>(ConStart),
 772                           Sec->SizeOfRawData);
 773   return object_error::success;
 774 }
 775
 776 const coff_relocation *COFFObjectFile::toRel(DataRefImpl Rel) const {
 777   return reinterpret_cast<const coff_relocation*>(Rel.p);
 778 }
 779
 780 error_code COFFObjectFile::getRelocationNext(DataRefImpl Rel,
 781                                              RelocationRef &Res) const {
 782   Rel.p = reinterpret_cast<uintptr_t>(
 783             reinterpret_cast<const coff_relocation*>(Rel.p) + 1);
 784   Res = RelocationRef(Rel, this);
 785   return object_error::success;
 786 }
 787
 788 error_code COFFObjectFile::getRelocationAddress(DataRefImpl Rel,
 789                                                 uint64_t &Res) const {
 790   report_fatal_error("getRelocationAddress not implemented in COFFObjectFile");
 791 }
 792
 793 error_code COFFObjectFile::getRelocationOffset(DataRefImpl Rel,
 794                                                uint64_t &Res) const {
 795   Res = toRel(Rel)->VirtualAddress;
 796   return object_error::success;
 797 }
 798
 799 symbol_iterator COFFObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
 800   const coff_relocation* R = toRel(Rel);
 801   DataRefImpl Ref;
 802   Ref.p = reinterpret_cast<uintptr_t>(SymbolTable + R->SymbolTableIndex);
 803   return symbol_iterator(SymbolRef(Ref, this));
 804 }
 805
 806 error_code COFFObjectFile::getRelocationType(DataRefImpl Rel,
 807                                              uint64_t &Res) const {
 808   const coff_relocation* R = toRel(Rel);
 809   Res = R->Type;
 810   return object_error::success;
 811 }
 812
 813 const coff_section *COFFObjectFile::getCOFFSection(section_iterator &It) const {
 814   return toSec(It->getRawDataRefImpl());
 815 }
 816
 817 const coff_symbol *COFFObjectFile::getCOFFSymbol(symbol_iterator &It) const {
 818   return toSymb(It->getRawDataRefImpl());
 819 }
 820
 821 const coff_relocation *COFFObjectFile::getCOFFRelocation(
 822                                              relocation_iterator &It) const {
 823   return toRel(It->getRawDataRefImpl());
 824 }
 825
 826 #define LLVM_COFF_SWITCH_RELOC_TYPE_NAME(enum) \
 827   case COFF::enum: Res = #enum; break;
 828
 829 error_code COFFObjectFile::getRelocationTypeName(DataRefImpl Rel,
 830                                           SmallVectorImpl<char> &Result) const {
 831   const coff_relocation *Reloc = toRel(Rel);
 832   StringRef Res;
 833   switch (COFFHeader->Machine) {
 834   case COFF::IMAGE_FILE_MACHINE_AMD64:
 835     switch (Reloc->Type) {
 836     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ABSOLUTE);
 837     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR64);
 838     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32);
 839     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32NB);
 840     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32);
 841     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_1);
 842     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_2);
 843     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_3);
 844     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_4);
 845     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_5);
 846     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECTION);
 847     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL);
 848     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL7);
 849     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_TOKEN);
 850     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SREL32);
 851     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_PAIR);
 852     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SSPAN32);
 853     default:
 854       Res = "Unknown";
 855     }
 856     break;
 857   case COFF::IMAGE_FILE_MACHINE_I386:
 858     switch (Reloc->Type) {
 859     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_ABSOLUTE);
 860     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR16);
 861     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL16);
 862     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32);
 863     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32NB);
 864     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SEG12);
 865     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECTION);
 866     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL);
 867     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_TOKEN);
 868     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL7);
 869     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL32);
 870     default:
 871       Res = "Unknown";
 872     }
 873     break;
 874   default:
 875     Res = "Unknown";
 876   }
 877   Result.append(Res.begin(), Res.end());
 878   return object_error::success;
 879 }
 880
 881 #undef LLVM_COFF_SWITCH_RELOC_TYPE_NAME
 882
 883 error_code COFFObjectFile::getRelocationValueString(DataRefImpl Rel,
 884                                           SmallVectorImpl<char> &Result) const {
 885   const coff_relocation *Reloc = toRel(Rel);
 886   const coff_symbol *Symb = 0;
 887   if (error_code EC = getSymbol(Reloc->SymbolTableIndex, Symb)) return EC;
 888   DataRefImpl Sym;
 889   Sym.p = reinterpret_cast<uintptr_t>(Symb);
 890   StringRef SymName;
 891   if (error_code EC = getSymbolName(Sym, SymName)) return EC;
 892   Result.append(SymName.begin(), SymName.end());
 893   return object_error::success;
 894 }
 895
 896 error_code COFFObjectFile::getLibraryNext(DataRefImpl LibData,
 897                                           LibraryRef &Result) const {
 898   report_fatal_error("getLibraryNext not implemented in COFFObjectFile");
 899 }
 900
 901 error_code COFFObjectFile::getLibraryPath(DataRefImpl LibData,
 902                                           StringRef &Result) const {
 903   report_fatal_error("getLibraryPath not implemented in COFFObjectFile");
 904 }
 905
 906 bool ImportDirectoryEntryRef::
 907 operator==(const ImportDirectoryEntryRef &Other) const {
 908   return ImportTable == Other.ImportTable && Index == Other.Index;
 909 }
 910
 911 error_code
 912 ImportDirectoryEntryRef::getNext(ImportDirectoryEntryRef &Result) const {
 913   Result = ImportDirectoryEntryRef(ImportTable, Index + 1, OwningObject);
 914   return object_error::success;
 915 }
 916
 917 error_code ImportDirectoryEntryRef::
 918 getImportTableEntry(const import_directory_table_entry *&Result) const {
 919   Result = ImportTable;
 920   return object_error::success;
 921 }
 922
 923 error_code ImportDirectoryEntryRef::getName(StringRef &Result) const {
 924   uintptr_t IntPtr = 0;
 925   if (error_code EC = OwningObject->getRvaPtr(ImportTable->NameRVA, IntPtr))
 926     return EC;
 927   Result = StringRef(reinterpret_cast<const char *>(IntPtr));
 928   return object_error::success;
 929 }
 930
 931 error_code ImportDirectoryEntryRef::getImportLookupEntry(
 932     const import_lookup_table_entry32 *&Result) const {
 933   uintptr_t IntPtr = 0;
 934   if (error_code EC =
 935           OwningObject->getRvaPtr(ImportTable->ImportLookupTableRVA, IntPtr))
 936     return EC;
 937   Result = reinterpret_cast<const import_lookup_table_entry32 *>(IntPtr);
 938   return object_error::success;
 939 }
 940
 941 bool ExportDirectoryEntryRef::
 942 operator==(const ExportDirectoryEntryRef &Other) const {
 943   return ExportTable == Other.ExportTable && Index == Other.Index;
 944 }
 945
 946 error_code
 947 ExportDirectoryEntryRef::getNext(ExportDirectoryEntryRef &Result) const {
 948   Result = ExportDirectoryEntryRef(ExportTable, Index + 1, OwningObject);
 949   return object_error::success;
 950 }
 951
 952 // Returns the export ordinal of the current export symbol.
 953 error_code ExportDirectoryEntryRef::getOrdinal(uint32_t &Result) const {
 954   Result = ExportTable->OrdinalBase + Index;
 955   return object_error::success;
 956 }
 957
 958 // Returns the address of the current export symbol.
 959 error_code ExportDirectoryEntryRef::getExportRVA(uint32_t &Result) const {
 960   uintptr_t IntPtr = 0;
 961   if (error_code EC = OwningObject->getRvaPtr(
 962           ExportTable->ExportAddressTableRVA, IntPtr))
 963     return EC;
 964   const export_address_table_entry *entry = reinterpret_cast<const export_address_table_entry *>(IntPtr);
 965   Result = entry[Index].ExportRVA;
 966   return object_error::success;
 967 }
 968
 969 // Returns the name of the current export symbol. If the symbol is exported only
 970 // by ordinal, the empty string is set as a result.
 971 error_code ExportDirectoryEntryRef::getName(StringRef &Result) const {
 972   uintptr_t IntPtr = 0;
 973   if (error_code EC = OwningObject->getRvaPtr(
 974           ExportTable->OrdinalTableRVA, IntPtr))
 975     return EC;
 976   const ulittle16_t *Start = reinterpret_cast<const ulittle16_t *>(IntPtr);
 977
 978   uint32_t NumEntries = ExportTable->NumberOfNamePointers;
 979   int Offset = 0;
 980   for (const ulittle16_t *I = Start, *E = Start + NumEntries;
 981        I < E; ++I, ++Offset) {
 982     if (*I != Index)
 983       continue;
 984     if (error_code EC = OwningObject->getRvaPtr(
 985             ExportTable->NamePointerRVA, IntPtr))
 986       return EC;
 987     const ulittle32_t *NamePtr = reinterpret_cast<const ulittle32_t *>(IntPtr);
 988     if (error_code EC = OwningObject->getRvaPtr(NamePtr[Offset], IntPtr))
 989       return EC;
 990     Result = StringRef(reinterpret_cast<const char *>(IntPtr));
 991     return object_error::success;
 992   }
 993   Result = "";
 994   return object_error::success;
 995 }
 996
 997 namespace llvm {
 998 ObjectFile *ObjectFile::createCOFFObjectFile(MemoryBuffer *Object) {
 999   error_code EC;
1000   return new COFFObjectFile(Object, EC);
1001 }
1002 }