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"
26*c34698a8SPavel Labath #include "lldb/Utility/LLDBLog.h"
27037ed1beSAaron Smith #include "lldb/Utility/Log.h"
28bf9a7730SZachary Turner #include "lldb/Utility/StreamString.h"
2938d0632eSPavel Labath #include "lldb/Utility/Timer.h"
30666cc0b2SZachary Turner #include "lldb/Utility/UUID.h"
315f19b907SPavel Labath #include "llvm/BinaryFormat/COFF.h"
32f754f88fSGreg Clayton 
33037ed1beSAaron Smith #include "llvm/Object/COFFImportFile.h"
34037ed1beSAaron Smith #include "llvm/Support/Error.h"
353f4a4b36SZachary Turner #include "llvm/Support/MemoryBuffer.h"
363f4a4b36SZachary Turner 
37f754f88fSGreg Clayton #define IMAGE_DOS_SIGNATURE 0x5A4D    // MZ
38f754f88fSGreg Clayton #define IMAGE_NT_SIGNATURE 0x00004550 // PE00
39f754f88fSGreg Clayton #define OPT_HEADER_MAGIC_PE32 0x010b
40f754f88fSGreg Clayton #define OPT_HEADER_MAGIC_PE32_PLUS 0x020b
41f754f88fSGreg Clayton 
42f754f88fSGreg Clayton using namespace lldb;
43f754f88fSGreg Clayton using namespace lldb_private;
44f754f88fSGreg Clayton 
45bba9ba8dSJonas Devlieghere LLDB_PLUGIN_DEFINE(ObjectFilePECOFF)
46fbb4d1e4SJonas Devlieghere 
47d372a8e8SPavel Labath static UUID GetCoffUUID(llvm::object::COFFObjectFile &coff_obj) {
48b8d03935SAaron Smith   const llvm::codeview::DebugInfo *pdb_info = nullptr;
49b8d03935SAaron Smith   llvm::StringRef pdb_file;
50b8d03935SAaron Smith 
51d372a8e8SPavel Labath   if (!coff_obj.getDebugPDBInfo(pdb_info, pdb_file) && pdb_info) {
52b8d03935SAaron Smith     if (pdb_info->PDB70.CVSignature == llvm::OMF::Signature::PDB70) {
534348e0eeSZequan Wu       UUID::CvRecordPdb70 info;
544348e0eeSZequan Wu       memcpy(&info.Uuid, pdb_info->PDB70.Signature, sizeof(info.Uuid));
554348e0eeSZequan Wu       info.Age = pdb_info->PDB70.Age;
564348e0eeSZequan Wu       return UUID::fromCvRecord(info);
57b8d03935SAaron Smith     }
58b8d03935SAaron Smith   }
59b8d03935SAaron Smith 
60b8d03935SAaron Smith   return UUID();
61b8d03935SAaron Smith }
62b8d03935SAaron Smith 
63e84f7841SPavel Labath char ObjectFilePECOFF::ID;
64e84f7841SPavel Labath 
65b9c1b51eSKate Stone void ObjectFilePECOFF::Initialize() {
66b9c1b51eSKate Stone   PluginManager::RegisterPlugin(
67b9c1b51eSKate Stone       GetPluginNameStatic(), GetPluginDescriptionStatic(), CreateInstance,
68b9c1b51eSKate Stone       CreateMemoryInstance, GetModuleSpecifications, SaveCore);
69f754f88fSGreg Clayton }
70f754f88fSGreg Clayton 
71b9c1b51eSKate Stone void ObjectFilePECOFF::Terminate() {
72f754f88fSGreg Clayton   PluginManager::UnregisterPlugin(CreateInstance);
73f754f88fSGreg Clayton }
74f754f88fSGreg Clayton 
752ace1e57SPavel Labath llvm::StringRef ObjectFilePECOFF::GetPluginDescriptionStatic() {
76b9c1b51eSKate Stone   return "Portable Executable and Common Object File Format object file reader "
77b9c1b51eSKate Stone          "(32 and 64 bit)";
78f754f88fSGreg Clayton }
79f754f88fSGreg Clayton 
80b9c1b51eSKate Stone ObjectFile *ObjectFilePECOFF::CreateInstance(const lldb::ModuleSP &module_sp,
815ce9c565SGreg Clayton                                              DataBufferSP &data_sp,
825ce9c565SGreg Clayton                                              lldb::offset_t data_offset,
8328e4942bSPavel Labath                                              const lldb_private::FileSpec *file_p,
845ce9c565SGreg Clayton                                              lldb::offset_t file_offset,
85b9c1b51eSKate Stone                                              lldb::offset_t length) {
8628e4942bSPavel Labath   FileSpec file = file_p ? *file_p : FileSpec();
87b9c1b51eSKate Stone   if (!data_sp) {
8850251fc7SPavel Labath     data_sp = MapFileData(file, length, file_offset);
893f4a4b36SZachary Turner     if (!data_sp)
903f4a4b36SZachary Turner       return nullptr;
915ce9c565SGreg Clayton     data_offset = 0;
925ce9c565SGreg Clayton   }
935ce9c565SGreg Clayton 
943f4a4b36SZachary Turner   if (!ObjectFilePECOFF::MagicBytesMatch(data_sp))
953f4a4b36SZachary Turner     return nullptr;
963f4a4b36SZachary Turner 
975ce9c565SGreg Clayton   // Update the data to contain the entire file if it doesn't already
983f4a4b36SZachary Turner   if (data_sp->GetByteSize() < length) {
9950251fc7SPavel Labath     data_sp = MapFileData(file, length, file_offset);
1003f4a4b36SZachary Turner     if (!data_sp)
1013f4a4b36SZachary Turner       return nullptr;
102f754f88fSGreg Clayton   }
1033f4a4b36SZachary Turner 
104a8f3ae7cSJonas Devlieghere   auto objfile_up = std::make_unique<ObjectFilePECOFF>(
10528e4942bSPavel Labath       module_sp, data_sp, data_offset, file_p, file_offset, length);
106d5b44036SJonas Devlieghere   if (!objfile_up || !objfile_up->ParseHeader())
1073f4a4b36SZachary Turner     return nullptr;
1083f4a4b36SZachary Turner 
109037ed1beSAaron Smith   // Cache coff binary.
110d5b44036SJonas Devlieghere   if (!objfile_up->CreateBinary())
111037ed1beSAaron Smith     return nullptr;
112d5b44036SJonas Devlieghere   return objfile_up.release();
113f754f88fSGreg Clayton }
114f754f88fSGreg Clayton 
115b9c1b51eSKate Stone ObjectFile *ObjectFilePECOFF::CreateMemoryInstance(
116b9c1b51eSKate Stone     const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
117b9c1b51eSKate Stone     const lldb::ProcessSP &process_sp, lldb::addr_t header_addr) {
118344546bdSWalter Erquinigo   if (!data_sp || !ObjectFilePECOFF::MagicBytesMatch(data_sp))
119344546bdSWalter Erquinigo     return nullptr;
120a8f3ae7cSJonas Devlieghere   auto objfile_up = std::make_unique<ObjectFilePECOFF>(
121344546bdSWalter Erquinigo       module_sp, data_sp, process_sp, header_addr);
122d5b44036SJonas Devlieghere   if (objfile_up.get() && objfile_up->ParseHeader()) {
123d5b44036SJonas Devlieghere     return objfile_up.release();
124344546bdSWalter Erquinigo   }
125344546bdSWalter Erquinigo   return nullptr;
126c9660546SGreg Clayton }
127c9660546SGreg Clayton 
128b9c1b51eSKate Stone size_t ObjectFilePECOFF::GetModuleSpecifications(
129b9c1b51eSKate Stone     const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp,
130b9c1b51eSKate Stone     lldb::offset_t data_offset, lldb::offset_t file_offset,
131b9c1b51eSKate Stone     lldb::offset_t length, lldb_private::ModuleSpecList &specs) {
13289eb1baeSVirgile Bello   const size_t initial_count = specs.GetSize();
133b8d03935SAaron Smith   if (!data_sp || !ObjectFilePECOFF::MagicBytesMatch(data_sp))
134b8d03935SAaron Smith     return initial_count;
13589eb1baeSVirgile Bello 
136a007a6d8SPavel Labath   Log *log = GetLog(LLDBLog::Object);
1373db1d138SMartin Storsjö 
138a4a00cedSFred Riss   if (data_sp->GetByteSize() < length)
139d372a8e8SPavel Labath     if (DataBufferSP full_sp = MapFileData(file, -1, file_offset))
140d372a8e8SPavel Labath       data_sp = std::move(full_sp);
141d372a8e8SPavel Labath   auto binary = llvm::object::createBinary(llvm::MemoryBufferRef(
142d372a8e8SPavel Labath       toStringRef(data_sp->GetData()), file.GetFilename().GetStringRef()));
1433db1d138SMartin Storsjö 
1443db1d138SMartin Storsjö   if (!binary) {
1453db1d138SMartin Storsjö     LLDB_LOG_ERROR(log, binary.takeError(),
1463db1d138SMartin Storsjö                    "Failed to create binary for file ({1}): {0}", file);
147b8d03935SAaron Smith     return initial_count;
1483db1d138SMartin Storsjö   }
14989eb1baeSVirgile Bello 
150d372a8e8SPavel Labath   auto *COFFObj = llvm::dyn_cast<llvm::object::COFFObjectFile>(binary->get());
151d372a8e8SPavel Labath   if (!COFFObj)
152b8d03935SAaron Smith     return initial_count;
15389eb1baeSVirgile Bello 
154b8d03935SAaron Smith   ModuleSpec module_spec(file);
155b8d03935SAaron Smith   ArchSpec &spec = module_spec.GetArchitecture();
156b8d03935SAaron Smith   lldb_private::UUID &uuid = module_spec.GetUUID();
157b8d03935SAaron Smith   if (!uuid.IsValid())
158d372a8e8SPavel Labath     uuid = GetCoffUUID(*COFFObj);
159b8d03935SAaron Smith 
160b8d03935SAaron Smith   switch (COFFObj->getMachine()) {
161b8d03935SAaron Smith   case MachineAmd64:
162ad587ae4SZachary Turner     spec.SetTriple("x86_64-pc-windows");
163b8d03935SAaron Smith     specs.Append(module_spec);
164b8d03935SAaron Smith     break;
165b8d03935SAaron Smith   case MachineX86:
166ad587ae4SZachary Turner     spec.SetTriple("i386-pc-windows");
167b8d03935SAaron Smith     specs.Append(module_spec);
1685e6f4520SZachary Turner     spec.SetTriple("i686-pc-windows");
169b8d03935SAaron Smith     specs.Append(module_spec);
170b8d03935SAaron Smith     break;
171b8d03935SAaron Smith   case MachineArmNt:
172544c8f48SMartin Storsjo     spec.SetTriple("armv7-pc-windows");
173b8d03935SAaron Smith     specs.Append(module_spec);
174b8d03935SAaron Smith     break;
175638f072fSMartin Storsjo   case MachineArm64:
176674d5543SMartin Storsjo     spec.SetTriple("aarch64-pc-windows");
177638f072fSMartin Storsjo     specs.Append(module_spec);
178638f072fSMartin Storsjo     break;
179b8d03935SAaron Smith   default:
180b8d03935SAaron Smith     break;
18189eb1baeSVirgile Bello   }
18289eb1baeSVirgile Bello 
18389eb1baeSVirgile Bello   return specs.GetSize() - initial_count;
184f4d6de6aSGreg Clayton }
185f4d6de6aSGreg Clayton 
186b9c1b51eSKate Stone bool ObjectFilePECOFF::SaveCore(const lldb::ProcessSP &process_sp,
187f7d1893fSAdrian McCarthy                                 const lldb_private::FileSpec &outfile,
1889ea6dd5cSJason Molenda                                 lldb::SaveCoreStyle &core_style,
18997206d57SZachary Turner                                 lldb_private::Status &error) {
1909ea6dd5cSJason Molenda   core_style = eSaveCoreFull;
191f7d1893fSAdrian McCarthy   return SaveMiniDump(process_sp, outfile, error);
192f7d1893fSAdrian McCarthy }
193f7d1893fSAdrian McCarthy 
194b9c1b51eSKate Stone bool ObjectFilePECOFF::MagicBytesMatch(DataBufferSP &data_sp) {
1955ce9c565SGreg Clayton   DataExtractor data(data_sp, eByteOrderLittle, 4);
196c7bece56SGreg Clayton   lldb::offset_t offset = 0;
197f754f88fSGreg Clayton   uint16_t magic = data.GetU16(&offset);
198f754f88fSGreg Clayton   return magic == IMAGE_DOS_SIGNATURE;
199f754f88fSGreg Clayton }
200f754f88fSGreg Clayton 
201b9c1b51eSKate Stone lldb::SymbolType ObjectFilePECOFF::MapSymbolType(uint16_t coff_symbol_type) {
202c35b91ceSAdrian McCarthy   // TODO:  We need to complete this mapping of COFF symbol types to LLDB ones.
203c35b91ceSAdrian McCarthy   // For now, here's a hack to make sure our function have types.
204b9c1b51eSKate Stone   const auto complex_type =
205b9c1b51eSKate Stone       coff_symbol_type >> llvm::COFF::SCT_COMPLEX_TYPE_SHIFT;
206b9c1b51eSKate Stone   if (complex_type == llvm::COFF::IMAGE_SYM_DTYPE_FUNCTION) {
207c35b91ceSAdrian McCarthy     return lldb::eSymbolTypeCode;
208c35b91ceSAdrian McCarthy   }
209c35b91ceSAdrian McCarthy   return lldb::eSymbolTypeInvalid;
210c35b91ceSAdrian McCarthy }
211f754f88fSGreg Clayton 
212037ed1beSAaron Smith bool ObjectFilePECOFF::CreateBinary() {
213d372a8e8SPavel Labath   if (m_binary)
214037ed1beSAaron Smith     return true;
215037ed1beSAaron Smith 
216a007a6d8SPavel Labath   Log *log = GetLog(LLDBLog::Object);
217037ed1beSAaron Smith 
218d372a8e8SPavel Labath   auto binary = llvm::object::createBinary(llvm::MemoryBufferRef(
219d372a8e8SPavel Labath       toStringRef(m_data.GetData()), m_file.GetFilename().GetStringRef()));
220037ed1beSAaron Smith   if (!binary) {
2213db1d138SMartin Storsjö     LLDB_LOG_ERROR(log, binary.takeError(),
2223db1d138SMartin Storsjö                    "Failed to create binary for file ({1}): {0}", m_file);
223037ed1beSAaron Smith     return false;
224037ed1beSAaron Smith   }
225037ed1beSAaron Smith 
226037ed1beSAaron Smith   // Make sure we only handle COFF format.
227d372a8e8SPavel Labath   m_binary =
228d372a8e8SPavel Labath       llvm::unique_dyn_cast<llvm::object::COFFObjectFile>(std::move(*binary));
229d372a8e8SPavel Labath   if (!m_binary)
230037ed1beSAaron Smith     return false;
231037ed1beSAaron Smith 
232d372a8e8SPavel Labath   LLDB_LOG(log, "this = {0}, module = {1} ({2}), file = {3}, binary = {4}",
233d372a8e8SPavel Labath            this, GetModule().get(), GetModule()->GetSpecificationDescription(),
234d372a8e8SPavel Labath            m_file.GetPath(), m_binary.get());
235037ed1beSAaron Smith   return true;
236037ed1beSAaron Smith }
237037ed1beSAaron Smith 
238e72dfb32SGreg Clayton ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
2395ce9c565SGreg Clayton                                    DataBufferSP &data_sp,
2405ce9c565SGreg Clayton                                    lldb::offset_t data_offset,
241f754f88fSGreg Clayton                                    const FileSpec *file,
2425ce9c565SGreg Clayton                                    lldb::offset_t file_offset,
243b9c1b51eSKate Stone                                    lldb::offset_t length)
244b9c1b51eSKate Stone     : ObjectFile(module_sp, file, file_offset, length, data_sp, data_offset),
2455c43ffd6SPavel Labath       m_dos_header(), m_coff_header(), m_sect_headers(),
246d372a8e8SPavel Labath       m_entry_point_address(), m_deps_filespec() {
247f754f88fSGreg Clayton   ::memset(&m_dos_header, 0, sizeof(m_dos_header));
248f754f88fSGreg Clayton   ::memset(&m_coff_header, 0, sizeof(m_coff_header));
249f754f88fSGreg Clayton }
250f754f88fSGreg Clayton 
251344546bdSWalter Erquinigo ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
252344546bdSWalter Erquinigo                                    DataBufferSP &header_data_sp,
253344546bdSWalter Erquinigo                                    const lldb::ProcessSP &process_sp,
254344546bdSWalter Erquinigo                                    addr_t header_addr)
255344546bdSWalter Erquinigo     : ObjectFile(module_sp, process_sp, header_addr, header_data_sp),
2565c43ffd6SPavel Labath       m_dos_header(), m_coff_header(), m_sect_headers(),
257d372a8e8SPavel Labath       m_entry_point_address(), m_deps_filespec() {
258344546bdSWalter Erquinigo   ::memset(&m_dos_header, 0, sizeof(m_dos_header));
259344546bdSWalter Erquinigo   ::memset(&m_coff_header, 0, sizeof(m_coff_header));
260344546bdSWalter Erquinigo }
261344546bdSWalter Erquinigo 
262fd2433e1SJonas Devlieghere ObjectFilePECOFF::~ObjectFilePECOFF() = default;
263f754f88fSGreg Clayton 
264b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseHeader() {
265a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
266b9c1b51eSKate Stone   if (module_sp) {
26716ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
268f754f88fSGreg Clayton     m_sect_headers.clear();
269f754f88fSGreg Clayton     m_data.SetByteOrder(eByteOrderLittle);
270c7bece56SGreg Clayton     lldb::offset_t offset = 0;
271f754f88fSGreg Clayton 
272b9c1b51eSKate Stone     if (ParseDOSHeader(m_data, m_dos_header)) {
273f754f88fSGreg Clayton       offset = m_dos_header.e_lfanew;
274f754f88fSGreg Clayton       uint32_t pe_signature = m_data.GetU32(&offset);
275f754f88fSGreg Clayton       if (pe_signature != IMAGE_NT_SIGNATURE)
276f754f88fSGreg Clayton         return false;
277b9c1b51eSKate Stone       if (ParseCOFFHeader(m_data, &offset, m_coff_header)) {
278f754f88fSGreg Clayton         if (m_coff_header.hdrsize > 0)
279f754f88fSGreg Clayton           ParseCOFFOptionalHeader(&offset);
280f754f88fSGreg Clayton         ParseSectionHeaders(offset);
28128469ca3SGreg Clayton       }
282a0f72441SMartin Storsjö       m_data.SetAddressByteSize(GetAddressByteSize());
283f754f88fSGreg Clayton       return true;
284f754f88fSGreg Clayton     }
285a1743499SGreg Clayton   }
286f754f88fSGreg Clayton   return false;
287f754f88fSGreg Clayton }
288f754f88fSGreg Clayton 
289b9c1b51eSKate Stone bool ObjectFilePECOFF::SetLoadAddress(Target &target, addr_t value,
290b9c1b51eSKate Stone                                       bool value_is_offset) {
2912756adf3SVirgile Bello   bool changed = false;
2922756adf3SVirgile Bello   ModuleSP module_sp = GetModule();
293b9c1b51eSKate Stone   if (module_sp) {
2942756adf3SVirgile Bello     size_t num_loaded_sections = 0;
2952756adf3SVirgile Bello     SectionList *section_list = GetSectionList();
296b9c1b51eSKate Stone     if (section_list) {
297b9c1b51eSKate Stone       if (!value_is_offset) {
2982756adf3SVirgile Bello         value -= m_image_base;
2992756adf3SVirgile Bello       }
3002756adf3SVirgile Bello 
3012756adf3SVirgile Bello       const size_t num_sections = section_list->GetSize();
3022756adf3SVirgile Bello       size_t sect_idx = 0;
3032756adf3SVirgile Bello 
304b9c1b51eSKate Stone       for (sect_idx = 0; sect_idx < num_sections; ++sect_idx) {
30505097246SAdrian Prantl         // Iterate through the object file sections to find all of the sections
30605097246SAdrian Prantl         // that have SHF_ALLOC in their flag bits.
3072756adf3SVirgile Bello         SectionSP section_sp(section_list->GetSectionAtIndex(sect_idx));
308b9c1b51eSKate Stone         if (section_sp && !section_sp->IsThreadSpecific()) {
309b9c1b51eSKate Stone           if (target.GetSectionLoadList().SetSectionLoadAddress(
310b9c1b51eSKate Stone                   section_sp, section_sp->GetFileAddress() + value))
3112756adf3SVirgile Bello             ++num_loaded_sections;
3122756adf3SVirgile Bello         }
3132756adf3SVirgile Bello       }
3142756adf3SVirgile Bello       changed = num_loaded_sections > 0;
3152756adf3SVirgile Bello     }
3162756adf3SVirgile Bello   }
3172756adf3SVirgile Bello   return changed;
3182756adf3SVirgile Bello }
3192756adf3SVirgile Bello 
320b9c1b51eSKate Stone ByteOrder ObjectFilePECOFF::GetByteOrder() const { return eByteOrderLittle; }
321f754f88fSGreg Clayton 
322b9c1b51eSKate Stone bool ObjectFilePECOFF::IsExecutable() const {
323237ad974SCharles Davis   return (m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0;
324f754f88fSGreg Clayton }
325f754f88fSGreg Clayton 
326b9c1b51eSKate Stone uint32_t ObjectFilePECOFF::GetAddressByteSize() const {
327f754f88fSGreg Clayton   if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32_PLUS)
328f754f88fSGreg Clayton     return 8;
329f754f88fSGreg Clayton   else if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32)
330f754f88fSGreg Clayton     return 4;
331f754f88fSGreg Clayton   return 4;
332f754f88fSGreg Clayton }
333f754f88fSGreg Clayton 
334f754f88fSGreg Clayton // NeedsEndianSwap
335f754f88fSGreg Clayton //
33605097246SAdrian Prantl // Return true if an endian swap needs to occur when extracting data from this
33705097246SAdrian Prantl // file.
338b9c1b51eSKate Stone bool ObjectFilePECOFF::NeedsEndianSwap() const {
339f754f88fSGreg Clayton #if defined(__LITTLE_ENDIAN__)
340f754f88fSGreg Clayton   return false;
341f754f88fSGreg Clayton #else
342f754f88fSGreg Clayton   return true;
343f754f88fSGreg Clayton #endif
344f754f88fSGreg Clayton }
345f754f88fSGreg Clayton // ParseDOSHeader
346b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseDOSHeader(DataExtractor &data,
347b9c1b51eSKate Stone                                       dos_header_t &dos_header) {
348f754f88fSGreg Clayton   bool success = false;
349c7bece56SGreg Clayton   lldb::offset_t offset = 0;
35089eb1baeSVirgile Bello   success = data.ValidOffsetForDataOfSize(0, sizeof(dos_header));
351f754f88fSGreg Clayton 
352b9c1b51eSKate Stone   if (success) {
35389eb1baeSVirgile Bello     dos_header.e_magic = data.GetU16(&offset); // Magic number
35489eb1baeSVirgile Bello     success = dos_header.e_magic == IMAGE_DOS_SIGNATURE;
355f754f88fSGreg Clayton 
356b9c1b51eSKate Stone     if (success) {
35789eb1baeSVirgile Bello       dos_header.e_cblp = data.GetU16(&offset); // Bytes on last page of file
35889eb1baeSVirgile Bello       dos_header.e_cp = data.GetU16(&offset);   // Pages in file
35989eb1baeSVirgile Bello       dos_header.e_crlc = data.GetU16(&offset); // Relocations
360b9c1b51eSKate Stone       dos_header.e_cparhdr =
361b9c1b51eSKate Stone           data.GetU16(&offset); // Size of header in paragraphs
362b9c1b51eSKate Stone       dos_header.e_minalloc =
363b9c1b51eSKate Stone           data.GetU16(&offset); // Minimum extra paragraphs needed
364b9c1b51eSKate Stone       dos_header.e_maxalloc =
365b9c1b51eSKate Stone           data.GetU16(&offset);               // Maximum extra paragraphs needed
36689eb1baeSVirgile Bello       dos_header.e_ss = data.GetU16(&offset); // Initial (relative) SS value
36789eb1baeSVirgile Bello       dos_header.e_sp = data.GetU16(&offset); // Initial SP value
36889eb1baeSVirgile Bello       dos_header.e_csum = data.GetU16(&offset); // Checksum
36989eb1baeSVirgile Bello       dos_header.e_ip = data.GetU16(&offset);   // Initial IP value
37089eb1baeSVirgile Bello       dos_header.e_cs = data.GetU16(&offset);   // Initial (relative) CS value
371b9c1b51eSKate Stone       dos_header.e_lfarlc =
372b9c1b51eSKate Stone           data.GetU16(&offset); // File address of relocation table
37389eb1baeSVirgile Bello       dos_header.e_ovno = data.GetU16(&offset); // Overlay number
374f754f88fSGreg Clayton 
37589eb1baeSVirgile Bello       dos_header.e_res[0] = data.GetU16(&offset); // Reserved words
37689eb1baeSVirgile Bello       dos_header.e_res[1] = data.GetU16(&offset); // Reserved words
37789eb1baeSVirgile Bello       dos_header.e_res[2] = data.GetU16(&offset); // Reserved words
37889eb1baeSVirgile Bello       dos_header.e_res[3] = data.GetU16(&offset); // Reserved words
379f754f88fSGreg Clayton 
380b9c1b51eSKate Stone       dos_header.e_oemid =
381b9c1b51eSKate Stone           data.GetU16(&offset); // OEM identifier (for e_oeminfo)
382b9c1b51eSKate Stone       dos_header.e_oeminfo =
383b9c1b51eSKate Stone           data.GetU16(&offset); // OEM information; e_oemid specific
38489eb1baeSVirgile Bello       dos_header.e_res2[0] = data.GetU16(&offset); // Reserved words
38589eb1baeSVirgile Bello       dos_header.e_res2[1] = data.GetU16(&offset); // Reserved words
38689eb1baeSVirgile Bello       dos_header.e_res2[2] = data.GetU16(&offset); // Reserved words
38789eb1baeSVirgile Bello       dos_header.e_res2[3] = data.GetU16(&offset); // Reserved words
38889eb1baeSVirgile Bello       dos_header.e_res2[4] = data.GetU16(&offset); // Reserved words
38989eb1baeSVirgile Bello       dos_header.e_res2[5] = data.GetU16(&offset); // Reserved words
39089eb1baeSVirgile Bello       dos_header.e_res2[6] = data.GetU16(&offset); // Reserved words
39189eb1baeSVirgile Bello       dos_header.e_res2[7] = data.GetU16(&offset); // Reserved words
39289eb1baeSVirgile Bello       dos_header.e_res2[8] = data.GetU16(&offset); // Reserved words
39389eb1baeSVirgile Bello       dos_header.e_res2[9] = data.GetU16(&offset); // Reserved words
394f754f88fSGreg Clayton 
395b9c1b51eSKate Stone       dos_header.e_lfanew =
396b9c1b51eSKate Stone           data.GetU32(&offset); // File address of new exe header
397f754f88fSGreg Clayton     }
398f754f88fSGreg Clayton   }
399f754f88fSGreg Clayton   if (!success)
40089eb1baeSVirgile Bello     memset(&dos_header, 0, sizeof(dos_header));
401f754f88fSGreg Clayton   return success;
402f754f88fSGreg Clayton }
403f754f88fSGreg Clayton 
404f754f88fSGreg Clayton // ParserCOFFHeader
405b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseCOFFHeader(DataExtractor &data,
406b9c1b51eSKate Stone                                        lldb::offset_t *offset_ptr,
407b9c1b51eSKate Stone                                        coff_header_t &coff_header) {
408b9c1b51eSKate Stone   bool success =
409b9c1b51eSKate Stone       data.ValidOffsetForDataOfSize(*offset_ptr, sizeof(coff_header));
410b9c1b51eSKate Stone   if (success) {
41189eb1baeSVirgile Bello     coff_header.machine = data.GetU16(offset_ptr);
41289eb1baeSVirgile Bello     coff_header.nsects = data.GetU16(offset_ptr);
41389eb1baeSVirgile Bello     coff_header.modtime = data.GetU32(offset_ptr);
41489eb1baeSVirgile Bello     coff_header.symoff = data.GetU32(offset_ptr);
41589eb1baeSVirgile Bello     coff_header.nsyms = data.GetU32(offset_ptr);
41689eb1baeSVirgile Bello     coff_header.hdrsize = data.GetU16(offset_ptr);
41789eb1baeSVirgile Bello     coff_header.flags = data.GetU16(offset_ptr);
418f754f88fSGreg Clayton   }
419f754f88fSGreg Clayton   if (!success)
42089eb1baeSVirgile Bello     memset(&coff_header, 0, sizeof(coff_header));
421f754f88fSGreg Clayton   return success;
422f754f88fSGreg Clayton }
423f754f88fSGreg Clayton 
424b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseCOFFOptionalHeader(lldb::offset_t *offset_ptr) {
425f754f88fSGreg Clayton   bool success = false;
426c7bece56SGreg Clayton   const lldb::offset_t end_offset = *offset_ptr + m_coff_header.hdrsize;
427b9c1b51eSKate Stone   if (*offset_ptr < end_offset) {
428f754f88fSGreg Clayton     success = true;
429f754f88fSGreg Clayton     m_coff_header_opt.magic = m_data.GetU16(offset_ptr);
430f754f88fSGreg Clayton     m_coff_header_opt.major_linker_version = m_data.GetU8(offset_ptr);
431f754f88fSGreg Clayton     m_coff_header_opt.minor_linker_version = m_data.GetU8(offset_ptr);
432f754f88fSGreg Clayton     m_coff_header_opt.code_size = m_data.GetU32(offset_ptr);
433f754f88fSGreg Clayton     m_coff_header_opt.data_size = m_data.GetU32(offset_ptr);
434f754f88fSGreg Clayton     m_coff_header_opt.bss_size = m_data.GetU32(offset_ptr);
435f754f88fSGreg Clayton     m_coff_header_opt.entry = m_data.GetU32(offset_ptr);
436f754f88fSGreg Clayton     m_coff_header_opt.code_offset = m_data.GetU32(offset_ptr);
437f754f88fSGreg Clayton 
438f754f88fSGreg Clayton     const uint32_t addr_byte_size = GetAddressByteSize();
439f754f88fSGreg Clayton 
440b9c1b51eSKate Stone     if (*offset_ptr < end_offset) {
441b9c1b51eSKate Stone       if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32) {
442f754f88fSGreg Clayton         // PE32 only
443f754f88fSGreg Clayton         m_coff_header_opt.data_offset = m_data.GetU32(offset_ptr);
444b9c1b51eSKate Stone       } else
445f754f88fSGreg Clayton         m_coff_header_opt.data_offset = 0;
446f754f88fSGreg Clayton 
447b9c1b51eSKate Stone       if (*offset_ptr < end_offset) {
448b9c1b51eSKate Stone         m_coff_header_opt.image_base =
449b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
450f754f88fSGreg Clayton         m_coff_header_opt.sect_alignment = m_data.GetU32(offset_ptr);
451f754f88fSGreg Clayton         m_coff_header_opt.file_alignment = m_data.GetU32(offset_ptr);
452f754f88fSGreg Clayton         m_coff_header_opt.major_os_system_version = m_data.GetU16(offset_ptr);
453f754f88fSGreg Clayton         m_coff_header_opt.minor_os_system_version = m_data.GetU16(offset_ptr);
454f754f88fSGreg Clayton         m_coff_header_opt.major_image_version = m_data.GetU16(offset_ptr);
455f754f88fSGreg Clayton         m_coff_header_opt.minor_image_version = m_data.GetU16(offset_ptr);
456f754f88fSGreg Clayton         m_coff_header_opt.major_subsystem_version = m_data.GetU16(offset_ptr);
457f754f88fSGreg Clayton         m_coff_header_opt.minor_subsystem_version = m_data.GetU16(offset_ptr);
458f754f88fSGreg Clayton         m_coff_header_opt.reserved1 = m_data.GetU32(offset_ptr);
459f754f88fSGreg Clayton         m_coff_header_opt.image_size = m_data.GetU32(offset_ptr);
460f754f88fSGreg Clayton         m_coff_header_opt.header_size = m_data.GetU32(offset_ptr);
46128469ca3SGreg Clayton         m_coff_header_opt.checksum = m_data.GetU32(offset_ptr);
462f754f88fSGreg Clayton         m_coff_header_opt.subsystem = m_data.GetU16(offset_ptr);
463f754f88fSGreg Clayton         m_coff_header_opt.dll_flags = m_data.GetU16(offset_ptr);
464b9c1b51eSKate Stone         m_coff_header_opt.stack_reserve_size =
465b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
466b9c1b51eSKate Stone         m_coff_header_opt.stack_commit_size =
467b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
468b9c1b51eSKate Stone         m_coff_header_opt.heap_reserve_size =
469b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
470b9c1b51eSKate Stone         m_coff_header_opt.heap_commit_size =
471b9c1b51eSKate Stone             m_data.GetMaxU64(offset_ptr, addr_byte_size);
472f754f88fSGreg Clayton         m_coff_header_opt.loader_flags = m_data.GetU32(offset_ptr);
473f754f88fSGreg Clayton         uint32_t num_data_dir_entries = m_data.GetU32(offset_ptr);
474f754f88fSGreg Clayton         m_coff_header_opt.data_dirs.clear();
475f754f88fSGreg Clayton         m_coff_header_opt.data_dirs.resize(num_data_dir_entries);
476f754f88fSGreg Clayton         uint32_t i;
477b9c1b51eSKate Stone         for (i = 0; i < num_data_dir_entries; i++) {
478f754f88fSGreg Clayton           m_coff_header_opt.data_dirs[i].vmaddr = m_data.GetU32(offset_ptr);
479f754f88fSGreg Clayton           m_coff_header_opt.data_dirs[i].vmsize = m_data.GetU32(offset_ptr);
480f754f88fSGreg Clayton         }
4812756adf3SVirgile Bello 
4822756adf3SVirgile Bello         m_image_base = m_coff_header_opt.image_base;
483f754f88fSGreg Clayton       }
484f754f88fSGreg Clayton     }
485f754f88fSGreg Clayton   }
486f754f88fSGreg Clayton   // Make sure we are on track for section data which follows
487f754f88fSGreg Clayton   *offset_ptr = end_offset;
488f754f88fSGreg Clayton   return success;
489f754f88fSGreg Clayton }
490f754f88fSGreg Clayton 
49130c2441aSAleksandr Urakov uint32_t ObjectFilePECOFF::GetRVA(const Address &addr) const {
49230c2441aSAleksandr Urakov   return addr.GetFileAddress() - m_image_base;
49330c2441aSAleksandr Urakov }
49430c2441aSAleksandr Urakov 
49530c2441aSAleksandr Urakov Address ObjectFilePECOFF::GetAddress(uint32_t rva) {
49630c2441aSAleksandr Urakov   SectionList *sect_list = GetSectionList();
49730c2441aSAleksandr Urakov   if (!sect_list)
49830c2441aSAleksandr Urakov     return Address(GetFileAddress(rva));
49930c2441aSAleksandr Urakov 
50030c2441aSAleksandr Urakov   return Address(GetFileAddress(rva), sect_list);
50130c2441aSAleksandr Urakov }
50230c2441aSAleksandr Urakov 
50330c2441aSAleksandr Urakov lldb::addr_t ObjectFilePECOFF::GetFileAddress(uint32_t rva) const {
50430c2441aSAleksandr Urakov   return m_image_base + rva;
50530c2441aSAleksandr Urakov }
50630c2441aSAleksandr Urakov 
507344546bdSWalter Erquinigo DataExtractor ObjectFilePECOFF::ReadImageData(uint32_t offset, size_t size) {
50830c2441aSAleksandr Urakov   if (!size)
50930c2441aSAleksandr Urakov     return {};
51030c2441aSAleksandr Urakov 
511a4a00cedSFred Riss   if (m_data.ValidOffsetForDataOfSize(offset, size))
512a4a00cedSFred Riss     return DataExtractor(m_data, offset, size);
513a4a00cedSFred Riss 
514344546bdSWalter Erquinigo   ProcessSP process_sp(m_process_wp.lock());
515344546bdSWalter Erquinigo   DataExtractor data;
516344546bdSWalter Erquinigo   if (process_sp) {
517a8f3ae7cSJonas Devlieghere     auto data_up = std::make_unique<DataBufferHeap>(size, 0);
51897206d57SZachary Turner     Status readmem_error;
519344546bdSWalter Erquinigo     size_t bytes_read =
520d5b44036SJonas Devlieghere         process_sp->ReadMemory(m_image_base + offset, data_up->GetBytes(),
521d5b44036SJonas Devlieghere                                data_up->GetByteSize(), readmem_error);
522344546bdSWalter Erquinigo     if (bytes_read == size) {
523d5b44036SJonas Devlieghere       DataBufferSP buffer_sp(data_up.release());
524344546bdSWalter Erquinigo       data.SetData(buffer_sp, 0, buffer_sp->GetByteSize());
525344546bdSWalter Erquinigo     }
526344546bdSWalter Erquinigo   }
527344546bdSWalter Erquinigo   return data;
528344546bdSWalter Erquinigo }
529344546bdSWalter Erquinigo 
53030c2441aSAleksandr Urakov DataExtractor ObjectFilePECOFF::ReadImageDataByRVA(uint32_t rva, size_t size) {
53130c2441aSAleksandr Urakov   Address addr = GetAddress(rva);
5327e1a3076SMartin Storsjö   SectionSP sect = addr.GetSection();
5337e1a3076SMartin Storsjö   if (!sect)
5347e1a3076SMartin Storsjö     return {};
5357e1a3076SMartin Storsjö   rva = sect->GetFileOffset() + addr.GetOffset();
53630c2441aSAleksandr Urakov 
53730c2441aSAleksandr Urakov   return ReadImageData(rva, size);
53830c2441aSAleksandr Urakov }
53930c2441aSAleksandr Urakov 
540f754f88fSGreg Clayton // ParseSectionHeaders
541b9c1b51eSKate Stone bool ObjectFilePECOFF::ParseSectionHeaders(
542b9c1b51eSKate Stone     uint32_t section_header_data_offset) {
543f754f88fSGreg Clayton   const uint32_t nsects = m_coff_header.nsects;
544f754f88fSGreg Clayton   m_sect_headers.clear();
545f754f88fSGreg Clayton 
546b9c1b51eSKate Stone   if (nsects > 0) {
547f754f88fSGreg Clayton     const size_t section_header_byte_size = nsects * sizeof(section_header_t);
548344546bdSWalter Erquinigo     DataExtractor section_header_data =
549344546bdSWalter Erquinigo         ReadImageData(section_header_data_offset, section_header_byte_size);
550f754f88fSGreg Clayton 
551c7bece56SGreg Clayton     lldb::offset_t offset = 0;
552b9c1b51eSKate Stone     if (section_header_data.ValidOffsetForDataOfSize(
553b9c1b51eSKate Stone             offset, section_header_byte_size)) {
554f754f88fSGreg Clayton       m_sect_headers.resize(nsects);
555f754f88fSGreg Clayton 
556b9c1b51eSKate Stone       for (uint32_t idx = 0; idx < nsects; ++idx) {
557f754f88fSGreg Clayton         const void *name_data = section_header_data.GetData(&offset, 8);
558b9c1b51eSKate Stone         if (name_data) {
559f754f88fSGreg Clayton           memcpy(m_sect_headers[idx].name, name_data, 8);
560f754f88fSGreg Clayton           m_sect_headers[idx].vmsize = section_header_data.GetU32(&offset);
561f754f88fSGreg Clayton           m_sect_headers[idx].vmaddr = section_header_data.GetU32(&offset);
562f754f88fSGreg Clayton           m_sect_headers[idx].size = section_header_data.GetU32(&offset);
563f754f88fSGreg Clayton           m_sect_headers[idx].offset = section_header_data.GetU32(&offset);
564f754f88fSGreg Clayton           m_sect_headers[idx].reloff = section_header_data.GetU32(&offset);
565f754f88fSGreg Clayton           m_sect_headers[idx].lineoff = section_header_data.GetU32(&offset);
566f754f88fSGreg Clayton           m_sect_headers[idx].nreloc = section_header_data.GetU16(&offset);
567f754f88fSGreg Clayton           m_sect_headers[idx].nline = section_header_data.GetU16(&offset);
568f754f88fSGreg Clayton           m_sect_headers[idx].flags = section_header_data.GetU32(&offset);
569f754f88fSGreg Clayton         }
570f754f88fSGreg Clayton       }
571f754f88fSGreg Clayton     }
572f754f88fSGreg Clayton   }
573f754f88fSGreg Clayton 
574a6682a41SJonas Devlieghere   return !m_sect_headers.empty();
575f754f88fSGreg Clayton }
576f754f88fSGreg Clayton 
5772886e4a0SPavel Labath llvm::StringRef ObjectFilePECOFF::GetSectionName(const section_header_t &sect) {
578f15014ffSBenjamin Kramer   llvm::StringRef hdr_name(sect.name, llvm::array_lengthof(sect.name));
5792886e4a0SPavel Labath   hdr_name = hdr_name.split('\0').first;
5802886e4a0SPavel Labath   if (hdr_name.consume_front("/")) {
5812886e4a0SPavel Labath     lldb::offset_t stroff;
5822886e4a0SPavel Labath     if (!to_integer(hdr_name, stroff, 10))
5832886e4a0SPavel Labath       return "";
584b9c1b51eSKate Stone     lldb::offset_t string_file_offset =
585b9c1b51eSKate Stone         m_coff_header.symoff + (m_coff_header.nsyms * 18) + stroff;
5862886e4a0SPavel Labath     if (const char *name = m_data.GetCStr(&string_file_offset))
5872886e4a0SPavel Labath       return name;
5882886e4a0SPavel Labath     return "";
589f754f88fSGreg Clayton   }
5902886e4a0SPavel Labath   return hdr_name;
591f754f88fSGreg Clayton }
592f754f88fSGreg Clayton 
5937e6df41fSGreg Clayton void ObjectFilePECOFF::ParseSymtab(Symtab &symtab) {
594f754f88fSGreg Clayton   SectionList *sect_list = GetSectionList();
59528469ca3SGreg Clayton   const uint32_t num_syms = m_coff_header.nsyms;
596344546bdSWalter Erquinigo   if (m_file && num_syms > 0 && m_coff_header.symoff > 0) {
5970076e715SGreg Clayton     const uint32_t symbol_size = 18;
59828469ca3SGreg Clayton     const size_t symbol_data_size = num_syms * symbol_size;
599c35b91ceSAdrian McCarthy     // Include the 4-byte string table size at the end of the symbols
600344546bdSWalter Erquinigo     DataExtractor symtab_data =
601344546bdSWalter Erquinigo         ReadImageData(m_coff_header.symoff, symbol_data_size + 4);
602c7bece56SGreg Clayton     lldb::offset_t offset = symbol_data_size;
60328469ca3SGreg Clayton     const uint32_t strtab_size = symtab_data.GetU32(&offset);
604344546bdSWalter Erquinigo     if (strtab_size > 0) {
605344546bdSWalter Erquinigo       DataExtractor strtab_data = ReadImageData(
606344546bdSWalter Erquinigo           m_coff_header.symoff + symbol_data_size, strtab_size);
60728469ca3SGreg Clayton 
60828469ca3SGreg Clayton       offset = 0;
60928469ca3SGreg Clayton       std::string symbol_name;
6107e6df41fSGreg Clayton       Symbol *symbols = symtab.Resize(num_syms);
611b9c1b51eSKate Stone       for (uint32_t i = 0; i < num_syms; ++i) {
612f754f88fSGreg Clayton         coff_symbol_t symbol;
61328469ca3SGreg Clayton         const uint32_t symbol_offset = offset;
614248a1305SKonrad Kleine         const char *symbol_name_cstr = nullptr;
615c35b91ceSAdrian McCarthy         // If the first 4 bytes of the symbol string are zero, then they
616c35b91ceSAdrian McCarthy         // are followed by a 4-byte string table offset. Else these
61728469ca3SGreg Clayton         // 8 bytes contain the symbol name
618b9c1b51eSKate Stone         if (symtab_data.GetU32(&offset) == 0) {
61905097246SAdrian Prantl           // Long string that doesn't fit into the symbol table name, so
62005097246SAdrian Prantl           // now we must read the 4 byte string table offset
62128469ca3SGreg Clayton           uint32_t strtab_offset = symtab_data.GetU32(&offset);
62228469ca3SGreg Clayton           symbol_name_cstr = strtab_data.PeekCStr(strtab_offset);
62328469ca3SGreg Clayton           symbol_name.assign(symbol_name_cstr);
624b9c1b51eSKate Stone         } else {
625b9c1b51eSKate Stone           // Short string that fits into the symbol table name which is 8
626b9c1b51eSKate Stone           // bytes
62728469ca3SGreg Clayton           offset += sizeof(symbol.name) - 4; // Skip remaining
62828469ca3SGreg Clayton           symbol_name_cstr = symtab_data.PeekCStr(symbol_offset);
629248a1305SKonrad Kleine           if (symbol_name_cstr == nullptr)
630f754f88fSGreg Clayton             break;
63128469ca3SGreg Clayton           symbol_name.assign(symbol_name_cstr, sizeof(symbol.name));
63228469ca3SGreg Clayton         }
63328469ca3SGreg Clayton         symbol.value = symtab_data.GetU32(&offset);
63428469ca3SGreg Clayton         symbol.sect = symtab_data.GetU16(&offset);
63528469ca3SGreg Clayton         symbol.type = symtab_data.GetU16(&offset);
63628469ca3SGreg Clayton         symbol.storage = symtab_data.GetU8(&offset);
63728469ca3SGreg Clayton         symbol.naux = symtab_data.GetU8(&offset);
638037520e9SGreg Clayton         symbols[i].GetMangled().SetValue(ConstString(symbol_name.c_str()));
639b9c1b51eSKate Stone         if ((int16_t)symbol.sect >= 1) {
6404394b5beSMartin Storsjö           Address symbol_addr(sect_list->FindSectionByID(symbol.sect),
641b9c1b51eSKate Stone                               symbol.value);
642358cf1eaSGreg Clayton           symbols[i].GetAddressRef() = symbol_addr;
643c35b91ceSAdrian McCarthy           symbols[i].SetType(MapSymbolType(symbol.type));
6440076e715SGreg Clayton         }
645f754f88fSGreg Clayton 
646b9c1b51eSKate Stone         if (symbol.naux > 0) {
647f754f88fSGreg Clayton           i += symbol.naux;
648f07ddbc9SMartin Storsjö           offset += symbol.naux * symbol_size;
6490076e715SGreg Clayton         }
650f754f88fSGreg Clayton       }
651f754f88fSGreg Clayton     }
652344546bdSWalter Erquinigo   }
653a4fe3a12SVirgile Bello 
654a4fe3a12SVirgile Bello   // Read export header
655b9c1b51eSKate Stone   if (coff_data_dir_export_table < m_coff_header_opt.data_dirs.size() &&
656b9c1b51eSKate Stone       m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmsize > 0 &&
657b9c1b51eSKate Stone       m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmaddr > 0) {
658a4fe3a12SVirgile Bello     export_directory_entry export_table;
659b9c1b51eSKate Stone     uint32_t data_start =
660b9c1b51eSKate Stone         m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmaddr;
661344546bdSWalter Erquinigo 
66230c2441aSAleksandr Urakov     DataExtractor symtab_data = ReadImageDataByRVA(
66330c2441aSAleksandr Urakov         data_start, m_coff_header_opt.data_dirs[0].vmsize);
664a4fe3a12SVirgile Bello     lldb::offset_t offset = 0;
665a4fe3a12SVirgile Bello 
666a4fe3a12SVirgile Bello     // Read export_table header
667a4fe3a12SVirgile Bello     export_table.characteristics = symtab_data.GetU32(&offset);
668a4fe3a12SVirgile Bello     export_table.time_date_stamp = symtab_data.GetU32(&offset);
669a4fe3a12SVirgile Bello     export_table.major_version = symtab_data.GetU16(&offset);
670a4fe3a12SVirgile Bello     export_table.minor_version = symtab_data.GetU16(&offset);
671a4fe3a12SVirgile Bello     export_table.name = symtab_data.GetU32(&offset);
672a4fe3a12SVirgile Bello     export_table.base = symtab_data.GetU32(&offset);
673a4fe3a12SVirgile Bello     export_table.number_of_functions = symtab_data.GetU32(&offset);
674a4fe3a12SVirgile Bello     export_table.number_of_names = symtab_data.GetU32(&offset);
675a4fe3a12SVirgile Bello     export_table.address_of_functions = symtab_data.GetU32(&offset);
676a4fe3a12SVirgile Bello     export_table.address_of_names = symtab_data.GetU32(&offset);
677a4fe3a12SVirgile Bello     export_table.address_of_name_ordinals = symtab_data.GetU32(&offset);
678a4fe3a12SVirgile Bello 
679a4fe3a12SVirgile Bello     bool has_ordinal = export_table.address_of_name_ordinals != 0;
680a4fe3a12SVirgile Bello 
681a4fe3a12SVirgile Bello     lldb::offset_t name_offset = export_table.address_of_names - data_start;
682b9c1b51eSKate Stone     lldb::offset_t name_ordinal_offset =
683b9c1b51eSKate Stone         export_table.address_of_name_ordinals - data_start;
684a4fe3a12SVirgile Bello 
6857e6df41fSGreg Clayton     Symbol *symbols = symtab.Resize(export_table.number_of_names);
686a4fe3a12SVirgile Bello 
687a4fe3a12SVirgile Bello     std::string symbol_name;
688a4fe3a12SVirgile Bello 
689a4fe3a12SVirgile Bello     // Read each export table entry
690b9c1b51eSKate Stone     for (size_t i = 0; i < export_table.number_of_names; ++i) {
691b9c1b51eSKate Stone       uint32_t name_ordinal =
692b9c1b51eSKate Stone           has_ordinal ? symtab_data.GetU16(&name_ordinal_offset) : i;
693a4fe3a12SVirgile Bello       uint32_t name_address = symtab_data.GetU32(&name_offset);
694a4fe3a12SVirgile Bello 
695b9c1b51eSKate Stone       const char *symbol_name_cstr =
696b9c1b51eSKate Stone           symtab_data.PeekCStr(name_address - data_start);
697a4fe3a12SVirgile Bello       symbol_name.assign(symbol_name_cstr);
698a4fe3a12SVirgile Bello 
699b9c1b51eSKate Stone       lldb::offset_t function_offset = export_table.address_of_functions -
700b9c1b51eSKate Stone                                         data_start +
701b9c1b51eSKate Stone                                         sizeof(uint32_t) * name_ordinal;
702a4fe3a12SVirgile Bello       uint32_t function_rva = symtab_data.GetU32(&function_offset);
703a4fe3a12SVirgile Bello 
704b9c1b51eSKate Stone       Address symbol_addr(m_coff_header_opt.image_base + function_rva,
705b9c1b51eSKate Stone                           sect_list);
706a4fe3a12SVirgile Bello       symbols[i].GetMangled().SetValue(ConstString(symbol_name.c_str()));
707358cf1eaSGreg Clayton       symbols[i].GetAddressRef() = symbol_addr;
708a4fe3a12SVirgile Bello       symbols[i].SetType(lldb::eSymbolTypeCode);
709a4fe3a12SVirgile Bello       symbols[i].SetDebug(true);
710a4fe3a12SVirgile Bello     }
711a4fe3a12SVirgile Bello   }
712f754f88fSGreg Clayton }
713f754f88fSGreg Clayton 
71430c2441aSAleksandr Urakov std::unique_ptr<CallFrameInfo> ObjectFilePECOFF::CreateCallFrameInfo() {
71530c2441aSAleksandr Urakov   if (coff_data_dir_exception_table >= m_coff_header_opt.data_dirs.size())
71630c2441aSAleksandr Urakov     return {};
71730c2441aSAleksandr Urakov 
71830c2441aSAleksandr Urakov   data_directory data_dir_exception =
71930c2441aSAleksandr Urakov       m_coff_header_opt.data_dirs[coff_data_dir_exception_table];
72030c2441aSAleksandr Urakov   if (!data_dir_exception.vmaddr)
72130c2441aSAleksandr Urakov     return {};
72230c2441aSAleksandr Urakov 
723aa786b88SMartin Storsjö   if (m_coff_header.machine != llvm::COFF::IMAGE_FILE_MACHINE_AMD64)
724aa786b88SMartin Storsjö     return {};
725aa786b88SMartin Storsjö 
72630c2441aSAleksandr Urakov   return std::make_unique<PECallFrameInfo>(*this, data_dir_exception.vmaddr,
72730c2441aSAleksandr Urakov                                            data_dir_exception.vmsize);
72830c2441aSAleksandr Urakov }
72930c2441aSAleksandr Urakov 
730b9c1b51eSKate Stone bool ObjectFilePECOFF::IsStripped() {
7313046e668SGreg Clayton   // TODO: determine this for COFF
7323046e668SGreg Clayton   return false;
7333046e668SGreg Clayton }
7343046e668SGreg Clayton 
7352e5bb6d8SMartin Storsjö SectionType ObjectFilePECOFF::GetSectionType(llvm::StringRef sect_name,
7362e5bb6d8SMartin Storsjö                                              const section_header_t &sect) {
7372e5bb6d8SMartin Storsjö   ConstString const_sect_name(sect_name);
7382e5bb6d8SMartin Storsjö   static ConstString g_code_sect_name(".code");
7392e5bb6d8SMartin Storsjö   static ConstString g_CODE_sect_name("CODE");
7402e5bb6d8SMartin Storsjö   static ConstString g_data_sect_name(".data");
7412e5bb6d8SMartin Storsjö   static ConstString g_DATA_sect_name("DATA");
7422e5bb6d8SMartin Storsjö   static ConstString g_bss_sect_name(".bss");
7432e5bb6d8SMartin Storsjö   static ConstString g_BSS_sect_name("BSS");
7442e5bb6d8SMartin Storsjö 
7452e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_CODE &&
7462e5bb6d8SMartin Storsjö       ((const_sect_name == g_code_sect_name) ||
7472e5bb6d8SMartin Storsjö        (const_sect_name == g_CODE_sect_name))) {
7482e5bb6d8SMartin Storsjö     return eSectionTypeCode;
7492e5bb6d8SMartin Storsjö   }
7502e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA &&
7512e5bb6d8SMartin Storsjö              ((const_sect_name == g_data_sect_name) ||
7522e5bb6d8SMartin Storsjö               (const_sect_name == g_DATA_sect_name))) {
7532e5bb6d8SMartin Storsjö     if (sect.size == 0 && sect.offset == 0)
7542e5bb6d8SMartin Storsjö       return eSectionTypeZeroFill;
7552e5bb6d8SMartin Storsjö     else
7562e5bb6d8SMartin Storsjö       return eSectionTypeData;
7572e5bb6d8SMartin Storsjö   }
7582e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA &&
7592e5bb6d8SMartin Storsjö              ((const_sect_name == g_bss_sect_name) ||
7602e5bb6d8SMartin Storsjö               (const_sect_name == g_BSS_sect_name))) {
7612e5bb6d8SMartin Storsjö     if (sect.size == 0)
7622e5bb6d8SMartin Storsjö       return eSectionTypeZeroFill;
7632e5bb6d8SMartin Storsjö     else
7642e5bb6d8SMartin Storsjö       return eSectionTypeData;
7652e5bb6d8SMartin Storsjö   }
7662e5bb6d8SMartin Storsjö 
7672e5bb6d8SMartin Storsjö   SectionType section_type =
7682e5bb6d8SMartin Storsjö       llvm::StringSwitch<SectionType>(sect_name)
7692e5bb6d8SMartin Storsjö           .Case(".debug", eSectionTypeDebug)
7702e5bb6d8SMartin Storsjö           .Case(".stabstr", eSectionTypeDataCString)
7712e5bb6d8SMartin Storsjö           .Case(".reloc", eSectionTypeOther)
7722e5bb6d8SMartin Storsjö           .Case(".debug_abbrev", eSectionTypeDWARFDebugAbbrev)
7732e5bb6d8SMartin Storsjö           .Case(".debug_aranges", eSectionTypeDWARFDebugAranges)
7742e5bb6d8SMartin Storsjö           .Case(".debug_frame", eSectionTypeDWARFDebugFrame)
7752e5bb6d8SMartin Storsjö           .Case(".debug_info", eSectionTypeDWARFDebugInfo)
7762e5bb6d8SMartin Storsjö           .Case(".debug_line", eSectionTypeDWARFDebugLine)
7772e5bb6d8SMartin Storsjö           .Case(".debug_loc", eSectionTypeDWARFDebugLoc)
7782e5bb6d8SMartin Storsjö           .Case(".debug_loclists", eSectionTypeDWARFDebugLocLists)
7792e5bb6d8SMartin Storsjö           .Case(".debug_macinfo", eSectionTypeDWARFDebugMacInfo)
7802e5bb6d8SMartin Storsjö           .Case(".debug_names", eSectionTypeDWARFDebugNames)
7812e5bb6d8SMartin Storsjö           .Case(".debug_pubnames", eSectionTypeDWARFDebugPubNames)
7822e5bb6d8SMartin Storsjö           .Case(".debug_pubtypes", eSectionTypeDWARFDebugPubTypes)
7832e5bb6d8SMartin Storsjö           .Case(".debug_ranges", eSectionTypeDWARFDebugRanges)
7842e5bb6d8SMartin Storsjö           .Case(".debug_str", eSectionTypeDWARFDebugStr)
7852e5bb6d8SMartin Storsjö           .Case(".debug_types", eSectionTypeDWARFDebugTypes)
786934c025eSMartin Storsjö           // .eh_frame can be truncated to 8 chars.
787934c025eSMartin Storsjö           .Cases(".eh_frame", ".eh_fram", eSectionTypeEHFrame)
7882e5bb6d8SMartin Storsjö           .Case(".gosymtab", eSectionTypeGoSymtab)
7892e5bb6d8SMartin Storsjö           .Default(eSectionTypeInvalid);
7902e5bb6d8SMartin Storsjö   if (section_type != eSectionTypeInvalid)
7912e5bb6d8SMartin Storsjö     return section_type;
7922e5bb6d8SMartin Storsjö 
7932e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_CODE)
7942e5bb6d8SMartin Storsjö     return eSectionTypeCode;
7952e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
7962e5bb6d8SMartin Storsjö     return eSectionTypeData;
7972e5bb6d8SMartin Storsjö   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) {
7982e5bb6d8SMartin Storsjö     if (sect.size == 0)
7992e5bb6d8SMartin Storsjö       return eSectionTypeZeroFill;
8002e5bb6d8SMartin Storsjö     else
8012e5bb6d8SMartin Storsjö       return eSectionTypeData;
8022e5bb6d8SMartin Storsjö   }
8032e5bb6d8SMartin Storsjö   return eSectionTypeOther;
8042e5bb6d8SMartin Storsjö }
8052e5bb6d8SMartin Storsjö 
806b9c1b51eSKate Stone void ObjectFilePECOFF::CreateSections(SectionList &unified_section_list) {
807d5b44036SJonas Devlieghere   if (m_sections_up)
80888a2c2a4SPavel Labath     return;
80906412daeSJonas Devlieghere   m_sections_up = std::make_unique<SectionList>();
810a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
811b9c1b51eSKate Stone   if (module_sp) {
81216ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
8137db8b5c4SPavel Labath 
81473a7a55cSPavel Labath     SectionSP header_sp = std::make_shared<Section>(
81573a7a55cSPavel Labath         module_sp, this, ~user_id_t(0), ConstString("PECOFF header"),
81673a7a55cSPavel Labath         eSectionTypeOther, m_coff_header_opt.image_base,
81773a7a55cSPavel Labath         m_coff_header_opt.header_size,
81873a7a55cSPavel Labath         /*file_offset*/ 0, m_coff_header_opt.header_size,
81973a7a55cSPavel Labath         m_coff_header_opt.sect_alignment,
8207db8b5c4SPavel Labath         /*flags*/ 0);
821f1e0ae34SPavel Labath     header_sp->SetPermissions(ePermissionsReadable);
82273a7a55cSPavel Labath     m_sections_up->AddSection(header_sp);
82373a7a55cSPavel Labath     unified_section_list.AddSection(header_sp);
8247db8b5c4SPavel Labath 
825f754f88fSGreg Clayton     const uint32_t nsects = m_sect_headers.size();
826e72dfb32SGreg Clayton     ModuleSP module_sp(GetModule());
827b9c1b51eSKate Stone     for (uint32_t idx = 0; idx < nsects; ++idx) {
8282e5bb6d8SMartin Storsjö       llvm::StringRef sect_name = GetSectionName(m_sect_headers[idx]);
8292e5bb6d8SMartin Storsjö       ConstString const_sect_name(sect_name);
8302e5bb6d8SMartin Storsjö       SectionType section_type = GetSectionType(sect_name, m_sect_headers[idx]);
831f754f88fSGreg Clayton 
832b9c1b51eSKate Stone       SectionSP section_sp(new Section(
833b9c1b51eSKate Stone           module_sp,       // Module to which this section belongs
834a7499c98SMichael Sartain           this,            // Object file to which this section belongs
8357db8b5c4SPavel Labath           idx + 1,         // Section ID is the 1 based section index.
836f754f88fSGreg Clayton           const_sect_name, // Name of this section
8377db8b5c4SPavel Labath           section_type,
83873a7a55cSPavel Labath           m_coff_header_opt.image_base +
839b9c1b51eSKate Stone               m_sect_headers[idx].vmaddr, // File VM address == addresses as
840b9c1b51eSKate Stone                                           // they are found in the object file
841f754f88fSGreg Clayton           m_sect_headers[idx].vmsize,     // VM size in bytes of this section
842b9c1b51eSKate Stone           m_sect_headers[idx]
843b9c1b51eSKate Stone               .offset, // Offset to the data for this section in the file
844b9c1b51eSKate Stone           m_sect_headers[idx]
845b9c1b51eSKate Stone               .size, // Size in bytes of this section as found in the file
84648672afbSGreg Clayton           m_coff_header_opt.sect_alignment, // Section alignment
847f754f88fSGreg Clayton           m_sect_headers[idx].flags));      // Flags for this section
848f754f88fSGreg Clayton 
849f1e0ae34SPavel Labath       uint32_t permissions = 0;
850f1e0ae34SPavel Labath       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_EXECUTE)
851f1e0ae34SPavel Labath         permissions |= ePermissionsExecutable;
852f1e0ae34SPavel Labath       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_READ)
853f1e0ae34SPavel Labath         permissions |= ePermissionsReadable;
854f1e0ae34SPavel Labath       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_WRITE)
855f1e0ae34SPavel Labath         permissions |= ePermissionsWritable;
856f1e0ae34SPavel Labath       section_sp->SetPermissions(permissions);
857f1e0ae34SPavel Labath 
85873a7a55cSPavel Labath       m_sections_up->AddSection(section_sp);
85973a7a55cSPavel Labath       unified_section_list.AddSection(section_sp);
860f754f88fSGreg Clayton     }
861f754f88fSGreg Clayton   }
862a1743499SGreg Clayton }
863f754f88fSGreg Clayton 
864b8d03935SAaron Smith UUID ObjectFilePECOFF::GetUUID() {
865b8d03935SAaron Smith   if (m_uuid.IsValid())
866b8d03935SAaron Smith     return m_uuid;
867b8d03935SAaron Smith 
868b8d03935SAaron Smith   if (!CreateBinary())
869b8d03935SAaron Smith     return UUID();
870b8d03935SAaron Smith 
871d372a8e8SPavel Labath   m_uuid = GetCoffUUID(*m_binary);
872b8d03935SAaron Smith   return m_uuid;
873b8d03935SAaron Smith }
874f754f88fSGreg Clayton 
875037ed1beSAaron Smith uint32_t ObjectFilePECOFF::ParseDependentModules() {
876037ed1beSAaron Smith   ModuleSP module_sp(GetModule());
877037ed1beSAaron Smith   if (!module_sp)
878f754f88fSGreg Clayton     return 0;
879037ed1beSAaron Smith 
880037ed1beSAaron Smith   std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
881037ed1beSAaron Smith   if (m_deps_filespec)
882037ed1beSAaron Smith     return m_deps_filespec->GetSize();
883037ed1beSAaron Smith 
884037ed1beSAaron Smith   // Cache coff binary if it is not done yet.
885037ed1beSAaron Smith   if (!CreateBinary())
886037ed1beSAaron Smith     return 0;
887037ed1beSAaron Smith 
888a007a6d8SPavel Labath   Log *log = GetLog(LLDBLog::Object);
889d372a8e8SPavel Labath   LLDB_LOG(log, "this = {0}, module = {1} ({2}), file = {3}, binary = {4}",
890d372a8e8SPavel Labath            this, GetModule().get(), GetModule()->GetSpecificationDescription(),
891d372a8e8SPavel Labath            m_file.GetPath(), m_binary.get());
892037ed1beSAaron Smith 
893037ed1beSAaron Smith   m_deps_filespec = FileSpecList();
894037ed1beSAaron Smith 
895d372a8e8SPavel Labath   for (const auto &entry : m_binary->import_directories()) {
896037ed1beSAaron Smith     llvm::StringRef dll_name;
897037ed1beSAaron Smith     // Report a bogus entry.
8981c03389cSReid Kleckner     if (llvm::Error e = entry.getName(dll_name)) {
89963e5fb76SJonas Devlieghere       LLDB_LOGF(log,
90063e5fb76SJonas Devlieghere                 "ObjectFilePECOFF::ParseDependentModules() - failed to get "
901037ed1beSAaron Smith                 "import directory entry name: %s",
9021c03389cSReid Kleckner                 llvm::toString(std::move(e)).c_str());
903037ed1beSAaron Smith       continue;
904037ed1beSAaron Smith     }
905037ed1beSAaron Smith 
906037ed1beSAaron Smith     // At this moment we only have the base name of the DLL. The full path can
907037ed1beSAaron Smith     // only be seen after the dynamic loading.  Our best guess is Try to get it
908037ed1beSAaron Smith     // with the help of the object file's directory.
909b3f44ad9SStella Stamenova     llvm::SmallString<128> dll_fullpath;
910037ed1beSAaron Smith     FileSpec dll_specs(dll_name);
911037ed1beSAaron Smith     dll_specs.GetDirectory().SetString(m_file.GetDirectory().GetCString());
912037ed1beSAaron Smith 
913037ed1beSAaron Smith     if (!llvm::sys::fs::real_path(dll_specs.GetPath(), dll_fullpath))
914f893d5bfSJonas Devlieghere       m_deps_filespec->EmplaceBack(dll_fullpath);
915037ed1beSAaron Smith     else {
916037ed1beSAaron Smith       // Known DLLs or DLL not found in the object file directory.
917f893d5bfSJonas Devlieghere       m_deps_filespec->EmplaceBack(dll_name);
918037ed1beSAaron Smith     }
919037ed1beSAaron Smith   }
920037ed1beSAaron Smith   return m_deps_filespec->GetSize();
921037ed1beSAaron Smith }
922037ed1beSAaron Smith 
923037ed1beSAaron Smith uint32_t ObjectFilePECOFF::GetDependentModules(FileSpecList &files) {
924037ed1beSAaron Smith   auto num_modules = ParseDependentModules();
925037ed1beSAaron Smith   auto original_size = files.GetSize();
926037ed1beSAaron Smith 
927037ed1beSAaron Smith   for (unsigned i = 0; i < num_modules; ++i)
928037ed1beSAaron Smith     files.AppendIfUnique(m_deps_filespec->GetFileSpecAtIndex(i));
929037ed1beSAaron Smith 
930037ed1beSAaron Smith   return files.GetSize() - original_size;
931f754f88fSGreg Clayton }
932f754f88fSGreg Clayton 
933b9c1b51eSKate Stone lldb_private::Address ObjectFilePECOFF::GetEntryPointAddress() {
9348e38c666SStephane Sezer   if (m_entry_point_address.IsValid())
9358e38c666SStephane Sezer     return m_entry_point_address;
9368e38c666SStephane Sezer 
9378e38c666SStephane Sezer   if (!ParseHeader() || !IsExecutable())
9388e38c666SStephane Sezer     return m_entry_point_address;
9398e38c666SStephane Sezer 
9408e38c666SStephane Sezer   SectionList *section_list = GetSectionList();
941a5235af9SAleksandr Urakov   addr_t file_addr = m_coff_header_opt.entry + m_coff_header_opt.image_base;
9428e38c666SStephane Sezer 
9438e38c666SStephane Sezer   if (!section_list)
944a5235af9SAleksandr Urakov     m_entry_point_address.SetOffset(file_addr);
9458e38c666SStephane Sezer   else
946b8d03935SAaron Smith     m_entry_point_address.ResolveAddressUsingFileSections(file_addr,
947b8d03935SAaron Smith                                                           section_list);
9488e38c666SStephane Sezer   return m_entry_point_address;
9498e38c666SStephane Sezer }
9508e38c666SStephane Sezer 
951d1304bbaSPavel Labath Address ObjectFilePECOFF::GetBaseAddress() {
952d1304bbaSPavel Labath   return Address(GetSectionList()->GetSectionAtIndex(0), 0);
953d1304bbaSPavel Labath }
954d1304bbaSPavel Labath 
955f754f88fSGreg Clayton // Dump
956f754f88fSGreg Clayton //
957f754f88fSGreg Clayton // Dump the specifics of the runtime file container (such as any headers
958f754f88fSGreg Clayton // segments, sections, etc).
959b9c1b51eSKate Stone void ObjectFilePECOFF::Dump(Stream *s) {
960a1743499SGreg Clayton   ModuleSP module_sp(GetModule());
961b9c1b51eSKate Stone   if (module_sp) {
96216ff8604SSaleem Abdulrasool     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
963324a1036SSaleem Abdulrasool     s->Printf("%p: ", static_cast<void *>(this));
964f754f88fSGreg Clayton     s->Indent();
965f754f88fSGreg Clayton     s->PutCString("ObjectFilePECOFF");
966f754f88fSGreg Clayton 
967f760f5aeSPavel Labath     ArchSpec header_arch = GetArchitecture();
968f754f88fSGreg Clayton 
969b9c1b51eSKate Stone     *s << ", file = '" << m_file
970b9c1b51eSKate Stone        << "', arch = " << header_arch.GetArchitectureName() << "\n";
971f754f88fSGreg Clayton 
9723046e668SGreg Clayton     SectionList *sections = GetSectionList();
9733046e668SGreg Clayton     if (sections)
9743a168297SPavel Labath       sections->Dump(s->AsRawOstream(), s->GetIndentLevel(), nullptr, true,
9753a168297SPavel Labath                      UINT32_MAX);
976f754f88fSGreg Clayton 
977d5b44036SJonas Devlieghere     if (m_symtab_up)
978248a1305SKonrad Kleine       m_symtab_up->Dump(s, nullptr, eSortOrderNone);
979f754f88fSGreg Clayton 
980f754f88fSGreg Clayton     if (m_dos_header.e_magic)
981f754f88fSGreg Clayton       DumpDOSHeader(s, m_dos_header);
982b9c1b51eSKate Stone     if (m_coff_header.machine) {
983f754f88fSGreg Clayton       DumpCOFFHeader(s, m_coff_header);
984f754f88fSGreg Clayton       if (m_coff_header.hdrsize)
985f754f88fSGreg Clayton         DumpOptCOFFHeader(s, m_coff_header_opt);
986f754f88fSGreg Clayton     }
987f754f88fSGreg Clayton     s->EOL();
988f754f88fSGreg Clayton     DumpSectionHeaders(s);
989f754f88fSGreg Clayton     s->EOL();
990037ed1beSAaron Smith 
991037ed1beSAaron Smith     DumpDependentModules(s);
992037ed1beSAaron Smith     s->EOL();
993f754f88fSGreg Clayton   }
994a1743499SGreg Clayton }
995f754f88fSGreg Clayton 
996f754f88fSGreg Clayton // DumpDOSHeader
997f754f88fSGreg Clayton //
998f754f88fSGreg Clayton // Dump the MS-DOS header to the specified output stream
999b9c1b51eSKate Stone void ObjectFilePECOFF::DumpDOSHeader(Stream *s, const dos_header_t &header) {
1000f754f88fSGreg Clayton   s->PutCString("MSDOS Header\n");
1001f754f88fSGreg Clayton   s->Printf("  e_magic    = 0x%4.4x\n", header.e_magic);
1002f754f88fSGreg Clayton   s->Printf("  e_cblp     = 0x%4.4x\n", header.e_cblp);
1003f754f88fSGreg Clayton   s->Printf("  e_cp       = 0x%4.4x\n", header.e_cp);
1004f754f88fSGreg Clayton   s->Printf("  e_crlc     = 0x%4.4x\n", header.e_crlc);
1005f754f88fSGreg Clayton   s->Printf("  e_cparhdr  = 0x%4.4x\n", header.e_cparhdr);
1006f754f88fSGreg Clayton   s->Printf("  e_minalloc = 0x%4.4x\n", header.e_minalloc);
1007f754f88fSGreg Clayton   s->Printf("  e_maxalloc = 0x%4.4x\n", header.e_maxalloc);
1008f754f88fSGreg Clayton   s->Printf("  e_ss       = 0x%4.4x\n", header.e_ss);
1009f754f88fSGreg Clayton   s->Printf("  e_sp       = 0x%4.4x\n", header.e_sp);
1010f754f88fSGreg Clayton   s->Printf("  e_csum     = 0x%4.4x\n", header.e_csum);
1011f754f88fSGreg Clayton   s->Printf("  e_ip       = 0x%4.4x\n", header.e_ip);
1012f754f88fSGreg Clayton   s->Printf("  e_cs       = 0x%4.4x\n", header.e_cs);
1013f754f88fSGreg Clayton   s->Printf("  e_lfarlc   = 0x%4.4x\n", header.e_lfarlc);
1014f754f88fSGreg Clayton   s->Printf("  e_ovno     = 0x%4.4x\n", header.e_ovno);
1015f754f88fSGreg Clayton   s->Printf("  e_res[4]   = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n",
1016b9c1b51eSKate Stone             header.e_res[0], header.e_res[1], header.e_res[2], header.e_res[3]);
1017f754f88fSGreg Clayton   s->Printf("  e_oemid    = 0x%4.4x\n", header.e_oemid);
1018f754f88fSGreg Clayton   s->Printf("  e_oeminfo  = 0x%4.4x\n", header.e_oeminfo);
1019b9c1b51eSKate Stone   s->Printf("  e_res2[10] = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, "
1020b9c1b51eSKate Stone             "0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n",
1021b9c1b51eSKate Stone             header.e_res2[0], header.e_res2[1], header.e_res2[2],
1022b9c1b51eSKate Stone             header.e_res2[3], header.e_res2[4], header.e_res2[5],
1023b9c1b51eSKate Stone             header.e_res2[6], header.e_res2[7], header.e_res2[8],
1024f754f88fSGreg Clayton             header.e_res2[9]);
1025f754f88fSGreg Clayton   s->Printf("  e_lfanew   = 0x%8.8x\n", header.e_lfanew);
1026f754f88fSGreg Clayton }
1027f754f88fSGreg Clayton 
1028f754f88fSGreg Clayton // DumpCOFFHeader
1029f754f88fSGreg Clayton //
1030f754f88fSGreg Clayton // Dump the COFF header to the specified output stream
1031b9c1b51eSKate Stone void ObjectFilePECOFF::DumpCOFFHeader(Stream *s, const coff_header_t &header) {
1032f754f88fSGreg Clayton   s->PutCString("COFF Header\n");
1033f754f88fSGreg Clayton   s->Printf("  machine = 0x%4.4x\n", header.machine);
1034f754f88fSGreg Clayton   s->Printf("  nsects  = 0x%4.4x\n", header.nsects);
1035f754f88fSGreg Clayton   s->Printf("  modtime = 0x%8.8x\n", header.modtime);
1036f754f88fSGreg Clayton   s->Printf("  symoff  = 0x%8.8x\n", header.symoff);
1037f754f88fSGreg Clayton   s->Printf("  nsyms   = 0x%8.8x\n", header.nsyms);
1038f754f88fSGreg Clayton   s->Printf("  hdrsize = 0x%4.4x\n", header.hdrsize);
1039f754f88fSGreg Clayton }
1040f754f88fSGreg Clayton 
1041f754f88fSGreg Clayton // DumpOptCOFFHeader
1042f754f88fSGreg Clayton //
1043f754f88fSGreg Clayton // Dump the optional COFF header to the specified output stream
1044b9c1b51eSKate Stone void ObjectFilePECOFF::DumpOptCOFFHeader(Stream *s,
1045b9c1b51eSKate Stone                                          const coff_opt_header_t &header) {
1046f754f88fSGreg Clayton   s->PutCString("Optional COFF Header\n");
1047f754f88fSGreg Clayton   s->Printf("  magic                   = 0x%4.4x\n", header.magic);
1048b9c1b51eSKate Stone   s->Printf("  major_linker_version    = 0x%2.2x\n",
1049b9c1b51eSKate Stone             header.major_linker_version);
1050b9c1b51eSKate Stone   s->Printf("  minor_linker_version    = 0x%2.2x\n",
1051b9c1b51eSKate Stone             header.minor_linker_version);
1052f754f88fSGreg Clayton   s->Printf("  code_size               = 0x%8.8x\n", header.code_size);
1053f754f88fSGreg Clayton   s->Printf("  data_size               = 0x%8.8x\n", header.data_size);
1054f754f88fSGreg Clayton   s->Printf("  bss_size                = 0x%8.8x\n", header.bss_size);
1055f754f88fSGreg Clayton   s->Printf("  entry                   = 0x%8.8x\n", header.entry);
1056f754f88fSGreg Clayton   s->Printf("  code_offset             = 0x%8.8x\n", header.code_offset);
1057f754f88fSGreg Clayton   s->Printf("  data_offset             = 0x%8.8x\n", header.data_offset);
1058b9c1b51eSKate Stone   s->Printf("  image_base              = 0x%16.16" PRIx64 "\n",
1059b9c1b51eSKate Stone             header.image_base);
1060f754f88fSGreg Clayton   s->Printf("  sect_alignment          = 0x%8.8x\n", header.sect_alignment);
1061f754f88fSGreg Clayton   s->Printf("  file_alignment          = 0x%8.8x\n", header.file_alignment);
1062b9c1b51eSKate Stone   s->Printf("  major_os_system_version = 0x%4.4x\n",
1063b9c1b51eSKate Stone             header.major_os_system_version);
1064b9c1b51eSKate Stone   s->Printf("  minor_os_system_version = 0x%4.4x\n",
1065b9c1b51eSKate Stone             header.minor_os_system_version);
1066b9c1b51eSKate Stone   s->Printf("  major_image_version     = 0x%4.4x\n",
1067b9c1b51eSKate Stone             header.major_image_version);
1068b9c1b51eSKate Stone   s->Printf("  minor_image_version     = 0x%4.4x\n",
1069b9c1b51eSKate Stone             header.minor_image_version);
1070b9c1b51eSKate Stone   s->Printf("  major_subsystem_version = 0x%4.4x\n",
1071b9c1b51eSKate Stone             header.major_subsystem_version);
1072b9c1b51eSKate Stone   s->Printf("  minor_subsystem_version = 0x%4.4x\n",
1073b9c1b51eSKate Stone             header.minor_subsystem_version);
1074f754f88fSGreg Clayton   s->Printf("  reserved1               = 0x%8.8x\n", header.reserved1);
1075f754f88fSGreg Clayton   s->Printf("  image_size              = 0x%8.8x\n", header.image_size);
1076f754f88fSGreg Clayton   s->Printf("  header_size             = 0x%8.8x\n", header.header_size);
107728469ca3SGreg Clayton   s->Printf("  checksum                = 0x%8.8x\n", header.checksum);
1078f754f88fSGreg Clayton   s->Printf("  subsystem               = 0x%4.4x\n", header.subsystem);
1079f754f88fSGreg Clayton   s->Printf("  dll_flags               = 0x%4.4x\n", header.dll_flags);
1080b9c1b51eSKate Stone   s->Printf("  stack_reserve_size      = 0x%16.16" PRIx64 "\n",
1081b9c1b51eSKate Stone             header.stack_reserve_size);
1082b9c1b51eSKate Stone   s->Printf("  stack_commit_size       = 0x%16.16" PRIx64 "\n",
1083b9c1b51eSKate Stone             header.stack_commit_size);
1084b9c1b51eSKate Stone   s->Printf("  heap_reserve_size       = 0x%16.16" PRIx64 "\n",
1085b9c1b51eSKate Stone             header.heap_reserve_size);
1086b9c1b51eSKate Stone   s->Printf("  heap_commit_size        = 0x%16.16" PRIx64 "\n",
1087b9c1b51eSKate Stone             header.heap_commit_size);
1088f754f88fSGreg Clayton   s->Printf("  loader_flags            = 0x%8.8x\n", header.loader_flags);
1089b9c1b51eSKate Stone   s->Printf("  num_data_dir_entries    = 0x%8.8x\n",
1090b9c1b51eSKate Stone             (uint32_t)header.data_dirs.size());
1091f754f88fSGreg Clayton   uint32_t i;
1092b9c1b51eSKate Stone   for (i = 0; i < header.data_dirs.size(); i++) {
1093b9c1b51eSKate Stone     s->Printf("  data_dirs[%2u] vmaddr = 0x%8.8x, vmsize = 0x%8.8x\n", i,
1094b9c1b51eSKate Stone               header.data_dirs[i].vmaddr, header.data_dirs[i].vmsize);
1095f754f88fSGreg Clayton   }
1096f754f88fSGreg Clayton }
1097f754f88fSGreg Clayton // DumpSectionHeader
1098f754f88fSGreg Clayton //
1099f754f88fSGreg Clayton // Dump a single ELF section header to the specified output stream
1100b9c1b51eSKate Stone void ObjectFilePECOFF::DumpSectionHeader(Stream *s,
1101b9c1b51eSKate Stone                                          const section_header_t &sh) {
1102adcd0268SBenjamin Kramer   std::string name = std::string(GetSectionName(sh));
1103b9c1b51eSKate 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 "
1104b9c1b51eSKate Stone             "0x%4.4x 0x%8.8x\n",
1105b9c1b51eSKate Stone             name.c_str(), sh.vmaddr, sh.vmsize, sh.offset, sh.size, sh.reloff,
1106b9c1b51eSKate Stone             sh.lineoff, sh.nreloc, sh.nline, sh.flags);
1107f754f88fSGreg Clayton }
1108f754f88fSGreg Clayton 
1109f754f88fSGreg Clayton // DumpSectionHeaders
1110f754f88fSGreg Clayton //
1111f754f88fSGreg Clayton // Dump all of the ELF section header to the specified output stream
1112b9c1b51eSKate Stone void ObjectFilePECOFF::DumpSectionHeaders(Stream *s) {
1113f754f88fSGreg Clayton 
1114f754f88fSGreg Clayton   s->PutCString("Section Headers\n");
1115b9c1b51eSKate Stone   s->PutCString("IDX  name             vm addr    vm size    file off   file "
1116b9c1b51eSKate Stone                 "size  reloc off  line off   nreloc nline  flags\n");
1117b9c1b51eSKate Stone   s->PutCString("==== ---------------- ---------- ---------- ---------- "
1118b9c1b51eSKate Stone                 "---------- ---------- ---------- ------ ------ ----------\n");
1119f754f88fSGreg Clayton 
1120f754f88fSGreg Clayton   uint32_t idx = 0;
1121f754f88fSGreg Clayton   SectionHeaderCollIter pos, end = m_sect_headers.end();
1122f754f88fSGreg Clayton 
1123b9c1b51eSKate Stone   for (pos = m_sect_headers.begin(); pos != end; ++pos, ++idx) {
1124f754f88fSGreg Clayton     s->Printf("[%2u] ", idx);
1125f754f88fSGreg Clayton     ObjectFilePECOFF::DumpSectionHeader(s, *pos);
1126f754f88fSGreg Clayton   }
1127f754f88fSGreg Clayton }
1128f754f88fSGreg Clayton 
1129037ed1beSAaron Smith // DumpDependentModules
1130037ed1beSAaron Smith //
1131037ed1beSAaron Smith // Dump all of the dependent modules to the specified output stream
1132037ed1beSAaron Smith void ObjectFilePECOFF::DumpDependentModules(lldb_private::Stream *s) {
1133037ed1beSAaron Smith   auto num_modules = ParseDependentModules();
1134037ed1beSAaron Smith   if (num_modules > 0) {
1135037ed1beSAaron Smith     s->PutCString("Dependent Modules\n");
1136037ed1beSAaron Smith     for (unsigned i = 0; i < num_modules; ++i) {
1137037ed1beSAaron Smith       auto spec = m_deps_filespec->GetFileSpecAtIndex(i);
1138037ed1beSAaron Smith       s->Printf("  %s\n", spec.GetFilename().GetCString());
1139037ed1beSAaron Smith     }
1140037ed1beSAaron Smith   }
1141037ed1beSAaron Smith }
1142037ed1beSAaron Smith 
1143fb3b3bd1SZachary Turner bool ObjectFilePECOFF::IsWindowsSubsystem() {
1144fb3b3bd1SZachary Turner   switch (m_coff_header_opt.subsystem) {
1145fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE:
1146fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_GUI:
1147fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CUI:
1148fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE_WINDOWS:
1149fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CE_GUI:
1150fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_XBOX:
1151fb3b3bd1SZachary Turner   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION:
1152fb3b3bd1SZachary Turner     return true;
1153fb3b3bd1SZachary Turner   default:
1154fb3b3bd1SZachary Turner     return false;
1155fb3b3bd1SZachary Turner   }
1156fb3b3bd1SZachary Turner }
1157fb3b3bd1SZachary Turner 
1158f760f5aeSPavel Labath ArchSpec ObjectFilePECOFF::GetArchitecture() {
1159237ad974SCharles Davis   uint16_t machine = m_coff_header.machine;
1160b9c1b51eSKate Stone   switch (machine) {
1161f760f5aeSPavel Labath   default:
1162f760f5aeSPavel Labath     break;
1163237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_AMD64:
1164237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_I386:
1165237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_POWERPC:
1166237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_POWERPCFP:
1167237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_ARM:
11681108cb36SSaleem Abdulrasool   case llvm::COFF::IMAGE_FILE_MACHINE_ARMNT:
1169237ad974SCharles Davis   case llvm::COFF::IMAGE_FILE_MACHINE_THUMB:
1170638f072fSMartin Storsjo   case llvm::COFF::IMAGE_FILE_MACHINE_ARM64:
1171f760f5aeSPavel Labath     ArchSpec arch;
1172fb3b3bd1SZachary Turner     arch.SetArchitecture(eArchTypeCOFF, machine, LLDB_INVALID_CPUTYPE,
1173fb3b3bd1SZachary Turner                          IsWindowsSubsystem() ? llvm::Triple::Win32
1174fb3b3bd1SZachary Turner                                               : llvm::Triple::UnknownOS);
1175f760f5aeSPavel Labath     return arch;
1176237ad974SCharles Davis   }
1177f760f5aeSPavel Labath   return ArchSpec();
1178f754f88fSGreg Clayton }
1179f754f88fSGreg Clayton 
1180b9c1b51eSKate Stone ObjectFile::Type ObjectFilePECOFF::CalculateType() {
1181b9c1b51eSKate Stone   if (m_coff_header.machine != 0) {
1182237ad974SCharles Davis     if ((m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0)
1183f754f88fSGreg Clayton       return eTypeExecutable;
1184f754f88fSGreg Clayton     else
1185f754f88fSGreg Clayton       return eTypeSharedLibrary;
1186f754f88fSGreg Clayton   }
1187f754f88fSGreg Clayton   return eTypeExecutable;
1188f754f88fSGreg Clayton }
1189f754f88fSGreg Clayton 
1190b9c1b51eSKate Stone ObjectFile::Strata ObjectFilePECOFF::CalculateStrata() { return eStrataUser; }
1191