1 //===-- ObjectFilePECOFF.h --------------------------------------*- 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 #ifndef liblldb_ObjectFilePECOFF_h_ 10 #define liblldb_ObjectFilePECOFF_h_ 11 12 #include <vector> 13 14 #include "lldb/Symbol/ObjectFile.h" 15 #include "llvm/Object/Binary.h" 16 17 class ObjectFilePECOFF : public lldb_private::ObjectFile { 18 public: 19 enum MachineType { 20 MachineUnknown = 0x0, 21 MachineAm33 = 0x1d3, 22 MachineAmd64 = 0x8664, 23 MachineArm = 0x1c0, 24 MachineArmNt = 0x1c4, 25 MachineArm64 = 0xaa64, 26 MachineEbc = 0xebc, 27 MachineX86 = 0x14c, 28 MachineIA64 = 0x200, 29 MachineM32R = 0x9041, 30 MachineMips16 = 0x266, 31 MachineMipsFpu = 0x366, 32 MachineMipsFpu16 = 0x466, 33 MachinePowerPc = 0x1f0, 34 MachinePowerPcfp = 0x1f1, 35 MachineR4000 = 0x166, 36 MachineSh3 = 0x1a2, 37 MachineSh3dsp = 0x1a3, 38 MachineSh4 = 0x1a6, 39 MachineSh5 = 0x1a8, 40 MachineThumb = 0x1c2, 41 MachineWcemIpsv2 = 0x169 42 }; 43 44 ObjectFilePECOFF(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, 45 lldb::offset_t data_offset, 46 const lldb_private::FileSpec *file, 47 lldb::offset_t file_offset, lldb::offset_t length); 48 49 ObjectFilePECOFF(const lldb::ModuleSP &module_sp, 50 lldb::DataBufferSP &header_data_sp, 51 const lldb::ProcessSP &process_sp, lldb::addr_t header_addr); 52 53 ~ObjectFilePECOFF() override; 54 55 // Static Functions 56 static void Initialize(); 57 58 static void Terminate(); 59 60 static lldb_private::ConstString GetPluginNameStatic(); 61 62 static const char *GetPluginDescriptionStatic(); 63 64 static ObjectFile * 65 CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, 66 lldb::offset_t data_offset, const lldb_private::FileSpec *file, 67 lldb::offset_t offset, lldb::offset_t length); 68 69 static lldb_private::ObjectFile *CreateMemoryInstance( 70 const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, 71 const lldb::ProcessSP &process_sp, lldb::addr_t header_addr); 72 73 static size_t GetModuleSpecifications(const lldb_private::FileSpec &file, 74 lldb::DataBufferSP &data_sp, 75 lldb::offset_t data_offset, 76 lldb::offset_t file_offset, 77 lldb::offset_t length, 78 lldb_private::ModuleSpecList &specs); 79 80 static bool SaveCore(const lldb::ProcessSP &process_sp, 81 const lldb_private::FileSpec &outfile, 82 lldb_private::Status &error); 83 84 static bool MagicBytesMatch(lldb::DataBufferSP &data_sp); 85 86 static lldb::SymbolType MapSymbolType(uint16_t coff_symbol_type); 87 88 bool ParseHeader() override; 89 90 bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value, 91 bool value_is_offset) override; 92 93 lldb::ByteOrder GetByteOrder() const override; 94 95 bool IsExecutable() const override; 96 97 uint32_t GetAddressByteSize() const override; 98 99 // virtual lldb_private::AddressClass 100 // GetAddressClass (lldb::addr_t file_addr); 101 102 lldb_private::Symtab *GetSymtab() override; 103 104 bool IsStripped() override; 105 106 void CreateSections(lldb_private::SectionList &unified_section_list) override; 107 108 void Dump(lldb_private::Stream *s) override; 109 110 lldb_private::ArchSpec GetArchitecture() override; 111 112 lldb_private::UUID GetUUID() override; 113 114 uint32_t GetDependentModules(lldb_private::FileSpecList &files) override; 115 116 lldb_private::Address GetEntryPointAddress() override; 117 118 lldb_private::Address GetBaseAddress() override; 119 120 ObjectFile::Type CalculateType() override; 121 122 ObjectFile::Strata CalculateStrata() override; 123 124 // PluginInterface protocol 125 lldb_private::ConstString GetPluginName() override; 126 127 uint32_t GetPluginVersion() override; 128 129 bool IsWindowsSubsystem(); 130 131 lldb_private::DataExtractor ReadImageData(uint32_t offset, size_t size); 132 133 protected: 134 bool NeedsEndianSwap() const; 135 136 typedef struct dos_header { // DOS .EXE header 137 uint16_t e_magic; // Magic number 138 uint16_t e_cblp; // Bytes on last page of file 139 uint16_t e_cp; // Pages in file 140 uint16_t e_crlc; // Relocations 141 uint16_t e_cparhdr; // Size of header in paragraphs 142 uint16_t e_minalloc; // Minimum extra paragraphs needed 143 uint16_t e_maxalloc; // Maximum extra paragraphs needed 144 uint16_t e_ss; // Initial (relative) SS value 145 uint16_t e_sp; // Initial SP value 146 uint16_t e_csum; // Checksum 147 uint16_t e_ip; // Initial IP value 148 uint16_t e_cs; // Initial (relative) CS value 149 uint16_t e_lfarlc; // File address of relocation table 150 uint16_t e_ovno; // Overlay number 151 uint16_t e_res[4]; // Reserved words 152 uint16_t e_oemid; // OEM identifier (for e_oeminfo) 153 uint16_t e_oeminfo; // OEM information; e_oemid specific 154 uint16_t e_res2[10]; // Reserved words 155 uint32_t e_lfanew; // File address of new exe header 156 } dos_header_t; 157 158 typedef struct coff_header { 159 uint16_t machine; 160 uint16_t nsects; 161 uint32_t modtime; 162 uint32_t symoff; 163 uint32_t nsyms; 164 uint16_t hdrsize; 165 uint16_t flags; 166 } coff_header_t; 167 168 typedef struct data_directory { 169 uint32_t vmaddr; 170 uint32_t vmsize; 171 } data_directory_t; 172 173 typedef struct coff_opt_header { 174 uint16_t magic; 175 uint8_t major_linker_version; 176 uint8_t minor_linker_version; 177 uint32_t code_size; 178 uint32_t data_size; 179 uint32_t bss_size; 180 uint32_t entry; 181 uint32_t code_offset; 182 uint32_t data_offset; 183 184 uint64_t image_base; 185 uint32_t sect_alignment; 186 uint32_t file_alignment; 187 uint16_t major_os_system_version; 188 uint16_t minor_os_system_version; 189 uint16_t major_image_version; 190 uint16_t minor_image_version; 191 uint16_t major_subsystem_version; 192 uint16_t minor_subsystem_version; 193 uint32_t reserved1; 194 uint32_t image_size; 195 uint32_t header_size; 196 uint32_t checksum; 197 uint16_t subsystem; 198 uint16_t dll_flags; 199 uint64_t stack_reserve_size; 200 uint64_t stack_commit_size; 201 uint64_t heap_reserve_size; 202 uint64_t heap_commit_size; 203 uint32_t loader_flags; 204 // uint32_t num_data_dir_entries; 205 std::vector<data_directory> 206 data_dirs; // will contain num_data_dir_entries entries 207 } coff_opt_header_t; 208 209 enum coff_data_dir_type { 210 coff_data_dir_export_table = 0, 211 coff_data_dir_import_table = 1, 212 }; 213 214 typedef struct section_header { 215 char name[8]; 216 uint32_t vmsize; // Virtual Size 217 uint32_t vmaddr; // Virtual Addr 218 uint32_t size; // File size 219 uint32_t offset; // File offset 220 uint32_t reloff; // Offset to relocations 221 uint32_t lineoff; // Offset to line table entries 222 uint16_t nreloc; // Number of relocation entries 223 uint16_t nline; // Number of line table entries 224 uint32_t flags; 225 } section_header_t; 226 227 typedef struct coff_symbol { 228 char name[8]; 229 uint32_t value; 230 uint16_t sect; 231 uint16_t type; 232 uint8_t storage; 233 uint8_t naux; 234 } coff_symbol_t; 235 236 typedef struct export_directory_entry { 237 uint32_t characteristics; 238 uint32_t time_date_stamp; 239 uint16_t major_version; 240 uint16_t minor_version; 241 uint32_t name; 242 uint32_t base; 243 uint32_t number_of_functions; 244 uint32_t number_of_names; 245 uint32_t address_of_functions; 246 uint32_t address_of_names; 247 uint32_t address_of_name_ordinals; 248 } export_directory_entry; 249 250 static bool ParseDOSHeader(lldb_private::DataExtractor &data, 251 dos_header_t &dos_header); 252 static bool ParseCOFFHeader(lldb_private::DataExtractor &data, 253 lldb::offset_t *offset_ptr, 254 coff_header_t &coff_header); 255 bool ParseCOFFOptionalHeader(lldb::offset_t *offset_ptr); 256 bool ParseSectionHeaders(uint32_t offset); 257 258 uint32_t ParseDependentModules(); 259 260 static void DumpDOSHeader(lldb_private::Stream *s, 261 const dos_header_t &header); 262 static void DumpCOFFHeader(lldb_private::Stream *s, 263 const coff_header_t &header); 264 static void DumpOptCOFFHeader(lldb_private::Stream *s, 265 const coff_opt_header_t &header); 266 void DumpSectionHeaders(lldb_private::Stream *s); 267 void DumpSectionHeader(lldb_private::Stream *s, const section_header_t &sh); 268 void DumpDependentModules(lldb_private::Stream *s); 269 270 llvm::StringRef GetSectionName(const section_header_t §); 271 272 typedef std::vector<section_header_t> SectionHeaderColl; 273 typedef SectionHeaderColl::iterator SectionHeaderCollIter; 274 typedef SectionHeaderColl::const_iterator SectionHeaderCollConstIter; 275 276 private: 277 bool CreateBinary(); 278 279 private: 280 dos_header_t m_dos_header; 281 coff_header_t m_coff_header; 282 coff_opt_header_t m_coff_header_opt; 283 SectionHeaderColl m_sect_headers; 284 lldb::addr_t m_image_base; 285 lldb_private::Address m_entry_point_address; 286 llvm::Optional<lldb_private::FileSpecList> m_deps_filespec; 287 typedef llvm::object::OwningBinary<llvm::object::Binary> OWNBINType; 288 llvm::Optional<OWNBINType> m_owningbin; 289 lldb_private::UUID m_uuid; 290 }; 291 292 #endif // liblldb_ObjectFilePECOFF_h_ 293