LLDB  mainline
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
lldb_private::ObjectFilePDB Class Reference

#include <ObjectFilePDB.h>

Inheritance diagram for lldb_private::ObjectFilePDB:
Inheritance graph
[legend]
Collaboration diagram for lldb_private::ObjectFilePDB:
Collaboration graph
[legend]

Public Member Functions

ConstString GetPluginName () override
 
bool isA (const void *ClassID) const override
 
uint32_t GetAddressByteSize () const override
 Gets the address size in bytes for the current object file. More...
 
lldb::ByteOrder GetByteOrder () const override
 Gets whether endian swapping should occur when extracting data from this object file. More...
 
bool ParseHeader () override
 Attempts to parse the object header. More...
 
bool IsExecutable () const override
 Tells whether this object file is capable of being the main executable for a process. More...
 
SymtabGetSymtab () override
 Gets the symbol table for the currently selected architecture (and object for archives). More...
 
bool IsStripped () override
 Detect if this object file has been stripped of local symbols. More...
 
void CreateSections (SectionList &unified_section_list) override
 
void Dump (Stream *s) override
 Dump a description of this object to a Stream. More...
 
ArchSpec GetArchitecture () override
 Get the ArchSpec for this object file. More...
 
UUID GetUUID () override
 Gets the UUID for this object file. More...
 
uint32_t GetDependentModules (FileSpecList &files) override
 Extract the dependent modules from an object file. More...
 
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. More...
 
Strata CalculateStrata () override
 The object file should be able to calculate the strata of the object file. More...
 
llvm::pdb::PDBFile & GetPDBFile ()
 
 ObjectFilePDB (const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, lldb::offset_t data_offset, const FileSpec *file, lldb::offset_t offset, lldb::offset_t length)
 
- 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, const lldb::DataBufferSP &data_sp, lldb::offset_t data_offset)
 Construct with a parent module, offset, and header data. More...
 
 ObjectFile (const lldb::ModuleSP &module_sp, const lldb::ProcessSP &process_sp, lldb::addr_t header_addr, lldb::DataBufferSP &data_sp)
 
 ~ObjectFile () override
 Destructor. More...
 
virtual AddressClass GetAddressClass (lldb::addr_t file_addr)
 Get the address type given a file address in an object file. More...
 
virtual lldb::addr_t GetFileOffset () const
 Returns the offset into a file at which this object resides. More...
 
virtual lldb::addr_t GetByteSize () const
 
virtual FileSpecGetFileSpec ()
 Get accessor to the object file specification. More...
 
virtual const FileSpecGetFileSpec () const
 Get const accessor to the object file specification. More...
 
virtual SectionListGetSectionList (bool update_module_section_list=true)
 Gets the section list for the currently selected architecture (and object for archives). More...
 
virtual void SectionFileAddressesChanged ()
 Notify the ObjectFile that the file addresses in the Sections for this module have been changed. More...
 
virtual void RelocateSection (lldb_private::Section *section)
 Perform relocations on the section if necessary. More...
 
virtual SymbolResolveSymbolForAddress (const Address &so_addr, bool verify_unique)
 Appends a Symbol for the specified so_addr to the symbol table. More...
 
virtual void ClearSymtab ()
 Frees the symbol table. More...
 
virtual lldb_private::FileSpecList GetReExportedLibraries ()
 Gets the file spec list of libraries re-exported by this object file. More...
 
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. More...
 
virtual bool AllowAssemblyEmulationUnwindPlans ()
 Returns if the function bounds for symbols in this symbol file are likely accurate. More...
 
virtual lldb_private::Address GetImageInfoAddress (Target *target)
 Similar to Process::GetImageInfoAddress(). More...
 
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. More...
 
virtual lldb_private::Address GetBaseAddress ()
 Returns base address of this object file. More...
 
virtual uint32_t GetNumThreadContexts ()
 
virtual std::string GetIdentifierString ()
 Some object files may have an identifier string embedded in them, e.g. More...
 
virtual lldb::addr_t GetAddressMask ()
 Some object files may have the number of bits used for addressing embedded in them, e.g. More...
 
virtual bool GetCorefileMainBinaryInfo (lldb::addr_t &address, UUID &uuid, ObjectFile::BinaryType &type)
 When the ObjectFile is a core file, lldb needs to locate the "binary" in the core file. More...
 
virtual lldb::RegisterContextSP GetThreadContextAtIndex (uint32_t idx, lldb_private::Thread &thread)
 
virtual void SetType (Type type)
 In cases where the type can't be calculated (elf files), this routine allows someone to explicitly set it. More...
 
virtual llvm::VersionTuple GetVersion ()
 Get the object file version numbers. More...
 
virtual llvm::VersionTuple GetMinimumOSVersion ()
 Get the minimum OS version this object file can run on. More...
 
virtual llvm::VersionTuple GetSDKVersion ()
 Get the SDK OS version this object file was built with. More...
 
virtual bool GetIsDynamicLinkEditor ()
 Return true if this file is a dynamic link editor (dyld) More...
 
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)
 
bool IsInMemory () const
 
virtual llvm::StringRef StripLinkerSymbolAnnotations (llvm::StringRef symbol_name) const
 
virtual std::vector< LoadableDataGetLoadableData (Target &target)
 Loads this objfile to memory. More...
 
virtual std::unique_ptr< CallFrameInfoCreateCallFrameInfo ()
 Creates a plugin-specific call frame info. More...
 
virtual bool LoadCoreFileImages (lldb_private::Process &process)
 Load binaries listed in a corefile. More...
 
- Public Member Functions inherited from lldb_private::PluginInterface
 PluginInterface ()=default
 
virtual ~PluginInterface ()=default
 
 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. More...
 
 ~ModuleChild ()
 Destructor. More...
 
const ModuleChildoperator= (const ModuleChild &rhs)
 Assignment operator. More...
 
lldb::ModuleSP GetModule () const
 Get const accessor for the module pointer. More...
 
void SetModule (const lldb::ModuleSP &module_sp)
 Set accessor for the module pointer. More...
 

Static Public Member Functions

static void Initialize ()
 
static void Terminate ()
 
static ConstString GetPluginNameStatic ()
 
static const char * GetPluginDescriptionStatic ()
 
static std::unique_ptr< llvm::pdb::PDBFile > loadPDBFile (std::string PdbPath, llvm::BumpPtrAllocator &Allocator)
 
static ObjectFileCreateInstance (const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, lldb::offset_t data_offset, const FileSpec *file, lldb::offset_t file_offset, lldb::offset_t length)
 
static ObjectFileCreateMemoryInstance (const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, const lldb::ProcessSP &process_sp, lldb::addr_t header_addr)
 
static size_t GetModuleSpecifications (const FileSpec &file, lldb::DataBufferSP &data_sp, lldb::offset_t data_offset, lldb::offset_t file_offset, lldb::offset_t length, ModuleSpecList &specs)
 
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. More...
 
static lldb::ObjectFileSP FindPlugin (const lldb::ModuleSP &module_sp, const lldb::ProcessSP &process_sp, lldb::addr_t header_addr, lldb::DataBufferSP &file_data_sp)
 Find a ObjectFile plug-in that can parse a file in memory. More...
 
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 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. More...
 
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 Public Attributes

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

Private Member Functions

bool initPDBFile ()
 

Private Attributes

UUID m_uuid
 
llvm::BumpPtrAllocator m_allocator
 
std::unique_ptr< llvm::pdb::PDBFile > m_file_up
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from lldb_private::ObjectFile
bool SetModulesArchitecture (const ArchSpec &new_arch)
 Sets the architecture for a module. More...
 
- Static Protected Member Functions inherited from lldb_private::ObjectFile
static lldb::DataBufferSP MapFileData (const FileSpec &file, uint64_t Size, uint64_t Offset)
 
- 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. More...
 
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). More...
 
DataExtractor m_data
 The data for this object file so things can be parsed lazily. More...
 
lldb::ProcessWP m_process_wp
 
const lldb::addr_t m_memory_addr
 
std::unique_ptr< lldb_private::SectionListm_sections_up
 
std::unique_ptr< lldb_private::Symtabm_symtab_up
 
uint32_t m_synthetic_symbol_idx
 
- Protected Attributes inherited from lldb_private::ModuleChild
lldb::ModuleWP m_module_wp
 The Module that owns the object that inherits from this class. More...
 

Detailed Description

Definition at line 19 of file ObjectFilePDB.h.

Constructor & Destructor Documentation

◆ ObjectFilePDB()

ObjectFilePDB::ObjectFilePDB ( const lldb::ModuleSP &  module_sp,
lldb::DataBufferSP &  data_sp,
lldb::offset_t  data_offset,
const FileSpec file,
lldb::offset_t  offset,
lldb::offset_t  length 
)

Definition at line 163 of file ObjectFilePDB.cpp.

Member Function Documentation

◆ CalculateStrata()

Strata lldb_private::ObjectFilePDB::CalculateStrata ( )
inlineoverridevirtual

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 88 of file ObjectFilePDB.h.

References lldb_private::ObjectFile::eStrataUser.

◆ CalculateType()

Type lldb_private::ObjectFilePDB::CalculateType ( )
inlineoverridevirtual

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 86 of file ObjectFilePDB.h.

References lldb_private::ObjectFile::eTypeDebugInfo.

◆ classof()

static bool lldb_private::ObjectFilePDB::classof ( const ObjectFile obj)
inlinestatic

Definition at line 58 of file ObjectFilePDB.h.

References ID, and lldb_private::ObjectFile::isA().

◆ CreateInstance()

ObjectFile * ObjectFilePDB::CreateInstance ( const lldb::ModuleSP &  module_sp,
lldb::DataBufferSP &  data_sp,
lldb::offset_t  data_offset,
const FileSpec file,
lldb::offset_t  file_offset,
lldb::offset_t  length 
)
static

Definition at line 95 of file ObjectFilePDB.cpp.

◆ CreateMemoryInstance()

ObjectFile * ObjectFilePDB::CreateMemoryInstance ( const lldb::ModuleSP &  module_sp,
lldb::DataBufferSP &  data_sp,
const lldb::ProcessSP &  process_sp,
lldb::addr_t  header_addr 
)
static

Definition at line 105 of file ObjectFilePDB.cpp.

◆ CreateSections()

void lldb_private::ObjectFilePDB::CreateSections ( SectionList unified_section_list)
inlineoverridevirtual

Implements lldb_private::ObjectFile.

Definition at line 76 of file ObjectFilePDB.h.

◆ Dump()

void lldb_private::ObjectFilePDB::Dump ( Stream s)
inlineoverridevirtual

Dump a description of this object to a Stream.

Dump a description of the current contents of this object to the supplied stream s. The dumping should include the section list if it has been parsed, and the symbol table if it has been parsed.

Parameters
[in]sThe stream to which to dump the object description.

Implements lldb_private::ObjectFile.

Definition at line 78 of file ObjectFilePDB.h.

◆ GetAddressByteSize()

uint32_t lldb_private::ObjectFilePDB::GetAddressByteSize ( ) const
inlineoverridevirtual

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 61 of file ObjectFilePDB.h.

◆ GetArchitecture()

ArchSpec ObjectFilePDB::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 54 of file ObjectFilePDB.cpp.

References lldb_private::eArchTypeCOFF, LLDB_INVALID_CPUTYPE, and lldb_private::ArchSpec::SetArchitecture().

◆ GetByteOrder()

lldb::ByteOrder lldb_private::ObjectFilePDB::GetByteOrder ( ) const
inlineoverridevirtual

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 63 of file ObjectFilePDB.h.

References lldb::eByteOrderLittle.

◆ GetDependentModules()

uint32_t lldb_private::ObjectFilePDB::GetDependentModules ( FileSpecList &  file_list)
inlineoverridevirtual

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 84 of file ObjectFilePDB.h.

◆ GetModuleSpecifications()

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

◆ GetPDBFile()

llvm::pdb::PDBFile& lldb_private::ObjectFilePDB::GetPDBFile ( )
inline

Definition at line 90 of file ObjectFilePDB.h.

References m_file_up.

◆ GetPluginDescriptionStatic()

static const char* lldb_private::ObjectFilePDB::GetPluginDescriptionStatic ( )
inlinestatic

Definition at line 26 of file ObjectFilePDB.h.

◆ GetPluginName()

ConstString lldb_private::ObjectFilePDB::GetPluginName ( )
inlineoverridevirtual

Implements lldb_private::PluginInterface.

Definition at line 51 of file ObjectFilePDB.h.

References GetPluginNameStatic().

◆ GetPluginNameStatic()

ConstString ObjectFilePDB::GetPluginNameStatic ( )
static

Definition at line 49 of file ObjectFilePDB.cpp.

Referenced by GetPluginName().

◆ GetSymtab()

Symtab* lldb_private::ObjectFilePDB::GetSymtab ( )
inlineoverridevirtual

Gets the symbol table for the currently selected architecture (and object for archives).

Symbol table parsing can be deferred by ObjectFile instances until this accessor is called the first time.

Returns
The symbol table for this object file.

Implements lldb_private::ObjectFile.

Definition at line 71 of file ObjectFilePDB.h.

◆ GetUUID()

UUID lldb_private::ObjectFilePDB::GetUUID ( )
inlineoverridevirtual

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 82 of file ObjectFilePDB.h.

References m_uuid.

◆ Initialize()

void ObjectFilePDB::Initialize ( )
static

Definition at line 39 of file ObjectFilePDB.cpp.

◆ initPDBFile()

bool ObjectFilePDB::initPDBFile ( )
private

Definition at line 81 of file ObjectFilePDB.cpp.

References GetPDBUUID().

◆ isA()

bool lldb_private::ObjectFilePDB::isA ( const void *  ClassID) const
inlineoverridevirtual

Reimplemented from lldb_private::ObjectFile.

Definition at line 55 of file ObjectFilePDB.h.

References ID, and lldb_private::ObjectFile::isA().

◆ IsExecutable()

bool lldb_private::ObjectFilePDB::IsExecutable ( ) const
inlineoverridevirtual

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 69 of file ObjectFilePDB.h.

◆ IsStripped()

bool lldb_private::ObjectFilePDB::IsStripped ( )
inlineoverridevirtual

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 73 of file ObjectFilePDB.h.

◆ loadPDBFile()

std::unique_ptr< PDBFile > ObjectFilePDB::loadPDBFile ( std::string  PdbPath,
llvm::BumpPtrAllocator &  Allocator 
)
static

Definition at line 169 of file ObjectFilePDB.cpp.

◆ ParseHeader()

bool lldb_private::ObjectFilePDB::ParseHeader ( )
inlineoverridevirtual

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 67 of file ObjectFilePDB.h.

◆ Terminate()

void ObjectFilePDB::Terminate ( )
static

Definition at line 45 of file ObjectFilePDB.cpp.

Member Data Documentation

◆ ID

char ObjectFilePDB::ID
static

Definition at line 54 of file ObjectFilePDB.h.

Referenced by classof(), and isA().

◆ m_allocator

llvm::BumpPtrAllocator lldb_private::ObjectFilePDB::m_allocator
private

Definition at line 98 of file ObjectFilePDB.h.

◆ m_file_up

std::unique_ptr<llvm::pdb::PDBFile> lldb_private::ObjectFilePDB::m_file_up
private

Definition at line 99 of file ObjectFilePDB.h.

Referenced by GetPDBFile().

◆ m_uuid

UUID lldb_private::ObjectFilePDB::m_uuid
private

Definition at line 97 of file ObjectFilePDB.h.

Referenced by GetUUID().


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