1 //===-- ObjectFilePECOFF.cpp ----------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "ObjectFilePECOFF.h"
10 #include "PECallFrameInfo.h"
11 #include "WindowsMiniDump.h"
12 
13 #include "lldb/Core/FileSpecList.h"
14 #include "lldb/Core/Module.h"
15 #include "lldb/Core/ModuleSpec.h"
16 #include "lldb/Core/PluginManager.h"
17 #include "lldb/Core/Section.h"
18 #include "lldb/Core/StreamFile.h"
19 #include "lldb/Symbol/ObjectFile.h"
20 #include "lldb/Target/Process.h"
21 #include "lldb/Target/SectionLoadList.h"
22 #include "lldb/Target/Target.h"
23 #include "lldb/Utility/ArchSpec.h"
24 #include "lldb/Utility/DataBufferHeap.h"
25 #include "lldb/Utility/FileSpec.h"
26 #include "lldb/Utility/Log.h"
27 #include "lldb/Utility/StreamString.h"
28 #include "lldb/Utility/Timer.h"
29 #include "lldb/Utility/UUID.h"
30 #include "llvm/BinaryFormat/COFF.h"
31 
32 #include "llvm/Object/COFFImportFile.h"
33 #include "llvm/Support/Error.h"
34 #include "llvm/Support/MemoryBuffer.h"
35 
36 #define IMAGE_DOS_SIGNATURE 0x5A4D    // MZ
37 #define IMAGE_NT_SIGNATURE 0x00004550 // PE00
38 #define OPT_HEADER_MAGIC_PE32 0x010b
39 #define OPT_HEADER_MAGIC_PE32_PLUS 0x020b
40 
41 using namespace lldb;
42 using namespace lldb_private;
43 
44 LLDB_PLUGIN_DEFINE(ObjectFilePECOFF)
45 
46 struct CVInfoPdb70 {
47   // 16-byte GUID
48   struct _Guid {
49     llvm::support::ulittle32_t Data1;
50     llvm::support::ulittle16_t Data2;
51     llvm::support::ulittle16_t Data3;
52     uint8_t Data4[8];
53   } Guid;
54 
55   llvm::support::ulittle32_t Age;
56 };
57 
58 static UUID GetCoffUUID(llvm::object::COFFObjectFile &coff_obj) {
59   const llvm::codeview::DebugInfo *pdb_info = nullptr;
60   llvm::StringRef pdb_file;
61 
62   // This part is similar with what has done in minidump parser.
63   if (!coff_obj.getDebugPDBInfo(pdb_info, pdb_file) && pdb_info) {
64     if (pdb_info->PDB70.CVSignature == llvm::OMF::Signature::PDB70) {
65       using llvm::support::endian::read16be;
66       using llvm::support::endian::read32be;
67 
68       const uint8_t *sig = pdb_info->PDB70.Signature;
69       struct CVInfoPdb70 info;
70       info.Guid.Data1 = read32be(sig);
71       sig += 4;
72       info.Guid.Data2 = read16be(sig);
73       sig += 2;
74       info.Guid.Data3 = read16be(sig);
75       sig += 2;
76       memcpy(info.Guid.Data4, sig, 8);
77 
78       // Return 20-byte UUID if the Age is not zero
79       if (pdb_info->PDB70.Age) {
80         info.Age = read32be(&pdb_info->PDB70.Age);
81         return UUID::fromOptionalData(&info, sizeof(info));
82       }
83       // Otherwise return 16-byte GUID
84       return UUID::fromOptionalData(&info.Guid, sizeof(info.Guid));
85     }
86   }
87 
88   return UUID();
89 }
90 
91 char ObjectFilePECOFF::ID;
92 
93 void ObjectFilePECOFF::Initialize() {
94   PluginManager::RegisterPlugin(
95       GetPluginNameStatic(), GetPluginDescriptionStatic(), CreateInstance,
96       CreateMemoryInstance, GetModuleSpecifications, SaveCore);
97 }
98 
99 void ObjectFilePECOFF::Terminate() {
100   PluginManager::UnregisterPlugin(CreateInstance);
101 }
102 
103 lldb_private::ConstString ObjectFilePECOFF::GetPluginNameStatic() {
104   static ConstString g_name("pe-coff");
105   return g_name;
106 }
107 
108 const char *ObjectFilePECOFF::GetPluginDescriptionStatic() {
109   return "Portable Executable and Common Object File Format object file reader "
110          "(32 and 64 bit)";
111 }
112 
113 ObjectFile *ObjectFilePECOFF::CreateInstance(const lldb::ModuleSP &module_sp,
114                                              DataBufferSP &data_sp,
115                                              lldb::offset_t data_offset,
116                                              const lldb_private::FileSpec *file_p,
117                                              lldb::offset_t file_offset,
118                                              lldb::offset_t length) {
119   FileSpec file = file_p ? *file_p : FileSpec();
120   if (!data_sp) {
121     data_sp = MapFileData(file, length, file_offset);
122     if (!data_sp)
123       return nullptr;
124     data_offset = 0;
125   }
126 
127   if (!ObjectFilePECOFF::MagicBytesMatch(data_sp))
128     return nullptr;
129 
130   // Update the data to contain the entire file if it doesn't already
131   if (data_sp->GetByteSize() < length) {
132     data_sp = MapFileData(file, length, file_offset);
133     if (!data_sp)
134       return nullptr;
135   }
136 
137   auto objfile_up = std::make_unique<ObjectFilePECOFF>(
138       module_sp, data_sp, data_offset, file_p, file_offset, length);
139   if (!objfile_up || !objfile_up->ParseHeader())
140     return nullptr;
141 
142   // Cache coff binary.
143   if (!objfile_up->CreateBinary())
144     return nullptr;
145 
146   return objfile_up.release();
147 }
148 
149 ObjectFile *ObjectFilePECOFF::CreateMemoryInstance(
150     const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
151     const lldb::ProcessSP &process_sp, lldb::addr_t header_addr) {
152   if (!data_sp || !ObjectFilePECOFF::MagicBytesMatch(data_sp))
153     return nullptr;
154   auto objfile_up = std::make_unique<ObjectFilePECOFF>(
155       module_sp, data_sp, process_sp, header_addr);
156   if (objfile_up.get() && objfile_up->ParseHeader()) {
157     return objfile_up.release();
158   }
159   return nullptr;
160 }
161 
162 size_t ObjectFilePECOFF::GetModuleSpecifications(
163     const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp,
164     lldb::offset_t data_offset, lldb::offset_t file_offset,
165     lldb::offset_t length, lldb_private::ModuleSpecList &specs) {
166   const size_t initial_count = specs.GetSize();
167   if (!data_sp || !ObjectFilePECOFF::MagicBytesMatch(data_sp))
168     return initial_count;
169 
170   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
171 
172   if (DataBufferSP full_sp = MapFileData(file, -1, file_offset))
173     data_sp = std::move(full_sp);
174   auto binary = llvm::object::createBinary(llvm::MemoryBufferRef(
175       toStringRef(data_sp->GetData()), file.GetFilename().GetStringRef()));
176 
177   if (!binary) {
178     LLDB_LOG_ERROR(log, binary.takeError(),
179                    "Failed to create binary for file ({1}): {0}", file);
180     return initial_count;
181   }
182 
183   auto *COFFObj = llvm::dyn_cast<llvm::object::COFFObjectFile>(binary->get());
184   if (!COFFObj)
185     return initial_count;
186 
187   ModuleSpec module_spec(file);
188   ArchSpec &spec = module_spec.GetArchitecture();
189   lldb_private::UUID &uuid = module_spec.GetUUID();
190   if (!uuid.IsValid())
191     uuid = GetCoffUUID(*COFFObj);
192 
193   switch (COFFObj->getMachine()) {
194   case MachineAmd64:
195     spec.SetTriple("x86_64-pc-windows");
196     specs.Append(module_spec);
197     break;
198   case MachineX86:
199     spec.SetTriple("i386-pc-windows");
200     specs.Append(module_spec);
201     spec.SetTriple("i686-pc-windows");
202     specs.Append(module_spec);
203     break;
204   case MachineArmNt:
205     spec.SetTriple("armv7-pc-windows");
206     specs.Append(module_spec);
207     break;
208   case MachineArm64:
209     spec.SetTriple("aarch64-pc-windows");
210     specs.Append(module_spec);
211     break;
212   default:
213     break;
214   }
215 
216   return specs.GetSize() - initial_count;
217 }
218 
219 bool ObjectFilePECOFF::SaveCore(const lldb::ProcessSP &process_sp,
220                                 const lldb_private::FileSpec &outfile,
221                                 lldb_private::Status &error) {
222   return SaveMiniDump(process_sp, outfile, error);
223 }
224 
225 bool ObjectFilePECOFF::MagicBytesMatch(DataBufferSP &data_sp) {
226   DataExtractor data(data_sp, eByteOrderLittle, 4);
227   lldb::offset_t offset = 0;
228   uint16_t magic = data.GetU16(&offset);
229   return magic == IMAGE_DOS_SIGNATURE;
230 }
231 
232 lldb::SymbolType ObjectFilePECOFF::MapSymbolType(uint16_t coff_symbol_type) {
233   // TODO:  We need to complete this mapping of COFF symbol types to LLDB ones.
234   // For now, here's a hack to make sure our function have types.
235   const auto complex_type =
236       coff_symbol_type >> llvm::COFF::SCT_COMPLEX_TYPE_SHIFT;
237   if (complex_type == llvm::COFF::IMAGE_SYM_DTYPE_FUNCTION) {
238     return lldb::eSymbolTypeCode;
239   }
240   return lldb::eSymbolTypeInvalid;
241 }
242 
243 bool ObjectFilePECOFF::CreateBinary() {
244   if (m_binary)
245     return true;
246 
247   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
248 
249   auto binary = llvm::object::createBinary(llvm::MemoryBufferRef(
250       toStringRef(m_data.GetData()), m_file.GetFilename().GetStringRef()));
251   if (!binary) {
252     LLDB_LOG_ERROR(log, binary.takeError(),
253                    "Failed to create binary for file ({1}): {0}", m_file);
254     return false;
255   }
256 
257   // Make sure we only handle COFF format.
258   m_binary =
259       llvm::unique_dyn_cast<llvm::object::COFFObjectFile>(std::move(*binary));
260   if (!m_binary)
261     return false;
262 
263   LLDB_LOG(log, "this = {0}, module = {1} ({2}), file = {3}, binary = {4}",
264            this, GetModule().get(), GetModule()->GetSpecificationDescription(),
265            m_file.GetPath(), m_binary.get());
266   return true;
267 }
268 
269 ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
270                                    DataBufferSP &data_sp,
271                                    lldb::offset_t data_offset,
272                                    const FileSpec *file,
273                                    lldb::offset_t file_offset,
274                                    lldb::offset_t length)
275     : ObjectFile(module_sp, file, file_offset, length, data_sp, data_offset),
276       m_dos_header(), m_coff_header(), m_sect_headers(),
277       m_entry_point_address(), m_deps_filespec() {
278   ::memset(&m_dos_header, 0, sizeof(m_dos_header));
279   ::memset(&m_coff_header, 0, sizeof(m_coff_header));
280 }
281 
282 ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
283                                    DataBufferSP &header_data_sp,
284                                    const lldb::ProcessSP &process_sp,
285                                    addr_t header_addr)
286     : ObjectFile(module_sp, process_sp, header_addr, header_data_sp),
287       m_dos_header(), m_coff_header(), m_sect_headers(),
288       m_entry_point_address(), m_deps_filespec() {
289   ::memset(&m_dos_header, 0, sizeof(m_dos_header));
290   ::memset(&m_coff_header, 0, sizeof(m_coff_header));
291 }
292 
293 ObjectFilePECOFF::~ObjectFilePECOFF() {}
294 
295 bool ObjectFilePECOFF::ParseHeader() {
296   ModuleSP module_sp(GetModule());
297   if (module_sp) {
298     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
299     m_sect_headers.clear();
300     m_data.SetByteOrder(eByteOrderLittle);
301     lldb::offset_t offset = 0;
302 
303     if (ParseDOSHeader(m_data, m_dos_header)) {
304       offset = m_dos_header.e_lfanew;
305       uint32_t pe_signature = m_data.GetU32(&offset);
306       if (pe_signature != IMAGE_NT_SIGNATURE)
307         return false;
308       if (ParseCOFFHeader(m_data, &offset, m_coff_header)) {
309         if (m_coff_header.hdrsize > 0)
310           ParseCOFFOptionalHeader(&offset);
311         ParseSectionHeaders(offset);
312       }
313       m_data.SetAddressByteSize(GetAddressByteSize());
314       return true;
315     }
316   }
317   return false;
318 }
319 
320 bool ObjectFilePECOFF::SetLoadAddress(Target &target, addr_t value,
321                                       bool value_is_offset) {
322   bool changed = false;
323   ModuleSP module_sp = GetModule();
324   if (module_sp) {
325     size_t num_loaded_sections = 0;
326     SectionList *section_list = GetSectionList();
327     if (section_list) {
328       if (!value_is_offset) {
329         value -= m_image_base;
330       }
331 
332       const size_t num_sections = section_list->GetSize();
333       size_t sect_idx = 0;
334 
335       for (sect_idx = 0; sect_idx < num_sections; ++sect_idx) {
336         // Iterate through the object file sections to find all of the sections
337         // that have SHF_ALLOC in their flag bits.
338         SectionSP section_sp(section_list->GetSectionAtIndex(sect_idx));
339         if (section_sp && !section_sp->IsThreadSpecific()) {
340           if (target.GetSectionLoadList().SetSectionLoadAddress(
341                   section_sp, section_sp->GetFileAddress() + value))
342             ++num_loaded_sections;
343         }
344       }
345       changed = num_loaded_sections > 0;
346     }
347   }
348   return changed;
349 }
350 
351 ByteOrder ObjectFilePECOFF::GetByteOrder() const { return eByteOrderLittle; }
352 
353 bool ObjectFilePECOFF::IsExecutable() const {
354   return (m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0;
355 }
356 
357 uint32_t ObjectFilePECOFF::GetAddressByteSize() const {
358   if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32_PLUS)
359     return 8;
360   else if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32)
361     return 4;
362   return 4;
363 }
364 
365 // NeedsEndianSwap
366 //
367 // Return true if an endian swap needs to occur when extracting data from this
368 // file.
369 bool ObjectFilePECOFF::NeedsEndianSwap() const {
370 #if defined(__LITTLE_ENDIAN__)
371   return false;
372 #else
373   return true;
374 #endif
375 }
376 // ParseDOSHeader
377 bool ObjectFilePECOFF::ParseDOSHeader(DataExtractor &data,
378                                       dos_header_t &dos_header) {
379   bool success = false;
380   lldb::offset_t offset = 0;
381   success = data.ValidOffsetForDataOfSize(0, sizeof(dos_header));
382 
383   if (success) {
384     dos_header.e_magic = data.GetU16(&offset); // Magic number
385     success = dos_header.e_magic == IMAGE_DOS_SIGNATURE;
386 
387     if (success) {
388       dos_header.e_cblp = data.GetU16(&offset); // Bytes on last page of file
389       dos_header.e_cp = data.GetU16(&offset);   // Pages in file
390       dos_header.e_crlc = data.GetU16(&offset); // Relocations
391       dos_header.e_cparhdr =
392           data.GetU16(&offset); // Size of header in paragraphs
393       dos_header.e_minalloc =
394           data.GetU16(&offset); // Minimum extra paragraphs needed
395       dos_header.e_maxalloc =
396           data.GetU16(&offset);               // Maximum extra paragraphs needed
397       dos_header.e_ss = data.GetU16(&offset); // Initial (relative) SS value
398       dos_header.e_sp = data.GetU16(&offset); // Initial SP value
399       dos_header.e_csum = data.GetU16(&offset); // Checksum
400       dos_header.e_ip = data.GetU16(&offset);   // Initial IP value
401       dos_header.e_cs = data.GetU16(&offset);   // Initial (relative) CS value
402       dos_header.e_lfarlc =
403           data.GetU16(&offset); // File address of relocation table
404       dos_header.e_ovno = data.GetU16(&offset); // Overlay number
405 
406       dos_header.e_res[0] = data.GetU16(&offset); // Reserved words
407       dos_header.e_res[1] = data.GetU16(&offset); // Reserved words
408       dos_header.e_res[2] = data.GetU16(&offset); // Reserved words
409       dos_header.e_res[3] = data.GetU16(&offset); // Reserved words
410 
411       dos_header.e_oemid =
412           data.GetU16(&offset); // OEM identifier (for e_oeminfo)
413       dos_header.e_oeminfo =
414           data.GetU16(&offset); // OEM information; e_oemid specific
415       dos_header.e_res2[0] = data.GetU16(&offset); // Reserved words
416       dos_header.e_res2[1] = data.GetU16(&offset); // Reserved words
417       dos_header.e_res2[2] = data.GetU16(&offset); // Reserved words
418       dos_header.e_res2[3] = data.GetU16(&offset); // Reserved words
419       dos_header.e_res2[4] = data.GetU16(&offset); // Reserved words
420       dos_header.e_res2[5] = data.GetU16(&offset); // Reserved words
421       dos_header.e_res2[6] = data.GetU16(&offset); // Reserved words
422       dos_header.e_res2[7] = data.GetU16(&offset); // Reserved words
423       dos_header.e_res2[8] = data.GetU16(&offset); // Reserved words
424       dos_header.e_res2[9] = data.GetU16(&offset); // Reserved words
425 
426       dos_header.e_lfanew =
427           data.GetU32(&offset); // File address of new exe header
428     }
429   }
430   if (!success)
431     memset(&dos_header, 0, sizeof(dos_header));
432   return success;
433 }
434 
435 // ParserCOFFHeader
436 bool ObjectFilePECOFF::ParseCOFFHeader(DataExtractor &data,
437                                        lldb::offset_t *offset_ptr,
438                                        coff_header_t &coff_header) {
439   bool success =
440       data.ValidOffsetForDataOfSize(*offset_ptr, sizeof(coff_header));
441   if (success) {
442     coff_header.machine = data.GetU16(offset_ptr);
443     coff_header.nsects = data.GetU16(offset_ptr);
444     coff_header.modtime = data.GetU32(offset_ptr);
445     coff_header.symoff = data.GetU32(offset_ptr);
446     coff_header.nsyms = data.GetU32(offset_ptr);
447     coff_header.hdrsize = data.GetU16(offset_ptr);
448     coff_header.flags = data.GetU16(offset_ptr);
449   }
450   if (!success)
451     memset(&coff_header, 0, sizeof(coff_header));
452   return success;
453 }
454 
455 bool ObjectFilePECOFF::ParseCOFFOptionalHeader(lldb::offset_t *offset_ptr) {
456   bool success = false;
457   const lldb::offset_t end_offset = *offset_ptr + m_coff_header.hdrsize;
458   if (*offset_ptr < end_offset) {
459     success = true;
460     m_coff_header_opt.magic = m_data.GetU16(offset_ptr);
461     m_coff_header_opt.major_linker_version = m_data.GetU8(offset_ptr);
462     m_coff_header_opt.minor_linker_version = m_data.GetU8(offset_ptr);
463     m_coff_header_opt.code_size = m_data.GetU32(offset_ptr);
464     m_coff_header_opt.data_size = m_data.GetU32(offset_ptr);
465     m_coff_header_opt.bss_size = m_data.GetU32(offset_ptr);
466     m_coff_header_opt.entry = m_data.GetU32(offset_ptr);
467     m_coff_header_opt.code_offset = m_data.GetU32(offset_ptr);
468 
469     const uint32_t addr_byte_size = GetAddressByteSize();
470 
471     if (*offset_ptr < end_offset) {
472       if (m_coff_header_opt.magic == OPT_HEADER_MAGIC_PE32) {
473         // PE32 only
474         m_coff_header_opt.data_offset = m_data.GetU32(offset_ptr);
475       } else
476         m_coff_header_opt.data_offset = 0;
477 
478       if (*offset_ptr < end_offset) {
479         m_coff_header_opt.image_base =
480             m_data.GetMaxU64(offset_ptr, addr_byte_size);
481         m_coff_header_opt.sect_alignment = m_data.GetU32(offset_ptr);
482         m_coff_header_opt.file_alignment = m_data.GetU32(offset_ptr);
483         m_coff_header_opt.major_os_system_version = m_data.GetU16(offset_ptr);
484         m_coff_header_opt.minor_os_system_version = m_data.GetU16(offset_ptr);
485         m_coff_header_opt.major_image_version = m_data.GetU16(offset_ptr);
486         m_coff_header_opt.minor_image_version = m_data.GetU16(offset_ptr);
487         m_coff_header_opt.major_subsystem_version = m_data.GetU16(offset_ptr);
488         m_coff_header_opt.minor_subsystem_version = m_data.GetU16(offset_ptr);
489         m_coff_header_opt.reserved1 = m_data.GetU32(offset_ptr);
490         m_coff_header_opt.image_size = m_data.GetU32(offset_ptr);
491         m_coff_header_opt.header_size = m_data.GetU32(offset_ptr);
492         m_coff_header_opt.checksum = m_data.GetU32(offset_ptr);
493         m_coff_header_opt.subsystem = m_data.GetU16(offset_ptr);
494         m_coff_header_opt.dll_flags = m_data.GetU16(offset_ptr);
495         m_coff_header_opt.stack_reserve_size =
496             m_data.GetMaxU64(offset_ptr, addr_byte_size);
497         m_coff_header_opt.stack_commit_size =
498             m_data.GetMaxU64(offset_ptr, addr_byte_size);
499         m_coff_header_opt.heap_reserve_size =
500             m_data.GetMaxU64(offset_ptr, addr_byte_size);
501         m_coff_header_opt.heap_commit_size =
502             m_data.GetMaxU64(offset_ptr, addr_byte_size);
503         m_coff_header_opt.loader_flags = m_data.GetU32(offset_ptr);
504         uint32_t num_data_dir_entries = m_data.GetU32(offset_ptr);
505         m_coff_header_opt.data_dirs.clear();
506         m_coff_header_opt.data_dirs.resize(num_data_dir_entries);
507         uint32_t i;
508         for (i = 0; i < num_data_dir_entries; i++) {
509           m_coff_header_opt.data_dirs[i].vmaddr = m_data.GetU32(offset_ptr);
510           m_coff_header_opt.data_dirs[i].vmsize = m_data.GetU32(offset_ptr);
511         }
512 
513         m_image_base = m_coff_header_opt.image_base;
514       }
515     }
516   }
517   // Make sure we are on track for section data which follows
518   *offset_ptr = end_offset;
519   return success;
520 }
521 
522 uint32_t ObjectFilePECOFF::GetRVA(const Address &addr) const {
523   return addr.GetFileAddress() - m_image_base;
524 }
525 
526 Address ObjectFilePECOFF::GetAddress(uint32_t rva) {
527   SectionList *sect_list = GetSectionList();
528   if (!sect_list)
529     return Address(GetFileAddress(rva));
530 
531   return Address(GetFileAddress(rva), sect_list);
532 }
533 
534 lldb::addr_t ObjectFilePECOFF::GetFileAddress(uint32_t rva) const {
535   return m_image_base + rva;
536 }
537 
538 DataExtractor ObjectFilePECOFF::ReadImageData(uint32_t offset, size_t size) {
539   if (!size)
540     return {};
541 
542   if (m_file) {
543     // A bit of a hack, but we intend to write to this buffer, so we can't
544     // mmap it.
545     auto buffer_sp = MapFileData(m_file, size, offset);
546     return DataExtractor(buffer_sp, GetByteOrder(), GetAddressByteSize());
547   }
548   ProcessSP process_sp(m_process_wp.lock());
549   DataExtractor data;
550   if (process_sp) {
551     auto data_up = std::make_unique<DataBufferHeap>(size, 0);
552     Status readmem_error;
553     size_t bytes_read =
554         process_sp->ReadMemory(m_image_base + offset, data_up->GetBytes(),
555                                data_up->GetByteSize(), readmem_error);
556     if (bytes_read == size) {
557       DataBufferSP buffer_sp(data_up.release());
558       data.SetData(buffer_sp, 0, buffer_sp->GetByteSize());
559     }
560   }
561   return data;
562 }
563 
564 DataExtractor ObjectFilePECOFF::ReadImageDataByRVA(uint32_t rva, size_t size) {
565   if (m_file) {
566     Address addr = GetAddress(rva);
567     SectionSP sect = addr.GetSection();
568     if (!sect)
569       return {};
570     rva = sect->GetFileOffset() + addr.GetOffset();
571   }
572 
573   return ReadImageData(rva, size);
574 }
575 
576 // ParseSectionHeaders
577 bool ObjectFilePECOFF::ParseSectionHeaders(
578     uint32_t section_header_data_offset) {
579   const uint32_t nsects = m_coff_header.nsects;
580   m_sect_headers.clear();
581 
582   if (nsects > 0) {
583     const size_t section_header_byte_size = nsects * sizeof(section_header_t);
584     DataExtractor section_header_data =
585         ReadImageData(section_header_data_offset, section_header_byte_size);
586 
587     lldb::offset_t offset = 0;
588     if (section_header_data.ValidOffsetForDataOfSize(
589             offset, section_header_byte_size)) {
590       m_sect_headers.resize(nsects);
591 
592       for (uint32_t idx = 0; idx < nsects; ++idx) {
593         const void *name_data = section_header_data.GetData(&offset, 8);
594         if (name_data) {
595           memcpy(m_sect_headers[idx].name, name_data, 8);
596           m_sect_headers[idx].vmsize = section_header_data.GetU32(&offset);
597           m_sect_headers[idx].vmaddr = section_header_data.GetU32(&offset);
598           m_sect_headers[idx].size = section_header_data.GetU32(&offset);
599           m_sect_headers[idx].offset = section_header_data.GetU32(&offset);
600           m_sect_headers[idx].reloff = section_header_data.GetU32(&offset);
601           m_sect_headers[idx].lineoff = section_header_data.GetU32(&offset);
602           m_sect_headers[idx].nreloc = section_header_data.GetU16(&offset);
603           m_sect_headers[idx].nline = section_header_data.GetU16(&offset);
604           m_sect_headers[idx].flags = section_header_data.GetU32(&offset);
605         }
606       }
607     }
608   }
609 
610   return !m_sect_headers.empty();
611 }
612 
613 llvm::StringRef ObjectFilePECOFF::GetSectionName(const section_header_t &sect) {
614   llvm::StringRef hdr_name(sect.name, llvm::array_lengthof(sect.name));
615   hdr_name = hdr_name.split('\0').first;
616   if (hdr_name.consume_front("/")) {
617     lldb::offset_t stroff;
618     if (!to_integer(hdr_name, stroff, 10))
619       return "";
620     lldb::offset_t string_file_offset =
621         m_coff_header.symoff + (m_coff_header.nsyms * 18) + stroff;
622     if (const char *name = m_data.GetCStr(&string_file_offset))
623       return name;
624     return "";
625   }
626   return hdr_name;
627 }
628 
629 // GetNListSymtab
630 Symtab *ObjectFilePECOFF::GetSymtab() {
631   ModuleSP module_sp(GetModule());
632   if (module_sp) {
633     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
634     if (m_symtab_up == nullptr) {
635       SectionList *sect_list = GetSectionList();
636       m_symtab_up = std::make_unique<Symtab>(this);
637       std::lock_guard<std::recursive_mutex> guard(m_symtab_up->GetMutex());
638 
639       const uint32_t num_syms = m_coff_header.nsyms;
640 
641       if (m_file && num_syms > 0 && m_coff_header.symoff > 0) {
642         const uint32_t symbol_size = 18;
643         const size_t symbol_data_size = num_syms * symbol_size;
644         // Include the 4-byte string table size at the end of the symbols
645         DataExtractor symtab_data =
646             ReadImageData(m_coff_header.symoff, symbol_data_size + 4);
647         lldb::offset_t offset = symbol_data_size;
648         const uint32_t strtab_size = symtab_data.GetU32(&offset);
649         if (strtab_size > 0) {
650           DataExtractor strtab_data = ReadImageData(
651               m_coff_header.symoff + symbol_data_size, strtab_size);
652 
653           // First 4 bytes should be zeroed after strtab_size has been read,
654           // because it is used as offset 0 to encode a NULL string.
655           uint32_t *strtab_data_start = const_cast<uint32_t *>(
656               reinterpret_cast<const uint32_t *>(strtab_data.GetDataStart()));
657           strtab_data_start[0] = 0;
658 
659           offset = 0;
660           std::string symbol_name;
661           Symbol *symbols = m_symtab_up->Resize(num_syms);
662           for (uint32_t i = 0; i < num_syms; ++i) {
663             coff_symbol_t symbol;
664             const uint32_t symbol_offset = offset;
665             const char *symbol_name_cstr = nullptr;
666             // If the first 4 bytes of the symbol string are zero, then they
667             // are followed by a 4-byte string table offset. Else these
668             // 8 bytes contain the symbol name
669             if (symtab_data.GetU32(&offset) == 0) {
670               // Long string that doesn't fit into the symbol table name, so
671               // now we must read the 4 byte string table offset
672               uint32_t strtab_offset = symtab_data.GetU32(&offset);
673               symbol_name_cstr = strtab_data.PeekCStr(strtab_offset);
674               symbol_name.assign(symbol_name_cstr);
675             } else {
676               // Short string that fits into the symbol table name which is 8
677               // bytes
678               offset += sizeof(symbol.name) - 4; // Skip remaining
679               symbol_name_cstr = symtab_data.PeekCStr(symbol_offset);
680               if (symbol_name_cstr == nullptr)
681                 break;
682               symbol_name.assign(symbol_name_cstr, sizeof(symbol.name));
683             }
684             symbol.value = symtab_data.GetU32(&offset);
685             symbol.sect = symtab_data.GetU16(&offset);
686             symbol.type = symtab_data.GetU16(&offset);
687             symbol.storage = symtab_data.GetU8(&offset);
688             symbol.naux = symtab_data.GetU8(&offset);
689             symbols[i].GetMangled().SetValue(ConstString(symbol_name.c_str()));
690             if ((int16_t)symbol.sect >= 1) {
691               Address symbol_addr(sect_list->FindSectionByID(symbol.sect),
692                                   symbol.value);
693               symbols[i].GetAddressRef() = symbol_addr;
694               symbols[i].SetType(MapSymbolType(symbol.type));
695             }
696 
697             if (symbol.naux > 0) {
698               i += symbol.naux;
699               offset += symbol_size;
700             }
701           }
702         }
703       }
704 
705       // Read export header
706       if (coff_data_dir_export_table < m_coff_header_opt.data_dirs.size() &&
707           m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmsize > 0 &&
708           m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmaddr > 0) {
709         export_directory_entry export_table;
710         uint32_t data_start =
711             m_coff_header_opt.data_dirs[coff_data_dir_export_table].vmaddr;
712 
713         DataExtractor symtab_data = ReadImageDataByRVA(
714             data_start, m_coff_header_opt.data_dirs[0].vmsize);
715         lldb::offset_t offset = 0;
716 
717         // Read export_table header
718         export_table.characteristics = symtab_data.GetU32(&offset);
719         export_table.time_date_stamp = symtab_data.GetU32(&offset);
720         export_table.major_version = symtab_data.GetU16(&offset);
721         export_table.minor_version = symtab_data.GetU16(&offset);
722         export_table.name = symtab_data.GetU32(&offset);
723         export_table.base = symtab_data.GetU32(&offset);
724         export_table.number_of_functions = symtab_data.GetU32(&offset);
725         export_table.number_of_names = symtab_data.GetU32(&offset);
726         export_table.address_of_functions = symtab_data.GetU32(&offset);
727         export_table.address_of_names = symtab_data.GetU32(&offset);
728         export_table.address_of_name_ordinals = symtab_data.GetU32(&offset);
729 
730         bool has_ordinal = export_table.address_of_name_ordinals != 0;
731 
732         lldb::offset_t name_offset = export_table.address_of_names - data_start;
733         lldb::offset_t name_ordinal_offset =
734             export_table.address_of_name_ordinals - data_start;
735 
736         Symbol *symbols = m_symtab_up->Resize(export_table.number_of_names);
737 
738         std::string symbol_name;
739 
740         // Read each export table entry
741         for (size_t i = 0; i < export_table.number_of_names; ++i) {
742           uint32_t name_ordinal =
743               has_ordinal ? symtab_data.GetU16(&name_ordinal_offset) : i;
744           uint32_t name_address = symtab_data.GetU32(&name_offset);
745 
746           const char *symbol_name_cstr =
747               symtab_data.PeekCStr(name_address - data_start);
748           symbol_name.assign(symbol_name_cstr);
749 
750           lldb::offset_t function_offset = export_table.address_of_functions -
751                                            data_start +
752                                            sizeof(uint32_t) * name_ordinal;
753           uint32_t function_rva = symtab_data.GetU32(&function_offset);
754 
755           Address symbol_addr(m_coff_header_opt.image_base + function_rva,
756                               sect_list);
757           symbols[i].GetMangled().SetValue(ConstString(symbol_name.c_str()));
758           symbols[i].GetAddressRef() = symbol_addr;
759           symbols[i].SetType(lldb::eSymbolTypeCode);
760           symbols[i].SetDebug(true);
761         }
762       }
763       m_symtab_up->CalculateSymbolSizes();
764     }
765   }
766   return m_symtab_up.get();
767 }
768 
769 std::unique_ptr<CallFrameInfo> ObjectFilePECOFF::CreateCallFrameInfo() {
770   if (coff_data_dir_exception_table >= m_coff_header_opt.data_dirs.size())
771     return {};
772 
773   data_directory data_dir_exception =
774       m_coff_header_opt.data_dirs[coff_data_dir_exception_table];
775   if (!data_dir_exception.vmaddr)
776     return {};
777 
778   if (m_coff_header.machine != llvm::COFF::IMAGE_FILE_MACHINE_AMD64)
779     return {};
780 
781   return std::make_unique<PECallFrameInfo>(*this, data_dir_exception.vmaddr,
782                                            data_dir_exception.vmsize);
783 }
784 
785 bool ObjectFilePECOFF::IsStripped() {
786   // TODO: determine this for COFF
787   return false;
788 }
789 
790 SectionType ObjectFilePECOFF::GetSectionType(llvm::StringRef sect_name,
791                                              const section_header_t &sect) {
792   ConstString const_sect_name(sect_name);
793   static ConstString g_code_sect_name(".code");
794   static ConstString g_CODE_sect_name("CODE");
795   static ConstString g_data_sect_name(".data");
796   static ConstString g_DATA_sect_name("DATA");
797   static ConstString g_bss_sect_name(".bss");
798   static ConstString g_BSS_sect_name("BSS");
799 
800   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_CODE &&
801       ((const_sect_name == g_code_sect_name) ||
802        (const_sect_name == g_CODE_sect_name))) {
803     return eSectionTypeCode;
804   }
805   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA &&
806              ((const_sect_name == g_data_sect_name) ||
807               (const_sect_name == g_DATA_sect_name))) {
808     if (sect.size == 0 && sect.offset == 0)
809       return eSectionTypeZeroFill;
810     else
811       return eSectionTypeData;
812   }
813   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA &&
814              ((const_sect_name == g_bss_sect_name) ||
815               (const_sect_name == g_BSS_sect_name))) {
816     if (sect.size == 0)
817       return eSectionTypeZeroFill;
818     else
819       return eSectionTypeData;
820   }
821 
822   SectionType section_type =
823       llvm::StringSwitch<SectionType>(sect_name)
824           .Case(".debug", eSectionTypeDebug)
825           .Case(".stabstr", eSectionTypeDataCString)
826           .Case(".reloc", eSectionTypeOther)
827           .Case(".debug_abbrev", eSectionTypeDWARFDebugAbbrev)
828           .Case(".debug_aranges", eSectionTypeDWARFDebugAranges)
829           .Case(".debug_frame", eSectionTypeDWARFDebugFrame)
830           .Case(".debug_info", eSectionTypeDWARFDebugInfo)
831           .Case(".debug_line", eSectionTypeDWARFDebugLine)
832           .Case(".debug_loc", eSectionTypeDWARFDebugLoc)
833           .Case(".debug_loclists", eSectionTypeDWARFDebugLocLists)
834           .Case(".debug_macinfo", eSectionTypeDWARFDebugMacInfo)
835           .Case(".debug_names", eSectionTypeDWARFDebugNames)
836           .Case(".debug_pubnames", eSectionTypeDWARFDebugPubNames)
837           .Case(".debug_pubtypes", eSectionTypeDWARFDebugPubTypes)
838           .Case(".debug_ranges", eSectionTypeDWARFDebugRanges)
839           .Case(".debug_str", eSectionTypeDWARFDebugStr)
840           .Case(".debug_types", eSectionTypeDWARFDebugTypes)
841           // .eh_frame can be truncated to 8 chars.
842           .Cases(".eh_frame", ".eh_fram", eSectionTypeEHFrame)
843           .Case(".gosymtab", eSectionTypeGoSymtab)
844           .Default(eSectionTypeInvalid);
845   if (section_type != eSectionTypeInvalid)
846     return section_type;
847 
848   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_CODE)
849     return eSectionTypeCode;
850   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
851     return eSectionTypeData;
852   if (sect.flags & llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) {
853     if (sect.size == 0)
854       return eSectionTypeZeroFill;
855     else
856       return eSectionTypeData;
857   }
858   return eSectionTypeOther;
859 }
860 
861 void ObjectFilePECOFF::CreateSections(SectionList &unified_section_list) {
862   if (m_sections_up)
863     return;
864   m_sections_up = std::make_unique<SectionList>();
865 
866   ModuleSP module_sp(GetModule());
867   if (module_sp) {
868     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
869 
870     SectionSP header_sp = std::make_shared<Section>(
871         module_sp, this, ~user_id_t(0), ConstString("PECOFF header"),
872         eSectionTypeOther, m_coff_header_opt.image_base,
873         m_coff_header_opt.header_size,
874         /*file_offset*/ 0, m_coff_header_opt.header_size,
875         m_coff_header_opt.sect_alignment,
876         /*flags*/ 0);
877     header_sp->SetPermissions(ePermissionsReadable);
878     m_sections_up->AddSection(header_sp);
879     unified_section_list.AddSection(header_sp);
880 
881     const uint32_t nsects = m_sect_headers.size();
882     ModuleSP module_sp(GetModule());
883     for (uint32_t idx = 0; idx < nsects; ++idx) {
884       llvm::StringRef sect_name = GetSectionName(m_sect_headers[idx]);
885       ConstString const_sect_name(sect_name);
886       SectionType section_type = GetSectionType(sect_name, m_sect_headers[idx]);
887 
888       SectionSP section_sp(new Section(
889           module_sp,       // Module to which this section belongs
890           this,            // Object file to which this section belongs
891           idx + 1,         // Section ID is the 1 based section index.
892           const_sect_name, // Name of this section
893           section_type,
894           m_coff_header_opt.image_base +
895               m_sect_headers[idx].vmaddr, // File VM address == addresses as
896                                           // they are found in the object file
897           m_sect_headers[idx].vmsize,     // VM size in bytes of this section
898           m_sect_headers[idx]
899               .offset, // Offset to the data for this section in the file
900           m_sect_headers[idx]
901               .size, // Size in bytes of this section as found in the file
902           m_coff_header_opt.sect_alignment, // Section alignment
903           m_sect_headers[idx].flags));      // Flags for this section
904 
905       uint32_t permissions = 0;
906       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_EXECUTE)
907         permissions |= ePermissionsExecutable;
908       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_READ)
909         permissions |= ePermissionsReadable;
910       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_WRITE)
911         permissions |= ePermissionsWritable;
912       section_sp->SetPermissions(permissions);
913 
914       m_sections_up->AddSection(section_sp);
915       unified_section_list.AddSection(section_sp);
916     }
917   }
918 }
919 
920 UUID ObjectFilePECOFF::GetUUID() {
921   if (m_uuid.IsValid())
922     return m_uuid;
923 
924   if (!CreateBinary())
925     return UUID();
926 
927   m_uuid = GetCoffUUID(*m_binary);
928   return m_uuid;
929 }
930 
931 uint32_t ObjectFilePECOFF::ParseDependentModules() {
932   ModuleSP module_sp(GetModule());
933   if (!module_sp)
934     return 0;
935 
936   std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
937   if (m_deps_filespec)
938     return m_deps_filespec->GetSize();
939 
940   // Cache coff binary if it is not done yet.
941   if (!CreateBinary())
942     return 0;
943 
944   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
945   LLDB_LOG(log, "this = {0}, module = {1} ({2}), file = {3}, binary = {4}",
946            this, GetModule().get(), GetModule()->GetSpecificationDescription(),
947            m_file.GetPath(), m_binary.get());
948 
949   m_deps_filespec = FileSpecList();
950 
951   for (const auto &entry : m_binary->import_directories()) {
952     llvm::StringRef dll_name;
953     // Report a bogus entry.
954     if (llvm::Error e = entry.getName(dll_name)) {
955       LLDB_LOGF(log,
956                 "ObjectFilePECOFF::ParseDependentModules() - failed to get "
957                 "import directory entry name: %s",
958                 llvm::toString(std::move(e)).c_str());
959       continue;
960     }
961 
962     // At this moment we only have the base name of the DLL. The full path can
963     // only be seen after the dynamic loading.  Our best guess is Try to get it
964     // with the help of the object file's directory.
965     llvm::SmallString<128> dll_fullpath;
966     FileSpec dll_specs(dll_name);
967     dll_specs.GetDirectory().SetString(m_file.GetDirectory().GetCString());
968 
969     if (!llvm::sys::fs::real_path(dll_specs.GetPath(), dll_fullpath))
970       m_deps_filespec->EmplaceBack(dll_fullpath);
971     else {
972       // Known DLLs or DLL not found in the object file directory.
973       m_deps_filespec->EmplaceBack(dll_name);
974     }
975   }
976   return m_deps_filespec->GetSize();
977 }
978 
979 uint32_t ObjectFilePECOFF::GetDependentModules(FileSpecList &files) {
980   auto num_modules = ParseDependentModules();
981   auto original_size = files.GetSize();
982 
983   for (unsigned i = 0; i < num_modules; ++i)
984     files.AppendIfUnique(m_deps_filespec->GetFileSpecAtIndex(i));
985 
986   return files.GetSize() - original_size;
987 }
988 
989 lldb_private::Address ObjectFilePECOFF::GetEntryPointAddress() {
990   if (m_entry_point_address.IsValid())
991     return m_entry_point_address;
992 
993   if (!ParseHeader() || !IsExecutable())
994     return m_entry_point_address;
995 
996   SectionList *section_list = GetSectionList();
997   addr_t file_addr = m_coff_header_opt.entry + m_coff_header_opt.image_base;
998 
999   if (!section_list)
1000     m_entry_point_address.SetOffset(file_addr);
1001   else
1002     m_entry_point_address.ResolveAddressUsingFileSections(file_addr,
1003                                                           section_list);
1004   return m_entry_point_address;
1005 }
1006 
1007 Address ObjectFilePECOFF::GetBaseAddress() {
1008   return Address(GetSectionList()->GetSectionAtIndex(0), 0);
1009 }
1010 
1011 // Dump
1012 //
1013 // Dump the specifics of the runtime file container (such as any headers
1014 // segments, sections, etc).
1015 void ObjectFilePECOFF::Dump(Stream *s) {
1016   ModuleSP module_sp(GetModule());
1017   if (module_sp) {
1018     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
1019     s->Printf("%p: ", static_cast<void *>(this));
1020     s->Indent();
1021     s->PutCString("ObjectFilePECOFF");
1022 
1023     ArchSpec header_arch = GetArchitecture();
1024 
1025     *s << ", file = '" << m_file
1026        << "', arch = " << header_arch.GetArchitectureName() << "\n";
1027 
1028     SectionList *sections = GetSectionList();
1029     if (sections)
1030       sections->Dump(s->AsRawOstream(), s->GetIndentLevel(), nullptr, true,
1031                      UINT32_MAX);
1032 
1033     if (m_symtab_up)
1034       m_symtab_up->Dump(s, nullptr, eSortOrderNone);
1035 
1036     if (m_dos_header.e_magic)
1037       DumpDOSHeader(s, m_dos_header);
1038     if (m_coff_header.machine) {
1039       DumpCOFFHeader(s, m_coff_header);
1040       if (m_coff_header.hdrsize)
1041         DumpOptCOFFHeader(s, m_coff_header_opt);
1042     }
1043     s->EOL();
1044     DumpSectionHeaders(s);
1045     s->EOL();
1046 
1047     DumpDependentModules(s);
1048     s->EOL();
1049   }
1050 }
1051 
1052 // DumpDOSHeader
1053 //
1054 // Dump the MS-DOS header to the specified output stream
1055 void ObjectFilePECOFF::DumpDOSHeader(Stream *s, const dos_header_t &header) {
1056   s->PutCString("MSDOS Header\n");
1057   s->Printf("  e_magic    = 0x%4.4x\n", header.e_magic);
1058   s->Printf("  e_cblp     = 0x%4.4x\n", header.e_cblp);
1059   s->Printf("  e_cp       = 0x%4.4x\n", header.e_cp);
1060   s->Printf("  e_crlc     = 0x%4.4x\n", header.e_crlc);
1061   s->Printf("  e_cparhdr  = 0x%4.4x\n", header.e_cparhdr);
1062   s->Printf("  e_minalloc = 0x%4.4x\n", header.e_minalloc);
1063   s->Printf("  e_maxalloc = 0x%4.4x\n", header.e_maxalloc);
1064   s->Printf("  e_ss       = 0x%4.4x\n", header.e_ss);
1065   s->Printf("  e_sp       = 0x%4.4x\n", header.e_sp);
1066   s->Printf("  e_csum     = 0x%4.4x\n", header.e_csum);
1067   s->Printf("  e_ip       = 0x%4.4x\n", header.e_ip);
1068   s->Printf("  e_cs       = 0x%4.4x\n", header.e_cs);
1069   s->Printf("  e_lfarlc   = 0x%4.4x\n", header.e_lfarlc);
1070   s->Printf("  e_ovno     = 0x%4.4x\n", header.e_ovno);
1071   s->Printf("  e_res[4]   = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n",
1072             header.e_res[0], header.e_res[1], header.e_res[2], header.e_res[3]);
1073   s->Printf("  e_oemid    = 0x%4.4x\n", header.e_oemid);
1074   s->Printf("  e_oeminfo  = 0x%4.4x\n", header.e_oeminfo);
1075   s->Printf("  e_res2[10] = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, "
1076             "0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n",
1077             header.e_res2[0], header.e_res2[1], header.e_res2[2],
1078             header.e_res2[3], header.e_res2[4], header.e_res2[5],
1079             header.e_res2[6], header.e_res2[7], header.e_res2[8],
1080             header.e_res2[9]);
1081   s->Printf("  e_lfanew   = 0x%8.8x\n", header.e_lfanew);
1082 }
1083 
1084 // DumpCOFFHeader
1085 //
1086 // Dump the COFF header to the specified output stream
1087 void ObjectFilePECOFF::DumpCOFFHeader(Stream *s, const coff_header_t &header) {
1088   s->PutCString("COFF Header\n");
1089   s->Printf("  machine = 0x%4.4x\n", header.machine);
1090   s->Printf("  nsects  = 0x%4.4x\n", header.nsects);
1091   s->Printf("  modtime = 0x%8.8x\n", header.modtime);
1092   s->Printf("  symoff  = 0x%8.8x\n", header.symoff);
1093   s->Printf("  nsyms   = 0x%8.8x\n", header.nsyms);
1094   s->Printf("  hdrsize = 0x%4.4x\n", header.hdrsize);
1095 }
1096 
1097 // DumpOptCOFFHeader
1098 //
1099 // Dump the optional COFF header to the specified output stream
1100 void ObjectFilePECOFF::DumpOptCOFFHeader(Stream *s,
1101                                          const coff_opt_header_t &header) {
1102   s->PutCString("Optional COFF Header\n");
1103   s->Printf("  magic                   = 0x%4.4x\n", header.magic);
1104   s->Printf("  major_linker_version    = 0x%2.2x\n",
1105             header.major_linker_version);
1106   s->Printf("  minor_linker_version    = 0x%2.2x\n",
1107             header.minor_linker_version);
1108   s->Printf("  code_size               = 0x%8.8x\n", header.code_size);
1109   s->Printf("  data_size               = 0x%8.8x\n", header.data_size);
1110   s->Printf("  bss_size                = 0x%8.8x\n", header.bss_size);
1111   s->Printf("  entry                   = 0x%8.8x\n", header.entry);
1112   s->Printf("  code_offset             = 0x%8.8x\n", header.code_offset);
1113   s->Printf("  data_offset             = 0x%8.8x\n", header.data_offset);
1114   s->Printf("  image_base              = 0x%16.16" PRIx64 "\n",
1115             header.image_base);
1116   s->Printf("  sect_alignment          = 0x%8.8x\n", header.sect_alignment);
1117   s->Printf("  file_alignment          = 0x%8.8x\n", header.file_alignment);
1118   s->Printf("  major_os_system_version = 0x%4.4x\n",
1119             header.major_os_system_version);
1120   s->Printf("  minor_os_system_version = 0x%4.4x\n",
1121             header.minor_os_system_version);
1122   s->Printf("  major_image_version     = 0x%4.4x\n",
1123             header.major_image_version);
1124   s->Printf("  minor_image_version     = 0x%4.4x\n",
1125             header.minor_image_version);
1126   s->Printf("  major_subsystem_version = 0x%4.4x\n",
1127             header.major_subsystem_version);
1128   s->Printf("  minor_subsystem_version = 0x%4.4x\n",
1129             header.minor_subsystem_version);
1130   s->Printf("  reserved1               = 0x%8.8x\n", header.reserved1);
1131   s->Printf("  image_size              = 0x%8.8x\n", header.image_size);
1132   s->Printf("  header_size             = 0x%8.8x\n", header.header_size);
1133   s->Printf("  checksum                = 0x%8.8x\n", header.checksum);
1134   s->Printf("  subsystem               = 0x%4.4x\n", header.subsystem);
1135   s->Printf("  dll_flags               = 0x%4.4x\n", header.dll_flags);
1136   s->Printf("  stack_reserve_size      = 0x%16.16" PRIx64 "\n",
1137             header.stack_reserve_size);
1138   s->Printf("  stack_commit_size       = 0x%16.16" PRIx64 "\n",
1139             header.stack_commit_size);
1140   s->Printf("  heap_reserve_size       = 0x%16.16" PRIx64 "\n",
1141             header.heap_reserve_size);
1142   s->Printf("  heap_commit_size        = 0x%16.16" PRIx64 "\n",
1143             header.heap_commit_size);
1144   s->Printf("  loader_flags            = 0x%8.8x\n", header.loader_flags);
1145   s->Printf("  num_data_dir_entries    = 0x%8.8x\n",
1146             (uint32_t)header.data_dirs.size());
1147   uint32_t i;
1148   for (i = 0; i < header.data_dirs.size(); i++) {
1149     s->Printf("  data_dirs[%2u] vmaddr = 0x%8.8x, vmsize = 0x%8.8x\n", i,
1150               header.data_dirs[i].vmaddr, header.data_dirs[i].vmsize);
1151   }
1152 }
1153 // DumpSectionHeader
1154 //
1155 // Dump a single ELF section header to the specified output stream
1156 void ObjectFilePECOFF::DumpSectionHeader(Stream *s,
1157                                          const section_header_t &sh) {
1158   std::string name = std::string(GetSectionName(sh));
1159   s->Printf("%-16s 0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x 0x%4.4x "
1160             "0x%4.4x 0x%8.8x\n",
1161             name.c_str(), sh.vmaddr, sh.vmsize, sh.offset, sh.size, sh.reloff,
1162             sh.lineoff, sh.nreloc, sh.nline, sh.flags);
1163 }
1164 
1165 // DumpSectionHeaders
1166 //
1167 // Dump all of the ELF section header to the specified output stream
1168 void ObjectFilePECOFF::DumpSectionHeaders(Stream *s) {
1169 
1170   s->PutCString("Section Headers\n");
1171   s->PutCString("IDX  name             vm addr    vm size    file off   file "
1172                 "size  reloc off  line off   nreloc nline  flags\n");
1173   s->PutCString("==== ---------------- ---------- ---------- ---------- "
1174                 "---------- ---------- ---------- ------ ------ ----------\n");
1175 
1176   uint32_t idx = 0;
1177   SectionHeaderCollIter pos, end = m_sect_headers.end();
1178 
1179   for (pos = m_sect_headers.begin(); pos != end; ++pos, ++idx) {
1180     s->Printf("[%2u] ", idx);
1181     ObjectFilePECOFF::DumpSectionHeader(s, *pos);
1182   }
1183 }
1184 
1185 // DumpDependentModules
1186 //
1187 // Dump all of the dependent modules to the specified output stream
1188 void ObjectFilePECOFF::DumpDependentModules(lldb_private::Stream *s) {
1189   auto num_modules = ParseDependentModules();
1190   if (num_modules > 0) {
1191     s->PutCString("Dependent Modules\n");
1192     for (unsigned i = 0; i < num_modules; ++i) {
1193       auto spec = m_deps_filespec->GetFileSpecAtIndex(i);
1194       s->Printf("  %s\n", spec.GetFilename().GetCString());
1195     }
1196   }
1197 }
1198 
1199 bool ObjectFilePECOFF::IsWindowsSubsystem() {
1200   switch (m_coff_header_opt.subsystem) {
1201   case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE:
1202   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_GUI:
1203   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CUI:
1204   case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE_WINDOWS:
1205   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CE_GUI:
1206   case llvm::COFF::IMAGE_SUBSYSTEM_XBOX:
1207   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION:
1208     return true;
1209   default:
1210     return false;
1211   }
1212 }
1213 
1214 ArchSpec ObjectFilePECOFF::GetArchitecture() {
1215   uint16_t machine = m_coff_header.machine;
1216   switch (machine) {
1217   default:
1218     break;
1219   case llvm::COFF::IMAGE_FILE_MACHINE_AMD64:
1220   case llvm::COFF::IMAGE_FILE_MACHINE_I386:
1221   case llvm::COFF::IMAGE_FILE_MACHINE_POWERPC:
1222   case llvm::COFF::IMAGE_FILE_MACHINE_POWERPCFP:
1223   case llvm::COFF::IMAGE_FILE_MACHINE_ARM:
1224   case llvm::COFF::IMAGE_FILE_MACHINE_ARMNT:
1225   case llvm::COFF::IMAGE_FILE_MACHINE_THUMB:
1226   case llvm::COFF::IMAGE_FILE_MACHINE_ARM64:
1227     ArchSpec arch;
1228     arch.SetArchitecture(eArchTypeCOFF, machine, LLDB_INVALID_CPUTYPE,
1229                          IsWindowsSubsystem() ? llvm::Triple::Win32
1230                                               : llvm::Triple::UnknownOS);
1231     return arch;
1232   }
1233   return ArchSpec();
1234 }
1235 
1236 ObjectFile::Type ObjectFilePECOFF::CalculateType() {
1237   if (m_coff_header.machine != 0) {
1238     if ((m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0)
1239       return eTypeExecutable;
1240     else
1241       return eTypeSharedLibrary;
1242   }
1243   return eTypeExecutable;
1244 }
1245 
1246 ObjectFile::Strata ObjectFilePECOFF::CalculateStrata() { return eStrataUser; }
1247 
1248 // PluginInterface protocol
1249 ConstString ObjectFilePECOFF::GetPluginName() { return GetPluginNameStatic(); }
1250 
1251 uint32_t ObjectFilePECOFF::GetPluginVersion() { return 1; }
1252