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