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_ignored_exceptions, // 'QSetIgnoredExceptions' 114 set_max_packet_size, // 'QSetMaxPacketSize:' 115 set_max_payload_size, // 'QSetMaxPayloadSize:' 116 set_environment_variable, // 'QEnvironment:' 117 set_environment_variable_hex, // 'QEnvironmentHexEncoded:' 118 set_launch_arch, // 'QLaunchArch:' 119 set_disable_aslr, // 'QSetDisableASLR:' 120 set_stdin, // 'QSetSTDIN:' 121 set_stdout, // 'QSetSTDOUT:' 122 set_stderr, // 'QSetSTDERR:' 123 set_working_dir, // 'QSetWorkingDir:' 124 set_list_threads_in_stop_reply, // 'QListThreadsInStopReply:' 125 sync_thread_state, // 'QSyncThreadState:' 126 memory_region_info, // 'qMemoryRegionInfo:' 127 get_profile_data, // 'qGetProfileData' 128 set_enable_profiling, // 'QSetEnableAsyncProfiling' 129 enable_compression, // 'QEnableCompression:' 130 watchpoint_support_info, // 'qWatchpointSupportInfo:' 131 allocate_memory, // '_M' 132 deallocate_memory, // '_m' 133 set_process_event, // 'QSetProcessEvent:' 134 save_register_state, // '_g' 135 restore_register_state, // '_G' 136 speed_test, // 'qSpeedTest:' 137 set_detach_on_error, // 'QSetDetachOnError:' 138 query_transfer, // 'qXfer:' 139 json_query_dyld_process_state, // 'jGetDyldProcessState' 140 unknown_type 141 }; 142 143 typedef rnb_err_t (RNBRemote::*HandlePacketCallback)(const char *p); 144 145 RNBRemote(); 146 ~RNBRemote(); 147 148 void Initialize(); 149 150 bool InitializeRegisters(bool force = false); 151 152 rnb_err_t HandleAsyncPacket(PacketEnum *type = NULL); 153 rnb_err_t HandleReceivedPacket(PacketEnum *type = NULL); 154 GetContinueThread()155 nub_thread_t GetContinueThread() const { return m_continue_thread; } 156 SetContinueThread(nub_thread_t tid)157 void SetContinueThread(nub_thread_t tid) { m_continue_thread = tid; } 158 GetCurrentThread()159 nub_thread_t GetCurrentThread() const { 160 if (m_thread == 0 || m_thread == (nub_thread_t)-1) 161 return DNBProcessGetCurrentThread(m_ctx.ProcessID()); 162 return m_thread; 163 } 164 SetCurrentThread(nub_thread_t tid)165 void SetCurrentThread(nub_thread_t tid) { 166 DNBProcessSetCurrentThread(m_ctx.ProcessID(), tid); 167 m_thread = tid; 168 } 169 170 static void *ThreadFunctionReadRemoteData(void *arg); 171 void StartReadRemoteDataThread(); 172 void StopReadRemoteDataThread(); 173 174 void NotifyThatProcessStopped(void); 175 176 rnb_err_t HandlePacket_A(const char *p); 177 rnb_err_t HandlePacket_H(const char *p); 178 rnb_err_t HandlePacket_qC(const char *p); 179 rnb_err_t HandlePacket_qRcmd(const char *p); 180 rnb_err_t HandlePacket_qGetPid(const char *p); 181 rnb_err_t HandlePacket_qEcho(const char *p); 182 rnb_err_t HandlePacket_qLaunchSuccess(const char *p); 183 rnb_err_t HandlePacket_qRegisterInfo(const char *p); 184 rnb_err_t HandlePacket_qShlibInfoAddr(const char *p); 185 rnb_err_t HandlePacket_qStepPacketSupported(const char *p); 186 rnb_err_t HandlePacket_qVAttachOrWaitSupported(const char *p); 187 rnb_err_t HandlePacket_qSyncThreadStateSupported(const char *p); 188 rnb_err_t HandlePacket_qThreadInfo(const char *p); 189 rnb_err_t HandlePacket_jThreadExtendedInfo(const char *p); 190 rnb_err_t HandlePacket_jGetLoadedDynamicLibrariesInfos(const char *p); 191 rnb_err_t HandlePacket_jThreadsInfo(const char *p); 192 rnb_err_t HandlePacket_jGetSharedCacheInfo(const char *p); 193 rnb_err_t HandlePacket_qThreadExtraInfo(const char *p); 194 rnb_err_t HandlePacket_qThreadStopInfo(const char *p); 195 rnb_err_t HandlePacket_qHostInfo(const char *p); 196 rnb_err_t HandlePacket_qGDBServerVersion(const char *p); 197 rnb_err_t HandlePacket_qProcessInfo(const char *p); 198 rnb_err_t HandlePacket_qSymbol(const char *p); 199 rnb_err_t HandlePacket_QStartNoAckMode(const char *p); 200 rnb_err_t HandlePacket_QThreadSuffixSupported(const char *p); 201 rnb_err_t HandlePacket_QSetLogging(const char *p); 202 rnb_err_t HandlePacket_QSetIgnoredExceptions(const char *p); 203 rnb_err_t HandlePacket_QSetDisableASLR(const char *p); 204 rnb_err_t HandlePacket_QSetSTDIO(const char *p); 205 rnb_err_t HandlePacket_QSetWorkingDir(const char *p); 206 rnb_err_t HandlePacket_QSetMaxPayloadSize(const char *p); 207 rnb_err_t HandlePacket_QSetMaxPacketSize(const char *p); 208 rnb_err_t HandlePacket_QEnvironment(const char *p); 209 rnb_err_t HandlePacket_QEnvironmentHexEncoded(const char *p); 210 rnb_err_t HandlePacket_QLaunchArch(const char *p); 211 rnb_err_t HandlePacket_QListThreadsInStopReply(const char *p); 212 rnb_err_t HandlePacket_QSyncThreadState(const char *p); 213 rnb_err_t HandlePacket_QPrefixRegisterPacketsWithThreadID(const char *p); 214 rnb_err_t HandlePacket_QSetProcessEvent(const char *p); 215 rnb_err_t HandlePacket_last_signal(const char *p); 216 rnb_err_t HandlePacket_m(const char *p); 217 rnb_err_t HandlePacket_M(const char *p); 218 rnb_err_t HandlePacket_x(const char *p); 219 rnb_err_t HandlePacket_X(const char *p); 220 rnb_err_t HandlePacket_g(const char *p); 221 rnb_err_t HandlePacket_G(const char *p); 222 rnb_err_t HandlePacket_z(const char *p); 223 rnb_err_t HandlePacket_T(const char *p); 224 rnb_err_t HandlePacket_p(const char *p); 225 rnb_err_t HandlePacket_P(const char *p); 226 rnb_err_t HandlePacket_c(const char *p); 227 rnb_err_t HandlePacket_C(const char *p); 228 rnb_err_t HandlePacket_D(const char *p); 229 rnb_err_t HandlePacket_k(const char *p); 230 rnb_err_t HandlePacket_s(const char *p); 231 rnb_err_t HandlePacket_S(const char *p); 232 rnb_err_t HandlePacket_qSupported(const char *p); 233 rnb_err_t HandlePacket_v(const char *p); 234 rnb_err_t HandlePacket_UNIMPLEMENTED(const char *p); 235 rnb_err_t HandlePacket_ILLFORMED(const char *file, int line, const char *p, 236 const char *description); 237 rnb_err_t HandlePacket_AllocateMemory(const char *p); 238 rnb_err_t HandlePacket_DeallocateMemory(const char *p); 239 rnb_err_t HandlePacket_SaveRegisterState(const char *p); 240 rnb_err_t HandlePacket_RestoreRegisterState(const char *p); 241 rnb_err_t HandlePacket_MemoryRegionInfo(const char *p); 242 rnb_err_t HandlePacket_GetProfileData(const char *p); 243 rnb_err_t HandlePacket_SetEnableAsyncProfiling(const char *p); 244 rnb_err_t HandlePacket_QEnableCompression(const char *p); 245 rnb_err_t HandlePacket_WatchpointSupportInfo(const char *p); 246 rnb_err_t HandlePacket_qSpeedTest(const char *p); 247 rnb_err_t HandlePacket_qXfer(const char *p); 248 rnb_err_t HandlePacket_stop_process(const char *p); 249 rnb_err_t HandlePacket_QSetDetachOnError(const char *p); 250 rnb_err_t HandlePacket_jGetDyldProcessState(const char *p); 251 rnb_err_t SendStopReplyPacketForThread(nub_thread_t tid); 252 rnb_err_t SendHexEncodedBytePacket(const char *header, const void *buf, 253 size_t buf_len, const char *footer); 254 rnb_err_t SendSTDOUTPacket(char *buf, nub_size_t buf_size); 255 rnb_err_t SendSTDERRPacket(char *buf, nub_size_t buf_size); 256 void FlushSTDIO(); 257 void SendAsyncProfileData(); 258 rnb_err_t SendAsyncProfileDataPacket(char *buf, nub_size_t buf_size); 259 rnb_err_t SendAsyncJSONPacket(const JSONGenerator::Dictionary &dictionary); 260 Context()261 RNBContext &Context() { return m_ctx; } Comm()262 RNBSocket &Comm() { return m_comm; } 263 264 private: 265 RNBRemote(const RNBRemote &) = delete; 266 267 protected: 268 rnb_err_t GetCommData(); 269 void CommDataReceived(const std::string &data); 270 struct Packet { 271 typedef std::vector<Packet> collection; 272 typedef collection::iterator iterator; 273 typedef collection::const_iterator const_iterator; 274 PacketEnum type; 275 HandlePacketCallback normal; // Function to call when inferior is halted 276 HandlePacketCallback async; // Function to call when inferior is running 277 std::string abbrev; 278 std::string printable_name; 279 IsPlatformPacketPacket280 bool IsPlatformPacket() const { 281 switch (type) { 282 case set_logging_mode: 283 case query_host_info: 284 return true; 285 default: 286 break; 287 } 288 return false; 289 } PacketPacket290 Packet() 291 : type(invalid_packet), normal(NULL), async(NULL), abbrev(), 292 printable_name() {} 293 PacketPacket294 Packet(PacketEnum in_type, HandlePacketCallback in_normal, 295 HandlePacketCallback in_async, const char *in_abbrev, 296 const char *in_printable_name) 297 : type(in_type), normal(in_normal), async(in_async), abbrev(in_abbrev), 298 printable_name(in_printable_name) {} 299 }; 300 301 struct DispatchQueueOffsets { 302 uint16_t dqo_version; 303 uint16_t dqo_label; 304 uint16_t dqo_label_size; 305 uint16_t dqo_flags; 306 uint16_t dqo_flags_size; 307 uint16_t dqo_serialnum; 308 uint16_t dqo_serialnum_size; 309 uint16_t dqo_width; 310 uint16_t dqo_width_size; 311 uint16_t dqo_running; 312 uint16_t dqo_running_size; 313 uint16_t dqo_suspend_cnt; // version 5 and later, starting with Mac OS X 314 // 10.10/iOS 8 315 uint16_t dqo_suspend_cnt_size; // version 5 and later, starting with Mac OS 316 // X 10.10/iOS 8 317 uint16_t dqo_target_queue; // version 5 and later, starting with Mac OS X 318 // 10.10/iOS 8 319 uint16_t dqo_target_queue_size; // version 5 and later, starting with Mac OS 320 // X 10.10/iOS 8 321 uint16_t 322 dqo_priority; // version 5 and later, starting with Mac OS X 10.10/iOS 8 323 uint16_t dqo_priority_size; // version 5 and later, starting with Mac OS X 324 // 10.10/iOS 8 325 DispatchQueueOffsetsDispatchQueueOffsets326 DispatchQueueOffsets() { Clear(); } 327 ClearDispatchQueueOffsets328 void Clear() { 329 dqo_version = UINT16_MAX; 330 dqo_label = UINT16_MAX; 331 dqo_label_size = UINT16_MAX; 332 dqo_flags = UINT16_MAX; 333 dqo_flags_size = UINT16_MAX; 334 dqo_serialnum = UINT16_MAX; 335 dqo_serialnum_size = UINT16_MAX; 336 dqo_width = UINT16_MAX; 337 dqo_width_size = UINT16_MAX; 338 dqo_running = UINT16_MAX; 339 dqo_running_size = UINT16_MAX; 340 dqo_suspend_cnt = UINT16_MAX; 341 dqo_suspend_cnt_size = UINT16_MAX; 342 dqo_target_queue = UINT16_MAX; 343 dqo_target_queue_size = UINT16_MAX; 344 dqo_priority = UINT16_MAX; 345 dqo_priority_size = UINT16_MAX; 346 } 347 IsValidDispatchQueueOffsets348 bool IsValid() const { return dqo_version != UINT16_MAX; } 349 350 void GetThreadQueueInfo(nub_process_t pid, nub_addr_t dispatch_qaddr, 351 nub_addr_t &dispatch_queue_t, 352 std::string &queue_name, uint64_t &queue_width, 353 uint64_t &queue_serialnum) const; 354 }; 355 356 rnb_err_t GetPacket(std::string &packet_data, RNBRemote::Packet &packet_info, 357 bool wait); 358 rnb_err_t SendPacket(const std::string &); 359 std::string CompressString(const std::string &); 360 361 void CreatePacketTable(); 362 rnb_err_t GetPacketPayload(std::string &); 363 364 nub_thread_t ExtractThreadIDFromThreadSuffix(const char *p); 365 366 void EnableCompressionNextSendPacket(compression_types); 367 368 compression_types GetCompressionType(); 369 370 const DispatchQueueOffsets *GetDispatchQueueOffsets(); 371 372 JSONGenerator::ObjectSP 373 GetJSONThreadsInfo(bool threads_with_valid_stop_info_only); 374 375 RNBContext m_ctx; // process context 376 RNBSocket m_comm; // communication port 377 std::string m_arch; 378 nub_thread_t m_continue_thread; // thread to continue; 0 for any, -1 for all 379 nub_thread_t m_thread; // thread for other ops; 0 for any, -1 for all 380 PThreadMutex m_mutex; // Mutex that protects 381 DispatchQueueOffsets m_dispatch_queue_offsets; 382 nub_addr_t m_dispatch_queue_offsets_addr; 383 uint32_t m_qSymbol_index; 384 uint32_t m_packets_recvd; 385 Packet::collection m_packets; 386 std::deque<std::string> m_rx_packets; 387 std::string m_rx_partial_data; // For packets that may come in more than one 388 // batch, anything left over can be left here 389 pthread_t m_rx_pthread; 390 uint32_t 391 m_max_payload_size; // the maximum sized payload we should send to gdb 392 bool m_extended_mode; // are we in extended mode? 393 bool m_noack_mode; // are we in no-ack mode? 394 bool m_thread_suffix_supported; // Set to true if the 'p', 'P', 'g', and 'G' 395 // packets should be prefixed with the thread 396 // ID and colon: 397 // "$pRR;thread:TTTT;" instead of "$pRR" 398 // "$PRR=VVVVVVVV;thread:TTTT;" instead of "$PRR=VVVVVVVV" 399 // "$g;thread:TTTT" instead of "$g" 400 // "$GVVVVVVVVVVVVVV;thread:TTTT;#00 instead of "$GVVVVVVVVVVVVVV" 401 bool m_list_threads_in_stop_reply; 402 403 size_t m_compression_minsize; // only packets larger than this size will be 404 // compressed 405 bool m_enable_compression_next_send_packet; 406 407 compression_types m_compression_mode; 408 }; 409 410 /* We translate the /usr/include/mach/exception_types.h exception types 411 (e.g. EXC_BAD_ACCESS) to the fake BSD signal numbers that gdb uses 412 in include/gdb/signals.h (e.g. TARGET_EXC_BAD_ACCESS). These hard 413 coded values for TARGET_EXC_BAD_ACCESS et al must match the gdb 414 values in its include/gdb/signals.h. */ 415 416 #define TARGET_EXC_BAD_ACCESS 0x91 417 #define TARGET_EXC_BAD_INSTRUCTION 0x92 418 #define TARGET_EXC_ARITHMETIC 0x93 419 #define TARGET_EXC_EMULATION 0x94 420 #define TARGET_EXC_SOFTWARE 0x95 421 #define TARGET_EXC_BREAKPOINT 0x96 422 423 /* Generally speaking, you can't assume gdb can receive more than 399 bytes 424 at a time with a random gdb. This bufsize constant is only specifying 425 how many bytes gdb can *receive* from debugserver -- it tells us nothing 426 about how many bytes gdb might try to send in a single packet. */ 427 #define DEFAULT_GDB_REMOTE_PROTOCOL_BUFSIZE 399 428 429 #endif // LLDB_TOOLS_DEBUGSERVER_SOURCE_RNBREMOTE_H 430