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,
118                                              lldb::offset_t file_offset,
119                                              lldb::offset_t length) {
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, 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   auto binary = llvm::object::createBinary(file.GetPath());
171   if (!binary)
172     return initial_count;
173 
174   if (!binary->getBinary()->isCOFF() &&
175       !binary->getBinary()->isCOFFImportFile())
176     return initial_count;
177 
178   auto COFFObj =
179     llvm::cast<llvm::object::COFFObjectFile>(binary->getBinary());
180 
181   ModuleSpec module_spec(file);
182   ArchSpec &spec = module_spec.GetArchitecture();
183   lldb_private::UUID &uuid = module_spec.GetUUID();
184   if (!uuid.IsValid())
185     uuid = GetCoffUUID(COFFObj);
186 
187   switch (COFFObj->getMachine()) {
188   case MachineAmd64:
189     spec.SetTriple("x86_64-pc-windows");
190     specs.Append(module_spec);
191     break;
192   case MachineX86:
193     spec.SetTriple("i386-pc-windows");
194     specs.Append(module_spec);
195     spec.SetTriple("i686-pc-windows");
196     specs.Append(module_spec);
197     break;
198   case MachineArmNt:
199     spec.SetTriple("armv7-pc-windows");
200     specs.Append(module_spec);
201     break;
202   case MachineArm64:
203     spec.SetTriple("aarch64-pc-windows");
204     specs.Append(module_spec);
205     break;
206   default:
207     break;
208   }
209 
210   return specs.GetSize() - initial_count;
211 }
212 
213 bool ObjectFilePECOFF::SaveCore(const lldb::ProcessSP &process_sp,
214                                 const lldb_private::FileSpec &outfile,
215                                 lldb_private::Status &error) {
216   return SaveMiniDump(process_sp, outfile, error);
217 }
218 
219 bool ObjectFilePECOFF::MagicBytesMatch(DataBufferSP &data_sp) {
220   DataExtractor data(data_sp, eByteOrderLittle, 4);
221   lldb::offset_t offset = 0;
222   uint16_t magic = data.GetU16(&offset);
223   return magic == IMAGE_DOS_SIGNATURE;
224 }
225 
226 lldb::SymbolType ObjectFilePECOFF::MapSymbolType(uint16_t coff_symbol_type) {
227   // TODO:  We need to complete this mapping of COFF symbol types to LLDB ones.
228   // For now, here's a hack to make sure our function have types.
229   const auto complex_type =
230       coff_symbol_type >> llvm::COFF::SCT_COMPLEX_TYPE_SHIFT;
231   if (complex_type == llvm::COFF::IMAGE_SYM_DTYPE_FUNCTION) {
232     return lldb::eSymbolTypeCode;
233   }
234   return lldb::eSymbolTypeInvalid;
235 }
236 
237 bool ObjectFilePECOFF::CreateBinary() {
238   if (m_owningbin)
239     return true;
240 
241   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
242 
243   auto binary = llvm::object::createBinary(m_file.GetPath());
244   if (!binary) {
245     LLDB_LOGF(log,
246               "ObjectFilePECOFF::CreateBinary() - failed to create binary "
247               "for file (%s): %s",
248               m_file ? m_file.GetPath().c_str() : "<NULL>",
249               errorToErrorCode(binary.takeError()).message().c_str());
250     return false;
251   }
252 
253   // Make sure we only handle COFF format.
254   if (!binary->getBinary()->isCOFF() &&
255       !binary->getBinary()->isCOFFImportFile())
256     return false;
257 
258   m_owningbin = OWNBINType(std::move(*binary));
259   LLDB_LOGF(log,
260             "%p ObjectFilePECOFF::CreateBinary() module = %p (%s), file = "
261             "%s, binary = %p (Bin = %p)",
262             static_cast<void *>(this), static_cast<void *>(GetModule().get()),
263             GetModule()->GetSpecificationDescription().c_str(),
264             m_file ? m_file.GetPath().c_str() : "<NULL>",
265             static_cast<void *>(m_owningbin.getPointer()),
266             static_cast<void *>(m_owningbin->getBinary()));
267   return true;
268 }
269 
270 ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
271                                    DataBufferSP &data_sp,
272                                    lldb::offset_t data_offset,
273                                    const FileSpec *file,
274                                    lldb::offset_t file_offset,
275                                    lldb::offset_t length)
276     : ObjectFile(module_sp, file, file_offset, length, data_sp, data_offset),
277       m_dos_header(), m_coff_header(), m_sect_headers(),
278       m_entry_point_address(), m_deps_filespec(), m_owningbin() {
279   ::memset(&m_dos_header, 0, sizeof(m_dos_header));
280   ::memset(&m_coff_header, 0, sizeof(m_coff_header));
281 }
282 
283 ObjectFilePECOFF::ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
284                                    DataBufferSP &header_data_sp,
285                                    const lldb::ProcessSP &process_sp,
286                                    addr_t header_addr)
287     : ObjectFile(module_sp, process_sp, header_addr, header_data_sp),
288       m_dos_header(), m_coff_header(), m_sect_headers(),
289       m_entry_point_address(), m_deps_filespec(), m_owningbin() {
290   ::memset(&m_dos_header, 0, sizeof(m_dos_header));
291   ::memset(&m_coff_header, 0, sizeof(m_coff_header));
292 }
293 
294 ObjectFilePECOFF::~ObjectFilePECOFF() {}
295 
296 bool ObjectFilePECOFF::ParseHeader() {
297   ModuleSP module_sp(GetModule());
298   if (module_sp) {
299     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
300     m_sect_headers.clear();
301     m_data.SetByteOrder(eByteOrderLittle);
302     lldb::offset_t offset = 0;
303 
304     if (ParseDOSHeader(m_data, m_dos_header)) {
305       offset = m_dos_header.e_lfanew;
306       uint32_t pe_signature = m_data.GetU32(&offset);
307       if (pe_signature != IMAGE_NT_SIGNATURE)
308         return false;
309       if (ParseCOFFHeader(m_data, &offset, m_coff_header)) {
310         if (m_coff_header.hdrsize > 0)
311           ParseCOFFOptionalHeader(&offset);
312         ParseSectionHeaders(offset);
313       }
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.reset(new 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   return std::make_unique<PECallFrameInfo>(*this, data_dir_exception.vmaddr,
779                                            data_dir_exception.vmsize);
780 }
781 
782 bool ObjectFilePECOFF::IsStripped() {
783   // TODO: determine this for COFF
784   return false;
785 }
786 
787 void ObjectFilePECOFF::CreateSections(SectionList &unified_section_list) {
788   if (m_sections_up)
789     return;
790   m_sections_up.reset(new SectionList());
791 
792   ModuleSP module_sp(GetModule());
793   if (module_sp) {
794     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
795 
796     SectionSP header_sp = std::make_shared<Section>(
797         module_sp, this, ~user_id_t(0), ConstString("PECOFF header"),
798         eSectionTypeOther, m_coff_header_opt.image_base,
799         m_coff_header_opt.header_size,
800         /*file_offset*/ 0, m_coff_header_opt.header_size,
801         m_coff_header_opt.sect_alignment,
802         /*flags*/ 0);
803     header_sp->SetPermissions(ePermissionsReadable);
804     m_sections_up->AddSection(header_sp);
805     unified_section_list.AddSection(header_sp);
806 
807     const uint32_t nsects = m_sect_headers.size();
808     ModuleSP module_sp(GetModule());
809     for (uint32_t idx = 0; idx < nsects; ++idx) {
810       ConstString const_sect_name(GetSectionName(m_sect_headers[idx]));
811       static ConstString g_code_sect_name(".code");
812       static ConstString g_CODE_sect_name("CODE");
813       static ConstString g_data_sect_name(".data");
814       static ConstString g_DATA_sect_name("DATA");
815       static ConstString g_bss_sect_name(".bss");
816       static ConstString g_BSS_sect_name("BSS");
817       static ConstString g_debug_sect_name(".debug");
818       static ConstString g_reloc_sect_name(".reloc");
819       static ConstString g_stab_sect_name(".stab");
820       static ConstString g_stabstr_sect_name(".stabstr");
821       static ConstString g_sect_name_dwarf_debug_abbrev(".debug_abbrev");
822       static ConstString g_sect_name_dwarf_debug_aranges(".debug_aranges");
823       static ConstString g_sect_name_dwarf_debug_frame(".debug_frame");
824       static ConstString g_sect_name_dwarf_debug_info(".debug_info");
825       static ConstString g_sect_name_dwarf_debug_line(".debug_line");
826       static ConstString g_sect_name_dwarf_debug_loc(".debug_loc");
827       static ConstString g_sect_name_dwarf_debug_loclists(".debug_loclists");
828       static ConstString g_sect_name_dwarf_debug_macinfo(".debug_macinfo");
829       static ConstString g_sect_name_dwarf_debug_names(".debug_names");
830       static ConstString g_sect_name_dwarf_debug_pubnames(".debug_pubnames");
831       static ConstString g_sect_name_dwarf_debug_pubtypes(".debug_pubtypes");
832       static ConstString g_sect_name_dwarf_debug_ranges(".debug_ranges");
833       static ConstString g_sect_name_dwarf_debug_str(".debug_str");
834       static ConstString g_sect_name_dwarf_debug_types(".debug_types");
835       static ConstString g_sect_name_eh_frame(".eh_frame");
836       static ConstString g_sect_name_go_symtab(".gosymtab");
837       SectionType section_type = eSectionTypeOther;
838       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_CNT_CODE &&
839           ((const_sect_name == g_code_sect_name) ||
840            (const_sect_name == g_CODE_sect_name))) {
841         section_type = eSectionTypeCode;
842       } else if (m_sect_headers[idx].flags &
843                      llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA &&
844                  ((const_sect_name == g_data_sect_name) ||
845                   (const_sect_name == g_DATA_sect_name))) {
846         if (m_sect_headers[idx].size == 0 && m_sect_headers[idx].offset == 0)
847           section_type = eSectionTypeZeroFill;
848         else
849           section_type = eSectionTypeData;
850       } else if (m_sect_headers[idx].flags &
851                      llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA &&
852                  ((const_sect_name == g_bss_sect_name) ||
853                   (const_sect_name == g_BSS_sect_name))) {
854         if (m_sect_headers[idx].size == 0)
855           section_type = eSectionTypeZeroFill;
856         else
857           section_type = eSectionTypeData;
858       } else if (const_sect_name == g_debug_sect_name) {
859         section_type = eSectionTypeDebug;
860       } else if (const_sect_name == g_stabstr_sect_name) {
861         section_type = eSectionTypeDataCString;
862       } else if (const_sect_name == g_reloc_sect_name) {
863         section_type = eSectionTypeOther;
864       } else if (const_sect_name == g_sect_name_dwarf_debug_abbrev)
865         section_type = eSectionTypeDWARFDebugAbbrev;
866       else if (const_sect_name == g_sect_name_dwarf_debug_aranges)
867         section_type = eSectionTypeDWARFDebugAranges;
868       else if (const_sect_name == g_sect_name_dwarf_debug_frame)
869         section_type = eSectionTypeDWARFDebugFrame;
870       else if (const_sect_name == g_sect_name_dwarf_debug_info)
871         section_type = eSectionTypeDWARFDebugInfo;
872       else if (const_sect_name == g_sect_name_dwarf_debug_line)
873         section_type = eSectionTypeDWARFDebugLine;
874       else if (const_sect_name == g_sect_name_dwarf_debug_loc)
875         section_type = eSectionTypeDWARFDebugLoc;
876       else if (const_sect_name == g_sect_name_dwarf_debug_loclists)
877         section_type = eSectionTypeDWARFDebugLocLists;
878       else if (const_sect_name == g_sect_name_dwarf_debug_macinfo)
879         section_type = eSectionTypeDWARFDebugMacInfo;
880       else if (const_sect_name == g_sect_name_dwarf_debug_names)
881         section_type = eSectionTypeDWARFDebugNames;
882       else if (const_sect_name == g_sect_name_dwarf_debug_pubnames)
883         section_type = eSectionTypeDWARFDebugPubNames;
884       else if (const_sect_name == g_sect_name_dwarf_debug_pubtypes)
885         section_type = eSectionTypeDWARFDebugPubTypes;
886       else if (const_sect_name == g_sect_name_dwarf_debug_ranges)
887         section_type = eSectionTypeDWARFDebugRanges;
888       else if (const_sect_name == g_sect_name_dwarf_debug_str)
889         section_type = eSectionTypeDWARFDebugStr;
890       else if (const_sect_name == g_sect_name_dwarf_debug_types)
891         section_type = eSectionTypeDWARFDebugTypes;
892       else if (const_sect_name == g_sect_name_eh_frame)
893         section_type = eSectionTypeEHFrame;
894       else if (const_sect_name == g_sect_name_go_symtab)
895         section_type = eSectionTypeGoSymtab;
896       else if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_CNT_CODE) {
897         section_type = eSectionTypeCode;
898       } else if (m_sect_headers[idx].flags &
899                  llvm::COFF::IMAGE_SCN_CNT_INITIALIZED_DATA) {
900         section_type = eSectionTypeData;
901       } else if (m_sect_headers[idx].flags &
902                  llvm::COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) {
903         if (m_sect_headers[idx].size == 0)
904           section_type = eSectionTypeZeroFill;
905         else
906           section_type = eSectionTypeData;
907       }
908 
909       SectionSP section_sp(new Section(
910           module_sp,       // Module to which this section belongs
911           this,            // Object file to which this section belongs
912           idx + 1,         // Section ID is the 1 based section index.
913           const_sect_name, // Name of this section
914           section_type,
915           m_coff_header_opt.image_base +
916               m_sect_headers[idx].vmaddr, // File VM address == addresses as
917                                           // they are found in the object file
918           m_sect_headers[idx].vmsize,     // VM size in bytes of this section
919           m_sect_headers[idx]
920               .offset, // Offset to the data for this section in the file
921           m_sect_headers[idx]
922               .size, // Size in bytes of this section as found in the file
923           m_coff_header_opt.sect_alignment, // Section alignment
924           m_sect_headers[idx].flags));      // Flags for this section
925 
926       uint32_t permissions = 0;
927       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_EXECUTE)
928         permissions |= ePermissionsExecutable;
929       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_READ)
930         permissions |= ePermissionsReadable;
931       if (m_sect_headers[idx].flags & llvm::COFF::IMAGE_SCN_MEM_WRITE)
932         permissions |= ePermissionsWritable;
933       section_sp->SetPermissions(permissions);
934 
935       m_sections_up->AddSection(section_sp);
936       unified_section_list.AddSection(section_sp);
937     }
938   }
939 }
940 
941 UUID ObjectFilePECOFF::GetUUID() {
942   if (m_uuid.IsValid())
943     return m_uuid;
944 
945   if (!CreateBinary())
946     return UUID();
947 
948   auto COFFObj =
949     llvm::cast<llvm::object::COFFObjectFile>(m_owningbin->getBinary());
950 
951   m_uuid = GetCoffUUID(COFFObj);
952   return m_uuid;
953 }
954 
955 uint32_t ObjectFilePECOFF::ParseDependentModules() {
956   ModuleSP module_sp(GetModule());
957   if (!module_sp)
958     return 0;
959 
960   std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
961   if (m_deps_filespec)
962     return m_deps_filespec->GetSize();
963 
964   // Cache coff binary if it is not done yet.
965   if (!CreateBinary())
966     return 0;
967 
968   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
969   LLDB_LOGF(log,
970             "%p ObjectFilePECOFF::ParseDependentModules() module = %p "
971             "(%s), binary = %p (Bin = %p)",
972             static_cast<void *>(this), static_cast<void *>(module_sp.get()),
973             module_sp->GetSpecificationDescription().c_str(),
974             static_cast<void *>(m_owningbin.getPointer()),
975             static_cast<void *>(m_owningbin->getBinary()));
976 
977   auto COFFObj =
978       llvm::dyn_cast<llvm::object::COFFObjectFile>(m_owningbin->getBinary());
979   if (!COFFObj)
980     return 0;
981 
982   m_deps_filespec = FileSpecList();
983 
984   for (const auto &entry : COFFObj->import_directories()) {
985     llvm::StringRef dll_name;
986     auto ec = entry.getName(dll_name);
987     // Report a bogus entry.
988     if (ec != std::error_code()) {
989       LLDB_LOGF(log,
990                 "ObjectFilePECOFF::ParseDependentModules() - failed to get "
991                 "import directory entry name: %s",
992                 ec.message().c_str());
993       continue;
994     }
995 
996     // At this moment we only have the base name of the DLL. The full path can
997     // only be seen after the dynamic loading.  Our best guess is Try to get it
998     // with the help of the object file's directory.
999     llvm::SmallString<128> dll_fullpath;
1000     FileSpec dll_specs(dll_name);
1001     dll_specs.GetDirectory().SetString(m_file.GetDirectory().GetCString());
1002 
1003     if (!llvm::sys::fs::real_path(dll_specs.GetPath(), dll_fullpath))
1004       m_deps_filespec->EmplaceBack(dll_fullpath);
1005     else {
1006       // Known DLLs or DLL not found in the object file directory.
1007       m_deps_filespec->EmplaceBack(dll_name);
1008     }
1009   }
1010   return m_deps_filespec->GetSize();
1011 }
1012 
1013 uint32_t ObjectFilePECOFF::GetDependentModules(FileSpecList &files) {
1014   auto num_modules = ParseDependentModules();
1015   auto original_size = files.GetSize();
1016 
1017   for (unsigned i = 0; i < num_modules; ++i)
1018     files.AppendIfUnique(m_deps_filespec->GetFileSpecAtIndex(i));
1019 
1020   return files.GetSize() - original_size;
1021 }
1022 
1023 lldb_private::Address ObjectFilePECOFF::GetEntryPointAddress() {
1024   if (m_entry_point_address.IsValid())
1025     return m_entry_point_address;
1026 
1027   if (!ParseHeader() || !IsExecutable())
1028     return m_entry_point_address;
1029 
1030   SectionList *section_list = GetSectionList();
1031   addr_t file_addr = m_coff_header_opt.entry + m_coff_header_opt.image_base;
1032 
1033   if (!section_list)
1034     m_entry_point_address.SetOffset(file_addr);
1035   else
1036     m_entry_point_address.ResolveAddressUsingFileSections(file_addr,
1037                                                           section_list);
1038   return m_entry_point_address;
1039 }
1040 
1041 Address ObjectFilePECOFF::GetBaseAddress() {
1042   return Address(GetSectionList()->GetSectionAtIndex(0), 0);
1043 }
1044 
1045 // Dump
1046 //
1047 // Dump the specifics of the runtime file container (such as any headers
1048 // segments, sections, etc).
1049 void ObjectFilePECOFF::Dump(Stream *s) {
1050   ModuleSP module_sp(GetModule());
1051   if (module_sp) {
1052     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
1053     s->Printf("%p: ", static_cast<void *>(this));
1054     s->Indent();
1055     s->PutCString("ObjectFilePECOFF");
1056 
1057     ArchSpec header_arch = GetArchitecture();
1058 
1059     *s << ", file = '" << m_file
1060        << "', arch = " << header_arch.GetArchitectureName() << "\n";
1061 
1062     SectionList *sections = GetSectionList();
1063     if (sections)
1064       sections->Dump(s, nullptr, true, UINT32_MAX);
1065 
1066     if (m_symtab_up)
1067       m_symtab_up->Dump(s, nullptr, eSortOrderNone);
1068 
1069     if (m_dos_header.e_magic)
1070       DumpDOSHeader(s, m_dos_header);
1071     if (m_coff_header.machine) {
1072       DumpCOFFHeader(s, m_coff_header);
1073       if (m_coff_header.hdrsize)
1074         DumpOptCOFFHeader(s, m_coff_header_opt);
1075     }
1076     s->EOL();
1077     DumpSectionHeaders(s);
1078     s->EOL();
1079 
1080     DumpDependentModules(s);
1081     s->EOL();
1082   }
1083 }
1084 
1085 // DumpDOSHeader
1086 //
1087 // Dump the MS-DOS header to the specified output stream
1088 void ObjectFilePECOFF::DumpDOSHeader(Stream *s, const dos_header_t &header) {
1089   s->PutCString("MSDOS Header\n");
1090   s->Printf("  e_magic    = 0x%4.4x\n", header.e_magic);
1091   s->Printf("  e_cblp     = 0x%4.4x\n", header.e_cblp);
1092   s->Printf("  e_cp       = 0x%4.4x\n", header.e_cp);
1093   s->Printf("  e_crlc     = 0x%4.4x\n", header.e_crlc);
1094   s->Printf("  e_cparhdr  = 0x%4.4x\n", header.e_cparhdr);
1095   s->Printf("  e_minalloc = 0x%4.4x\n", header.e_minalloc);
1096   s->Printf("  e_maxalloc = 0x%4.4x\n", header.e_maxalloc);
1097   s->Printf("  e_ss       = 0x%4.4x\n", header.e_ss);
1098   s->Printf("  e_sp       = 0x%4.4x\n", header.e_sp);
1099   s->Printf("  e_csum     = 0x%4.4x\n", header.e_csum);
1100   s->Printf("  e_ip       = 0x%4.4x\n", header.e_ip);
1101   s->Printf("  e_cs       = 0x%4.4x\n", header.e_cs);
1102   s->Printf("  e_lfarlc   = 0x%4.4x\n", header.e_lfarlc);
1103   s->Printf("  e_ovno     = 0x%4.4x\n", header.e_ovno);
1104   s->Printf("  e_res[4]   = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n",
1105             header.e_res[0], header.e_res[1], header.e_res[2], header.e_res[3]);
1106   s->Printf("  e_oemid    = 0x%4.4x\n", header.e_oemid);
1107   s->Printf("  e_oeminfo  = 0x%4.4x\n", header.e_oeminfo);
1108   s->Printf("  e_res2[10] = { 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, "
1109             "0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x, 0x%4.4x }\n",
1110             header.e_res2[0], header.e_res2[1], header.e_res2[2],
1111             header.e_res2[3], header.e_res2[4], header.e_res2[5],
1112             header.e_res2[6], header.e_res2[7], header.e_res2[8],
1113             header.e_res2[9]);
1114   s->Printf("  e_lfanew   = 0x%8.8x\n", header.e_lfanew);
1115 }
1116 
1117 // DumpCOFFHeader
1118 //
1119 // Dump the COFF header to the specified output stream
1120 void ObjectFilePECOFF::DumpCOFFHeader(Stream *s, const coff_header_t &header) {
1121   s->PutCString("COFF Header\n");
1122   s->Printf("  machine = 0x%4.4x\n", header.machine);
1123   s->Printf("  nsects  = 0x%4.4x\n", header.nsects);
1124   s->Printf("  modtime = 0x%8.8x\n", header.modtime);
1125   s->Printf("  symoff  = 0x%8.8x\n", header.symoff);
1126   s->Printf("  nsyms   = 0x%8.8x\n", header.nsyms);
1127   s->Printf("  hdrsize = 0x%4.4x\n", header.hdrsize);
1128 }
1129 
1130 // DumpOptCOFFHeader
1131 //
1132 // Dump the optional COFF header to the specified output stream
1133 void ObjectFilePECOFF::DumpOptCOFFHeader(Stream *s,
1134                                          const coff_opt_header_t &header) {
1135   s->PutCString("Optional COFF Header\n");
1136   s->Printf("  magic                   = 0x%4.4x\n", header.magic);
1137   s->Printf("  major_linker_version    = 0x%2.2x\n",
1138             header.major_linker_version);
1139   s->Printf("  minor_linker_version    = 0x%2.2x\n",
1140             header.minor_linker_version);
1141   s->Printf("  code_size               = 0x%8.8x\n", header.code_size);
1142   s->Printf("  data_size               = 0x%8.8x\n", header.data_size);
1143   s->Printf("  bss_size                = 0x%8.8x\n", header.bss_size);
1144   s->Printf("  entry                   = 0x%8.8x\n", header.entry);
1145   s->Printf("  code_offset             = 0x%8.8x\n", header.code_offset);
1146   s->Printf("  data_offset             = 0x%8.8x\n", header.data_offset);
1147   s->Printf("  image_base              = 0x%16.16" PRIx64 "\n",
1148             header.image_base);
1149   s->Printf("  sect_alignment          = 0x%8.8x\n", header.sect_alignment);
1150   s->Printf("  file_alignment          = 0x%8.8x\n", header.file_alignment);
1151   s->Printf("  major_os_system_version = 0x%4.4x\n",
1152             header.major_os_system_version);
1153   s->Printf("  minor_os_system_version = 0x%4.4x\n",
1154             header.minor_os_system_version);
1155   s->Printf("  major_image_version     = 0x%4.4x\n",
1156             header.major_image_version);
1157   s->Printf("  minor_image_version     = 0x%4.4x\n",
1158             header.minor_image_version);
1159   s->Printf("  major_subsystem_version = 0x%4.4x\n",
1160             header.major_subsystem_version);
1161   s->Printf("  minor_subsystem_version = 0x%4.4x\n",
1162             header.minor_subsystem_version);
1163   s->Printf("  reserved1               = 0x%8.8x\n", header.reserved1);
1164   s->Printf("  image_size              = 0x%8.8x\n", header.image_size);
1165   s->Printf("  header_size             = 0x%8.8x\n", header.header_size);
1166   s->Printf("  checksum                = 0x%8.8x\n", header.checksum);
1167   s->Printf("  subsystem               = 0x%4.4x\n", header.subsystem);
1168   s->Printf("  dll_flags               = 0x%4.4x\n", header.dll_flags);
1169   s->Printf("  stack_reserve_size      = 0x%16.16" PRIx64 "\n",
1170             header.stack_reserve_size);
1171   s->Printf("  stack_commit_size       = 0x%16.16" PRIx64 "\n",
1172             header.stack_commit_size);
1173   s->Printf("  heap_reserve_size       = 0x%16.16" PRIx64 "\n",
1174             header.heap_reserve_size);
1175   s->Printf("  heap_commit_size        = 0x%16.16" PRIx64 "\n",
1176             header.heap_commit_size);
1177   s->Printf("  loader_flags            = 0x%8.8x\n", header.loader_flags);
1178   s->Printf("  num_data_dir_entries    = 0x%8.8x\n",
1179             (uint32_t)header.data_dirs.size());
1180   uint32_t i;
1181   for (i = 0; i < header.data_dirs.size(); i++) {
1182     s->Printf("  data_dirs[%2u] vmaddr = 0x%8.8x, vmsize = 0x%8.8x\n", i,
1183               header.data_dirs[i].vmaddr, header.data_dirs[i].vmsize);
1184   }
1185 }
1186 // DumpSectionHeader
1187 //
1188 // Dump a single ELF section header to the specified output stream
1189 void ObjectFilePECOFF::DumpSectionHeader(Stream *s,
1190                                          const section_header_t &sh) {
1191   std::string name = GetSectionName(sh);
1192   s->Printf("%-16s 0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x 0x%8.8x 0x%4.4x "
1193             "0x%4.4x 0x%8.8x\n",
1194             name.c_str(), sh.vmaddr, sh.vmsize, sh.offset, sh.size, sh.reloff,
1195             sh.lineoff, sh.nreloc, sh.nline, sh.flags);
1196 }
1197 
1198 // DumpSectionHeaders
1199 //
1200 // Dump all of the ELF section header to the specified output stream
1201 void ObjectFilePECOFF::DumpSectionHeaders(Stream *s) {
1202 
1203   s->PutCString("Section Headers\n");
1204   s->PutCString("IDX  name             vm addr    vm size    file off   file "
1205                 "size  reloc off  line off   nreloc nline  flags\n");
1206   s->PutCString("==== ---------------- ---------- ---------- ---------- "
1207                 "---------- ---------- ---------- ------ ------ ----------\n");
1208 
1209   uint32_t idx = 0;
1210   SectionHeaderCollIter pos, end = m_sect_headers.end();
1211 
1212   for (pos = m_sect_headers.begin(); pos != end; ++pos, ++idx) {
1213     s->Printf("[%2u] ", idx);
1214     ObjectFilePECOFF::DumpSectionHeader(s, *pos);
1215   }
1216 }
1217 
1218 // DumpDependentModules
1219 //
1220 // Dump all of the dependent modules to the specified output stream
1221 void ObjectFilePECOFF::DumpDependentModules(lldb_private::Stream *s) {
1222   auto num_modules = ParseDependentModules();
1223   if (num_modules > 0) {
1224     s->PutCString("Dependent Modules\n");
1225     for (unsigned i = 0; i < num_modules; ++i) {
1226       auto spec = m_deps_filespec->GetFileSpecAtIndex(i);
1227       s->Printf("  %s\n", spec.GetFilename().GetCString());
1228     }
1229   }
1230 }
1231 
1232 bool ObjectFilePECOFF::IsWindowsSubsystem() {
1233   switch (m_coff_header_opt.subsystem) {
1234   case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE:
1235   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_GUI:
1236   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CUI:
1237   case llvm::COFF::IMAGE_SUBSYSTEM_NATIVE_WINDOWS:
1238   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_CE_GUI:
1239   case llvm::COFF::IMAGE_SUBSYSTEM_XBOX:
1240   case llvm::COFF::IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION:
1241     return true;
1242   default:
1243     return false;
1244   }
1245 }
1246 
1247 ArchSpec ObjectFilePECOFF::GetArchitecture() {
1248   uint16_t machine = m_coff_header.machine;
1249   switch (machine) {
1250   default:
1251     break;
1252   case llvm::COFF::IMAGE_FILE_MACHINE_AMD64:
1253   case llvm::COFF::IMAGE_FILE_MACHINE_I386:
1254   case llvm::COFF::IMAGE_FILE_MACHINE_POWERPC:
1255   case llvm::COFF::IMAGE_FILE_MACHINE_POWERPCFP:
1256   case llvm::COFF::IMAGE_FILE_MACHINE_ARM:
1257   case llvm::COFF::IMAGE_FILE_MACHINE_ARMNT:
1258   case llvm::COFF::IMAGE_FILE_MACHINE_THUMB:
1259   case llvm::COFF::IMAGE_FILE_MACHINE_ARM64:
1260     ArchSpec arch;
1261     arch.SetArchitecture(eArchTypeCOFF, machine, LLDB_INVALID_CPUTYPE,
1262                          IsWindowsSubsystem() ? llvm::Triple::Win32
1263                                               : llvm::Triple::UnknownOS);
1264     return arch;
1265   }
1266   return ArchSpec();
1267 }
1268 
1269 ObjectFile::Type ObjectFilePECOFF::CalculateType() {
1270   if (m_coff_header.machine != 0) {
1271     if ((m_coff_header.flags & llvm::COFF::IMAGE_FILE_DLL) == 0)
1272       return eTypeExecutable;
1273     else
1274       return eTypeSharedLibrary;
1275   }
1276   return eTypeExecutable;
1277 }
1278 
1279 ObjectFile::Strata ObjectFilePECOFF::CalculateStrata() { return eStrataUser; }
1280 
1281 // PluginInterface protocol
1282 ConstString ObjectFilePECOFF::GetPluginName() { return GetPluginNameStatic(); }
1283 
1284 uint32_t ObjectFilePECOFF::GetPluginVersion() { return 1; }
1285