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