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 
44bba9ba8dSJonas Devlieghere LLDB_PLUGIN_DEFINE(ObjectFilePECOFF)
45fbb4d1e4SJonas Devlieghere 
46d372a8e8SPavel Labath static UUID GetCoffUUID(llvm::object::COFFObjectFile &coff_obj) {
47b8d03935SAaron Smith   const llvm::codeview::DebugInfo *pdb_info = nullptr;
48b8d03935SAaron Smith   llvm::StringRef pdb_file;
49b8d03935SAaron Smith 
50d372a8e8SPavel Labath   if (!coff_obj.getDebugPDBInfo(pdb_info, pdb_file) && pdb_info) {
51b8d03935SAaron Smith     if (pdb_info->PDB70.CVSignature == llvm::OMF::Signature::PDB70) {
524348e0eeSZequan Wu       UUID::CvRecordPdb70 info;
534348e0eeSZequan Wu       memcpy(&info.Uuid, pdb_info->PDB70.Signature, sizeof(info.Uuid));
544348e0eeSZequan Wu       info.Age = pdb_info->PDB70.Age;
554348e0eeSZequan Wu       return UUID::fromCvRecord(info);
56b8d03935SAaron Smith     }
57b8d03935SAaron Smith   }
58b8d03935SAaron Smith 
59b8d03935SAaron Smith   return UUID();
60b8d03935SAaron Smith }
61b8d03935SAaron Smith 
62e84f7841SPavel Labath char ObjectFilePECOFF::ID;
63e84f7841SPavel Labath 
64b9c1b51eSKate Stone void ObjectFilePECOFF::Initialize() {
65b9c1b51eSKate Stone   PluginManager::RegisterPlugin(
66b9c1b51eSKate Stone       GetPluginNameStatic(), GetPluginDescriptionStatic(), CreateInstance,
67b9c1b51eSKate Stone       CreateMemoryInstance, GetModuleSpecifications, SaveCore);
68f754f88fSGreg Clayton }
69f754f88fSGreg Clayton 
70b9c1b51eSKate Stone void ObjectFilePECOFF::Terminate() {
71f754f88fSGreg Clayton   PluginManager::UnregisterPlugin(CreateInstance);
72f754f88fSGreg Clayton }
73f754f88fSGreg Clayton 
74b9c1b51eSKate Stone lldb_private::ConstString ObjectFilePECOFF::GetPluginNameStatic() {
7557abc5d6SGreg Clayton   static ConstString g_name("pe-coff");
7657abc5d6SGreg Clayton   return g_name;
77f754f88fSGreg Clayton }
78f754f88fSGreg Clayton 
79b9c1b51eSKate Stone const char *ObjectFilePECOFF::GetPluginDescriptionStatic() {
80b9c1b51eSKate Stone   return "Portable Executable and Common Object File Format object file reader "
81b9c1b51eSKate Stone          "(32 and 64 bit)";
82f754f88fSGreg Clayton }
83f754f88fSGreg Clayton 
84b9c1b51eSKate Stone ObjectFile *ObjectFilePECOFF::CreateInstance(const lldb::ModuleSP &module_sp,
855ce9c565SGreg Clayton                                              DataBufferSP &data_sp,
865ce9c565SGreg Clayton                                              lldb::offset_t data_offset,
8728e4942bSPavel Labath                                              const lldb_private::FileSpec *file_p,
885ce9c565SGreg Clayton                                              lldb::offset_t file_offset,
89b9c1b51eSKate Stone                                              lldb::offset_t length) {
9028e4942bSPavel Labath   FileSpec file = file_p ? *file_p : FileSpec();
91b9c1b51eSKate Stone   if (!data_sp) {
9250251fc7SPavel Labath     data_sp = MapFileData(file, length, file_offset);
933f4a4b36SZachary Turner     if (!data_sp)
943f4a4b36SZachary Turner       return nullptr;
955ce9c565SGreg Clayton     data_offset = 0;
965ce9c565SGreg Clayton   }
975ce9c565SGreg Clayton 
983f4a4b36SZachary Turner   if (!ObjectFilePECOFF::MagicBytesMatch(data_sp))
993f4a4b36SZachary Turner     return nullptr;
1003f4a4b36SZachary Turner 
1015ce9c565SGreg Clayton   // Update the data to contain the entire file if it doesn't already
1023f4a4b36SZachary Turner   if (data_sp->GetByteSize() < length) {
10350251fc7SPavel Labath     data_sp = MapFileData(file, length, file_offset);
1043f4a4b36SZachary Turner     if (!data_sp)
1053f4a4b36SZachary Turner       return nullptr;
106f754f88fSGreg Clayton   }
1073f4a4b36SZachary Turner 
108a8f3ae7cSJonas Devlieghere   auto objfile_up = std::make_unique<ObjectFilePECOFF>(
10928e4942bSPavel Labath       module_sp, data_sp, data_offset, file_p, file_offset, length);
110d5b44036SJonas Devlieghere   if (!objfile_up || !objfile_up->ParseHeader())
1113f4a4b36SZachary Turner     return nullptr;
1123f4a4b36SZachary Turner 
113037ed1beSAaron Smith   // Cache coff binary.
114d5b44036SJonas Devlieghere   if (!objfile_up->CreateBinary())
115037ed1beSAaron Smith     return nullptr;
116d5b44036SJonas Devlieghere   return objfile_up.release();
117f754f88fSGreg Clayton }
118f754f88fSGreg Clayton 
119b9c1b51eSKate Stone ObjectFile *ObjectFilePECOFF::CreateMemoryInstance(
120b9c1b51eSKate Stone     const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
121b9c1b51eSKate Stone     const lldb::ProcessSP &process_sp, lldb::addr_t header_addr) {
122344546bdSWalter Erquinigo   if (!data_sp || !ObjectFilePECOFF::MagicBytesMatch(data_sp))
123344546bdSWalter Erquinigo     return nullptr;
124a8f3ae7cSJonas Devlieghere   auto objfile_up = std::make_unique<ObjectFilePECOFF>(
125344546bdSWalter Erquinigo       module_sp, data_sp, process_sp, header_addr);
126d5b44036SJonas Devlieghere   if (objfile_up.get() && objfile_up->ParseHeader()) {
127d5b44036SJonas Devlieghere     return objfile_up.release();
128344546bdSWalter Erquinigo   }
129344546bdSWalter Erquinigo   return nullptr;
130c9660546SGreg Clayton }
131c9660546SGreg Clayton 
132b9c1b51eSKate Stone size_t ObjectFilePECOFF::GetModuleSpecifications(
133b9c1b51eSKate Stone     const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp,
134b9c1b51eSKate Stone     lldb::offset_t data_offset, lldb::offset_t file_offset,
135b9c1b51eSKate Stone     lldb::offset_t length, lldb_private::ModuleSpecList &specs) {
13689eb1baeSVirgile Bello   const size_t initial_count = specs.GetSize();
137b8d03935SAaron Smith   if (!data_sp || !ObjectFilePECOFF::MagicBytesMatch(data_sp))
138b8d03935SAaron Smith     return initial_count;
13989eb1baeSVirgile Bello 
1403db1d138SMartin Storsjö   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
1413db1d138SMartin Storsjö 
142a4a00cedSFred Riss   if (data_sp->GetByteSize() < length)
143d372a8e8SPavel Labath     if (DataBufferSP full_sp = MapFileData(file, -1, file_offset))
144d372a8e8SPavel Labath       data_sp = std::move(full_sp);
145d372a8e8SPavel Labath   auto binary = llvm::object::createBinary(llvm::MemoryBufferRef(
146d372a8e8SPavel Labath       toStringRef(data_sp->GetData()), file.GetFilename().GetStringRef()));
1473db1d138SMartin Storsjö 
1483db1d138SMartin Storsjö   if (!binary) {
1493db1d138SMartin Storsjö     LLDB_LOG_ERROR(log, binary.takeError(),
1503db1d138SMartin Storsjö                    "Failed to create binary for file ({1}): {0}", file);
151b8d03935SAaron Smith     return initial_count;
1523db1d138SMartin Storsjö   }
15389eb1baeSVirgile Bello 
154d372a8e8SPavel Labath   auto *COFFObj = llvm::dyn_cast<llvm::object::COFFObjectFile>(binary->get());
155d372a8e8SPavel Labath   if (!COFFObj)
156b8d03935SAaron Smith     return initial_count;
15789eb1baeSVirgile Bello 
158b8d03935SAaron Smith   ModuleSpec module_spec(file);
159b8d03935SAaron Smith   ArchSpec &spec = module_spec.GetArchitecture();
160b8d03935SAaron Smith   lldb_private::UUID &uuid = module_spec.GetUUID();
161b8d03935SAaron Smith   if (!uuid.IsValid())
162d372a8e8SPavel Labath     uuid = GetCoffUUID(*COFFObj);
163b8d03935SAaron Smith 
164b8d03935SAaron Smith   switch (COFFObj->getMachine()) {
165b8d03935SAaron Smith   case MachineAmd64:
166ad587ae4SZachary Turner     spec.SetTriple("x86_64-pc-windows");
167b8d03935SAaron Smith     specs.Append(module_spec);
168b8d03935SAaron Smith     break;
169b8d03935SAaron Smith   case MachineX86:
170ad587ae4SZachary Turner     spec.SetTriple("i386-pc-windows");
171b8d03935SAaron Smith     specs.Append(module_spec);
1725e6f4520SZachary Turner     spec.SetTriple("i686-pc-windows");
173b8d03935SAaron Smith     specs.Append(module_spec);
174b8d03935SAaron Smith     break;
175b8d03935SAaron Smith   case MachineArmNt:
176544c8f48SMartin Storsjo     spec.SetTriple("armv7-pc-windows");
177b8d03935SAaron Smith     specs.Append(module_spec);
178b8d03935SAaron Smith     break;
179638f072fSMartin Storsjo   case MachineArm64:
180674d5543SMartin Storsjo     spec.SetTriple("aarch64-pc-windows");
181638f072fSMartin Storsjo     specs.Append(module_spec);
182638f072fSMartin Storsjo     break;
183b8d03935SAaron Smith   default:
184b8d03935SAaron Smith     break;
18589eb1baeSVirgile Bello   }
18689eb1baeSVirgile Bello 
18789eb1baeSVirgile Bello   return specs.GetSize() - initial_count;
188f4d6de6aSGreg Clayton }
189f4d6de6aSGreg Clayton 
190b9c1b51eSKate Stone bool ObjectFilePECOFF::SaveCore(const lldb::ProcessSP &process_sp,
191f7d1893fSAdrian McCarthy                                 const lldb_private::FileSpec &outfile,
1929ea6dd5cSJason Molenda                                 lldb::SaveCoreStyle &core_style,
19397206d57SZachary Turner                                 lldb_private::Status &error) {
1949ea6dd5cSJason Molenda   core_style = eSaveCoreFull;
195f7d1893fSAdrian McCarthy   return SaveMiniDump(process_sp, outfile, error);
196f7d1893fSAdrian McCarthy }
197f7d1893fSAdrian McCarthy 
198b9c1b51eSKate Stone bool ObjectFilePECOFF::MagicBytesMatch(DataBufferSP &data_sp) {
1995ce9c565SGreg Clayton   DataExtractor data(data_sp, eByteOrderLittle, 4);
200c7bece56SGreg Clayton   lldb::offset_t offset = 0;
201f754f88fSGreg Clayton   uint16_t magic = data.GetU16(&offset);
202f754f88fSGreg Clayton   return magic == IMAGE_DOS_SIGNATURE;
203f754f88fSGreg Clayton }
204f754f88fSGreg Clayton 
205b9c1b51eSKate Stone lldb::SymbolType ObjectFilePECOFF::MapSymbolType(uint16_t coff_symbol_type) {
206c35b91ceSAdrian McCarthy   // TODO:  We need to complete this mapping of COFF symbol types to LLDB ones.
207c35b91ceSAdrian McCarthy   // For now, here's a hack to make sure our function have types.
208b9c1b51eSKate Stone   const auto complex_type =
209b9c1b51eSKate Stone       coff_symbol_type >> llvm::COFF::SCT_COMPLEX_TYPE_SHIFT;
210b9c1b51eSKate Stone   if (complex_type == llvm::COFF::IMAGE_SYM_DTYPE_FUNCTION) {
211c35b91ceSAdrian McCarthy     return lldb::eSymbolTypeCode;
212c35b91ceSAdrian McCarthy   }
213c35b91ceSAdrian McCarthy   return lldb::eSymbolTypeInvalid;
214c35b91ceSAdrian McCarthy }
215f754f88fSGreg Clayton 
216037ed1beSAaron Smith bool ObjectFilePECOFF::CreateBinary() {
217d372a8e8SPavel Labath   if (m_binary)
218037ed1beSAaron Smith     return true;
219037ed1beSAaron Smith 
220037ed1beSAaron Smith   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
221037ed1beSAaron Smith 
222d372a8e8SPavel Labath   auto binary = llvm::object::createBinary(llvm::MemoryBufferRef(
223d372a8e8SPavel Labath       toStringRef(m_data.GetData()), m_file.GetFilename().GetStringRef()));
224037ed1beSAaron Smith   if (!binary) {
2253db1d138SMartin Storsjö     LLDB_LOG_ERROR(log, binary.takeError(),
2263db1d138SMartin Storsjö                    "Failed to create binary for file ({1}): {0}", m_file);
227037ed1beSAaron Smith     return false;
228037ed1beSAaron Smith   }
229037ed1beSAaron Smith 
230037ed1beSAaron Smith   // Make sure we only handle COFF format.
231d372a8e8SPavel Labath   m_binary =
232d372a8e8SPavel Labath       llvm::unique_dyn_cast<llvm::object::COFFObjectFile>(std::move(*binary));
233d372a8e8SPavel Labath   if (!m_binary)
234037ed1beSAaron Smith     return false;
235037ed1beSAaron Smith 
236d372a8e8SPavel Labath   LLDB_LOG(log, "this = {0}, module = {1} ({2}), file = {3}, binary = {4}",
237d372a8e8SPavel Labath            this, GetModule().get(), GetModule()->GetSpecificationDescription(),
238d372a8e8SPavel Labath            m_file.GetPath(), m_binary.get());
239037ed1beSAaron Smith   return true;
240037ed1beSAaron Smith }
241037ed1beSAaron Smith 
242e72dfb32SGreg Clayton ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
2435ce9c565SGreg Clayton                                    DataBufferSP &data_sp,
2445ce9c565SGreg Clayton                                    lldb::offset_t data_offset,
245f754f88fSGreg Clayton                                    const FileSpec *file,
2465ce9c565SGreg Clayton                                    lldb::offset_t file_offset,
247b9c1b51eSKate Stone                                    lldb::offset_t length)
248b9c1b51eSKate Stone     : ObjectFile(module_sp, file, file_offset, length, data_sp, data_offset),
2495c43ffd6SPavel Labath       m_dos_header(), m_coff_header(), m_sect_headers(),
250d372a8e8SPavel Labath       m_entry_point_address(), m_deps_filespec() {
251f754f88fSGreg Clayton   ::memset(&m_dos_header, 0, sizeof(m_dos_header));
252f754f88fSGreg Clayton   ::memset(&m_coff_header, 0, sizeof(m_coff_header));
253f754f88fSGreg Clayton }
254f754f88fSGreg Clayton 
255344546bdSWalter Erquinigo ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
256344546bdSWalter Erquinigo                                    DataBufferSP &header_data_sp,
257344546bdSWalter Erquinigo                                    const lldb::ProcessSP &process_sp,
258344546bdSWalter Erquinigo                                    addr_t header_addr)
259344546bdSWalter Erquinigo     : ObjectFile(module_sp, process_sp, header_addr, header_data_sp),
2605c43ffd6SPavel Labath       m_dos_header(), m_coff_header(), m_sect_headers(),
261d372a8e8SPavel Labath       m_entry_point_address(), m_deps_filespec() {
262344546bdSWalter Erquinigo   ::memset(&m_dos_header, 0, sizeof(m_dos_header));
263344546bdSWalter Erquinigo   ::memset(&m_coff_header, 0, sizeof(m_coff_header));
264344546bdSWalter Erquinigo }
265344546bdSWalter Erquinigo 
266*fd2433e1SJonas Devlieghere ObjectFilePECOFF::~ObjectFilePECOFF() = default;
267f754f88fSGreg Clayton 
268b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseHeader() {
269a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
270b9c1b51eSKate Stone   if (module_sp) {
27116ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
272f754f88fSGreg Clayton     m_sect_headers.clear();
273f754f88fSGreg Clayton     m_data.SetByteOrder(eByteOrderLittle);
274c7bece56SGreg Clayton     lldb::offset_t offset = 0;
275f754f88fSGreg Clayton 
276b9c1b51eSKate Stone     if (ParseDOSHeader(m_data, m_dos_header)) {
277f754f88fSGreg Clayton       offset = m_dos_header.e_lfanew;
278f754f88fSGreg Clayton       uint32_t pe_signature = m_data.GetU32(&offset);
279f754f88fSGreg Clayton       if (pe_signature != IMAGE_NT_SIGNATURE)
280f754f88fSGreg Clayton         return false;
281b9c1b51eSKate Stone       if (ParseCOFFHeader(m_data, &offset, m_coff_header)) {
282f754f88fSGreg Clayton         if (m_coff_header.hdrsize > 0)
283f754f88fSGreg Clayton           ParseCOFFOptionalHeader(&offset);
284f754f88fSGreg Clayton         ParseSectionHeaders(offset);
28528469ca3SGreg Clayton       }
286a0f72441SMartin Storsjö       m_data.SetAddressByteSize(GetAddressByteSize());
287f754f88fSGreg Clayton       return true;
288f754f88fSGreg Clayton     }
289a1743499SGreg Clayton   }
290f754f88fSGreg Clayton   return false;
291f754f88fSGreg Clayton }
292f754f88fSGreg Clayton 
293b9c1b51eSKate Stone bool ObjectFilePECOFF::SetLoadAddress(Target &target, addr_t value,
294b9c1b51eSKate Stone                                       bool value_is_offset) {
2952756adf3SVirgile Bello   bool changed = false;
2962756adf3SVirgile Bello   ModuleSP module_sp = GetModule();
297b9c1b51eSKate Stone   if (module_sp) {
2982756adf3SVirgile Bello     size_t num_loaded_sections = 0;
2992756adf3SVirgile Bello     SectionList *section_list = GetSectionList();
300b9c1b51eSKate Stone     if (section_list) {
301b9c1b51eSKate Stone       if (!value_is_offset) {
3022756adf3SVirgile Bello         value -= m_image_base;
3032756adf3SVirgile Bello       }
3042756adf3SVirgile Bello 
3052756adf3SVirgile Bello       const size_t num_sections = section_list->GetSize();
3062756adf3SVirgile Bello       size_t sect_idx = 0;
3072756adf3SVirgile Bello 
308b9c1b51eSKate Stone       for (sect_idx = 0; sect_idx < num_sections; ++sect_idx) {
30905097246SAdrian Prantl         // Iterate through the object file sections to find all of the sections
31005097246SAdrian Prantl         // that have SHF_ALLOC in their flag bits.
3112756adf3SVirgile Bello         SectionSP section_sp(section_list->GetSectionAtIndex(sect_idx));
312b9c1b51eSKate Stone         if (section_sp && !section_sp->IsThreadSpecific()) {
313b9c1b51eSKate Stone           if (target.GetSectionLoadList().SetSectionLoadAddress(
314b9c1b51eSKate Stone                   section_sp, section_sp->GetFileAddress() + value))
3152756adf3SVirgile Bello             ++num_loaded_sections;
3162756adf3SVirgile Bello         }
3172756adf3SVirgile Bello       }
3182756adf3SVirgile Bello       changed = num_loaded_sections > 0;
3192756adf3SVirgile Bello     }
3202756adf3SVirgile Bello   }
3212756adf3SVirgile Bello   return changed;
3222756adf3SVirgile Bello }
3232756adf3SVirgile Bello 
324b9c1b51eSKate Stone ByteOrder ObjectFilePECOFF::GetByteOrder() const { return eByteOrderLittle; }
325f754f88fSGreg Clayton 
326b9c1b51eSKate Stone bool ObjectFilePECOFF::IsExecutable() const {
327237ad974SCharles Davis   return (m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0;
328f754f88fSGreg Clayton }
329f754f88fSGreg Clayton 
330b9c1b51eSKate Stone uint32_t ObjectFilePECOFF::GetAddressByteSize() const {
331f754f88fSGreg Clayton   if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32_PLUS)
332f754f88fSGreg Clayton     return 8;
333f754f88fSGreg Clayton   else if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32)
334f754f88fSGreg Clayton     return 4;
335f754f88fSGreg Clayton   return 4;
336f754f88fSGreg Clayton }
337f754f88fSGreg Clayton 
338f754f88fSGreg Clayton // NeedsEndianSwap
339f754f88fSGreg Clayton //
34005097246SAdrian Prantl // Return true if an endian swap needs to occur when extracting data from this
34105097246SAdrian Prantl // file.
342b9c1b51eSKate Stone bool ObjectFilePECOFF::NeedsEndianSwap() const {
343f754f88fSGreg Clayton #if defined(__LITTLE_ENDIAN__)
344f754f88fSGreg Clayton   return false;
345f754f88fSGreg Clayton #else
346f754f88fSGreg Clayton   return true;
347f754f88fSGreg Clayton #endif
348f754f88fSGreg Clayton }
349f754f88fSGreg Clayton // ParseDOSHeader
350b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseDOSHeader(DataExtractor &data,
351b9c1b51eSKate Stone                                       dos_header_t &dos_header) {
352f754f88fSGreg Clayton   bool success = false;
353c7bece56SGreg Clayton   lldb::offset_t offset = 0;
35489eb1baeSVirgile Bello   success = data.ValidOffsetForDataOfSize(0, sizeof(dos_header));
355f754f88fSGreg Clayton 
356b9c1b51eSKate Stone   if (success) {
35789eb1baeSVirgile Bello     dos_header.e_magic = data.GetU16(&offset); // Magic number
35889eb1baeSVirgile Bello     success = dos_header.e_magic == IMAGE_DOS_SIGNATURE;
359f754f88fSGreg Clayton 
360b9c1b51eSKate Stone     if (success) {
36189eb1baeSVirgile Bello       dos_header.e_cblp = data.GetU16(&offset); // Bytes on last page of file
36289eb1baeSVirgile Bello       dos_header.e_cp = data.GetU16(&offset);   // Pages in file
36389eb1baeSVirgile Bello       dos_header.e_crlc = data.GetU16(&offset); // Relocations
364b9c1b51eSKate Stone       dos_header.e_cparhdr =
365b9c1b51eSKate Stone           data.GetU16(&offset); // Size of header in paragraphs
366b9c1b51eSKate Stone       dos_header.e_minalloc =
367b9c1b51eSKate Stone           data.GetU16(&offset); // Minimum extra paragraphs needed
368b9c1b51eSKate Stone       dos_header.e_maxalloc =
369b9c1b51eSKate Stone           data.GetU16(&offset);               // Maximum extra paragraphs needed
37089eb1baeSVirgile Bello       dos_header.e_ss = data.GetU16(&offset); // Initial (relative) SS value
37189eb1baeSVirgile Bello       dos_header.e_sp = data.GetU16(&offset); // Initial SP value
37289eb1baeSVirgile Bello       dos_header.e_csum = data.GetU16(&offset); // Checksum
37389eb1baeSVirgile Bello       dos_header.e_ip = data.GetU16(&offset);   // Initial IP value
37489eb1baeSVirgile Bello       dos_header.e_cs = data.GetU16(&offset);   // Initial (relative) CS value
375b9c1b51eSKate Stone       dos_header.e_lfarlc =
376b9c1b51eSKate Stone           data.GetU16(&offset); // File address of relocation table
37789eb1baeSVirgile Bello       dos_header.e_ovno = data.GetU16(&offset); // Overlay number
378f754f88fSGreg Clayton 
37989eb1baeSVirgile Bello       dos_header.e_res[0] = data.GetU16(&offset); // Reserved words
38089eb1baeSVirgile Bello       dos_header.e_res[1] = data.GetU16(&offset); // Reserved words
38189eb1baeSVirgile Bello       dos_header.e_res[2] = data.GetU16(&offset); // Reserved words
38289eb1baeSVirgile Bello       dos_header.e_res[3] = data.GetU16(&offset); // Reserved words
383f754f88fSGreg Clayton 
384b9c1b51eSKate Stone       dos_header.e_oemid =
385b9c1b51eSKate Stone           data.GetU16(&offset); // OEM identifier (for e_oeminfo)
386b9c1b51eSKate Stone       dos_header.e_oeminfo =
387b9c1b51eSKate Stone           data.GetU16(&offset); // OEM information; e_oemid specific
38889eb1baeSVirgile Bello       dos_header.e_res2[0] = data.GetU16(&offset); // Reserved words
38989eb1baeSVirgile Bello       dos_header.e_res2[1] = data.GetU16(&offset); // Reserved words
39089eb1baeSVirgile Bello       dos_header.e_res2[2] = data.GetU16(&offset); // Reserved words
39189eb1baeSVirgile Bello       dos_header.e_res2[3] = data.GetU16(&offset); // Reserved words
39289eb1baeSVirgile Bello       dos_header.e_res2[4] = data.GetU16(&offset); // Reserved words
39389eb1baeSVirgile Bello       dos_header.e_res2[5] = data.GetU16(&offset); // Reserved words
39489eb1baeSVirgile Bello       dos_header.e_res2[6] = data.GetU16(&offset); // Reserved words
39589eb1baeSVirgile Bello       dos_header.e_res2[7] = data.GetU16(&offset); // Reserved words
39689eb1baeSVirgile Bello       dos_header.e_res2[8] = data.GetU16(&offset); // Reserved words
39789eb1baeSVirgile Bello       dos_header.e_res2[9] = data.GetU16(&offset); // Reserved words
398f754f88fSGreg Clayton 
399b9c1b51eSKate Stone       dos_header.e_lfanew =
400b9c1b51eSKate Stone           data.GetU32(&offset); // File address of new exe header
401f754f88fSGreg Clayton     }
402f754f88fSGreg Clayton   }
403f754f88fSGreg Clayton   if (!success)
40489eb1baeSVirgile Bello     memset(&dos_header, 0, sizeof(dos_header));
405f754f88fSGreg Clayton   return success;
406f754f88fSGreg Clayton }
407f754f88fSGreg Clayton 
408f754f88fSGreg Clayton // ParserCOFFHeader
409b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseCOFFHeader(DataExtractor &data,
410b9c1b51eSKate Stone                                        lldb::offset_t *offset_ptr,
411b9c1b51eSKate Stone                                        coff_header_t &coff_header) {
412b9c1b51eSKate Stone   bool success =
413b9c1b51eSKate Stone       data.ValidOffsetForDataOfSize(*offset_ptr, sizeof(coff_header));
414b9c1b51eSKate Stone   if (success) {
41589eb1baeSVirgile Bello     coff_header.machine = data.GetU16(offset_ptr);
41689eb1baeSVirgile Bello     coff_header.nsects = data.GetU16(offset_ptr);
41789eb1baeSVirgile Bello     coff_header.modtime = data.GetU32(offset_ptr);
41889eb1baeSVirgile Bello     coff_header.symoff = data.GetU32(offset_ptr);
41989eb1baeSVirgile Bello     coff_header.nsyms = data.GetU32(offset_ptr);
42089eb1baeSVirgile Bello     coff_header.hdrsize = data.GetU16(offset_ptr);
42189eb1baeSVirgile Bello     coff_header.flags = data.GetU16(offset_ptr);
422f754f88fSGreg Clayton   }
423f754f88fSGreg Clayton   if (!success)
42489eb1baeSVirgile Bello     memset(&coff_header, 0, sizeof(coff_header));
425f754f88fSGreg Clayton   return success;
426f754f88fSGreg Clayton }
427f754f88fSGreg Clayton 
428b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseCOFFOptionalHeader(lldb::offset_t *offset_ptr) {
429f754f88fSGreg Clayton   bool success = false;
430c7bece56SGreg Clayton   const lldb::offset_t end_offset = *offset_ptr + m_coff_header.hdrsize;
431b9c1b51eSKate Stone   if (*offset_ptr < end_offset) {
432f754f88fSGreg Clayton     success = true;
433f754f88fSGreg Clayton     m_coff_header_opt.magic = m_data.GetU16(offset_ptr);
434f754f88fSGreg Clayton     m_coff_header_opt.major_linker_version = m_data.GetU8(offset_ptr);
435f754f88fSGreg Clayton     m_coff_header_opt.minor_linker_version = m_data.GetU8(offset_ptr);
436f754f88fSGreg Clayton     m_coff_header_opt.code_size = m_data.GetU32(offset_ptr);
437f754f88fSGreg Clayton     m_coff_header_opt.data_size = m_data.GetU32(offset_ptr);
438f754f88fSGreg Clayton     m_coff_header_opt.bss_size = m_data.GetU32(offset_ptr);
439f754f88fSGreg Clayton     m_coff_header_opt.entry = m_data.GetU32(offset_ptr);
440f754f88fSGreg Clayton     m_coff_header_opt.code_offset = m_data.GetU32(offset_ptr);
441f754f88fSGreg Clayton 
442f754f88fSGreg Clayton     const uint32_t addr_byte_size = GetAddressByteSize();
443f754f88fSGreg Clayton 
444b9c1b51eSKate Stone     if (*offset_ptr < end_offset) {
445b9c1b51eSKate Stone       if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32) {
446f754f88fSGreg Clayton         // PE32 only
447f754f88fSGreg Clayton         m_coff_header_opt.data_offset = m_data.GetU32(offset_ptr);
448b9c1b51eSKate Stone       } else
449f754f88fSGreg Clayton         m_coff_header_opt.data_offset = 0;
450f754f88fSGreg Clayton 
451b9c1b51eSKate Stone       if (*offset_ptr < end_offset) {
452b9c1b51eSKate Stone         m_coff_header_opt.image_base =
453b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
454f754f88fSGreg Clayton         m_coff_header_opt.sect_alignment = m_data.GetU32(offset_ptr);
455f754f88fSGreg Clayton         m_coff_header_opt.file_alignment = m_data.GetU32(offset_ptr);
456f754f88fSGreg Clayton         m_coff_header_opt.major_os_system_version = m_data.GetU16(offset_ptr);
457f754f88fSGreg Clayton         m_coff_header_opt.minor_os_system_version = m_data.GetU16(offset_ptr);
458f754f88fSGreg Clayton         m_coff_header_opt.major_image_version = m_data.GetU16(offset_ptr);
459f754f88fSGreg Clayton         m_coff_header_opt.minor_image_version = m_data.GetU16(offset_ptr);
460f754f88fSGreg Clayton         m_coff_header_opt.major_subsystem_version = m_data.GetU16(offset_ptr);
461f754f88fSGreg Clayton         m_coff_header_opt.minor_subsystem_version = m_data.GetU16(offset_ptr);
462f754f88fSGreg Clayton         m_coff_header_opt.reserved1 = m_data.GetU32(offset_ptr);
463f754f88fSGreg Clayton         m_coff_header_opt.image_size = m_data.GetU32(offset_ptr);
464f754f88fSGreg Clayton         m_coff_header_opt.header_size = m_data.GetU32(offset_ptr);
46528469ca3SGreg Clayton         m_coff_header_opt.checksum = m_data.GetU32(offset_ptr);
466f754f88fSGreg Clayton         m_coff_header_opt.subsystem = m_data.GetU16(offset_ptr);
467f754f88fSGreg Clayton         m_coff_header_opt.dll_flags = m_data.GetU16(offset_ptr);
468b9c1b51eSKate Stone         m_coff_header_opt.stack_reserve_size =
469b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
470b9c1b51eSKate Stone         m_coff_header_opt.stack_commit_size =
471b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
472b9c1b51eSKate Stone         m_coff_header_opt.heap_reserve_size =
473b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
474b9c1b51eSKate Stone         m_coff_header_opt.heap_commit_size =
475b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
476f754f88fSGreg Clayton         m_coff_header_opt.loader_flags = m_data.GetU32(offset_ptr);
477f754f88fSGreg Clayton         uint32_t num_data_dir_entries = m_data.GetU32(offset_ptr);
478f754f88fSGreg Clayton         m_coff_header_opt.data_dirs.clear();
479f754f88fSGreg Clayton         m_coff_header_opt.data_dirs.resize(num_data_dir_entries);
480f754f88fSGreg Clayton         uint32_t i;
481b9c1b51eSKate Stone         for (i = 0; i < num_data_dir_entries; i++) {
482f754f88fSGreg Clayton           m_coff_header_opt.data_dirs[i].vmaddr = m_data.GetU32(offset_ptr);
483f754f88fSGreg Clayton           m_coff_header_opt.data_dirs[i].vmsize = m_data.GetU32(offset_ptr);
484f754f88fSGreg Clayton         }
4852756adf3SVirgile Bello 
4862756adf3SVirgile Bello         m_image_base = m_coff_header_opt.image_base;
487f754f88fSGreg Clayton       }
488f754f88fSGreg Clayton     }
489f754f88fSGreg Clayton   }
490f754f88fSGreg Clayton   // Make sure we are on track for section data which follows
491f754f88fSGreg Clayton   *offset_ptr = end_offset;
492f754f88fSGreg Clayton   return success;
493f754f88fSGreg Clayton }
494f754f88fSGreg Clayton 
49530c2441aSAleksandr Urakov uint32_t ObjectFilePECOFF::GetRVA(const Address &addr) const {
49630c2441aSAleksandr Urakov   return addr.GetFileAddress() - m_image_base;
49730c2441aSAleksandr Urakov }
49830c2441aSAleksandr Urakov 
49930c2441aSAleksandr Urakov Address ObjectFilePECOFF::GetAddress(uint32_t rva) {
50030c2441aSAleksandr Urakov   SectionList *sect_list = GetSectionList();
50130c2441aSAleksandr Urakov   if (!sect_list)
50230c2441aSAleksandr Urakov     return Address(GetFileAddress(rva));
50330c2441aSAleksandr Urakov 
50430c2441aSAleksandr Urakov   return Address(GetFileAddress(rva), sect_list);
50530c2441aSAleksandr Urakov }
50630c2441aSAleksandr Urakov 
50730c2441aSAleksandr Urakov lldb::addr_t ObjectFilePECOFF::GetFileAddress(uint32_t rva) const {
50830c2441aSAleksandr Urakov   return m_image_base + rva;
50930c2441aSAleksandr Urakov }
51030c2441aSAleksandr Urakov 
511344546bdSWalter Erquinigo DataExtractor ObjectFilePECOFF::ReadImageData(uint32_t offset, size_t size) {
51230c2441aSAleksandr Urakov   if (!size)
51330c2441aSAleksandr Urakov     return {};
51430c2441aSAleksandr Urakov 
515a4a00cedSFred Riss   if (m_data.ValidOffsetForDataOfSize(offset, size))
516a4a00cedSFred Riss     return DataExtractor(m_data, offset, size);
517a4a00cedSFred Riss 
518344546bdSWalter Erquinigo   ProcessSP process_sp(m_process_wp.lock());
519344546bdSWalter Erquinigo   DataExtractor data;
520344546bdSWalter Erquinigo   if (process_sp) {
521a8f3ae7cSJonas Devlieghere     auto data_up = std::make_unique<DataBufferHeap>(size, 0);
52297206d57SZachary Turner     Status readmem_error;
523344546bdSWalter Erquinigo     size_t bytes_read =
524d5b44036SJonas Devlieghere         process_sp->ReadMemory(m_image_base + offset, data_up->GetBytes(),
525d5b44036SJonas Devlieghere                                data_up->GetByteSize(), readmem_error);
526344546bdSWalter Erquinigo     if (bytes_read == size) {
527d5b44036SJonas Devlieghere       DataBufferSP buffer_sp(data_up.release());
528344546bdSWalter Erquinigo       data.SetData(buffer_sp, 0, buffer_sp->GetByteSize());
529344546bdSWalter Erquinigo     }
530344546bdSWalter Erquinigo   }
531344546bdSWalter Erquinigo   return data;
532344546bdSWalter Erquinigo }
533344546bdSWalter Erquinigo 
53430c2441aSAleksandr Urakov DataExtractor ObjectFilePECOFF::ReadImageDataByRVA(uint32_t rva, size_t size) {
53530c2441aSAleksandr Urakov   Address addr = GetAddress(rva);
5367e1a3076SMartin Storsjö   SectionSP sect = addr.GetSection();
5377e1a3076SMartin Storsjö   if (!sect)
5387e1a3076SMartin Storsjö     return {};
5397e1a3076SMartin Storsjö   rva = sect->GetFileOffset() + addr.GetOffset();
54030c2441aSAleksandr Urakov 
54130c2441aSAleksandr Urakov   return ReadImageData(rva, size);
54230c2441aSAleksandr Urakov }
54330c2441aSAleksandr Urakov 
544f754f88fSGreg Clayton // ParseSectionHeaders
545b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseSectionHeaders(
546b9c1b51eSKate Stone     uint32_t section_header_data_offset) {
547f754f88fSGreg Clayton   const uint32_t nsects = m_coff_header.nsects;
548f754f88fSGreg Clayton   m_sect_headers.clear();
549f754f88fSGreg Clayton 
550b9c1b51eSKate Stone   if (nsects > 0) {
551f754f88fSGreg Clayton     const size_t section_header_byte_size = nsects * sizeof(section_header_t);
552344546bdSWalter Erquinigo     DataExtractor section_header_data =
553344546bdSWalter Erquinigo         ReadImageData(section_header_data_offset, section_header_byte_size);
554f754f88fSGreg Clayton 
555c7bece56SGreg Clayton     lldb::offset_t offset = 0;
556b9c1b51eSKate Stone     if (section_header_data.ValidOffsetForDataOfSize(
557b9c1b51eSKate Stone             offset, section_header_byte_size)) {
558f754f88fSGreg Clayton       m_sect_headers.resize(nsects);
559f754f88fSGreg Clayton 
560b9c1b51eSKate Stone       for (uint32_t idx = 0; idx < nsects; ++idx) {
561f754f88fSGreg Clayton         const void *name_data = section_header_data.GetData(&offset, 8);
562b9c1b51eSKate Stone         if (name_data) {
563f754f88fSGreg Clayton           memcpy(m_sect_headers[idx].name, name_data, 8);
564f754f88fSGreg Clayton           m_sect_headers[idx].vmsize = section_header_data.GetU32(&offset);
565f754f88fSGreg Clayton           m_sect_headers[idx].vmaddr = section_header_data.GetU32(&offset);
566f754f88fSGreg Clayton           m_sect_headers[idx].size = section_header_data.GetU32(&offset);
567f754f88fSGreg Clayton           m_sect_headers[idx].offset = section_header_data.GetU32(&offset);
568f754f88fSGreg Clayton           m_sect_headers[idx].reloff = section_header_data.GetU32(&offset);
569f754f88fSGreg Clayton           m_sect_headers[idx].lineoff = section_header_data.GetU32(&offset);
570f754f88fSGreg Clayton           m_sect_headers[idx].nreloc = section_header_data.GetU16(&offset);
571f754f88fSGreg Clayton           m_sect_headers[idx].nline = section_header_data.GetU16(&offset);
572f754f88fSGreg Clayton           m_sect_headers[idx].flags = section_header_data.GetU32(&offset);
573f754f88fSGreg Clayton         }
574f754f88fSGreg Clayton       }
575f754f88fSGreg Clayton     }
576f754f88fSGreg Clayton   }
577f754f88fSGreg Clayton 
578a6682a41SJonas Devlieghere   return !m_sect_headers.empty();
579f754f88fSGreg Clayton }
580f754f88fSGreg Clayton 
5812886e4a0SPavel Labath llvm::StringRef ObjectFilePECOFF::GetSectionName(const section_header_t &sect) {
5822886e4a0SPavel Labath   llvm::StringRef hdr_name(sect.name, llvm::array_lengthof(sect.name));
5832886e4a0SPavel Labath   hdr_name = hdr_name.split('\0').first;
5842886e4a0SPavel Labath   if (hdr_name.consume_front("/")) {
5852886e4a0SPavel Labath     lldb::offset_t stroff;
5862886e4a0SPavel Labath     if (!to_integer(hdr_name, stroff, 10))
5872886e4a0SPavel Labath       return "";
588b9c1b51eSKate Stone     lldb::offset_t string_file_offset =
589b9c1b51eSKate Stone         m_coff_header.symoff + (m_coff_header.nsyms * 18) + stroff;
5902886e4a0SPavel Labath     if (const char *name = m_data.GetCStr(&string_file_offset))
5912886e4a0SPavel Labath       return name;
5922886e4a0SPavel Labath     return "";
593f754f88fSGreg Clayton   }
5942886e4a0SPavel Labath   return hdr_name;
595f754f88fSGreg Clayton }
596f754f88fSGreg Clayton 
597f754f88fSGreg Clayton // GetNListSymtab
598b9c1b51eSKate Stone Symtab *ObjectFilePECOFF::GetSymtab() {
599a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
600b9c1b51eSKate Stone   if (module_sp) {
60116ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
602248a1305SKonrad Kleine     if (m_symtab_up == nullptr) {
603f754f88fSGreg Clayton       SectionList *sect_list = GetSectionList();
60406412daeSJonas Devlieghere       m_symtab_up = std::make_unique<Symtab>(this);
605d5b44036SJonas Devlieghere       std::lock_guard<std::recursive_mutex> guard(m_symtab_up->GetMutex());
60628469ca3SGreg Clayton 
60728469ca3SGreg Clayton       const uint32_t num_syms = m_coff_header.nsyms;
60828469ca3SGreg Clayton 
609344546bdSWalter Erquinigo       if (m_file && num_syms > 0 && m_coff_header.symoff > 0) {
6100076e715SGreg Clayton         const uint32_t symbol_size = 18;
61128469ca3SGreg Clayton         const size_t symbol_data_size = num_syms * symbol_size;
612c35b91ceSAdrian McCarthy         // Include the 4-byte string table size at the end of the symbols
613344546bdSWalter Erquinigo         DataExtractor symtab_data =
614344546bdSWalter Erquinigo             ReadImageData(m_coff_header.symoff, symbol_data_size + 4);
615c7bece56SGreg Clayton         lldb::offset_t offset = symbol_data_size;
61628469ca3SGreg Clayton         const uint32_t strtab_size = symtab_data.GetU32(&offset);
617344546bdSWalter Erquinigo         if (strtab_size > 0) {
618344546bdSWalter Erquinigo           DataExtractor strtab_data = ReadImageData(
619344546bdSWalter Erquinigo               m_coff_header.symoff + symbol_data_size, strtab_size);
62028469ca3SGreg Clayton 
62128469ca3SGreg Clayton           offset = 0;
62228469ca3SGreg Clayton           std::string symbol_name;
623d5b44036SJonas Devlieghere           Symbol *symbols = m_symtab_up->Resize(num_syms);
624b9c1b51eSKate Stone           for (uint32_t i = 0; i < num_syms; ++i) {
625f754f88fSGreg Clayton             coff_symbol_t symbol;
62628469ca3SGreg Clayton             const uint32_t symbol_offset = offset;
627248a1305SKonrad Kleine             const char *symbol_name_cstr = nullptr;
628c35b91ceSAdrian McCarthy             // If the first 4 bytes of the symbol string are zero, then they
629c35b91ceSAdrian McCarthy             // are followed by a 4-byte string table offset. Else these
63028469ca3SGreg Clayton             // 8 bytes contain the symbol name
631b9c1b51eSKate Stone             if (symtab_data.GetU32(&offset) == 0) {
63205097246SAdrian Prantl               // Long string that doesn't fit into the symbol table name, so
63305097246SAdrian Prantl               // now we must read the 4 byte string table offset
63428469ca3SGreg Clayton               uint32_t strtab_offset = symtab_data.GetU32(&offset);
63528469ca3SGreg Clayton               symbol_name_cstr = strtab_data.PeekCStr(strtab_offset);
63628469ca3SGreg Clayton               symbol_name.assign(symbol_name_cstr);
637b9c1b51eSKate Stone             } else {
638b9c1b51eSKate Stone               // Short string that fits into the symbol table name which is 8
639b9c1b51eSKate Stone               // bytes
64028469ca3SGreg Clayton               offset += sizeof(symbol.name) - 4; // Skip remaining
64128469ca3SGreg Clayton               symbol_name_cstr = symtab_data.PeekCStr(symbol_offset);
642248a1305SKonrad Kleine               if (symbol_name_cstr == nullptr)
643f754f88fSGreg Clayton                 break;
64428469ca3SGreg Clayton               symbol_name.assign(symbol_name_cstr, sizeof(symbol.name));
64528469ca3SGreg Clayton             }
64628469ca3SGreg Clayton             symbol.value = symtab_data.GetU32(&offset);
64728469ca3SGreg Clayton             symbol.sect = symtab_data.GetU16(&offset);
64828469ca3SGreg Clayton             symbol.type = symtab_data.GetU16(&offset);
64928469ca3SGreg Clayton             symbol.storage = symtab_data.GetU8(&offset);
65028469ca3SGreg Clayton             symbol.naux = symtab_data.GetU8(&offset);
651037520e9SGreg Clayton             symbols[i].GetMangled().SetValue(ConstString(symbol_name.c_str()));
652b9c1b51eSKate Stone             if ((int16_t)symbol.sect >= 1) {
6534394b5beSMartin Storsjö               Address symbol_addr(sect_list->FindSectionByID(symbol.sect),
654b9c1b51eSKate Stone                                   symbol.value);
655358cf1eaSGreg Clayton               symbols[i].GetAddressRef() = symbol_addr;
656c35b91ceSAdrian McCarthy               symbols[i].SetType(MapSymbolType(symbol.type));
6570076e715SGreg Clayton             }
658f754f88fSGreg Clayton 
659b9c1b51eSKate Stone             if (symbol.naux > 0) {
660f754f88fSGreg Clayton               i += symbol.naux;
661f07ddbc9SMartin Storsjö               offset += symbol.naux * symbol_size;
6620076e715SGreg Clayton             }
663f754f88fSGreg Clayton           }
664f754f88fSGreg Clayton         }
665344546bdSWalter Erquinigo       }
666a4fe3a12SVirgile Bello 
667a4fe3a12SVirgile Bello       // Read export header
668b9c1b51eSKate Stone       if (coff_data_dir_export_table < m_coff_header_opt.data_dirs.size() &&
669b9c1b51eSKate Stone           m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmsize > 0 &&
670b9c1b51eSKate Stone           m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmaddr > 0) {
671a4fe3a12SVirgile Bello         export_directory_entry export_table;
672b9c1b51eSKate Stone         uint32_t data_start =
673b9c1b51eSKate Stone             m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmaddr;
674344546bdSWalter Erquinigo 
67530c2441aSAleksandr Urakov         DataExtractor symtab_data = ReadImageDataByRVA(
67630c2441aSAleksandr Urakov             data_start, m_coff_header_opt.data_dirs[0].vmsize);
677a4fe3a12SVirgile Bello         lldb::offset_t offset = 0;
678a4fe3a12SVirgile Bello 
679a4fe3a12SVirgile Bello         // Read export_table header
680a4fe3a12SVirgile Bello         export_table.characteristics = symtab_data.GetU32(&offset);
681a4fe3a12SVirgile Bello         export_table.time_date_stamp = symtab_data.GetU32(&offset);
682a4fe3a12SVirgile Bello         export_table.major_version = symtab_data.GetU16(&offset);
683a4fe3a12SVirgile Bello         export_table.minor_version = symtab_data.GetU16(&offset);
684a4fe3a12SVirgile Bello         export_table.name = symtab_data.GetU32(&offset);
685a4fe3a12SVirgile Bello         export_table.base = symtab_data.GetU32(&offset);
686a4fe3a12SVirgile Bello         export_table.number_of_functions = symtab_data.GetU32(&offset);
687a4fe3a12SVirgile Bello         export_table.number_of_names = symtab_data.GetU32(&offset);
688a4fe3a12SVirgile Bello         export_table.address_of_functions = symtab_data.GetU32(&offset);
689a4fe3a12SVirgile Bello         export_table.address_of_names = symtab_data.GetU32(&offset);
690a4fe3a12SVirgile Bello         export_table.address_of_name_ordinals = symtab_data.GetU32(&offset);
691a4fe3a12SVirgile Bello 
692a4fe3a12SVirgile Bello         bool has_ordinal = export_table.address_of_name_ordinals != 0;
693a4fe3a12SVirgile Bello 
694a4fe3a12SVirgile Bello         lldb::offset_t name_offset = export_table.address_of_names - data_start;
695b9c1b51eSKate Stone         lldb::offset_t name_ordinal_offset =
696b9c1b51eSKate Stone             export_table.address_of_name_ordinals - data_start;
697a4fe3a12SVirgile Bello 
698d5b44036SJonas Devlieghere         Symbol *symbols = m_symtab_up->Resize(export_table.number_of_names);
699a4fe3a12SVirgile Bello 
700a4fe3a12SVirgile Bello         std::string symbol_name;
701a4fe3a12SVirgile Bello 
702a4fe3a12SVirgile Bello         // Read each export table entry
703b9c1b51eSKate Stone         for (size_t i = 0; i < export_table.number_of_names; ++i) {
704b9c1b51eSKate Stone           uint32_t name_ordinal =
705b9c1b51eSKate Stone               has_ordinal ? symtab_data.GetU16(&name_ordinal_offset) : i;
706a4fe3a12SVirgile Bello           uint32_t name_address = symtab_data.GetU32(&name_offset);
707a4fe3a12SVirgile Bello 
708b9c1b51eSKate Stone           const char *symbol_name_cstr =
709b9c1b51eSKate Stone               symtab_data.PeekCStr(name_address - data_start);
710a4fe3a12SVirgile Bello           symbol_name.assign(symbol_name_cstr);
711a4fe3a12SVirgile Bello 
712b9c1b51eSKate Stone           lldb::offset_t function_offset = export_table.address_of_functions -
713b9c1b51eSKate Stone                                            data_start +
714b9c1b51eSKate Stone                                            sizeof(uint32_t) * name_ordinal;
715a4fe3a12SVirgile Bello           uint32_t function_rva = symtab_data.GetU32(&function_offset);
716a4fe3a12SVirgile Bello 
717b9c1b51eSKate Stone           Address symbol_addr(m_coff_header_opt.image_base + function_rva,
718b9c1b51eSKate Stone                               sect_list);
719a4fe3a12SVirgile Bello           symbols[i].GetMangled().SetValue(ConstString(symbol_name.c_str()));
720358cf1eaSGreg Clayton           symbols[i].GetAddressRef() = symbol_addr;
721a4fe3a12SVirgile Bello           symbols[i].SetType(lldb::eSymbolTypeCode);
722a4fe3a12SVirgile Bello           symbols[i].SetDebug(true);
723a4fe3a12SVirgile Bello         }
724a4fe3a12SVirgile Bello       }
725d5b44036SJonas Devlieghere       m_symtab_up->CalculateSymbolSizes();
726f754f88fSGreg Clayton     }
727a1743499SGreg Clayton   }
728d5b44036SJonas Devlieghere   return m_symtab_up.get();
729f754f88fSGreg Clayton }
730f754f88fSGreg Clayton 
73130c2441aSAleksandr Urakov std::unique_ptr<CallFrameInfo> ObjectFilePECOFF::CreateCallFrameInfo() {
73230c2441aSAleksandr Urakov   if (coff_data_dir_exception_table >= m_coff_header_opt.data_dirs.size())
73330c2441aSAleksandr Urakov     return {};
73430c2441aSAleksandr Urakov 
73530c2441aSAleksandr Urakov   data_directory data_dir_exception =
73630c2441aSAleksandr Urakov       m_coff_header_opt.data_dirs[coff_data_dir_exception_table];
73730c2441aSAleksandr Urakov   if (!data_dir_exception.vmaddr)
73830c2441aSAleksandr Urakov     return {};
73930c2441aSAleksandr Urakov 
740aa786b88SMartin Storsjö   if (m_coff_header.machine != llvm::COFF::IMAGE_FILE_MACHINE_AMD64)
741aa786b88SMartin Storsjö     return {};
742aa786b88SMartin Storsjö 
74330c2441aSAleksandr Urakov   return std::make_unique<PECallFrameInfo>(*this, data_dir_exception.vmaddr,
74430c2441aSAleksandr Urakov                                            data_dir_exception.vmsize);
74530c2441aSAleksandr Urakov }
74630c2441aSAleksandr Urakov 
747b9c1b51eSKate Stone bool ObjectFilePECOFF::IsStripped() {
7483046e668SGreg Clayton   // TODO: determine this for COFF
7493046e668SGreg Clayton   return false;
7503046e668SGreg Clayton }
7513046e668SGreg Clayton 
7522e5bb6d8SMartin Storsjö SectionType ObjectFilePECOFF::GetSectionType(llvm::StringRef sect_name,
7532e5bb6d8SMartin Storsjö                                              const section_header_t &sect) {
7542e5bb6d8SMartin Storsjö   ConstString const_sect_name(sect_name);
7552e5bb6d8SMartin Storsjö   static ConstString g_code_sect_name(".code");
7562e5bb6d8SMartin Storsjö   static ConstString g_CODE_sect_name("CODE");
7572e5bb6d8SMartin Storsjö   static ConstString g_data_sect_name(".data");
7582e5bb6d8SMartin Storsjö   static ConstString g_DATA_sect_name("DATA");
7592e5bb6d8SMartin Storsjö   static ConstString g_bss_sect_name(".bss");
7602e5bb6d8SMartin Storsjö   static ConstString g_BSS_sect_name("BSS");
7612e5bb6d8SMartin Storsjö 
7622e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_CODE &&
7632e5bb6d8SMartin Storsjö       ((const_sect_name == g_code_sect_name) ||
7642e5bb6d8SMartin Storsjö        (const_sect_name == g_CODE_sect_name))) {
7652e5bb6d8SMartin Storsjö     return eSectionTypeCode;
7662e5bb6d8SMartin Storsjö   }
7672e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA &&
7682e5bb6d8SMartin Storsjö              ((const_sect_name == g_data_sect_name) ||
7692e5bb6d8SMartin Storsjö               (const_sect_name == g_DATA_sect_name))) {
7702e5bb6d8SMartin Storsjö     if (sect.size == 0 && sect.offset == 0)
7712e5bb6d8SMartin Storsjö       return eSectionTypeZeroFill;
7722e5bb6d8SMartin Storsjö     else
7732e5bb6d8SMartin Storsjö       return eSectionTypeData;
7742e5bb6d8SMartin Storsjö   }
7752e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA &&
7762e5bb6d8SMartin Storsjö              ((const_sect_name == g_bss_sect_name) ||
7772e5bb6d8SMartin Storsjö               (const_sect_name == g_BSS_sect_name))) {
7782e5bb6d8SMartin Storsjö     if (sect.size == 0)
7792e5bb6d8SMartin Storsjö       return eSectionTypeZeroFill;
7802e5bb6d8SMartin Storsjö     else
7812e5bb6d8SMartin Storsjö       return eSectionTypeData;
7822e5bb6d8SMartin Storsjö   }
7832e5bb6d8SMartin Storsjö 
7842e5bb6d8SMartin Storsjö   SectionType section_type =
7852e5bb6d8SMartin Storsjö       llvm::StringSwitch<SectionType>(sect_name)
7862e5bb6d8SMartin Storsjö           .Case(".debug", eSectionTypeDebug)
7872e5bb6d8SMartin Storsjö           .Case(".stabstr", eSectionTypeDataCString)
7882e5bb6d8SMartin Storsjö           .Case(".reloc", eSectionTypeOther)
7892e5bb6d8SMartin Storsjö           .Case(".debug_abbrev", eSectionTypeDWARFDebugAbbrev)
7902e5bb6d8SMartin Storsjö           .Case(".debug_aranges", eSectionTypeDWARFDebugAranges)
7912e5bb6d8SMartin Storsjö           .Case(".debug_frame", eSectionTypeDWARFDebugFrame)
7922e5bb6d8SMartin Storsjö           .Case(".debug_info", eSectionTypeDWARFDebugInfo)
7932e5bb6d8SMartin Storsjö           .Case(".debug_line", eSectionTypeDWARFDebugLine)
7942e5bb6d8SMartin Storsjö           .Case(".debug_loc", eSectionTypeDWARFDebugLoc)
7952e5bb6d8SMartin Storsjö           .Case(".debug_loclists", eSectionTypeDWARFDebugLocLists)
7962e5bb6d8SMartin Storsjö           .Case(".debug_macinfo", eSectionTypeDWARFDebugMacInfo)
7972e5bb6d8SMartin Storsjö           .Case(".debug_names", eSectionTypeDWARFDebugNames)
7982e5bb6d8SMartin Storsjö           .Case(".debug_pubnames", eSectionTypeDWARFDebugPubNames)
7992e5bb6d8SMartin Storsjö           .Case(".debug_pubtypes", eSectionTypeDWARFDebugPubTypes)
8002e5bb6d8SMartin Storsjö           .Case(".debug_ranges", eSectionTypeDWARFDebugRanges)
8012e5bb6d8SMartin Storsjö           .Case(".debug_str", eSectionTypeDWARFDebugStr)
8022e5bb6d8SMartin Storsjö           .Case(".debug_types", eSectionTypeDWARFDebugTypes)
803934c025eSMartin Storsjö           // .eh_frame can be truncated to 8 chars.
804934c025eSMartin Storsjö           .Cases(".eh_frame", ".eh_fram", eSectionTypeEHFrame)
8052e5bb6d8SMartin Storsjö           .Case(".gosymtab", eSectionTypeGoSymtab)
8062e5bb6d8SMartin Storsjö           .Default(eSectionTypeInvalid);
8072e5bb6d8SMartin Storsjö   if (section_type != eSectionTypeInvalid)
8082e5bb6d8SMartin Storsjö     return section_type;
8092e5bb6d8SMartin Storsjö 
8102e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_CODE)
8112e5bb6d8SMartin Storsjö     return eSectionTypeCode;
8122e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
8132e5bb6d8SMartin Storsjö     return eSectionTypeData;
8142e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) {
8152e5bb6d8SMartin Storsjö     if (sect.size == 0)
8162e5bb6d8SMartin Storsjö       return eSectionTypeZeroFill;
8172e5bb6d8SMartin Storsjö     else
8182e5bb6d8SMartin Storsjö       return eSectionTypeData;
8192e5bb6d8SMartin Storsjö   }
8202e5bb6d8SMartin Storsjö   return eSectionTypeOther;
8212e5bb6d8SMartin Storsjö }
8222e5bb6d8SMartin Storsjö 
823b9c1b51eSKate Stone void ObjectFilePECOFF::CreateSections(SectionList &unified_section_list) {
824d5b44036SJonas Devlieghere   if (m_sections_up)
82588a2c2a4SPavel Labath     return;
82606412daeSJonas Devlieghere   m_sections_up = std::make_unique<SectionList>();
827a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
828b9c1b51eSKate Stone   if (module_sp) {
82916ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
8307db8b5c4SPavel Labath 
83173a7a55cSPavel Labath     SectionSP header_sp = std::make_shared<Section>(
83273a7a55cSPavel Labath         module_sp, this, ~user_id_t(0), ConstString("PECOFF header"),
83373a7a55cSPavel Labath         eSectionTypeOther, m_coff_header_opt.image_base,
83473a7a55cSPavel Labath         m_coff_header_opt.header_size,
83573a7a55cSPavel Labath         /*file_offset*/ 0, m_coff_header_opt.header_size,
83673a7a55cSPavel Labath         m_coff_header_opt.sect_alignment,
8377db8b5c4SPavel Labath         /*flags*/ 0);
838f1e0ae34SPavel Labath     header_sp->SetPermissions(ePermissionsReadable);
83973a7a55cSPavel Labath     m_sections_up->AddSection(header_sp);
84073a7a55cSPavel Labath     unified_section_list.AddSection(header_sp);
8417db8b5c4SPavel Labath 
842f754f88fSGreg Clayton     const uint32_t nsects = m_sect_headers.size();
843e72dfb32SGreg Clayton     ModuleSP module_sp(GetModule());
844b9c1b51eSKate Stone     for (uint32_t idx = 0; idx < nsects; ++idx) {
8452e5bb6d8SMartin Storsjö       llvm::StringRef sect_name = GetSectionName(m_sect_headers[idx]);
8462e5bb6d8SMartin Storsjö       ConstString const_sect_name(sect_name);
8472e5bb6d8SMartin Storsjö       SectionType section_type = GetSectionType(sect_name, m_sect_headers[idx]);
848f754f88fSGreg Clayton 
849b9c1b51eSKate Stone       SectionSP section_sp(new Section(
850b9c1b51eSKate Stone           module_sp,       // Module to which this section belongs
851a7499c98SMichael Sartain           this,            // Object file to which this section belongs
8527db8b5c4SPavel Labath           idx + 1,         // Section ID is the 1 based section index.
853f754f88fSGreg Clayton           const_sect_name, // Name of this section
8547db8b5c4SPavel Labath           section_type,
85573a7a55cSPavel Labath           m_coff_header_opt.image_base +
856b9c1b51eSKate Stone               m_sect_headers[idx].vmaddr, // File VM address == addresses as
857b9c1b51eSKate Stone                                           // they are found in the object file
858f754f88fSGreg Clayton           m_sect_headers[idx].vmsize,     // VM size in bytes of this section
859b9c1b51eSKate Stone           m_sect_headers[idx]
860b9c1b51eSKate Stone               .offset, // Offset to the data for this section in the file
861b9c1b51eSKate Stone           m_sect_headers[idx]
862b9c1b51eSKate Stone               .size, // Size in bytes of this section as found in the file
86348672afbSGreg Clayton           m_coff_header_opt.sect_alignment, // Section alignment
864f754f88fSGreg Clayton           m_sect_headers[idx].flags));      // Flags for this section
865f754f88fSGreg Clayton 
866f1e0ae34SPavel Labath       uint32_t permissions = 0;
867f1e0ae34SPavel Labath       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_EXECUTE)
868f1e0ae34SPavel Labath         permissions |= ePermissionsExecutable;
869f1e0ae34SPavel Labath       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_READ)
870f1e0ae34SPavel Labath         permissions |= ePermissionsReadable;
871f1e0ae34SPavel Labath       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_WRITE)
872f1e0ae34SPavel Labath         permissions |= ePermissionsWritable;
873f1e0ae34SPavel Labath       section_sp->SetPermissions(permissions);
874f1e0ae34SPavel Labath 
87573a7a55cSPavel Labath       m_sections_up->AddSection(section_sp);
87673a7a55cSPavel Labath       unified_section_list.AddSection(section_sp);
877f754f88fSGreg Clayton     }
878f754f88fSGreg Clayton   }
879a1743499SGreg Clayton }
880f754f88fSGreg Clayton 
881b8d03935SAaron Smith UUID ObjectFilePECOFF::GetUUID() {
882b8d03935SAaron Smith   if (m_uuid.IsValid())
883b8d03935SAaron Smith     return m_uuid;
884b8d03935SAaron Smith 
885b8d03935SAaron Smith   if (!CreateBinary())
886b8d03935SAaron Smith     return UUID();
887b8d03935SAaron Smith 
888d372a8e8SPavel Labath   m_uuid = GetCoffUUID(*m_binary);
889b8d03935SAaron Smith   return m_uuid;
890b8d03935SAaron Smith }
891f754f88fSGreg Clayton 
892037ed1beSAaron Smith uint32_t ObjectFilePECOFF::ParseDependentModules() {
893037ed1beSAaron Smith   ModuleSP module_sp(GetModule());
894037ed1beSAaron Smith   if (!module_sp)
895f754f88fSGreg Clayton     return 0;
896037ed1beSAaron Smith 
897037ed1beSAaron Smith   std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
898037ed1beSAaron Smith   if (m_deps_filespec)
899037ed1beSAaron Smith     return m_deps_filespec->GetSize();
900037ed1beSAaron Smith 
901037ed1beSAaron Smith   // Cache coff binary if it is not done yet.
902037ed1beSAaron Smith   if (!CreateBinary())
903037ed1beSAaron Smith     return 0;
904037ed1beSAaron Smith 
905037ed1beSAaron Smith   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
906d372a8e8SPavel Labath   LLDB_LOG(log, "this = {0}, module = {1} ({2}), file = {3}, binary = {4}",
907d372a8e8SPavel Labath            this, GetModule().get(), GetModule()->GetSpecificationDescription(),
908d372a8e8SPavel Labath            m_file.GetPath(), m_binary.get());
909037ed1beSAaron Smith 
910037ed1beSAaron Smith   m_deps_filespec = FileSpecList();
911037ed1beSAaron Smith 
912d372a8e8SPavel Labath   for (const auto &entry : m_binary->import_directories()) {
913037ed1beSAaron Smith     llvm::StringRef dll_name;
914037ed1beSAaron Smith     // Report a bogus entry.
9151c03389cSReid Kleckner     if (llvm::Error e = entry.getName(dll_name)) {
91663e5fb76SJonas Devlieghere       LLDB_LOGF(log,
91763e5fb76SJonas Devlieghere                 "ObjectFilePECOFF::ParseDependentModules() - failed to get "
918037ed1beSAaron Smith                 "import directory entry name: %s",
9191c03389cSReid Kleckner                 llvm::toString(std::move(e)).c_str());
920037ed1beSAaron Smith       continue;
921037ed1beSAaron Smith     }
922037ed1beSAaron Smith 
923037ed1beSAaron Smith     // At this moment we only have the base name of the DLL. The full path can
924037ed1beSAaron Smith     // only be seen after the dynamic loading.  Our best guess is Try to get it
925037ed1beSAaron Smith     // with the help of the object file's directory.
926b3f44ad9SStella Stamenova     llvm::SmallString<128> dll_fullpath;
927037ed1beSAaron Smith     FileSpec dll_specs(dll_name);
928037ed1beSAaron Smith     dll_specs.GetDirectory().SetString(m_file.GetDirectory().GetCString());
929037ed1beSAaron Smith 
930037ed1beSAaron Smith     if (!llvm::sys::fs::real_path(dll_specs.GetPath(), dll_fullpath))
931f893d5bfSJonas Devlieghere       m_deps_filespec->EmplaceBack(dll_fullpath);
932037ed1beSAaron Smith     else {
933037ed1beSAaron Smith       // Known DLLs or DLL not found in the object file directory.
934f893d5bfSJonas Devlieghere       m_deps_filespec->EmplaceBack(dll_name);
935037ed1beSAaron Smith     }
936037ed1beSAaron Smith   }
937037ed1beSAaron Smith   return m_deps_filespec->GetSize();
938037ed1beSAaron Smith }
939037ed1beSAaron Smith 
940037ed1beSAaron Smith uint32_t ObjectFilePECOFF::GetDependentModules(FileSpecList &files) {
941037ed1beSAaron Smith   auto num_modules = ParseDependentModules();
942037ed1beSAaron Smith   auto original_size = files.GetSize();
943037ed1beSAaron Smith 
944037ed1beSAaron Smith   for (unsigned i = 0; i < num_modules; ++i)
945037ed1beSAaron Smith     files.AppendIfUnique(m_deps_filespec->GetFileSpecAtIndex(i));
946037ed1beSAaron Smith 
947037ed1beSAaron Smith   return files.GetSize() - original_size;
948f754f88fSGreg Clayton }
949f754f88fSGreg Clayton 
950b9c1b51eSKate Stone lldb_private::Address ObjectFilePECOFF::GetEntryPointAddress() {
9518e38c666SStephane Sezer   if (m_entry_point_address.IsValid())
9528e38c666SStephane Sezer     return m_entry_point_address;
9538e38c666SStephane Sezer 
9548e38c666SStephane Sezer   if (!ParseHeader() || !IsExecutable())
9558e38c666SStephane Sezer     return m_entry_point_address;
9568e38c666SStephane Sezer 
9578e38c666SStephane Sezer   SectionList *section_list = GetSectionList();
958a5235af9SAleksandr Urakov   addr_t file_addr = m_coff_header_opt.entry + m_coff_header_opt.image_base;
9598e38c666SStephane Sezer 
9608e38c666SStephane Sezer   if (!section_list)
961a5235af9SAleksandr Urakov     m_entry_point_address.SetOffset(file_addr);
9628e38c666SStephane Sezer   else
963b8d03935SAaron Smith     m_entry_point_address.ResolveAddressUsingFileSections(file_addr,
964b8d03935SAaron Smith                                                           section_list);
9658e38c666SStephane Sezer   return m_entry_point_address;
9668e38c666SStephane Sezer }
9678e38c666SStephane Sezer 
968d1304bbaSPavel Labath Address ObjectFilePECOFF::GetBaseAddress() {
969d1304bbaSPavel Labath   return Address(GetSectionList()->GetSectionAtIndex(0), 0);
970d1304bbaSPavel Labath }
971d1304bbaSPavel Labath 
972f754f88fSGreg Clayton // Dump
973f754f88fSGreg Clayton //
974f754f88fSGreg Clayton // Dump the specifics of the runtime file container (such as any headers
975f754f88fSGreg Clayton // segments, sections, etc).
976b9c1b51eSKate Stone void ObjectFilePECOFF::Dump(Stream *s) {
977a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
978b9c1b51eSKate Stone   if (module_sp) {
97916ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
980324a1036SSaleem Abdulrasool     s->Printf("%p: ", static_cast<void *>(this));
981f754f88fSGreg Clayton     s->Indent();
982f754f88fSGreg Clayton     s->PutCString("ObjectFilePECOFF");
983f754f88fSGreg Clayton 
984f760f5aeSPavel Labath     ArchSpec header_arch = GetArchitecture();
985f754f88fSGreg Clayton 
986b9c1b51eSKate Stone     *s << ", file = '" << m_file
987b9c1b51eSKate Stone        << "', arch = " << header_arch.GetArchitectureName() << "\n";
988f754f88fSGreg Clayton 
9893046e668SGreg Clayton     SectionList *sections = GetSectionList();
9903046e668SGreg Clayton     if (sections)
9913a168297SPavel Labath       sections->Dump(s->AsRawOstream(), s->GetIndentLevel(), nullptr, true,
9923a168297SPavel Labath                      UINT32_MAX);
993f754f88fSGreg Clayton 
994d5b44036SJonas Devlieghere     if (m_symtab_up)
995248a1305SKonrad Kleine       m_symtab_up->Dump(s, nullptr, eSortOrderNone);
996f754f88fSGreg Clayton 
997f754f88fSGreg Clayton     if (m_dos_header.e_magic)
998f754f88fSGreg Clayton       DumpDOSHeader(s, m_dos_header);
999b9c1b51eSKate Stone     if (m_coff_header.machine) {
1000f754f88fSGreg Clayton       DumpCOFFHeader(s, m_coff_header);
1001f754f88fSGreg Clayton       if (m_coff_header.hdrsize)
1002f754f88fSGreg Clayton         DumpOptCOFFHeader(s, m_coff_header_opt);
1003f754f88fSGreg Clayton     }
1004f754f88fSGreg Clayton     s->EOL();
1005f754f88fSGreg Clayton     DumpSectionHeaders(s);
1006f754f88fSGreg Clayton     s->EOL();
1007037ed1beSAaron Smith 
1008037ed1beSAaron Smith     DumpDependentModules(s);
1009037ed1beSAaron Smith     s->EOL();
1010f754f88fSGreg Clayton   }
1011a1743499SGreg Clayton }
1012f754f88fSGreg Clayton 
1013f754f88fSGreg Clayton // DumpDOSHeader
1014f754f88fSGreg Clayton //
1015f754f88fSGreg Clayton // Dump the MS-DOS header to the specified output stream
1016b9c1b51eSKate Stone void ObjectFilePECOFF::DumpDOSHeader(Stream *s, const dos_header_t &header) {
1017f754f88fSGreg Clayton   s->PutCString("MSDOS Header\n");
1018f754f88fSGreg Clayton   s->Printf("  e_magic    = 0x%4.4x\n", header.e_magic);
1019f754f88fSGreg Clayton   s->Printf("  e_cblp     = 0x%4.4x\n", header.e_cblp);
1020f754f88fSGreg Clayton   s->Printf("  e_cp       = 0x%4.4x\n", header.e_cp);
1021f754f88fSGreg Clayton   s->Printf("  e_crlc     = 0x%4.4x\n", header.e_crlc);
1022f754f88fSGreg Clayton   s->Printf("  e_cparhdr  = 0x%4.4x\n", header.e_cparhdr);
1023f754f88fSGreg Clayton   s->Printf("  e_minalloc = 0x%4.4x\n", header.e_minalloc);
1024f754f88fSGreg Clayton   s->Printf("  e_maxalloc = 0x%4.4x\n", header.e_maxalloc);
1025f754f88fSGreg Clayton   s->Printf("  e_ss       = 0x%4.4x\n", header.e_ss);
1026f754f88fSGreg Clayton   s->Printf("  e_sp       = 0x%4.4x\n", header.e_sp);
1027f754f88fSGreg Clayton   s->Printf("  e_csum     = 0x%4.4x\n", header.e_csum);
1028f754f88fSGreg Clayton   s->Printf("  e_ip       = 0x%4.4x\n", header.e_ip);
1029f754f88fSGreg Clayton   s->Printf("  e_cs       = 0x%4.4x\n", header.e_cs);
1030f754f88fSGreg Clayton   s->Printf("  e_lfarlc   = 0x%4.4x\n", header.e_lfarlc);
1031f754f88fSGreg Clayton   s->Printf("  e_ovno     = 0x%4.4x\n", header.e_ovno);
1032f754f88fSGreg Clayton   s->Printf("  e_res[4]   = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n",
1033b9c1b51eSKate Stone             header.e_res[0], header.e_res[1], header.e_res[2], header.e_res[3]);
1034f754f88fSGreg Clayton   s->Printf("  e_oemid    = 0x%4.4x\n", header.e_oemid);
1035f754f88fSGreg Clayton   s->Printf("  e_oeminfo  = 0x%4.4x\n", header.e_oeminfo);
1036b9c1b51eSKate Stone   s->Printf("  e_res2[10] = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, "
1037b9c1b51eSKate Stone             "0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n",
1038b9c1b51eSKate Stone             header.e_res2[0], header.e_res2[1], header.e_res2[2],
1039b9c1b51eSKate Stone             header.e_res2[3], header.e_res2[4], header.e_res2[5],
1040b9c1b51eSKate Stone             header.e_res2[6], header.e_res2[7], header.e_res2[8],
1041f754f88fSGreg Clayton             header.e_res2[9]);
1042f754f88fSGreg Clayton   s->Printf("  e_lfanew   = 0x%8.8x\n", header.e_lfanew);
1043f754f88fSGreg Clayton }
1044f754f88fSGreg Clayton 
1045f754f88fSGreg Clayton // DumpCOFFHeader
1046f754f88fSGreg Clayton //
1047f754f88fSGreg Clayton // Dump the COFF header to the specified output stream
1048b9c1b51eSKate Stone void ObjectFilePECOFF::DumpCOFFHeader(Stream *s, const coff_header_t &header) {
1049f754f88fSGreg Clayton   s->PutCString("COFF Header\n");
1050f754f88fSGreg Clayton   s->Printf("  machine = 0x%4.4x\n", header.machine);
1051f754f88fSGreg Clayton   s->Printf("  nsects  = 0x%4.4x\n", header.nsects);
1052f754f88fSGreg Clayton   s->Printf("  modtime = 0x%8.8x\n", header.modtime);
1053f754f88fSGreg Clayton   s->Printf("  symoff  = 0x%8.8x\n", header.symoff);
1054f754f88fSGreg Clayton   s->Printf("  nsyms   = 0x%8.8x\n", header.nsyms);
1055f754f88fSGreg Clayton   s->Printf("  hdrsize = 0x%4.4x\n", header.hdrsize);
1056f754f88fSGreg Clayton }
1057f754f88fSGreg Clayton 
1058f754f88fSGreg Clayton // DumpOptCOFFHeader
1059f754f88fSGreg Clayton //
1060f754f88fSGreg Clayton // Dump the optional COFF header to the specified output stream
1061b9c1b51eSKate Stone void ObjectFilePECOFF::DumpOptCOFFHeader(Stream *s,
1062b9c1b51eSKate Stone                                          const coff_opt_header_t &header) {
1063f754f88fSGreg Clayton   s->PutCString("Optional COFF Header\n");
1064f754f88fSGreg Clayton   s->Printf("  magic                   = 0x%4.4x\n", header.magic);
1065b9c1b51eSKate Stone   s->Printf("  major_linker_version    = 0x%2.2x\n",
1066b9c1b51eSKate Stone             header.major_linker_version);
1067b9c1b51eSKate Stone   s->Printf("  minor_linker_version    = 0x%2.2x\n",
1068b9c1b51eSKate Stone             header.minor_linker_version);
1069f754f88fSGreg Clayton   s->Printf("  code_size               = 0x%8.8x\n", header.code_size);
1070f754f88fSGreg Clayton   s->Printf("  data_size               = 0x%8.8x\n", header.data_size);
1071f754f88fSGreg Clayton   s->Printf("  bss_size                = 0x%8.8x\n", header.bss_size);
1072f754f88fSGreg Clayton   s->Printf("  entry                   = 0x%8.8x\n", header.entry);
1073f754f88fSGreg Clayton   s->Printf("  code_offset             = 0x%8.8x\n", header.code_offset);
1074f754f88fSGreg Clayton   s->Printf("  data_offset             = 0x%8.8x\n", header.data_offset);
1075b9c1b51eSKate Stone   s->Printf("  image_base              = 0x%16.16" PRIx64 "\n",
1076b9c1b51eSKate Stone             header.image_base);
1077f754f88fSGreg Clayton   s->Printf("  sect_alignment          = 0x%8.8x\n", header.sect_alignment);
1078f754f88fSGreg Clayton   s->Printf("  file_alignment          = 0x%8.8x\n", header.file_alignment);
1079b9c1b51eSKate Stone   s->Printf("  major_os_system_version = 0x%4.4x\n",
1080b9c1b51eSKate Stone             header.major_os_system_version);
1081b9c1b51eSKate Stone   s->Printf("  minor_os_system_version = 0x%4.4x\n",
1082b9c1b51eSKate Stone             header.minor_os_system_version);
1083b9c1b51eSKate Stone   s->Printf("  major_image_version     = 0x%4.4x\n",
1084b9c1b51eSKate Stone             header.major_image_version);
1085b9c1b51eSKate Stone   s->Printf("  minor_image_version     = 0x%4.4x\n",
1086b9c1b51eSKate Stone             header.minor_image_version);
1087b9c1b51eSKate Stone   s->Printf("  major_subsystem_version = 0x%4.4x\n",
1088b9c1b51eSKate Stone             header.major_subsystem_version);
1089b9c1b51eSKate Stone   s->Printf("  minor_subsystem_version = 0x%4.4x\n",
1090b9c1b51eSKate Stone             header.minor_subsystem_version);
1091f754f88fSGreg Clayton   s->Printf("  reserved1               = 0x%8.8x\n", header.reserved1);
1092f754f88fSGreg Clayton   s->Printf("  image_size              = 0x%8.8x\n", header.image_size);
1093f754f88fSGreg Clayton   s->Printf("  header_size             = 0x%8.8x\n", header.header_size);
109428469ca3SGreg Clayton   s->Printf("  checksum                = 0x%8.8x\n", header.checksum);
1095f754f88fSGreg Clayton   s->Printf("  subsystem               = 0x%4.4x\n", header.subsystem);
1096f754f88fSGreg Clayton   s->Printf("  dll_flags               = 0x%4.4x\n", header.dll_flags);
1097b9c1b51eSKate Stone   s->Printf("  stack_reserve_size      = 0x%16.16" PRIx64 "\n",
1098b9c1b51eSKate Stone             header.stack_reserve_size);
1099b9c1b51eSKate Stone   s->Printf("  stack_commit_size       = 0x%16.16" PRIx64 "\n",
1100b9c1b51eSKate Stone             header.stack_commit_size);
1101b9c1b51eSKate Stone   s->Printf("  heap_reserve_size       = 0x%16.16" PRIx64 "\n",
1102b9c1b51eSKate Stone             header.heap_reserve_size);
1103b9c1b51eSKate Stone   s->Printf("  heap_commit_size        = 0x%16.16" PRIx64 "\n",
1104b9c1b51eSKate Stone             header.heap_commit_size);
1105f754f88fSGreg Clayton   s->Printf("  loader_flags            = 0x%8.8x\n", header.loader_flags);
1106b9c1b51eSKate Stone   s->Printf("  num_data_dir_entries    = 0x%8.8x\n",
1107b9c1b51eSKate Stone             (uint32_t)header.data_dirs.size());
1108f754f88fSGreg Clayton   uint32_t i;
1109b9c1b51eSKate Stone   for (i = 0; i < header.data_dirs.size(); i++) {
1110b9c1b51eSKate Stone     s->Printf("  data_dirs[%2u] vmaddr = 0x%8.8x, vmsize = 0x%8.8x\n", i,
1111b9c1b51eSKate Stone               header.data_dirs[i].vmaddr, header.data_dirs[i].vmsize);
1112f754f88fSGreg Clayton   }
1113f754f88fSGreg Clayton }
1114f754f88fSGreg Clayton // DumpSectionHeader
1115f754f88fSGreg Clayton //
1116f754f88fSGreg Clayton // Dump a single ELF section header to the specified output stream
1117b9c1b51eSKate Stone void ObjectFilePECOFF::DumpSectionHeader(Stream *s,
1118b9c1b51eSKate Stone                                          const section_header_t &sh) {
1119adcd0268SBenjamin Kramer   std::string name = std::string(GetSectionName(sh));
1120b9c1b51eSKate 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 "
1121b9c1b51eSKate Stone             "0x%4.4x 0x%8.8x\n",
1122b9c1b51eSKate Stone             name.c_str(), sh.vmaddr, sh.vmsize, sh.offset, sh.size, sh.reloff,
1123b9c1b51eSKate Stone             sh.lineoff, sh.nreloc, sh.nline, sh.flags);
1124f754f88fSGreg Clayton }
1125f754f88fSGreg Clayton 
1126f754f88fSGreg Clayton // DumpSectionHeaders
1127f754f88fSGreg Clayton //
1128f754f88fSGreg Clayton // Dump all of the ELF section header to the specified output stream
1129b9c1b51eSKate Stone void ObjectFilePECOFF::DumpSectionHeaders(Stream *s) {
1130f754f88fSGreg Clayton 
1131f754f88fSGreg Clayton   s->PutCString("Section Headers\n");
1132b9c1b51eSKate Stone   s->PutCString("IDX  name             vm addr    vm size    file off   file "
1133b9c1b51eSKate Stone                 "size  reloc off  line off   nreloc nline  flags\n");
1134b9c1b51eSKate Stone   s->PutCString("==== ---------------- ---------- ---------- ---------- "
1135b9c1b51eSKate Stone                 "---------- ---------- ---------- ------ ------ ----------\n");
1136f754f88fSGreg Clayton 
1137f754f88fSGreg Clayton   uint32_t idx = 0;
1138f754f88fSGreg Clayton   SectionHeaderCollIter pos, end = m_sect_headers.end();
1139f754f88fSGreg Clayton 
1140b9c1b51eSKate Stone   for (pos = m_sect_headers.begin(); pos != end; ++pos, ++idx) {
1141f754f88fSGreg Clayton     s->Printf("[%2u] ", idx);
1142f754f88fSGreg Clayton     ObjectFilePECOFF::DumpSectionHeader(s, *pos);
1143f754f88fSGreg Clayton   }
1144f754f88fSGreg Clayton }
1145f754f88fSGreg Clayton 
1146037ed1beSAaron Smith // DumpDependentModules
1147037ed1beSAaron Smith //
1148037ed1beSAaron Smith // Dump all of the dependent modules to the specified output stream
1149037ed1beSAaron Smith void ObjectFilePECOFF::DumpDependentModules(lldb_private::Stream *s) {
1150037ed1beSAaron Smith   auto num_modules = ParseDependentModules();
1151037ed1beSAaron Smith   if (num_modules > 0) {
1152037ed1beSAaron Smith     s->PutCString("Dependent Modules\n");
1153037ed1beSAaron Smith     for (unsigned i = 0; i < num_modules; ++i) {
1154037ed1beSAaron Smith       auto spec = m_deps_filespec->GetFileSpecAtIndex(i);
1155037ed1beSAaron Smith       s->Printf("  %s\n", spec.GetFilename().GetCString());
1156037ed1beSAaron Smith     }
1157037ed1beSAaron Smith   }
1158037ed1beSAaron Smith }
1159037ed1beSAaron Smith 
1160fb3b3bd1SZachary Turner bool ObjectFilePECOFF::IsWindowsSubsystem() {
1161fb3b3bd1SZachary Turner   switch (m_coff_header_opt.subsystem) {
1162fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE:
1163fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_GUI:
1164fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CUI:
1165fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE_WINDOWS:
1166fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CE_GUI:
1167fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_XBOX:
1168fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION:
1169fb3b3bd1SZachary Turner     return true;
1170fb3b3bd1SZachary Turner   default:
1171fb3b3bd1SZachary Turner     return false;
1172fb3b3bd1SZachary Turner   }
1173fb3b3bd1SZachary Turner }
1174fb3b3bd1SZachary Turner 
1175f760f5aeSPavel Labath ArchSpec ObjectFilePECOFF::GetArchitecture() {
1176237ad974SCharles Davis   uint16_t machine = m_coff_header.machine;
1177b9c1b51eSKate Stone   switch (machine) {
1178f760f5aeSPavel Labath   default:
1179f760f5aeSPavel Labath     break;
1180237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_AMD64:
1181237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_I386:
1182237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_POWERPC:
1183237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_POWERPCFP:
1184237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_ARM:
11851108cb36SSaleem Abdulrasool   case llvm::COFF::IMAGE_FILE_MACHINE_ARMNT:
1186237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_THUMB:
1187638f072fSMartin Storsjo   case llvm::COFF::IMAGE_FILE_MACHINE_ARM64:
1188f760f5aeSPavel Labath     ArchSpec arch;
1189fb3b3bd1SZachary Turner     arch.SetArchitecture(eArchTypeCOFF, machine, LLDB_INVALID_CPUTYPE,
1190fb3b3bd1SZachary Turner                          IsWindowsSubsystem() ? llvm::Triple::Win32
1191fb3b3bd1SZachary Turner                                               : llvm::Triple::UnknownOS);
1192f760f5aeSPavel Labath     return arch;
1193237ad974SCharles Davis   }
1194f760f5aeSPavel Labath   return ArchSpec();
1195f754f88fSGreg Clayton }
1196f754f88fSGreg Clayton 
1197b9c1b51eSKate Stone ObjectFile::Type ObjectFilePECOFF::CalculateType() {
1198b9c1b51eSKate Stone   if (m_coff_header.machine != 0) {
1199237ad974SCharles Davis     if ((m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0)
1200f754f88fSGreg Clayton       return eTypeExecutable;
1201f754f88fSGreg Clayton     else
1202f754f88fSGreg Clayton       return eTypeSharedLibrary;
1203f754f88fSGreg Clayton   }
1204f754f88fSGreg Clayton   return eTypeExecutable;
1205f754f88fSGreg Clayton }
1206f754f88fSGreg Clayton 
1207b9c1b51eSKate Stone ObjectFile::Strata ObjectFilePECOFF::CalculateStrata() { return eStrataUser; }
12089cad24a7SZachary Turner 
1209f754f88fSGreg Clayton // PluginInterface protocol
1210b9c1b51eSKate Stone ConstString ObjectFilePECOFF::GetPluginName() { return GetPluginNameStatic(); }
1211f754f88fSGreg Clayton 
1212b9c1b51eSKate Stone uint32_t ObjectFilePECOFF::GetPluginVersion() { return 1; }
1213