Interface to the runtime linker. More...

#include <HexagonDYLDRendezvous.h>

Classes
struct	Rendezvous

struct	SOEntry
	Structure representing the shared objects currently loaded into the inferior process. More...

struct	ThreadInfo

Public Types
enum	RendezvousState { eConsistent = 0 , eAdd , eDelete }
	Constants describing the state of the rendezvous. More...

typedef SOEntryList::const_iterator	iterator

Public Member Functions
	HexagonDYLDRendezvous (lldb_private::Process *process)

bool	Resolve ()
	Update the internal snapshot of runtime linker rendezvous and recompute the currently loaded modules.

bool	IsValid ()

lldb::addr_t	GetRendezvousAddress () const

void	SetRendezvousAddress (lldb::addr_t)
	Provide the dyld structure address.

uint64_t	GetVersion () const

lldb::addr_t	GetLinkMapAddress () const

lldb::addr_t	GetBreakAddress () const
	A breakpoint should be set at this address and Resolve called on each hit.

void	SetBreakAddress (lldb::addr_t addr)
	In hexagon it is possible that we can know the dyld breakpoint without having to find it from the rendezvous structure.

uint64_t	GetState () const
	Returns the current state of the rendezvous structure.

lldb::addr_t	GetLDBase () const

const ThreadInfo &	GetThreadInfo ()

bool	ModulesDidLoad () const

bool	ModulesDidUnload () const

void	DumpToLog (lldb_private::Log *log) const

iterator	begin () const
	Iterators over all currently loaded modules.

iterator	end () const

iterator	loaded_begin () const
	Iterators over all modules loaded into the inferior since the last call to Resolve().

iterator	loaded_end () const

iterator	unloaded_begin () const
	Iterators over all modules unloaded from the inferior since the last call to Resolve().

iterator	unloaded_end () const

Protected Types
enum	PThreadField { eSize , eNElem , eOffset }

typedef std::list< SOEntry >	SOEntryList

Protected Member Functions
lldb::addr_t	ReadWord (lldb::addr_t addr, uint64_t *dst, size_t size)
	Reads an unsigned integer of `size` bytes from the inferior's address space starting at `addr`.

lldb::addr_t	ReadPointer (lldb::addr_t addr, lldb::addr_t *dst)
	Reads an address from the inferior's address space starting at `addr`.

std::string	ReadStringFromMemory (lldb::addr_t addr)
	Reads a null-terminated C string from the memory location starting at `addr`.

bool	ReadSOEntryFromMemory (lldb::addr_t addr, SOEntry &entry)
	Reads an SOEntry starting at `addr`.

bool	UpdateSOEntries ()
	Updates the current set of SOEntries, the set of added entries, and the set of removed entries.

bool	UpdateSOEntriesForAddition ()

bool	UpdateSOEntriesForDeletion ()

bool	TakeSnapshot (SOEntryList &entry_list)
	Reads the current list of shared objects according to the link map supplied by the runtime linker.

bool	FindMetadata (const char *name, PThreadField field, uint32_t &value)

Protected Attributes
lldb_private::Process *	m_process

char	m_exe_path [PATH_MAX]

lldb::addr_t	m_rendezvous_addr
	Location of the r_debug structure in the inferiors address space.

Rendezvous	m_current
	Current and previous snapshots of the rendezvous structure.

Rendezvous	m_previous

SOEntryList	m_soentries
	List of SOEntry objects corresponding to the current link map state.

SOEntryList	m_added_soentries
	List of SOEntry's added to the link map since the last call to Resolve().

SOEntryList	m_removed_soentries
	List of SOEntry's removed from the link map since the last call to Resolve().

ThreadInfo	m_thread_info
	Threading metadata read from the inferior.

Detailed Description

Interface to the runtime linker.

A structure is present in a processes memory space which is updated by the runtime liker each time a module is loaded or unloaded. This class provides an interface to this structure and maintains a consistent snapshot of the currently loaded modules.

Definition at line 31 of file HexagonDYLDRendezvous.h.

Member Typedef Documentation

◆ iterator

typedef SOEntryList::const_iterator HexagonDYLDRendezvous::iterator

Definition at line 165 of file HexagonDYLDRendezvous.h.

◆ SOEntryList

typedef std::list<SOEntry> HexagonDYLDRendezvous::SOEntryList

protected

Definition at line 162 of file HexagonDYLDRendezvous.h.

Member Enumeration Documentation

◆ PThreadField

enum HexagonDYLDRendezvous::PThreadField

protected

Enumerator
eSize
eNElem
eOffset

Definition at line 239 of file HexagonDYLDRendezvous.h.

◆ RendezvousState

enum HexagonDYLDRendezvous::RendezvousState

Constants describing the state of the rendezvous.

See also: GetState().

Enumerator
eConsistent
eAdd
eDelete

Definition at line 126 of file HexagonDYLDRendezvous.h.

Constructor & Destructor Documentation

◆ HexagonDYLDRendezvous()

HexagonDYLDRendezvous::HexagonDYLDRendezvous ( lldb_private::Process * process )

Definition at line 48 of file HexagonDYLDRendezvous.cpp.

References HexagonDYLDRendezvous::ThreadInfo::dtv_offset, HexagonDYLDRendezvous::ThreadInfo::dtv_slot_size, lldb_private::Target::GetExecutableModulePointer(), lldb_private::Module::GetFileSpec(), lldb_private::FileSpec::GetPath(), lldb_private::Process::GetTarget(), m_exe_path, m_process, m_thread_info, HexagonDYLDRendezvous::ThreadInfo::modid_offset, PATH_MAX, HexagonDYLDRendezvous::ThreadInfo::tls_offset, and HexagonDYLDRendezvous::ThreadInfo::valid.

Member Function Documentation

◆ begin()

iterator HexagonDYLDRendezvous::begin ( ) const

inline

Iterators over all currently loaded modules.

Definition at line 168 of file HexagonDYLDRendezvous.h.

References m_soentries.

Referenced by DumpToLog(), DynamicLoaderHexagonDYLD::LoadAllCurrentModules(), and UpdateSOEntriesForDeletion().

◆ DumpToLog()

void HexagonDYLDRendezvous::DumpToLog ( lldb_private::Log * log ) const

Definition at line 338 of file HexagonDYLDRendezvous.cpp.

References begin(), eAdd, eConsistent, eDelete, end(), GetBreakAddress(), GetLDBase(), GetLinkMapAddress(), GetRendezvousAddress(), GetState(), GetVersion(), LLDB_LOGF, and lldb_private::Log::PutCString().

◆ end()

iterator HexagonDYLDRendezvous::end ( ) const

inline

Definition at line 169 of file HexagonDYLDRendezvous.h.

References m_soentries.

Referenced by DumpToLog(), DynamicLoaderHexagonDYLD::LoadAllCurrentModules(), and UpdateSOEntriesForDeletion().

◆ FindMetadata()

bool HexagonDYLDRendezvous::FindMetadata	(	const char *	name,
		PThreadField	field,
		uint32_t &	value
	)

protected

Definition at line 290 of file HexagonDYLDRendezvous.cpp.

References error(), eSize, lldb::eSymbolTypeAny, lldb_private::ModuleList::FindSymbolsWithNameAndType(), lldb_private::Target::GetImages(), lldb_private::Address::GetLoadAddress(), lldb_private::Process::GetTarget(), lldb_private::SymbolContextList::IsEmpty(), LLDB_INVALID_ADDRESS, m_process, and lldb_private::Process::ReadUnsignedIntegerFromMemory().

Referenced by GetThreadInfo().

◆ GetBreakAddress()

lldb::addr_t HexagonDYLDRendezvous::GetBreakAddress ( ) const

inline

A breakpoint should be set at this address and Resolve called on each hit.

Returns: the address of a function called by the runtime linker each time a module is loaded/unloaded, or about to be loaded/unloaded.

See also: Resolve()

Definition at line 96 of file HexagonDYLDRendezvous.h.

References HexagonDYLDRendezvous::Rendezvous::brk, and m_current.

Referenced by DumpToLog().

◆ GetLDBase()

lldb::addr_t HexagonDYLDRendezvous::GetLDBase ( ) const

inline

Returns: the base address of the runtime linker in the inferiors address space.

Definition at line 108 of file HexagonDYLDRendezvous.h.

References HexagonDYLDRendezvous::Rendezvous::ldbase, and m_current.

Referenced by DumpToLog().

◆ GetLinkMapAddress()

lldb::addr_t HexagonDYLDRendezvous::GetLinkMapAddress ( ) const

inline

Returns: address in the inferiors address space containing the linked list of shared object descriptors.

Definition at line 87 of file HexagonDYLDRendezvous.h.

References m_current, and HexagonDYLDRendezvous::Rendezvous::map_addr.

Referenced by DumpToLog(), and DynamicLoaderHexagonDYLD::LoadAllCurrentModules().

◆ GetRendezvousAddress()

lldb::addr_t HexagonDYLDRendezvous::GetRendezvousAddress ( ) const

inline

Returns: the address of the rendezvous structure in the inferiors address space.

Definition at line 77 of file HexagonDYLDRendezvous.h.

References m_rendezvous_addr.

Referenced by DumpToLog().

◆ GetState()

uint64_t HexagonDYLDRendezvous::GetState ( ) const

inline

Returns the current state of the rendezvous structure.

Definition at line 104 of file HexagonDYLDRendezvous.h.

References m_current, and HexagonDYLDRendezvous::Rendezvous::state.

Referenced by DumpToLog().

◆ GetThreadInfo()

const HexagonDYLDRendezvous::ThreadInfo & HexagonDYLDRendezvous::GetThreadInfo ( )

Returns: the thread layout metadata from the inferiors thread library.

Definition at line 318 of file HexagonDYLDRendezvous.cpp.

References HexagonDYLDRendezvous::ThreadInfo::dtv_offset, HexagonDYLDRendezvous::ThreadInfo::dtv_slot_size, eOffset, eSize, FindMetadata(), m_thread_info, HexagonDYLDRendezvous::ThreadInfo::modid_offset, HexagonDYLDRendezvous::ThreadInfo::tls_offset, and HexagonDYLDRendezvous::ThreadInfo::valid.

Referenced by DynamicLoaderHexagonDYLD::GetThreadLocalData().

◆ GetVersion()

uint64_t HexagonDYLDRendezvous::GetVersion ( ) const

inline

Returns: the version of the rendezvous protocol being used.

Definition at line 83 of file HexagonDYLDRendezvous.h.

References m_current, and HexagonDYLDRendezvous::Rendezvous::version.

Referenced by DumpToLog().

◆ IsValid()

bool HexagonDYLDRendezvous::IsValid ( )

Returns: true if this rendezvous has been located in the inferiors address space and false otherwise.

Definition at line 111 of file HexagonDYLDRendezvous.cpp.

References LLDB_INVALID_ADDRESS, and m_rendezvous_addr.

Referenced by DynamicLoaderHexagonDYLD::RendezvousBreakpointHit().

◆ loaded_begin()

iterator HexagonDYLDRendezvous::loaded_begin ( ) const

inline

Iterators over all modules loaded into the inferior since the last call to Resolve().

Definition at line 173 of file HexagonDYLDRendezvous.h.

References m_added_soentries.

Referenced by DynamicLoaderHexagonDYLD::RefreshModules().

◆ loaded_end()

iterator HexagonDYLDRendezvous::loaded_end ( ) const

inline

Definition at line 174 of file HexagonDYLDRendezvous.h.

References m_added_soentries.

Referenced by DynamicLoaderHexagonDYLD::RefreshModules().

◆ ModulesDidLoad()

bool HexagonDYLDRendezvous::ModulesDidLoad ( ) const

inline

Returns: true if modules have been loaded into the inferior since the last call to Resolve().

Definition at line 115 of file HexagonDYLDRendezvous.h.

References m_added_soentries.

Referenced by DynamicLoaderHexagonDYLD::RefreshModules().

◆ ModulesDidUnload()

bool HexagonDYLDRendezvous::ModulesDidUnload ( ) const

inline

Returns: true if modules have been unloaded from the inferior since the last call to Resolve().

Definition at line 119 of file HexagonDYLDRendezvous.h.

References m_removed_soentries.

Referenced by DynamicLoaderHexagonDYLD::RefreshModules().

◆ ReadPointer()

addr_t HexagonDYLDRendezvous::ReadPointer	(	lldb::addr_t	addr,
		lldb::addr_t *	dst
	)

protected

Reads an address from the inferior's address space starting at addr.

Returns: addr + target address size if the read was successful and 0 otherwise.

Definition at line 231 of file HexagonDYLDRendezvous.cpp.

References error(), lldb_private::Process::GetAddressByteSize(), m_process, and lldb_private::Process::ReadPointerFromMemory().

Referenced by ReadSOEntryFromMemory(), and Resolve().

◆ ReadSOEntryFromMemory()

bool HexagonDYLDRendezvous::ReadSOEntryFromMemory	(	lldb::addr_t	addr,
		SOEntry &	entry
	)

protected

Reads an SOEntry starting at addr.

Definition at line 265 of file HexagonDYLDRendezvous.cpp.

References HexagonDYLDRendezvous::SOEntry::base_addr, HexagonDYLDRendezvous::SOEntry::clear(), HexagonDYLDRendezvous::SOEntry::dyn_addr, HexagonDYLDRendezvous::SOEntry::link_addr, HexagonDYLDRendezvous::SOEntry::next, HexagonDYLDRendezvous::SOEntry::path, HexagonDYLDRendezvous::SOEntry::path_addr, HexagonDYLDRendezvous::SOEntry::prev, ReadPointer(), and ReadStringFromMemory().

Referenced by TakeSnapshot(), and UpdateSOEntriesForAddition().

◆ ReadStringFromMemory()

std::string HexagonDYLDRendezvous::ReadStringFromMemory ( lldb::addr_t addr )

protected

Reads a null-terminated C string from the memory location starting at addr.

Definition at line 241 of file HexagonDYLDRendezvous.cpp.

References error(), LLDB_INVALID_ADDRESS, m_process, and lldb_private::Process::ReadMemory().

Referenced by ReadSOEntryFromMemory().

◆ ReadWord()

addr_t HexagonDYLDRendezvous::ReadWord	(	lldb::addr_t	addr,
		uint64_t *	dst,
		size_t	size
	)

protected

Reads an unsigned integer of size bytes from the inferior's address space starting at addr.

Returns: addr + size if the read was successful and false otherwise.

Definition at line 220 of file HexagonDYLDRendezvous.cpp.

References error(), m_process, and lldb_private::Process::ReadUnsignedIntegerFromMemory().

Referenced by Resolve().

◆ Resolve()

bool HexagonDYLDRendezvous::Resolve ( )

Update the internal snapshot of runtime linker rendezvous and recompute the currently loaded modules.

This method should be called once one start up, then once each time the runtime linker enters the function given by GetBreakAddress().

Returns: true on success and false on failure.

See also: GetBreakAddress().

Definition at line 65 of file HexagonDYLDRendezvous.cpp.

References HexagonDYLDRendezvous::Rendezvous::brk, lldb_private::Process::GetAddressByteSize(), HexagonDYLDRendezvous::Rendezvous::ldbase, LLDB_INVALID_ADDRESS, m_current, m_previous, m_process, m_rendezvous_addr, HexagonDYLDRendezvous::Rendezvous::map_addr, ReadPointer(), ReadWord(), ResolveRendezvousAddress(), HexagonDYLDRendezvous::Rendezvous::state, UpdateSOEntries(), HexagonDYLDRendezvous::Rendezvous::version, and word_size.

Referenced by DynamicLoaderHexagonDYLD::LoadAllCurrentModules(), and DynamicLoaderHexagonDYLD::RefreshModules().

◆ SetBreakAddress()

void HexagonDYLDRendezvous::SetBreakAddress ( lldb::addr_t addr )

inline

In hexagon it is possible that we can know the dyld breakpoint without having to find it from the rendezvous structure.

Definition at line 101 of file HexagonDYLDRendezvous.h.

References HexagonDYLDRendezvous::Rendezvous::brk, and m_current.

Referenced by DynamicLoaderHexagonDYLD::SetRendezvousBreakpoint().

◆ SetRendezvousAddress()

void HexagonDYLDRendezvous::SetRendezvousAddress ( lldb::addr_t addr )

Provide the dyld structure address.

Definition at line 107 of file HexagonDYLDRendezvous.cpp.

References m_rendezvous_addr.

Referenced by DynamicLoaderHexagonDYLD::RendezvousBreakpointHit().

◆ TakeSnapshot()

bool HexagonDYLDRendezvous::TakeSnapshot ( SOEntryList & entry_list )

protected

Reads the current list of shared objects according to the link map supplied by the runtime linker.

Definition at line 198 of file HexagonDYLDRendezvous.cpp.

References m_current, m_exe_path, HexagonDYLDRendezvous::Rendezvous::map_addr, HexagonDYLDRendezvous::SOEntry::next, HexagonDYLDRendezvous::SOEntry::path, and ReadSOEntryFromMemory().

Referenced by UpdateSOEntries(), and UpdateSOEntriesForDeletion().

◆ unloaded_begin()

iterator HexagonDYLDRendezvous::unloaded_begin ( ) const

inline

Iterators over all modules unloaded from the inferior since the last call to Resolve().

Definition at line 178 of file HexagonDYLDRendezvous.h.

References m_removed_soentries.

Referenced by DynamicLoaderHexagonDYLD::RefreshModules().

◆ unloaded_end()

iterator HexagonDYLDRendezvous::unloaded_end ( ) const

inline

Definition at line 179 of file HexagonDYLDRendezvous.h.

References m_removed_soentries.

Referenced by DynamicLoaderHexagonDYLD::RefreshModules().

◆ UpdateSOEntries()

bool HexagonDYLDRendezvous::UpdateSOEntries ( )

protected

Updates the current set of SOEntries, the set of added entries, and the set of removed entries.

Definition at line 115 of file HexagonDYLDRendezvous.cpp.

References eAdd, eConsistent, eDelete, m_added_soentries, m_current, m_previous, m_removed_soentries, m_soentries, HexagonDYLDRendezvous::Rendezvous::map_addr, HexagonDYLDRendezvous::Rendezvous::state, TakeSnapshot(), UpdateSOEntriesForAddition(), and UpdateSOEntriesForDeletion().

Referenced by Resolve().

◆ UpdateSOEntriesForAddition()

bool HexagonDYLDRendezvous::UpdateSOEntriesForAddition ( )

protected

Definition at line 152 of file HexagonDYLDRendezvous.cpp.

References eAdd, m_added_soentries, m_current, m_exe_path, m_previous, m_soentries, HexagonDYLDRendezvous::Rendezvous::map_addr, HexagonDYLDRendezvous::SOEntry::next, HexagonDYLDRendezvous::SOEntry::path, ReadSOEntryFromMemory(), and HexagonDYLDRendezvous::Rendezvous::state.

Referenced by UpdateSOEntries().

◆ UpdateSOEntriesForDeletion()

bool HexagonDYLDRendezvous::UpdateSOEntriesForDeletion ( )

protected

Definition at line 180 of file HexagonDYLDRendezvous.cpp.

References begin(), eDelete, end(), m_previous, m_removed_soentries, m_soentries, HexagonDYLDRendezvous::Rendezvous::state, and TakeSnapshot().

Referenced by UpdateSOEntries().

Member Data Documentation

◆ m_added_soentries

SOEntryList HexagonDYLDRendezvous::m_added_soentries

protected

List of SOEntry's added to the link map since the last call to Resolve().

Definition at line 199 of file HexagonDYLDRendezvous.h.

Referenced by loaded_begin(), loaded_end(), ModulesDidLoad(), UpdateSOEntries(), and UpdateSOEntriesForAddition().

◆ m_current

Rendezvous HexagonDYLDRendezvous::m_current

protected

Current and previous snapshots of the rendezvous structure.

Definition at line 191 of file HexagonDYLDRendezvous.h.

Referenced by GetBreakAddress(), GetLDBase(), GetLinkMapAddress(), GetState(), GetVersion(), Resolve(), SetBreakAddress(), TakeSnapshot(), UpdateSOEntries(), and UpdateSOEntriesForAddition().

◆ m_exe_path

char HexagonDYLDRendezvous::m_exe_path[PATH_MAX]

protected

Definition at line 185 of file HexagonDYLDRendezvous.h.

Referenced by HexagonDYLDRendezvous(), TakeSnapshot(), and UpdateSOEntriesForAddition().

◆ m_previous

Rendezvous HexagonDYLDRendezvous::m_previous

protected

Definition at line 192 of file HexagonDYLDRendezvous.h.

Referenced by Resolve(), UpdateSOEntries(), UpdateSOEntriesForAddition(), and UpdateSOEntriesForDeletion().

◆ m_process

lldb_private::Process* HexagonDYLDRendezvous::m_process

protected

Definition at line 182 of file HexagonDYLDRendezvous.h.

Referenced by FindMetadata(), HexagonDYLDRendezvous(), ReadPointer(), ReadStringFromMemory(), ReadWord(), and Resolve().

◆ m_removed_soentries

SOEntryList HexagonDYLDRendezvous::m_removed_soentries

protected

List of SOEntry's removed from the link map since the last call to Resolve().

Definition at line 203 of file HexagonDYLDRendezvous.h.

Referenced by ModulesDidUnload(), unloaded_begin(), unloaded_end(), UpdateSOEntries(), and UpdateSOEntriesForDeletion().

◆ m_rendezvous_addr

lldb::addr_t HexagonDYLDRendezvous::m_rendezvous_addr

protected

Location of the r_debug structure in the inferiors address space.

Definition at line 188 of file HexagonDYLDRendezvous.h.

Referenced by GetRendezvousAddress(), IsValid(), Resolve(), and SetRendezvousAddress().

◆ m_soentries

SOEntryList HexagonDYLDRendezvous::m_soentries

protected

List of SOEntry objects corresponding to the current link map state.

Definition at line 195 of file HexagonDYLDRendezvous.h.

Referenced by begin(), end(), UpdateSOEntries(), UpdateSOEntriesForAddition(), and UpdateSOEntriesForDeletion().

◆ m_thread_info

ThreadInfo HexagonDYLDRendezvous::m_thread_info

protected

Threading metadata read from the inferior.

Definition at line 206 of file HexagonDYLDRendezvous.h.

Referenced by GetThreadInfo(), and HexagonDYLDRendezvous().

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

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ iterator

◆ SOEntryList

Member Enumeration Documentation

◆ PThreadField

◆ RendezvousState

Constructor & Destructor Documentation

◆ HexagonDYLDRendezvous()

Member Function Documentation

◆ begin()

◆ DumpToLog()

◆ end()

◆ FindMetadata()

◆ GetBreakAddress()

◆ GetLDBase()

◆ GetLinkMapAddress()

◆ GetRendezvousAddress()

◆ GetState()

◆ GetThreadInfo()

◆ GetVersion()

◆ IsValid()

◆ loaded_begin()

◆ loaded_end()

◆ ModulesDidLoad()

◆ ModulesDidUnload()

◆ ReadPointer()

◆ ReadSOEntryFromMemory()

◆ ReadStringFromMemory()

◆ ReadWord()

◆ Resolve()

◆ SetBreakAddress()

◆ SetRendezvousAddress()

◆ TakeSnapshot()

◆ unloaded_begin()

◆ unloaded_end()

◆ UpdateSOEntries()

◆ UpdateSOEntriesForAddition()

◆ UpdateSOEntriesForDeletion()

Member Data Documentation

◆ m_added_soentries

◆ m_current

◆ m_exe_path

◆ m_previous

◆ m_process

◆ m_removed_soentries

◆ m_rendezvous_addr

◆ m_soentries

◆ m_thread_info