#include <DynamicLoaderDarwin.h>

Inheritance diagram for lldb_private::DynamicLoaderDarwin:

[legend]

Classes
struct	ImageInfo

class	Segment

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

	~DynamicLoaderDarwin () override

void	DidAttach () override
	Called after attaching a process.

void	DidLaunch () override
	Called after attaching a process.

lldb::ThreadPlanSP	GetStepThroughTrampolinePlan (lldb_private::Thread &thread, bool stop_others) override
	Provides a plan to step through the dynamic loader trampoline for the current state of thread.

void	FindEquivalentSymbols (lldb_private::Symbol *original_symbol, lldb_private::ModuleList &module_list, lldb_private::SymbolContextList &equivalent_symbols) override
	Some dynamic loaders provide features where there are a group of symbols "equivalent to" a given symbol one of which will be chosen when the symbol is bound.

lldb::addr_t	GetThreadLocalData (const lldb::ModuleSP module, const lldb::ThreadSP thread, lldb::addr_t tls_file_addr) override
	Retrieves the per-module TLS block for a given thread.

bool	AlwaysRelyOnEHUnwindInfo (lldb_private::SymbolContext &sym_ctx) override
	Ask if the eh_frame information for the given SymbolContext should be relied on even when it's the first frame in a stack unwind.

virtual void	DoInitialImageFetch ()=0

virtual bool	NeedToDoInitialImageFetch ()=0

std::optional< lldb_private::Address >	GetStartAddress () override
	Return the `start` address in the dynamic loader module.

Public Member Functions inherited from lldb_private::DynamicLoader
	DynamicLoader (Process *process)
	Construct with a process.

virtual void	DidAttach ()=0
	Called after attaching a process.

virtual void	DidLaunch ()=0
	Called after launching a process.

virtual bool	ProcessDidExec ()
	Helper function that can be used to detect when a process has called exec and is now a new and different process.

bool	GetStopWhenImagesChange () const
	Get whether the process should stop when images change.

void	SetStopWhenImagesChange (bool stop)
	Set whether the process should stop when images change.

virtual lldb::ThreadPlanSP	GetStepThroughTrampolinePlan (Thread &thread, bool stop_others)=0
	Provides a plan to step through the dynamic loader trampoline for the current state of thread.

virtual void	FindEquivalentSymbols (Symbol *original_symbol, ModuleList &module_list, SymbolContextList &equivalent_symbols)
	Some dynamic loaders provide features where there are a group of symbols "equivalent to" a given symbol one of which will be chosen when the symbol is bound.

virtual Status	CanLoadImage ()=0
	Ask if it is ok to try and load or unload an shared library (image).

virtual bool	AlwaysRelyOnEHUnwindInfo (SymbolContext &sym_ctx)
	Ask if the eh_frame information for the given SymbolContext should be relied on even when it's the first frame in a stack unwind.

virtual lldb::addr_t	GetThreadLocalData (const lldb::ModuleSP module, const lldb::ThreadSP thread, lldb::addr_t tls_file_addr)
	Retrieves the per-module TLS block for a given thread.

virtual lldb::ModuleSP	LoadModuleAtAddress (const lldb_private::FileSpec &file, lldb::addr_t link_map_addr, lldb::addr_t base_addr, bool base_addr_is_offset)
	Locates or creates a module given by `file` and updates/loads the resulting module at the virtual base address `base_addr`.

virtual bool	GetSharedCacheInformation (lldb::addr_t &base_address, UUID &uuid, LazyBool &using_shared_cache, LazyBool &private_shared_cache)
	Get information about the shared cache for a process, if possible.

virtual bool	IsFullyInitialized ()
	Return whether the dynamic loader is fully initialized and it's safe to call its APIs.

virtual std::optional< lldb_private::Address >	GetStartAddress ()
	Return the `start` address in the dynamic loader module.

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

Protected Types
typedef std::map< uint64_t, lldb::addr_t >	PthreadKeyToTLSMap

typedef std::map< lldb::user_id_t, PthreadKeyToTLSMap >	ThreadIDToTLSMap

Protected Member Functions
void	PrivateInitialize (lldb_private::Process *process)

void	PrivateProcessStateChanged (lldb_private::Process *process, lldb::StateType state)

void	Clear (bool clear_process)

virtual void	DoClear ()=0

void	SetDYLDModule (lldb::ModuleSP &dyld_module_sp)

lldb::ModuleSP	GetDYLDModule ()

void	ClearDYLDModule ()

bool	UpdateImageLoadAddress (lldb_private::Module *module, ImageInfo &info)

bool	UnloadModuleSections (lldb_private::Module *module, ImageInfo &info)

lldb::ModuleSP	FindTargetModuleForImageInfo (ImageInfo &image_info, bool can_create, bool *did_create_ptr)

void	UnloadImages (const std::vector< lldb::addr_t > &solib_addresses)

void	UnloadAllImages ()

virtual bool	SetNotificationBreakpoint ()=0

virtual void	ClearNotificationBreakpoint ()=0

virtual bool	DidSetNotificationBreakpoint ()=0

std::recursive_mutex &	GetMutex () const

lldb::ModuleSP	GetPThreadLibraryModule ()

lldb_private::Address	GetPthreadSetSpecificAddress ()

bool	JSONImageInformationIntoImageInfo (lldb_private::StructuredData::ObjectSP image_details, ImageInfo::collection &image_infos)

void	UpdateSpecialBinariesFromNewImageInfos (ImageInfo::collection &image_infos)

void	UpdateDYLDImageInfoFromNewImageInfo (ImageInfo &image_info)

void	AddExecutableModuleIfInImageInfos (ImageInfo::collection &image_infos)

bool	AddModulesUsingImageInfos (ImageInfo::collection &image_infos)

Protected Member Functions inherited from lldb_private::DynamicLoader
lldb::ModuleSP	FindModuleViaTarget (const FileSpec &file)

lldb::ModuleSP	GetTargetExecutable ()
	Checks to see if the target module has changed, updates the target accordingly and returns the target executable module.

virtual void	UpdateLoadedSections (lldb::ModuleSP module, lldb::addr_t link_map_addr, lldb::addr_t base_addr, bool base_addr_is_offset)
	Updates the load address of every allocatable section in `module`.

void	UpdateLoadedSectionsCommon (lldb::ModuleSP module, lldb::addr_t base_addr, bool base_addr_is_offset)

virtual void	UnloadSections (const lldb::ModuleSP module)
	Removes the loaded sections from the target in `module`.

void	UnloadSectionsCommon (const lldb::ModuleSP module)

const lldb_private::SectionList *	GetSectionListFromModule (const lldb::ModuleSP module) const

int64_t	ReadUnsignedIntWithSizeInBytes (lldb::addr_t addr, int size_in_bytes)

lldb::addr_t	ReadPointer (lldb::addr_t addr)

void	LoadOperatingSystemPlugin (bool flush)

Static Protected Member Functions
static bool	UseDYLDSPI (lldb_private::Process *process)

Protected Attributes
lldb::ModuleWP	m_dyld_module_wp

lldb::ModuleWP	m_libpthread_module_wp

lldb_private::Address	m_pthread_getspecific_addr

ThreadIDToTLSMap	m_tid_to_tls_map

ImageInfo::collection	m_dyld_image_infos

uint32_t	m_dyld_image_infos_stop_id

ImageInfo	m_dyld

std::recursive_mutex	m_mutex

Protected Attributes inherited from lldb_private::DynamicLoader
Process *	m_process
	The process that this dynamic loader plug-in is tracking.

Private Member Functions
	DynamicLoaderDarwin (const DynamicLoaderDarwin &)=delete

const DynamicLoaderDarwin &	operator= (const DynamicLoaderDarwin &)=delete

Additional Inherited Members
Static Public Member Functions inherited from lldb_private::DynamicLoader
static DynamicLoader *	FindPlugin (Process *process, llvm::StringRef plugin_name)
	Find a dynamic loader plugin for a given process.

static lldb::ModuleSP	LoadBinaryWithUUIDAndAddress (Process *process, llvm::StringRef name, UUID uuid, lldb::addr_t value, bool value_is_offset, bool force_symbol_search, bool notify, bool set_address_in_target, bool allow_memory_image_last_resort)
	Find/load a binary into lldb given a UUID and the address where it is loaded in memory, or a slide to be applied to the file address.

Detailed Description

Definition at line 27 of file DynamicLoaderDarwin.h.

Member Typedef Documentation

◆ PthreadKeyToTLSMap

typedef std::map<uint64_t, lldb::addr_t> lldb_private::DynamicLoaderDarwin::PthreadKeyToTLSMap

protected

Definition at line 191 of file DynamicLoaderDarwin.h.

◆ ThreadIDToTLSMap

typedef std::map<lldb::user_id_t, PthreadKeyToTLSMap> lldb_private::DynamicLoaderDarwin::ThreadIDToTLSMap

protected

Definition at line 192 of file DynamicLoaderDarwin.h.

Constructor & Destructor Documentation

◆ DynamicLoaderDarwin() [1/2]

DynamicLoaderDarwin::DynamicLoaderDarwin ( lldb_private::Process * process )

Definition at line 52 of file DynamicLoaderDarwin.cpp.

◆ ~DynamicLoaderDarwin()

DynamicLoaderDarwin::~DynamicLoaderDarwin ( )

overridedefault

◆ DynamicLoaderDarwin() [2/2]

lldb_private::DynamicLoaderDarwin::DynamicLoaderDarwin ( const DynamicLoaderDarwin & )

privatedelete

Member Function Documentation

◆ AddExecutableModuleIfInImageInfos()

void lldb_private::DynamicLoaderDarwin::AddExecutableModuleIfInImageInfos ( ImageInfo::collection & image_infos )

protected

◆ AddModulesUsingImageInfos()

bool DynamicLoaderDarwin::AddModulesUsingImageInfos ( ImageInfo::collection & image_infos )

protected

Definition at line 643 of file DynamicLoaderDarwin.cpp.

References lldb_private::ModuleList::Append(), lldb_private::ModuleList::AppendIfNeeded(), lldb_private::DynamicLoader, lldb_private::ModuleList::FindFirstModule(), lldb_private::SectionList::FindSectionByName(), FindTargetModuleForImageInfo(), lldb_private::ObjectFile::GetByteSize(), lldb_private::Section::GetFileOffset(), lldb_private::ObjectFile::GetFileOffset(), lldb_private::ObjectFile::GetFileSpec(), lldb_private::Target::GetImages(), lldb_private::GetLog(), lldb_private::ModuleSpec::GetObjectName(), lldb_private::Target::GetOrCreateModule(), lldb_private::ObjectFile::GetSectionList(), lldb_private::ModuleList::GetSize(), lldb_private::Process::GetStopID(), lldb_private::Process::GetTarget(), lldb_private::ArchSpec::GetTriple(), LLDB_LOGF, lldb_private::ModuleList::LogUUIDAndPaths(), m_dyld_image_infos, m_mutex, lldb_private::DynamicLoader::m_process, lldb_private::Target::ModulesDidLoad(), lldb_private::Process::ReadModuleFromMemory(), lldb_private::ModuleSpec::SetObjectOffset(), lldb_private::ModuleSpec::SetObjectSize(), and UpdateImageLoadAddress().

Referenced by DynamicLoaderMacOS::AddBinaries(), DynamicLoaderMacOSXDYLD::AddModulesUsingImageInfosAddress(), and DynamicLoaderMacOS::DoInitialImageFetch().

◆ AlwaysRelyOnEHUnwindInfo()

bool DynamicLoaderDarwin::AlwaysRelyOnEHUnwindInfo ( lldb_private::SymbolContext & sym_ctx )

overridevirtual

Ask if the eh_frame information for the given SymbolContext should be relied on even when it's the first frame in a stack unwind.

The CFI instructions from the eh_frame section are normally only valid at call sites – places where a program could throw an exception and need to unwind out. But some Modules may be known to the system as having reliable eh_frame information at all call sites. This would be the case if the Module's contents are largely hand-written assembly with hand-written eh_frame information. Normally when unwinding from a function at the beginning of a stack unwind lldb will examine the assembly instructions to understand how the stack frame is set up and where saved registers are stored. But with hand-written assembly this is not reliable enough – we need to consult those function's hand-written eh_frame information.

Returns: True if the symbol context should use eh_frame instructions unconditionally when unwinding from this frame. Else false, the normal lldb unwind behavior of only using eh_frame when the function appears in the middle of the stack.

Reimplemented from lldb_private::DynamicLoader.

Definition at line 750 of file DynamicLoaderDarwin.cpp.

References lldb_private::SymbolContext::function, lldb_private::ObjCLanguageRuntime::Get(), lldb_private::Function::GetAddressRange(), lldb_private::Symbol::GetAddressRef(), lldb_private::AddressRange::GetBaseAddress(), lldb_private::Address::GetModule(), lldb_private::ObjCLanguageRuntime::IsModuleObjCLibrary(), lldb_private::DynamicLoader::m_process, and lldb_private::SymbolContext::symbol.

◆ Clear()

void DynamicLoaderDarwin::Clear ( bool clear_process )

protected

Definition at line 81 of file DynamicLoaderDarwin.cpp.

References lldb_private::DynamicLoaderDarwin::ImageInfo::Clear(), m_dyld, m_dyld_image_infos, m_dyld_image_infos_stop_id, m_mutex, lldb_private::DynamicLoader::m_process, and UINT32_MAX.

Referenced by PrivateInitialize(), and PrivateProcessStateChanged().

◆ ClearDYLDModule()

void DynamicLoaderDarwin::ClearDYLDModule ( )

protected

Definition at line 641 of file DynamicLoaderDarwin.cpp.

References m_dyld_module_wp.

Referenced by DynamicLoaderMacOS::NotifyBreakpointHit().

◆ ClearNotificationBreakpoint()

virtual void lldb_private::DynamicLoaderDarwin::ClearNotificationBreakpoint ( )

protectedpure virtual

Implemented in DynamicLoaderMacOS, and DynamicLoaderMacOSXDYLD.

◆ DidAttach()

void DynamicLoaderDarwin::DidAttach ( )

overridevirtual

Called after attaching a process.

Allow DynamicLoader plug-ins to execute some code after attaching to a process.

Implements lldb_private::DynamicLoader.

Definition at line 64 of file DynamicLoaderDarwin.cpp.

References DoInitialImageFetch(), lldb_private::DynamicLoader::m_process, PrivateInitialize(), and SetNotificationBreakpoint().

◆ DidLaunch()

void DynamicLoaderDarwin::DidLaunch ( )

overridevirtual

Called after attaching a process.

Allow DynamicLoader plug-ins to execute some code after attaching to a process.

Implements lldb_private::DynamicLoader.

Definition at line 74 of file DynamicLoaderDarwin.cpp.

References DoInitialImageFetch(), lldb_private::DynamicLoader::m_process, PrivateInitialize(), and SetNotificationBreakpoint().

◆ DidSetNotificationBreakpoint()

virtual bool lldb_private::DynamicLoaderDarwin::DidSetNotificationBreakpoint ( )

protectedpure virtual

Implemented in DynamicLoaderMacOS, and DynamicLoaderMacOSXDYLD.

Referenced by PrivateProcessStateChanged().

◆ DoClear()

virtual void lldb_private::DynamicLoaderDarwin::DoClear ( )

protectedpure virtual

Implemented in DynamicLoaderMacOS, and DynamicLoaderMacOSXDYLD.

◆ DoInitialImageFetch()

virtual void lldb_private::DynamicLoaderDarwin::DoInitialImageFetch ( )

pure virtual

Implemented in DynamicLoaderMacOS, and DynamicLoaderMacOSXDYLD.

Referenced by DidAttach(), DidLaunch(), and PrivateProcessStateChanged().

◆ FindEquivalentSymbols()

void DynamicLoaderDarwin::FindEquivalentSymbols	(	lldb_private::Symbol *	original_symbol,
		lldb_private::ModuleList &	module_list,
		lldb_private::SymbolContextList &	equivalent_symbols
	)

overridevirtual

Some dynamic loaders provide features where there are a group of symbols "equivalent to" a given symbol one of which will be chosen when the symbol is bound.

If you want to set a breakpoint on one of these symbols, you really need to set it on all the equivalent symbols.

Parameters

[in]	original_symbol	The symbol for which we are finding equivalences.
[in]	module_list	The set of modules in which to search.
[out]	equivalent_symbols	The equivalent symbol list - any equivalent symbols found are appended to this list.

Reimplemented from lldb_private::DynamicLoader.

Definition at line 1007 of file DynamicLoaderDarwin.cpp.

References lldb_private::Mangled::ePreferMangled, lldb::eSymbolTypeCode, lldb_private::ModuleList::FindSymbolsMatchingRegExAndType(), lldb_private::ConstString::GetCString(), lldb_private::Symbol::GetMangled(), and lldb_private::Mangled::GetName().

◆ FindTargetModuleForImageInfo()

ModuleSP DynamicLoaderDarwin::FindTargetModuleForImageInfo	(	ImageInfo &	image_info,
		bool	can_create,
		bool *	did_create_ptr
	)

protected

Definition at line 90 of file DynamicLoaderDarwin.cpp.

References lldb_private::DynamicLoaderDarwin::ImageInfo::address, lldb_private::SharedCacheImageInfo::data_sp, lldb_private::DynamicLoaderDarwin::ImageInfo::file_spec, lldb_private::ModuleList::FindFirstModule(), lldb_private::ModuleSpec::GetArchitecture(), lldb_private::Target::GetArchitecture(), lldb_private::ModuleSpec::GetFileSpec(), lldb_private::Target::GetImages(), lldb_private::FileSystem::GetModificationTime(), lldb_private::Target::GetOrCreateModule(), lldb_private::FileSpec::GetPath(), lldb_private::Process::GetTarget(), lldb_private::ArchSpec::GetTriple(), lldb_private::ModuleSpec::GetUUID(), lldb_private::FileSystem::Instance(), lldb_private::UUID::IsValid(), lldb_private::DynamicLoader::m_process, lldb_private::Process::ReadModuleFromMemory(), lldb_private::SharedCacheImageInfo::uuid, and lldb_private::DynamicLoaderDarwin::ImageInfo::uuid.

Referenced by AddModulesUsingImageInfos(), DynamicLoaderMacOSXDYLD::RemoveModulesUsingImageInfosAddress(), UpdateDYLDImageInfoFromNewImageInfo(), DynamicLoaderMacOSXDYLD::UpdateImageInfosHeaderAndLoadCommands(), and UpdateSpecialBinariesFromNewImageInfos().

◆ GetDYLDModule()

ModuleSP DynamicLoaderDarwin::GetDYLDModule ( )

protected

Definition at line 636 of file DynamicLoaderDarwin.cpp.

References m_dyld_module_wp.

Referenced by GetStartAddress(), DynamicLoaderMacOSXDYLD::ReadDYLDInfoFromMemoryAndSetNotificationCallback(), DynamicLoaderMacOS::SetNotificationBreakpoint(), DynamicLoaderMacOSXDYLD::SetNotificationBreakpoint(), UnloadAllImages(), and DynamicLoaderMacOSXDYLD::UpdateImageInfosHeaderAndLoadCommands().

◆ GetMutex()

std::recursive_mutex & lldb_private::DynamicLoaderDarwin::GetMutex ( ) const

inlineprotected

Definition at line 194 of file DynamicLoaderDarwin.h.

References m_mutex.

◆ GetPThreadLibraryModule()

lldb::ModuleSP DynamicLoaderDarwin::GetPThreadLibraryModule ( )

protected

Definition at line 1026 of file DynamicLoaderDarwin.cpp.

References lldb_private::ModuleList::FindModules(), lldb_private::ModuleSpec::GetFileSpec(), lldb_private::Target::GetImages(), lldb_private::ModuleList::GetModuleAtIndex(), lldb_private::ModuleList::GetSize(), lldb_private::Process::GetTarget(), lldb_private::ModuleList::IsEmpty(), m_libpthread_module_wp, lldb_private::DynamicLoader::m_process, and lldb_private::FileSpec::SetFilename().

Referenced by GetPthreadSetSpecificAddress().

◆ GetPthreadSetSpecificAddress()

Address DynamicLoaderDarwin::GetPthreadSetSpecificAddress ( )

protected

Definition at line 1045 of file DynamicLoaderDarwin.cpp.

References lldb::eSymbolTypeCode, lldb_private::Symbol::GetAddress(), lldb_private::SymbolContextList::GetContextAtIndex(), GetPThreadLibraryModule(), lldb_private::Address::IsValid(), m_pthread_getspecific_addr, and lldb_private::SymbolContext::symbol.

Referenced by GetThreadLocalData().

◆ GetStartAddress()

std::optional< lldb_private::Address > DynamicLoaderDarwin::GetStartAddress ( )

overridevirtual

Return the start address in the dynamic loader module.

This is the address the process will begin executing with process launch --stop-at-entry.

Reimplemented from lldb_private::DynamicLoader.

Definition at line 612 of file DynamicLoaderDarwin.cpp.

References lldb_private::DynamicLoader, lldb_private::Symbol::GetAddress(), GetDYLDModule(), lldb_private::GetLog(), and LLDB_LOGV.

◆ GetStepThroughTrampolinePlan()

ThreadPlanSP DynamicLoaderDarwin::GetStepThroughTrampolinePlan	(	lldb_private::Thread &	thread,
		bool	stop_others
	)

overridevirtual

Provides a plan to step through the dynamic loader trampoline for the current state of thread.

Parameters

[in] stop_others Whether the plan should be set to stop other threads.

Returns: A pointer to the plan (caller owned) or NULL if we are not at such a trampoline.

Implements lldb_private::DynamicLoader.

Definition at line 876 of file DynamicLoaderDarwin.cpp.

References lldb_private::Symbol::CalculateSymbolContextSymbol(), lldb_private::Thread::CalculateTarget(), lldb_private::Mangled::ePreferMangled, error(), lldb::eSymbolTypeCode, lldb::eSymbolTypeReExported, lldb::eSymbolTypeResolver, lldb_private::ModuleList::FindSymbolsWithNameAndType(), lldb_private::Symbol::GetAddress(), lldb_private::AddressRange::GetBaseAddress(), lldb_private::ConstString::GetCString(), lldb_private::Address::GetLoadAddress(), lldb_private::GetLog(), lldb_private::Symbol::GetMangled(), lldb_private::Symbol::GetName(), lldb_private::Mangled::GetName(), lldb_private::Thread::GetProcess(), lldb_private::Thread::GetStackFrameAtIndex(), lldb_private::StackFrame::GetSymbolContext(), lldb_private::Symbol::GetType(), lldb_private::Symbol::IsIndirect(), lldb_private::Symbol::IsTrampoline(), lldb_private::Address::IsValid(), LLDB_LOGF, lldb_private::Symbol::ResolveReExportedSymbol(), lldb_private::Step, and lldb_private::SymbolContext::symbol.

◆ GetThreadLocalData()

lldb::addr_t DynamicLoaderDarwin::GetThreadLocalData	(	const lldb::ModuleSP	module,
		const lldb::ThreadSP	thread,
		lldb::addr_t	tls_file_addr
	)

overridevirtual

Retrieves the per-module TLS block for a given thread.

Parameters

[in]	module	The module to query TLS data for.
[in]	thread	The specific thread to query TLS data for.

Returns: If the given thread has TLS data allocated for the module, the address of the TLS block. Otherwise LLDB_INVALID_ADDRESS is returned.

Reimplemented from lldb_private::DynamicLoader.

Definition at line 1063 of file DynamicLoaderDarwin.cpp.

References lldb::eBasicTypeVoid, lldb::eExpressionCompleted, error(), lldb_private::Process::FixCodeAddress(), lldb_private::DataExtractor::GetAddress(), lldb_private::Process::GetAddressByteSize(), lldb_private::Process::GetByteOrder(), lldb_private::ScratchTypeSystemClang::GetForTarget(), lldb_private::Address::GetLoadAddress(), lldb_private::CompilerType::GetPointerType(), GetPthreadSetSpecificAddress(), lldb_private::Process::GetTarget(), lldb_private::Address::IsValid(), LLDB_INVALID_ADDRESS, m_mutex, lldb_private::DynamicLoader::m_process, m_tid_to_tls_map, lldb_private::Target::ReadMemory(), lldb_private::Target::ResolveLoadAddress(), and lldb_private::Process::RunThreadPlan().

◆ JSONImageInformationIntoImageInfo()

bool DynamicLoaderDarwin::JSONImageInformationIntoImageInfo	(	lldb_private::StructuredData::ObjectSP	image_details,
		ImageInfo::collection &	image_infos
	)