RNBRemote.h revision 73f6b49b568f48755bb5058a3db679c3b9093682 
1//===-- RNBRemote.h ---------------------------------------------*- 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//  Created by Greg Clayton on 12/12/07.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef __RNBRemote_h__
15#define __RNBRemote_h__
16
17#include "RNBDefs.h"
18#include "DNB.h"
19#include "RNBContext.h"
20#include "RNBSocket.h"
21#include "PThreadMutex.h"
22#include <string>
23#include <vector>
24#include <deque>
25#include <map>
26
27class RNBSocket;
28class RNBContext;
29class PThreadEvents;
30
31enum event_loop_mode { debug_nub, gdb_remote_protocol, done };
32
33class RNBRemote
34{
35public:
36
37    typedef enum {
38        invalid_packet = 0,
39        ack,                            // '+'
40        nack,                           // '-'
41        halt,                           // ^C  (async halt)
42        use_extended_mode,              // '!'
43        why_halted,                     // '?'
44        set_argv,                       // 'A'
45        set_bp,                         // 'B'
46        cont,                           // 'c'
47        continue_with_sig,              // 'C'
48        detach,                         // 'D'
49        read_general_regs,              // 'g'
50        write_general_regs,             // 'G'
51        set_thread,                     // 'H'
52        step_inferior_one_cycle,        // 'i'
53        signal_and_step_inf_one_cycle,  // 'I'
54        kill,                           // 'k'
55        read_memory,                    // 'm'
56        write_memory,                   // 'M'
57        read_register,                  // 'p'
58        write_register,                 // 'P'
59        restart,                        // 'R'
60        single_step,                    // 's'
61        single_step_with_sig,           // 'S'
62        search_mem_backwards,           // 't'
63        thread_alive_p,                 // 'T'
64        vattach,                        // 'vAttach;pid'
65        vattachwait,                    // 'vAttachWait:XX...' where XX is one or more hex encoded process name ASCII bytes
66        vattachorwait,                  // 'vAttachOrWait:XX...' where XX is one or more hex encoded process name ASCII bytes
67        vattachname,                    // 'vAttachName:XX...' where XX is one or more hex encoded process name ASCII bytes
68        vcont,                          // 'vCont'
69        vcont_list_actions,             // 'vCont?'
70        write_data_to_memory,           // 'X'
71        insert_mem_bp,                  // 'Z0'
72        remove_mem_bp,                  // 'z0'
73        insert_hardware_bp,             // 'Z1'
74        remove_hardware_bp,             // 'z1'
75        insert_write_watch_bp,          // 'Z2'
76        remove_write_watch_bp,          // 'z2'
77        insert_read_watch_bp,           // 'Z3'
78        remove_read_watch_bp,           // 'z3'
79        insert_access_watch_bp,         // 'Z4'
80        remove_access_watch_bp,         // 'z4'
81
82        query_current_thread_id,        // 'qC'
83        query_get_pid,                  // 'qGetPid'
84        query_memory_crc,               // 'qCRC:'
85        query_thread_ids_first,         // 'qfThreadInfo'
86        query_thread_ids_subsequent,    // 'qsThreadInfo'
87        query_thread_extra_info,        // 'qThreadExtraInfo'
88        query_thread_stop_info,         // 'qThreadStopInfo'
89        query_image_offsets,            // 'qOffsets'
90        query_symbol_lookup,            // 'gSymbols'
91        query_launch_success,           // 'qLaunchSuccess'
92        query_register_info,            // 'qRegisterInfo'
93        query_shlib_notify_info_addr,   // 'qShlibInfoAddr'
94        query_step_packet_supported,    // 'qStepPacketSupported'
95        query_vattachorwait_supported,  // 'qVAttachOrWaitSupported'
96        query_sync_thread_state_supported,// 'QSyncThreadState'
97        query_host_info,                // 'qHostInfo'
98        pass_signals_to_inferior,       // 'QPassSignals'
99        start_noack_mode,               // 'QStartNoAckMode'
100        prefix_reg_packets_with_tid,    // 'QPrefixRegisterPacketsWithThreadID
101        set_logging_mode,               // 'QSetLogging:'
102        set_max_packet_size,            // 'QSetMaxPacketSize:'
103        set_max_payload_size,           // 'QSetMaxPayloadSize:'
104        set_environment_variable,       // 'QEnvironment:'
105        set_environment_variable_hex,   // 'QEnvironmentHexEncoded:'
106        set_launch_arch,                // 'QLaunchArch:'
107        set_disable_aslr,               // 'QSetDisableASLR:'
108        set_stdin,                      // 'QSetSTDIN:'
109        set_stdout,                     // 'QSetSTDOUT:'
110        set_stderr,                     // 'QSetSTDERR:'
111        set_working_dir,                // 'QSetWorkingDir:'
112        set_list_threads_in_stop_reply, // 'QListThreadsInStopReply:'
113        sync_thread_state,              // 'QSyncThreadState:'
114        memory_region_info,             // 'qMemoryRegionInfo:'
115        watchpoint_support_info,        // 'qWatchpointSupportInfo:'
116        allocate_memory,                // '_M'
117        deallocate_memory,              // '_m'
118
119        unknown_type
120    } PacketEnum;
121
122    typedef rnb_err_t (RNBRemote::*HandlePacketCallback)(const char *p);
123
124    RNBRemote ();
125    ~RNBRemote ();
126
127    void            Initialize();
128
129    bool            InitializeRegisters ();
130
131    rnb_err_t       HandleAsyncPacket(PacketEnum *type = NULL);
132    rnb_err_t       HandleReceivedPacket(PacketEnum *type = NULL);
133
134    nub_thread_t    GetContinueThread () const
135                    {
136                        return m_continue_thread;
137                    }
138
139    void            SetContinueThread (nub_thread_t tid)
140                    {
141                        m_continue_thread = tid;
142                    }
143
144    nub_thread_t    GetCurrentThread () const
145                    {
146                        if (m_thread == 0 || m_thread == -1)
147                            return DNBProcessGetCurrentThread (m_ctx.ProcessID());
148                        return m_thread;
149                    }
150
151    void            SetCurrentThread (nub_thread_t tid)
152                    {
153                        DNBProcessSetCurrentThread (m_ctx.ProcessID(), tid);
154                        m_thread = tid;
155                    }
156
157    static void*    ThreadFunctionReadRemoteData(void *arg);
158    void            StartReadRemoteDataThread ();
159    void            StopReadRemoteDataThread ();
160
161    void NotifyThatProcessStopped (void);
162
163    rnb_err_t HandlePacket_A (const char *p);
164    rnb_err_t HandlePacket_H (const char *p);
165    rnb_err_t HandlePacket_qC (const char *p);
166    rnb_err_t HandlePacket_qGetPid (const char *p);
167    rnb_err_t HandlePacket_qLaunchSuccess (const char *p);
168    rnb_err_t HandlePacket_qRegisterInfo (const char *p);
169    rnb_err_t HandlePacket_qShlibInfoAddr (const char *p);
170    rnb_err_t HandlePacket_qStepPacketSupported (const char *p);
171    rnb_err_t HandlePacket_qVAttachOrWaitSupported (const char *p);
172    rnb_err_t HandlePacket_qSyncThreadStateSupported (const char *p);
173    rnb_err_t HandlePacket_qThreadInfo (const char *p);
174    rnb_err_t HandlePacket_qThreadExtraInfo (const char *p);
175    rnb_err_t HandlePacket_qThreadStopInfo (const char *p);
176    rnb_err_t HandlePacket_qHostInfo (const char *p);
177    rnb_err_t HandlePacket_QStartNoAckMode (const char *p);
178    rnb_err_t HandlePacket_QThreadSuffixSupported (const char *p);
179    rnb_err_t HandlePacket_QSetLogging (const char *p);
180    rnb_err_t HandlePacket_QSetDisableASLR (const char *p);
181    rnb_err_t HandlePacket_QSetSTDIO (const char *p);
182    rnb_err_t HandlePacket_QSetWorkingDir (const char *p);
183    rnb_err_t HandlePacket_QSetMaxPayloadSize (const char *p);
184    rnb_err_t HandlePacket_QSetMaxPacketSize (const char *p);
185    rnb_err_t HandlePacket_QEnvironment (const char *p);
186    rnb_err_t HandlePacket_QEnvironmentHexEncoded (const char *p);
187    rnb_err_t HandlePacket_QLaunchArch (const char *p);
188    rnb_err_t HandlePacket_QListThreadsInStopReply (const char *p);
189    rnb_err_t HandlePacket_QSyncThreadState (const char *p);
190    rnb_err_t HandlePacket_QPrefixRegisterPacketsWithThreadID (const char *p);
191    rnb_err_t HandlePacket_last_signal (const char *p);
192    rnb_err_t HandlePacket_m (const char *p);
193    rnb_err_t HandlePacket_M (const char *p);
194    rnb_err_t HandlePacket_X (const char *p);
195    rnb_err_t HandlePacket_g (const char *p);
196    rnb_err_t HandlePacket_G (const char *p);
197    rnb_err_t HandlePacket_z (const char *p);
198    rnb_err_t HandlePacket_T (const char *p);
199    rnb_err_t HandlePacket_p (const char *p);
200    rnb_err_t HandlePacket_P (const char *p);
201    rnb_err_t HandlePacket_c (const char *p);
202    rnb_err_t HandlePacket_C (const char *p);
203    rnb_err_t HandlePacket_D (const char *p);
204    rnb_err_t HandlePacket_k (const char *p);
205    rnb_err_t HandlePacket_s (const char *p);
206    rnb_err_t HandlePacket_S (const char *p);
207    rnb_err_t HandlePacket_v (const char *p);
208    rnb_err_t HandlePacket_UNIMPLEMENTED (const char *p);
209    rnb_err_t HandlePacket_ILLFORMED (const char *file, int line, const char *p, const char *description);
210    rnb_err_t HandlePacket_AllocateMemory (const char *p);
211    rnb_err_t HandlePacket_DeallocateMemory (const char *p);
212    rnb_err_t HandlePacket_MemoryRegionInfo (const char *p);
213    rnb_err_t HandlePacket_WatchpointSupportInfo (const char *p);
214
215    rnb_err_t HandlePacket_stop_process (const char *p);
216
217    rnb_err_t SendStopReplyPacketForThread (nub_thread_t tid);
218    rnb_err_t SendHexEncodedBytePacket (const char *header, const void *buf, size_t buf_len, const char *footer);
219    rnb_err_t SendSTDOUTPacket (char *buf, nub_size_t buf_size);
220    rnb_err_t SendSTDERRPacket (char *buf, nub_size_t buf_size);
221    void      FlushSTDIO ();
222
223    RNBContext&     Context() { return m_ctx; }
224    RNBSocket&      Comm() { return m_comm; }
225
226    void
227    SetUseNativeRegisters (bool b)
228    {
229        m_use_native_regs = b;
230    }
231private:
232    // Outlaw some contructors
233    RNBRemote (const RNBRemote &);
234
235protected:
236
237    rnb_err_t GetCommData ();
238    void CommDataReceived(const std::string& data);
239    struct Packet
240    {
241        typedef std::vector<Packet>         collection;
242        typedef collection::iterator        iterator;
243        typedef collection::const_iterator  const_iterator;
244        PacketEnum type;
245        HandlePacketCallback normal;    // Function to call when inferior is halted
246        HandlePacketCallback async;     // Function to call when inferior is running
247        std::string abbrev;
248        std::string printable_name;
249
250        bool
251        IsPlatformPacket () const
252        {
253            switch (type)
254            {
255            case set_logging_mode:
256            case query_host_info:
257                return true;
258            default:
259                    break;
260            }
261            return false;
262        }
263        Packet() :
264            type(invalid_packet),
265            normal (NULL),
266            async (NULL),
267            abbrev (),
268            printable_name ()
269        {
270        }
271
272        Packet( PacketEnum in_type,
273                HandlePacketCallback in_normal,
274                HandlePacketCallback in_async,
275                const char *in_abbrev,
276                const char *in_printable_name) :
277            type    (in_type),
278            normal  (in_normal),
279            async   (in_async),
280            abbrev  (in_abbrev),
281            printable_name (in_printable_name)
282        {
283        }
284    };
285
286    rnb_err_t       GetPacket (std::string &packet_data, RNBRemote::Packet& packet_info, bool wait);
287    rnb_err_t       SendPacket (const std::string &);
288
289    void CreatePacketTable ();
290    rnb_err_t GetPacketPayload (std::string &);
291
292    nub_thread_t
293    ExtractThreadIDFromThreadSuffix (const char *p);
294
295    // gdb can send multiple Z/z packets for the same address and
296    // these calls must be ref counted.
297    struct Breakpoint
298    {
299        Breakpoint(nub_break_t breakID) :
300            m_breakID(breakID),
301            m_refCount(1)
302        {
303        }
304
305        Breakpoint() :
306            m_breakID(INVALID_NUB_BREAK_ID),
307            m_refCount(0)
308        {
309        }
310
311        Breakpoint(const Breakpoint& rhs) :
312            m_breakID(rhs.m_breakID),
313            m_refCount(rhs.m_refCount)
314        {
315        }
316
317        nub_break_t BreakID() const { return m_breakID; }
318        uint32_t RefCount() const { return m_refCount; }
319        void Release() { if (m_refCount > 0) --m_refCount; }
320        void Retain() { ++m_refCount; }
321
322        nub_break_t m_breakID;
323        uint32_t m_refCount;
324    };
325    typedef std::map<nub_addr_t, Breakpoint> BreakpointMap;
326    typedef BreakpointMap::iterator          BreakpointMapIter;
327    typedef BreakpointMap::const_iterator    BreakpointMapConstIter;
328    RNBContext      m_ctx;              // process context
329    RNBSocket       m_comm;             // communication port
330    std::string     m_arch;
331    nub_thread_t    m_continue_thread;  // thread to continue; 0 for any, -1 for all
332    nub_thread_t    m_thread;           // thread for other ops; 0 for any, -1 for all
333    PThreadMutex    m_mutex;            // Mutex that protects
334    uint32_t        m_packets_recvd;
335    Packet::collection m_packets;
336    std::deque<std::string> m_rx_packets;
337    std::string     m_rx_partial_data;  // For packets that may come in more than one batch, anything left over can be left here
338    pthread_t       m_rx_pthread;
339    BreakpointMap   m_breakpoints;
340    BreakpointMap   m_watchpoints;
341    uint32_t        m_max_payload_size;  // the maximum sized payload we should send to gdb
342    bool            m_extended_mode;   // are we in extended mode?
343    bool            m_noack_mode;      // are we in no-ack mode?
344    bool            m_use_native_regs; // Use native registers by querying DNB layer for register definitions?
345    bool            m_thread_suffix_supported; // Set to true if the 'p', 'P', 'g', and 'G' packets should be prefixed with the thread ID and colon:
346                                                                // "$pRR;thread:TTTT;" instead of "$pRR"
347                                                                // "$PRR=VVVVVVVV;thread:TTTT;" instead of "$PRR=VVVVVVVV"
348                                                                // "$g;thread:TTTT" instead of "$g"
349                                                                // "$GVVVVVVVVVVVVVV;thread:TTTT;#00 instead of "$GVVVVVVVVVVVVVV"
350    bool            m_list_threads_in_stop_reply;
351};
352
353/* We translate the /usr/include/mach/exception_types.h exception types
354   (e.g. EXC_BAD_ACCESS) to the fake BSD signal numbers that gdb uses
355   in include/gdb/signals.h (e.g. TARGET_EXC_BAD_ACCESS).  These hard
356   coded values for TARGET_EXC_BAD_ACCESS et al must match the gdb
357   values in its include/gdb/signals.h.  */
358
359#define TARGET_EXC_BAD_ACCESS      0x91
360#define TARGET_EXC_BAD_INSTRUCTION 0x92
361#define TARGET_EXC_ARITHMETIC      0x93
362#define TARGET_EXC_EMULATION       0x94
363#define TARGET_EXC_SOFTWARE        0x95
364#define TARGET_EXC_BREAKPOINT      0x96
365
366/* Generally speaking, you can't assume gdb can receive more than 399 bytes
367   at a time with a random gdb.  This bufsize constant is only specifying
368   how many bytes gdb can *receive* from debugserver -- it tells us nothing
369   about how many bytes gdb might try to send in a single packet.  */
370#define DEFAULT_GDB_REMOTE_PROTOCOL_BUFSIZE 399
371
372#endif // #ifndef __RNBRemote_h__
373