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 
1464     return LLDB_INVALID_PROCESS_ID;
1465 }
1466 
1467 bool
1468 GDBRemoteCommunicationClient::GetLaunchSuccess (std::string &error_str)
1469 {
1470     error_str.clear();
1471     StringExtractorGDBRemote response;
1472     if (SendPacketAndWaitForResponse("qLaunchSuccess", strlen("qLaunchSuccess"), response, false) == PacketResult::Success)
1473     {
1474         if (response.IsOKResponse())
1475             return true;
1476         if (response.GetChar() == 'E')
1477         {
1478             // A string the describes what failed when launching...
1479             error_str = response.GetStringRef().substr(1);
1480         }
1481         else
1482         {
1483             error_str.assign ("unknown error occurred launching process");
1484         }
1485     }
1486     else
1487     {
1488         error_str.assign ("timed out waiting for app to launch");
1489     }
1490     return false;
1491 }
1492 
1493 int
1494 GDBRemoteCommunicationClient::SendArgumentsPacket (const ProcessLaunchInfo &launch_info)
1495 {
1496     // Since we don't get the send argv0 separate from the executable path, we need to
1497     // make sure to use the actual executable path found in the launch_info...
1498     std::vector<const char *> argv;
1499     FileSpec exe_file = launch_info.GetExecutableFile();
1500     std::string exe_path;
1501     const char *arg = NULL;
1502     const Args &launch_args = launch_info.GetArguments();
1503     if (exe_file)
1504         exe_path = exe_file.GetPath(false);
1505     else
1506     {
1507         arg = launch_args.GetArgumentAtIndex(0);
1508         if (arg)
1509             exe_path = arg;
1510     }
1511     if (!exe_path.empty())
1512     {
1513         argv.push_back(exe_path.c_str());
1514         for (uint32_t i=1; (arg = launch_args.GetArgumentAtIndex(i)) != NULL; ++i)
1515         {
1516             if (arg)
1517                 argv.push_back(arg);
1518         }
1519     }
1520     if (!argv.empty())
1521     {
1522         StreamString packet;
1523         packet.PutChar('A');
1524         for (size_t i = 0, n = argv.size(); i < n; ++i)
1525         {
1526             arg = argv[i];
1527             const int arg_len = strlen(arg);
1528             if (i > 0)
1529                 packet.PutChar(',');
1530             packet.Printf("%i,%i,", arg_len * 2, (int)i);
1531             packet.PutBytesAsRawHex8 (arg, arg_len);
1532         }
1533 
1534         StringExtractorGDBRemote response;
1535         if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
1536         {
1537             if (response.IsOKResponse())
1538                 return 0;
1539             uint8_t error = response.GetError();
1540             if (error)
1541                 return error;
1542         }
1543     }
1544     return -1;
1545 }
1546 
1547 int
1548 GDBRemoteCommunicationClient::SendEnvironmentPacket (char const *name_equal_value)
1549 {
1550     if (name_equal_value && name_equal_value[0])
1551     {
1552         StreamString packet;
1553         bool send_hex_encoding = false;
1554         for (const char *p = name_equal_value; *p != '\0' && send_hex_encoding == false; ++p)
1555         {
1556             if (isprint(*p))
1557             {
1558                 switch (*p)
1559                 {
1560                     case '$':
1561                     case '#':
1562                         send_hex_encoding = true;
1563                         break;
1564                     default:
1565                         break;
1566                 }
1567             }
1568             else
1569             {
1570                 // We have non printable characters, lets hex encode this...
1571                 send_hex_encoding = true;
1572             }
1573         }
1574 
1575         StringExtractorGDBRemote response;
1576         if (send_hex_encoding)
1577         {
1578             if (m_supports_QEnvironmentHexEncoded)
1579             {
1580                 packet.PutCString("QEnvironmentHexEncoded:");
1581                 packet.PutBytesAsRawHex8 (name_equal_value, strlen(name_equal_value));
1582                 if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
1583                 {
1584                     if (response.IsOKResponse())
1585                         return 0;
1586                     uint8_t error = response.GetError();
1587                     if (error)
1588                         return error;
1589                     if (response.IsUnsupportedResponse())
1590                         m_supports_QEnvironmentHexEncoded = false;
1591                 }
1592             }
1593 
1594         }
1595         else if (m_supports_QEnvironment)
1596         {
1597             packet.Printf("QEnvironment:%s", name_equal_value);
1598             if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
1599             {
1600                 if (response.IsOKResponse())
1601                     return 0;
1602                 uint8_t error = response.GetError();
1603                 if (error)
1604                     return error;
1605                 if (response.IsUnsupportedResponse())
1606                     m_supports_QEnvironment = false;
1607             }
1608         }
1609     }
1610     return -1;
1611 }
1612 
1613 int
1614 GDBRemoteCommunicationClient::SendLaunchArchPacket (char const *arch)
1615 {
1616     if (arch && arch[0])
1617     {
1618         StreamString packet;
1619         packet.Printf("QLaunchArch:%s", arch);
1620         StringExtractorGDBRemote response;
1621         if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
1622         {
1623             if (response.IsOKResponse())
1624                 return 0;
1625             uint8_t error = response.GetError();
1626             if (error)
1627                 return error;
1628         }
1629     }
1630     return -1;
1631 }
1632 
1633 int
1634 GDBRemoteCommunicationClient::SendLaunchEventDataPacket (char const *data, bool *was_supported)
1635 {
1636     if (data && *data != '\0')
1637     {
1638         StreamString packet;
1639         packet.Printf("QSetProcessEvent:%s", data);
1640         StringExtractorGDBRemote response;
1641         if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
1642         {
1643             if (response.IsOKResponse())
1644             {
1645                 if (was_supported)
1646                     *was_supported = true;
1647                 return 0;
1648             }
1649             else if (response.IsUnsupportedResponse())
1650             {
1651                 if (was_supported)
1652                     *was_supported = false;
1653                 return -1;
1654             }
1655             else
1656             {
1657                 uint8_t error = response.GetError();
1658                 if (was_supported)
1659                     *was_supported = true;
1660                 if (error)
1661                     return error;
1662             }
1663         }
1664     }
1665     return -1;
1666 }
1667 
1668 bool
1669 GDBRemoteCommunicationClient::GetOSVersion (uint32_t &major,
1670                                             uint32_t &minor,
1671                                             uint32_t &update)
1672 {
1673     if (GetHostInfo ())
1674     {
1675         if (m_os_version_major != UINT32_MAX)
1676         {
1677             major = m_os_version_major;
1678             minor = m_os_version_minor;
1679             update = m_os_version_update;
1680             return true;
1681         }
1682     }
1683     return false;
1684 }
1685 
1686 bool
1687 GDBRemoteCommunicationClient::GetOSBuildString (std::string &s)
1688 {
1689     if (GetHostInfo ())
1690     {
1691         if (!m_os_build.empty())
1692         {
1693             s = m_os_build;
1694             return true;
1695         }
1696     }
1697     s.clear();
1698     return false;
1699 }
1700 
1701 
1702 bool
1703 GDBRemoteCommunicationClient::GetOSKernelDescription (std::string &s)
1704 {
1705     if (GetHostInfo ())
1706     {
1707         if (!m_os_kernel.empty())
1708         {
1709             s = m_os_kernel;
1710             return true;
1711         }
1712     }
1713     s.clear();
1714     return false;
1715 }
1716 
1717 bool
1718 GDBRemoteCommunicationClient::GetHostname (std::string &s)
1719 {
1720     if (GetHostInfo ())
1721     {
1722         if (!m_hostname.empty())
1723         {
1724             s = m_hostname;
1725             return true;
1726         }
1727     }
1728     s.clear();
1729     return false;
1730 }
1731 
1732 ArchSpec
1733 GDBRemoteCommunicationClient::GetSystemArchitecture ()
1734 {
1735     if (GetHostInfo ())
1736         return m_host_arch;
1737     return ArchSpec();
1738 }
1739 
1740 const lldb_private::ArchSpec &
1741 GDBRemoteCommunicationClient::GetProcessArchitecture ()
1742 {
1743     if (m_qProcessInfo_is_valid == eLazyBoolCalculate)
1744         GetCurrentProcessInfo ();
1745     return m_process_arch;
1746 }
1747 
1748 bool
1749 GDBRemoteCommunicationClient::GetGDBServerVersion()
1750 {
1751     if (m_qGDBServerVersion_is_valid == eLazyBoolCalculate)
1752     {
1753         m_gdb_server_name.clear();
1754         m_gdb_server_version = 0;
1755         m_qGDBServerVersion_is_valid = eLazyBoolNo;
1756 
1757         StringExtractorGDBRemote response;
1758         if (SendPacketAndWaitForResponse ("qGDBServerVersion", response, false) == PacketResult::Success)
1759         {
1760             if (response.IsNormalResponse())
1761             {
1762                 std::string name;
1763                 std::string value;
1764                 bool success = false;
1765                 while (response.GetNameColonValue(name, value))
1766                 {
1767                     if (name.compare("name") == 0)
1768                     {
1769                         success = true;
1770                         m_gdb_server_name.swap(value);
1771                     }
1772                     else if (name.compare("version") == 0)
1773                     {
1774                         size_t dot_pos = value.find('.');
1775                         if (dot_pos != std::string::npos)
1776                             value[dot_pos] = '\0';
1777                         const uint32_t version = StringConvert::ToUInt32(value.c_str(), UINT32_MAX, 0);
1778                         if (version != UINT32_MAX)
1779                         {
1780                             success = true;
1781                             m_gdb_server_version = version;
1782                         }
1783                     }
1784                 }
1785                 if (success)
1786                     m_qGDBServerVersion_is_valid = eLazyBoolYes;
1787             }
1788         }
1789     }
1790     return m_qGDBServerVersion_is_valid == eLazyBoolYes;
1791 }
1792 
1793 void
1794 GDBRemoteCommunicationClient::MaybeEnableCompression (std::vector<std::string> supported_compressions)
1795 {
1796     CompressionType avail_type = CompressionType::None;
1797     std::string avail_name;
1798 
1799 #if defined (HAVE_LIBCOMPRESSION)
1800     // libcompression is weak linked so test if compression_decode_buffer() is available
1801     if (compression_decode_buffer != NULL && avail_type == CompressionType::None)
1802     {
1803         for (auto compression : supported_compressions)
1804         {
1805             if (compression == "lzfse")
1806             {
1807                 avail_type = CompressionType::LZFSE;
1808                 avail_name = compression;
1809                 break;
1810             }
1811         }
1812     }
1813 #endif
1814 
1815 #if defined (HAVE_LIBCOMPRESSION)
1816     // libcompression is weak linked so test if compression_decode_buffer() is available
1817     if (compression_decode_buffer != NULL && avail_type == CompressionType::None)
1818     {
1819         for (auto compression : supported_compressions)
1820         {
1821             if (compression == "zlib-deflate")
1822             {
1823                 avail_type = CompressionType::ZlibDeflate;
1824                 avail_name = compression;
1825                 break;
1826             }
1827         }
1828     }
1829 #endif
1830 
1831 #if defined (HAVE_LIBZ)
1832     if (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_LIBCOMPRESSION)
1847     // libcompression is weak linked so test if compression_decode_buffer() is available
1848     if (compression_decode_buffer != NULL && avail_type == CompressionType::None)
1849     {
1850         for (auto compression : supported_compressions)
1851         {
1852             if (compression == "lz4")
1853             {
1854                 avail_type = CompressionType::LZ4;
1855                 avail_name = compression;
1856                 break;
1857             }
1858         }
1859     }
1860 #endif
1861 
1862 #if defined (HAVE_LIBCOMPRESSION)
1863     // libcompression is weak linked so test if compression_decode_buffer() is available
1864     if (compression_decode_buffer != NULL && avail_type == CompressionType::None)
1865     {
1866         for (auto compression : supported_compressions)
1867         {
1868             if (compression == "lzma")
1869             {
1870                 avail_type = CompressionType::LZMA;
1871                 avail_name = compression;
1872                 break;
1873             }
1874         }
1875     }
1876 #endif
1877 
1878     if (avail_type != CompressionType::None)
1879     {
1880         StringExtractorGDBRemote response;
1881         std::string packet = "QEnableCompression:type:" + avail_name + ";";
1882         if (SendPacketAndWaitForResponse (packet.c_str(), response, false) !=  PacketResult::Success)
1883             return;
1884 
1885         if (response.IsOKResponse())
1886         {
1887             m_compression_type = avail_type;
1888         }
1889     }
1890 }
1891 
1892 const char *
1893 GDBRemoteCommunicationClient::GetGDBServerProgramName()
1894 {
1895     if (GetGDBServerVersion())
1896     {
1897         if (!m_gdb_server_name.empty())
1898             return m_gdb_server_name.c_str();
1899     }
1900     return NULL;
1901 }
1902 
1903 uint32_t
1904 GDBRemoteCommunicationClient::GetGDBServerProgramVersion()
1905 {
1906     if (GetGDBServerVersion())
1907         return m_gdb_server_version;
1908     return 0;
1909 }
1910 
1911 bool
1912 GDBRemoteCommunicationClient::GetDefaultThreadId (lldb::tid_t &tid)
1913 {
1914     StringExtractorGDBRemote response;
1915     if (SendPacketAndWaitForResponse("qC",response,false) !=  PacketResult::Success)
1916         return false;
1917 
1918     if (!response.IsNormalResponse())
1919         return false;
1920 
1921     if (response.GetChar() == 'Q' && response.GetChar() == 'C')
1922         tid = response.GetHexMaxU32(true, -1);
1923 
1924     return true;
1925 }
1926 
1927 bool
1928 GDBRemoteCommunicationClient::GetHostInfo (bool force)
1929 {
1930     Log *log (ProcessGDBRemoteLog::GetLogIfAnyCategoryIsSet (GDBR_LOG_PROCESS));
1931 
1932     if (force || m_qHostInfo_is_valid == eLazyBoolCalculate)
1933     {
1934         m_qHostInfo_is_valid = eLazyBoolNo;
1935         StringExtractorGDBRemote response;
1936         if (SendPacketAndWaitForResponse ("qHostInfo", response, false) == PacketResult::Success)
1937         {
1938             if (response.IsNormalResponse())
1939             {
1940                 std::string name;
1941                 std::string value;
1942                 uint32_t cpu = LLDB_INVALID_CPUTYPE;
1943                 uint32_t sub = 0;
1944                 std::string arch_name;
1945                 std::string os_name;
1946                 std::string vendor_name;
1947                 std::string triple;
1948                 std::string distribution_id;
1949                 uint32_t pointer_byte_size = 0;
1950                 StringExtractor extractor;
1951                 ByteOrder byte_order = eByteOrderInvalid;
1952                 uint32_t num_keys_decoded = 0;
1953                 while (response.GetNameColonValue(name, value))
1954                 {
1955                     if (name.compare("cputype") == 0)
1956                     {
1957                         // exception type in big endian hex
1958                         cpu = StringConvert::ToUInt32 (value.c_str(), LLDB_INVALID_CPUTYPE, 0);
1959                         if (cpu != LLDB_INVALID_CPUTYPE)
1960                             ++num_keys_decoded;
1961                     }
1962                     else if (name.compare("cpusubtype") == 0)
1963                     {
1964                         // exception count in big endian hex
1965                         sub = StringConvert::ToUInt32 (value.c_str(), 0, 0);
1966                         if (sub != 0)
1967                             ++num_keys_decoded;
1968                     }
1969                     else if (name.compare("arch") == 0)
1970                     {
1971                         arch_name.swap (value);
1972                         ++num_keys_decoded;
1973                     }
1974                     else if (name.compare("triple") == 0)
1975                     {
1976                         extractor.GetStringRef ().swap (value);
1977                         extractor.SetFilePos(0);
1978                         extractor.GetHexByteString (triple);
1979                         ++num_keys_decoded;
1980                     }
1981                     else if (name.compare ("distribution_id") == 0)
1982                     {
1983                         extractor.GetStringRef ().swap (value);
1984                         extractor.SetFilePos (0);
1985                         extractor.GetHexByteString (distribution_id);
1986                         ++num_keys_decoded;
1987                     }
1988                     else if (name.compare("os_build") == 0)
1989                     {
1990                         extractor.GetStringRef().swap(value);
1991                         extractor.SetFilePos(0);
1992                         extractor.GetHexByteString (m_os_build);
1993                         ++num_keys_decoded;
1994                     }
1995                     else if (name.compare("hostname") == 0)
1996                     {
1997                         extractor.GetStringRef().swap(value);
1998                         extractor.SetFilePos(0);
1999                         extractor.GetHexByteString (m_hostname);
2000                         ++num_keys_decoded;
2001                     }
2002                     else if (name.compare("os_kernel") == 0)
2003                     {
2004                         extractor.GetStringRef().swap(value);
2005                         extractor.SetFilePos(0);
2006                         extractor.GetHexByteString (m_os_kernel);
2007                         ++num_keys_decoded;
2008                     }
2009                     else if (name.compare("ostype") == 0)
2010                     {
2011                         os_name.swap (value);
2012                         ++num_keys_decoded;
2013                     }
2014                     else if (name.compare("vendor") == 0)
2015                     {
2016                         vendor_name.swap(value);
2017                         ++num_keys_decoded;
2018                     }
2019                     else if (name.compare("endian") == 0)
2020                     {
2021                         ++num_keys_decoded;
2022                         if (value.compare("little") == 0)
2023                             byte_order = eByteOrderLittle;
2024                         else if (value.compare("big") == 0)
2025                             byte_order = eByteOrderBig;
2026                         else if (value.compare("pdp") == 0)
2027                             byte_order = eByteOrderPDP;
2028                         else
2029                             --num_keys_decoded;
2030                     }
2031                     else if (name.compare("ptrsize") == 0)
2032                     {
2033                         pointer_byte_size = StringConvert::ToUInt32 (value.c_str(), 0, 0);
2034                         if (pointer_byte_size != 0)
2035                             ++num_keys_decoded;
2036                     }
2037                     else if (name.compare("os_version") == 0)
2038                     {
2039                         Args::StringToVersion (value.c_str(),
2040                                                m_os_version_major,
2041                                                m_os_version_minor,
2042                                                m_os_version_update);
2043                         if (m_os_version_major != UINT32_MAX)
2044                             ++num_keys_decoded;
2045                     }
2046                     else if (name.compare("watchpoint_exceptions_received") == 0)
2047                     {
2048                         ++num_keys_decoded;
2049                         if (strcmp(value.c_str(),"before") == 0)
2050                             m_watchpoints_trigger_after_instruction = eLazyBoolNo;
2051                         else if (strcmp(value.c_str(),"after") == 0)
2052                             m_watchpoints_trigger_after_instruction = eLazyBoolYes;
2053                         else
2054                             --num_keys_decoded;
2055                     }
2056                     else if (name.compare("default_packet_timeout") == 0)
2057                     {
2058                         m_default_packet_timeout = StringConvert::ToUInt32(value.c_str(), 0);
2059                         if (m_default_packet_timeout > 0)
2060                         {
2061                             SetPacketTimeout(m_default_packet_timeout);
2062                             ++num_keys_decoded;
2063                         }
2064                     }
2065 
2066                 }
2067 
2068                 if (num_keys_decoded > 0)
2069                     m_qHostInfo_is_valid = eLazyBoolYes;
2070 
2071                 if (triple.empty())
2072                 {
2073                     if (arch_name.empty())
2074                     {
2075                         if (cpu != LLDB_INVALID_CPUTYPE)
2076                         {
2077                             m_host_arch.SetArchitecture (eArchTypeMachO, cpu, sub);
2078                             if (pointer_byte_size)
2079                             {
2080                                 assert (pointer_byte_size == m_host_arch.GetAddressByteSize());
2081                             }
2082                             if (byte_order != eByteOrderInvalid)
2083                             {
2084                                 assert (byte_order == m_host_arch.GetByteOrder());
2085                             }
2086 
2087                             if (!os_name.empty() && vendor_name.compare("apple") == 0 && os_name.find("darwin") == 0)
2088                             {
2089                                 switch (m_host_arch.GetMachine())
2090                                 {
2091                                 case llvm::Triple::aarch64:
2092                                 case llvm::Triple::arm:
2093                                 case llvm::Triple::thumb:
2094                                     os_name = "ios";
2095                                     break;
2096                                 default:
2097                                     os_name = "macosx";
2098                                     break;
2099                                 }
2100                             }
2101                             if (!vendor_name.empty())
2102                                 m_host_arch.GetTriple().setVendorName (llvm::StringRef (vendor_name));
2103                             if (!os_name.empty())
2104                                 m_host_arch.GetTriple().setOSName (llvm::StringRef (os_name));
2105 
2106                         }
2107                     }
2108                     else
2109                     {
2110                         std::string triple;
2111                         triple += arch_name;
2112                         if (!vendor_name.empty() || !os_name.empty())
2113                         {
2114                             triple += '-';
2115                             if (vendor_name.empty())
2116                                 triple += "unknown";
2117                             else
2118                                 triple += vendor_name;
2119                             triple += '-';
2120                             if (os_name.empty())
2121                                 triple += "unknown";
2122                             else
2123                                 triple += os_name;
2124                         }
2125                         m_host_arch.SetTriple (triple.c_str());
2126 
2127                         llvm::Triple &host_triple = m_host_arch.GetTriple();
2128                         if (host_triple.getVendor() == llvm::Triple::Apple && host_triple.getOS() == llvm::Triple::Darwin)
2129                         {
2130                             switch (m_host_arch.GetMachine())
2131                             {
2132                                 case llvm::Triple::aarch64:
2133                                 case llvm::Triple::arm:
2134                                 case llvm::Triple::thumb:
2135                                     host_triple.setOS(llvm::Triple::IOS);
2136                                     break;
2137                                 default:
2138                                     host_triple.setOS(llvm::Triple::MacOSX);
2139                                     break;
2140                             }
2141                         }
2142                         if (pointer_byte_size)
2143                         {
2144                             assert (pointer_byte_size == m_host_arch.GetAddressByteSize());
2145                         }
2146                         if (byte_order != eByteOrderInvalid)
2147                         {
2148                             assert (byte_order == m_host_arch.GetByteOrder());
2149                         }
2150 
2151                     }
2152                 }
2153                 else
2154                 {
2155                     m_host_arch.SetTriple (triple.c_str());
2156                     if (pointer_byte_size)
2157                     {
2158                         assert (pointer_byte_size == m_host_arch.GetAddressByteSize());
2159                     }
2160                     if (byte_order != eByteOrderInvalid)
2161                     {
2162                         assert (byte_order == m_host_arch.GetByteOrder());
2163                     }
2164 
2165                     if (log)
2166                         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 ());
2167                 }
2168                 if (!distribution_id.empty ())
2169                     m_host_arch.SetDistributionId (distribution_id.c_str ());
2170             }
2171         }
2172     }
2173     return m_qHostInfo_is_valid == eLazyBoolYes;
2174 }
2175 
2176 int
2177 GDBRemoteCommunicationClient::SendAttach
2178 (
2179     lldb::pid_t pid,
2180     StringExtractorGDBRemote& response
2181 )
2182 {
2183     if (pid != LLDB_INVALID_PROCESS_ID)
2184     {
2185         char packet[64];
2186         const int packet_len = ::snprintf (packet, sizeof(packet), "vAttach;%" PRIx64, pid);
2187         assert (packet_len < (int)sizeof(packet));
2188         if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success)
2189         {
2190             if (response.IsErrorResponse())
2191                 return response.GetError();
2192             return 0;
2193         }
2194     }
2195     return -1;
2196 }
2197 
2198 int
2199 GDBRemoteCommunicationClient::SendStdinNotification (const char* data, size_t data_len)
2200 {
2201     StreamString packet;
2202     packet.PutCString("I");
2203     packet.PutBytesAsRawHex8(data, data_len);
2204     StringExtractorGDBRemote response;
2205     if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
2206     {
2207         return 0;
2208     }
2209     return response.GetError();
2210 
2211 }
2212 
2213 const lldb_private::ArchSpec &
2214 GDBRemoteCommunicationClient::GetHostArchitecture ()
2215 {
2216     if (m_qHostInfo_is_valid == eLazyBoolCalculate)
2217         GetHostInfo ();
2218     return m_host_arch;
2219 }
2220 
2221 uint32_t
2222 GDBRemoteCommunicationClient::GetHostDefaultPacketTimeout ()
2223 {
2224     if (m_qHostInfo_is_valid == eLazyBoolCalculate)
2225         GetHostInfo ();
2226     return m_default_packet_timeout;
2227 }
2228 
2229 addr_t
2230 GDBRemoteCommunicationClient::AllocateMemory (size_t size, uint32_t permissions)
2231 {
2232     if (m_supports_alloc_dealloc_memory != eLazyBoolNo)
2233     {
2234         m_supports_alloc_dealloc_memory = eLazyBoolYes;
2235         char packet[64];
2236         const int packet_len = ::snprintf (packet, sizeof(packet), "_M%" PRIx64 ",%s%s%s",
2237                                            (uint64_t)size,
2238                                            permissions & lldb::ePermissionsReadable ? "r" : "",
2239                                            permissions & lldb::ePermissionsWritable ? "w" : "",
2240                                            permissions & lldb::ePermissionsExecutable ? "x" : "");
2241         assert (packet_len < (int)sizeof(packet));
2242         StringExtractorGDBRemote response;
2243         if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success)
2244         {
2245             if (response.IsUnsupportedResponse())
2246                 m_supports_alloc_dealloc_memory = eLazyBoolNo;
2247             else if (!response.IsErrorResponse())
2248                 return response.GetHexMaxU64(false, LLDB_INVALID_ADDRESS);
2249         }
2250         else
2251         {
2252             m_supports_alloc_dealloc_memory = eLazyBoolNo;
2253         }
2254     }
2255     return LLDB_INVALID_ADDRESS;
2256 }
2257 
2258 bool
2259 GDBRemoteCommunicationClient::DeallocateMemory (addr_t addr)
2260 {
2261     if (m_supports_alloc_dealloc_memory != eLazyBoolNo)
2262     {
2263         m_supports_alloc_dealloc_memory = eLazyBoolYes;
2264         char packet[64];
2265         const int packet_len = ::snprintf(packet, sizeof(packet), "_m%" PRIx64, (uint64_t)addr);
2266         assert (packet_len < (int)sizeof(packet));
2267         StringExtractorGDBRemote response;
2268         if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success)
2269         {
2270             if (response.IsUnsupportedResponse())
2271                 m_supports_alloc_dealloc_memory = eLazyBoolNo;
2272             else if (response.IsOKResponse())
2273                 return true;
2274         }
2275         else
2276         {
2277             m_supports_alloc_dealloc_memory = eLazyBoolNo;
2278         }
2279     }
2280     return false;
2281 }
2282 
2283 Error
2284 GDBRemoteCommunicationClient::Detach (bool keep_stopped)
2285 {
2286     Error error;
2287 
2288     if (keep_stopped)
2289     {
2290         if (m_supports_detach_stay_stopped == eLazyBoolCalculate)
2291         {
2292             char packet[64];
2293             const int packet_len = ::snprintf(packet, sizeof(packet), "qSupportsDetachAndStayStopped:");
2294             assert (packet_len < (int)sizeof(packet));
2295             StringExtractorGDBRemote response;
2296             if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success
2297                   && response.IsOKResponse())
2298             {
2299                 m_supports_detach_stay_stopped = eLazyBoolYes;
2300             }
2301             else
2302             {
2303                 m_supports_detach_stay_stopped = eLazyBoolNo;
2304             }
2305         }
2306 
2307         if (m_supports_detach_stay_stopped == eLazyBoolNo)
2308         {
2309             error.SetErrorString("Stays stopped not supported by this target.");
2310             return error;
2311         }
2312         else
2313         {
2314             StringExtractorGDBRemote response;
2315             PacketResult packet_result = SendPacketAndWaitForResponse ("D1", 2, response, false);
2316             if (packet_result != PacketResult::Success)
2317                 error.SetErrorString ("Sending extended disconnect packet failed.");
2318         }
2319     }
2320     else
2321     {
2322         StringExtractorGDBRemote response;
2323         PacketResult packet_result = SendPacketAndWaitForResponse ("D", 1, response, false);
2324         if (packet_result != PacketResult::Success)
2325             error.SetErrorString ("Sending disconnect packet failed.");
2326     }
2327     return error;
2328 }
2329 
2330 Error
2331 GDBRemoteCommunicationClient::GetMemoryRegionInfo (lldb::addr_t addr,
2332                                                   lldb_private::MemoryRegionInfo &region_info)
2333 {
2334     Error error;
2335     region_info.Clear();
2336 
2337     if (m_supports_memory_region_info != eLazyBoolNo)
2338     {
2339         m_supports_memory_region_info = eLazyBoolYes;
2340         char packet[64];
2341         const int packet_len = ::snprintf(packet, sizeof(packet), "qMemoryRegionInfo:%" PRIx64, (uint64_t)addr);
2342         assert (packet_len < (int)sizeof(packet));
2343         StringExtractorGDBRemote response;
2344         if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success)
2345         {
2346             std::string name;
2347             std::string value;
2348             addr_t addr_value;
2349             bool success = true;
2350             bool saw_permissions = false;
2351             while (success && response.GetNameColonValue(name, value))
2352             {
2353                 if (name.compare ("start") == 0)
2354                 {
2355                     addr_value = StringConvert::ToUInt64(value.c_str(), LLDB_INVALID_ADDRESS, 16, &success);
2356                     if (success)
2357                         region_info.GetRange().SetRangeBase(addr_value);
2358                 }
2359                 else if (name.compare ("size") == 0)
2360                 {
2361                     addr_value = StringConvert::ToUInt64(value.c_str(), 0, 16, &success);
2362                     if (success)
2363                         region_info.GetRange().SetByteSize (addr_value);
2364                 }
2365                 else if (name.compare ("permissions") == 0 && region_info.GetRange().IsValid())
2366                 {
2367                     saw_permissions = true;
2368                     if (region_info.GetRange().Contains (addr))
2369                     {
2370                         if (value.find('r') != std::string::npos)
2371                             region_info.SetReadable (MemoryRegionInfo::eYes);
2372                         else
2373                             region_info.SetReadable (MemoryRegionInfo::eNo);
2374 
2375                         if (value.find('w') != std::string::npos)
2376                             region_info.SetWritable (MemoryRegionInfo::eYes);
2377                         else
2378                             region_info.SetWritable (MemoryRegionInfo::eNo);
2379 
2380                         if (value.find('x') != std::string::npos)
2381                             region_info.SetExecutable (MemoryRegionInfo::eYes);
2382                         else
2383                             region_info.SetExecutable (MemoryRegionInfo::eNo);
2384                     }
2385                     else
2386                     {
2387                         // The reported region does not contain this address -- we're looking at an unmapped page
2388                         region_info.SetReadable (MemoryRegionInfo::eNo);
2389                         region_info.SetWritable (MemoryRegionInfo::eNo);
2390                         region_info.SetExecutable (MemoryRegionInfo::eNo);
2391                     }
2392                 }
2393                 else if (name.compare ("error") == 0)
2394                 {
2395                     StringExtractorGDBRemote name_extractor;
2396                     // Swap "value" over into "name_extractor"
2397                     name_extractor.GetStringRef().swap(value);
2398                     // Now convert the HEX bytes into a string value
2399                     name_extractor.GetHexByteString (value);
2400                     error.SetErrorString(value.c_str());
2401                 }
2402             }
2403 
2404             // We got a valid address range back but no permissions -- which means this is an unmapped page
2405             if (region_info.GetRange().IsValid() && saw_permissions == false)
2406             {
2407                 region_info.SetReadable (MemoryRegionInfo::eNo);
2408                 region_info.SetWritable (MemoryRegionInfo::eNo);
2409                 region_info.SetExecutable (MemoryRegionInfo::eNo);
2410             }
2411         }
2412         else
2413         {
2414             m_supports_memory_region_info = eLazyBoolNo;
2415         }
2416     }
2417 
2418     if (m_supports_memory_region_info == eLazyBoolNo)
2419     {
2420         error.SetErrorString("qMemoryRegionInfo is not supported");
2421     }
2422     if (error.Fail())
2423         region_info.Clear();
2424     return error;
2425 
2426 }
2427 
2428 Error
2429 GDBRemoteCommunicationClient::GetWatchpointSupportInfo (uint32_t &num)
2430 {
2431     Error error;
2432 
2433     if (m_supports_watchpoint_support_info == eLazyBoolYes)
2434     {
2435         num = m_num_supported_hardware_watchpoints;
2436         return error;
2437     }
2438 
2439     // Set num to 0 first.
2440     num = 0;
2441     if (m_supports_watchpoint_support_info != eLazyBoolNo)
2442     {
2443         char packet[64];
2444         const int packet_len = ::snprintf(packet, sizeof(packet), "qWatchpointSupportInfo:");
2445         assert (packet_len < (int)sizeof(packet));
2446         StringExtractorGDBRemote response;
2447         if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success)
2448         {
2449             m_supports_watchpoint_support_info = eLazyBoolYes;
2450             std::string name;
2451             std::string value;
2452             while (response.GetNameColonValue(name, value))
2453             {
2454                 if (name.compare ("num") == 0)
2455                 {
2456                     num = StringConvert::ToUInt32(value.c_str(), 0, 0);
2457                     m_num_supported_hardware_watchpoints = num;
2458                 }
2459             }
2460         }
2461         else
2462         {
2463             m_supports_watchpoint_support_info = eLazyBoolNo;
2464         }
2465     }
2466 
2467     if (m_supports_watchpoint_support_info == eLazyBoolNo)
2468     {
2469         error.SetErrorString("qWatchpointSupportInfo is not supported");
2470     }
2471     return error;
2472 
2473 }
2474 
2475 lldb_private::Error
2476 GDBRemoteCommunicationClient::GetWatchpointSupportInfo (uint32_t &num, bool& after)
2477 {
2478     Error error(GetWatchpointSupportInfo(num));
2479     if (error.Success())
2480         error = GetWatchpointsTriggerAfterInstruction(after);
2481     return error;
2482 }
2483 
2484 lldb_private::Error
2485 GDBRemoteCommunicationClient::GetWatchpointsTriggerAfterInstruction (bool &after)
2486 {
2487     Error error;
2488 
2489     // we assume watchpoints will happen after running the relevant opcode
2490     // and we only want to override this behavior if we have explicitly
2491     // received a qHostInfo telling us otherwise
2492     if (m_qHostInfo_is_valid != eLazyBoolYes)
2493         after = true;
2494     else
2495         after = (m_watchpoints_trigger_after_instruction != eLazyBoolNo);
2496     return error;
2497 }
2498 
2499 int
2500 GDBRemoteCommunicationClient::SetSTDIN(const FileSpec &file_spec)
2501 {
2502     if (file_spec)
2503     {
2504         std::string path{file_spec.GetPath(false)};
2505         StreamString packet;
2506         packet.PutCString("QSetSTDIN:");
2507         packet.PutCStringAsRawHex8(path.c_str());
2508 
2509         StringExtractorGDBRemote response;
2510         if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
2511         {
2512             if (response.IsOKResponse())
2513                 return 0;
2514             uint8_t error = response.GetError();
2515             if (error)
2516                 return error;
2517         }
2518     }
2519     return -1;
2520 }
2521 
2522 int
2523 GDBRemoteCommunicationClient::SetSTDOUT(const FileSpec &file_spec)
2524 {
2525     if (file_spec)
2526     {
2527         std::string path{file_spec.GetPath(false)};
2528         StreamString packet;
2529         packet.PutCString("QSetSTDOUT:");
2530         packet.PutCStringAsRawHex8(path.c_str());
2531 
2532         StringExtractorGDBRemote response;
2533         if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
2534         {
2535             if (response.IsOKResponse())
2536                 return 0;
2537             uint8_t error = response.GetError();
2538             if (error)
2539                 return error;
2540         }
2541     }
2542     return -1;
2543 }
2544 
2545 int
2546 GDBRemoteCommunicationClient::SetSTDERR(const FileSpec &file_spec)
2547 {
2548     if (file_spec)
2549     {
2550         std::string path{file_spec.GetPath(false)};
2551         StreamString packet;
2552         packet.PutCString("QSetSTDERR:");
2553         packet.PutCStringAsRawHex8(path.c_str());
2554 
2555         StringExtractorGDBRemote response;
2556         if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
2557         {
2558             if (response.IsOKResponse())
2559                 return 0;
2560             uint8_t error = response.GetError();
2561             if (error)
2562                 return error;
2563         }
2564     }
2565     return -1;
2566 }
2567 
2568 bool
2569 GDBRemoteCommunicationClient::GetWorkingDir(FileSpec &working_dir)
2570 {
2571     StringExtractorGDBRemote response;
2572     if (SendPacketAndWaitForResponse ("qGetWorkingDir", response, false) == PacketResult::Success)
2573     {
2574         if (response.IsUnsupportedResponse())
2575             return false;
2576         if (response.IsErrorResponse())
2577             return false;
2578         std::string cwd;
2579         response.GetHexByteString(cwd);
2580         working_dir.SetFile(cwd, false, GetHostArchitecture());
2581         return !cwd.empty();
2582     }
2583     return false;
2584 }
2585 
2586 int
2587 GDBRemoteCommunicationClient::SetWorkingDir(const FileSpec &working_dir)
2588 {
2589     if (working_dir)
2590     {
2591         std::string path{working_dir.GetPath(false)};
2592         StreamString packet;
2593         packet.PutCString("QSetWorkingDir:");
2594         packet.PutCStringAsRawHex8(path.c_str());
2595 
2596         StringExtractorGDBRemote response;
2597         if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
2598         {
2599             if (response.IsOKResponse())
2600                 return 0;
2601             uint8_t error = response.GetError();
2602             if (error)
2603                 return error;
2604         }
2605     }
2606     return -1;
2607 }
2608 
2609 int
2610 GDBRemoteCommunicationClient::SetDisableASLR (bool enable)
2611 {
2612     char packet[32];
2613     const int packet_len = ::snprintf (packet, sizeof (packet), "QSetDisableASLR:%i", enable ? 1 : 0);
2614     assert (packet_len < (int)sizeof(packet));
2615     StringExtractorGDBRemote response;
2616     if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success)
2617     {
2618         if (response.IsOKResponse())
2619             return 0;
2620         uint8_t error = response.GetError();
2621         if (error)
2622             return error;
2623     }
2624     return -1;
2625 }
2626 
2627 int
2628 GDBRemoteCommunicationClient::SetDetachOnError (bool enable)
2629 {
2630     char packet[32];
2631     const int packet_len = ::snprintf (packet, sizeof (packet), "QSetDetachOnError:%i", enable ? 1 : 0);
2632     assert (packet_len < (int)sizeof(packet));
2633     StringExtractorGDBRemote response;
2634     if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success)
2635     {
2636         if (response.IsOKResponse())
2637             return 0;
2638         uint8_t error = response.GetError();
2639         if (error)
2640             return error;
2641     }
2642     return -1;
2643 }
2644 
2645 
2646 bool
2647 GDBRemoteCommunicationClient::DecodeProcessInfoResponse (StringExtractorGDBRemote &response, ProcessInstanceInfo &process_info)
2648 {
2649     if (response.IsNormalResponse())
2650     {
2651         std::string name;
2652         std::string value;
2653         StringExtractor extractor;
2654 
2655         uint32_t cpu = LLDB_INVALID_CPUTYPE;
2656         uint32_t sub = 0;
2657         std::string vendor;
2658         std::string os_type;
2659 
2660         while (response.GetNameColonValue(name, value))
2661         {
2662             if (name.compare("pid") == 0)
2663             {
2664                 process_info.SetProcessID (StringConvert::ToUInt32 (value.c_str(), LLDB_INVALID_PROCESS_ID, 0));
2665             }
2666             else if (name.compare("ppid") == 0)
2667             {
2668                 process_info.SetParentProcessID (StringConvert::ToUInt32 (value.c_str(), LLDB_INVALID_PROCESS_ID, 0));
2669             }
2670             else if (name.compare("uid") == 0)
2671             {
2672                 process_info.SetUserID (StringConvert::ToUInt32 (value.c_str(), UINT32_MAX, 0));
2673             }
2674             else if (name.compare("euid") == 0)
2675             {
2676                 process_info.SetEffectiveUserID (StringConvert::ToUInt32 (value.c_str(), UINT32_MAX, 0));
2677             }
2678             else if (name.compare("gid") == 0)
2679             {
2680                 process_info.SetGroupID (StringConvert::ToUInt32 (value.c_str(), UINT32_MAX, 0));
2681             }
2682             else if (name.compare("egid") == 0)
2683             {
2684                 process_info.SetEffectiveGroupID (StringConvert::ToUInt32 (value.c_str(), UINT32_MAX, 0));
2685             }
2686             else if (name.compare("triple") == 0)
2687             {
2688                 StringExtractor extractor;
2689                 extractor.GetStringRef().swap(value);
2690                 extractor.SetFilePos(0);
2691                 extractor.GetHexByteString (value);
2692                 process_info.GetArchitecture ().SetTriple (value.c_str());
2693             }
2694             else if (name.compare("name") == 0)
2695             {
2696                 StringExtractor extractor;
2697                 // The process name from ASCII hex bytes since we can't
2698                 // control the characters in a process name
2699                 extractor.GetStringRef().swap(value);
2700                 extractor.SetFilePos(0);
2701                 extractor.GetHexByteString (value);
2702                 process_info.GetExecutableFile().SetFile (value.c_str(), false);
2703             }
2704             else if (name.compare("cputype") == 0)
2705             {
2706                 cpu = StringConvert::ToUInt32 (value.c_str(), LLDB_INVALID_CPUTYPE, 16);
2707             }
2708             else if (name.compare("cpusubtype") == 0)
2709             {
2710                 sub = StringConvert::ToUInt32 (value.c_str(), 0, 16);
2711             }
2712             else if (name.compare("vendor") == 0)
2713             {
2714                 vendor = value;
2715             }
2716             else if (name.compare("ostype") == 0)
2717             {
2718                 os_type = value;
2719             }
2720         }
2721 
2722         if (cpu != LLDB_INVALID_CPUTYPE && !vendor.empty() && !os_type.empty())
2723         {
2724             if (vendor == "apple")
2725             {
2726                 process_info.GetArchitecture().SetArchitecture (eArchTypeMachO, cpu, sub);
2727                 process_info.GetArchitecture().GetTriple().setVendorName (llvm::StringRef (vendor));
2728                 process_info.GetArchitecture().GetTriple().setOSName (llvm::StringRef (os_type));
2729             }
2730         }
2731 
2732         if (process_info.GetProcessID() != LLDB_INVALID_PROCESS_ID)
2733             return true;
2734     }
2735     return false;
2736 }
2737 
2738 bool
2739 GDBRemoteCommunicationClient::GetProcessInfo (lldb::pid_t pid, ProcessInstanceInfo &process_info)
2740 {
2741     process_info.Clear();
2742 
2743     if (m_supports_qProcessInfoPID)
2744     {
2745         char packet[32];
2746         const int packet_len = ::snprintf (packet, sizeof (packet), "qProcessInfoPID:%" PRIu64, pid);
2747         assert (packet_len < (int)sizeof(packet));
2748         StringExtractorGDBRemote response;
2749         if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success)
2750         {
2751             return DecodeProcessInfoResponse (response, process_info);
2752         }
2753         else
2754         {
2755             m_supports_qProcessInfoPID = false;
2756             return false;
2757         }
2758     }
2759     return false;
2760 }
2761 
2762 bool
2763 GDBRemoteCommunicationClient::GetCurrentProcessInfo (bool allow_lazy)
2764 {
2765     Log *log (ProcessGDBRemoteLog::GetLogIfAnyCategoryIsSet (GDBR_LOG_PROCESS | GDBR_LOG_PACKETS));
2766 
2767     if (allow_lazy)
2768     {
2769         if (m_qProcessInfo_is_valid == eLazyBoolYes)
2770             return true;
2771         if (m_qProcessInfo_is_valid == eLazyBoolNo)
2772             return false;
2773     }
2774 
2775     GetHostInfo ();
2776 
2777     StringExtractorGDBRemote response;
2778     if (SendPacketAndWaitForResponse ("qProcessInfo", response, false) == PacketResult::Success)
2779     {
2780         if (response.IsNormalResponse())
2781         {
2782             std::string name;
2783             std::string value;
2784             uint32_t cpu = LLDB_INVALID_CPUTYPE;
2785             uint32_t sub = 0;
2786             std::string arch_name;
2787             std::string os_name;
2788             std::string vendor_name;
2789             std::string triple;
2790             uint32_t pointer_byte_size = 0;
2791             StringExtractor extractor;
2792             ByteOrder byte_order = eByteOrderInvalid;
2793             uint32_t num_keys_decoded = 0;
2794             lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
2795             while (response.GetNameColonValue(name, value))
2796             {
2797                 if (name.compare("cputype") == 0)
2798                 {
2799                     cpu = StringConvert::ToUInt32 (value.c_str(), LLDB_INVALID_CPUTYPE, 16);
2800                     if (cpu != LLDB_INVALID_CPUTYPE)
2801                         ++num_keys_decoded;
2802                 }
2803                 else if (name.compare("cpusubtype") == 0)
2804                 {
2805                     sub = StringConvert::ToUInt32 (value.c_str(), 0, 16);
2806                     if (sub != 0)
2807                         ++num_keys_decoded;
2808                 }
2809                 else if (name.compare("triple") == 0)
2810                 {
2811                     StringExtractor extractor;
2812                     extractor.GetStringRef().swap(value);
2813                     extractor.SetFilePos(0);
2814                     extractor.GetHexByteString (triple);
2815                     ++num_keys_decoded;
2816                 }
2817                 else if (name.compare("ostype") == 0)
2818                 {
2819                     os_name.swap (value);
2820                     ++num_keys_decoded;
2821                 }
2822                 else if (name.compare("vendor") == 0)
2823                 {
2824                     vendor_name.swap(value);
2825                     ++num_keys_decoded;
2826                 }
2827                 else if (name.compare("endian") == 0)
2828                 {
2829                     ++num_keys_decoded;
2830                     if (value.compare("little") == 0)
2831                         byte_order = eByteOrderLittle;
2832                     else if (value.compare("big") == 0)
2833                         byte_order = eByteOrderBig;
2834                     else if (value.compare("pdp") == 0)
2835                         byte_order = eByteOrderPDP;
2836                     else
2837                         --num_keys_decoded;
2838                 }
2839                 else if (name.compare("ptrsize") == 0)
2840                 {
2841                     pointer_byte_size = StringConvert::ToUInt32 (value.c_str(), 0, 16);
2842                     if (pointer_byte_size != 0)
2843                         ++num_keys_decoded;
2844                 }
2845                 else if (name.compare("pid") == 0)
2846                 {
2847                     pid = StringConvert::ToUInt64(value.c_str(), 0, 16);
2848                     if (pid != LLDB_INVALID_PROCESS_ID)
2849                         ++num_keys_decoded;
2850                 }
2851             }
2852             if (num_keys_decoded > 0)
2853                 m_qProcessInfo_is_valid = eLazyBoolYes;
2854             if (pid != LLDB_INVALID_PROCESS_ID)
2855             {
2856                 m_curr_pid_is_valid = eLazyBoolYes;
2857                 m_curr_pid = pid;
2858             }
2859 
2860             // Set the ArchSpec from the triple if we have it.
2861             if (!triple.empty ())
2862             {
2863                 m_process_arch.SetTriple (triple.c_str ());
2864                 if (pointer_byte_size)
2865                 {
2866                     assert (pointer_byte_size == m_process_arch.GetAddressByteSize());
2867                 }
2868             }
2869             else if (cpu != LLDB_INVALID_CPUTYPE && !os_name.empty() && !vendor_name.empty())
2870             {
2871                 llvm::Triple triple(llvm::Twine("-") + vendor_name + "-" + os_name);
2872 
2873                 assert(triple.getObjectFormat() != llvm::Triple::UnknownObjectFormat);
2874                 switch (triple.getObjectFormat()) {
2875                     case llvm::Triple::MachO:
2876                         m_process_arch.SetArchitecture (eArchTypeMachO, cpu, sub);
2877                         break;
2878                     case llvm::Triple::ELF:
2879                         m_process_arch.SetArchitecture (eArchTypeELF, cpu, sub);
2880                         break;
2881                     case llvm::Triple::COFF:
2882                         m_process_arch.SetArchitecture (eArchTypeCOFF, cpu, sub);
2883                         break;
2884                     case llvm::Triple::UnknownObjectFormat:
2885                         if (log)
2886                             log->Printf("error: failed to determine target architecture");
2887                         return false;
2888                 }
2889 
2890                 if (pointer_byte_size)
2891                 {
2892                     assert (pointer_byte_size == m_process_arch.GetAddressByteSize());
2893                 }
2894                 if (byte_order != eByteOrderInvalid)
2895                 {
2896                     assert (byte_order == m_process_arch.GetByteOrder());
2897                 }
2898                 m_process_arch.GetTriple().setVendorName (llvm::StringRef (vendor_name));
2899                 m_process_arch.GetTriple().setOSName(llvm::StringRef (os_name));
2900                 m_host_arch.GetTriple().setVendorName (llvm::StringRef (vendor_name));
2901                 m_host_arch.GetTriple().setOSName (llvm::StringRef (os_name));
2902             }
2903             return true;
2904         }
2905     }
2906     else
2907     {
2908         m_qProcessInfo_is_valid = eLazyBoolNo;
2909     }
2910 
2911     return false;
2912 }
2913 
2914 
2915 uint32_t
2916 GDBRemoteCommunicationClient::FindProcesses (const ProcessInstanceInfoMatch &match_info,
2917                                              ProcessInstanceInfoList &process_infos)
2918 {
2919     process_infos.Clear();
2920 
2921     if (m_supports_qfProcessInfo)
2922     {
2923         StreamString packet;
2924         packet.PutCString ("qfProcessInfo");
2925         if (!match_info.MatchAllProcesses())
2926         {
2927             packet.PutChar (':');
2928             const char *name = match_info.GetProcessInfo().GetName();
2929             bool has_name_match = false;
2930             if (name && name[0])
2931             {
2932                 has_name_match = true;
2933                 NameMatchType name_match_type = match_info.GetNameMatchType();
2934                 switch (name_match_type)
2935                 {
2936                 case eNameMatchIgnore:
2937                     has_name_match = false;
2938                     break;
2939 
2940                 case eNameMatchEquals:
2941                     packet.PutCString ("name_match:equals;");
2942                     break;
2943 
2944                 case eNameMatchContains:
2945                     packet.PutCString ("name_match:contains;");
2946                     break;
2947 
2948                 case eNameMatchStartsWith:
2949                     packet.PutCString ("name_match:starts_with;");
2950                     break;
2951 
2952                 case eNameMatchEndsWith:
2953                     packet.PutCString ("name_match:ends_with;");
2954                     break;
2955 
2956                 case eNameMatchRegularExpression:
2957                     packet.PutCString ("name_match:regex;");
2958                     break;
2959                 }
2960                 if (has_name_match)
2961                 {
2962                     packet.PutCString ("name:");
2963                     packet.PutBytesAsRawHex8(name, ::strlen(name));
2964                     packet.PutChar (';');
2965                 }
2966             }
2967 
2968             if (match_info.GetProcessInfo().ProcessIDIsValid())
2969                 packet.Printf("pid:%" PRIu64 ";",match_info.GetProcessInfo().GetProcessID());
2970             if (match_info.GetProcessInfo().ParentProcessIDIsValid())
2971                 packet.Printf("parent_pid:%" PRIu64 ";",match_info.GetProcessInfo().GetParentProcessID());
2972             if (match_info.GetProcessInfo().UserIDIsValid())
2973                 packet.Printf("uid:%u;",match_info.GetProcessInfo().GetUserID());
2974             if (match_info.GetProcessInfo().GroupIDIsValid())
2975                 packet.Printf("gid:%u;",match_info.GetProcessInfo().GetGroupID());
2976             if (match_info.GetProcessInfo().EffectiveUserIDIsValid())
2977                 packet.Printf("euid:%u;",match_info.GetProcessInfo().GetEffectiveUserID());
2978             if (match_info.GetProcessInfo().EffectiveGroupIDIsValid())
2979                 packet.Printf("egid:%u;",match_info.GetProcessInfo().GetEffectiveGroupID());
2980             if (match_info.GetProcessInfo().EffectiveGroupIDIsValid())
2981                 packet.Printf("all_users:%u;",match_info.GetMatchAllUsers() ? 1 : 0);
2982             if (match_info.GetProcessInfo().GetArchitecture().IsValid())
2983             {
2984                 const ArchSpec &match_arch = match_info.GetProcessInfo().GetArchitecture();
2985                 const llvm::Triple &triple = match_arch.GetTriple();
2986                 packet.PutCString("triple:");
2987                 packet.PutCString(triple.getTriple().c_str());
2988                 packet.PutChar (';');
2989             }
2990         }
2991         StringExtractorGDBRemote response;
2992         // Increase timeout as the first qfProcessInfo packet takes a long time
2993         // on Android. The value of 1min was arrived at empirically.
2994         GDBRemoteCommunication::ScopedTimeout timeout (*this, 60);
2995         if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) == PacketResult::Success)
2996         {
2997             do
2998             {
2999                 ProcessInstanceInfo process_info;
3000                 if (!DecodeProcessInfoResponse (response, process_info))
3001                     break;
3002                 process_infos.Append(process_info);
3003                 response.GetStringRef().clear();
3004                 response.SetFilePos(0);
3005             } while (SendPacketAndWaitForResponse ("qsProcessInfo", strlen ("qsProcessInfo"), response, false) == PacketResult::Success);
3006         }
3007         else
3008         {
3009             m_supports_qfProcessInfo = false;
3010             return 0;
3011         }
3012     }
3013     return process_infos.GetSize();
3014 
3015 }
3016 
3017 bool
3018 GDBRemoteCommunicationClient::GetUserName (uint32_t uid, std::string &name)
3019 {
3020     if (m_supports_qUserName)
3021     {
3022         char packet[32];
3023         const int packet_len = ::snprintf (packet, sizeof (packet), "qUserName:%i", uid);
3024         assert (packet_len < (int)sizeof(packet));
3025         StringExtractorGDBRemote response;
3026         if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success)
3027         {
3028             if (response.IsNormalResponse())
3029             {
3030                 // Make sure we parsed the right number of characters. The response is
3031                 // the hex encoded user name and should make up the entire packet.
3032                 // If there are any non-hex ASCII bytes, the length won't match below..
3033                 if (response.GetHexByteString (name) * 2 == response.GetStringRef().size())
3034                     return true;
3035             }
3036         }
3037         else
3038         {
3039             m_supports_qUserName = false;
3040             return false;
3041         }
3042     }
3043     return false;
3044 
3045 }
3046 
3047 bool
3048 GDBRemoteCommunicationClient::GetGroupName (uint32_t gid, std::string &name)
3049 {
3050     if (m_supports_qGroupName)
3051     {
3052         char packet[32];
3053         const int packet_len = ::snprintf (packet, sizeof (packet), "qGroupName:%i", gid);
3054         assert (packet_len < (int)sizeof(packet));
3055         StringExtractorGDBRemote response;
3056         if (SendPacketAndWaitForResponse (packet, packet_len, response, false) == PacketResult::Success)
3057         {
3058             if (response.IsNormalResponse())
3059             {
3060                 // Make sure we parsed the right number of characters. The response is
3061                 // the hex encoded group name and should make up the entire packet.
3062                 // If there are any non-hex ASCII bytes, the length won't match below..
3063                 if (response.GetHexByteString (name) * 2 == response.GetStringRef().size())
3064                     return true;
3065             }
3066         }
3067         else
3068         {
3069             m_supports_qGroupName = false;
3070             return false;
3071         }
3072     }
3073     return false;
3074 }
3075 
3076 bool
3077 GDBRemoteCommunicationClient::SetNonStopMode (const bool enable)
3078 {
3079     // Form non-stop packet request
3080     char packet[32];
3081     const int packet_len = ::snprintf(packet, sizeof(packet), "QNonStop:%1d", (int)enable);
3082     assert(packet_len < (int)sizeof(packet));
3083 
3084     StringExtractorGDBRemote response;
3085     // Send to target
3086     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3087         if (response.IsOKResponse())
3088             return true;
3089 
3090     // Failed or not supported
3091     return false;
3092 
3093 }
3094 
3095 static void
3096 MakeSpeedTestPacket(StreamString &packet, uint32_t send_size, uint32_t recv_size)
3097 {
3098     packet.Clear();
3099     packet.Printf ("qSpeedTest:response_size:%i;data:", recv_size);
3100     uint32_t bytes_left = send_size;
3101     while (bytes_left > 0)
3102     {
3103         if (bytes_left >= 26)
3104         {
3105             packet.PutCString("abcdefghijklmnopqrstuvwxyz");
3106             bytes_left -= 26;
3107         }
3108         else
3109         {
3110             packet.Printf ("%*.*s;", bytes_left, bytes_left, "abcdefghijklmnopqrstuvwxyz");
3111             bytes_left = 0;
3112         }
3113     }
3114 }
3115 
3116 template<typename T>
3117 T calculate_standard_deviation(const std::vector<T> &v)
3118 {
3119     T sum = std::accumulate(std::begin(v), std::end(v), T(0));
3120     T mean =  sum / (T)v.size();
3121     T accum = T(0);
3122     std::for_each (std::begin(v), std::end(v), [&](const T d) {
3123         T delta = d - mean;
3124         accum += delta * delta;
3125     });
3126 
3127     T stdev = sqrt(accum / (v.size()-1));
3128     return stdev;
3129 }
3130 
3131 void
3132 GDBRemoteCommunicationClient::TestPacketSpeed (const uint32_t num_packets, uint32_t max_send, uint32_t max_recv, bool json, Stream &strm)
3133 {
3134     uint32_t i;
3135     TimeValue start_time, end_time;
3136     uint64_t total_time_nsec;
3137     if (SendSpeedTestPacket (0, 0))
3138     {
3139         StreamString packet;
3140         if (json)
3141             strm.Printf("{ \"packet_speeds\" : {\n    \"num_packets\" : %u,\n    \"results\" : [", num_packets);
3142         else
3143             strm.Printf("Testing sending %u packets of various sizes:\n", num_packets);
3144         strm.Flush();
3145 
3146         uint32_t result_idx = 0;
3147         uint32_t send_size;
3148         std::vector<float> packet_times;
3149 
3150         for (send_size = 0; send_size <= max_send; send_size ? send_size *= 2 : send_size = 4)
3151         {
3152             for (uint32_t recv_size = 0; recv_size <= max_recv; recv_size ? recv_size *= 2 : recv_size = 4)
3153             {
3154                 MakeSpeedTestPacket (packet, send_size, recv_size);
3155 
3156                 packet_times.clear();
3157                 // Test how long it takes to send 'num_packets' packets
3158                 start_time = TimeValue::Now();
3159                 for (i=0; i<num_packets; ++i)
3160                 {
3161                     TimeValue packet_start_time = TimeValue::Now();
3162                     StringExtractorGDBRemote response;
3163                     SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false);
3164                     TimeValue packet_end_time = TimeValue::Now();
3165                     uint64_t packet_time_nsec = packet_end_time.GetAsNanoSecondsSinceJan1_1970() - packet_start_time.GetAsNanoSecondsSinceJan1_1970();
3166                     packet_times.push_back((float)packet_time_nsec);
3167                 }
3168                 end_time = TimeValue::Now();
3169                 total_time_nsec = end_time.GetAsNanoSecondsSinceJan1_1970() - start_time.GetAsNanoSecondsSinceJan1_1970();
3170 
3171                 float packets_per_second = (((float)num_packets)/(float)total_time_nsec) * (float)TimeValue::NanoSecPerSec;
3172                 float total_ms = (float)total_time_nsec/(float)TimeValue::NanoSecPerMilliSec;
3173                 float average_ms_per_packet = total_ms / num_packets;
3174                 const float standard_deviation = calculate_standard_deviation<float>(packet_times);
3175                 if (json)
3176                 {
3177                     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);
3178                     ++result_idx;
3179                 }
3180                 else
3181                 {
3182                     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",
3183                                  send_size,
3184                                  recv_size,
3185                                  total_time_nsec / TimeValue::NanoSecPerSec,
3186                                  total_time_nsec % TimeValue::NanoSecPerSec,
3187                                  packets_per_second,
3188                                  average_ms_per_packet,
3189                                  standard_deviation/(float)TimeValue::NanoSecPerMilliSec);
3190                 }
3191                 strm.Flush();
3192             }
3193         }
3194 
3195         const uint64_t k_recv_amount = 4*1024*1024; // Receive amount in bytes
3196 
3197         const float k_recv_amount_mb = (float)k_recv_amount/(1024.0f*1024.0f);
3198         if (json)
3199             strm.Printf("\n    ]\n  },\n  \"download_speed\" : {\n    \"byte_size\" : %" PRIu64 ",\n    \"results\" : [", k_recv_amount);
3200         else
3201             strm.Printf("Testing receiving %2.1fMB of data using varying receive packet sizes:\n", k_recv_amount_mb);
3202         strm.Flush();
3203         send_size = 0;
3204         result_idx = 0;
3205         for (uint32_t recv_size = 32; recv_size <= max_recv; recv_size *= 2)
3206         {
3207             MakeSpeedTestPacket (packet, send_size, recv_size);
3208 
3209             // If we have a receive size, test how long it takes to receive 4MB of data
3210             if (recv_size > 0)
3211             {
3212                 start_time = TimeValue::Now();
3213                 uint32_t bytes_read = 0;
3214                 uint32_t packet_count = 0;
3215                 while (bytes_read < k_recv_amount)
3216                 {
3217                     StringExtractorGDBRemote response;
3218                     SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false);
3219                     bytes_read += recv_size;
3220                     ++packet_count;
3221                 }
3222                 end_time = TimeValue::Now();
3223                 total_time_nsec = end_time.GetAsNanoSecondsSinceJan1_1970() - start_time.GetAsNanoSecondsSinceJan1_1970();
3224                 float mb_second = ((((float)k_recv_amount)/(float)total_time_nsec) * (float)TimeValue::NanoSecPerSec) / (1024.0*1024.0);
3225                 float packets_per_second = (((float)packet_count)/(float)total_time_nsec) * (float)TimeValue::NanoSecPerSec;
3226                 float total_ms = (float)total_time_nsec/(float)TimeValue::NanoSecPerMilliSec;
3227                 float average_ms_per_packet = total_ms / packet_count;
3228 
3229                 if (json)
3230                 {
3231                     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);
3232                     ++result_idx;
3233                 }
3234                 else
3235                 {
3236                     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",
3237                                  send_size,
3238                                  recv_size,
3239                                  packet_count,
3240                                  k_recv_amount_mb,
3241                                  total_time_nsec / TimeValue::NanoSecPerSec,
3242                                  total_time_nsec % TimeValue::NanoSecPerSec,
3243                                  mb_second,
3244                                  packets_per_second,
3245                                  average_ms_per_packet);
3246                 }
3247                 strm.Flush();
3248             }
3249         }
3250         if (json)
3251             strm.Printf("\n    ]\n  }\n}\n");
3252         else
3253             strm.EOL();
3254     }
3255 }
3256 
3257 bool
3258 GDBRemoteCommunicationClient::SendSpeedTestPacket (uint32_t send_size, uint32_t recv_size)
3259 {
3260     StreamString packet;
3261     packet.Printf ("qSpeedTest:response_size:%i;data:", recv_size);
3262     uint32_t bytes_left = send_size;
3263     while (bytes_left > 0)
3264     {
3265         if (bytes_left >= 26)
3266         {
3267             packet.PutCString("abcdefghijklmnopqrstuvwxyz");
3268             bytes_left -= 26;
3269         }
3270         else
3271         {
3272             packet.Printf ("%*.*s;", bytes_left, bytes_left, "abcdefghijklmnopqrstuvwxyz");
3273             bytes_left = 0;
3274         }
3275     }
3276 
3277     StringExtractorGDBRemote response;
3278     return SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false)  == PacketResult::Success;
3279 }
3280 
3281 uint16_t
3282 GDBRemoteCommunicationClient::LaunchGDBserverAndGetPort (lldb::pid_t &pid, const char *remote_accept_hostname)
3283 {
3284     pid = LLDB_INVALID_PROCESS_ID;
3285     StringExtractorGDBRemote response;
3286     StreamString stream;
3287     stream.PutCString("qLaunchGDBServer;");
3288     std::string hostname;
3289     if (remote_accept_hostname  && remote_accept_hostname[0])
3290         hostname = remote_accept_hostname;
3291     else
3292     {
3293         if (HostInfo::GetHostname(hostname))
3294         {
3295             // Make the GDB server we launch only accept connections from this host
3296             stream.Printf("host:%s;", hostname.c_str());
3297         }
3298         else
3299         {
3300             // Make the GDB server we launch accept connections from any host since we can't figure out the hostname
3301             stream.Printf("host:*;");
3302         }
3303     }
3304     const char *packet = stream.GetData();
3305     int packet_len = stream.GetSize();
3306 
3307     // give the process a few seconds to startup
3308     GDBRemoteCommunication::ScopedTimeout timeout (*this, 10);
3309 
3310     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3311     {
3312         std::string name;
3313         std::string value;
3314         uint16_t port = 0;
3315         while (response.GetNameColonValue(name, value))
3316         {
3317             if (name.compare("port") == 0)
3318                 port = StringConvert::ToUInt32(value.c_str(), 0, 0);
3319             else if (name.compare("pid") == 0)
3320                 pid = StringConvert::ToUInt64(value.c_str(), LLDB_INVALID_PROCESS_ID, 0);
3321         }
3322         return port;
3323     }
3324     return 0;
3325 }
3326 
3327 bool
3328 GDBRemoteCommunicationClient::KillSpawnedProcess (lldb::pid_t pid)
3329 {
3330     StreamString stream;
3331     stream.Printf ("qKillSpawnedProcess:%" PRId64 , pid);
3332     const char *packet = stream.GetData();
3333     int packet_len = stream.GetSize();
3334 
3335     StringExtractorGDBRemote response;
3336     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3337     {
3338         if (response.IsOKResponse())
3339             return true;
3340     }
3341     return false;
3342 }
3343 
3344 bool
3345 GDBRemoteCommunicationClient::SetCurrentThread (uint64_t tid)
3346 {
3347     if (m_curr_tid == tid)
3348         return true;
3349 
3350     char packet[32];
3351     int packet_len;
3352     if (tid == UINT64_MAX)
3353         packet_len = ::snprintf (packet, sizeof(packet), "Hg-1");
3354     else
3355         packet_len = ::snprintf (packet, sizeof(packet), "Hg%" PRIx64, tid);
3356     assert (packet_len + 1 < (int)sizeof(packet));
3357     StringExtractorGDBRemote response;
3358     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3359     {
3360         if (response.IsOKResponse())
3361         {
3362             m_curr_tid = tid;
3363             return true;
3364         }
3365     }
3366     return false;
3367 }
3368 
3369 bool
3370 GDBRemoteCommunicationClient::SetCurrentThreadForRun (uint64_t tid)
3371 {
3372     if (m_curr_tid_run == tid)
3373         return true;
3374 
3375     char packet[32];
3376     int packet_len;
3377     if (tid == UINT64_MAX)
3378         packet_len = ::snprintf (packet, sizeof(packet), "Hc-1");
3379     else
3380         packet_len = ::snprintf (packet, sizeof(packet), "Hc%" PRIx64, tid);
3381 
3382     assert (packet_len + 1 < (int)sizeof(packet));
3383     StringExtractorGDBRemote response;
3384     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3385     {
3386         if (response.IsOKResponse())
3387         {
3388             m_curr_tid_run = tid;
3389             return true;
3390         }
3391     }
3392     return false;
3393 }
3394 
3395 bool
3396 GDBRemoteCommunicationClient::GetStopReply (StringExtractorGDBRemote &response)
3397 {
3398     if (SendPacketAndWaitForResponse("?", 1, response, false) == PacketResult::Success)
3399         return response.IsNormalResponse();
3400     return false;
3401 }
3402 
3403 bool
3404 GDBRemoteCommunicationClient::GetThreadStopInfo (lldb::tid_t tid, StringExtractorGDBRemote &response)
3405 {
3406     if (m_supports_qThreadStopInfo)
3407     {
3408         char packet[256];
3409         int packet_len = ::snprintf(packet, sizeof(packet), "qThreadStopInfo%" PRIx64, tid);
3410         assert (packet_len < (int)sizeof(packet));
3411         if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3412         {
3413             if (response.IsUnsupportedResponse())
3414                 m_supports_qThreadStopInfo = false;
3415             else if (response.IsNormalResponse())
3416                 return true;
3417             else
3418                 return false;
3419         }
3420         else
3421         {
3422             m_supports_qThreadStopInfo = false;
3423         }
3424     }
3425     return false;
3426 }
3427 
3428 
3429 uint8_t
3430 GDBRemoteCommunicationClient::SendGDBStoppointTypePacket (GDBStoppointType type, bool insert,  addr_t addr, uint32_t length)
3431 {
3432     Log *log (GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
3433     if (log)
3434         log->Printf ("GDBRemoteCommunicationClient::%s() %s at addr = 0x%" PRIx64,
3435                      __FUNCTION__, insert ? "add" : "remove", addr);
3436 
3437     // Check if the stub is known not to support this breakpoint type
3438     if (!SupportsGDBStoppointPacket(type))
3439         return UINT8_MAX;
3440     // Construct the breakpoint packet
3441     char packet[64];
3442     const int packet_len = ::snprintf (packet,
3443                                        sizeof(packet),
3444                                        "%c%i,%" PRIx64 ",%x",
3445                                        insert ? 'Z' : 'z',
3446                                        type,
3447                                        addr,
3448                                        length);
3449     // Check we haven't overwritten the end of the packet buffer
3450     assert (packet_len + 1 < (int)sizeof(packet));
3451     StringExtractorGDBRemote response;
3452     // Try to send the breakpoint packet, and check that it was correctly sent
3453     if (SendPacketAndWaitForResponse(packet, packet_len, response, true) == PacketResult::Success)
3454     {
3455         // Receive and OK packet when the breakpoint successfully placed
3456         if (response.IsOKResponse())
3457             return 0;
3458 
3459         // Error while setting breakpoint, send back specific error
3460         if (response.IsErrorResponse())
3461             return response.GetError();
3462 
3463         // Empty packet informs us that breakpoint is not supported
3464         if (response.IsUnsupportedResponse())
3465         {
3466             // Disable this breakpoint type since it is unsupported
3467             switch (type)
3468             {
3469             case eBreakpointSoftware:   m_supports_z0 = false; break;
3470             case eBreakpointHardware:   m_supports_z1 = false; break;
3471             case eWatchpointWrite:      m_supports_z2 = false; break;
3472             case eWatchpointRead:       m_supports_z3 = false; break;
3473             case eWatchpointReadWrite:  m_supports_z4 = false; break;
3474             case eStoppointInvalid:     return UINT8_MAX;
3475             }
3476         }
3477     }
3478     // Signal generic failure
3479     return UINT8_MAX;
3480 }
3481 
3482 size_t
3483 GDBRemoteCommunicationClient::GetCurrentThreadIDs (std::vector<lldb::tid_t> &thread_ids,
3484                                                    bool &sequence_mutex_unavailable)
3485 {
3486     Mutex::Locker locker;
3487     thread_ids.clear();
3488 
3489     if (GetSequenceMutex (locker, "ProcessGDBRemote::UpdateThreadList() failed due to not getting the sequence mutex"))
3490     {
3491         sequence_mutex_unavailable = false;
3492         StringExtractorGDBRemote response;
3493 
3494         PacketResult packet_result;
3495         for (packet_result = SendPacketAndWaitForResponseNoLock ("qfThreadInfo", strlen("qfThreadInfo"), response);
3496              packet_result == PacketResult::Success && response.IsNormalResponse();
3497              packet_result = SendPacketAndWaitForResponseNoLock ("qsThreadInfo", strlen("qsThreadInfo"), response))
3498         {
3499             char ch = response.GetChar();
3500             if (ch == 'l')
3501                 break;
3502             if (ch == 'm')
3503             {
3504                 do
3505                 {
3506                     tid_t tid = response.GetHexMaxU64(false, LLDB_INVALID_THREAD_ID);
3507 
3508                     if (tid != LLDB_INVALID_THREAD_ID)
3509                     {
3510                         thread_ids.push_back (tid);
3511                     }
3512                     ch = response.GetChar();    // Skip the command separator
3513                 } while (ch == ',');            // Make sure we got a comma separator
3514             }
3515         }
3516     }
3517     else
3518     {
3519 #if defined (LLDB_CONFIGURATION_DEBUG)
3520         // assert(!"ProcessGDBRemote::UpdateThreadList() failed due to not getting the sequence mutex");
3521 #else
3522         Log *log (ProcessGDBRemoteLog::GetLogIfAnyCategoryIsSet (GDBR_LOG_PROCESS | GDBR_LOG_PACKETS));
3523         if (log)
3524             log->Printf("error: failed to get packet sequence mutex, not sending packet 'qfThreadInfo'");
3525 #endif
3526         sequence_mutex_unavailable = true;
3527     }
3528     return thread_ids.size();
3529 }
3530 
3531 lldb::addr_t
3532 GDBRemoteCommunicationClient::GetShlibInfoAddr()
3533 {
3534     if (!IsRunning())
3535     {
3536         StringExtractorGDBRemote response;
3537         if (SendPacketAndWaitForResponse("qShlibInfoAddr", ::strlen ("qShlibInfoAddr"), response, false) == PacketResult::Success)
3538         {
3539             if (response.IsNormalResponse())
3540                 return response.GetHexMaxU64(false, LLDB_INVALID_ADDRESS);
3541         }
3542     }
3543     return LLDB_INVALID_ADDRESS;
3544 }
3545 
3546 lldb_private::Error
3547 GDBRemoteCommunicationClient::RunShellCommand(const char *command,           // Shouldn't be NULL
3548                                               const FileSpec &working_dir,   // Pass empty FileSpec to use the current working directory
3549                                               int *status_ptr,               // Pass NULL if you don't want the process exit status
3550                                               int *signo_ptr,                // Pass NULL if you don't want the signal that caused the process to exit
3551                                               std::string *command_output,   // Pass NULL if you don't want the command output
3552                                               uint32_t timeout_sec)          // Timeout in seconds to wait for shell program to finish
3553 {
3554     lldb_private::StreamString stream;
3555     stream.PutCString("qPlatform_shell:");
3556     stream.PutBytesAsRawHex8(command, strlen(command));
3557     stream.PutChar(',');
3558     stream.PutHex32(timeout_sec);
3559     if (working_dir)
3560     {
3561         std::string path{working_dir.GetPath(false)};
3562         stream.PutChar(',');
3563         stream.PutCStringAsRawHex8(path.c_str());
3564     }
3565     const char *packet = stream.GetData();
3566     int packet_len = stream.GetSize();
3567     StringExtractorGDBRemote response;
3568     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3569     {
3570         if (response.GetChar() != 'F')
3571             return Error("malformed reply");
3572         if (response.GetChar() != ',')
3573             return Error("malformed reply");
3574         uint32_t exitcode = response.GetHexMaxU32(false, UINT32_MAX);
3575         if (exitcode == UINT32_MAX)
3576             return Error("unable to run remote process");
3577         else if (status_ptr)
3578             *status_ptr = exitcode;
3579         if (response.GetChar() != ',')
3580             return Error("malformed reply");
3581         uint32_t signo = response.GetHexMaxU32(false, UINT32_MAX);
3582         if (signo_ptr)
3583             *signo_ptr = signo;
3584         if (response.GetChar() != ',')
3585             return Error("malformed reply");
3586         std::string output;
3587         response.GetEscapedBinaryData(output);
3588         if (command_output)
3589             command_output->assign(output);
3590         return Error();
3591     }
3592     return Error("unable to send packet");
3593 }
3594 
3595 Error
3596 GDBRemoteCommunicationClient::MakeDirectory(const FileSpec &file_spec,
3597                                             uint32_t file_permissions)
3598 {
3599     std::string path{file_spec.GetPath(false)};
3600     lldb_private::StreamString stream;
3601     stream.PutCString("qPlatform_mkdir:");
3602     stream.PutHex32(file_permissions);
3603     stream.PutChar(',');
3604     stream.PutCStringAsRawHex8(path.c_str());
3605     const char *packet = stream.GetData();
3606     int packet_len = stream.GetSize();
3607     StringExtractorGDBRemote response;
3608 
3609     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) != PacketResult::Success)
3610         return Error("failed to send '%s' packet", packet);
3611 
3612     if (response.GetChar() != 'F')
3613         return Error("invalid response to '%s' packet", packet);
3614 
3615     return Error(response.GetU32(UINT32_MAX), eErrorTypePOSIX);
3616 }
3617 
3618 Error
3619 GDBRemoteCommunicationClient::SetFilePermissions(const FileSpec &file_spec,
3620                                                  uint32_t file_permissions)
3621 {
3622     std::string path{file_spec.GetPath(false)};
3623     lldb_private::StreamString stream;
3624     stream.PutCString("qPlatform_chmod:");
3625     stream.PutHex32(file_permissions);
3626     stream.PutChar(',');
3627     stream.PutCStringAsRawHex8(path.c_str());
3628     const char *packet = stream.GetData();
3629     int packet_len = stream.GetSize();
3630     StringExtractorGDBRemote response;
3631 
3632     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) != PacketResult::Success)
3633         return Error("failed to send '%s' packet", packet);
3634 
3635     if (response.GetChar() != 'F')
3636         return Error("invalid response to '%s' packet", packet);
3637 
3638     return Error(response.GetU32(UINT32_MAX), eErrorTypePOSIX);
3639 }
3640 
3641 static uint64_t
3642 ParseHostIOPacketResponse (StringExtractorGDBRemote &response,
3643                            uint64_t fail_result,
3644                            Error &error)
3645 {
3646     response.SetFilePos(0);
3647     if (response.GetChar() != 'F')
3648         return fail_result;
3649     int32_t result = response.GetS32 (-2);
3650     if (result == -2)
3651         return fail_result;
3652     if (response.GetChar() == ',')
3653     {
3654         int result_errno = response.GetS32 (-2);
3655         if (result_errno != -2)
3656             error.SetError(result_errno, eErrorTypePOSIX);
3657         else
3658             error.SetError(-1, eErrorTypeGeneric);
3659     }
3660     else
3661         error.Clear();
3662     return  result;
3663 }
3664 lldb::user_id_t
3665 GDBRemoteCommunicationClient::OpenFile (const lldb_private::FileSpec& file_spec,
3666                                         uint32_t flags,
3667                                         mode_t mode,
3668                                         Error &error)
3669 {
3670     std::string path(file_spec.GetPath(false));
3671     lldb_private::StreamString stream;
3672     stream.PutCString("vFile:open:");
3673     if (path.empty())
3674         return UINT64_MAX;
3675     stream.PutCStringAsRawHex8(path.c_str());
3676     stream.PutChar(',');
3677     stream.PutHex32(flags);
3678     stream.PutChar(',');
3679     stream.PutHex32(mode);
3680     const char* packet = stream.GetData();
3681     int packet_len = stream.GetSize();
3682     StringExtractorGDBRemote response;
3683     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3684     {
3685         return ParseHostIOPacketResponse (response, UINT64_MAX, error);
3686     }
3687     return UINT64_MAX;
3688 }
3689 
3690 bool
3691 GDBRemoteCommunicationClient::CloseFile (lldb::user_id_t fd,
3692                                          Error &error)
3693 {
3694     lldb_private::StreamString stream;
3695     stream.Printf("vFile:close:%i", (int)fd);
3696     const char* packet = stream.GetData();
3697     int packet_len = stream.GetSize();
3698     StringExtractorGDBRemote response;
3699     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3700     {
3701         return ParseHostIOPacketResponse (response, -1, error) == 0;
3702     }
3703     return false;
3704 }
3705 
3706 // Extension of host I/O packets to get the file size.
3707 lldb::user_id_t
3708 GDBRemoteCommunicationClient::GetFileSize (const lldb_private::FileSpec& file_spec)
3709 {
3710     std::string path(file_spec.GetPath(false));
3711     lldb_private::StreamString stream;
3712     stream.PutCString("vFile:size:");
3713     stream.PutCStringAsRawHex8(path.c_str());
3714     const char* packet = stream.GetData();
3715     int packet_len = stream.GetSize();
3716     StringExtractorGDBRemote response;
3717     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3718     {
3719         if (response.GetChar() != 'F')
3720             return UINT64_MAX;
3721         uint32_t retcode = response.GetHexMaxU64(false, UINT64_MAX);
3722         return retcode;
3723     }
3724     return UINT64_MAX;
3725 }
3726 
3727 Error
3728 GDBRemoteCommunicationClient::GetFilePermissions(const FileSpec &file_spec,
3729                                                  uint32_t &file_permissions)
3730 {
3731     std::string path{file_spec.GetPath(false)};
3732     Error error;
3733     lldb_private::StreamString stream;
3734     stream.PutCString("vFile:mode:");
3735     stream.PutCStringAsRawHex8(path.c_str());
3736     const char* packet = stream.GetData();
3737     int packet_len = stream.GetSize();
3738     StringExtractorGDBRemote response;
3739     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3740     {
3741         if (response.GetChar() != 'F')
3742         {
3743             error.SetErrorStringWithFormat ("invalid response to '%s' packet", packet);
3744         }
3745         else
3746         {
3747             const uint32_t mode = response.GetS32(-1);
3748             if (static_cast<int32_t>(mode) == -1)
3749             {
3750                 if (response.GetChar() == ',')
3751                 {
3752                     int response_errno = response.GetS32(-1);
3753                     if (response_errno > 0)
3754                         error.SetError(response_errno, lldb::eErrorTypePOSIX);
3755                     else
3756                         error.SetErrorToGenericError();
3757                 }
3758                 else
3759                     error.SetErrorToGenericError();
3760             }
3761             else
3762             {
3763                 file_permissions = mode & (S_IRWXU|S_IRWXG|S_IRWXO);
3764             }
3765         }
3766     }
3767     else
3768     {
3769         error.SetErrorStringWithFormat ("failed to send '%s' packet", packet);
3770     }
3771     return error;
3772 }
3773 
3774 uint64_t
3775 GDBRemoteCommunicationClient::ReadFile (lldb::user_id_t fd,
3776                                         uint64_t offset,
3777                                         void *dst,
3778                                         uint64_t dst_len,
3779                                         Error &error)
3780 {
3781     lldb_private::StreamString stream;
3782     stream.Printf("vFile:pread:%i,%" PRId64 ",%" PRId64, (int)fd, dst_len, offset);
3783     const char* packet = stream.GetData();
3784     int packet_len = stream.GetSize();
3785     StringExtractorGDBRemote response;
3786     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3787     {
3788         if (response.GetChar() != 'F')
3789             return 0;
3790         uint32_t retcode = response.GetHexMaxU32(false, UINT32_MAX);
3791         if (retcode == UINT32_MAX)
3792             return retcode;
3793         const char next = (response.Peek() ? *response.Peek() : 0);
3794         if (next == ',')
3795             return 0;
3796         if (next == ';')
3797         {
3798             response.GetChar(); // skip the semicolon
3799             std::string buffer;
3800             if (response.GetEscapedBinaryData(buffer))
3801             {
3802                 const uint64_t data_to_write = std::min<uint64_t>(dst_len, buffer.size());
3803                 if (data_to_write > 0)
3804                     memcpy(dst, &buffer[0], data_to_write);
3805                 return data_to_write;
3806             }
3807         }
3808     }
3809     return 0;
3810 }
3811 
3812 uint64_t
3813 GDBRemoteCommunicationClient::WriteFile (lldb::user_id_t fd,
3814                                          uint64_t offset,
3815                                          const void* src,
3816                                          uint64_t src_len,
3817                                          Error &error)
3818 {
3819     lldb_private::StreamGDBRemote stream;
3820     stream.Printf("vFile:pwrite:%i,%" PRId64 ",", (int)fd, offset);
3821     stream.PutEscapedBytes(src, src_len);
3822     const char* packet = stream.GetData();
3823     int packet_len = stream.GetSize();
3824     StringExtractorGDBRemote response;
3825     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3826     {
3827         if (response.GetChar() != 'F')
3828         {
3829             error.SetErrorStringWithFormat("write file failed");
3830             return 0;
3831         }
3832         uint64_t bytes_written = response.GetU64(UINT64_MAX);
3833         if (bytes_written == UINT64_MAX)
3834         {
3835             error.SetErrorToGenericError();
3836             if (response.GetChar() == ',')
3837             {
3838                 int response_errno = response.GetS32(-1);
3839                 if (response_errno > 0)
3840                     error.SetError(response_errno, lldb::eErrorTypePOSIX);
3841             }
3842             return 0;
3843         }
3844         return bytes_written;
3845     }
3846     else
3847     {
3848         error.SetErrorString ("failed to send vFile:pwrite packet");
3849     }
3850     return 0;
3851 }
3852 
3853 Error
3854 GDBRemoteCommunicationClient::CreateSymlink(const FileSpec &src, const FileSpec &dst)
3855 {
3856     std::string src_path{src.GetPath(false)},
3857                 dst_path{dst.GetPath(false)};
3858     Error error;
3859     lldb_private::StreamGDBRemote stream;
3860     stream.PutCString("vFile:symlink:");
3861     // the unix symlink() command reverses its parameters where the dst if first,
3862     // so we follow suit here
3863     stream.PutCStringAsRawHex8(dst_path.c_str());
3864     stream.PutChar(',');
3865     stream.PutCStringAsRawHex8(src_path.c_str());
3866     const char* packet = stream.GetData();
3867     int packet_len = stream.GetSize();
3868     StringExtractorGDBRemote response;
3869     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3870     {
3871         if (response.GetChar() == 'F')
3872         {
3873             uint32_t result = response.GetU32(UINT32_MAX);
3874             if (result != 0)
3875             {
3876                 error.SetErrorToGenericError();
3877                 if (response.GetChar() == ',')
3878                 {
3879                     int response_errno = response.GetS32(-1);
3880                     if (response_errno > 0)
3881                         error.SetError(response_errno, lldb::eErrorTypePOSIX);
3882                 }
3883             }
3884         }
3885         else
3886         {
3887             // Should have returned with 'F<result>[,<errno>]'
3888             error.SetErrorStringWithFormat("symlink failed");
3889         }
3890     }
3891     else
3892     {
3893         error.SetErrorString ("failed to send vFile:symlink packet");
3894     }
3895     return error;
3896 }
3897 
3898 Error
3899 GDBRemoteCommunicationClient::Unlink(const FileSpec &file_spec)
3900 {
3901     std::string path{file_spec.GetPath(false)};
3902     Error error;
3903     lldb_private::StreamGDBRemote stream;
3904     stream.PutCString("vFile:unlink:");
3905     // the unix symlink() command reverses its parameters where the dst if first,
3906     // so we follow suit here
3907     stream.PutCStringAsRawHex8(path.c_str());
3908     const char* packet = stream.GetData();
3909     int packet_len = stream.GetSize();
3910     StringExtractorGDBRemote response;
3911     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3912     {
3913         if (response.GetChar() == 'F')
3914         {
3915             uint32_t result = response.GetU32(UINT32_MAX);
3916             if (result != 0)
3917             {
3918                 error.SetErrorToGenericError();
3919                 if (response.GetChar() == ',')
3920                 {
3921                     int response_errno = response.GetS32(-1);
3922                     if (response_errno > 0)
3923                         error.SetError(response_errno, lldb::eErrorTypePOSIX);
3924                 }
3925             }
3926         }
3927         else
3928         {
3929             // Should have returned with 'F<result>[,<errno>]'
3930             error.SetErrorStringWithFormat("unlink failed");
3931         }
3932     }
3933     else
3934     {
3935         error.SetErrorString ("failed to send vFile:unlink packet");
3936     }
3937     return error;
3938 }
3939 
3940 // Extension of host I/O packets to get whether a file exists.
3941 bool
3942 GDBRemoteCommunicationClient::GetFileExists (const lldb_private::FileSpec& file_spec)
3943 {
3944     std::string path(file_spec.GetPath(false));
3945     lldb_private::StreamString stream;
3946     stream.PutCString("vFile:exists:");
3947     stream.PutCStringAsRawHex8(path.c_str());
3948     const char* packet = stream.GetData();
3949     int packet_len = stream.GetSize();
3950     StringExtractorGDBRemote response;
3951     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3952     {
3953         if (response.GetChar() != 'F')
3954             return false;
3955         if (response.GetChar() != ',')
3956             return false;
3957         bool retcode = (response.GetChar() != '0');
3958         return retcode;
3959     }
3960     return false;
3961 }
3962 
3963 bool
3964 GDBRemoteCommunicationClient::CalculateMD5 (const lldb_private::FileSpec& file_spec,
3965                                             uint64_t &high,
3966                                             uint64_t &low)
3967 {
3968     std::string path(file_spec.GetPath(false));
3969     lldb_private::StreamString stream;
3970     stream.PutCString("vFile:MD5:");
3971     stream.PutCStringAsRawHex8(path.c_str());
3972     const char* packet = stream.GetData();
3973     int packet_len = stream.GetSize();
3974     StringExtractorGDBRemote response;
3975     if (SendPacketAndWaitForResponse(packet, packet_len, response, false) == PacketResult::Success)
3976     {
3977         if (response.GetChar() != 'F')
3978             return false;
3979         if (response.GetChar() != ',')
3980             return false;
3981         if (response.Peek() && *response.Peek() == 'x')
3982             return false;
3983         low = response.GetHexMaxU64(false, UINT64_MAX);
3984         high = response.GetHexMaxU64(false, UINT64_MAX);
3985         return true;
3986     }
3987     return false;
3988 }
3989 
3990 bool
3991 GDBRemoteCommunicationClient::AvoidGPackets (ProcessGDBRemote *process)
3992 {
3993     // Some targets have issues with g/G packets and we need to avoid using them
3994     if (m_avoid_g_packets == eLazyBoolCalculate)
3995     {
3996         if (process)
3997         {
3998             m_avoid_g_packets = eLazyBoolNo;
3999             const ArchSpec &arch = process->GetTarget().GetArchitecture();
4000             if (arch.IsValid()
4001                 && arch.GetTriple().getVendor() == llvm::Triple::Apple
4002                 && arch.GetTriple().getOS() == llvm::Triple::IOS
4003                 && arch.GetTriple().getArch() == llvm::Triple::aarch64)
4004             {
4005                 m_avoid_g_packets = eLazyBoolYes;
4006                 uint32_t gdb_server_version = GetGDBServerProgramVersion();
4007                 if (gdb_server_version != 0)
4008                 {
4009                     const char *gdb_server_name = GetGDBServerProgramName();
4010                     if (gdb_server_name && strcmp(gdb_server_name, "debugserver") == 0)
4011                     {
4012                         if (gdb_server_version >= 310)
4013                             m_avoid_g_packets = eLazyBoolNo;
4014                     }
4015                 }
4016             }
4017         }
4018     }
4019     return m_avoid_g_packets == eLazyBoolYes;
4020 }
4021 
4022 bool
4023 GDBRemoteCommunicationClient::ReadRegister(lldb::tid_t tid, uint32_t reg, StringExtractorGDBRemote &response)
4024 {
4025     Mutex::Locker locker;
4026     if (GetSequenceMutex (locker, "Didn't get sequence mutex for p packet."))
4027     {
4028         const bool thread_suffix_supported = GetThreadSuffixSupported();
4029 
4030         if (thread_suffix_supported || SetCurrentThread(tid))
4031         {
4032             char packet[64];
4033             int packet_len = 0;
4034             if (thread_suffix_supported)
4035                 packet_len = ::snprintf (packet, sizeof(packet), "p%x;thread:%4.4" PRIx64 ";", reg, tid);
4036             else
4037                 packet_len = ::snprintf (packet, sizeof(packet), "p%x", reg);
4038             assert (packet_len < ((int)sizeof(packet) - 1));
4039             return SendPacketAndWaitForResponse(packet, response, false) == PacketResult::Success;
4040         }
4041     }
4042     return false;
4043 
4044 }
4045 
4046 
4047 bool
4048 GDBRemoteCommunicationClient::ReadAllRegisters (lldb::tid_t tid, StringExtractorGDBRemote &response)
4049 {
4050     Mutex::Locker locker;
4051     if (GetSequenceMutex (locker, "Didn't get sequence mutex for g packet."))
4052     {
4053         const bool thread_suffix_supported = GetThreadSuffixSupported();
4054 
4055         if (thread_suffix_supported || SetCurrentThread(tid))
4056         {
4057             char packet[64];
4058             int packet_len = 0;
4059             // Get all registers in one packet
4060             if (thread_suffix_supported)
4061                 packet_len = ::snprintf (packet, sizeof(packet), "g;thread:%4.4" PRIx64 ";", tid);
4062             else
4063                 packet_len = ::snprintf (packet, sizeof(packet), "g");
4064             assert (packet_len < ((int)sizeof(packet) - 1));
4065             return SendPacketAndWaitForResponse(packet, response, false) == PacketResult::Success;
4066         }
4067     }
4068     return false;
4069 }
4070 bool
4071 GDBRemoteCommunicationClient::SaveRegisterState (lldb::tid_t tid, uint32_t &save_id)
4072 {
4073     save_id = 0; // Set to invalid save ID
4074     if (m_supports_QSaveRegisterState == eLazyBoolNo)
4075         return false;
4076 
4077     m_supports_QSaveRegisterState = eLazyBoolYes;
4078     Mutex::Locker locker;
4079     if (GetSequenceMutex (locker, "Didn't get sequence mutex for QSaveRegisterState."))
4080     {
4081         const bool thread_suffix_supported = GetThreadSuffixSupported();
4082         if (thread_suffix_supported || SetCurrentThread(tid))
4083         {
4084             char packet[256];
4085             if (thread_suffix_supported)
4086                 ::snprintf (packet, sizeof(packet), "QSaveRegisterState;thread:%4.4" PRIx64 ";", tid);
4087             else
4088                 ::snprintf(packet, sizeof(packet), "QSaveRegisterState");
4089 
4090             StringExtractorGDBRemote response;
4091 
4092             if (SendPacketAndWaitForResponse(packet, response, false) == PacketResult::Success)
4093             {
4094                 if (response.IsUnsupportedResponse())
4095                 {
4096                     // This packet isn't supported, don't try calling it again
4097                     m_supports_QSaveRegisterState = eLazyBoolNo;
4098                 }
4099 
4100                 const uint32_t response_save_id = response.GetU32(0);
4101                 if (response_save_id != 0)
4102                 {
4103                     save_id = response_save_id;
4104                     return true;
4105                 }
4106             }
4107         }
4108     }
4109     return false;
4110 }
4111 
4112 bool
4113 GDBRemoteCommunicationClient::RestoreRegisterState (lldb::tid_t tid, uint32_t save_id)
4114 {
4115     // We use the "m_supports_QSaveRegisterState" variable here because the
4116     // QSaveRegisterState and QRestoreRegisterState packets must both be supported in
4117     // order to be useful
4118     if (m_supports_QSaveRegisterState == eLazyBoolNo)
4119         return false;
4120 
4121     Mutex::Locker locker;
4122     if (GetSequenceMutex (locker, "Didn't get sequence mutex for QRestoreRegisterState."))
4123     {
4124         const bool thread_suffix_supported = GetThreadSuffixSupported();
4125         if (thread_suffix_supported || SetCurrentThread(tid))
4126         {
4127             char packet[256];
4128             if (thread_suffix_supported)
4129                 ::snprintf (packet, sizeof(packet), "QRestoreRegisterState:%u;thread:%4.4" PRIx64 ";", save_id, tid);
4130             else
4131                 ::snprintf (packet, sizeof(packet), "QRestoreRegisterState:%u" PRIx64 ";", save_id);
4132 
4133             StringExtractorGDBRemote response;
4134 
4135             if (SendPacketAndWaitForResponse(packet, response, false) == PacketResult::Success)
4136             {
4137                 if (response.IsOKResponse())
4138                 {
4139                     return true;
4140                 }
4141                 else if (response.IsUnsupportedResponse())
4142                 {
4143                     // This packet isn't supported, don't try calling this packet or
4144                     // QSaveRegisterState again...
4145                     m_supports_QSaveRegisterState = eLazyBoolNo;
4146                 }
4147             }
4148         }
4149     }
4150     return false;
4151 }
4152 
4153 bool
4154 GDBRemoteCommunicationClient::GetModuleInfo (const FileSpec& module_file_spec,
4155                                              const lldb_private::ArchSpec& arch_spec,
4156                                              ModuleSpec &module_spec)
4157 {
4158     std::string module_path = module_file_spec.GetPath (false);
4159     if (module_path.empty ())
4160         return false;
4161 
4162     StreamString packet;
4163     packet.PutCString("qModuleInfo:");
4164     packet.PutCStringAsRawHex8(module_path.c_str());
4165     packet.PutCString(";");
4166     const auto& triple = arch_spec.GetTriple().getTriple();
4167     packet.PutCStringAsRawHex8(triple.c_str());
4168 
4169     StringExtractorGDBRemote response;
4170     if (SendPacketAndWaitForResponse (packet.GetData(), packet.GetSize(), response, false) != PacketResult::Success)
4171         return false;
4172 
4173     if (response.IsErrorResponse () || response.IsUnsupportedResponse ())
4174         return false;
4175 
4176     std::string name;
4177     std::string value;
4178     bool success;
4179     StringExtractor extractor;
4180 
4181     module_spec.Clear ();
4182     module_spec.GetFileSpec () = module_file_spec;
4183 
4184     while (response.GetNameColonValue (name, value))
4185     {
4186         if (name == "uuid" || name == "md5")
4187         {
4188             extractor.GetStringRef ().swap (value);
4189             extractor.SetFilePos (0);
4190             extractor.GetHexByteString (value);
4191             module_spec.GetUUID().SetFromCString (value.c_str(), value.size() / 2);
4192         }
4193         else if (name == "triple")
4194         {
4195             extractor.GetStringRef ().swap (value);
4196             extractor.SetFilePos (0);
4197             extractor.GetHexByteString (value);
4198             module_spec.GetArchitecture().SetTriple (value.c_str ());
4199         }
4200         else if (name == "file_offset")
4201         {
4202             const auto ival = StringConvert::ToUInt64 (value.c_str (), 0, 16, &success);
4203             if (success)
4204                 module_spec.SetObjectOffset (ival);
4205         }
4206         else if (name == "file_size")
4207         {
4208             const auto ival = StringConvert::ToUInt64 (value.c_str (), 0, 16, &success);
4209             if (success)
4210                 module_spec.SetObjectSize (ival);
4211         }
4212         else if (name == "file_path")
4213         {
4214             extractor.GetStringRef ().swap (value);
4215             extractor.SetFilePos (0);
4216             extractor.GetHexByteString (value);
4217             module_spec.GetFileSpec() = FileSpec(value.c_str(), false, arch_spec);
4218         }
4219     }
4220 
4221     return true;
4222 }
4223 
4224 // query the target remote for extended information using the qXfer packet
4225 //
4226 // example: object='features', annex='target.xml', out=<xml output>
4227 // return:  'true'  on success
4228 //          'false' on failure (err set)
4229 bool
4230 GDBRemoteCommunicationClient::ReadExtFeature (const lldb_private::ConstString object,
4231                                               const lldb_private::ConstString annex,
4232                                               std::string & out,
4233                                               lldb_private::Error & err) {
4234 
4235     std::stringstream output;
4236     StringExtractorGDBRemote chunk;
4237 
4238     uint64_t size = GetRemoteMaxPacketSize();
4239     if (size == 0)
4240         size = 0x1000;
4241     size = size - 1; // Leave space for the 'm' or 'l' character in the response
4242     int offset = 0;
4243     bool active = true;
4244 
4245     // loop until all data has been read
4246     while ( active ) {
4247 
4248         // send query extended feature packet
4249         std::stringstream packet;
4250         packet << "qXfer:"
4251                << object.AsCString("") << ":read:"
4252                << annex.AsCString("")  << ":"
4253                << std::hex << offset  << ","
4254                << std::hex << size;
4255 
4256         GDBRemoteCommunication::PacketResult res =
4257             SendPacketAndWaitForResponse( packet.str().c_str(),
4258                                           chunk,
4259                                           false );
4260 
4261         if ( res != GDBRemoteCommunication::PacketResult::Success ) {
4262             err.SetErrorString( "Error sending $qXfer packet" );
4263             return false;
4264         }
4265 
4266         const std::string & str = chunk.GetStringRef( );
4267         if ( str.length() == 0 ) {
4268             // should have some data in chunk
4269             err.SetErrorString( "Empty response from $qXfer packet" );
4270             return false;
4271         }
4272 
4273         // check packet code
4274         switch ( str[0] ) {
4275             // last chunk
4276         case ( 'l' ):
4277             active = false;
4278             // fall through intentional
4279 
4280             // more chunks
4281         case ( 'm' ) :
4282             if ( str.length() > 1 )
4283                 output << &str[1];
4284             offset += size;
4285             break;
4286 
4287             // unknown chunk
4288         default:
4289             err.SetErrorString( "Invalid continuation code from $qXfer packet" );
4290             return false;
4291         }
4292     }
4293 
4294     out = output.str( );
4295     err.Success( );
4296     return true;
4297 }
4298 
4299 // Notify the target that gdb is prepared to serve symbol lookup requests.
4300 //  packet: "qSymbol::"
4301 //  reply:
4302 //  OK                  The target does not need to look up any (more) symbols.
4303 //  qSymbol:<sym_name>  The target requests the value of symbol sym_name (hex encoded).
4304 //                      LLDB may provide the value by sending another qSymbol packet
4305 //                      in the form of"qSymbol:<sym_value>:<sym_name>".
4306 
4307 void
4308 GDBRemoteCommunicationClient::ServeSymbolLookups(lldb_private::Process *process)
4309 {
4310     if (m_supports_qSymbol)
4311     {
4312         Mutex::Locker locker;
4313         if (GetSequenceMutex(locker, "GDBRemoteCommunicationClient::ServeSymbolLookups() failed due to not getting the sequence mutex"))
4314         {
4315             StreamString packet;
4316             packet.PutCString ("qSymbol::");
4317             while (1)
4318             {
4319                 StringExtractorGDBRemote response;
4320                 if (SendPacketAndWaitForResponseNoLock(packet.GetData(), packet.GetSize(), response) == PacketResult::Success)
4321                 {
4322                     if (response.IsOKResponse())
4323                     {
4324                         // We are done serving symbols requests
4325                         return;
4326                     }
4327 
4328                     if (response.IsUnsupportedResponse())
4329                     {
4330                         // qSymbol is not supported by the current GDB server we are connected to
4331                         m_supports_qSymbol = false;
4332                         return;
4333                     }
4334                     else
4335                     {
4336                         llvm::StringRef response_str(response.GetStringRef());
4337                         if (response_str.startswith("qSymbol:"))
4338                         {
4339                             response.SetFilePos(strlen("qSymbol:"));
4340                             std::string symbol_name;
4341                             if (response.GetHexByteString(symbol_name))
4342                             {
4343                                 if (symbol_name.empty())
4344                                     return;
4345 
4346                                 addr_t symbol_load_addr = LLDB_INVALID_ADDRESS;
4347                                 lldb_private::SymbolContextList sc_list;
4348                                 if (process->GetTarget().GetImages().FindSymbolsWithNameAndType(ConstString(symbol_name), eSymbolTypeAny, sc_list))
4349                                 {
4350                                     const size_t num_scs = sc_list.GetSize();
4351                                     for (size_t sc_idx=0; sc_idx<num_scs && symbol_load_addr == LLDB_INVALID_ADDRESS; ++sc_idx)
4352                                     {
4353                                         SymbolContext sc;
4354                                         if (sc_list.GetContextAtIndex(sc_idx, sc))
4355                                         {
4356                                             if (sc.symbol)
4357                                             {
4358                                                 switch (sc.symbol->GetType())
4359                                                 {
4360                                                 case eSymbolTypeInvalid:
4361                                                 case eSymbolTypeAbsolute:
4362                                                 case eSymbolTypeUndefined:
4363                                                 case eSymbolTypeSourceFile:
4364                                                 case eSymbolTypeHeaderFile:
4365                                                 case eSymbolTypeObjectFile:
4366                                                 case eSymbolTypeCommonBlock:
4367                                                 case eSymbolTypeBlock:
4368                                                 case eSymbolTypeLocal:
4369                                                 case eSymbolTypeParam:
4370                                                 case eSymbolTypeVariable:
4371                                                 case eSymbolTypeVariableType:
4372                                                 case eSymbolTypeLineEntry:
4373                                                 case eSymbolTypeLineHeader:
4374                                                 case eSymbolTypeScopeBegin:
4375                                                 case eSymbolTypeScopeEnd:
4376                                                 case eSymbolTypeAdditional:
4377                                                 case eSymbolTypeCompiler:
4378                                                 case eSymbolTypeInstrumentation:
4379                                                 case eSymbolTypeTrampoline:
4380                                                     break;
4381 
4382                                                 case eSymbolTypeCode:
4383                                                 case eSymbolTypeResolver:
4384                                                 case eSymbolTypeData:
4385                                                 case eSymbolTypeRuntime:
4386                                                 case eSymbolTypeException:
4387                                                 case eSymbolTypeObjCClass:
4388                                                 case eSymbolTypeObjCMetaClass:
4389                                                 case eSymbolTypeObjCIVar:
4390                                                 case eSymbolTypeReExported:
4391                                                     symbol_load_addr = sc.symbol->GetLoadAddress(&process->GetTarget());
4392                                                     break;
4393                                                 }
4394                                             }
4395                                         }
4396                                     }
4397                                 }
4398                                 // This is the normal path where our symbol lookup was successful and we want
4399                                 // to send a packet with the new symbol value and see if another lookup needs to be
4400                                 // done.
4401 
4402                                 // Change "packet" to contain the requested symbol value and name
4403                                 packet.Clear();
4404                                 packet.PutCString("qSymbol:");
4405                                 if (symbol_load_addr != LLDB_INVALID_ADDRESS)
4406                                     packet.Printf("%" PRIx64, symbol_load_addr);
4407                                 packet.PutCString(":");
4408                                 packet.PutBytesAsRawHex8(symbol_name.data(), symbol_name.size());
4409                                 continue; // go back to the while loop and send "packet" and wait for another response
4410                             }
4411                         }
4412                     }
4413                 }
4414             }
4415             // If we make it here, the symbol request packet response wasn't valid or
4416             // our symbol lookup failed so we must abort
4417             return;
4418 
4419         }
4420     }
4421 }
4422 
4423