LLDB  mainline
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
DynamicLoaderMacOS Class Reference

#include <DynamicLoaderMacOS.h>

Inheritance diagram for DynamicLoaderMacOS:
Inheritance graph
Collaboration diagram for DynamicLoaderMacOS:
Collaboration graph

Public Member Functions

 DynamicLoaderMacOS (lldb_private::Process *process)
 ~DynamicLoaderMacOS () override
bool ProcessDidExec () override
 Called after attaching a process. More...
lldb_private::Status CanLoadImage () override
 Ask if it is ok to try and load or unload an shared library (image). More...
bool GetSharedCacheInformation (lldb::addr_t &base_address, lldb_private::UUID &uuid, lldb_private::LazyBool &using_shared_cache, lldb_private::LazyBool &private_shared_cache) override
 Get information about the shared cache for a process, if possible. More...
llvm::StringRef GetPluginName () override
- Public Member Functions inherited from lldb_private::DynamicLoaderDarwin
 DynamicLoaderDarwin (lldb_private::Process *process)
 ~DynamicLoaderDarwin () override
void DidAttach () override
 Called after attaching a process. More...
void DidLaunch () override
 Called after attaching a process. More...
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. More...
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. More...
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. More...
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. More...
- Public Member Functions inherited from lldb_private::DynamicLoader
 DynamicLoader (Process *process)
 Construct with a process. More...
bool GetStopWhenImagesChange () const
 Get whether the process should stop when images change. More...
void SetStopWhenImagesChange (bool stop)
 Set whether the process should stop when images change. More...
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. More...
virtual bool IsFullyInitialized ()
 Return whether the dynamic loader is fully initialized and it's safe to call its APIs. More...
- Public Member Functions inherited from lldb_private::PluginInterface
 PluginInterface ()=default
virtual ~PluginInterface ()=default
 PluginInterface (const PluginInterface &)=delete
PluginInterfaceoperator= (const PluginInterface &)=delete

Static Public Member Functions

static void Initialize ()
static void Terminate ()
static llvm::StringRef GetPluginNameStatic ()
static llvm::StringRef GetPluginDescriptionStatic ()
static lldb_private::DynamicLoaderCreateInstance (lldb_private::Process *process, bool force)
- Static Public Member Functions inherited from lldb_private::DynamicLoader
static DynamicLoaderFindPlugin (Process *process, llvm::StringRef plugin_name)
 Find a dynamic loader plugin for a given process. More...

Protected Member Functions

void PutToLog (lldb_private::Log *log) const
void DoInitialImageFetch () override
bool NeedToDoInitialImageFetch () override
bool DidSetNotificationBreakpoint () override
void AddBinaries (const std::vector< lldb::addr_t > &load_addresses)
void DoClear () override
bool SetNotificationBreakpoint () override
void ClearNotificationBreakpoint () override
void UpdateImageInfosHeaderAndLoadCommands (ImageInfo::collection &image_infos, uint32_t infos_count, bool update_executable)
lldb::addr_t GetDyldLockVariableAddressFromModule (lldb_private::Module *module)
- Protected Member Functions inherited from lldb_private::DynamicLoaderDarwin
void PrivateInitialize (lldb_private::Process *process)
void PrivateProcessStateChanged (lldb_private::Process *process, lldb::StateType state)
void Clear (bool clear_process)
void SetDYLDModule (lldb::ModuleSP &dyld_module_sp)
lldb::ModuleSP GetDYLDModule ()
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 ()
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 GetTargetExecutable ()
 Checks to see if the target module has changed, updates the target accordingly and returns the target executable module. More...
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. More...
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. More...
void UnloadSectionsCommon (const lldb::ModuleSP module)
const lldb_private::SectionListGetSectionListFromModule (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 NotifyBreakpointHit (void *baton, lldb_private::StoppointCallbackContext *context, lldb::user_id_t break_id, lldb::user_id_t break_loc_id)
- Static Protected Member Functions inherited from lldb_private::DynamicLoaderDarwin
static bool UseDYLDSPI (lldb_private::Process *process)

Protected Attributes

uint32_t m_image_infos_stop_id
lldb::user_id_t m_break_id
std::recursive_mutex m_mutex
lldb::addr_t m_maybe_image_infos_address
- Protected Attributes inherited from lldb_private::DynamicLoaderDarwin
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
 The process that this dynamic loader plug-in is tracking. More...

Additional Inherited Members

- Protected Types inherited from lldb_private::DynamicLoaderDarwin
typedef std::map< uint64_t, lldb::addr_tPthreadKeyToTLSMap
typedef std::map< lldb::user_id_t, PthreadKeyToTLSMapThreadIDToTLSMap

Detailed Description

Definition at line 31 of file DynamicLoaderMacOS.h.

Constructor & Destructor Documentation

◆ DynamicLoaderMacOS()

DynamicLoaderMacOS::DynamicLoaderMacOS ( lldb_private::Process process)

Definition at line 76 of file DynamicLoaderMacOS.cpp.

◆ ~DynamicLoaderMacOS()

DynamicLoaderMacOS::~DynamicLoaderMacOS ( )

Member Function Documentation

◆ AddBinaries()

void DynamicLoaderMacOS::AddBinaries ( const std::vector< lldb::addr_t > &  load_addresses)

◆ CanLoadImage()

Status DynamicLoaderMacOS::CanLoadImage ( )

Ask if it is ok to try and load or unload an shared library (image).

The dynamic loader often knows when it would be ok to try and load or unload a shared library. This function call allows the dynamic loader plug-ins to check any current dyld state to make sure it is an ok time to load a shared library.

true if it is currently ok to try and load a shared library into the process, false otherwise.

Implements lldb_private::DynamicLoader.

Definition at line 398 of file DynamicLoaderMacOS.cpp.

References error(), GetDyldLockVariableAddressFromModule(), lldb_private::Target::GetImages(), lldb_private::ModuleList::GetMutex(), lldb_private::ModuleList::GetSize(), lldb_private::Process::GetTarget(), LLDB_INVALID_ADDRESS, lldb_private::DynamicLoader::m_process, lldb_private::ModuleList::Modules(), lldb_private::ModuleList::ModulesNoLocking(), and lldb_private::Process::ReadUnsignedIntegerFromMemory().

◆ ClearNotificationBreakpoint()

void DynamicLoaderMacOS::ClearNotificationBreakpoint ( )

◆ CreateInstance()

DynamicLoader * DynamicLoaderMacOS::CreateInstance ( lldb_private::Process process,
bool  force 

◆ DidSetNotificationBreakpoint()

bool DynamicLoaderMacOS::DidSetNotificationBreakpoint ( )

Implements lldb_private::DynamicLoaderDarwin.

Definition at line 142 of file DynamicLoaderMacOS.cpp.

References LLDB_BREAK_ID_IS_VALID, and m_break_id.

◆ DoClear()

void DynamicLoaderMacOS::DoClear ( )

◆ DoInitialImageFetch()

void DynamicLoaderMacOS::DoInitialImageFetch ( )

◆ GetDyldLockVariableAddressFromModule()

addr_t DynamicLoaderMacOS::GetDyldLockVariableAddressFromModule ( lldb_private::Module module)

◆ GetPluginDescriptionStatic()

llvm::StringRef DynamicLoaderMacOS::GetPluginDescriptionStatic ( )

Definition at line 507 of file DynamicLoaderMacOS.cpp.

Referenced by Initialize().

◆ GetPluginName()

llvm::StringRef DynamicLoaderMacOS::GetPluginName ( )

Implements lldb_private::PluginInterface.

Definition at line 63 of file DynamicLoaderMacOS.h.

References GetPluginNameStatic().

◆ GetPluginNameStatic()

static llvm::StringRef DynamicLoaderMacOS::GetPluginNameStatic ( )

Definition at line 42 of file DynamicLoaderMacOS.h.

Referenced by GetPluginName(), and Initialize().

◆ GetSharedCacheInformation()

bool DynamicLoaderMacOS::GetSharedCacheInformation ( lldb::addr_t base_address,
lldb_private::UUID uuid,
lldb_private::LazyBool using_shared_cache,
lldb_private::LazyBool private_shared_cache 

Get information about the shared cache for a process, if possible.

On some systems (e.g. Darwin based systems), a set of libraries that are common to most processes may be put in a single region of memory and mapped into every process, this is called the shared cache, as a performance optimization.

Many targets will not have the concept of a shared cache.

Depending on how the DynamicLoader gathers information about the shared cache, it may be able to only return basic information - like the UUID of the cache - or it may be able to return additional information about the cache.

[out]base_addressThe base address (load address) of the shared cache. LLDB_INVALID_ADDRESS if it cannot be determined.
[out]uuidThe UUID of the shared cache, if it can be determined. If the UUID cannot be fetched, IsValid() will be false.
[out]using_shared_cacheIf this process is using a shared cache. If unknown, eLazyBoolCalculate is returned.
[out]private_shared_cacheA LazyBool indicating whether this process is using a private shared cache. If this information cannot be fetched, eLazyBoolCalculate.
Returns false if this DynamicLoader cannot gather information about the shared cache / has no concept of a shared cache.

Reimplemented from lldb_private::DynamicLoader.

Definition at line 454 of file DynamicLoaderMacOS.cpp.

References lldb_private::UUID::Clear(), lldb_private::eLazyBoolCalculate, lldb_private::eLazyBoolNo, lldb_private::eLazyBoolYes, lldb_private::StructuredData::Object::GetAsDictionary(), lldb_private::Process::GetSharedCacheInfo(), lldb_private::StructuredData::Dictionary::GetValueForKey(), lldb_private::StructuredData::Dictionary::HasKey(), LLDB_INVALID_ADDRESS, lldb_private::DynamicLoader::m_process, lldb_private::UUID::SetFromStringRef(), and string().

◆ Initialize()

void DynamicLoaderMacOS::Initialize ( )

◆ NeedToDoInitialImageFetch()

bool DynamicLoaderMacOS::NeedToDoInitialImageFetch ( )

Implements lldb_private::DynamicLoaderDarwin.

Definition at line 189 of file DynamicLoaderMacOS.cpp.

◆ NotifyBreakpointHit()

bool DynamicLoaderMacOS::NotifyBreakpointHit ( void *  baton,
lldb_private::StoppointCallbackContext context,
lldb::user_id_t  break_id,
lldb::user_id_t  break_loc_id 

◆ ProcessDidExec()

bool DynamicLoaderMacOS::ProcessDidExec ( )

◆ PutToLog()

void DynamicLoaderMacOS::PutToLog ( lldb_private::Log log) const

Definition at line 339 of file DynamicLoaderMacOS.cpp.

◆ SetNotificationBreakpoint()

bool DynamicLoaderMacOS::SetNotificationBreakpoint ( )

◆ Terminate()

void DynamicLoaderMacOS::Terminate ( )

Definition at line 503 of file DynamicLoaderMacOS.cpp.

References CreateInstance().

Referenced by DynamicLoaderMacOSXDYLD::Terminate().

◆ UpdateImageInfosHeaderAndLoadCommands()

void DynamicLoaderMacOS::UpdateImageInfosHeaderAndLoadCommands ( ImageInfo::collection image_infos,
uint32_t  infos_count,
bool  update_executable 

Member Data Documentation

◆ m_break_id

lldb::user_id_t DynamicLoaderMacOS::m_break_id

◆ m_image_infos_stop_id

uint32_t DynamicLoaderMacOS::m_image_infos_stop_id

Definition at line 94 of file DynamicLoaderMacOS.h.

Referenced by NotifyBreakpointHit().

◆ m_maybe_image_infos_address

lldb::addr_t DynamicLoaderMacOS::m_maybe_image_infos_address

Definition at line 98 of file DynamicLoaderMacOS.h.

Referenced by DoInitialImageFetch(), and ProcessDidExec().

◆ m_mutex

std::recursive_mutex DynamicLoaderMacOS::m_mutex

Definition at line 97 of file DynamicLoaderMacOS.h.

Referenced by DoClear().

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