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