1f754f88fSGreg Clayton //===-- ObjectFilePECOFF.cpp ------------------------------------*- C++ -*-===//
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"
10f7d1893fSAdrian McCarthy #include "WindowsMiniDump.h"
11f754f88fSGreg Clayton 
12f754f88fSGreg Clayton #include "lldb/Core/FileSpecList.h"
13f754f88fSGreg Clayton #include "lldb/Core/Module.h"
14f4d6de6aSGreg Clayton #include "lldb/Core/ModuleSpec.h"
15f754f88fSGreg Clayton #include "lldb/Core/PluginManager.h"
16f754f88fSGreg Clayton #include "lldb/Core/Section.h"
17f754f88fSGreg Clayton #include "lldb/Core/StreamFile.h"
18f754f88fSGreg Clayton #include "lldb/Symbol/ObjectFile.h"
19f7d1893fSAdrian McCarthy #include "lldb/Target/Process.h"
202756adf3SVirgile Bello #include "lldb/Target/SectionLoadList.h"
212756adf3SVirgile Bello #include "lldb/Target/Target.h"
225f19b907SPavel Labath #include "lldb/Utility/ArchSpec.h"
23666cc0b2SZachary Turner #include "lldb/Utility/DataBufferHeap.h"
245713a05bSZachary Turner #include "lldb/Utility/FileSpec.h"
25037ed1beSAaron Smith #include "lldb/Utility/Log.h"
26bf9a7730SZachary Turner #include "lldb/Utility/StreamString.h"
2738d0632eSPavel Labath #include "lldb/Utility/Timer.h"
28666cc0b2SZachary Turner #include "lldb/Utility/UUID.h"
295f19b907SPavel Labath #include "llvm/BinaryFormat/COFF.h"
30f754f88fSGreg Clayton 
31037ed1beSAaron Smith #include "llvm/Object/COFFImportFile.h"
32037ed1beSAaron Smith #include "llvm/Support/Error.h"
333f4a4b36SZachary Turner #include "llvm/Support/MemoryBuffer.h"
343f4a4b36SZachary Turner 
35f754f88fSGreg Clayton #define IMAGE_DOS_SIGNATURE 0x5A4D    // MZ
36f754f88fSGreg Clayton #define IMAGE_NT_SIGNATURE 0x00004550 // PE00
37f754f88fSGreg Clayton #define OPT_HEADER_MAGIC_PE32 0x010b
38f754f88fSGreg Clayton #define OPT_HEADER_MAGIC_PE32_PLUS 0x020b
39f754f88fSGreg Clayton 
40f754f88fSGreg Clayton using namespace lldb;
41f754f88fSGreg Clayton using namespace lldb_private;
42f754f88fSGreg Clayton 
43b8d03935SAaron Smith struct CVInfoPdb70 {
44b8d03935SAaron Smith   // 16-byte GUID
45b8d03935SAaron Smith   struct _Guid {
46b8d03935SAaron Smith     llvm::support::ulittle32_t Data1;
47b8d03935SAaron Smith     llvm::support::ulittle16_t Data2;
48b8d03935SAaron Smith     llvm::support::ulittle16_t Data3;
49b8d03935SAaron Smith     uint8_t Data4[8];
50b8d03935SAaron Smith   } Guid;
51b8d03935SAaron Smith 
52b8d03935SAaron Smith   llvm::support::ulittle32_t Age;
53b8d03935SAaron Smith };
54b8d03935SAaron Smith 
55b8d03935SAaron Smith static UUID GetCoffUUID(llvm::object::COFFObjectFile *coff_obj) {
56b8d03935SAaron Smith   if (!coff_obj)
57b8d03935SAaron Smith     return UUID();
58b8d03935SAaron Smith 
59b8d03935SAaron Smith   const llvm::codeview::DebugInfo *pdb_info = nullptr;
60b8d03935SAaron Smith   llvm::StringRef pdb_file;
61b8d03935SAaron Smith 
62b8d03935SAaron Smith   // This part is similar with what has done in minidump parser.
63b8d03935SAaron Smith   if (!coff_obj->getDebugPDBInfo(pdb_info, pdb_file) && pdb_info) {
64b8d03935SAaron Smith     if (pdb_info->PDB70.CVSignature == llvm::OMF::Signature::PDB70) {
65b8d03935SAaron Smith       using llvm::support::endian::read16be;
66b8d03935SAaron Smith       using llvm::support::endian::read32be;
67b8d03935SAaron Smith 
68b8d03935SAaron Smith       const uint8_t *sig = pdb_info->PDB70.Signature;
69b8d03935SAaron Smith       struct CVInfoPdb70 info;
70b8d03935SAaron Smith       info.Guid.Data1 = read32be(sig);
71b8d03935SAaron Smith       sig += 4;
72b8d03935SAaron Smith       info.Guid.Data2 = read16be(sig);
73b8d03935SAaron Smith       sig += 2;
74b8d03935SAaron Smith       info.Guid.Data3 = read16be(sig);
75b8d03935SAaron Smith       sig += 2;
76b8d03935SAaron Smith       memcpy(info.Guid.Data4, sig, 8);
77b8d03935SAaron Smith 
78b8d03935SAaron Smith       // Return 20-byte UUID if the Age is not zero
79b8d03935SAaron Smith       if (pdb_info->PDB70.Age) {
80b8d03935SAaron Smith         info.Age = read32be(&pdb_info->PDB70.Age);
81b8d03935SAaron Smith         return UUID::fromOptionalData(&info, sizeof(info));
82b8d03935SAaron Smith       }
83b8d03935SAaron Smith       // Otherwise return 16-byte GUID
84b8d03935SAaron Smith       return UUID::fromOptionalData(&info.Guid, sizeof(info.Guid));
85b8d03935SAaron Smith     }
86b8d03935SAaron Smith   }
87b8d03935SAaron Smith 
88b8d03935SAaron Smith   return UUID();
89b8d03935SAaron Smith }
90b8d03935SAaron Smith 
91b9c1b51eSKate Stone void ObjectFilePECOFF::Initialize() {
92b9c1b51eSKate Stone   PluginManager::RegisterPlugin(
93b9c1b51eSKate Stone       GetPluginNameStatic(), GetPluginDescriptionStatic(), CreateInstance,
94b9c1b51eSKate Stone       CreateMemoryInstance, GetModuleSpecifications, SaveCore);
95f754f88fSGreg Clayton }
96f754f88fSGreg Clayton 
97b9c1b51eSKate Stone void ObjectFilePECOFF::Terminate() {
98f754f88fSGreg Clayton   PluginManager::UnregisterPlugin(CreateInstance);
99f754f88fSGreg Clayton }
100f754f88fSGreg Clayton 
101b9c1b51eSKate Stone lldb_private::ConstString ObjectFilePECOFF::GetPluginNameStatic() {
10257abc5d6SGreg Clayton   static ConstString g_name("pe-coff");
10357abc5d6SGreg Clayton   return g_name;
104f754f88fSGreg Clayton }
105f754f88fSGreg Clayton 
106b9c1b51eSKate Stone const char *ObjectFilePECOFF::GetPluginDescriptionStatic() {
107b9c1b51eSKate Stone   return "Portable Executable and Common Object File Format object file reader "
108b9c1b51eSKate Stone          "(32 and 64 bit)";
109f754f88fSGreg Clayton }
110f754f88fSGreg Clayton 
111b9c1b51eSKate Stone ObjectFile *ObjectFilePECOFF::CreateInstance(const lldb::ModuleSP &module_sp,
1125ce9c565SGreg Clayton                                              DataBufferSP &data_sp,
1135ce9c565SGreg Clayton                                              lldb::offset_t data_offset,
1145ce9c565SGreg Clayton                                              const lldb_private::FileSpec *file,
1155ce9c565SGreg Clayton                                              lldb::offset_t file_offset,
116b9c1b51eSKate Stone                                              lldb::offset_t length) {
117b9c1b51eSKate Stone   if (!data_sp) {
11850251fc7SPavel Labath     data_sp = MapFileData(file, length, file_offset);
1193f4a4b36SZachary Turner     if (!data_sp)
1203f4a4b36SZachary Turner       return nullptr;
1215ce9c565SGreg Clayton     data_offset = 0;
1225ce9c565SGreg Clayton   }
1235ce9c565SGreg Clayton 
1243f4a4b36SZachary Turner   if (!ObjectFilePECOFF::MagicBytesMatch(data_sp))
1253f4a4b36SZachary Turner     return nullptr;
1263f4a4b36SZachary Turner 
1275ce9c565SGreg Clayton   // Update the data to contain the entire file if it doesn't already
1283f4a4b36SZachary Turner   if (data_sp->GetByteSize() < length) {
12950251fc7SPavel Labath     data_sp = MapFileData(file, length, file_offset);
1303f4a4b36SZachary Turner     if (!data_sp)
1313f4a4b36SZachary Turner       return nullptr;
132f754f88fSGreg Clayton   }
1333f4a4b36SZachary Turner 
134d5b44036SJonas Devlieghere   auto objfile_up = llvm::make_unique<ObjectFilePECOFF>(
1353f4a4b36SZachary Turner       module_sp, data_sp, data_offset, file, file_offset, length);
136d5b44036SJonas Devlieghere   if (!objfile_up || !objfile_up->ParseHeader())
1373f4a4b36SZachary Turner     return nullptr;
1383f4a4b36SZachary Turner 
139037ed1beSAaron Smith   // Cache coff binary.
140d5b44036SJonas Devlieghere   if (!objfile_up->CreateBinary())
141037ed1beSAaron Smith     return nullptr;
142037ed1beSAaron Smith 
143d5b44036SJonas Devlieghere   return objfile_up.release();
144f754f88fSGreg Clayton }
145f754f88fSGreg Clayton 
146b9c1b51eSKate Stone ObjectFile *ObjectFilePECOFF::CreateMemoryInstance(
147b9c1b51eSKate Stone     const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
148b9c1b51eSKate Stone     const lldb::ProcessSP &process_sp, lldb::addr_t header_addr) {
149344546bdSWalter Erquinigo   if (!data_sp || !ObjectFilePECOFF::MagicBytesMatch(data_sp))
150344546bdSWalter Erquinigo     return nullptr;
151d5b44036SJonas Devlieghere   auto objfile_up = llvm::make_unique<ObjectFilePECOFF>(
152344546bdSWalter Erquinigo       module_sp, data_sp, process_sp, header_addr);
153d5b44036SJonas Devlieghere   if (objfile_up.get() && objfile_up->ParseHeader()) {
154d5b44036SJonas Devlieghere     return objfile_up.release();
155344546bdSWalter Erquinigo   }
156344546bdSWalter Erquinigo   return nullptr;
157c9660546SGreg Clayton }
158c9660546SGreg Clayton 
159b9c1b51eSKate Stone size_t ObjectFilePECOFF::GetModuleSpecifications(
160b9c1b51eSKate Stone     const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp,
161b9c1b51eSKate Stone     lldb::offset_t data_offset, lldb::offset_t file_offset,
162b9c1b51eSKate Stone     lldb::offset_t length, lldb_private::ModuleSpecList &specs) {
16389eb1baeSVirgile Bello   const size_t initial_count = specs.GetSize();
164b8d03935SAaron Smith   if (!data_sp || !ObjectFilePECOFF::MagicBytesMatch(data_sp))
165b8d03935SAaron Smith     return initial_count;
16689eb1baeSVirgile Bello 
167b8d03935SAaron Smith   auto binary = llvm::object::createBinary(file.GetPath());
168b8d03935SAaron Smith   if (!binary)
169b8d03935SAaron Smith     return initial_count;
17089eb1baeSVirgile Bello 
171b8d03935SAaron Smith   if (!binary->getBinary()->isCOFF() &&
172b8d03935SAaron Smith       !binary->getBinary()->isCOFFImportFile())
173b8d03935SAaron Smith     return initial_count;
17489eb1baeSVirgile Bello 
175b8d03935SAaron Smith   auto COFFObj =
176b8d03935SAaron Smith     llvm::cast<llvm::object::COFFObjectFile>(binary->getBinary());
177b8d03935SAaron Smith 
178b8d03935SAaron Smith   ModuleSpec module_spec(file);
179b8d03935SAaron Smith   ArchSpec &spec = module_spec.GetArchitecture();
180b8d03935SAaron Smith   lldb_private::UUID &uuid = module_spec.GetUUID();
181b8d03935SAaron Smith   if (!uuid.IsValid())
182b8d03935SAaron Smith     uuid = GetCoffUUID(COFFObj);
183b8d03935SAaron Smith 
184b8d03935SAaron Smith   switch (COFFObj->getMachine()) {
185b8d03935SAaron Smith   case MachineAmd64:
186ad587ae4SZachary Turner     spec.SetTriple("x86_64-pc-windows");
187b8d03935SAaron Smith     specs.Append(module_spec);
188b8d03935SAaron Smith     break;
189b8d03935SAaron Smith   case MachineX86:
190ad587ae4SZachary Turner     spec.SetTriple("i386-pc-windows");
191b8d03935SAaron Smith     specs.Append(module_spec);
1925e6f4520SZachary Turner     spec.SetTriple("i686-pc-windows");
193b8d03935SAaron Smith     specs.Append(module_spec);
194b8d03935SAaron Smith     break;
195b8d03935SAaron Smith   case MachineArmNt:
1967b6e8ef6SStephane Sezer     spec.SetTriple("arm-pc-windows");
197b8d03935SAaron Smith     specs.Append(module_spec);
198b8d03935SAaron Smith     break;
199b8d03935SAaron Smith   default:
200b8d03935SAaron Smith     break;
20189eb1baeSVirgile Bello   }
20289eb1baeSVirgile Bello 
20389eb1baeSVirgile Bello   return specs.GetSize() - initial_count;
204f4d6de6aSGreg Clayton }
205f4d6de6aSGreg Clayton 
206b9c1b51eSKate Stone bool ObjectFilePECOFF::SaveCore(const lldb::ProcessSP &process_sp,
207f7d1893fSAdrian McCarthy                                 const lldb_private::FileSpec &outfile,
20897206d57SZachary Turner                                 lldb_private::Status &error) {
209f7d1893fSAdrian McCarthy   return SaveMiniDump(process_sp, outfile, error);
210f7d1893fSAdrian McCarthy }
211f7d1893fSAdrian McCarthy 
212b9c1b51eSKate Stone bool ObjectFilePECOFF::MagicBytesMatch(DataBufferSP &data_sp) {
2135ce9c565SGreg Clayton   DataExtractor data(data_sp, eByteOrderLittle, 4);
214c7bece56SGreg Clayton   lldb::offset_t offset = 0;
215f754f88fSGreg Clayton   uint16_t magic = data.GetU16(&offset);
216f754f88fSGreg Clayton   return magic == IMAGE_DOS_SIGNATURE;
217f754f88fSGreg Clayton }
218f754f88fSGreg Clayton 
219b9c1b51eSKate Stone lldb::SymbolType ObjectFilePECOFF::MapSymbolType(uint16_t coff_symbol_type) {
220c35b91ceSAdrian McCarthy   // TODO:  We need to complete this mapping of COFF symbol types to LLDB ones.
221c35b91ceSAdrian McCarthy   // For now, here's a hack to make sure our function have types.
222b9c1b51eSKate Stone   const auto complex_type =
223b9c1b51eSKate Stone       coff_symbol_type >> llvm::COFF::SCT_COMPLEX_TYPE_SHIFT;
224b9c1b51eSKate Stone   if (complex_type == llvm::COFF::IMAGE_SYM_DTYPE_FUNCTION) {
225c35b91ceSAdrian McCarthy     return lldb::eSymbolTypeCode;
226c35b91ceSAdrian McCarthy   }
227c35b91ceSAdrian McCarthy   return lldb::eSymbolTypeInvalid;
228c35b91ceSAdrian McCarthy }
229f754f88fSGreg Clayton 
230037ed1beSAaron Smith bool ObjectFilePECOFF::CreateBinary() {
231037ed1beSAaron Smith   if (m_owningbin)
232037ed1beSAaron Smith     return true;
233037ed1beSAaron Smith 
234037ed1beSAaron Smith   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
235037ed1beSAaron Smith 
236037ed1beSAaron Smith   auto binary = llvm::object::createBinary(m_file.GetPath());
237037ed1beSAaron Smith   if (!binary) {
23863e5fb76SJonas Devlieghere     LLDB_LOGF(log,
23963e5fb76SJonas Devlieghere               "ObjectFilePECOFF::CreateBinary() - failed to create binary "
240037ed1beSAaron Smith               "for file (%s): %s",
241037ed1beSAaron Smith               m_file ? m_file.GetPath().c_str() : "<NULL>",
242037ed1beSAaron Smith               errorToErrorCode(binary.takeError()).message().c_str());
243037ed1beSAaron Smith     return false;
244037ed1beSAaron Smith   }
245037ed1beSAaron Smith 
246037ed1beSAaron Smith   // Make sure we only handle COFF format.
247037ed1beSAaron Smith   if (!binary->getBinary()->isCOFF() &&
248037ed1beSAaron Smith       !binary->getBinary()->isCOFFImportFile())
249037ed1beSAaron Smith     return false;
250037ed1beSAaron Smith 
251037ed1beSAaron Smith   m_owningbin = OWNBINType(std::move(*binary));
25263e5fb76SJonas Devlieghere   LLDB_LOGF(log,
25363e5fb76SJonas Devlieghere             "%p ObjectFilePECOFF::CreateBinary() module = %p (%s), file = "
254037ed1beSAaron Smith             "%s, binary = %p (Bin = %p)",
25563e5fb76SJonas Devlieghere             static_cast<void *>(this), static_cast<void *>(GetModule().get()),
256037ed1beSAaron Smith             GetModule()->GetSpecificationDescription().c_str(),
257037ed1beSAaron Smith             m_file ? m_file.GetPath().c_str() : "<NULL>",
258037ed1beSAaron Smith             static_cast<void *>(m_owningbin.getPointer()),
259037ed1beSAaron Smith             static_cast<void *>(m_owningbin->getBinary()));
260037ed1beSAaron Smith   return true;
261037ed1beSAaron Smith }
262037ed1beSAaron Smith 
263e72dfb32SGreg Clayton ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
2645ce9c565SGreg Clayton                                    DataBufferSP &data_sp,
2655ce9c565SGreg Clayton                                    lldb::offset_t data_offset,
266f754f88fSGreg Clayton                                    const FileSpec *file,
2675ce9c565SGreg Clayton                                    lldb::offset_t file_offset,
268b9c1b51eSKate Stone                                    lldb::offset_t length)
269b9c1b51eSKate Stone     : ObjectFile(module_sp, file, file_offset, length, data_sp, data_offset),
270*5c43ffd6SPavel Labath       m_dos_header(), m_coff_header(), m_sect_headers(),
271037ed1beSAaron Smith       m_entry_point_address(), m_deps_filespec(), m_owningbin() {
272f754f88fSGreg Clayton   ::memset(&m_dos_header, 0, sizeof(m_dos_header));
273f754f88fSGreg Clayton   ::memset(&m_coff_header, 0, sizeof(m_coff_header));
274f754f88fSGreg Clayton }
275f754f88fSGreg Clayton 
276344546bdSWalter Erquinigo ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
277344546bdSWalter Erquinigo                                    DataBufferSP &header_data_sp,
278344546bdSWalter Erquinigo                                    const lldb::ProcessSP &process_sp,
279344546bdSWalter Erquinigo                                    addr_t header_addr)
280344546bdSWalter Erquinigo     : ObjectFile(module_sp, process_sp, header_addr, header_data_sp),
281*5c43ffd6SPavel Labath       m_dos_header(), m_coff_header(), m_sect_headers(),
282037ed1beSAaron Smith       m_entry_point_address(), m_deps_filespec(), m_owningbin() {
283344546bdSWalter Erquinigo   ::memset(&m_dos_header, 0, sizeof(m_dos_header));
284344546bdSWalter Erquinigo   ::memset(&m_coff_header, 0, sizeof(m_coff_header));
285344546bdSWalter Erquinigo }
286344546bdSWalter Erquinigo 
287b9c1b51eSKate Stone ObjectFilePECOFF::~ObjectFilePECOFF() {}
288f754f88fSGreg Clayton 
289b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseHeader() {
290a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
291b9c1b51eSKate Stone   if (module_sp) {
29216ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
293f754f88fSGreg Clayton     m_sect_headers.clear();
294f754f88fSGreg Clayton     m_data.SetByteOrder(eByteOrderLittle);
295c7bece56SGreg Clayton     lldb::offset_t offset = 0;
296f754f88fSGreg Clayton 
297b9c1b51eSKate Stone     if (ParseDOSHeader(m_data, m_dos_header)) {
298f754f88fSGreg Clayton       offset = m_dos_header.e_lfanew;
299f754f88fSGreg Clayton       uint32_t pe_signature = m_data.GetU32(&offset);
300f754f88fSGreg Clayton       if (pe_signature != IMAGE_NT_SIGNATURE)
301f754f88fSGreg Clayton         return false;
302b9c1b51eSKate Stone       if (ParseCOFFHeader(m_data, &offset, m_coff_header)) {
303f754f88fSGreg Clayton         if (m_coff_header.hdrsize > 0)
304f754f88fSGreg Clayton           ParseCOFFOptionalHeader(&offset);
305f754f88fSGreg Clayton         ParseSectionHeaders(offset);
30628469ca3SGreg Clayton       }
307f754f88fSGreg Clayton       return true;
308f754f88fSGreg Clayton     }
309a1743499SGreg Clayton   }
310f754f88fSGreg Clayton   return false;
311f754f88fSGreg Clayton }
312f754f88fSGreg Clayton 
313b9c1b51eSKate Stone bool ObjectFilePECOFF::SetLoadAddress(Target &target, addr_t value,
314b9c1b51eSKate Stone                                       bool value_is_offset) {
3152756adf3SVirgile Bello   bool changed = false;
3162756adf3SVirgile Bello   ModuleSP module_sp = GetModule();
317b9c1b51eSKate Stone   if (module_sp) {
3182756adf3SVirgile Bello     size_t num_loaded_sections = 0;
3192756adf3SVirgile Bello     SectionList *section_list = GetSectionList();
320b9c1b51eSKate Stone     if (section_list) {
321b9c1b51eSKate Stone       if (!value_is_offset) {
3222756adf3SVirgile Bello         value -= m_image_base;
3232756adf3SVirgile Bello       }
3242756adf3SVirgile Bello 
3252756adf3SVirgile Bello       const size_t num_sections = section_list->GetSize();
3262756adf3SVirgile Bello       size_t sect_idx = 0;
3272756adf3SVirgile Bello 
328b9c1b51eSKate Stone       for (sect_idx = 0; sect_idx < num_sections; ++sect_idx) {
32905097246SAdrian Prantl         // Iterate through the object file sections to find all of the sections
33005097246SAdrian Prantl         // that have SHF_ALLOC in their flag bits.
3312756adf3SVirgile Bello         SectionSP section_sp(section_list->GetSectionAtIndex(sect_idx));
332b9c1b51eSKate Stone         if (section_sp && !section_sp->IsThreadSpecific()) {
333b9c1b51eSKate Stone           if (target.GetSectionLoadList().SetSectionLoadAddress(
334b9c1b51eSKate Stone                   section_sp, section_sp->GetFileAddress() + value))
3352756adf3SVirgile Bello             ++num_loaded_sections;
3362756adf3SVirgile Bello         }
3372756adf3SVirgile Bello       }
3382756adf3SVirgile Bello       changed = num_loaded_sections > 0;
3392756adf3SVirgile Bello     }
3402756adf3SVirgile Bello   }
3412756adf3SVirgile Bello   return changed;
3422756adf3SVirgile Bello }
3432756adf3SVirgile Bello 
344b9c1b51eSKate Stone ByteOrder ObjectFilePECOFF::GetByteOrder() const { return eByteOrderLittle; }
345f754f88fSGreg Clayton 
346b9c1b51eSKate Stone bool ObjectFilePECOFF::IsExecutable() const {
347237ad974SCharles Davis   return (m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0;
348f754f88fSGreg Clayton }
349f754f88fSGreg Clayton 
350b9c1b51eSKate Stone uint32_t ObjectFilePECOFF::GetAddressByteSize() const {
351f754f88fSGreg Clayton   if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32_PLUS)
352f754f88fSGreg Clayton     return 8;
353f754f88fSGreg Clayton   else if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32)
354f754f88fSGreg Clayton     return 4;
355f754f88fSGreg Clayton   return 4;
356f754f88fSGreg Clayton }
357f754f88fSGreg Clayton 
358f754f88fSGreg Clayton // NeedsEndianSwap
359f754f88fSGreg Clayton //
36005097246SAdrian Prantl // Return true if an endian swap needs to occur when extracting data from this
36105097246SAdrian Prantl // file.
362b9c1b51eSKate Stone bool ObjectFilePECOFF::NeedsEndianSwap() const {
363f754f88fSGreg Clayton #if defined(__LITTLE_ENDIAN__)
364f754f88fSGreg Clayton   return false;
365f754f88fSGreg Clayton #else
366f754f88fSGreg Clayton   return true;
367f754f88fSGreg Clayton #endif
368f754f88fSGreg Clayton }
369f754f88fSGreg Clayton // ParseDOSHeader
370b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseDOSHeader(DataExtractor &data,
371b9c1b51eSKate Stone                                       dos_header_t &dos_header) {
372f754f88fSGreg Clayton   bool success = false;
373c7bece56SGreg Clayton   lldb::offset_t offset = 0;
37489eb1baeSVirgile Bello   success = data.ValidOffsetForDataOfSize(0, sizeof(dos_header));
375f754f88fSGreg Clayton 
376b9c1b51eSKate Stone   if (success) {
37789eb1baeSVirgile Bello     dos_header.e_magic = data.GetU16(&offset); // Magic number
37889eb1baeSVirgile Bello     success = dos_header.e_magic == IMAGE_DOS_SIGNATURE;
379f754f88fSGreg Clayton 
380b9c1b51eSKate Stone     if (success) {
38189eb1baeSVirgile Bello       dos_header.e_cblp = data.GetU16(&offset); // Bytes on last page of file
38289eb1baeSVirgile Bello       dos_header.e_cp = data.GetU16(&offset);   // Pages in file
38389eb1baeSVirgile Bello       dos_header.e_crlc = data.GetU16(&offset); // Relocations
384b9c1b51eSKate Stone       dos_header.e_cparhdr =
385b9c1b51eSKate Stone           data.GetU16(&offset); // Size of header in paragraphs
386b9c1b51eSKate Stone       dos_header.e_minalloc =
387b9c1b51eSKate Stone           data.GetU16(&offset); // Minimum extra paragraphs needed
388b9c1b51eSKate Stone       dos_header.e_maxalloc =
389b9c1b51eSKate Stone           data.GetU16(&offset);               // Maximum extra paragraphs needed
39089eb1baeSVirgile Bello       dos_header.e_ss = data.GetU16(&offset); // Initial (relative) SS value
39189eb1baeSVirgile Bello       dos_header.e_sp = data.GetU16(&offset); // Initial SP value
39289eb1baeSVirgile Bello       dos_header.e_csum = data.GetU16(&offset); // Checksum
39389eb1baeSVirgile Bello       dos_header.e_ip = data.GetU16(&offset);   // Initial IP value
39489eb1baeSVirgile Bello       dos_header.e_cs = data.GetU16(&offset);   // Initial (relative) CS value
395b9c1b51eSKate Stone       dos_header.e_lfarlc =
396b9c1b51eSKate Stone           data.GetU16(&offset); // File address of relocation table
39789eb1baeSVirgile Bello       dos_header.e_ovno = data.GetU16(&offset); // Overlay number
398f754f88fSGreg Clayton 
39989eb1baeSVirgile Bello       dos_header.e_res[0] = data.GetU16(&offset); // Reserved words
40089eb1baeSVirgile Bello       dos_header.e_res[1] = data.GetU16(&offset); // Reserved words
40189eb1baeSVirgile Bello       dos_header.e_res[2] = data.GetU16(&offset); // Reserved words
40289eb1baeSVirgile Bello       dos_header.e_res[3] = data.GetU16(&offset); // Reserved words
403f754f88fSGreg Clayton 
404b9c1b51eSKate Stone       dos_header.e_oemid =
405b9c1b51eSKate Stone           data.GetU16(&offset); // OEM identifier (for e_oeminfo)
406b9c1b51eSKate Stone       dos_header.e_oeminfo =
407b9c1b51eSKate Stone           data.GetU16(&offset); // OEM information; e_oemid specific
40889eb1baeSVirgile Bello       dos_header.e_res2[0] = data.GetU16(&offset); // Reserved words
40989eb1baeSVirgile Bello       dos_header.e_res2[1] = data.GetU16(&offset); // Reserved words
41089eb1baeSVirgile Bello       dos_header.e_res2[2] = data.GetU16(&offset); // Reserved words
41189eb1baeSVirgile Bello       dos_header.e_res2[3] = data.GetU16(&offset); // Reserved words
41289eb1baeSVirgile Bello       dos_header.e_res2[4] = data.GetU16(&offset); // Reserved words
41389eb1baeSVirgile Bello       dos_header.e_res2[5] = data.GetU16(&offset); // Reserved words
41489eb1baeSVirgile Bello       dos_header.e_res2[6] = data.GetU16(&offset); // Reserved words
41589eb1baeSVirgile Bello       dos_header.e_res2[7] = data.GetU16(&offset); // Reserved words
41689eb1baeSVirgile Bello       dos_header.e_res2[8] = data.GetU16(&offset); // Reserved words
41789eb1baeSVirgile Bello       dos_header.e_res2[9] = data.GetU16(&offset); // Reserved words
418f754f88fSGreg Clayton 
419b9c1b51eSKate Stone       dos_header.e_lfanew =
420b9c1b51eSKate Stone           data.GetU32(&offset); // File address of new exe header
421f754f88fSGreg Clayton     }
422f754f88fSGreg Clayton   }
423f754f88fSGreg Clayton   if (!success)
42489eb1baeSVirgile Bello     memset(&dos_header, 0, sizeof(dos_header));
425f754f88fSGreg Clayton   return success;
426f754f88fSGreg Clayton }
427f754f88fSGreg Clayton 
428f754f88fSGreg Clayton // ParserCOFFHeader
429b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseCOFFHeader(DataExtractor &data,
430b9c1b51eSKate Stone                                        lldb::offset_t *offset_ptr,
431b9c1b51eSKate Stone                                        coff_header_t &coff_header) {
432b9c1b51eSKate Stone   bool success =
433b9c1b51eSKate Stone       data.ValidOffsetForDataOfSize(*offset_ptr, sizeof(coff_header));
434b9c1b51eSKate Stone   if (success) {
43589eb1baeSVirgile Bello     coff_header.machine = data.GetU16(offset_ptr);
43689eb1baeSVirgile Bello     coff_header.nsects = data.GetU16(offset_ptr);
43789eb1baeSVirgile Bello     coff_header.modtime = data.GetU32(offset_ptr);
43889eb1baeSVirgile Bello     coff_header.symoff = data.GetU32(offset_ptr);
43989eb1baeSVirgile Bello     coff_header.nsyms = data.GetU32(offset_ptr);
44089eb1baeSVirgile Bello     coff_header.hdrsize = data.GetU16(offset_ptr);
44189eb1baeSVirgile Bello     coff_header.flags = data.GetU16(offset_ptr);
442f754f88fSGreg Clayton   }
443f754f88fSGreg Clayton   if (!success)
44489eb1baeSVirgile Bello     memset(&coff_header, 0, sizeof(coff_header));
445f754f88fSGreg Clayton   return success;
446f754f88fSGreg Clayton }
447f754f88fSGreg Clayton 
448b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseCOFFOptionalHeader(lldb::offset_t *offset_ptr) {
449f754f88fSGreg Clayton   bool success = false;
450c7bece56SGreg Clayton   const lldb::offset_t end_offset = *offset_ptr + m_coff_header.hdrsize;
451b9c1b51eSKate Stone   if (*offset_ptr < end_offset) {
452f754f88fSGreg Clayton     success = true;
453f754f88fSGreg Clayton     m_coff_header_opt.magic = m_data.GetU16(offset_ptr);
454f754f88fSGreg Clayton     m_coff_header_opt.major_linker_version = m_data.GetU8(offset_ptr);
455f754f88fSGreg Clayton     m_coff_header_opt.minor_linker_version = m_data.GetU8(offset_ptr);
456f754f88fSGreg Clayton     m_coff_header_opt.code_size = m_data.GetU32(offset_ptr);
457f754f88fSGreg Clayton     m_coff_header_opt.data_size = m_data.GetU32(offset_ptr);
458f754f88fSGreg Clayton     m_coff_header_opt.bss_size = m_data.GetU32(offset_ptr);
459f754f88fSGreg Clayton     m_coff_header_opt.entry = m_data.GetU32(offset_ptr);
460f754f88fSGreg Clayton     m_coff_header_opt.code_offset = m_data.GetU32(offset_ptr);
461f754f88fSGreg Clayton 
462f754f88fSGreg Clayton     const uint32_t addr_byte_size = GetAddressByteSize();
463f754f88fSGreg Clayton 
464b9c1b51eSKate Stone     if (*offset_ptr < end_offset) {
465b9c1b51eSKate Stone       if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32) {
466f754f88fSGreg Clayton         // PE32 only
467f754f88fSGreg Clayton         m_coff_header_opt.data_offset = m_data.GetU32(offset_ptr);
468b9c1b51eSKate Stone       } else
469f754f88fSGreg Clayton         m_coff_header_opt.data_offset = 0;
470f754f88fSGreg Clayton 
471b9c1b51eSKate Stone       if (*offset_ptr < end_offset) {
472b9c1b51eSKate Stone         m_coff_header_opt.image_base =
473b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
474f754f88fSGreg Clayton         m_coff_header_opt.sect_alignment = m_data.GetU32(offset_ptr);
475f754f88fSGreg Clayton         m_coff_header_opt.file_alignment = m_data.GetU32(offset_ptr);
476f754f88fSGreg Clayton         m_coff_header_opt.major_os_system_version = m_data.GetU16(offset_ptr);
477f754f88fSGreg Clayton         m_coff_header_opt.minor_os_system_version = m_data.GetU16(offset_ptr);
478f754f88fSGreg Clayton         m_coff_header_opt.major_image_version = m_data.GetU16(offset_ptr);
479f754f88fSGreg Clayton         m_coff_header_opt.minor_image_version = m_data.GetU16(offset_ptr);
480f754f88fSGreg Clayton         m_coff_header_opt.major_subsystem_version = m_data.GetU16(offset_ptr);
481f754f88fSGreg Clayton         m_coff_header_opt.minor_subsystem_version = m_data.GetU16(offset_ptr);
482f754f88fSGreg Clayton         m_coff_header_opt.reserved1 = m_data.GetU32(offset_ptr);
483f754f88fSGreg Clayton         m_coff_header_opt.image_size = m_data.GetU32(offset_ptr);
484f754f88fSGreg Clayton         m_coff_header_opt.header_size = m_data.GetU32(offset_ptr);
48528469ca3SGreg Clayton         m_coff_header_opt.checksum = m_data.GetU32(offset_ptr);
486f754f88fSGreg Clayton         m_coff_header_opt.subsystem = m_data.GetU16(offset_ptr);
487f754f88fSGreg Clayton         m_coff_header_opt.dll_flags = m_data.GetU16(offset_ptr);
488b9c1b51eSKate Stone         m_coff_header_opt.stack_reserve_size =
489b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
490b9c1b51eSKate Stone         m_coff_header_opt.stack_commit_size =
491b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
492b9c1b51eSKate Stone         m_coff_header_opt.heap_reserve_size =
493b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
494b9c1b51eSKate Stone         m_coff_header_opt.heap_commit_size =
495b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
496f754f88fSGreg Clayton         m_coff_header_opt.loader_flags = m_data.GetU32(offset_ptr);
497f754f88fSGreg Clayton         uint32_t num_data_dir_entries = m_data.GetU32(offset_ptr);
498f754f88fSGreg Clayton         m_coff_header_opt.data_dirs.clear();
499f754f88fSGreg Clayton         m_coff_header_opt.data_dirs.resize(num_data_dir_entries);
500f754f88fSGreg Clayton         uint32_t i;
501b9c1b51eSKate Stone         for (i = 0; i < num_data_dir_entries; i++) {
502f754f88fSGreg Clayton           m_coff_header_opt.data_dirs[i].vmaddr = m_data.GetU32(offset_ptr);
503f754f88fSGreg Clayton           m_coff_header_opt.data_dirs[i].vmsize = m_data.GetU32(offset_ptr);
504f754f88fSGreg Clayton         }
5052756adf3SVirgile Bello 
5062756adf3SVirgile Bello         m_image_base = m_coff_header_opt.image_base;
507f754f88fSGreg Clayton       }
508f754f88fSGreg Clayton     }
509f754f88fSGreg Clayton   }
510f754f88fSGreg Clayton   // Make sure we are on track for section data which follows
511f754f88fSGreg Clayton   *offset_ptr = end_offset;
512f754f88fSGreg Clayton   return success;
513f754f88fSGreg Clayton }
514f754f88fSGreg Clayton 
515344546bdSWalter Erquinigo DataExtractor ObjectFilePECOFF::ReadImageData(uint32_t offset, size_t size) {
516344546bdSWalter Erquinigo   if (m_file) {
5177f6a7a37SZachary Turner     // A bit of a hack, but we intend to write to this buffer, so we can't
5187f6a7a37SZachary Turner     // mmap it.
51950251fc7SPavel Labath     auto buffer_sp = MapFileData(m_file, size, offset);
520344546bdSWalter Erquinigo     return DataExtractor(buffer_sp, GetByteOrder(), GetAddressByteSize());
521344546bdSWalter Erquinigo   }
522344546bdSWalter Erquinigo   ProcessSP process_sp(m_process_wp.lock());
523344546bdSWalter Erquinigo   DataExtractor data;
524344546bdSWalter Erquinigo   if (process_sp) {
525d5b44036SJonas Devlieghere     auto data_up = llvm::make_unique<DataBufferHeap>(size, 0);
52697206d57SZachary Turner     Status readmem_error;
527344546bdSWalter Erquinigo     size_t bytes_read =
528d5b44036SJonas Devlieghere         process_sp->ReadMemory(m_image_base + offset, data_up->GetBytes(),
529d5b44036SJonas Devlieghere                                data_up->GetByteSize(), readmem_error);
530344546bdSWalter Erquinigo     if (bytes_read == size) {
531d5b44036SJonas Devlieghere       DataBufferSP buffer_sp(data_up.release());
532344546bdSWalter Erquinigo       data.SetData(buffer_sp, 0, buffer_sp->GetByteSize());
533344546bdSWalter Erquinigo     }
534344546bdSWalter Erquinigo   }
535344546bdSWalter Erquinigo   return data;
536344546bdSWalter Erquinigo }
537344546bdSWalter Erquinigo 
538f754f88fSGreg Clayton // ParseSectionHeaders
539b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseSectionHeaders(
540b9c1b51eSKate Stone     uint32_t section_header_data_offset) {
541f754f88fSGreg Clayton   const uint32_t nsects = m_coff_header.nsects;
542f754f88fSGreg Clayton   m_sect_headers.clear();
543f754f88fSGreg Clayton 
544b9c1b51eSKate Stone   if (nsects > 0) {
545f754f88fSGreg Clayton     const size_t section_header_byte_size = nsects * sizeof(section_header_t);
546344546bdSWalter Erquinigo     DataExtractor section_header_data =
547344546bdSWalter Erquinigo         ReadImageData(section_header_data_offset, section_header_byte_size);
548f754f88fSGreg Clayton 
549c7bece56SGreg Clayton     lldb::offset_t offset = 0;
550b9c1b51eSKate Stone     if (section_header_data.ValidOffsetForDataOfSize(
551b9c1b51eSKate Stone             offset, section_header_byte_size)) {
552f754f88fSGreg Clayton       m_sect_headers.resize(nsects);
553f754f88fSGreg Clayton 
554b9c1b51eSKate Stone       for (uint32_t idx = 0; idx < nsects; ++idx) {
555f754f88fSGreg Clayton         const void *name_data = section_header_data.GetData(&offset, 8);
556b9c1b51eSKate Stone         if (name_data) {
557f754f88fSGreg Clayton           memcpy(m_sect_headers[idx].name, name_data, 8);
558f754f88fSGreg Clayton           m_sect_headers[idx].vmsize = section_header_data.GetU32(&offset);
559f754f88fSGreg Clayton           m_sect_headers[idx].vmaddr = section_header_data.GetU32(&offset);
560f754f88fSGreg Clayton           m_sect_headers[idx].size = section_header_data.GetU32(&offset);
561f754f88fSGreg Clayton           m_sect_headers[idx].offset = section_header_data.GetU32(&offset);
562f754f88fSGreg Clayton           m_sect_headers[idx].reloff = section_header_data.GetU32(&offset);
563f754f88fSGreg Clayton           m_sect_headers[idx].lineoff = section_header_data.GetU32(&offset);
564f754f88fSGreg Clayton           m_sect_headers[idx].nreloc = section_header_data.GetU16(&offset);
565f754f88fSGreg Clayton           m_sect_headers[idx].nline = section_header_data.GetU16(&offset);
566f754f88fSGreg Clayton           m_sect_headers[idx].flags = section_header_data.GetU32(&offset);
567f754f88fSGreg Clayton         }
568f754f88fSGreg Clayton       }
569f754f88fSGreg Clayton     }
570f754f88fSGreg Clayton   }
571f754f88fSGreg Clayton 
572a6682a41SJonas Devlieghere   return !m_sect_headers.empty();
573f754f88fSGreg Clayton }
574f754f88fSGreg Clayton 
5752886e4a0SPavel Labath llvm::StringRef ObjectFilePECOFF::GetSectionName(const section_header_t &sect) {
5762886e4a0SPavel Labath   llvm::StringRef hdr_name(sect.name, llvm::array_lengthof(sect.name));
5772886e4a0SPavel Labath   hdr_name = hdr_name.split('\0').first;
5782886e4a0SPavel Labath   if (hdr_name.consume_front("/")) {
5792886e4a0SPavel Labath     lldb::offset_t stroff;
5802886e4a0SPavel Labath     if (!to_integer(hdr_name, stroff, 10))
5812886e4a0SPavel Labath       return "";
582b9c1b51eSKate Stone     lldb::offset_t string_file_offset =
583b9c1b51eSKate Stone         m_coff_header.symoff + (m_coff_header.nsyms * 18) + stroff;
5842886e4a0SPavel Labath     if (const char *name = m_data.GetCStr(&string_file_offset))
5852886e4a0SPavel Labath       return name;
5862886e4a0SPavel Labath     return "";
587f754f88fSGreg Clayton   }
5882886e4a0SPavel Labath   return hdr_name;
589f754f88fSGreg Clayton }
590f754f88fSGreg Clayton 
591f754f88fSGreg Clayton // GetNListSymtab
592b9c1b51eSKate Stone Symtab *ObjectFilePECOFF::GetSymtab() {
593a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
594b9c1b51eSKate Stone   if (module_sp) {
59516ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
596248a1305SKonrad Kleine     if (m_symtab_up == nullptr) {
597f754f88fSGreg Clayton       SectionList *sect_list = GetSectionList();
598d5b44036SJonas Devlieghere       m_symtab_up.reset(new Symtab(this));
599d5b44036SJonas Devlieghere       std::lock_guard<std::recursive_mutex> guard(m_symtab_up->GetMutex());
60028469ca3SGreg Clayton 
60128469ca3SGreg Clayton       const uint32_t num_syms = m_coff_header.nsyms;
60228469ca3SGreg Clayton 
603344546bdSWalter Erquinigo       if (m_file && num_syms > 0 && m_coff_header.symoff > 0) {
6040076e715SGreg Clayton         const uint32_t symbol_size = 18;
60528469ca3SGreg Clayton         const size_t symbol_data_size = num_syms * symbol_size;
606c35b91ceSAdrian McCarthy         // Include the 4-byte string table size at the end of the symbols
607344546bdSWalter Erquinigo         DataExtractor symtab_data =
608344546bdSWalter Erquinigo             ReadImageData(m_coff_header.symoff, symbol_data_size + 4);
609c7bece56SGreg Clayton         lldb::offset_t offset = symbol_data_size;
61028469ca3SGreg Clayton         const uint32_t strtab_size = symtab_data.GetU32(&offset);
611344546bdSWalter Erquinigo         if (strtab_size > 0) {
612344546bdSWalter Erquinigo           DataExtractor strtab_data = ReadImageData(
613344546bdSWalter Erquinigo               m_coff_header.symoff + symbol_data_size, strtab_size);
61428469ca3SGreg Clayton 
6150076e715SGreg Clayton           // First 4 bytes should be zeroed after strtab_size has been read,
6160076e715SGreg Clayton           // because it is used as offset 0 to encode a NULL string.
617f76e099cSSaleem Abdulrasool           uint32_t *strtab_data_start = const_cast<uint32_t *>(
618f76e099cSSaleem Abdulrasool               reinterpret_cast<const uint32_t *>(strtab_data.GetDataStart()));
6190076e715SGreg Clayton           strtab_data_start[0] = 0;
6200076e715SGreg 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) {
653b9c1b51eSKate Stone               Address symbol_addr(sect_list->GetSectionAtIndex(symbol.sect - 1),
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;
6610076e715SGreg Clayton               offset += 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 
675344546bdSWalter Erquinigo         uint32_t address_rva = data_start;
676344546bdSWalter Erquinigo         if (m_file) {
677a4fe3a12SVirgile Bello           Address address(m_coff_header_opt.image_base + data_start, sect_list);
678344546bdSWalter Erquinigo           address_rva =
679344546bdSWalter Erquinigo               address.GetSection()->GetFileOffset() + address.GetOffset();
680344546bdSWalter Erquinigo         }
681344546bdSWalter Erquinigo         DataExtractor symtab_data =
682344546bdSWalter Erquinigo             ReadImageData(address_rva, m_coff_header_opt.data_dirs[0].vmsize);
683a4fe3a12SVirgile Bello         lldb::offset_t offset = 0;
684a4fe3a12SVirgile Bello 
685a4fe3a12SVirgile Bello         // Read export_table header
686a4fe3a12SVirgile Bello         export_table.characteristics = symtab_data.GetU32(&offset);
687a4fe3a12SVirgile Bello         export_table.time_date_stamp = symtab_data.GetU32(&offset);
688a4fe3a12SVirgile Bello         export_table.major_version = symtab_data.GetU16(&offset);
689a4fe3a12SVirgile Bello         export_table.minor_version = symtab_data.GetU16(&offset);
690a4fe3a12SVirgile Bello         export_table.name = symtab_data.GetU32(&offset);
691a4fe3a12SVirgile Bello         export_table.base = symtab_data.GetU32(&offset);
692a4fe3a12SVirgile Bello         export_table.number_of_functions = symtab_data.GetU32(&offset);
693a4fe3a12SVirgile Bello         export_table.number_of_names = symtab_data.GetU32(&offset);
694a4fe3a12SVirgile Bello         export_table.address_of_functions = symtab_data.GetU32(&offset);
695a4fe3a12SVirgile Bello         export_table.address_of_names = symtab_data.GetU32(&offset);
696a4fe3a12SVirgile Bello         export_table.address_of_name_ordinals = symtab_data.GetU32(&offset);
697a4fe3a12SVirgile Bello 
698a4fe3a12SVirgile Bello         bool has_ordinal = export_table.address_of_name_ordinals != 0;
699a4fe3a12SVirgile Bello 
700a4fe3a12SVirgile Bello         lldb::offset_t name_offset = export_table.address_of_names - data_start;
701b9c1b51eSKate Stone         lldb::offset_t name_ordinal_offset =
702b9c1b51eSKate Stone             export_table.address_of_name_ordinals - data_start;
703a4fe3a12SVirgile Bello 
704d5b44036SJonas Devlieghere         Symbol *symbols = m_symtab_up->Resize(export_table.number_of_names);
705a4fe3a12SVirgile Bello 
706a4fe3a12SVirgile Bello         std::string symbol_name;
707a4fe3a12SVirgile Bello 
708a4fe3a12SVirgile Bello         // Read each export table entry
709b9c1b51eSKate Stone         for (size_t i = 0; i < export_table.number_of_names; ++i) {
710b9c1b51eSKate Stone           uint32_t name_ordinal =
711b9c1b51eSKate Stone               has_ordinal ? symtab_data.GetU16(&name_ordinal_offset) : i;
712a4fe3a12SVirgile Bello           uint32_t name_address = symtab_data.GetU32(&name_offset);
713a4fe3a12SVirgile Bello 
714b9c1b51eSKate Stone           const char *symbol_name_cstr =
715b9c1b51eSKate Stone               symtab_data.PeekCStr(name_address - data_start);
716a4fe3a12SVirgile Bello           symbol_name.assign(symbol_name_cstr);
717a4fe3a12SVirgile Bello 
718b9c1b51eSKate Stone           lldb::offset_t function_offset = export_table.address_of_functions -
719b9c1b51eSKate Stone                                            data_start +
720b9c1b51eSKate Stone                                            sizeof(uint32_t) * name_ordinal;
721a4fe3a12SVirgile Bello           uint32_t function_rva = symtab_data.GetU32(&function_offset);
722a4fe3a12SVirgile Bello 
723b9c1b51eSKate Stone           Address symbol_addr(m_coff_header_opt.image_base + function_rva,
724b9c1b51eSKate Stone                               sect_list);
725a4fe3a12SVirgile Bello           symbols[i].GetMangled().SetValue(ConstString(symbol_name.c_str()));
726358cf1eaSGreg Clayton           symbols[i].GetAddressRef() = symbol_addr;
727a4fe3a12SVirgile Bello           symbols[i].SetType(lldb::eSymbolTypeCode);
728a4fe3a12SVirgile Bello           symbols[i].SetDebug(true);
729a4fe3a12SVirgile Bello         }
730a4fe3a12SVirgile Bello       }
731d5b44036SJonas Devlieghere       m_symtab_up->CalculateSymbolSizes();
732f754f88fSGreg Clayton     }
733a1743499SGreg Clayton   }
734d5b44036SJonas Devlieghere   return m_symtab_up.get();
735f754f88fSGreg Clayton }
736f754f88fSGreg Clayton 
737b9c1b51eSKate Stone bool ObjectFilePECOFF::IsStripped() {
7383046e668SGreg Clayton   // TODO: determine this for COFF
7393046e668SGreg Clayton   return false;
7403046e668SGreg Clayton }
7413046e668SGreg Clayton 
742b9c1b51eSKate Stone void ObjectFilePECOFF::CreateSections(SectionList &unified_section_list) {
743d5b44036SJonas Devlieghere   if (m_sections_up)
74488a2c2a4SPavel Labath     return;
745d5b44036SJonas Devlieghere   m_sections_up.reset(new SectionList());
7463046e668SGreg Clayton 
747a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
748b9c1b51eSKate Stone   if (module_sp) {
74916ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
7507db8b5c4SPavel Labath 
7517db8b5c4SPavel Labath     SectionSP image_sp = std::make_shared<Section>(
7527db8b5c4SPavel Labath         module_sp, this, ~user_id_t(0), ConstString(), eSectionTypeContainer,
7537db8b5c4SPavel Labath         m_coff_header_opt.image_base, m_coff_header_opt.image_size,
7547db8b5c4SPavel Labath         /*file_offset*/ 0, /*file_size*/ 0, m_coff_header_opt.sect_alignment,
7557db8b5c4SPavel Labath         /*flags*/ 0);
7567db8b5c4SPavel Labath     m_sections_up->AddSection(image_sp);
7577db8b5c4SPavel Labath     unified_section_list.AddSection(image_sp);
7587db8b5c4SPavel Labath 
759f754f88fSGreg Clayton     const uint32_t nsects = m_sect_headers.size();
760e72dfb32SGreg Clayton     ModuleSP module_sp(GetModule());
761b9c1b51eSKate Stone     for (uint32_t idx = 0; idx < nsects; ++idx) {
7622886e4a0SPavel Labath       ConstString const_sect_name(GetSectionName(m_sect_headers[idx]));
76328469ca3SGreg Clayton       static ConstString g_code_sect_name(".code");
76428469ca3SGreg Clayton       static ConstString g_CODE_sect_name("CODE");
76528469ca3SGreg Clayton       static ConstString g_data_sect_name(".data");
76628469ca3SGreg Clayton       static ConstString g_DATA_sect_name("DATA");
76728469ca3SGreg Clayton       static ConstString g_bss_sect_name(".bss");
76828469ca3SGreg Clayton       static ConstString g_BSS_sect_name("BSS");
76928469ca3SGreg Clayton       static ConstString g_debug_sect_name(".debug");
77028469ca3SGreg Clayton       static ConstString g_reloc_sect_name(".reloc");
77128469ca3SGreg Clayton       static ConstString g_stab_sect_name(".stab");
77228469ca3SGreg Clayton       static ConstString g_stabstr_sect_name(".stabstr");
7730076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_abbrev(".debug_abbrev");
7740076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_aranges(".debug_aranges");
7750076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_frame(".debug_frame");
7760076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_info(".debug_info");
7770076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_line(".debug_line");
7780076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_loc(".debug_loc");
779e4dee269SGeorge Rimar       static ConstString g_sect_name_dwarf_debug_loclists(".debug_loclists");
7800076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_macinfo(".debug_macinfo");
781a041d848SPavel Labath       static ConstString g_sect_name_dwarf_debug_names(".debug_names");
7820076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_pubnames(".debug_pubnames");
7830076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_pubtypes(".debug_pubtypes");
7840076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_ranges(".debug_ranges");
7850076e715SGreg Clayton       static ConstString g_sect_name_dwarf_debug_str(".debug_str");
7862550ca1eSGreg Clayton       static ConstString g_sect_name_dwarf_debug_types(".debug_types");
7870076e715SGreg Clayton       static ConstString g_sect_name_eh_frame(".eh_frame");
78865d4d5c3SRyan Brown       static ConstString g_sect_name_go_symtab(".gosymtab");
78928469ca3SGreg Clayton       SectionType section_type = eSectionTypeOther;
790237ad974SCharles Davis       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_CNT_CODE &&
791b9c1b51eSKate Stone           ((const_sect_name == g_code_sect_name) ||
792b9c1b51eSKate Stone            (const_sect_name == g_CODE_sect_name))) {
79328469ca3SGreg Clayton         section_type = eSectionTypeCode;
794b9c1b51eSKate Stone       } else if (m_sect_headers[idx].flags &
795b9c1b51eSKate Stone                      llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA &&
796b9c1b51eSKate Stone                  ((const_sect_name == g_data_sect_name) ||
797b9c1b51eSKate Stone                   (const_sect_name == g_DATA_sect_name))) {
7989cad24a7SZachary Turner         if (m_sect_headers[idx].size == 0 && m_sect_headers[idx].offset == 0)
7999cad24a7SZachary Turner           section_type = eSectionTypeZeroFill;
8009cad24a7SZachary Turner         else
80128469ca3SGreg Clayton           section_type = eSectionTypeData;
802b9c1b51eSKate Stone       } else if (m_sect_headers[idx].flags &
803b9c1b51eSKate Stone                      llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA &&
804b9c1b51eSKate Stone                  ((const_sect_name == g_bss_sect_name) ||
805b9c1b51eSKate Stone                   (const_sect_name == g_BSS_sect_name))) {
80628469ca3SGreg Clayton         if (m_sect_headers[idx].size == 0)
80728469ca3SGreg Clayton           section_type = eSectionTypeZeroFill;
80828469ca3SGreg Clayton         else
80928469ca3SGreg Clayton           section_type = eSectionTypeData;
810b9c1b51eSKate Stone       } else if (const_sect_name == g_debug_sect_name) {
81128469ca3SGreg Clayton         section_type = eSectionTypeDebug;
812b9c1b51eSKate Stone       } else if (const_sect_name == g_stabstr_sect_name) {
81328469ca3SGreg Clayton         section_type = eSectionTypeDataCString;
814b9c1b51eSKate Stone       } else if (const_sect_name == g_reloc_sect_name) {
81528469ca3SGreg Clayton         section_type = eSectionTypeOther;
816b9c1b51eSKate Stone       } else if (const_sect_name == g_sect_name_dwarf_debug_abbrev)
817b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugAbbrev;
818b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_dwarf_debug_aranges)
819b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugAranges;
820b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_dwarf_debug_frame)
821b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugFrame;
822b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_dwarf_debug_info)
823b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugInfo;
824b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_dwarf_debug_line)
825b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugLine;
826b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_dwarf_debug_loc)
827b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugLoc;
828e4dee269SGeorge Rimar       else if (const_sect_name == g_sect_name_dwarf_debug_loclists)
829e4dee269SGeorge Rimar         section_type = eSectionTypeDWARFDebugLocLists;
830b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_dwarf_debug_macinfo)
831b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugMacInfo;
832a041d848SPavel Labath       else if (const_sect_name == g_sect_name_dwarf_debug_names)
833a041d848SPavel Labath         section_type = eSectionTypeDWARFDebugNames;
834b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_dwarf_debug_pubnames)
835b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugPubNames;
836b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_dwarf_debug_pubtypes)
837b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugPubTypes;
838b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_dwarf_debug_ranges)
839b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugRanges;
840b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_dwarf_debug_str)
841b9c1b51eSKate Stone         section_type = eSectionTypeDWARFDebugStr;
8422550ca1eSGreg Clayton       else if (const_sect_name == g_sect_name_dwarf_debug_types)
8432550ca1eSGreg Clayton         section_type = eSectionTypeDWARFDebugTypes;
844b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_eh_frame)
845b9c1b51eSKate Stone         section_type = eSectionTypeEHFrame;
846b9c1b51eSKate Stone       else if (const_sect_name == g_sect_name_go_symtab)
847b9c1b51eSKate Stone         section_type = eSectionTypeGoSymtab;
848b9c1b51eSKate Stone       else if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_CNT_CODE) {
84928469ca3SGreg Clayton         section_type = eSectionTypeCode;
850b9c1b51eSKate Stone       } else if (m_sect_headers[idx].flags &
851b9c1b51eSKate Stone                  llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA) {
85228469ca3SGreg Clayton         section_type = eSectionTypeData;
853b9c1b51eSKate Stone       } else if (m_sect_headers[idx].flags &
854b9c1b51eSKate Stone                  llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) {
85528469ca3SGreg Clayton         if (m_sect_headers[idx].size == 0)
85628469ca3SGreg Clayton           section_type = eSectionTypeZeroFill;
85728469ca3SGreg Clayton         else
85828469ca3SGreg Clayton           section_type = eSectionTypeData;
85928469ca3SGreg Clayton       }
860f754f88fSGreg Clayton 
861b9c1b51eSKate Stone       SectionSP section_sp(new Section(
8627db8b5c4SPavel Labath           image_sp,        // Parent section
863b9c1b51eSKate Stone           module_sp,       // Module to which this section belongs
864a7499c98SMichael Sartain           this,            // Object file to which this section belongs
8657db8b5c4SPavel Labath           idx + 1,         // Section ID is the 1 based section index.
866f754f88fSGreg Clayton           const_sect_name, // Name of this section
8677db8b5c4SPavel Labath           section_type,
868b9c1b51eSKate Stone           m_sect_headers[idx].vmaddr, // File VM address == addresses as
869b9c1b51eSKate Stone                                       // they are found in the object file
870f754f88fSGreg Clayton           m_sect_headers[idx].vmsize, // VM size in bytes of this section
871b9c1b51eSKate Stone           m_sect_headers[idx]
872b9c1b51eSKate Stone               .offset, // Offset to the data for this section in the file
873b9c1b51eSKate Stone           m_sect_headers[idx]
874b9c1b51eSKate Stone               .size, // Size in bytes of this section as found in the file
87548672afbSGreg Clayton           m_coff_header_opt.sect_alignment, // Section alignment
876f754f88fSGreg Clayton           m_sect_headers[idx].flags));      // Flags for this section
877f754f88fSGreg Clayton 
8787db8b5c4SPavel Labath       image_sp->GetChildren().AddSection(std::move(section_sp));
879f754f88fSGreg Clayton     }
880f754f88fSGreg Clayton   }
881a1743499SGreg Clayton }
882f754f88fSGreg Clayton 
883b8d03935SAaron Smith UUID ObjectFilePECOFF::GetUUID() {
884b8d03935SAaron Smith   if (m_uuid.IsValid())
885b8d03935SAaron Smith     return m_uuid;
886b8d03935SAaron Smith 
887b8d03935SAaron Smith   if (!CreateBinary())
888b8d03935SAaron Smith     return UUID();
889b8d03935SAaron Smith 
890b8d03935SAaron Smith   auto COFFObj =
891b8d03935SAaron Smith     llvm::cast<llvm::object::COFFObjectFile>(m_owningbin->getBinary());
892b8d03935SAaron Smith 
893b8d03935SAaron Smith   m_uuid = GetCoffUUID(COFFObj);
894b8d03935SAaron Smith   return m_uuid;
895b8d03935SAaron Smith }
896f754f88fSGreg Clayton 
897037ed1beSAaron Smith uint32_t ObjectFilePECOFF::ParseDependentModules() {
898037ed1beSAaron Smith   ModuleSP module_sp(GetModule());
899037ed1beSAaron Smith   if (!module_sp)
900f754f88fSGreg Clayton     return 0;
901037ed1beSAaron Smith 
902037ed1beSAaron Smith   std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
903037ed1beSAaron Smith   if (m_deps_filespec)
904037ed1beSAaron Smith     return m_deps_filespec->GetSize();
905037ed1beSAaron Smith 
906037ed1beSAaron Smith   // Cache coff binary if it is not done yet.
907037ed1beSAaron Smith   if (!CreateBinary())
908037ed1beSAaron Smith     return 0;
909037ed1beSAaron Smith 
910037ed1beSAaron Smith   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
91163e5fb76SJonas Devlieghere   LLDB_LOGF(log,
91263e5fb76SJonas Devlieghere             "%p ObjectFilePECOFF::ParseDependentModules() module = %p "
913037ed1beSAaron Smith             "(%s), binary = %p (Bin = %p)",
914037ed1beSAaron Smith             static_cast<void *>(this), static_cast<void *>(module_sp.get()),
915037ed1beSAaron Smith             module_sp->GetSpecificationDescription().c_str(),
916037ed1beSAaron Smith             static_cast<void *>(m_owningbin.getPointer()),
917b8d03935SAaron Smith             static_cast<void *>(m_owningbin->getBinary()));
918037ed1beSAaron Smith 
919037ed1beSAaron Smith   auto COFFObj =
920037ed1beSAaron Smith       llvm::dyn_cast<llvm::object::COFFObjectFile>(m_owningbin->getBinary());
921037ed1beSAaron Smith   if (!COFFObj)
922037ed1beSAaron Smith     return 0;
923037ed1beSAaron Smith 
924037ed1beSAaron Smith   m_deps_filespec = FileSpecList();
925037ed1beSAaron Smith 
926037ed1beSAaron Smith   for (const auto &entry : COFFObj->import_directories()) {
927037ed1beSAaron Smith     llvm::StringRef dll_name;
928037ed1beSAaron Smith     auto ec = entry.getName(dll_name);
929037ed1beSAaron Smith     // Report a bogus entry.
930037ed1beSAaron Smith     if (ec != std::error_code()) {
93163e5fb76SJonas Devlieghere       LLDB_LOGF(log,
93263e5fb76SJonas Devlieghere                 "ObjectFilePECOFF::ParseDependentModules() - failed to get "
933037ed1beSAaron Smith                 "import directory entry name: %s",
934037ed1beSAaron Smith                 ec.message().c_str());
935037ed1beSAaron Smith       continue;
936037ed1beSAaron Smith     }
937037ed1beSAaron Smith 
938037ed1beSAaron Smith     // At this moment we only have the base name of the DLL. The full path can
939037ed1beSAaron Smith     // only be seen after the dynamic loading.  Our best guess is Try to get it
940037ed1beSAaron Smith     // with the help of the object file's directory.
941b3f44ad9SStella Stamenova     llvm::SmallString<128> dll_fullpath;
942037ed1beSAaron Smith     FileSpec dll_specs(dll_name);
943037ed1beSAaron Smith     dll_specs.GetDirectory().SetString(m_file.GetDirectory().GetCString());
944037ed1beSAaron Smith 
945037ed1beSAaron Smith     if (!llvm::sys::fs::real_path(dll_specs.GetPath(), dll_fullpath))
946f893d5bfSJonas Devlieghere       m_deps_filespec->EmplaceBack(dll_fullpath);
947037ed1beSAaron Smith     else {
948037ed1beSAaron Smith       // Known DLLs or DLL not found in the object file directory.
949f893d5bfSJonas Devlieghere       m_deps_filespec->EmplaceBack(dll_name);
950037ed1beSAaron Smith     }
951037ed1beSAaron Smith   }
952037ed1beSAaron Smith   return m_deps_filespec->GetSize();
953037ed1beSAaron Smith }
954037ed1beSAaron Smith 
955037ed1beSAaron Smith uint32_t ObjectFilePECOFF::GetDependentModules(FileSpecList &files) {
956037ed1beSAaron Smith   auto num_modules = ParseDependentModules();
957037ed1beSAaron Smith   auto original_size = files.GetSize();
958037ed1beSAaron Smith 
959037ed1beSAaron Smith   for (unsigned i = 0; i < num_modules; ++i)
960037ed1beSAaron Smith     files.AppendIfUnique(m_deps_filespec->GetFileSpecAtIndex(i));
961037ed1beSAaron Smith 
962037ed1beSAaron Smith   return files.GetSize() - original_size;
963f754f88fSGreg Clayton }
964f754f88fSGreg Clayton 
965b9c1b51eSKate Stone lldb_private::Address ObjectFilePECOFF::GetEntryPointAddress() {
9668e38c666SStephane Sezer   if (m_entry_point_address.IsValid())
9678e38c666SStephane Sezer     return m_entry_point_address;
9688e38c666SStephane Sezer 
9698e38c666SStephane Sezer   if (!ParseHeader() || !IsExecutable())
9708e38c666SStephane Sezer     return m_entry_point_address;
9718e38c666SStephane Sezer 
9728e38c666SStephane Sezer   SectionList *section_list = GetSectionList();
973a5235af9SAleksandr Urakov   addr_t file_addr = m_coff_header_opt.entry + m_coff_header_opt.image_base;
9748e38c666SStephane Sezer 
9758e38c666SStephane Sezer   if (!section_list)
976a5235af9SAleksandr Urakov     m_entry_point_address.SetOffset(file_addr);
9778e38c666SStephane Sezer   else
978b8d03935SAaron Smith     m_entry_point_address.ResolveAddressUsingFileSections(file_addr,
979b8d03935SAaron Smith                                                           section_list);
9808e38c666SStephane Sezer   return m_entry_point_address;
9818e38c666SStephane Sezer }
9828e38c666SStephane Sezer 
983d1304bbaSPavel Labath Address ObjectFilePECOFF::GetBaseAddress() {
984d1304bbaSPavel Labath   return Address(GetSectionList()->GetSectionAtIndex(0), 0);
985d1304bbaSPavel Labath }
986d1304bbaSPavel Labath 
987f754f88fSGreg Clayton // Dump
988f754f88fSGreg Clayton //
989f754f88fSGreg Clayton // Dump the specifics of the runtime file container (such as any headers
990f754f88fSGreg Clayton // segments, sections, etc).
991b9c1b51eSKate Stone void ObjectFilePECOFF::Dump(Stream *s) {
992a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
993b9c1b51eSKate Stone   if (module_sp) {
99416ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
995324a1036SSaleem Abdulrasool     s->Printf("%p: ", static_cast<void *>(this));
996f754f88fSGreg Clayton     s->Indent();
997f754f88fSGreg Clayton     s->PutCString("ObjectFilePECOFF");
998f754f88fSGreg Clayton 
999f760f5aeSPavel Labath     ArchSpec header_arch = GetArchitecture();
1000f754f88fSGreg Clayton 
1001b9c1b51eSKate Stone     *s << ", file = '" << m_file
1002b9c1b51eSKate Stone        << "', arch = " << header_arch.GetArchitectureName() << "\n";
1003f754f88fSGreg Clayton 
10043046e668SGreg Clayton     SectionList *sections = GetSectionList();
10053046e668SGreg Clayton     if (sections)
1006248a1305SKonrad Kleine       sections->Dump(s, nullptr, true, UINT32_MAX);
1007f754f88fSGreg Clayton 
1008d5b44036SJonas Devlieghere     if (m_symtab_up)
1009248a1305SKonrad Kleine       m_symtab_up->Dump(s, nullptr, eSortOrderNone);
1010f754f88fSGreg Clayton 
1011f754f88fSGreg Clayton     if (m_dos_header.e_magic)
1012f754f88fSGreg Clayton       DumpDOSHeader(s, m_dos_header);
1013b9c1b51eSKate Stone     if (m_coff_header.machine) {
1014f754f88fSGreg Clayton       DumpCOFFHeader(s, m_coff_header);
1015f754f88fSGreg Clayton       if (m_coff_header.hdrsize)
1016f754f88fSGreg Clayton         DumpOptCOFFHeader(s, m_coff_header_opt);
1017f754f88fSGreg Clayton     }
1018f754f88fSGreg Clayton     s->EOL();
1019f754f88fSGreg Clayton     DumpSectionHeaders(s);
1020f754f88fSGreg Clayton     s->EOL();
1021037ed1beSAaron Smith 
1022037ed1beSAaron Smith     DumpDependentModules(s);
1023037ed1beSAaron Smith     s->EOL();
1024f754f88fSGreg Clayton   }
1025a1743499SGreg Clayton }
1026f754f88fSGreg Clayton 
1027f754f88fSGreg Clayton // DumpDOSHeader
1028f754f88fSGreg Clayton //
1029f754f88fSGreg Clayton // Dump the MS-DOS header to the specified output stream
1030b9c1b51eSKate Stone void ObjectFilePECOFF::DumpDOSHeader(Stream *s, const dos_header_t &header) {
1031f754f88fSGreg Clayton   s->PutCString("MSDOS Header\n");
1032f754f88fSGreg Clayton   s->Printf("  e_magic    = 0x%4.4x\n", header.e_magic);
1033f754f88fSGreg Clayton   s->Printf("  e_cblp     = 0x%4.4x\n", header.e_cblp);
1034f754f88fSGreg Clayton   s->Printf("  e_cp       = 0x%4.4x\n", header.e_cp);
1035f754f88fSGreg Clayton   s->Printf("  e_crlc     = 0x%4.4x\n", header.e_crlc);
1036f754f88fSGreg Clayton   s->Printf("  e_cparhdr  = 0x%4.4x\n", header.e_cparhdr);
1037f754f88fSGreg Clayton   s->Printf("  e_minalloc = 0x%4.4x\n", header.e_minalloc);
1038f754f88fSGreg Clayton   s->Printf("  e_maxalloc = 0x%4.4x\n", header.e_maxalloc);
1039f754f88fSGreg Clayton   s->Printf("  e_ss       = 0x%4.4x\n", header.e_ss);
1040f754f88fSGreg Clayton   s->Printf("  e_sp       = 0x%4.4x\n", header.e_sp);
1041f754f88fSGreg Clayton   s->Printf("  e_csum     = 0x%4.4x\n", header.e_csum);
1042f754f88fSGreg Clayton   s->Printf("  e_ip       = 0x%4.4x\n", header.e_ip);
1043f754f88fSGreg Clayton   s->Printf("  e_cs       = 0x%4.4x\n", header.e_cs);
1044f754f88fSGreg Clayton   s->Printf("  e_lfarlc   = 0x%4.4x\n", header.e_lfarlc);
1045f754f88fSGreg Clayton   s->Printf("  e_ovno     = 0x%4.4x\n", header.e_ovno);
1046f754f88fSGreg Clayton   s->Printf("  e_res[4]   = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n",
1047b9c1b51eSKate Stone             header.e_res[0], header.e_res[1], header.e_res[2], header.e_res[3]);
1048f754f88fSGreg Clayton   s->Printf("  e_oemid    = 0x%4.4x\n", header.e_oemid);
1049f754f88fSGreg Clayton   s->Printf("  e_oeminfo  = 0x%4.4x\n", header.e_oeminfo);
1050b9c1b51eSKate Stone   s->Printf("  e_res2[10] = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, "
1051b9c1b51eSKate Stone             "0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n",
1052b9c1b51eSKate Stone             header.e_res2[0], header.e_res2[1], header.e_res2[2],
1053b9c1b51eSKate Stone             header.e_res2[3], header.e_res2[4], header.e_res2[5],
1054b9c1b51eSKate Stone             header.e_res2[6], header.e_res2[7], header.e_res2[8],
1055f754f88fSGreg Clayton             header.e_res2[9]);
1056f754f88fSGreg Clayton   s->Printf("  e_lfanew   = 0x%8.8x\n", header.e_lfanew);
1057f754f88fSGreg Clayton }
1058f754f88fSGreg Clayton 
1059f754f88fSGreg Clayton // DumpCOFFHeader
1060f754f88fSGreg Clayton //
1061f754f88fSGreg Clayton // Dump the COFF header to the specified output stream
1062b9c1b51eSKate Stone void ObjectFilePECOFF::DumpCOFFHeader(Stream *s, const coff_header_t &header) {
1063f754f88fSGreg Clayton   s->PutCString("COFF Header\n");
1064f754f88fSGreg Clayton   s->Printf("  machine = 0x%4.4x\n", header.machine);
1065f754f88fSGreg Clayton   s->Printf("  nsects  = 0x%4.4x\n", header.nsects);
1066f754f88fSGreg Clayton   s->Printf("  modtime = 0x%8.8x\n", header.modtime);
1067f754f88fSGreg Clayton   s->Printf("  symoff  = 0x%8.8x\n", header.symoff);
1068f754f88fSGreg Clayton   s->Printf("  nsyms   = 0x%8.8x\n", header.nsyms);
1069f754f88fSGreg Clayton   s->Printf("  hdrsize = 0x%4.4x\n", header.hdrsize);
1070f754f88fSGreg Clayton }
1071f754f88fSGreg Clayton 
1072f754f88fSGreg Clayton // DumpOptCOFFHeader
1073f754f88fSGreg Clayton //
1074f754f88fSGreg Clayton // Dump the optional COFF header to the specified output stream
1075b9c1b51eSKate Stone void ObjectFilePECOFF::DumpOptCOFFHeader(Stream *s,
1076b9c1b51eSKate Stone                                          const coff_opt_header_t &header) {
1077f754f88fSGreg Clayton   s->PutCString("Optional COFF Header\n");
1078f754f88fSGreg Clayton   s->Printf("  magic                   = 0x%4.4x\n", header.magic);
1079b9c1b51eSKate Stone   s->Printf("  major_linker_version    = 0x%2.2x\n",
1080b9c1b51eSKate Stone             header.major_linker_version);
1081b9c1b51eSKate Stone   s->Printf("  minor_linker_version    = 0x%2.2x\n",
1082b9c1b51eSKate Stone             header.minor_linker_version);
1083f754f88fSGreg Clayton   s->Printf("  code_size               = 0x%8.8x\n", header.code_size);
1084f754f88fSGreg Clayton   s->Printf("  data_size               = 0x%8.8x\n", header.data_size);
1085f754f88fSGreg Clayton   s->Printf("  bss_size                = 0x%8.8x\n", header.bss_size);
1086f754f88fSGreg Clayton   s->Printf("  entry                   = 0x%8.8x\n", header.entry);
1087f754f88fSGreg Clayton   s->Printf("  code_offset             = 0x%8.8x\n", header.code_offset);
1088f754f88fSGreg Clayton   s->Printf("  data_offset             = 0x%8.8x\n", header.data_offset);
1089b9c1b51eSKate Stone   s->Printf("  image_base              = 0x%16.16" PRIx64 "\n",
1090b9c1b51eSKate Stone             header.image_base);
1091f754f88fSGreg Clayton   s->Printf("  sect_alignment          = 0x%8.8x\n", header.sect_alignment);
1092f754f88fSGreg Clayton   s->Printf("  file_alignment          = 0x%8.8x\n", header.file_alignment);
1093b9c1b51eSKate Stone   s->Printf("  major_os_system_version = 0x%4.4x\n",
1094b9c1b51eSKate Stone             header.major_os_system_version);
1095b9c1b51eSKate Stone   s->Printf("  minor_os_system_version = 0x%4.4x\n",
1096b9c1b51eSKate Stone             header.minor_os_system_version);
1097b9c1b51eSKate Stone   s->Printf("  major_image_version     = 0x%4.4x\n",
1098b9c1b51eSKate Stone             header.major_image_version);
1099b9c1b51eSKate Stone   s->Printf("  minor_image_version     = 0x%4.4x\n",
1100b9c1b51eSKate Stone             header.minor_image_version);
1101b9c1b51eSKate Stone   s->Printf("  major_subsystem_version = 0x%4.4x\n",
1102b9c1b51eSKate Stone             header.major_subsystem_version);
1103b9c1b51eSKate Stone   s->Printf("  minor_subsystem_version = 0x%4.4x\n",
1104b9c1b51eSKate Stone             header.minor_subsystem_version);
1105f754f88fSGreg Clayton   s->Printf("  reserved1               = 0x%8.8x\n", header.reserved1);
1106f754f88fSGreg Clayton   s->Printf("  image_size              = 0x%8.8x\n", header.image_size);
1107f754f88fSGreg Clayton   s->Printf("  header_size             = 0x%8.8x\n", header.header_size);
110828469ca3SGreg Clayton   s->Printf("  checksum                = 0x%8.8x\n", header.checksum);
1109f754f88fSGreg Clayton   s->Printf("  subsystem               = 0x%4.4x\n", header.subsystem);
1110f754f88fSGreg Clayton   s->Printf("  dll_flags               = 0x%4.4x\n", header.dll_flags);
1111b9c1b51eSKate Stone   s->Printf("  stack_reserve_size      = 0x%16.16" PRIx64 "\n",
1112b9c1b51eSKate Stone             header.stack_reserve_size);
1113b9c1b51eSKate Stone   s->Printf("  stack_commit_size       = 0x%16.16" PRIx64 "\n",
1114b9c1b51eSKate Stone             header.stack_commit_size);
1115b9c1b51eSKate Stone   s->Printf("  heap_reserve_size       = 0x%16.16" PRIx64 "\n",
1116b9c1b51eSKate Stone             header.heap_reserve_size);
1117b9c1b51eSKate Stone   s->Printf("  heap_commit_size        = 0x%16.16" PRIx64 "\n",
1118b9c1b51eSKate Stone             header.heap_commit_size);
1119f754f88fSGreg Clayton   s->Printf("  loader_flags            = 0x%8.8x\n", header.loader_flags);
1120b9c1b51eSKate Stone   s->Printf("  num_data_dir_entries    = 0x%8.8x\n",
1121b9c1b51eSKate Stone             (uint32_t)header.data_dirs.size());
1122f754f88fSGreg Clayton   uint32_t i;
1123b9c1b51eSKate Stone   for (i = 0; i < header.data_dirs.size(); i++) {
1124b9c1b51eSKate Stone     s->Printf("  data_dirs[%2u] vmaddr = 0x%8.8x, vmsize = 0x%8.8x\n", i,
1125b9c1b51eSKate Stone               header.data_dirs[i].vmaddr, header.data_dirs[i].vmsize);
1126f754f88fSGreg Clayton   }
1127f754f88fSGreg Clayton }
1128f754f88fSGreg Clayton // DumpSectionHeader
1129f754f88fSGreg Clayton //
1130f754f88fSGreg Clayton // Dump a single ELF section header to the specified output stream
1131b9c1b51eSKate Stone void ObjectFilePECOFF::DumpSectionHeader(Stream *s,
1132b9c1b51eSKate Stone                                          const section_header_t &sh) {
11332886e4a0SPavel Labath   std::string name = GetSectionName(sh);
1134b9c1b51eSKate 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 "
1135b9c1b51eSKate Stone             "0x%4.4x 0x%8.8x\n",
1136b9c1b51eSKate Stone             name.c_str(), sh.vmaddr, sh.vmsize, sh.offset, sh.size, sh.reloff,
1137b9c1b51eSKate Stone             sh.lineoff, sh.nreloc, sh.nline, sh.flags);
1138f754f88fSGreg Clayton }
1139f754f88fSGreg Clayton 
1140f754f88fSGreg Clayton // DumpSectionHeaders
1141f754f88fSGreg Clayton //
1142f754f88fSGreg Clayton // Dump all of the ELF section header to the specified output stream
1143b9c1b51eSKate Stone void ObjectFilePECOFF::DumpSectionHeaders(Stream *s) {
1144f754f88fSGreg Clayton 
1145f754f88fSGreg Clayton   s->PutCString("Section Headers\n");
1146b9c1b51eSKate Stone   s->PutCString("IDX  name             vm addr    vm size    file off   file "
1147b9c1b51eSKate Stone                 "size  reloc off  line off   nreloc nline  flags\n");
1148b9c1b51eSKate Stone   s->PutCString("==== ---------------- ---------- ---------- ---------- "
1149b9c1b51eSKate Stone                 "---------- ---------- ---------- ------ ------ ----------\n");
1150f754f88fSGreg Clayton 
1151f754f88fSGreg Clayton   uint32_t idx = 0;
1152f754f88fSGreg Clayton   SectionHeaderCollIter pos, end = m_sect_headers.end();
1153f754f88fSGreg Clayton 
1154b9c1b51eSKate Stone   for (pos = m_sect_headers.begin(); pos != end; ++pos, ++idx) {
1155f754f88fSGreg Clayton     s->Printf("[%2u] ", idx);
1156f754f88fSGreg Clayton     ObjectFilePECOFF::DumpSectionHeader(s, *pos);
1157f754f88fSGreg Clayton   }
1158f754f88fSGreg Clayton }
1159f754f88fSGreg Clayton 
1160037ed1beSAaron Smith // DumpDependentModules
1161037ed1beSAaron Smith //
1162037ed1beSAaron Smith // Dump all of the dependent modules to the specified output stream
1163037ed1beSAaron Smith void ObjectFilePECOFF::DumpDependentModules(lldb_private::Stream *s) {
1164037ed1beSAaron Smith   auto num_modules = ParseDependentModules();
1165037ed1beSAaron Smith   if (num_modules > 0) {
1166037ed1beSAaron Smith     s->PutCString("Dependent Modules\n");
1167037ed1beSAaron Smith     for (unsigned i = 0; i < num_modules; ++i) {
1168037ed1beSAaron Smith       auto spec = m_deps_filespec->GetFileSpecAtIndex(i);
1169037ed1beSAaron Smith       s->Printf("  %s\n", spec.GetFilename().GetCString());
1170037ed1beSAaron Smith     }
1171037ed1beSAaron Smith   }
1172037ed1beSAaron Smith }
1173037ed1beSAaron Smith 
1174fb3b3bd1SZachary Turner bool ObjectFilePECOFF::IsWindowsSubsystem() {
1175fb3b3bd1SZachary Turner   switch (m_coff_header_opt.subsystem) {
1176fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE:
1177fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_GUI:
1178fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CUI:
1179fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE_WINDOWS:
1180fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CE_GUI:
1181fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_XBOX:
1182fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION:
1183fb3b3bd1SZachary Turner     return true;
1184fb3b3bd1SZachary Turner   default:
1185fb3b3bd1SZachary Turner     return false;
1186fb3b3bd1SZachary Turner   }
1187fb3b3bd1SZachary Turner }
1188fb3b3bd1SZachary Turner 
1189f760f5aeSPavel Labath ArchSpec ObjectFilePECOFF::GetArchitecture() {
1190237ad974SCharles Davis   uint16_t machine = m_coff_header.machine;
1191b9c1b51eSKate Stone   switch (machine) {
1192f760f5aeSPavel Labath   default:
1193f760f5aeSPavel Labath     break;
1194237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_AMD64:
1195237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_I386:
1196237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_POWERPC:
1197237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_POWERPCFP:
1198237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_ARM:
11991108cb36SSaleem Abdulrasool   case llvm::COFF::IMAGE_FILE_MACHINE_ARMNT:
1200237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_THUMB:
1201f760f5aeSPavel Labath     ArchSpec arch;
1202fb3b3bd1SZachary Turner     arch.SetArchitecture(eArchTypeCOFF, machine, LLDB_INVALID_CPUTYPE,
1203fb3b3bd1SZachary Turner                          IsWindowsSubsystem() ? llvm::Triple::Win32
1204fb3b3bd1SZachary Turner                                               : llvm::Triple::UnknownOS);
1205f760f5aeSPavel Labath     return arch;
1206237ad974SCharles Davis   }
1207f760f5aeSPavel Labath   return ArchSpec();
1208f754f88fSGreg Clayton }
1209f754f88fSGreg Clayton 
1210b9c1b51eSKate Stone ObjectFile::Type ObjectFilePECOFF::CalculateType() {
1211b9c1b51eSKate Stone   if (m_coff_header.machine != 0) {
1212237ad974SCharles Davis     if ((m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0)
1213f754f88fSGreg Clayton       return eTypeExecutable;
1214f754f88fSGreg Clayton     else
1215f754f88fSGreg Clayton       return eTypeSharedLibrary;
1216f754f88fSGreg Clayton   }
1217f754f88fSGreg Clayton   return eTypeExecutable;
1218f754f88fSGreg Clayton }
1219f754f88fSGreg Clayton 
1220b9c1b51eSKate Stone ObjectFile::Strata ObjectFilePECOFF::CalculateStrata() { return eStrataUser; }
12219cad24a7SZachary Turner 
1222f754f88fSGreg Clayton // PluginInterface protocol
1223b9c1b51eSKate Stone ConstString ObjectFilePECOFF::GetPluginName() { return GetPluginNameStatic(); }
1224f754f88fSGreg Clayton 
1225b9c1b51eSKate Stone uint32_t ObjectFilePECOFF::GetPluginVersion() { return 1; }
1226