RNBRemote.h revision 0a7f75f9e375911ca91a884968b0efa36f18588d 
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'
65        vattachwait,                    // 'vAttachWait'
66        vcont,                          // 'vCont'
67        vcont_list_actions,             // 'vCont?'
68        write_data_to_memory,           // 'X'
69        insert_mem_bp,                  // 'Z0'
70        remove_mem_bp,                  // 'z0'
71        insert_hardware_bp,             // 'Z1'
72        remove_hardware_bp,             // 'z1'
73        insert_write_watch_bp,          // 'Z2'
74        remove_write_watch_bp,          // 'z2'
75        insert_read_watch_bp,           // 'Z3'
76        remove_read_watch_bp,           // 'z3'
77        insert_access_watch_bp,         // 'Z4'
78        remove_access_watch_bp,         // 'z4'
79
80        query_current_thread_id,        // 'qC'
81        query_memory_crc,               // 'qCRC:'
82        query_thread_ids_first,         // 'qfThreadInfo'
83        query_thread_ids_subsequent,    // 'qsThreadInfo'
84        query_thread_extra_info,        // 'qThreadExtraInfo'
85        query_thread_stop_info,         // 'qThreadStopInfo'
86        query_image_offsets,            // 'qOffsets'
87        query_symbol_lookup,            // 'gSymbols'
88        query_launch_success,           // 'qLaunchSuccess'
89        query_register_info,            // 'qRegisterInfo'
90        query_shlib_notify_info_addr,   // 'qShlibInfoAddr'
91        query_step_packet_supported,    // 'qStepPacketSupported'
92        query_host_info,                // 'qHostInfo'
93        pass_signals_to_inferior,       // 'QPassSignals'
94        start_noack_mode,               // 'QStartNoAckMode'
95        set_logging_mode,               // 'QSetLogging:'
96        set_max_packet_size,            // 'QSetMaxPacketSize:'
97        set_max_payload_size,           // 'QSetMaxPayloadSize:'
98        set_environment_variable,       // 'QEnvironment:'
99        set_disable_aslr,               // 'QSetDisableASLR:'
100        allocate_memory,                // '_M'
101        deallocate_memory,              // '_m'
102
103        unknown_type,
104    } PacketEnum;
105
106    typedef rnb_err_t (RNBRemote::*HandlePacketCallback)(const char *p);
107
108    RNBRemote(bool use_native_regs);
109    ~RNBRemote();
110
111    static void     InitializeRegisters (int use_native);
112
113    rnb_err_t       HandleAsyncPacket(PacketEnum *type = NULL);
114    rnb_err_t       HandleReceivedPacket(PacketEnum *type = NULL);
115
116    nub_thread_t    GetContinueThread () const
117                    {
118                        return m_continue_thread;
119                    }
120
121    void            SetContinueThread (nub_thread_t tid)
122                    {
123                        m_continue_thread = tid;
124                    }
125
126    nub_thread_t    GetCurrentThread () const
127                    {
128                        if (m_thread == 0 || m_thread == -1)
129                            return DNBProcessGetCurrentThread (m_ctx.ProcessID());
130                        return m_thread;
131                    }
132
133    void            SetCurrentThread (nub_thread_t tid)
134                    {
135                        DNBProcessSetCurrentThread (m_ctx.ProcessID(), tid);
136                        m_thread = tid;
137                    }
138
139    static void*    ThreadFunctionReadRemoteData(void *arg);
140    void            StartReadRemoteDataThread ();
141    void            StopReadRemoteDataThread ();
142
143    void NotifyThatProcessStopped (void);
144
145    rnb_err_t HandlePacket_A (const char *p);
146    rnb_err_t HandlePacket_H (const char *p);
147    rnb_err_t HandlePacket_qC (const char *p);
148    rnb_err_t HandlePacket_qLaunchSuccess (const char *p);
149    rnb_err_t HandlePacket_qRegisterInfo (const char *p);
150    rnb_err_t HandlePacket_qShlibInfoAddr (const char *p);
151    rnb_err_t HandlePacket_qStepPacketSupported (const char *p);
152    rnb_err_t HandlePacket_qThreadInfo (const char *p);
153    rnb_err_t HandlePacket_qThreadExtraInfo (const char *p);
154    rnb_err_t HandlePacket_qThreadStopInfo (const char *p);
155    rnb_err_t HandlePacket_qHostInfo (const char *p);
156    rnb_err_t HandlePacket_Q (const char *p);
157    rnb_err_t HandlePacket_last_signal (const char *p);
158    rnb_err_t HandlePacket_m (const char *p);
159    rnb_err_t HandlePacket_M (const char *p);
160    rnb_err_t HandlePacket_X (const char *p);
161    rnb_err_t HandlePacket_g (const char *p);
162    rnb_err_t HandlePacket_G (const char *p);
163    rnb_err_t HandlePacket_z (const char *p);
164    rnb_err_t HandlePacket_T (const char *p);
165    rnb_err_t HandlePacket_p (const char *p);
166    rnb_err_t HandlePacket_P (const char *p);
167    rnb_err_t HandlePacket_c (const char *p);
168    rnb_err_t HandlePacket_C (const char *p);
169    rnb_err_t HandlePacket_D (const char *p);
170    rnb_err_t HandlePacket_k (const char *p);
171    rnb_err_t HandlePacket_s (const char *p);
172    rnb_err_t HandlePacket_S (const char *p);
173    rnb_err_t HandlePacket_v (const char *p);
174    rnb_err_t HandlePacket_UNIMPLEMENTED (const char *p);
175    rnb_err_t HandlePacket_ILLFORMED (const char *description);
176    rnb_err_t HandlePacket_AllocateMemory (const char *p);
177    rnb_err_t HandlePacket_DeallocateMemory (const char *p);
178
179    rnb_err_t HandlePacket_stop_process (const char *p);
180
181    rnb_err_t SendStopReplyPacketForThread (nub_thread_t tid);
182    rnb_err_t SendHexEncodedBytePacket (const char *header, const void *buf, size_t buf_len, const char *footer);
183    rnb_err_t SendSTDOUTPacket (char *buf, nub_size_t buf_size);
184    rnb_err_t SendSTDERRPacket (char *buf, nub_size_t buf_size);
185    void      FlushSTDIO ();
186
187    RNBContext&     Context() { return m_ctx; }
188    RNBSocket&      Comm() { return m_comm; }
189
190private:
191    // Outlaw some contructors
192    RNBRemote (const RNBRemote &);
193
194protected:
195
196    static void
197    InitializeNativeRegisters ();
198
199    rnb_err_t GetCommData ();
200    void CommDataReceived(const std::string& data);
201    struct Packet
202    {
203        typedef std::vector<Packet>         collection;
204        typedef collection::iterator        iterator;
205        typedef collection::const_iterator  const_iterator;
206        PacketEnum type;
207        HandlePacketCallback normal;    // Function to call when inferior is halted
208        HandlePacketCallback async;     // Function to call when inferior is running
209        std::string abbrev;
210        std::string printable_name;
211        Packet() :
212            type(invalid_packet),
213            normal (NULL),
214            async (NULL),
215            abbrev (),
216            printable_name ()
217        {
218        }
219
220        Packet( PacketEnum in_type,
221                HandlePacketCallback in_normal,
222                HandlePacketCallback in_async,
223                const char *in_abbrev,
224                const char *in_printable_name) :
225            type    (in_type),
226            normal  (in_normal),
227            async   (in_async),
228            abbrev  (in_abbrev),
229            printable_name (in_printable_name)
230        {
231        }
232    };
233
234    rnb_err_t       GetPacket (std::string &packet_data, RNBRemote::Packet& packet_info, bool wait);
235    rnb_err_t       SendPacket (const std::string &);
236
237    void CreatePacketTable ();
238    rnb_err_t GetPacketPayload (std::string &);
239
240    // gdb can send multiple Z/z packets for the same address and
241    // these calls must be ref counted.
242    typedef struct Breakpoint
243    {
244        Breakpoint(nub_break_t breakID) :
245            m_breakID(breakID),
246            m_refCount(1)
247        {
248        }
249
250        Breakpoint() :
251            m_breakID(INVALID_NUB_BREAK_ID),
252            m_refCount(0)
253        {
254        }
255
256        Breakpoint(const Breakpoint& rhs) :
257            m_breakID(rhs.m_breakID),
258            m_refCount(rhs.m_refCount)
259        {
260        }
261
262        nub_break_t BreakID() const { return m_breakID; }
263        uint32_t RefCount() const { return m_refCount; }
264        void Release() { if (m_refCount > 0) --m_refCount; }
265        void Retain() { ++m_refCount; }
266
267        nub_break_t m_breakID;
268        uint32_t m_refCount;
269    };
270    typedef std::map<nub_addr_t, Breakpoint> BreakpointMap;
271    typedef BreakpointMap::iterator          BreakpointMapIter;
272    typedef BreakpointMap::const_iterator    BreakpointMapConstIter;
273    RNBContext      m_ctx;              // process context
274    RNBSocket       m_comm;             // communication port
275    bool            m_extended_mode;    // are we in extended mode?
276    bool            m_noack_mode;       // are we in no-ack mode?
277    nub_thread_t    m_continue_thread;  // thread to continue; 0 for any, -1 for all
278    nub_thread_t    m_thread;           // thread for other ops; 0 for any, -1 for all
279    PThreadMutex    m_mutex;            // Mutex that protects
280    uint32_t        m_packets_recvd;
281    Packet::collection m_packets;
282    std::deque<std::string> m_rx_packets;
283    std::string     m_rx_partial_data;  // For packets that may come in more than one batch, anything left over can be left here
284    pthread_t       m_rx_pthread;
285    BreakpointMap   m_breakpoints;
286    BreakpointMap   m_watchpoints;
287    uint32_t        m_max_payload_size;  // the maximum sized payload we should send to gdb
288    bool            m_use_native_regs;
289};
290
291/* We translate the /usr/include/mach/exception_types.h exception types
292   (e.g. EXC_BAD_ACCESS) to the fake BSD signal numbers that gdb uses
293   in include/gdb/signals.h (e.g. TARGET_EXC_BAD_ACCESS).  These hard
294   coded values for TARGET_EXC_BAD_ACCESS et al must match the gdb
295   values in its include/gdb/signals.h.  */
296
297#define TARGET_EXC_BAD_ACCESS      0x91
298#define TARGET_EXC_BAD_INSTRUCTION 0x92
299#define TARGET_EXC_ARITHMETIC      0x93
300#define TARGET_EXC_EMULATION       0x94
301#define TARGET_EXC_SOFTWARE        0x95
302#define TARGET_EXC_BREAKPOINT      0x96
303
304/* Generally speaking, you can't assume gdb can receive more than 399 bytes
305   at a time with a random gdb.  This bufsize constant is only specifying
306   how many bytes gdb can *receive* from debugserver -- it tells us nothing
307   about how many bytes gdb might try to send in a single packet.  */
308#define DEFAULT_GDB_REMOTE_PROTOCOL_BUFSIZE 399
309
310#endif // #ifndef __RNBRemote_h__
311