#include <GDBRemoteCommunication.h>

Inheritance diagram for lldb_private::process_gdb_remote::GDBRemoteCommunication:

[legend]

Collaboration diagram for lldb_private::process_gdb_remote::GDBRemoteCommunication:

[legend]

Classes
class	ScopedTimeout

Public Types
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)

Public Member Functions
	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 ()

Static Public Member Functions
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 Member Functions
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 ()

Static Protected Member Functions
static lldb::thread_result_t	ListenThread (lldb::thread_arg_t arg)

Protected Attributes
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

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

typedef std::weak_ptr< BroadcasterImpl >	BroadcasterImplWP

Detailed Description

Definition at line 53 of file GDBRemoteCommunication.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
eBroadcastBitRunPacketSent
eBroadcastBitGdbReadThreadGotNotify

Definition at line 55 of file GDBRemoteCommunication.h.

◆ PacketResult

enum lldb_private::process_gdb_remote::GDBRemoteCommunication::PacketResult

strong

Enumerator
Success
ErrorSendFailed
ErrorSendAck
ErrorReplyFailed
ErrorReplyTimeout
ErrorReplyInvalid
ErrorReplyAck
ErrorDisconnected
ErrorNoSequenceLock

Definition at line 63 of file GDBRemoteCommunication.h.

◆ PacketType

enum lldb_private::process_gdb_remote::GDBRemoteCommunication::PacketType

strong

Enumerator
Invalid
Standard
Notify

Definition at line 61 of file GDBRemoteCommunication.h.

Constructor & Destructor Documentation

◆ GDBRemoteCommunication()

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

Definition at line 58 of file GDBRemoteCommunication.cpp.

References lldb_private::process_gdb_remote::None.

◆ ~GDBRemoteCommunication()

GDBRemoteCommunication::~GDBRemoteCommunication ( )

override

Definition at line 72 of file GDBRemoteCommunication.cpp.

References lldb_private::Communication::Disconnect(), lldb_private::Communication::IsConnected(), lldb_private::Communication::m_read_thread_enabled, and lldb_private::Communication::StopReadThread().

Member Function Documentation

◆ AppendBytesToCache()

void GDBRemoteCommunication::AppendBytesToCache	(	const uint8_t *	src,
		size_t	src_len,
		bool	broadcast,
		lldb::ConnectionStatus	status
	)

overrideprotectedvirtual

Append new bytes that get read from the read thread into the internal object byte cache.

This will cause a eBroadcastBitReadThreadGotBytes event to be broadcast if broadcast is true.

Subclasses can override this function in order to inspect the received data and check if a packet is available.

Subclasses can also still call this function from the overridden method to allow the caching to correctly happen and suppress the broadcasting of the eBroadcastBitReadThreadGotBytes event by setting broadcast to false.

Parameters

[in]	src	A source buffer that must be at least src_len bytes long.
[in]	src_len	The number of bytes to append to the cache.

Reimplemented from lldb_private::Communication.

Definition at line 1322 of file GDBRemoteCommunication.cpp.

References lldb_private::Broadcaster::BroadcastEvent(), CheckForPacket(), eBroadcastBitGdbReadThreadGotNotify, ErrorDisconnected, ErrorNoSequenceLock, ErrorReplyAck, ErrorReplyFailed, ErrorReplyInvalid, ErrorReplyTimeout, ErrorSendAck, ErrorSendFailed, StringExtractor::GetStringRef(), Invalid, Notify, Standard, and Success.

◆ CalculcateChecksum()

char GDBRemoteCommunication::CalculcateChecksum ( llvm::StringRef payload )

Definition at line 88 of file GDBRemoteCommunication.cpp.

Referenced by CheckForPacket(), DecompressPacket(), and SendPacketNoLock().

◆ CheckForPacket()

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

Definition at line 644 of file GDBRemoteCommunication.cpp.

References lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::AddPacket(), CalculcateChecksum(), StringExtractor::Clear(), CompressionIsEnabled(), DecompressPacket(), lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::DidDumpToLog(), lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::Dump(), lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::ePacketTypeRecv, GDBR_LOG_PACKETS, lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), GetSendAcks(), lldb_private::StreamString::GetString(), StringExtractor::GetStringRef(), lldb_private::Log::GetVerbose(), Invalid, isprint(), lldb_private::Communication::m_bytes, lldb_private::Communication::m_bytes_mutex, m_history, Notify, lldb_private::Log::Printf(), lldb_private::Stream::Printf(), lldb_private::Log::PutString(), SendAck(), SendNack(), StringExtractor::SetFilePos(), and Standard.

Referenced by AppendBytesToCache(), and WaitForPacketNoLock().

◆ CompressionIsEnabled()

bool lldb_private::process_gdb_remote::GDBRemoteCommunication::CompressionIsEnabled ( )

inlineprotected

Definition at line 173 of file GDBRemoteCommunication.h.

References lldb_private::process_gdb_remote::None.

Referenced by CheckForPacket(), and DecompressPacket().

◆ ConnectLocally()

llvm::Error GDBRemoteCommunication::ConnectLocally	(	GDBRemoteCommunication &	client,
		GDBRemoteCommunication &	server
	)

static

Definition at line 1266 of file GDBRemoteCommunication.cpp.

References lldb_private::TCPSocket::Accept(), lldb_private::Status::AsCString(), lldb::eConnectionStatusSuccess, lldb_private::TCPSocket::GetLocalPortNumber(), lldb_private::TCPSocket::Listen(), lldb_private::Communication::SetConnection(), and lldb_private::Status::ToError().

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

◆ DecompressPacket()

bool GDBRemoteCommunication::DecompressPacket ( )

protected

Definition at line 413 of file GDBRemoteCommunication.cpp.

References CalculcateChecksum(), CompressionIsEnabled(), GDBR_LOG_PACKETS, lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), GetSendAcks(), lldb_private::process_gdb_remote::LZ4, lldb_private::process_gdb_remote::LZFSE, lldb_private::process_gdb_remote::LZMA, lldb_private::Communication::m_bytes, m_compression_type, lldb_private::Log::Printf(), SendAck(), SendNack(), x20, and lldb_private::process_gdb_remote::ZlibDeflate.

Referenced by CheckForPacket().

◆ DumpHistory()

void GDBRemoteCommunication::DumpHistory ( Stream & strm )

Definition at line 1259 of file GDBRemoteCommunication.cpp.

References lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::Dump(), and m_history.

Referenced by CommandObjectProcessGDBRemotePacketHistory::DoExecute(), lldb_private::process_gdb_remote::GDBRemoteRegisterContext::ReadAllRegisterValues(), lldb_private::process_gdb_remote::GDBRemoteRegisterContext::WriteAllRegisterValues(), and lldb_private::process_gdb_remote::GDBRemoteRegisterContext::WriteRegisterBytes().

◆ GetAck()

GDBRemoteCommunication::PacketResult GDBRemoteCommunication::GetAck ( )

Definition at line 197 of file GDBRemoteCommunication.cpp.

References ErrorSendAck, GetPacketTimeout(), StringExtractorGDBRemote::GetResponseType(), ReadPacket(), and Success.

Referenced by lldb_private::process_gdb_remote::GDBRemoteCommunicationReplayServer::HandshakeWithClient(), lldb_private::process_gdb_remote::GDBRemoteCommunicationServer::HandshakeWithClient(), and SendRawPacketNoLock().

◆ GetPacketTimeout()

std::chrono::seconds lldb_private::process_gdb_remote::GDBRemoteCommunication::GetPacketTimeout ( ) const

inline

Definition at line 123 of file GDBRemoteCommunication.h.

Referenced by GetAck(), lldb_private::process_gdb_remote::GDBRemoteCommunicationClient::QueryNoAckModeSupported(), lldb_private::process_gdb_remote::GDBRemoteCommunication::ScopedTimeout::ScopedTimeout(), lldb_private::process_gdb_remote::GDBRemoteClientBase::SendPacketAndReceiveResponseWithOutputSupport(), and lldb_private::process_gdb_remote::GDBRemoteClientBase::SendPacketAndWaitForResponseNoLock().

◆ GetSendAcks()

bool lldb_private::process_gdb_remote::GDBRemoteCommunication::GetSendAcks ( )

inline

Definition at line 110 of file GDBRemoteCommunication.h.

Referenced by CheckForPacket(), DecompressPacket(), and SendRawPacketNoLock().

◆ JoinListenThread()

bool GDBRemoteCommunication::JoinListenThread ( )

protected

Definition at line 909 of file GDBRemoteCommunication.cpp.

References lldb_private::HostThread::IsJoinable(), and lldb_private::HostThread::Join().

Referenced by StartDebugserverProcess().

◆ ListenThread()

lldb::thread_result_t GDBRemoteCommunication::ListenThread ( lldb::thread_arg_t arg )

staticprotected

Definition at line 916 of file GDBRemoteCommunication.cpp.

References lldb_private::ConnectionFileDescriptor::Connect(), lldb::eConnectionStatusSuccess, lldb_private::Communication::GetConnection(), and lldb_private::Communication::SetConnection().

Referenced by StartListenThread().

◆ PopPacketFromQueue()

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

protected

Definition at line 242 of file GDBRemoteCommunication.cpp.

References ErrorDisconnected, ErrorReplyTimeout, lldb_private::Communication::IsConnected(), and Success.

Referenced by ReadPacket().

◆ ReadPacket()

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

protected

Definition at line 228 of file GDBRemoteCommunication.cpp.

References lldb_private::Communication::m_read_thread_enabled, PopPacketFromQueue(), and WaitForPacketNoLock().

Referenced by GetAck(), lldb_private::process_gdb_remote::GDBRemoteCommunicationClient::HandshakeWithServer(), ReadPacketWithOutputSupport(), lldb_private::process_gdb_remote::GDBRemoteClientBase::SendContinuePacketAndWaitForResponse(), lldb_private::process_gdb_remote::GDBRemoteClientBase::SendPacketAndWaitForResponseNoLock(), and lldb_private::process_gdb_remote::GDBRemoteClientBase::SendvContPacket().

◆ ReadPacketWithOutputSupport()

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

protected

Definition at line 211 of file GDBRemoteCommunication.cpp.

References StringExtractor::GetChar(), StringExtractor::GetHexByteString(), StringExtractorGDBRemote::IsNormalResponse(), StringExtractor::PeekChar(), ReadPacket(), and Success.

Referenced by lldb_private::process_gdb_remote::GDBRemoteClientBase::SendPacketAndReceiveResponseWithOutputSupport().

◆ SendAck()

size_t GDBRemoteCommunication::SendAck ( )

Definition at line 97 of file GDBRemoteCommunication.cpp.

References lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::AddPacket(), lldb::eConnectionStatusSuccess, lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::ePacketTypeSend, GDBR_LOG_PACKETS, lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), m_history, lldb_private::Log::Printf(), and lldb_private::Communication::Write().

Referenced by CheckForPacket(), DecompressPacket(), and lldb_private::process_gdb_remote::GDBRemoteCommunicationClient::HandshakeWithServer().

◆ SendNack()

size_t GDBRemoteCommunication::SendNack ( )

Definition at line 109 of file GDBRemoteCommunication.cpp.

References lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::AddPacket(), lldb::eConnectionStatusSuccess, lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::ePacketTypeSend, GDBR_LOG_PACKETS, lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), m_history, lldb_private::Log::Printf(), and lldb_private::Communication::Write().

Referenced by CheckForPacket(), and DecompressPacket().

◆ SendPacketNoLock()

GDBRemoteCommunication::PacketResult GDBRemoteCommunication::SendPacketNoLock ( llvm::StringRef payload )

protected

Definition at line 122 of file GDBRemoteCommunication.cpp.

References CalculcateChecksum(), lldb::eByteOrderBig, lldb_private::StreamString::GetString(), lldb_private::Stream::PutChar(), lldb_private::Stream::PutHex8(), SendRawPacketNoLock(), and lldb_private::Stream::Write().

◆ SendRawPacketNoLock()

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

protected

Definition at line 134 of file GDBRemoteCommunication.cpp.

References lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::AddPacket(), lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::DidDumpToLog(), lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::Dump(), lldb::eConnectionStatusSuccess, lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::ePacketTypeSend, ErrorSendFailed, GDBR_LOG_PACKETS, GetAck(), lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), GetSendAcks(), lldb_private::StreamString::GetString(), lldb_private::Communication::IsConnected(), m_history, lldb_private::Log::Printf(), lldb_private::Stream::Printf(), lldb_private::Log::PutString(), Success, and lldb_private::Communication::Write().

Referenced by lldb_private::process_gdb_remote::GDBRemoteCommunicationReplayServer::GetPacketAndSendResponse(), and SendPacketNoLock().

◆ SetHistoryStream()

void GDBRemoteCommunication::SetHistoryStream ( llvm::raw_ostream * strm )

Definition at line 1261 of file GDBRemoteCommunication.cpp.

References m_history, and lldb_private::process_gdb_remote::GDBRemoteCommunicationHistory::SetStream().

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

◆ SetPacketTimeout()

std::chrono::seconds lldb_private::process_gdb_remote::GDBRemoteCommunication::SetPacketTimeout ( std::chrono::seconds packet_timeout )

inline

Definition at line 117 of file GDBRemoteCommunication.h.

Referenced by lldb_private::process_gdb_remote::GDBRemoteCommunicationClient::GetHostInfo(), lldb_private::process_gdb_remote::ProcessGDBRemote::ProcessGDBRemote(), lldb_private::process_gdb_remote::GDBRemoteCommunication::ScopedTimeout::ScopedTimeout(), and lldb_private::process_gdb_remote::GDBRemoteCommunication::ScopedTimeout::~ScopedTimeout().

◆ StartDebugserverProcess()

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

Definition at line 931 of file GDBRemoteCommunication.cpp.

References lldb_private::Args::AppendArgument(), lldb_private::Args::AppendArguments(), lldb_private::ProcessLaunchInfo::AppendCloseFileAction(), lldb_private::ProcessLaunchInfo::AppendDuplicateFileAction(), lldb_private::FileSpec::AppendPathComponent(), lldb_private::ProcessLaunchInfo::AppendSuppressFileAction(), lldb_private::Status::AsCString(), lldb_private::FileSpec::Clear(), lldb_private::Args::Clear(), DEBUGSERVER_BASENAME, lldb_private::ProcessInfo::Dump(), lldb_private::FileSystem::Exists(), lldb_private::Status::Fail(), GDBR_LOG_PROCESS, lldb_private::Args::GetArgumentCount(), lldb_private::ProcessInfo::GetArguments(), lldb_private::Communication::GetConnection(), lldb_private::StreamString::GetData(), lldb_private::ProcessInfo::GetEnvironment(), lldb_private::Host::GetEnvironment(), lldb_private::ProcessInfo::GetExecutableFile(), lldb_private::ProcessLaunchInfo::GetLaunchInSeparateProcessGroup(), lldb_private::ConnectionFileDescriptor::GetListeningPort(), lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), lldb_private::FileSpec::GetPath(), lldb_private::ProcessInfo::GetProcessID(), lldb_private::StreamString::GetString(), lldb_private::FileSystem::Instance(), JoinListenThread(), lldb_private::Host::LaunchProcess(), LLDB_INVALID_PROCESS_ID, lldb_private::Platform::LocateExecutable(), PATH_MAX, lldb_private::Log::Printf(), lldb_private::Stream::Printf(), lldb_private::Status::SetErrorString(), lldb_private::Status::SetErrorStringWithFormat(), lldb_private::FileSpec::SetFile(), StartListenThread(), lldb_private::Status::Success(), and lldb_private::StringConvert::ToUInt32().

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::LaunchAndConnectToDebugserver(), and lldb_private::process_gdb_remote::GDBRemoteCommunicationServerPlatform::LaunchGDBServer().

◆ StartListenThread()

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

protected

Definition at line 889 of file GDBRemoteCommunication.cpp.

References lldb_private::HostThread::IsJoinable(), lldb_private::ThreadLauncher::LaunchThread(), ListenThread(), lldb_private::Communication::SetConnection(), and lldb_private::Status::SetErrorString().

Referenced by StartDebugserverProcess().

◆ WaitForPacketNoLock()

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

protected

Sync the remote GDB server and make sure we get a response that corresponds to what we send.

Sends a "qEcho" packet and makes sure it gets the exact packet echoed back. If the qEcho packet isn't supported, we send a qC packet and make sure we get a valid thread ID back. We use the "qC" packet since its response if very unique: is responds with "QC%x" where x is the thread ID of the current thread. This makes the response unique enough from other packet responses to ensure we are back on track.

This packet is needed after we time out sending a packet so we can ensure that we are getting the response for the packet we are sending. There are no sequence IDs in the GDB remote protocol (there used to be, but they are not supported anymore) so if you timeout sending packet "abc", you might then send packet "cde" and get the response for the previous "abc" packet. Many responses are "OK" or "" (unsupported) or "EXX" (error) so many responses for packets can look like responses for other packets. So if we timeout, we need to ensure that we can get back on track. If we can't get back on track, we must disconnect.

Definition at line 268 of file GDBRemoteCommunication.cpp.

References CheckForPacket(), StringExtractor::Clear(), lldb_private::RegularExpression::Compile(), lldb_private::Communication::ConnectionStatusAsCString(), lldb_private::Communication::Disconnect(), lldb::eConnectionStatusEndOfFile, lldb::eConnectionStatusError, lldb::eConnectionStatusInterrupted, lldb::eConnectionStatusLostConnection, lldb::eConnectionStatusNoConnection, lldb::eConnectionStatusSuccess, lldb::eConnectionStatusTimedOut, lldb_private::eLazyBoolYes, ErrorDisconnected, ErrorReplyFailed, ErrorReplyTimeout, lldb_private::RegularExpression::Execute(), GDBR_LOG_PACKETS, lldb_private::process_gdb_remote::ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(), StringExtractor::GetStringRef(), Invalid, lldb_private::Communication::IsConnected(), LLDB_LOGV, m_echo_number, m_supports_qEcho, lldb_private::Communication::Read(), SendPacketNoLock(), and Success.

Referenced by lldb_private::process_gdb_remote::GDBRemoteCommunicationServer::GetPacketAndSendResponse(), lldb_private::process_gdb_remote::GDBRemoteCommunicationReplayServer::GetPacketAndSendResponse(), and ReadPacket().

Member Data Documentation

◆ m_compression_type

CompressionType lldb_private::process_gdb_remote::GDBRemoteCommunication::m_compression_type

protected

Definition at line 151 of file GDBRemoteCommunication.h.

Referenced by DecompressPacket(), and lldb_private::process_gdb_remote::GDBRemoteCommunicationClient::MaybeEnableCompression().

◆ m_echo_number

uint32_t lldb_private::process_gdb_remote::GDBRemoteCommunication::m_echo_number

protected

Definition at line 143 of file GDBRemoteCommunication.h.

Referenced by WaitForPacketNoLock().

◆ m_history

GDBRemoteCommunicationHistory lldb_private::process_gdb_remote::GDBRemoteCommunication::m_history

protected

Definition at line 145 of file GDBRemoteCommunication.h.

Referenced by CheckForPacket(), DumpHistory(), SendAck(), SendNack(), SendRawPacketNoLock(), and SetHistoryStream().

◆ m_is_platform

bool lldb_private::process_gdb_remote::GDBRemoteCommunication::m_is_platform

protected

Definition at line 147 of file GDBRemoteCommunication.h.

◆ m_packet_timeout

std::chrono::seconds lldb_private::process_gdb_remote::GDBRemoteCommunication::m_packet_timeout

protected

Definition at line 142 of file GDBRemoteCommunication.h.

◆ m_send_acks

bool lldb_private::process_gdb_remote::GDBRemoteCommunication::m_send_acks

protected

Definition at line 146 of file GDBRemoteCommunication.h.

Referenced by lldb_private::process_gdb_remote::GDBRemoteCommunicationReplayServer::GetPacketAndSendResponse(), lldb_private::process_gdb_remote::GDBRemoteCommunicationServerCommon::Handle_QStartNoAckMode(), and lldb_private::process_gdb_remote::GDBRemoteCommunicationClient::QueryNoAckModeSupported().

◆ m_supports_qEcho

LazyBool lldb_private::process_gdb_remote::GDBRemoteCommunication::m_supports_qEcho

protected

Definition at line 144 of file GDBRemoteCommunication.h.

Referenced by lldb_private::process_gdb_remote::GDBRemoteCommunicationClient::GetEchoSupported(), lldb_private::process_gdb_remote::GDBRemoteCommunicationClient::GetRemoteQSupported(), and WaitForPacketNoLock().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ PacketResult

◆ PacketType

Constructor & Destructor Documentation

◆ GDBRemoteCommunication()

◆ ~GDBRemoteCommunication()

Member Function Documentation

◆ AppendBytesToCache()

◆ CalculcateChecksum()

◆ CheckForPacket()

◆ CompressionIsEnabled()

◆ ConnectLocally()

◆ DecompressPacket()

◆ DumpHistory()

◆ GetAck()

◆ GetPacketTimeout()

◆ GetSendAcks()

◆ JoinListenThread()

◆ ListenThread()

◆ PopPacketFromQueue()

◆ ReadPacket()

◆ ReadPacketWithOutputSupport()

◆ SendAck()

◆ SendNack()

◆ SendPacketNoLock()

◆ SendRawPacketNoLock()

◆ SetHistoryStream()

◆ SetPacketTimeout()

◆ StartDebugserverProcess()

◆ StartListenThread()

◆ WaitForPacketNoLock()

Member Data Documentation

◆ m_compression_type

◆ m_echo_number

◆ m_history

◆ m_is_platform

◆ m_packet_timeout

◆ m_send_acks

◆ m_supports_qEcho