The PrivateStateThread struct gathers all the bits of state needed to manage handling Process events, from receiving them on the Private State to signaling when process events are broadcase publicly, to determining when various actors can act on the process. More...

#include <Process.h>

Public Member Functions
	PrivateStateThread (Process &process, lldb::StateType public_state, lldb::StateType private_state, bool is_secondary_thread, llvm::StringRef thread_name)
bool	StartupThread ()
bool	IsOnThread (const HostThread &thread) const
bool	IsJoinable ()
void	JoinAndReset ()
bool	IsRunning ()
void	SetThreadName (llvm::StringRef new_name)
lldb::StateType	GetPrivateState () const
lldb::StateType	GetPublicState () const
void	SetPublicState (lldb::StateType new_value)
void	SetPrivateState (lldb::StateType new_value)
std::recursive_mutex &	GetPrivateStateMutex ()
lldb::StateType	GetPrivateStateNoLock () const
void	SetPrivateStateNoLock (lldb::StateType new_state)
void	SetPublicStateNoLock (lldb::StateType new_state)
bool	SetPublicRunLockToRunning ()
bool	SetPrivateRunLockToRunning ()
bool	SetPublicRunLockToStopped ()
bool	SetPrivateRunLockToStopped ()
ProcessRunLock &	GetRunLock ()

Public Attributes
Process &	m_process
	The process state that we show to client code.
ThreadSafeValue< lldb::StateType >	m_public_state
	The actual state of our process.
ThreadSafeValue< lldb::StateType >	m_private_state
	HostThread for the thread that watches for internal state events.
HostThread	m_private_state_thread
ProcessRunLock	m_public_run_lock
ProcessRunLock	m_private_run_lock
bool	m_is_running = false
bool	m_is_secondary_thread
	If we need to run an expression modally in the private state thread, we have to spin up a secondary private state thread to manage the events that drive that interaction.
std::string	m_thread_name

Detailed Description

The PrivateStateThread struct gathers all the bits of state needed to manage handling Process events, from receiving them on the Private State to signaling when process events are broadcase publicly, to determining when various actors can act on the process.

It also holds the current private state thread. These need to be swappable as a group to manage the temporary modal private state thread that we spin up when we need to run an expression on the private state thread.

Definition at line 3204 of file Process.h.

Constructor & Destructor Documentation

◆ PrivateStateThread()

lldb_private::Process::PrivateStateThread::PrivateStateThread	(	Process &	process,
		lldb::StateType	public_state,
		lldb::StateType	private_state,
		bool	is_secondary_thread,
		llvm::StringRef	thread_name )

inline

Definition at line 3205 of file Process.h.

References m_is_secondary_thread, m_private_state, m_process, m_public_state, m_thread_name, and lldb_private::Process::Process().

Member Function Documentation

◆ GetPrivateState()

lldb::StateType lldb_private::Process::PrivateStateThread::GetPrivateState ( ) const

inline

Definition at line 3233 of file Process.h.

References m_private_state.

◆ GetPrivateStateMutex()

std::recursive_mutex & lldb_private::Process::PrivateStateThread::GetPrivateStateMutex ( )

inline

Definition at line 3247 of file Process.h.

References m_private_state.

◆ GetPrivateStateNoLock()

lldb::StateType lldb_private::Process::PrivateStateThread::GetPrivateStateNoLock ( ) const

inline

Definition at line 3251 of file Process.h.

References m_private_state.

◆ GetPublicState()

lldb::StateType lldb_private::Process::PrivateStateThread::GetPublicState ( ) const

inline

Definition at line 3237 of file Process.h.

References m_public_state.

◆ GetRunLock()

ProcessRunLock & lldb_private::Process::PrivateStateThread::GetRunLock ( )

inline

Definition at line 3275 of file Process.h.

References lldb_private::Host::GetCurrentThread(), IsOnThread(), m_private_run_lock, and m_public_run_lock.

◆ IsJoinable()

bool lldb_private::Process::PrivateStateThread::IsJoinable ( )

inline

Definition at line 3220 of file Process.h.

References m_private_state_thread.

Referenced by lldb_private::Process::RunThreadPlan().

◆ IsOnThread()

bool Process::PrivateStateThread::IsOnThread ( const HostThread & thread ) const

Definition at line 3934 of file Process.cpp.

References m_private_state_thread.

Referenced by GetRunLock().

◆ IsRunning()

bool lldb_private::Process::PrivateStateThread::IsRunning ( )

inline

Definition at line 3229 of file Process.h.

References m_is_running.

◆ JoinAndReset()

void lldb_private::Process::PrivateStateThread::JoinAndReset ( )

inline

Definition at line 3222 of file Process.h.

References m_is_running, and m_private_state_thread.

◆ SetPrivateRunLockToRunning()

bool lldb_private::Process::PrivateStateThread::SetPrivateRunLockToRunning ( )

inline

Definition at line 3265 of file Process.h.

References m_private_run_lock.

◆ SetPrivateRunLockToStopped()

bool lldb_private::Process::PrivateStateThread::SetPrivateRunLockToStopped ( )

inline

Definition at line 3271 of file Process.h.

References m_private_run_lock.

◆ SetPrivateState()

void lldb_private::Process::PrivateStateThread::SetPrivateState ( lldb::StateType new_value )

inline

Definition at line 3243 of file Process.h.

References m_private_state.

◆ SetPrivateStateNoLock()

void lldb_private::Process::PrivateStateThread::SetPrivateStateNoLock ( lldb::StateType new_state )

inline

Definition at line 3255 of file Process.h.

References m_private_state.

◆ SetPublicRunLockToRunning()

bool lldb_private::Process::PrivateStateThread::SetPublicRunLockToRunning ( )

inline

Definition at line 3263 of file Process.h.

References m_public_run_lock.

◆ SetPublicRunLockToStopped()

bool lldb_private::Process::PrivateStateThread::SetPublicRunLockToStopped ( )

inline

Definition at line 3269 of file Process.h.

References m_public_run_lock.

◆ SetPublicState()

void lldb_private::Process::PrivateStateThread::SetPublicState ( lldb::StateType new_value )

inline

Definition at line 3239 of file Process.h.

References m_public_state.

◆ SetPublicStateNoLock()

void lldb_private::Process::PrivateStateThread::SetPublicStateNoLock ( lldb::StateType new_state )

inline

Definition at line 3259 of file Process.h.

References m_public_state.

◆ SetThreadName()

void lldb_private::Process::PrivateStateThread::SetThreadName ( llvm::StringRef new_name )

inline

Definition at line 3231 of file Process.h.

References m_thread_name.

◆ StartupThread()

bool Process::PrivateStateThread::StartupThread ( )

Definition at line 3916 of file Process.cpp.

References lldb_private::GetLog(), lldb_private::Host, lldb_private::ThreadLauncher::LaunchThread(), LLDB_LOG_ERROR, m_is_running, m_private_state_thread, m_process, and m_thread_name.

Member Data Documentation

◆ m_is_running

bool lldb_private::Process::PrivateStateThread::m_is_running = false

Definition at line 3299 of file Process.h.

Referenced by IsRunning(), JoinAndReset(), and StartupThread().

◆ m_is_secondary_thread

bool lldb_private::Process::PrivateStateThread::m_is_secondary_thread

If we need to run an expression modally in the private state thread, we have to spin up a secondary private state thread to manage the events that drive that interaction.

This will be true if this is a modal private state thread. This will be the thread name given to the Private State HostThread when it gets spun up.

Definition at line 3304 of file Process.h.

Referenced by PrivateStateThread().

◆ m_private_run_lock

ProcessRunLock lldb_private::Process::PrivateStateThread::m_private_run_lock

Definition at line 3298 of file Process.h.

Referenced by GetRunLock(), SetPrivateRunLockToRunning(), and SetPrivateRunLockToStopped().

◆ m_private_state

ThreadSafeValue<lldb::StateType> lldb_private::Process::PrivateStateThread::m_private_state

HostThread for the thread that watches for internal state events.

Definition at line 3289 of file Process.h.

Referenced by GetPrivateState(), GetPrivateStateMutex(), GetPrivateStateNoLock(), PrivateStateThread(), SetPrivateState(), and SetPrivateStateNoLock().

◆ m_private_state_thread

HostThread lldb_private::Process::PrivateStateThread::m_private_state_thread

Definition at line 3291 of file Process.h.

Referenced by IsJoinable(), IsOnThread(), JoinAndReset(), and StartupThread().

◆ m_process

Process& lldb_private::Process::PrivateStateThread::m_process

The process state that we show to client code.

This will often differ from the actual process state, for instance when we've stopped in the middle of a ThreadPlan's operations, before we've decided to stop or continue.

Definition at line 3282 of file Process.h.

Referenced by PrivateStateThread(), and StartupThread().

◆ m_public_run_lock

ProcessRunLock lldb_private::Process::PrivateStateThread::m_public_run_lock

Definition at line 3297 of file Process.h.

Referenced by GetRunLock(), SetPublicRunLockToRunning(), and SetPublicRunLockToStopped().

◆ m_public_state

ThreadSafeValue<lldb::StateType> lldb_private::Process::PrivateStateThread::m_public_state

The actual state of our process.

Definition at line 3287 of file Process.h.

Referenced by GetPublicState(), PrivateStateThread(), SetPublicState(), and SetPublicStateNoLock().

◆ m_thread_name

std::string lldb_private::Process::PrivateStateThread::m_thread_name

Definition at line 3307 of file Process.h.

Referenced by PrivateStateThread(), SetThreadName(), and StartupThread().

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PrivateStateThread()

Member Function Documentation

◆ GetPrivateState()

◆ GetPrivateStateMutex()

◆ GetPrivateStateNoLock()

◆ GetPublicState()

◆ GetRunLock()

◆ IsJoinable()

◆ IsOnThread()

◆ IsRunning()

◆ JoinAndReset()

◆ SetPrivateRunLockToRunning()

◆ SetPrivateRunLockToStopped()

◆ SetPrivateState()

◆ SetPrivateStateNoLock()

◆ SetPublicRunLockToRunning()

◆ SetPublicRunLockToStopped()

◆ SetPublicState()

◆ SetPublicStateNoLock()

◆ SetThreadName()

◆ StartupThread()

Member Data Documentation

◆ m_is_running

◆ m_is_secondary_thread

◆ m_private_run_lock

◆ m_private_state

◆ m_private_state_thread

◆ m_process

◆ m_public_run_lock

◆ m_public_state

◆ m_thread_name