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