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
  20 using namespace llvm;
  21 using namespace object;
  22
  23 namespace {
  24 using support::ulittle8_t;
  25 using support::ulittle16_t;
  26 using support::ulittle32_t;
  27 using support::little16_t;
  28 }
  29
  30 namespace {
  31 // Returns false if size is greater than the buffer size. And sets ec.
  32 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 // Returns false if any bytes in [addr, addr + size) fall outsize of m.
  41 bool checkAddr(const MemoryBuffer *m,
  42                error_code &ec,
  43                uintptr_t addr,
  44                uint64_t size) {
  45   if (addr + size < addr ||
  46       addr + size < size ||
  47       addr + size > uintptr_t(m->getBufferEnd())) {
  48     ec = object_error::unexpected_eof;
  49     return false;
  50   }
  51   return true;
  52 }
  53 }
  54
  55 const coff_symbol *COFFObjectFile::toSymb(DataRefImpl Symb) const {
  56   const coff_symbol *addr = reinterpret_cast<const coff_symbol*>(Symb.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 < Header->PointerToSymbolTable
  62       || offset >= Header->PointerToSymbolTable
  63          + (Header->NumberOfSymbols * sizeof(coff_symbol)))
  64     report_fatal_error("Symbol was outside of symbol table.");
  65
  66   assert((offset - Header->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 Sec) const {
  74   const coff_section *addr = reinterpret_cast<const coff_section*>(Sec.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 + Header->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 Symb,
  91                                          SymbolRef &Result) const {
  92   const coff_symbol *symb = toSymb(Symb);
  93   symb += 1 + symb->NumberOfAuxSymbols;
  94   Symb.p = reinterpret_cast<uintptr_t>(symb);
  95   Result = SymbolRef(Symb, this);
  96   return object_error::success;
  97 }
  98
  99  error_code COFFObjectFile::getSymbolName(DataRefImpl Symb,
 100                                           StringRef &Result) const {
 101   const coff_symbol *symb = toSymb(Symb);
 102   return getSymbolName(symb, Result);
 103 }
 104
 105 error_code COFFObjectFile::getSymbolFileOffset(DataRefImpl Symb,
 106                                             uint64_t &Result) const {
 107   const coff_symbol *symb = toSymb(Symb);
 108   const coff_section *Section = NULL;
 109   if (error_code ec = getSection(symb->SectionNumber, Section))
 110     return ec;
 111   char Type;
 112   if (error_code ec = getSymbolNMTypeChar(Symb, Type))
 113     return ec;
 114   if (Type == 'U' || Type == 'w')
 115     Result = UnknownAddressOrSize;
 116   else if (Section)
 117     Result = Section->PointerToRawData + symb->Value;
 118   else
 119     Result = symb->Value;
 120   return object_error::success;
 121 }
 122
 123 error_code COFFObjectFile::getSymbolAddress(DataRefImpl Symb,
 124                                             uint64_t &Result) const {
 125   const coff_symbol *symb = toSymb(Symb);
 126   const coff_section *Section = NULL;
 127   if (error_code ec = getSection(symb->SectionNumber, Section))
 128     return ec;
 129   char Type;
 130   if (error_code ec = getSymbolNMTypeChar(Symb, Type))
 131     return ec;
 132   if (Type == 'U' || Type == 'w')
 133     Result = UnknownAddressOrSize;
 134   else if (Section)
 135     Result = Section->VirtualAddress + symb->Value;
 136   else
 137     Result = symb->Value;
 138   return object_error::success;
 139 }
 140
 141 error_code COFFObjectFile::getSymbolType(DataRefImpl Symb,
 142                                          SymbolRef::Type &Result) const {
 143   const coff_symbol *symb = toSymb(Symb);
 144   Result = SymbolRef::ST_Other;
 145   if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
 146       symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED) {
 147     Result = SymbolRef::ST_Unknown;
 148   } else {
 149     if (symb->getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION) {
 150       Result = SymbolRef::ST_Function;
 151     } else {
 152       char Type;
 153       if (error_code ec = getSymbolNMTypeChar(Symb, Type))
 154         return ec;
 155       if (Type == 'r' || Type == 'R') {
 156         Result = SymbolRef::ST_Data;
 157       }
 158     }
 159   }
 160   return object_error::success;
 161 }
 162
 163 error_code COFFObjectFile::getSymbolFlags(DataRefImpl Symb,
 164                                           uint32_t &Result) const {
 165   const coff_symbol *symb = toSymb(Symb);
 166   Result = SymbolRef::SF_None;
 167
 168   // TODO: Correctly set SF_FormatSpecific, SF_ThreadLocal, SF_Common
 169
 170   if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
 171       symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED)
 172     Result |= SymbolRef::SF_Undefined;
 173
 174   // TODO: This are certainly too restrictive.
 175   if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL)
 176     Result |= SymbolRef::SF_Global;
 177
 178   if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL)
 179     Result |= SymbolRef::SF_Weak;
 180
 181   if (symb->SectionNumber == COFF::IMAGE_SYM_ABSOLUTE)
 182     Result |= SymbolRef::SF_Absolute;
 183
 184   return object_error::success;
 185 }
 186
 187 error_code COFFObjectFile::getSymbolSize(DataRefImpl Symb,
 188                                          uint64_t &Result) const {
 189   // FIXME: Return the correct size. This requires looking at all the symbols
 190   //        in the same section as this symbol, and looking for either the next
 191   //        symbol, or the end of the section.
 192   const coff_symbol *symb = toSymb(Symb);
 193   const coff_section *Section = NULL;
 194   if (error_code ec = getSection(symb->SectionNumber, Section))
 195     return ec;
 196   char Type;
 197   if (error_code ec = getSymbolNMTypeChar(Symb, Type))
 198     return ec;
 199   if (Type == 'U' || Type == 'w')
 200     Result = UnknownAddressOrSize;
 201   else if (Section)
 202     Result = Section->SizeOfRawData - symb->Value;
 203   else
 204     Result = 0;
 205   return object_error::success;
 206 }
 207
 208 error_code COFFObjectFile::getSymbolNMTypeChar(DataRefImpl Symb,
 209                                                char &Result) const {
 210   const coff_symbol *symb = toSymb(Symb);
 211   StringRef name;
 212   if (error_code ec = getSymbolName(Symb, name))
 213     return ec;
 214   char ret = StringSwitch<char>(name)
 215     .StartsWith(".debug", 'N')
 216     .StartsWith(".sxdata", 'N')
 217     .Default('?');
 218
 219   if (ret != '?') {
 220     Result = ret;
 221     return object_error::success;
 222   }
 223
 224   uint32_t Characteristics = 0;
 225   if (symb->SectionNumber > 0) {
 226     const coff_section *Section = NULL;
 227     if (error_code ec = getSection(symb->SectionNumber, Section))
 228       return ec;
 229     Characteristics = Section->Characteristics;
 230   }
 231
 232   switch (symb->SectionNumber) {
 233   case COFF::IMAGE_SYM_UNDEFINED:
 234     // Check storage classes.
 235     if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL) {
 236       Result = 'w';
 237       return object_error::success; // Don't do ::toupper.
 238     } else if (symb->Value != 0) // Check for common symbols.
 239       ret = 'c';
 240     else
 241       ret = 'u';
 242     break;
 243   case COFF::IMAGE_SYM_ABSOLUTE:
 244     ret = 'a';
 245     break;
 246   case COFF::IMAGE_SYM_DEBUG:
 247     ret = 'n';
 248     break;
 249   default:
 250     // Check section type.
 251     if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
 252       ret = 't';
 253     else if (  Characteristics & COFF::IMAGE_SCN_MEM_READ
 254             && ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
 255       ret = 'r';
 256     else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
 257       ret = 'd';
 258     else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
 259       ret = 'b';
 260     else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
 261       ret = 'i';
 262
 263     // Check for section symbol.
 264     else if (  symb->StorageClass == COFF::IMAGE_SYM_CLASS_STATIC
 265             && symb->Value == 0)
 266        ret = 's';
 267   }
 268
 269   if (symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL)
 270     ret = ::toupper(ret);
 271
 272   Result = ret;
 273   return object_error::success;
 274 }
 275
 276 error_code COFFObjectFile::getSymbolSection(DataRefImpl Symb,
 277                                             section_iterator &Result) const {
 278   const coff_symbol *symb = toSymb(Symb);
 279   if (symb->SectionNumber <= COFF::IMAGE_SYM_UNDEFINED)
 280     Result = end_sections();
 281   else {
 282     const coff_section *sec = 0;
 283     if (error_code ec = getSection(symb->SectionNumber, sec)) return ec;
 284     DataRefImpl Sec;
 285     Sec.p = reinterpret_cast<uintptr_t>(sec);
 286     Result = section_iterator(SectionRef(Sec, this));
 287   }
 288   return object_error::success;
 289 }
 290
 291 error_code COFFObjectFile::getSectionNext(DataRefImpl Sec,
 292                                           SectionRef &Result) const {
 293   const coff_section *sec = toSec(Sec);
 294   sec += 1;
 295   Sec.p = reinterpret_cast<uintptr_t>(sec);
 296   Result = SectionRef(Sec, this);
 297   return object_error::success;
 298 }
 299
 300 error_code COFFObjectFile::getSectionName(DataRefImpl Sec,
 301                                           StringRef &Result) const {
 302   const coff_section *sec = toSec(Sec);
 303   return getSectionName(sec, Result);
 304 }
 305
 306 error_code COFFObjectFile::getSectionAddress(DataRefImpl Sec,
 307                                              uint64_t &Result) const {
 308   const coff_section *sec = toSec(Sec);
 309   Result = sec->VirtualAddress;
 310   return object_error::success;
 311 }
 312
 313 error_code COFFObjectFile::getSectionSize(DataRefImpl Sec,
 314                                           uint64_t &Result) const {
 315   const coff_section *sec = toSec(Sec);
 316   Result = sec->SizeOfRawData;
 317   return object_error::success;
 318 }
 319
 320 error_code COFFObjectFile::getSectionContents(DataRefImpl Sec,
 321                                               StringRef &Result) const {
 322   const coff_section *sec = toSec(Sec);
 323   ArrayRef<uint8_t> Res;
 324   error_code EC = getSectionContents(sec, Res);
 325   Result = StringRef(reinterpret_cast<const char*>(Res.data()), Res.size());
 326   return EC;
 327 }
 328
 329 error_code COFFObjectFile::getSectionAlignment(DataRefImpl Sec,
 330                                                uint64_t &Res) const {
 331   const coff_section *sec = toSec(Sec);
 332   if (!sec)
 333     return object_error::parse_failed;
 334   Res = uint64_t(1) << (((sec->Characteristics & 0x00F00000) >> 20) - 1);
 335   return object_error::success;
 336 }
 337
 338 error_code COFFObjectFile::isSectionText(DataRefImpl Sec,
 339                                          bool &Result) const {
 340   const coff_section *sec = toSec(Sec);
 341   Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_CODE;
 342   return object_error::success;
 343 }
 344
 345 error_code COFFObjectFile::isSectionData(DataRefImpl Sec,
 346                                          bool &Result) const {
 347   const coff_section *sec = toSec(Sec);
 348   Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA;
 349   return object_error::success;
 350 }
 351
 352 error_code COFFObjectFile::isSectionBSS(DataRefImpl Sec,
 353                                         bool &Result) const {
 354   const coff_section *sec = toSec(Sec);
 355   Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
 356   return object_error::success;
 357 }
 358
 359 error_code COFFObjectFile::isSectionRequiredForExecution(DataRefImpl Sec,
 360                                                          bool &Result) const {
 361   // FIXME: Unimplemented
 362   Result = true;
 363   return object_error::success;
 364 }
 365
 366 error_code COFFObjectFile::isSectionVirtual(DataRefImpl Sec,
 367                                            bool &Result) const {
 368   const coff_section *sec = toSec(Sec);
 369   Result = sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
 370   return object_error::success;
 371 }
 372
 373 error_code COFFObjectFile::isSectionZeroInit(DataRefImpl Sec,
 374                                              bool &Result) const {
 375   // FIXME: Unimplemented.
 376   Result = false;
 377   return object_error::success;
 378 }
 379
 380 error_code COFFObjectFile::isSectionReadOnlyData(DataRefImpl Sec,
 381                                                 bool &Result) const {
 382   // FIXME: Unimplemented.
 383   Result = false;
 384   return object_error::success;
 385 }
 386
 387 error_code COFFObjectFile::sectionContainsSymbol(DataRefImpl Sec,
 388                                                  DataRefImpl Symb,
 389                                                  bool &Result) const {
 390   const coff_section *sec = toSec(Sec);
 391   const coff_symbol *symb = toSymb(Symb);
 392   const coff_section *symb_sec = 0;
 393   if (error_code ec = getSection(symb->SectionNumber, symb_sec)) return ec;
 394   if (symb_sec == sec)
 395     Result = true;
 396   else
 397     Result = false;
 398   return object_error::success;
 399 }
 400
 401 relocation_iterator COFFObjectFile::getSectionRelBegin(DataRefImpl Sec) const {
 402   const coff_section *sec = toSec(Sec);
 403   DataRefImpl ret;
 404   if (sec->NumberOfRelocations == 0)
 405     ret.p = 0;
 406   else
 407     ret.p = reinterpret_cast<uintptr_t>(base() + sec->PointerToRelocations);
 408
 409   return relocation_iterator(RelocationRef(ret, this));
 410 }
 411
 412 relocation_iterator COFFObjectFile::getSectionRelEnd(DataRefImpl Sec) const {
 413   const coff_section *sec = toSec(Sec);
 414   DataRefImpl ret;
 415   if (sec->NumberOfRelocations == 0)
 416     ret.p = 0;
 417   else
 418     ret.p = reinterpret_cast<uintptr_t>(
 419               reinterpret_cast<const coff_relocation*>(
 420                 base() + sec->PointerToRelocations)
 421               + sec->NumberOfRelocations);
 422
 423   return relocation_iterator(RelocationRef(ret, this));
 424 }
 425
 426 COFFObjectFile::COFFObjectFile(MemoryBuffer *Object, error_code &ec)
 427   : ObjectFile(Binary::ID_COFF, Object, ec)
 428   , Header(0)
 429   , SectionTable(0)
 430   , SymbolTable(0)
 431   , StringTable(0)
 432   , StringTableSize(0) {
 433   // Check that we at least have enough room for a header.
 434   if (!checkSize(Data, ec, sizeof(coff_file_header))) return;
 435
 436   // The actual starting location of the COFF header in the file. This can be
 437   // non-zero in PE/COFF files.
 438   uint64_t HeaderStart = 0;
 439
 440   // Check if this is a PE/COFF file.
 441   if (base()[0] == 0x4d && base()[1] == 0x5a) {
 442     // PE/COFF, seek through MS-DOS compatibility stub and 4-byte
 443     // PE signature to find 'normal' COFF header.
 444     if (!checkSize(Data, ec, 0x3c + 8)) return;
 445     HeaderStart = *reinterpret_cast<const ulittle16_t *>(base() + 0x3c);
 446     // Check the PE header. ("PE\0\0")
 447     if (std::memcmp(base() + HeaderStart, "PE\0\0", 4) != 0) {
 448       ec = object_error::parse_failed;
 449       return;
 450     }
 451     HeaderStart += 4; // Skip the PE Header.
 452   }
 453
 454   Header = reinterpret_cast<const coff_file_header *>(base() + HeaderStart);
 455   if (!checkAddr(Data, ec, uintptr_t(Header), sizeof(coff_file_header)))
 456     return;
 457
 458   SectionTable =
 459     reinterpret_cast<const coff_section *>( base()
 460                                           + HeaderStart
 461                                           + sizeof(coff_file_header)
 462                                           + Header->SizeOfOptionalHeader);
 463   if (!checkAddr(Data, ec, uintptr_t(SectionTable),
 464                  Header->NumberOfSections * sizeof(coff_section)))
 465     return;
 466
 467   if (Header->PointerToSymbolTable != 0) {
 468     SymbolTable =
 469       reinterpret_cast<const coff_symbol *>(base()
 470                                             + Header->PointerToSymbolTable);
 471     if (!checkAddr(Data, ec, uintptr_t(SymbolTable),
 472                    Header->NumberOfSymbols * sizeof(coff_symbol)))
 473       return;
 474
 475     // Find string table.
 476     StringTable = reinterpret_cast<const char *>(base())
 477                   + Header->PointerToSymbolTable
 478                   + Header->NumberOfSymbols * sizeof(coff_symbol);
 479     if (!checkAddr(Data, ec, uintptr_t(StringTable), sizeof(ulittle32_t)))
 480       return;
 481
 482     StringTableSize = *reinterpret_cast<const ulittle32_t *>(StringTable);
 483     if (!checkAddr(Data, ec, uintptr_t(StringTable), StringTableSize))
 484       return;
 485     // Check that the string table is null terminated if has any in it.
 486     if (StringTableSize < 4
 487         || (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0)) {
 488       ec = object_error::parse_failed;
 489       return;
 490     }
 491   }
 492
 493   ec = object_error::success;
 494 }
 495
 496 symbol_iterator COFFObjectFile::begin_symbols() const {
 497   DataRefImpl ret;
 498   ret.p = reinterpret_cast<intptr_t>(SymbolTable);
 499   return symbol_iterator(SymbolRef(ret, this));
 500 }
 501
 502 symbol_iterator COFFObjectFile::end_symbols() const {
 503   // The symbol table ends where the string table begins.
 504   DataRefImpl ret;
 505   ret.p = reinterpret_cast<intptr_t>(StringTable);
 506   return symbol_iterator(SymbolRef(ret, this));
 507 }
 508
 509 symbol_iterator COFFObjectFile::begin_dynamic_symbols() const {
 510   // TODO: implement
 511   report_fatal_error("Dynamic symbols unimplemented in COFFObjectFile");
 512 }
 513
 514 symbol_iterator COFFObjectFile::end_dynamic_symbols() const {
 515   // TODO: implement
 516   report_fatal_error("Dynamic symbols unimplemented in COFFObjectFile");
 517 }
 518
 519 library_iterator COFFObjectFile::begin_libraries_needed() const {
 520   // TODO: implement
 521   report_fatal_error("Libraries needed unimplemented in COFFObjectFile");
 522 }
 523
 524 library_iterator COFFObjectFile::end_libraries_needed() const {
 525   // TODO: implement
 526   report_fatal_error("Libraries needed unimplemented in COFFObjectFile");
 527 }
 528
 529 StringRef COFFObjectFile::getLoadName() const {
 530   // COFF does not have this field.
 531   return "";
 532 }
 533
 534
 535 section_iterator COFFObjectFile::begin_sections() const {
 536   DataRefImpl ret;
 537   ret.p = reinterpret_cast<intptr_t>(SectionTable);
 538   return section_iterator(SectionRef(ret, this));
 539 }
 540
 541 section_iterator COFFObjectFile::end_sections() const {
 542   DataRefImpl ret;
 543   ret.p = reinterpret_cast<intptr_t>(SectionTable + Header->NumberOfSections);
 544   return section_iterator(SectionRef(ret, this));
 545 }
 546
 547 uint8_t COFFObjectFile::getBytesInAddress() const {
 548   return getArch() == Triple::x86_64 ? 8 : 4;
 549 }
 550
 551 StringRef COFFObjectFile::getFileFormatName() const {
 552   switch(Header->Machine) {
 553   case COFF::IMAGE_FILE_MACHINE_I386:
 554     return "COFF-i386";
 555   case COFF::IMAGE_FILE_MACHINE_AMD64:
 556     return "COFF-x86-64";
 557   default:
 558     return "COFF-<unknown arch>";
 559   }
 560 }
 561
 562 unsigned COFFObjectFile::getArch() const {
 563   switch(Header->Machine) {
 564   case COFF::IMAGE_FILE_MACHINE_I386:
 565     return Triple::x86;
 566   case COFF::IMAGE_FILE_MACHINE_AMD64:
 567     return Triple::x86_64;
 568   default:
 569     return Triple::UnknownArch;
 570   }
 571 }
 572
 573 error_code COFFObjectFile::getHeader(const coff_file_header *&Res) const {
 574   Res = Header;
 575   return object_error::success;
 576 }
 577
 578 error_code COFFObjectFile::getSection(int32_t index,
 579                                       const coff_section *&Result) const {
 580   // Check for special index values.
 581   if (index == COFF::IMAGE_SYM_UNDEFINED ||
 582       index == COFF::IMAGE_SYM_ABSOLUTE ||
 583       index == COFF::IMAGE_SYM_DEBUG)
 584     Result = NULL;
 585   else if (index > 0 && index <= Header->NumberOfSections)
 586     // We already verified the section table data, so no need to check again.
 587     Result = SectionTable + (index - 1);
 588   else
 589     return object_error::parse_failed;
 590   return object_error::success;
 591 }
 592
 593 error_code COFFObjectFile::getString(uint32_t offset,
 594                                      StringRef &Result) const {
 595   if (StringTableSize <= 4)
 596     // Tried to get a string from an empty string table.
 597     return object_error::parse_failed;
 598   if (offset >= StringTableSize)
 599     return object_error::unexpected_eof;
 600   Result = StringRef(StringTable + offset);
 601   return object_error::success;
 602 }
 603
 604 error_code COFFObjectFile::getSymbol(uint32_t index,
 605                                      const coff_symbol *&Result) const {
 606   if (index < Header->NumberOfSymbols)
 607     Result = SymbolTable + index;
 608   else
 609     return object_error::parse_failed;
 610   return object_error::success;
 611 }
 612
 613 error_code COFFObjectFile::getSymbolName(const coff_symbol *symbol,
 614                                          StringRef &Res) const {
 615   // Check for string table entry. First 4 bytes are 0.
 616   if (symbol->Name.Offset.Zeroes == 0) {
 617     uint32_t Offset = symbol->Name.Offset.Offset;
 618     if (error_code ec = getString(Offset, Res))
 619       return ec;
 620     return object_error::success;
 621   }
 622
 623   if (symbol->Name.ShortName[7] == 0)
 624     // Null terminated, let ::strlen figure out the length.
 625     Res = StringRef(symbol->Name.ShortName);
 626   else
 627     // Not null terminated, use all 8 bytes.
 628     Res = StringRef(symbol->Name.ShortName, 8);
 629   return object_error::success;
 630 }
 631
 632 ArrayRef<uint8_t> COFFObjectFile::getSymbolAuxData(
 633                                   const coff_symbol *symbol) const {
 634   const uint8_t *aux = NULL;
 635
 636   if ( symbol->NumberOfAuxSymbols > 0 ) {
 637   // AUX data comes immediately after the symbol in COFF
 638     aux = reinterpret_cast<const uint8_t *>(symbol + 1);
 639 # ifndef NDEBUG
 640     // Verify that the aux symbol points to a valid entry in the symbol table.
 641     uintptr_t offset = uintptr_t(aux) - uintptr_t(base());
 642     if (offset < Header->PointerToSymbolTable
 643         || offset >= Header->PointerToSymbolTable
 644            + (Header->NumberOfSymbols * sizeof(coff_symbol)))
 645       report_fatal_error("Aux Symbol data was outside of symbol table.");
 646
 647     assert((offset - Header->PointerToSymbolTable) % sizeof(coff_symbol)
 648          == 0 && "Aux Symbol data did not point to the beginning of a symbol");
 649 # endif
 650   }
 651   return ArrayRef<uint8_t>(aux, symbol->NumberOfAuxSymbols * sizeof(coff_symbol));
 652 }
 653
 654 error_code COFFObjectFile::getSectionName(const coff_section *Sec,
 655                                           StringRef &Res) const {
 656   StringRef Name;
 657   if (Sec->Name[7] == 0)
 658     // Null terminated, let ::strlen figure out the length.
 659     Name = Sec->Name;
 660   else
 661     // Not null terminated, use all 8 bytes.
 662     Name = StringRef(Sec->Name, 8);
 663
 664   // Check for string table entry. First byte is '/'.
 665   if (Name[0] == '/') {
 666     uint32_t Offset;
 667     if (Name.substr(1).getAsInteger(10, Offset))
 668       return object_error::parse_failed;
 669     if (error_code ec = getString(Offset, Name))
 670       return ec;
 671   }
 672
 673   Res = Name;
 674   return object_error::success;
 675 }
 676
 677 error_code COFFObjectFile::getSectionContents(const coff_section *Sec,
 678                                               ArrayRef<uint8_t> &Res) const {
 679   // The only thing that we need to verify is that the contents is contained
 680   // within the file bounds. We don't need to make sure it doesn't cover other
 681   // data, as there's nothing that says that is not allowed.
 682   uintptr_t ConStart = uintptr_t(base()) + Sec->PointerToRawData;
 683   uintptr_t ConEnd = ConStart + Sec->SizeOfRawData;
 684   if (ConEnd > uintptr_t(Data->getBufferEnd()))
 685     return object_error::parse_failed;
 686   Res = ArrayRef<uint8_t>(reinterpret_cast<const unsigned char*>(ConStart),
 687                           Sec->SizeOfRawData);
 688   return object_error::success;
 689 }
 690
 691 const coff_relocation *COFFObjectFile::toRel(DataRefImpl Rel) const {
 692   return reinterpret_cast<const coff_relocation*>(Rel.p);
 693 }
 694 error_code COFFObjectFile::getRelocationNext(DataRefImpl Rel,
 695                                              RelocationRef &Res) const {
 696   Rel.p = reinterpret_cast<uintptr_t>(
 697             reinterpret_cast<const coff_relocation*>(Rel.p) + 1);
 698   Res = RelocationRef(Rel, this);
 699   return object_error::success;
 700 }
 701 error_code COFFObjectFile::getRelocationAddress(DataRefImpl Rel,
 702                                                 uint64_t &Res) const {
 703   Res = toRel(Rel)->VirtualAddress;
 704   return object_error::success;
 705 }
 706 error_code COFFObjectFile::getRelocationOffset(DataRefImpl Rel,
 707                                                uint64_t &Res) const {
 708   Res = toRel(Rel)->VirtualAddress;
 709   return object_error::success;
 710 }
 711 error_code COFFObjectFile::getRelocationSymbol(DataRefImpl Rel,
 712                                                SymbolRef &Res) const {
 713   const coff_relocation* R = toRel(Rel);
 714   DataRefImpl Symb;
 715   Symb.p = reinterpret_cast<uintptr_t>(SymbolTable + R->SymbolTableIndex);
 716   Res = SymbolRef(Symb, this);
 717   return object_error::success;
 718 }
 719 error_code COFFObjectFile::getRelocationType(DataRefImpl Rel,
 720                                              uint64_t &Res) const {
 721   const coff_relocation* R = toRel(Rel);
 722   Res = R->Type;
 723   return object_error::success;
 724 }
 725
 726 const coff_section *COFFObjectFile::getCOFFSection(section_iterator &It) const {
 727   return toSec(It->getRawDataRefImpl());
 728 }
 729
 730 const coff_symbol *COFFObjectFile::getCOFFSymbol(symbol_iterator &It) const {
 731   return toSymb(It->getRawDataRefImpl());
 732 }
 733
 734 const coff_relocation *COFFObjectFile::getCOFFRelocation(
 735                                              relocation_iterator &It) const {
 736   return toRel(It->getRawDataRefImpl());
 737 }
 738
 739
 740 #define LLVM_COFF_SWITCH_RELOC_TYPE_NAME(enum) \
 741   case COFF::enum: res = #enum; break;
 742
 743 error_code COFFObjectFile::getRelocationTypeName(DataRefImpl Rel,
 744                                           SmallVectorImpl<char> &Result) const {
 745   const coff_relocation *reloc = toRel(Rel);
 746   StringRef res;
 747   switch (Header->Machine) {
 748   case COFF::IMAGE_FILE_MACHINE_AMD64:
 749     switch (reloc->Type) {
 750     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ABSOLUTE);
 751     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR64);
 752     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32);
 753     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32NB);
 754     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32);
 755     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_1);
 756     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_2);
 757     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_3);
 758     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_4);
 759     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_5);
 760     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECTION);
 761     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL);
 762     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL7);
 763     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_TOKEN);
 764     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SREL32);
 765     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_PAIR);
 766     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SSPAN32);
 767     default:
 768       res = "Unknown";
 769     }
 770     break;
 771   case COFF::IMAGE_FILE_MACHINE_I386:
 772     switch (reloc->Type) {
 773     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_ABSOLUTE);
 774     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR16);
 775     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL16);
 776     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32);
 777     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32NB);
 778     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SEG12);
 779     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECTION);
 780     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL);
 781     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_TOKEN);
 782     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL7);
 783     LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL32);
 784     default:
 785       res = "Unknown";
 786     }
 787     break;
 788   default:
 789     res = "Unknown";
 790   }
 791   Result.append(res.begin(), res.end());
 792   return object_error::success;
 793 }
 794
 795 #undef LLVM_COFF_SWITCH_RELOC_TYPE_NAME
 796
 797 error_code COFFObjectFile::getRelocationAdditionalInfo(DataRefImpl Rel,
 798                                                        int64_t &Res) const {
 799   Res = 0;
 800   return object_error::success;
 801 }
 802 error_code COFFObjectFile::getRelocationValueString(DataRefImpl Rel,
 803                                           SmallVectorImpl<char> &Result) const {
 804   const coff_relocation *reloc = toRel(Rel);
 805   const coff_symbol *symb = 0;
 806   if (error_code ec = getSymbol(reloc->SymbolTableIndex, symb)) return ec;
 807   DataRefImpl sym;
 808   sym.p = reinterpret_cast<uintptr_t>(symb);
 809   StringRef symname;
 810   if (error_code ec = getSymbolName(sym, symname)) return ec;
 811   Result.append(symname.begin(), symname.end());
 812   return object_error::success;
 813 }
 814
 815 error_code COFFObjectFile::getLibraryNext(DataRefImpl LibData,
 816                                           LibraryRef &Result) const {
 817   report_fatal_error("getLibraryNext not implemented in COFFObjectFile");
 818 }
 819
 820 error_code COFFObjectFile::getLibraryPath(DataRefImpl LibData,
 821                                           StringRef &Result) const {
 822   report_fatal_error("getLibraryPath not implemented in COFFObjectFile");
 823 }
 824
 825 namespace llvm {
 826
 827   ObjectFile *ObjectFile::createCOFFObjectFile(MemoryBuffer *Object) {
 828     error_code ec;
 829     return new COFFObjectFile(Object, ec);
 830   }
 831
 832 } // end namespace llvm