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