#include <ObjectContainerBSDArchive.h>

Inheritance diagram for ObjectContainerBSDArchive:

[legend]

Classes
class	Archive

struct	Object

Public Member Functions
	ObjectContainerBSDArchive (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, ArchiveType archive_type)

	~ObjectContainerBSDArchive () override

bool	ParseHeader () override
	Attempts to parse the object header.

size_t	GetNumObjects () const override
	Get the number of objects within this object file (archives).

lldb::ObjectFileSP	GetObjectFile (const lldb_private::FileSpec *file) override
	Selects an architecture in an object file.

llvm::StringRef	GetPluginName () override

Public Member Functions inherited from lldb_private::ObjectContainer
	ObjectContainer (const lldb::ModuleSP &module_sp, const FileSpec *file, 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.

	~ObjectContainer () override=default
	Destructor.

virtual bool	GetArchitectureAtIndex (uint32_t idx, ArchSpec &arch) const
	Gets the architecture given an index.

virtual lldb::addr_t	GetOffset () const
	Returns the offset into a file at which this object resides.

virtual lldb::addr_t	GetByteSize () const

virtual size_t	GetNumObjects () const
	Get the number of objects within this object file (archives).

virtual size_t	GetNumArchitectures () const
	Get the number of architectures in this object file.

virtual bool	ParseHeader ()=0
	Attempts to parse the object header.

virtual lldb::ObjectFileSP	GetObjectFile (const FileSpec *file)=0
	Selects an architecture in an object file.

Public Member Functions inherited from lldb_private::PluginInterface
	PluginInterface ()=default

virtual	~PluginInterface ()=default

virtual llvm::StringRef	GetPluginName ()=0

	PluginInterface (const PluginInterface &)=delete

PluginInterface &	operator= (const PluginInterface &)=delete

Public Member Functions inherited from lldb_private::ModuleChild
	ModuleChild (const lldb::ModuleSP &module_sp)
	Construct with owning module.

	~ModuleChild ()
	Destructor.

const ModuleChild &	operator= (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	Terminate ()

static llvm::StringRef	GetPluginNameStatic ()

static llvm::StringRef	GetPluginDescriptionStatic ()

static lldb_private::ObjectContainer *	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 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 ArchiveType	MagicBytesMatch (const lldb_private::DataExtractor &data)

Static Public Member Functions inherited from lldb_private::ObjectContainer
static lldb::ObjectContainerSP	FindPlugin (const lldb::ModuleSP &module_sp, const lldb::ProcessSP &process_sp, lldb::addr_t header_addr, lldb::WritableDataBufferSP file_data_sp)

Protected Member Functions
void	SetArchive (Archive::shared_ptr &archive_sp)

Protected Attributes
Archive::shared_ptr	m_archive_sp

ArchiveType	m_archive_type

Protected Attributes inherited from lldb_private::ObjectContainer
FileSpec	m_file
	The file that represents this container objects (which can be different from the module's file).

lldb::addr_t	m_offset
	The offset in bytes into the file, or the address in memory.

lldb::addr_t	m_length
	The size in bytes if known (can be zero).

DataExtractor	m_data
	The data for this object file so things can be parsed lazily.

Protected Attributes inherited from lldb_private::ModuleChild
lldb::ModuleWP	m_module_wp
	The Module that owns the object that inherits from this class.

Detailed Description

Definition at line 28 of file ObjectContainerBSDArchive.h.

Constructor & Destructor Documentation

◆ ObjectContainerBSDArchive()

ObjectContainerBSDArchive::ObjectContainerBSDArchive	(	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,
		ArchiveType	archive_type
	)

Definition at line 352 of file ObjectContainerBSDArchive.cpp.

References m_archive_type.

◆ ~ObjectContainerBSDArchive()

ObjectContainerBSDArchive::~ObjectContainerBSDArchive ( )

overridedefault

Member Function Documentation

◆ CreateInstance()

ObjectContainer * ObjectContainerBSDArchive::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 260 of file ObjectContainerBSDArchive.cpp.

References lldb_private::FileSystem::CreateDataBuffer(), ObjectContainerBSDArchive::Archive::FindCachedArchive(), lldb_private::FileSystem::Instance(), LLDB_SCOPED_TIMERF, MagicBytesMatch(), and lldb_private::DataExtractor::SetData().

Referenced by Initialize(), and Terminate().

◆ GetModuleSpecifications()

size_t ObjectContainerBSDArchive::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

Definition at line 431 of file ObjectContainerBSDArchive.cpp.

Referenced by Initialize().

◆ GetNumObjects()

size_t ObjectContainerBSDArchive::GetNumObjects ( ) const

inlineoverridevirtual

Get the number of objects within this object file (archives).

Returns: Zero for object files that are not archives, or the number of objects contained in the archive.

Reimplemented from lldb_private::ObjectContainer.

Definition at line 67 of file ObjectContainerBSDArchive.h.

References m_archive_sp.

◆ GetObjectFile()

ObjectFileSP ObjectContainerBSDArchive::GetObjectFile ( const lldb_private::FileSpec * file )

overridevirtual

Selects an architecture in an object file.

Object files that contain a single architecture should verify that the specified arch matches the architecture in the object file and return true or false accordingly.

Object files that contain more than one architecture should attempt to select that architecture, and if successful, clear out any previous state from any previously selected architecture and prepare to return information for the new architecture.

Returns: Returns a pointer to the object file of the requested arch and optional name. Returns nullptr of no such object file exists in the container.

Implements lldb_private::ObjectContainer.

Definition at line 397 of file ObjectContainerBSDArchive.cpp.

References ObjectContainerBSDArchive::Object::ar_name, lldb_private::FileSystem::CreateDataBuffer(), ObjectContainerBSDArchive::Object::file_offset, ObjectContainerBSDArchive::Object::file_size, lldb_private::ObjectFile::FindPlugin(), GetChildFileSpecificationsFromThin(), lldb_private::ModuleChild::GetModule(), lldb_private::ConstString::GetStringRef(), lldb_private::FileSystem::Instance(), m_archive_sp, m_archive_type, lldb_private::ObjectContainer::m_file, and lldb_private::ObjectContainer::m_offset.

◆ GetPluginDescriptionStatic()

static llvm::StringRef ObjectContainerBSDArchive::GetPluginDescriptionStatic ( )

inlinestatic

Definition at line 46 of file ObjectContainerBSDArchive.h.

Referenced by Initialize().

◆ GetPluginName()

llvm::StringRef ObjectContainerBSDArchive::GetPluginName ( )

inlineoverridevirtual

Implements lldb_private::PluginInterface.

Definition at line 76 of file ObjectContainerBSDArchive.h.

References GetPluginNameStatic().

◆ GetPluginNameStatic()

static llvm::StringRef ObjectContainerBSDArchive::GetPluginNameStatic ( )

inlinestatic

Definition at line 44 of file ObjectContainerBSDArchive.h.

Referenced by GetPluginName(), and Initialize().

◆ Initialize()

void ObjectContainerBSDArchive::Initialize ( )

static

Definition at line 250 of file ObjectContainerBSDArchive.cpp.

References CreateInstance(), GetModuleSpecifications(), GetPluginDescriptionStatic(), GetPluginNameStatic(), and lldb_private::PluginManager::RegisterPlugin().

◆ MagicBytesMatch()

ArchiveType ObjectContainerBSDArchive::MagicBytesMatch ( const lldb_private::DataExtractor & data )

static

Definition at line 332 of file ObjectContainerBSDArchive.cpp.

References lldb_private::DataExtractor::PeekData().

Referenced by CreateInstance(), and GetModuleSpecifications().

◆ ParseHeader()

bool ObjectContainerBSDArchive::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 ObjectContainer::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.