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