1 //===-- GDBRemoteCommunicationClient.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 "GDBRemoteCommunicationClient.h"
10 
11 #include <cmath>
12 #include <sys/stat.h>
13 
14 #include <numeric>
15 #include <sstream>
16 
17 #include "lldb/Core/ModuleSpec.h"
18 #include "lldb/Host/HostInfo.h"
19 #include "lldb/Host/XML.h"
20 #include "lldb/Symbol/Symbol.h"
21 #include "lldb/Target/MemoryRegionInfo.h"
22 #include "lldb/Target/Target.h"
23 #include "lldb/Target/UnixSignals.h"
24 #include "lldb/Utility/Args.h"
25 #include "lldb/Utility/DataBufferHeap.h"
26 #include "lldb/Utility/LLDBAssert.h"
27 #include "lldb/Utility/LLDBLog.h"
28 #include "lldb/Utility/Log.h"
29 #include "lldb/Utility/State.h"
30 #include "lldb/Utility/StreamString.h"
31 
32 #include "ProcessGDBRemote.h"
33 #include "ProcessGDBRemoteLog.h"
34 #include "lldb/Host/Config.h"
35 #include "lldb/Utility/StringExtractorGDBRemote.h"
36 
37 #include "llvm/ADT/StringSwitch.h"
38 #include "llvm/Support/JSON.h"
39 
40 #if defined(HAVE_LIBCOMPRESSION)
41 #include <compression.h>
42 #endif
43 
44 using namespace lldb;
45 using namespace lldb_private::process_gdb_remote;
46 using namespace lldb_private;
47 using namespace std::chrono;
48 
49 llvm::raw_ostream &process_gdb_remote::operator<<(llvm::raw_ostream &os,
50                                                   const QOffsets &offsets) {
51   return os << llvm::formatv(
52              "QOffsets({0}, [{1:@[x]}])", offsets.segments,
53              llvm::make_range(offsets.offsets.begin(), offsets.offsets.end()));
54 }
55 
56 // GDBRemoteCommunicationClient constructor
57 GDBRemoteCommunicationClient::GDBRemoteCommunicationClient()
58     : GDBRemoteClientBase("gdb-remote.client", "gdb-remote.client.rx_packet"),
59 
60       m_supports_qProcessInfoPID(true), m_supports_qfProcessInfo(true),
61       m_supports_qUserName(true), m_supports_qGroupName(true),
62       m_supports_qThreadStopInfo(true), m_supports_z0(true),
63       m_supports_z1(true), m_supports_z2(true), m_supports_z3(true),
64       m_supports_z4(true), m_supports_QEnvironment(true),
65       m_supports_QEnvironmentHexEncoded(true), m_supports_qSymbol(true),
66       m_qSymbol_requests_done(false), m_supports_qModuleInfo(true),
67       m_supports_jThreadsInfo(true), m_supports_jModulesInfo(true),
68       m_supports_vFileSize(true), m_supports_vFileMode(true),
69       m_supports_vFileExists(true), m_supports_vRun(true),
70 
71       m_host_arch(), m_process_arch(), m_os_build(), m_os_kernel(),
72       m_hostname(), m_gdb_server_name(), m_default_packet_timeout(0),
73       m_qSupported_response(), m_supported_async_json_packets_sp(),
74       m_qXfer_memory_map() {}
75 
76 // Destructor
77 GDBRemoteCommunicationClient::~GDBRemoteCommunicationClient() {
78   if (IsConnected())
79     Disconnect();
80 }
81 
82 bool GDBRemoteCommunicationClient::HandshakeWithServer(Status *error_ptr) {
83   ResetDiscoverableSettings(false);
84 
85   // Start the read thread after we send the handshake ack since if we fail to
86   // send the handshake ack, there is no reason to continue...
87   std::chrono::steady_clock::time_point start_of_handshake =
88       std::chrono::steady_clock::now();
89   if (SendAck()) {
90     // The return value from QueryNoAckModeSupported() is true if the packet
91     // was sent and _any_ response (including UNIMPLEMENTED) was received), or
92     // false if no response was received. This quickly tells us if we have a
93     // live connection to a remote GDB server...
94     if (QueryNoAckModeSupported()) {
95       return true;
96     } else {
97       std::chrono::steady_clock::time_point end_of_handshake =
98           std::chrono::steady_clock::now();
99       auto handshake_timeout =
100           std::chrono::duration<double>(end_of_handshake - start_of_handshake)
101               .count();
102       if (error_ptr) {
103         if (!IsConnected())
104           error_ptr->SetErrorString("Connection shut down by remote side "
105                                     "while waiting for reply to initial "
106                                     "handshake packet");
107         else
108           error_ptr->SetErrorStringWithFormat(
109               "failed to get reply to handshake packet within timeout of "
110               "%.1f seconds",
111               handshake_timeout);
112       }
113     }
114   } else {
115     if (error_ptr)
116       error_ptr->SetErrorString("failed to send the handshake ack");
117   }
118   return false;
119 }
120 
121 bool GDBRemoteCommunicationClient::GetEchoSupported() {
122   if (m_supports_qEcho == eLazyBoolCalculate) {
123     GetRemoteQSupported();
124   }
125   return m_supports_qEcho == eLazyBoolYes;
126 }
127 
128 bool GDBRemoteCommunicationClient::GetQPassSignalsSupported() {
129   if (m_supports_QPassSignals == eLazyBoolCalculate) {
130     GetRemoteQSupported();
131   }
132   return m_supports_QPassSignals == eLazyBoolYes;
133 }
134 
135 bool GDBRemoteCommunicationClient::GetAugmentedLibrariesSVR4ReadSupported() {
136   if (m_supports_augmented_libraries_svr4_read == eLazyBoolCalculate) {
137     GetRemoteQSupported();
138   }
139   return m_supports_augmented_libraries_svr4_read == eLazyBoolYes;
140 }
141 
142 bool GDBRemoteCommunicationClient::GetQXferLibrariesSVR4ReadSupported() {
143   if (m_supports_qXfer_libraries_svr4_read == eLazyBoolCalculate) {
144     GetRemoteQSupported();
145   }
146   return m_supports_qXfer_libraries_svr4_read == eLazyBoolYes;
147 }
148 
149 bool GDBRemoteCommunicationClient::GetQXferLibrariesReadSupported() {
150   if (m_supports_qXfer_libraries_read == eLazyBoolCalculate) {
151     GetRemoteQSupported();
152   }
153   return m_supports_qXfer_libraries_read == eLazyBoolYes;
154 }
155 
156 bool GDBRemoteCommunicationClient::GetQXferAuxvReadSupported() {
157   if (m_supports_qXfer_auxv_read == eLazyBoolCalculate) {
158     GetRemoteQSupported();
159   }
160   return m_supports_qXfer_auxv_read == eLazyBoolYes;
161 }
162 
163 bool GDBRemoteCommunicationClient::GetQXferFeaturesReadSupported() {
164   if (m_supports_qXfer_features_read == eLazyBoolCalculate) {
165     GetRemoteQSupported();
166   }
167   return m_supports_qXfer_features_read == eLazyBoolYes;
168 }
169 
170 bool GDBRemoteCommunicationClient::GetQXferMemoryMapReadSupported() {
171   if (m_supports_qXfer_memory_map_read == eLazyBoolCalculate) {
172     GetRemoteQSupported();
173   }
174   return m_supports_qXfer_memory_map_read == eLazyBoolYes;
175 }
176 
177 bool GDBRemoteCommunicationClient::GetQXferSigInfoReadSupported() {
178   if (m_supports_qXfer_siginfo_read == eLazyBoolCalculate) {
179     GetRemoteQSupported();
180   }
181   return m_supports_qXfer_siginfo_read == eLazyBoolYes;
182 }
183 
184 uint64_t GDBRemoteCommunicationClient::GetRemoteMaxPacketSize() {
185   if (m_max_packet_size == 0) {
186     GetRemoteQSupported();
187   }
188   return m_max_packet_size;
189 }
190 
191 bool GDBRemoteCommunicationClient::QueryNoAckModeSupported() {
192   if (m_supports_not_sending_acks == eLazyBoolCalculate) {
193     m_send_acks = true;
194     m_supports_not_sending_acks = eLazyBoolNo;
195 
196     // This is the first real packet that we'll send in a debug session and it
197     // may take a little longer than normal to receive a reply.  Wait at least
198     // 6 seconds for a reply to this packet.
199 
200     ScopedTimeout timeout(*this, std::max(GetPacketTimeout(), seconds(6)));
201 
202     StringExtractorGDBRemote response;
203     if (SendPacketAndWaitForResponse("QStartNoAckMode", response) ==
204         PacketResult::Success) {
205       if (response.IsOKResponse()) {
206         m_send_acks = false;
207         m_supports_not_sending_acks = eLazyBoolYes;
208       }
209       return true;
210     }
211   }
212   return false;
213 }
214 
215 void GDBRemoteCommunicationClient::GetListThreadsInStopReplySupported() {
216   if (m_supports_threads_in_stop_reply == eLazyBoolCalculate) {
217     m_supports_threads_in_stop_reply = eLazyBoolNo;
218 
219     StringExtractorGDBRemote response;
220     if (SendPacketAndWaitForResponse("QListThreadsInStopReply", response) ==
221         PacketResult::Success) {
222       if (response.IsOKResponse())
223         m_supports_threads_in_stop_reply = eLazyBoolYes;
224     }
225   }
226 }
227 
228 bool GDBRemoteCommunicationClient::GetVAttachOrWaitSupported() {
229   if (m_attach_or_wait_reply == eLazyBoolCalculate) {
230     m_attach_or_wait_reply = eLazyBoolNo;
231 
232     StringExtractorGDBRemote response;
233     if (SendPacketAndWaitForResponse("qVAttachOrWaitSupported", response) ==
234         PacketResult::Success) {
235       if (response.IsOKResponse())
236         m_attach_or_wait_reply = eLazyBoolYes;
237     }
238   }
239   return m_attach_or_wait_reply == eLazyBoolYes;
240 }
241 
242 bool GDBRemoteCommunicationClient::GetSyncThreadStateSupported() {
243   if (m_prepare_for_reg_writing_reply == eLazyBoolCalculate) {
244     m_prepare_for_reg_writing_reply = eLazyBoolNo;
245 
246     StringExtractorGDBRemote response;
247     if (SendPacketAndWaitForResponse("qSyncThreadStateSupported", response) ==
248         PacketResult::Success) {
249       if (response.IsOKResponse())
250         m_prepare_for_reg_writing_reply = eLazyBoolYes;
251     }
252   }
253   return m_prepare_for_reg_writing_reply == eLazyBoolYes;
254 }
255 
256 void GDBRemoteCommunicationClient::ResetDiscoverableSettings(bool did_exec) {
257   if (!did_exec) {
258     // Hard reset everything, this is when we first connect to a GDB server
259     m_supports_not_sending_acks = eLazyBoolCalculate;
260     m_supports_thread_suffix = eLazyBoolCalculate;
261     m_supports_threads_in_stop_reply = eLazyBoolCalculate;
262     m_supports_vCont_c = eLazyBoolCalculate;
263     m_supports_vCont_C = eLazyBoolCalculate;
264     m_supports_vCont_s = eLazyBoolCalculate;
265     m_supports_vCont_S = eLazyBoolCalculate;
266     m_supports_p = eLazyBoolCalculate;
267     m_supports_x = eLazyBoolCalculate;
268     m_supports_QSaveRegisterState = eLazyBoolCalculate;
269     m_qHostInfo_is_valid = eLazyBoolCalculate;
270     m_curr_pid_is_valid = eLazyBoolCalculate;
271     m_qGDBServerVersion_is_valid = eLazyBoolCalculate;
272     m_supports_alloc_dealloc_memory = eLazyBoolCalculate;
273     m_supports_memory_region_info = eLazyBoolCalculate;
274     m_prepare_for_reg_writing_reply = eLazyBoolCalculate;
275     m_attach_or_wait_reply = eLazyBoolCalculate;
276     m_avoid_g_packets = eLazyBoolCalculate;
277     m_supports_multiprocess = eLazyBoolCalculate;
278     m_supports_qSaveCore = eLazyBoolCalculate;
279     m_supports_qXfer_auxv_read = eLazyBoolCalculate;
280     m_supports_qXfer_libraries_read = eLazyBoolCalculate;
281     m_supports_qXfer_libraries_svr4_read = eLazyBoolCalculate;
282     m_supports_qXfer_features_read = eLazyBoolCalculate;
283     m_supports_qXfer_memory_map_read = eLazyBoolCalculate;
284     m_supports_qXfer_siginfo_read = eLazyBoolCalculate;
285     m_supports_augmented_libraries_svr4_read = eLazyBoolCalculate;
286     m_uses_native_signals = eLazyBoolCalculate;
287     m_supports_qProcessInfoPID = true;
288     m_supports_qfProcessInfo = true;
289     m_supports_qUserName = true;
290     m_supports_qGroupName = true;
291     m_supports_qThreadStopInfo = true;
292     m_supports_z0 = true;
293     m_supports_z1 = true;
294     m_supports_z2 = true;
295     m_supports_z3 = true;
296     m_supports_z4 = true;
297     m_supports_QEnvironment = true;
298     m_supports_QEnvironmentHexEncoded = true;
299     m_supports_qSymbol = true;
300     m_qSymbol_requests_done = false;
301     m_supports_qModuleInfo = true;
302     m_host_arch.Clear();
303     m_os_version = llvm::VersionTuple();
304     m_os_build.clear();
305     m_os_kernel.clear();
306     m_hostname.clear();
307     m_gdb_server_name.clear();
308     m_gdb_server_version = UINT32_MAX;
309     m_default_packet_timeout = seconds(0);
310     m_target_vm_page_size = 0;
311     m_max_packet_size = 0;
312     m_qSupported_response.clear();
313     m_supported_async_json_packets_is_valid = false;
314     m_supported_async_json_packets_sp.reset();
315     m_supports_jModulesInfo = true;
316   }
317 
318   // These flags should be reset when we first connect to a GDB server and when
319   // our inferior process execs
320   m_qProcessInfo_is_valid = eLazyBoolCalculate;
321   m_process_arch.Clear();
322 }
323 
324 void GDBRemoteCommunicationClient::GetRemoteQSupported() {
325   // Clear out any capabilities we expect to see in the qSupported response
326   m_supports_qXfer_auxv_read = eLazyBoolNo;
327   m_supports_qXfer_libraries_read = eLazyBoolNo;
328   m_supports_qXfer_libraries_svr4_read = eLazyBoolNo;
329   m_supports_augmented_libraries_svr4_read = eLazyBoolNo;
330   m_supports_qXfer_features_read = eLazyBoolNo;
331   m_supports_qXfer_memory_map_read = eLazyBoolNo;
332   m_supports_qXfer_siginfo_read = eLazyBoolNo;
333   m_supports_multiprocess = eLazyBoolNo;
334   m_supports_qEcho = eLazyBoolNo;
335   m_supports_QPassSignals = eLazyBoolNo;
336   m_supports_memory_tagging = eLazyBoolNo;
337   m_supports_qSaveCore = eLazyBoolNo;
338   m_uses_native_signals = eLazyBoolNo;
339 
340   m_max_packet_size = UINT64_MAX; // It's supposed to always be there, but if
341                                   // not, we assume no limit
342 
343   // build the qSupported packet
344   std::vector<std::string> features = {"xmlRegisters=i386,arm,mips,arc",
345                                        "multiprocess+", "fork-events+",
346                                        "vfork-events+"};
347   StreamString packet;
348   packet.PutCString("qSupported");
349   for (uint32_t i = 0; i < features.size(); ++i) {
350     packet.PutCString(i == 0 ? ":" : ";");
351     packet.PutCString(features[i]);
352   }
353 
354   StringExtractorGDBRemote response;
355   if (SendPacketAndWaitForResponse(packet.GetString(), response) ==
356       PacketResult::Success) {
357     // Hang on to the qSupported packet, so that platforms can do custom
358     // configuration of the transport before attaching/launching the process.
359     m_qSupported_response = response.GetStringRef().str();
360 
361     for (llvm::StringRef x : llvm::split(response.GetStringRef(), ';')) {
362       if (x == "qXfer:auxv:read+")
363         m_supports_qXfer_auxv_read = eLazyBoolYes;
364       else if (x == "qXfer:libraries-svr4:read+")
365         m_supports_qXfer_libraries_svr4_read = eLazyBoolYes;
366       else if (x == "augmented-libraries-svr4-read") {
367         m_supports_qXfer_libraries_svr4_read = eLazyBoolYes; // implied
368         m_supports_augmented_libraries_svr4_read = eLazyBoolYes;
369       } else if (x == "qXfer:libraries:read+")
370         m_supports_qXfer_libraries_read = eLazyBoolYes;
371       else if (x == "qXfer:features:read+")
372         m_supports_qXfer_features_read = eLazyBoolYes;
373       else if (x == "qXfer:memory-map:read+")
374         m_supports_qXfer_memory_map_read = eLazyBoolYes;
375       else if (x == "qXfer:siginfo:read+")
376         m_supports_qXfer_siginfo_read = eLazyBoolYes;
377       else if (x == "qEcho")
378         m_supports_qEcho = eLazyBoolYes;
379       else if (x == "QPassSignals+")
380         m_supports_QPassSignals = eLazyBoolYes;
381       else if (x == "multiprocess+")
382         m_supports_multiprocess = eLazyBoolYes;
383       else if (x == "memory-tagging+")
384         m_supports_memory_tagging = eLazyBoolYes;
385       else if (x == "qSaveCore+")
386         m_supports_qSaveCore = eLazyBoolYes;
387       else if (x == "native-signals+")
388         m_uses_native_signals = eLazyBoolYes;
389       // Look for a list of compressions in the features list e.g.
390       // qXfer:features:read+;PacketSize=20000;qEcho+;SupportedCompressions=zlib-
391       // deflate,lzma
392       else if (x.consume_front("SupportedCompressions=")) {
393         llvm::SmallVector<llvm::StringRef, 4> compressions;
394         x.split(compressions, ',');
395         if (!compressions.empty())
396           MaybeEnableCompression(compressions);
397       } else if (x.consume_front("PacketSize=")) {
398         StringExtractorGDBRemote packet_response(x);
399         m_max_packet_size =
400             packet_response.GetHexMaxU64(/*little_endian=*/false, UINT64_MAX);
401         if (m_max_packet_size == 0) {
402           m_max_packet_size = UINT64_MAX; // Must have been a garbled response
403           Log *log(GetLog(GDBRLog::Process));
404           LLDB_LOGF(log, "Garbled PacketSize spec in qSupported response");
405         }
406       }
407     }
408   }
409 }
410 
411 bool GDBRemoteCommunicationClient::GetThreadSuffixSupported() {
412   if (m_supports_thread_suffix == eLazyBoolCalculate) {
413     StringExtractorGDBRemote response;
414     m_supports_thread_suffix = eLazyBoolNo;
415     if (SendPacketAndWaitForResponse("QThreadSuffixSupported", response) ==
416         PacketResult::Success) {
417       if (response.IsOKResponse())
418         m_supports_thread_suffix = eLazyBoolYes;
419     }
420   }
421   return m_supports_thread_suffix;
422 }
423 bool GDBRemoteCommunicationClient::GetVContSupported(char flavor) {
424   if (m_supports_vCont_c == eLazyBoolCalculate) {
425     StringExtractorGDBRemote response;
426     m_supports_vCont_any = eLazyBoolNo;
427     m_supports_vCont_all = eLazyBoolNo;
428     m_supports_vCont_c = eLazyBoolNo;
429     m_supports_vCont_C = eLazyBoolNo;
430     m_supports_vCont_s = eLazyBoolNo;
431     m_supports_vCont_S = eLazyBoolNo;
432     if (SendPacketAndWaitForResponse("vCont?", response) ==
433         PacketResult::Success) {
434       const char *response_cstr = response.GetStringRef().data();
435       if (::strstr(response_cstr, ";c"))
436         m_supports_vCont_c = eLazyBoolYes;
437 
438       if (::strstr(response_cstr, ";C"))
439         m_supports_vCont_C = eLazyBoolYes;
440 
441       if (::strstr(response_cstr, ";s"))
442         m_supports_vCont_s = eLazyBoolYes;
443 
444       if (::strstr(response_cstr, ";S"))
445         m_supports_vCont_S = eLazyBoolYes;
446 
447       if (m_supports_vCont_c == eLazyBoolYes &&
448           m_supports_vCont_C == eLazyBoolYes &&
449           m_supports_vCont_s == eLazyBoolYes &&
450           m_supports_vCont_S == eLazyBoolYes) {
451         m_supports_vCont_all = eLazyBoolYes;
452       }
453 
454       if (m_supports_vCont_c == eLazyBoolYes ||
455           m_supports_vCont_C == eLazyBoolYes ||
456           m_supports_vCont_s == eLazyBoolYes ||
457           m_supports_vCont_S == eLazyBoolYes) {
458         m_supports_vCont_any = eLazyBoolYes;
459       }
460     }
461   }
462 
463   switch (flavor) {
464   case 'a':
465     return m_supports_vCont_any;
466   case 'A':
467     return m_supports_vCont_all;
468   case 'c':
469     return m_supports_vCont_c;
470   case 'C':
471     return m_supports_vCont_C;
472   case 's':
473     return m_supports_vCont_s;
474   case 'S':
475     return m_supports_vCont_S;
476   default:
477     break;
478   }
479   return false;
480 }
481 
482 GDBRemoteCommunication::PacketResult
483 GDBRemoteCommunicationClient::SendThreadSpecificPacketAndWaitForResponse(
484     lldb::tid_t tid, StreamString &&payload,
485     StringExtractorGDBRemote &response) {
486   Lock lock(*this);
487   if (!lock) {
488     if (Log *log = GetLog(GDBRLog::Process | GDBRLog::Packets))
489       LLDB_LOGF(log,
490                 "GDBRemoteCommunicationClient::%s: Didn't get sequence mutex "
491                 "for %s packet.",
492                 __FUNCTION__, payload.GetData());
493     return PacketResult::ErrorNoSequenceLock;
494   }
495 
496   if (GetThreadSuffixSupported())
497     payload.Printf(";thread:%4.4" PRIx64 ";", tid);
498   else {
499     if (!SetCurrentThread(tid))
500       return PacketResult::ErrorSendFailed;
501   }
502 
503   return SendPacketAndWaitForResponseNoLock(payload.GetString(), response);
504 }
505 
506 // Check if the target supports 'p' packet. It sends out a 'p' packet and
507 // checks the response. A normal packet will tell us that support is available.
508 //
509 // Takes a valid thread ID because p needs to apply to a thread.
510 bool GDBRemoteCommunicationClient::GetpPacketSupported(lldb::tid_t tid) {
511   if (m_supports_p == eLazyBoolCalculate)
512     m_supports_p = GetThreadPacketSupported(tid, "p0");
513   return m_supports_p;
514 }
515 
516 LazyBool GDBRemoteCommunicationClient::GetThreadPacketSupported(
517     lldb::tid_t tid, llvm::StringRef packetStr) {
518   StreamString payload;
519   payload.PutCString(packetStr);
520   StringExtractorGDBRemote response;
521   if (SendThreadSpecificPacketAndWaitForResponse(
522           tid, std::move(payload), response) == PacketResult::Success &&
523       response.IsNormalResponse()) {
524     return eLazyBoolYes;
525   }
526   return eLazyBoolNo;
527 }
528 
529 bool GDBRemoteCommunicationClient::GetSaveCoreSupported() const {
530   return m_supports_qSaveCore == eLazyBoolYes;
531 }
532 
533 StructuredData::ObjectSP GDBRemoteCommunicationClient::GetThreadsInfo() {
534   // Get information on all threads at one using the "jThreadsInfo" packet
535   StructuredData::ObjectSP object_sp;
536 
537   if (m_supports_jThreadsInfo) {
538     StringExtractorGDBRemote response;
539     response.SetResponseValidatorToJSON();
540     if (SendPacketAndWaitForResponse("jThreadsInfo", response) ==
541         PacketResult::Success) {
542       if (response.IsUnsupportedResponse()) {
543         m_supports_jThreadsInfo = false;
544       } else if (!response.Empty()) {
545         object_sp =
546             StructuredData::ParseJSON(std::string(response.GetStringRef()));
547       }
548     }
549   }
550   return object_sp;
551 }
552 
553 bool GDBRemoteCommunicationClient::GetThreadExtendedInfoSupported() {
554   if (m_supports_jThreadExtendedInfo == eLazyBoolCalculate) {
555     StringExtractorGDBRemote response;
556     m_supports_jThreadExtendedInfo = eLazyBoolNo;
557     if (SendPacketAndWaitForResponse("jThreadExtendedInfo:", response) ==
558         PacketResult::Success) {
559       if (response.IsOKResponse()) {
560         m_supports_jThreadExtendedInfo = eLazyBoolYes;
561       }
562     }
563   }
564   return m_supports_jThreadExtendedInfo;
565 }
566 
567 void GDBRemoteCommunicationClient::EnableErrorStringInPacket() {
568   if (m_supports_error_string_reply == eLazyBoolCalculate) {
569     StringExtractorGDBRemote response;
570     // We try to enable error strings in remote packets but if we fail, we just
571     // work in the older way.
572     m_supports_error_string_reply = eLazyBoolNo;
573     if (SendPacketAndWaitForResponse("QEnableErrorStrings", response) ==
574         PacketResult::Success) {
575       if (response.IsOKResponse()) {
576         m_supports_error_string_reply = eLazyBoolYes;
577       }
578     }
579   }
580 }
581 
582 bool GDBRemoteCommunicationClient::GetLoadedDynamicLibrariesInfosSupported() {
583   if (m_supports_jLoadedDynamicLibrariesInfos == eLazyBoolCalculate) {
584     StringExtractorGDBRemote response;
585     m_supports_jLoadedDynamicLibrariesInfos = eLazyBoolNo;
586     if (SendPacketAndWaitForResponse("jGetLoadedDynamicLibrariesInfos:",
587                                      response) == PacketResult::Success) {
588       if (response.IsOKResponse()) {
589         m_supports_jLoadedDynamicLibrariesInfos = eLazyBoolYes;
590       }
591     }
592   }
593   return m_supports_jLoadedDynamicLibrariesInfos;
594 }
595 
596 bool GDBRemoteCommunicationClient::GetSharedCacheInfoSupported() {
597   if (m_supports_jGetSharedCacheInfo == eLazyBoolCalculate) {
598     StringExtractorGDBRemote response;
599     m_supports_jGetSharedCacheInfo = eLazyBoolNo;
600     if (SendPacketAndWaitForResponse("jGetSharedCacheInfo:", response) ==
601         PacketResult::Success) {
602       if (response.IsOKResponse()) {
603         m_supports_jGetSharedCacheInfo = eLazyBoolYes;
604       }
605     }
606   }
607   return m_supports_jGetSharedCacheInfo;
608 }
609 
610 bool GDBRemoteCommunicationClient::GetMemoryTaggingSupported() {
611   if (m_supports_memory_tagging == eLazyBoolCalculate) {
612     GetRemoteQSupported();
613   }
614   return m_supports_memory_tagging == eLazyBoolYes;
615 }
616 
617 DataBufferSP GDBRemoteCommunicationClient::ReadMemoryTags(lldb::addr_t addr,
618                                                           size_t len,
619                                                           int32_t type) {
620   StreamString packet;
621   packet.Printf("qMemTags:%" PRIx64 ",%zx:%" PRIx32, addr, len, type);
622   StringExtractorGDBRemote response;
623 
624   Log *log = GetLog(GDBRLog::Memory);
625 
626   if (SendPacketAndWaitForResponse(packet.GetString(), response) !=
627           PacketResult::Success ||
628       !response.IsNormalResponse()) {
629     LLDB_LOGF(log, "GDBRemoteCommunicationClient::%s: qMemTags packet failed",
630               __FUNCTION__);
631     return nullptr;
632   }
633 
634   // We are expecting
635   // m<hex encoded bytes>
636 
637   if (response.GetChar() != 'm') {
638     LLDB_LOGF(log,
639               "GDBRemoteCommunicationClient::%s: qMemTags response did not "
640               "begin with \"m\"",
641               __FUNCTION__);
642     return nullptr;
643   }
644 
645   size_t expected_bytes = response.GetBytesLeft() / 2;
646   WritableDataBufferSP buffer_sp(new DataBufferHeap(expected_bytes, 0));
647   size_t got_bytes = response.GetHexBytesAvail(buffer_sp->GetData());
648   // Check both because in some situations chars are consumed even
649   // if the decoding fails.
650   if (response.GetBytesLeft() || (expected_bytes != got_bytes)) {
651     LLDB_LOGF(
652         log,
653         "GDBRemoteCommunicationClient::%s: Invalid data in qMemTags response",
654         __FUNCTION__);
655     return nullptr;
656   }
657 
658   return buffer_sp;
659 }
660 
661 Status GDBRemoteCommunicationClient::WriteMemoryTags(
662     lldb::addr_t addr, size_t len, int32_t type,
663     const std::vector<uint8_t> &tags) {
664   // Format QMemTags:address,length:type:tags
665   StreamString packet;
666   packet.Printf("QMemTags:%" PRIx64 ",%zx:%" PRIx32 ":", addr, len, type);
667   packet.PutBytesAsRawHex8(tags.data(), tags.size());
668 
669   Status status;
670   StringExtractorGDBRemote response;
671   if (SendPacketAndWaitForResponse(packet.GetString(), response) !=
672           PacketResult::Success ||
673       !response.IsOKResponse()) {
674     status.SetErrorString("QMemTags packet failed");
675   }
676   return status;
677 }
678 
679 bool GDBRemoteCommunicationClient::GetxPacketSupported() {
680   if (m_supports_x == eLazyBoolCalculate) {
681     StringExtractorGDBRemote response;
682     m_supports_x = eLazyBoolNo;
683     char packet[256];
684     snprintf(packet, sizeof(packet), "x0,0");
685     if (SendPacketAndWaitForResponse(packet, response) ==
686         PacketResult::Success) {
687       if (response.IsOKResponse())
688         m_supports_x = eLazyBoolYes;
689     }
690   }
691   return m_supports_x;
692 }
693 
694 lldb::pid_t GDBRemoteCommunicationClient::GetCurrentProcessID(bool allow_lazy) {
695   if (allow_lazy && m_curr_pid_is_valid == eLazyBoolYes)
696     return m_curr_pid;
697 
698   // First try to retrieve the pid via the qProcessInfo request.
699   GetCurrentProcessInfo(allow_lazy);
700   if (m_curr_pid_is_valid == eLazyBoolYes) {
701     // We really got it.
702     return m_curr_pid;
703   } else {
704     // If we don't get a response for qProcessInfo, check if $qC gives us a
705     // result. $qC only returns a real process id on older debugserver and
706     // lldb-platform stubs. The gdb remote protocol documents $qC as returning
707     // the thread id, which newer debugserver and lldb-gdbserver stubs return
708     // correctly.
709     StringExtractorGDBRemote response;
710     if (SendPacketAndWaitForResponse("qC", response) == PacketResult::Success) {
711       if (response.GetChar() == 'Q') {
712         if (response.GetChar() == 'C') {
713           m_curr_pid_run = m_curr_pid =
714               response.GetHexMaxU64(false, LLDB_INVALID_PROCESS_ID);
715           if (m_curr_pid != LLDB_INVALID_PROCESS_ID) {
716             m_curr_pid_is_valid = eLazyBoolYes;
717             return m_curr_pid;
718           }
719         }
720       }
721     }
722 
723     // If we don't get a response for $qC, check if $qfThreadID gives us a
724     // result.
725     if (m_curr_pid == LLDB_INVALID_PROCESS_ID) {
726       bool sequence_mutex_unavailable;
727       auto ids = GetCurrentProcessAndThreadIDs(sequence_mutex_unavailable);
728       if (!ids.empty() && !sequence_mutex_unavailable) {
729         // If server returned an explicit PID, use that.
730         m_curr_pid_run = m_curr_pid = ids.front().first;
731         // Otherwise, use the TID of the first thread (Linux hack).
732         if (m_curr_pid == LLDB_INVALID_PROCESS_ID)
733           m_curr_pid_run = m_curr_pid = ids.front().second;
734         m_curr_pid_is_valid = eLazyBoolYes;
735         return m_curr_pid;
736       }
737     }
738   }
739 
740   return LLDB_INVALID_PROCESS_ID;
741 }
742 
743 bool GDBRemoteCommunicationClient::GetLaunchSuccess(std::string &error_str) {
744   error_str.clear();
745   StringExtractorGDBRemote response;
746   if (SendPacketAndWaitForResponse("qLaunchSuccess", response) ==
747       PacketResult::Success) {
748     if (response.IsOKResponse())
749       return true;
750     // GDB does not implement qLaunchSuccess -- but if we used vRun,
751     // then we already received a successful launch indication via stop
752     // reason.
753     if (response.IsUnsupportedResponse() && m_supports_vRun)
754       return true;
755     if (response.GetChar() == 'E') {
756       // A string the describes what failed when launching...
757       error_str = std::string(response.GetStringRef().substr(1));
758     } else {
759       error_str.assign("unknown error occurred launching process");
760     }
761   } else {
762     error_str.assign("timed out waiting for app to launch");
763   }
764   return false;
765 }
766 
767 int GDBRemoteCommunicationClient::SendArgumentsPacket(
768     const ProcessLaunchInfo &launch_info) {
769   // Since we don't get the send argv0 separate from the executable path, we
770   // need to make sure to use the actual executable path found in the
771   // launch_info...
772   std::vector<const char *> argv;
773   FileSpec exe_file = launch_info.GetExecutableFile();
774   std::string exe_path;
775   const char *arg = nullptr;
776   const Args &launch_args = launch_info.GetArguments();
777   if (exe_file)
778     exe_path = exe_file.GetPath(false);
779   else {
780     arg = launch_args.GetArgumentAtIndex(0);
781     if (arg)
782       exe_path = arg;
783   }
784   if (!exe_path.empty()) {
785     argv.push_back(exe_path.c_str());
786     for (uint32_t i = 1; (arg = launch_args.GetArgumentAtIndex(i)) != nullptr;
787          ++i) {
788       if (arg)
789         argv.push_back(arg);
790     }
791   }
792   if (!argv.empty()) {
793     // try vRun first
794     if (m_supports_vRun) {
795       StreamString packet;
796       packet.PutCString("vRun");
797       for (const char *arg : argv) {
798         packet.PutChar(';');
799         packet.PutBytesAsRawHex8(arg, strlen(arg));
800       }
801 
802       StringExtractorGDBRemote response;
803       if (SendPacketAndWaitForResponse(packet.GetString(), response) !=
804           PacketResult::Success)
805         return -1;
806 
807       if (response.IsErrorResponse()) {
808         uint8_t error = response.GetError();
809         if (error)
810           return error;
811         return -1;
812       }
813       // vRun replies with a stop reason packet
814       // FIXME: right now we just discard the packet and LLDB queries
815       // for stop reason again
816       if (!response.IsUnsupportedResponse())
817         return 0;
818 
819       m_supports_vRun = false;
820     }
821 
822     // fallback to A
823     StreamString packet;
824     packet.PutChar('A');
825     for (size_t i = 0, n = argv.size(); i < n; ++i) {
826       arg = argv[i];
827       const int arg_len = strlen(arg);
828       if (i > 0)
829         packet.PutChar(',');
830       packet.Printf("%i,%i,", arg_len * 2, (int)i);
831       packet.PutBytesAsRawHex8(arg, arg_len);
832     }
833 
834     StringExtractorGDBRemote response;
835     if (SendPacketAndWaitForResponse(packet.GetString(), response) ==
836         PacketResult::Success) {
837       if (response.IsOKResponse())
838         return 0;
839       uint8_t error = response.GetError();
840       if (error)
841         return error;
842     }
843   }
844   return -1;
845 }
846 
847 int GDBRemoteCommunicationClient::SendEnvironment(const Environment &env) {
848   for (const auto &KV : env) {
849     int r = SendEnvironmentPacket(Environment::compose(KV).c_str());
850     if (r != 0)
851       return r;
852   }
853   return 0;
854 }
855 
856 int GDBRemoteCommunicationClient::SendEnvironmentPacket(
857     char const *name_equal_value) {
858   if (name_equal_value && name_equal_value[0]) {
859     bool send_hex_encoding = false;
860     for (const char *p = name_equal_value; *p != '\0' && !send_hex_encoding;
861          ++p) {
862       if (llvm::isPrint(*p)) {
863         switch (*p) {
864         case '$':
865         case '#':
866         case '*':
867         case '}':
868           send_hex_encoding = true;
869           break;
870         default:
871           break;
872         }
873       } else {
874         // We have non printable characters, lets hex encode this...
875         send_hex_encoding = true;
876       }
877     }
878 
879     StringExtractorGDBRemote response;
880     // Prefer sending unencoded, if possible and the server supports it.
881     if (!send_hex_encoding && m_supports_QEnvironment) {
882       StreamString packet;
883       packet.Printf("QEnvironment:%s", name_equal_value);
884       if (SendPacketAndWaitForResponse(packet.GetString(), response) !=
885           PacketResult::Success)
886         return -1;
887 
888       if (response.IsOKResponse())
889         return 0;
890       if (response.IsUnsupportedResponse())
891         m_supports_QEnvironment = false;
892       else {
893         uint8_t error = response.GetError();
894         if (error)
895           return error;
896         return -1;
897       }
898     }
899 
900     if (m_supports_QEnvironmentHexEncoded) {
901       StreamString packet;
902       packet.PutCString("QEnvironmentHexEncoded:");
903       packet.PutBytesAsRawHex8(name_equal_value, strlen(name_equal_value));
904       if (SendPacketAndWaitForResponse(packet.GetString(), response) !=
905           PacketResult::Success)
906         return -1;
907 
908       if (response.IsOKResponse())
909         return 0;
910       if (response.IsUnsupportedResponse())
911         m_supports_QEnvironmentHexEncoded = false;
912       else {
913         uint8_t error = response.GetError();
914         if (error)
915           return error;
916         return -1;
917       }
918     }
919   }
920   return -1;
921 }
922 
923 int GDBRemoteCommunicationClient::SendLaunchArchPacket(char const *arch) {
924   if (arch && arch[0]) {
925     StreamString packet;
926     packet.Printf("QLaunchArch:%s", arch);
927     StringExtractorGDBRemote response;
928     if (SendPacketAndWaitForResponse(packet.GetString(), response) ==
929         PacketResult::Success) {
930       if (response.IsOKResponse())
931         return 0;
932       uint8_t error = response.GetError();
933       if (error)
934         return error;
935     }
936   }
937   return -1;
938 }
939 
940 int GDBRemoteCommunicationClient::SendLaunchEventDataPacket(
941     char const *data, bool *was_supported) {
942   if (data && *data != '\0') {
943     StreamString packet;
944     packet.Printf("QSetProcessEvent:%s", data);
945     StringExtractorGDBRemote response;
946     if (SendPacketAndWaitForResponse(packet.GetString(), response) ==
947         PacketResult::Success) {
948       if (response.IsOKResponse()) {
949         if (was_supported)
950           *was_supported = true;
951         return 0;
952       } else if (response.IsUnsupportedResponse()) {
953         if (was_supported)
954           *was_supported = false;
955         return -1;
956       } else {
957         uint8_t error = response.GetError();
958         if (was_supported)
959           *was_supported = true;
960         if (error)
961           return error;
962       }
963     }
964   }
965   return -1;
966 }
967 
968 llvm::VersionTuple GDBRemoteCommunicationClient::GetOSVersion() {
969   GetHostInfo();
970   return m_os_version;
971 }
972 
973 llvm::VersionTuple GDBRemoteCommunicationClient::GetMacCatalystVersion() {
974   GetHostInfo();
975   return m_maccatalyst_version;
976 }
977 
978 llvm::Optional<std::string> GDBRemoteCommunicationClient::GetOSBuildString() {
979   if (GetHostInfo()) {
980     if (!m_os_build.empty())
981       return m_os_build;
982   }
983   return llvm::None;
984 }
985 
986 llvm::Optional<std::string>
987 GDBRemoteCommunicationClient::GetOSKernelDescription() {
988   if (GetHostInfo()) {
989     if (!m_os_kernel.empty())
990       return m_os_kernel;
991   }
992   return llvm::None;
993 }
994 
995 bool GDBRemoteCommunicationClient::GetHostname(std::string &s) {
996   if (GetHostInfo()) {
997     if (!m_hostname.empty()) {
998       s = m_hostname;
999       return true;
1000     }
1001   }
1002   s.clear();
1003   return false;
1004 }
1005 
1006 ArchSpec GDBRemoteCommunicationClient::GetSystemArchitecture() {
1007   if (GetHostInfo())
1008     return m_host_arch;
1009   return ArchSpec();
1010 }
1011 
1012 const lldb_private::ArchSpec &
1013 GDBRemoteCommunicationClient::GetProcessArchitecture() {
1014   if (m_qProcessInfo_is_valid == eLazyBoolCalculate)
1015     GetCurrentProcessInfo();
1016   return m_process_arch;
1017 }
1018 
1019 bool GDBRemoteCommunicationClient::GetProcessStandaloneBinary(
1020     UUID &uuid, addr_t &value, bool &value_is_offset) {
1021   if (m_qProcessInfo_is_valid == eLazyBoolCalculate)
1022     GetCurrentProcessInfo();
1023 
1024   // Return true if we have a UUID or an address/offset of the
1025   // main standalone / firmware binary being used.
1026   if (!m_process_standalone_uuid.IsValid() &&
1027       m_process_standalone_value == LLDB_INVALID_ADDRESS)
1028     return false;
1029 
1030   uuid = m_process_standalone_uuid;
1031   value = m_process_standalone_value;
1032   value_is_offset = m_process_standalone_value_is_offset;
1033   return true;
1034 }
1035 
1036 bool GDBRemoteCommunicationClient::GetGDBServerVersion() {
1037   if (m_qGDBServerVersion_is_valid == eLazyBoolCalculate) {
1038     m_gdb_server_name.clear();
1039     m_gdb_server_version = 0;
1040     m_qGDBServerVersion_is_valid = eLazyBoolNo;
1041 
1042     StringExtractorGDBRemote response;
1043     if (SendPacketAndWaitForResponse("qGDBServerVersion", response) ==
1044         PacketResult::Success) {
1045       if (response.IsNormalResponse()) {
1046         llvm::StringRef name, value;
1047         bool success = false;
1048         while (response.GetNameColonValue(name, value)) {
1049           if (name.equals("name")) {
1050             success = true;
1051             m_gdb_server_name = std::string(value);
1052           } else if (name.equals("version")) {
1053             llvm::StringRef major, minor;
1054             std::tie(major, minor) = value.split('.');
1055             if (!major.getAsInteger(0, m_gdb_server_version))
1056               success = true;
1057           }
1058         }
1059         if (success)
1060           m_qGDBServerVersion_is_valid = eLazyBoolYes;
1061       }
1062     }
1063   }
1064   return m_qGDBServerVersion_is_valid == eLazyBoolYes;
1065 }
1066 
1067 void GDBRemoteCommunicationClient::MaybeEnableCompression(
1068     llvm::ArrayRef<llvm::StringRef> supported_compressions) {
1069   CompressionType avail_type = CompressionType::None;
1070   llvm::StringRef avail_name;
1071 
1072 #if defined(HAVE_LIBCOMPRESSION)
1073   if (avail_type == CompressionType::None) {
1074     for (auto compression : supported_compressions) {
1075       if (compression == "lzfse") {
1076         avail_type = CompressionType::LZFSE;
1077         avail_name = compression;
1078         break;
1079       }
1080     }
1081   }
1082 #endif
1083 
1084 #if defined(HAVE_LIBCOMPRESSION)
1085   if (avail_type == CompressionType::None) {
1086     for (auto compression : supported_compressions) {
1087       if (compression == "zlib-deflate") {
1088         avail_type = CompressionType::ZlibDeflate;
1089         avail_name = compression;
1090         break;
1091       }
1092     }
1093   }
1094 #endif
1095 
1096 #if LLVM_ENABLE_ZLIB
1097   if (avail_type == CompressionType::None) {
1098     for (auto compression : supported_compressions) {
1099       if (compression == "zlib-deflate") {
1100         avail_type = CompressionType::ZlibDeflate;
1101         avail_name = compression;
1102         break;
1103       }
1104     }
1105   }
1106 #endif
1107 
1108 #if defined(HAVE_LIBCOMPRESSION)
1109   if (avail_type == CompressionType::None) {
1110     for (auto compression : supported_compressions) {
1111       if (compression == "lz4") {
1112         avail_type = CompressionType::LZ4;
1113         avail_name = compression;
1114         break;
1115       }
1116     }
1117   }
1118 #endif
1119 
1120 #if defined(HAVE_LIBCOMPRESSION)
1121   if (avail_type == CompressionType::None) {
1122     for (auto compression : supported_compressions) {
1123       if (compression == "lzma") {
1124         avail_type = CompressionType::LZMA;
1125         avail_name = compression;
1126         break;
1127       }
1128     }
1129   }
1130 #endif
1131 
1132   if (avail_type != CompressionType::None) {
1133     StringExtractorGDBRemote response;
1134     std::string packet = "QEnableCompression:type:" + avail_name.str() + ";";
1135     if (SendPacketAndWaitForResponse(packet, response) != PacketResult::Success)
1136       return;
1137 
1138     if (response.IsOKResponse()) {
1139       m_compression_type = avail_type;
1140     }
1141   }
1142 }
1143 
1144 const char *GDBRemoteCommunicationClient::GetGDBServerProgramName() {
1145   if (GetGDBServerVersion()) {
1146     if (!m_gdb_server_name.empty())
1147       return m_gdb_server_name.c_str();
1148   }
1149   return nullptr;
1150 }
1151 
1152 uint32_t GDBRemoteCommunicationClient::GetGDBServerProgramVersion() {
1153   if (GetGDBServerVersion())
1154     return m_gdb_server_version;
1155   return 0;
1156 }
1157 
1158 bool GDBRemoteCommunicationClient::GetDefaultThreadId(lldb::tid_t &tid) {
1159   StringExtractorGDBRemote response;
1160   if (SendPacketAndWaitForResponse("qC", response) != PacketResult::Success)
1161     return false;
1162 
1163   if (!response.IsNormalResponse())
1164     return false;
1165 
1166   if (response.GetChar() == 'Q' && response.GetChar() == 'C') {
1167     auto pid_tid = response.GetPidTid(0);
1168     if (!pid_tid)
1169       return false;
1170 
1171     lldb::pid_t pid = pid_tid->first;
1172     // invalid
1173     if (pid == StringExtractorGDBRemote::AllProcesses)
1174       return false;
1175 
1176     // if we get pid as well, update m_curr_pid
1177     if (pid != 0) {
1178       m_curr_pid_run = m_curr_pid = pid;
1179       m_curr_pid_is_valid = eLazyBoolYes;
1180     }
1181     tid = pid_tid->second;
1182   }
1183 
1184   return true;
1185 }
1186 
1187 static void ParseOSType(llvm::StringRef value, std::string &os_name,
1188                         std::string &environment) {
1189   if (value.equals("iossimulator") || value.equals("tvossimulator") ||
1190       value.equals("watchossimulator")) {
1191     environment = "simulator";
1192     os_name = value.drop_back(environment.size()).str();
1193   } else if (value.equals("maccatalyst")) {
1194     os_name = "ios";
1195     environment = "macabi";
1196   } else {
1197     os_name = value.str();
1198   }
1199 }
1200 
1201 bool GDBRemoteCommunicationClient::GetHostInfo(bool force) {
1202   Log *log = GetLog(GDBRLog::Process);
1203 
1204   if (force || m_qHostInfo_is_valid == eLazyBoolCalculate) {
1205     // host info computation can require DNS traffic and shelling out to external processes.
1206     // Increase the timeout to account for that.
1207     ScopedTimeout timeout(*this, seconds(10));
1208     m_qHostInfo_is_valid = eLazyBoolNo;
1209     StringExtractorGDBRemote response;
1210     if (SendPacketAndWaitForResponse("qHostInfo", response) ==
1211         PacketResult::Success) {
1212       if (response.IsNormalResponse()) {
1213         llvm::StringRef name;
1214         llvm::StringRef value;
1215         uint32_t cpu = LLDB_INVALID_CPUTYPE;
1216         uint32_t sub = 0;
1217         std::string arch_name;
1218         std::string os_name;
1219         std::string environment;
1220         std::string vendor_name;
1221         std::string triple;
1222         std::string distribution_id;
1223         uint32_t pointer_byte_size = 0;
1224         ByteOrder byte_order = eByteOrderInvalid;
1225         uint32_t num_keys_decoded = 0;
1226         while (response.GetNameColonValue(name, value)) {
1227           if (name.equals("cputype")) {
1228             // exception type in big endian hex
1229             if (!value.getAsInteger(0, cpu))
1230               ++num_keys_decoded;
1231           } else if (name.equals("cpusubtype")) {
1232             // exception count in big endian hex
1233             if (!value.getAsInteger(0, sub))
1234               ++num_keys_decoded;
1235           } else if (name.equals("arch")) {
1236             arch_name = std::string(value);
1237             ++num_keys_decoded;
1238           } else if (name.equals("triple")) {
1239             StringExtractor extractor(value);
1240             extractor.GetHexByteString(triple);
1241             ++num_keys_decoded;
1242           } else if (name.equals("distribution_id")) {
1243             StringExtractor extractor(value);
1244             extractor.GetHexByteString(distribution_id);
1245             ++num_keys_decoded;
1246           } else if (name.equals("os_build")) {
1247             StringExtractor extractor(value);
1248             extractor.GetHexByteString(m_os_build);
1249             ++num_keys_decoded;
1250           } else if (name.equals("hostname")) {
1251             StringExtractor extractor(value);
1252             extractor.GetHexByteString(m_hostname);
1253             ++num_keys_decoded;
1254           } else if (name.equals("os_kernel")) {
1255             StringExtractor extractor(value);
1256             extractor.GetHexByteString(m_os_kernel);
1257             ++num_keys_decoded;
1258           } else if (name.equals("ostype")) {
1259             ParseOSType(value, os_name, environment);
1260             ++num_keys_decoded;
1261           } else if (name.equals("vendor")) {
1262             vendor_name = std::string(value);
1263             ++num_keys_decoded;
1264           } else if (name.equals("endian")) {
1265             byte_order = llvm::StringSwitch<lldb::ByteOrder>(value)
1266                              .Case("little", eByteOrderLittle)
1267                              .Case("big", eByteOrderBig)
1268                              .Case("pdp", eByteOrderPDP)
1269                              .Default(eByteOrderInvalid);
1270             if (byte_order != eByteOrderInvalid)
1271               ++num_keys_decoded;
1272           } else if (name.equals("ptrsize")) {
1273             if (!value.getAsInteger(0, pointer_byte_size))
1274               ++num_keys_decoded;
1275           } else if (name.equals("addressing_bits")) {
1276             if (!value.getAsInteger(0, m_addressing_bits))
1277               ++num_keys_decoded;
1278           } else if (name.equals("os_version") ||
1279                      name.equals("version")) // Older debugserver binaries used
1280                                              // the "version" key instead of
1281                                              // "os_version"...
1282           {
1283             if (!m_os_version.tryParse(value))
1284               ++num_keys_decoded;
1285           } else if (name.equals("maccatalyst_version")) {
1286             if (!m_maccatalyst_version.tryParse(value))
1287               ++num_keys_decoded;
1288           } else if (name.equals("watchpoint_exceptions_received")) {
1289             m_watchpoints_trigger_after_instruction =
1290                 llvm::StringSwitch<LazyBool>(value)
1291                     .Case("before", eLazyBoolNo)
1292                     .Case("after", eLazyBoolYes)
1293                     .Default(eLazyBoolCalculate);
1294             if (m_watchpoints_trigger_after_instruction != eLazyBoolCalculate)
1295               ++num_keys_decoded;
1296           } else if (name.equals("default_packet_timeout")) {
1297             uint32_t timeout_seconds;
1298             if (!value.getAsInteger(0, timeout_seconds)) {
1299               m_default_packet_timeout = seconds(timeout_seconds);
1300               SetPacketTimeout(m_default_packet_timeout);
1301               ++num_keys_decoded;
1302             }
1303           } else if (name.equals("vm-page-size")) {
1304             int page_size;
1305             if (!value.getAsInteger(0, page_size)) {
1306               m_target_vm_page_size = page_size;
1307               ++num_keys_decoded;
1308             }
1309           }
1310         }
1311 
1312         if (num_keys_decoded > 0)
1313           m_qHostInfo_is_valid = eLazyBoolYes;
1314 
1315         if (triple.empty()) {
1316           if (arch_name.empty()) {
1317             if (cpu != LLDB_INVALID_CPUTYPE) {
1318               m_host_arch.SetArchitecture(eArchTypeMachO, cpu, sub);
1319               if (pointer_byte_size) {
1320                 assert(pointer_byte_size == m_host_arch.GetAddressByteSize());
1321               }
1322               if (byte_order != eByteOrderInvalid) {
1323                 assert(byte_order == m_host_arch.GetByteOrder());
1324               }
1325 
1326               if (!vendor_name.empty())
1327                 m_host_arch.GetTriple().setVendorName(
1328                     llvm::StringRef(vendor_name));
1329               if (!os_name.empty())
1330                 m_host_arch.GetTriple().setOSName(llvm::StringRef(os_name));
1331               if (!environment.empty())
1332                 m_host_arch.GetTriple().setEnvironmentName(environment);
1333             }
1334           } else {
1335             std::string triple;
1336             triple += arch_name;
1337             if (!vendor_name.empty() || !os_name.empty()) {
1338               triple += '-';
1339               if (vendor_name.empty())
1340                 triple += "unknown";
1341               else
1342                 triple += vendor_name;
1343               triple += '-';
1344               if (os_name.empty())
1345                 triple += "unknown";
1346               else
1347                 triple += os_name;
1348             }
1349             m_host_arch.SetTriple(triple.c_str());
1350 
1351             llvm::Triple &host_triple = m_host_arch.GetTriple();
1352             if (host_triple.getVendor() == llvm::Triple::Apple &&
1353                 host_triple.getOS() == llvm::Triple::Darwin) {
1354               switch (m_host_arch.GetMachine()) {
1355               case llvm::Triple::aarch64:
1356               case llvm::Triple::aarch64_32:
1357               case llvm::Triple::arm:
1358               case llvm::Triple::thumb:
1359                 host_triple.setOS(llvm::Triple::IOS);
1360                 break;
1361               default:
1362                 host_triple.setOS(llvm::Triple::MacOSX);
1363                 break;
1364               }
1365             }
1366             if (pointer_byte_size) {
1367               assert(pointer_byte_size == m_host_arch.GetAddressByteSize());
1368             }
1369             if (byte_order != eByteOrderInvalid) {
1370               assert(byte_order == m_host_arch.GetByteOrder());
1371             }
1372           }
1373         } else {
1374           m_host_arch.SetTriple(triple.c_str());
1375           if (pointer_byte_size) {
1376             assert(pointer_byte_size == m_host_arch.GetAddressByteSize());
1377           }
1378           if (byte_order != eByteOrderInvalid) {
1379             assert(byte_order == m_host_arch.GetByteOrder());
1380           }
1381 
1382           LLDB_LOGF(log,
1383                     "GDBRemoteCommunicationClient::%s parsed host "
1384                     "architecture as %s, triple as %s from triple text %s",
1385                     __FUNCTION__,
1386                     m_host_arch.GetArchitectureName()
1387                         ? m_host_arch.GetArchitectureName()
1388                         : "<null-arch-name>",
1389                     m_host_arch.GetTriple().getTriple().c_str(),
1390                     triple.c_str());
1391         }
1392         if (!distribution_id.empty())
1393           m_host_arch.SetDistributionId(distribution_id.c_str());
1394       }
1395     }
1396   }
1397   return m_qHostInfo_is_valid == eLazyBoolYes;
1398 }
1399 
1400 int GDBRemoteCommunicationClient::SendStdinNotification(const char *data,
1401                                                         size_t data_len) {
1402   StreamString packet;
1403   packet.PutCString("I");
1404   packet.PutBytesAsRawHex8(data, data_len);
1405   StringExtractorGDBRemote response;
1406   if (SendPacketAndWaitForResponse(packet.GetString(), response) ==
1407       PacketResult::Success) {
1408     return 0;
1409   }
1410   return response.GetError();
1411 }
1412 
1413 const lldb_private::ArchSpec &
1414 GDBRemoteCommunicationClient::GetHostArchitecture() {
1415   if (m_qHostInfo_is_valid == eLazyBoolCalculate)
1416     GetHostInfo();
1417   return m_host_arch;
1418 }
1419 
1420 uint32_t GDBRemoteCommunicationClient::GetAddressingBits() {
1421   if (m_qHostInfo_is_valid == eLazyBoolCalculate)
1422     GetHostInfo();
1423   return m_addressing_bits;
1424 }
1425 seconds GDBRemoteCommunicationClient::GetHostDefaultPacketTimeout() {
1426   if (m_qHostInfo_is_valid == eLazyBoolCalculate)
1427     GetHostInfo();
1428   return m_default_packet_timeout;
1429 }
1430 
1431 addr_t GDBRemoteCommunicationClient::AllocateMemory(size_t size,
1432                                                     uint32_t permissions) {
1433   if (m_supports_alloc_dealloc_memory != eLazyBoolNo) {
1434     m_supports_alloc_dealloc_memory = eLazyBoolYes;
1435     char packet[64];
1436     const int packet_len = ::snprintf(
1437         packet, sizeof(packet), "_M%" PRIx64 ",%s%s%s", (uint64_t)size,
1438         permissions & lldb::ePermissionsReadable ? "r" : "",
1439         permissions & lldb::ePermissionsWritable ? "w" : "",
1440         permissions & lldb::ePermissionsExecutable ? "x" : "");
1441     assert(packet_len < (int)sizeof(packet));
1442     UNUSED_IF_ASSERT_DISABLED(packet_len);
1443     StringExtractorGDBRemote response;
1444     if (SendPacketAndWaitForResponse(packet, response) ==
1445         PacketResult::Success) {
1446       if (response.IsUnsupportedResponse())
1447         m_supports_alloc_dealloc_memory = eLazyBoolNo;
1448       else if (!response.IsErrorResponse())
1449         return response.GetHexMaxU64(false, LLDB_INVALID_ADDRESS);
1450     } else {
1451       m_supports_alloc_dealloc_memory = eLazyBoolNo;
1452     }
1453   }
1454   return LLDB_INVALID_ADDRESS;
1455 }
1456 
1457 bool GDBRemoteCommunicationClient::DeallocateMemory(addr_t addr) {
1458   if (m_supports_alloc_dealloc_memory != eLazyBoolNo) {
1459     m_supports_alloc_dealloc_memory = eLazyBoolYes;
1460     char packet[64];
1461     const int packet_len =
1462         ::snprintf(packet, sizeof(packet), "_m%" PRIx64, (uint64_t)addr);
1463     assert(packet_len < (int)sizeof(packet));
1464     UNUSED_IF_ASSERT_DISABLED(packet_len);
1465     StringExtractorGDBRemote response;
1466     if (SendPacketAndWaitForResponse(packet, response) ==
1467         PacketResult::Success) {
1468       if (response.IsUnsupportedResponse())
1469         m_supports_alloc_dealloc_memory = eLazyBoolNo;
1470       else if (response.IsOKResponse())
1471         return true;
1472     } else {
1473       m_supports_alloc_dealloc_memory = eLazyBoolNo;
1474     }
1475   }
1476   return false;
1477 }
1478 
1479 Status GDBRemoteCommunicationClient::Detach(bool keep_stopped,
1480                                             lldb::pid_t pid) {
1481   Status error;
1482   lldb_private::StreamString packet;
1483 
1484   packet.PutChar('D');
1485   if (keep_stopped) {
1486     if (m_supports_detach_stay_stopped == eLazyBoolCalculate) {
1487       char packet[64];
1488       const int packet_len =
1489           ::snprintf(packet, sizeof(packet), "qSupportsDetachAndStayStopped:");
1490       assert(packet_len < (int)sizeof(packet));
1491       UNUSED_IF_ASSERT_DISABLED(packet_len);
1492       StringExtractorGDBRemote response;
1493       if (SendPacketAndWaitForResponse(packet, response) ==
1494               PacketResult::Success &&
1495           response.IsOKResponse()) {
1496         m_supports_detach_stay_stopped = eLazyBoolYes;
1497       } else {
1498         m_supports_detach_stay_stopped = eLazyBoolNo;
1499       }
1500     }
1501 
1502     if (m_supports_detach_stay_stopped == eLazyBoolNo) {
1503       error.SetErrorString("Stays stopped not supported by this target.");
1504       return error;
1505     } else {
1506       packet.PutChar('1');
1507     }
1508   }
1509 
1510   if (m_supports_multiprocess) {
1511     // Some servers (e.g. qemu) require specifying the PID even if only a single
1512     // process is running.
1513     if (pid == LLDB_INVALID_PROCESS_ID)
1514       pid = GetCurrentProcessID();
1515     packet.PutChar(';');
1516     packet.PutHex64(pid);
1517   } else if (pid != LLDB_INVALID_PROCESS_ID) {
1518     error.SetErrorString("Multiprocess extension not supported by the server.");
1519     return error;
1520   }
1521 
1522   StringExtractorGDBRemote response;
1523   PacketResult packet_result =
1524       SendPacketAndWaitForResponse(packet.GetString(), response);
1525   if (packet_result != PacketResult::Success)
1526     error.SetErrorString("Sending isconnect packet failed.");
1527   return error;
1528 }
1529 
1530 Status GDBRemoteCommunicationClient::GetMemoryRegionInfo(
1531     lldb::addr_t addr, lldb_private::MemoryRegionInfo &region_info) {
1532   Status error;
1533   region_info.Clear();
1534 
1535   if (m_supports_memory_region_info != eLazyBoolNo) {
1536     m_supports_memory_region_info = eLazyBoolYes;
1537     char packet[64];
1538     const int packet_len = ::snprintf(
1539         packet, sizeof(packet), "qMemoryRegionInfo:%" PRIx64, (uint64_t)addr);
1540     assert(packet_len < (int)sizeof(packet));
1541     UNUSED_IF_ASSERT_DISABLED(packet_len);
1542     StringExtractorGDBRemote response;
1543     if (SendPacketAndWaitForResponse(packet, response) ==
1544             PacketResult::Success &&
1545         response.GetResponseType() == StringExtractorGDBRemote::eResponse) {
1546       llvm::StringRef name;
1547       llvm::StringRef value;
1548       addr_t addr_value = LLDB_INVALID_ADDRESS;
1549       bool success = true;
1550       bool saw_permissions = false;
1551       while (success && response.GetNameColonValue(name, value)) {
1552         if (name.equals("start")) {
1553           if (!value.getAsInteger(16, addr_value))
1554             region_info.GetRange().SetRangeBase(addr_value);
1555         } else if (name.equals("size")) {
1556           if (!value.getAsInteger(16, addr_value))
1557             region_info.GetRange().SetByteSize(addr_value);
1558         } else if (name.equals("permissions") &&
1559                    region_info.GetRange().IsValid()) {
1560           saw_permissions = true;
1561           if (region_info.GetRange().Contains(addr)) {
1562             if (value.contains('r'))
1563               region_info.SetReadable(MemoryRegionInfo::eYes);
1564             else
1565               region_info.SetReadable(MemoryRegionInfo::eNo);
1566 
1567             if (value.contains('w'))
1568               region_info.SetWritable(MemoryRegionInfo::eYes);
1569             else
1570               region_info.SetWritable(MemoryRegionInfo::eNo);
1571 
1572             if (value.contains('x'))
1573               region_info.SetExecutable(MemoryRegionInfo::eYes);
1574             else
1575               region_info.SetExecutable(MemoryRegionInfo::eNo);
1576 
1577             region_info.SetMapped(MemoryRegionInfo::eYes);
1578           } else {
1579             // The reported region does not contain this address -- we're
1580             // looking at an unmapped page
1581             region_info.SetReadable(MemoryRegionInfo::eNo);
1582             region_info.SetWritable(MemoryRegionInfo::eNo);
1583             region_info.SetExecutable(MemoryRegionInfo::eNo);
1584             region_info.SetMapped(MemoryRegionInfo::eNo);
1585           }
1586         } else if (name.equals("name")) {
1587           StringExtractorGDBRemote name_extractor(value);
1588           std::string name;
1589           name_extractor.GetHexByteString(name);
1590           region_info.SetName(name.c_str());
1591         } else if (name.equals("flags")) {
1592           region_info.SetMemoryTagged(MemoryRegionInfo::eNo);
1593 
1594           llvm::StringRef flags = value;
1595           llvm::StringRef flag;
1596           while (flags.size()) {
1597             flags = flags.ltrim();
1598             std::tie(flag, flags) = flags.split(' ');
1599             // To account for trailing whitespace
1600             if (flag.size()) {
1601               if (flag == "mt") {
1602                 region_info.SetMemoryTagged(MemoryRegionInfo::eYes);
1603                 break;
1604               }
1605             }
1606           }
1607         } else if (name.equals("type")) {
1608           std::string comma_sep_str = value.str();
1609           size_t comma_pos;
1610           while ((comma_pos = comma_sep_str.find(',')) != std::string::npos) {
1611             comma_sep_str[comma_pos] = '\0';
1612             if (comma_sep_str == "stack") {
1613               region_info.SetIsStackMemory(MemoryRegionInfo::eYes);
1614             }
1615           }
1616           // handle final (or only) type of "stack"
1617           if (comma_sep_str == "stack") {
1618             region_info.SetIsStackMemory(MemoryRegionInfo::eYes);
1619           }
1620         } else if (name.equals("error")) {
1621           StringExtractorGDBRemote error_extractor(value);
1622           std::string error_string;
1623           // Now convert the HEX bytes into a string value
1624           error_extractor.GetHexByteString(error_string);
1625           error.SetErrorString(error_string.c_str());
1626         } else if (name.equals("dirty-pages")) {
1627           std::vector<addr_t> dirty_page_list;
1628           for (llvm::StringRef x : llvm::split(value, ',')) {
1629             addr_t page;
1630             x.consume_front("0x");
1631             if (llvm::to_integer(x, page, 16))
1632               dirty_page_list.push_back(page);
1633           }
1634           region_info.SetDirtyPageList(dirty_page_list);
1635         }
1636       }
1637 
1638       if (m_target_vm_page_size != 0)
1639         region_info.SetPageSize(m_target_vm_page_size);
1640 
1641       if (region_info.GetRange().IsValid()) {
1642         // We got a valid address range back but no permissions -- which means
1643         // this is an unmapped page
1644         if (!saw_permissions) {
1645           region_info.SetReadable(MemoryRegionInfo::eNo);
1646           region_info.SetWritable(MemoryRegionInfo::eNo);
1647           region_info.SetExecutable(MemoryRegionInfo::eNo);
1648           region_info.SetMapped(MemoryRegionInfo::eNo);
1649         }
1650       } else {
1651         // We got an invalid address range back
1652         error.SetErrorString("Server returned invalid range");
1653       }
1654     } else {
1655       m_supports_memory_region_info = eLazyBoolNo;
1656     }
1657   }
1658 
1659   if (m_supports_memory_region_info == eLazyBoolNo) {
1660     error.SetErrorString("qMemoryRegionInfo is not supported");
1661   }
1662 
1663   // Try qXfer:memory-map:read to get region information not included in
1664   // qMemoryRegionInfo
1665   MemoryRegionInfo qXfer_region_info;
1666   Status qXfer_error = GetQXferMemoryMapRegionInfo(addr, qXfer_region_info);
1667 
1668   if (error.Fail()) {
1669     // If qMemoryRegionInfo failed, but qXfer:memory-map:read succeeded, use
1670     // the qXfer result as a fallback
1671     if (qXfer_error.Success()) {
1672       region_info = qXfer_region_info;
1673       error.Clear();
1674     } else {
1675       region_info.Clear();
1676     }
1677   } else if (qXfer_error.Success()) {
1678     // If both qMemoryRegionInfo and qXfer:memory-map:read succeeded, and if
1679     // both regions are the same range, update the result to include the flash-
1680     // memory information that is specific to the qXfer result.
1681     if (region_info.GetRange() == qXfer_region_info.GetRange()) {
1682       region_info.SetFlash(qXfer_region_info.GetFlash());
1683       region_info.SetBlocksize(qXfer_region_info.GetBlocksize());
1684     }
1685   }
1686   return error;
1687 }
1688 
1689 Status GDBRemoteCommunicationClient::GetQXferMemoryMapRegionInfo(
1690     lldb::addr_t addr, MemoryRegionInfo &region) {
1691   Status error = LoadQXferMemoryMap();
1692   if (!error.Success())
1693     return error;
1694   for (const auto &map_region : m_qXfer_memory_map) {
1695     if (map_region.GetRange().Contains(addr)) {
1696       region = map_region;
1697       return error;
1698     }
1699   }
1700   error.SetErrorString("Region not found");
1701   return error;
1702 }
1703 
1704 Status GDBRemoteCommunicationClient::LoadQXferMemoryMap() {
1705 
1706   Status error;
1707 
1708   if (m_qXfer_memory_map_loaded)
1709     // Already loaded, return success
1710     return error;
1711 
1712   if (!XMLDocument::XMLEnabled()) {
1713     error.SetErrorString("XML is not supported");
1714     return error;
1715   }
1716 
1717   if (!GetQXferMemoryMapReadSupported()) {
1718     error.SetErrorString("Memory map is not supported");
1719     return error;
1720   }
1721 
1722   llvm::Expected<std::string> xml = ReadExtFeature("memory-map", "");
1723   if (!xml)
1724     return Status(xml.takeError());
1725 
1726   XMLDocument xml_document;
1727 
1728   if (!xml_document.ParseMemory(xml->c_str(), xml->size())) {
1729     error.SetErrorString("Failed to parse memory map xml");
1730     return error;
1731   }
1732 
1733   XMLNode map_node = xml_document.GetRootElement("memory-map");
1734   if (!map_node) {
1735     error.SetErrorString("Invalid root node in memory map xml");
1736     return error;
1737   }
1738 
1739   m_qXfer_memory_map.clear();
1740 
1741   map_node.ForEachChildElement([this](const XMLNode &memory_node) -> bool {
1742     if (!memory_node.IsElement())
1743       return true;
1744     if (memory_node.GetName() != "memory")
1745       return true;
1746     auto type = memory_node.GetAttributeValue("type", "");
1747     uint64_t start;
1748     uint64_t length;
1749     if (!memory_node.GetAttributeValueAsUnsigned("start", start))
1750       return true;
1751     if (!memory_node.GetAttributeValueAsUnsigned("length", length))
1752       return true;
1753     MemoryRegionInfo region;
1754     region.GetRange().SetRangeBase(start);
1755     region.GetRange().SetByteSize(length);
1756     if (type == "rom") {
1757       region.SetReadable(MemoryRegionInfo::eYes);
1758       this->m_qXfer_memory_map.push_back(region);
1759     } else if (type == "ram") {
1760       region.SetReadable(MemoryRegionInfo::eYes);
1761       region.SetWritable(MemoryRegionInfo::eYes);
1762       this->m_qXfer_memory_map.push_back(region);
1763     } else if (type == "flash") {
1764       region.SetFlash(MemoryRegionInfo::eYes);
1765       memory_node.ForEachChildElement(
1766           [&region](const XMLNode &prop_node) -> bool {
1767             if (!prop_node.IsElement())
1768               return true;
1769             if (prop_node.GetName() != "property")
1770               return true;
1771             auto propname = prop_node.GetAttributeValue("name", "");
1772             if (propname == "blocksize") {
1773               uint64_t blocksize;
1774               if (prop_node.GetElementTextAsUnsigned(blocksize))
1775                 region.SetBlocksize(blocksize);
1776             }
1777             return true;
1778           });
1779       this->m_qXfer_memory_map.push_back(region);
1780     }
1781     return true;
1782   });
1783 
1784   m_qXfer_memory_map_loaded = true;
1785 
1786   return error;
1787 }
1788 
1789 Status GDBRemoteCommunicationClient::GetWatchpointSupportInfo(uint32_t &num) {
1790   Status error;
1791 
1792   if (m_supports_watchpoint_support_info == eLazyBoolYes) {
1793     num = m_num_supported_hardware_watchpoints;
1794     return error;
1795   }
1796 
1797   // Set num to 0 first.
1798   num = 0;
1799   if (m_supports_watchpoint_support_info != eLazyBoolNo) {
1800     StringExtractorGDBRemote response;
1801     if (SendPacketAndWaitForResponse("qWatchpointSupportInfo:", response) ==
1802         PacketResult::Success) {
1803       m_supports_watchpoint_support_info = eLazyBoolYes;
1804       llvm::StringRef name;
1805       llvm::StringRef value;
1806       bool found_num_field = false;
1807       while (response.GetNameColonValue(name, value)) {
1808         if (name.equals("num")) {
1809           value.getAsInteger(0, m_num_supported_hardware_watchpoints);
1810           num = m_num_supported_hardware_watchpoints;
1811           found_num_field = true;
1812         }
1813       }
1814       if (!found_num_field) {
1815         m_supports_watchpoint_support_info = eLazyBoolNo;
1816       }
1817     } else {
1818       m_supports_watchpoint_support_info = eLazyBoolNo;
1819     }
1820   }
1821 
1822   if (m_supports_watchpoint_support_info == eLazyBoolNo) {
1823     error.SetErrorString("qWatchpointSupportInfo is not supported");
1824   }
1825   return error;
1826 }
1827 
1828 lldb_private::Status GDBRemoteCommunicationClient::GetWatchpointSupportInfo(
1829     uint32_t &num, bool &after, const ArchSpec &arch) {
1830   Status error(GetWatchpointSupportInfo(num));
1831   if (error.Success())
1832     error = GetWatchpointsTriggerAfterInstruction(after, arch);
1833   return error;
1834 }
1835 
1836 lldb_private::Status
1837 GDBRemoteCommunicationClient::GetWatchpointsTriggerAfterInstruction(
1838     bool &after, const ArchSpec &arch) {
1839   Status error;
1840   llvm::Triple triple = arch.GetTriple();
1841 
1842   // we assume watchpoints will happen after running the relevant opcode and we
1843   // only want to override this behavior if we have explicitly received a
1844   // qHostInfo telling us otherwise
1845   if (m_qHostInfo_is_valid != eLazyBoolYes) {
1846     // On targets like MIPS and ppc64, watchpoint exceptions are always
1847     // generated before the instruction is executed. The connected target may
1848     // not support qHostInfo or qWatchpointSupportInfo packets.
1849     after = !(triple.isMIPS() || triple.isPPC64());
1850   } else {
1851     // For MIPS and ppc64, set m_watchpoints_trigger_after_instruction to
1852     // eLazyBoolNo if it is not calculated before.
1853     if (m_watchpoints_trigger_after_instruction == eLazyBoolCalculate &&
1854         (triple.isMIPS() || triple.isPPC64()))
1855       m_watchpoints_trigger_after_instruction = eLazyBoolNo;
1856 
1857     after = (m_watchpoints_trigger_after_instruction != eLazyBoolNo);
1858   }
1859   return error;
1860 }
1861 
1862 int GDBRemoteCommunicationClient::SetSTDIN(const FileSpec &file_spec) {
1863   if (file_spec) {
1864     std::string path{file_spec.GetPath(false)};
1865     StreamString packet;
1866     packet.PutCString("QSetSTDIN:");
1867     packet.PutStringAsRawHex8(path);
1868 
1869     StringExtractorGDBRemote response;
1870     if (SendPacketAndWaitForResponse(packet.GetString(), response) ==
1871         PacketResult::Success) {
1872       if (response.IsOKResponse())
1873         return 0;
1874       uint8_t error = response.GetError();
1875       if (error)
1876         return error;
1877     }
1878   }
1879   return -1;
1880 }
1881 
1882 int GDBRemoteCommunicationClient::SetSTDOUT(const FileSpec &file_spec) {
1883   if (file_spec) {
1884     std::string path{file_spec.GetPath(false)};
1885     StreamString packet;
1886     packet.PutCString("QSetSTDOUT:");
1887     packet.PutStringAsRawHex8(path);
1888 
1889     StringExtractorGDBRemote response;
1890     if (SendPacketAndWaitForResponse(packet.GetString(), response) ==
1891         PacketResult::Success) {
1892       if (response.IsOKResponse())
1893         return 0;
1894       uint8_t error = response.GetError();
1895       if (error)
1896         return error;
1897     }
1898   }
1899   return -1;
1900 }
1901 
1902 int GDBRemoteCommunicationClient::SetSTDERR(const FileSpec &file_spec) {
1903   if (file_spec) {
1904     std::string path{file_spec.GetPath(false)};
1905     StreamString packet;
1906     packet.PutCString("QSetSTDERR:");
1907     packet.PutStringAsRawHex8(path);
1908 
1909     StringExtractorGDBRemote response;
1910     if (SendPacketAndWaitForResponse(packet.GetString(), response) ==
1911         PacketResult::Success) {
1912       if (response.IsOKResponse())
1913         return 0;
1914       uint8_t error = response.GetError();
1915       if (error)
1916         return error;
1917     }
1918   }
1919   return -1;
1920 }
1921 
1922 bool GDBRemoteCommunicationClient::GetWorkingDir(FileSpec &working_dir) {
1923   StringExtractorGDBRemote response;
1924   if (SendPacketAndWaitForResponse("qGetWorkingDir", response) ==
1925       PacketResult::Success) {
1926     if (response.IsUnsupportedResponse())
1927       return false;
1928     if (response.IsErrorResponse())
1929       return false;
1930     std::string cwd;
1931     response.GetHexByteString(cwd);
1932     working_dir.SetFile(cwd, GetHostArchitecture().GetTriple());
1933     return !cwd.empty();
1934   }
1935   return false;
1936 }
1937 
1938 int GDBRemoteCommunicationClient::SetWorkingDir(const FileSpec &working_dir) {
1939   if (working_dir) {
1940     std::string path{working_dir.GetPath(false)};
1941     StreamString packet;
1942     packet.PutCString("QSetWorkingDir:");
1943     packet.PutStringAsRawHex8(path);
1944 
1945     StringExtractorGDBRemote response;
1946     if (SendPacketAndWaitForResponse(packet.GetString(), response) ==
1947         PacketResult::Success) {
1948       if (response.IsOKResponse())
1949         return 0;
1950       uint8_t error = response.GetError();
1951       if (error)
1952         return error;
1953     }
1954   }
1955   return -1;
1956 }
1957 
1958 int GDBRemoteCommunicationClient::SetDisableASLR(bool enable) {
1959   char packet[32];
1960   const int packet_len =
1961       ::snprintf(packet, sizeof(packet), "QSetDisableASLR:%i", enable ? 1 : 0);
1962   assert(packet_len < (int)sizeof(packet));
1963   UNUSED_IF_ASSERT_DISABLED(packet_len);
1964   StringExtractorGDBRemote response;
1965   if (SendPacketAndWaitForResponse(packet, response) == PacketResult::Success) {
1966     if (response.IsOKResponse())
1967       return 0;
1968     uint8_t error = response.GetError();
1969     if (error)
1970       return error;
1971   }
1972   return -1;
1973 }
1974 
1975 int GDBRemoteCommunicationClient::SetDetachOnError(bool enable) {
1976   char packet[32];
1977   const int packet_len = ::snprintf(packet, sizeof(packet),
1978                                     "QSetDetachOnError:%i", enable ? 1 : 0);
1979   assert(packet_len < (int)sizeof(packet));
1980   UNUSED_IF_ASSERT_DISABLED(packet_len);
1981   StringExtractorGDBRemote response;
1982   if (SendPacketAndWaitForResponse(packet, response) == PacketResult::Success) {
1983     if (response.IsOKResponse())
1984       return 0;
1985     uint8_t error = response.GetError();
1986     if (error)
1987       return error;
1988   }
1989   return -1;
1990 }
1991 
1992 bool GDBRemoteCommunicationClient::DecodeProcessInfoResponse(
1993     StringExtractorGDBRemote &response, ProcessInstanceInfo &process_info) {
1994   if (response.IsNormalResponse()) {
1995     llvm::StringRef name;
1996     llvm::StringRef value;
1997     StringExtractor extractor;
1998 
1999     uint32_t cpu = LLDB_INVALID_CPUTYPE;
2000     uint32_t sub = 0;
2001     std::string vendor;
2002     std::string os_type;
2003 
2004     while (response.GetNameColonValue(name, value)) {
2005       if (name.equals("pid")) {
2006         lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
2007         value.getAsInteger(0, pid);
2008         process_info.SetProcessID(pid);
2009       } else if (name.equals("ppid")) {
2010         lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
2011         value.getAsInteger(0, pid);
2012         process_info.SetParentProcessID(pid);
2013       } else if (name.equals("uid")) {
2014         uint32_t uid = UINT32_MAX;
2015         value.getAsInteger(0, uid);
2016         process_info.SetUserID(uid);
2017       } else if (name.equals("euid")) {
2018         uint32_t uid = UINT32_MAX;
2019         value.getAsInteger(0, uid);
2020         process_info.SetEffectiveUserID(uid);
2021       } else if (name.equals("gid")) {
2022         uint32_t gid = UINT32_MAX;
2023         value.getAsInteger(0, gid);
2024         process_info.SetGroupID(gid);
2025       } else if (name.equals("egid")) {
2026         uint32_t gid = UINT32_MAX;
2027         value.getAsInteger(0, gid);
2028         process_info.SetEffectiveGroupID(gid);
2029       } else if (name.equals("triple")) {
2030         StringExtractor extractor(value);
2031         std::string triple;
2032         extractor.GetHexByteString(triple);
2033         process_info.GetArchitecture().SetTriple(triple.c_str());
2034       } else if (name.equals("name")) {
2035         StringExtractor extractor(value);
2036         // The process name from ASCII hex bytes since we can't control the
2037         // characters in a process name
2038         std::string name;
2039         extractor.GetHexByteString(name);
2040         process_info.GetExecutableFile().SetFile(name, FileSpec::Style::native);
2041       } else if (name.equals("args")) {
2042         llvm::StringRef encoded_args(value), hex_arg;
2043 
2044         bool is_arg0 = true;
2045         while (!encoded_args.empty()) {
2046           std::tie(hex_arg, encoded_args) = encoded_args.split('-');
2047           std::string arg;
2048           StringExtractor extractor(hex_arg);
2049           if (extractor.GetHexByteString(arg) * 2 != hex_arg.size()) {
2050             // In case of wrong encoding, we discard all the arguments
2051             process_info.GetArguments().Clear();
2052             process_info.SetArg0("");
2053             break;
2054           }
2055           if (is_arg0)
2056             process_info.SetArg0(arg);
2057           else
2058             process_info.GetArguments().AppendArgument(arg);
2059           is_arg0 = false;
2060         }
2061       } else if (name.equals("cputype")) {
2062         value.getAsInteger(0, cpu);
2063       } else if (name.equals("cpusubtype")) {
2064         value.getAsInteger(0, sub);
2065       } else if (name.equals("vendor")) {
2066         vendor = std::string(value);
2067       } else if (name.equals("ostype")) {
2068         os_type = std::string(value);
2069       }
2070     }
2071 
2072     if (cpu != LLDB_INVALID_CPUTYPE && !vendor.empty() && !os_type.empty()) {
2073       if (vendor == "apple") {
2074         process_info.GetArchitecture().SetArchitecture(eArchTypeMachO, cpu,
2075                                                        sub);
2076         process_info.GetArchitecture().GetTriple().setVendorName(
2077             llvm::StringRef(vendor));
2078         process_info.GetArchitecture().GetTriple().setOSName(
2079             llvm::StringRef(os_type));
2080       }
2081     }
2082 
2083     if (process_info.GetProcessID() != LLDB_INVALID_PROCESS_ID)
2084       return true;
2085   }
2086   return false;
2087 }
2088 
2089 bool GDBRemoteCommunicationClient::GetProcessInfo(
2090     lldb::pid_t pid, ProcessInstanceInfo &process_info) {
2091   process_info.Clear();
2092 
2093   if (m_supports_qProcessInfoPID) {
2094     char packet[32];
2095     const int packet_len =
2096         ::snprintf(packet, sizeof(packet), "qProcessInfoPID:%" PRIu64, pid);
2097     assert(packet_len < (int)sizeof(packet));
2098     UNUSED_IF_ASSERT_DISABLED(packet_len);
2099     StringExtractorGDBRemote response;
2100     if (SendPacketAndWaitForResponse(packet, response) ==
2101         PacketResult::Success) {
2102       return DecodeProcessInfoResponse(response, process_info);
2103     } else {
2104       m_supports_qProcessInfoPID = false;
2105       return false;
2106     }
2107   }
2108   return false;
2109 }
2110 
2111 bool GDBRemoteCommunicationClient::GetCurrentProcessInfo(bool allow_lazy) {
2112   Log *log(GetLog(GDBRLog::Process | GDBRLog::Packets));
2113 
2114   if (allow_lazy) {
2115     if (m_qProcessInfo_is_valid == eLazyBoolYes)
2116       return true;
2117     if (m_qProcessInfo_is_valid == eLazyBoolNo)
2118       return false;
2119   }
2120 
2121   GetHostInfo();
2122 
2123   StringExtractorGDBRemote response;
2124   if (SendPacketAndWaitForResponse("qProcessInfo", response) ==
2125       PacketResult::Success) {
2126     if (response.IsNormalResponse()) {
2127       llvm::StringRef name;
2128       llvm::StringRef value;
2129       uint32_t cpu = LLDB_INVALID_CPUTYPE;
2130       uint32_t sub = 0;
2131       std::string arch_name;
2132       std::string os_name;
2133       std::string environment;
2134       std::string vendor_name;
2135       std::string triple;
2136       std::string elf_abi;
2137       uint32_t pointer_byte_size = 0;
2138       StringExtractor extractor;
2139       ByteOrder byte_order = eByteOrderInvalid;
2140       uint32_t num_keys_decoded = 0;
2141       lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
2142       while (response.GetNameColonValue(name, value)) {
2143         if (name.equals("cputype")) {
2144           if (!value.getAsInteger(16, cpu))
2145             ++num_keys_decoded;
2146         } else if (name.equals("cpusubtype")) {
2147           if (!value.getAsInteger(16, sub))
2148             ++num_keys_decoded;
2149         } else if (name.equals("triple")) {
2150           StringExtractor extractor(value);
2151           extractor.GetHexByteString(triple);
2152           ++num_keys_decoded;
2153         } else if (name.equals("ostype")) {
2154           ParseOSType(value, os_name, environment);
2155           ++num_keys_decoded;
2156         } else if (name.equals("vendor")) {
2157           vendor_name = std::string(value);
2158           ++num_keys_decoded;
2159         } else if (name.equals("endian")) {
2160           byte_order = llvm::StringSwitch<lldb::ByteOrder>(value)
2161                            .Case("little", eByteOrderLittle)
2162                            .Case("big", eByteOrderBig)
2163                            .Case("pdp", eByteOrderPDP)
2164                            .Default(eByteOrderInvalid);
2165           if (byte_order != eByteOrderInvalid)
2166             ++num_keys_decoded;
2167         } else if (name.equals("ptrsize")) {
2168           if (!value.getAsInteger(16, pointer_byte_size))
2169             ++num_keys_decoded;
2170         } else if (name.equals("pid")) {
2171           if (!value.getAsInteger(16, pid))
2172             ++num_keys_decoded;
2173         } else if (name.equals("elf_abi")) {
2174           elf_abi = std::string(value);
2175           ++num_keys_decoded;
2176         } else if (name.equals("main-binary-uuid")) {
2177           m_process_standalone_uuid.SetFromStringRef(value);
2178           ++num_keys_decoded;
2179         } else if (name.equals("main-binary-slide")) {
2180           StringExtractor extractor(value);
2181           m_process_standalone_value =
2182               extractor.GetU64(LLDB_INVALID_ADDRESS, 16);
2183           if (m_process_standalone_value != LLDB_INVALID_ADDRESS) {
2184             m_process_standalone_value_is_offset = true;
2185             ++num_keys_decoded;
2186           }
2187         } else if (name.equals("main-binary-address")) {
2188           StringExtractor extractor(value);
2189           m_process_standalone_value =
2190               extractor.GetU64(LLDB_INVALID_ADDRESS, 16);
2191           if (m_process_standalone_value != LLDB_INVALID_ADDRESS) {
2192             m_process_standalone_value_is_offset = false;
2193             ++num_keys_decoded;
2194           }
2195         }
2196       }
2197       if (num_keys_decoded > 0)
2198         m_qProcessInfo_is_valid = eLazyBoolYes;
2199       if (pid != LLDB_INVALID_PROCESS_ID) {
2200         m_curr_pid_is_valid = eLazyBoolYes;
2201         m_curr_pid_run = m_curr_pid = pid;
2202       }
2203 
2204       // Set the ArchSpec from the triple if we have it.
2205       if (!triple.empty()) {
2206         m_process_arch.SetTriple(triple.c_str());
2207         m_process_arch.SetFlags(elf_abi);
2208         if (pointer_byte_size) {
2209           assert(pointer_byte_size == m_process_arch.GetAddressByteSize());
2210         }
2211       } else if (cpu != LLDB_INVALID_CPUTYPE && !os_name.empty() &&
2212                  !vendor_name.empty()) {
2213         llvm::Triple triple(llvm::Twine("-") + vendor_name + "-" + os_name);
2214         if (!environment.empty())
2215             triple.setEnvironmentName(environment);
2216 
2217         assert(triple.getObjectFormat() != llvm::Triple::UnknownObjectFormat);
2218         assert(triple.getObjectFormat() != llvm::Triple::Wasm);
2219         assert(triple.getObjectFormat() != llvm::Triple::XCOFF);
2220         switch (triple.getObjectFormat()) {
2221         case llvm::Triple::MachO:
2222           m_process_arch.SetArchitecture(eArchTypeMachO, cpu, sub);
2223           break;
2224         case llvm::Triple::ELF:
2225           m_process_arch.SetArchitecture(eArchTypeELF, cpu, sub);
2226           break;
2227         case llvm::Triple::COFF:
2228           m_process_arch.SetArchitecture(eArchTypeCOFF, cpu, sub);
2229           break;
2230         case llvm::Triple::GOFF:
2231         case llvm::Triple::Wasm:
2232         case llvm::Triple::XCOFF:
2233         case llvm::Triple::DXContainer:
2234           LLDB_LOGF(log, "error: not supported target architecture");
2235           return false;
2236         case llvm::Triple::UnknownObjectFormat:
2237           LLDB_LOGF(log, "error: failed to determine target architecture");
2238           return false;
2239         }
2240 
2241         if (pointer_byte_size) {
2242           assert(pointer_byte_size == m_process_arch.GetAddressByteSize());
2243         }
2244         if (byte_order != eByteOrderInvalid) {
2245           assert(byte_order == m_process_arch.GetByteOrder());
2246         }
2247         m_process_arch.GetTriple().setVendorName(llvm::StringRef(vendor_name));
2248         m_process_arch.GetTriple().setOSName(llvm::StringRef(os_name));
2249         m_process_arch.GetTriple().setEnvironmentName(llvm::StringRef(environment));
2250       }
2251       return true;
2252     }
2253   } else {
2254     m_qProcessInfo_is_valid = eLazyBoolNo;
2255   }
2256 
2257   return false;
2258 }
2259 
2260 uint32_t GDBRemoteCommunicationClient::FindProcesses(
2261     const ProcessInstanceInfoMatch &match_info,
2262     ProcessInstanceInfoList &process_infos) {
2263   process_infos.clear();
2264 
2265   if (m_supports_qfProcessInfo) {
2266     StreamString packet;
2267     packet.PutCString("qfProcessInfo");
2268     if (!match_info.MatchAllProcesses()) {
2269       packet.PutChar(':');
2270       const char *name = match_info.GetProcessInfo().GetName();
2271       bool has_name_match = false;
2272       if (name && name[0]) {
2273         has_name_match = true;
2274         NameMatch name_match_type = match_info.GetNameMatchType();
2275         switch (name_match_type) {
2276         case NameMatch::Ignore:
2277           has_name_match = false;
2278           break;
2279 
2280         case NameMatch::Equals:
2281           packet.PutCString("name_match:equals;");
2282           break;
2283 
2284         case NameMatch::Contains:
2285           packet.PutCString("name_match:contains;");
2286           break;
2287 
2288         case NameMatch::StartsWith:
2289           packet.PutCString("name_match:starts_with;");
2290           break;
2291 
2292         case NameMatch::EndsWith:
2293           packet.PutCString("name_match:ends_with;");
2294           break;
2295 
2296         case NameMatch::RegularExpression:
2297           packet.PutCString("name_match:regex;");
2298           break;
2299         }
2300         if (has_name_match) {
2301           packet.PutCString("name:");
2302           packet.PutBytesAsRawHex8(name, ::strlen(name));
2303           packet.PutChar(';');
2304         }
2305       }
2306 
2307       if (match_info.GetProcessInfo().ProcessIDIsValid())
2308         packet.Printf("pid:%" PRIu64 ";",
2309                       match_info.GetProcessInfo().GetProcessID());
2310       if (match_info.GetProcessInfo().ParentProcessIDIsValid())
2311         packet.Printf("parent_pid:%" PRIu64 ";",
2312                       match_info.GetProcessInfo().GetParentProcessID());
2313       if (match_info.GetProcessInfo().UserIDIsValid())
2314         packet.Printf("uid:%u;", match_info.GetProcessInfo().GetUserID());
2315       if (match_info.GetProcessInfo().GroupIDIsValid())
2316         packet.Printf("gid:%u;", match_info.GetProcessInfo().GetGroupID());
2317       if (match_info.GetProcessInfo().EffectiveUserIDIsValid())
2318         packet.Printf("euid:%u;",
2319                       match_info.GetProcessInfo().GetEffectiveUserID());
2320       if (match_info.GetProcessInfo().EffectiveGroupIDIsValid())
2321         packet.Printf("egid:%u;",
2322                       match_info.GetProcessInfo().GetEffectiveGroupID());
2323       packet.Printf("all_users:%u;", match_info.GetMatchAllUsers() ? 1 : 0);
2324       if (match_info.GetProcessInfo().GetArchitecture().IsValid()) {
2325         const ArchSpec &match_arch =
2326             match_info.GetProcessInfo().GetArchitecture();
2327         const llvm::Triple &triple = match_arch.GetTriple();
2328         packet.PutCString("triple:");
2329         packet.PutCString(triple.getTriple());
2330         packet.PutChar(';');
2331       }
2332     }
2333     StringExtractorGDBRemote response;
2334     // Increase timeout as the first qfProcessInfo packet takes a long time on
2335     // Android. The value of 1min was arrived at empirically.
2336     ScopedTimeout timeout(*this, minutes(1));
2337     if (SendPacketAndWaitForResponse(packet.GetString(), response) ==
2338         PacketResult::Success) {
2339       do {
2340         ProcessInstanceInfo process_info;
2341         if (!DecodeProcessInfoResponse(response, process_info))
2342           break;
2343         process_infos.push_back(process_info);
2344         response = StringExtractorGDBRemote();
2345       } while (SendPacketAndWaitForResponse("qsProcessInfo", response) ==
2346                PacketResult::Success);
2347     } else {
2348       m_supports_qfProcessInfo = false;
2349       return 0;
2350     }
2351   }
2352   return process_infos.size();
2353 }
2354 
2355 bool GDBRemoteCommunicationClient::GetUserName(uint32_t uid,
2356                                                std::string &name) {
2357   if (m_supports_qUserName) {
2358     char packet[32];
2359     const int packet_len =
2360         ::snprintf(packet, sizeof(packet), "qUserName:%i", uid);
2361     assert(packet_len < (int)sizeof(packet));
2362     UNUSED_IF_ASSERT_DISABLED(packet_len);
2363     StringExtractorGDBRemote response;
2364     if (SendPacketAndWaitForResponse(packet, response) ==
2365         PacketResult::Success) {
2366       if (response.IsNormalResponse()) {
2367         // Make sure we parsed the right number of characters. The response is
2368         // the hex encoded user name and should make up the entire packet. If
2369         // there are any non-hex ASCII bytes, the length won't match below..
2370         if (response.GetHexByteString(name) * 2 ==
2371             response.GetStringRef().size())
2372           return true;
2373       }
2374     } else {
2375       m_supports_qUserName = false;
2376       return false;
2377     }
2378   }
2379   return false;
2380 }
2381 
2382 bool GDBRemoteCommunicationClient::GetGroupName(uint32_t gid,
2383                                                 std::string &name) {
2384   if (m_supports_qGroupName) {
2385     char packet[32];
2386     const int packet_len =
2387         ::snprintf(packet, sizeof(packet), "qGroupName:%i", gid);
2388     assert(packet_len < (int)sizeof(packet));
2389     UNUSED_IF_ASSERT_DISABLED(packet_len);
2390     StringExtractorGDBRemote response;
2391     if (SendPacketAndWaitForResponse(packet, response) ==
2392         PacketResult::Success) {
2393       if (response.IsNormalResponse()) {
2394         // Make sure we parsed the right number of characters. The response is
2395         // the hex encoded group name and should make up the entire packet. If
2396         // there are any non-hex ASCII bytes, the length won't match below..
2397         if (response.GetHexByteString(name) * 2 ==
2398             response.GetStringRef().size())
2399           return true;
2400       }
2401     } else {
2402       m_supports_qGroupName = false;
2403       return false;
2404     }
2405   }
2406   return false;
2407 }
2408 
2409 static void MakeSpeedTestPacket(StreamString &packet, uint32_t send_size,
2410                                 uint32_t recv_size) {
2411   packet.Clear();
2412   packet.Printf("qSpeedTest:response_size:%i;data:", recv_size);
2413   uint32_t bytes_left = send_size;
2414   while (bytes_left > 0) {
2415     if (bytes_left >= 26) {
2416       packet.PutCString("abcdefghijklmnopqrstuvwxyz");
2417       bytes_left -= 26;
2418     } else {
2419       packet.Printf("%*.*s;", bytes_left, bytes_left,
2420                     "abcdefghijklmnopqrstuvwxyz");
2421       bytes_left = 0;
2422     }
2423   }
2424 }
2425 
2426 duration<float>
2427 calculate_standard_deviation(const std::vector<duration<float>> &v) {
2428   using Dur = duration<float>;
2429   Dur sum = std::accumulate(std::begin(v), std::end(v), Dur());
2430   Dur mean = sum / v.size();
2431   float accum = 0;
2432   for (auto d : v) {
2433     float delta = (d - mean).count();
2434     accum += delta * delta;
2435   };
2436 
2437   return Dur(sqrtf(accum / (v.size() - 1)));
2438 }
2439 
2440 void GDBRemoteCommunicationClient::TestPacketSpeed(const uint32_t num_packets,
2441                                                    uint32_t max_send,
2442                                                    uint32_t max_recv,
2443                                                    uint64_t recv_amount,
2444                                                    bool json, Stream &strm) {
2445   uint32_t i;
2446   if (SendSpeedTestPacket(0, 0)) {
2447     StreamString packet;
2448     if (json)
2449       strm.Printf("{ \"packet_speeds\" : {\n    \"num_packets\" : %u,\n    "
2450                   "\"results\" : [",
2451                   num_packets);
2452     else
2453       strm.Printf("Testing sending %u packets of various sizes:\n",
2454                   num_packets);
2455     strm.Flush();
2456 
2457     uint32_t result_idx = 0;
2458     uint32_t send_size;
2459     std::vector<duration<float>> packet_times;
2460 
2461     for (send_size = 0; send_size <= max_send;
2462          send_size ? send_size *= 2 : send_size = 4) {
2463       for (uint32_t recv_size = 0; recv_size <= max_recv;
2464            recv_size ? recv_size *= 2 : recv_size = 4) {
2465         MakeSpeedTestPacket(packet, send_size, recv_size);
2466 
2467         packet_times.clear();
2468         // Test how long it takes to send 'num_packets' packets
2469         const auto start_time = steady_clock::now();
2470         for (i = 0; i < num_packets; ++i) {
2471           const auto packet_start_time = steady_clock::now();
2472           StringExtractorGDBRemote response;
2473           SendPacketAndWaitForResponse(packet.GetString(), response);
2474           const auto packet_end_time = steady_clock::now();
2475           packet_times.push_back(packet_end_time - packet_start_time);
2476         }
2477         const auto end_time = steady_clock::now();
2478         const auto total_time = end_time - start_time;
2479 
2480         float packets_per_second =
2481             ((float)num_packets) / duration<float>(total_time).count();
2482         auto average_per_packet = total_time / num_packets;
2483         const duration<float> standard_deviation =
2484             calculate_standard_deviation(packet_times);
2485         if (json) {
2486           strm.Format("{0}\n     {{\"send_size\" : {1,6}, \"recv_size\" : "
2487                       "{2,6}, \"total_time_nsec\" : {3,12:ns-}, "
2488                       "\"standard_deviation_nsec\" : {4,9:ns-f0}}",
2489                       result_idx > 0 ? "," : "", send_size, recv_size,
2490                       total_time, standard_deviation);
2491           ++result_idx;
2492         } else {
2493           strm.Format("qSpeedTest(send={0,7}, recv={1,7}) in {2:s+f9} for "
2494                       "{3,9:f2} packets/s ({4,10:ms+f6} per packet) with "
2495                       "standard deviation of {5,10:ms+f6}\n",
2496                       send_size, recv_size, duration<float>(total_time),
2497                       packets_per_second, duration<float>(average_per_packet),
2498                       standard_deviation);
2499         }
2500         strm.Flush();
2501       }
2502     }
2503 
2504     const float k_recv_amount_mb = (float)recv_amount / (1024.0f * 1024.0f);
2505     if (json)
2506       strm.Printf("\n    ]\n  },\n  \"download_speed\" : {\n    \"byte_size\" "
2507                   ": %" PRIu64 ",\n    \"results\" : [",
2508                   recv_amount);
2509     else
2510       strm.Printf("Testing receiving %2.1fMB of data using varying receive "
2511                   "packet sizes:\n",
2512                   k_recv_amount_mb);
2513     strm.Flush();
2514     send_size = 0;
2515     result_idx = 0;
2516     for (uint32_t recv_size = 32; recv_size <= max_recv; recv_size *= 2) {
2517       MakeSpeedTestPacket(packet, send_size, recv_size);
2518 
2519       // If we have a receive size, test how long it takes to receive 4MB of
2520       // data
2521       if (recv_size > 0) {
2522         const auto start_time = steady_clock::now();
2523         uint32_t bytes_read = 0;
2524         uint32_t packet_count = 0;
2525         while (bytes_read < recv_amount) {
2526           StringExtractorGDBRemote response;
2527           SendPacketAndWaitForResponse(packet.GetString(), response);
2528           bytes_read += recv_size;
2529           ++packet_count;
2530         }
2531         const auto end_time = steady_clock::now();
2532         const auto total_time = end_time - start_time;
2533         float mb_second = ((float)recv_amount) /
2534                           duration<float>(total_time).count() /
2535                           (1024.0 * 1024.0);
2536         float packets_per_second =
2537             ((float)packet_count) / duration<float>(total_time).count();
2538         const auto average_per_packet = total_time / packet_count;
2539 
2540         if (json) {
2541           strm.Format("{0}\n     {{\"send_size\" : {1,6}, \"recv_size\" : "
2542                       "{2,6}, \"total_time_nsec\" : {3,12:ns-}}",
2543                       result_idx > 0 ? "," : "", send_size, recv_size,
2544                       total_time);
2545           ++result_idx;
2546         } else {
2547           strm.Format("qSpeedTest(send={0,7}, recv={1,7}) {2,6} packets needed "
2548                       "to receive {3:f1}MB in {4:s+f9} for {5} MB/sec for "
2549                       "{6,9:f2} packets/sec ({7,10:ms+f6} per packet)\n",
2550                       send_size, recv_size, packet_count, k_recv_amount_mb,
2551                       duration<float>(total_time), mb_second,
2552                       packets_per_second, duration<float>(average_per_packet));
2553         }
2554         strm.Flush();
2555       }
2556     }
2557     if (json)
2558       strm.Printf("\n    ]\n  }\n}\n");
2559     else
2560       strm.EOL();
2561   }
2562 }
2563 
2564 bool GDBRemoteCommunicationClient::SendSpeedTestPacket(uint32_t send_size,
2565                                                        uint32_t recv_size) {
2566   StreamString packet;
2567   packet.Printf("qSpeedTest:response_size:%i;data:", recv_size);
2568   uint32_t bytes_left = send_size;
2569   while (bytes_left > 0) {
2570     if (bytes_left >= 26) {
2571       packet.PutCString("abcdefghijklmnopqrstuvwxyz");
2572       bytes_left -= 26;
2573     } else {
2574       packet.Printf("%*.*s;", bytes_left, bytes_left,
2575                     "abcdefghijklmnopqrstuvwxyz");
2576       bytes_left = 0;
2577     }
2578   }
2579 
2580   StringExtractorGDBRemote response;
2581   return SendPacketAndWaitForResponse(packet.GetString(), response) ==
2582          PacketResult::Success;
2583 }
2584 
2585 bool GDBRemoteCommunicationClient::LaunchGDBServer(
2586     const char *remote_accept_hostname, lldb::pid_t &pid, uint16_t &port,
2587     std::string &socket_name) {
2588   pid = LLDB_INVALID_PROCESS_ID;
2589   port = 0;
2590   socket_name.clear();
2591 
2592   StringExtractorGDBRemote response;
2593   StreamString stream;
2594   stream.PutCString("qLaunchGDBServer;");
2595   std::string hostname;
2596   if (remote_accept_hostname && remote_accept_hostname[0])
2597     hostname = remote_accept_hostname;
2598   else {
2599     if (HostInfo::GetHostname(hostname)) {
2600       // Make the GDB server we launch only accept connections from this host
2601       stream.Printf("host:%s;", hostname.c_str());
2602     } else {
2603       // Make the GDB server we launch accept connections from any host since
2604       // we can't figure out the hostname
2605       stream.Printf("host:*;");
2606     }
2607   }
2608   // give the process a few seconds to startup
2609   ScopedTimeout timeout(*this, seconds(10));
2610 
2611   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
2612       PacketResult::Success) {
2613     llvm::StringRef name;
2614     llvm::StringRef value;
2615     while (response.GetNameColonValue(name, value)) {
2616       if (name.equals("port"))
2617         value.getAsInteger(0, port);
2618       else if (name.equals("pid"))
2619         value.getAsInteger(0, pid);
2620       else if (name.compare("socket_name") == 0) {
2621         StringExtractor extractor(value);
2622         extractor.GetHexByteString(socket_name);
2623       }
2624     }
2625     return true;
2626   }
2627   return false;
2628 }
2629 
2630 size_t GDBRemoteCommunicationClient::QueryGDBServer(
2631     std::vector<std::pair<uint16_t, std::string>> &connection_urls) {
2632   connection_urls.clear();
2633 
2634   StringExtractorGDBRemote response;
2635   if (SendPacketAndWaitForResponse("qQueryGDBServer", response) !=
2636       PacketResult::Success)
2637     return 0;
2638 
2639   StructuredData::ObjectSP data =
2640       StructuredData::ParseJSON(std::string(response.GetStringRef()));
2641   if (!data)
2642     return 0;
2643 
2644   StructuredData::Array *array = data->GetAsArray();
2645   if (!array)
2646     return 0;
2647 
2648   for (size_t i = 0, count = array->GetSize(); i < count; ++i) {
2649     StructuredData::Dictionary *element = nullptr;
2650     if (!array->GetItemAtIndexAsDictionary(i, element))
2651       continue;
2652 
2653     uint16_t port = 0;
2654     if (StructuredData::ObjectSP port_osp =
2655             element->GetValueForKey(llvm::StringRef("port")))
2656       port = port_osp->GetIntegerValue(0);
2657 
2658     std::string socket_name;
2659     if (StructuredData::ObjectSP socket_name_osp =
2660             element->GetValueForKey(llvm::StringRef("socket_name")))
2661       socket_name = std::string(socket_name_osp->GetStringValue());
2662 
2663     if (port != 0 || !socket_name.empty())
2664       connection_urls.emplace_back(port, socket_name);
2665   }
2666   return connection_urls.size();
2667 }
2668 
2669 bool GDBRemoteCommunicationClient::KillSpawnedProcess(lldb::pid_t pid) {
2670   StreamString stream;
2671   stream.Printf("qKillSpawnedProcess:%" PRId64, pid);
2672 
2673   StringExtractorGDBRemote response;
2674   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
2675       PacketResult::Success) {
2676     if (response.IsOKResponse())
2677       return true;
2678   }
2679   return false;
2680 }
2681 
2682 llvm::Optional<PidTid>
2683 GDBRemoteCommunicationClient::SendSetCurrentThreadPacket(uint64_t tid,
2684                                                          uint64_t pid,
2685                                                          char op) {
2686   lldb_private::StreamString packet;
2687   packet.PutChar('H');
2688   packet.PutChar(op);
2689 
2690   if (pid != LLDB_INVALID_PROCESS_ID)
2691     packet.Printf("p%" PRIx64 ".", pid);
2692 
2693   if (tid == UINT64_MAX)
2694     packet.PutCString("-1");
2695   else
2696     packet.Printf("%" PRIx64, tid);
2697 
2698   StringExtractorGDBRemote response;
2699   if (SendPacketAndWaitForResponse(packet.GetString(), response)
2700       == PacketResult::Success) {
2701     if (response.IsOKResponse())
2702       return {{pid, tid}};
2703 
2704     /*
2705      * Connected bare-iron target (like YAMON gdb-stub) may not have support for
2706      * Hg packet.
2707      * The reply from '?' packet could be as simple as 'S05'. There is no packet
2708      * which can
2709      * give us pid and/or tid. Assume pid=tid=1 in such cases.
2710      */
2711     if (response.IsUnsupportedResponse() && IsConnected())
2712       return {{1, 1}};
2713   }
2714   return llvm::None;
2715 }
2716 
2717 bool GDBRemoteCommunicationClient::SetCurrentThread(uint64_t tid,
2718                                                     uint64_t pid) {
2719   if (m_curr_tid == tid &&
2720       (m_curr_pid == pid || LLDB_INVALID_PROCESS_ID == pid))
2721     return true;
2722 
2723   llvm::Optional<PidTid> ret = SendSetCurrentThreadPacket(tid, pid, 'g');
2724   if (ret.hasValue()) {
2725     if (ret->pid != LLDB_INVALID_PROCESS_ID)
2726       m_curr_pid = ret->pid;
2727     m_curr_tid = ret->tid;
2728   }
2729   return ret.hasValue();
2730 }
2731 
2732 bool GDBRemoteCommunicationClient::SetCurrentThreadForRun(uint64_t tid,
2733                                                           uint64_t pid) {
2734   if (m_curr_tid_run == tid &&
2735       (m_curr_pid_run == pid || LLDB_INVALID_PROCESS_ID == pid))
2736     return true;
2737 
2738   llvm::Optional<PidTid> ret = SendSetCurrentThreadPacket(tid, pid, 'c');
2739   if (ret.hasValue()) {
2740     if (ret->pid != LLDB_INVALID_PROCESS_ID)
2741       m_curr_pid_run = ret->pid;
2742     m_curr_tid_run = ret->tid;
2743   }
2744   return ret.hasValue();
2745 }
2746 
2747 bool GDBRemoteCommunicationClient::GetStopReply(
2748     StringExtractorGDBRemote &response) {
2749   if (SendPacketAndWaitForResponse("?", response) == PacketResult::Success)
2750     return response.IsNormalResponse();
2751   return false;
2752 }
2753 
2754 bool GDBRemoteCommunicationClient::GetThreadStopInfo(
2755     lldb::tid_t tid, StringExtractorGDBRemote &response) {
2756   if (m_supports_qThreadStopInfo) {
2757     char packet[256];
2758     int packet_len =
2759         ::snprintf(packet, sizeof(packet), "qThreadStopInfo%" PRIx64, tid);
2760     assert(packet_len < (int)sizeof(packet));
2761     UNUSED_IF_ASSERT_DISABLED(packet_len);
2762     if (SendPacketAndWaitForResponse(packet, response) ==
2763         PacketResult::Success) {
2764       if (response.IsUnsupportedResponse())
2765         m_supports_qThreadStopInfo = false;
2766       else if (response.IsNormalResponse())
2767         return true;
2768       else
2769         return false;
2770     } else {
2771       m_supports_qThreadStopInfo = false;
2772     }
2773   }
2774   return false;
2775 }
2776 
2777 uint8_t GDBRemoteCommunicationClient::SendGDBStoppointTypePacket(
2778     GDBStoppointType type, bool insert, addr_t addr, uint32_t length,
2779     std::chrono::seconds timeout) {
2780   Log *log = GetLog(LLDBLog::Breakpoints);
2781   LLDB_LOGF(log, "GDBRemoteCommunicationClient::%s() %s at addr = 0x%" PRIx64,
2782             __FUNCTION__, insert ? "add" : "remove", addr);
2783 
2784   // Check if the stub is known not to support this breakpoint type
2785   if (!SupportsGDBStoppointPacket(type))
2786     return UINT8_MAX;
2787   // Construct the breakpoint packet
2788   char packet[64];
2789   const int packet_len =
2790       ::snprintf(packet, sizeof(packet), "%c%i,%" PRIx64 ",%x",
2791                  insert ? 'Z' : 'z', type, addr, length);
2792   // Check we haven't overwritten the end of the packet buffer
2793   assert(packet_len + 1 < (int)sizeof(packet));
2794   UNUSED_IF_ASSERT_DISABLED(packet_len);
2795   StringExtractorGDBRemote response;
2796   // Make sure the response is either "OK", "EXX" where XX are two hex digits,
2797   // or "" (unsupported)
2798   response.SetResponseValidatorToOKErrorNotSupported();
2799   // Try to send the breakpoint packet, and check that it was correctly sent
2800   if (SendPacketAndWaitForResponse(packet, response, timeout) ==
2801       PacketResult::Success) {
2802     // Receive and OK packet when the breakpoint successfully placed
2803     if (response.IsOKResponse())
2804       return 0;
2805 
2806     // Status while setting breakpoint, send back specific error
2807     if (response.IsErrorResponse())
2808       return response.GetError();
2809 
2810     // Empty packet informs us that breakpoint is not supported
2811     if (response.IsUnsupportedResponse()) {
2812       // Disable this breakpoint type since it is unsupported
2813       switch (type) {
2814       case eBreakpointSoftware:
2815         m_supports_z0 = false;
2816         break;
2817       case eBreakpointHardware:
2818         m_supports_z1 = false;
2819         break;
2820       case eWatchpointWrite:
2821         m_supports_z2 = false;
2822         break;
2823       case eWatchpointRead:
2824         m_supports_z3 = false;
2825         break;
2826       case eWatchpointReadWrite:
2827         m_supports_z4 = false;
2828         break;
2829       case eStoppointInvalid:
2830         return UINT8_MAX;
2831       }
2832     }
2833   }
2834   // Signal generic failure
2835   return UINT8_MAX;
2836 }
2837 
2838 std::vector<std::pair<lldb::pid_t, lldb::tid_t>>
2839 GDBRemoteCommunicationClient::GetCurrentProcessAndThreadIDs(
2840     bool &sequence_mutex_unavailable) {
2841   std::vector<std::pair<lldb::pid_t, lldb::tid_t>> ids;
2842 
2843   Lock lock(*this);
2844   if (lock) {
2845     sequence_mutex_unavailable = false;
2846     StringExtractorGDBRemote response;
2847 
2848     PacketResult packet_result;
2849     for (packet_result =
2850              SendPacketAndWaitForResponseNoLock("qfThreadInfo", response);
2851          packet_result == PacketResult::Success && response.IsNormalResponse();
2852          packet_result =
2853              SendPacketAndWaitForResponseNoLock("qsThreadInfo", response)) {
2854       char ch = response.GetChar();
2855       if (ch == 'l')
2856         break;
2857       if (ch == 'm') {
2858         do {
2859           auto pid_tid = response.GetPidTid(LLDB_INVALID_PROCESS_ID);
2860           // If we get an invalid response, break out of the loop.
2861           // If there are valid tids, they have been added to ids.
2862           // If there are no valid tids, we'll fall through to the
2863           // bare-iron target handling below.
2864           if (!pid_tid)
2865             break;
2866 
2867           ids.push_back(pid_tid.getValue());
2868           ch = response.GetChar(); // Skip the command separator
2869         } while (ch == ',');       // Make sure we got a comma separator
2870       }
2871     }
2872 
2873     /*
2874      * Connected bare-iron target (like YAMON gdb-stub) may not have support for
2875      * qProcessInfo, qC and qfThreadInfo packets. The reply from '?' packet
2876      * could
2877      * be as simple as 'S05'. There is no packet which can give us pid and/or
2878      * tid.
2879      * Assume pid=tid=1 in such cases.
2880      */
2881     if ((response.IsUnsupportedResponse() || response.IsNormalResponse()) &&
2882         ids.size() == 0 && IsConnected()) {
2883       ids.emplace_back(1, 1);
2884     }
2885   } else {
2886     Log *log(GetLog(GDBRLog::Process | GDBRLog::Packets));
2887     LLDB_LOG(log, "error: failed to get packet sequence mutex, not sending "
2888                   "packet 'qfThreadInfo'");
2889     sequence_mutex_unavailable = true;
2890   }
2891 
2892   return ids;
2893 }
2894 
2895 size_t GDBRemoteCommunicationClient::GetCurrentThreadIDs(
2896     std::vector<lldb::tid_t> &thread_ids, bool &sequence_mutex_unavailable) {
2897   lldb::pid_t pid = GetCurrentProcessID();
2898   thread_ids.clear();
2899 
2900   auto ids = GetCurrentProcessAndThreadIDs(sequence_mutex_unavailable);
2901   if (ids.empty() || sequence_mutex_unavailable)
2902     return 0;
2903 
2904   for (auto id : ids) {
2905     // skip threads that do not belong to the current process
2906     if (id.first != LLDB_INVALID_PROCESS_ID && id.first != pid)
2907       continue;
2908     if (id.second != LLDB_INVALID_THREAD_ID &&
2909         id.second != StringExtractorGDBRemote::AllThreads)
2910       thread_ids.push_back(id.second);
2911   }
2912 
2913   return thread_ids.size();
2914 }
2915 
2916 lldb::addr_t GDBRemoteCommunicationClient::GetShlibInfoAddr() {
2917   StringExtractorGDBRemote response;
2918   if (SendPacketAndWaitForResponse("qShlibInfoAddr", response) !=
2919           PacketResult::Success ||
2920       !response.IsNormalResponse())
2921     return LLDB_INVALID_ADDRESS;
2922   return response.GetHexMaxU64(false, LLDB_INVALID_ADDRESS);
2923 }
2924 
2925 lldb_private::Status GDBRemoteCommunicationClient::RunShellCommand(
2926     llvm::StringRef command,
2927     const FileSpec &
2928         working_dir, // Pass empty FileSpec to use the current working directory
2929     int *status_ptr, // Pass NULL if you don't want the process exit status
2930     int *signo_ptr,  // Pass NULL if you don't want the signal that caused the
2931                      // process to exit
2932     std::string
2933         *command_output, // Pass NULL if you don't want the command output
2934     const Timeout<std::micro> &timeout) {
2935   lldb_private::StreamString stream;
2936   stream.PutCString("qPlatform_shell:");
2937   stream.PutBytesAsRawHex8(command.data(), command.size());
2938   stream.PutChar(',');
2939   uint32_t timeout_sec = UINT32_MAX;
2940   if (timeout) {
2941     // TODO: Use chrono version of std::ceil once c++17 is available.
2942     timeout_sec = std::ceil(std::chrono::duration<double>(*timeout).count());
2943   }
2944   stream.PutHex32(timeout_sec);
2945   if (working_dir) {
2946     std::string path{working_dir.GetPath(false)};
2947     stream.PutChar(',');
2948     stream.PutStringAsRawHex8(path);
2949   }
2950   StringExtractorGDBRemote response;
2951   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
2952       PacketResult::Success) {
2953     if (response.GetChar() != 'F')
2954       return Status("malformed reply");
2955     if (response.GetChar() != ',')
2956       return Status("malformed reply");
2957     uint32_t exitcode = response.GetHexMaxU32(false, UINT32_MAX);
2958     if (exitcode == UINT32_MAX)
2959       return Status("unable to run remote process");
2960     else if (status_ptr)
2961       *status_ptr = exitcode;
2962     if (response.GetChar() != ',')
2963       return Status("malformed reply");
2964     uint32_t signo = response.GetHexMaxU32(false, UINT32_MAX);
2965     if (signo_ptr)
2966       *signo_ptr = signo;
2967     if (response.GetChar() != ',')
2968       return Status("malformed reply");
2969     std::string output;
2970     response.GetEscapedBinaryData(output);
2971     if (command_output)
2972       command_output->assign(output);
2973     return Status();
2974   }
2975   return Status("unable to send packet");
2976 }
2977 
2978 Status GDBRemoteCommunicationClient::MakeDirectory(const FileSpec &file_spec,
2979                                                    uint32_t file_permissions) {
2980   std::string path{file_spec.GetPath(false)};
2981   lldb_private::StreamString stream;
2982   stream.PutCString("qPlatform_mkdir:");
2983   stream.PutHex32(file_permissions);
2984   stream.PutChar(',');
2985   stream.PutStringAsRawHex8(path);
2986   llvm::StringRef packet = stream.GetString();
2987   StringExtractorGDBRemote response;
2988 
2989   if (SendPacketAndWaitForResponse(packet, response) != PacketResult::Success)
2990     return Status("failed to send '%s' packet", packet.str().c_str());
2991 
2992   if (response.GetChar() != 'F')
2993     return Status("invalid response to '%s' packet", packet.str().c_str());
2994 
2995   return Status(response.GetHexMaxU32(false, UINT32_MAX), eErrorTypePOSIX);
2996 }
2997 
2998 Status
2999 GDBRemoteCommunicationClient::SetFilePermissions(const FileSpec &file_spec,
3000                                                  uint32_t file_permissions) {
3001   std::string path{file_spec.GetPath(false)};
3002   lldb_private::StreamString stream;
3003   stream.PutCString("qPlatform_chmod:");
3004   stream.PutHex32(file_permissions);
3005   stream.PutChar(',');
3006   stream.PutStringAsRawHex8(path);
3007   llvm::StringRef packet = stream.GetString();
3008   StringExtractorGDBRemote response;
3009 
3010   if (SendPacketAndWaitForResponse(packet, response) != PacketResult::Success)
3011     return Status("failed to send '%s' packet", stream.GetData());
3012 
3013   if (response.GetChar() != 'F')
3014     return Status("invalid response to '%s' packet", stream.GetData());
3015 
3016   return Status(response.GetHexMaxU32(false, UINT32_MAX), eErrorTypePOSIX);
3017 }
3018 
3019 static int gdb_errno_to_system(int err) {
3020   switch (err) {
3021 #define HANDLE_ERRNO(name, value)                                              \
3022   case GDB_##name:                                                             \
3023     return name;
3024 #include "Plugins/Process/gdb-remote/GDBRemoteErrno.def"
3025   default:
3026     return -1;
3027   }
3028 }
3029 
3030 static uint64_t ParseHostIOPacketResponse(StringExtractorGDBRemote &response,
3031                                           uint64_t fail_result, Status &error) {
3032   response.SetFilePos(0);
3033   if (response.GetChar() != 'F')
3034     return fail_result;
3035   int32_t result = response.GetS32(-2, 16);
3036   if (result == -2)
3037     return fail_result;
3038   if (response.GetChar() == ',') {
3039     int result_errno = gdb_errno_to_system(response.GetS32(-1, 16));
3040     if (result_errno != -1)
3041       error.SetError(result_errno, eErrorTypePOSIX);
3042     else
3043       error.SetError(-1, eErrorTypeGeneric);
3044   } else
3045     error.Clear();
3046   return result;
3047 }
3048 lldb::user_id_t
3049 GDBRemoteCommunicationClient::OpenFile(const lldb_private::FileSpec &file_spec,
3050                                        File::OpenOptions flags, mode_t mode,
3051                                        Status &error) {
3052   std::string path(file_spec.GetPath(false));
3053   lldb_private::StreamString stream;
3054   stream.PutCString("vFile:open:");
3055   if (path.empty())
3056     return UINT64_MAX;
3057   stream.PutStringAsRawHex8(path);
3058   stream.PutChar(',');
3059   stream.PutHex32(flags);
3060   stream.PutChar(',');
3061   stream.PutHex32(mode);
3062   StringExtractorGDBRemote response;
3063   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
3064       PacketResult::Success) {
3065     return ParseHostIOPacketResponse(response, UINT64_MAX, error);
3066   }
3067   return UINT64_MAX;
3068 }
3069 
3070 bool GDBRemoteCommunicationClient::CloseFile(lldb::user_id_t fd,
3071                                              Status &error) {
3072   lldb_private::StreamString stream;
3073   stream.Printf("vFile:close:%x", (int)fd);
3074   StringExtractorGDBRemote response;
3075   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
3076       PacketResult::Success) {
3077     return ParseHostIOPacketResponse(response, -1, error) == 0;
3078   }
3079   return false;
3080 }
3081 
3082 llvm::Optional<GDBRemoteFStatData>
3083 GDBRemoteCommunicationClient::FStat(lldb::user_id_t fd) {
3084   lldb_private::StreamString stream;
3085   stream.Printf("vFile:fstat:%" PRIx64, fd);
3086   StringExtractorGDBRemote response;
3087   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
3088       PacketResult::Success) {
3089     if (response.GetChar() != 'F')
3090       return llvm::None;
3091     int64_t size = response.GetS64(-1, 16);
3092     if (size > 0 && response.GetChar() == ';') {
3093       std::string buffer;
3094       if (response.GetEscapedBinaryData(buffer)) {
3095         GDBRemoteFStatData out;
3096         if (buffer.size() != sizeof(out))
3097           return llvm::None;
3098         memcpy(&out, buffer.data(), sizeof(out));
3099         return out;
3100       }
3101     }
3102   }
3103   return llvm::None;
3104 }
3105 
3106 llvm::Optional<GDBRemoteFStatData>
3107 GDBRemoteCommunicationClient::Stat(const lldb_private::FileSpec &file_spec) {
3108   Status error;
3109   lldb::user_id_t fd = OpenFile(file_spec, File::eOpenOptionReadOnly, 0, error);
3110   if (fd == UINT64_MAX)
3111     return llvm::None;
3112   llvm::Optional<GDBRemoteFStatData> st = FStat(fd);
3113   CloseFile(fd, error);
3114   return st;
3115 }
3116 
3117 // Extension of host I/O packets to get the file size.
3118 lldb::user_id_t GDBRemoteCommunicationClient::GetFileSize(
3119     const lldb_private::FileSpec &file_spec) {
3120   if (m_supports_vFileSize) {
3121     std::string path(file_spec.GetPath(false));
3122     lldb_private::StreamString stream;
3123     stream.PutCString("vFile:size:");
3124     stream.PutStringAsRawHex8(path);
3125     StringExtractorGDBRemote response;
3126     if (SendPacketAndWaitForResponse(stream.GetString(), response) !=
3127         PacketResult::Success)
3128       return UINT64_MAX;
3129 
3130     if (!response.IsUnsupportedResponse()) {
3131       if (response.GetChar() != 'F')
3132         return UINT64_MAX;
3133       uint32_t retcode = response.GetHexMaxU64(false, UINT64_MAX);
3134       return retcode;
3135     }
3136     m_supports_vFileSize = false;
3137   }
3138 
3139   // Fallback to fstat.
3140   llvm::Optional<GDBRemoteFStatData> st = Stat(file_spec);
3141   return st ? st->gdb_st_size : UINT64_MAX;
3142 }
3143 
3144 void GDBRemoteCommunicationClient::AutoCompleteDiskFileOrDirectory(
3145     CompletionRequest &request, bool only_dir) {
3146   lldb_private::StreamString stream;
3147   stream.PutCString("qPathComplete:");
3148   stream.PutHex32(only_dir ? 1 : 0);
3149   stream.PutChar(',');
3150   stream.PutStringAsRawHex8(request.GetCursorArgumentPrefix());
3151   StringExtractorGDBRemote response;
3152   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
3153       PacketResult::Success) {
3154     StreamString strm;
3155     char ch = response.GetChar();
3156     if (ch != 'M')
3157       return;
3158     while (response.Peek()) {
3159       strm.Clear();
3160       while ((ch = response.GetHexU8(0, false)) != '\0')
3161         strm.PutChar(ch);
3162       request.AddCompletion(strm.GetString());
3163       if (response.GetChar() != ',')
3164         break;
3165     }
3166   }
3167 }
3168 
3169 Status
3170 GDBRemoteCommunicationClient::GetFilePermissions(const FileSpec &file_spec,
3171                                                  uint32_t &file_permissions) {
3172   if (m_supports_vFileMode) {
3173     std::string path{file_spec.GetPath(false)};
3174     Status error;
3175     lldb_private::StreamString stream;
3176     stream.PutCString("vFile:mode:");
3177     stream.PutStringAsRawHex8(path);
3178     StringExtractorGDBRemote response;
3179     if (SendPacketAndWaitForResponse(stream.GetString(), response) !=
3180         PacketResult::Success) {
3181       error.SetErrorStringWithFormat("failed to send '%s' packet",
3182                                      stream.GetData());
3183       return error;
3184     }
3185     if (!response.IsUnsupportedResponse()) {
3186       if (response.GetChar() != 'F') {
3187         error.SetErrorStringWithFormat("invalid response to '%s' packet",
3188                                        stream.GetData());
3189       } else {
3190         const uint32_t mode = response.GetS32(-1, 16);
3191         if (static_cast<int32_t>(mode) == -1) {
3192           if (response.GetChar() == ',') {
3193             int response_errno = gdb_errno_to_system(response.GetS32(-1, 16));
3194             if (response_errno > 0)
3195               error.SetError(response_errno, lldb::eErrorTypePOSIX);
3196             else
3197               error.SetErrorToGenericError();
3198           } else
3199             error.SetErrorToGenericError();
3200         } else {
3201           file_permissions = mode & (S_IRWXU | S_IRWXG | S_IRWXO);
3202         }
3203       }
3204       return error;
3205     } else { // response.IsUnsupportedResponse()
3206       m_supports_vFileMode = false;
3207     }
3208   }
3209 
3210   // Fallback to fstat.
3211   if (llvm::Optional<GDBRemoteFStatData> st = Stat(file_spec)) {
3212     file_permissions = st->gdb_st_mode & (S_IRWXU | S_IRWXG | S_IRWXO);
3213     return Status();
3214   }
3215   return Status("fstat failed");
3216 }
3217 
3218 uint64_t GDBRemoteCommunicationClient::ReadFile(lldb::user_id_t fd,
3219                                                 uint64_t offset, void *dst,
3220                                                 uint64_t dst_len,
3221                                                 Status &error) {
3222   lldb_private::StreamString stream;
3223   stream.Printf("vFile:pread:%x,%" PRIx64 ",%" PRIx64, (int)fd, dst_len,
3224                 offset);
3225   StringExtractorGDBRemote response;
3226   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
3227       PacketResult::Success) {
3228     if (response.GetChar() != 'F')
3229       return 0;
3230     int64_t retcode = response.GetS64(-1, 16);
3231     if (retcode == -1) {
3232       error.SetErrorToGenericError();
3233       if (response.GetChar() == ',') {
3234         int response_errno = gdb_errno_to_system(response.GetS32(-1, 16));
3235         if (response_errno > 0)
3236           error.SetError(response_errno, lldb::eErrorTypePOSIX);
3237       }
3238       return -1;
3239     }
3240     const char next = (response.Peek() ? *response.Peek() : 0);
3241     if (next == ',')
3242       return 0;
3243     if (next == ';') {
3244       response.GetChar(); // skip the semicolon
3245       std::string buffer;
3246       if (response.GetEscapedBinaryData(buffer)) {
3247         const uint64_t data_to_write =
3248             std::min<uint64_t>(dst_len, buffer.size());
3249         if (data_to_write > 0)
3250           memcpy(dst, &buffer[0], data_to_write);
3251         return data_to_write;
3252       }
3253     }
3254   }
3255   return 0;
3256 }
3257 
3258 uint64_t GDBRemoteCommunicationClient::WriteFile(lldb::user_id_t fd,
3259                                                  uint64_t offset,
3260                                                  const void *src,
3261                                                  uint64_t src_len,
3262                                                  Status &error) {
3263   lldb_private::StreamGDBRemote stream;
3264   stream.Printf("vFile:pwrite:%x,%" PRIx64 ",", (int)fd, offset);
3265   stream.PutEscapedBytes(src, src_len);
3266   StringExtractorGDBRemote response;
3267   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
3268       PacketResult::Success) {
3269     if (response.GetChar() != 'F') {
3270       error.SetErrorStringWithFormat("write file failed");
3271       return 0;
3272     }
3273     int64_t bytes_written = response.GetS64(-1, 16);
3274     if (bytes_written == -1) {
3275       error.SetErrorToGenericError();
3276       if (response.GetChar() == ',') {
3277         int response_errno = gdb_errno_to_system(response.GetS32(-1, 16));
3278         if (response_errno > 0)
3279           error.SetError(response_errno, lldb::eErrorTypePOSIX);
3280       }
3281       return -1;
3282     }
3283     return bytes_written;
3284   } else {
3285     error.SetErrorString("failed to send vFile:pwrite packet");
3286   }
3287   return 0;
3288 }
3289 
3290 Status GDBRemoteCommunicationClient::CreateSymlink(const FileSpec &src,
3291                                                    const FileSpec &dst) {
3292   std::string src_path{src.GetPath(false)}, dst_path{dst.GetPath(false)};
3293   Status error;
3294   lldb_private::StreamGDBRemote stream;
3295   stream.PutCString("vFile:symlink:");
3296   // the unix symlink() command reverses its parameters where the dst if first,
3297   // so we follow suit here
3298   stream.PutStringAsRawHex8(dst_path);
3299   stream.PutChar(',');
3300   stream.PutStringAsRawHex8(src_path);
3301   StringExtractorGDBRemote response;
3302   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
3303       PacketResult::Success) {
3304     if (response.GetChar() == 'F') {
3305       uint32_t result = response.GetHexMaxU32(false, UINT32_MAX);
3306       if (result != 0) {
3307         error.SetErrorToGenericError();
3308         if (response.GetChar() == ',') {
3309           int response_errno = gdb_errno_to_system(response.GetS32(-1, 16));
3310           if (response_errno > 0)
3311             error.SetError(response_errno, lldb::eErrorTypePOSIX);
3312         }
3313       }
3314     } else {
3315       // Should have returned with 'F<result>[,<errno>]'
3316       error.SetErrorStringWithFormat("symlink failed");
3317     }
3318   } else {
3319     error.SetErrorString("failed to send vFile:symlink packet");
3320   }
3321   return error;
3322 }
3323 
3324 Status GDBRemoteCommunicationClient::Unlink(const FileSpec &file_spec) {
3325   std::string path{file_spec.GetPath(false)};
3326   Status error;
3327   lldb_private::StreamGDBRemote stream;
3328   stream.PutCString("vFile:unlink:");
3329   // the unix symlink() command reverses its parameters where the dst if first,
3330   // so we follow suit here
3331   stream.PutStringAsRawHex8(path);
3332   StringExtractorGDBRemote response;
3333   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
3334       PacketResult::Success) {
3335     if (response.GetChar() == 'F') {
3336       uint32_t result = response.GetHexMaxU32(false, UINT32_MAX);
3337       if (result != 0) {
3338         error.SetErrorToGenericError();
3339         if (response.GetChar() == ',') {
3340           int response_errno = gdb_errno_to_system(response.GetS32(-1, 16));
3341           if (response_errno > 0)
3342             error.SetError(response_errno, lldb::eErrorTypePOSIX);
3343         }
3344       }
3345     } else {
3346       // Should have returned with 'F<result>[,<errno>]'
3347       error.SetErrorStringWithFormat("unlink failed");
3348     }
3349   } else {
3350     error.SetErrorString("failed to send vFile:unlink packet");
3351   }
3352   return error;
3353 }
3354 
3355 // Extension of host I/O packets to get whether a file exists.
3356 bool GDBRemoteCommunicationClient::GetFileExists(
3357     const lldb_private::FileSpec &file_spec) {
3358   if (m_supports_vFileExists) {
3359     std::string path(file_spec.GetPath(false));
3360     lldb_private::StreamString stream;
3361     stream.PutCString("vFile:exists:");
3362     stream.PutStringAsRawHex8(path);
3363     StringExtractorGDBRemote response;
3364     if (SendPacketAndWaitForResponse(stream.GetString(), response) !=
3365         PacketResult::Success)
3366       return false;
3367     if (!response.IsUnsupportedResponse()) {
3368       if (response.GetChar() != 'F')
3369         return false;
3370       if (response.GetChar() != ',')
3371         return false;
3372       bool retcode = (response.GetChar() != '0');
3373       return retcode;
3374     } else
3375       m_supports_vFileExists = false;
3376   }
3377 
3378   // Fallback to open.
3379   Status error;
3380   lldb::user_id_t fd = OpenFile(file_spec, File::eOpenOptionReadOnly, 0, error);
3381   if (fd == UINT64_MAX)
3382     return false;
3383   CloseFile(fd, error);
3384   return true;
3385 }
3386 
3387 bool GDBRemoteCommunicationClient::CalculateMD5(
3388     const lldb_private::FileSpec &file_spec, uint64_t &high, uint64_t &low) {
3389   std::string path(file_spec.GetPath(false));
3390   lldb_private::StreamString stream;
3391   stream.PutCString("vFile:MD5:");
3392   stream.PutStringAsRawHex8(path);
3393   StringExtractorGDBRemote response;
3394   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
3395       PacketResult::Success) {
3396     if (response.GetChar() != 'F')
3397       return false;
3398     if (response.GetChar() != ',')
3399       return false;
3400     if (response.Peek() && *response.Peek() == 'x')
3401       return false;
3402     low = response.GetHexMaxU64(false, UINT64_MAX);
3403     high = response.GetHexMaxU64(false, UINT64_MAX);
3404     return true;
3405   }
3406   return false;
3407 }
3408 
3409 bool GDBRemoteCommunicationClient::AvoidGPackets(ProcessGDBRemote *process) {
3410   // Some targets have issues with g/G packets and we need to avoid using them
3411   if (m_avoid_g_packets == eLazyBoolCalculate) {
3412     if (process) {
3413       m_avoid_g_packets = eLazyBoolNo;
3414       const ArchSpec &arch = process->GetTarget().GetArchitecture();
3415       if (arch.IsValid() &&
3416           arch.GetTriple().getVendor() == llvm::Triple::Apple &&
3417           arch.GetTriple().getOS() == llvm::Triple::IOS &&
3418           (arch.GetTriple().getArch() == llvm::Triple::aarch64 ||
3419            arch.GetTriple().getArch() == llvm::Triple::aarch64_32)) {
3420         m_avoid_g_packets = eLazyBoolYes;
3421         uint32_t gdb_server_version = GetGDBServerProgramVersion();
3422         if (gdb_server_version != 0) {
3423           const char *gdb_server_name = GetGDBServerProgramName();
3424           if (gdb_server_name && strcmp(gdb_server_name, "debugserver") == 0) {
3425             if (gdb_server_version >= 310)
3426               m_avoid_g_packets = eLazyBoolNo;
3427           }
3428         }
3429       }
3430     }
3431   }
3432   return m_avoid_g_packets == eLazyBoolYes;
3433 }
3434 
3435 DataBufferSP GDBRemoteCommunicationClient::ReadRegister(lldb::tid_t tid,
3436                                                         uint32_t reg) {
3437   StreamString payload;
3438   payload.Printf("p%x", reg);
3439   StringExtractorGDBRemote response;
3440   if (SendThreadSpecificPacketAndWaitForResponse(
3441           tid, std::move(payload), response) != PacketResult::Success ||
3442       !response.IsNormalResponse())
3443     return nullptr;
3444 
3445   WritableDataBufferSP buffer_sp(
3446       new DataBufferHeap(response.GetStringRef().size() / 2, 0));
3447   response.GetHexBytes(buffer_sp->GetData(), '\xcc');
3448   return buffer_sp;
3449 }
3450 
3451 DataBufferSP GDBRemoteCommunicationClient::ReadAllRegisters(lldb::tid_t tid) {
3452   StreamString payload;
3453   payload.PutChar('g');
3454   StringExtractorGDBRemote response;
3455   if (SendThreadSpecificPacketAndWaitForResponse(
3456           tid, std::move(payload), response) != PacketResult::Success ||
3457       !response.IsNormalResponse())
3458     return nullptr;
3459 
3460   WritableDataBufferSP buffer_sp(
3461       new DataBufferHeap(response.GetStringRef().size() / 2, 0));
3462   response.GetHexBytes(buffer_sp->GetData(), '\xcc');
3463   return buffer_sp;
3464 }
3465 
3466 bool GDBRemoteCommunicationClient::WriteRegister(lldb::tid_t tid,
3467                                                  uint32_t reg_num,
3468                                                  llvm::ArrayRef<uint8_t> data) {
3469   StreamString payload;
3470   payload.Printf("P%x=", reg_num);
3471   payload.PutBytesAsRawHex8(data.data(), data.size(),
3472                             endian::InlHostByteOrder(),
3473                             endian::InlHostByteOrder());
3474   StringExtractorGDBRemote response;
3475   return SendThreadSpecificPacketAndWaitForResponse(
3476              tid, std::move(payload), response) == PacketResult::Success &&
3477          response.IsOKResponse();
3478 }
3479 
3480 bool GDBRemoteCommunicationClient::WriteAllRegisters(
3481     lldb::tid_t tid, llvm::ArrayRef<uint8_t> data) {
3482   StreamString payload;
3483   payload.PutChar('G');
3484   payload.PutBytesAsRawHex8(data.data(), data.size(),
3485                             endian::InlHostByteOrder(),
3486                             endian::InlHostByteOrder());
3487   StringExtractorGDBRemote response;
3488   return SendThreadSpecificPacketAndWaitForResponse(
3489              tid, std::move(payload), response) == PacketResult::Success &&
3490          response.IsOKResponse();
3491 }
3492 
3493 bool GDBRemoteCommunicationClient::SaveRegisterState(lldb::tid_t tid,
3494                                                      uint32_t &save_id) {
3495   save_id = 0; // Set to invalid save ID
3496   if (m_supports_QSaveRegisterState == eLazyBoolNo)
3497     return false;
3498 
3499   m_supports_QSaveRegisterState = eLazyBoolYes;
3500   StreamString payload;
3501   payload.PutCString("QSaveRegisterState");
3502   StringExtractorGDBRemote response;
3503   if (SendThreadSpecificPacketAndWaitForResponse(
3504           tid, std::move(payload), response) != PacketResult::Success)
3505     return false;
3506 
3507   if (response.IsUnsupportedResponse())
3508     m_supports_QSaveRegisterState = eLazyBoolNo;
3509 
3510   const uint32_t response_save_id = response.GetU32(0);
3511   if (response_save_id == 0)
3512     return false;
3513 
3514   save_id = response_save_id;
3515   return true;
3516 }
3517 
3518 bool GDBRemoteCommunicationClient::RestoreRegisterState(lldb::tid_t tid,
3519                                                         uint32_t save_id) {
3520   // We use the "m_supports_QSaveRegisterState" variable here because the
3521   // QSaveRegisterState and QRestoreRegisterState packets must both be
3522   // supported in order to be useful
3523   if (m_supports_QSaveRegisterState == eLazyBoolNo)
3524     return false;
3525 
3526   StreamString payload;
3527   payload.Printf("QRestoreRegisterState:%u", save_id);
3528   StringExtractorGDBRemote response;
3529   if (SendThreadSpecificPacketAndWaitForResponse(
3530           tid, std::move(payload), response) != PacketResult::Success)
3531     return false;
3532 
3533   if (response.IsOKResponse())
3534     return true;
3535 
3536   if (response.IsUnsupportedResponse())
3537     m_supports_QSaveRegisterState = eLazyBoolNo;
3538   return false;
3539 }
3540 
3541 bool GDBRemoteCommunicationClient::SyncThreadState(lldb::tid_t tid) {
3542   if (!GetSyncThreadStateSupported())
3543     return false;
3544 
3545   StreamString packet;
3546   StringExtractorGDBRemote response;
3547   packet.Printf("QSyncThreadState:%4.4" PRIx64 ";", tid);
3548   return SendPacketAndWaitForResponse(packet.GetString(), response) ==
3549              GDBRemoteCommunication::PacketResult::Success &&
3550          response.IsOKResponse();
3551 }
3552 
3553 llvm::Expected<TraceSupportedResponse>
3554 GDBRemoteCommunicationClient::SendTraceSupported(std::chrono::seconds timeout) {
3555   Log *log = GetLog(GDBRLog::Process);
3556 
3557   StreamGDBRemote escaped_packet;
3558   escaped_packet.PutCString("jLLDBTraceSupported");
3559 
3560   StringExtractorGDBRemote response;
3561   if (SendPacketAndWaitForResponse(escaped_packet.GetString(), response,
3562                                    timeout) ==
3563       GDBRemoteCommunication::PacketResult::Success) {
3564     if (response.IsErrorResponse())
3565       return response.GetStatus().ToError();
3566     if (response.IsUnsupportedResponse())
3567       return llvm::createStringError(llvm::inconvertibleErrorCode(),
3568                                      "jLLDBTraceSupported is unsupported");
3569 
3570     return llvm::json::parse<TraceSupportedResponse>(response.Peek(),
3571                                                      "TraceSupportedResponse");
3572   }
3573   LLDB_LOG(log, "failed to send packet: jLLDBTraceSupported");
3574   return llvm::createStringError(llvm::inconvertibleErrorCode(),
3575                                  "failed to send packet: jLLDBTraceSupported");
3576 }
3577 
3578 llvm::Error
3579 GDBRemoteCommunicationClient::SendTraceStop(const TraceStopRequest &request,
3580                                             std::chrono::seconds timeout) {
3581   Log *log = GetLog(GDBRLog::Process);
3582 
3583   StreamGDBRemote escaped_packet;
3584   escaped_packet.PutCString("jLLDBTraceStop:");
3585 
3586   std::string json_string;
3587   llvm::raw_string_ostream os(json_string);
3588   os << toJSON(request);
3589   os.flush();
3590 
3591   escaped_packet.PutEscapedBytes(json_string.c_str(), json_string.size());
3592 
3593   StringExtractorGDBRemote response;
3594   if (SendPacketAndWaitForResponse(escaped_packet.GetString(), response,
3595                                    timeout) ==
3596       GDBRemoteCommunication::PacketResult::Success) {
3597     if (response.IsErrorResponse())
3598       return response.GetStatus().ToError();
3599     if (response.IsUnsupportedResponse())
3600       return llvm::createStringError(llvm::inconvertibleErrorCode(),
3601                                      "jLLDBTraceStop is unsupported");
3602     if (response.IsOKResponse())
3603       return llvm::Error::success();
3604     return llvm::createStringError(llvm::inconvertibleErrorCode(),
3605                                    "Invalid jLLDBTraceStart response");
3606   }
3607   LLDB_LOG(log, "failed to send packet: jLLDBTraceStop");
3608   return llvm::createStringError(llvm::inconvertibleErrorCode(),
3609                                  "failed to send packet: jLLDBTraceStop '%s'",
3610                                  escaped_packet.GetData());
3611 }
3612 
3613 llvm::Error
3614 GDBRemoteCommunicationClient::SendTraceStart(const llvm::json::Value &params,
3615                                              std::chrono::seconds timeout) {
3616   Log *log = GetLog(GDBRLog::Process);
3617 
3618   StreamGDBRemote escaped_packet;
3619   escaped_packet.PutCString("jLLDBTraceStart:");
3620 
3621   std::string json_string;
3622   llvm::raw_string_ostream os(json_string);
3623   os << params;
3624   os.flush();
3625 
3626   escaped_packet.PutEscapedBytes(json_string.c_str(), json_string.size());
3627 
3628   StringExtractorGDBRemote response;
3629   if (SendPacketAndWaitForResponse(escaped_packet.GetString(), response,
3630                                    timeout) ==
3631       GDBRemoteCommunication::PacketResult::Success) {
3632     if (response.IsErrorResponse())
3633       return response.GetStatus().ToError();
3634     if (response.IsUnsupportedResponse())
3635       return llvm::createStringError(llvm::inconvertibleErrorCode(),
3636                                      "jLLDBTraceStart is unsupported");
3637     if (response.IsOKResponse())
3638       return llvm::Error::success();
3639     return llvm::createStringError(llvm::inconvertibleErrorCode(),
3640                                    "Invalid jLLDBTraceStart response");
3641   }
3642   LLDB_LOG(log, "failed to send packet: jLLDBTraceStart");
3643   return llvm::createStringError(llvm::inconvertibleErrorCode(),
3644                                  "failed to send packet: jLLDBTraceStart '%s'",
3645                                  escaped_packet.GetData());
3646 }
3647 
3648 llvm::Expected<std::string>
3649 GDBRemoteCommunicationClient::SendTraceGetState(llvm::StringRef type,
3650                                                 std::chrono::seconds timeout) {
3651   Log *log = GetLog(GDBRLog::Process);
3652 
3653   StreamGDBRemote escaped_packet;
3654   escaped_packet.PutCString("jLLDBTraceGetState:");
3655 
3656   std::string json_string;
3657   llvm::raw_string_ostream os(json_string);
3658   os << toJSON(TraceGetStateRequest{type.str()});
3659   os.flush();
3660 
3661   escaped_packet.PutEscapedBytes(json_string.c_str(), json_string.size());
3662 
3663   StringExtractorGDBRemote response;
3664   if (SendPacketAndWaitForResponse(escaped_packet.GetString(), response,
3665                                    timeout) ==
3666       GDBRemoteCommunication::PacketResult::Success) {
3667     if (response.IsErrorResponse())
3668       return response.GetStatus().ToError();
3669     if (response.IsUnsupportedResponse())
3670       return llvm::createStringError(llvm::inconvertibleErrorCode(),
3671                                      "jLLDBTraceGetState is unsupported");
3672     return std::string(response.Peek());
3673   }
3674 
3675   LLDB_LOG(log, "failed to send packet: jLLDBTraceGetState");
3676   return llvm::createStringError(
3677       llvm::inconvertibleErrorCode(),
3678       "failed to send packet: jLLDBTraceGetState '%s'",
3679       escaped_packet.GetData());
3680 }
3681 
3682 llvm::Expected<std::vector<uint8_t>>
3683 GDBRemoteCommunicationClient::SendTraceGetBinaryData(
3684     const TraceGetBinaryDataRequest &request, std::chrono::seconds timeout) {
3685   Log *log = GetLog(GDBRLog::Process);
3686 
3687   StreamGDBRemote escaped_packet;
3688   escaped_packet.PutCString("jLLDBTraceGetBinaryData:");
3689 
3690   std::string json_string;
3691   llvm::raw_string_ostream os(json_string);
3692   os << toJSON(request);
3693   os.flush();
3694 
3695   escaped_packet.PutEscapedBytes(json_string.c_str(), json_string.size());
3696 
3697   StringExtractorGDBRemote response;
3698   if (SendPacketAndWaitForResponse(escaped_packet.GetString(), response,
3699                                    timeout) ==
3700       GDBRemoteCommunication::PacketResult::Success) {
3701     if (response.IsErrorResponse())
3702       return response.GetStatus().ToError();
3703     if (response.IsUnsupportedResponse())
3704       return llvm::createStringError(llvm::inconvertibleErrorCode(),
3705                                      "jLLDBTraceGetBinaryData is unsupported");
3706     std::string data;
3707     response.GetEscapedBinaryData(data);
3708     return std::vector<uint8_t>(data.begin(), data.end());
3709   }
3710   LLDB_LOG(log, "failed to send packet: jLLDBTraceGetBinaryData");
3711   return llvm::createStringError(
3712       llvm::inconvertibleErrorCode(),
3713       "failed to send packet: jLLDBTraceGetBinaryData '%s'",
3714       escaped_packet.GetData());
3715 }
3716 
3717 llvm::Optional<QOffsets> GDBRemoteCommunicationClient::GetQOffsets() {
3718   StringExtractorGDBRemote response;
3719   if (SendPacketAndWaitForResponse("qOffsets", response) !=
3720       PacketResult::Success)
3721     return llvm::None;
3722   if (!response.IsNormalResponse())
3723     return llvm::None;
3724 
3725   QOffsets result;
3726   llvm::StringRef ref = response.GetStringRef();
3727   const auto &GetOffset = [&] {
3728     addr_t offset;
3729     if (ref.consumeInteger(16, offset))
3730       return false;
3731     result.offsets.push_back(offset);
3732     return true;
3733   };
3734 
3735   if (ref.consume_front("Text=")) {
3736     result.segments = false;
3737     if (!GetOffset())
3738       return llvm::None;
3739     if (!ref.consume_front(";Data=") || !GetOffset())
3740       return llvm::None;
3741     if (ref.empty())
3742       return result;
3743     if (ref.consume_front(";Bss=") && GetOffset() && ref.empty())
3744       return result;
3745   } else if (ref.consume_front("TextSeg=")) {
3746     result.segments = true;
3747     if (!GetOffset())
3748       return llvm::None;
3749     if (ref.empty())
3750       return result;
3751     if (ref.consume_front(";DataSeg=") && GetOffset() && ref.empty())
3752       return result;
3753   }
3754   return llvm::None;
3755 }
3756 
3757 bool GDBRemoteCommunicationClient::GetModuleInfo(
3758     const FileSpec &module_file_spec, const lldb_private::ArchSpec &arch_spec,
3759     ModuleSpec &module_spec) {
3760   if (!m_supports_qModuleInfo)
3761     return false;
3762 
3763   std::string module_path = module_file_spec.GetPath(false);
3764   if (module_path.empty())
3765     return false;
3766 
3767   StreamString packet;
3768   packet.PutCString("qModuleInfo:");
3769   packet.PutStringAsRawHex8(module_path);
3770   packet.PutCString(";");
3771   const auto &triple = arch_spec.GetTriple().getTriple();
3772   packet.PutStringAsRawHex8(triple);
3773 
3774   StringExtractorGDBRemote response;
3775   if (SendPacketAndWaitForResponse(packet.GetString(), response) !=
3776       PacketResult::Success)
3777     return false;
3778 
3779   if (response.IsErrorResponse())
3780     return false;
3781 
3782   if (response.IsUnsupportedResponse()) {
3783     m_supports_qModuleInfo = false;
3784     return false;
3785   }
3786 
3787   llvm::StringRef name;
3788   llvm::StringRef value;
3789 
3790   module_spec.Clear();
3791   module_spec.GetFileSpec() = module_file_spec;
3792 
3793   while (response.GetNameColonValue(name, value)) {
3794     if (name == "uuid" || name == "md5") {
3795       StringExtractor extractor(value);
3796       std::string uuid;
3797       extractor.GetHexByteString(uuid);
3798       module_spec.GetUUID().SetFromStringRef(uuid);
3799     } else if (name == "triple") {
3800       StringExtractor extractor(value);
3801       std::string triple;
3802       extractor.GetHexByteString(triple);
3803       module_spec.GetArchitecture().SetTriple(triple.c_str());
3804     } else if (name == "file_offset") {
3805       uint64_t ival = 0;
3806       if (!value.getAsInteger(16, ival))
3807         module_spec.SetObjectOffset(ival);
3808     } else if (name == "file_size") {
3809       uint64_t ival = 0;
3810       if (!value.getAsInteger(16, ival))
3811         module_spec.SetObjectSize(ival);
3812     } else if (name == "file_path") {
3813       StringExtractor extractor(value);
3814       std::string path;
3815       extractor.GetHexByteString(path);
3816       module_spec.GetFileSpec() = FileSpec(path, arch_spec.GetTriple());
3817     }
3818   }
3819 
3820   return true;
3821 }
3822 
3823 static llvm::Optional<ModuleSpec>
3824 ParseModuleSpec(StructuredData::Dictionary *dict) {
3825   ModuleSpec result;
3826   if (!dict)
3827     return llvm::None;
3828 
3829   llvm::StringRef string;
3830   uint64_t integer;
3831 
3832   if (!dict->GetValueForKeyAsString("uuid", string))
3833     return llvm::None;
3834   if (!result.GetUUID().SetFromStringRef(string))
3835     return llvm::None;
3836 
3837   if (!dict->GetValueForKeyAsInteger("file_offset", integer))
3838     return llvm::None;
3839   result.SetObjectOffset(integer);
3840 
3841   if (!dict->GetValueForKeyAsInteger("file_size", integer))
3842     return llvm::None;
3843   result.SetObjectSize(integer);
3844 
3845   if (!dict->GetValueForKeyAsString("triple", string))
3846     return llvm::None;
3847   result.GetArchitecture().SetTriple(string);
3848 
3849   if (!dict->GetValueForKeyAsString("file_path", string))
3850     return llvm::None;
3851   result.GetFileSpec() = FileSpec(string, result.GetArchitecture().GetTriple());
3852 
3853   return result;
3854 }
3855 
3856 llvm::Optional<std::vector<ModuleSpec>>
3857 GDBRemoteCommunicationClient::GetModulesInfo(
3858     llvm::ArrayRef<FileSpec> module_file_specs, const llvm::Triple &triple) {
3859   namespace json = llvm::json;
3860 
3861   if (!m_supports_jModulesInfo)
3862     return llvm::None;
3863 
3864   json::Array module_array;
3865   for (const FileSpec &module_file_spec : module_file_specs) {
3866     module_array.push_back(
3867         json::Object{{"file", module_file_spec.GetPath(false)},
3868                      {"triple", triple.getTriple()}});
3869   }
3870   StreamString unescaped_payload;
3871   unescaped_payload.PutCString("jModulesInfo:");
3872   unescaped_payload.AsRawOstream() << std::move(module_array);
3873 
3874   StreamGDBRemote payload;
3875   payload.PutEscapedBytes(unescaped_payload.GetString().data(),
3876                           unescaped_payload.GetSize());
3877 
3878   // Increase the timeout for jModulesInfo since this packet can take longer.
3879   ScopedTimeout timeout(*this, std::chrono::seconds(10));
3880 
3881   StringExtractorGDBRemote response;
3882   if (SendPacketAndWaitForResponse(payload.GetString(), response) !=
3883           PacketResult::Success ||
3884       response.IsErrorResponse())
3885     return llvm::None;
3886 
3887   if (response.IsUnsupportedResponse()) {
3888     m_supports_jModulesInfo = false;
3889     return llvm::None;
3890   }
3891 
3892   StructuredData::ObjectSP response_object_sp =
3893       StructuredData::ParseJSON(std::string(response.GetStringRef()));
3894   if (!response_object_sp)
3895     return llvm::None;
3896 
3897   StructuredData::Array *response_array = response_object_sp->GetAsArray();
3898   if (!response_array)
3899     return llvm::None;
3900 
3901   std::vector<ModuleSpec> result;
3902   for (size_t i = 0; i < response_array->GetSize(); ++i) {
3903     if (llvm::Optional<ModuleSpec> module_spec = ParseModuleSpec(
3904             response_array->GetItemAtIndex(i)->GetAsDictionary()))
3905       result.push_back(*module_spec);
3906   }
3907 
3908   return result;
3909 }
3910 
3911 // query the target remote for extended information using the qXfer packet
3912 //
3913 // example: object='features', annex='target.xml'
3914 // return: <xml output> or error
3915 llvm::Expected<std::string>
3916 GDBRemoteCommunicationClient::ReadExtFeature(llvm::StringRef object,
3917                                              llvm::StringRef annex) {
3918 
3919   std::string output;
3920   llvm::raw_string_ostream output_stream(output);
3921   StringExtractorGDBRemote chunk;
3922 
3923   uint64_t size = GetRemoteMaxPacketSize();
3924   if (size == 0)
3925     size = 0x1000;
3926   size = size - 1; // Leave space for the 'm' or 'l' character in the response
3927   int offset = 0;
3928   bool active = true;
3929 
3930   // loop until all data has been read
3931   while (active) {
3932 
3933     // send query extended feature packet
3934     std::string packet =
3935         ("qXfer:" + object + ":read:" + annex + ":" +
3936          llvm::Twine::utohexstr(offset) + "," + llvm::Twine::utohexstr(size))
3937             .str();
3938 
3939     GDBRemoteCommunication::PacketResult res =
3940         SendPacketAndWaitForResponse(packet, chunk);
3941 
3942     if (res != GDBRemoteCommunication::PacketResult::Success ||
3943         chunk.GetStringRef().empty()) {
3944       return llvm::createStringError(llvm::inconvertibleErrorCode(),
3945                                      "Error sending $qXfer packet");
3946     }
3947 
3948     // check packet code
3949     switch (chunk.GetStringRef()[0]) {
3950     // last chunk
3951     case ('l'):
3952       active = false;
3953       LLVM_FALLTHROUGH;
3954 
3955     // more chunks
3956     case ('m'):
3957       output_stream << chunk.GetStringRef().drop_front();
3958       offset += chunk.GetStringRef().size() - 1;
3959       break;
3960 
3961     // unknown chunk
3962     default:
3963       return llvm::createStringError(
3964           llvm::inconvertibleErrorCode(),
3965           "Invalid continuation code from $qXfer packet");
3966     }
3967   }
3968 
3969   return output_stream.str();
3970 }
3971 
3972 // Notify the target that gdb is prepared to serve symbol lookup requests.
3973 //  packet: "qSymbol::"
3974 //  reply:
3975 //  OK                  The target does not need to look up any (more) symbols.
3976 //  qSymbol:<sym_name>  The target requests the value of symbol sym_name (hex
3977 //  encoded).
3978 //                      LLDB may provide the value by sending another qSymbol
3979 //                      packet
3980 //                      in the form of"qSymbol:<sym_value>:<sym_name>".
3981 //
3982 //  Three examples:
3983 //
3984 //  lldb sends:    qSymbol::
3985 //  lldb receives: OK
3986 //     Remote gdb stub does not need to know the addresses of any symbols, lldb
3987 //     does not
3988 //     need to ask again in this session.
3989 //
3990 //  lldb sends:    qSymbol::
3991 //  lldb receives: qSymbol:64697370617463685f71756575655f6f666673657473
3992 //  lldb sends:    qSymbol::64697370617463685f71756575655f6f666673657473
3993 //  lldb receives: OK
3994 //     Remote gdb stub asks for address of 'dispatch_queue_offsets'.  lldb does
3995 //     not know
3996 //     the address at this time.  lldb needs to send qSymbol:: again when it has
3997 //     more
3998 //     solibs loaded.
3999 //
4000 //  lldb sends:    qSymbol::
4001 //  lldb receives: qSymbol:64697370617463685f71756575655f6f666673657473
4002 //  lldb sends:    qSymbol:2bc97554:64697370617463685f71756575655f6f666673657473
4003 //  lldb receives: OK
4004 //     Remote gdb stub asks for address of 'dispatch_queue_offsets'.  lldb says
4005 //     that it
4006 //     is at address 0x2bc97554.  Remote gdb stub sends 'OK' indicating that it
4007 //     does not
4008 //     need any more symbols.  lldb does not need to ask again in this session.
4009 
4010 void GDBRemoteCommunicationClient::ServeSymbolLookups(
4011     lldb_private::Process *process) {
4012   // Set to true once we've resolved a symbol to an address for the remote
4013   // stub. If we get an 'OK' response after this, the remote stub doesn't need
4014   // any more symbols and we can stop asking.
4015   bool symbol_response_provided = false;
4016 
4017   // Is this the initial qSymbol:: packet?
4018   bool first_qsymbol_query = true;
4019 
4020   if (m_supports_qSymbol && !m_qSymbol_requests_done) {
4021     Lock lock(*this);
4022     if (lock) {
4023       StreamString packet;
4024       packet.PutCString("qSymbol::");
4025       StringExtractorGDBRemote response;
4026       while (SendPacketAndWaitForResponseNoLock(packet.GetString(), response) ==
4027              PacketResult::Success) {
4028         if (response.IsOKResponse()) {
4029           if (symbol_response_provided || first_qsymbol_query) {
4030             m_qSymbol_requests_done = true;
4031           }
4032 
4033           // We are done serving symbols requests
4034           return;
4035         }
4036         first_qsymbol_query = false;
4037 
4038         if (response.IsUnsupportedResponse()) {
4039           // qSymbol is not supported by the current GDB server we are
4040           // connected to
4041           m_supports_qSymbol = false;
4042           return;
4043         } else {
4044           llvm::StringRef response_str(response.GetStringRef());
4045           if (response_str.startswith("qSymbol:")) {
4046             response.SetFilePos(strlen("qSymbol:"));
4047             std::string symbol_name;
4048             if (response.GetHexByteString(symbol_name)) {
4049               if (symbol_name.empty())
4050                 return;
4051 
4052               addr_t symbol_load_addr = LLDB_INVALID_ADDRESS;
4053               lldb_private::SymbolContextList sc_list;
4054               process->GetTarget().GetImages().FindSymbolsWithNameAndType(
4055                   ConstString(symbol_name), eSymbolTypeAny, sc_list);
4056               if (!sc_list.IsEmpty()) {
4057                 const size_t num_scs = sc_list.GetSize();
4058                 for (size_t sc_idx = 0;
4059                      sc_idx < num_scs &&
4060                      symbol_load_addr == LLDB_INVALID_ADDRESS;
4061                      ++sc_idx) {
4062                   SymbolContext sc;
4063                   if (sc_list.GetContextAtIndex(sc_idx, sc)) {
4064                     if (sc.symbol) {
4065                       switch (sc.symbol->GetType()) {
4066                       case eSymbolTypeInvalid:
4067                       case eSymbolTypeAbsolute:
4068                       case eSymbolTypeUndefined:
4069                       case eSymbolTypeSourceFile:
4070                       case eSymbolTypeHeaderFile:
4071                       case eSymbolTypeObjectFile:
4072                       case eSymbolTypeCommonBlock:
4073                       case eSymbolTypeBlock:
4074                       case eSymbolTypeLocal:
4075                       case eSymbolTypeParam:
4076                       case eSymbolTypeVariable:
4077                       case eSymbolTypeVariableType:
4078                       case eSymbolTypeLineEntry:
4079                       case eSymbolTypeLineHeader:
4080                       case eSymbolTypeScopeBegin:
4081                       case eSymbolTypeScopeEnd:
4082                       case eSymbolTypeAdditional:
4083                       case eSymbolTypeCompiler:
4084                       case eSymbolTypeInstrumentation:
4085                       case eSymbolTypeTrampoline:
4086                         break;
4087 
4088                       case eSymbolTypeCode:
4089                       case eSymbolTypeResolver:
4090                       case eSymbolTypeData:
4091                       case eSymbolTypeRuntime:
4092                       case eSymbolTypeException:
4093                       case eSymbolTypeObjCClass:
4094                       case eSymbolTypeObjCMetaClass:
4095                       case eSymbolTypeObjCIVar:
4096                       case eSymbolTypeReExported:
4097                         symbol_load_addr =
4098                             sc.symbol->GetLoadAddress(&process->GetTarget());
4099                         break;
4100                       }
4101                     }
4102                   }
4103                 }
4104               }
4105               // This is the normal path where our symbol lookup was successful
4106               // and we want to send a packet with the new symbol value and see
4107               // if another lookup needs to be done.
4108 
4109               // Change "packet" to contain the requested symbol value and name
4110               packet.Clear();
4111               packet.PutCString("qSymbol:");
4112               if (symbol_load_addr != LLDB_INVALID_ADDRESS) {
4113                 packet.Printf("%" PRIx64, symbol_load_addr);
4114                 symbol_response_provided = true;
4115               } else {
4116                 symbol_response_provided = false;
4117               }
4118               packet.PutCString(":");
4119               packet.PutBytesAsRawHex8(symbol_name.data(), symbol_name.size());
4120               continue; // go back to the while loop and send "packet" and wait
4121                         // for another response
4122             }
4123           }
4124         }
4125       }
4126       // If we make it here, the symbol request packet response wasn't valid or
4127       // our symbol lookup failed so we must abort
4128       return;
4129 
4130     } else if (Log *log = GetLog(GDBRLog::Process | GDBRLog::Packets)) {
4131       LLDB_LOGF(log,
4132                 "GDBRemoteCommunicationClient::%s: Didn't get sequence mutex.",
4133                 __FUNCTION__);
4134     }
4135   }
4136 }
4137 
4138 StructuredData::Array *
4139 GDBRemoteCommunicationClient::GetSupportedStructuredDataPlugins() {
4140   if (!m_supported_async_json_packets_is_valid) {
4141     // Query the server for the array of supported asynchronous JSON packets.
4142     m_supported_async_json_packets_is_valid = true;
4143 
4144     Log *log = GetLog(GDBRLog::Process);
4145 
4146     // Poll it now.
4147     StringExtractorGDBRemote response;
4148     if (SendPacketAndWaitForResponse("qStructuredDataPlugins", response) ==
4149         PacketResult::Success) {
4150       m_supported_async_json_packets_sp =
4151           StructuredData::ParseJSON(std::string(response.GetStringRef()));
4152       if (m_supported_async_json_packets_sp &&
4153           !m_supported_async_json_packets_sp->GetAsArray()) {
4154         // We were returned something other than a JSON array.  This is
4155         // invalid.  Clear it out.
4156         LLDB_LOGF(log,
4157                   "GDBRemoteCommunicationClient::%s(): "
4158                   "QSupportedAsyncJSONPackets returned invalid "
4159                   "result: %s",
4160                   __FUNCTION__, response.GetStringRef().data());
4161         m_supported_async_json_packets_sp.reset();
4162       }
4163     } else {
4164       LLDB_LOGF(log,
4165                 "GDBRemoteCommunicationClient::%s(): "
4166                 "QSupportedAsyncJSONPackets unsupported",
4167                 __FUNCTION__);
4168     }
4169 
4170     if (log && m_supported_async_json_packets_sp) {
4171       StreamString stream;
4172       m_supported_async_json_packets_sp->Dump(stream);
4173       LLDB_LOGF(log,
4174                 "GDBRemoteCommunicationClient::%s(): supported async "
4175                 "JSON packets: %s",
4176                 __FUNCTION__, stream.GetData());
4177     }
4178   }
4179 
4180   return m_supported_async_json_packets_sp
4181              ? m_supported_async_json_packets_sp->GetAsArray()
4182              : nullptr;
4183 }
4184 
4185 Status GDBRemoteCommunicationClient::SendSignalsToIgnore(
4186     llvm::ArrayRef<int32_t> signals) {
4187   // Format packet:
4188   // QPassSignals:<hex_sig1>;<hex_sig2>...;<hex_sigN>
4189   auto range = llvm::make_range(signals.begin(), signals.end());
4190   std::string packet = formatv("QPassSignals:{0:$[;]@(x-2)}", range).str();
4191 
4192   StringExtractorGDBRemote response;
4193   auto send_status = SendPacketAndWaitForResponse(packet, response);
4194 
4195   if (send_status != GDBRemoteCommunication::PacketResult::Success)
4196     return Status("Sending QPassSignals packet failed");
4197 
4198   if (response.IsOKResponse()) {
4199     return Status();
4200   } else {
4201     return Status("Unknown error happened during sending QPassSignals packet.");
4202   }
4203 }
4204 
4205 Status GDBRemoteCommunicationClient::ConfigureRemoteStructuredData(
4206     ConstString type_name, const StructuredData::ObjectSP &config_sp) {
4207   Status error;
4208 
4209   if (type_name.GetLength() == 0) {
4210     error.SetErrorString("invalid type_name argument");
4211     return error;
4212   }
4213 
4214   // Build command: Configure{type_name}: serialized config data.
4215   StreamGDBRemote stream;
4216   stream.PutCString("QConfigure");
4217   stream.PutCString(type_name.GetStringRef());
4218   stream.PutChar(':');
4219   if (config_sp) {
4220     // Gather the plain-text version of the configuration data.
4221     StreamString unescaped_stream;
4222     config_sp->Dump(unescaped_stream);
4223     unescaped_stream.Flush();
4224 
4225     // Add it to the stream in escaped fashion.
4226     stream.PutEscapedBytes(unescaped_stream.GetString().data(),
4227                            unescaped_stream.GetSize());
4228   }
4229   stream.Flush();
4230 
4231   // Send the packet.
4232   StringExtractorGDBRemote response;
4233   auto result = SendPacketAndWaitForResponse(stream.GetString(), response);
4234   if (result == PacketResult::Success) {
4235     // We failed if the config result comes back other than OK.
4236     if (strcmp(response.GetStringRef().data(), "OK") == 0) {
4237       // Okay!
4238       error.Clear();
4239     } else {
4240       error.SetErrorStringWithFormat("configuring StructuredData feature "
4241                                      "%s failed with error %s",
4242                                      type_name.AsCString(),
4243                                      response.GetStringRef().data());
4244     }
4245   } else {
4246     // Can we get more data here on the failure?
4247     error.SetErrorStringWithFormat("configuring StructuredData feature %s "
4248                                    "failed when sending packet: "
4249                                    "PacketResult=%d",
4250                                    type_name.AsCString(), (int)result);
4251   }
4252   return error;
4253 }
4254 
4255 void GDBRemoteCommunicationClient::OnRunPacketSent(bool first) {
4256   GDBRemoteClientBase::OnRunPacketSent(first);
4257   m_curr_tid = LLDB_INVALID_THREAD_ID;
4258 }
4259 
4260 bool GDBRemoteCommunicationClient::UsesNativeSignals() {
4261   if (m_uses_native_signals == eLazyBoolCalculate)
4262     GetRemoteQSupported();
4263   if (m_uses_native_signals == eLazyBoolYes)
4264     return true;
4265 
4266   // If the remote didn't indicate native-signal support explicitly,
4267   // check whether it is an old version of lldb-server.
4268   return GetThreadSuffixSupported();
4269 }
4270