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