180814287SRaphael Isemann //===-- ObjectFilePECOFF.cpp ----------------------------------------------===// 2f754f88fSGreg Clayton // 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 6f754f88fSGreg Clayton // 7f754f88fSGreg Clayton //===----------------------------------------------------------------------===// 8f754f88fSGreg Clayton 9f754f88fSGreg Clayton #include "ObjectFilePECOFF.h" 1030c2441aSAleksandr Urakov #include "PECallFrameInfo.h" 11f7d1893fSAdrian McCarthy #include "WindowsMiniDump.h" 12f754f88fSGreg Clayton 13f754f88fSGreg Clayton #include "lldb/Core/FileSpecList.h" 14f754f88fSGreg Clayton #include "lldb/Core/Module.h" 15f4d6de6aSGreg Clayton #include "lldb/Core/ModuleSpec.h" 16f754f88fSGreg Clayton #include "lldb/Core/PluginManager.h" 17f754f88fSGreg Clayton #include "lldb/Core/Section.h" 18f754f88fSGreg Clayton #include "lldb/Core/StreamFile.h" 19f754f88fSGreg Clayton #include "lldb/Symbol/ObjectFile.h" 20f7d1893fSAdrian McCarthy #include "lldb/Target/Process.h" 212756adf3SVirgile Bello #include "lldb/Target/SectionLoadList.h" 222756adf3SVirgile Bello #include "lldb/Target/Target.h" 235f19b907SPavel Labath #include "lldb/Utility/ArchSpec.h" 24666cc0b2SZachary Turner #include "lldb/Utility/DataBufferHeap.h" 255713a05bSZachary Turner #include "lldb/Utility/FileSpec.h" 26037ed1beSAaron Smith #include "lldb/Utility/Log.h" 27bf9a7730SZachary Turner #include "lldb/Utility/StreamString.h" 2838d0632eSPavel Labath #include "lldb/Utility/Timer.h" 29666cc0b2SZachary Turner #include "lldb/Utility/UUID.h" 305f19b907SPavel Labath #include "llvm/BinaryFormat/COFF.h" 31f754f88fSGreg Clayton 32037ed1beSAaron Smith #include "llvm/Object/COFFImportFile.h" 33037ed1beSAaron Smith #include "llvm/Support/Error.h" 343f4a4b36SZachary Turner #include "llvm/Support/MemoryBuffer.h" 353f4a4b36SZachary Turner 36f754f88fSGreg Clayton #define IMAGE_DOS_SIGNATURE 0x5A4D // MZ 37f754f88fSGreg Clayton #define IMAGE_NT_SIGNATURE 0x00004550 // PE00 38f754f88fSGreg Clayton #define OPT_HEADER_MAGIC_PE32 0x010b 39f754f88fSGreg Clayton #define OPT_HEADER_MAGIC_PE32_PLUS 0x020b 40f754f88fSGreg Clayton 41f754f88fSGreg Clayton using namespace lldb; 42f754f88fSGreg Clayton using namespace lldb_private; 43f754f88fSGreg Clayton 44b8d03935SAaron Smith struct CVInfoPdb70 { 45b8d03935SAaron Smith // 16-byte GUID 46b8d03935SAaron Smith struct _Guid { 47b8d03935SAaron Smith llvm::support::ulittle32_t Data1; 48b8d03935SAaron Smith llvm::support::ulittle16_t Data2; 49b8d03935SAaron Smith llvm::support::ulittle16_t Data3; 50b8d03935SAaron Smith uint8_t Data4[8]; 51b8d03935SAaron Smith } Guid; 52b8d03935SAaron Smith 53b8d03935SAaron Smith llvm::support::ulittle32_t Age; 54b8d03935SAaron Smith }; 55b8d03935SAaron Smith 56b8d03935SAaron Smith static UUID GetCoffUUID(llvm::object::COFFObjectFile *coff_obj) { 57b8d03935SAaron Smith if (!coff_obj) 58b8d03935SAaron Smith return UUID(); 59b8d03935SAaron Smith 60b8d03935SAaron Smith const llvm::codeview::DebugInfo *pdb_info = nullptr; 61b8d03935SAaron Smith llvm::StringRef pdb_file; 62b8d03935SAaron Smith 63b8d03935SAaron Smith // This part is similar with what has done in minidump parser. 64b8d03935SAaron Smith if (!coff_obj->getDebugPDBInfo(pdb_info, pdb_file) && pdb_info) { 65b8d03935SAaron Smith if (pdb_info->PDB70.CVSignature == llvm::OMF::Signature::PDB70) { 66b8d03935SAaron Smith using llvm::support::endian::read16be; 67b8d03935SAaron Smith using llvm::support::endian::read32be; 68b8d03935SAaron Smith 69b8d03935SAaron Smith const uint8_t *sig = pdb_info->PDB70.Signature; 70b8d03935SAaron Smith struct CVInfoPdb70 info; 71b8d03935SAaron Smith info.Guid.Data1 = read32be(sig); 72b8d03935SAaron Smith sig += 4; 73b8d03935SAaron Smith info.Guid.Data2 = read16be(sig); 74b8d03935SAaron Smith sig += 2; 75b8d03935SAaron Smith info.Guid.Data3 = read16be(sig); 76b8d03935SAaron Smith sig += 2; 77b8d03935SAaron Smith memcpy(info.Guid.Data4, sig, 8); 78b8d03935SAaron Smith 79b8d03935SAaron Smith // Return 20-byte UUID if the Age is not zero 80b8d03935SAaron Smith if (pdb_info->PDB70.Age) { 81b8d03935SAaron Smith info.Age = read32be(&pdb_info->PDB70.Age); 82b8d03935SAaron Smith return UUID::fromOptionalData(&info, sizeof(info)); 83b8d03935SAaron Smith } 84b8d03935SAaron Smith // Otherwise return 16-byte GUID 85b8d03935SAaron Smith return UUID::fromOptionalData(&info.Guid, sizeof(info.Guid)); 86b8d03935SAaron Smith } 87b8d03935SAaron Smith } 88b8d03935SAaron Smith 89b8d03935SAaron Smith return UUID(); 90b8d03935SAaron Smith } 91b8d03935SAaron Smith 92e84f7841SPavel Labath char ObjectFilePECOFF::ID; 93e84f7841SPavel Labath 94b9c1b51eSKate Stone void ObjectFilePECOFF::Initialize() { 95b9c1b51eSKate Stone PluginManager::RegisterPlugin( 96b9c1b51eSKate Stone GetPluginNameStatic(), GetPluginDescriptionStatic(), CreateInstance, 97b9c1b51eSKate Stone CreateMemoryInstance, GetModuleSpecifications, SaveCore); 98f754f88fSGreg Clayton } 99f754f88fSGreg Clayton 100b9c1b51eSKate Stone void ObjectFilePECOFF::Terminate() { 101f754f88fSGreg Clayton PluginManager::UnregisterPlugin(CreateInstance); 102f754f88fSGreg Clayton } 103f754f88fSGreg Clayton 104b9c1b51eSKate Stone lldb_private::ConstString ObjectFilePECOFF::GetPluginNameStatic() { 10557abc5d6SGreg Clayton static ConstString g_name("pe-coff"); 10657abc5d6SGreg Clayton return g_name; 107f754f88fSGreg Clayton } 108f754f88fSGreg Clayton 109b9c1b51eSKate Stone const char *ObjectFilePECOFF::GetPluginDescriptionStatic() { 110b9c1b51eSKate Stone return "Portable Executable and Common Object File Format object file reader " 111b9c1b51eSKate Stone "(32 and 64 bit)"; 112f754f88fSGreg Clayton } 113f754f88fSGreg Clayton 114b9c1b51eSKate Stone ObjectFile *ObjectFilePECOFF::CreateInstance(const lldb::ModuleSP &module_sp, 1155ce9c565SGreg Clayton DataBufferSP &data_sp, 1165ce9c565SGreg Clayton lldb::offset_t data_offset, 11728e4942bSPavel Labath const lldb_private::FileSpec *file_p, 1185ce9c565SGreg Clayton lldb::offset_t file_offset, 119b9c1b51eSKate Stone lldb::offset_t length) { 12028e4942bSPavel Labath FileSpec file = file_p ? *file_p : FileSpec(); 121b9c1b51eSKate Stone if (!data_sp) { 12250251fc7SPavel Labath data_sp = MapFileData(file, length, file_offset); 1233f4a4b36SZachary Turner if (!data_sp) 1243f4a4b36SZachary Turner return nullptr; 1255ce9c565SGreg Clayton data_offset = 0; 1265ce9c565SGreg Clayton } 1275ce9c565SGreg Clayton 1283f4a4b36SZachary Turner if (!ObjectFilePECOFF::MagicBytesMatch(data_sp)) 1293f4a4b36SZachary Turner return nullptr; 1303f4a4b36SZachary Turner 1315ce9c565SGreg Clayton // Update the data to contain the entire file if it doesn't already 1323f4a4b36SZachary Turner if (data_sp->GetByteSize() < length) { 13350251fc7SPavel Labath data_sp = MapFileData(file, length, file_offset); 1343f4a4b36SZachary Turner if (!data_sp) 1353f4a4b36SZachary Turner return nullptr; 136f754f88fSGreg Clayton } 1373f4a4b36SZachary Turner 138a8f3ae7cSJonas Devlieghere auto objfile_up = std::make_unique<ObjectFilePECOFF>( 13928e4942bSPavel Labath module_sp, data_sp, data_offset, file_p, file_offset, length); 140d5b44036SJonas Devlieghere if (!objfile_up || !objfile_up->ParseHeader()) 1413f4a4b36SZachary Turner return nullptr; 1423f4a4b36SZachary Turner 143037ed1beSAaron Smith // Cache coff binary. 144d5b44036SJonas Devlieghere if (!objfile_up->CreateBinary()) 145037ed1beSAaron Smith return nullptr; 146037ed1beSAaron Smith 147d5b44036SJonas Devlieghere return objfile_up.release(); 148f754f88fSGreg Clayton } 149f754f88fSGreg Clayton 150b9c1b51eSKate Stone ObjectFile *ObjectFilePECOFF::CreateMemoryInstance( 151b9c1b51eSKate Stone const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, 152b9c1b51eSKate Stone const lldb::ProcessSP &process_sp, lldb::addr_t header_addr) { 153344546bdSWalter Erquinigo if (!data_sp || !ObjectFilePECOFF::MagicBytesMatch(data_sp)) 154344546bdSWalter Erquinigo return nullptr; 155a8f3ae7cSJonas Devlieghere auto objfile_up = std::make_unique<ObjectFilePECOFF>( 156344546bdSWalter Erquinigo module_sp, data_sp, process_sp, header_addr); 157d5b44036SJonas Devlieghere if (objfile_up.get() && objfile_up->ParseHeader()) { 158d5b44036SJonas Devlieghere return objfile_up.release(); 159344546bdSWalter Erquinigo } 160344546bdSWalter Erquinigo return nullptr; 161c9660546SGreg Clayton } 162c9660546SGreg Clayton 163b9c1b51eSKate Stone size_t ObjectFilePECOFF::GetModuleSpecifications( 164b9c1b51eSKate Stone const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp, 165b9c1b51eSKate Stone lldb::offset_t data_offset, lldb::offset_t file_offset, 166b9c1b51eSKate Stone lldb::offset_t length, lldb_private::ModuleSpecList &specs) { 16789eb1baeSVirgile Bello const size_t initial_count = specs.GetSize(); 168b8d03935SAaron Smith if (!data_sp || !ObjectFilePECOFF::MagicBytesMatch(data_sp)) 169b8d03935SAaron Smith return initial_count; 17089eb1baeSVirgile Bello 1713db1d138SMartin Storsjö Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT)); 1723db1d138SMartin Storsjö 173b8d03935SAaron Smith auto binary = llvm::object::createBinary(file.GetPath()); 1743db1d138SMartin Storsjö 1753db1d138SMartin Storsjö if (!binary) { 1763db1d138SMartin Storsjö LLDB_LOG_ERROR(log, binary.takeError(), 1773db1d138SMartin Storsjö "Failed to create binary for file ({1}): {0}", file); 178b8d03935SAaron Smith return initial_count; 1793db1d138SMartin Storsjö } 18089eb1baeSVirgile Bello 181b8d03935SAaron Smith if (!binary->getBinary()->isCOFF() && 182b8d03935SAaron Smith !binary->getBinary()->isCOFFImportFile()) 183b8d03935SAaron Smith return initial_count; 18489eb1baeSVirgile Bello 185b8d03935SAaron Smith auto COFFObj = 186b8d03935SAaron Smith llvm::cast<llvm::object::COFFObjectFile>(binary->getBinary()); 187b8d03935SAaron Smith 188b8d03935SAaron Smith ModuleSpec module_spec(file); 189b8d03935SAaron Smith ArchSpec &spec = module_spec.GetArchitecture(); 190b8d03935SAaron Smith lldb_private::UUID &uuid = module_spec.GetUUID(); 191b8d03935SAaron Smith if (!uuid.IsValid()) 192b8d03935SAaron Smith uuid = GetCoffUUID(COFFObj); 193b8d03935SAaron Smith 194b8d03935SAaron Smith switch (COFFObj->getMachine()) { 195b8d03935SAaron Smith case MachineAmd64: 196ad587ae4SZachary Turner spec.SetTriple("x86_64-pc-windows"); 197b8d03935SAaron Smith specs.Append(module_spec); 198b8d03935SAaron Smith break; 199b8d03935SAaron Smith case MachineX86: 200ad587ae4SZachary Turner spec.SetTriple("i386-pc-windows"); 201b8d03935SAaron Smith specs.Append(module_spec); 2025e6f4520SZachary Turner spec.SetTriple("i686-pc-windows"); 203b8d03935SAaron Smith specs.Append(module_spec); 204b8d03935SAaron Smith break; 205b8d03935SAaron Smith case MachineArmNt: 206544c8f48SMartin Storsjo spec.SetTriple("armv7-pc-windows"); 207b8d03935SAaron Smith specs.Append(module_spec); 208b8d03935SAaron Smith break; 209638f072fSMartin Storsjo case MachineArm64: 210674d5543SMartin Storsjo spec.SetTriple("aarch64-pc-windows"); 211638f072fSMartin Storsjo specs.Append(module_spec); 212638f072fSMartin Storsjo break; 213b8d03935SAaron Smith default: 214b8d03935SAaron Smith break; 21589eb1baeSVirgile Bello } 21689eb1baeSVirgile Bello 21789eb1baeSVirgile Bello return specs.GetSize() - initial_count; 218f4d6de6aSGreg Clayton } 219f4d6de6aSGreg Clayton 220b9c1b51eSKate Stone bool ObjectFilePECOFF::SaveCore(const lldb::ProcessSP &process_sp, 221f7d1893fSAdrian McCarthy const lldb_private::FileSpec &outfile, 22297206d57SZachary Turner lldb_private::Status &error) { 223f7d1893fSAdrian McCarthy return SaveMiniDump(process_sp, outfile, error); 224f7d1893fSAdrian McCarthy } 225f7d1893fSAdrian McCarthy 226b9c1b51eSKate Stone bool ObjectFilePECOFF::MagicBytesMatch(DataBufferSP &data_sp) { 2275ce9c565SGreg Clayton DataExtractor data(data_sp, eByteOrderLittle, 4); 228c7bece56SGreg Clayton lldb::offset_t offset = 0; 229f754f88fSGreg Clayton uint16_t magic = data.GetU16(&offset); 230f754f88fSGreg Clayton return magic == IMAGE_DOS_SIGNATURE; 231f754f88fSGreg Clayton } 232f754f88fSGreg Clayton 233b9c1b51eSKate Stone lldb::SymbolType ObjectFilePECOFF::MapSymbolType(uint16_t coff_symbol_type) { 234c35b91ceSAdrian McCarthy // TODO: We need to complete this mapping of COFF symbol types to LLDB ones. 235c35b91ceSAdrian McCarthy // For now, here's a hack to make sure our function have types. 236b9c1b51eSKate Stone const auto complex_type = 237b9c1b51eSKate Stone coff_symbol_type >> llvm::COFF::SCT_COMPLEX_TYPE_SHIFT; 238b9c1b51eSKate Stone if (complex_type == llvm::COFF::IMAGE_SYM_DTYPE_FUNCTION) { 239c35b91ceSAdrian McCarthy return lldb::eSymbolTypeCode; 240c35b91ceSAdrian McCarthy } 241c35b91ceSAdrian McCarthy return lldb::eSymbolTypeInvalid; 242c35b91ceSAdrian McCarthy } 243f754f88fSGreg Clayton 244037ed1beSAaron Smith bool ObjectFilePECOFF::CreateBinary() { 245037ed1beSAaron Smith if (m_owningbin) 246037ed1beSAaron Smith return true; 247037ed1beSAaron Smith 248037ed1beSAaron Smith Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT)); 249037ed1beSAaron Smith 250037ed1beSAaron Smith auto binary = llvm::object::createBinary(m_file.GetPath()); 251037ed1beSAaron Smith if (!binary) { 2523db1d138SMartin Storsjö LLDB_LOG_ERROR(log, binary.takeError(), 2533db1d138SMartin Storsjö "Failed to create binary for file ({1}): {0}", m_file); 254037ed1beSAaron Smith return false; 255037ed1beSAaron Smith } 256037ed1beSAaron Smith 257037ed1beSAaron Smith // Make sure we only handle COFF format. 258037ed1beSAaron Smith if (!binary->getBinary()->isCOFF() && 259037ed1beSAaron Smith !binary->getBinary()->isCOFFImportFile()) 260037ed1beSAaron Smith return false; 261037ed1beSAaron Smith 262037ed1beSAaron Smith m_owningbin = OWNBINType(std::move(*binary)); 26363e5fb76SJonas Devlieghere LLDB_LOGF(log, 26463e5fb76SJonas Devlieghere "%p ObjectFilePECOFF::CreateBinary() module = %p (%s), file = " 265037ed1beSAaron Smith "%s, binary = %p (Bin = %p)", 26663e5fb76SJonas Devlieghere static_cast<void *>(this), static_cast<void *>(GetModule().get()), 267037ed1beSAaron Smith GetModule()->GetSpecificationDescription().c_str(), 268037ed1beSAaron Smith m_file ? m_file.GetPath().c_str() : "<NULL>", 269037ed1beSAaron Smith static_cast<void *>(m_owningbin.getPointer()), 270037ed1beSAaron Smith static_cast<void *>(m_owningbin->getBinary())); 271037ed1beSAaron Smith return true; 272037ed1beSAaron Smith } 273037ed1beSAaron Smith 274e72dfb32SGreg Clayton ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp, 2755ce9c565SGreg Clayton DataBufferSP &data_sp, 2765ce9c565SGreg Clayton lldb::offset_t data_offset, 277f754f88fSGreg Clayton const FileSpec *file, 2785ce9c565SGreg Clayton lldb::offset_t file_offset, 279b9c1b51eSKate Stone lldb::offset_t length) 280b9c1b51eSKate Stone : ObjectFile(module_sp, file, file_offset, length, data_sp, data_offset), 2815c43ffd6SPavel Labath m_dos_header(), m_coff_header(), m_sect_headers(), 282037ed1beSAaron Smith m_entry_point_address(), m_deps_filespec(), m_owningbin() { 283f754f88fSGreg Clayton ::memset(&m_dos_header, 0, sizeof(m_dos_header)); 284f754f88fSGreg Clayton ::memset(&m_coff_header, 0, sizeof(m_coff_header)); 285f754f88fSGreg Clayton } 286f754f88fSGreg Clayton 287344546bdSWalter Erquinigo ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp, 288344546bdSWalter Erquinigo DataBufferSP &header_data_sp, 289344546bdSWalter Erquinigo const lldb::ProcessSP &process_sp, 290344546bdSWalter Erquinigo addr_t header_addr) 291344546bdSWalter Erquinigo : ObjectFile(module_sp, process_sp, header_addr, header_data_sp), 2925c43ffd6SPavel Labath m_dos_header(), m_coff_header(), m_sect_headers(), 293037ed1beSAaron Smith m_entry_point_address(), m_deps_filespec(), m_owningbin() { 294344546bdSWalter Erquinigo ::memset(&m_dos_header, 0, sizeof(m_dos_header)); 295344546bdSWalter Erquinigo ::memset(&m_coff_header, 0, sizeof(m_coff_header)); 296344546bdSWalter Erquinigo } 297344546bdSWalter Erquinigo 298b9c1b51eSKate Stone ObjectFilePECOFF::~ObjectFilePECOFF() {} 299f754f88fSGreg Clayton 300b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseHeader() { 301a1743499SGreg Clayton ModuleSP module_sp(GetModule()); 302b9c1b51eSKate Stone if (module_sp) { 30316ff8604SSaleem Abdulrasool std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex()); 304f754f88fSGreg Clayton m_sect_headers.clear(); 305f754f88fSGreg Clayton m_data.SetByteOrder(eByteOrderLittle); 306c7bece56SGreg Clayton lldb::offset_t offset = 0; 307f754f88fSGreg Clayton 308b9c1b51eSKate Stone if (ParseDOSHeader(m_data, m_dos_header)) { 309f754f88fSGreg Clayton offset = m_dos_header.e_lfanew; 310f754f88fSGreg Clayton uint32_t pe_signature = m_data.GetU32(&offset); 311f754f88fSGreg Clayton if (pe_signature != IMAGE_NT_SIGNATURE) 312f754f88fSGreg Clayton return false; 313b9c1b51eSKate Stone if (ParseCOFFHeader(m_data, &offset, m_coff_header)) { 314f754f88fSGreg Clayton if (m_coff_header.hdrsize > 0) 315f754f88fSGreg Clayton ParseCOFFOptionalHeader(&offset); 316f754f88fSGreg Clayton ParseSectionHeaders(offset); 31728469ca3SGreg Clayton } 318a0f72441SMartin Storsjö m_data.SetAddressByteSize(GetAddressByteSize()); 319f754f88fSGreg Clayton return true; 320f754f88fSGreg Clayton } 321a1743499SGreg Clayton } 322f754f88fSGreg Clayton return false; 323f754f88fSGreg Clayton } 324f754f88fSGreg Clayton 325b9c1b51eSKate Stone bool ObjectFilePECOFF::SetLoadAddress(Target &target, addr_t value, 326b9c1b51eSKate Stone bool value_is_offset) { 3272756adf3SVirgile Bello bool changed = false; 3282756adf3SVirgile Bello ModuleSP module_sp = GetModule(); 329b9c1b51eSKate Stone if (module_sp) { 3302756adf3SVirgile Bello size_t num_loaded_sections = 0; 3312756adf3SVirgile Bello SectionList *section_list = GetSectionList(); 332b9c1b51eSKate Stone if (section_list) { 333b9c1b51eSKate Stone if (!value_is_offset) { 3342756adf3SVirgile Bello value -= m_image_base; 3352756adf3SVirgile Bello } 3362756adf3SVirgile Bello 3372756adf3SVirgile Bello const size_t num_sections = section_list->GetSize(); 3382756adf3SVirgile Bello size_t sect_idx = 0; 3392756adf3SVirgile Bello 340b9c1b51eSKate Stone for (sect_idx = 0; sect_idx < num_sections; ++sect_idx) { 34105097246SAdrian Prantl // Iterate through the object file sections to find all of the sections 34205097246SAdrian Prantl // that have SHF_ALLOC in their flag bits. 3432756adf3SVirgile Bello SectionSP section_sp(section_list->GetSectionAtIndex(sect_idx)); 344b9c1b51eSKate Stone if (section_sp && !section_sp->IsThreadSpecific()) { 345b9c1b51eSKate Stone if (target.GetSectionLoadList().SetSectionLoadAddress( 346b9c1b51eSKate Stone section_sp, section_sp->GetFileAddress() + value)) 3472756adf3SVirgile Bello ++num_loaded_sections; 3482756adf3SVirgile Bello } 3492756adf3SVirgile Bello } 3502756adf3SVirgile Bello changed = num_loaded_sections > 0; 3512756adf3SVirgile Bello } 3522756adf3SVirgile Bello } 3532756adf3SVirgile Bello return changed; 3542756adf3SVirgile Bello } 3552756adf3SVirgile Bello 356b9c1b51eSKate Stone ByteOrder ObjectFilePECOFF::GetByteOrder() const { return eByteOrderLittle; } 357f754f88fSGreg Clayton 358b9c1b51eSKate Stone bool ObjectFilePECOFF::IsExecutable() const { 359237ad974SCharles Davis return (m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0; 360f754f88fSGreg Clayton } 361f754f88fSGreg Clayton 362b9c1b51eSKate Stone uint32_t ObjectFilePECOFF::GetAddressByteSize() const { 363f754f88fSGreg Clayton if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32_PLUS) 364f754f88fSGreg Clayton return 8; 365f754f88fSGreg Clayton else if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32) 366f754f88fSGreg Clayton return 4; 367f754f88fSGreg Clayton return 4; 368f754f88fSGreg Clayton } 369f754f88fSGreg Clayton 370f754f88fSGreg Clayton // NeedsEndianSwap 371f754f88fSGreg Clayton // 37205097246SAdrian Prantl // Return true if an endian swap needs to occur when extracting data from this 37305097246SAdrian Prantl // file. 374b9c1b51eSKate Stone bool ObjectFilePECOFF::NeedsEndianSwap() const { 375f754f88fSGreg Clayton #if defined(__LITTLE_ENDIAN__) 376f754f88fSGreg Clayton return false; 377f754f88fSGreg Clayton #else 378f754f88fSGreg Clayton return true; 379f754f88fSGreg Clayton #endif 380f754f88fSGreg Clayton } 381f754f88fSGreg Clayton // ParseDOSHeader 382b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseDOSHeader(DataExtractor &data, 383b9c1b51eSKate Stone dos_header_t &dos_header) { 384f754f88fSGreg Clayton bool success = false; 385c7bece56SGreg Clayton lldb::offset_t offset = 0; 38689eb1baeSVirgile Bello success = data.ValidOffsetForDataOfSize(0, sizeof(dos_header)); 387f754f88fSGreg Clayton 388b9c1b51eSKate Stone if (success) { 38989eb1baeSVirgile Bello dos_header.e_magic = data.GetU16(&offset); // Magic number 39089eb1baeSVirgile Bello success = dos_header.e_magic == IMAGE_DOS_SIGNATURE; 391f754f88fSGreg Clayton 392b9c1b51eSKate Stone if (success) { 39389eb1baeSVirgile Bello dos_header.e_cblp = data.GetU16(&offset); // Bytes on last page of file 39489eb1baeSVirgile Bello dos_header.e_cp = data.GetU16(&offset); // Pages in file 39589eb1baeSVirgile Bello dos_header.e_crlc = data.GetU16(&offset); // Relocations 396b9c1b51eSKate Stone dos_header.e_cparhdr = 397b9c1b51eSKate Stone data.GetU16(&offset); // Size of header in paragraphs 398b9c1b51eSKate Stone dos_header.e_minalloc = 399b9c1b51eSKate Stone data.GetU16(&offset); // Minimum extra paragraphs needed 400b9c1b51eSKate Stone dos_header.e_maxalloc = 401b9c1b51eSKate Stone data.GetU16(&offset); // Maximum extra paragraphs needed 40289eb1baeSVirgile Bello dos_header.e_ss = data.GetU16(&offset); // Initial (relative) SS value 40389eb1baeSVirgile Bello dos_header.e_sp = data.GetU16(&offset); // Initial SP value 40489eb1baeSVirgile Bello dos_header.e_csum = data.GetU16(&offset); // Checksum 40589eb1baeSVirgile Bello dos_header.e_ip = data.GetU16(&offset); // Initial IP value 40689eb1baeSVirgile Bello dos_header.e_cs = data.GetU16(&offset); // Initial (relative) CS value 407b9c1b51eSKate Stone dos_header.e_lfarlc = 408b9c1b51eSKate Stone data.GetU16(&offset); // File address of relocation table 40989eb1baeSVirgile Bello dos_header.e_ovno = data.GetU16(&offset); // Overlay number 410f754f88fSGreg Clayton 41189eb1baeSVirgile Bello dos_header.e_res[0] = data.GetU16(&offset); // Reserved words 41289eb1baeSVirgile Bello dos_header.e_res[1] = data.GetU16(&offset); // Reserved words 41389eb1baeSVirgile Bello dos_header.e_res[2] = data.GetU16(&offset); // Reserved words 41489eb1baeSVirgile Bello dos_header.e_res[3] = data.GetU16(&offset); // Reserved words 415f754f88fSGreg Clayton 416b9c1b51eSKate Stone dos_header.e_oemid = 417b9c1b51eSKate Stone data.GetU16(&offset); // OEM identifier (for e_oeminfo) 418b9c1b51eSKate Stone dos_header.e_oeminfo = 419b9c1b51eSKate Stone data.GetU16(&offset); // OEM information; e_oemid specific 42089eb1baeSVirgile Bello dos_header.e_res2[0] = data.GetU16(&offset); // Reserved words 42189eb1baeSVirgile Bello dos_header.e_res2[1] = data.GetU16(&offset); // Reserved words 42289eb1baeSVirgile Bello dos_header.e_res2[2] = data.GetU16(&offset); // Reserved words 42389eb1baeSVirgile Bello dos_header.e_res2[3] = data.GetU16(&offset); // Reserved words 42489eb1baeSVirgile Bello dos_header.e_res2[4] = data.GetU16(&offset); // Reserved words 42589eb1baeSVirgile Bello dos_header.e_res2[5] = data.GetU16(&offset); // Reserved words 42689eb1baeSVirgile Bello dos_header.e_res2[6] = data.GetU16(&offset); // Reserved words 42789eb1baeSVirgile Bello dos_header.e_res2[7] = data.GetU16(&offset); // Reserved words 42889eb1baeSVirgile Bello dos_header.e_res2[8] = data.GetU16(&offset); // Reserved words 42989eb1baeSVirgile Bello dos_header.e_res2[9] = data.GetU16(&offset); // Reserved words 430f754f88fSGreg Clayton 431b9c1b51eSKate Stone dos_header.e_lfanew = 432b9c1b51eSKate Stone data.GetU32(&offset); // File address of new exe header 433f754f88fSGreg Clayton } 434f754f88fSGreg Clayton } 435f754f88fSGreg Clayton if (!success) 43689eb1baeSVirgile Bello memset(&dos_header, 0, sizeof(dos_header)); 437f754f88fSGreg Clayton return success; 438f754f88fSGreg Clayton } 439f754f88fSGreg Clayton 440f754f88fSGreg Clayton // ParserCOFFHeader 441b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseCOFFHeader(DataExtractor &data, 442b9c1b51eSKate Stone lldb::offset_t *offset_ptr, 443b9c1b51eSKate Stone coff_header_t &coff_header) { 444b9c1b51eSKate Stone bool success = 445b9c1b51eSKate Stone data.ValidOffsetForDataOfSize(*offset_ptr, sizeof(coff_header)); 446b9c1b51eSKate Stone if (success) { 44789eb1baeSVirgile Bello coff_header.machine = data.GetU16(offset_ptr); 44889eb1baeSVirgile Bello coff_header.nsects = data.GetU16(offset_ptr); 44989eb1baeSVirgile Bello coff_header.modtime = data.GetU32(offset_ptr); 45089eb1baeSVirgile Bello coff_header.symoff = data.GetU32(offset_ptr); 45189eb1baeSVirgile Bello coff_header.nsyms = data.GetU32(offset_ptr); 45289eb1baeSVirgile Bello coff_header.hdrsize = data.GetU16(offset_ptr); 45389eb1baeSVirgile Bello coff_header.flags = data.GetU16(offset_ptr); 454f754f88fSGreg Clayton } 455f754f88fSGreg Clayton if (!success) 45689eb1baeSVirgile Bello memset(&coff_header, 0, sizeof(coff_header)); 457f754f88fSGreg Clayton return success; 458f754f88fSGreg Clayton } 459f754f88fSGreg Clayton 460b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseCOFFOptionalHeader(lldb::offset_t *offset_ptr) { 461f754f88fSGreg Clayton bool success = false; 462c7bece56SGreg Clayton const lldb::offset_t end_offset = *offset_ptr + m_coff_header.hdrsize; 463b9c1b51eSKate Stone if (*offset_ptr < end_offset) { 464f754f88fSGreg Clayton success = true; 465f754f88fSGreg Clayton m_coff_header_opt.magic = m_data.GetU16(offset_ptr); 466f754f88fSGreg Clayton m_coff_header_opt.major_linker_version = m_data.GetU8(offset_ptr); 467f754f88fSGreg Clayton m_coff_header_opt.minor_linker_version = m_data.GetU8(offset_ptr); 468f754f88fSGreg Clayton m_coff_header_opt.code_size = m_data.GetU32(offset_ptr); 469f754f88fSGreg Clayton m_coff_header_opt.data_size = m_data.GetU32(offset_ptr); 470f754f88fSGreg Clayton m_coff_header_opt.bss_size = m_data.GetU32(offset_ptr); 471f754f88fSGreg Clayton m_coff_header_opt.entry = m_data.GetU32(offset_ptr); 472f754f88fSGreg Clayton m_coff_header_opt.code_offset = m_data.GetU32(offset_ptr); 473f754f88fSGreg Clayton 474f754f88fSGreg Clayton const uint32_t addr_byte_size = GetAddressByteSize(); 475f754f88fSGreg Clayton 476b9c1b51eSKate Stone if (*offset_ptr < end_offset) { 477b9c1b51eSKate Stone if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32) { 478f754f88fSGreg Clayton // PE32 only 479f754f88fSGreg Clayton m_coff_header_opt.data_offset = m_data.GetU32(offset_ptr); 480b9c1b51eSKate Stone } else 481f754f88fSGreg Clayton m_coff_header_opt.data_offset = 0; 482f754f88fSGreg Clayton 483b9c1b51eSKate Stone if (*offset_ptr < end_offset) { 484b9c1b51eSKate Stone m_coff_header_opt.image_base = 485b9c1b51eSKate Stone m_data.GetMaxU64(offset_ptr, addr_byte_size); 486f754f88fSGreg Clayton m_coff_header_opt.sect_alignment = m_data.GetU32(offset_ptr); 487f754f88fSGreg Clayton m_coff_header_opt.file_alignment = m_data.GetU32(offset_ptr); 488f754f88fSGreg Clayton m_coff_header_opt.major_os_system_version = m_data.GetU16(offset_ptr); 489f754f88fSGreg Clayton m_coff_header_opt.minor_os_system_version = m_data.GetU16(offset_ptr); 490f754f88fSGreg Clayton m_coff_header_opt.major_image_version = m_data.GetU16(offset_ptr); 491f754f88fSGreg Clayton m_coff_header_opt.minor_image_version = m_data.GetU16(offset_ptr); 492f754f88fSGreg Clayton m_coff_header_opt.major_subsystem_version = m_data.GetU16(offset_ptr); 493f754f88fSGreg Clayton m_coff_header_opt.minor_subsystem_version = m_data.GetU16(offset_ptr); 494f754f88fSGreg Clayton m_coff_header_opt.reserved1 = m_data.GetU32(offset_ptr); 495f754f88fSGreg Clayton m_coff_header_opt.image_size = m_data.GetU32(offset_ptr); 496f754f88fSGreg Clayton m_coff_header_opt.header_size = m_data.GetU32(offset_ptr); 49728469ca3SGreg Clayton m_coff_header_opt.checksum = m_data.GetU32(offset_ptr); 498f754f88fSGreg Clayton m_coff_header_opt.subsystem = m_data.GetU16(offset_ptr); 499f754f88fSGreg Clayton m_coff_header_opt.dll_flags = m_data.GetU16(offset_ptr); 500b9c1b51eSKate Stone m_coff_header_opt.stack_reserve_size = 501b9c1b51eSKate Stone m_data.GetMaxU64(offset_ptr, addr_byte_size); 502b9c1b51eSKate Stone m_coff_header_opt.stack_commit_size = 503b9c1b51eSKate Stone m_data.GetMaxU64(offset_ptr, addr_byte_size); 504b9c1b51eSKate Stone m_coff_header_opt.heap_reserve_size = 505b9c1b51eSKate Stone m_data.GetMaxU64(offset_ptr, addr_byte_size); 506b9c1b51eSKate Stone m_coff_header_opt.heap_commit_size = 507b9c1b51eSKate Stone m_data.GetMaxU64(offset_ptr, addr_byte_size); 508f754f88fSGreg Clayton m_coff_header_opt.loader_flags = m_data.GetU32(offset_ptr); 509f754f88fSGreg Clayton uint32_t num_data_dir_entries = m_data.GetU32(offset_ptr); 510f754f88fSGreg Clayton m_coff_header_opt.data_dirs.clear(); 511f754f88fSGreg Clayton m_coff_header_opt.data_dirs.resize(num_data_dir_entries); 512f754f88fSGreg Clayton uint32_t i; 513b9c1b51eSKate Stone for (i = 0; i < num_data_dir_entries; i++) { 514f754f88fSGreg Clayton m_coff_header_opt.data_dirs[i].vmaddr = m_data.GetU32(offset_ptr); 515f754f88fSGreg Clayton m_coff_header_opt.data_dirs[i].vmsize = m_data.GetU32(offset_ptr); 516f754f88fSGreg Clayton } 5172756adf3SVirgile Bello 5182756adf3SVirgile Bello m_image_base = m_coff_header_opt.image_base; 519f754f88fSGreg Clayton } 520f754f88fSGreg Clayton } 521f754f88fSGreg Clayton } 522f754f88fSGreg Clayton // Make sure we are on track for section data which follows 523f754f88fSGreg Clayton *offset_ptr = end_offset; 524f754f88fSGreg Clayton return success; 525f754f88fSGreg Clayton } 526f754f88fSGreg Clayton 52730c2441aSAleksandr Urakov uint32_t ObjectFilePECOFF::GetRVA(const Address &addr) const { 52830c2441aSAleksandr Urakov return addr.GetFileAddress() - m_image_base; 52930c2441aSAleksandr Urakov } 53030c2441aSAleksandr Urakov 53130c2441aSAleksandr Urakov Address ObjectFilePECOFF::GetAddress(uint32_t rva) { 53230c2441aSAleksandr Urakov SectionList *sect_list = GetSectionList(); 53330c2441aSAleksandr Urakov if (!sect_list) 53430c2441aSAleksandr Urakov return Address(GetFileAddress(rva)); 53530c2441aSAleksandr Urakov 53630c2441aSAleksandr Urakov return Address(GetFileAddress(rva), sect_list); 53730c2441aSAleksandr Urakov } 53830c2441aSAleksandr Urakov 53930c2441aSAleksandr Urakov lldb::addr_t ObjectFilePECOFF::GetFileAddress(uint32_t rva) const { 54030c2441aSAleksandr Urakov return m_image_base + rva; 54130c2441aSAleksandr Urakov } 54230c2441aSAleksandr Urakov 543344546bdSWalter Erquinigo DataExtractor ObjectFilePECOFF::ReadImageData(uint32_t offset, size_t size) { 54430c2441aSAleksandr Urakov if (!size) 54530c2441aSAleksandr Urakov return {}; 54630c2441aSAleksandr Urakov 547344546bdSWalter Erquinigo if (m_file) { 5487f6a7a37SZachary Turner // A bit of a hack, but we intend to write to this buffer, so we can't 5497f6a7a37SZachary Turner // mmap it. 55050251fc7SPavel Labath auto buffer_sp = MapFileData(m_file, size, offset); 551344546bdSWalter Erquinigo return DataExtractor(buffer_sp, GetByteOrder(), GetAddressByteSize()); 552344546bdSWalter Erquinigo } 553344546bdSWalter Erquinigo ProcessSP process_sp(m_process_wp.lock()); 554344546bdSWalter Erquinigo DataExtractor data; 555344546bdSWalter Erquinigo if (process_sp) { 556a8f3ae7cSJonas Devlieghere auto data_up = std::make_unique<DataBufferHeap>(size, 0); 55797206d57SZachary Turner Status readmem_error; 558344546bdSWalter Erquinigo size_t bytes_read = 559d5b44036SJonas Devlieghere process_sp->ReadMemory(m_image_base + offset, data_up->GetBytes(), 560d5b44036SJonas Devlieghere data_up->GetByteSize(), readmem_error); 561344546bdSWalter Erquinigo if (bytes_read == size) { 562d5b44036SJonas Devlieghere DataBufferSP buffer_sp(data_up.release()); 563344546bdSWalter Erquinigo data.SetData(buffer_sp, 0, buffer_sp->GetByteSize()); 564344546bdSWalter Erquinigo } 565344546bdSWalter Erquinigo } 566344546bdSWalter Erquinigo return data; 567344546bdSWalter Erquinigo } 568344546bdSWalter Erquinigo 56930c2441aSAleksandr Urakov DataExtractor ObjectFilePECOFF::ReadImageDataByRVA(uint32_t rva, size_t size) { 57030c2441aSAleksandr Urakov if (m_file) { 57130c2441aSAleksandr Urakov Address addr = GetAddress(rva); 5727e1a3076SMartin Storsjö SectionSP sect = addr.GetSection(); 5737e1a3076SMartin Storsjö if (!sect) 5747e1a3076SMartin Storsjö return {}; 5757e1a3076SMartin Storsjö rva = sect->GetFileOffset() + addr.GetOffset(); 57630c2441aSAleksandr Urakov } 57730c2441aSAleksandr Urakov 57830c2441aSAleksandr Urakov return ReadImageData(rva, size); 57930c2441aSAleksandr Urakov } 58030c2441aSAleksandr Urakov 581f754f88fSGreg Clayton // ParseSectionHeaders 582b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseSectionHeaders( 583b9c1b51eSKate Stone uint32_t section_header_data_offset) { 584f754f88fSGreg Clayton const uint32_t nsects = m_coff_header.nsects; 585f754f88fSGreg Clayton m_sect_headers.clear(); 586f754f88fSGreg Clayton 587b9c1b51eSKate Stone if (nsects > 0) { 588f754f88fSGreg Clayton const size_t section_header_byte_size = nsects * sizeof(section_header_t); 589344546bdSWalter Erquinigo DataExtractor section_header_data = 590344546bdSWalter Erquinigo ReadImageData(section_header_data_offset, section_header_byte_size); 591f754f88fSGreg Clayton 592c7bece56SGreg Clayton lldb::offset_t offset = 0; 593b9c1b51eSKate Stone if (section_header_data.ValidOffsetForDataOfSize( 594b9c1b51eSKate Stone offset, section_header_byte_size)) { 595f754f88fSGreg Clayton m_sect_headers.resize(nsects); 596f754f88fSGreg Clayton 597b9c1b51eSKate Stone for (uint32_t idx = 0; idx < nsects; ++idx) { 598f754f88fSGreg Clayton const void *name_data = section_header_data.GetData(&offset, 8); 599b9c1b51eSKate Stone if (name_data) { 600f754f88fSGreg Clayton memcpy(m_sect_headers[idx].name, name_data, 8); 601f754f88fSGreg Clayton m_sect_headers[idx].vmsize = section_header_data.GetU32(&offset); 602f754f88fSGreg Clayton m_sect_headers[idx].vmaddr = section_header_data.GetU32(&offset); 603f754f88fSGreg Clayton m_sect_headers[idx].size = section_header_data.GetU32(&offset); 604f754f88fSGreg Clayton m_sect_headers[idx].offset = section_header_data.GetU32(&offset); 605f754f88fSGreg Clayton m_sect_headers[idx].reloff = section_header_data.GetU32(&offset); 606f754f88fSGreg Clayton m_sect_headers[idx].lineoff = section_header_data.GetU32(&offset); 607f754f88fSGreg Clayton m_sect_headers[idx].nreloc = section_header_data.GetU16(&offset); 608f754f88fSGreg Clayton m_sect_headers[idx].nline = section_header_data.GetU16(&offset); 609f754f88fSGreg Clayton m_sect_headers[idx].flags = section_header_data.GetU32(&offset); 610f754f88fSGreg Clayton } 611f754f88fSGreg Clayton } 612f754f88fSGreg Clayton } 613f754f88fSGreg Clayton } 614f754f88fSGreg Clayton 615a6682a41SJonas Devlieghere return !m_sect_headers.empty(); 616f754f88fSGreg Clayton } 617f754f88fSGreg Clayton 6182886e4a0SPavel Labath llvm::StringRef ObjectFilePECOFF::GetSectionName(const section_header_t §) { 6192886e4a0SPavel Labath llvm::StringRef hdr_name(sect.name, llvm::array_lengthof(sect.name)); 6202886e4a0SPavel Labath hdr_name = hdr_name.split('\0').first; 6212886e4a0SPavel Labath if (hdr_name.consume_front("/")) { 6222886e4a0SPavel Labath lldb::offset_t stroff; 6232886e4a0SPavel Labath if (!to_integer(hdr_name, stroff, 10)) 6242886e4a0SPavel Labath return ""; 625b9c1b51eSKate Stone lldb::offset_t string_file_offset = 626b9c1b51eSKate Stone m_coff_header.symoff + (m_coff_header.nsyms * 18) + stroff; 6272886e4a0SPavel Labath if (const char *name = m_data.GetCStr(&string_file_offset)) 6282886e4a0SPavel Labath return name; 6292886e4a0SPavel Labath return ""; 630f754f88fSGreg Clayton } 6312886e4a0SPavel Labath return hdr_name; 632f754f88fSGreg Clayton } 633f754f88fSGreg Clayton 634f754f88fSGreg Clayton // GetNListSymtab 635b9c1b51eSKate Stone Symtab *ObjectFilePECOFF::GetSymtab() { 636a1743499SGreg Clayton ModuleSP module_sp(GetModule()); 637b9c1b51eSKate Stone if (module_sp) { 63816ff8604SSaleem Abdulrasool std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex()); 639248a1305SKonrad Kleine if (m_symtab_up == nullptr) { 640f754f88fSGreg Clayton SectionList *sect_list = GetSectionList(); 641d5b44036SJonas Devlieghere m_symtab_up.reset(new Symtab(this)); 642d5b44036SJonas Devlieghere std::lock_guard<std::recursive_mutex> guard(m_symtab_up->GetMutex()); 64328469ca3SGreg Clayton 64428469ca3SGreg Clayton const uint32_t num_syms = m_coff_header.nsyms; 64528469ca3SGreg Clayton 646344546bdSWalter Erquinigo if (m_file && num_syms > 0 && m_coff_header.symoff > 0) { 6470076e715SGreg Clayton const uint32_t symbol_size = 18; 64828469ca3SGreg Clayton const size_t symbol_data_size = num_syms * symbol_size; 649c35b91ceSAdrian McCarthy // Include the 4-byte string table size at the end of the symbols 650344546bdSWalter Erquinigo DataExtractor symtab_data = 651344546bdSWalter Erquinigo ReadImageData(m_coff_header.symoff, symbol_data_size + 4); 652c7bece56SGreg Clayton lldb::offset_t offset = symbol_data_size; 65328469ca3SGreg Clayton const uint32_t strtab_size = symtab_data.GetU32(&offset); 654344546bdSWalter Erquinigo if (strtab_size > 0) { 655344546bdSWalter Erquinigo DataExtractor strtab_data = ReadImageData( 656344546bdSWalter Erquinigo m_coff_header.symoff + symbol_data_size, strtab_size); 65728469ca3SGreg Clayton 6580076e715SGreg Clayton // First 4 bytes should be zeroed after strtab_size has been read, 6590076e715SGreg Clayton // because it is used as offset 0 to encode a NULL string. 660f76e099cSSaleem Abdulrasool uint32_t *strtab_data_start = const_cast<uint32_t *>( 661f76e099cSSaleem Abdulrasool reinterpret_cast<const uint32_t *>(strtab_data.GetDataStart())); 6620076e715SGreg Clayton strtab_data_start[0] = 0; 6630076e715SGreg Clayton 66428469ca3SGreg Clayton offset = 0; 66528469ca3SGreg Clayton std::string symbol_name; 666d5b44036SJonas Devlieghere Symbol *symbols = m_symtab_up->Resize(num_syms); 667b9c1b51eSKate Stone for (uint32_t i = 0; i < num_syms; ++i) { 668f754f88fSGreg Clayton coff_symbol_t symbol; 66928469ca3SGreg Clayton const uint32_t symbol_offset = offset; 670248a1305SKonrad Kleine const char *symbol_name_cstr = nullptr; 671c35b91ceSAdrian McCarthy // If the first 4 bytes of the symbol string are zero, then they 672c35b91ceSAdrian McCarthy // are followed by a 4-byte string table offset. Else these 67328469ca3SGreg Clayton // 8 bytes contain the symbol name 674b9c1b51eSKate Stone if (symtab_data.GetU32(&offset) == 0) { 67505097246SAdrian Prantl // Long string that doesn't fit into the symbol table name, so 67605097246SAdrian Prantl // now we must read the 4 byte string table offset 67728469ca3SGreg Clayton uint32_t strtab_offset = symtab_data.GetU32(&offset); 67828469ca3SGreg Clayton symbol_name_cstr = strtab_data.PeekCStr(strtab_offset); 67928469ca3SGreg Clayton symbol_name.assign(symbol_name_cstr); 680b9c1b51eSKate Stone } else { 681b9c1b51eSKate Stone // Short string that fits into the symbol table name which is 8 682b9c1b51eSKate Stone // bytes 68328469ca3SGreg Clayton offset += sizeof(symbol.name) - 4; // Skip remaining 68428469ca3SGreg Clayton symbol_name_cstr = symtab_data.PeekCStr(symbol_offset); 685248a1305SKonrad Kleine if (symbol_name_cstr == nullptr) 686f754f88fSGreg Clayton break; 68728469ca3SGreg Clayton symbol_name.assign(symbol_name_cstr, sizeof(symbol.name)); 68828469ca3SGreg Clayton } 68928469ca3SGreg Clayton symbol.value = symtab_data.GetU32(&offset); 69028469ca3SGreg Clayton symbol.sect = symtab_data.GetU16(&offset); 69128469ca3SGreg Clayton symbol.type = symtab_data.GetU16(&offset); 69228469ca3SGreg Clayton symbol.storage = symtab_data.GetU8(&offset); 69328469ca3SGreg Clayton symbol.naux = symtab_data.GetU8(&offset); 694037520e9SGreg Clayton symbols[i].GetMangled().SetValue(ConstString(symbol_name.c_str())); 695b9c1b51eSKate Stone if ((int16_t)symbol.sect >= 1) { 6964394b5beSMartin Storsjö Address symbol_addr(sect_list->FindSectionByID(symbol.sect), 697b9c1b51eSKate Stone symbol.value); 698358cf1eaSGreg Clayton symbols[i].GetAddressRef() = symbol_addr; 699c35b91ceSAdrian McCarthy symbols[i].SetType(MapSymbolType(symbol.type)); 7000076e715SGreg Clayton } 701f754f88fSGreg Clayton 702b9c1b51eSKate Stone if (symbol.naux > 0) { 703f754f88fSGreg Clayton i += symbol.naux; 7040076e715SGreg Clayton offset += symbol_size; 7050076e715SGreg Clayton } 706f754f88fSGreg Clayton } 707f754f88fSGreg Clayton } 708344546bdSWalter Erquinigo } 709a4fe3a12SVirgile Bello 710a4fe3a12SVirgile Bello // Read export header 711b9c1b51eSKate Stone if (coff_data_dir_export_table < m_coff_header_opt.data_dirs.size() && 712b9c1b51eSKate Stone m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmsize > 0 && 713b9c1b51eSKate Stone m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmaddr > 0) { 714a4fe3a12SVirgile Bello export_directory_entry export_table; 715b9c1b51eSKate Stone uint32_t data_start = 716b9c1b51eSKate Stone m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmaddr; 717344546bdSWalter Erquinigo 71830c2441aSAleksandr Urakov DataExtractor symtab_data = ReadImageDataByRVA( 71930c2441aSAleksandr Urakov data_start, m_coff_header_opt.data_dirs[0].vmsize); 720a4fe3a12SVirgile Bello lldb::offset_t offset = 0; 721a4fe3a12SVirgile Bello 722a4fe3a12SVirgile Bello // Read export_table header 723a4fe3a12SVirgile Bello export_table.characteristics = symtab_data.GetU32(&offset); 724a4fe3a12SVirgile Bello export_table.time_date_stamp = symtab_data.GetU32(&offset); 725a4fe3a12SVirgile Bello export_table.major_version = symtab_data.GetU16(&offset); 726a4fe3a12SVirgile Bello export_table.minor_version = symtab_data.GetU16(&offset); 727a4fe3a12SVirgile Bello export_table.name = symtab_data.GetU32(&offset); 728a4fe3a12SVirgile Bello export_table.base = symtab_data.GetU32(&offset); 729a4fe3a12SVirgile Bello export_table.number_of_functions = symtab_data.GetU32(&offset); 730a4fe3a12SVirgile Bello export_table.number_of_names = symtab_data.GetU32(&offset); 731a4fe3a12SVirgile Bello export_table.address_of_functions = symtab_data.GetU32(&offset); 732a4fe3a12SVirgile Bello export_table.address_of_names = symtab_data.GetU32(&offset); 733a4fe3a12SVirgile Bello export_table.address_of_name_ordinals = symtab_data.GetU32(&offset); 734a4fe3a12SVirgile Bello 735a4fe3a12SVirgile Bello bool has_ordinal = export_table.address_of_name_ordinals != 0; 736a4fe3a12SVirgile Bello 737a4fe3a12SVirgile Bello lldb::offset_t name_offset = export_table.address_of_names - data_start; 738b9c1b51eSKate Stone lldb::offset_t name_ordinal_offset = 739b9c1b51eSKate Stone export_table.address_of_name_ordinals - data_start; 740a4fe3a12SVirgile Bello 741d5b44036SJonas Devlieghere Symbol *symbols = m_symtab_up->Resize(export_table.number_of_names); 742a4fe3a12SVirgile Bello 743a4fe3a12SVirgile Bello std::string symbol_name; 744a4fe3a12SVirgile Bello 745a4fe3a12SVirgile Bello // Read each export table entry 746b9c1b51eSKate Stone for (size_t i = 0; i < export_table.number_of_names; ++i) { 747b9c1b51eSKate Stone uint32_t name_ordinal = 748b9c1b51eSKate Stone has_ordinal ? symtab_data.GetU16(&name_ordinal_offset) : i; 749a4fe3a12SVirgile Bello uint32_t name_address = symtab_data.GetU32(&name_offset); 750a4fe3a12SVirgile Bello 751b9c1b51eSKate Stone const char *symbol_name_cstr = 752b9c1b51eSKate Stone symtab_data.PeekCStr(name_address - data_start); 753a4fe3a12SVirgile Bello symbol_name.assign(symbol_name_cstr); 754a4fe3a12SVirgile Bello 755b9c1b51eSKate Stone lldb::offset_t function_offset = export_table.address_of_functions - 756b9c1b51eSKate Stone data_start + 757b9c1b51eSKate Stone sizeof(uint32_t) * name_ordinal; 758a4fe3a12SVirgile Bello uint32_t function_rva = symtab_data.GetU32(&function_offset); 759a4fe3a12SVirgile Bello 760b9c1b51eSKate Stone Address symbol_addr(m_coff_header_opt.image_base + function_rva, 761b9c1b51eSKate Stone sect_list); 762a4fe3a12SVirgile Bello symbols[i].GetMangled().SetValue(ConstString(symbol_name.c_str())); 763358cf1eaSGreg Clayton symbols[i].GetAddressRef() = symbol_addr; 764a4fe3a12SVirgile Bello symbols[i].SetType(lldb::eSymbolTypeCode); 765a4fe3a12SVirgile Bello symbols[i].SetDebug(true); 766a4fe3a12SVirgile Bello } 767a4fe3a12SVirgile Bello } 768d5b44036SJonas Devlieghere m_symtab_up->CalculateSymbolSizes(); 769f754f88fSGreg Clayton } 770a1743499SGreg Clayton } 771d5b44036SJonas Devlieghere return m_symtab_up.get(); 772f754f88fSGreg Clayton } 773f754f88fSGreg Clayton 77430c2441aSAleksandr Urakov std::unique_ptr<CallFrameInfo> ObjectFilePECOFF::CreateCallFrameInfo() { 77530c2441aSAleksandr Urakov if (coff_data_dir_exception_table >= m_coff_header_opt.data_dirs.size()) 77630c2441aSAleksandr Urakov return {}; 77730c2441aSAleksandr Urakov 77830c2441aSAleksandr Urakov data_directory data_dir_exception = 77930c2441aSAleksandr Urakov m_coff_header_opt.data_dirs[coff_data_dir_exception_table]; 78030c2441aSAleksandr Urakov if (!data_dir_exception.vmaddr) 78130c2441aSAleksandr Urakov return {}; 78230c2441aSAleksandr Urakov 78330c2441aSAleksandr Urakov return std::make_unique<PECallFrameInfo>(*this, data_dir_exception.vmaddr, 78430c2441aSAleksandr Urakov data_dir_exception.vmsize); 78530c2441aSAleksandr Urakov } 78630c2441aSAleksandr Urakov 787b9c1b51eSKate Stone bool ObjectFilePECOFF::IsStripped() { 7883046e668SGreg Clayton // TODO: determine this for COFF 7893046e668SGreg Clayton return false; 7903046e668SGreg Clayton } 7913046e668SGreg Clayton 7922e5bb6d8SMartin Storsjö SectionType ObjectFilePECOFF::GetSectionType(llvm::StringRef sect_name, 7932e5bb6d8SMartin Storsjö const section_header_t §) { 7942e5bb6d8SMartin Storsjö ConstString const_sect_name(sect_name); 7952e5bb6d8SMartin Storsjö static ConstString g_code_sect_name(".code"); 7962e5bb6d8SMartin Storsjö static ConstString g_CODE_sect_name("CODE"); 7972e5bb6d8SMartin Storsjö static ConstString g_data_sect_name(".data"); 7982e5bb6d8SMartin Storsjö static ConstString g_DATA_sect_name("DATA"); 7992e5bb6d8SMartin Storsjö static ConstString g_bss_sect_name(".bss"); 8002e5bb6d8SMartin Storsjö static ConstString g_BSS_sect_name("BSS"); 8012e5bb6d8SMartin Storsjö 8022e5bb6d8SMartin Storsjö if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_CODE && 8032e5bb6d8SMartin Storsjö ((const_sect_name == g_code_sect_name) || 8042e5bb6d8SMartin Storsjö (const_sect_name == g_CODE_sect_name))) { 8052e5bb6d8SMartin Storsjö return eSectionTypeCode; 8062e5bb6d8SMartin Storsjö } 8072e5bb6d8SMartin Storsjö if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA && 8082e5bb6d8SMartin Storsjö ((const_sect_name == g_data_sect_name) || 8092e5bb6d8SMartin Storsjö (const_sect_name == g_DATA_sect_name))) { 8102e5bb6d8SMartin Storsjö if (sect.size == 0 && sect.offset == 0) 8112e5bb6d8SMartin Storsjö return eSectionTypeZeroFill; 8122e5bb6d8SMartin Storsjö else 8132e5bb6d8SMartin Storsjö return eSectionTypeData; 8142e5bb6d8SMartin Storsjö } 8152e5bb6d8SMartin Storsjö if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA && 8162e5bb6d8SMartin Storsjö ((const_sect_name == g_bss_sect_name) || 8172e5bb6d8SMartin Storsjö (const_sect_name == g_BSS_sect_name))) { 8182e5bb6d8SMartin Storsjö if (sect.size == 0) 8192e5bb6d8SMartin Storsjö return eSectionTypeZeroFill; 8202e5bb6d8SMartin Storsjö else 8212e5bb6d8SMartin Storsjö return eSectionTypeData; 8222e5bb6d8SMartin Storsjö } 8232e5bb6d8SMartin Storsjö 8242e5bb6d8SMartin Storsjö SectionType section_type = 8252e5bb6d8SMartin Storsjö llvm::StringSwitch<SectionType>(sect_name) 8262e5bb6d8SMartin Storsjö .Case(".debug", eSectionTypeDebug) 8272e5bb6d8SMartin Storsjö .Case(".stabstr", eSectionTypeDataCString) 8282e5bb6d8SMartin Storsjö .Case(".reloc", eSectionTypeOther) 8292e5bb6d8SMartin Storsjö .Case(".debug_abbrev", eSectionTypeDWARFDebugAbbrev) 8302e5bb6d8SMartin Storsjö .Case(".debug_aranges", eSectionTypeDWARFDebugAranges) 8312e5bb6d8SMartin Storsjö .Case(".debug_frame", eSectionTypeDWARFDebugFrame) 8322e5bb6d8SMartin Storsjö .Case(".debug_info", eSectionTypeDWARFDebugInfo) 8332e5bb6d8SMartin Storsjö .Case(".debug_line", eSectionTypeDWARFDebugLine) 8342e5bb6d8SMartin Storsjö .Case(".debug_loc", eSectionTypeDWARFDebugLoc) 8352e5bb6d8SMartin Storsjö .Case(".debug_loclists", eSectionTypeDWARFDebugLocLists) 8362e5bb6d8SMartin Storsjö .Case(".debug_macinfo", eSectionTypeDWARFDebugMacInfo) 8372e5bb6d8SMartin Storsjö .Case(".debug_names", eSectionTypeDWARFDebugNames) 8382e5bb6d8SMartin Storsjö .Case(".debug_pubnames", eSectionTypeDWARFDebugPubNames) 8392e5bb6d8SMartin Storsjö .Case(".debug_pubtypes", eSectionTypeDWARFDebugPubTypes) 8402e5bb6d8SMartin Storsjö .Case(".debug_ranges", eSectionTypeDWARFDebugRanges) 8412e5bb6d8SMartin Storsjö .Case(".debug_str", eSectionTypeDWARFDebugStr) 8422e5bb6d8SMartin Storsjö .Case(".debug_types", eSectionTypeDWARFDebugTypes) 843934c025eSMartin Storsjö // .eh_frame can be truncated to 8 chars. 844934c025eSMartin Storsjö .Cases(".eh_frame", ".eh_fram", eSectionTypeEHFrame) 8452e5bb6d8SMartin Storsjö .Case(".gosymtab", eSectionTypeGoSymtab) 8462e5bb6d8SMartin Storsjö .Default(eSectionTypeInvalid); 8472e5bb6d8SMartin Storsjö if (section_type != eSectionTypeInvalid) 8482e5bb6d8SMartin Storsjö return section_type; 8492e5bb6d8SMartin Storsjö 8502e5bb6d8SMartin Storsjö if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_CODE) 8512e5bb6d8SMartin Storsjö return eSectionTypeCode; 8522e5bb6d8SMartin Storsjö if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA) 8532e5bb6d8SMartin Storsjö return eSectionTypeData; 8542e5bb6d8SMartin Storsjö if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) { 8552e5bb6d8SMartin Storsjö if (sect.size == 0) 8562e5bb6d8SMartin Storsjö return eSectionTypeZeroFill; 8572e5bb6d8SMartin Storsjö else 8582e5bb6d8SMartin Storsjö return eSectionTypeData; 8592e5bb6d8SMartin Storsjö } 8602e5bb6d8SMartin Storsjö return eSectionTypeOther; 8612e5bb6d8SMartin Storsjö } 8622e5bb6d8SMartin Storsjö 863b9c1b51eSKate Stone void ObjectFilePECOFF::CreateSections(SectionList &unified_section_list) { 864d5b44036SJonas Devlieghere if (m_sections_up) 86588a2c2a4SPavel Labath return; 866d5b44036SJonas Devlieghere m_sections_up.reset(new SectionList()); 8673046e668SGreg Clayton 868a1743499SGreg Clayton ModuleSP module_sp(GetModule()); 869b9c1b51eSKate Stone if (module_sp) { 87016ff8604SSaleem Abdulrasool std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex()); 8717db8b5c4SPavel Labath 87273a7a55cSPavel Labath SectionSP header_sp = std::make_shared<Section>( 87373a7a55cSPavel Labath module_sp, this, ~user_id_t(0), ConstString("PECOFF header"), 87473a7a55cSPavel Labath eSectionTypeOther, m_coff_header_opt.image_base, 87573a7a55cSPavel Labath m_coff_header_opt.header_size, 87673a7a55cSPavel Labath /*file_offset*/ 0, m_coff_header_opt.header_size, 87773a7a55cSPavel Labath m_coff_header_opt.sect_alignment, 8787db8b5c4SPavel Labath /*flags*/ 0); 879f1e0ae34SPavel Labath header_sp->SetPermissions(ePermissionsReadable); 88073a7a55cSPavel Labath m_sections_up->AddSection(header_sp); 88173a7a55cSPavel Labath unified_section_list.AddSection(header_sp); 8827db8b5c4SPavel Labath 883f754f88fSGreg Clayton const uint32_t nsects = m_sect_headers.size(); 884e72dfb32SGreg Clayton ModuleSP module_sp(GetModule()); 885b9c1b51eSKate Stone for (uint32_t idx = 0; idx < nsects; ++idx) { 8862e5bb6d8SMartin Storsjö llvm::StringRef sect_name = GetSectionName(m_sect_headers[idx]); 8872e5bb6d8SMartin Storsjö ConstString const_sect_name(sect_name); 8882e5bb6d8SMartin Storsjö SectionType section_type = GetSectionType(sect_name, m_sect_headers[idx]); 889f754f88fSGreg Clayton 890b9c1b51eSKate Stone SectionSP section_sp(new Section( 891b9c1b51eSKate Stone module_sp, // Module to which this section belongs 892a7499c98SMichael Sartain this, // Object file to which this section belongs 8937db8b5c4SPavel Labath idx + 1, // Section ID is the 1 based section index. 894f754f88fSGreg Clayton const_sect_name, // Name of this section 8957db8b5c4SPavel Labath section_type, 89673a7a55cSPavel Labath m_coff_header_opt.image_base + 897b9c1b51eSKate Stone m_sect_headers[idx].vmaddr, // File VM address == addresses as 898b9c1b51eSKate Stone // they are found in the object file 899f754f88fSGreg Clayton m_sect_headers[idx].vmsize, // VM size in bytes of this section 900b9c1b51eSKate Stone m_sect_headers[idx] 901b9c1b51eSKate Stone .offset, // Offset to the data for this section in the file 902b9c1b51eSKate Stone m_sect_headers[idx] 903b9c1b51eSKate Stone .size, // Size in bytes of this section as found in the file 90448672afbSGreg Clayton m_coff_header_opt.sect_alignment, // Section alignment 905f754f88fSGreg Clayton m_sect_headers[idx].flags)); // Flags for this section 906f754f88fSGreg Clayton 907f1e0ae34SPavel Labath uint32_t permissions = 0; 908f1e0ae34SPavel Labath if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_EXECUTE) 909f1e0ae34SPavel Labath permissions |= ePermissionsExecutable; 910f1e0ae34SPavel Labath if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_READ) 911f1e0ae34SPavel Labath permissions |= ePermissionsReadable; 912f1e0ae34SPavel Labath if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_WRITE) 913f1e0ae34SPavel Labath permissions |= ePermissionsWritable; 914f1e0ae34SPavel Labath section_sp->SetPermissions(permissions); 915f1e0ae34SPavel Labath 91673a7a55cSPavel Labath m_sections_up->AddSection(section_sp); 91773a7a55cSPavel Labath unified_section_list.AddSection(section_sp); 918f754f88fSGreg Clayton } 919f754f88fSGreg Clayton } 920a1743499SGreg Clayton } 921f754f88fSGreg Clayton 922b8d03935SAaron Smith UUID ObjectFilePECOFF::GetUUID() { 923b8d03935SAaron Smith if (m_uuid.IsValid()) 924b8d03935SAaron Smith return m_uuid; 925b8d03935SAaron Smith 926b8d03935SAaron Smith if (!CreateBinary()) 927b8d03935SAaron Smith return UUID(); 928b8d03935SAaron Smith 929b8d03935SAaron Smith auto COFFObj = 930b8d03935SAaron Smith llvm::cast<llvm::object::COFFObjectFile>(m_owningbin->getBinary()); 931b8d03935SAaron Smith 932b8d03935SAaron Smith m_uuid = GetCoffUUID(COFFObj); 933b8d03935SAaron Smith return m_uuid; 934b8d03935SAaron Smith } 935f754f88fSGreg Clayton 936037ed1beSAaron Smith uint32_t ObjectFilePECOFF::ParseDependentModules() { 937037ed1beSAaron Smith ModuleSP module_sp(GetModule()); 938037ed1beSAaron Smith if (!module_sp) 939f754f88fSGreg Clayton return 0; 940037ed1beSAaron Smith 941037ed1beSAaron Smith std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex()); 942037ed1beSAaron Smith if (m_deps_filespec) 943037ed1beSAaron Smith return m_deps_filespec->GetSize(); 944037ed1beSAaron Smith 945037ed1beSAaron Smith // Cache coff binary if it is not done yet. 946037ed1beSAaron Smith if (!CreateBinary()) 947037ed1beSAaron Smith return 0; 948037ed1beSAaron Smith 949037ed1beSAaron Smith Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT)); 95063e5fb76SJonas Devlieghere LLDB_LOGF(log, 95163e5fb76SJonas Devlieghere "%p ObjectFilePECOFF::ParseDependentModules() module = %p " 952037ed1beSAaron Smith "(%s), binary = %p (Bin = %p)", 953037ed1beSAaron Smith static_cast<void *>(this), static_cast<void *>(module_sp.get()), 954037ed1beSAaron Smith module_sp->GetSpecificationDescription().c_str(), 955037ed1beSAaron Smith static_cast<void *>(m_owningbin.getPointer()), 956b8d03935SAaron Smith static_cast<void *>(m_owningbin->getBinary())); 957037ed1beSAaron Smith 958037ed1beSAaron Smith auto COFFObj = 959037ed1beSAaron Smith llvm::dyn_cast<llvm::object::COFFObjectFile>(m_owningbin->getBinary()); 960037ed1beSAaron Smith if (!COFFObj) 961037ed1beSAaron Smith return 0; 962037ed1beSAaron Smith 963037ed1beSAaron Smith m_deps_filespec = FileSpecList(); 964037ed1beSAaron Smith 965037ed1beSAaron Smith for (const auto &entry : COFFObj->import_directories()) { 966037ed1beSAaron Smith llvm::StringRef dll_name; 967037ed1beSAaron Smith auto ec = entry.getName(dll_name); 968037ed1beSAaron Smith // Report a bogus entry. 969037ed1beSAaron Smith if (ec != std::error_code()) { 97063e5fb76SJonas Devlieghere LLDB_LOGF(log, 97163e5fb76SJonas Devlieghere "ObjectFilePECOFF::ParseDependentModules() - failed to get " 972037ed1beSAaron Smith "import directory entry name: %s", 973037ed1beSAaron Smith ec.message().c_str()); 974037ed1beSAaron Smith continue; 975037ed1beSAaron Smith } 976037ed1beSAaron Smith 977037ed1beSAaron Smith // At this moment we only have the base name of the DLL. The full path can 978037ed1beSAaron Smith // only be seen after the dynamic loading. Our best guess is Try to get it 979037ed1beSAaron Smith // with the help of the object file's directory. 980b3f44ad9SStella Stamenova llvm::SmallString<128> dll_fullpath; 981037ed1beSAaron Smith FileSpec dll_specs(dll_name); 982037ed1beSAaron Smith dll_specs.GetDirectory().SetString(m_file.GetDirectory().GetCString()); 983037ed1beSAaron Smith 984037ed1beSAaron Smith if (!llvm::sys::fs::real_path(dll_specs.GetPath(), dll_fullpath)) 985f893d5bfSJonas Devlieghere m_deps_filespec->EmplaceBack(dll_fullpath); 986037ed1beSAaron Smith else { 987037ed1beSAaron Smith // Known DLLs or DLL not found in the object file directory. 988f893d5bfSJonas Devlieghere m_deps_filespec->EmplaceBack(dll_name); 989037ed1beSAaron Smith } 990037ed1beSAaron Smith } 991037ed1beSAaron Smith return m_deps_filespec->GetSize(); 992037ed1beSAaron Smith } 993037ed1beSAaron Smith 994037ed1beSAaron Smith uint32_t ObjectFilePECOFF::GetDependentModules(FileSpecList &files) { 995037ed1beSAaron Smith auto num_modules = ParseDependentModules(); 996037ed1beSAaron Smith auto original_size = files.GetSize(); 997037ed1beSAaron Smith 998037ed1beSAaron Smith for (unsigned i = 0; i < num_modules; ++i) 999037ed1beSAaron Smith files.AppendIfUnique(m_deps_filespec->GetFileSpecAtIndex(i)); 1000037ed1beSAaron Smith 1001037ed1beSAaron Smith return files.GetSize() - original_size; 1002f754f88fSGreg Clayton } 1003f754f88fSGreg Clayton 1004b9c1b51eSKate Stone lldb_private::Address ObjectFilePECOFF::GetEntryPointAddress() { 10058e38c666SStephane Sezer if (m_entry_point_address.IsValid()) 10068e38c666SStephane Sezer return m_entry_point_address; 10078e38c666SStephane Sezer 10088e38c666SStephane Sezer if (!ParseHeader() || !IsExecutable()) 10098e38c666SStephane Sezer return m_entry_point_address; 10108e38c666SStephane Sezer 10118e38c666SStephane Sezer SectionList *section_list = GetSectionList(); 1012a5235af9SAleksandr Urakov addr_t file_addr = m_coff_header_opt.entry + m_coff_header_opt.image_base; 10138e38c666SStephane Sezer 10148e38c666SStephane Sezer if (!section_list) 1015a5235af9SAleksandr Urakov m_entry_point_address.SetOffset(file_addr); 10168e38c666SStephane Sezer else 1017b8d03935SAaron Smith m_entry_point_address.ResolveAddressUsingFileSections(file_addr, 1018b8d03935SAaron Smith section_list); 10198e38c666SStephane Sezer return m_entry_point_address; 10208e38c666SStephane Sezer } 10218e38c666SStephane Sezer 1022d1304bbaSPavel Labath Address ObjectFilePECOFF::GetBaseAddress() { 1023d1304bbaSPavel Labath return Address(GetSectionList()->GetSectionAtIndex(0), 0); 1024d1304bbaSPavel Labath } 1025d1304bbaSPavel Labath 1026f754f88fSGreg Clayton // Dump 1027f754f88fSGreg Clayton // 1028f754f88fSGreg Clayton // Dump the specifics of the runtime file container (such as any headers 1029f754f88fSGreg Clayton // segments, sections, etc). 1030b9c1b51eSKate Stone void ObjectFilePECOFF::Dump(Stream *s) { 1031a1743499SGreg Clayton ModuleSP module_sp(GetModule()); 1032b9c1b51eSKate Stone if (module_sp) { 103316ff8604SSaleem Abdulrasool std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex()); 1034324a1036SSaleem Abdulrasool s->Printf("%p: ", static_cast<void *>(this)); 1035f754f88fSGreg Clayton s->Indent(); 1036f754f88fSGreg Clayton s->PutCString("ObjectFilePECOFF"); 1037f754f88fSGreg Clayton 1038f760f5aeSPavel Labath ArchSpec header_arch = GetArchitecture(); 1039f754f88fSGreg Clayton 1040b9c1b51eSKate Stone *s << ", file = '" << m_file 1041b9c1b51eSKate Stone << "', arch = " << header_arch.GetArchitectureName() << "\n"; 1042f754f88fSGreg Clayton 10433046e668SGreg Clayton SectionList *sections = GetSectionList(); 10443046e668SGreg Clayton if (sections) 1045248a1305SKonrad Kleine sections->Dump(s, nullptr, true, UINT32_MAX); 1046f754f88fSGreg Clayton 1047d5b44036SJonas Devlieghere if (m_symtab_up) 1048248a1305SKonrad Kleine m_symtab_up->Dump(s, nullptr, eSortOrderNone); 1049f754f88fSGreg Clayton 1050f754f88fSGreg Clayton if (m_dos_header.e_magic) 1051f754f88fSGreg Clayton DumpDOSHeader(s, m_dos_header); 1052b9c1b51eSKate Stone if (m_coff_header.machine) { 1053f754f88fSGreg Clayton DumpCOFFHeader(s, m_coff_header); 1054f754f88fSGreg Clayton if (m_coff_header.hdrsize) 1055f754f88fSGreg Clayton DumpOptCOFFHeader(s, m_coff_header_opt); 1056f754f88fSGreg Clayton } 1057f754f88fSGreg Clayton s->EOL(); 1058f754f88fSGreg Clayton DumpSectionHeaders(s); 1059f754f88fSGreg Clayton s->EOL(); 1060037ed1beSAaron Smith 1061037ed1beSAaron Smith DumpDependentModules(s); 1062037ed1beSAaron Smith s->EOL(); 1063f754f88fSGreg Clayton } 1064a1743499SGreg Clayton } 1065f754f88fSGreg Clayton 1066f754f88fSGreg Clayton // DumpDOSHeader 1067f754f88fSGreg Clayton // 1068f754f88fSGreg Clayton // Dump the MS-DOS header to the specified output stream 1069b9c1b51eSKate Stone void ObjectFilePECOFF::DumpDOSHeader(Stream *s, const dos_header_t &header) { 1070f754f88fSGreg Clayton s->PutCString("MSDOS Header\n"); 1071f754f88fSGreg Clayton s->Printf(" e_magic = 0x%4.4x\n", header.e_magic); 1072f754f88fSGreg Clayton s->Printf(" e_cblp = 0x%4.4x\n", header.e_cblp); 1073f754f88fSGreg Clayton s->Printf(" e_cp = 0x%4.4x\n", header.e_cp); 1074f754f88fSGreg Clayton s->Printf(" e_crlc = 0x%4.4x\n", header.e_crlc); 1075f754f88fSGreg Clayton s->Printf(" e_cparhdr = 0x%4.4x\n", header.e_cparhdr); 1076f754f88fSGreg Clayton s->Printf(" e_minalloc = 0x%4.4x\n", header.e_minalloc); 1077f754f88fSGreg Clayton s->Printf(" e_maxalloc = 0x%4.4x\n", header.e_maxalloc); 1078f754f88fSGreg Clayton s->Printf(" e_ss = 0x%4.4x\n", header.e_ss); 1079f754f88fSGreg Clayton s->Printf(" e_sp = 0x%4.4x\n", header.e_sp); 1080f754f88fSGreg Clayton s->Printf(" e_csum = 0x%4.4x\n", header.e_csum); 1081f754f88fSGreg Clayton s->Printf(" e_ip = 0x%4.4x\n", header.e_ip); 1082f754f88fSGreg Clayton s->Printf(" e_cs = 0x%4.4x\n", header.e_cs); 1083f754f88fSGreg Clayton s->Printf(" e_lfarlc = 0x%4.4x\n", header.e_lfarlc); 1084f754f88fSGreg Clayton s->Printf(" e_ovno = 0x%4.4x\n", header.e_ovno); 1085f754f88fSGreg Clayton s->Printf(" e_res[4] = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n", 1086b9c1b51eSKate Stone header.e_res[0], header.e_res[1], header.e_res[2], header.e_res[3]); 1087f754f88fSGreg Clayton s->Printf(" e_oemid = 0x%4.4x\n", header.e_oemid); 1088f754f88fSGreg Clayton s->Printf(" e_oeminfo = 0x%4.4x\n", header.e_oeminfo); 1089b9c1b51eSKate Stone s->Printf(" e_res2[10] = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, " 1090b9c1b51eSKate Stone "0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n", 1091b9c1b51eSKate Stone header.e_res2[0], header.e_res2[1], header.e_res2[2], 1092b9c1b51eSKate Stone header.e_res2[3], header.e_res2[4], header.e_res2[5], 1093b9c1b51eSKate Stone header.e_res2[6], header.e_res2[7], header.e_res2[8], 1094f754f88fSGreg Clayton header.e_res2[9]); 1095f754f88fSGreg Clayton s->Printf(" e_lfanew = 0x%8.8x\n", header.e_lfanew); 1096f754f88fSGreg Clayton } 1097f754f88fSGreg Clayton 1098f754f88fSGreg Clayton // DumpCOFFHeader 1099f754f88fSGreg Clayton // 1100f754f88fSGreg Clayton // Dump the COFF header to the specified output stream 1101b9c1b51eSKate Stone void ObjectFilePECOFF::DumpCOFFHeader(Stream *s, const coff_header_t &header) { 1102f754f88fSGreg Clayton s->PutCString("COFF Header\n"); 1103f754f88fSGreg Clayton s->Printf(" machine = 0x%4.4x\n", header.machine); 1104f754f88fSGreg Clayton s->Printf(" nsects = 0x%4.4x\n", header.nsects); 1105f754f88fSGreg Clayton s->Printf(" modtime = 0x%8.8x\n", header.modtime); 1106f754f88fSGreg Clayton s->Printf(" symoff = 0x%8.8x\n", header.symoff); 1107f754f88fSGreg Clayton s->Printf(" nsyms = 0x%8.8x\n", header.nsyms); 1108f754f88fSGreg Clayton s->Printf(" hdrsize = 0x%4.4x\n", header.hdrsize); 1109f754f88fSGreg Clayton } 1110f754f88fSGreg Clayton 1111f754f88fSGreg Clayton // DumpOptCOFFHeader 1112f754f88fSGreg Clayton // 1113f754f88fSGreg Clayton // Dump the optional COFF header to the specified output stream 1114b9c1b51eSKate Stone void ObjectFilePECOFF::DumpOptCOFFHeader(Stream *s, 1115b9c1b51eSKate Stone const coff_opt_header_t &header) { 1116f754f88fSGreg Clayton s->PutCString("Optional COFF Header\n"); 1117f754f88fSGreg Clayton s->Printf(" magic = 0x%4.4x\n", header.magic); 1118b9c1b51eSKate Stone s->Printf(" major_linker_version = 0x%2.2x\n", 1119b9c1b51eSKate Stone header.major_linker_version); 1120b9c1b51eSKate Stone s->Printf(" minor_linker_version = 0x%2.2x\n", 1121b9c1b51eSKate Stone header.minor_linker_version); 1122f754f88fSGreg Clayton s->Printf(" code_size = 0x%8.8x\n", header.code_size); 1123f754f88fSGreg Clayton s->Printf(" data_size = 0x%8.8x\n", header.data_size); 1124f754f88fSGreg Clayton s->Printf(" bss_size = 0x%8.8x\n", header.bss_size); 1125f754f88fSGreg Clayton s->Printf(" entry = 0x%8.8x\n", header.entry); 1126f754f88fSGreg Clayton s->Printf(" code_offset = 0x%8.8x\n", header.code_offset); 1127f754f88fSGreg Clayton s->Printf(" data_offset = 0x%8.8x\n", header.data_offset); 1128b9c1b51eSKate Stone s->Printf(" image_base = 0x%16.16" PRIx64 "\n", 1129b9c1b51eSKate Stone header.image_base); 1130f754f88fSGreg Clayton s->Printf(" sect_alignment = 0x%8.8x\n", header.sect_alignment); 1131f754f88fSGreg Clayton s->Printf(" file_alignment = 0x%8.8x\n", header.file_alignment); 1132b9c1b51eSKate Stone s->Printf(" major_os_system_version = 0x%4.4x\n", 1133b9c1b51eSKate Stone header.major_os_system_version); 1134b9c1b51eSKate Stone s->Printf(" minor_os_system_version = 0x%4.4x\n", 1135b9c1b51eSKate Stone header.minor_os_system_version); 1136b9c1b51eSKate Stone s->Printf(" major_image_version = 0x%4.4x\n", 1137b9c1b51eSKate Stone header.major_image_version); 1138b9c1b51eSKate Stone s->Printf(" minor_image_version = 0x%4.4x\n", 1139b9c1b51eSKate Stone header.minor_image_version); 1140b9c1b51eSKate Stone s->Printf(" major_subsystem_version = 0x%4.4x\n", 1141b9c1b51eSKate Stone header.major_subsystem_version); 1142b9c1b51eSKate Stone s->Printf(" minor_subsystem_version = 0x%4.4x\n", 1143b9c1b51eSKate Stone header.minor_subsystem_version); 1144f754f88fSGreg Clayton s->Printf(" reserved1 = 0x%8.8x\n", header.reserved1); 1145f754f88fSGreg Clayton s->Printf(" image_size = 0x%8.8x\n", header.image_size); 1146f754f88fSGreg Clayton s->Printf(" header_size = 0x%8.8x\n", header.header_size); 114728469ca3SGreg Clayton s->Printf(" checksum = 0x%8.8x\n", header.checksum); 1148f754f88fSGreg Clayton s->Printf(" subsystem = 0x%4.4x\n", header.subsystem); 1149f754f88fSGreg Clayton s->Printf(" dll_flags = 0x%4.4x\n", header.dll_flags); 1150b9c1b51eSKate Stone s->Printf(" stack_reserve_size = 0x%16.16" PRIx64 "\n", 1151b9c1b51eSKate Stone header.stack_reserve_size); 1152b9c1b51eSKate Stone s->Printf(" stack_commit_size = 0x%16.16" PRIx64 "\n", 1153b9c1b51eSKate Stone header.stack_commit_size); 1154b9c1b51eSKate Stone s->Printf(" heap_reserve_size = 0x%16.16" PRIx64 "\n", 1155b9c1b51eSKate Stone header.heap_reserve_size); 1156b9c1b51eSKate Stone s->Printf(" heap_commit_size = 0x%16.16" PRIx64 "\n", 1157b9c1b51eSKate Stone header.heap_commit_size); 1158f754f88fSGreg Clayton s->Printf(" loader_flags = 0x%8.8x\n", header.loader_flags); 1159b9c1b51eSKate Stone s->Printf(" num_data_dir_entries = 0x%8.8x\n", 1160b9c1b51eSKate Stone (uint32_t)header.data_dirs.size()); 1161f754f88fSGreg Clayton uint32_t i; 1162b9c1b51eSKate Stone for (i = 0; i < header.data_dirs.size(); i++) { 1163b9c1b51eSKate Stone s->Printf(" data_dirs[%2u] vmaddr = 0x%8.8x, vmsize = 0x%8.8x\n", i, 1164b9c1b51eSKate Stone header.data_dirs[i].vmaddr, header.data_dirs[i].vmsize); 1165f754f88fSGreg Clayton } 1166f754f88fSGreg Clayton } 1167f754f88fSGreg Clayton // DumpSectionHeader 1168f754f88fSGreg Clayton // 1169f754f88fSGreg Clayton // Dump a single ELF section header to the specified output stream 1170b9c1b51eSKate Stone void ObjectFilePECOFF::DumpSectionHeader(Stream *s, 1171b9c1b51eSKate Stone const section_header_t &sh) { 1172*adcd0268SBenjamin Kramer std::string name = std::string(GetSectionName(sh)); 1173b9c1b51eSKate Stone s->Printf("%-16s 0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x 0x%4.4x " 1174b9c1b51eSKate Stone "0x%4.4x 0x%8.8x\n", 1175b9c1b51eSKate Stone name.c_str(), sh.vmaddr, sh.vmsize, sh.offset, sh.size, sh.reloff, 1176b9c1b51eSKate Stone sh.lineoff, sh.nreloc, sh.nline, sh.flags); 1177f754f88fSGreg Clayton } 1178f754f88fSGreg Clayton 1179f754f88fSGreg Clayton // DumpSectionHeaders 1180f754f88fSGreg Clayton // 1181f754f88fSGreg Clayton // Dump all of the ELF section header to the specified output stream 1182b9c1b51eSKate Stone void ObjectFilePECOFF::DumpSectionHeaders(Stream *s) { 1183f754f88fSGreg Clayton 1184f754f88fSGreg Clayton s->PutCString("Section Headers\n"); 1185b9c1b51eSKate Stone s->PutCString("IDX name vm addr vm size file off file " 1186b9c1b51eSKate Stone "size reloc off line off nreloc nline flags\n"); 1187b9c1b51eSKate Stone s->PutCString("==== ---------------- ---------- ---------- ---------- " 1188b9c1b51eSKate Stone "---------- ---------- ---------- ------ ------ ----------\n"); 1189f754f88fSGreg Clayton 1190f754f88fSGreg Clayton uint32_t idx = 0; 1191f754f88fSGreg Clayton SectionHeaderCollIter pos, end = m_sect_headers.end(); 1192f754f88fSGreg Clayton 1193b9c1b51eSKate Stone for (pos = m_sect_headers.begin(); pos != end; ++pos, ++idx) { 1194f754f88fSGreg Clayton s->Printf("[%2u] ", idx); 1195f754f88fSGreg Clayton ObjectFilePECOFF::DumpSectionHeader(s, *pos); 1196f754f88fSGreg Clayton } 1197f754f88fSGreg Clayton } 1198f754f88fSGreg Clayton 1199037ed1beSAaron Smith // DumpDependentModules 1200037ed1beSAaron Smith // 1201037ed1beSAaron Smith // Dump all of the dependent modules to the specified output stream 1202037ed1beSAaron Smith void ObjectFilePECOFF::DumpDependentModules(lldb_private::Stream *s) { 1203037ed1beSAaron Smith auto num_modules = ParseDependentModules(); 1204037ed1beSAaron Smith if (num_modules > 0) { 1205037ed1beSAaron Smith s->PutCString("Dependent Modules\n"); 1206037ed1beSAaron Smith for (unsigned i = 0; i < num_modules; ++i) { 1207037ed1beSAaron Smith auto spec = m_deps_filespec->GetFileSpecAtIndex(i); 1208037ed1beSAaron Smith s->Printf(" %s\n", spec.GetFilename().GetCString()); 1209037ed1beSAaron Smith } 1210037ed1beSAaron Smith } 1211037ed1beSAaron Smith } 1212037ed1beSAaron Smith 1213fb3b3bd1SZachary Turner bool ObjectFilePECOFF::IsWindowsSubsystem() { 1214fb3b3bd1SZachary Turner switch (m_coff_header_opt.subsystem) { 1215fb3b3bd1SZachary Turner case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE: 1216fb3b3bd1SZachary Turner case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_GUI: 1217fb3b3bd1SZachary Turner case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CUI: 1218fb3b3bd1SZachary Turner case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE_WINDOWS: 1219fb3b3bd1SZachary Turner case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CE_GUI: 1220fb3b3bd1SZachary Turner case llvm::COFF::IMAGE_SUBSYSTEM_XBOX: 1221fb3b3bd1SZachary Turner case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION: 1222fb3b3bd1SZachary Turner return true; 1223fb3b3bd1SZachary Turner default: 1224fb3b3bd1SZachary Turner return false; 1225fb3b3bd1SZachary Turner } 1226fb3b3bd1SZachary Turner } 1227fb3b3bd1SZachary Turner 1228f760f5aeSPavel Labath ArchSpec ObjectFilePECOFF::GetArchitecture() { 1229237ad974SCharles Davis uint16_t machine = m_coff_header.machine; 1230b9c1b51eSKate Stone switch (machine) { 1231f760f5aeSPavel Labath default: 1232f760f5aeSPavel Labath break; 1233237ad974SCharles Davis case llvm::COFF::IMAGE_FILE_MACHINE_AMD64: 1234237ad974SCharles Davis case llvm::COFF::IMAGE_FILE_MACHINE_I386: 1235237ad974SCharles Davis case llvm::COFF::IMAGE_FILE_MACHINE_POWERPC: 1236237ad974SCharles Davis case llvm::COFF::IMAGE_FILE_MACHINE_POWERPCFP: 1237237ad974SCharles Davis case llvm::COFF::IMAGE_FILE_MACHINE_ARM: 12381108cb36SSaleem Abdulrasool case llvm::COFF::IMAGE_FILE_MACHINE_ARMNT: 1239237ad974SCharles Davis case llvm::COFF::IMAGE_FILE_MACHINE_THUMB: 1240638f072fSMartin Storsjo case llvm::COFF::IMAGE_FILE_MACHINE_ARM64: 1241f760f5aeSPavel Labath ArchSpec arch; 1242fb3b3bd1SZachary Turner arch.SetArchitecture(eArchTypeCOFF, machine, LLDB_INVALID_CPUTYPE, 1243fb3b3bd1SZachary Turner IsWindowsSubsystem() ? llvm::Triple::Win32 1244fb3b3bd1SZachary Turner : llvm::Triple::UnknownOS); 1245f760f5aeSPavel Labath return arch; 1246237ad974SCharles Davis } 1247f760f5aeSPavel Labath return ArchSpec(); 1248f754f88fSGreg Clayton } 1249f754f88fSGreg Clayton 1250b9c1b51eSKate Stone ObjectFile::Type ObjectFilePECOFF::CalculateType() { 1251b9c1b51eSKate Stone if (m_coff_header.machine != 0) { 1252237ad974SCharles Davis if ((m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0) 1253f754f88fSGreg Clayton return eTypeExecutable; 1254f754f88fSGreg Clayton else 1255f754f88fSGreg Clayton return eTypeSharedLibrary; 1256f754f88fSGreg Clayton } 1257f754f88fSGreg Clayton return eTypeExecutable; 1258f754f88fSGreg Clayton } 1259f754f88fSGreg Clayton 1260b9c1b51eSKate Stone ObjectFile::Strata ObjectFilePECOFF::CalculateStrata() { return eStrataUser; } 12619cad24a7SZachary Turner 1262f754f88fSGreg Clayton // PluginInterface protocol 1263b9c1b51eSKate Stone ConstString ObjectFilePECOFF::GetPluginName() { return GetPluginNameStatic(); } 1264f754f88fSGreg Clayton 1265b9c1b51eSKate Stone uint32_t ObjectFilePECOFF::GetPluginVersion() { return 1; } 1266