1//===-- GDBRemoteCommunicationServer.cpp ----------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include <cerrno>
10
11#include "lldb/Host/Config.h"
12
13#include "GDBRemoteCommunicationServer.h"
14
15#include "ProcessGDBRemoteLog.h"
16#include "lldb/Utility/StreamString.h"
17#include "lldb/Utility/StringExtractorGDBRemote.h"
18#include "lldb/Utility/UnimplementedError.h"
19#include "llvm/Support/JSON.h"
20#include <cstring>
21
22using namespace lldb;
23using namespace lldb_private;
24using namespace lldb_private::process_gdb_remote;
25using namespace llvm;
26
27GDBRemoteCommunicationServer::GDBRemoteCommunicationServer()
28 : GDBRemoteCommunication(), m_exit_now(false) {
29 RegisterPacketHandler(
30 packet_type: StringExtractorGDBRemote::eServerPacketType_QEnableErrorStrings,
31 handler: [this](StringExtractorGDBRemote packet, Status &error, bool &interrupt,
32 bool &quit) { return this->Handle_QErrorStringEnable(packet); });
33}
34
35GDBRemoteCommunicationServer::~GDBRemoteCommunicationServer() = default;
36
37void GDBRemoteCommunicationServer::RegisterPacketHandler(
38 StringExtractorGDBRemote::ServerPacketType packet_type,
39 PacketHandler handler) {
40 m_packet_handlers[packet_type] = std::move(handler);
41}
42
43GDBRemoteCommunication::PacketResult
44GDBRemoteCommunicationServer::GetPacketAndSendResponse(
45 Timeout<std::micro> timeout, Status &error, bool &interrupt, bool &quit) {
46 StringExtractorGDBRemote packet;
47
48 PacketResult packet_result = ReadPacket(response&: packet, timeout, sync_on_timeout: false);
49 if (packet_result == PacketResult::Success) {
50 const StringExtractorGDBRemote::ServerPacketType packet_type =
51 packet.GetServerPacketType();
52 switch (packet_type) {
53 case StringExtractorGDBRemote::eServerPacketType_nack:
54 case StringExtractorGDBRemote::eServerPacketType_ack:
55 break;
56
57 case StringExtractorGDBRemote::eServerPacketType_invalid:
58 error = Status::FromErrorString(str: "invalid packet");
59 quit = true;
60 break;
61
62 case StringExtractorGDBRemote::eServerPacketType_unimplemented:
63 packet_result = SendUnimplementedResponse(packet: packet.GetStringRef().data());
64 break;
65
66 default:
67 auto handler_it = m_packet_handlers.find(x: packet_type);
68 if (handler_it == m_packet_handlers.end())
69 packet_result = SendUnimplementedResponse(packet: packet.GetStringRef().data());
70 else
71 packet_result = handler_it->second(packet, error, interrupt, quit);
72 break;
73 }
74 } else {
75 if (!IsConnected()) {
76 error = Status::FromErrorString(str: "lost connection");
77 quit = true;
78 } else {
79 error = Status::FromErrorString(str: "timeout");
80 }
81 }
82
83 // Check if anything occurred that would force us to want to exit.
84 if (m_exit_now)
85 quit = true;
86
87 return packet_result;
88}
89
90GDBRemoteCommunication::PacketResult
91GDBRemoteCommunicationServer::SendUnimplementedResponse(const char *) {
92 // TODO: Log the packet we aren't handling...
93 return SendPacketNoLock(payload: "");
94}
95
96GDBRemoteCommunication::PacketResult
97GDBRemoteCommunicationServer::SendErrorResponse(uint8_t err) {
98 char packet[16];
99 int packet_len = ::snprintf(s: packet, maxlen: sizeof(packet), format: "E%2.2x", err);
100 assert(packet_len < (int)sizeof(packet));
101 return SendPacketNoLock(payload: llvm::StringRef(packet, packet_len));
102}
103
104GDBRemoteCommunication::PacketResult
105GDBRemoteCommunicationServer::SendErrorResponse(const Status &error) {
106 uint8_t code = error.GetType() == eErrorTypePOSIX ? error.GetError() : 0xff;
107 if (m_send_error_strings) {
108 lldb_private::StreamString packet;
109 packet.Printf(format: "E%2.2x;", code);
110 packet.PutStringAsRawHex8(s: error.AsCString());
111 return SendPacketNoLock(payload: packet.GetString());
112 }
113 return SendErrorResponse(err: code);
114}
115
116GDBRemoteCommunication::PacketResult
117GDBRemoteCommunicationServer::SendErrorResponse(llvm::Error error) {
118 assert(error);
119 std::unique_ptr<llvm::ErrorInfoBase> EIB;
120 std::unique_ptr<UnimplementedError> UE;
121 llvm::handleAllErrors(
122 E: std::move(error),
123 Handlers: [&](std::unique_ptr<UnimplementedError> E) { UE = std::move(E); },
124 Handlers: [&](std::unique_ptr<llvm::ErrorInfoBase> E) { EIB = std::move(E); });
125
126 if (EIB)
127 return SendErrorResponse(error: Status::FromError(error: llvm::Error(std::move(EIB))));
128 return SendUnimplementedResponse("");
129}
130
131GDBRemoteCommunication::PacketResult
132GDBRemoteCommunicationServer::Handle_QErrorStringEnable(
133 StringExtractorGDBRemote &packet) {
134 m_send_error_strings = true;
135 return SendOKResponse();
136}
137
138GDBRemoteCommunication::PacketResult
139GDBRemoteCommunicationServer::SendIllFormedResponse(
140 const StringExtractorGDBRemote &failed_packet, const char *message) {
141 Log *log = GetLog(mask: GDBRLog::Packets);
142 LLDB_LOGF(log, "GDBRemoteCommunicationServer::%s: ILLFORMED: '%s' (%s)",
143 __FUNCTION__, failed_packet.GetStringRef().data(),
144 message ? message : "");
145 return SendErrorResponse(err: 0x03);
146}
147
148GDBRemoteCommunication::PacketResult
149GDBRemoteCommunicationServer::SendOKResponse() {
150 return SendPacketNoLock(payload: "OK");
151}
152
153GDBRemoteCommunication::PacketResult
154GDBRemoteCommunicationServer::SendJSONResponse(const json::Value &value) {
155 std::string json_string;
156 raw_string_ostream os(json_string);
157 os << value;
158 StreamGDBRemote escaped_response;
159 escaped_response.PutEscapedBytes(s: json_string.c_str(), src_len: json_string.size());
160 return SendPacketNoLock(payload: escaped_response.GetString());
161}
162
163GDBRemoteCommunication::PacketResult
164GDBRemoteCommunicationServer::SendJSONResponse(Expected<json::Value> value) {
165 if (!value)
166 return SendErrorResponse(error: value.takeError());
167 return SendJSONResponse(value: *value);
168}
169

source code of lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServer.cpp