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