LLDB mainline
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ObjectFilePECOFF Class Reference

#include <ObjectFilePECOFF.h>

Inheritance diagram for ObjectFilePECOFF:
Inheritance graph
[legend]

Classes

struct  coff_header
 
struct  coff_opt_header
 
struct  data_directory
 
struct  dos_header
 
struct  section_header
 

Public Types

enum  MachineType {
  MachineUnknown = 0x0 , MachineAm33 = 0x1d3 , MachineAmd64 = 0x8664 , MachineArm = 0x1c0 ,
  MachineArmNt = 0x1c4 , MachineArm64 = 0xaa64 , MachineArm64X = 0xa64e , MachineEbc = 0xebc ,
  MachineX86 = 0x14c , MachineIA64 = 0x200 , MachineM32R = 0x9041 , MachineMips16 = 0x266 ,
  MachineMipsFpu = 0x366 , MachineMipsFpu16 = 0x466 , MachinePowerPc = 0x1f0 , MachinePowerPcfp = 0x1f1 ,
  MachineR4000 = 0x166 , MachineSh3 = 0x1a2 , MachineSh3dsp = 0x1a3 , MachineSh4 = 0x1a6 ,
  MachineSh5 = 0x1a8 , MachineThumb = 0x1c2 , MachineWcemIpsv2 = 0x169
}
 
- Public Types inherited from lldb_private::ObjectFile
enum  Type {
  eTypeInvalid = 0 , eTypeCoreFile , eTypeExecutable , eTypeDebugInfo ,
  eTypeDynamicLinker , eTypeObjectFile , eTypeSharedLibrary , eTypeStubLibrary ,
  eTypeJIT , eTypeUnknown
}
 
enum  Strata {
  eStrataInvalid = 0 , eStrataUnknown , eStrataUser , eStrataKernel ,
  eStrataRawImage , eStrataJIT
}
 
enum  BinaryType {
  eBinaryTypeInvalid = 0 , eBinaryTypeUnknown , eBinaryTypeKernel , eBinaryTypeUser ,
  eBinaryTypeStandalone
}
 If we have a corefile binary hint, this enum specifies the binary type which we can use to select the correct DynamicLoader plugin. More...
 

Public Member Functions

 ObjectFilePECOFF (const lldb::ModuleSP &module_sp, lldb::DataBufferSP data_sp, lldb::offset_t data_offset, const lldb_private::FileSpec *file, lldb::offset_t file_offset, lldb::offset_t length)
 
 ObjectFilePECOFF (const lldb::ModuleSP &module_sp, lldb::WritableDataBufferSP header_data_sp, const lldb::ProcessSP &process_sp, lldb::addr_t header_addr)
 
 ~ObjectFilePECOFF () override
 
bool isA (const void *ClassID) const override
 
bool ParseHeader () override
 Attempts to parse the object header.
 
bool SetLoadAddress (lldb_private::Target &target, lldb::addr_t value, bool value_is_offset) override
 Sets the load address for an entire module, assuming a rigid slide of sections, if possible in the implementation.
 
lldb::ByteOrder GetByteOrder () const override
 Gets whether endian swapping should occur when extracting data from this object file.
 
bool IsExecutable () const override
 Tells whether this object file is capable of being the main executable for a process.
 
uint32_t GetAddressByteSize () const override
 Gets the address size in bytes for the current object file.
 
void ParseSymtab (lldb_private::Symtab &symtab) override
 Parse the symbol table into the provides symbol table object.
 
bool IsStripped () override
 Detect if this object file has been stripped of local symbols.
 
void CreateSections (lldb_private::SectionList &unified_section_list) override
 
void Dump (lldb_private::Stream *s) override
 Dump a description of this object to a Stream.
 
lldb_private::ArchSpec GetArchitecture () override
 Get the ArchSpec for this object file.
 
lldb_private::UUID GetUUID () override
 Gets the UUID for this object file.
 
std::optional< lldb_private::FileSpecGetDebugLink ()
 Return the contents of the .gnu_debuglink section, if the object file contains it.
 
uint32_t GetDependentModules (lldb_private::FileSpecList &files) override
 Extract the dependent modules from an object file.
 
lldb_private::Address GetEntryPointAddress () override
 Returns the address of the Entry Point in this object file - if the object file doesn't have an entry point (because it is not an executable file) then an invalid address is returned.
 
lldb_private::Address GetBaseAddress () override
 Returns base address of this object file.
 
ObjectFile::Type CalculateType () override
 The object file should be able to calculate its type by looking at its file header and possibly the sections or other data in the object file.
 
ObjectFile::Strata CalculateStrata () override
 The object file should be able to calculate the strata of the object file.
 
llvm::StringRef GetPluginName () override
 
bool IsWindowsSubsystem ()
 
uint32_t GetRVA (const lldb_private::Address &addr) const
 
lldb_private::Address GetAddress (uint32_t rva)
 
lldb::addr_t GetFileAddress (uint32_t rva) const
 
lldb_private::DataExtractor ReadImageData (uint32_t offset, size_t size)
 
lldb_private::DataExtractor ReadImageDataByRVA (uint32_t rva, size_t size)
 
std::unique_ptr< lldb_private::CallFrameInfoCreateCallFrameInfo () override
 Creates a plugin-specific call frame info.
 
- Public Member Functions inherited from lldb_private::ObjectFile
 ObjectFile (const lldb::ModuleSP &module_sp, const FileSpec *file_spec_ptr, lldb::offset_t file_offset, lldb::offset_t length, lldb::DataBufferSP data_sp, lldb::offset_t data_offset)
 Construct with a parent module, offset, and header data.
 
 ObjectFile (const lldb::ModuleSP &module_sp, const lldb::ProcessSP &process_sp, lldb::addr_t header_addr, lldb::DataBufferSP data_sp)
 
 ~ObjectFile () override
 Destructor.
 
virtual void Dump (Stream *s)=0
 Dump a description of this object to a Stream.
 
virtual bool isA (const void *ClassID) const
 
virtual uint32_t GetAddressByteSize () const =0
 Gets the address size in bytes for the current object file.
 
virtual AddressClass GetAddressClass (lldb::addr_t file_addr)
 Get the address type given a file address in an object file.
 
virtual uint32_t GetDependentModules (FileSpecList &file_list)=0
 Extract the dependent modules from an object file.
 
virtual bool IsExecutable () const =0
 Tells whether this object file is capable of being the main executable for a process.
 
virtual lldb::addr_t GetFileOffset () const
 Returns the offset into a file at which this object resides.
 
virtual lldb::addr_t GetByteSize () const
 
virtual FileSpecGetFileSpec ()
 Get accessor to the object file specification.
 
virtual const FileSpecGetFileSpec () const
 Get const accessor to the object file specification.
 
virtual ArchSpec GetArchitecture ()=0
 Get the ArchSpec for this object file.
 
virtual SectionListGetSectionList (bool update_module_section_list=true)
 Gets the section list for the currently selected architecture (and object for archives).
 
virtual void CreateSections (SectionList &unified_section_list)=0
 
virtual void SectionFileAddressesChanged ()
 Notify the ObjectFile that the file addresses in the Sections for this module have been changed.
 
SymtabGetSymtab ()
 Gets the symbol table for the currently selected architecture (and object for archives).
 
virtual void ParseSymtab (Symtab &symtab)=0
 Parse the symbol table into the provides symbol table object.
 
virtual void RelocateSection (lldb_private::Section *section)
 Perform relocations on the section if necessary.
 
virtual SymbolResolveSymbolForAddress (const Address &so_addr, bool verify_unique)
 Appends a Symbol for the specified so_addr to the symbol table.
 
virtual bool IsStripped ()=0
 Detect if this object file has been stripped of local symbols.
 
virtual void ClearSymtab ()
 Frees the symbol table.
 
virtual UUID GetUUID ()=0
 Gets the UUID for this object file.
 
virtual lldb_private::FileSpecList GetReExportedLibraries ()
 Gets the file spec list of libraries re-exported by this object file.
 
virtual bool SetLoadAddress (Target &target, lldb::addr_t value, bool value_is_offset)
 Sets the load address for an entire module, assuming a rigid slide of sections, if possible in the implementation.
 
virtual lldb::ByteOrder GetByteOrder () const =0
 Gets whether endian swapping should occur when extracting data from this object file.
 
virtual bool ParseHeader ()=0
 Attempts to parse the object header.
 
virtual bool AllowAssemblyEmulationUnwindPlans ()
 Returns if the function bounds for symbols in this symbol file are likely accurate.
 
virtual lldb_private::Address GetImageInfoAddress (Target *target)
 Similar to Process::GetImageInfoAddress().
 
virtual lldb_private::Address GetEntryPointAddress ()
 Returns the address of the Entry Point in this object file - if the object file doesn't have an entry point (because it is not an executable file) then an invalid address is returned.
 
virtual lldb_private::Address GetBaseAddress ()
 Returns base address of this object file.
 
virtual uint32_t GetNumThreadContexts ()
 
virtual std::string GetIdentifierString ()
 Some object files may have an identifier string embedded in them, e.g.
 
virtual lldb_private::AddressableBits GetAddressableBits ()
 Some object files may have the number of bits used for addressing embedded in them, e.g.
 
virtual bool GetCorefileMainBinaryInfo (lldb::addr_t &value, bool &value_is_offset, UUID &uuid, ObjectFile::BinaryType &type)
 When the ObjectFile is a core file, lldb needs to locate the "binary" in the core file.
 
virtual bool GetCorefileThreadExtraInfos (std::vector< lldb::tid_t > &tids)
 Get metadata about threads from the corefile.
 
virtual lldb::RegisterContextSP GetThreadContextAtIndex (uint32_t idx, lldb_private::Thread &thread)
 
virtual Type CalculateType ()=0
 The object file should be able to calculate its type by looking at its file header and possibly the sections or other data in the object file.
 
virtual void SetType (Type type)
 In cases where the type can't be calculated (elf files), this routine allows someone to explicitly set it.
 
virtual Strata CalculateStrata ()=0
 The object file should be able to calculate the strata of the object file.
 
virtual llvm::VersionTuple GetVersion ()
 Get the object file version numbers.
 
virtual llvm::VersionTuple GetMinimumOSVersion ()
 Get the minimum OS version this object file can run on.
 
virtual llvm::VersionTuple GetSDKVersion ()
 Get the SDK OS version this object file was built with.
 
virtual bool GetIsDynamicLinkEditor ()
 Return true if this file is a dynamic link editor (dyld)
 
Type GetType ()
 
Strata GetStrata ()
 
size_t GetData (lldb::offset_t offset, size_t length, DataExtractor &data) const
 
size_t CopyData (lldb::offset_t offset, size_t length, void *dst) const
 
virtual size_t ReadSectionData (Section *section, lldb::offset_t section_offset, void *dst, size_t dst_len)
 
virtual size_t ReadSectionData (Section *section, DataExtractor &section_data)
 
virtual size_t GetSectionDataSize (Section *section)
 
bool IsInMemory () const
 Returns true if the object file exists only in memory.
 
virtual llvm::StringRef StripLinkerSymbolAnnotations (llvm::StringRef symbol_name) const
 
virtual bool CanTrustAddressRanges ()
 Can we trust the address ranges accelerator associated with this object file to be complete.
 
virtual std::vector< LoadableDataGetLoadableData (Target &target)
 Loads this objfile to memory.
 
virtual std::unique_ptr< CallFrameInfoCreateCallFrameInfo ()
 Creates a plugin-specific call frame info.
 
virtual bool LoadCoreFileImages (lldb_private::Process &process)
 Load binaries listed in a corefile.
 
uint32_t GetCacheHash ()
 Get a hash that can be used for caching object file releated information.
 
- Public Member Functions inherited from lldb_private::PluginInterface
 PluginInterface ()=default
 
virtual ~PluginInterface ()=default
 
virtual llvm::StringRef GetPluginName ()=0
 
 PluginInterface (const PluginInterface &)=delete
 
PluginInterfaceoperator= (const PluginInterface &)=delete
 
- Public Member Functions inherited from lldb_private::ModuleChild
 ModuleChild (const lldb::ModuleSP &module_sp)
 Construct with owning module.
 
 ~ModuleChild ()
 Destructor.
 
const ModuleChildoperator= (const ModuleChild &rhs)
 Assignment operator.
 
lldb::ModuleSP GetModule () const
 Get const accessor for the module pointer.
 
void SetModule (const lldb::ModuleSP &module_sp)
 Set accessor for the module pointer.
 

Static Public Member Functions

static void Initialize ()
 
static void DebuggerInitialize (lldb_private::Debugger &debugger)
 
static void Terminate ()
 
static llvm::StringRef GetPluginNameStatic ()
 
static llvm::StringRef GetPluginDescriptionStatic ()
 
static ObjectFileCreateInstance (const lldb::ModuleSP &module_sp, lldb::DataBufferSP data_sp, lldb::offset_t data_offset, const lldb_private::FileSpec *file, lldb::offset_t offset, lldb::offset_t length)
 
static lldb_private::ObjectFileCreateMemoryInstance (const lldb::ModuleSP &module_sp, lldb::WritableDataBufferSP data_sp, const lldb::ProcessSP &process_sp, lldb::addr_t header_addr)
 
static size_t GetModuleSpecifications (const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp, lldb::offset_t data_offset, lldb::offset_t file_offset, lldb::offset_t length, lldb_private::ModuleSpecList &specs)
 
static bool SaveCore (const lldb::ProcessSP &process_sp, const lldb_private::SaveCoreOptions &options, lldb_private::Status &error)
 
static bool MagicBytesMatch (lldb::DataBufferSP data_sp)
 
static lldb::SymbolType MapSymbolType (uint16_t coff_symbol_type)
 
static bool classof (const ObjectFile *obj)
 
- Static Public Member Functions inherited from lldb_private::ObjectFile
static lldb::ObjectFileSP FindPlugin (const lldb::ModuleSP &module_sp, const FileSpec *file_spec, lldb::offset_t file_offset, lldb::offset_t file_size, lldb::DataBufferSP &data_sp, lldb::offset_t &data_offset)
 Find a ObjectFile plug-in that can parse file_spec.
 
static lldb::ObjectFileSP FindPlugin (const lldb::ModuleSP &module_sp, const lldb::ProcessSP &process_sp, lldb::addr_t header_addr, lldb::WritableDataBufferSP file_data_sp)
 Find a ObjectFile plug-in that can parse a file in memory.
 
static size_t GetModuleSpecifications (const FileSpec &file, lldb::offset_t file_offset, lldb::offset_t file_size, ModuleSpecList &specs, lldb::DataBufferSP data_sp=lldb::DataBufferSP())
 
static size_t GetModuleSpecifications (const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp, lldb::offset_t data_offset, lldb::offset_t file_offset, lldb::offset_t file_size, lldb_private::ModuleSpecList &specs)
 
static bool IsObjectFile (lldb_private::FileSpec file_spec)
 
static bool SplitArchivePathWithObject (llvm::StringRef path_with_object, lldb_private::FileSpec &archive_file, lldb_private::ConstString &archive_object, bool must_exist)
 Split a path into a file path with object name.
 
static lldb::DataBufferSP ReadMemory (const lldb::ProcessSP &process_sp, lldb::addr_t addr, size_t byte_size)
 
static lldb::SymbolType GetSymbolTypeFromName (llvm::StringRef name, lldb::SymbolType symbol_type_hint=lldb::eSymbolTypeUndefined)
 
static lldb::DataBufferSP MapFileData (const FileSpec &file, uint64_t Size, uint64_t Offset)
 

Static Public Attributes

static char ID
 
- Static Public Attributes inherited from lldb_private::ObjectFile
static char ID
 

Protected Types

typedef struct ObjectFilePECOFF::dos_header dos_header_t
 
typedef struct ObjectFilePECOFF::coff_header coff_header_t
 
typedef struct ObjectFilePECOFF::data_directory data_directory_t
 
typedef struct ObjectFilePECOFF::coff_opt_header coff_opt_header_t
 
typedef struct ObjectFilePECOFF::section_header section_header_t
 
typedef std::vector< section_header_tSectionHeaderColl
 
typedef SectionHeaderColl::iterator SectionHeaderCollIter
 
typedef SectionHeaderColl::const_iterator SectionHeaderCollConstIter
 

Protected Member Functions

bool NeedsEndianSwap () const
 
bool ParseCOFFOptionalHeader (lldb::offset_t *offset_ptr)
 
bool ParseSectionHeaders (uint32_t offset)
 
uint32_t ParseDependentModules ()
 
void DumpSectionHeaders (lldb_private::Stream *s)
 
void DumpSectionHeader (lldb_private::Stream *s, const section_header_t &sh)
 
void DumpDependentModules (lldb_private::Stream *s)
 
llvm::StringRef GetSectionName (const section_header_t &sect)
 
size_t GetSectionDataSize (lldb_private::Section *section) override
 
- Protected Member Functions inherited from lldb_private::ObjectFile
bool SetModulesArchitecture (const ArchSpec &new_arch)
 Sets the architecture for a module.
 

Static Protected Member Functions

static bool ParseDOSHeader (lldb_private::DataExtractor &data, dos_header_t &dos_header)
 
static bool ParseCOFFHeader (lldb_private::DataExtractor &data, lldb::offset_t *offset_ptr, coff_header_t &coff_header)
 
static void DumpDOSHeader (lldb_private::Stream *s, const dos_header_t &header)
 
static void DumpCOFFHeader (lldb_private::Stream *s, const coff_header_t &header)
 
static void DumpOptCOFFHeader (lldb_private::Stream *s, const coff_opt_header_t &header)
 
static lldb::SectionType GetSectionType (llvm::StringRef sect_name, const section_header_t &sect)
 

Private Types

typedef std::vector< std::pair< uint32_t, uint32_t > > rva_symbol_list_t
 

Private Member Functions

bool CreateBinary ()
 
void AppendFromCOFFSymbolTable (lldb_private::SectionList *sect_list, lldb_private::Symtab &symtab, const rva_symbol_list_t &sorted_exports)
 
rva_symbol_list_t AppendFromExportTable (lldb_private::SectionList *sect_list, lldb_private::Symtab &symtab)
 

Private Attributes

dos_header_t m_dos_header
 
coff_header_t m_coff_header
 
coff_opt_header_t m_coff_header_opt
 
SectionHeaderColl m_sect_headers
 
lldb::addr_t m_image_base
 
lldb_private::Address m_entry_point_address
 
std::optional< lldb_private::FileSpecListm_deps_filespec
 
std::unique_ptr< llvm::object::COFFObjectFile > m_binary
 
lldb_private::UUID m_uuid
 

Additional Inherited Members

- Protected Attributes inherited from lldb_private::ObjectFile
FileSpec m_file
 
Type m_type
 
Strata m_strata
 
lldb::addr_t m_file_offset
 The offset in bytes into the file, or the address in memory.
 
lldb::addr_t m_length
 The length of this object file if it is known (can be zero if length is unknown or can't be determined).
 
DataExtractor m_data
 The data for this object file so things can be parsed lazily.
 
lldb::ProcessWP m_process_wp
 
const lldb::addr_t m_memory_addr
 Set if the object file only exists in memory.
 
std::unique_ptr< lldb_private::SectionListm_sections_up
 
std::unique_ptr< lldb_private::Symtabm_symtab_up
 
std::unique_ptr< llvm::once_flag > m_symtab_once_up
 We need a llvm::once_flag that we can use to avoid locking the module lock and deadlocking LLDB.
 
std::optional< uint32_t > m_cache_hash
 
- Protected Attributes inherited from lldb_private::ModuleChild
lldb::ModuleWP m_module_wp
 The Module that owns the object that inherits from this class.
 
- Static Protected Attributes inherited from lldb_private::ObjectFile
static size_t g_initial_bytes_to_read = 512
 The number of bytes to read when going through the plugins.
 

Detailed Description

Definition at line 18 of file ObjectFilePECOFF.h.

Member Typedef Documentation

◆ coff_header_t

◆ coff_opt_header_t

◆ data_directory_t

◆ dos_header_t

◆ rva_symbol_list_t

typedef std::vector<std::pair<uint32_t, uint32_t> > ObjectFilePECOFF::rva_symbol_list_t
private

Definition at line 273 of file ObjectFilePECOFF.h.

◆ section_header_t

◆ SectionHeaderColl

typedef std::vector<section_header_t> ObjectFilePECOFF::SectionHeaderColl
protected

Definition at line 267 of file ObjectFilePECOFF.h.

◆ SectionHeaderCollConstIter

typedef SectionHeaderColl::const_iterator ObjectFilePECOFF::SectionHeaderCollConstIter
protected

Definition at line 269 of file ObjectFilePECOFF.h.

◆ SectionHeaderCollIter

typedef SectionHeaderColl::iterator ObjectFilePECOFF::SectionHeaderCollIter
protected

Definition at line 268 of file ObjectFilePECOFF.h.

Member Enumeration Documentation

◆ MachineType

Enumerator
MachineUnknown 
MachineAm33 
MachineAmd64 
MachineArm 
MachineArmNt 
MachineArm64 
MachineArm64X 
MachineEbc 
MachineX86 
MachineIA64 
MachineM32R 
MachineMips16 
MachineMipsFpu 
MachineMipsFpu16 
MachinePowerPc 
MachinePowerPcfp 
MachineR4000 
MachineSh3 
MachineSh3dsp 
MachineSh4 
MachineSh5 
MachineThumb 
MachineWcemIpsv2 

Definition at line 20 of file ObjectFilePECOFF.h.

Constructor & Destructor Documentation

◆ ObjectFilePECOFF() [1/2]

ObjectFilePECOFF::ObjectFilePECOFF ( const lldb::ModuleSP module_sp,
lldb::DataBufferSP  data_sp,
lldb::offset_t  data_offset,
const lldb_private::FileSpec file,
lldb::offset_t  file_offset,
lldb::offset_t  length 
)

Definition at line 417 of file ObjectFilePECOFF.cpp.

◆ ObjectFilePECOFF() [2/2]

ObjectFilePECOFF::ObjectFilePECOFF ( const lldb::ModuleSP module_sp,
lldb::WritableDataBufferSP  header_data_sp,
const lldb::ProcessSP process_sp,
lldb::addr_t  header_addr 
)

Definition at line 428 of file ObjectFilePECOFF.cpp.

◆ ~ObjectFilePECOFF()

ObjectFilePECOFF::~ObjectFilePECOFF ( )
overridedefault

Member Function Documentation

◆ AppendFromCOFFSymbolTable()

void ObjectFilePECOFF::AppendFromCOFFSymbolTable ( lldb_private::SectionList sect_list,
lldb_private::Symtab symtab,
const rva_symbol_list_t sorted_exports 
)
private

◆ AppendFromExportTable()

ObjectFilePECOFF::rva_symbol_list_t ObjectFilePECOFF::AppendFromExportTable ( lldb_private::SectionList sect_list,
lldb_private::Symtab symtab 
)
private

◆ CalculateStrata()

ObjectFile::Strata ObjectFilePECOFF::CalculateStrata ( )
overridevirtual

The object file should be able to calculate the strata of the object file.

Many object files for platforms might be for either user space debugging or for kernel debugging. If your object file subclass can figure this out, it will help with debugger plug-in selection when it comes time to debug.

Returns
The calculated object file strata for the current object file.

Implements lldb_private::ObjectFile.

Definition at line 1431 of file ObjectFilePECOFF.cpp.

References lldb_private::ObjectFile::eStrataUser.

◆ CalculateType()

ObjectFile::Type ObjectFilePECOFF::CalculateType ( )
overridevirtual

The object file should be able to calculate its type by looking at its file header and possibly the sections or other data in the object file.

The file type is used in the debugger to help select the correct plug- ins for the job at hand, so this is important to get right. If any eTypeXXX definitions do not match up with the type of file you are loading, please feel free to add a new enumeration value.

Returns
The calculated file type for the current object file.

Implements lldb_private::ObjectFile.

Definition at line 1421 of file ObjectFilePECOFF.cpp.

References lldb_private::ObjectFile::eTypeExecutable, lldb_private::ObjectFile::eTypeSharedLibrary, ObjectFilePECOFF::coff_header::flags, m_coff_header, and ObjectFilePECOFF::coff_header::machine.

◆ classof()

static bool ObjectFilePECOFF::classof ( const ObjectFile obj)
inlinestatic

Definition at line 97 of file ObjectFilePECOFF.h.

References ID.

◆ CreateBinary()

bool ObjectFilePECOFF::CreateBinary ( )
private

◆ CreateCallFrameInfo()

std::unique_ptr< CallFrameInfo > ObjectFilePECOFF::CreateCallFrameInfo ( )
overridevirtual

◆ CreateInstance()

ObjectFile * ObjectFilePECOFF::CreateInstance ( const lldb::ModuleSP module_sp,
lldb::DataBufferSP  data_sp,
lldb::offset_t  data_offset,
const lldb_private::FileSpec file,
lldb::offset_t  offset,
lldb::offset_t  length 
)
static

Definition at line 204 of file ObjectFilePECOFF.cpp.

References MagicBytesMatch(), and lldb_private::ObjectFile::MapFileData().

Referenced by Initialize(), and Terminate().

◆ CreateMemoryInstance()

ObjectFile * ObjectFilePECOFF::CreateMemoryInstance ( const lldb::ModuleSP module_sp,
lldb::WritableDataBufferSP  data_sp,
const lldb::ProcessSP process_sp,
lldb::addr_t  header_addr 
)
static

Definition at line 237 of file ObjectFilePECOFF.cpp.

References MagicBytesMatch().

Referenced by Initialize().

◆ CreateSections()

void ObjectFilePECOFF::CreateSections ( lldb_private::SectionList unified_section_list)
overridevirtual

◆ DebuggerInitialize()

void ObjectFilePECOFF::DebuggerInitialize ( lldb_private::Debugger debugger)
static

◆ Dump()

void ObjectFilePECOFF::Dump ( lldb_private::Stream s)
overridevirtual

◆ DumpCOFFHeader()

void ObjectFilePECOFF::DumpCOFFHeader ( lldb_private::Stream s,
const coff_header_t header 
)
staticprotected

◆ DumpDependentModules()

void ObjectFilePECOFF::DumpDependentModules ( lldb_private::Stream s)
protected

◆ DumpDOSHeader()

void ObjectFilePECOFF::DumpDOSHeader ( lldb_private::Stream s,
const dos_header_t header 
)
staticprotected

◆ DumpOptCOFFHeader()

void ObjectFilePECOFF::DumpOptCOFFHeader ( lldb_private::Stream s,
const coff_opt_header_t header 
)
staticprotected

Definition at line 1285 of file ObjectFilePECOFF.cpp.

References ObjectFilePECOFF::coff_opt_header::bss_size, ObjectFilePECOFF::coff_opt_header::checksum, ObjectFilePECOFF::coff_opt_header::code_offset, ObjectFilePECOFF::coff_opt_header::code_size, ObjectFilePECOFF::coff_opt_header::data_dirs, ObjectFilePECOFF::coff_opt_header::data_offset, ObjectFilePECOFF::coff_opt_header::data_size, ObjectFilePECOFF::coff_opt_header::dll_flags, ObjectFilePECOFF::coff_opt_header::entry, ObjectFilePECOFF::coff_opt_header::file_alignment, ObjectFilePECOFF::coff_opt_header::header_size, ObjectFilePECOFF::coff_opt_header::heap_commit_size, ObjectFilePECOFF::coff_opt_header::heap_reserve_size, ObjectFilePECOFF::coff_opt_header::image_base, ObjectFilePECOFF::coff_opt_header::image_size, ObjectFilePECOFF::coff_opt_header::loader_flags, ObjectFilePECOFF::coff_opt_header::magic, ObjectFilePECOFF::coff_opt_header::major_image_version, ObjectFilePECOFF::coff_opt_header::major_linker_version, ObjectFilePECOFF::coff_opt_header::major_os_system_version, ObjectFilePECOFF::coff_opt_header::major_subsystem_version, ObjectFilePECOFF::coff_opt_header::minor_image_version, ObjectFilePECOFF::coff_opt_header::minor_linker_version, ObjectFilePECOFF::coff_opt_header::minor_os_system_version, ObjectFilePECOFF::coff_opt_header::minor_subsystem_version, lldb_private::Stream::Printf(), lldb_private::Stream::PutCString(), ObjectFilePECOFF::coff_opt_header::reserved1, ObjectFilePECOFF::coff_opt_header::sect_alignment, ObjectFilePECOFF::coff_opt_header::stack_commit_size, ObjectFilePECOFF::coff_opt_header::stack_reserve_size, and ObjectFilePECOFF::coff_opt_header::subsystem.

Referenced by Dump().

◆ DumpSectionHeader()

void ObjectFilePECOFF::DumpSectionHeader ( lldb_private::Stream s,
const section_header_t sh 
)
protected

◆ DumpSectionHeaders()

void ObjectFilePECOFF::DumpSectionHeaders ( lldb_private::Stream s)
protected

◆ GetAddress()

Address ObjectFilePECOFF::GetAddress ( uint32_t  rva)

◆ GetAddressByteSize()

uint32_t ObjectFilePECOFF::GetAddressByteSize ( ) const
overridevirtual

Gets the address size in bytes for the current object file.

Returns
The size of an address in bytes for the currently selected architecture (and object for archives). Returns zero if no architecture or object has been selected.

Implements lldb_private::ObjectFile.

Definition at line 501 of file ObjectFilePECOFF.cpp.

References m_coff_header_opt, ObjectFilePECOFF::coff_opt_header::magic, OPT_HEADER_MAGIC_PE32, and OPT_HEADER_MAGIC_PE32_PLUS.

Referenced by ParseCOFFOptionalHeader(), and ParseHeader().

◆ GetArchitecture()

ArchSpec ObjectFilePECOFF::GetArchitecture ( )
overridevirtual

Get the ArchSpec for this object file.

Returns
The ArchSpec of this object file. In case of error, an invalid ArchSpec object is returned.

Implements lldb_private::ObjectFile.

Definition at line 1399 of file ObjectFilePECOFF.cpp.

References lldb_private::eArchTypeCOFF, IsWindowsSubsystem(), LLDB_INVALID_CPUTYPE, m_coff_header, ObjectFilePECOFF::coff_header::machine, and lldb_private::ArchSpec::SetArchitecture().

Referenced by Dump().

◆ GetBaseAddress()

Address ObjectFilePECOFF::GetBaseAddress ( )
overridevirtual

Returns base address of this object file.

This also sometimes referred to as the "preferred load address" or the "image base address". Addresses within object files are often expressed relative to this base. If this address corresponds to a specific section (usually the first byte of the first section) then the returned address will have this section set. Otherwise, the address will just have the offset member filled in, indicating that this represents a file address.

Reimplemented from lldb_private::ObjectFile.

Definition at line 1192 of file ObjectFilePECOFF.cpp.

References lldb_private::ObjectFile::GetSectionList().

◆ GetByteOrder()

ByteOrder ObjectFilePECOFF::GetByteOrder ( ) const
overridevirtual

Gets whether endian swapping should occur when extracting data from this object file.

Returns
Returns true if endian swapping is needed, false otherwise.

Implements lldb_private::ObjectFile.

Definition at line 495 of file ObjectFilePECOFF.cpp.

References lldb::eByteOrderLittle.

◆ GetDebugLink()

std::optional< FileSpec > ObjectFilePECOFF::GetDebugLink ( )

Return the contents of the .gnu_debuglink section, if the object file contains it.

Definition at line 1108 of file ObjectFilePECOFF.cpp.

References GetDebugLinkContents(), and m_binary.

Referenced by SymbolVendorPECOFF::CreateInstance().

◆ GetDependentModules()

uint32_t ObjectFilePECOFF::GetDependentModules ( lldb_private::FileSpecList file_list)
overridevirtual

Extract the dependent modules from an object file.

If an object file has information about which other images it depends on (such as shared libraries), this function will provide the list. Since many executables or shared libraries may depend on the same files, FileSpecList::AppendIfUnique(const FileSpec &) should be used to make sure any files that are added are not already in the list.

Parameters
[out]file_listA list of file specification objects that gets dependent files appended to.
Returns
The number of new files that were appended to file_list.
See also
FileSpecList::AppendIfUnique(const FileSpec &)

Implements lldb_private::ObjectFile.

Definition at line 1164 of file ObjectFilePECOFF.cpp.

References lldb_private::FileSpecList::AppendIfUnique(), lldb_private::FileSpecList::GetSize(), m_deps_filespec, and ParseDependentModules().

◆ GetEntryPointAddress()

lldb_private::Address ObjectFilePECOFF::GetEntryPointAddress ( )
overridevirtual

Returns the address of the Entry Point in this object file - if the object file doesn't have an entry point (because it is not an executable file) then an invalid address is returned.

Returns
Returns the entry address for this module.

Reimplemented from lldb_private::ObjectFile.

Definition at line 1174 of file ObjectFilePECOFF.cpp.

References ObjectFilePECOFF::coff_opt_header::entry, lldb_private::ObjectFile::GetSectionList(), ObjectFilePECOFF::coff_opt_header::image_base, IsExecutable(), lldb_private::Address::IsValid(), m_coff_header_opt, m_entry_point_address, ParseHeader(), lldb_private::Address::ResolveAddressUsingFileSections(), and lldb_private::Address::SetOffset().

◆ GetFileAddress()

lldb::addr_t ObjectFilePECOFF::GetFileAddress ( uint32_t  rva) const

Definition at line 678 of file ObjectFilePECOFF.cpp.

References m_image_base.

Referenced by GetAddress().

◆ GetModuleSpecifications()

size_t ObjectFilePECOFF::GetModuleSpecifications ( const lldb_private::FileSpec file,
lldb::DataBufferSP data_sp,
lldb::offset_t  data_offset,
lldb::offset_t  file_offset,
lldb::offset_t  length,
lldb_private::ModuleSpecList specs 
)
static

◆ GetPluginDescriptionStatic()

llvm::StringRef ObjectFilePECOFF::GetPluginDescriptionStatic ( )
static

Definition at line 199 of file ObjectFilePECOFF.cpp.

Referenced by Initialize().

◆ GetPluginName()

llvm::StringRef ObjectFilePECOFF::GetPluginName ( )
inlineoverridevirtual

Implements lldb_private::PluginInterface.

Definition at line 140 of file ObjectFilePECOFF.h.

References GetPluginNameStatic().

◆ GetPluginNameStatic()

static llvm::StringRef ObjectFilePECOFF::GetPluginNameStatic ( )
inlinestatic

Definition at line 64 of file ObjectFilePECOFF.h.

Referenced by GetPluginName(), and Initialize().

◆ GetRVA()

uint32_t ObjectFilePECOFF::GetRVA ( const lldb_private::Address addr) const

◆ GetSectionDataSize()

size_t ObjectFilePECOFF::GetSectionDataSize ( lldb_private::Section section)
overrideprotectedvirtual

◆ GetSectionName()

llvm::StringRef ObjectFilePECOFF::GetSectionName ( const section_header_t sect)
protected

◆ GetSectionType()

SectionType ObjectFilePECOFF::GetSectionType ( llvm::StringRef  sect_name,
const section_header_t sect 
)
staticprotected

◆ GetUUID()

UUID ObjectFilePECOFF::GetUUID ( )
overridevirtual

Gets the UUID for this object file.

If the object file format contains a UUID, the value should be returned. Else ObjectFile instances should return the MD5 checksum of all of the bytes for the object file (or memory for memory based object files).

Returns
The object file's UUID. In case of an error, an empty UUID is returned.

Implements lldb_private::ObjectFile.

Definition at line 1097 of file ObjectFilePECOFF.cpp.

References CreateBinary(), GetCoffUUID(), lldb_private::UUID::IsValid(), m_binary, and m_uuid.

Referenced by SymbolVendorPECOFF::CreateInstance().

◆ Initialize()

void ObjectFilePECOFF::Initialize ( )
static

◆ isA()

bool ObjectFilePECOFF::isA ( const void *  ClassID) const
inlineoverridevirtual

Reimplemented from lldb_private::ObjectFile.

Definition at line 94 of file ObjectFilePECOFF.h.

References ID.

◆ IsExecutable()

bool ObjectFilePECOFF::IsExecutable ( ) const
overridevirtual

Tells whether this object file is capable of being the main executable for a process.

Returns
true if it is, false otherwise.

Implements lldb_private::ObjectFile.

Definition at line 497 of file ObjectFilePECOFF.cpp.

References ObjectFilePECOFF::coff_header::flags, and m_coff_header.

Referenced by GetEntryPointAddress().

◆ IsStripped()

bool ObjectFilePECOFF::IsStripped ( )
overridevirtual

Detect if this object file has been stripped of local symbols.

Detect if this object file has been stripped of local symbols.

Returns
Return true if the object file has been stripped of local symbols.

Implements lldb_private::ObjectFile.

Definition at line 953 of file ObjectFilePECOFF.cpp.

◆ IsWindowsSubsystem()

bool ObjectFilePECOFF::IsWindowsSubsystem ( )

◆ MagicBytesMatch()

bool ObjectFilePECOFF::MagicBytesMatch ( lldb::DataBufferSP  data_sp)
static

◆ MapSymbolType()

lldb::SymbolType ObjectFilePECOFF::MapSymbolType ( uint16_t  coff_symbol_type)
static

◆ NeedsEndianSwap()

bool ObjectFilePECOFF::NeedsEndianSwap ( ) const
protected

Definition at line 513 of file ObjectFilePECOFF.cpp.

◆ ParseCOFFHeader()

bool ObjectFilePECOFF::ParseCOFFHeader ( lldb_private::DataExtractor data,
lldb::offset_t offset_ptr,
coff_header_t coff_header 
)
staticprotected

◆ ParseCOFFOptionalHeader()

bool ObjectFilePECOFF::ParseCOFFOptionalHeader ( lldb::offset_t offset_ptr)
protected

Definition at line 599 of file ObjectFilePECOFF.cpp.

References ObjectFilePECOFF::coff_opt_header::bss_size, ObjectFilePECOFF::coff_opt_header::checksum, ObjectFilePECOFF::coff_opt_header::code_offset, ObjectFilePECOFF::coff_opt_header::code_size, ObjectFilePECOFF::coff_opt_header::data_dirs, ObjectFilePECOFF::coff_opt_header::data_offset, ObjectFilePECOFF::coff_opt_header::data_size, ObjectFilePECOFF::coff_opt_header::dll_flags, ObjectFilePECOFF::coff_opt_header::entry, ObjectFilePECOFF::coff_opt_header::file_alignment, GetAddressByteSize(), lldb_private::DataExtractor::GetMaxU64(), lldb_private::DataExtractor::GetU16(), lldb_private::DataExtractor::GetU32(), lldb_private::DataExtractor::GetU8(), ObjectFilePECOFF::coff_header::hdrsize, ObjectFilePECOFF::coff_opt_header::header_size, ObjectFilePECOFF::coff_opt_header::heap_commit_size, ObjectFilePECOFF::coff_opt_header::heap_reserve_size, ObjectFilePECOFF::coff_opt_header::image_base, ObjectFilePECOFF::coff_opt_header::image_size, ObjectFilePECOFF::coff_opt_header::loader_flags, m_coff_header, m_coff_header_opt, lldb_private::ObjectFile::m_data, m_image_base, ObjectFilePECOFF::coff_opt_header::magic, ObjectFilePECOFF::coff_opt_header::major_image_version, ObjectFilePECOFF::coff_opt_header::major_linker_version, ObjectFilePECOFF::coff_opt_header::major_os_system_version, ObjectFilePECOFF::coff_opt_header::major_subsystem_version, ObjectFilePECOFF::coff_opt_header::minor_image_version, ObjectFilePECOFF::coff_opt_header::minor_linker_version, ObjectFilePECOFF::coff_opt_header::minor_os_system_version, ObjectFilePECOFF::coff_opt_header::minor_subsystem_version, OPT_HEADER_MAGIC_PE32, ObjectFilePECOFF::coff_opt_header::reserved1, ObjectFilePECOFF::coff_opt_header::sect_alignment, ObjectFilePECOFF::coff_opt_header::stack_commit_size, ObjectFilePECOFF::coff_opt_header::stack_reserve_size, and ObjectFilePECOFF::coff_opt_header::subsystem.

Referenced by ParseHeader().

◆ ParseDependentModules()

uint32_t ObjectFilePECOFF::ParseDependentModules ( )
protected

◆ ParseDOSHeader()

bool ObjectFilePECOFF::ParseDOSHeader ( lldb_private::DataExtractor data,
dos_header_t dos_header 
)
staticprotected

◆ ParseHeader()

bool ObjectFilePECOFF::ParseHeader ( )
overridevirtual

Attempts to parse the object header.

This function is used as a test to see if a given plug-in instance can parse the header data already contained in ObjectFile::m_data. If an object file parser does not recognize that magic bytes in a header, false should be returned and the next plug-in can attempt to parse an object file.

Returns
Returns true if the header was parsed successfully, false otherwise.

Implements lldb_private::ObjectFile.

Definition at line 439 of file ObjectFilePECOFF.cpp.

References ObjectFilePECOFF::dos_header::e_lfanew, lldb::eByteOrderLittle, GetAddressByteSize(), lldb_private::ModuleChild::GetModule(), lldb_private::DataExtractor::GetU32(), ObjectFilePECOFF::coff_header::hdrsize, IMAGE_NT_SIGNATURE, m_coff_header, lldb_private::ObjectFile::m_data, m_dos_header, m_sect_headers, ParseCOFFHeader(), ParseCOFFOptionalHeader(), ParseDOSHeader(), ParseSectionHeaders(), lldb_private::DataExtractor::SetAddressByteSize(), and lldb_private::DataExtractor::SetByteOrder().

Referenced by GetEntryPointAddress().

◆ ParseSectionHeaders()

bool ObjectFilePECOFF::ParseSectionHeaders ( uint32_t  offset)
protected

◆ ParseSymtab()

void ObjectFilePECOFF::ParseSymtab ( lldb_private::Symtab symtab)
overridevirtual

Parse the symbol table into the provides symbol table object.

Symbol table parsing will be done once when this function is called by each object file plugin. All of the necessary locks will already be acquired before this function is called and the symbol table object to populate is supplied as an argument and doesn't need to be created by each plug-in.

Parameters
Thesymbol table to populate.

Implements lldb_private::ObjectFile.

Definition at line 768 of file ObjectFilePECOFF.cpp.

References AppendFromCOFFSymbolTable(), AppendFromExportTable(), and lldb_private::ObjectFile::GetSectionList().

◆ ReadImageData()

DataExtractor ObjectFilePECOFF::ReadImageData ( uint32_t  offset,
size_t  size 
)

◆ ReadImageDataByRVA()

DataExtractor ObjectFilePECOFF::ReadImageDataByRVA ( uint32_t  rva,
size_t  size 
)

◆ SaveCore()

bool ObjectFilePECOFF::SaveCore ( const lldb::ProcessSP process_sp,
const lldb_private::SaveCoreOptions options,
lldb_private::Status error 
)
static

◆ SetLoadAddress()

bool ObjectFilePECOFF::SetLoadAddress ( lldb_private::Target target,
lldb::addr_t  value,
bool  value_is_offset 
)
overridevirtual

Sets the load address for an entire module, assuming a rigid slide of sections, if possible in the implementation.

Returns
Returns true iff any section's load address changed.

Reimplemented from lldb_private::ObjectFile.

Definition at line 464 of file ObjectFilePECOFF.cpp.

References lldb_private::ModuleChild::GetModule(), lldb_private::SectionList::GetSectionAtIndex(), lldb_private::ObjectFile::GetSectionList(), lldb_private::Target::GetSectionLoadList(), lldb_private::SectionList::GetSize(), m_image_base, and lldb_private::SectionLoadList::SetSectionLoadAddress().

◆ Terminate()

void ObjectFilePECOFF::Terminate ( )
static

Member Data Documentation

◆ ID

char ObjectFilePECOFF::ID
static

Definition at line 93 of file ObjectFilePECOFF.h.

Referenced by classof(), and isA().

◆ m_binary

std::unique_ptr<llvm::object::COFFObjectFile> ObjectFilePECOFF::m_binary
private

◆ m_coff_header

coff_header_t ObjectFilePECOFF::m_coff_header
private

◆ m_coff_header_opt

coff_opt_header_t ObjectFilePECOFF::m_coff_header_opt
private

◆ m_deps_filespec

std::optional<lldb_private::FileSpecList> ObjectFilePECOFF::m_deps_filespec
private

◆ m_dos_header

dos_header_t ObjectFilePECOFF::m_dos_header
private

Definition at line 280 of file ObjectFilePECOFF.h.

Referenced by Dump(), and ParseHeader().

◆ m_entry_point_address

lldb_private::Address ObjectFilePECOFF::m_entry_point_address
private

Definition at line 285 of file ObjectFilePECOFF.h.

Referenced by GetEntryPointAddress().

◆ m_image_base

lldb::addr_t ObjectFilePECOFF::m_image_base
private

◆ m_sect_headers

SectionHeaderColl ObjectFilePECOFF::m_sect_headers
private

◆ m_uuid

lldb_private::UUID ObjectFilePECOFF::m_uuid
private

Definition at line 288 of file ObjectFilePECOFF.h.

Referenced by GetUUID().


The documentation for this class was generated from the following files: