1 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // Created by Greg Clayton on 12/12/07. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #ifndef LLDB_TOOLS_DEBUGSERVER_SOURCE_RNBREMOTE_H 14 #define LLDB_TOOLS_DEBUGSERVER_SOURCE_RNBREMOTE_H 15 16 #include "DNB.h" 17 #include "PThreadMutex.h" 18 #include "RNBContext.h" 19 #include "RNBDefs.h" 20 #include "RNBSocket.h" 21 #include <deque> 22 #include <map> 23 #include <string> 24 #include <vector> 25 26 class RNBSocket; 27 class RNBContext; 28 class PThreadEvents; 29 30 enum event_loop_mode { debug_nub, gdb_remote_protocol, done }; 31 32 enum class compression_types { zlib_deflate, lz4, lzma, lzfse, none }; 33 34 class RNBRemote { 35 public: 36 enum PacketEnum { 37 invalid_packet = 0, 38 ack, // '+' 39 nack, // '-' 40 halt, // ^C (async halt) 41 use_extended_mode, // '!' 42 why_halted, // '?' 43 set_argv, // 'A' 44 set_bp, // 'B' 45 cont, // 'c' 46 continue_with_sig, // 'C' 47 detach, // 'D' 48 read_general_regs, // 'g' 49 write_general_regs, // 'G' 50 set_thread, // 'H' 51 step_inferior_one_cycle, // 'i' 52 signal_and_step_inf_one_cycle, // 'I' 53 kill, // 'k' 54 read_memory, // 'm' 55 write_memory, // 'M' 56 read_register, // 'p' 57 write_register, // 'P' 58 restart, // 'R' 59 single_step, // 's' 60 single_step_with_sig, // 'S' 61 search_mem_backwards, // 't' 62 thread_alive_p, // 'T' 63 vattach, // 'vAttach;pid' 64 vattachwait, // 'vAttachWait:XX...' where XX is one or more hex encoded 65 // process name ASCII bytes 66 vattachorwait, // 'vAttachOrWait:XX...' where XX is one or more hex encoded 67 // process name ASCII bytes 68 vattachname, // 'vAttachName:XX...' where XX is one or more hex encoded 69 // process name ASCII bytes 70 vcont, // 'vCont' 71 vcont_list_actions, // 'vCont?' 72 read_data_from_memory, // 'x' 73 write_data_to_memory, // 'X' 74 insert_mem_bp, // 'Z0' 75 remove_mem_bp, // 'z0' 76 insert_hardware_bp, // 'Z1' 77 remove_hardware_bp, // 'z1' 78 insert_write_watch_bp, // 'Z2' 79 remove_write_watch_bp, // 'z2' 80 insert_read_watch_bp, // 'Z3' 81 remove_read_watch_bp, // 'z3' 82 insert_access_watch_bp, // 'Z4' 83 remove_access_watch_bp, // 'z4' 84 85 query_monitor, // 'qRcmd' 86 query_current_thread_id, // 'qC' 87 query_get_pid, // 'qGetPid' 88 query_echo, // 'qEcho' 89 query_thread_ids_first, // 'qfThreadInfo' 90 query_thread_ids_subsequent, // 'qsThreadInfo' 91 query_thread_extra_info, // 'qThreadExtraInfo' 92 query_thread_stop_info, // 'qThreadStopInfo' 93 query_image_offsets, // 'qOffsets' 94 query_symbol_lookup, // 'qSymbol' 95 query_launch_success, // 'qLaunchSuccess' 96 query_register_info, // 'qRegisterInfo' 97 query_shlib_notify_info_addr, // 'qShlibInfoAddr' 98 query_step_packet_supported, // 'qStepPacketSupported' 99 query_supported_features, // 'qSupported' 100 query_vattachorwait_supported, // 'qVAttachOrWaitSupported' 101 query_sync_thread_state_supported, // 'QSyncThreadState' 102 query_host_info, // 'qHostInfo' 103 query_gdb_server_version, // 'qGDBServerVersion' 104 query_process_info, // 'qProcessInfo' 105 json_query_thread_extended_info, // 'jThreadExtendedInfo' 106 json_query_get_loaded_dynamic_libraries_infos, // 'jGetLoadedDynamicLibrariesInfos' 107 json_query_threads_info, // 'jThreadsInfo' 108 json_query_get_shared_cache_info, // 'jGetSharedCacheInfo' 109 pass_signals_to_inferior, // 'QPassSignals' 110 start_noack_mode, // 'QStartNoAckMode' 111 prefix_reg_packets_with_tid, // 'QPrefixRegisterPacketsWithThreadID 112 set_logging_mode, // 'QSetLogging:' 113 set_max_packet_size, // 'QSetMaxPacketSize:' 114 set_max_payload_size, // 'QSetMaxPayloadSize:' 115 set_environment_variable, // 'QEnvironment:' 116 set_environment_variable_hex, // 'QEnvironmentHexEncoded:' 117 set_launch_arch, // 'QLaunchArch:' 118 set_disable_aslr, // 'QSetDisableASLR:' 119 set_stdin, // 'QSetSTDIN:' 120 set_stdout, // 'QSetSTDOUT:' 121 set_stderr, // 'QSetSTDERR:' 122 set_working_dir, // 'QSetWorkingDir:' 123 set_list_threads_in_stop_reply, // 'QListThreadsInStopReply:' 124 sync_thread_state, // 'QSyncThreadState:' 125 memory_region_info, // 'qMemoryRegionInfo:' 126 get_profile_data, // 'qGetProfileData' 127 set_enable_profiling, // 'QSetEnableAsyncProfiling' 128 enable_compression, // 'QEnableCompression:' 129 watchpoint_support_info, // 'qWatchpointSupportInfo:' 130 allocate_memory, // '_M' 131 deallocate_memory, // '_m' 132 set_process_event, // 'QSetProcessEvent:' 133 save_register_state, // '_g' 134 restore_register_state, // '_G' 135 speed_test, // 'qSpeedTest:' 136 set_detach_on_error, // 'QSetDetachOnError:' 137 query_transfer, // 'qXfer:' 138 unknown_type 139 }; 140 141 typedef rnb_err_t (RNBRemote::*HandlePacketCallback)(const char *p); 142 143 RNBRemote(); 144 ~RNBRemote(); 145 146 void Initialize(); 147 148 bool InitializeRegisters(bool force = false); 149 150 rnb_err_t HandleAsyncPacket(PacketEnum *type = NULL); 151 rnb_err_t HandleReceivedPacket(PacketEnum *type = NULL); 152 GetContinueThread()153 nub_thread_t GetContinueThread() const { return m_continue_thread; } 154 SetContinueThread(nub_thread_t tid)155 void SetContinueThread(nub_thread_t tid) { m_continue_thread = tid; } 156 GetCurrentThread()157 nub_thread_t GetCurrentThread() const { 158 if (m_thread == 0 || m_thread == (nub_thread_t)-1) 159 return DNBProcessGetCurrentThread(m_ctx.ProcessID()); 160 return m_thread; 161 } 162 SetCurrentThread(nub_thread_t tid)163 void SetCurrentThread(nub_thread_t tid) { 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_qEcho(const char *p); 180 rnb_err_t HandlePacket_qLaunchSuccess(const char *p); 181 rnb_err_t HandlePacket_qRegisterInfo(const char *p); 182 rnb_err_t HandlePacket_qShlibInfoAddr(const char *p); 183 rnb_err_t HandlePacket_qStepPacketSupported(const char *p); 184 rnb_err_t HandlePacket_qVAttachOrWaitSupported(const char *p); 185 rnb_err_t HandlePacket_qSyncThreadStateSupported(const char *p); 186 rnb_err_t HandlePacket_qThreadInfo(const char *p); 187 rnb_err_t HandlePacket_jThreadExtendedInfo(const char *p); 188 rnb_err_t HandlePacket_jGetLoadedDynamicLibrariesInfos(const char *p); 189 rnb_err_t HandlePacket_jThreadsInfo(const char *p); 190 rnb_err_t HandlePacket_jGetSharedCacheInfo(const char *p); 191 rnb_err_t HandlePacket_qThreadExtraInfo(const char *p); 192 rnb_err_t HandlePacket_qThreadStopInfo(const char *p); 193 rnb_err_t HandlePacket_qHostInfo(const char *p); 194 rnb_err_t HandlePacket_qGDBServerVersion(const char *p); 195 rnb_err_t HandlePacket_qProcessInfo(const char *p); 196 rnb_err_t HandlePacket_qSymbol(const char *p); 197 rnb_err_t HandlePacket_QStartNoAckMode(const char *p); 198 rnb_err_t HandlePacket_QThreadSuffixSupported(const char *p); 199 rnb_err_t HandlePacket_QSetLogging(const char *p); 200 rnb_err_t HandlePacket_QSetDisableASLR(const char *p); 201 rnb_err_t HandlePacket_QSetSTDIO(const char *p); 202 rnb_err_t HandlePacket_QSetWorkingDir(const char *p); 203 rnb_err_t HandlePacket_QSetMaxPayloadSize(const char *p); 204 rnb_err_t HandlePacket_QSetMaxPacketSize(const char *p); 205 rnb_err_t HandlePacket_QEnvironment(const char *p); 206 rnb_err_t HandlePacket_QEnvironmentHexEncoded(const char *p); 207 rnb_err_t HandlePacket_QLaunchArch(const char *p); 208 rnb_err_t HandlePacket_QListThreadsInStopReply(const char *p); 209 rnb_err_t HandlePacket_QSyncThreadState(const char *p); 210 rnb_err_t HandlePacket_QPrefixRegisterPacketsWithThreadID(const char *p); 211 rnb_err_t HandlePacket_QSetProcessEvent(const char *p); 212 rnb_err_t HandlePacket_last_signal(const char *p); 213 rnb_err_t HandlePacket_m(const char *p); 214 rnb_err_t HandlePacket_M(const char *p); 215 rnb_err_t HandlePacket_x(const char *p); 216 rnb_err_t HandlePacket_X(const char *p); 217 rnb_err_t HandlePacket_g(const char *p); 218 rnb_err_t HandlePacket_G(const char *p); 219 rnb_err_t HandlePacket_z(const char *p); 220 rnb_err_t HandlePacket_T(const char *p); 221 rnb_err_t HandlePacket_p(const char *p); 222 rnb_err_t HandlePacket_P(const char *p); 223 rnb_err_t HandlePacket_c(const char *p); 224 rnb_err_t HandlePacket_C(const char *p); 225 rnb_err_t HandlePacket_D(const char *p); 226 rnb_err_t HandlePacket_k(const char *p); 227 rnb_err_t HandlePacket_s(const char *p); 228 rnb_err_t HandlePacket_S(const char *p); 229 rnb_err_t HandlePacket_qSupported(const char *p); 230 rnb_err_t HandlePacket_v(const char *p); 231 rnb_err_t HandlePacket_UNIMPLEMENTED(const char *p); 232 rnb_err_t HandlePacket_ILLFORMED(const char *file, int line, const char *p, 233 const char *description); 234 rnb_err_t HandlePacket_AllocateMemory(const char *p); 235 rnb_err_t HandlePacket_DeallocateMemory(const char *p); 236 rnb_err_t HandlePacket_SaveRegisterState(const char *p); 237 rnb_err_t HandlePacket_RestoreRegisterState(const char *p); 238 rnb_err_t HandlePacket_MemoryRegionInfo(const char *p); 239 rnb_err_t HandlePacket_GetProfileData(const char *p); 240 rnb_err_t HandlePacket_SetEnableAsyncProfiling(const char *p); 241 rnb_err_t HandlePacket_QEnableCompression(const char *p); 242 rnb_err_t HandlePacket_WatchpointSupportInfo(const char *p); 243 rnb_err_t HandlePacket_qSpeedTest(const char *p); 244 rnb_err_t HandlePacket_qXfer(const char *p); 245 rnb_err_t HandlePacket_stop_process(const char *p); 246 rnb_err_t HandlePacket_QSetDetachOnError(const char *p); 247 rnb_err_t SendStopReplyPacketForThread(nub_thread_t tid); 248 rnb_err_t SendHexEncodedBytePacket(const char *header, const void *buf, 249 size_t buf_len, const char *footer); 250 rnb_err_t SendSTDOUTPacket(char *buf, nub_size_t buf_size); 251 rnb_err_t SendSTDERRPacket(char *buf, nub_size_t buf_size); 252 void FlushSTDIO(); 253 void SendAsyncProfileData(); 254 rnb_err_t SendAsyncProfileDataPacket(char *buf, nub_size_t buf_size); 255 rnb_err_t SendAsyncJSONPacket(const JSONGenerator::Dictionary &dictionary); 256 Context()257 RNBContext &Context() { return m_ctx; } Comm()258 RNBSocket &Comm() { return m_comm; } 259 260 private: 261 RNBRemote(const RNBRemote &) = delete; 262 263 protected: 264 rnb_err_t GetCommData(); 265 void CommDataReceived(const std::string &data); 266 struct Packet { 267 typedef std::vector<Packet> collection; 268 typedef collection::iterator iterator; 269 typedef collection::const_iterator const_iterator; 270 PacketEnum type; 271 HandlePacketCallback normal; // Function to call when inferior is halted 272 HandlePacketCallback async; // Function to call when inferior is running 273 std::string abbrev; 274 std::string printable_name; 275 IsPlatformPacketPacket276 bool IsPlatformPacket() const { 277 switch (type) { 278 case set_logging_mode: 279 case query_host_info: 280 return true; 281 default: 282 break; 283 } 284 return false; 285 } PacketPacket286 Packet() 287 : type(invalid_packet), normal(NULL), async(NULL), abbrev(), 288 printable_name() {} 289 PacketPacket290 Packet(PacketEnum in_type, HandlePacketCallback in_normal, 291 HandlePacketCallback in_async, const char *in_abbrev, 292 const char *in_printable_name) 293 : type(in_type), normal(in_normal), async(in_async), abbrev(in_abbrev), 294 printable_name(in_printable_name) {} 295 }; 296 297 struct DispatchQueueOffsets { 298 uint16_t dqo_version; 299 uint16_t dqo_label; 300 uint16_t dqo_label_size; 301 uint16_t dqo_flags; 302 uint16_t dqo_flags_size; 303 uint16_t dqo_serialnum; 304 uint16_t dqo_serialnum_size; 305 uint16_t dqo_width; 306 uint16_t dqo_width_size; 307 uint16_t dqo_running; 308 uint16_t dqo_running_size; 309 uint16_t dqo_suspend_cnt; // version 5 and later, starting with Mac OS X 310 // 10.10/iOS 8 311 uint16_t dqo_suspend_cnt_size; // version 5 and later, starting with Mac OS 312 // X 10.10/iOS 8 313 uint16_t dqo_target_queue; // version 5 and later, starting with Mac OS X 314 // 10.10/iOS 8 315 uint16_t dqo_target_queue_size; // version 5 and later, starting with Mac OS 316 // X 10.10/iOS 8 317 uint16_t 318 dqo_priority; // version 5 and later, starting with Mac OS X 10.10/iOS 8 319 uint16_t dqo_priority_size; // version 5 and later, starting with Mac OS X 320 // 10.10/iOS 8 321 DispatchQueueOffsetsDispatchQueueOffsets322 DispatchQueueOffsets() { Clear(); } 323 ClearDispatchQueueOffsets324 void Clear() { 325 dqo_version = UINT16_MAX; 326 dqo_label = UINT16_MAX; 327 dqo_label_size = UINT16_MAX; 328 dqo_flags = UINT16_MAX; 329 dqo_flags_size = UINT16_MAX; 330 dqo_serialnum = UINT16_MAX; 331 dqo_serialnum_size = UINT16_MAX; 332 dqo_width = UINT16_MAX; 333 dqo_width_size = UINT16_MAX; 334 dqo_running = UINT16_MAX; 335 dqo_running_size = UINT16_MAX; 336 dqo_suspend_cnt = UINT16_MAX; 337 dqo_suspend_cnt_size = UINT16_MAX; 338 dqo_target_queue = UINT16_MAX; 339 dqo_target_queue_size = UINT16_MAX; 340 dqo_priority = UINT16_MAX; 341 dqo_priority_size = UINT16_MAX; 342 } 343 IsValidDispatchQueueOffsets344 bool IsValid() const { return dqo_version != UINT16_MAX; } 345 346 void GetThreadQueueInfo(nub_process_t pid, nub_addr_t dispatch_qaddr, 347 nub_addr_t &dispatch_queue_t, 348 std::string &queue_name, uint64_t &queue_width, 349 uint64_t &queue_serialnum) const; 350 }; 351 352 rnb_err_t GetPacket(std::string &packet_data, RNBRemote::Packet &packet_info, 353 bool wait); 354 rnb_err_t SendPacket(const std::string &); 355 std::string CompressString(const std::string &); 356 357 void CreatePacketTable(); 358 rnb_err_t GetPacketPayload(std::string &); 359 360 nub_thread_t ExtractThreadIDFromThreadSuffix(const char *p); 361 362 void EnableCompressionNextSendPacket(compression_types); 363 364 compression_types GetCompressionType(); 365 366 const DispatchQueueOffsets *GetDispatchQueueOffsets(); 367 368 JSONGenerator::ObjectSP 369 GetJSONThreadsInfo(bool threads_with_valid_stop_info_only); 370 371 RNBContext m_ctx; // process context 372 RNBSocket m_comm; // communication port 373 std::string m_arch; 374 nub_thread_t m_continue_thread; // thread to continue; 0 for any, -1 for all 375 nub_thread_t m_thread; // thread for other ops; 0 for any, -1 for all 376 PThreadMutex m_mutex; // Mutex that protects 377 DispatchQueueOffsets m_dispatch_queue_offsets; 378 nub_addr_t m_dispatch_queue_offsets_addr; 379 uint32_t m_qSymbol_index; 380 uint32_t m_packets_recvd; 381 Packet::collection m_packets; 382 std::deque<std::string> m_rx_packets; 383 std::string m_rx_partial_data; // For packets that may come in more than one 384 // batch, anything left over can be left here 385 pthread_t m_rx_pthread; 386 uint32_t 387 m_max_payload_size; // the maximum sized payload we should send to gdb 388 bool m_extended_mode; // are we in extended mode? 389 bool m_noack_mode; // are we in no-ack mode? 390 bool m_thread_suffix_supported; // Set to true if the 'p', 'P', 'g', and 'G' 391 // packets should be prefixed with the thread 392 // ID and colon: 393 // "$pRR;thread:TTTT;" instead of "$pRR" 394 // "$PRR=VVVVVVVV;thread:TTTT;" instead of "$PRR=VVVVVVVV" 395 // "$g;thread:TTTT" instead of "$g" 396 // "$GVVVVVVVVVVVVVV;thread:TTTT;#00 instead of "$GVVVVVVVVVVVVVV" 397 bool m_list_threads_in_stop_reply; 398 399 size_t m_compression_minsize; // only packets larger than this size will be 400 // compressed 401 bool m_enable_compression_next_send_packet; 402 403 compression_types m_compression_mode; 404 }; 405 406 /* We translate the /usr/include/mach/exception_types.h exception types 407 (e.g. EXC_BAD_ACCESS) to the fake BSD signal numbers that gdb uses 408 in include/gdb/signals.h (e.g. TARGET_EXC_BAD_ACCESS). These hard 409 coded values for TARGET_EXC_BAD_ACCESS et al must match the gdb 410 values in its include/gdb/signals.h. */ 411 412 #define TARGET_EXC_BAD_ACCESS 0x91 413 #define TARGET_EXC_BAD_INSTRUCTION 0x92 414 #define TARGET_EXC_ARITHMETIC 0x93 415 #define TARGET_EXC_EMULATION 0x94 416 #define TARGET_EXC_SOFTWARE 0x95 417 #define TARGET_EXC_BREAKPOINT 0x96 418 419 /* Generally speaking, you can't assume gdb can receive more than 399 bytes 420 at a time with a random gdb. This bufsize constant is only specifying 421 how many bytes gdb can *receive* from debugserver -- it tells us nothing 422 about how many bytes gdb might try to send in a single packet. */ 423 #define DEFAULT_GDB_REMOTE_PROTOCOL_BUFSIZE 399 424 425 #endif // LLDB_TOOLS_DEBUGSERVER_SOURCE_RNBREMOTE_H 426