1 //===-- ProcessGDBRemote.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 #include "lldb/lldb-python.h"
11 
12 // C Includes
13 #include <errno.h>
14 #include <spawn.h>
15 #include <stdlib.h>
16 #include <netinet/in.h>
17 #include <sys/mman.h>       // for mmap
18 #include <sys/stat.h>
19 #include <sys/types.h>
20 #include <time.h>
21 
22 // C++ Includes
23 #include <algorithm>
24 #include <map>
25 
26 // Other libraries and framework includes
27 
28 #include "lldb/Breakpoint/Watchpoint.h"
29 #include "lldb/Interpreter/Args.h"
30 #include "lldb/Core/ArchSpec.h"
31 #include "lldb/Core/Debugger.h"
32 #include "lldb/Core/ConnectionFileDescriptor.h"
33 #include "lldb/Host/FileSpec.h"
34 #include "lldb/Core/InputReader.h"
35 #include "lldb/Core/Module.h"
36 #include "lldb/Core/ModuleSpec.h"
37 #include "lldb/Core/PluginManager.h"
38 #include "lldb/Core/State.h"
39 #include "lldb/Core/StreamFile.h"
40 #include "lldb/Core/StreamString.h"
41 #include "lldb/Core/Timer.h"
42 #include "lldb/Core/Value.h"
43 #include "lldb/Host/Symbols.h"
44 #include "lldb/Host/TimeValue.h"
45 #include "lldb/Interpreter/CommandInterpreter.h"
46 #include "lldb/Interpreter/CommandObject.h"
47 #include "lldb/Interpreter/CommandObjectMultiword.h"
48 #include "lldb/Interpreter/CommandReturnObject.h"
49 #include "lldb/Symbol/ObjectFile.h"
50 #include "lldb/Target/DynamicLoader.h"
51 #include "lldb/Target/Target.h"
52 #include "lldb/Target/TargetList.h"
53 #include "lldb/Target/ThreadPlanCallFunction.h"
54 #include "lldb/Utility/PseudoTerminal.h"
55 
56 // Project includes
57 #include "lldb/Host/Host.h"
58 #include "Plugins/Process/Utility/InferiorCallPOSIX.h"
59 #include "Plugins/Process/Utility/StopInfoMachException.h"
60 #include "Plugins/Platform/MacOSX/PlatformRemoteiOS.h"
61 #include "Utility/StringExtractorGDBRemote.h"
62 #include "GDBRemoteRegisterContext.h"
63 #include "ProcessGDBRemote.h"
64 #include "ProcessGDBRemoteLog.h"
65 #include "ThreadGDBRemote.h"
66 
67 
68 namespace lldb
69 {
70     // Provide a function that can easily dump the packet history if we know a
71     // ProcessGDBRemote * value (which we can get from logs or from debugging).
72     // We need the function in the lldb namespace so it makes it into the final
73     // executable since the LLDB shared library only exports stuff in the lldb
74     // namespace. This allows you to attach with a debugger and call this
75     // function and get the packet history dumped to a file.
76     void
77     DumpProcessGDBRemotePacketHistory (void *p, const char *path)
78     {
79         lldb_private::StreamFile strm;
80         lldb_private::Error error (strm.GetFile().Open(path, lldb_private::File::eOpenOptionWrite | lldb_private::File::eOpenOptionCanCreate));
81         if (error.Success())
82             ((ProcessGDBRemote *)p)->GetGDBRemote().DumpHistory (strm);
83     }
84 }
85 
86 
87 #define DEBUGSERVER_BASENAME    "debugserver"
88 using namespace lldb;
89 using namespace lldb_private;
90 
91 static bool rand_initialized = false;
92 
93 // TODO Randomly assigning a port is unsafe.  We should get an unused
94 // ephemeral port from the kernel and make sure we reserve it before passing
95 // it to debugserver.
96 
97 #if defined (__APPLE__)
98 #define LOW_PORT    (IPPORT_RESERVED)
99 #define HIGH_PORT   (IPPORT_HIFIRSTAUTO)
100 #else
101 #define LOW_PORT    (1024u)
102 #define HIGH_PORT   (49151u)
103 #endif
104 
105 static inline uint16_t
106 get_random_port ()
107 {
108     if (!rand_initialized)
109     {
110         time_t seed = time(NULL);
111 
112         rand_initialized = true;
113         srand(seed);
114     }
115     return (rand() % (HIGH_PORT - LOW_PORT)) + LOW_PORT;
116 }
117 
118 
119 const char *
120 ProcessGDBRemote::GetPluginNameStatic()
121 {
122     return "gdb-remote";
123 }
124 
125 const char *
126 ProcessGDBRemote::GetPluginDescriptionStatic()
127 {
128     return "GDB Remote protocol based debugging plug-in.";
129 }
130 
131 void
132 ProcessGDBRemote::Terminate()
133 {
134     PluginManager::UnregisterPlugin (ProcessGDBRemote::CreateInstance);
135 }
136 
137 
138 lldb::ProcessSP
139 ProcessGDBRemote::CreateInstance (Target &target, Listener &listener, const FileSpec *crash_file_path)
140 {
141     lldb::ProcessSP process_sp;
142     if (crash_file_path == NULL)
143         process_sp.reset (new ProcessGDBRemote (target, listener));
144     return process_sp;
145 }
146 
147 bool
148 ProcessGDBRemote::CanDebug (Target &target, bool plugin_specified_by_name)
149 {
150     if (plugin_specified_by_name)
151         return true;
152 
153     // For now we are just making sure the file exists for a given module
154     Module *exe_module = target.GetExecutableModulePointer();
155     if (exe_module)
156     {
157         ObjectFile *exe_objfile = exe_module->GetObjectFile();
158         // We can't debug core files...
159         switch (exe_objfile->GetType())
160         {
161             case ObjectFile::eTypeInvalid:
162             case ObjectFile::eTypeCoreFile:
163             case ObjectFile::eTypeDebugInfo:
164             case ObjectFile::eTypeObjectFile:
165             case ObjectFile::eTypeSharedLibrary:
166             case ObjectFile::eTypeStubLibrary:
167                 return false;
168             case ObjectFile::eTypeExecutable:
169             case ObjectFile::eTypeDynamicLinker:
170             case ObjectFile::eTypeUnknown:
171                 break;
172         }
173         return exe_module->GetFileSpec().Exists();
174     }
175     // However, if there is no executable module, we return true since we might be preparing to attach.
176     return true;
177 }
178 
179 //----------------------------------------------------------------------
180 // ProcessGDBRemote constructor
181 //----------------------------------------------------------------------
182 ProcessGDBRemote::ProcessGDBRemote(Target& target, Listener &listener) :
183     Process (target, listener),
184     m_flags (0),
185     m_gdb_comm(false),
186     m_debugserver_pid (LLDB_INVALID_PROCESS_ID),
187     m_last_stop_packet (),
188     m_last_stop_packet_mutex (Mutex::eMutexTypeNormal),
189     m_register_info (),
190     m_async_broadcaster (NULL, "lldb.process.gdb-remote.async-broadcaster"),
191     m_async_thread (LLDB_INVALID_HOST_THREAD),
192     m_async_thread_state(eAsyncThreadNotStarted),
193     m_async_thread_state_mutex(Mutex::eMutexTypeRecursive),
194     m_thread_ids (),
195     m_continue_c_tids (),
196     m_continue_C_tids (),
197     m_continue_s_tids (),
198     m_continue_S_tids (),
199     m_dispatch_queue_offsets_addr (LLDB_INVALID_ADDRESS),
200     m_max_memory_size (512),
201     m_addr_to_mmap_size (),
202     m_thread_create_bp_sp (),
203     m_waiting_for_attach (false),
204     m_destroy_tried_resuming (false),
205     m_dyld_plugin_name(),
206     m_command_sp ()
207 {
208     m_async_broadcaster.SetEventName (eBroadcastBitAsyncThreadShouldExit,   "async thread should exit");
209     m_async_broadcaster.SetEventName (eBroadcastBitAsyncContinue,           "async thread continue");
210     m_async_broadcaster.SetEventName (eBroadcastBitAsyncThreadDidExit,      "async thread did exit");
211 }
212 
213 //----------------------------------------------------------------------
214 // Destructor
215 //----------------------------------------------------------------------
216 ProcessGDBRemote::~ProcessGDBRemote()
217 {
218     //  m_mach_process.UnregisterNotificationCallbacks (this);
219     Clear();
220     // We need to call finalize on the process before destroying ourselves
221     // to make sure all of the broadcaster cleanup goes as planned. If we
222     // destruct this class, then Process::~Process() might have problems
223     // trying to fully destroy the broadcaster.
224     Finalize();
225 
226     // The general Finalize is going to try to destroy the process and that SHOULD
227     // shut down the async thread.  However, if we don't kill it it will get stranded and
228     // its connection will go away so when it wakes up it will crash.  So kill it for sure here.
229     StopAsyncThread();
230     KillDebugserverProcess();
231 }
232 
233 //----------------------------------------------------------------------
234 // PluginInterface
235 //----------------------------------------------------------------------
236 const char *
237 ProcessGDBRemote::GetPluginName()
238 {
239     return "Process debugging plug-in that uses the GDB remote protocol";
240 }
241 
242 const char *
243 ProcessGDBRemote::GetShortPluginName()
244 {
245     return GetPluginNameStatic();
246 }
247 
248 uint32_t
249 ProcessGDBRemote::GetPluginVersion()
250 {
251     return 1;
252 }
253 
254 void
255 ProcessGDBRemote::BuildDynamicRegisterInfo (bool force)
256 {
257     if (!force && m_register_info.GetNumRegisters() > 0)
258         return;
259 
260     char packet[128];
261     m_register_info.Clear();
262     uint32_t reg_offset = 0;
263     uint32_t reg_num = 0;
264     for (StringExtractorGDBRemote::ResponseType response_type = StringExtractorGDBRemote::eResponse;
265          response_type == StringExtractorGDBRemote::eResponse;
266          ++reg_num)
267     {
268         const int packet_len = ::snprintf (packet, sizeof(packet), "qRegisterInfo%x", reg_num);
269         assert (packet_len < sizeof(packet));
270         StringExtractorGDBRemote response;
271         if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, false))
272         {
273             response_type = response.GetResponseType();
274             if (response_type == StringExtractorGDBRemote::eResponse)
275             {
276                 std::string name;
277                 std::string value;
278                 ConstString reg_name;
279                 ConstString alt_name;
280                 ConstString set_name;
281                 std::vector<uint32_t> value_regs;
282                 std::vector<uint32_t> invalidate_regs;
283                 RegisterInfo reg_info = { NULL,                 // Name
284                     NULL,                 // Alt name
285                     0,                    // byte size
286                     reg_offset,           // offset
287                     eEncodingUint,        // encoding
288                     eFormatHex,           // formate
289                     {
290                         LLDB_INVALID_REGNUM, // GCC reg num
291                         LLDB_INVALID_REGNUM, // DWARF reg num
292                         LLDB_INVALID_REGNUM, // generic reg num
293                         reg_num,             // GDB reg num
294                         reg_num           // native register number
295                     },
296                     NULL,
297                     NULL
298                 };
299 
300                 while (response.GetNameColonValue(name, value))
301                 {
302                     if (name.compare("name") == 0)
303                     {
304                         reg_name.SetCString(value.c_str());
305                     }
306                     else if (name.compare("alt-name") == 0)
307                     {
308                         alt_name.SetCString(value.c_str());
309                     }
310                     else if (name.compare("bitsize") == 0)
311                     {
312                         reg_info.byte_size = Args::StringToUInt32(value.c_str(), 0, 0) / CHAR_BIT;
313                     }
314                     else if (name.compare("offset") == 0)
315                     {
316                         uint32_t offset = Args::StringToUInt32(value.c_str(), UINT32_MAX, 0);
317                         if (reg_offset != offset)
318                         {
319                             reg_offset = offset;
320                         }
321                     }
322                     else if (name.compare("encoding") == 0)
323                     {
324                         const Encoding encoding = Args::StringToEncoding (value.c_str());
325                         if (encoding != eEncodingInvalid)
326                             reg_info.encoding = encoding;
327                     }
328                     else if (name.compare("format") == 0)
329                     {
330                         Format format = eFormatInvalid;
331                         if (Args::StringToFormat (value.c_str(), format, NULL).Success())
332                             reg_info.format = format;
333                         else if (value.compare("binary") == 0)
334                             reg_info.format = eFormatBinary;
335                         else if (value.compare("decimal") == 0)
336                             reg_info.format = eFormatDecimal;
337                         else if (value.compare("hex") == 0)
338                             reg_info.format = eFormatHex;
339                         else if (value.compare("float") == 0)
340                             reg_info.format = eFormatFloat;
341                         else if (value.compare("vector-sint8") == 0)
342                             reg_info.format = eFormatVectorOfSInt8;
343                         else if (value.compare("vector-uint8") == 0)
344                             reg_info.format = eFormatVectorOfUInt8;
345                         else if (value.compare("vector-sint16") == 0)
346                             reg_info.format = eFormatVectorOfSInt16;
347                         else if (value.compare("vector-uint16") == 0)
348                             reg_info.format = eFormatVectorOfUInt16;
349                         else if (value.compare("vector-sint32") == 0)
350                             reg_info.format = eFormatVectorOfSInt32;
351                         else if (value.compare("vector-uint32") == 0)
352                             reg_info.format = eFormatVectorOfUInt32;
353                         else if (value.compare("vector-float32") == 0)
354                             reg_info.format = eFormatVectorOfFloat32;
355                         else if (value.compare("vector-uint128") == 0)
356                             reg_info.format = eFormatVectorOfUInt128;
357                     }
358                     else if (name.compare("set") == 0)
359                     {
360                         set_name.SetCString(value.c_str());
361                     }
362                     else if (name.compare("gcc") == 0)
363                     {
364                         reg_info.kinds[eRegisterKindGCC] = Args::StringToUInt32(value.c_str(), LLDB_INVALID_REGNUM, 0);
365                     }
366                     else if (name.compare("dwarf") == 0)
367                     {
368                         reg_info.kinds[eRegisterKindDWARF] = Args::StringToUInt32(value.c_str(), LLDB_INVALID_REGNUM, 0);
369                     }
370                     else if (name.compare("generic") == 0)
371                     {
372                         reg_info.kinds[eRegisterKindGeneric] = Args::StringToGenericRegister (value.c_str());
373                     }
374                     else if (name.compare("container-regs") == 0)
375                     {
376                         std::pair<llvm::StringRef, llvm::StringRef> value_pair;
377                         value_pair.second = value;
378                         do
379                         {
380                             value_pair = value_pair.second.split(',');
381                             if (!value_pair.first.empty())
382                             {
383                                 uint32_t reg = Args::StringToUInt32 (value_pair.first.str().c_str(), LLDB_INVALID_REGNUM, 16);
384                                 if (reg != LLDB_INVALID_REGNUM)
385                                     value_regs.push_back (reg);
386                             }
387                         } while (!value_pair.second.empty());
388                     }
389                     else if (name.compare("invalidate-regs") == 0)
390                     {
391                         std::pair<llvm::StringRef, llvm::StringRef> value_pair;
392                         value_pair.second = value;
393                         do
394                         {
395                             value_pair = value_pair.second.split(',');
396                             if (!value_pair.first.empty())
397                             {
398                                 uint32_t reg = Args::StringToUInt32 (value_pair.first.str().c_str(), LLDB_INVALID_REGNUM, 16);
399                                 if (reg != LLDB_INVALID_REGNUM)
400                                     invalidate_regs.push_back (reg);
401                             }
402                         } while (!value_pair.second.empty());
403                     }
404                 }
405 
406                 reg_info.byte_offset = reg_offset;
407                 assert (reg_info.byte_size != 0);
408                 reg_offset += reg_info.byte_size;
409                 if (!value_regs.empty())
410                 {
411                     value_regs.push_back(LLDB_INVALID_REGNUM);
412                     reg_info.value_regs = value_regs.data();
413                 }
414                 if (!invalidate_regs.empty())
415                 {
416                     invalidate_regs.push_back(LLDB_INVALID_REGNUM);
417                     reg_info.invalidate_regs = invalidate_regs.data();
418                 }
419 
420                 m_register_info.AddRegister(reg_info, reg_name, alt_name, set_name);
421             }
422         }
423         else
424         {
425             break;
426         }
427     }
428 
429     // We didn't get anything if the accumulated reg_num is zero.  See if we are
430     // debugging ARM and fill with a hard coded register set until we can get an
431     // updated debugserver down on the devices.
432     // On the other hand, if the accumulated reg_num is positive, see if we can
433     // add composite registers to the existing primordial ones.
434     bool from_scratch = (reg_num == 0);
435 
436     const ArchSpec &target_arch = GetTarget().GetArchitecture();
437     const ArchSpec &remote_host_arch = m_gdb_comm.GetHostArchitecture();
438     const ArchSpec &remote_process_arch = m_gdb_comm.GetProcessArchitecture();
439 
440     // Use the process' architecture instead of the host arch, if available
441     ArchSpec remote_arch;
442     if (remote_process_arch.IsValid ())
443         remote_arch = remote_process_arch;
444     else
445         remote_arch = remote_host_arch;
446 
447     if (!target_arch.IsValid())
448     {
449         if (remote_arch.IsValid()
450               && remote_arch.GetMachine() == llvm::Triple::arm
451               && remote_arch.GetTriple().getVendor() == llvm::Triple::Apple)
452             m_register_info.HardcodeARMRegisters(from_scratch);
453     }
454     else if (target_arch.GetMachine() == llvm::Triple::arm)
455     {
456         m_register_info.HardcodeARMRegisters(from_scratch);
457     }
458 
459     // At this point, we can finalize our register info.
460     m_register_info.Finalize ();
461 }
462 
463 Error
464 ProcessGDBRemote::WillLaunch (Module* module)
465 {
466     return WillLaunchOrAttach ();
467 }
468 
469 Error
470 ProcessGDBRemote::WillAttachToProcessWithID (lldb::pid_t pid)
471 {
472     return WillLaunchOrAttach ();
473 }
474 
475 Error
476 ProcessGDBRemote::WillAttachToProcessWithName (const char *process_name, bool wait_for_launch)
477 {
478     return WillLaunchOrAttach ();
479 }
480 
481 Error
482 ProcessGDBRemote::DoConnectRemote (Stream *strm, const char *remote_url)
483 {
484     Error error (WillLaunchOrAttach ());
485 
486     if (error.Fail())
487         return error;
488 
489     error = ConnectToDebugserver (remote_url);
490 
491     if (error.Fail())
492         return error;
493     StartAsyncThread ();
494 
495     lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID ();
496     if (pid == LLDB_INVALID_PROCESS_ID)
497     {
498         // We don't have a valid process ID, so note that we are connected
499         // and could now request to launch or attach, or get remote process
500         // listings...
501         SetPrivateState (eStateConnected);
502     }
503     else
504     {
505         // We have a valid process
506         SetID (pid);
507         GetThreadList();
508         if (m_gdb_comm.SendPacketAndWaitForResponse("?", 1, m_last_stop_packet, false))
509         {
510             const StateType state = SetThreadStopInfo (m_last_stop_packet);
511             if (state == eStateStopped)
512             {
513                 SetPrivateState (state);
514             }
515             else
516                 error.SetErrorStringWithFormat ("Process %" PRIu64 " was reported after connecting to '%s', but state was not stopped: %s", pid, remote_url, StateAsCString (state));
517         }
518         else
519             error.SetErrorStringWithFormat ("Process %" PRIu64 " was reported after connecting to '%s', but no stop reply packet was received", pid, remote_url);
520     }
521 
522     if (error.Success()
523         && !GetTarget().GetArchitecture().IsValid()
524         && m_gdb_comm.GetHostArchitecture().IsValid())
525     {
526         // Prefer the *process'* architecture over that of the *host*, if available.
527         if (m_gdb_comm.GetProcessArchitecture().IsValid())
528             GetTarget().SetArchitecture(m_gdb_comm.GetProcessArchitecture());
529         else
530             GetTarget().SetArchitecture(m_gdb_comm.GetHostArchitecture());
531     }
532 
533     return error;
534 }
535 
536 Error
537 ProcessGDBRemote::WillLaunchOrAttach ()
538 {
539     Error error;
540     m_stdio_communication.Clear ();
541     return error;
542 }
543 
544 //----------------------------------------------------------------------
545 // Process Control
546 //----------------------------------------------------------------------
547 Error
548 ProcessGDBRemote::DoLaunch (Module *exe_module, const ProcessLaunchInfo &launch_info)
549 {
550     Error error;
551 
552     uint32_t launch_flags = launch_info.GetFlags().Get();
553     const char *stdin_path = NULL;
554     const char *stdout_path = NULL;
555     const char *stderr_path = NULL;
556     const char *working_dir = launch_info.GetWorkingDirectory();
557 
558     const ProcessLaunchInfo::FileAction *file_action;
559     file_action = launch_info.GetFileActionForFD (STDIN_FILENO);
560     if (file_action)
561     {
562         if (file_action->GetAction () == ProcessLaunchInfo::FileAction::eFileActionOpen)
563             stdin_path = file_action->GetPath();
564     }
565     file_action = launch_info.GetFileActionForFD (STDOUT_FILENO);
566     if (file_action)
567     {
568         if (file_action->GetAction () == ProcessLaunchInfo::FileAction::eFileActionOpen)
569             stdout_path = file_action->GetPath();
570     }
571     file_action = launch_info.GetFileActionForFD (STDERR_FILENO);
572     if (file_action)
573     {
574         if (file_action->GetAction () == ProcessLaunchInfo::FileAction::eFileActionOpen)
575             stderr_path = file_action->GetPath();
576     }
577 
578     //  ::LogSetBitMask (GDBR_LOG_DEFAULT);
579     //  ::LogSetOptions (LLDB_LOG_OPTION_THREADSAFE | LLDB_LOG_OPTION_PREPEND_TIMESTAMP | LLDB_LOG_OPTION_PREPEND_PROC_AND_THREAD);
580     //  ::LogSetLogFile ("/dev/stdout");
581     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
582 
583     ObjectFile * object_file = exe_module->GetObjectFile();
584     if (object_file)
585     {
586         char host_port[128];
587         snprintf (host_port, sizeof(host_port), "localhost:%u", get_random_port ());
588         char connect_url[128];
589         snprintf (connect_url, sizeof(connect_url), "connect://%s", host_port);
590 
591         // Make sure we aren't already connected?
592         if (!m_gdb_comm.IsConnected())
593         {
594             error = StartDebugserverProcess (host_port, launch_info);
595             if (error.Fail())
596             {
597                 if (log)
598                     log->Printf("failed to start debugserver process: %s", error.AsCString());
599                 return error;
600             }
601 
602             error = ConnectToDebugserver (connect_url);
603         }
604 
605         if (error.Success())
606         {
607             lldb_utility::PseudoTerminal pty;
608             const bool disable_stdio = (launch_flags & eLaunchFlagDisableSTDIO) != 0;
609 
610             // If the debugserver is local and we aren't disabling STDIO, lets use
611             // a pseudo terminal to instead of relying on the 'O' packets for stdio
612             // since 'O' packets can really slow down debugging if the inferior
613             // does a lot of output.
614             PlatformSP platform_sp (m_target.GetPlatform());
615             if (platform_sp && platform_sp->IsHost() && !disable_stdio)
616             {
617                 const char *slave_name = NULL;
618                 if (stdin_path == NULL || stdout_path == NULL || stderr_path == NULL)
619                 {
620                     if (pty.OpenFirstAvailableMaster(O_RDWR|O_NOCTTY, NULL, 0))
621                         slave_name = pty.GetSlaveName (NULL, 0);
622                 }
623                 if (stdin_path == NULL)
624                     stdin_path = slave_name;
625 
626                 if (stdout_path == NULL)
627                     stdout_path = slave_name;
628 
629                 if (stderr_path == NULL)
630                     stderr_path = slave_name;
631             }
632 
633             // Set STDIN to /dev/null if we want STDIO disabled or if either
634             // STDOUT or STDERR have been set to something and STDIN hasn't
635             if (disable_stdio || (stdin_path == NULL && (stdout_path || stderr_path)))
636                 stdin_path = "/dev/null";
637 
638             // Set STDOUT to /dev/null if we want STDIO disabled or if either
639             // STDIN or STDERR have been set to something and STDOUT hasn't
640             if (disable_stdio || (stdout_path == NULL && (stdin_path || stderr_path)))
641                 stdout_path = "/dev/null";
642 
643             // Set STDERR to /dev/null if we want STDIO disabled or if either
644             // STDIN or STDOUT have been set to something and STDERR hasn't
645             if (disable_stdio || (stderr_path == NULL && (stdin_path || stdout_path)))
646                 stderr_path = "/dev/null";
647 
648             if (stdin_path)
649                 m_gdb_comm.SetSTDIN (stdin_path);
650             if (stdout_path)
651                 m_gdb_comm.SetSTDOUT (stdout_path);
652             if (stderr_path)
653                 m_gdb_comm.SetSTDERR (stderr_path);
654 
655             m_gdb_comm.SetDisableASLR (launch_flags & eLaunchFlagDisableASLR);
656 
657             m_gdb_comm.SendLaunchArchPacket (m_target.GetArchitecture().GetArchitectureName());
658 
659             if (working_dir && working_dir[0])
660             {
661                 m_gdb_comm.SetWorkingDir (working_dir);
662             }
663 
664             // Send the environment and the program + arguments after we connect
665             const Args &environment = launch_info.GetEnvironmentEntries();
666             if (environment.GetArgumentCount())
667             {
668                 size_t num_environment_entries = environment.GetArgumentCount();
669                 for (size_t i=0; i<num_environment_entries; ++i)
670                 {
671                     const char *env_entry = environment.GetArgumentAtIndex(i);
672                     if (env_entry == NULL || m_gdb_comm.SendEnvironmentPacket(env_entry) != 0)
673                         break;
674                 }
675             }
676 
677             const uint32_t old_packet_timeout = m_gdb_comm.SetPacketTimeout (10);
678             int arg_packet_err = m_gdb_comm.SendArgumentsPacket (launch_info.GetArguments().GetConstArgumentVector());
679             if (arg_packet_err == 0)
680             {
681                 std::string error_str;
682                 if (m_gdb_comm.GetLaunchSuccess (error_str))
683                 {
684                     SetID (m_gdb_comm.GetCurrentProcessID ());
685                 }
686                 else
687                 {
688                     error.SetErrorString (error_str.c_str());
689                 }
690             }
691             else
692             {
693                 error.SetErrorStringWithFormat("'A' packet returned an error: %i", arg_packet_err);
694             }
695 
696             m_gdb_comm.SetPacketTimeout (old_packet_timeout);
697 
698             if (GetID() == LLDB_INVALID_PROCESS_ID)
699             {
700                 if (log)
701                     log->Printf("failed to connect to debugserver: %s", error.AsCString());
702                 KillDebugserverProcess ();
703                 return error;
704             }
705 
706             if (m_gdb_comm.SendPacketAndWaitForResponse("?", 1, m_last_stop_packet, false))
707             {
708                 SetPrivateState (SetThreadStopInfo (m_last_stop_packet));
709 
710                 if (!disable_stdio)
711                 {
712                     if (pty.GetMasterFileDescriptor() != lldb_utility::PseudoTerminal::invalid_fd)
713                         SetSTDIOFileDescriptor (pty.ReleaseMasterFileDescriptor());
714                 }
715             }
716         }
717         else
718         {
719             if (log)
720                 log->Printf("failed to connect to debugserver: %s", error.AsCString());
721         }
722     }
723     else
724     {
725         // Set our user ID to an invalid process ID.
726         SetID(LLDB_INVALID_PROCESS_ID);
727         error.SetErrorStringWithFormat ("failed to get object file from '%s' for arch %s",
728                                         exe_module->GetFileSpec().GetFilename().AsCString(),
729                                         exe_module->GetArchitecture().GetArchitectureName());
730     }
731     return error;
732 
733 }
734 
735 
736 Error
737 ProcessGDBRemote::ConnectToDebugserver (const char *connect_url)
738 {
739     Error error;
740     // Sleep and wait a bit for debugserver to start to listen...
741     std::unique_ptr<ConnectionFileDescriptor> conn_ap(new ConnectionFileDescriptor());
742     if (conn_ap.get())
743     {
744         const uint32_t max_retry_count = 50;
745         uint32_t retry_count = 0;
746         while (!m_gdb_comm.IsConnected())
747         {
748             if (conn_ap->Connect(connect_url, &error) == eConnectionStatusSuccess)
749             {
750                 m_gdb_comm.SetConnection (conn_ap.release());
751                 break;
752             }
753             retry_count++;
754 
755             if (retry_count >= max_retry_count)
756                 break;
757 
758             usleep (100000);
759         }
760     }
761 
762     if (!m_gdb_comm.IsConnected())
763     {
764         if (error.Success())
765             error.SetErrorString("not connected to remote gdb server");
766         return error;
767     }
768 
769     // We always seem to be able to open a connection to a local port
770     // so we need to make sure we can then send data to it. If we can't
771     // then we aren't actually connected to anything, so try and do the
772     // handshake with the remote GDB server and make sure that goes
773     // alright.
774     if (!m_gdb_comm.HandshakeWithServer (NULL))
775     {
776         m_gdb_comm.Disconnect();
777         if (error.Success())
778             error.SetErrorString("not connected to remote gdb server");
779         return error;
780     }
781     m_gdb_comm.ResetDiscoverableSettings();
782     m_gdb_comm.QueryNoAckModeSupported ();
783     m_gdb_comm.GetThreadSuffixSupported ();
784     m_gdb_comm.GetListThreadsInStopReplySupported ();
785     m_gdb_comm.GetHostInfo ();
786     m_gdb_comm.GetVContSupported ('c');
787     m_gdb_comm.GetVAttachOrWaitSupported();
788 
789     size_t num_cmds = GetExtraStartupCommands().GetArgumentCount();
790     for (size_t idx = 0; idx < num_cmds; idx++)
791     {
792         StringExtractorGDBRemote response;
793         m_gdb_comm.SendPacketAndWaitForResponse (GetExtraStartupCommands().GetArgumentAtIndex(idx), response, false);
794     }
795     return error;
796 }
797 
798 void
799 ProcessGDBRemote::DidLaunchOrAttach ()
800 {
801     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
802     if (log)
803         log->Printf ("ProcessGDBRemote::DidLaunch()");
804     if (GetID() != LLDB_INVALID_PROCESS_ID)
805     {
806         m_dispatch_queue_offsets_addr = LLDB_INVALID_ADDRESS;
807 
808         BuildDynamicRegisterInfo (false);
809 
810         // See if the GDB server supports the qHostInfo information
811 
812         ArchSpec gdb_remote_arch = m_gdb_comm.GetHostArchitecture();
813 
814         // See if the GDB server supports the qProcessInfo packet, if so
815         // prefer that over the Host information as it will be more specific
816         // to our process.
817 
818         if (m_gdb_comm.GetProcessArchitecture().IsValid())
819             gdb_remote_arch = m_gdb_comm.GetProcessArchitecture();
820 
821         if (gdb_remote_arch.IsValid())
822         {
823             ArchSpec &target_arch = GetTarget().GetArchitecture();
824 
825             if (target_arch.IsValid())
826             {
827                 // If the remote host is ARM and we have apple as the vendor, then
828                 // ARM executables and shared libraries can have mixed ARM architectures.
829                 // You can have an armv6 executable, and if the host is armv7, then the
830                 // system will load the best possible architecture for all shared libraries
831                 // it has, so we really need to take the remote host architecture as our
832                 // defacto architecture in this case.
833 
834                 if (gdb_remote_arch.GetMachine() == llvm::Triple::arm &&
835                     gdb_remote_arch.GetTriple().getVendor() == llvm::Triple::Apple)
836                 {
837                     target_arch = gdb_remote_arch;
838                 }
839                 else
840                 {
841                     // Fill in what is missing in the triple
842                     const llvm::Triple &remote_triple = gdb_remote_arch.GetTriple();
843                     llvm::Triple &target_triple = target_arch.GetTriple();
844                     if (target_triple.getVendorName().size() == 0)
845                     {
846                         target_triple.setVendor (remote_triple.getVendor());
847 
848                         if (target_triple.getOSName().size() == 0)
849                         {
850                             target_triple.setOS (remote_triple.getOS());
851 
852                             if (target_triple.getEnvironmentName().size() == 0)
853                                 target_triple.setEnvironment (remote_triple.getEnvironment());
854                         }
855                     }
856                 }
857             }
858             else
859             {
860                 // The target doesn't have a valid architecture yet, set it from
861                 // the architecture we got from the remote GDB server
862                 target_arch = gdb_remote_arch;
863             }
864         }
865     }
866 }
867 
868 void
869 ProcessGDBRemote::DidLaunch ()
870 {
871     DidLaunchOrAttach ();
872 }
873 
874 Error
875 ProcessGDBRemote::DoAttachToProcessWithID (lldb::pid_t attach_pid)
876 {
877     ProcessAttachInfo attach_info;
878     return DoAttachToProcessWithID(attach_pid, attach_info);
879 }
880 
881 Error
882 ProcessGDBRemote::DoAttachToProcessWithID (lldb::pid_t attach_pid, const ProcessAttachInfo &attach_info)
883 {
884     Error error;
885     // Clear out and clean up from any current state
886     Clear();
887     if (attach_pid != LLDB_INVALID_PROCESS_ID)
888     {
889         // Make sure we aren't already connected?
890         if (!m_gdb_comm.IsConnected())
891         {
892             char host_port[128];
893             snprintf (host_port, sizeof(host_port), "localhost:%u", get_random_port ());
894             char connect_url[128];
895             snprintf (connect_url, sizeof(connect_url), "connect://%s", host_port);
896 
897             error = StartDebugserverProcess (host_port, attach_info);
898 
899             if (error.Fail())
900             {
901                 const char *error_string = error.AsCString();
902                 if (error_string == NULL)
903                     error_string = "unable to launch " DEBUGSERVER_BASENAME;
904 
905                 SetExitStatus (-1, error_string);
906             }
907             else
908             {
909                 error = ConnectToDebugserver (connect_url);
910             }
911         }
912 
913         if (error.Success())
914         {
915             char packet[64];
916             const int packet_len = ::snprintf (packet, sizeof(packet), "vAttach;%" PRIx64, attach_pid);
917             SetID (attach_pid);
918             m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue, new EventDataBytes (packet, packet_len));
919         }
920     }
921     return error;
922 }
923 
924 size_t
925 ProcessGDBRemote::AttachInputReaderCallback
926 (
927     void *baton,
928     InputReader *reader,
929     lldb::InputReaderAction notification,
930     const char *bytes,
931     size_t bytes_len
932 )
933 {
934     if (notification == eInputReaderGotToken)
935     {
936         ProcessGDBRemote *gdb_process = (ProcessGDBRemote *)baton;
937         if (gdb_process->m_waiting_for_attach)
938             gdb_process->m_waiting_for_attach = false;
939         reader->SetIsDone(true);
940         return 1;
941     }
942     return 0;
943 }
944 
945 Error
946 ProcessGDBRemote::DoAttachToProcessWithName (const char *process_name, bool wait_for_launch, const ProcessAttachInfo &attach_info)
947 {
948     Error error;
949     // Clear out and clean up from any current state
950     Clear();
951 
952     if (process_name && process_name[0])
953     {
954         // Make sure we aren't already connected?
955         if (!m_gdb_comm.IsConnected())
956         {
957             char host_port[128];
958             snprintf (host_port, sizeof(host_port), "localhost:%u", get_random_port ());
959             char connect_url[128];
960             snprintf (connect_url, sizeof(connect_url), "connect://%s", host_port);
961 
962             error = StartDebugserverProcess (host_port, attach_info);
963             if (error.Fail())
964             {
965                 const char *error_string = error.AsCString();
966                 if (error_string == NULL)
967                     error_string = "unable to launch " DEBUGSERVER_BASENAME;
968 
969                 SetExitStatus (-1, error_string);
970             }
971             else
972             {
973                 error = ConnectToDebugserver (connect_url);
974             }
975         }
976 
977         if (error.Success())
978         {
979             StreamString packet;
980 
981             if (wait_for_launch)
982             {
983                 if (!m_gdb_comm.GetVAttachOrWaitSupported())
984                 {
985                     packet.PutCString ("vAttachWait");
986                 }
987                 else
988                 {
989                     if (attach_info.GetIgnoreExisting())
990                         packet.PutCString("vAttachWait");
991                     else
992                         packet.PutCString ("vAttachOrWait");
993                 }
994             }
995             else
996                 packet.PutCString("vAttachName");
997             packet.PutChar(';');
998             packet.PutBytesAsRawHex8(process_name, strlen(process_name), lldb::endian::InlHostByteOrder(), lldb::endian::InlHostByteOrder());
999 
1000             m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue, new EventDataBytes (packet.GetData(), packet.GetSize()));
1001 
1002         }
1003     }
1004     return error;
1005 }
1006 
1007 
1008 void
1009 ProcessGDBRemote::DidAttach ()
1010 {
1011     DidLaunchOrAttach ();
1012 }
1013 
1014 void
1015 ProcessGDBRemote::DoDidExec ()
1016 {
1017     // The process exec'ed itself, figure out the dynamic loader, etc...
1018     BuildDynamicRegisterInfo (true);
1019     m_gdb_comm.ResetDiscoverableSettings();
1020     DidLaunchOrAttach ();
1021 }
1022 
1023 
1024 
1025 Error
1026 ProcessGDBRemote::WillResume ()
1027 {
1028     m_continue_c_tids.clear();
1029     m_continue_C_tids.clear();
1030     m_continue_s_tids.clear();
1031     m_continue_S_tids.clear();
1032     return Error();
1033 }
1034 
1035 Error
1036 ProcessGDBRemote::DoResume ()
1037 {
1038     Error error;
1039     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
1040     if (log)
1041         log->Printf ("ProcessGDBRemote::Resume()");
1042 
1043     Listener listener ("gdb-remote.resume-packet-sent");
1044     if (listener.StartListeningForEvents (&m_gdb_comm, GDBRemoteCommunication::eBroadcastBitRunPacketSent))
1045     {
1046         listener.StartListeningForEvents (&m_async_broadcaster, ProcessGDBRemote::eBroadcastBitAsyncThreadDidExit);
1047 
1048         const size_t num_threads = GetThreadList().GetSize();
1049 
1050         StreamString continue_packet;
1051         bool continue_packet_error = false;
1052         if (m_gdb_comm.HasAnyVContSupport ())
1053         {
1054             if (m_continue_c_tids.size() == num_threads)
1055             {
1056                 // All threads are continuing, just send a "c" packet
1057                 continue_packet.PutCString ("c");
1058             }
1059             else
1060             {
1061                 continue_packet.PutCString ("vCont");
1062 
1063                 if (!m_continue_c_tids.empty())
1064                 {
1065                     if (m_gdb_comm.GetVContSupported ('c'))
1066                     {
1067                         for (tid_collection::const_iterator t_pos = m_continue_c_tids.begin(), t_end = m_continue_c_tids.end(); t_pos != t_end; ++t_pos)
1068                             continue_packet.Printf(";c:%4.4" PRIx64, *t_pos);
1069                     }
1070                     else
1071                         continue_packet_error = true;
1072                 }
1073 
1074                 if (!continue_packet_error && !m_continue_C_tids.empty())
1075                 {
1076                     if (m_gdb_comm.GetVContSupported ('C'))
1077                     {
1078                         for (tid_sig_collection::const_iterator s_pos = m_continue_C_tids.begin(), s_end = m_continue_C_tids.end(); s_pos != s_end; ++s_pos)
1079                             continue_packet.Printf(";C%2.2x:%4.4" PRIx64, s_pos->second, s_pos->first);
1080                     }
1081                     else
1082                         continue_packet_error = true;
1083                 }
1084 
1085                 if (!continue_packet_error && !m_continue_s_tids.empty())
1086                 {
1087                     if (m_gdb_comm.GetVContSupported ('s'))
1088                     {
1089                         for (tid_collection::const_iterator t_pos = m_continue_s_tids.begin(), t_end = m_continue_s_tids.end(); t_pos != t_end; ++t_pos)
1090                             continue_packet.Printf(";s:%4.4" PRIx64, *t_pos);
1091                     }
1092                     else
1093                         continue_packet_error = true;
1094                 }
1095 
1096                 if (!continue_packet_error && !m_continue_S_tids.empty())
1097                 {
1098                     if (m_gdb_comm.GetVContSupported ('S'))
1099                     {
1100                         for (tid_sig_collection::const_iterator s_pos = m_continue_S_tids.begin(), s_end = m_continue_S_tids.end(); s_pos != s_end; ++s_pos)
1101                             continue_packet.Printf(";S%2.2x:%4.4" PRIx64, s_pos->second, s_pos->first);
1102                     }
1103                     else
1104                         continue_packet_error = true;
1105                 }
1106 
1107                 if (continue_packet_error)
1108                     continue_packet.GetString().clear();
1109             }
1110         }
1111         else
1112             continue_packet_error = true;
1113 
1114         if (continue_packet_error)
1115         {
1116             // Either no vCont support, or we tried to use part of the vCont
1117             // packet that wasn't supported by the remote GDB server.
1118             // We need to try and make a simple packet that can do our continue
1119             const size_t num_continue_c_tids = m_continue_c_tids.size();
1120             const size_t num_continue_C_tids = m_continue_C_tids.size();
1121             const size_t num_continue_s_tids = m_continue_s_tids.size();
1122             const size_t num_continue_S_tids = m_continue_S_tids.size();
1123             if (num_continue_c_tids > 0)
1124             {
1125                 if (num_continue_c_tids == num_threads)
1126                 {
1127                     // All threads are resuming...
1128                     m_gdb_comm.SetCurrentThreadForRun (-1);
1129                     continue_packet.PutChar ('c');
1130                     continue_packet_error = false;
1131                 }
1132                 else if (num_continue_c_tids == 1 &&
1133                          num_continue_C_tids == 0 &&
1134                          num_continue_s_tids == 0 &&
1135                          num_continue_S_tids == 0 )
1136                 {
1137                     // Only one thread is continuing
1138                     m_gdb_comm.SetCurrentThreadForRun (m_continue_c_tids.front());
1139                     continue_packet.PutChar ('c');
1140                     continue_packet_error = false;
1141                 }
1142             }
1143 
1144             if (continue_packet_error && num_continue_C_tids > 0)
1145             {
1146                 if ((num_continue_C_tids + num_continue_c_tids) == num_threads &&
1147                     num_continue_C_tids > 0 &&
1148                     num_continue_s_tids == 0 &&
1149                     num_continue_S_tids == 0 )
1150                 {
1151                     const int continue_signo = m_continue_C_tids.front().second;
1152                     // Only one thread is continuing
1153                     if (num_continue_C_tids > 1)
1154                     {
1155                         // More that one thread with a signal, yet we don't have
1156                         // vCont support and we are being asked to resume each
1157                         // thread with a signal, we need to make sure they are
1158                         // all the same signal, or we can't issue the continue
1159                         // accurately with the current support...
1160                         if (num_continue_C_tids > 1)
1161                         {
1162                             continue_packet_error = false;
1163                             for (size_t i=1; i<m_continue_C_tids.size(); ++i)
1164                             {
1165                                 if (m_continue_C_tids[i].second != continue_signo)
1166                                     continue_packet_error = true;
1167                             }
1168                         }
1169                         if (!continue_packet_error)
1170                             m_gdb_comm.SetCurrentThreadForRun (-1);
1171                     }
1172                     else
1173                     {
1174                         // Set the continue thread ID
1175                         continue_packet_error = false;
1176                         m_gdb_comm.SetCurrentThreadForRun (m_continue_C_tids.front().first);
1177                     }
1178                     if (!continue_packet_error)
1179                     {
1180                         // Add threads continuing with the same signo...
1181                         continue_packet.Printf("C%2.2x", continue_signo);
1182                     }
1183                 }
1184             }
1185 
1186             if (continue_packet_error && num_continue_s_tids > 0)
1187             {
1188                 if (num_continue_s_tids == num_threads)
1189                 {
1190                     // All threads are resuming...
1191                     m_gdb_comm.SetCurrentThreadForRun (-1);
1192                     continue_packet.PutChar ('s');
1193                     continue_packet_error = false;
1194                 }
1195                 else if (num_continue_c_tids == 0 &&
1196                          num_continue_C_tids == 0 &&
1197                          num_continue_s_tids == 1 &&
1198                          num_continue_S_tids == 0 )
1199                 {
1200                     // Only one thread is stepping
1201                     m_gdb_comm.SetCurrentThreadForRun (m_continue_s_tids.front());
1202                     continue_packet.PutChar ('s');
1203                     continue_packet_error = false;
1204                 }
1205             }
1206 
1207             if (!continue_packet_error && num_continue_S_tids > 0)
1208             {
1209                 if (num_continue_S_tids == num_threads)
1210                 {
1211                     const int step_signo = m_continue_S_tids.front().second;
1212                     // Are all threads trying to step with the same signal?
1213                     continue_packet_error = false;
1214                     if (num_continue_S_tids > 1)
1215                     {
1216                         for (size_t i=1; i<num_threads; ++i)
1217                         {
1218                             if (m_continue_S_tids[i].second != step_signo)
1219                                 continue_packet_error = true;
1220                         }
1221                     }
1222                     if (!continue_packet_error)
1223                     {
1224                         // Add threads stepping with the same signo...
1225                         m_gdb_comm.SetCurrentThreadForRun (-1);
1226                         continue_packet.Printf("S%2.2x", step_signo);
1227                     }
1228                 }
1229                 else if (num_continue_c_tids == 0 &&
1230                          num_continue_C_tids == 0 &&
1231                          num_continue_s_tids == 0 &&
1232                          num_continue_S_tids == 1 )
1233                 {
1234                     // Only one thread is stepping with signal
1235                     m_gdb_comm.SetCurrentThreadForRun (m_continue_S_tids.front().first);
1236                     continue_packet.Printf("S%2.2x", m_continue_S_tids.front().second);
1237                     continue_packet_error = false;
1238                 }
1239             }
1240         }
1241 
1242         if (continue_packet_error)
1243         {
1244             error.SetErrorString ("can't make continue packet for this resume");
1245         }
1246         else
1247         {
1248             EventSP event_sp;
1249             TimeValue timeout;
1250             timeout = TimeValue::Now();
1251             timeout.OffsetWithSeconds (5);
1252             if (!IS_VALID_LLDB_HOST_THREAD(m_async_thread))
1253             {
1254                 error.SetErrorString ("Trying to resume but the async thread is dead.");
1255                 if (log)
1256                     log->Printf ("ProcessGDBRemote::DoResume: Trying to resume but the async thread is dead.");
1257                 return error;
1258             }
1259 
1260             m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue, new EventDataBytes (continue_packet.GetData(), continue_packet.GetSize()));
1261 
1262             if (listener.WaitForEvent (&timeout, event_sp) == false)
1263             {
1264                 error.SetErrorString("Resume timed out.");
1265                 if (log)
1266                     log->Printf ("ProcessGDBRemote::DoResume: Resume timed out.");
1267             }
1268             else if (event_sp->BroadcasterIs (&m_async_broadcaster))
1269             {
1270                 error.SetErrorString ("Broadcast continue, but the async thread was killed before we got an ack back.");
1271                 if (log)
1272                     log->Printf ("ProcessGDBRemote::DoResume: Broadcast continue, but the async thread was killed before we got an ack back.");
1273                 return error;
1274             }
1275         }
1276     }
1277 
1278     return error;
1279 }
1280 
1281 void
1282 ProcessGDBRemote::ClearThreadIDList ()
1283 {
1284     Mutex::Locker locker(m_thread_list_real.GetMutex());
1285     m_thread_ids.clear();
1286 }
1287 
1288 bool
1289 ProcessGDBRemote::UpdateThreadIDList ()
1290 {
1291     Mutex::Locker locker(m_thread_list_real.GetMutex());
1292     bool sequence_mutex_unavailable = false;
1293     m_gdb_comm.GetCurrentThreadIDs (m_thread_ids, sequence_mutex_unavailable);
1294     if (sequence_mutex_unavailable)
1295     {
1296         return false; // We just didn't get the list
1297     }
1298     return true;
1299 }
1300 
1301 bool
1302 ProcessGDBRemote::UpdateThreadList (ThreadList &old_thread_list, ThreadList &new_thread_list)
1303 {
1304     // locker will keep a mutex locked until it goes out of scope
1305     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_THREAD));
1306     if (log && log->GetMask().Test(GDBR_LOG_VERBOSE))
1307         log->Printf ("ProcessGDBRemote::%s (pid = %" PRIu64 ")", __FUNCTION__, GetID());
1308 
1309     size_t num_thread_ids = m_thread_ids.size();
1310     // The "m_thread_ids" thread ID list should always be updated after each stop
1311     // reply packet, but in case it isn't, update it here.
1312     if (num_thread_ids == 0)
1313     {
1314         if (!UpdateThreadIDList ())
1315             return false;
1316         num_thread_ids = m_thread_ids.size();
1317     }
1318 
1319     ThreadList old_thread_list_copy(old_thread_list);
1320     if (num_thread_ids > 0)
1321     {
1322         for (size_t i=0; i<num_thread_ids; ++i)
1323         {
1324             tid_t tid = m_thread_ids[i];
1325             ThreadSP thread_sp (old_thread_list_copy.RemoveThreadByProtocolID(tid, false));
1326             if (!thread_sp)
1327                 thread_sp.reset (new ThreadGDBRemote (*this, tid));
1328             new_thread_list.AddThread(thread_sp);
1329         }
1330     }
1331 
1332     // Whatever that is left in old_thread_list_copy are not
1333     // present in new_thread_list. Remove non-existent threads from internal id table.
1334     size_t old_num_thread_ids = old_thread_list_copy.GetSize(false);
1335     for (size_t i=0; i<old_num_thread_ids; i++)
1336     {
1337         ThreadSP old_thread_sp(old_thread_list_copy.GetThreadAtIndex (i, false));
1338         if (old_thread_sp)
1339         {
1340             lldb::tid_t old_thread_id = old_thread_sp->GetProtocolID();
1341             m_thread_id_to_index_id_map.erase(old_thread_id);
1342         }
1343     }
1344 
1345     return true;
1346 }
1347 
1348 
1349 StateType
1350 ProcessGDBRemote::SetThreadStopInfo (StringExtractor& stop_packet)
1351 {
1352     stop_packet.SetFilePos (0);
1353     const char stop_type = stop_packet.GetChar();
1354     switch (stop_type)
1355     {
1356     case 'T':
1357     case 'S':
1358         {
1359             if (GetStopID() == 0)
1360             {
1361                 // Our first stop, make sure we have a process ID, and also make
1362                 // sure we know about our registers
1363                 if (GetID() == LLDB_INVALID_PROCESS_ID)
1364                 {
1365                     lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID ();
1366                     if (pid != LLDB_INVALID_PROCESS_ID)
1367                         SetID (pid);
1368                 }
1369                 BuildDynamicRegisterInfo (true);
1370             }
1371             // Stop with signal and thread info
1372             const uint8_t signo = stop_packet.GetHexU8();
1373             std::string name;
1374             std::string value;
1375             std::string thread_name;
1376             std::string reason;
1377             std::string description;
1378             uint32_t exc_type = 0;
1379             std::vector<addr_t> exc_data;
1380             addr_t thread_dispatch_qaddr = LLDB_INVALID_ADDRESS;
1381             ThreadSP thread_sp;
1382             ThreadGDBRemote *gdb_thread = NULL;
1383 
1384             while (stop_packet.GetNameColonValue(name, value))
1385             {
1386                 if (name.compare("metype") == 0)
1387                 {
1388                     // exception type in big endian hex
1389                     exc_type = Args::StringToUInt32 (value.c_str(), 0, 16);
1390                 }
1391                 else if (name.compare("medata") == 0)
1392                 {
1393                     // exception data in big endian hex
1394                     exc_data.push_back(Args::StringToUInt64 (value.c_str(), 0, 16));
1395                 }
1396                 else if (name.compare("thread") == 0)
1397                 {
1398                     // thread in big endian hex
1399                     lldb::tid_t tid = Args::StringToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
1400                     // m_thread_list_real does have its own mutex, but we need to
1401                     // hold onto the mutex between the call to m_thread_list_real.FindThreadByID(...)
1402                     // and the m_thread_list_real.AddThread(...) so it doesn't change on us
1403                     Mutex::Locker locker (m_thread_list_real.GetMutex ());
1404                     thread_sp = m_thread_list_real.FindThreadByProtocolID(tid, false);
1405 
1406                     if (!thread_sp)
1407                     {
1408                         // Create the thread if we need to
1409                         thread_sp.reset (new ThreadGDBRemote (*this, tid));
1410                         m_thread_list_real.AddThread(thread_sp);
1411                     }
1412                     gdb_thread = static_cast<ThreadGDBRemote *> (thread_sp.get());
1413 
1414                 }
1415                 else if (name.compare("threads") == 0)
1416                 {
1417                     Mutex::Locker locker(m_thread_list_real.GetMutex());
1418                     m_thread_ids.clear();
1419                     // A comma separated list of all threads in the current
1420                     // process that includes the thread for this stop reply
1421                     // packet
1422                     size_t comma_pos;
1423                     lldb::tid_t tid;
1424                     while ((comma_pos = value.find(',')) != std::string::npos)
1425                     {
1426                         value[comma_pos] = '\0';
1427                         // thread in big endian hex
1428                         tid = Args::StringToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
1429                         if (tid != LLDB_INVALID_THREAD_ID)
1430                             m_thread_ids.push_back (tid);
1431                         value.erase(0, comma_pos + 1);
1432 
1433                     }
1434                     tid = Args::StringToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
1435                     if (tid != LLDB_INVALID_THREAD_ID)
1436                         m_thread_ids.push_back (tid);
1437                 }
1438                 else if (name.compare("hexname") == 0)
1439                 {
1440                     StringExtractor name_extractor;
1441                     // Swap "value" over into "name_extractor"
1442                     name_extractor.GetStringRef().swap(value);
1443                     // Now convert the HEX bytes into a string value
1444                     name_extractor.GetHexByteString (value);
1445                     thread_name.swap (value);
1446                 }
1447                 else if (name.compare("name") == 0)
1448                 {
1449                     thread_name.swap (value);
1450                 }
1451                 else if (name.compare("qaddr") == 0)
1452                 {
1453                     thread_dispatch_qaddr = Args::StringToUInt64 (value.c_str(), 0, 16);
1454                 }
1455                 else if (name.compare("reason") == 0)
1456                 {
1457                     reason.swap(value);
1458                 }
1459                 else if (name.compare("description") == 0)
1460                 {
1461                     StringExtractor desc_extractor;
1462                     // Swap "value" over into "name_extractor"
1463                     desc_extractor.GetStringRef().swap(value);
1464                     // Now convert the HEX bytes into a string value
1465                     desc_extractor.GetHexByteString (thread_name);
1466                 }
1467                 else if (name.size() == 2 && ::isxdigit(name[0]) && ::isxdigit(name[1]))
1468                 {
1469                     // We have a register number that contains an expedited
1470                     // register value. Lets supply this register to our thread
1471                     // so it won't have to go and read it.
1472                     if (gdb_thread)
1473                     {
1474                         uint32_t reg = Args::StringToUInt32 (name.c_str(), UINT32_MAX, 16);
1475 
1476                         if (reg != UINT32_MAX)
1477                         {
1478                             StringExtractor reg_value_extractor;
1479                             // Swap "value" over into "reg_value_extractor"
1480                             reg_value_extractor.GetStringRef().swap(value);
1481                             if (!gdb_thread->PrivateSetRegisterValue (reg, reg_value_extractor))
1482                             {
1483                                 Host::SetCrashDescriptionWithFormat("Setting thread register '%s' (decoded to %u (0x%x)) with value '%s' for stop packet: '%s'",
1484                                                                     name.c_str(),
1485                                                                     reg,
1486                                                                     reg,
1487                                                                     reg_value_extractor.GetStringRef().c_str(),
1488                                                                     stop_packet.GetStringRef().c_str());
1489                             }
1490                         }
1491                     }
1492                 }
1493             }
1494 
1495             if (thread_sp)
1496             {
1497                 // Clear the stop info just in case we don't set it to anything
1498                 thread_sp->SetStopInfo (StopInfoSP());
1499 
1500                 gdb_thread->SetThreadDispatchQAddr (thread_dispatch_qaddr);
1501                 gdb_thread->SetName (thread_name.empty() ? NULL : thread_name.c_str());
1502                 if (exc_type != 0)
1503                 {
1504                     const size_t exc_data_size = exc_data.size();
1505 
1506                     thread_sp->SetStopInfo (StopInfoMachException::CreateStopReasonWithMachException (*thread_sp,
1507                                                                                                       exc_type,
1508                                                                                                       exc_data_size,
1509                                                                                                       exc_data_size >= 1 ? exc_data[0] : 0,
1510                                                                                                       exc_data_size >= 2 ? exc_data[1] : 0,
1511                                                                                                       exc_data_size >= 3 ? exc_data[2] : 0));
1512                 }
1513                 else
1514                 {
1515                     bool handled = false;
1516                     if (!reason.empty())
1517                     {
1518                         if (reason.compare("trace") == 0)
1519                         {
1520                             thread_sp->SetStopInfo (StopInfo::CreateStopReasonToTrace (*thread_sp));
1521                             handled = true;
1522                         }
1523                         else if (reason.compare("breakpoint") == 0)
1524                         {
1525                             addr_t pc = thread_sp->GetRegisterContext()->GetPC();
1526                             lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
1527                             if (bp_site_sp)
1528                             {
1529                                 // If the breakpoint is for this thread, then we'll report the hit, but if it is for another thread,
1530                                 // we can just report no reason.  We don't need to worry about stepping over the breakpoint here, that
1531                                 // will be taken care of when the thread resumes and notices that there's a breakpoint under the pc.
1532                                 handled = true;
1533                                 if (bp_site_sp->ValidForThisThread (thread_sp.get()))
1534                                 {
1535                                     thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithBreakpointSiteID (*thread_sp, bp_site_sp->GetID()));
1536                                 }
1537                                 else
1538                                 {
1539                                     StopInfoSP invalid_stop_info_sp;
1540                                     thread_sp->SetStopInfo (invalid_stop_info_sp);
1541                                 }
1542                             }
1543 
1544                         }
1545                         else if (reason.compare("trap") == 0)
1546                         {
1547                             // Let the trap just use the standard signal stop reason below...
1548                         }
1549                         else if (reason.compare("watchpoint") == 0)
1550                         {
1551                             break_id_t watch_id = LLDB_INVALID_WATCH_ID;
1552                             // TODO: locate the watchpoint somehow...
1553                             thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithWatchpointID (*thread_sp, watch_id));
1554                             handled = true;
1555                         }
1556                         else if (reason.compare("exception") == 0)
1557                         {
1558                             thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithException(*thread_sp, description.c_str()));
1559                             handled = true;
1560                         }
1561                     }
1562 
1563                     if (signo)
1564                     {
1565                         if (signo == SIGTRAP)
1566                         {
1567                             // Currently we are going to assume SIGTRAP means we are either
1568                             // hitting a breakpoint or hardware single stepping.
1569                             handled = true;
1570                             addr_t pc = thread_sp->GetRegisterContext()->GetPC();
1571                             lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
1572 
1573                             if (bp_site_sp)
1574                             {
1575                                 // If the breakpoint is for this thread, then we'll report the hit, but if it is for another thread,
1576                                 // we can just report no reason.  We don't need to worry about stepping over the breakpoint here, that
1577                                 // will be taken care of when the thread resumes and notices that there's a breakpoint under the pc.
1578                                 if (bp_site_sp->ValidForThisThread (thread_sp.get()))
1579                                 {
1580                                     thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithBreakpointSiteID (*thread_sp, bp_site_sp->GetID()));
1581                                 }
1582                                 else
1583                                 {
1584                                     StopInfoSP invalid_stop_info_sp;
1585                                     thread_sp->SetStopInfo (invalid_stop_info_sp);
1586                                 }
1587                             }
1588                             else
1589                             {
1590                                 // If we were stepping then assume the stop was the result of the trace.  If we were
1591                                 // not stepping then report the SIGTRAP.
1592                                 // FIXME: We are still missing the case where we single step over a trap instruction.
1593                                 if (thread_sp->GetTemporaryResumeState() == eStateStepping)
1594                                     thread_sp->SetStopInfo (StopInfo::CreateStopReasonToTrace (*thread_sp));
1595                                 else
1596                                     thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithSignal(*thread_sp, signo));
1597                             }
1598                         }
1599                         if (!handled)
1600                             thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithSignal (*thread_sp, signo));
1601                     }
1602 
1603                     if (!description.empty())
1604                     {
1605                         lldb::StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
1606                         if (stop_info_sp)
1607                         {
1608                             stop_info_sp->SetDescription (description.c_str());
1609                         }
1610                         else
1611                         {
1612                             thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithException (*thread_sp, description.c_str()));
1613                         }
1614                     }
1615                 }
1616             }
1617             return eStateStopped;
1618         }
1619         break;
1620 
1621     case 'W':
1622         // process exited
1623         return eStateExited;
1624 
1625     default:
1626         break;
1627     }
1628     return eStateInvalid;
1629 }
1630 
1631 void
1632 ProcessGDBRemote::RefreshStateAfterStop ()
1633 {
1634     Mutex::Locker locker(m_thread_list_real.GetMutex());
1635     m_thread_ids.clear();
1636     // Set the thread stop info. It might have a "threads" key whose value is
1637     // a list of all thread IDs in the current process, so m_thread_ids might
1638     // get set.
1639     SetThreadStopInfo (m_last_stop_packet);
1640     // Check to see if SetThreadStopInfo() filled in m_thread_ids?
1641     if (m_thread_ids.empty())
1642     {
1643         // No, we need to fetch the thread list manually
1644         UpdateThreadIDList();
1645     }
1646 
1647     // Let all threads recover from stopping and do any clean up based
1648     // on the previous thread state (if any).
1649     m_thread_list_real.RefreshStateAfterStop();
1650 
1651 }
1652 
1653 Error
1654 ProcessGDBRemote::DoHalt (bool &caused_stop)
1655 {
1656     Error error;
1657 
1658     bool timed_out = false;
1659     Mutex::Locker locker;
1660 
1661     if (m_public_state.GetValue() == eStateAttaching)
1662     {
1663         // We are being asked to halt during an attach. We need to just close
1664         // our file handle and debugserver will go away, and we can be done...
1665         m_gdb_comm.Disconnect();
1666     }
1667     else
1668     {
1669         if (!m_gdb_comm.SendInterrupt (locker, 2, timed_out))
1670         {
1671             if (timed_out)
1672                 error.SetErrorString("timed out sending interrupt packet");
1673             else
1674                 error.SetErrorString("unknown error sending interrupt packet");
1675         }
1676 
1677         caused_stop = m_gdb_comm.GetInterruptWasSent ();
1678     }
1679     return error;
1680 }
1681 
1682 Error
1683 ProcessGDBRemote::DoDetach(bool keep_stopped)
1684 {
1685     Error error;
1686     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
1687     if (log)
1688         log->Printf ("ProcessGDBRemote::DoDetach(keep_stopped: %i)", keep_stopped);
1689 
1690     DisableAllBreakpointSites ();
1691 
1692     m_thread_list.DiscardThreadPlans();
1693 
1694     error = m_gdb_comm.Detach (keep_stopped);
1695     if (log)
1696     {
1697         if (error.Success())
1698             log->PutCString ("ProcessGDBRemote::DoDetach() detach packet sent successfully");
1699         else
1700             log->Printf ("ProcessGDBRemote::DoDetach() detach packet send failed: %s", error.AsCString() ? error.AsCString() : "<unknown error>");
1701     }
1702 
1703     if (!error.Success())
1704         return error;
1705 
1706     // Sleep for one second to let the process get all detached...
1707     StopAsyncThread ();
1708 
1709     SetPrivateState (eStateDetached);
1710     ResumePrivateStateThread();
1711 
1712     //KillDebugserverProcess ();
1713     return error;
1714 }
1715 
1716 
1717 Error
1718 ProcessGDBRemote::DoDestroy ()
1719 {
1720     Error error;
1721     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
1722     if (log)
1723         log->Printf ("ProcessGDBRemote::DoDestroy()");
1724 
1725     // There is a bug in older iOS debugservers where they don't shut down the process
1726     // they are debugging properly.  If the process is sitting at a breakpoint or an exception,
1727     // this can cause problems with restarting.  So we check to see if any of our threads are stopped
1728     // at a breakpoint, and if so we remove all the breakpoints, resume the process, and THEN
1729     // destroy it again.
1730     //
1731     // Note, we don't have a good way to test the version of debugserver, but I happen to know that
1732     // the set of all the iOS debugservers which don't support GetThreadSuffixSupported() and that of
1733     // the debugservers with this bug are equal.  There really should be a better way to test this!
1734     //
1735     // We also use m_destroy_tried_resuming to make sure we only do this once, if we resume and then halt and
1736     // get called here to destroy again and we're still at a breakpoint or exception, then we should
1737     // just do the straight-forward kill.
1738     //
1739     // And of course, if we weren't able to stop the process by the time we get here, it isn't
1740     // necessary (or helpful) to do any of this.
1741 
1742     if (!m_gdb_comm.GetThreadSuffixSupported() && m_public_state.GetValue() != eStateRunning)
1743     {
1744         PlatformSP platform_sp = GetTarget().GetPlatform();
1745 
1746         // FIXME: These should be ConstStrings so we aren't doing strcmp'ing.
1747         if (platform_sp
1748             && platform_sp->GetName()
1749             && strcmp (platform_sp->GetName(), PlatformRemoteiOS::GetShortPluginNameStatic()) == 0)
1750         {
1751             if (m_destroy_tried_resuming)
1752             {
1753                 if (log)
1754                     log->PutCString ("ProcessGDBRemote::DoDestroy()Tried resuming to destroy once already, not doing it again.");
1755             }
1756             else
1757             {
1758                 // At present, the plans are discarded and the breakpoints disabled Process::Destroy,
1759                 // but we really need it to happen here and it doesn't matter if we do it twice.
1760                 m_thread_list.DiscardThreadPlans();
1761                 DisableAllBreakpointSites();
1762 
1763                 bool stop_looks_like_crash = false;
1764                 ThreadList &threads = GetThreadList();
1765 
1766                 {
1767                     Mutex::Locker locker(threads.GetMutex());
1768 
1769                     size_t num_threads = threads.GetSize();
1770                     for (size_t i = 0; i < num_threads; i++)
1771                     {
1772                         ThreadSP thread_sp = threads.GetThreadAtIndex(i);
1773                         StopInfoSP stop_info_sp = thread_sp->GetPrivateStopInfo();
1774                         StopReason reason = eStopReasonInvalid;
1775                         if (stop_info_sp)
1776                             reason = stop_info_sp->GetStopReason();
1777                         if (reason == eStopReasonBreakpoint
1778                             || reason == eStopReasonException)
1779                         {
1780                             if (log)
1781                                 log->Printf ("ProcessGDBRemote::DoDestroy() - thread: 0x%4.4" PRIx64 " stopped with reason: %s.",
1782                                              thread_sp->GetProtocolID(),
1783                                              stop_info_sp->GetDescription());
1784                             stop_looks_like_crash = true;
1785                             break;
1786                         }
1787                     }
1788                 }
1789 
1790                 if (stop_looks_like_crash)
1791                 {
1792                     if (log)
1793                         log->PutCString ("ProcessGDBRemote::DoDestroy() - Stopped at a breakpoint, continue and then kill.");
1794                     m_destroy_tried_resuming = true;
1795 
1796                     // If we are going to run again before killing, it would be good to suspend all the threads
1797                     // before resuming so they won't get into more trouble.  Sadly, for the threads stopped with
1798                     // the breakpoint or exception, the exception doesn't get cleared if it is suspended, so we do
1799                     // have to run the risk of letting those threads proceed a bit.
1800 
1801                     {
1802                         Mutex::Locker locker(threads.GetMutex());
1803 
1804                         size_t num_threads = threads.GetSize();
1805                         for (size_t i = 0; i < num_threads; i++)
1806                         {
1807                             ThreadSP thread_sp = threads.GetThreadAtIndex(i);
1808                             StopInfoSP stop_info_sp = thread_sp->GetPrivateStopInfo();
1809                             StopReason reason = eStopReasonInvalid;
1810                             if (stop_info_sp)
1811                                 reason = stop_info_sp->GetStopReason();
1812                             if (reason != eStopReasonBreakpoint
1813                                 && reason != eStopReasonException)
1814                             {
1815                                 if (log)
1816                                     log->Printf ("ProcessGDBRemote::DoDestroy() - Suspending thread: 0x%4.4" PRIx64 " before running.",
1817                                                  thread_sp->GetProtocolID());
1818                                 thread_sp->SetResumeState(eStateSuspended);
1819                             }
1820                         }
1821                     }
1822                     Resume ();
1823                     return Destroy();
1824                 }
1825             }
1826         }
1827     }
1828 
1829     // Interrupt if our inferior is running...
1830     int exit_status = SIGABRT;
1831     std::string exit_string;
1832 
1833     if (m_gdb_comm.IsConnected())
1834     {
1835         if (m_public_state.GetValue() != eStateAttaching)
1836         {
1837 
1838             StringExtractorGDBRemote response;
1839             bool send_async = true;
1840             const uint32_t old_packet_timeout = m_gdb_comm.SetPacketTimeout (3);
1841 
1842             if (m_gdb_comm.SendPacketAndWaitForResponse("k", 1, response, send_async))
1843             {
1844                 char packet_cmd = response.GetChar(0);
1845 
1846                 if (packet_cmd == 'W' || packet_cmd == 'X')
1847                 {
1848                     SetLastStopPacket (response);
1849                     ClearThreadIDList ();
1850                     exit_status = response.GetHexU8();
1851                 }
1852                 else
1853                 {
1854                     if (log)
1855                         log->Printf ("ProcessGDBRemote::DoDestroy - got unexpected response to k packet: %s", response.GetStringRef().c_str());
1856                     exit_string.assign("got unexpected response to k packet: ");
1857                     exit_string.append(response.GetStringRef());
1858                 }
1859             }
1860             else
1861             {
1862                 if (log)
1863                     log->Printf ("ProcessGDBRemote::DoDestroy - failed to send k packet");
1864                 exit_string.assign("failed to send the k packet");
1865             }
1866 
1867             m_gdb_comm.SetPacketTimeout(old_packet_timeout);
1868         }
1869         else
1870         {
1871             if (log)
1872                 log->Printf ("ProcessGDBRemote::DoDestroy - failed to send k packet");
1873             exit_string.assign ("killed or interrupted while attaching.");
1874         }
1875     }
1876     else
1877     {
1878         // If we missed setting the exit status on the way out, do it here.
1879         // NB set exit status can be called multiple times, the first one sets the status.
1880         exit_string.assign("destroying when not connected to debugserver");
1881     }
1882 
1883     SetExitStatus(exit_status, exit_string.c_str());
1884 
1885     StopAsyncThread ();
1886     KillDebugserverProcess ();
1887     return error;
1888 }
1889 
1890 //------------------------------------------------------------------
1891 // Process Queries
1892 //------------------------------------------------------------------
1893 
1894 bool
1895 ProcessGDBRemote::IsAlive ()
1896 {
1897     return m_gdb_comm.IsConnected() && m_private_state.GetValue() != eStateExited;
1898 }
1899 
1900 addr_t
1901 ProcessGDBRemote::GetImageInfoAddress()
1902 {
1903     return m_gdb_comm.GetShlibInfoAddr();
1904 }
1905 
1906 //------------------------------------------------------------------
1907 // Process Memory
1908 //------------------------------------------------------------------
1909 size_t
1910 ProcessGDBRemote::DoReadMemory (addr_t addr, void *buf, size_t size, Error &error)
1911 {
1912     if (size > m_max_memory_size)
1913     {
1914         // Keep memory read sizes down to a sane limit. This function will be
1915         // called multiple times in order to complete the task by
1916         // lldb_private::Process so it is ok to do this.
1917         size = m_max_memory_size;
1918     }
1919 
1920     char packet[64];
1921     const int packet_len = ::snprintf (packet, sizeof(packet), "m%" PRIx64 ",%" PRIx64, (uint64_t)addr, (uint64_t)size);
1922     assert (packet_len + 1 < sizeof(packet));
1923     StringExtractorGDBRemote response;
1924     if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, true))
1925     {
1926         if (response.IsNormalResponse())
1927         {
1928             error.Clear();
1929             return response.GetHexBytes(buf, size, '\xdd');
1930         }
1931         else if (response.IsErrorResponse())
1932             error.SetErrorStringWithFormat("memory read failed for 0x%" PRIx64, addr);
1933         else if (response.IsUnsupportedResponse())
1934             error.SetErrorStringWithFormat("GDB server does not support reading memory");
1935         else
1936             error.SetErrorStringWithFormat("unexpected response to GDB server memory read packet '%s': '%s'", packet, response.GetStringRef().c_str());
1937     }
1938     else
1939     {
1940         error.SetErrorStringWithFormat("failed to sent packet: '%s'", packet);
1941     }
1942     return 0;
1943 }
1944 
1945 size_t
1946 ProcessGDBRemote::DoWriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
1947 {
1948     if (size > m_max_memory_size)
1949     {
1950         // Keep memory read sizes down to a sane limit. This function will be
1951         // called multiple times in order to complete the task by
1952         // lldb_private::Process so it is ok to do this.
1953         size = m_max_memory_size;
1954     }
1955 
1956     StreamString packet;
1957     packet.Printf("M%" PRIx64 ",%" PRIx64 ":", addr, (uint64_t)size);
1958     packet.PutBytesAsRawHex8(buf, size, lldb::endian::InlHostByteOrder(), lldb::endian::InlHostByteOrder());
1959     StringExtractorGDBRemote response;
1960     if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetData(), packet.GetSize(), response, true))
1961     {
1962         if (response.IsOKResponse())
1963         {
1964             error.Clear();
1965             return size;
1966         }
1967         else if (response.IsErrorResponse())
1968             error.SetErrorStringWithFormat("memory write failed for 0x%" PRIx64, addr);
1969         else if (response.IsUnsupportedResponse())
1970             error.SetErrorStringWithFormat("GDB server does not support writing memory");
1971         else
1972             error.SetErrorStringWithFormat("unexpected response to GDB server memory write packet '%s': '%s'", packet.GetString().c_str(), response.GetStringRef().c_str());
1973     }
1974     else
1975     {
1976         error.SetErrorStringWithFormat("failed to sent packet: '%s'", packet.GetString().c_str());
1977     }
1978     return 0;
1979 }
1980 
1981 lldb::addr_t
1982 ProcessGDBRemote::DoAllocateMemory (size_t size, uint32_t permissions, Error &error)
1983 {
1984     addr_t allocated_addr = LLDB_INVALID_ADDRESS;
1985 
1986     LazyBool supported = m_gdb_comm.SupportsAllocDeallocMemory();
1987     switch (supported)
1988     {
1989         case eLazyBoolCalculate:
1990         case eLazyBoolYes:
1991             allocated_addr = m_gdb_comm.AllocateMemory (size, permissions);
1992             if (allocated_addr != LLDB_INVALID_ADDRESS || supported == eLazyBoolYes)
1993                 return allocated_addr;
1994 
1995         case eLazyBoolNo:
1996             // Call mmap() to create memory in the inferior..
1997             unsigned prot = 0;
1998             if (permissions & lldb::ePermissionsReadable)
1999                 prot |= eMmapProtRead;
2000             if (permissions & lldb::ePermissionsWritable)
2001                 prot |= eMmapProtWrite;
2002             if (permissions & lldb::ePermissionsExecutable)
2003                 prot |= eMmapProtExec;
2004 
2005             if (InferiorCallMmap(this, allocated_addr, 0, size, prot,
2006                                  eMmapFlagsAnon | eMmapFlagsPrivate, -1, 0))
2007                 m_addr_to_mmap_size[allocated_addr] = size;
2008             else
2009                 allocated_addr = LLDB_INVALID_ADDRESS;
2010             break;
2011     }
2012 
2013     if (allocated_addr == LLDB_INVALID_ADDRESS)
2014         error.SetErrorStringWithFormat("unable to allocate %" PRIu64 " bytes of memory with permissions %s", (uint64_t)size, GetPermissionsAsCString (permissions));
2015     else
2016         error.Clear();
2017     return allocated_addr;
2018 }
2019 
2020 Error
2021 ProcessGDBRemote::GetMemoryRegionInfo (addr_t load_addr,
2022                                        MemoryRegionInfo &region_info)
2023 {
2024 
2025     Error error (m_gdb_comm.GetMemoryRegionInfo (load_addr, region_info));
2026     return error;
2027 }
2028 
2029 Error
2030 ProcessGDBRemote::GetWatchpointSupportInfo (uint32_t &num)
2031 {
2032 
2033     Error error (m_gdb_comm.GetWatchpointSupportInfo (num));
2034     return error;
2035 }
2036 
2037 Error
2038 ProcessGDBRemote::GetWatchpointSupportInfo (uint32_t &num, bool& after)
2039 {
2040     Error error (m_gdb_comm.GetWatchpointSupportInfo (num, after));
2041     return error;
2042 }
2043 
2044 Error
2045 ProcessGDBRemote::DoDeallocateMemory (lldb::addr_t addr)
2046 {
2047     Error error;
2048     LazyBool supported = m_gdb_comm.SupportsAllocDeallocMemory();
2049 
2050     switch (supported)
2051     {
2052         case eLazyBoolCalculate:
2053             // We should never be deallocating memory without allocating memory
2054             // first so we should never get eLazyBoolCalculate
2055             error.SetErrorString ("tried to deallocate memory without ever allocating memory");
2056             break;
2057 
2058         case eLazyBoolYes:
2059             if (!m_gdb_comm.DeallocateMemory (addr))
2060                 error.SetErrorStringWithFormat("unable to deallocate memory at 0x%" PRIx64, addr);
2061             break;
2062 
2063         case eLazyBoolNo:
2064             // Call munmap() to deallocate memory in the inferior..
2065             {
2066                 MMapMap::iterator pos = m_addr_to_mmap_size.find(addr);
2067                 if (pos != m_addr_to_mmap_size.end() &&
2068                     InferiorCallMunmap(this, addr, pos->second))
2069                     m_addr_to_mmap_size.erase (pos);
2070                 else
2071                     error.SetErrorStringWithFormat("unable to deallocate memory at 0x%" PRIx64, addr);
2072             }
2073             break;
2074     }
2075 
2076     return error;
2077 }
2078 
2079 
2080 //------------------------------------------------------------------
2081 // Process STDIO
2082 //------------------------------------------------------------------
2083 size_t
2084 ProcessGDBRemote::PutSTDIN (const char *src, size_t src_len, Error &error)
2085 {
2086     if (m_stdio_communication.IsConnected())
2087     {
2088         ConnectionStatus status;
2089         m_stdio_communication.Write(src, src_len, status, NULL);
2090     }
2091     return 0;
2092 }
2093 
2094 Error
2095 ProcessGDBRemote::EnableBreakpointSite (BreakpointSite *bp_site)
2096 {
2097     Error error;
2098     assert (bp_site != NULL);
2099 
2100     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_BREAKPOINTS));
2101     user_id_t site_id = bp_site->GetID();
2102     const addr_t addr = bp_site->GetLoadAddress();
2103     if (log)
2104         log->Printf ("ProcessGDBRemote::EnableBreakpointSite (size_id = %" PRIu64 ") address = 0x%" PRIx64, site_id, (uint64_t)addr);
2105 
2106     if (bp_site->IsEnabled())
2107     {
2108         if (log)
2109             log->Printf ("ProcessGDBRemote::EnableBreakpointSite (size_id = %" PRIu64 ") address = 0x%" PRIx64 " -- SUCCESS (already enabled)", site_id, (uint64_t)addr);
2110         return error;
2111     }
2112     else
2113     {
2114         const size_t bp_op_size = GetSoftwareBreakpointTrapOpcode (bp_site);
2115 
2116         if (bp_site->HardwarePreferred())
2117         {
2118             // Try and set hardware breakpoint, and if that fails, fall through
2119             // and set a software breakpoint?
2120             if (m_gdb_comm.SupportsGDBStoppointPacket (eBreakpointHardware))
2121             {
2122                 if (m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointHardware, true, addr, bp_op_size) == 0)
2123                 {
2124                     bp_site->SetEnabled(true);
2125                     bp_site->SetType (BreakpointSite::eHardware);
2126                     return error;
2127                 }
2128             }
2129         }
2130 
2131         if (m_gdb_comm.SupportsGDBStoppointPacket (eBreakpointSoftware))
2132         {
2133             if (m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointSoftware, true, addr, bp_op_size) == 0)
2134             {
2135                 bp_site->SetEnabled(true);
2136                 bp_site->SetType (BreakpointSite::eExternal);
2137                 return error;
2138             }
2139         }
2140 
2141         return EnableSoftwareBreakpoint (bp_site);
2142     }
2143 
2144     if (log)
2145     {
2146         const char *err_string = error.AsCString();
2147         log->Printf ("ProcessGDBRemote::EnableBreakpointSite () error for breakpoint at 0x%8.8" PRIx64 ": %s",
2148                      bp_site->GetLoadAddress(),
2149                      err_string ? err_string : "NULL");
2150     }
2151     // We shouldn't reach here on a successful breakpoint enable...
2152     if (error.Success())
2153         error.SetErrorToGenericError();
2154     return error;
2155 }
2156 
2157 Error
2158 ProcessGDBRemote::DisableBreakpointSite (BreakpointSite *bp_site)
2159 {
2160     Error error;
2161     assert (bp_site != NULL);
2162     addr_t addr = bp_site->GetLoadAddress();
2163     user_id_t site_id = bp_site->GetID();
2164     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_BREAKPOINTS));
2165     if (log)
2166         log->Printf ("ProcessGDBRemote::DisableBreakpointSite (site_id = %" PRIu64 ") addr = 0x%8.8" PRIx64, site_id, (uint64_t)addr);
2167 
2168     if (bp_site->IsEnabled())
2169     {
2170         const size_t bp_op_size = GetSoftwareBreakpointTrapOpcode (bp_site);
2171 
2172         BreakpointSite::Type bp_type = bp_site->GetType();
2173         switch (bp_type)
2174         {
2175         case BreakpointSite::eSoftware:
2176             error = DisableSoftwareBreakpoint (bp_site);
2177             break;
2178 
2179         case BreakpointSite::eHardware:
2180             if (m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointSoftware, false, addr, bp_op_size))
2181                 error.SetErrorToGenericError();
2182             break;
2183 
2184         case BreakpointSite::eExternal:
2185             if (m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointSoftware, false, addr, bp_op_size))
2186                 error.SetErrorToGenericError();
2187             break;
2188         }
2189         if (error.Success())
2190             bp_site->SetEnabled(false);
2191     }
2192     else
2193     {
2194         if (log)
2195             log->Printf ("ProcessGDBRemote::DisableBreakpointSite (site_id = %" PRIu64 ") addr = 0x%8.8" PRIx64 " -- SUCCESS (already disabled)", site_id, (uint64_t)addr);
2196         return error;
2197     }
2198 
2199     if (error.Success())
2200         error.SetErrorToGenericError();
2201     return error;
2202 }
2203 
2204 // Pre-requisite: wp != NULL.
2205 static GDBStoppointType
2206 GetGDBStoppointType (Watchpoint *wp)
2207 {
2208     assert(wp);
2209     bool watch_read = wp->WatchpointRead();
2210     bool watch_write = wp->WatchpointWrite();
2211 
2212     // watch_read and watch_write cannot both be false.
2213     assert(watch_read || watch_write);
2214     if (watch_read && watch_write)
2215         return eWatchpointReadWrite;
2216     else if (watch_read)
2217         return eWatchpointRead;
2218     else // Must be watch_write, then.
2219         return eWatchpointWrite;
2220 }
2221 
2222 Error
2223 ProcessGDBRemote::EnableWatchpoint (Watchpoint *wp, bool notify)
2224 {
2225     Error error;
2226     if (wp)
2227     {
2228         user_id_t watchID = wp->GetID();
2229         addr_t addr = wp->GetLoadAddress();
2230         Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_WATCHPOINTS));
2231         if (log)
2232             log->Printf ("ProcessGDBRemote::EnableWatchpoint(watchID = %" PRIu64 ")", watchID);
2233         if (wp->IsEnabled())
2234         {
2235             if (log)
2236                 log->Printf("ProcessGDBRemote::EnableWatchpoint(watchID = %" PRIu64 ") addr = 0x%8.8" PRIx64 ": watchpoint already enabled.", watchID, (uint64_t)addr);
2237             return error;
2238         }
2239 
2240         GDBStoppointType type = GetGDBStoppointType(wp);
2241         // Pass down an appropriate z/Z packet...
2242         if (m_gdb_comm.SupportsGDBStoppointPacket (type))
2243         {
2244             if (m_gdb_comm.SendGDBStoppointTypePacket(type, true, addr, wp->GetByteSize()) == 0)
2245             {
2246                 wp->SetEnabled(true, notify);
2247                 return error;
2248             }
2249             else
2250                 error.SetErrorString("sending gdb watchpoint packet failed");
2251         }
2252         else
2253             error.SetErrorString("watchpoints not supported");
2254     }
2255     else
2256     {
2257         error.SetErrorString("Watchpoint argument was NULL.");
2258     }
2259     if (error.Success())
2260         error.SetErrorToGenericError();
2261     return error;
2262 }
2263 
2264 Error
2265 ProcessGDBRemote::DisableWatchpoint (Watchpoint *wp, bool notify)
2266 {
2267     Error error;
2268     if (wp)
2269     {
2270         user_id_t watchID = wp->GetID();
2271 
2272         Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_WATCHPOINTS));
2273 
2274         addr_t addr = wp->GetLoadAddress();
2275 
2276         if (log)
2277             log->Printf ("ProcessGDBRemote::DisableWatchpoint (watchID = %" PRIu64 ") addr = 0x%8.8" PRIx64, watchID, (uint64_t)addr);
2278 
2279         if (!wp->IsEnabled())
2280         {
2281             if (log)
2282                 log->Printf ("ProcessGDBRemote::DisableWatchpoint (watchID = %" PRIu64 ") addr = 0x%8.8" PRIx64 " -- SUCCESS (already disabled)", watchID, (uint64_t)addr);
2283             // See also 'class WatchpointSentry' within StopInfo.cpp.
2284             // This disabling attempt might come from the user-supplied actions, we'll route it in order for
2285             // the watchpoint object to intelligently process this action.
2286             wp->SetEnabled(false, notify);
2287             return error;
2288         }
2289 
2290         if (wp->IsHardware())
2291         {
2292             GDBStoppointType type = GetGDBStoppointType(wp);
2293             // Pass down an appropriate z/Z packet...
2294             if (m_gdb_comm.SendGDBStoppointTypePacket(type, false, addr, wp->GetByteSize()) == 0)
2295             {
2296                 wp->SetEnabled(false, notify);
2297                 return error;
2298             }
2299             else
2300                 error.SetErrorString("sending gdb watchpoint packet failed");
2301         }
2302         // TODO: clear software watchpoints if we implement them
2303     }
2304     else
2305     {
2306         error.SetErrorString("Watchpoint argument was NULL.");
2307     }
2308     if (error.Success())
2309         error.SetErrorToGenericError();
2310     return error;
2311 }
2312 
2313 void
2314 ProcessGDBRemote::Clear()
2315 {
2316     m_flags = 0;
2317     m_thread_list_real.Clear();
2318     m_thread_list.Clear();
2319 }
2320 
2321 Error
2322 ProcessGDBRemote::DoSignal (int signo)
2323 {
2324     Error error;
2325     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2326     if (log)
2327         log->Printf ("ProcessGDBRemote::DoSignal (signal = %d)", signo);
2328 
2329     if (!m_gdb_comm.SendAsyncSignal (signo))
2330         error.SetErrorStringWithFormat("failed to send signal %i", signo);
2331     return error;
2332 }
2333 
2334 Error
2335 ProcessGDBRemote::StartDebugserverProcess (const char *debugserver_url)
2336 {
2337     ProcessLaunchInfo launch_info;
2338     return StartDebugserverProcess(debugserver_url, launch_info);
2339 }
2340 
2341 Error
2342 ProcessGDBRemote::StartDebugserverProcess (const char *debugserver_url, const ProcessInfo &process_info)    // The connection string to use in the spawned debugserver ("localhost:1234" or "/dev/tty...")
2343 {
2344     Error error;
2345     if (m_debugserver_pid == LLDB_INVALID_PROCESS_ID)
2346     {
2347         // If we locate debugserver, keep that located version around
2348         static FileSpec g_debugserver_file_spec;
2349 
2350         ProcessLaunchInfo debugserver_launch_info;
2351         char debugserver_path[PATH_MAX];
2352         FileSpec &debugserver_file_spec = debugserver_launch_info.GetExecutableFile();
2353 
2354         // Always check to see if we have an environment override for the path
2355         // to the debugserver to use and use it if we do.
2356         const char *env_debugserver_path = getenv("LLDB_DEBUGSERVER_PATH");
2357         if (env_debugserver_path)
2358             debugserver_file_spec.SetFile (env_debugserver_path, false);
2359         else
2360             debugserver_file_spec = g_debugserver_file_spec;
2361         bool debugserver_exists = debugserver_file_spec.Exists();
2362         if (!debugserver_exists)
2363         {
2364             // The debugserver binary is in the LLDB.framework/Resources
2365             // directory.
2366             if (Host::GetLLDBPath (ePathTypeSupportExecutableDir, debugserver_file_spec))
2367             {
2368                 debugserver_file_spec.GetFilename().SetCString(DEBUGSERVER_BASENAME);
2369                 debugserver_exists = debugserver_file_spec.Exists();
2370                 if (debugserver_exists)
2371                 {
2372                     g_debugserver_file_spec = debugserver_file_spec;
2373                 }
2374                 else
2375                 {
2376                     g_debugserver_file_spec.Clear();
2377                     debugserver_file_spec.Clear();
2378                 }
2379             }
2380         }
2381 
2382         if (debugserver_exists)
2383         {
2384             debugserver_file_spec.GetPath (debugserver_path, sizeof(debugserver_path));
2385 
2386             m_stdio_communication.Clear();
2387 
2388             Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
2389 
2390             Args &debugserver_args = debugserver_launch_info.GetArguments();
2391             char arg_cstr[PATH_MAX];
2392 
2393             // Start args with "debugserver /file/path -r --"
2394             debugserver_args.AppendArgument(debugserver_path);
2395             debugserver_args.AppendArgument(debugserver_url);
2396             // use native registers, not the GDB registers
2397             debugserver_args.AppendArgument("--native-regs");
2398             // make debugserver run in its own session so signals generated by
2399             // special terminal key sequences (^C) don't affect debugserver
2400             debugserver_args.AppendArgument("--setsid");
2401 
2402             const char *env_debugserver_log_file = getenv("LLDB_DEBUGSERVER_LOG_FILE");
2403             if (env_debugserver_log_file)
2404             {
2405                 ::snprintf (arg_cstr, sizeof(arg_cstr), "--log-file=%s", env_debugserver_log_file);
2406                 debugserver_args.AppendArgument(arg_cstr);
2407             }
2408 
2409             const char *env_debugserver_log_flags = getenv("LLDB_DEBUGSERVER_LOG_FLAGS");
2410             if (env_debugserver_log_flags)
2411             {
2412                 ::snprintf (arg_cstr, sizeof(arg_cstr), "--log-flags=%s", env_debugserver_log_flags);
2413                 debugserver_args.AppendArgument(arg_cstr);
2414             }
2415 //            debugserver_args.AppendArgument("--log-file=/tmp/debugserver.txt");
2416 //            debugserver_args.AppendArgument("--log-flags=0x802e0e");
2417 
2418             // We currently send down all arguments, attach pids, or attach
2419             // process names in dedicated GDB server packets, so we don't need
2420             // to pass them as arguments. This is currently because of all the
2421             // things we need to setup prior to launching: the environment,
2422             // current working dir, file actions, etc.
2423 #if 0
2424             // Now append the program arguments
2425             if (inferior_argv)
2426             {
2427                 // Terminate the debugserver args so we can now append the inferior args
2428                 debugserver_args.AppendArgument("--");
2429 
2430                 for (int i = 0; inferior_argv[i] != NULL; ++i)
2431                     debugserver_args.AppendArgument (inferior_argv[i]);
2432             }
2433             else if (attach_pid != LLDB_INVALID_PROCESS_ID)
2434             {
2435                 ::snprintf (arg_cstr, sizeof(arg_cstr), "--attach=%u", attach_pid);
2436                 debugserver_args.AppendArgument (arg_cstr);
2437             }
2438             else if (attach_name && attach_name[0])
2439             {
2440                 if (wait_for_launch)
2441                     debugserver_args.AppendArgument ("--waitfor");
2442                 else
2443                     debugserver_args.AppendArgument ("--attach");
2444                 debugserver_args.AppendArgument (attach_name);
2445             }
2446 #endif
2447 
2448             ProcessLaunchInfo::FileAction file_action;
2449 
2450             // Close STDIN, STDOUT and STDERR. We might need to redirect them
2451             // to "/dev/null" if we run into any problems.
2452             file_action.Close (STDIN_FILENO);
2453             debugserver_launch_info.AppendFileAction (file_action);
2454             file_action.Close (STDOUT_FILENO);
2455             debugserver_launch_info.AppendFileAction (file_action);
2456             file_action.Close (STDERR_FILENO);
2457             debugserver_launch_info.AppendFileAction (file_action);
2458 
2459             if (log)
2460             {
2461                 StreamString strm;
2462                 debugserver_args.Dump (&strm);
2463                 log->Printf("%s arguments:\n%s", debugserver_args.GetArgumentAtIndex(0), strm.GetData());
2464             }
2465 
2466             debugserver_launch_info.SetMonitorProcessCallback (MonitorDebugserverProcess, this, false);
2467             debugserver_launch_info.SetUserID(process_info.GetUserID());
2468 
2469             error = Host::LaunchProcess(debugserver_launch_info);
2470 
2471             if (error.Success ())
2472                 m_debugserver_pid = debugserver_launch_info.GetProcessID();
2473             else
2474                 m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
2475 
2476             if (error.Fail() || log)
2477                 error.PutToLog(log, "Host::LaunchProcess (launch_info) => pid=%" PRIu64 ", path='%s'", m_debugserver_pid, debugserver_path);
2478         }
2479         else
2480         {
2481             error.SetErrorStringWithFormat ("unable to locate " DEBUGSERVER_BASENAME);
2482         }
2483 
2484         if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID)
2485             StartAsyncThread ();
2486     }
2487     return error;
2488 }
2489 
2490 bool
2491 ProcessGDBRemote::MonitorDebugserverProcess
2492 (
2493     void *callback_baton,
2494     lldb::pid_t debugserver_pid,
2495     bool exited,        // True if the process did exit
2496     int signo,          // Zero for no signal
2497     int exit_status     // Exit value of process if signal is zero
2498 )
2499 {
2500     // The baton is a "ProcessGDBRemote *". Now this class might be gone
2501     // and might not exist anymore, so we need to carefully try to get the
2502     // target for this process first since we have a race condition when
2503     // we are done running between getting the notice that the inferior
2504     // process has died and the debugserver that was debugging this process.
2505     // In our test suite, we are also continually running process after
2506     // process, so we must be very careful to make sure:
2507     // 1 - process object hasn't been deleted already
2508     // 2 - that a new process object hasn't been recreated in its place
2509 
2510     // "debugserver_pid" argument passed in is the process ID for
2511     // debugserver that we are tracking...
2512     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2513 
2514     ProcessGDBRemote *process = (ProcessGDBRemote *)callback_baton;
2515 
2516     // Get a shared pointer to the target that has a matching process pointer.
2517     // This target could be gone, or the target could already have a new process
2518     // object inside of it
2519     TargetSP target_sp (Debugger::FindTargetWithProcess(process));
2520 
2521     if (log)
2522         log->Printf ("ProcessGDBRemote::MonitorDebugserverProcess (baton=%p, pid=%" PRIu64 ", signo=%i (0x%x), exit_status=%i)", callback_baton, debugserver_pid, signo, signo, exit_status);
2523 
2524     if (target_sp)
2525     {
2526         // We found a process in a target that matches, but another thread
2527         // might be in the process of launching a new process that will
2528         // soon replace it, so get a shared pointer to the process so we
2529         // can keep it alive.
2530         ProcessSP process_sp (target_sp->GetProcessSP());
2531         // Now we have a shared pointer to the process that can't go away on us
2532         // so we now make sure it was the same as the one passed in, and also make
2533         // sure that our previous "process *" didn't get deleted and have a new
2534         // "process *" created in its place with the same pointer. To verify this
2535         // we make sure the process has our debugserver process ID. If we pass all
2536         // of these tests, then we are sure that this process is the one we were
2537         // looking for.
2538         if (process_sp && process == process_sp.get() && process->m_debugserver_pid == debugserver_pid)
2539         {
2540             // Sleep for a half a second to make sure our inferior process has
2541             // time to set its exit status before we set it incorrectly when
2542             // both the debugserver and the inferior process shut down.
2543             usleep (500000);
2544             // If our process hasn't yet exited, debugserver might have died.
2545             // If the process did exit, the we are reaping it.
2546             const StateType state = process->GetState();
2547 
2548             if (process->m_debugserver_pid != LLDB_INVALID_PROCESS_ID &&
2549                 state != eStateInvalid &&
2550                 state != eStateUnloaded &&
2551                 state != eStateExited &&
2552                 state != eStateDetached)
2553             {
2554                 char error_str[1024];
2555                 if (signo)
2556                 {
2557                     const char *signal_cstr = process->GetUnixSignals().GetSignalAsCString (signo);
2558                     if (signal_cstr)
2559                         ::snprintf (error_str, sizeof (error_str), DEBUGSERVER_BASENAME " died with signal %s", signal_cstr);
2560                     else
2561                         ::snprintf (error_str, sizeof (error_str), DEBUGSERVER_BASENAME " died with signal %i", signo);
2562                 }
2563                 else
2564                 {
2565                     ::snprintf (error_str, sizeof (error_str), DEBUGSERVER_BASENAME " died with an exit status of 0x%8.8x", exit_status);
2566                 }
2567 
2568                 process->SetExitStatus (-1, error_str);
2569             }
2570             // Debugserver has exited we need to let our ProcessGDBRemote
2571             // know that it no longer has a debugserver instance
2572             process->m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
2573         }
2574     }
2575     return true;
2576 }
2577 
2578 void
2579 ProcessGDBRemote::KillDebugserverProcess ()
2580 {
2581     if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID)
2582     {
2583         ::kill (m_debugserver_pid, SIGINT);
2584         m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
2585     }
2586 }
2587 
2588 void
2589 ProcessGDBRemote::Initialize()
2590 {
2591     static bool g_initialized = false;
2592 
2593     if (g_initialized == false)
2594     {
2595         g_initialized = true;
2596         PluginManager::RegisterPlugin (GetPluginNameStatic(),
2597                                        GetPluginDescriptionStatic(),
2598                                        CreateInstance);
2599 
2600         Log::Callbacks log_callbacks = {
2601             ProcessGDBRemoteLog::DisableLog,
2602             ProcessGDBRemoteLog::EnableLog,
2603             ProcessGDBRemoteLog::ListLogCategories
2604         };
2605 
2606         Log::RegisterLogChannel (ProcessGDBRemote::GetPluginNameStatic(), log_callbacks);
2607     }
2608 }
2609 
2610 bool
2611 ProcessGDBRemote::StartAsyncThread ()
2612 {
2613     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2614 
2615     if (log)
2616         log->Printf ("ProcessGDBRemote::%s ()", __FUNCTION__);
2617 
2618     Mutex::Locker start_locker(m_async_thread_state_mutex);
2619     if (m_async_thread_state == eAsyncThreadNotStarted)
2620     {
2621         // Create a thread that watches our internal state and controls which
2622         // events make it to clients (into the DCProcess event queue).
2623         m_async_thread = Host::ThreadCreate ("<lldb.process.gdb-remote.async>", ProcessGDBRemote::AsyncThread, this, NULL);
2624         if (IS_VALID_LLDB_HOST_THREAD(m_async_thread))
2625         {
2626             m_async_thread_state = eAsyncThreadRunning;
2627             return true;
2628         }
2629         else
2630             return false;
2631     }
2632     else
2633     {
2634         // Somebody tried to start the async thread while it was either being started or stopped.  If the former, and
2635         // it started up successfully, then say all's well.  Otherwise it is an error, since we aren't going to restart it.
2636         if (log)
2637             log->Printf ("ProcessGDBRemote::%s () - Called when Async thread was in state: %d.", __FUNCTION__, m_async_thread_state);
2638         if (m_async_thread_state == eAsyncThreadRunning)
2639             return true;
2640         else
2641             return false;
2642     }
2643 }
2644 
2645 void
2646 ProcessGDBRemote::StopAsyncThread ()
2647 {
2648     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2649 
2650     if (log)
2651         log->Printf ("ProcessGDBRemote::%s ()", __FUNCTION__);
2652 
2653     Mutex::Locker start_locker(m_async_thread_state_mutex);
2654     if (m_async_thread_state == eAsyncThreadRunning)
2655     {
2656         m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncThreadShouldExit);
2657 
2658         //  This will shut down the async thread.
2659         m_gdb_comm.Disconnect();    // Disconnect from the debug server.
2660 
2661         // Stop the stdio thread
2662         if (IS_VALID_LLDB_HOST_THREAD(m_async_thread))
2663         {
2664             Host::ThreadJoin (m_async_thread, NULL, NULL);
2665         }
2666         m_async_thread_state = eAsyncThreadDone;
2667     }
2668     else
2669     {
2670         if (log)
2671             log->Printf ("ProcessGDBRemote::%s () - Called when Async thread was in state: %d.", __FUNCTION__, m_async_thread_state);
2672     }
2673 }
2674 
2675 
2676 void *
2677 ProcessGDBRemote::AsyncThread (void *arg)
2678 {
2679     ProcessGDBRemote *process = (ProcessGDBRemote*) arg;
2680 
2681     Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
2682     if (log)
2683         log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") thread starting...", __FUNCTION__, arg, process->GetID());
2684 
2685     Listener listener ("ProcessGDBRemote::AsyncThread");
2686     EventSP event_sp;
2687     const uint32_t desired_event_mask = eBroadcastBitAsyncContinue |
2688                                         eBroadcastBitAsyncThreadShouldExit;
2689 
2690     if (listener.StartListeningForEvents (&process->m_async_broadcaster, desired_event_mask) == desired_event_mask)
2691     {
2692         listener.StartListeningForEvents (&process->m_gdb_comm, Communication::eBroadcastBitReadThreadDidExit);
2693 
2694         bool done = false;
2695         while (!done)
2696         {
2697             if (log)
2698                 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") listener.WaitForEvent (NULL, event_sp)...", __FUNCTION__, arg, process->GetID());
2699             if (listener.WaitForEvent (NULL, event_sp))
2700             {
2701                 const uint32_t event_type = event_sp->GetType();
2702                 if (event_sp->BroadcasterIs (&process->m_async_broadcaster))
2703                 {
2704                     if (log)
2705                         log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") Got an event of type: %d...", __FUNCTION__, arg, process->GetID(), event_type);
2706 
2707                     switch (event_type)
2708                     {
2709                         case eBroadcastBitAsyncContinue:
2710                             {
2711                                 const EventDataBytes *continue_packet = EventDataBytes::GetEventDataFromEvent(event_sp.get());
2712 
2713                                 if (continue_packet)
2714                                 {
2715                                     const char *continue_cstr = (const char *)continue_packet->GetBytes ();
2716                                     const size_t continue_cstr_len = continue_packet->GetByteSize ();
2717                                     if (log)
2718                                         log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got eBroadcastBitAsyncContinue: %s", __FUNCTION__, arg, process->GetID(), continue_cstr);
2719 
2720                                     if (::strstr (continue_cstr, "vAttach") == NULL)
2721                                         process->SetPrivateState(eStateRunning);
2722                                     StringExtractorGDBRemote response;
2723                                     StateType stop_state = process->GetGDBRemote().SendContinuePacketAndWaitForResponse (process, continue_cstr, continue_cstr_len, response);
2724 
2725                                     // We need to immediately clear the thread ID list so we are sure to get a valid list of threads.
2726                                     // The thread ID list might be contained within the "response", or the stop reply packet that
2727                                     // caused the stop. So clear it now before we give the stop reply packet to the process
2728                                     // using the process->SetLastStopPacket()...
2729                                     process->ClearThreadIDList ();
2730 
2731                                     switch (stop_state)
2732                                     {
2733                                     case eStateStopped:
2734                                     case eStateCrashed:
2735                                     case eStateSuspended:
2736                                         process->SetLastStopPacket (response);
2737                                         process->SetPrivateState (stop_state);
2738                                         break;
2739 
2740                                     case eStateExited:
2741                                         process->SetLastStopPacket (response);
2742                                         process->ClearThreadIDList();
2743                                         response.SetFilePos(1);
2744                                         process->SetExitStatus(response.GetHexU8(), NULL);
2745                                         done = true;
2746                                         break;
2747 
2748                                     case eStateInvalid:
2749                                         process->SetExitStatus(-1, "lost connection");
2750                                         break;
2751 
2752                                     default:
2753                                         process->SetPrivateState (stop_state);
2754                                         break;
2755                                     }
2756                                 }
2757                             }
2758                             break;
2759 
2760                         case eBroadcastBitAsyncThreadShouldExit:
2761                             if (log)
2762                                 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got eBroadcastBitAsyncThreadShouldExit...", __FUNCTION__, arg, process->GetID());
2763                             done = true;
2764                             break;
2765 
2766                         default:
2767                             if (log)
2768                                 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got unknown event 0x%8.8x", __FUNCTION__, arg, process->GetID(), event_type);
2769                             done = true;
2770                             break;
2771                     }
2772                 }
2773                 else if (event_sp->BroadcasterIs (&process->m_gdb_comm))
2774                 {
2775                     if (event_type & Communication::eBroadcastBitReadThreadDidExit)
2776                     {
2777                         process->SetExitStatus (-1, "lost connection");
2778                         done = true;
2779                     }
2780                 }
2781             }
2782             else
2783             {
2784                 if (log)
2785                     log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") listener.WaitForEvent (NULL, event_sp) => false", __FUNCTION__, arg, process->GetID());
2786                 done = true;
2787             }
2788         }
2789     }
2790 
2791     if (log)
2792         log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") thread exiting...", __FUNCTION__, arg, process->GetID());
2793 
2794     process->m_async_thread = LLDB_INVALID_HOST_THREAD;
2795     return NULL;
2796 }
2797 
2798 const char *
2799 ProcessGDBRemote::GetDispatchQueueNameForThread
2800 (
2801     addr_t thread_dispatch_qaddr,
2802     std::string &dispatch_queue_name
2803 )
2804 {
2805     dispatch_queue_name.clear();
2806     if (thread_dispatch_qaddr != 0 && thread_dispatch_qaddr != LLDB_INVALID_ADDRESS)
2807     {
2808         // Cache the dispatch_queue_offsets_addr value so we don't always have
2809         // to look it up
2810         if (m_dispatch_queue_offsets_addr == LLDB_INVALID_ADDRESS)
2811         {
2812             static ConstString g_dispatch_queue_offsets_symbol_name ("dispatch_queue_offsets");
2813             const Symbol *dispatch_queue_offsets_symbol = NULL;
2814             ModuleSpec libSystem_module_spec (FileSpec("libSystem.B.dylib", false));
2815             ModuleSP module_sp(GetTarget().GetImages().FindFirstModule (libSystem_module_spec));
2816             if (module_sp)
2817                 dispatch_queue_offsets_symbol = module_sp->FindFirstSymbolWithNameAndType (g_dispatch_queue_offsets_symbol_name, eSymbolTypeData);
2818 
2819             if (dispatch_queue_offsets_symbol == NULL)
2820             {
2821                 ModuleSpec libdispatch_module_spec (FileSpec("libdispatch.dylib", false));
2822                 module_sp = GetTarget().GetImages().FindFirstModule (libdispatch_module_spec);
2823                 if (module_sp)
2824                     dispatch_queue_offsets_symbol = module_sp->FindFirstSymbolWithNameAndType (g_dispatch_queue_offsets_symbol_name, eSymbolTypeData);
2825             }
2826             if (dispatch_queue_offsets_symbol)
2827                 m_dispatch_queue_offsets_addr = dispatch_queue_offsets_symbol->GetAddress().GetLoadAddress(&m_target);
2828 
2829             if (m_dispatch_queue_offsets_addr == LLDB_INVALID_ADDRESS)
2830                 return NULL;
2831         }
2832 
2833         uint8_t memory_buffer[8];
2834         DataExtractor data (memory_buffer,
2835                             sizeof(memory_buffer),
2836                             m_target.GetArchitecture().GetByteOrder(),
2837                             m_target.GetArchitecture().GetAddressByteSize());
2838 
2839         // Excerpt from src/queue_private.h
2840         struct dispatch_queue_offsets_s
2841         {
2842             uint16_t dqo_version;
2843             uint16_t dqo_label;      // in version 1-3, offset to string; in version 4+, offset to a pointer to a string
2844             uint16_t dqo_label_size; // in version 1-3, length of string; in version 4+, size of a (void*) in this process
2845         } dispatch_queue_offsets;
2846 
2847 
2848         Error error;
2849         if (ReadMemory (m_dispatch_queue_offsets_addr, memory_buffer, sizeof(dispatch_queue_offsets), error) == sizeof(dispatch_queue_offsets))
2850         {
2851             lldb::offset_t data_offset = 0;
2852             if (data.GetU16(&data_offset, &dispatch_queue_offsets.dqo_version, sizeof(dispatch_queue_offsets)/sizeof(uint16_t)))
2853             {
2854                 if (ReadMemory (thread_dispatch_qaddr, &memory_buffer, data.GetAddressByteSize(), error) == data.GetAddressByteSize())
2855                 {
2856                     data_offset = 0;
2857                     lldb::addr_t queue_addr = data.GetAddress(&data_offset);
2858                     if (dispatch_queue_offsets.dqo_version >= 4)
2859                     {
2860                         // libdispatch versions 4+, pointer to dispatch name is in the
2861                         // queue structure.
2862                         lldb::addr_t pointer_to_label_address = queue_addr + dispatch_queue_offsets.dqo_label;
2863                         if (ReadMemory (pointer_to_label_address, &memory_buffer, data.GetAddressByteSize(), error) == data.GetAddressByteSize())
2864                         {
2865                             data_offset = 0;
2866                             lldb::addr_t label_addr = data.GetAddress(&data_offset);
2867                             ReadCStringFromMemory (label_addr, dispatch_queue_name, error);
2868                         }
2869                     }
2870                     else
2871                     {
2872                         // libdispatch versions 1-3, dispatch name is a fixed width char array
2873                         // in the queue structure.
2874                         lldb::addr_t label_addr = queue_addr + dispatch_queue_offsets.dqo_label;
2875                         dispatch_queue_name.resize(dispatch_queue_offsets.dqo_label_size, '\0');
2876                         size_t bytes_read = ReadMemory (label_addr, &dispatch_queue_name[0], dispatch_queue_offsets.dqo_label_size, error);
2877                         if (bytes_read < dispatch_queue_offsets.dqo_label_size)
2878                             dispatch_queue_name.erase (bytes_read);
2879                     }
2880                 }
2881             }
2882         }
2883     }
2884     if (dispatch_queue_name.empty())
2885         return NULL;
2886     return dispatch_queue_name.c_str();
2887 }
2888 
2889 //uint32_t
2890 //ProcessGDBRemote::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
2891 //{
2892 //    // If we are planning to launch the debugserver remotely, then we need to fire up a debugserver
2893 //    // process and ask it for the list of processes. But if we are local, we can let the Host do it.
2894 //    if (m_local_debugserver)
2895 //    {
2896 //        return Host::ListProcessesMatchingName (name, matches, pids);
2897 //    }
2898 //    else
2899 //    {
2900 //        // FIXME: Implement talking to the remote debugserver.
2901 //        return 0;
2902 //    }
2903 //
2904 //}
2905 //
2906 bool
2907 ProcessGDBRemote::NewThreadNotifyBreakpointHit (void *baton,
2908                              lldb_private::StoppointCallbackContext *context,
2909                              lldb::user_id_t break_id,
2910                              lldb::user_id_t break_loc_id)
2911 {
2912     // I don't think I have to do anything here, just make sure I notice the new thread when it starts to
2913     // run so I can stop it if that's what I want to do.
2914     Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
2915     if (log)
2916         log->Printf("Hit New Thread Notification breakpoint.");
2917     return false;
2918 }
2919 
2920 
2921 bool
2922 ProcessGDBRemote::StartNoticingNewThreads()
2923 {
2924     Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
2925     if (m_thread_create_bp_sp)
2926     {
2927         if (log && log->GetVerbose())
2928             log->Printf("Enabled noticing new thread breakpoint.");
2929         m_thread_create_bp_sp->SetEnabled(true);
2930     }
2931     else
2932     {
2933         PlatformSP platform_sp (m_target.GetPlatform());
2934         if (platform_sp)
2935         {
2936             m_thread_create_bp_sp = platform_sp->SetThreadCreationBreakpoint(m_target);
2937             if (m_thread_create_bp_sp)
2938             {
2939                 if (log && log->GetVerbose())
2940                     log->Printf("Successfully created new thread notification breakpoint %i", m_thread_create_bp_sp->GetID());
2941                 m_thread_create_bp_sp->SetCallback (ProcessGDBRemote::NewThreadNotifyBreakpointHit, this, true);
2942             }
2943             else
2944             {
2945                 if (log)
2946                     log->Printf("Failed to create new thread notification breakpoint.");
2947             }
2948         }
2949     }
2950     return m_thread_create_bp_sp.get() != NULL;
2951 }
2952 
2953 bool
2954 ProcessGDBRemote::StopNoticingNewThreads()
2955 {
2956     Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
2957     if (log && log->GetVerbose())
2958         log->Printf ("Disabling new thread notification breakpoint.");
2959 
2960     if (m_thread_create_bp_sp)
2961         m_thread_create_bp_sp->SetEnabled(false);
2962 
2963     return true;
2964 }
2965 
2966 lldb_private::DynamicLoader *
2967 ProcessGDBRemote::GetDynamicLoader ()
2968 {
2969     if (m_dyld_ap.get() == NULL)
2970         m_dyld_ap.reset (DynamicLoader::FindPlugin(this, m_dyld_plugin_name.empty() ? NULL : m_dyld_plugin_name.c_str()));
2971     return m_dyld_ap.get();
2972 }
2973 
2974 
2975 class CommandObjectProcessGDBRemotePacketHistory : public CommandObjectParsed
2976 {
2977 private:
2978 
2979 public:
2980     CommandObjectProcessGDBRemotePacketHistory(CommandInterpreter &interpreter) :
2981     CommandObjectParsed (interpreter,
2982                          "process plugin packet history",
2983                          "Dumps the packet history buffer. ",
2984                          NULL)
2985     {
2986     }
2987 
2988     ~CommandObjectProcessGDBRemotePacketHistory ()
2989     {
2990     }
2991 
2992     bool
2993     DoExecute (Args& command, CommandReturnObject &result)
2994     {
2995         const size_t argc = command.GetArgumentCount();
2996         if (argc == 0)
2997         {
2998             ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
2999             if (process)
3000             {
3001                 process->GetGDBRemote().DumpHistory(result.GetOutputStream());
3002                 result.SetStatus (eReturnStatusSuccessFinishResult);
3003                 return true;
3004             }
3005         }
3006         else
3007         {
3008             result.AppendErrorWithFormat ("'%s' takes no arguments", m_cmd_name.c_str());
3009         }
3010         result.SetStatus (eReturnStatusFailed);
3011         return false;
3012     }
3013 };
3014 
3015 class CommandObjectProcessGDBRemotePacketSend : public CommandObjectParsed
3016 {
3017 private:
3018 
3019 public:
3020     CommandObjectProcessGDBRemotePacketSend(CommandInterpreter &interpreter) :
3021         CommandObjectParsed (interpreter,
3022                              "process plugin packet send",
3023                              "Send a custom packet through the GDB remote protocol and print the answer. "
3024                              "The packet header and footer will automatically be added to the packet prior to sending and stripped from the result.",
3025                              NULL)
3026     {
3027     }
3028 
3029     ~CommandObjectProcessGDBRemotePacketSend ()
3030     {
3031     }
3032 
3033     bool
3034     DoExecute (Args& command, CommandReturnObject &result)
3035     {
3036         const size_t argc = command.GetArgumentCount();
3037         if (argc == 0)
3038         {
3039             result.AppendErrorWithFormat ("'%s' takes a one or more packet content arguments", m_cmd_name.c_str());
3040             result.SetStatus (eReturnStatusFailed);
3041             return false;
3042         }
3043 
3044         ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
3045         if (process)
3046         {
3047             for (size_t i=0; i<argc; ++ i)
3048             {
3049                 const char *packet_cstr = command.GetArgumentAtIndex(0);
3050                 bool send_async = true;
3051                 StringExtractorGDBRemote response;
3052                 process->GetGDBRemote().SendPacketAndWaitForResponse(packet_cstr, response, send_async);
3053                 result.SetStatus (eReturnStatusSuccessFinishResult);
3054                 Stream &output_strm = result.GetOutputStream();
3055                 output_strm.Printf ("  packet: %s\n", packet_cstr);
3056                 std::string &response_str = response.GetStringRef();
3057 
3058                 if (strcmp(packet_cstr, "qGetProfileData") == 0)
3059                 {
3060                     response_str = process->GetGDBRemote().HarmonizeThreadIdsForProfileData(process, response);
3061                 }
3062 
3063                 if (response_str.empty())
3064                     output_strm.PutCString ("response: \nerror: UNIMPLEMENTED\n");
3065                 else
3066                     output_strm.Printf ("response: %s\n", response.GetStringRef().c_str());
3067             }
3068         }
3069         return true;
3070     }
3071 };
3072 
3073 class CommandObjectProcessGDBRemotePacketMonitor : public CommandObjectRaw
3074 {
3075 private:
3076 
3077 public:
3078     CommandObjectProcessGDBRemotePacketMonitor(CommandInterpreter &interpreter) :
3079         CommandObjectRaw (interpreter,
3080                          "process plugin packet monitor",
3081                          "Send a qRcmd packet through the GDB remote protocol and print the response."
3082                          "The argument passed to this command will be hex encoded into a valid 'qRcmd' packet, sent and the response will be printed.",
3083                          NULL)
3084     {
3085     }
3086 
3087     ~CommandObjectProcessGDBRemotePacketMonitor ()
3088     {
3089     }
3090 
3091     bool
3092     DoExecute (const char *command, CommandReturnObject &result)
3093     {
3094         if (command == NULL || command[0] == '\0')
3095         {
3096             result.AppendErrorWithFormat ("'%s' takes a command string argument", m_cmd_name.c_str());
3097             result.SetStatus (eReturnStatusFailed);
3098             return false;
3099         }
3100 
3101         ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
3102         if (process)
3103         {
3104             StreamString packet;
3105             packet.PutCString("qRcmd,");
3106             packet.PutBytesAsRawHex8(command, strlen(command));
3107             const char *packet_cstr = packet.GetString().c_str();
3108 
3109             bool send_async = true;
3110             StringExtractorGDBRemote response;
3111             process->GetGDBRemote().SendPacketAndWaitForResponse(packet_cstr, response, send_async);
3112             result.SetStatus (eReturnStatusSuccessFinishResult);
3113             Stream &output_strm = result.GetOutputStream();
3114             output_strm.Printf ("  packet: %s\n", packet_cstr);
3115             const std::string &response_str = response.GetStringRef();
3116 
3117             if (response_str.empty())
3118                 output_strm.PutCString ("response: \nerror: UNIMPLEMENTED\n");
3119             else
3120                 output_strm.Printf ("response: %s\n", response.GetStringRef().c_str());
3121         }
3122         return true;
3123     }
3124 };
3125 
3126 class CommandObjectProcessGDBRemotePacket : public CommandObjectMultiword
3127 {
3128 private:
3129 
3130 public:
3131     CommandObjectProcessGDBRemotePacket(CommandInterpreter &interpreter) :
3132         CommandObjectMultiword (interpreter,
3133                                 "process plugin packet",
3134                                 "Commands that deal with GDB remote packets.",
3135                                 NULL)
3136     {
3137         LoadSubCommand ("history", CommandObjectSP (new CommandObjectProcessGDBRemotePacketHistory (interpreter)));
3138         LoadSubCommand ("send", CommandObjectSP (new CommandObjectProcessGDBRemotePacketSend (interpreter)));
3139         LoadSubCommand ("monitor", CommandObjectSP (new CommandObjectProcessGDBRemotePacketMonitor (interpreter)));
3140     }
3141 
3142     ~CommandObjectProcessGDBRemotePacket ()
3143     {
3144     }
3145 };
3146 
3147 class CommandObjectMultiwordProcessGDBRemote : public CommandObjectMultiword
3148 {
3149 public:
3150     CommandObjectMultiwordProcessGDBRemote (CommandInterpreter &interpreter) :
3151         CommandObjectMultiword (interpreter,
3152                                 "process plugin",
3153                                 "A set of commands for operating on a ProcessGDBRemote process.",
3154                                 "process plugin <subcommand> [<subcommand-options>]")
3155     {
3156         LoadSubCommand ("packet", CommandObjectSP (new CommandObjectProcessGDBRemotePacket    (interpreter)));
3157     }
3158 
3159     ~CommandObjectMultiwordProcessGDBRemote ()
3160     {
3161     }
3162 };
3163 
3164 CommandObject *
3165 ProcessGDBRemote::GetPluginCommandObject()
3166 {
3167     if (!m_command_sp)
3168         m_command_sp.reset (new CommandObjectMultiwordProcessGDBRemote (GetTarget().GetDebugger().GetCommandInterpreter()));
3169     return m_command_sp.get();
3170 }
3171