1 //===- COFFObjectFile.cpp - COFF object file implementation -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the COFFObjectFile class.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Object/COFF.h"
15 #include "llvm/ADT/ArrayRef.h"
16 #include "llvm/ADT/SmallString.h"
17 #include "llvm/ADT/StringSwitch.h"
18 #include "llvm/ADT/Triple.h"
19 #include "llvm/Support/COFF.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/raw_ostream.h"
26 using namespace object;
28 using support::ulittle8_t;
29 using support::ulittle16_t;
30 using support::ulittle32_t;
31 using support::little16_t;
33 // Returns false if size is greater than the buffer size. And sets ec.
34 static bool checkSize(const MemoryBuffer &M, std::error_code &EC,
36 if (M.getBufferSize() < Size) {
37 EC = object_error::unexpected_eof;
43 // Sets Obj unless any bytes in [addr, addr + size) fall outsize of m.
44 // Returns unexpected_eof if error.
46 static std::error_code getObject(const T *&Obj, const MemoryBuffer &M,
48 const size_t Size = sizeof(T)) {
49 uintptr_t Addr = uintptr_t(Ptr);
50 if (Addr + Size < Addr || Addr + Size < Size ||
51 Addr + Size > uintptr_t(M.getBufferEnd())) {
52 return object_error::unexpected_eof;
54 Obj = reinterpret_cast<const T *>(Addr);
55 return object_error::success;
58 // Decode a string table entry in base 64 (//AAAAAA). Expects \arg Str without
60 static bool decodeBase64StringEntry(StringRef Str, uint32_t &Result) {
61 assert(Str.size() <= 6 && "String too long, possible overflow.");
66 while (!Str.empty()) {
68 if (Str[0] >= 'A' && Str[0] <= 'Z') // 0..25
69 CharVal = Str[0] - 'A';
70 else if (Str[0] >= 'a' && Str[0] <= 'z') // 26..51
71 CharVal = Str[0] - 'a' + 26;
72 else if (Str[0] >= '0' && Str[0] <= '9') // 52..61
73 CharVal = Str[0] - '0' + 52;
74 else if (Str[0] == '+') // 62
76 else if (Str[0] == '/') // 63
81 Value = (Value * 64) + CharVal;
85 if (Value > std::numeric_limits<uint32_t>::max())
88 Result = static_cast<uint32_t>(Value);
92 const coff_symbol *COFFObjectFile::toSymb(DataRefImpl Ref) const {
93 const coff_symbol *Addr = reinterpret_cast<const coff_symbol*>(Ref.p);
96 // Verify that the symbol points to a valid entry in the symbol table.
97 uintptr_t Offset = uintptr_t(Addr) - uintptr_t(base());
98 if (Offset < COFFHeader->PointerToSymbolTable
99 || Offset >= COFFHeader->PointerToSymbolTable
100 + (COFFHeader->NumberOfSymbols * sizeof(coff_symbol)))
101 report_fatal_error("Symbol was outside of symbol table.");
103 assert((Offset - COFFHeader->PointerToSymbolTable) % sizeof(coff_symbol)
104 == 0 && "Symbol did not point to the beginning of a symbol");
110 const coff_section *COFFObjectFile::toSec(DataRefImpl Ref) const {
111 const coff_section *Addr = reinterpret_cast<const coff_section*>(Ref.p);
114 // Verify that the section points to a valid entry in the section table.
115 if (Addr < SectionTable
116 || Addr >= (SectionTable + COFFHeader->NumberOfSections))
117 report_fatal_error("Section was outside of section table.");
119 uintptr_t Offset = uintptr_t(Addr) - uintptr_t(SectionTable);
120 assert(Offset % sizeof(coff_section) == 0 &&
121 "Section did not point to the beginning of a section");
127 void COFFObjectFile::moveSymbolNext(DataRefImpl &Ref) const {
128 const coff_symbol *Symb = toSymb(Ref);
129 Symb += 1 + Symb->NumberOfAuxSymbols;
130 Ref.p = reinterpret_cast<uintptr_t>(Symb);
133 std::error_code COFFObjectFile::getSymbolName(DataRefImpl Ref,
134 StringRef &Result) const {
135 const coff_symbol *Symb = toSymb(Ref);
136 return getSymbolName(Symb, Result);
139 std::error_code COFFObjectFile::getSymbolAddress(DataRefImpl Ref,
140 uint64_t &Result) const {
141 const coff_symbol *Symb = toSymb(Ref);
142 const coff_section *Section = nullptr;
143 if (std::error_code EC = getSection(Symb->SectionNumber, Section))
146 if (Symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED)
147 Result = UnknownAddressOrSize;
149 Result = Section->VirtualAddress + Symb->Value;
151 Result = Symb->Value;
152 return object_error::success;
155 std::error_code COFFObjectFile::getSymbolType(DataRefImpl Ref,
156 SymbolRef::Type &Result) const {
157 const coff_symbol *Symb = toSymb(Ref);
158 Result = SymbolRef::ST_Other;
159 if (Symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
160 Symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED) {
161 Result = SymbolRef::ST_Unknown;
162 } else if (Symb->isFunctionDefinition()) {
163 Result = SymbolRef::ST_Function;
165 uint32_t Characteristics = 0;
166 if (!COFF::isReservedSectionNumber(Symb->SectionNumber)) {
167 const coff_section *Section = nullptr;
168 if (std::error_code EC = getSection(Symb->SectionNumber, Section))
170 Characteristics = Section->Characteristics;
172 if (Characteristics & COFF::IMAGE_SCN_MEM_READ &&
173 ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
174 Result = SymbolRef::ST_Data;
176 return object_error::success;
179 uint32_t COFFObjectFile::getSymbolFlags(DataRefImpl Ref) const {
180 const coff_symbol *Symb = toSymb(Ref);
181 uint32_t Result = SymbolRef::SF_None;
183 // TODO: Correctly set SF_FormatSpecific, SF_Common
185 if (Symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED) {
186 if (Symb->Value == 0)
187 Result |= SymbolRef::SF_Undefined;
189 Result |= SymbolRef::SF_Common;
193 // TODO: This are certainly too restrictive.
194 if (Symb->StorageClass == COFF::IMAGE_SYM_CLASS_EXTERNAL)
195 Result |= SymbolRef::SF_Global;
197 if (Symb->StorageClass == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL)
198 Result |= SymbolRef::SF_Weak;
200 if (Symb->SectionNumber == COFF::IMAGE_SYM_ABSOLUTE)
201 Result |= SymbolRef::SF_Absolute;
206 std::error_code COFFObjectFile::getSymbolSize(DataRefImpl Ref,
207 uint64_t &Result) const {
208 // FIXME: Return the correct size. This requires looking at all the symbols
209 // in the same section as this symbol, and looking for either the next
210 // symbol, or the end of the section.
211 const coff_symbol *Symb = toSymb(Ref);
212 const coff_section *Section = nullptr;
213 if (std::error_code EC = getSection(Symb->SectionNumber, Section))
216 if (Symb->SectionNumber == COFF::IMAGE_SYM_UNDEFINED)
217 Result = UnknownAddressOrSize;
219 Result = Section->SizeOfRawData - Symb->Value;
222 return object_error::success;
226 COFFObjectFile::getSymbolSection(DataRefImpl Ref,
227 section_iterator &Result) const {
228 const coff_symbol *Symb = toSymb(Ref);
229 if (COFF::isReservedSectionNumber(Symb->SectionNumber)) {
230 Result = section_end();
232 const coff_section *Sec = nullptr;
233 if (std::error_code EC = getSection(Symb->SectionNumber, Sec))
236 Ref.p = reinterpret_cast<uintptr_t>(Sec);
237 Result = section_iterator(SectionRef(Ref, this));
239 return object_error::success;
242 void COFFObjectFile::moveSectionNext(DataRefImpl &Ref) const {
243 const coff_section *Sec = toSec(Ref);
245 Ref.p = reinterpret_cast<uintptr_t>(Sec);
248 std::error_code COFFObjectFile::getSectionName(DataRefImpl Ref,
249 StringRef &Result) const {
250 const coff_section *Sec = toSec(Ref);
251 return getSectionName(Sec, Result);
254 std::error_code COFFObjectFile::getSectionAddress(DataRefImpl Ref,
255 uint64_t &Result) const {
256 const coff_section *Sec = toSec(Ref);
257 Result = Sec->VirtualAddress;
258 return object_error::success;
261 std::error_code COFFObjectFile::getSectionSize(DataRefImpl Ref,
262 uint64_t &Result) const {
263 const coff_section *Sec = toSec(Ref);
264 Result = Sec->SizeOfRawData;
265 return object_error::success;
268 std::error_code COFFObjectFile::getSectionContents(DataRefImpl Ref,
269 StringRef &Result) const {
270 const coff_section *Sec = toSec(Ref);
271 ArrayRef<uint8_t> Res;
272 std::error_code EC = getSectionContents(Sec, Res);
273 Result = StringRef(reinterpret_cast<const char*>(Res.data()), Res.size());
277 std::error_code COFFObjectFile::getSectionAlignment(DataRefImpl Ref,
278 uint64_t &Res) const {
279 const coff_section *Sec = toSec(Ref);
281 return object_error::parse_failed;
282 Res = uint64_t(1) << (((Sec->Characteristics & 0x00F00000) >> 20) - 1);
283 return object_error::success;
286 std::error_code COFFObjectFile::isSectionText(DataRefImpl Ref,
287 bool &Result) const {
288 const coff_section *Sec = toSec(Ref);
289 Result = Sec->Characteristics & COFF::IMAGE_SCN_CNT_CODE;
290 return object_error::success;
293 std::error_code COFFObjectFile::isSectionData(DataRefImpl Ref,
294 bool &Result) const {
295 const coff_section *Sec = toSec(Ref);
296 Result = Sec->Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA;
297 return object_error::success;
300 std::error_code COFFObjectFile::isSectionBSS(DataRefImpl Ref,
301 bool &Result) const {
302 const coff_section *Sec = toSec(Ref);
303 Result = Sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
304 return object_error::success;
308 COFFObjectFile::isSectionRequiredForExecution(DataRefImpl Ref,
309 bool &Result) const {
310 // FIXME: Unimplemented
312 return object_error::success;
315 std::error_code COFFObjectFile::isSectionVirtual(DataRefImpl Ref,
316 bool &Result) const {
317 const coff_section *Sec = toSec(Ref);
318 Result = Sec->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
319 return object_error::success;
322 std::error_code COFFObjectFile::isSectionZeroInit(DataRefImpl Ref,
323 bool &Result) const {
324 // FIXME: Unimplemented.
326 return object_error::success;
329 std::error_code COFFObjectFile::isSectionReadOnlyData(DataRefImpl Ref,
330 bool &Result) const {
331 // FIXME: Unimplemented.
333 return object_error::success;
336 std::error_code COFFObjectFile::sectionContainsSymbol(DataRefImpl SecRef,
338 bool &Result) const {
339 const coff_section *Sec = toSec(SecRef);
340 const coff_symbol *Symb = toSymb(SymbRef);
341 const coff_section *SymbSec = nullptr;
342 if (std::error_code EC = getSection(Symb->SectionNumber, SymbSec))
348 return object_error::success;
351 relocation_iterator COFFObjectFile::section_rel_begin(DataRefImpl Ref) const {
352 const coff_section *Sec = toSec(Ref);
354 if (Sec->NumberOfRelocations == 0) {
357 auto begin = reinterpret_cast<const coff_relocation*>(
358 base() + Sec->PointerToRelocations);
359 if (Sec->hasExtendedRelocations()) {
360 // Skip the first relocation entry repurposed to store the number of
364 Ret.p = reinterpret_cast<uintptr_t>(begin);
366 return relocation_iterator(RelocationRef(Ret, this));
369 static uint32_t getNumberOfRelocations(const coff_section *Sec,
370 const uint8_t *base) {
371 // The field for the number of relocations in COFF section table is only
372 // 16-bit wide. If a section has more than 65535 relocations, 0xFFFF is set to
373 // NumberOfRelocations field, and the actual relocation count is stored in the
374 // VirtualAddress field in the first relocation entry.
375 if (Sec->hasExtendedRelocations()) {
376 auto *FirstReloc = reinterpret_cast<const coff_relocation*>(
377 base + Sec->PointerToRelocations);
378 return FirstReloc->VirtualAddress;
380 return Sec->NumberOfRelocations;
383 relocation_iterator COFFObjectFile::section_rel_end(DataRefImpl Ref) const {
384 const coff_section *Sec = toSec(Ref);
386 if (Sec->NumberOfRelocations == 0) {
389 auto begin = reinterpret_cast<const coff_relocation*>(
390 base() + Sec->PointerToRelocations);
391 uint32_t NumReloc = getNumberOfRelocations(Sec, base());
392 Ret.p = reinterpret_cast<uintptr_t>(begin + NumReloc);
394 return relocation_iterator(RelocationRef(Ret, this));
397 // Initialize the pointer to the symbol table.
398 std::error_code COFFObjectFile::initSymbolTablePtr() {
399 if (std::error_code EC = getObject(
400 SymbolTable, *Data, base() + COFFHeader->PointerToSymbolTable,
401 COFFHeader->NumberOfSymbols * sizeof(coff_symbol)))
404 // Find string table. The first four byte of the string table contains the
405 // total size of the string table, including the size field itself. If the
406 // string table is empty, the value of the first four byte would be 4.
407 const uint8_t *StringTableAddr =
408 base() + COFFHeader->PointerToSymbolTable +
409 COFFHeader->NumberOfSymbols * sizeof(coff_symbol);
410 const ulittle32_t *StringTableSizePtr;
411 if (std::error_code EC =
412 getObject(StringTableSizePtr, *Data, StringTableAddr))
414 StringTableSize = *StringTableSizePtr;
415 if (std::error_code EC =
416 getObject(StringTable, *Data, StringTableAddr, StringTableSize))
419 // Treat table sizes < 4 as empty because contrary to the PECOFF spec, some
420 // tools like cvtres write a size of 0 for an empty table instead of 4.
421 if (StringTableSize < 4)
424 // Check that the string table is null terminated if has any in it.
425 if (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0)
426 return object_error::parse_failed;
427 return object_error::success;
430 // Returns the file offset for the given VA.
431 std::error_code COFFObjectFile::getVaPtr(uint64_t Addr, uintptr_t &Res) const {
432 uint64_t ImageBase = PE32Header ? (uint64_t)PE32Header->ImageBase
433 : (uint64_t)PE32PlusHeader->ImageBase;
434 uint64_t Rva = Addr - ImageBase;
435 assert(Rva <= UINT32_MAX);
436 return getRvaPtr((uint32_t)Rva, Res);
439 // Returns the file offset for the given RVA.
440 std::error_code COFFObjectFile::getRvaPtr(uint32_t Addr, uintptr_t &Res) const {
441 for (const SectionRef &S : sections()) {
442 const coff_section *Section = getCOFFSection(S);
443 uint32_t SectionStart = Section->VirtualAddress;
444 uint32_t SectionEnd = Section->VirtualAddress + Section->VirtualSize;
445 if (SectionStart <= Addr && Addr < SectionEnd) {
446 uint32_t Offset = Addr - SectionStart;
447 Res = uintptr_t(base()) + Section->PointerToRawData + Offset;
448 return object_error::success;
451 return object_error::parse_failed;
454 // Returns hint and name fields, assuming \p Rva is pointing to a Hint/Name
456 std::error_code COFFObjectFile::getHintName(uint32_t Rva, uint16_t &Hint,
457 StringRef &Name) const {
458 uintptr_t IntPtr = 0;
459 if (std::error_code EC = getRvaPtr(Rva, IntPtr))
461 const uint8_t *Ptr = reinterpret_cast<const uint8_t *>(IntPtr);
462 Hint = *reinterpret_cast<const ulittle16_t *>(Ptr);
463 Name = StringRef(reinterpret_cast<const char *>(Ptr + 2));
464 return object_error::success;
467 // Find the import table.
468 std::error_code COFFObjectFile::initImportTablePtr() {
469 // First, we get the RVA of the import table. If the file lacks a pointer to
470 // the import table, do nothing.
471 const data_directory *DataEntry;
472 if (getDataDirectory(COFF::IMPORT_TABLE, DataEntry))
473 return object_error::success;
475 // Do nothing if the pointer to import table is NULL.
476 if (DataEntry->RelativeVirtualAddress == 0)
477 return object_error::success;
479 uint32_t ImportTableRva = DataEntry->RelativeVirtualAddress;
480 NumberOfImportDirectory = DataEntry->Size /
481 sizeof(import_directory_table_entry);
483 // Find the section that contains the RVA. This is needed because the RVA is
484 // the import table's memory address which is different from its file offset.
485 uintptr_t IntPtr = 0;
486 if (std::error_code EC = getRvaPtr(ImportTableRva, IntPtr))
488 ImportDirectory = reinterpret_cast<
489 const import_directory_table_entry *>(IntPtr);
490 return object_error::success;
493 // Find the export table.
494 std::error_code COFFObjectFile::initExportTablePtr() {
495 // First, we get the RVA of the export table. If the file lacks a pointer to
496 // the export table, do nothing.
497 const data_directory *DataEntry;
498 if (getDataDirectory(COFF::EXPORT_TABLE, DataEntry))
499 return object_error::success;
501 // Do nothing if the pointer to export table is NULL.
502 if (DataEntry->RelativeVirtualAddress == 0)
503 return object_error::success;
505 uint32_t ExportTableRva = DataEntry->RelativeVirtualAddress;
506 uintptr_t IntPtr = 0;
507 if (std::error_code EC = getRvaPtr(ExportTableRva, IntPtr))
510 reinterpret_cast<const export_directory_table_entry *>(IntPtr);
511 return object_error::success;
514 COFFObjectFile::COFFObjectFile(MemoryBuffer *Object, std::error_code &EC)
515 : ObjectFile(Binary::ID_COFF, Object), COFFHeader(nullptr),
516 PE32Header(nullptr), PE32PlusHeader(nullptr), DataDirectory(nullptr),
517 SectionTable(nullptr), SymbolTable(nullptr), StringTable(nullptr),
518 StringTableSize(0), ImportDirectory(nullptr), NumberOfImportDirectory(0),
519 ExportDirectory(nullptr) {
520 // Check that we at least have enough room for a header.
521 if (!checkSize(*Data, EC, sizeof(coff_file_header)))
524 // The current location in the file where we are looking at.
527 // PE header is optional and is present only in executables. If it exists,
528 // it is placed right after COFF header.
529 bool HasPEHeader = false;
531 // Check if this is a PE/COFF file.
532 if (base()[0] == 0x4d && base()[1] == 0x5a) {
533 // PE/COFF, seek through MS-DOS compatibility stub and 4-byte
534 // PE signature to find 'normal' COFF header.
535 if (!checkSize(*Data, EC, 0x3c + 8))
537 CurPtr = *reinterpret_cast<const ulittle16_t *>(base() + 0x3c);
538 // Check the PE magic bytes. ("PE\0\0")
539 if (std::memcmp(base() + CurPtr, "PE\0\0", 4) != 0) {
540 EC = object_error::parse_failed;
543 CurPtr += 4; // Skip the PE magic bytes.
547 if ((EC = getObject(COFFHeader, *Data, base() + CurPtr)))
549 CurPtr += sizeof(coff_file_header);
552 const pe32_header *Header;
553 if ((EC = getObject(Header, *Data, base() + CurPtr)))
556 const uint8_t *DataDirAddr;
557 uint64_t DataDirSize;
558 if (Header->Magic == 0x10b) {
560 DataDirAddr = base() + CurPtr + sizeof(pe32_header);
561 DataDirSize = sizeof(data_directory) * PE32Header->NumberOfRvaAndSize;
562 } else if (Header->Magic == 0x20b) {
563 PE32PlusHeader = reinterpret_cast<const pe32plus_header *>(Header);
564 DataDirAddr = base() + CurPtr + sizeof(pe32plus_header);
565 DataDirSize = sizeof(data_directory) * PE32PlusHeader->NumberOfRvaAndSize;
567 // It's neither PE32 nor PE32+.
568 EC = object_error::parse_failed;
571 if ((EC = getObject(DataDirectory, *Data, DataDirAddr, DataDirSize)))
573 CurPtr += COFFHeader->SizeOfOptionalHeader;
576 if (COFFHeader->isImportLibrary())
579 if ((EC = getObject(SectionTable, *Data, base() + CurPtr,
580 COFFHeader->NumberOfSections * sizeof(coff_section))))
583 // Initialize the pointer to the symbol table.
584 if (COFFHeader->PointerToSymbolTable != 0)
585 if ((EC = initSymbolTablePtr()))
588 // Initialize the pointer to the beginning of the import table.
589 if ((EC = initImportTablePtr()))
592 // Initialize the pointer to the export table.
593 if ((EC = initExportTablePtr()))
596 EC = object_error::success;
599 basic_symbol_iterator COFFObjectFile::symbol_begin_impl() const {
601 Ret.p = reinterpret_cast<uintptr_t>(SymbolTable);
602 return basic_symbol_iterator(SymbolRef(Ret, this));
605 basic_symbol_iterator COFFObjectFile::symbol_end_impl() const {
606 // The symbol table ends where the string table begins.
608 Ret.p = reinterpret_cast<uintptr_t>(StringTable);
609 return basic_symbol_iterator(SymbolRef(Ret, this));
612 library_iterator COFFObjectFile::needed_library_begin() const {
614 report_fatal_error("Libraries needed unimplemented in COFFObjectFile");
617 library_iterator COFFObjectFile::needed_library_end() const {
619 report_fatal_error("Libraries needed unimplemented in COFFObjectFile");
622 StringRef COFFObjectFile::getLoadName() const {
623 // COFF does not have this field.
627 import_directory_iterator COFFObjectFile::import_directory_begin() const {
628 return import_directory_iterator(
629 ImportDirectoryEntryRef(ImportDirectory, 0, this));
632 import_directory_iterator COFFObjectFile::import_directory_end() const {
633 return import_directory_iterator(
634 ImportDirectoryEntryRef(ImportDirectory, NumberOfImportDirectory, this));
637 export_directory_iterator COFFObjectFile::export_directory_begin() const {
638 return export_directory_iterator(
639 ExportDirectoryEntryRef(ExportDirectory, 0, this));
642 export_directory_iterator COFFObjectFile::export_directory_end() const {
643 if (!ExportDirectory)
644 return export_directory_iterator(ExportDirectoryEntryRef(nullptr, 0, this));
645 ExportDirectoryEntryRef Ref(ExportDirectory,
646 ExportDirectory->AddressTableEntries, this);
647 return export_directory_iterator(Ref);
650 section_iterator COFFObjectFile::section_begin() const {
652 Ret.p = reinterpret_cast<uintptr_t>(SectionTable);
653 return section_iterator(SectionRef(Ret, this));
656 section_iterator COFFObjectFile::section_end() const {
658 int NumSections = COFFHeader->isImportLibrary()
659 ? 0 : COFFHeader->NumberOfSections;
660 Ret.p = reinterpret_cast<uintptr_t>(SectionTable + NumSections);
661 return section_iterator(SectionRef(Ret, this));
664 uint8_t COFFObjectFile::getBytesInAddress() const {
665 return getArch() == Triple::x86_64 ? 8 : 4;
668 StringRef COFFObjectFile::getFileFormatName() const {
669 switch(COFFHeader->Machine) {
670 case COFF::IMAGE_FILE_MACHINE_I386:
672 case COFF::IMAGE_FILE_MACHINE_AMD64:
673 return "COFF-x86-64";
674 case COFF::IMAGE_FILE_MACHINE_ARMNT:
677 return "COFF-<unknown arch>";
681 unsigned COFFObjectFile::getArch() const {
682 switch(COFFHeader->Machine) {
683 case COFF::IMAGE_FILE_MACHINE_I386:
685 case COFF::IMAGE_FILE_MACHINE_AMD64:
686 return Triple::x86_64;
687 case COFF::IMAGE_FILE_MACHINE_ARMNT:
688 return Triple::thumb;
690 return Triple::UnknownArch;
694 // This method is kept here because lld uses this. As soon as we make
695 // lld to use getCOFFHeader, this method will be removed.
696 std::error_code COFFObjectFile::getHeader(const coff_file_header *&Res) const {
697 return getCOFFHeader(Res);
701 COFFObjectFile::getCOFFHeader(const coff_file_header *&Res) const {
703 return object_error::success;
706 std::error_code COFFObjectFile::getPE32Header(const pe32_header *&Res) const {
708 return object_error::success;
712 COFFObjectFile::getPE32PlusHeader(const pe32plus_header *&Res) const {
713 Res = PE32PlusHeader;
714 return object_error::success;
718 COFFObjectFile::getDataDirectory(uint32_t Index,
719 const data_directory *&Res) const {
720 // Error if if there's no data directory or the index is out of range.
722 return object_error::parse_failed;
723 assert(PE32Header || PE32PlusHeader);
724 uint32_t NumEnt = PE32Header ? PE32Header->NumberOfRvaAndSize
725 : PE32PlusHeader->NumberOfRvaAndSize;
727 return object_error::parse_failed;
728 Res = &DataDirectory[Index];
729 return object_error::success;
732 std::error_code COFFObjectFile::getSection(int32_t Index,
733 const coff_section *&Result) const {
734 // Check for special index values.
735 if (COFF::isReservedSectionNumber(Index))
737 else if (Index > 0 && Index <= COFFHeader->NumberOfSections)
738 // We already verified the section table data, so no need to check again.
739 Result = SectionTable + (Index - 1);
741 return object_error::parse_failed;
742 return object_error::success;
745 std::error_code COFFObjectFile::getString(uint32_t Offset,
746 StringRef &Result) const {
747 if (StringTableSize <= 4)
748 // Tried to get a string from an empty string table.
749 return object_error::parse_failed;
750 if (Offset >= StringTableSize)
751 return object_error::unexpected_eof;
752 Result = StringRef(StringTable + Offset);
753 return object_error::success;
756 std::error_code COFFObjectFile::getSymbol(uint32_t Index,
757 const coff_symbol *&Result) const {
758 if (Index < COFFHeader->NumberOfSymbols)
759 Result = SymbolTable + Index;
761 return object_error::parse_failed;
762 return object_error::success;
765 std::error_code COFFObjectFile::getSymbolName(const coff_symbol *Symbol,
766 StringRef &Res) const {
767 // Check for string table entry. First 4 bytes are 0.
768 if (Symbol->Name.Offset.Zeroes == 0) {
769 uint32_t Offset = Symbol->Name.Offset.Offset;
770 if (std::error_code EC = getString(Offset, Res))
772 return object_error::success;
775 if (Symbol->Name.ShortName[7] == 0)
776 // Null terminated, let ::strlen figure out the length.
777 Res = StringRef(Symbol->Name.ShortName);
779 // Not null terminated, use all 8 bytes.
780 Res = StringRef(Symbol->Name.ShortName, 8);
781 return object_error::success;
784 ArrayRef<uint8_t> COFFObjectFile::getSymbolAuxData(
785 const coff_symbol *Symbol) const {
786 const uint8_t *Aux = nullptr;
788 if (Symbol->NumberOfAuxSymbols > 0) {
789 // AUX data comes immediately after the symbol in COFF
790 Aux = reinterpret_cast<const uint8_t *>(Symbol + 1);
792 // Verify that the Aux symbol points to a valid entry in the symbol table.
793 uintptr_t Offset = uintptr_t(Aux) - uintptr_t(base());
794 if (Offset < COFFHeader->PointerToSymbolTable
795 || Offset >= COFFHeader->PointerToSymbolTable
796 + (COFFHeader->NumberOfSymbols * sizeof(coff_symbol)))
797 report_fatal_error("Aux Symbol data was outside of symbol table.");
799 assert((Offset - COFFHeader->PointerToSymbolTable) % sizeof(coff_symbol)
800 == 0 && "Aux Symbol data did not point to the beginning of a symbol");
803 return ArrayRef<uint8_t>(Aux,
804 Symbol->NumberOfAuxSymbols * sizeof(coff_symbol));
807 std::error_code COFFObjectFile::getSectionName(const coff_section *Sec,
808 StringRef &Res) const {
810 if (Sec->Name[7] == 0)
811 // Null terminated, let ::strlen figure out the length.
814 // Not null terminated, use all 8 bytes.
815 Name = StringRef(Sec->Name, 8);
817 // Check for string table entry. First byte is '/'.
818 if (Name[0] == '/') {
820 if (Name[1] == '/') {
821 if (decodeBase64StringEntry(Name.substr(2), Offset))
822 return object_error::parse_failed;
824 if (Name.substr(1).getAsInteger(10, Offset))
825 return object_error::parse_failed;
827 if (std::error_code EC = getString(Offset, Name))
832 return object_error::success;
836 COFFObjectFile::getSectionContents(const coff_section *Sec,
837 ArrayRef<uint8_t> &Res) const {
838 // The only thing that we need to verify is that the contents is contained
839 // within the file bounds. We don't need to make sure it doesn't cover other
840 // data, as there's nothing that says that is not allowed.
841 uintptr_t ConStart = uintptr_t(base()) + Sec->PointerToRawData;
842 uintptr_t ConEnd = ConStart + Sec->SizeOfRawData;
843 if (ConEnd > uintptr_t(Data->getBufferEnd()))
844 return object_error::parse_failed;
845 Res = ArrayRef<uint8_t>(reinterpret_cast<const unsigned char*>(ConStart),
847 return object_error::success;
850 const coff_relocation *COFFObjectFile::toRel(DataRefImpl Rel) const {
851 return reinterpret_cast<const coff_relocation*>(Rel.p);
854 void COFFObjectFile::moveRelocationNext(DataRefImpl &Rel) const {
855 Rel.p = reinterpret_cast<uintptr_t>(
856 reinterpret_cast<const coff_relocation*>(Rel.p) + 1);
859 std::error_code COFFObjectFile::getRelocationAddress(DataRefImpl Rel,
860 uint64_t &Res) const {
861 report_fatal_error("getRelocationAddress not implemented in COFFObjectFile");
864 std::error_code COFFObjectFile::getRelocationOffset(DataRefImpl Rel,
865 uint64_t &Res) const {
866 Res = toRel(Rel)->VirtualAddress;
867 return object_error::success;
870 symbol_iterator COFFObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
871 const coff_relocation* R = toRel(Rel);
873 Ref.p = reinterpret_cast<uintptr_t>(SymbolTable + R->SymbolTableIndex);
874 return symbol_iterator(SymbolRef(Ref, this));
877 std::error_code COFFObjectFile::getRelocationType(DataRefImpl Rel,
878 uint64_t &Res) const {
879 const coff_relocation* R = toRel(Rel);
881 return object_error::success;
885 COFFObjectFile::getCOFFSection(const SectionRef &Section) const {
886 return toSec(Section.getRawDataRefImpl());
890 COFFObjectFile::getCOFFSymbol(const SymbolRef &Symbol) const {
891 return toSymb(Symbol.getRawDataRefImpl());
894 const coff_relocation *
895 COFFObjectFile::getCOFFRelocation(const RelocationRef &Reloc) const {
896 return toRel(Reloc.getRawDataRefImpl());
899 #define LLVM_COFF_SWITCH_RELOC_TYPE_NAME(reloc_type) \
900 case COFF::reloc_type: \
905 COFFObjectFile::getRelocationTypeName(DataRefImpl Rel,
906 SmallVectorImpl<char> &Result) const {
907 const coff_relocation *Reloc = toRel(Rel);
909 switch (COFFHeader->Machine) {
910 case COFF::IMAGE_FILE_MACHINE_AMD64:
911 switch (Reloc->Type) {
912 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ABSOLUTE);
913 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR64);
914 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32);
915 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32NB);
916 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32);
917 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_1);
918 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_2);
919 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_3);
920 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_4);
921 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_5);
922 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECTION);
923 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL);
924 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL7);
925 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_TOKEN);
926 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SREL32);
927 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_PAIR);
928 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SSPAN32);
933 case COFF::IMAGE_FILE_MACHINE_ARMNT:
934 switch (Reloc->Type) {
935 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ABSOLUTE);
936 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ADDR32);
937 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ADDR32NB);
938 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH24);
939 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH11);
940 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_TOKEN);
941 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX24);
942 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX11);
943 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_SECTION);
944 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_SECREL);
945 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_MOV32A);
946 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_MOV32T);
947 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH20T);
948 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH24T);
949 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX23T);
954 case COFF::IMAGE_FILE_MACHINE_I386:
955 switch (Reloc->Type) {
956 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_ABSOLUTE);
957 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR16);
958 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL16);
959 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32);
960 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32NB);
961 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SEG12);
962 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECTION);
963 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL);
964 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_TOKEN);
965 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL7);
966 LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL32);
974 Result.append(Res.begin(), Res.end());
975 return object_error::success;
978 #undef LLVM_COFF_SWITCH_RELOC_TYPE_NAME
981 COFFObjectFile::getRelocationValueString(DataRefImpl Rel,
982 SmallVectorImpl<char> &Result) const {
983 const coff_relocation *Reloc = toRel(Rel);
984 const coff_symbol *Symb = nullptr;
985 if (std::error_code EC = getSymbol(Reloc->SymbolTableIndex, Symb))
988 Sym.p = reinterpret_cast<uintptr_t>(Symb);
990 if (std::error_code EC = getSymbolName(Sym, SymName))
992 Result.append(SymName.begin(), SymName.end());
993 return object_error::success;
996 std::error_code COFFObjectFile::getLibraryNext(DataRefImpl LibData,
997 LibraryRef &Result) const {
998 report_fatal_error("getLibraryNext not implemented in COFFObjectFile");
1001 std::error_code COFFObjectFile::getLibraryPath(DataRefImpl LibData,
1002 StringRef &Result) const {
1003 report_fatal_error("getLibraryPath not implemented in COFFObjectFile");
1006 bool ImportDirectoryEntryRef::
1007 operator==(const ImportDirectoryEntryRef &Other) const {
1008 return ImportTable == Other.ImportTable && Index == Other.Index;
1011 void ImportDirectoryEntryRef::moveNext() {
1015 std::error_code ImportDirectoryEntryRef::getImportTableEntry(
1016 const import_directory_table_entry *&Result) const {
1017 Result = ImportTable;
1018 return object_error::success;
1021 std::error_code ImportDirectoryEntryRef::getName(StringRef &Result) const {
1022 uintptr_t IntPtr = 0;
1023 if (std::error_code EC =
1024 OwningObject->getRvaPtr(ImportTable->NameRVA, IntPtr))
1026 Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1027 return object_error::success;
1030 std::error_code ImportDirectoryEntryRef::getImportLookupEntry(
1031 const import_lookup_table_entry32 *&Result) const {
1032 uintptr_t IntPtr = 0;
1033 if (std::error_code EC =
1034 OwningObject->getRvaPtr(ImportTable->ImportLookupTableRVA, IntPtr))
1036 Result = reinterpret_cast<const import_lookup_table_entry32 *>(IntPtr);
1037 return object_error::success;
1040 bool ExportDirectoryEntryRef::
1041 operator==(const ExportDirectoryEntryRef &Other) const {
1042 return ExportTable == Other.ExportTable && Index == Other.Index;
1045 void ExportDirectoryEntryRef::moveNext() {
1049 // Returns the name of the current export symbol. If the symbol is exported only
1050 // by ordinal, the empty string is set as a result.
1051 std::error_code ExportDirectoryEntryRef::getDllName(StringRef &Result) const {
1052 uintptr_t IntPtr = 0;
1053 if (std::error_code EC =
1054 OwningObject->getRvaPtr(ExportTable->NameRVA, IntPtr))
1056 Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1057 return object_error::success;
1060 // Returns the starting ordinal number.
1062 ExportDirectoryEntryRef::getOrdinalBase(uint32_t &Result) const {
1063 Result = ExportTable->OrdinalBase;
1064 return object_error::success;
1067 // Returns the export ordinal of the current export symbol.
1068 std::error_code ExportDirectoryEntryRef::getOrdinal(uint32_t &Result) const {
1069 Result = ExportTable->OrdinalBase + Index;
1070 return object_error::success;
1073 // Returns the address of the current export symbol.
1074 std::error_code ExportDirectoryEntryRef::getExportRVA(uint32_t &Result) const {
1075 uintptr_t IntPtr = 0;
1076 if (std::error_code EC =
1077 OwningObject->getRvaPtr(ExportTable->ExportAddressTableRVA, IntPtr))
1079 const export_address_table_entry *entry =
1080 reinterpret_cast<const export_address_table_entry *>(IntPtr);
1081 Result = entry[Index].ExportRVA;
1082 return object_error::success;
1085 // Returns the name of the current export symbol. If the symbol is exported only
1086 // by ordinal, the empty string is set as a result.
1088 ExportDirectoryEntryRef::getSymbolName(StringRef &Result) const {
1089 uintptr_t IntPtr = 0;
1090 if (std::error_code EC =
1091 OwningObject->getRvaPtr(ExportTable->OrdinalTableRVA, IntPtr))
1093 const ulittle16_t *Start = reinterpret_cast<const ulittle16_t *>(IntPtr);
1095 uint32_t NumEntries = ExportTable->NumberOfNamePointers;
1097 for (const ulittle16_t *I = Start, *E = Start + NumEntries;
1098 I < E; ++I, ++Offset) {
1101 if (std::error_code EC =
1102 OwningObject->getRvaPtr(ExportTable->NamePointerRVA, IntPtr))
1104 const ulittle32_t *NamePtr = reinterpret_cast<const ulittle32_t *>(IntPtr);
1105 if (std::error_code EC = OwningObject->getRvaPtr(NamePtr[Offset], IntPtr))
1107 Result = StringRef(reinterpret_cast<const char *>(IntPtr));
1108 return object_error::success;
1111 return object_error::success;
1114 ErrorOr<ObjectFile *> ObjectFile::createCOFFObjectFile(MemoryBuffer *Object) {
1116 std::unique_ptr<COFFObjectFile> Ret(new COFFObjectFile(Object, EC));
1119 return Ret.release();