#include <GDBRemoteClientBase.h>

Inheritance diagram for lldb_private::process_gdb_remote::GDBRemoteClientBase:

[legend]

Collaboration diagram for lldb_private::process_gdb_remote::GDBRemoteClientBase:

[legend]

Classes
struct	ContinueDelegate

class	Lock

Public Member Functions
	GDBRemoteClientBase (const char comm_name, const char listener_name)

bool	SendAsyncSignal (int signo)

bool	Interrupt ()

lldb::StateType	SendContinuePacketAndWaitForResponse (ContinueDelegate &delegate, const UnixSignals &signals, llvm::StringRef payload, StringExtractorGDBRemote &response)

PacketResult	SendPacketAndWaitForResponse (llvm::StringRef payload, StringExtractorGDBRemote &response, bool send_async)

PacketResult	SendPacketAndReceiveResponseWithOutputSupport (llvm::StringRef payload, StringExtractorGDBRemote &response, bool send_async, llvm::function_ref< void(llvm::StringRef)> output_callback)

bool	SendvContPacket (llvm::StringRef payload, StringExtractorGDBRemote &response)

Public Member Functions inherited from lldb_private::process_gdb_remote::GDBRemoteCommunication
	GDBRemoteCommunication (const char comm_name, const char listener_name)

	~GDBRemoteCommunication () override

PacketResult	GetAck ()

size_t	SendAck ()

size_t	SendNack ()

char	CalculcateChecksum (llvm::StringRef payload)

PacketType	CheckForPacket (const uint8_t *src, size_t src_len, StringExtractorGDBRemote &packet)

bool	GetSendAcks ()

std::chrono::seconds	SetPacketTimeout (std::chrono::seconds packet_timeout)

std::chrono::seconds	GetPacketTimeout () const

Status	StartDebugserverProcess (const char url, Platform platform, ProcessLaunchInfo &launch_info, uint16_t port, const Args inferior_args, int pass_comm_fd)

void	DumpHistory (Stream &strm)

void	SetHistoryStream (llvm::raw_ostream *strm)

Public Member Functions inherited from lldb_private::Communication
	FLAGS_ANONYMOUS_ENUM ()

	Communication (const char *broadcaster_name)
	Construct the Communication object with the specified name for the Broadcaster that this object inherits from. More...

	~Communication () override
	Destructor. More...

void	Clear ()

lldb::ConnectionStatus	Connect (const char url, Status error_ptr)
	Connect using the current connection by passing url to its connect function. More...

lldb::ConnectionStatus	Disconnect (Status *error_ptr=nullptr)
	Disconnect the communications connection if one is currently connected. More...

bool	IsConnected () const
	Check if the connection is valid. More...

bool	HasConnection () const

lldb_private::Connection *	GetConnection ()

size_t	Read (void dst, size_t dst_len, const Timeout< std::micro > &timeout, lldb::ConnectionStatus &status, Status error_ptr)
	Read bytes from the current connection. More...

size_t	Write (const void src, size_t src_len, lldb::ConnectionStatus &status, Status error_ptr)
	The actual write function that attempts to write to the communications protocol. More...

void	SetConnection (Connection *connection)
	Sets the connection that it to be used by this class. More...

virtual bool	StartReadThread (Status *error_ptr=nullptr)
	Starts a read thread whose sole purpose it to read bytes from the current connection. More...

virtual bool	StopReadThread (Status *error_ptr=nullptr)
	Stops the read thread by cancelling it. More...

virtual bool	JoinReadThread (Status *error_ptr=nullptr)

bool	ReadThreadIsRunning ()
	Checks if there is a currently running read thread. More...

void	SetReadThreadBytesReceivedCallback (ReadThreadBytesReceived callback, void *callback_baton)

void	SynchronizeWithReadThread ()
	Wait for the read thread to process all outstanding data. More...

bool	GetCloseOnEOF () const

void	SetCloseOnEOF (bool b)

ConstString &	GetBroadcasterClass () const override

Public Member Functions inherited from lldb_private::Broadcaster
	Broadcaster (lldb::BroadcasterManagerSP manager_sp, const char *name)
	Construct with a broadcaster with a name. More...

virtual	~Broadcaster ()
	Destructor. More...

void	CheckInWithManager ()

void	BroadcastEvent (lldb::EventSP &event_sp)
	Broadcast an event which has no associated data. More...

void	BroadcastEventIfUnique (lldb::EventSP &event_sp)

void	BroadcastEvent (uint32_t event_type, const lldb::EventDataSP &event_data_sp)

void	BroadcastEvent (uint32_t event_type, EventData *event_data=nullptr)

void	BroadcastEventIfUnique (uint32_t event_type, EventData *event_data=nullptr)

void	Clear ()

virtual void	AddInitialEventsToListener (const lldb::ListenerSP &listener_sp, uint32_t requested_events)

uint32_t	AddListener (const lldb::ListenerSP &listener_sp, uint32_t event_mask)
	Listen for any events specified by event_mask. More...

ConstString	GetBroadcasterName ()
	Get the NULL terminated C string name of this Broadcaster object. More...

bool	GetEventNames (Stream &s, const uint32_t event_mask, bool prefix_with_broadcaster_name) const
	Get the event name(s) for one or more event bits. More...

void	SetEventName (uint32_t event_mask, const char *name)
	Set the name for an event bit. More...

const char *	GetEventName (uint32_t event_mask) const

bool	EventTypeHasListeners (uint32_t event_type)

bool	RemoveListener (const lldb::ListenerSP &listener_sp, uint32_t event_mask=UINT32_MAX)
	Removes a Listener from this broadcasters list and frees the event bits specified by event_mask that were previously acquired by listener (assuming listener was listening to this object) for other listener objects to use. More...

bool	HijackBroadcaster (const lldb::ListenerSP &listener_sp, uint32_t event_mask=UINT32_MAX)
	Provides a simple mechanism to temporarily redirect events from broadcaster. More...

bool	IsHijackedForEvent (uint32_t event_mask)

void	RestoreBroadcaster ()
	Restore the state of the Broadcaster from a previous hijack attempt. More...

lldb::BroadcasterManagerSP	GetManager ()

Protected Member Functions
PacketResult	SendPacketAndWaitForResponseNoLock (llvm::StringRef payload, StringExtractorGDBRemote &response)

virtual void	OnRunPacketSent (bool first)

Protected Member Functions inherited from lldb_private::process_gdb_remote::GDBRemoteCommunication
PacketResult	SendPacketNoLock (llvm::StringRef payload)

PacketResult	SendRawPacketNoLock (llvm::StringRef payload, bool skip_ack=false)

PacketResult	ReadPacket (StringExtractorGDBRemote &response, Timeout< std::micro > timeout, bool sync_on_timeout)

PacketResult	ReadPacketWithOutputSupport (StringExtractorGDBRemote &response, Timeout< std::micro > timeout, bool sync_on_timeout, llvm::function_ref< void(llvm::StringRef)> output_callback)

PacketResult	PopPacketFromQueue (StringExtractorGDBRemote &response, Timeout< std::micro > timeout)

PacketResult	WaitForPacketNoLock (StringExtractorGDBRemote &response, Timeout< std::micro > timeout, bool sync_on_timeout)

bool	CompressionIsEnabled ()

bool	DecompressPacket ()

Status	StartListenThread (const char *hostname="127.0.0.1", uint16_t port=0)

bool	JoinListenThread ()

void	AppendBytesToCache (const uint8_t *bytes, size_t len, bool broadcast, lldb::ConnectionStatus status) override
	Append new bytes that get read from the read thread into the internal object byte cache. More...

Protected Member Functions inherited from lldb_private::Communication
size_t	ReadFromConnection (void dst, size_t dst_len, const Timeout< std::micro > &timeout, lldb::ConnectionStatus &status, Status error_ptr)

size_t	GetCachedBytes (void *dst, size_t dst_len)
	Get any available bytes from our data cache. More...

Protected Member Functions inherited from lldb_private::Broadcaster
BroadcasterImplSP	GetBroadcasterImpl ()

const char *	GetHijackingListenerName ()

Additional Inherited Members
Public Types inherited from lldb_private::process_gdb_remote::GDBRemoteCommunication
enum	{ eBroadcastBitRunPacketSent = kLoUserBroadcastBit, eBroadcastBitGdbReadThreadGotNotify }

enum	PacketType { PacketType::Invalid = 0, PacketType::Standard, PacketType::Notify }

enum	PacketResult { PacketResult::Success = 0, PacketResult::ErrorSendFailed, PacketResult::ErrorSendAck, PacketResult::ErrorReplyFailed, PacketResult::ErrorReplyTimeout, PacketResult::ErrorReplyInvalid, PacketResult::ErrorReplyAck, PacketResult::ErrorDisconnected, PacketResult::ErrorNoSequenceLock }

Public Types inherited from lldb_private::Communication
typedef void(*	ReadThreadBytesReceived) (void baton, const void src, size_t src_len)

Static Public Member Functions inherited from lldb_private::process_gdb_remote::GDBRemoteCommunication
static llvm::Error	ConnectLocally (GDBRemoteCommunication &client, GDBRemoteCommunication &server)

Static Public Member Functions inherited from lldb_private::Communication
static lldb::thread_result_t	ReadThread (lldb::thread_arg_t comm_ptr)
	The static read thread function. More...

static const char *	ConnectionStatusAsCString (lldb::ConnectionStatus status)

static ConstString &	GetStaticBroadcasterClass ()

Protected Types inherited from lldb_private::Broadcaster
typedef std::shared_ptr< BroadcasterImpl >	BroadcasterImplSP

typedef std::weak_ptr< BroadcasterImpl >	BroadcasterImplWP

Static Protected Member Functions inherited from lldb_private::process_gdb_remote::GDBRemoteCommunication
static lldb::thread_result_t	ListenThread (lldb::thread_arg_t arg)

Protected Attributes inherited from lldb_private::process_gdb_remote::GDBRemoteCommunication
std::chrono::seconds	m_packet_timeout

uint32_t	m_echo_number

LazyBool	m_supports_qEcho

GDBRemoteCommunicationHistory	m_history

bool	m_send_acks

bool	m_is_platform

CompressionType	m_compression_type

Protected Attributes inherited from lldb_private::Communication
lldb::ConnectionSP	m_connection_sp
	The connection that is current in use by this communications class. More...

HostThread	m_read_thread
	The read thread handle in case we need to cancel the thread. More...

std::atomic< bool >	m_read_thread_enabled

std::atomic< bool >	m_read_thread_did_exit

std::string	m_bytes
	A buffer to cache bytes read in the ReadThread function. More...

std::recursive_mutex	m_bytes_mutex
	A mutex to protect multi-threaded access to the cached bytes. More...

std::mutex	m_write_mutex
	Don't let multiple threads write at the same time... More...

std::mutex	m_synchronize_mutex

ReadThreadBytesReceived	m_callback

void *	m_callback_baton

bool	m_close_on_eof

Detailed Description

Definition at line 19 of file GDBRemoteClientBase.h.

Constructor & Destructor Documentation

◆ GDBRemoteClientBase()

GDBRemoteClientBase::GDBRemoteClientBase	(	const char *	comm_name,
		const char *	listener_name
	)

Definition at line 31 of file GDBRemoteClientBase.cpp.

Member Function Documentation

◆ Interrupt()

bool GDBRemoteClientBase::Interrupt ( )

Definition at line 150 of file GDBRemoteClientBase.cpp.

References lldb_private::process_gdb_remote::GDBRemoteClientBase::Lock::DidInterrupt().

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::DoHalt().

◆ OnRunPacketSent()

void GDBRemoteClientBase::OnRunPacketSent ( bool first )

protectedvirtual

Reimplemented in lldb_private::process_gdb_remote::GDBRemoteCommunicationClient.

Definition at line 286 of file GDBRemoteClientBase.cpp.

References lldb_private::Broadcaster::BroadcastEvent(), lldb_private::process_gdb_remote::GDBRemoteCommunication::eBroadcastBitRunPacketSent, GDBR_LOG_PROCESS, lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), lldbassert, lldb_private::Log::Printf(), lldb_private::process_gdb_remote::GDBRemoteCommunication::Success, and lldb_private::Success.

Referenced by lldb_private::process_gdb_remote::GDBRemoteClientBase::Lock::DidInterrupt(), lldb_private::process_gdb_remote::GDBRemoteCommunicationClient::OnRunPacketSent(), SendContinuePacketAndWaitForResponse(), and SendvContPacket().

◆ SendAsyncSignal()

bool GDBRemoteClientBase::SendAsyncSignal ( int signo )

Definition at line 139 of file GDBRemoteClientBase.cpp.

References lldb_private::process_gdb_remote::GDBRemoteClientBase::Lock::DidInterrupt().

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::DoSignal().

◆ SendContinuePacketAndWaitForResponse()

StateType GDBRemoteClientBase::SendContinuePacketAndWaitForResponse	(	ContinueDelegate &	delegate,
		const UnixSignals &	signals,
		llvm::StringRef	payload,
		StringExtractorGDBRemote &	response
	)

Definition at line 36 of file GDBRemoteClientBase.cpp.

References StringExtractor::Clear(), StringExtractor::Empty(), lldb_private::process_gdb_remote::GDBRemoteCommunication::ErrorReplyTimeout, lldb::eStateExited, lldb::eStateInvalid, lldb::eStateStopped, GDBR_LOG_PROCESS, StringExtractor::GetChar(), StringExtractor::GetHexByteString(), lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), StringExtractor::GetStringRef(), lldb_private::process_gdb_remote::GDBRemoteClientBase::ContinueDelegate::HandleAsyncMisc(), lldb_private::process_gdb_remote::GDBRemoteClientBase::ContinueDelegate::HandleAsyncStdout(), lldb_private::process_gdb_remote::GDBRemoteClientBase::ContinueDelegate::HandleAsyncStructuredDataPacket(), lldb_private::process_gdb_remote::GDBRemoteClientBase::ContinueDelegate::HandleStopReply(), kInterruptTimeout(), OnRunPacketSent(), lldb_private::Log::Printf(), lldb_private::process_gdb_remote::GDBRemoteCommunication::ReadPacket(), StringExtractor::SetFilePos(), and lldb_private::process_gdb_remote::GDBRemoteCommunication::Success.

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::AsyncThread().

◆ SendPacketAndReceiveResponseWithOutputSupport()

GDBRemoteCommunication::PacketResult GDBRemoteClientBase::SendPacketAndReceiveResponseWithOutputSupport	(	llvm::StringRef	payload,
		StringExtractorGDBRemote &	response,
		bool	send_async,
		llvm::function_ref< void(llvm::StringRef)>	output_callback
	)

Definition at line 176 of file GDBRemoteClientBase.cpp.

References lldb_private::process_gdb_remote::GDBRemoteCommunication::ErrorSendFailed, GDBR_LOG_PROCESS, lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), lldb_private::process_gdb_remote::GDBRemoteCommunication::GetPacketTimeout(), lldb_private::process_gdb_remote::GDBRemoteCommunication::ReadPacketWithOutputSupport(), lldb_private::process_gdb_remote::GDBRemoteCommunication::SendPacketNoLock(), and lldb_private::process_gdb_remote::GDBRemoteCommunication::Success.

Referenced by CommandObjectProcessGDBRemotePacketMonitor::DoExecute().

◆ SendPacketAndWaitForResponse()

GDBRemoteCommunication::PacketResult GDBRemoteClientBase::SendPacketAndWaitForResponse	(	llvm::StringRef	payload,
		StringExtractorGDBRemote &	response,
		bool	send_async
	)

Definition at line 158 of file GDBRemoteClientBase.cpp.

References lldb_private::process_gdb_remote::GDBRemoteCommunication::ErrorSendFailed, GDBR_LOG_PROCESS, lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), and SendPacketAndWaitForResponseNoLock().

◆ SendPacketAndWaitForResponseNoLock()

GDBRemoteCommunication::PacketResult GDBRemoteClientBase::SendPacketAndWaitForResponseNoLock	(	llvm::StringRef	payload,
		StringExtractorGDBRemote &	response
	)