#include <GDBRemoteCommunicationServer.h>

Inheritance diagram for lldb_private::process_gdb_remote::GDBRemoteCommunicationServer:

Public Types
using	PacketHandler
Public Types inherited from lldb_private::process_gdb_remote::GDBRemoteCommunication
enum class	PacketType { Invalid = 0 , Standard , Notify }
enum class	PacketResult { Success = 0 , ErrorSendFailed , ErrorSendAck , ErrorReplyFailed , ErrorReplyTimeout , ErrorReplyInvalid , ErrorReplyAck , ErrorDisconnected , ErrorNoSequenceLock }

Public Member Functions
	GDBRemoteCommunicationServer ()
	~GDBRemoteCommunicationServer () override
void	RegisterPacketHandler (StringExtractorGDBRemote::ServerPacketType packet_type, PacketHandler handler)
PacketResult	GetPacketAndSendResponse (Timeout< std::micro > timeout, Status &error, bool &interrupt, bool &quit)
Public Member Functions inherited from lldb_private::process_gdb_remote::GDBRemoteCommunication
	GDBRemoteCommunication ()
	~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
void	DumpHistory (Stream &strm)
Public Member Functions inherited from lldb_private::Communication
	Communication ()
	Construct the Communication object.
virtual	~Communication ()
	Destructor.
virtual void	Clear ()
lldb::ConnectionStatus	Connect (const char url, Status error_ptr)
	Connect using the current connection by passing url to its connect function.
virtual lldb::ConnectionStatus	Disconnect (Status *error_ptr=nullptr)
	Disconnect the communications connection if one is currently connected.
bool	IsConnected () const
	Check if the connection is valid.
bool	HasConnection () const
lldb_private::Connection *	GetConnection ()
virtual 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.
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.
size_t	WriteAll (const void src, size_t src_len, lldb::ConnectionStatus &status, Status error_ptr)
	Repeatedly attempt writing until either src_len bytes are written or a permanent failure occurs.
virtual void	SetConnection (std::unique_ptr< Connection > connection)
	Sets the connection that it to be used by this class.
bool	GetCloseOnEOF () const
void	SetCloseOnEOF (bool b)

Protected Member Functions
PacketResult	Handle_QErrorStringEnable (StringExtractorGDBRemote &packet)
PacketResult	SendErrorResponse (const Status &error)
PacketResult	SendErrorResponse (llvm::Error error)
PacketResult	SendUnimplementedResponse (const char *packet)
PacketResult	SendErrorResponse (uint8_t error)
PacketResult	SendIllFormedResponse (const StringExtractorGDBRemote &packet, const char *error_message)
PacketResult	SendOKResponse ()
PacketResult	SendJSONResponse (const llvm::json::Value &value)
	Serialize and send a JSON object response.
PacketResult	SendJSONResponse (llvm::Expected< llvm::json::Value > value)
	Serialize and send a JSON object response, or respond with an error if the input object is an llvm::Error.
Protected Member Functions inherited from lldb_private::process_gdb_remote::GDBRemoteCommunication
PacketResult	SendPacketNoLock (llvm::StringRef payload)
PacketResult	SendNotificationPacketNoLock (llvm::StringRef notify_type, std::deque< std::string > &queue, 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	WaitForPacketNoLock (StringExtractorGDBRemote &response, Timeout< std::micro > timeout, bool sync_on_timeout)
bool	CompressionIsEnabled ()
bool	DecompressPacket ()
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)

Protected Attributes
std::map< StringExtractorGDBRemote::ServerPacketType, PacketHandler >	m_packet_handlers
bool	m_exit_now
bool	m_send_error_strings = false
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
std::string	m_bytes
std::recursive_mutex	m_bytes_mutex
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.
std::mutex	m_write_mutex
	Don't let multiple threads write at the same time...
bool	m_close_on_eof

Private Member Functions
	GDBRemoteCommunicationServer (const GDBRemoteCommunicationServer &)=delete
const GDBRemoteCommunicationServer &	operator= (const GDBRemoteCommunicationServer &)=delete

Additional Inherited Members
Static Public Member Functions inherited from lldb_private::process_gdb_remote::GDBRemoteCommunication
static Status	StartDebugserverProcess (std::variant< llvm::StringRef, shared_fd_t > comm, ProcessLaunchInfo &launch_info, const Args *inferior_args)
static std::optional< std::string >	ExpandRLE (std::string)
	Expand GDB run-length encoding.
Static Public Member Functions inherited from lldb_private::Communication
static std::string	ConnectionStatusAsString (lldb::ConnectionStatus status)

Detailed Description

Definition at line 28 of file GDBRemoteCommunicationServer.h.

Member Typedef Documentation

◆ PacketHandler

using lldb_private::process_gdb_remote::GDBRemoteCommunicationServer::PacketHandler

Initial value:

 
      std::function<PacketResult(StringExtractorGDBRemote &packet,
                                 Status &error, bool &interrupt, bool &quit)>

Definition at line 30 of file GDBRemoteCommunicationServer.h.

Constructor & Destructor Documentation

◆ GDBRemoteCommunicationServer() [1/2]

GDBRemoteCommunicationServer::GDBRemoteCommunicationServer ( )

Definition at line 27 of file GDBRemoteCommunicationServer.cpp.

References error(), StringExtractorGDBRemote::eServerPacketType_QEnableErrorStrings, lldb_private::process_gdb_remote::GDBRemoteCommunication::GDBRemoteCommunication(), Handle_QErrorStringEnable(), m_exit_now, and RegisterPacketHandler().

Referenced by GDBRemoteCommunicationServer(), lldb_private::process_gdb_remote::GDBRemoteCommunicationServerCommon::GDBRemoteCommunicationServerCommon(), and operator=().

◆ ~GDBRemoteCommunicationServer()

GDBRemoteCommunicationServer::~GDBRemoteCommunicationServer ( )

overridedefault

References error().

◆ GDBRemoteCommunicationServer() [2/2]

lldb_private::process_gdb_remote::GDBRemoteCommunicationServer::GDBRemoteCommunicationServer ( const GDBRemoteCommunicationServer & )

privatedelete

References GDBRemoteCommunicationServer().

Member Function Documentation

◆ GetPacketAndSendResponse()

GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServer::GetPacketAndSendResponse	(	Timeout< std::micro >	timeout,
		Status &	error,
		bool &	interrupt,
		bool &	quit )

Definition at line 44 of file GDBRemoteCommunicationServer.cpp.

References error(), StringExtractorGDBRemote::eServerPacketType_ack, StringExtractorGDBRemote::eServerPacketType_invalid, StringExtractorGDBRemote::eServerPacketType_nack, StringExtractorGDBRemote::eServerPacketType_unimplemented, lldb_private::Status::FromErrorString(), StringExtractorGDBRemote::GetServerPacketType(), StringExtractor::GetStringRef(), lldb_private::Communication::IsConnected(), m_exit_now, m_packet_handlers, lldb_private::process_gdb_remote::GDBRemoteCommunication::ReadPacket(), SendUnimplementedResponse(), and lldb_private::process_gdb_remote::GDBRemoteCommunication::Success.

Referenced by lldb_private::process_gdb_remote::GDBRemoteCommunicationServerLLGS::DataAvailableCallback().

◆ Handle_QErrorStringEnable()

GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServer::Handle_QErrorStringEnable ( StringExtractorGDBRemote & packet )

protected

Definition at line 132 of file GDBRemoteCommunicationServer.cpp.

References m_send_error_strings, and SendOKResponse().

Referenced by GDBRemoteCommunicationServer().

◆ operator=()

const GDBRemoteCommunicationServer & lldb_private::process_gdb_remote::GDBRemoteCommunicationServer::operator= ( const GDBRemoteCommunicationServer & )

privatedelete

References GDBRemoteCommunicationServer().

◆ RegisterPacketHandler()

void GDBRemoteCommunicationServer::RegisterPacketHandler	(	StringExtractorGDBRemote::ServerPacketType	packet_type,
		PacketHandler	handler )

Definition at line 37 of file GDBRemoteCommunicationServer.cpp.

References m_packet_handlers.

Referenced by GDBRemoteCommunicationServer(), lldb_private::process_gdb_remote::GDBRemoteCommunicationServerPlatform::GDBRemoteCommunicationServerPlatform(), lldb_private::process_gdb_remote::GDBRemoteCommunicationServerCommon::RegisterMemberFunctionHandler(), and lldb_private::process_gdb_remote::GDBRemoteCommunicationServerLLGS::RegisterPacketHandlers().

◆ SendErrorResponse() [1/3]

GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServer::SendErrorResponse ( const Status & error )

protected

Definition at line 105 of file GDBRemoteCommunicationServer.cpp.

References lldb::eErrorTypePOSIX, error(), lldb_private::StreamString::GetString(), m_send_error_strings, lldb_private::Stream::Printf(), lldb_private::Stream::PutStringAsRawHex8(), SendErrorResponse(), and lldb_private::process_gdb_remote::GDBRemoteCommunication::SendPacketNoLock().

◆ SendErrorResponse() [2/3]

GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServer::SendErrorResponse ( llvm::Error error )

protected

Definition at line 117 of file GDBRemoteCommunicationServer.cpp.

References error(), lldb_private::Status::FromError(), SendErrorResponse(), and SendUnimplementedResponse().

◆ SendErrorResponse() [3/3]

GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServer::SendErrorResponse ( uint8_t error )

protected

Definition at line 97 of file GDBRemoteCommunicationServer.cpp.

References lldb_private::process_gdb_remote::GDBRemoteCommunication::SendPacketNoLock().

◆ SendIllFormedResponse()

GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServer::SendIllFormedResponse	(	const StringExtractorGDBRemote &	packet,
		const char *	error_message )