1d341c932SEugene Zelenko //===- COFFObjectFile.cpp - COFF object file implementation ---------------===// 28e90adafSMichael J. Spencer // 32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information. 52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 68e90adafSMichael J. Spencer // 78e90adafSMichael J. Spencer //===----------------------------------------------------------------------===// 88e90adafSMichael J. Spencer // 98e90adafSMichael J. Spencer // This file declares the COFFObjectFile class. 108e90adafSMichael J. Spencer // 118e90adafSMichael J. Spencer //===----------------------------------------------------------------------===// 128e90adafSMichael J. Spencer 139da9e693SMichael J. Spencer #include "llvm/ADT/ArrayRef.h" 14d341c932SEugene Zelenko #include "llvm/ADT/StringRef.h" 150ea52537SSimon Pilgrim #include "llvm/ADT/StringSwitch.h" 168e90adafSMichael J. Spencer #include "llvm/ADT/Triple.h" 176a75acb1SRui Ueyama #include "llvm/ADT/iterator_range.h" 18264b5d9eSZachary Turner #include "llvm/BinaryFormat/COFF.h" 19d341c932SEugene Zelenko #include "llvm/Object/Binary.h" 20d341c932SEugene Zelenko #include "llvm/Object/COFF.h" 21d341c932SEugene Zelenko #include "llvm/Object/Error.h" 22d341c932SEugene Zelenko #include "llvm/Object/ObjectFile.h" 23efef15a0SEric Beckmann #include "llvm/Support/BinaryStreamReader.h" 24d341c932SEugene Zelenko #include "llvm/Support/Endian.h" 25d341c932SEugene Zelenko #include "llvm/Support/Error.h" 26d341c932SEugene Zelenko #include "llvm/Support/ErrorHandling.h" 27d341c932SEugene Zelenko #include "llvm/Support/MathExtras.h" 28d341c932SEugene Zelenko #include "llvm/Support/MemoryBuffer.h" 29d341c932SEugene Zelenko #include <algorithm> 30d341c932SEugene Zelenko #include <cassert> 31d341c932SEugene Zelenko #include <cstddef> 32d341c932SEugene Zelenko #include <cstdint> 33d341c932SEugene Zelenko #include <cstring> 349d2c15efSNico Rieck #include <limits> 35d341c932SEugene Zelenko #include <memory> 36d341c932SEugene Zelenko #include <system_error> 378e90adafSMichael J. Spencer 388e90adafSMichael J. Spencer using namespace llvm; 398e90adafSMichael J. Spencer using namespace object; 408e90adafSMichael J. Spencer 418e90adafSMichael J. Spencer using support::ulittle16_t; 428e90adafSMichael J. Spencer using support::ulittle32_t; 43861021f9SRui Ueyama using support::ulittle64_t; 448e90adafSMichael J. Spencer using support::little16_t; 458e90adafSMichael J. Spencer 461d6167fdSMichael J. Spencer // Returns false if size is greater than the buffer size. And sets ec. 4748af1c2aSRafael Espindola static bool checkSize(MemoryBufferRef M, std::error_code &EC, uint64_t Size) { 48c3f9b5a5SRafael Espindola if (M.getBufferSize() < Size) { 498ff24d25SRui Ueyama EC = object_error::unexpected_eof; 501d6167fdSMichael J. Spencer return false; 511d6167fdSMichael J. Spencer } 521d6167fdSMichael J. Spencer return true; 538e90adafSMichael J. Spencer } 548e90adafSMichael J. Spencer 55ed64342bSRui Ueyama // Sets Obj unless any bytes in [addr, addr + size) fall outsize of m. 56ed64342bSRui Ueyama // Returns unexpected_eof if error. 57ed64342bSRui Ueyama template <typename T> 5848af1c2aSRafael Espindola static std::error_code getObject(const T *&Obj, MemoryBufferRef M, 5958323a97SDavid Majnemer const void *Ptr, 60236b0ca7SDavid Majnemer const uint64_t Size = sizeof(T)) { 61ed64342bSRui Ueyama uintptr_t Addr = uintptr_t(Ptr); 62*e03a135bSReid Kleckner if (Error E = Binary::checkOffset(M, Addr, Size)) 63*e03a135bSReid Kleckner return errorToErrorCode(std::move(E)); 64ed64342bSRui Ueyama Obj = reinterpret_cast<const T *>(Addr); 657d099195SRui Ueyama return std::error_code(); 661d6167fdSMichael J. Spencer } 671d6167fdSMichael J. Spencer 689d2c15efSNico Rieck // Decode a string table entry in base 64 (//AAAAAA). Expects \arg Str without 699d2c15efSNico Rieck // prefixed slashes. 709d2c15efSNico Rieck static bool decodeBase64StringEntry(StringRef Str, uint32_t &Result) { 719d2c15efSNico Rieck assert(Str.size() <= 6 && "String too long, possible overflow."); 729d2c15efSNico Rieck if (Str.size() > 6) 739d2c15efSNico Rieck return true; 749d2c15efSNico Rieck 759d2c15efSNico Rieck uint64_t Value = 0; 769d2c15efSNico Rieck while (!Str.empty()) { 779d2c15efSNico Rieck unsigned CharVal; 789d2c15efSNico Rieck if (Str[0] >= 'A' && Str[0] <= 'Z') // 0..25 799d2c15efSNico Rieck CharVal = Str[0] - 'A'; 809d2c15efSNico Rieck else if (Str[0] >= 'a' && Str[0] <= 'z') // 26..51 819d2c15efSNico Rieck CharVal = Str[0] - 'a' + 26; 829d2c15efSNico Rieck else if (Str[0] >= '0' && Str[0] <= '9') // 52..61 839d2c15efSNico Rieck CharVal = Str[0] - '0' + 52; 849d2c15efSNico Rieck else if (Str[0] == '+') // 62 855500b07cSRui Ueyama CharVal = 62; 869d2c15efSNico Rieck else if (Str[0] == '/') // 63 875500b07cSRui Ueyama CharVal = 63; 889d2c15efSNico Rieck else 899d2c15efSNico Rieck return true; 909d2c15efSNico Rieck 919d2c15efSNico Rieck Value = (Value * 64) + CharVal; 929d2c15efSNico Rieck Str = Str.substr(1); 939d2c15efSNico Rieck } 949d2c15efSNico Rieck 959d2c15efSNico Rieck if (Value > std::numeric_limits<uint32_t>::max()) 969d2c15efSNico Rieck return true; 979d2c15efSNico Rieck 989d2c15efSNico Rieck Result = static_cast<uint32_t>(Value); 999d2c15efSNico Rieck return false; 1009d2c15efSNico Rieck } 1019d2c15efSNico Rieck 10244f51e51SDavid Majnemer template <typename coff_symbol_type> 10344f51e51SDavid Majnemer const coff_symbol_type *COFFObjectFile::toSymb(DataRefImpl Ref) const { 10444f51e51SDavid Majnemer const coff_symbol_type *Addr = 10544f51e51SDavid Majnemer reinterpret_cast<const coff_symbol_type *>(Ref.p); 1061d6167fdSMichael J. Spencer 107236b0ca7SDavid Majnemer assert(!checkOffset(Data, uintptr_t(Addr), sizeof(*Addr))); 1081d6167fdSMichael J. Spencer #ifndef NDEBUG 1091d6167fdSMichael J. Spencer // Verify that the symbol points to a valid entry in the symbol table. 1108ff24d25SRui Ueyama uintptr_t Offset = uintptr_t(Addr) - uintptr_t(base()); 1111d6167fdSMichael J. Spencer 11244f51e51SDavid Majnemer assert((Offset - getPointerToSymbolTable()) % sizeof(coff_symbol_type) == 0 && 11344f51e51SDavid Majnemer "Symbol did not point to the beginning of a symbol"); 1141d6167fdSMichael J. Spencer #endif 1151d6167fdSMichael J. Spencer 1168ff24d25SRui Ueyama return Addr; 1171d6167fdSMichael J. Spencer } 1181d6167fdSMichael J. Spencer 1198ff24d25SRui Ueyama const coff_section *COFFObjectFile::toSec(DataRefImpl Ref) const { 1208ff24d25SRui Ueyama const coff_section *Addr = reinterpret_cast<const coff_section*>(Ref.p); 1211d6167fdSMichael J. Spencer 1221d6167fdSMichael J. Spencer #ifndef NDEBUG 1231d6167fdSMichael J. Spencer // Verify that the section points to a valid entry in the section table. 12444f51e51SDavid Majnemer if (Addr < SectionTable || Addr >= (SectionTable + getNumberOfSections())) 1251d6167fdSMichael J. Spencer report_fatal_error("Section was outside of section table."); 1261d6167fdSMichael J. Spencer 1278ff24d25SRui Ueyama uintptr_t Offset = uintptr_t(Addr) - uintptr_t(SectionTable); 1288ff24d25SRui Ueyama assert(Offset % sizeof(coff_section) == 0 && 1291d6167fdSMichael J. Spencer "Section did not point to the beginning of a section"); 1301d6167fdSMichael J. Spencer #endif 1311d6167fdSMichael J. Spencer 1328ff24d25SRui Ueyama return Addr; 1331d6167fdSMichael J. Spencer } 1341d6167fdSMichael J. Spencer 1355e812afaSRafael Espindola void COFFObjectFile::moveSymbolNext(DataRefImpl &Ref) const { 136236b0ca7SDavid Majnemer auto End = reinterpret_cast<uintptr_t>(StringTable); 13744f51e51SDavid Majnemer if (SymbolTable16) { 13844f51e51SDavid Majnemer const coff_symbol16 *Symb = toSymb<coff_symbol16>(Ref); 1398ff24d25SRui Ueyama Symb += 1 + Symb->NumberOfAuxSymbols; 140236b0ca7SDavid Majnemer Ref.p = std::min(reinterpret_cast<uintptr_t>(Symb), End); 14144f51e51SDavid Majnemer } else if (SymbolTable32) { 14244f51e51SDavid Majnemer const coff_symbol32 *Symb = toSymb<coff_symbol32>(Ref); 14344f51e51SDavid Majnemer Symb += 1 + Symb->NumberOfAuxSymbols; 144236b0ca7SDavid Majnemer Ref.p = std::min(reinterpret_cast<uintptr_t>(Symb), End); 14544f51e51SDavid Majnemer } else { 14644f51e51SDavid Majnemer llvm_unreachable("no symbol table pointer!"); 14744f51e51SDavid Majnemer } 1481d6167fdSMichael J. Spencer } 1491d6167fdSMichael J. Spencer 15081e8b7d9SKevin Enderby Expected<StringRef> COFFObjectFile::getSymbolName(DataRefImpl Ref) const { 15177ecf90cSReid Kleckner return getSymbolName(getCOFFSymbol(Ref)); 1528e90adafSMichael J. Spencer } 1538e90adafSMichael J. Spencer 154be8b0ea8SRafael Espindola uint64_t COFFObjectFile::getSymbolValueImpl(DataRefImpl Ref) const { 155be8b0ea8SRafael Espindola return getCOFFSymbol(Ref).getValue(); 156991af666SRafael Espindola } 157991af666SRafael Espindola 1586b2bba14SDavide Italiano uint32_t COFFObjectFile::getSymbolAlignment(DataRefImpl Ref) const { 1596b2bba14SDavide Italiano // MSVC/link.exe seems to align symbols to the next-power-of-2 1606b2bba14SDavide Italiano // up to 32 bytes. 1616b2bba14SDavide Italiano COFFSymbolRef Symb = getCOFFSymbol(Ref); 16203a85680SDavide Italiano return std::min(uint64_t(32), PowerOf2Ceil(Symb.getValue())); 1636b2bba14SDavide Italiano } 1646b2bba14SDavide Italiano 165931cb65dSKevin Enderby Expected<uint64_t> COFFObjectFile::getSymbolAddress(DataRefImpl Ref) const { 166ff6a0b6aSXing GUO uint64_t Result = cantFail(getSymbolValue(Ref)); 16744f51e51SDavid Majnemer COFFSymbolRef Symb = getCOFFSymbol(Ref); 168c7d7c6fbSDavid Majnemer int32_t SectionNumber = Symb.getSectionNumber(); 169991af666SRafael Espindola 170991af666SRafael Espindola if (Symb.isAnyUndefined() || Symb.isCommon() || 171991af666SRafael Espindola COFF::isReservedSectionNumber(SectionNumber)) 172ed067c45SRafael Espindola return Result; 17354c9f3daSRafael Espindola 17477ecf90cSReid Kleckner Expected<const coff_section *> Section = getSection(SectionNumber); 17577ecf90cSReid Kleckner if (!Section) 17677ecf90cSReid Kleckner return Section.takeError(); 17777ecf90cSReid Kleckner Result += (*Section)->VirtualAddress; 17847ea9eceSReid Kleckner 17947ea9eceSReid Kleckner // The section VirtualAddress does not include ImageBase, and we want to 18047ea9eceSReid Kleckner // return virtual addresses. 18121427adaSReid Kleckner Result += getImageBase(); 18247ea9eceSReid Kleckner 183ed067c45SRafael Espindola return Result; 184c7d7c6fbSDavid Majnemer } 185c7d7c6fbSDavid Majnemer 1867bd8d994SKevin Enderby Expected<SymbolRef::Type> COFFObjectFile::getSymbolType(DataRefImpl Ref) const { 18744f51e51SDavid Majnemer COFFSymbolRef Symb = getCOFFSymbol(Ref); 188c7d7c6fbSDavid Majnemer int32_t SectionNumber = Symb.getSectionNumber(); 18944f51e51SDavid Majnemer 190e834f420SPeter Collingbourne if (Symb.getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION) 191e834f420SPeter Collingbourne return SymbolRef::ST_Function; 1922fa80cc5SRafael Espindola if (Symb.isAnyUndefined()) 1932fa80cc5SRafael Espindola return SymbolRef::ST_Unknown; 1942fa80cc5SRafael Espindola if (Symb.isCommon()) 1952fa80cc5SRafael Espindola return SymbolRef::ST_Data; 1962fa80cc5SRafael Espindola if (Symb.isFileRecord()) 1972fa80cc5SRafael Espindola return SymbolRef::ST_File; 1982fa80cc5SRafael Espindola 1991a666e0fSDavid Majnemer // TODO: perhaps we need a new symbol type ST_Section. 2002fa80cc5SRafael Espindola if (SectionNumber == COFF::IMAGE_SYM_DEBUG || Symb.isSectionDefinition()) 2012fa80cc5SRafael Espindola return SymbolRef::ST_Debug; 2022fa80cc5SRafael Espindola 2032fa80cc5SRafael Espindola if (!COFF::isReservedSectionNumber(SectionNumber)) 2042fa80cc5SRafael Espindola return SymbolRef::ST_Data; 2052fa80cc5SRafael Espindola 2062fa80cc5SRafael Espindola return SymbolRef::ST_Other; 20775d1cf33SBenjamin Kramer } 20875d1cf33SBenjamin Kramer 209ac00376aSvgxbj Expected<uint32_t> COFFObjectFile::getSymbolFlags(DataRefImpl Ref) const { 21044f51e51SDavid Majnemer COFFSymbolRef Symb = getCOFFSymbol(Ref); 21120122a43SRafael Espindola uint32_t Result = SymbolRef::SF_None; 21275d1cf33SBenjamin Kramer 213c7d7c6fbSDavid Majnemer if (Symb.isExternal() || Symb.isWeakExternal()) 2149dc0eb42SLang Hames Result |= SymbolRef::SF_Global; 2151df4b84dSDavid Meyer 216a6ffc9c8SMartin Storsjo if (const coff_aux_weak_external *AWE = Symb.getWeakExternal()) { 2171df4b84dSDavid Meyer Result |= SymbolRef::SF_Weak; 218a6ffc9c8SMartin Storsjo if (AWE->Characteristics != COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS) 219a6ffc9c8SMartin Storsjo Result |= SymbolRef::SF_Undefined; 2201079ef8dSMartell Malone } 2211df4b84dSDavid Meyer 22244f51e51SDavid Majnemer if (Symb.getSectionNumber() == COFF::IMAGE_SYM_ABSOLUTE) 2231df4b84dSDavid Meyer Result |= SymbolRef::SF_Absolute; 2241df4b84dSDavid Meyer 225c7d7c6fbSDavid Majnemer if (Symb.isFileRecord()) 226c7d7c6fbSDavid Majnemer Result |= SymbolRef::SF_FormatSpecific; 227c7d7c6fbSDavid Majnemer 228c7d7c6fbSDavid Majnemer if (Symb.isSectionDefinition()) 229c7d7c6fbSDavid Majnemer Result |= SymbolRef::SF_FormatSpecific; 230c7d7c6fbSDavid Majnemer 231c7d7c6fbSDavid Majnemer if (Symb.isCommon()) 232c7d7c6fbSDavid Majnemer Result |= SymbolRef::SF_Common; 233c7d7c6fbSDavid Majnemer 234a6ffc9c8SMartin Storsjo if (Symb.isUndefined()) 235c7d7c6fbSDavid Majnemer Result |= SymbolRef::SF_Undefined; 236c7d7c6fbSDavid Majnemer 23720122a43SRafael Espindola return Result; 23801759754SMichael J. Spencer } 23901759754SMichael J. Spencer 240d7a32ea4SRafael Espindola uint64_t COFFObjectFile::getCommonSymbolSizeImpl(DataRefImpl Ref) const { 241c7d7c6fbSDavid Majnemer COFFSymbolRef Symb = getCOFFSymbol(Ref); 2425eb02e45SRafael Espindola return Symb.getValue(); 2438e90adafSMichael J. Spencer } 2448e90adafSMichael J. Spencer 2457bd8d994SKevin Enderby Expected<section_iterator> 2468bab889bSRafael Espindola COFFObjectFile::getSymbolSection(DataRefImpl Ref) const { 24744f51e51SDavid Majnemer COFFSymbolRef Symb = getCOFFSymbol(Ref); 2488bab889bSRafael Espindola if (COFF::isReservedSectionNumber(Symb.getSectionNumber())) 2498bab889bSRafael Espindola return section_end(); 25077ecf90cSReid Kleckner Expected<const coff_section *> Sec = getSection(Symb.getSectionNumber()); 25177ecf90cSReid Kleckner if (!Sec) 25277ecf90cSReid Kleckner return Sec.takeError(); 2538bab889bSRafael Espindola DataRefImpl Ret; 25477ecf90cSReid Kleckner Ret.p = reinterpret_cast<uintptr_t>(*Sec); 2558bab889bSRafael Espindola return section_iterator(SectionRef(Ret, this)); 25632173153SMichael J. Spencer } 25732173153SMichael J. Spencer 2586bf32210SRafael Espindola unsigned COFFObjectFile::getSymbolSectionID(SymbolRef Sym) const { 2596bf32210SRafael Espindola COFFSymbolRef Symb = getCOFFSymbol(Sym.getRawDataRefImpl()); 2606bf32210SRafael Espindola return Symb.getSectionNumber(); 2616bf32210SRafael Espindola } 2626bf32210SRafael Espindola 2635e812afaSRafael Espindola void COFFObjectFile::moveSectionNext(DataRefImpl &Ref) const { 2648ff24d25SRui Ueyama const coff_section *Sec = toSec(Ref); 2658ff24d25SRui Ueyama Sec += 1; 2668ff24d25SRui Ueyama Ref.p = reinterpret_cast<uintptr_t>(Sec); 2678e90adafSMichael J. Spencer } 2688e90adafSMichael J. Spencer 2698be28cdcSFangrui Song Expected<StringRef> COFFObjectFile::getSectionName(DataRefImpl Ref) const { 2708ff24d25SRui Ueyama const coff_section *Sec = toSec(Ref); 2718be28cdcSFangrui Song return getSectionName(Sec); 2728e90adafSMichael J. Spencer } 2738e90adafSMichael J. Spencer 27480291274SRafael Espindola uint64_t COFFObjectFile::getSectionAddress(DataRefImpl Ref) const { 2758ff24d25SRui Ueyama const coff_section *Sec = toSec(Ref); 2767c6a071bSDavid Majnemer uint64_t Result = Sec->VirtualAddress; 2777c6a071bSDavid Majnemer 2787c6a071bSDavid Majnemer // The section VirtualAddress does not include ImageBase, and we want to 2797c6a071bSDavid Majnemer // return virtual addresses. 28021427adaSReid Kleckner Result += getImageBase(); 2817c6a071bSDavid Majnemer return Result; 2828e90adafSMichael J. Spencer } 2838e90adafSMichael J. Spencer 284a25d329bSGeorge Rimar uint64_t COFFObjectFile::getSectionIndex(DataRefImpl Sec) const { 285a25d329bSGeorge Rimar return toSec(Sec) - SectionTable; 286a25d329bSGeorge Rimar } 287a25d329bSGeorge Rimar 28880291274SRafael Espindola uint64_t COFFObjectFile::getSectionSize(DataRefImpl Ref) const { 289a9ee5c06SDavid Majnemer return getSectionSize(toSec(Ref)); 2908e90adafSMichael J. Spencer } 2918e90adafSMichael J. Spencer 292e1cb2c0fSFangrui Song Expected<ArrayRef<uint8_t>> 293e1cb2c0fSFangrui Song COFFObjectFile::getSectionContents(DataRefImpl Ref) const { 2948ff24d25SRui Ueyama const coff_section *Sec = toSec(Ref); 2959da9e693SMichael J. Spencer ArrayRef<uint8_t> Res; 296e1cb2c0fSFangrui Song if (Error E = getSectionContents(Sec, Res)) 297c55cf4afSBill Wendling return std::move(E); 298e1cb2c0fSFangrui Song return Res; 2998e90adafSMichael J. Spencer } 3008e90adafSMichael J. Spencer 30180291274SRafael Espindola uint64_t COFFObjectFile::getSectionAlignment(DataRefImpl Ref) const { 3028ff24d25SRui Ueyama const coff_section *Sec = toSec(Ref); 303511391feSDavid Majnemer return Sec->getAlignment(); 3047989460aSMichael J. Spencer } 3057989460aSMichael J. Spencer 306401e4e57SGeorge Rimar bool COFFObjectFile::isSectionCompressed(DataRefImpl Sec) const { 307401e4e57SGeorge Rimar return false; 308401e4e57SGeorge Rimar } 309401e4e57SGeorge Rimar 31080291274SRafael Espindola bool COFFObjectFile::isSectionText(DataRefImpl Ref) const { 3118ff24d25SRui Ueyama const coff_section *Sec = toSec(Ref); 31280291274SRafael Espindola return Sec->Characteristics & COFF::IMAGE_SCN_CNT_CODE; 3138e90adafSMichael J. Spencer } 3148e90adafSMichael J. Spencer 31580291274SRafael Espindola bool COFFObjectFile::isSectionData(DataRefImpl Ref) const { 3168ff24d25SRui Ueyama const coff_section *Sec = toSec(Ref); 31780291274SRafael Espindola return Sec->Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA; 318800619f2SMichael J. Spencer } 319800619f2SMichael J. Spencer 32080291274SRafael Espindola bool COFFObjectFile::isSectionBSS(DataRefImpl Ref) const { 3218ff24d25SRui Ueyama const coff_section *Sec = toSec(Ref); 3221a666e0fSDavid Majnemer const uint32_t BssFlags = COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA | 3231a666e0fSDavid Majnemer COFF::IMAGE_SCN_MEM_READ | 3241a666e0fSDavid Majnemer COFF::IMAGE_SCN_MEM_WRITE; 3251a666e0fSDavid Majnemer return (Sec->Characteristics & BssFlags) == BssFlags; 326800619f2SMichael J. Spencer } 327800619f2SMichael J. Spencer 32829d253c4SDjordje Todorovic // The .debug sections are the only debug sections for COFF 32929d253c4SDjordje Todorovic // (\see MCObjectFileInfo.cpp). 33029d253c4SDjordje Todorovic bool COFFObjectFile::isDebugSection(StringRef SectionName) const { 33129d253c4SDjordje Todorovic return SectionName.startswith(".debug"); 33229d253c4SDjordje Todorovic } 33329d253c4SDjordje Todorovic 3346bf32210SRafael Espindola unsigned COFFObjectFile::getSectionID(SectionRef Sec) const { 3356bf32210SRafael Espindola uintptr_t Offset = 3366bf32210SRafael Espindola uintptr_t(Sec.getRawDataRefImpl().p) - uintptr_t(SectionTable); 3376bf32210SRafael Espindola assert((Offset % sizeof(coff_section)) == 0); 3386bf32210SRafael Espindola return (Offset / sizeof(coff_section)) + 1; 3396bf32210SRafael Espindola } 3406bf32210SRafael Espindola 34180291274SRafael Espindola bool COFFObjectFile::isSectionVirtual(DataRefImpl Ref) const { 3428ff24d25SRui Ueyama const coff_section *Sec = toSec(Ref); 3431a666e0fSDavid Majnemer // In COFF, a virtual section won't have any in-file 3441a666e0fSDavid Majnemer // content, so the file pointer to the content will be zero. 3451a666e0fSDavid Majnemer return Sec->PointerToRawData == 0; 3462138ef6dSPreston Gurd } 3472138ef6dSPreston Gurd 348e830c60dSDavid Majnemer static uint32_t getNumberOfRelocations(const coff_section *Sec, 349e830c60dSDavid Majnemer MemoryBufferRef M, const uint8_t *base) { 350e830c60dSDavid Majnemer // The field for the number of relocations in COFF section table is only 351e830c60dSDavid Majnemer // 16-bit wide. If a section has more than 65535 relocations, 0xFFFF is set to 352e830c60dSDavid Majnemer // NumberOfRelocations field, and the actual relocation count is stored in the 353e830c60dSDavid Majnemer // VirtualAddress field in the first relocation entry. 354e830c60dSDavid Majnemer if (Sec->hasExtendedRelocations()) { 355e830c60dSDavid Majnemer const coff_relocation *FirstReloc; 356e830c60dSDavid Majnemer if (getObject(FirstReloc, M, reinterpret_cast<const coff_relocation*>( 357e830c60dSDavid Majnemer base + Sec->PointerToRelocations))) 358e830c60dSDavid Majnemer return 0; 35998fe58a3SRui Ueyama // -1 to exclude this first relocation entry. 36098fe58a3SRui Ueyama return FirstReloc->VirtualAddress - 1; 361e830c60dSDavid Majnemer } 362e830c60dSDavid Majnemer return Sec->NumberOfRelocations; 363e830c60dSDavid Majnemer } 364e830c60dSDavid Majnemer 36594751be7SDavid Majnemer static const coff_relocation * 36694751be7SDavid Majnemer getFirstReloc(const coff_section *Sec, MemoryBufferRef M, const uint8_t *Base) { 36794751be7SDavid Majnemer uint64_t NumRelocs = getNumberOfRelocations(Sec, M, Base); 36894751be7SDavid Majnemer if (!NumRelocs) 36994751be7SDavid Majnemer return nullptr; 370827c8a2bSRui Ueyama auto begin = reinterpret_cast<const coff_relocation *>( 37194751be7SDavid Majnemer Base + Sec->PointerToRelocations); 372827c8a2bSRui Ueyama if (Sec->hasExtendedRelocations()) { 373827c8a2bSRui Ueyama // Skip the first relocation entry repurposed to store the number of 374827c8a2bSRui Ueyama // relocations. 375827c8a2bSRui Ueyama begin++; 376827c8a2bSRui Ueyama } 377*e03a135bSReid Kleckner if (auto E = Binary::checkOffset(M, uintptr_t(begin), 378*e03a135bSReid Kleckner sizeof(coff_relocation) * NumRelocs)) { 379*e03a135bSReid Kleckner consumeError(std::move(E)); 38094751be7SDavid Majnemer return nullptr; 381*e03a135bSReid Kleckner } 38294751be7SDavid Majnemer return begin; 383827c8a2bSRui Ueyama } 38494751be7SDavid Majnemer 38594751be7SDavid Majnemer relocation_iterator COFFObjectFile::section_rel_begin(DataRefImpl Ref) const { 38694751be7SDavid Majnemer const coff_section *Sec = toSec(Ref); 38794751be7SDavid Majnemer const coff_relocation *begin = getFirstReloc(Sec, Data, base()); 38876d650e8SRafael Espindola if (begin && Sec->VirtualAddress != 0) 38976d650e8SRafael Espindola report_fatal_error("Sections with relocations should have an address of 0"); 39094751be7SDavid Majnemer DataRefImpl Ret; 39194751be7SDavid Majnemer Ret.p = reinterpret_cast<uintptr_t>(begin); 3928ff24d25SRui Ueyama return relocation_iterator(RelocationRef(Ret, this)); 393e5fd0047SMichael J. Spencer } 394e5fd0047SMichael J. Spencer 3958ff24d25SRui Ueyama relocation_iterator COFFObjectFile::section_rel_end(DataRefImpl Ref) const { 3968ff24d25SRui Ueyama const coff_section *Sec = toSec(Ref); 39794751be7SDavid Majnemer const coff_relocation *I = getFirstReloc(Sec, Data, base()); 39894751be7SDavid Majnemer if (I) 39994751be7SDavid Majnemer I += getNumberOfRelocations(Sec, Data, base()); 4008ff24d25SRui Ueyama DataRefImpl Ret; 40194751be7SDavid Majnemer Ret.p = reinterpret_cast<uintptr_t>(I); 4028ff24d25SRui Ueyama return relocation_iterator(RelocationRef(Ret, this)); 403e5fd0047SMichael J. Spencer } 404e5fd0047SMichael J. Spencer 405c2bed429SRui Ueyama // Initialize the pointer to the symbol table. 406db4ed0bdSRafael Espindola std::error_code COFFObjectFile::initSymbolTablePtr() { 40744f51e51SDavid Majnemer if (COFFHeader) 408236b0ca7SDavid Majnemer if (std::error_code EC = getObject( 409236b0ca7SDavid Majnemer SymbolTable16, Data, base() + getPointerToSymbolTable(), 410236b0ca7SDavid Majnemer (uint64_t)getNumberOfSymbols() * getSymbolTableEntrySize())) 41144f51e51SDavid Majnemer return EC; 41244f51e51SDavid Majnemer 41344f51e51SDavid Majnemer if (COFFBigObjHeader) 414236b0ca7SDavid Majnemer if (std::error_code EC = getObject( 415236b0ca7SDavid Majnemer SymbolTable32, Data, base() + getPointerToSymbolTable(), 416236b0ca7SDavid Majnemer (uint64_t)getNumberOfSymbols() * getSymbolTableEntrySize())) 4178ff24d25SRui Ueyama return EC; 418c2bed429SRui Ueyama 419c2bed429SRui Ueyama // Find string table. The first four byte of the string table contains the 420c2bed429SRui Ueyama // total size of the string table, including the size field itself. If the 421c2bed429SRui Ueyama // string table is empty, the value of the first four byte would be 4. 422f69b0585SDavid Majnemer uint32_t StringTableOffset = getPointerToSymbolTable() + 42344f51e51SDavid Majnemer getNumberOfSymbols() * getSymbolTableEntrySize(); 424f69b0585SDavid Majnemer const uint8_t *StringTableAddr = base() + StringTableOffset; 425c2bed429SRui Ueyama const ulittle32_t *StringTableSizePtr; 42648af1c2aSRafael Espindola if (std::error_code EC = getObject(StringTableSizePtr, Data, StringTableAddr)) 4278ff24d25SRui Ueyama return EC; 428c2bed429SRui Ueyama StringTableSize = *StringTableSizePtr; 429db4ed0bdSRafael Espindola if (std::error_code EC = 43048af1c2aSRafael Espindola getObject(StringTable, Data, StringTableAddr, StringTableSize)) 4318ff24d25SRui Ueyama return EC; 432c2bed429SRui Ueyama 433773a5795SNico Rieck // Treat table sizes < 4 as empty because contrary to the PECOFF spec, some 434773a5795SNico Rieck // tools like cvtres write a size of 0 for an empty table instead of 4. 435773a5795SNico Rieck if (StringTableSize < 4) 436773a5795SNico Rieck StringTableSize = 4; 437773a5795SNico Rieck 438c2bed429SRui Ueyama // Check that the string table is null terminated if has any in it. 439773a5795SNico Rieck if (StringTableSize > 4 && StringTable[StringTableSize - 1] != 0) 440c2bed429SRui Ueyama return object_error::parse_failed; 4417d099195SRui Ueyama return std::error_code(); 442c2bed429SRui Ueyama } 443c2bed429SRui Ueyama 44421427adaSReid Kleckner uint64_t COFFObjectFile::getImageBase() const { 445e94fef7bSReid Kleckner if (PE32Header) 44621427adaSReid Kleckner return PE32Header->ImageBase; 447e94fef7bSReid Kleckner else if (PE32PlusHeader) 44821427adaSReid Kleckner return PE32PlusHeader->ImageBase; 44921427adaSReid Kleckner // This actually comes up in practice. 45021427adaSReid Kleckner return 0; 451e94fef7bSReid Kleckner } 452e94fef7bSReid Kleckner 453215a586cSRui Ueyama // Returns the file offset for the given VA. 454db4ed0bdSRafael Espindola std::error_code COFFObjectFile::getVaPtr(uint64_t Addr, uintptr_t &Res) const { 45521427adaSReid Kleckner uint64_t ImageBase = getImageBase(); 456b7a40081SRui Ueyama uint64_t Rva = Addr - ImageBase; 457b7a40081SRui Ueyama assert(Rva <= UINT32_MAX); 458b7a40081SRui Ueyama return getRvaPtr((uint32_t)Rva, Res); 459215a586cSRui Ueyama } 460215a586cSRui Ueyama 461c2bed429SRui Ueyama // Returns the file offset for the given RVA. 462db4ed0bdSRafael Espindola std::error_code COFFObjectFile::getRvaPtr(uint32_t Addr, uintptr_t &Res) const { 46327dc8394SAlexey Samsonov for (const SectionRef &S : sections()) { 46427dc8394SAlexey Samsonov const coff_section *Section = getCOFFSection(S); 465c2bed429SRui Ueyama uint32_t SectionStart = Section->VirtualAddress; 466c2bed429SRui Ueyama uint32_t SectionEnd = Section->VirtualAddress + Section->VirtualSize; 467215a586cSRui Ueyama if (SectionStart <= Addr && Addr < SectionEnd) { 468215a586cSRui Ueyama uint32_t Offset = Addr - SectionStart; 469c2bed429SRui Ueyama Res = uintptr_t(base()) + Section->PointerToRawData + Offset; 4707d099195SRui Ueyama return std::error_code(); 471c2bed429SRui Ueyama } 472c2bed429SRui Ueyama } 473c2bed429SRui Ueyama return object_error::parse_failed; 474c2bed429SRui Ueyama } 475c2bed429SRui Ueyama 4762da433eaSReid Kleckner std::error_code 4772da433eaSReid Kleckner COFFObjectFile::getRvaAndSizeAsBytes(uint32_t RVA, uint32_t Size, 4782da433eaSReid Kleckner ArrayRef<uint8_t> &Contents) const { 4792da433eaSReid Kleckner for (const SectionRef &S : sections()) { 4802da433eaSReid Kleckner const coff_section *Section = getCOFFSection(S); 4812da433eaSReid Kleckner uint32_t SectionStart = Section->VirtualAddress; 4822da433eaSReid Kleckner // Check if this RVA is within the section bounds. Be careful about integer 4832da433eaSReid Kleckner // overflow. 4842da433eaSReid Kleckner uint32_t OffsetIntoSection = RVA - SectionStart; 4852da433eaSReid Kleckner if (SectionStart <= RVA && OffsetIntoSection < Section->VirtualSize && 4862da433eaSReid Kleckner Size <= Section->VirtualSize - OffsetIntoSection) { 4872da433eaSReid Kleckner uintptr_t Begin = 4882da433eaSReid Kleckner uintptr_t(base()) + Section->PointerToRawData + OffsetIntoSection; 4892da433eaSReid Kleckner Contents = 4902da433eaSReid Kleckner ArrayRef<uint8_t>(reinterpret_cast<const uint8_t *>(Begin), Size); 4912da433eaSReid Kleckner return std::error_code(); 4922da433eaSReid Kleckner } 4932da433eaSReid Kleckner } 4942da433eaSReid Kleckner return object_error::parse_failed; 4952da433eaSReid Kleckner } 4962da433eaSReid Kleckner 497c2bed429SRui Ueyama // Returns hint and name fields, assuming \p Rva is pointing to a Hint/Name 498c2bed429SRui Ueyama // table entry. 499db4ed0bdSRafael Espindola std::error_code COFFObjectFile::getHintName(uint32_t Rva, uint16_t &Hint, 500db4ed0bdSRafael Espindola StringRef &Name) const { 501c2bed429SRui Ueyama uintptr_t IntPtr = 0; 502db4ed0bdSRafael Espindola if (std::error_code EC = getRvaPtr(Rva, IntPtr)) 5038ff24d25SRui Ueyama return EC; 504c2bed429SRui Ueyama const uint8_t *Ptr = reinterpret_cast<const uint8_t *>(IntPtr); 505c2bed429SRui Ueyama Hint = *reinterpret_cast<const ulittle16_t *>(Ptr); 506c2bed429SRui Ueyama Name = StringRef(reinterpret_cast<const char *>(Ptr + 2)); 5077d099195SRui Ueyama return std::error_code(); 508c2bed429SRui Ueyama } 509c2bed429SRui Ueyama 51001528021SSaleem Abdulrasool std::error_code 51101528021SSaleem Abdulrasool COFFObjectFile::getDebugPDBInfo(const debug_directory *DebugDir, 51201528021SSaleem Abdulrasool const codeview::DebugInfo *&PDBInfo, 5132da433eaSReid Kleckner StringRef &PDBFileName) const { 5142da433eaSReid Kleckner ArrayRef<uint8_t> InfoBytes; 5152da433eaSReid Kleckner if (std::error_code EC = getRvaAndSizeAsBytes( 5162da433eaSReid Kleckner DebugDir->AddressOfRawData, DebugDir->SizeOfData, InfoBytes)) 5172da433eaSReid Kleckner return EC; 51801528021SSaleem Abdulrasool if (InfoBytes.size() < sizeof(*PDBInfo) + 1) 5192da433eaSReid Kleckner return object_error::parse_failed; 52001528021SSaleem Abdulrasool PDBInfo = reinterpret_cast<const codeview::DebugInfo *>(InfoBytes.data()); 52101528021SSaleem Abdulrasool InfoBytes = InfoBytes.drop_front(sizeof(*PDBInfo)); 5222da433eaSReid Kleckner PDBFileName = StringRef(reinterpret_cast<const char *>(InfoBytes.data()), 5232da433eaSReid Kleckner InfoBytes.size()); 5242da433eaSReid Kleckner // Truncate the name at the first null byte. Ignore any padding. 5252da433eaSReid Kleckner PDBFileName = PDBFileName.split('\0').first; 5262da433eaSReid Kleckner return std::error_code(); 5272da433eaSReid Kleckner } 5282da433eaSReid Kleckner 52901528021SSaleem Abdulrasool std::error_code 53001528021SSaleem Abdulrasool COFFObjectFile::getDebugPDBInfo(const codeview::DebugInfo *&PDBInfo, 531f27f3f84SReid Kleckner StringRef &PDBFileName) const { 532f27f3f84SReid Kleckner for (const debug_directory &D : debug_directories()) 533f27f3f84SReid Kleckner if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW) 534f27f3f84SReid Kleckner return getDebugPDBInfo(&D, PDBInfo, PDBFileName); 535f27f3f84SReid Kleckner // If we get here, there is no PDB info to return. 536f27f3f84SReid Kleckner PDBInfo = nullptr; 537f27f3f84SReid Kleckner PDBFileName = StringRef(); 538f27f3f84SReid Kleckner return std::error_code(); 539f27f3f84SReid Kleckner } 540f27f3f84SReid Kleckner 541c2bed429SRui Ueyama // Find the import table. 542db4ed0bdSRafael Espindola std::error_code COFFObjectFile::initImportTablePtr() { 543c2bed429SRui Ueyama // First, we get the RVA of the import table. If the file lacks a pointer to 544c2bed429SRui Ueyama // the import table, do nothing. 545c2bed429SRui Ueyama const data_directory *DataEntry; 546c2bed429SRui Ueyama if (getDataDirectory(COFF::IMPORT_TABLE, DataEntry)) 5477d099195SRui Ueyama return std::error_code(); 548c2bed429SRui Ueyama 549c2bed429SRui Ueyama // Do nothing if the pointer to import table is NULL. 550c2bed429SRui Ueyama if (DataEntry->RelativeVirtualAddress == 0) 5517d099195SRui Ueyama return std::error_code(); 552c2bed429SRui Ueyama 553c2bed429SRui Ueyama uint32_t ImportTableRva = DataEntry->RelativeVirtualAddress; 554c2bed429SRui Ueyama 555c2bed429SRui Ueyama // Find the section that contains the RVA. This is needed because the RVA is 556c2bed429SRui Ueyama // the import table's memory address which is different from its file offset. 557c2bed429SRui Ueyama uintptr_t IntPtr = 0; 558db4ed0bdSRafael Espindola if (std::error_code EC = getRvaPtr(ImportTableRva, IntPtr)) 5598ff24d25SRui Ueyama return EC; 560*e03a135bSReid Kleckner if (Error E = checkOffset(Data, IntPtr, DataEntry->Size)) 561*e03a135bSReid Kleckner return errorToErrorCode(std::move(E)); 562c2bed429SRui Ueyama ImportDirectory = reinterpret_cast< 5631c0aa04eSDavid Majnemer const coff_import_directory_table_entry *>(IntPtr); 5647d099195SRui Ueyama return std::error_code(); 565ad882ba8SRui Ueyama } 566c2bed429SRui Ueyama 56715d99359SRui Ueyama // Initializes DelayImportDirectory and NumberOfDelayImportDirectory. 56815d99359SRui Ueyama std::error_code COFFObjectFile::initDelayImportTablePtr() { 56915d99359SRui Ueyama const data_directory *DataEntry; 57015d99359SRui Ueyama if (getDataDirectory(COFF::DELAY_IMPORT_DESCRIPTOR, DataEntry)) 5717d099195SRui Ueyama return std::error_code(); 57215d99359SRui Ueyama if (DataEntry->RelativeVirtualAddress == 0) 5737d099195SRui Ueyama return std::error_code(); 57415d99359SRui Ueyama 57515d99359SRui Ueyama uint32_t RVA = DataEntry->RelativeVirtualAddress; 57615d99359SRui Ueyama NumberOfDelayImportDirectory = DataEntry->Size / 57715d99359SRui Ueyama sizeof(delay_import_directory_table_entry) - 1; 57815d99359SRui Ueyama 57915d99359SRui Ueyama uintptr_t IntPtr = 0; 58015d99359SRui Ueyama if (std::error_code EC = getRvaPtr(RVA, IntPtr)) 58115d99359SRui Ueyama return EC; 58215d99359SRui Ueyama DelayImportDirectory = reinterpret_cast< 58315d99359SRui Ueyama const delay_import_directory_table_entry *>(IntPtr); 5847d099195SRui Ueyama return std::error_code(); 58515d99359SRui Ueyama } 58615d99359SRui Ueyama 587ad882ba8SRui Ueyama // Find the export table. 588db4ed0bdSRafael Espindola std::error_code COFFObjectFile::initExportTablePtr() { 589ad882ba8SRui Ueyama // First, we get the RVA of the export table. If the file lacks a pointer to 590ad882ba8SRui Ueyama // the export table, do nothing. 591ad882ba8SRui Ueyama const data_directory *DataEntry; 592ad882ba8SRui Ueyama if (getDataDirectory(COFF::EXPORT_TABLE, DataEntry)) 5937d099195SRui Ueyama return std::error_code(); 594ad882ba8SRui Ueyama 595ad882ba8SRui Ueyama // Do nothing if the pointer to export table is NULL. 596ad882ba8SRui Ueyama if (DataEntry->RelativeVirtualAddress == 0) 5977d099195SRui Ueyama return std::error_code(); 598ad882ba8SRui Ueyama 599ad882ba8SRui Ueyama uint32_t ExportTableRva = DataEntry->RelativeVirtualAddress; 600ad882ba8SRui Ueyama uintptr_t IntPtr = 0; 601db4ed0bdSRafael Espindola if (std::error_code EC = getRvaPtr(ExportTableRva, IntPtr)) 602ad882ba8SRui Ueyama return EC; 60324fc2d64SRui Ueyama ExportDirectory = 60424fc2d64SRui Ueyama reinterpret_cast<const export_directory_table_entry *>(IntPtr); 6057d099195SRui Ueyama return std::error_code(); 606c2bed429SRui Ueyama } 607c2bed429SRui Ueyama 60874e85130SRui Ueyama std::error_code COFFObjectFile::initBaseRelocPtr() { 60974e85130SRui Ueyama const data_directory *DataEntry; 61074e85130SRui Ueyama if (getDataDirectory(COFF::BASE_RELOCATION_TABLE, DataEntry)) 6117d099195SRui Ueyama return std::error_code(); 61274e85130SRui Ueyama if (DataEntry->RelativeVirtualAddress == 0) 6137d099195SRui Ueyama return std::error_code(); 61474e85130SRui Ueyama 61574e85130SRui Ueyama uintptr_t IntPtr = 0; 61674e85130SRui Ueyama if (std::error_code EC = getRvaPtr(DataEntry->RelativeVirtualAddress, IntPtr)) 61774e85130SRui Ueyama return EC; 61874e85130SRui Ueyama BaseRelocHeader = reinterpret_cast<const coff_base_reloc_block_header *>( 61974e85130SRui Ueyama IntPtr); 62074e85130SRui Ueyama BaseRelocEnd = reinterpret_cast<coff_base_reloc_block_header *>( 62174e85130SRui Ueyama IntPtr + DataEntry->Size); 622893c6469SNico Weber // FIXME: Verify the section containing BaseRelocHeader has at least 623893c6469SNico Weber // DataEntry->Size bytes after DataEntry->RelativeVirtualAddress. 6247d099195SRui Ueyama return std::error_code(); 62574e85130SRui Ueyama } 62674e85130SRui Ueyama 6272da433eaSReid Kleckner std::error_code COFFObjectFile::initDebugDirectoryPtr() { 6282da433eaSReid Kleckner // Get the RVA of the debug directory. Do nothing if it does not exist. 6292da433eaSReid Kleckner const data_directory *DataEntry; 6302da433eaSReid Kleckner if (getDataDirectory(COFF::DEBUG_DIRECTORY, DataEntry)) 6312da433eaSReid Kleckner return std::error_code(); 6322da433eaSReid Kleckner 6332da433eaSReid Kleckner // Do nothing if the RVA is NULL. 6342da433eaSReid Kleckner if (DataEntry->RelativeVirtualAddress == 0) 6352da433eaSReid Kleckner return std::error_code(); 6362da433eaSReid Kleckner 6372da433eaSReid Kleckner // Check that the size is a multiple of the entry size. 6382da433eaSReid Kleckner if (DataEntry->Size % sizeof(debug_directory) != 0) 6392da433eaSReid Kleckner return object_error::parse_failed; 6402da433eaSReid Kleckner 6412da433eaSReid Kleckner uintptr_t IntPtr = 0; 6422da433eaSReid Kleckner if (std::error_code EC = getRvaPtr(DataEntry->RelativeVirtualAddress, IntPtr)) 6432da433eaSReid Kleckner return EC; 6442da433eaSReid Kleckner DebugDirectoryBegin = reinterpret_cast<const debug_directory *>(IntPtr); 645893c6469SNico Weber DebugDirectoryEnd = reinterpret_cast<const debug_directory *>( 646893c6469SNico Weber IntPtr + DataEntry->Size); 647893c6469SNico Weber // FIXME: Verify the section containing DebugDirectoryBegin has at least 648893c6469SNico Weber // DataEntry->Size bytes after DataEntry->RelativeVirtualAddress. 6492da433eaSReid Kleckner return std::error_code(); 6502da433eaSReid Kleckner } 6512da433eaSReid Kleckner 652b7d716c0SReid Kleckner std::error_code COFFObjectFile::initLoadConfigPtr() { 653b7d716c0SReid Kleckner // Get the RVA of the debug directory. Do nothing if it does not exist. 654b7d716c0SReid Kleckner const data_directory *DataEntry; 655b7d716c0SReid Kleckner if (getDataDirectory(COFF::LOAD_CONFIG_TABLE, DataEntry)) 656b7d716c0SReid Kleckner return std::error_code(); 657b7d716c0SReid Kleckner 658b7d716c0SReid Kleckner // Do nothing if the RVA is NULL. 659b7d716c0SReid Kleckner if (DataEntry->RelativeVirtualAddress == 0) 660b7d716c0SReid Kleckner return std::error_code(); 661b7d716c0SReid Kleckner uintptr_t IntPtr = 0; 662b7d716c0SReid Kleckner if (std::error_code EC = getRvaPtr(DataEntry->RelativeVirtualAddress, IntPtr)) 663b7d716c0SReid Kleckner return EC; 664b7d716c0SReid Kleckner 665b7d716c0SReid Kleckner LoadConfig = (const void *)IntPtr; 666b7d716c0SReid Kleckner return std::error_code(); 667b7d716c0SReid Kleckner } 668b7d716c0SReid Kleckner 66939772063SReid Kleckner Expected<std::unique_ptr<COFFObjectFile>> 67039772063SReid Kleckner COFFObjectFile::create(MemoryBufferRef Object) { 67139772063SReid Kleckner std::unique_ptr<COFFObjectFile> Obj(new COFFObjectFile(std::move(Object))); 67239772063SReid Kleckner if (Error E = Obj->initialize()) 67339772063SReid Kleckner return std::move(E); 67439772063SReid Kleckner return std::move(Obj); 67539772063SReid Kleckner } 67639772063SReid Kleckner 67739772063SReid Kleckner COFFObjectFile::COFFObjectFile(MemoryBufferRef Object) 67848af1c2aSRafael Espindola : ObjectFile(Binary::ID_COFF, Object), COFFHeader(nullptr), 67944f51e51SDavid Majnemer COFFBigObjHeader(nullptr), PE32Header(nullptr), PE32PlusHeader(nullptr), 68044f51e51SDavid Majnemer DataDirectory(nullptr), SectionTable(nullptr), SymbolTable16(nullptr), 68144f51e51SDavid Majnemer SymbolTable32(nullptr), StringTable(nullptr), StringTableSize(0), 68239772063SReid Kleckner ImportDirectory(nullptr), DelayImportDirectory(nullptr), 68339772063SReid Kleckner NumberOfDelayImportDirectory(0), ExportDirectory(nullptr), 68439772063SReid Kleckner BaseRelocHeader(nullptr), BaseRelocEnd(nullptr), 68539772063SReid Kleckner DebugDirectoryBegin(nullptr), DebugDirectoryEnd(nullptr) {} 68639772063SReid Kleckner 68739772063SReid Kleckner Error COFFObjectFile::initialize() { 6881d6167fdSMichael J. Spencer // Check that we at least have enough room for a header. 68939772063SReid Kleckner std::error_code EC; 69048af1c2aSRafael Espindola if (!checkSize(Data, EC, sizeof(coff_file_header))) 69139772063SReid Kleckner return errorCodeToError(EC); 692ee066fc4SEric Christopher 69382ebd8e3SRui Ueyama // The current location in the file where we are looking at. 69482ebd8e3SRui Ueyama uint64_t CurPtr = 0; 69582ebd8e3SRui Ueyama 69682ebd8e3SRui Ueyama // PE header is optional and is present only in executables. If it exists, 69782ebd8e3SRui Ueyama // it is placed right after COFF header. 6988ff24d25SRui Ueyama bool HasPEHeader = false; 699ee066fc4SEric Christopher 7001d6167fdSMichael J. Spencer // Check if this is a PE/COFF file. 70150267222SDavid Majnemer if (checkSize(Data, EC, sizeof(dos_header) + sizeof(COFF::PEMagic))) { 702ee066fc4SEric Christopher // PE/COFF, seek through MS-DOS compatibility stub and 4-byte 703ee066fc4SEric Christopher // PE signature to find 'normal' COFF header. 70450267222SDavid Majnemer const auto *DH = reinterpret_cast<const dos_header *>(base()); 70550267222SDavid Majnemer if (DH->Magic[0] == 'M' && DH->Magic[1] == 'Z') { 70650267222SDavid Majnemer CurPtr = DH->AddressOfNewExeHeader; 70782ebd8e3SRui Ueyama // Check the PE magic bytes. ("PE\0\0") 70850267222SDavid Majnemer if (memcmp(base() + CurPtr, COFF::PEMagic, sizeof(COFF::PEMagic)) != 0) { 70939772063SReid Kleckner return errorCodeToError(object_error::parse_failed); 7101d6167fdSMichael J. Spencer } 71144f51e51SDavid Majnemer CurPtr += sizeof(COFF::PEMagic); // Skip the PE magic bytes. 7128ff24d25SRui Ueyama HasPEHeader = true; 713ee066fc4SEric Christopher } 71450267222SDavid Majnemer } 715ee066fc4SEric Christopher 71648af1c2aSRafael Espindola if ((EC = getObject(COFFHeader, Data, base() + CurPtr))) 71739772063SReid Kleckner return errorCodeToError(EC); 71844f51e51SDavid Majnemer 71944f51e51SDavid Majnemer // It might be a bigobj file, let's check. Note that COFF bigobj and COFF 72044f51e51SDavid Majnemer // import libraries share a common prefix but bigobj is more restrictive. 72144f51e51SDavid Majnemer if (!HasPEHeader && COFFHeader->Machine == COFF::IMAGE_FILE_MACHINE_UNKNOWN && 72244f51e51SDavid Majnemer COFFHeader->NumberOfSections == uint16_t(0xffff) && 72344f51e51SDavid Majnemer checkSize(Data, EC, sizeof(coff_bigobj_file_header))) { 72444f51e51SDavid Majnemer if ((EC = getObject(COFFBigObjHeader, Data, base() + CurPtr))) 72539772063SReid Kleckner return errorCodeToError(EC); 72644f51e51SDavid Majnemer 72744f51e51SDavid Majnemer // Verify that we are dealing with bigobj. 72844f51e51SDavid Majnemer if (COFFBigObjHeader->Version >= COFF::BigObjHeader::MinBigObjectVersion && 72944f51e51SDavid Majnemer std::memcmp(COFFBigObjHeader->UUID, COFF::BigObjMagic, 73044f51e51SDavid Majnemer sizeof(COFF::BigObjMagic)) == 0) { 73144f51e51SDavid Majnemer COFFHeader = nullptr; 73244f51e51SDavid Majnemer CurPtr += sizeof(coff_bigobj_file_header); 73344f51e51SDavid Majnemer } else { 73444f51e51SDavid Majnemer // It's not a bigobj. 73544f51e51SDavid Majnemer COFFBigObjHeader = nullptr; 73644f51e51SDavid Majnemer } 73744f51e51SDavid Majnemer } 73844f51e51SDavid Majnemer if (COFFHeader) { 73944f51e51SDavid Majnemer // The prior checkSize call may have failed. This isn't a hard error 74044f51e51SDavid Majnemer // because we were just trying to sniff out bigobj. 7417d099195SRui Ueyama EC = std::error_code(); 74282ebd8e3SRui Ueyama CurPtr += sizeof(coff_file_header); 74382ebd8e3SRui Ueyama 74444f51e51SDavid Majnemer if (COFFHeader->isImportLibrary()) 74539772063SReid Kleckner return errorCodeToError(EC); 74644f51e51SDavid Majnemer } 74744f51e51SDavid Majnemer 7488ff24d25SRui Ueyama if (HasPEHeader) { 74910ed9ddcSRui Ueyama const pe32_header *Header; 75048af1c2aSRafael Espindola if ((EC = getObject(Header, Data, base() + CurPtr))) 75139772063SReid Kleckner return errorCodeToError(EC); 75210ed9ddcSRui Ueyama 75310ed9ddcSRui Ueyama const uint8_t *DataDirAddr; 75410ed9ddcSRui Ueyama uint64_t DataDirSize; 75550267222SDavid Majnemer if (Header->Magic == COFF::PE32Header::PE32) { 75610ed9ddcSRui Ueyama PE32Header = Header; 75710ed9ddcSRui Ueyama DataDirAddr = base() + CurPtr + sizeof(pe32_header); 75810ed9ddcSRui Ueyama DataDirSize = sizeof(data_directory) * PE32Header->NumberOfRvaAndSize; 75950267222SDavid Majnemer } else if (Header->Magic == COFF::PE32Header::PE32_PLUS) { 76010ed9ddcSRui Ueyama PE32PlusHeader = reinterpret_cast<const pe32plus_header *>(Header); 76110ed9ddcSRui Ueyama DataDirAddr = base() + CurPtr + sizeof(pe32plus_header); 76210ed9ddcSRui Ueyama DataDirSize = sizeof(data_directory) * PE32PlusHeader->NumberOfRvaAndSize; 76310ed9ddcSRui Ueyama } else { 76410ed9ddcSRui Ueyama // It's neither PE32 nor PE32+. 76539772063SReid Kleckner return errorCodeToError(object_error::parse_failed); 766ed64342bSRui Ueyama } 76748af1c2aSRafael Espindola if ((EC = getObject(DataDirectory, Data, DataDirAddr, DataDirSize))) 76839772063SReid Kleckner return errorCodeToError(EC); 769f53c8cb4SRui Ueyama } 770776c6828SRui Ueyama 7718950a538SRui Ueyama if (COFFHeader) 7728950a538SRui Ueyama CurPtr += COFFHeader->SizeOfOptionalHeader; 7738950a538SRui Ueyama 77448af1c2aSRafael Espindola if ((EC = getObject(SectionTable, Data, base() + CurPtr, 775236b0ca7SDavid Majnemer (uint64_t)getNumberOfSections() * sizeof(coff_section)))) 77639772063SReid Kleckner return errorCodeToError(EC); 7771d6167fdSMichael J. Spencer 778c2bed429SRui Ueyama // Initialize the pointer to the symbol table. 779236b0ca7SDavid Majnemer if (getPointerToSymbolTable() != 0) { 780ac8cfab5SDavid Majnemer if ((EC = initSymbolTablePtr())) { 781ac8cfab5SDavid Majnemer SymbolTable16 = nullptr; 782ac8cfab5SDavid Majnemer SymbolTable32 = nullptr; 783ac8cfab5SDavid Majnemer StringTable = nullptr; 784ac8cfab5SDavid Majnemer StringTableSize = 0; 785ac8cfab5SDavid Majnemer } 786236b0ca7SDavid Majnemer } else { 787236b0ca7SDavid Majnemer // We had better not have any symbols if we don't have a symbol table. 788236b0ca7SDavid Majnemer if (getNumberOfSymbols() != 0) { 78939772063SReid Kleckner return errorCodeToError(object_error::parse_failed); 790236b0ca7SDavid Majnemer } 791236b0ca7SDavid Majnemer } 7928e90adafSMichael J. Spencer 793c2bed429SRui Ueyama // Initialize the pointer to the beginning of the import table. 7948ff24d25SRui Ueyama if ((EC = initImportTablePtr())) 79539772063SReid Kleckner return errorCodeToError(EC); 79615d99359SRui Ueyama if ((EC = initDelayImportTablePtr())) 79739772063SReid Kleckner return errorCodeToError(EC); 7981d6167fdSMichael J. Spencer 799ad882ba8SRui Ueyama // Initialize the pointer to the export table. 8008ff24d25SRui Ueyama if ((EC = initExportTablePtr())) 80139772063SReid Kleckner return errorCodeToError(EC); 802ad882ba8SRui Ueyama 80374e85130SRui Ueyama // Initialize the pointer to the base relocation table. 80474e85130SRui Ueyama if ((EC = initBaseRelocPtr())) 80539772063SReid Kleckner return errorCodeToError(EC); 80674e85130SRui Ueyama 8072da433eaSReid Kleckner // Initialize the pointer to the export table. 8082da433eaSReid Kleckner if ((EC = initDebugDirectoryPtr())) 80939772063SReid Kleckner return errorCodeToError(EC); 8102da433eaSReid Kleckner 811b7d716c0SReid Kleckner if ((EC = initLoadConfigPtr())) 81239772063SReid Kleckner return errorCodeToError(EC); 813b7d716c0SReid Kleckner 81439772063SReid Kleckner return Error::success(); 8158e90adafSMichael J. Spencer } 8168e90adafSMichael J. Spencer 817435890a4SPeter Collingbourne basic_symbol_iterator COFFObjectFile::symbol_begin() const { 8188ff24d25SRui Ueyama DataRefImpl Ret; 81944f51e51SDavid Majnemer Ret.p = getSymbolTable(); 820f12b8282SRafael Espindola return basic_symbol_iterator(SymbolRef(Ret, this)); 8218e90adafSMichael J. Spencer } 8228e90adafSMichael J. Spencer 823435890a4SPeter Collingbourne basic_symbol_iterator COFFObjectFile::symbol_end() const { 8248e90adafSMichael J. Spencer // The symbol table ends where the string table begins. 8258ff24d25SRui Ueyama DataRefImpl Ret; 8268ff24d25SRui Ueyama Ret.p = reinterpret_cast<uintptr_t>(StringTable); 827f12b8282SRafael Espindola return basic_symbol_iterator(SymbolRef(Ret, this)); 8288e90adafSMichael J. Spencer } 8298e90adafSMichael J. Spencer 830bc654b18SRui Ueyama import_directory_iterator COFFObjectFile::import_directory_begin() const { 831ad7b7e73SDavid Majnemer if (!ImportDirectory) 832ad7b7e73SDavid Majnemer return import_directory_end(); 8331c0aa04eSDavid Majnemer if (ImportDirectory->isNull()) 834ad7b7e73SDavid Majnemer return import_directory_end(); 835a045b73aSRui Ueyama return import_directory_iterator( 836a045b73aSRui Ueyama ImportDirectoryEntryRef(ImportDirectory, 0, this)); 837c2bed429SRui Ueyama } 838c2bed429SRui Ueyama 839bc654b18SRui Ueyama import_directory_iterator COFFObjectFile::import_directory_end() const { 840a045b73aSRui Ueyama return import_directory_iterator( 841ad7b7e73SDavid Majnemer ImportDirectoryEntryRef(nullptr, -1, this)); 842c2bed429SRui Ueyama } 843c429b80dSDavid Meyer 84415d99359SRui Ueyama delay_import_directory_iterator 84515d99359SRui Ueyama COFFObjectFile::delay_import_directory_begin() const { 84615d99359SRui Ueyama return delay_import_directory_iterator( 84715d99359SRui Ueyama DelayImportDirectoryEntryRef(DelayImportDirectory, 0, this)); 84815d99359SRui Ueyama } 84915d99359SRui Ueyama 85015d99359SRui Ueyama delay_import_directory_iterator 85115d99359SRui Ueyama COFFObjectFile::delay_import_directory_end() const { 85215d99359SRui Ueyama return delay_import_directory_iterator( 85315d99359SRui Ueyama DelayImportDirectoryEntryRef( 85415d99359SRui Ueyama DelayImportDirectory, NumberOfDelayImportDirectory, this)); 85515d99359SRui Ueyama } 85615d99359SRui Ueyama 857ad882ba8SRui Ueyama export_directory_iterator COFFObjectFile::export_directory_begin() const { 858ad882ba8SRui Ueyama return export_directory_iterator( 859ad882ba8SRui Ueyama ExportDirectoryEntryRef(ExportDirectory, 0, this)); 860ad882ba8SRui Ueyama } 861ad882ba8SRui Ueyama 862ad882ba8SRui Ueyama export_directory_iterator COFFObjectFile::export_directory_end() const { 8632617dcceSCraig Topper if (!ExportDirectory) 8642617dcceSCraig Topper return export_directory_iterator(ExportDirectoryEntryRef(nullptr, 0, this)); 8658ff24d25SRui Ueyama ExportDirectoryEntryRef Ref(ExportDirectory, 866ad882ba8SRui Ueyama ExportDirectory->AddressTableEntries, this); 8678ff24d25SRui Ueyama return export_directory_iterator(Ref); 868ad882ba8SRui Ueyama } 869ad882ba8SRui Ueyama 870b5155a57SRafael Espindola section_iterator COFFObjectFile::section_begin() const { 8718ff24d25SRui Ueyama DataRefImpl Ret; 8728ff24d25SRui Ueyama Ret.p = reinterpret_cast<uintptr_t>(SectionTable); 8738ff24d25SRui Ueyama return section_iterator(SectionRef(Ret, this)); 8748e90adafSMichael J. Spencer } 8758e90adafSMichael J. Spencer 876b5155a57SRafael Espindola section_iterator COFFObjectFile::section_end() const { 8778ff24d25SRui Ueyama DataRefImpl Ret; 87844f51e51SDavid Majnemer int NumSections = 87944f51e51SDavid Majnemer COFFHeader && COFFHeader->isImportLibrary() ? 0 : getNumberOfSections(); 8808ff24d25SRui Ueyama Ret.p = reinterpret_cast<uintptr_t>(SectionTable + NumSections); 8818ff24d25SRui Ueyama return section_iterator(SectionRef(Ret, this)); 8828e90adafSMichael J. Spencer } 8838e90adafSMichael J. Spencer 88474e85130SRui Ueyama base_reloc_iterator COFFObjectFile::base_reloc_begin() const { 88574e85130SRui Ueyama return base_reloc_iterator(BaseRelocRef(BaseRelocHeader, this)); 88674e85130SRui Ueyama } 88774e85130SRui Ueyama 88874e85130SRui Ueyama base_reloc_iterator COFFObjectFile::base_reloc_end() const { 88974e85130SRui Ueyama return base_reloc_iterator(BaseRelocRef(BaseRelocEnd, this)); 89074e85130SRui Ueyama } 89174e85130SRui Ueyama 8928e90adafSMichael J. Spencer uint8_t COFFObjectFile::getBytesInAddress() const { 89343c85453SMartin Storsjo return getArch() == Triple::x86_64 || getArch() == Triple::aarch64 ? 8 : 4; 8948e90adafSMichael J. Spencer } 8958e90adafSMichael J. Spencer 8968e90adafSMichael J. Spencer StringRef COFFObjectFile::getFileFormatName() const { 89744f51e51SDavid Majnemer switch(getMachine()) { 8988e90adafSMichael J. Spencer case COFF::IMAGE_FILE_MACHINE_I386: 8998e90adafSMichael J. Spencer return "COFF-i386"; 9008e90adafSMichael J. Spencer case COFF::IMAGE_FILE_MACHINE_AMD64: 9018e90adafSMichael J. Spencer return "COFF-x86-64"; 9029b7c0af2SSaleem Abdulrasool case COFF::IMAGE_FILE_MACHINE_ARMNT: 9039b7c0af2SSaleem Abdulrasool return "COFF-ARM"; 9041eff5c9cSMartell Malone case COFF::IMAGE_FILE_MACHINE_ARM64: 9051eff5c9cSMartell Malone return "COFF-ARM64"; 9068e90adafSMichael J. Spencer default: 9078e90adafSMichael J. Spencer return "COFF-<unknown arch>"; 9088e90adafSMichael J. Spencer } 9098e90adafSMichael J. Spencer } 9108e90adafSMichael J. Spencer 911260fe3ecSZachary Turner Triple::ArchType COFFObjectFile::getArch() const { 91244f51e51SDavid Majnemer switch (getMachine()) { 9138e90adafSMichael J. Spencer case COFF::IMAGE_FILE_MACHINE_I386: 9148e90adafSMichael J. Spencer return Triple::x86; 9158e90adafSMichael J. Spencer case COFF::IMAGE_FILE_MACHINE_AMD64: 9168e90adafSMichael J. Spencer return Triple::x86_64; 9179b7c0af2SSaleem Abdulrasool case COFF::IMAGE_FILE_MACHINE_ARMNT: 9189b7c0af2SSaleem Abdulrasool return Triple::thumb; 9191eff5c9cSMartell Malone case COFF::IMAGE_FILE_MACHINE_ARM64: 9201eff5c9cSMartell Malone return Triple::aarch64; 9218e90adafSMichael J. Spencer default: 9228e90adafSMichael J. Spencer return Triple::UnknownArch; 9238e90adafSMichael J. Spencer } 9248e90adafSMichael J. Spencer } 9258e90adafSMichael J. Spencer 926d2af4d6fSPaul Semel Expected<uint64_t> COFFObjectFile::getStartAddress() const { 927d2af4d6fSPaul Semel if (PE32Header) 928d2af4d6fSPaul Semel return PE32Header->AddressOfEntryPoint; 929d2af4d6fSPaul Semel return 0; 930d2af4d6fSPaul Semel } 931d2af4d6fSPaul Semel 932979fb40bSRui Ueyama iterator_range<import_directory_iterator> 933979fb40bSRui Ueyama COFFObjectFile::import_directories() const { 934979fb40bSRui Ueyama return make_range(import_directory_begin(), import_directory_end()); 935979fb40bSRui Ueyama } 936979fb40bSRui Ueyama 937979fb40bSRui Ueyama iterator_range<delay_import_directory_iterator> 938979fb40bSRui Ueyama COFFObjectFile::delay_import_directories() const { 939979fb40bSRui Ueyama return make_range(delay_import_directory_begin(), 940979fb40bSRui Ueyama delay_import_directory_end()); 941979fb40bSRui Ueyama } 942979fb40bSRui Ueyama 943979fb40bSRui Ueyama iterator_range<export_directory_iterator> 944979fb40bSRui Ueyama COFFObjectFile::export_directories() const { 945979fb40bSRui Ueyama return make_range(export_directory_begin(), export_directory_end()); 946979fb40bSRui Ueyama } 947979fb40bSRui Ueyama 94874e85130SRui Ueyama iterator_range<base_reloc_iterator> COFFObjectFile::base_relocs() const { 94974e85130SRui Ueyama return make_range(base_reloc_begin(), base_reloc_end()); 95074e85130SRui Ueyama } 95174e85130SRui Ueyama 952e84a0b5aSMartin Storsjo std::error_code 953db4ed0bdSRafael Espindola COFFObjectFile::getDataDirectory(uint32_t Index, 954ed64342bSRui Ueyama const data_directory *&Res) const { 955bcadfee2SHiroshi Inoue // Error if there's no data directory or the index is out of range. 956f69b0585SDavid Majnemer if (!DataDirectory) { 957f69b0585SDavid Majnemer Res = nullptr; 95810ed9ddcSRui Ueyama return object_error::parse_failed; 959f69b0585SDavid Majnemer } 96010ed9ddcSRui Ueyama assert(PE32Header || PE32PlusHeader); 96110ed9ddcSRui Ueyama uint32_t NumEnt = PE32Header ? PE32Header->NumberOfRvaAndSize 96210ed9ddcSRui Ueyama : PE32PlusHeader->NumberOfRvaAndSize; 963f69b0585SDavid Majnemer if (Index >= NumEnt) { 964f69b0585SDavid Majnemer Res = nullptr; 965ed64342bSRui Ueyama return object_error::parse_failed; 966f69b0585SDavid Majnemer } 9678ff24d25SRui Ueyama Res = &DataDirectory[Index]; 9687d099195SRui Ueyama return std::error_code(); 969ed64342bSRui Ueyama } 970ed64342bSRui Ueyama 97177ecf90cSReid Kleckner Expected<const coff_section *> COFFObjectFile::getSection(int32_t Index) const { 97277ecf90cSReid Kleckner // Perhaps getting the section of a reserved section index should be an error, 97377ecf90cSReid Kleckner // but callers rely on this to return null. 974236b0ca7SDavid Majnemer if (COFF::isReservedSectionNumber(Index)) 97577ecf90cSReid Kleckner return (const coff_section *)nullptr; 976236b0ca7SDavid Majnemer if (static_cast<uint32_t>(Index) <= getNumberOfSections()) { 9771d6167fdSMichael J. Spencer // We already verified the section table data, so no need to check again. 97877ecf90cSReid Kleckner return SectionTable + (Index - 1); 9798e90adafSMichael J. Spencer } 98077ecf90cSReid Kleckner return errorCodeToError(object_error::parse_failed); 981236b0ca7SDavid Majnemer } 9828e90adafSMichael J. Spencer 98377ecf90cSReid Kleckner Expected<StringRef> COFFObjectFile::getString(uint32_t Offset) const { 9841d6167fdSMichael J. Spencer if (StringTableSize <= 4) 9851d6167fdSMichael J. Spencer // Tried to get a string from an empty string table. 98677ecf90cSReid Kleckner return errorCodeToError(object_error::parse_failed); 9878ff24d25SRui Ueyama if (Offset >= StringTableSize) 98877ecf90cSReid Kleckner return errorCodeToError(object_error::unexpected_eof); 98977ecf90cSReid Kleckner return StringRef(StringTable + Offset); 9908e90adafSMichael J. Spencer } 991022ecdf2SBenjamin Kramer 99277ecf90cSReid Kleckner Expected<StringRef> COFFObjectFile::getSymbolName(COFFSymbolRef Symbol) const { 99377ecf90cSReid Kleckner return getSymbolName(Symbol.getGeneric()); 994e40d30f3SRui Ueyama } 995e40d30f3SRui Ueyama 99677ecf90cSReid Kleckner Expected<StringRef> 99777ecf90cSReid Kleckner COFFObjectFile::getSymbolName(const coff_symbol_generic *Symbol) const { 99889a7a5eaSMichael J. Spencer // Check for string table entry. First 4 bytes are 0. 99977ecf90cSReid Kleckner if (Symbol->Name.Offset.Zeroes == 0) 100077ecf90cSReid Kleckner return getString(Symbol->Name.Offset.Offset); 100189a7a5eaSMichael J. Spencer 100289a7a5eaSMichael J. Spencer // Null terminated, let ::strlen figure out the length. 100377ecf90cSReid Kleckner if (Symbol->Name.ShortName[COFF::NameSize - 1] == 0) 100477ecf90cSReid Kleckner return StringRef(Symbol->Name.ShortName); 100577ecf90cSReid Kleckner 100689a7a5eaSMichael J. Spencer // Not null terminated, use all 8 bytes. 100777ecf90cSReid Kleckner return StringRef(Symbol->Name.ShortName, COFF::NameSize); 100889a7a5eaSMichael J. Spencer } 100989a7a5eaSMichael J. Spencer 101044f51e51SDavid Majnemer ArrayRef<uint8_t> 101144f51e51SDavid Majnemer COFFObjectFile::getSymbolAuxData(COFFSymbolRef Symbol) const { 10122617dcceSCraig Topper const uint8_t *Aux = nullptr; 101371757ef3SMarshall Clow 101444f51e51SDavid Majnemer size_t SymbolSize = getSymbolTableEntrySize(); 101544f51e51SDavid Majnemer if (Symbol.getNumberOfAuxSymbols() > 0) { 101671757ef3SMarshall Clow // AUX data comes immediately after the symbol in COFF 101744f51e51SDavid Majnemer Aux = reinterpret_cast<const uint8_t *>(Symbol.getRawPtr()) + SymbolSize; 101871757ef3SMarshall Clow #ifndef NDEBUG 10198ff24d25SRui Ueyama // Verify that the Aux symbol points to a valid entry in the symbol table. 10208ff24d25SRui Ueyama uintptr_t Offset = uintptr_t(Aux) - uintptr_t(base()); 102144f51e51SDavid Majnemer if (Offset < getPointerToSymbolTable() || 102244f51e51SDavid Majnemer Offset >= 102344f51e51SDavid Majnemer getPointerToSymbolTable() + (getNumberOfSymbols() * SymbolSize)) 102471757ef3SMarshall Clow report_fatal_error("Aux Symbol data was outside of symbol table."); 102571757ef3SMarshall Clow 102644f51e51SDavid Majnemer assert((Offset - getPointerToSymbolTable()) % SymbolSize == 0 && 102744f51e51SDavid Majnemer "Aux Symbol data did not point to the beginning of a symbol"); 102871757ef3SMarshall Clow #endif 1029bfb85e67SMarshall Clow } 103044f51e51SDavid Majnemer return makeArrayRef(Aux, Symbol.getNumberOfAuxSymbols() * SymbolSize); 103171757ef3SMarshall Clow } 103271757ef3SMarshall Clow 103374e7d260SMartin Storsjo uint32_t COFFObjectFile::getSymbolIndex(COFFSymbolRef Symbol) const { 103474e7d260SMartin Storsjo uintptr_t Offset = 103574e7d260SMartin Storsjo reinterpret_cast<uintptr_t>(Symbol.getRawPtr()) - getSymbolTable(); 103674e7d260SMartin Storsjo assert(Offset % getSymbolTableEntrySize() == 0 && 103774e7d260SMartin Storsjo "Symbol did not point to the beginning of a symbol"); 103874e7d260SMartin Storsjo size_t Index = Offset / getSymbolTableEntrySize(); 103974e7d260SMartin Storsjo assert(Index < getNumberOfSymbols()); 104074e7d260SMartin Storsjo return Index; 104174e7d260SMartin Storsjo } 104274e7d260SMartin Storsjo 10438be28cdcSFangrui Song Expected<StringRef> 10448be28cdcSFangrui Song COFFObjectFile::getSectionName(const coff_section *Sec) const { 104553c2d547SMichael J. Spencer StringRef Name; 104644f51e51SDavid Majnemer if (Sec->Name[COFF::NameSize - 1] == 0) 104753c2d547SMichael J. Spencer // Null terminated, let ::strlen figure out the length. 104853c2d547SMichael J. Spencer Name = Sec->Name; 104953c2d547SMichael J. Spencer else 105053c2d547SMichael J. Spencer // Not null terminated, use all 8 bytes. 105144f51e51SDavid Majnemer Name = StringRef(Sec->Name, COFF::NameSize); 105253c2d547SMichael J. Spencer 105353c2d547SMichael J. Spencer // Check for string table entry. First byte is '/'. 10542314b3deSDavid Majnemer if (Name.startswith("/")) { 105553c2d547SMichael J. Spencer uint32_t Offset; 10562314b3deSDavid Majnemer if (Name.startswith("//")) { 10579d2c15efSNico Rieck if (decodeBase64StringEntry(Name.substr(2), Offset)) 10588be28cdcSFangrui Song return createStringError(object_error::parse_failed, 1059400b6c08Sserge-sans-paille "invalid section name"); 10609d2c15efSNico Rieck } else { 106153c2d547SMichael J. Spencer if (Name.substr(1).getAsInteger(10, Offset)) 10628be28cdcSFangrui Song return createStringError(object_error::parse_failed, 10638be28cdcSFangrui Song "invalid section name"); 10649d2c15efSNico Rieck } 106577ecf90cSReid Kleckner return getString(Offset); 106653c2d547SMichael J. Spencer } 106753c2d547SMichael J. Spencer 10688be28cdcSFangrui Song return Name; 106953c2d547SMichael J. Spencer } 107053c2d547SMichael J. Spencer 1071a9ee5c06SDavid Majnemer uint64_t COFFObjectFile::getSectionSize(const coff_section *Sec) const { 1072a9ee5c06SDavid Majnemer // SizeOfRawData and VirtualSize change what they represent depending on 1073a9ee5c06SDavid Majnemer // whether or not we have an executable image. 1074a9ee5c06SDavid Majnemer // 1075a9ee5c06SDavid Majnemer // For object files, SizeOfRawData contains the size of section's data; 1076d5297ee7SRui Ueyama // VirtualSize should be zero but isn't due to buggy COFF writers. 1077a9ee5c06SDavid Majnemer // 1078a9ee5c06SDavid Majnemer // For executables, SizeOfRawData *must* be a multiple of FileAlignment; the 1079a9ee5c06SDavid Majnemer // actual section size is in VirtualSize. It is possible for VirtualSize to 1080a9ee5c06SDavid Majnemer // be greater than SizeOfRawData; the contents past that point should be 1081a9ee5c06SDavid Majnemer // considered to be zero. 1082d5297ee7SRui Ueyama if (getDOSHeader()) 1083d5297ee7SRui Ueyama return std::min(Sec->VirtualSize, Sec->SizeOfRawData); 1084d5297ee7SRui Ueyama return Sec->SizeOfRawData; 1085a9ee5c06SDavid Majnemer } 1086a9ee5c06SDavid Majnemer 1087e1cb2c0fSFangrui Song Error COFFObjectFile::getSectionContents(const coff_section *Sec, 10889da9e693SMichael J. Spencer ArrayRef<uint8_t> &Res) const { 1089e2129662SDavid Majnemer // In COFF, a virtual section won't have any in-file 1090e2129662SDavid Majnemer // content, so the file pointer to the content will be zero. 1091e2129662SDavid Majnemer if (Sec->PointerToRawData == 0) 1092e1cb2c0fSFangrui Song return Error::success(); 10939da9e693SMichael J. Spencer // The only thing that we need to verify is that the contents is contained 10949da9e693SMichael J. Spencer // within the file bounds. We don't need to make sure it doesn't cover other 10959da9e693SMichael J. Spencer // data, as there's nothing that says that is not allowed. 10969da9e693SMichael J. Spencer uintptr_t ConStart = uintptr_t(base()) + Sec->PointerToRawData; 1097a9ee5c06SDavid Majnemer uint32_t SectionSize = getSectionSize(Sec); 1098*e03a135bSReid Kleckner if (Error E = checkOffset(Data, ConStart, SectionSize)) 1099*e03a135bSReid Kleckner return E; 1100a9ee5c06SDavid Majnemer Res = makeArrayRef(reinterpret_cast<const uint8_t *>(ConStart), SectionSize); 1101e1cb2c0fSFangrui Song return Error::success(); 11029da9e693SMichael J. Spencer } 11039da9e693SMichael J. Spencer 1104022ecdf2SBenjamin Kramer const coff_relocation *COFFObjectFile::toRel(DataRefImpl Rel) const { 1105e5fd0047SMichael J. Spencer return reinterpret_cast<const coff_relocation*>(Rel.p); 1106022ecdf2SBenjamin Kramer } 11078ff24d25SRui Ueyama 11085e812afaSRafael Espindola void COFFObjectFile::moveRelocationNext(DataRefImpl &Rel) const { 1109e5fd0047SMichael J. Spencer Rel.p = reinterpret_cast<uintptr_t>( 1110e5fd0047SMichael J. Spencer reinterpret_cast<const coff_relocation*>(Rel.p) + 1); 1111022ecdf2SBenjamin Kramer } 11128ff24d25SRui Ueyama 111396d071cdSRafael Espindola uint64_t COFFObjectFile::getRelocationOffset(DataRefImpl Rel) const { 111458323a97SDavid Majnemer const coff_relocation *R = toRel(Rel); 111596d071cdSRafael Espindola return R->VirtualAddress; 1116cbe72fc9SDanil Malyshev } 11178ff24d25SRui Ueyama 1118806f0064SRafael Espindola symbol_iterator COFFObjectFile::getRelocationSymbol(DataRefImpl Rel) const { 1119022ecdf2SBenjamin Kramer const coff_relocation *R = toRel(Rel); 11208ff24d25SRui Ueyama DataRefImpl Ref; 1121236b0ca7SDavid Majnemer if (R->SymbolTableIndex >= getNumberOfSymbols()) 1122236b0ca7SDavid Majnemer return symbol_end(); 112344f51e51SDavid Majnemer if (SymbolTable16) 112444f51e51SDavid Majnemer Ref.p = reinterpret_cast<uintptr_t>(SymbolTable16 + R->SymbolTableIndex); 112544f51e51SDavid Majnemer else if (SymbolTable32) 112644f51e51SDavid Majnemer Ref.p = reinterpret_cast<uintptr_t>(SymbolTable32 + R->SymbolTableIndex); 112744f51e51SDavid Majnemer else 1128c7353b58SDavid Majnemer llvm_unreachable("no symbol table pointer!"); 11298ff24d25SRui Ueyama return symbol_iterator(SymbolRef(Ref, this)); 1130022ecdf2SBenjamin Kramer } 11318ff24d25SRui Ueyama 113299c041b7SRafael Espindola uint64_t COFFObjectFile::getRelocationType(DataRefImpl Rel) const { 1133022ecdf2SBenjamin Kramer const coff_relocation* R = toRel(Rel); 113499c041b7SRafael Espindola return R->Type; 1135022ecdf2SBenjamin Kramer } 1136e5fd0047SMichael J. Spencer 113727dc8394SAlexey Samsonov const coff_section * 113827dc8394SAlexey Samsonov COFFObjectFile::getCOFFSection(const SectionRef &Section) const { 113927dc8394SAlexey Samsonov return toSec(Section.getRawDataRefImpl()); 114071757ef3SMarshall Clow } 114171757ef3SMarshall Clow 114244f51e51SDavid Majnemer COFFSymbolRef COFFObjectFile::getCOFFSymbol(const DataRefImpl &Ref) const { 114344f51e51SDavid Majnemer if (SymbolTable16) 114444f51e51SDavid Majnemer return toSymb<coff_symbol16>(Ref); 114544f51e51SDavid Majnemer if (SymbolTable32) 114644f51e51SDavid Majnemer return toSymb<coff_symbol32>(Ref); 114744f51e51SDavid Majnemer llvm_unreachable("no symbol table pointer!"); 114844f51e51SDavid Majnemer } 114944f51e51SDavid Majnemer 115044f51e51SDavid Majnemer COFFSymbolRef COFFObjectFile::getCOFFSymbol(const SymbolRef &Symbol) const { 115144f51e51SDavid Majnemer return getCOFFSymbol(Symbol.getRawDataRefImpl()); 115271757ef3SMarshall Clow } 115371757ef3SMarshall Clow 1154f12b8282SRafael Espindola const coff_relocation * 115527dc8394SAlexey Samsonov COFFObjectFile::getCOFFRelocation(const RelocationRef &Reloc) const { 115627dc8394SAlexey Samsonov return toRel(Reloc.getRawDataRefImpl()); 1157d3e2a76cSMarshall Clow } 1158d3e2a76cSMarshall Clow 11592f6d0061SPeter Collingbourne ArrayRef<coff_relocation> 11606a75acb1SRui Ueyama COFFObjectFile::getRelocations(const coff_section *Sec) const { 11612f6d0061SPeter Collingbourne return {getFirstReloc(Sec, Data, base()), 11622f6d0061SPeter Collingbourne getNumberOfRelocations(Sec, Data, base())}; 11636a75acb1SRui Ueyama } 11646a75acb1SRui Ueyama 116527dc8394SAlexey Samsonov #define LLVM_COFF_SWITCH_RELOC_TYPE_NAME(reloc_type) \ 116627dc8394SAlexey Samsonov case COFF::reloc_type: \ 1167114ebf4aSMartin Storsjo return #reloc_type; 1168e5fd0047SMichael J. Spencer 1169114ebf4aSMartin Storsjo StringRef COFFObjectFile::getRelocationTypeName(uint16_t Type) const { 117044f51e51SDavid Majnemer switch (getMachine()) { 1171e5fd0047SMichael J. Spencer case COFF::IMAGE_FILE_MACHINE_AMD64: 1172114ebf4aSMartin Storsjo switch (Type) { 1173e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ABSOLUTE); 1174e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR64); 1175e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32); 1176e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_ADDR32NB); 1177e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32); 1178e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_1); 1179e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_2); 1180e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_3); 1181e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_4); 1182e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_REL32_5); 1183e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECTION); 1184e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL); 1185e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SECREL7); 1186e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_TOKEN); 1187e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SREL32); 1188e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_PAIR); 1189e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_AMD64_SSPAN32); 1190e5fd0047SMichael J. Spencer default: 1191114ebf4aSMartin Storsjo return "Unknown"; 1192e5fd0047SMichael J. Spencer } 1193e5fd0047SMichael J. Spencer break; 11945c503bf4SSaleem Abdulrasool case COFF::IMAGE_FILE_MACHINE_ARMNT: 1195114ebf4aSMartin Storsjo switch (Type) { 11965c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ABSOLUTE); 11975c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ADDR32); 11985c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_ADDR32NB); 11995c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH24); 12005c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH11); 12015c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_TOKEN); 12025c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX24); 12035c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX11); 1204e5eb6fb9SMartin Storsjo LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_REL32); 12055c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_SECTION); 12065c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_SECREL); 12075c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_MOV32A); 12085c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_MOV32T); 12095c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH20T); 12105c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BRANCH24T); 12115c503bf4SSaleem Abdulrasool LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_BLX23T); 1212e5eb6fb9SMartin Storsjo LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM_PAIR); 12135c503bf4SSaleem Abdulrasool default: 1214114ebf4aSMartin Storsjo return "Unknown"; 12155c503bf4SSaleem Abdulrasool } 12165c503bf4SSaleem Abdulrasool break; 12170c72172eSMandeep Singh Grang case COFF::IMAGE_FILE_MACHINE_ARM64: 1218114ebf4aSMartin Storsjo switch (Type) { 12190c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_ABSOLUTE); 12200c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_ADDR32); 12210c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_ADDR32NB); 12220c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_BRANCH26); 12230c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_PAGEBASE_REL21); 12240c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_REL21); 12250c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_PAGEOFFSET_12A); 12260c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_PAGEOFFSET_12L); 12270c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_SECREL); 12280c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_SECREL_LOW12A); 12290c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_SECREL_HIGH12A); 12300c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_SECREL_LOW12L); 12310c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_TOKEN); 12320c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_SECTION); 12330c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_ADDR64); 12340c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_BRANCH19); 12350c72172eSMandeep Singh Grang LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_BRANCH14); 1236e5eb6fb9SMartin Storsjo LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_ARM64_REL32); 12370c72172eSMandeep Singh Grang default: 1238114ebf4aSMartin Storsjo return "Unknown"; 12390c72172eSMandeep Singh Grang } 12400c72172eSMandeep Singh Grang break; 1241e5fd0047SMichael J. Spencer case COFF::IMAGE_FILE_MACHINE_I386: 1242114ebf4aSMartin Storsjo switch (Type) { 1243e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_ABSOLUTE); 1244e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR16); 1245e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL16); 1246e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32); 1247e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_DIR32NB); 1248e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SEG12); 1249e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECTION); 1250e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL); 1251e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_TOKEN); 1252e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_SECREL7); 1253e5fd0047SMichael J. Spencer LLVM_COFF_SWITCH_RELOC_TYPE_NAME(IMAGE_REL_I386_REL32); 1254e5fd0047SMichael J. Spencer default: 1255114ebf4aSMartin Storsjo return "Unknown"; 1256e5fd0047SMichael J. Spencer } 1257e5fd0047SMichael J. Spencer break; 1258e5fd0047SMichael J. Spencer default: 1259114ebf4aSMartin Storsjo return "Unknown"; 1260e5fd0047SMichael J. Spencer } 1261e5fd0047SMichael J. Spencer } 1262e5fd0047SMichael J. Spencer 1263e5fd0047SMichael J. Spencer #undef LLVM_COFF_SWITCH_RELOC_TYPE_NAME 1264e5fd0047SMichael J. Spencer 1265114ebf4aSMartin Storsjo void COFFObjectFile::getRelocationTypeName( 1266114ebf4aSMartin Storsjo DataRefImpl Rel, SmallVectorImpl<char> &Result) const { 1267114ebf4aSMartin Storsjo const coff_relocation *Reloc = toRel(Rel); 1268114ebf4aSMartin Storsjo StringRef Res = getRelocationTypeName(Reloc->Type); 1269114ebf4aSMartin Storsjo Result.append(Res.begin(), Res.end()); 1270114ebf4aSMartin Storsjo } 1271114ebf4aSMartin Storsjo 1272c66d761bSRafael Espindola bool COFFObjectFile::isRelocatableObject() const { 1273c66d761bSRafael Espindola return !DataDirectory; 1274c66d761bSRafael Espindola } 1275c66d761bSRafael Espindola 1276e3093808SMartin Storsjo StringRef COFFObjectFile::mapDebugSectionName(StringRef Name) const { 1277e3093808SMartin Storsjo return StringSwitch<StringRef>(Name) 1278e3093808SMartin Storsjo .Case("eh_fram", "eh_frame") 1279e3093808SMartin Storsjo .Default(Name); 1280e3093808SMartin Storsjo } 1281e3093808SMartin Storsjo 1282c2bed429SRui Ueyama bool ImportDirectoryEntryRef:: 1283c2bed429SRui Ueyama operator==(const ImportDirectoryEntryRef &Other) const { 1284a045b73aSRui Ueyama return ImportTable == Other.ImportTable && Index == Other.Index; 1285c2bed429SRui Ueyama } 1286c2bed429SRui Ueyama 12875e812afaSRafael Espindola void ImportDirectoryEntryRef::moveNext() { 12885e812afaSRafael Espindola ++Index; 12891c0aa04eSDavid Majnemer if (ImportTable[Index].isNull()) { 1290ad7b7e73SDavid Majnemer Index = -1; 1291ad7b7e73SDavid Majnemer ImportTable = nullptr; 1292ad7b7e73SDavid Majnemer } 1293c2bed429SRui Ueyama } 1294c2bed429SRui Ueyama 1295db4ed0bdSRafael Espindola std::error_code ImportDirectoryEntryRef::getImportTableEntry( 12961c0aa04eSDavid Majnemer const coff_import_directory_table_entry *&Result) const { 1297ad7b7e73SDavid Majnemer return getObject(Result, OwningObject->Data, ImportTable + Index); 1298c2bed429SRui Ueyama } 1299c2bed429SRui Ueyama 1300861021f9SRui Ueyama static imported_symbol_iterator 130115d99359SRui Ueyama makeImportedSymbolIterator(const COFFObjectFile *Object, 1302861021f9SRui Ueyama uintptr_t Ptr, int Index) { 130315d99359SRui Ueyama if (Object->getBytesInAddress() == 4) { 1304861021f9SRui Ueyama auto *P = reinterpret_cast<const import_lookup_table_entry32 *>(Ptr); 130515d99359SRui Ueyama return imported_symbol_iterator(ImportedSymbolRef(P, Index, Object)); 1306861021f9SRui Ueyama } 1307861021f9SRui Ueyama auto *P = reinterpret_cast<const import_lookup_table_entry64 *>(Ptr); 130815d99359SRui Ueyama return imported_symbol_iterator(ImportedSymbolRef(P, Index, Object)); 1309861021f9SRui Ueyama } 1310861021f9SRui Ueyama 131115d99359SRui Ueyama static imported_symbol_iterator 131215d99359SRui Ueyama importedSymbolBegin(uint32_t RVA, const COFFObjectFile *Object) { 1313861021f9SRui Ueyama uintptr_t IntPtr = 0; 131415d99359SRui Ueyama Object->getRvaPtr(RVA, IntPtr); 131515d99359SRui Ueyama return makeImportedSymbolIterator(Object, IntPtr, 0); 1316861021f9SRui Ueyama } 1317861021f9SRui Ueyama 131815d99359SRui Ueyama static imported_symbol_iterator 131915d99359SRui Ueyama importedSymbolEnd(uint32_t RVA, const COFFObjectFile *Object) { 1320861021f9SRui Ueyama uintptr_t IntPtr = 0; 132115d99359SRui Ueyama Object->getRvaPtr(RVA, IntPtr); 1322861021f9SRui Ueyama // Forward the pointer to the last entry which is null. 1323861021f9SRui Ueyama int Index = 0; 132415d99359SRui Ueyama if (Object->getBytesInAddress() == 4) { 1325861021f9SRui Ueyama auto *Entry = reinterpret_cast<ulittle32_t *>(IntPtr); 1326861021f9SRui Ueyama while (*Entry++) 1327861021f9SRui Ueyama ++Index; 1328861021f9SRui Ueyama } else { 1329861021f9SRui Ueyama auto *Entry = reinterpret_cast<ulittle64_t *>(IntPtr); 1330861021f9SRui Ueyama while (*Entry++) 1331861021f9SRui Ueyama ++Index; 1332861021f9SRui Ueyama } 133315d99359SRui Ueyama return makeImportedSymbolIterator(Object, IntPtr, Index); 133415d99359SRui Ueyama } 133515d99359SRui Ueyama 133615d99359SRui Ueyama imported_symbol_iterator 133715d99359SRui Ueyama ImportDirectoryEntryRef::imported_symbol_begin() const { 133860049526SDavid Majnemer return importedSymbolBegin(ImportTable[Index].ImportAddressTableRVA, 133915d99359SRui Ueyama OwningObject); 134015d99359SRui Ueyama } 134115d99359SRui Ueyama 134215d99359SRui Ueyama imported_symbol_iterator 134315d99359SRui Ueyama ImportDirectoryEntryRef::imported_symbol_end() const { 134460049526SDavid Majnemer return importedSymbolEnd(ImportTable[Index].ImportAddressTableRVA, 134515d99359SRui Ueyama OwningObject); 1346861021f9SRui Ueyama } 1347861021f9SRui Ueyama 1348979fb40bSRui Ueyama iterator_range<imported_symbol_iterator> 1349979fb40bSRui Ueyama ImportDirectoryEntryRef::imported_symbols() const { 1350979fb40bSRui Ueyama return make_range(imported_symbol_begin(), imported_symbol_end()); 1351979fb40bSRui Ueyama } 1352979fb40bSRui Ueyama 135360049526SDavid Majnemer imported_symbol_iterator ImportDirectoryEntryRef::lookup_table_begin() const { 135460049526SDavid Majnemer return importedSymbolBegin(ImportTable[Index].ImportLookupTableRVA, 135560049526SDavid Majnemer OwningObject); 135660049526SDavid Majnemer } 135760049526SDavid Majnemer 135860049526SDavid Majnemer imported_symbol_iterator ImportDirectoryEntryRef::lookup_table_end() const { 135960049526SDavid Majnemer return importedSymbolEnd(ImportTable[Index].ImportLookupTableRVA, 136060049526SDavid Majnemer OwningObject); 136160049526SDavid Majnemer } 136260049526SDavid Majnemer 136360049526SDavid Majnemer iterator_range<imported_symbol_iterator> 136460049526SDavid Majnemer ImportDirectoryEntryRef::lookup_table_symbols() const { 136560049526SDavid Majnemer return make_range(lookup_table_begin(), lookup_table_end()); 136660049526SDavid Majnemer } 136760049526SDavid Majnemer 1368db4ed0bdSRafael Espindola std::error_code ImportDirectoryEntryRef::getName(StringRef &Result) const { 1369c2bed429SRui Ueyama uintptr_t IntPtr = 0; 1370db4ed0bdSRafael Espindola if (std::error_code EC = 13711e152d5eSRui Ueyama OwningObject->getRvaPtr(ImportTable[Index].NameRVA, IntPtr)) 1372a045b73aSRui Ueyama return EC; 1373a045b73aSRui Ueyama Result = StringRef(reinterpret_cast<const char *>(IntPtr)); 13747d099195SRui Ueyama return std::error_code(); 1375c2bed429SRui Ueyama } 1376c2bed429SRui Ueyama 13771e152d5eSRui Ueyama std::error_code 13781e152d5eSRui Ueyama ImportDirectoryEntryRef::getImportLookupTableRVA(uint32_t &Result) const { 13791e152d5eSRui Ueyama Result = ImportTable[Index].ImportLookupTableRVA; 13807d099195SRui Ueyama return std::error_code(); 13811e152d5eSRui Ueyama } 13821e152d5eSRui Ueyama 13831e152d5eSRui Ueyama std::error_code 13841e152d5eSRui Ueyama ImportDirectoryEntryRef::getImportAddressTableRVA(uint32_t &Result) const { 13851e152d5eSRui Ueyama Result = ImportTable[Index].ImportAddressTableRVA; 13867d099195SRui Ueyama return std::error_code(); 13871e152d5eSRui Ueyama } 13881e152d5eSRui Ueyama 138915d99359SRui Ueyama bool DelayImportDirectoryEntryRef:: 139015d99359SRui Ueyama operator==(const DelayImportDirectoryEntryRef &Other) const { 139115d99359SRui Ueyama return Table == Other.Table && Index == Other.Index; 139215d99359SRui Ueyama } 139315d99359SRui Ueyama 139415d99359SRui Ueyama void DelayImportDirectoryEntryRef::moveNext() { 139515d99359SRui Ueyama ++Index; 139615d99359SRui Ueyama } 139715d99359SRui Ueyama 139815d99359SRui Ueyama imported_symbol_iterator 139915d99359SRui Ueyama DelayImportDirectoryEntryRef::imported_symbol_begin() const { 140015d99359SRui Ueyama return importedSymbolBegin(Table[Index].DelayImportNameTable, 140115d99359SRui Ueyama OwningObject); 140215d99359SRui Ueyama } 140315d99359SRui Ueyama 140415d99359SRui Ueyama imported_symbol_iterator 140515d99359SRui Ueyama DelayImportDirectoryEntryRef::imported_symbol_end() const { 140615d99359SRui Ueyama return importedSymbolEnd(Table[Index].DelayImportNameTable, 140715d99359SRui Ueyama OwningObject); 140815d99359SRui Ueyama } 140915d99359SRui Ueyama 1410979fb40bSRui Ueyama iterator_range<imported_symbol_iterator> 1411979fb40bSRui Ueyama DelayImportDirectoryEntryRef::imported_symbols() const { 1412979fb40bSRui Ueyama return make_range(imported_symbol_begin(), imported_symbol_end()); 1413979fb40bSRui Ueyama } 1414979fb40bSRui Ueyama 141515d99359SRui Ueyama std::error_code DelayImportDirectoryEntryRef::getName(StringRef &Result) const { 141615d99359SRui Ueyama uintptr_t IntPtr = 0; 141715d99359SRui Ueyama if (std::error_code EC = OwningObject->getRvaPtr(Table[Index].Name, IntPtr)) 141815d99359SRui Ueyama return EC; 141915d99359SRui Ueyama Result = StringRef(reinterpret_cast<const char *>(IntPtr)); 14207d099195SRui Ueyama return std::error_code(); 142115d99359SRui Ueyama } 142215d99359SRui Ueyama 14231af08658SRui Ueyama std::error_code DelayImportDirectoryEntryRef:: 14241af08658SRui Ueyama getDelayImportTable(const delay_import_directory_table_entry *&Result) const { 14259f598ac7SJoseph Tremoulet Result = &Table[Index]; 14267d099195SRui Ueyama return std::error_code(); 14271af08658SRui Ueyama } 14281af08658SRui Ueyama 1429ffa4cebeSRui Ueyama std::error_code DelayImportDirectoryEntryRef:: 1430ffa4cebeSRui Ueyama getImportAddress(int AddrIndex, uint64_t &Result) const { 1431ffa4cebeSRui Ueyama uint32_t RVA = Table[Index].DelayImportAddressTable + 1432ffa4cebeSRui Ueyama AddrIndex * (OwningObject->is64() ? 8 : 4); 1433ffa4cebeSRui Ueyama uintptr_t IntPtr = 0; 1434ffa4cebeSRui Ueyama if (std::error_code EC = OwningObject->getRvaPtr(RVA, IntPtr)) 1435ffa4cebeSRui Ueyama return EC; 1436ffa4cebeSRui Ueyama if (OwningObject->is64()) 14375dcf11d1SRui Ueyama Result = *reinterpret_cast<const ulittle64_t *>(IntPtr); 1438ffa4cebeSRui Ueyama else 14395dcf11d1SRui Ueyama Result = *reinterpret_cast<const ulittle32_t *>(IntPtr); 14407d099195SRui Ueyama return std::error_code(); 1441ffa4cebeSRui Ueyama } 1442ffa4cebeSRui Ueyama 1443ad882ba8SRui Ueyama bool ExportDirectoryEntryRef:: 1444ad882ba8SRui Ueyama operator==(const ExportDirectoryEntryRef &Other) const { 1445ad882ba8SRui Ueyama return ExportTable == Other.ExportTable && Index == Other.Index; 1446ad882ba8SRui Ueyama } 1447ad882ba8SRui Ueyama 14485e812afaSRafael Espindola void ExportDirectoryEntryRef::moveNext() { 14495e812afaSRafael Espindola ++Index; 1450ad882ba8SRui Ueyama } 1451ad882ba8SRui Ueyama 1452da49d0d4SRui Ueyama // Returns the name of the current export symbol. If the symbol is exported only 1453da49d0d4SRui Ueyama // by ordinal, the empty string is set as a result. 1454db4ed0bdSRafael Espindola std::error_code ExportDirectoryEntryRef::getDllName(StringRef &Result) const { 1455da49d0d4SRui Ueyama uintptr_t IntPtr = 0; 1456db4ed0bdSRafael Espindola if (std::error_code EC = 1457db4ed0bdSRafael Espindola OwningObject->getRvaPtr(ExportTable->NameRVA, IntPtr)) 1458da49d0d4SRui Ueyama return EC; 1459da49d0d4SRui Ueyama Result = StringRef(reinterpret_cast<const char *>(IntPtr)); 14607d099195SRui Ueyama return std::error_code(); 1461da49d0d4SRui Ueyama } 1462da49d0d4SRui Ueyama 1463e5df6095SRui Ueyama // Returns the starting ordinal number. 1464db4ed0bdSRafael Espindola std::error_code 1465db4ed0bdSRafael Espindola ExportDirectoryEntryRef::getOrdinalBase(uint32_t &Result) const { 1466e5df6095SRui Ueyama Result = ExportTable->OrdinalBase; 14677d099195SRui Ueyama return std::error_code(); 1468e5df6095SRui Ueyama } 1469e5df6095SRui Ueyama 1470ad882ba8SRui Ueyama // Returns the export ordinal of the current export symbol. 1471db4ed0bdSRafael Espindola std::error_code ExportDirectoryEntryRef::getOrdinal(uint32_t &Result) const { 1472ad882ba8SRui Ueyama Result = ExportTable->OrdinalBase + Index; 14737d099195SRui Ueyama return std::error_code(); 1474ad882ba8SRui Ueyama } 1475ad882ba8SRui Ueyama 1476ad882ba8SRui Ueyama // Returns the address of the current export symbol. 1477db4ed0bdSRafael Espindola std::error_code ExportDirectoryEntryRef::getExportRVA(uint32_t &Result) const { 1478ad882ba8SRui Ueyama uintptr_t IntPtr = 0; 1479db4ed0bdSRafael Espindola if (std::error_code EC = 1480db4ed0bdSRafael Espindola OwningObject->getRvaPtr(ExportTable->ExportAddressTableRVA, IntPtr)) 1481ad882ba8SRui Ueyama return EC; 148224fc2d64SRui Ueyama const export_address_table_entry *entry = 148324fc2d64SRui Ueyama reinterpret_cast<const export_address_table_entry *>(IntPtr); 1484ad882ba8SRui Ueyama Result = entry[Index].ExportRVA; 14857d099195SRui Ueyama return std::error_code(); 1486ad882ba8SRui Ueyama } 1487ad882ba8SRui Ueyama 1488ad882ba8SRui Ueyama // Returns the name of the current export symbol. If the symbol is exported only 1489ad882ba8SRui Ueyama // by ordinal, the empty string is set as a result. 1490db4ed0bdSRafael Espindola std::error_code 1491db4ed0bdSRafael Espindola ExportDirectoryEntryRef::getSymbolName(StringRef &Result) const { 1492ad882ba8SRui Ueyama uintptr_t IntPtr = 0; 1493db4ed0bdSRafael Espindola if (std::error_code EC = 1494db4ed0bdSRafael Espindola OwningObject->getRvaPtr(ExportTable->OrdinalTableRVA, IntPtr)) 1495ad882ba8SRui Ueyama return EC; 1496ad882ba8SRui Ueyama const ulittle16_t *Start = reinterpret_cast<const ulittle16_t *>(IntPtr); 1497ad882ba8SRui Ueyama 1498ad882ba8SRui Ueyama uint32_t NumEntries = ExportTable->NumberOfNamePointers; 1499ad882ba8SRui Ueyama int Offset = 0; 1500ad882ba8SRui Ueyama for (const ulittle16_t *I = Start, *E = Start + NumEntries; 1501ad882ba8SRui Ueyama I < E; ++I, ++Offset) { 1502ad882ba8SRui Ueyama if (*I != Index) 1503ad882ba8SRui Ueyama continue; 1504db4ed0bdSRafael Espindola if (std::error_code EC = 1505db4ed0bdSRafael Espindola OwningObject->getRvaPtr(ExportTable->NamePointerRVA, IntPtr)) 1506ad882ba8SRui Ueyama return EC; 1507ad882ba8SRui Ueyama const ulittle32_t *NamePtr = reinterpret_cast<const ulittle32_t *>(IntPtr); 1508db4ed0bdSRafael Espindola if (std::error_code EC = OwningObject->getRvaPtr(NamePtr[Offset], IntPtr)) 1509ad882ba8SRui Ueyama return EC; 1510ad882ba8SRui Ueyama Result = StringRef(reinterpret_cast<const char *>(IntPtr)); 15117d099195SRui Ueyama return std::error_code(); 1512ad882ba8SRui Ueyama } 1513ad882ba8SRui Ueyama Result = ""; 15147d099195SRui Ueyama return std::error_code(); 1515ad882ba8SRui Ueyama } 1516ad882ba8SRui Ueyama 15176161b38dSRui Ueyama std::error_code ExportDirectoryEntryRef::isForwarder(bool &Result) const { 15186161b38dSRui Ueyama const data_directory *DataEntry; 15196161b38dSRui Ueyama if (auto EC = OwningObject->getDataDirectory(COFF::EXPORT_TABLE, DataEntry)) 15206161b38dSRui Ueyama return EC; 15216161b38dSRui Ueyama uint32_t RVA; 15226161b38dSRui Ueyama if (auto EC = getExportRVA(RVA)) 15236161b38dSRui Ueyama return EC; 15246161b38dSRui Ueyama uint32_t Begin = DataEntry->RelativeVirtualAddress; 15256161b38dSRui Ueyama uint32_t End = DataEntry->RelativeVirtualAddress + DataEntry->Size; 15266161b38dSRui Ueyama Result = (Begin <= RVA && RVA < End); 15276161b38dSRui Ueyama return std::error_code(); 15286161b38dSRui Ueyama } 15296161b38dSRui Ueyama 15306161b38dSRui Ueyama std::error_code ExportDirectoryEntryRef::getForwardTo(StringRef &Result) const { 15316161b38dSRui Ueyama uint32_t RVA; 15326161b38dSRui Ueyama if (auto EC = getExportRVA(RVA)) 15336161b38dSRui Ueyama return EC; 15346161b38dSRui Ueyama uintptr_t IntPtr = 0; 15356161b38dSRui Ueyama if (auto EC = OwningObject->getRvaPtr(RVA, IntPtr)) 15366161b38dSRui Ueyama return EC; 15376161b38dSRui Ueyama Result = StringRef(reinterpret_cast<const char *>(IntPtr)); 15386161b38dSRui Ueyama return std::error_code(); 15396161b38dSRui Ueyama } 15406161b38dSRui Ueyama 1541861021f9SRui Ueyama bool ImportedSymbolRef:: 1542861021f9SRui Ueyama operator==(const ImportedSymbolRef &Other) const { 1543861021f9SRui Ueyama return Entry32 == Other.Entry32 && Entry64 == Other.Entry64 1544861021f9SRui Ueyama && Index == Other.Index; 1545861021f9SRui Ueyama } 1546861021f9SRui Ueyama 1547861021f9SRui Ueyama void ImportedSymbolRef::moveNext() { 1548861021f9SRui Ueyama ++Index; 1549861021f9SRui Ueyama } 1550861021f9SRui Ueyama 1551861021f9SRui Ueyama std::error_code 1552861021f9SRui Ueyama ImportedSymbolRef::getSymbolName(StringRef &Result) const { 1553861021f9SRui Ueyama uint32_t RVA; 1554861021f9SRui Ueyama if (Entry32) { 1555861021f9SRui Ueyama // If a symbol is imported only by ordinal, it has no name. 1556861021f9SRui Ueyama if (Entry32[Index].isOrdinal()) 15577d099195SRui Ueyama return std::error_code(); 1558861021f9SRui Ueyama RVA = Entry32[Index].getHintNameRVA(); 1559861021f9SRui Ueyama } else { 1560861021f9SRui Ueyama if (Entry64[Index].isOrdinal()) 15617d099195SRui Ueyama return std::error_code(); 1562861021f9SRui Ueyama RVA = Entry64[Index].getHintNameRVA(); 1563861021f9SRui Ueyama } 1564861021f9SRui Ueyama uintptr_t IntPtr = 0; 1565861021f9SRui Ueyama if (std::error_code EC = OwningObject->getRvaPtr(RVA, IntPtr)) 1566861021f9SRui Ueyama return EC; 1567861021f9SRui Ueyama // +2 because the first two bytes is hint. 1568861021f9SRui Ueyama Result = StringRef(reinterpret_cast<const char *>(IntPtr + 2)); 15697d099195SRui Ueyama return std::error_code(); 1570861021f9SRui Ueyama } 1571861021f9SRui Ueyama 1572ad7b7e73SDavid Majnemer std::error_code ImportedSymbolRef::isOrdinal(bool &Result) const { 1573ad7b7e73SDavid Majnemer if (Entry32) 1574ad7b7e73SDavid Majnemer Result = Entry32[Index].isOrdinal(); 1575ad7b7e73SDavid Majnemer else 1576ad7b7e73SDavid Majnemer Result = Entry64[Index].isOrdinal(); 1577ad7b7e73SDavid Majnemer return std::error_code(); 1578ad7b7e73SDavid Majnemer } 1579ad7b7e73SDavid Majnemer 1580ad7b7e73SDavid Majnemer std::error_code ImportedSymbolRef::getHintNameRVA(uint32_t &Result) const { 1581ad7b7e73SDavid Majnemer if (Entry32) 1582ad7b7e73SDavid Majnemer Result = Entry32[Index].getHintNameRVA(); 1583ad7b7e73SDavid Majnemer else 1584ad7b7e73SDavid Majnemer Result = Entry64[Index].getHintNameRVA(); 1585ad7b7e73SDavid Majnemer return std::error_code(); 1586ad7b7e73SDavid Majnemer } 1587ad7b7e73SDavid Majnemer 1588861021f9SRui Ueyama std::error_code ImportedSymbolRef::getOrdinal(uint16_t &Result) const { 1589861021f9SRui Ueyama uint32_t RVA; 1590861021f9SRui Ueyama if (Entry32) { 1591861021f9SRui Ueyama if (Entry32[Index].isOrdinal()) { 1592861021f9SRui Ueyama Result = Entry32[Index].getOrdinal(); 15937d099195SRui Ueyama return std::error_code(); 1594861021f9SRui Ueyama } 1595861021f9SRui Ueyama RVA = Entry32[Index].getHintNameRVA(); 1596861021f9SRui Ueyama } else { 1597861021f9SRui Ueyama if (Entry64[Index].isOrdinal()) { 1598861021f9SRui Ueyama Result = Entry64[Index].getOrdinal(); 15997d099195SRui Ueyama return std::error_code(); 1600861021f9SRui Ueyama } 1601861021f9SRui Ueyama RVA = Entry64[Index].getHintNameRVA(); 1602861021f9SRui Ueyama } 1603861021f9SRui Ueyama uintptr_t IntPtr = 0; 1604861021f9SRui Ueyama if (std::error_code EC = OwningObject->getRvaPtr(RVA, IntPtr)) 1605861021f9SRui Ueyama return EC; 1606861021f9SRui Ueyama Result = *reinterpret_cast<const ulittle16_t *>(IntPtr); 16077d099195SRui Ueyama return std::error_code(); 1608861021f9SRui Ueyama } 1609861021f9SRui Ueyama 161012db383eSRafael Espindola Expected<std::unique_ptr<COFFObjectFile>> 161148af1c2aSRafael Espindola ObjectFile::createCOFFObjectFile(MemoryBufferRef Object) { 161239772063SReid Kleckner return COFFObjectFile::create(Object); 1613686738e2SRui Ueyama } 161474e85130SRui Ueyama 161574e85130SRui Ueyama bool BaseRelocRef::operator==(const BaseRelocRef &Other) const { 161674e85130SRui Ueyama return Header == Other.Header && Index == Other.Index; 161774e85130SRui Ueyama } 161874e85130SRui Ueyama 161974e85130SRui Ueyama void BaseRelocRef::moveNext() { 162074e85130SRui Ueyama // Header->BlockSize is the size of the current block, including the 162174e85130SRui Ueyama // size of the header itself. 162274e85130SRui Ueyama uint32_t Size = sizeof(*Header) + 1623970dda29SRui Ueyama sizeof(coff_base_reloc_block_entry) * (Index + 1); 162474e85130SRui Ueyama if (Size == Header->BlockSize) { 162574e85130SRui Ueyama // .reloc contains a list of base relocation blocks. Each block 162674e85130SRui Ueyama // consists of the header followed by entries. The header contains 162774e85130SRui Ueyama // how many entories will follow. When we reach the end of the 162874e85130SRui Ueyama // current block, proceed to the next block. 162974e85130SRui Ueyama Header = reinterpret_cast<const coff_base_reloc_block_header *>( 163074e85130SRui Ueyama reinterpret_cast<const uint8_t *>(Header) + Size); 163174e85130SRui Ueyama Index = 0; 163274e85130SRui Ueyama } else { 163374e85130SRui Ueyama ++Index; 163474e85130SRui Ueyama } 163574e85130SRui Ueyama } 163674e85130SRui Ueyama 163774e85130SRui Ueyama std::error_code BaseRelocRef::getType(uint8_t &Type) const { 163874e85130SRui Ueyama auto *Entry = reinterpret_cast<const coff_base_reloc_block_entry *>(Header + 1); 163974e85130SRui Ueyama Type = Entry[Index].getType(); 16407d099195SRui Ueyama return std::error_code(); 164174e85130SRui Ueyama } 164274e85130SRui Ueyama 164374e85130SRui Ueyama std::error_code BaseRelocRef::getRVA(uint32_t &Result) const { 164474e85130SRui Ueyama auto *Entry = reinterpret_cast<const coff_base_reloc_block_entry *>(Header + 1); 164574e85130SRui Ueyama Result = Header->PageRVA + Entry[Index].getOffset(); 16467d099195SRui Ueyama return std::error_code(); 164774e85130SRui Ueyama } 1648efef15a0SEric Beckmann 1649357a40ecSMartin Storsjo #define RETURN_IF_ERROR(Expr) \ 1650357a40ecSMartin Storsjo do { \ 1651357a40ecSMartin Storsjo Error E = (Expr); \ 165287867988SRafael Espindola if (E) \ 1653c55cf4afSBill Wendling return std::move(E); \ 1654357a40ecSMartin Storsjo } while (0) 1655efef15a0SEric Beckmann 165687867988SRafael Espindola Expected<ArrayRef<UTF16>> 165787867988SRafael Espindola ResourceSectionRef::getDirStringAtOffset(uint32_t Offset) { 1658efef15a0SEric Beckmann BinaryStreamReader Reader = BinaryStreamReader(BBS); 1659efef15a0SEric Beckmann Reader.setOffset(Offset); 1660efef15a0SEric Beckmann uint16_t Length; 1661efef15a0SEric Beckmann RETURN_IF_ERROR(Reader.readInteger(Length)); 1662efef15a0SEric Beckmann ArrayRef<UTF16> RawDirString; 1663efef15a0SEric Beckmann RETURN_IF_ERROR(Reader.readArray(RawDirString, Length)); 1664cd704cb6SEric Beckmann return RawDirString; 1665efef15a0SEric Beckmann } 1666efef15a0SEric Beckmann 1667f3404674SRafael Espindola Expected<ArrayRef<UTF16>> 1668efef15a0SEric Beckmann ResourceSectionRef::getEntryNameString(const coff_resource_dir_entry &Entry) { 1669f3404674SRafael Espindola return getDirStringAtOffset(Entry.Identifier.getNameOffset()); 1670efef15a0SEric Beckmann } 1671efef15a0SEric Beckmann 167287867988SRafael Espindola Expected<const coff_resource_dir_table &> 1673efef15a0SEric Beckmann ResourceSectionRef::getTableAtOffset(uint32_t Offset) { 1674efef15a0SEric Beckmann const coff_resource_dir_table *Table = nullptr; 1675efef15a0SEric Beckmann 1676efef15a0SEric Beckmann BinaryStreamReader Reader(BBS); 1677efef15a0SEric Beckmann Reader.setOffset(Offset); 1678efef15a0SEric Beckmann RETURN_IF_ERROR(Reader.readObject(Table)); 1679efef15a0SEric Beckmann assert(Table != nullptr); 1680efef15a0SEric Beckmann return *Table; 1681efef15a0SEric Beckmann } 1682efef15a0SEric Beckmann 1683edb6ab9bSMartin Storsjo Expected<const coff_resource_dir_entry &> 1684edb6ab9bSMartin Storsjo ResourceSectionRef::getTableEntryAtOffset(uint32_t Offset) { 1685edb6ab9bSMartin Storsjo const coff_resource_dir_entry *Entry = nullptr; 1686edb6ab9bSMartin Storsjo 1687edb6ab9bSMartin Storsjo BinaryStreamReader Reader(BBS); 1688edb6ab9bSMartin Storsjo Reader.setOffset(Offset); 1689edb6ab9bSMartin Storsjo RETURN_IF_ERROR(Reader.readObject(Entry)); 1690edb6ab9bSMartin Storsjo assert(Entry != nullptr); 1691edb6ab9bSMartin Storsjo return *Entry; 1692edb6ab9bSMartin Storsjo } 1693edb6ab9bSMartin Storsjo 16947ba81d95SMartin Storsjo Expected<const coff_resource_data_entry &> 16957ba81d95SMartin Storsjo ResourceSectionRef::getDataEntryAtOffset(uint32_t Offset) { 16967ba81d95SMartin Storsjo const coff_resource_data_entry *Entry = nullptr; 16977ba81d95SMartin Storsjo 16987ba81d95SMartin Storsjo BinaryStreamReader Reader(BBS); 16997ba81d95SMartin Storsjo Reader.setOffset(Offset); 17007ba81d95SMartin Storsjo RETURN_IF_ERROR(Reader.readObject(Entry)); 17017ba81d95SMartin Storsjo assert(Entry != nullptr); 17027ba81d95SMartin Storsjo return *Entry; 17037ba81d95SMartin Storsjo } 17047ba81d95SMartin Storsjo 1705f3404674SRafael Espindola Expected<const coff_resource_dir_table &> 1706efef15a0SEric Beckmann ResourceSectionRef::getEntrySubDir(const coff_resource_dir_entry &Entry) { 17077ba81d95SMartin Storsjo assert(Entry.Offset.isSubDir()); 1708f3404674SRafael Espindola return getTableAtOffset(Entry.Offset.value()); 1709efef15a0SEric Beckmann } 1710efef15a0SEric Beckmann 17117ba81d95SMartin Storsjo Expected<const coff_resource_data_entry &> 17127ba81d95SMartin Storsjo ResourceSectionRef::getEntryData(const coff_resource_dir_entry &Entry) { 17137ba81d95SMartin Storsjo assert(!Entry.Offset.isSubDir()); 17147ba81d95SMartin Storsjo return getDataEntryAtOffset(Entry.Offset.value()); 17157ba81d95SMartin Storsjo } 17167ba81d95SMartin Storsjo 1717f3404674SRafael Espindola Expected<const coff_resource_dir_table &> ResourceSectionRef::getBaseTable() { 1718f3404674SRafael Espindola return getTableAtOffset(0); 1719efef15a0SEric Beckmann } 1720edb6ab9bSMartin Storsjo 1721edb6ab9bSMartin Storsjo Expected<const coff_resource_dir_entry &> 1722edb6ab9bSMartin Storsjo ResourceSectionRef::getTableEntry(const coff_resource_dir_table &Table, 1723edb6ab9bSMartin Storsjo uint32_t Index) { 1724edb6ab9bSMartin Storsjo if (Index >= (uint32_t)(Table.NumberOfNameEntries + Table.NumberOfIDEntries)) 1725edb6ab9bSMartin Storsjo return createStringError(object_error::parse_failed, "index out of range"); 1726edb6ab9bSMartin Storsjo const uint8_t *TablePtr = reinterpret_cast<const uint8_t *>(&Table); 1727edb6ab9bSMartin Storsjo ptrdiff_t TableOffset = TablePtr - BBS.data().data(); 1728edb6ab9bSMartin Storsjo return getTableEntryAtOffset(TableOffset + sizeof(Table) + 1729edb6ab9bSMartin Storsjo Index * sizeof(coff_resource_dir_entry)); 1730edb6ab9bSMartin Storsjo } 173194382217SMartin Storsjo 173294382217SMartin Storsjo Error ResourceSectionRef::load(const COFFObjectFile *O) { 173394382217SMartin Storsjo for (const SectionRef &S : O->sections()) { 173494382217SMartin Storsjo Expected<StringRef> Name = S.getName(); 173594382217SMartin Storsjo if (!Name) 173694382217SMartin Storsjo return Name.takeError(); 173794382217SMartin Storsjo 173894382217SMartin Storsjo if (*Name == ".rsrc" || *Name == ".rsrc$01") 173994382217SMartin Storsjo return load(O, S); 174094382217SMartin Storsjo } 174194382217SMartin Storsjo return createStringError(object_error::parse_failed, 174294382217SMartin Storsjo "no resource section found"); 174394382217SMartin Storsjo } 174494382217SMartin Storsjo 174594382217SMartin Storsjo Error ResourceSectionRef::load(const COFFObjectFile *O, const SectionRef &S) { 174694382217SMartin Storsjo Obj = O; 174794382217SMartin Storsjo Section = S; 174894382217SMartin Storsjo Expected<StringRef> Contents = Section.getContents(); 174994382217SMartin Storsjo if (!Contents) 175094382217SMartin Storsjo return Contents.takeError(); 175194382217SMartin Storsjo BBS = BinaryByteStream(*Contents, support::little); 175294382217SMartin Storsjo const coff_section *COFFSect = Obj->getCOFFSection(Section); 175394382217SMartin Storsjo ArrayRef<coff_relocation> OrigRelocs = Obj->getRelocations(COFFSect); 175494382217SMartin Storsjo Relocs.reserve(OrigRelocs.size()); 175594382217SMartin Storsjo for (const coff_relocation &R : OrigRelocs) 175694382217SMartin Storsjo Relocs.push_back(&R); 175794382217SMartin Storsjo std::sort(Relocs.begin(), Relocs.end(), 175894382217SMartin Storsjo [](const coff_relocation *A, const coff_relocation *B) { 175994382217SMartin Storsjo return A->VirtualAddress < B->VirtualAddress; 176094382217SMartin Storsjo }); 176194382217SMartin Storsjo return Error::success(); 176294382217SMartin Storsjo } 176394382217SMartin Storsjo 176494382217SMartin Storsjo Expected<StringRef> 176594382217SMartin Storsjo ResourceSectionRef::getContents(const coff_resource_data_entry &Entry) { 176694382217SMartin Storsjo if (!Obj) 176794382217SMartin Storsjo return createStringError(object_error::parse_failed, "no object provided"); 176894382217SMartin Storsjo 176994382217SMartin Storsjo // Find a potential relocation at the DataRVA field (first member of 177094382217SMartin Storsjo // the coff_resource_data_entry struct). 177194382217SMartin Storsjo const uint8_t *EntryPtr = reinterpret_cast<const uint8_t *>(&Entry); 177294382217SMartin Storsjo ptrdiff_t EntryOffset = EntryPtr - BBS.data().data(); 177394382217SMartin Storsjo coff_relocation RelocTarget{ulittle32_t(EntryOffset), ulittle32_t(0), 177494382217SMartin Storsjo ulittle16_t(0)}; 177594382217SMartin Storsjo auto RelocsForOffset = 177694382217SMartin Storsjo std::equal_range(Relocs.begin(), Relocs.end(), &RelocTarget, 177794382217SMartin Storsjo [](const coff_relocation *A, const coff_relocation *B) { 177894382217SMartin Storsjo return A->VirtualAddress < B->VirtualAddress; 177994382217SMartin Storsjo }); 178094382217SMartin Storsjo 178194382217SMartin Storsjo if (RelocsForOffset.first != RelocsForOffset.second) { 178294382217SMartin Storsjo // We found a relocation with the right offset. Check that it does have 178394382217SMartin Storsjo // the expected type. 178494382217SMartin Storsjo const coff_relocation &R = **RelocsForOffset.first; 178594382217SMartin Storsjo uint16_t RVAReloc; 178694382217SMartin Storsjo switch (Obj->getMachine()) { 178794382217SMartin Storsjo case COFF::IMAGE_FILE_MACHINE_I386: 178894382217SMartin Storsjo RVAReloc = COFF::IMAGE_REL_I386_DIR32NB; 178994382217SMartin Storsjo break; 179094382217SMartin Storsjo case COFF::IMAGE_FILE_MACHINE_AMD64: 179194382217SMartin Storsjo RVAReloc = COFF::IMAGE_REL_AMD64_ADDR32NB; 179294382217SMartin Storsjo break; 179394382217SMartin Storsjo case COFF::IMAGE_FILE_MACHINE_ARMNT: 179494382217SMartin Storsjo RVAReloc = COFF::IMAGE_REL_ARM_ADDR32NB; 179594382217SMartin Storsjo break; 179694382217SMartin Storsjo case COFF::IMAGE_FILE_MACHINE_ARM64: 179794382217SMartin Storsjo RVAReloc = COFF::IMAGE_REL_ARM64_ADDR32NB; 179894382217SMartin Storsjo break; 179994382217SMartin Storsjo default: 180094382217SMartin Storsjo return createStringError(object_error::parse_failed, 180194382217SMartin Storsjo "unsupported architecture"); 180294382217SMartin Storsjo } 180394382217SMartin Storsjo if (R.Type != RVAReloc) 180494382217SMartin Storsjo return createStringError(object_error::parse_failed, 180594382217SMartin Storsjo "unexpected relocation type"); 180694382217SMartin Storsjo // Get the relocation's symbol 180794382217SMartin Storsjo Expected<COFFSymbolRef> Sym = Obj->getSymbol(R.SymbolTableIndex); 180894382217SMartin Storsjo if (!Sym) 180994382217SMartin Storsjo return Sym.takeError(); 181094382217SMartin Storsjo // And the symbol's section 181177ecf90cSReid Kleckner Expected<const coff_section *> Section = 181277ecf90cSReid Kleckner Obj->getSection(Sym->getSectionNumber()); 181377ecf90cSReid Kleckner if (!Section) 181477ecf90cSReid Kleckner return Section.takeError(); 181594382217SMartin Storsjo // Add the initial value of DataRVA to the symbol's offset to find the 181694382217SMartin Storsjo // data it points at. 181794382217SMartin Storsjo uint64_t Offset = Entry.DataRVA + Sym->getValue(); 181894382217SMartin Storsjo ArrayRef<uint8_t> Contents; 181977ecf90cSReid Kleckner if (Error E = Obj->getSectionContents(*Section, Contents)) 1820c55cf4afSBill Wendling return std::move(E); 182194382217SMartin Storsjo if (Offset + Entry.DataSize > Contents.size()) 182294382217SMartin Storsjo return createStringError(object_error::parse_failed, 182394382217SMartin Storsjo "data outside of section"); 182494382217SMartin Storsjo // Return a reference to the data inside the section. 182594382217SMartin Storsjo return StringRef(reinterpret_cast<const char *>(Contents.data()) + Offset, 182694382217SMartin Storsjo Entry.DataSize); 182794382217SMartin Storsjo } else { 182894382217SMartin Storsjo // Relocatable objects need a relocation for the DataRVA field. 182994382217SMartin Storsjo if (Obj->isRelocatableObject()) 183094382217SMartin Storsjo return createStringError(object_error::parse_failed, 183194382217SMartin Storsjo "no relocation found for DataRVA"); 183294382217SMartin Storsjo 183394382217SMartin Storsjo // Locate the section that contains the address that DataRVA points at. 183494382217SMartin Storsjo uint64_t VA = Entry.DataRVA + Obj->getImageBase(); 183594382217SMartin Storsjo for (const SectionRef &S : Obj->sections()) { 183694382217SMartin Storsjo if (VA >= S.getAddress() && 183794382217SMartin Storsjo VA + Entry.DataSize <= S.getAddress() + S.getSize()) { 183894382217SMartin Storsjo uint64_t Offset = VA - S.getAddress(); 183994382217SMartin Storsjo Expected<StringRef> Contents = S.getContents(); 184094382217SMartin Storsjo if (!Contents) 184194382217SMartin Storsjo return Contents.takeError(); 184294382217SMartin Storsjo return Contents->slice(Offset, Offset + Entry.DataSize); 184394382217SMartin Storsjo } 184494382217SMartin Storsjo } 184594382217SMartin Storsjo return createStringError(object_error::parse_failed, 184694382217SMartin Storsjo "address not found in image"); 184794382217SMartin Storsjo } 184894382217SMartin Storsjo } 1849