1 //===-- GDBRemoteCommunicationServerLLGS.cpp --------------------*- C++ -*-===// 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 #include <errno.h> 10 11 #include "lldb/Host/Config.h" 12 13 #include "GDBRemoteCommunicationServerLLGS.h" 14 #include "lldb/Utility/StreamGDBRemote.h" 15 16 #include <chrono> 17 #include <cstring> 18 #include <thread> 19 20 #include "lldb/Host/ConnectionFileDescriptor.h" 21 #include "lldb/Host/Debug.h" 22 #include "lldb/Host/File.h" 23 #include "lldb/Host/FileAction.h" 24 #include "lldb/Host/FileSystem.h" 25 #include "lldb/Host/Host.h" 26 #include "lldb/Host/HostInfo.h" 27 #include "lldb/Host/PosixApi.h" 28 #include "lldb/Host/common/NativeProcessProtocol.h" 29 #include "lldb/Host/common/NativeRegisterContext.h" 30 #include "lldb/Host/common/NativeThreadProtocol.h" 31 #include "lldb/Target/MemoryRegionInfo.h" 32 #include "lldb/Utility/Args.h" 33 #include "lldb/Utility/DataBuffer.h" 34 #include "lldb/Utility/Endian.h" 35 #include "lldb/Utility/JSON.h" 36 #include "lldb/Utility/LLDBAssert.h" 37 #include "lldb/Utility/Log.h" 38 #include "lldb/Utility/RegisterValue.h" 39 #include "lldb/Utility/State.h" 40 #include "lldb/Utility/StreamString.h" 41 #include "lldb/Utility/UriParser.h" 42 #include "llvm/ADT/Triple.h" 43 #include "llvm/Support/ScopedPrinter.h" 44 45 #include "ProcessGDBRemote.h" 46 #include "ProcessGDBRemoteLog.h" 47 #include "lldb/Utility/StringExtractorGDBRemote.h" 48 49 using namespace lldb; 50 using namespace lldb_private; 51 using namespace lldb_private::process_gdb_remote; 52 using namespace llvm; 53 54 // GDBRemote Errors 55 56 namespace { 57 enum GDBRemoteServerError { 58 // Set to the first unused error number in literal form below 59 eErrorFirst = 29, 60 eErrorNoProcess = eErrorFirst, 61 eErrorResume, 62 eErrorExitStatus 63 }; 64 } 65 66 // GDBRemoteCommunicationServerLLGS constructor 67 GDBRemoteCommunicationServerLLGS::GDBRemoteCommunicationServerLLGS( 68 MainLoop &mainloop, const NativeProcessProtocol::Factory &process_factory) 69 : GDBRemoteCommunicationServerCommon("gdb-remote.server", 70 "gdb-remote.server.rx_packet"), 71 m_mainloop(mainloop), m_process_factory(process_factory), 72 m_stdio_communication("process.stdio") { 73 RegisterPacketHandlers(); 74 } 75 76 void GDBRemoteCommunicationServerLLGS::RegisterPacketHandlers() { 77 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_C, 78 &GDBRemoteCommunicationServerLLGS::Handle_C); 79 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_c, 80 &GDBRemoteCommunicationServerLLGS::Handle_c); 81 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_D, 82 &GDBRemoteCommunicationServerLLGS::Handle_D); 83 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_H, 84 &GDBRemoteCommunicationServerLLGS::Handle_H); 85 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_I, 86 &GDBRemoteCommunicationServerLLGS::Handle_I); 87 RegisterMemberFunctionHandler( 88 StringExtractorGDBRemote::eServerPacketType_interrupt, 89 &GDBRemoteCommunicationServerLLGS::Handle_interrupt); 90 RegisterMemberFunctionHandler( 91 StringExtractorGDBRemote::eServerPacketType_m, 92 &GDBRemoteCommunicationServerLLGS::Handle_memory_read); 93 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_M, 94 &GDBRemoteCommunicationServerLLGS::Handle_M); 95 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_p, 96 &GDBRemoteCommunicationServerLLGS::Handle_p); 97 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_P, 98 &GDBRemoteCommunicationServerLLGS::Handle_P); 99 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_qC, 100 &GDBRemoteCommunicationServerLLGS::Handle_qC); 101 RegisterMemberFunctionHandler( 102 StringExtractorGDBRemote::eServerPacketType_qfThreadInfo, 103 &GDBRemoteCommunicationServerLLGS::Handle_qfThreadInfo); 104 RegisterMemberFunctionHandler( 105 StringExtractorGDBRemote::eServerPacketType_qFileLoadAddress, 106 &GDBRemoteCommunicationServerLLGS::Handle_qFileLoadAddress); 107 RegisterMemberFunctionHandler( 108 StringExtractorGDBRemote::eServerPacketType_qGetWorkingDir, 109 &GDBRemoteCommunicationServerLLGS::Handle_qGetWorkingDir); 110 RegisterMemberFunctionHandler( 111 StringExtractorGDBRemote::eServerPacketType_qMemoryRegionInfo, 112 &GDBRemoteCommunicationServerLLGS::Handle_qMemoryRegionInfo); 113 RegisterMemberFunctionHandler( 114 StringExtractorGDBRemote::eServerPacketType_qMemoryRegionInfoSupported, 115 &GDBRemoteCommunicationServerLLGS::Handle_qMemoryRegionInfoSupported); 116 RegisterMemberFunctionHandler( 117 StringExtractorGDBRemote::eServerPacketType_qProcessInfo, 118 &GDBRemoteCommunicationServerLLGS::Handle_qProcessInfo); 119 RegisterMemberFunctionHandler( 120 StringExtractorGDBRemote::eServerPacketType_qRegisterInfo, 121 &GDBRemoteCommunicationServerLLGS::Handle_qRegisterInfo); 122 RegisterMemberFunctionHandler( 123 StringExtractorGDBRemote::eServerPacketType_QRestoreRegisterState, 124 &GDBRemoteCommunicationServerLLGS::Handle_QRestoreRegisterState); 125 RegisterMemberFunctionHandler( 126 StringExtractorGDBRemote::eServerPacketType_QSaveRegisterState, 127 &GDBRemoteCommunicationServerLLGS::Handle_QSaveRegisterState); 128 RegisterMemberFunctionHandler( 129 StringExtractorGDBRemote::eServerPacketType_QSetDisableASLR, 130 &GDBRemoteCommunicationServerLLGS::Handle_QSetDisableASLR); 131 RegisterMemberFunctionHandler( 132 StringExtractorGDBRemote::eServerPacketType_QSetWorkingDir, 133 &GDBRemoteCommunicationServerLLGS::Handle_QSetWorkingDir); 134 RegisterMemberFunctionHandler( 135 StringExtractorGDBRemote::eServerPacketType_qsThreadInfo, 136 &GDBRemoteCommunicationServerLLGS::Handle_qsThreadInfo); 137 RegisterMemberFunctionHandler( 138 StringExtractorGDBRemote::eServerPacketType_qThreadStopInfo, 139 &GDBRemoteCommunicationServerLLGS::Handle_qThreadStopInfo); 140 RegisterMemberFunctionHandler( 141 StringExtractorGDBRemote::eServerPacketType_jThreadsInfo, 142 &GDBRemoteCommunicationServerLLGS::Handle_jThreadsInfo); 143 RegisterMemberFunctionHandler( 144 StringExtractorGDBRemote::eServerPacketType_qWatchpointSupportInfo, 145 &GDBRemoteCommunicationServerLLGS::Handle_qWatchpointSupportInfo); 146 RegisterMemberFunctionHandler( 147 StringExtractorGDBRemote::eServerPacketType_qXfer, 148 &GDBRemoteCommunicationServerLLGS::Handle_qXfer); 149 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_s, 150 &GDBRemoteCommunicationServerLLGS::Handle_s); 151 RegisterMemberFunctionHandler( 152 StringExtractorGDBRemote::eServerPacketType_stop_reason, 153 &GDBRemoteCommunicationServerLLGS::Handle_stop_reason); // ? 154 RegisterMemberFunctionHandler( 155 StringExtractorGDBRemote::eServerPacketType_vAttach, 156 &GDBRemoteCommunicationServerLLGS::Handle_vAttach); 157 RegisterMemberFunctionHandler( 158 StringExtractorGDBRemote::eServerPacketType_vCont, 159 &GDBRemoteCommunicationServerLLGS::Handle_vCont); 160 RegisterMemberFunctionHandler( 161 StringExtractorGDBRemote::eServerPacketType_vCont_actions, 162 &GDBRemoteCommunicationServerLLGS::Handle_vCont_actions); 163 RegisterMemberFunctionHandler( 164 StringExtractorGDBRemote::eServerPacketType_x, 165 &GDBRemoteCommunicationServerLLGS::Handle_memory_read); 166 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_Z, 167 &GDBRemoteCommunicationServerLLGS::Handle_Z); 168 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_z, 169 &GDBRemoteCommunicationServerLLGS::Handle_z); 170 RegisterMemberFunctionHandler( 171 StringExtractorGDBRemote::eServerPacketType_QPassSignals, 172 &GDBRemoteCommunicationServerLLGS::Handle_QPassSignals); 173 174 RegisterMemberFunctionHandler( 175 StringExtractorGDBRemote::eServerPacketType_jTraceStart, 176 &GDBRemoteCommunicationServerLLGS::Handle_jTraceStart); 177 RegisterMemberFunctionHandler( 178 StringExtractorGDBRemote::eServerPacketType_jTraceBufferRead, 179 &GDBRemoteCommunicationServerLLGS::Handle_jTraceRead); 180 RegisterMemberFunctionHandler( 181 StringExtractorGDBRemote::eServerPacketType_jTraceMetaRead, 182 &GDBRemoteCommunicationServerLLGS::Handle_jTraceRead); 183 RegisterMemberFunctionHandler( 184 StringExtractorGDBRemote::eServerPacketType_jTraceStop, 185 &GDBRemoteCommunicationServerLLGS::Handle_jTraceStop); 186 RegisterMemberFunctionHandler( 187 StringExtractorGDBRemote::eServerPacketType_jTraceConfigRead, 188 &GDBRemoteCommunicationServerLLGS::Handle_jTraceConfigRead); 189 190 RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_g, 191 &GDBRemoteCommunicationServerLLGS::Handle_g); 192 193 RegisterPacketHandler(StringExtractorGDBRemote::eServerPacketType_k, 194 [this](StringExtractorGDBRemote packet, Status &error, 195 bool &interrupt, bool &quit) { 196 quit = true; 197 return this->Handle_k(packet); 198 }); 199 } 200 201 void GDBRemoteCommunicationServerLLGS::SetLaunchInfo(const ProcessLaunchInfo &info) { 202 m_process_launch_info = info; 203 } 204 205 Status GDBRemoteCommunicationServerLLGS::LaunchProcess() { 206 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 207 208 if (!m_process_launch_info.GetArguments().GetArgumentCount()) 209 return Status("%s: no process command line specified to launch", 210 __FUNCTION__); 211 212 const bool should_forward_stdio = 213 m_process_launch_info.GetFileActionForFD(STDIN_FILENO) == nullptr || 214 m_process_launch_info.GetFileActionForFD(STDOUT_FILENO) == nullptr || 215 m_process_launch_info.GetFileActionForFD(STDERR_FILENO) == nullptr; 216 m_process_launch_info.SetLaunchInSeparateProcessGroup(true); 217 m_process_launch_info.GetFlags().Set(eLaunchFlagDebug); 218 219 if (should_forward_stdio) { 220 // Temporarily relax the following for Windows until we can take advantage 221 // of the recently added pty support. This doesn't really affect the use of 222 // lldb-server on Windows. 223 #if !defined(_WIN32) 224 if (llvm::Error Err = m_process_launch_info.SetUpPtyRedirection()) 225 return Status(std::move(Err)); 226 #endif 227 } 228 229 { 230 std::lock_guard<std::recursive_mutex> guard(m_debugged_process_mutex); 231 assert(!m_debugged_process_up && "lldb-server creating debugged " 232 "process but one already exists"); 233 auto process_or = 234 m_process_factory.Launch(m_process_launch_info, *this, m_mainloop); 235 if (!process_or) 236 return Status(process_or.takeError()); 237 m_debugged_process_up = std::move(*process_or); 238 } 239 240 // Handle mirroring of inferior stdout/stderr over the gdb-remote protocol as 241 // needed. llgs local-process debugging may specify PTY paths, which will 242 // make these file actions non-null process launch -i/e/o will also make 243 // these file actions non-null nullptr means that the traffic is expected to 244 // flow over gdb-remote protocol 245 if (should_forward_stdio) { 246 // nullptr means it's not redirected to file or pty (in case of LLGS local) 247 // at least one of stdio will be transferred pty<->gdb-remote we need to 248 // give the pty master handle to this object to read and/or write 249 LLDB_LOG(log, 250 "pid = {0}: setting up stdout/stderr redirection via $O " 251 "gdb-remote commands", 252 m_debugged_process_up->GetID()); 253 254 // Setup stdout/stderr mapping from inferior to $O 255 auto terminal_fd = m_debugged_process_up->GetTerminalFileDescriptor(); 256 if (terminal_fd >= 0) { 257 LLDB_LOGF(log, 258 "ProcessGDBRemoteCommunicationServerLLGS::%s setting " 259 "inferior STDIO fd to %d", 260 __FUNCTION__, terminal_fd); 261 Status status = SetSTDIOFileDescriptor(terminal_fd); 262 if (status.Fail()) 263 return status; 264 } else { 265 LLDB_LOGF(log, 266 "ProcessGDBRemoteCommunicationServerLLGS::%s ignoring " 267 "inferior STDIO since terminal fd reported as %d", 268 __FUNCTION__, terminal_fd); 269 } 270 } else { 271 LLDB_LOG(log, 272 "pid = {0} skipping stdout/stderr redirection via $O: inferior " 273 "will communicate over client-provided file descriptors", 274 m_debugged_process_up->GetID()); 275 } 276 277 printf("Launched '%s' as process %" PRIu64 "...\n", 278 m_process_launch_info.GetArguments().GetArgumentAtIndex(0), 279 m_debugged_process_up->GetID()); 280 281 return Status(); 282 } 283 284 Status GDBRemoteCommunicationServerLLGS::AttachToProcess(lldb::pid_t pid) { 285 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 286 LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s pid %" PRIu64, 287 __FUNCTION__, pid); 288 289 // Before we try to attach, make sure we aren't already monitoring something 290 // else. 291 if (m_debugged_process_up && 292 m_debugged_process_up->GetID() != LLDB_INVALID_PROCESS_ID) 293 return Status("cannot attach to process %" PRIu64 294 " when another process with pid %" PRIu64 295 " is being debugged.", 296 pid, m_debugged_process_up->GetID()); 297 298 // Try to attach. 299 auto process_or = m_process_factory.Attach(pid, *this, m_mainloop); 300 if (!process_or) { 301 Status status(process_or.takeError()); 302 llvm::errs() << llvm::formatv("failed to attach to process {0}: {1}", pid, 303 status); 304 return status; 305 } 306 m_debugged_process_up = std::move(*process_or); 307 308 // Setup stdout/stderr mapping from inferior. 309 auto terminal_fd = m_debugged_process_up->GetTerminalFileDescriptor(); 310 if (terminal_fd >= 0) { 311 LLDB_LOGF(log, 312 "ProcessGDBRemoteCommunicationServerLLGS::%s setting " 313 "inferior STDIO fd to %d", 314 __FUNCTION__, terminal_fd); 315 Status status = SetSTDIOFileDescriptor(terminal_fd); 316 if (status.Fail()) 317 return status; 318 } else { 319 LLDB_LOGF(log, 320 "ProcessGDBRemoteCommunicationServerLLGS::%s ignoring " 321 "inferior STDIO since terminal fd reported as %d", 322 __FUNCTION__, terminal_fd); 323 } 324 325 printf("Attached to process %" PRIu64 "...\n", pid); 326 return Status(); 327 } 328 329 void GDBRemoteCommunicationServerLLGS::InitializeDelegate( 330 NativeProcessProtocol *process) { 331 assert(process && "process cannot be NULL"); 332 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 333 if (log) { 334 LLDB_LOGF(log, 335 "GDBRemoteCommunicationServerLLGS::%s called with " 336 "NativeProcessProtocol pid %" PRIu64 ", current state: %s", 337 __FUNCTION__, process->GetID(), 338 StateAsCString(process->GetState())); 339 } 340 } 341 342 GDBRemoteCommunication::PacketResult 343 GDBRemoteCommunicationServerLLGS::SendWResponse( 344 NativeProcessProtocol *process) { 345 assert(process && "process cannot be NULL"); 346 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 347 348 // send W notification 349 auto wait_status = process->GetExitStatus(); 350 if (!wait_status) { 351 LLDB_LOG(log, "pid = {0}, failed to retrieve process exit status", 352 process->GetID()); 353 354 StreamGDBRemote response; 355 response.PutChar('E'); 356 response.PutHex8(GDBRemoteServerError::eErrorExitStatus); 357 return SendPacketNoLock(response.GetString()); 358 } 359 360 LLDB_LOG(log, "pid = {0}, returning exit type {1}", process->GetID(), 361 *wait_status); 362 363 StreamGDBRemote response; 364 response.Format("{0:g}", *wait_status); 365 return SendPacketNoLock(response.GetString()); 366 } 367 368 static void AppendHexValue(StreamString &response, const uint8_t *buf, 369 uint32_t buf_size, bool swap) { 370 int64_t i; 371 if (swap) { 372 for (i = buf_size - 1; i >= 0; i--) 373 response.PutHex8(buf[i]); 374 } else { 375 for (i = 0; i < buf_size; i++) 376 response.PutHex8(buf[i]); 377 } 378 } 379 380 static void WriteRegisterValueInHexFixedWidth( 381 StreamString &response, NativeRegisterContext ®_ctx, 382 const RegisterInfo ®_info, const RegisterValue *reg_value_p, 383 lldb::ByteOrder byte_order) { 384 RegisterValue reg_value; 385 if (!reg_value_p) { 386 Status error = reg_ctx.ReadRegister(®_info, reg_value); 387 if (error.Success()) 388 reg_value_p = ®_value; 389 // else log. 390 } 391 392 if (reg_value_p) { 393 AppendHexValue(response, (const uint8_t *)reg_value_p->GetBytes(), 394 reg_value_p->GetByteSize(), 395 byte_order == lldb::eByteOrderLittle); 396 } else { 397 // Zero-out any unreadable values. 398 if (reg_info.byte_size > 0) { 399 std::basic_string<uint8_t> zeros(reg_info.byte_size, '\0'); 400 AppendHexValue(response, zeros.data(), zeros.size(), false); 401 } 402 } 403 } 404 405 static JSONObject::SP GetRegistersAsJSON(NativeThreadProtocol &thread) { 406 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 407 408 NativeRegisterContext& reg_ctx = thread.GetRegisterContext(); 409 410 JSONObject::SP register_object_sp = std::make_shared<JSONObject>(); 411 412 #ifdef LLDB_JTHREADSINFO_FULL_REGISTER_SET 413 // Expedite all registers in the first register set (i.e. should be GPRs) 414 // that are not contained in other registers. 415 const RegisterSet *reg_set_p = reg_ctx_sp->GetRegisterSet(0); 416 if (!reg_set_p) 417 return nullptr; 418 for (const uint32_t *reg_num_p = reg_set_p->registers; 419 *reg_num_p != LLDB_INVALID_REGNUM; ++reg_num_p) { 420 uint32_t reg_num = *reg_num_p; 421 #else 422 // Expedite only a couple of registers until we figure out why sending 423 // registers is expensive. 424 static const uint32_t k_expedited_registers[] = { 425 LLDB_REGNUM_GENERIC_PC, LLDB_REGNUM_GENERIC_SP, LLDB_REGNUM_GENERIC_FP, 426 LLDB_REGNUM_GENERIC_RA, LLDB_INVALID_REGNUM}; 427 428 for (const uint32_t *generic_reg_p = k_expedited_registers; 429 *generic_reg_p != LLDB_INVALID_REGNUM; ++generic_reg_p) { 430 uint32_t reg_num = reg_ctx.ConvertRegisterKindToRegisterNumber( 431 eRegisterKindGeneric, *generic_reg_p); 432 if (reg_num == LLDB_INVALID_REGNUM) 433 continue; // Target does not support the given register. 434 #endif 435 436 const RegisterInfo *const reg_info_p = 437 reg_ctx.GetRegisterInfoAtIndex(reg_num); 438 if (reg_info_p == nullptr) { 439 LLDB_LOGF(log, 440 "%s failed to get register info for register index %" PRIu32, 441 __FUNCTION__, reg_num); 442 continue; 443 } 444 445 if (reg_info_p->value_regs != nullptr) 446 continue; // Only expedite registers that are not contained in other 447 // registers. 448 449 RegisterValue reg_value; 450 Status error = reg_ctx.ReadRegister(reg_info_p, reg_value); 451 if (error.Fail()) { 452 LLDB_LOGF(log, "%s failed to read register '%s' index %" PRIu32 ": %s", 453 __FUNCTION__, 454 reg_info_p->name ? reg_info_p->name : "<unnamed-register>", 455 reg_num, error.AsCString()); 456 continue; 457 } 458 459 StreamString stream; 460 WriteRegisterValueInHexFixedWidth(stream, reg_ctx, *reg_info_p, 461 ®_value, lldb::eByteOrderBig); 462 463 register_object_sp->SetObject( 464 llvm::to_string(reg_num), 465 std::make_shared<JSONString>(stream.GetString())); 466 } 467 468 return register_object_sp; 469 } 470 471 static const char *GetStopReasonString(StopReason stop_reason) { 472 switch (stop_reason) { 473 case eStopReasonTrace: 474 return "trace"; 475 case eStopReasonBreakpoint: 476 return "breakpoint"; 477 case eStopReasonWatchpoint: 478 return "watchpoint"; 479 case eStopReasonSignal: 480 return "signal"; 481 case eStopReasonException: 482 return "exception"; 483 case eStopReasonExec: 484 return "exec"; 485 case eStopReasonInstrumentation: 486 case eStopReasonInvalid: 487 case eStopReasonPlanComplete: 488 case eStopReasonThreadExiting: 489 case eStopReasonNone: 490 break; // ignored 491 } 492 return nullptr; 493 } 494 495 static JSONArray::SP GetJSONThreadsInfo(NativeProcessProtocol &process, 496 bool abridged) { 497 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_THREAD)); 498 499 JSONArray::SP threads_array_sp = std::make_shared<JSONArray>(); 500 501 // Ensure we can get info on the given thread. 502 uint32_t thread_idx = 0; 503 for (NativeThreadProtocol *thread; 504 (thread = process.GetThreadAtIndex(thread_idx)) != nullptr; 505 ++thread_idx) { 506 507 lldb::tid_t tid = thread->GetID(); 508 509 // Grab the reason this thread stopped. 510 struct ThreadStopInfo tid_stop_info; 511 std::string description; 512 if (!thread->GetStopReason(tid_stop_info, description)) 513 return nullptr; 514 515 const int signum = tid_stop_info.details.signal.signo; 516 if (log) { 517 LLDB_LOGF(log, 518 "GDBRemoteCommunicationServerLLGS::%s pid %" PRIu64 519 " tid %" PRIu64 520 " got signal signo = %d, reason = %d, exc_type = %" PRIu64, 521 __FUNCTION__, process.GetID(), tid, signum, 522 tid_stop_info.reason, tid_stop_info.details.exception.type); 523 } 524 525 JSONObject::SP thread_obj_sp = std::make_shared<JSONObject>(); 526 threads_array_sp->AppendObject(thread_obj_sp); 527 528 if (!abridged) { 529 if (JSONObject::SP registers_sp = GetRegistersAsJSON(*thread)) 530 thread_obj_sp->SetObject("registers", registers_sp); 531 } 532 533 thread_obj_sp->SetObject("tid", std::make_shared<JSONNumber>(tid)); 534 if (signum != 0) 535 thread_obj_sp->SetObject("signal", std::make_shared<JSONNumber>(signum)); 536 537 const std::string thread_name = thread->GetName(); 538 if (!thread_name.empty()) 539 thread_obj_sp->SetObject("name", 540 std::make_shared<JSONString>(thread_name)); 541 542 if (const char *stop_reason_str = GetStopReasonString(tid_stop_info.reason)) 543 thread_obj_sp->SetObject("reason", 544 std::make_shared<JSONString>(stop_reason_str)); 545 546 if (!description.empty()) 547 thread_obj_sp->SetObject("description", 548 std::make_shared<JSONString>(description)); 549 550 if ((tid_stop_info.reason == eStopReasonException) && 551 tid_stop_info.details.exception.type) { 552 thread_obj_sp->SetObject( 553 "metype", 554 std::make_shared<JSONNumber>(tid_stop_info.details.exception.type)); 555 556 JSONArray::SP medata_array_sp = std::make_shared<JSONArray>(); 557 for (uint32_t i = 0; i < tid_stop_info.details.exception.data_count; 558 ++i) { 559 medata_array_sp->AppendObject(std::make_shared<JSONNumber>( 560 tid_stop_info.details.exception.data[i])); 561 } 562 thread_obj_sp->SetObject("medata", medata_array_sp); 563 } 564 565 // TODO: Expedite interesting regions of inferior memory 566 } 567 568 return threads_array_sp; 569 } 570 571 GDBRemoteCommunication::PacketResult 572 GDBRemoteCommunicationServerLLGS::SendStopReplyPacketForThread( 573 lldb::tid_t tid) { 574 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_THREAD)); 575 576 // Ensure we have a debugged process. 577 if (!m_debugged_process_up || 578 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) 579 return SendErrorResponse(50); 580 581 LLDB_LOG(log, "preparing packet for pid {0} tid {1}", 582 m_debugged_process_up->GetID(), tid); 583 584 // Ensure we can get info on the given thread. 585 NativeThreadProtocol *thread = m_debugged_process_up->GetThreadByID(tid); 586 if (!thread) 587 return SendErrorResponse(51); 588 589 // Grab the reason this thread stopped. 590 struct ThreadStopInfo tid_stop_info; 591 std::string description; 592 if (!thread->GetStopReason(tid_stop_info, description)) 593 return SendErrorResponse(52); 594 595 // FIXME implement register handling for exec'd inferiors. 596 // if (tid_stop_info.reason == eStopReasonExec) { 597 // const bool force = true; 598 // InitializeRegisters(force); 599 // } 600 601 StreamString response; 602 // Output the T packet with the thread 603 response.PutChar('T'); 604 int signum = tid_stop_info.details.signal.signo; 605 LLDB_LOG( 606 log, 607 "pid {0}, tid {1}, got signal signo = {2}, reason = {3}, exc_type = {4}", 608 m_debugged_process_up->GetID(), tid, signum, int(tid_stop_info.reason), 609 tid_stop_info.details.exception.type); 610 611 // Print the signal number. 612 response.PutHex8(signum & 0xff); 613 614 // Include the tid. 615 response.Printf("thread:%" PRIx64 ";", tid); 616 617 // Include the thread name if there is one. 618 const std::string thread_name = thread->GetName(); 619 if (!thread_name.empty()) { 620 size_t thread_name_len = thread_name.length(); 621 622 if (::strcspn(thread_name.c_str(), "$#+-;:") == thread_name_len) { 623 response.PutCString("name:"); 624 response.PutCString(thread_name); 625 } else { 626 // The thread name contains special chars, send as hex bytes. 627 response.PutCString("hexname:"); 628 response.PutStringAsRawHex8(thread_name); 629 } 630 response.PutChar(';'); 631 } 632 633 // If a 'QListThreadsInStopReply' was sent to enable this feature, we will 634 // send all thread IDs back in the "threads" key whose value is a list of hex 635 // thread IDs separated by commas: 636 // "threads:10a,10b,10c;" 637 // This will save the debugger from having to send a pair of qfThreadInfo and 638 // qsThreadInfo packets, but it also might take a lot of room in the stop 639 // reply packet, so it must be enabled only on systems where there are no 640 // limits on packet lengths. 641 if (m_list_threads_in_stop_reply) { 642 response.PutCString("threads:"); 643 644 uint32_t thread_index = 0; 645 NativeThreadProtocol *listed_thread; 646 for (listed_thread = m_debugged_process_up->GetThreadAtIndex(thread_index); 647 listed_thread; ++thread_index, 648 listed_thread = m_debugged_process_up->GetThreadAtIndex(thread_index)) { 649 if (thread_index > 0) 650 response.PutChar(','); 651 response.Printf("%" PRIx64, listed_thread->GetID()); 652 } 653 response.PutChar(';'); 654 655 // Include JSON info that describes the stop reason for any threads that 656 // actually have stop reasons. We use the new "jstopinfo" key whose values 657 // is hex ascii JSON that contains the thread IDs thread stop info only for 658 // threads that have stop reasons. Only send this if we have more than one 659 // thread otherwise this packet has all the info it needs. 660 if (thread_index > 0) { 661 const bool threads_with_valid_stop_info_only = true; 662 JSONArray::SP threads_info_sp = GetJSONThreadsInfo( 663 *m_debugged_process_up, threads_with_valid_stop_info_only); 664 if (threads_info_sp) { 665 response.PutCString("jstopinfo:"); 666 StreamString unescaped_response; 667 threads_info_sp->Write(unescaped_response); 668 response.PutStringAsRawHex8(unescaped_response.GetData()); 669 response.PutChar(';'); 670 } else 671 LLDB_LOG(log, "failed to prepare a jstopinfo field for pid {0}", 672 m_debugged_process_up->GetID()); 673 } 674 675 uint32_t i = 0; 676 response.PutCString("thread-pcs"); 677 char delimiter = ':'; 678 for (NativeThreadProtocol *thread; 679 (thread = m_debugged_process_up->GetThreadAtIndex(i)) != nullptr; 680 ++i) { 681 NativeRegisterContext& reg_ctx = thread->GetRegisterContext(); 682 683 uint32_t reg_to_read = reg_ctx.ConvertRegisterKindToRegisterNumber( 684 eRegisterKindGeneric, LLDB_REGNUM_GENERIC_PC); 685 const RegisterInfo *const reg_info_p = 686 reg_ctx.GetRegisterInfoAtIndex(reg_to_read); 687 688 RegisterValue reg_value; 689 Status error = reg_ctx.ReadRegister(reg_info_p, reg_value); 690 if (error.Fail()) { 691 LLDB_LOGF(log, "%s failed to read register '%s' index %" PRIu32 ": %s", 692 __FUNCTION__, 693 reg_info_p->name ? reg_info_p->name : "<unnamed-register>", 694 reg_to_read, error.AsCString()); 695 continue; 696 } 697 698 response.PutChar(delimiter); 699 delimiter = ','; 700 WriteRegisterValueInHexFixedWidth(response, reg_ctx, *reg_info_p, 701 ®_value, endian::InlHostByteOrder()); 702 } 703 704 response.PutChar(';'); 705 } 706 707 // 708 // Expedite registers. 709 // 710 711 // Grab the register context. 712 NativeRegisterContext& reg_ctx = thread->GetRegisterContext(); 713 // Expedite all registers in the first register set (i.e. should be GPRs) 714 // that are not contained in other registers. 715 const RegisterSet *reg_set_p; 716 if (reg_ctx.GetRegisterSetCount() > 0 && 717 ((reg_set_p = reg_ctx.GetRegisterSet(0)) != nullptr)) { 718 LLDB_LOGF(log, 719 "GDBRemoteCommunicationServerLLGS::%s expediting registers " 720 "from set '%s' (registers set count: %zu)", 721 __FUNCTION__, reg_set_p->name ? reg_set_p->name : "<unnamed-set>", 722 reg_set_p->num_registers); 723 724 for (const uint32_t *reg_num_p = reg_set_p->registers; 725 *reg_num_p != LLDB_INVALID_REGNUM; ++reg_num_p) { 726 const RegisterInfo *const reg_info_p = 727 reg_ctx.GetRegisterInfoAtIndex(*reg_num_p); 728 if (reg_info_p == nullptr) { 729 LLDB_LOGF(log, 730 "GDBRemoteCommunicationServerLLGS::%s failed to get " 731 "register info for register set '%s', register index " 732 "%" PRIu32, 733 __FUNCTION__, 734 reg_set_p->name ? reg_set_p->name : "<unnamed-set>", 735 *reg_num_p); 736 } else if (reg_info_p->value_regs == nullptr) { 737 // Only expediate registers that are not contained in other registers. 738 RegisterValue reg_value; 739 Status error = reg_ctx.ReadRegister(reg_info_p, reg_value); 740 if (error.Success()) { 741 response.Printf("%.02x:", *reg_num_p); 742 WriteRegisterValueInHexFixedWidth(response, reg_ctx, *reg_info_p, 743 ®_value, lldb::eByteOrderBig); 744 response.PutChar(';'); 745 } else { 746 LLDB_LOGF(log, 747 "GDBRemoteCommunicationServerLLGS::%s failed to read " 748 "register '%s' index %" PRIu32 ": %s", 749 __FUNCTION__, 750 reg_info_p->name ? reg_info_p->name : "<unnamed-register>", 751 *reg_num_p, error.AsCString()); 752 } 753 } 754 } 755 } 756 757 const char *reason_str = GetStopReasonString(tid_stop_info.reason); 758 if (reason_str != nullptr) { 759 response.Printf("reason:%s;", reason_str); 760 } 761 762 if (!description.empty()) { 763 // Description may contains special chars, send as hex bytes. 764 response.PutCString("description:"); 765 response.PutStringAsRawHex8(description); 766 response.PutChar(';'); 767 } else if ((tid_stop_info.reason == eStopReasonException) && 768 tid_stop_info.details.exception.type) { 769 response.PutCString("metype:"); 770 response.PutHex64(tid_stop_info.details.exception.type); 771 response.PutCString(";mecount:"); 772 response.PutHex32(tid_stop_info.details.exception.data_count); 773 response.PutChar(';'); 774 775 for (uint32_t i = 0; i < tid_stop_info.details.exception.data_count; ++i) { 776 response.PutCString("medata:"); 777 response.PutHex64(tid_stop_info.details.exception.data[i]); 778 response.PutChar(';'); 779 } 780 } 781 782 return SendPacketNoLock(response.GetString()); 783 } 784 785 void GDBRemoteCommunicationServerLLGS::HandleInferiorState_Exited( 786 NativeProcessProtocol *process) { 787 assert(process && "process cannot be NULL"); 788 789 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 790 LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s called", __FUNCTION__); 791 792 PacketResult result = SendStopReasonForState(StateType::eStateExited); 793 if (result != PacketResult::Success) { 794 LLDB_LOGF(log, 795 "GDBRemoteCommunicationServerLLGS::%s failed to send stop " 796 "notification for PID %" PRIu64 ", state: eStateExited", 797 __FUNCTION__, process->GetID()); 798 } 799 800 // Close the pipe to the inferior terminal i/o if we launched it and set one 801 // up. 802 MaybeCloseInferiorTerminalConnection(); 803 804 // We are ready to exit the debug monitor. 805 m_exit_now = true; 806 m_mainloop.RequestTermination(); 807 } 808 809 void GDBRemoteCommunicationServerLLGS::HandleInferiorState_Stopped( 810 NativeProcessProtocol *process) { 811 assert(process && "process cannot be NULL"); 812 813 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 814 LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s called", __FUNCTION__); 815 816 // Send the stop reason unless this is the stop after the launch or attach. 817 switch (m_inferior_prev_state) { 818 case eStateLaunching: 819 case eStateAttaching: 820 // Don't send anything per debugserver behavior. 821 break; 822 default: 823 // In all other cases, send the stop reason. 824 PacketResult result = SendStopReasonForState(StateType::eStateStopped); 825 if (result != PacketResult::Success) { 826 LLDB_LOGF(log, 827 "GDBRemoteCommunicationServerLLGS::%s failed to send stop " 828 "notification for PID %" PRIu64 ", state: eStateExited", 829 __FUNCTION__, process->GetID()); 830 } 831 break; 832 } 833 } 834 835 void GDBRemoteCommunicationServerLLGS::ProcessStateChanged( 836 NativeProcessProtocol *process, lldb::StateType state) { 837 assert(process && "process cannot be NULL"); 838 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 839 if (log) { 840 LLDB_LOGF(log, 841 "GDBRemoteCommunicationServerLLGS::%s called with " 842 "NativeProcessProtocol pid %" PRIu64 ", state: %s", 843 __FUNCTION__, process->GetID(), StateAsCString(state)); 844 } 845 846 switch (state) { 847 case StateType::eStateRunning: 848 StartSTDIOForwarding(); 849 break; 850 851 case StateType::eStateStopped: 852 // Make sure we get all of the pending stdout/stderr from the inferior and 853 // send it to the lldb host before we send the state change notification 854 SendProcessOutput(); 855 // Then stop the forwarding, so that any late output (see llvm.org/pr25652) 856 // does not interfere with our protocol. 857 StopSTDIOForwarding(); 858 HandleInferiorState_Stopped(process); 859 break; 860 861 case StateType::eStateExited: 862 // Same as above 863 SendProcessOutput(); 864 StopSTDIOForwarding(); 865 HandleInferiorState_Exited(process); 866 break; 867 868 default: 869 if (log) { 870 LLDB_LOGF(log, 871 "GDBRemoteCommunicationServerLLGS::%s didn't handle state " 872 "change for pid %" PRIu64 ", new state: %s", 873 __FUNCTION__, process->GetID(), StateAsCString(state)); 874 } 875 break; 876 } 877 878 // Remember the previous state reported to us. 879 m_inferior_prev_state = state; 880 } 881 882 void GDBRemoteCommunicationServerLLGS::DidExec(NativeProcessProtocol *process) { 883 ClearProcessSpecificData(); 884 } 885 886 void GDBRemoteCommunicationServerLLGS::DataAvailableCallback() { 887 Log *log(GetLogIfAnyCategoriesSet(GDBR_LOG_COMM)); 888 889 if (!m_handshake_completed) { 890 if (!HandshakeWithClient()) { 891 LLDB_LOGF(log, 892 "GDBRemoteCommunicationServerLLGS::%s handshake with " 893 "client failed, exiting", 894 __FUNCTION__); 895 m_mainloop.RequestTermination(); 896 return; 897 } 898 m_handshake_completed = true; 899 } 900 901 bool interrupt = false; 902 bool done = false; 903 Status error; 904 while (true) { 905 const PacketResult result = GetPacketAndSendResponse( 906 std::chrono::microseconds(0), error, interrupt, done); 907 if (result == PacketResult::ErrorReplyTimeout) 908 break; // No more packets in the queue 909 910 if ((result != PacketResult::Success)) { 911 LLDB_LOGF(log, 912 "GDBRemoteCommunicationServerLLGS::%s processing a packet " 913 "failed: %s", 914 __FUNCTION__, error.AsCString()); 915 m_mainloop.RequestTermination(); 916 break; 917 } 918 } 919 } 920 921 Status GDBRemoteCommunicationServerLLGS::InitializeConnection( 922 std::unique_ptr<Connection> &&connection) { 923 IOObjectSP read_object_sp = connection->GetReadObject(); 924 GDBRemoteCommunicationServer::SetConnection(connection.release()); 925 926 Status error; 927 m_network_handle_up = m_mainloop.RegisterReadObject( 928 read_object_sp, [this](MainLoopBase &) { DataAvailableCallback(); }, 929 error); 930 return error; 931 } 932 933 GDBRemoteCommunication::PacketResult 934 GDBRemoteCommunicationServerLLGS::SendONotification(const char *buffer, 935 uint32_t len) { 936 if ((buffer == nullptr) || (len == 0)) { 937 // Nothing to send. 938 return PacketResult::Success; 939 } 940 941 StreamString response; 942 response.PutChar('O'); 943 response.PutBytesAsRawHex8(buffer, len); 944 945 return SendPacketNoLock(response.GetString()); 946 } 947 948 Status GDBRemoteCommunicationServerLLGS::SetSTDIOFileDescriptor(int fd) { 949 Status error; 950 951 // Set up the reading/handling of process I/O 952 std::unique_ptr<ConnectionFileDescriptor> conn_up( 953 new ConnectionFileDescriptor(fd, true)); 954 if (!conn_up) { 955 error.SetErrorString("failed to create ConnectionFileDescriptor"); 956 return error; 957 } 958 959 m_stdio_communication.SetCloseOnEOF(false); 960 m_stdio_communication.SetConnection(conn_up.release()); 961 if (!m_stdio_communication.IsConnected()) { 962 error.SetErrorString( 963 "failed to set connection for inferior I/O communication"); 964 return error; 965 } 966 967 return Status(); 968 } 969 970 void GDBRemoteCommunicationServerLLGS::StartSTDIOForwarding() { 971 // Don't forward if not connected (e.g. when attaching). 972 if (!m_stdio_communication.IsConnected()) 973 return; 974 975 Status error; 976 lldbassert(!m_stdio_handle_up); 977 m_stdio_handle_up = m_mainloop.RegisterReadObject( 978 m_stdio_communication.GetConnection()->GetReadObject(), 979 [this](MainLoopBase &) { SendProcessOutput(); }, error); 980 981 if (!m_stdio_handle_up) { 982 // Not much we can do about the failure. Log it and continue without 983 // forwarding. 984 if (Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)) 985 LLDB_LOGF(log, 986 "GDBRemoteCommunicationServerLLGS::%s Failed to set up stdio " 987 "forwarding: %s", 988 __FUNCTION__, error.AsCString()); 989 } 990 } 991 992 void GDBRemoteCommunicationServerLLGS::StopSTDIOForwarding() { 993 m_stdio_handle_up.reset(); 994 } 995 996 void GDBRemoteCommunicationServerLLGS::SendProcessOutput() { 997 char buffer[1024]; 998 ConnectionStatus status; 999 Status error; 1000 while (true) { 1001 size_t bytes_read = m_stdio_communication.Read( 1002 buffer, sizeof buffer, std::chrono::microseconds(0), status, &error); 1003 switch (status) { 1004 case eConnectionStatusSuccess: 1005 SendONotification(buffer, bytes_read); 1006 break; 1007 case eConnectionStatusLostConnection: 1008 case eConnectionStatusEndOfFile: 1009 case eConnectionStatusError: 1010 case eConnectionStatusNoConnection: 1011 if (Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)) 1012 LLDB_LOGF(log, 1013 "GDBRemoteCommunicationServerLLGS::%s Stopping stdio " 1014 "forwarding as communication returned status %d (error: " 1015 "%s)", 1016 __FUNCTION__, status, error.AsCString()); 1017 m_stdio_handle_up.reset(); 1018 return; 1019 1020 case eConnectionStatusInterrupted: 1021 case eConnectionStatusTimedOut: 1022 return; 1023 } 1024 } 1025 } 1026 1027 GDBRemoteCommunication::PacketResult 1028 GDBRemoteCommunicationServerLLGS::Handle_jTraceStart( 1029 StringExtractorGDBRemote &packet) { 1030 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 1031 // Fail if we don't have a current process. 1032 if (!m_debugged_process_up || 1033 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) 1034 return SendErrorResponse(68); 1035 1036 if (!packet.ConsumeFront("jTraceStart:")) 1037 return SendIllFormedResponse(packet, "jTraceStart: Ill formed packet "); 1038 1039 TraceOptions options; 1040 uint64_t type = std::numeric_limits<uint64_t>::max(); 1041 uint64_t buffersize = std::numeric_limits<uint64_t>::max(); 1042 lldb::tid_t tid = LLDB_INVALID_THREAD_ID; 1043 uint64_t metabuffersize = std::numeric_limits<uint64_t>::max(); 1044 1045 auto json_object = StructuredData::ParseJSON(packet.Peek()); 1046 1047 if (!json_object || 1048 json_object->GetType() != lldb::eStructuredDataTypeDictionary) 1049 return SendIllFormedResponse(packet, "jTraceStart: Ill formed packet "); 1050 1051 auto json_dict = json_object->GetAsDictionary(); 1052 1053 json_dict->GetValueForKeyAsInteger("metabuffersize", metabuffersize); 1054 options.setMetaDataBufferSize(metabuffersize); 1055 1056 json_dict->GetValueForKeyAsInteger("buffersize", buffersize); 1057 options.setTraceBufferSize(buffersize); 1058 1059 json_dict->GetValueForKeyAsInteger("type", type); 1060 options.setType(static_cast<lldb::TraceType>(type)); 1061 1062 json_dict->GetValueForKeyAsInteger("threadid", tid); 1063 options.setThreadID(tid); 1064 1065 StructuredData::ObjectSP custom_params_sp = 1066 json_dict->GetValueForKey("params"); 1067 if (custom_params_sp && 1068 custom_params_sp->GetType() != lldb::eStructuredDataTypeDictionary) 1069 return SendIllFormedResponse(packet, "jTraceStart: Ill formed packet "); 1070 1071 options.setTraceParams( 1072 static_pointer_cast<StructuredData::Dictionary>(custom_params_sp)); 1073 1074 if (buffersize == std::numeric_limits<uint64_t>::max() || 1075 type != lldb::TraceType::eTraceTypeProcessorTrace) { 1076 LLDB_LOG(log, "Ill formed packet buffersize = {0} type = {1}", buffersize, 1077 type); 1078 return SendIllFormedResponse(packet, "JTrace:start: Ill formed packet "); 1079 } 1080 1081 Status error; 1082 lldb::user_id_t uid = LLDB_INVALID_UID; 1083 uid = m_debugged_process_up->StartTrace(options, error); 1084 LLDB_LOG(log, "uid is {0} , error is {1}", uid, error.GetError()); 1085 if (error.Fail()) 1086 return SendErrorResponse(error); 1087 1088 StreamGDBRemote response; 1089 response.Printf("%" PRIx64, uid); 1090 return SendPacketNoLock(response.GetString()); 1091 } 1092 1093 GDBRemoteCommunication::PacketResult 1094 GDBRemoteCommunicationServerLLGS::Handle_jTraceStop( 1095 StringExtractorGDBRemote &packet) { 1096 // Fail if we don't have a current process. 1097 if (!m_debugged_process_up || 1098 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) 1099 return SendErrorResponse(68); 1100 1101 if (!packet.ConsumeFront("jTraceStop:")) 1102 return SendIllFormedResponse(packet, "jTraceStop: Ill formed packet "); 1103 1104 lldb::user_id_t uid = LLDB_INVALID_UID; 1105 lldb::tid_t tid = LLDB_INVALID_THREAD_ID; 1106 1107 auto json_object = StructuredData::ParseJSON(packet.Peek()); 1108 1109 if (!json_object || 1110 json_object->GetType() != lldb::eStructuredDataTypeDictionary) 1111 return SendIllFormedResponse(packet, "jTraceStop: Ill formed packet "); 1112 1113 auto json_dict = json_object->GetAsDictionary(); 1114 1115 if (!json_dict->GetValueForKeyAsInteger("traceid", uid)) 1116 return SendIllFormedResponse(packet, "jTraceStop: Ill formed packet "); 1117 1118 json_dict->GetValueForKeyAsInteger("threadid", tid); 1119 1120 Status error = m_debugged_process_up->StopTrace(uid, tid); 1121 1122 if (error.Fail()) 1123 return SendErrorResponse(error); 1124 1125 return SendOKResponse(); 1126 } 1127 1128 GDBRemoteCommunication::PacketResult 1129 GDBRemoteCommunicationServerLLGS::Handle_jTraceConfigRead( 1130 StringExtractorGDBRemote &packet) { 1131 1132 // Fail if we don't have a current process. 1133 if (!m_debugged_process_up || 1134 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) 1135 return SendErrorResponse(68); 1136 1137 if (!packet.ConsumeFront("jTraceConfigRead:")) 1138 return SendIllFormedResponse(packet, 1139 "jTraceConfigRead: Ill formed packet "); 1140 1141 lldb::user_id_t uid = LLDB_INVALID_UID; 1142 lldb::tid_t threadid = LLDB_INVALID_THREAD_ID; 1143 1144 auto json_object = StructuredData::ParseJSON(packet.Peek()); 1145 1146 if (!json_object || 1147 json_object->GetType() != lldb::eStructuredDataTypeDictionary) 1148 return SendIllFormedResponse(packet, 1149 "jTraceConfigRead: Ill formed packet "); 1150 1151 auto json_dict = json_object->GetAsDictionary(); 1152 1153 if (!json_dict->GetValueForKeyAsInteger("traceid", uid)) 1154 return SendIllFormedResponse(packet, 1155 "jTraceConfigRead: Ill formed packet "); 1156 1157 json_dict->GetValueForKeyAsInteger("threadid", threadid); 1158 1159 TraceOptions options; 1160 StreamGDBRemote response; 1161 1162 options.setThreadID(threadid); 1163 Status error = m_debugged_process_up->GetTraceConfig(uid, options); 1164 1165 if (error.Fail()) 1166 return SendErrorResponse(error); 1167 1168 StreamGDBRemote escaped_response; 1169 StructuredData::Dictionary json_packet; 1170 1171 json_packet.AddIntegerItem("type", options.getType()); 1172 json_packet.AddIntegerItem("buffersize", options.getTraceBufferSize()); 1173 json_packet.AddIntegerItem("metabuffersize", options.getMetaDataBufferSize()); 1174 1175 StructuredData::DictionarySP custom_params = options.getTraceParams(); 1176 if (custom_params) 1177 json_packet.AddItem("params", custom_params); 1178 1179 StreamString json_string; 1180 json_packet.Dump(json_string, false); 1181 escaped_response.PutEscapedBytes(json_string.GetData(), 1182 json_string.GetSize()); 1183 return SendPacketNoLock(escaped_response.GetString()); 1184 } 1185 1186 GDBRemoteCommunication::PacketResult 1187 GDBRemoteCommunicationServerLLGS::Handle_jTraceRead( 1188 StringExtractorGDBRemote &packet) { 1189 1190 // Fail if we don't have a current process. 1191 if (!m_debugged_process_up || 1192 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) 1193 return SendErrorResponse(68); 1194 1195 enum PacketType { MetaData, BufferData }; 1196 PacketType tracetype = MetaData; 1197 1198 if (packet.ConsumeFront("jTraceBufferRead:")) 1199 tracetype = BufferData; 1200 else if (packet.ConsumeFront("jTraceMetaRead:")) 1201 tracetype = MetaData; 1202 else { 1203 return SendIllFormedResponse(packet, "jTrace: Ill formed packet "); 1204 } 1205 1206 lldb::user_id_t uid = LLDB_INVALID_UID; 1207 1208 uint64_t byte_count = std::numeric_limits<uint64_t>::max(); 1209 lldb::tid_t tid = LLDB_INVALID_THREAD_ID; 1210 uint64_t offset = std::numeric_limits<uint64_t>::max(); 1211 1212 auto json_object = StructuredData::ParseJSON(packet.Peek()); 1213 1214 if (!json_object || 1215 json_object->GetType() != lldb::eStructuredDataTypeDictionary) 1216 return SendIllFormedResponse(packet, "jTrace: Ill formed packet "); 1217 1218 auto json_dict = json_object->GetAsDictionary(); 1219 1220 if (!json_dict->GetValueForKeyAsInteger("traceid", uid) || 1221 !json_dict->GetValueForKeyAsInteger("offset", offset) || 1222 !json_dict->GetValueForKeyAsInteger("buffersize", byte_count)) 1223 return SendIllFormedResponse(packet, "jTrace: Ill formed packet "); 1224 1225 json_dict->GetValueForKeyAsInteger("threadid", tid); 1226 1227 // Allocate the response buffer. 1228 std::unique_ptr<uint8_t[]> buffer (new (std::nothrow) uint8_t[byte_count]); 1229 if (!buffer) 1230 return SendErrorResponse(0x78); 1231 1232 StreamGDBRemote response; 1233 Status error; 1234 llvm::MutableArrayRef<uint8_t> buf(buffer.get(), byte_count); 1235 1236 if (tracetype == BufferData) 1237 error = m_debugged_process_up->GetData(uid, tid, buf, offset); 1238 else if (tracetype == MetaData) 1239 error = m_debugged_process_up->GetMetaData(uid, tid, buf, offset); 1240 1241 if (error.Fail()) 1242 return SendErrorResponse(error); 1243 1244 for (auto i : buf) 1245 response.PutHex8(i); 1246 1247 StreamGDBRemote escaped_response; 1248 escaped_response.PutEscapedBytes(response.GetData(), response.GetSize()); 1249 return SendPacketNoLock(escaped_response.GetString()); 1250 } 1251 1252 GDBRemoteCommunication::PacketResult 1253 GDBRemoteCommunicationServerLLGS::Handle_qProcessInfo( 1254 StringExtractorGDBRemote &packet) { 1255 // Fail if we don't have a current process. 1256 if (!m_debugged_process_up || 1257 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) 1258 return SendErrorResponse(68); 1259 1260 lldb::pid_t pid = m_debugged_process_up->GetID(); 1261 1262 if (pid == LLDB_INVALID_PROCESS_ID) 1263 return SendErrorResponse(1); 1264 1265 ProcessInstanceInfo proc_info; 1266 if (!Host::GetProcessInfo(pid, proc_info)) 1267 return SendErrorResponse(1); 1268 1269 StreamString response; 1270 CreateProcessInfoResponse_DebugServerStyle(proc_info, response); 1271 return SendPacketNoLock(response.GetString()); 1272 } 1273 1274 GDBRemoteCommunication::PacketResult 1275 GDBRemoteCommunicationServerLLGS::Handle_qC(StringExtractorGDBRemote &packet) { 1276 // Fail if we don't have a current process. 1277 if (!m_debugged_process_up || 1278 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) 1279 return SendErrorResponse(68); 1280 1281 // Make sure we set the current thread so g and p packets return the data the 1282 // gdb will expect. 1283 lldb::tid_t tid = m_debugged_process_up->GetCurrentThreadID(); 1284 SetCurrentThreadID(tid); 1285 1286 NativeThreadProtocol *thread = m_debugged_process_up->GetCurrentThread(); 1287 if (!thread) 1288 return SendErrorResponse(69); 1289 1290 StreamString response; 1291 response.Printf("QC%" PRIx64, thread->GetID()); 1292 1293 return SendPacketNoLock(response.GetString()); 1294 } 1295 1296 GDBRemoteCommunication::PacketResult 1297 GDBRemoteCommunicationServerLLGS::Handle_k(StringExtractorGDBRemote &packet) { 1298 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 1299 1300 StopSTDIOForwarding(); 1301 1302 if (!m_debugged_process_up) { 1303 LLDB_LOG(log, "No debugged process found."); 1304 return PacketResult::Success; 1305 } 1306 1307 Status error = m_debugged_process_up->Kill(); 1308 if (error.Fail()) 1309 LLDB_LOG(log, "Failed to kill debugged process {0}: {1}", 1310 m_debugged_process_up->GetID(), error); 1311 1312 // No OK response for kill packet. 1313 // return SendOKResponse (); 1314 return PacketResult::Success; 1315 } 1316 1317 GDBRemoteCommunication::PacketResult 1318 GDBRemoteCommunicationServerLLGS::Handle_QSetDisableASLR( 1319 StringExtractorGDBRemote &packet) { 1320 packet.SetFilePos(::strlen("QSetDisableASLR:")); 1321 if (packet.GetU32(0)) 1322 m_process_launch_info.GetFlags().Set(eLaunchFlagDisableASLR); 1323 else 1324 m_process_launch_info.GetFlags().Clear(eLaunchFlagDisableASLR); 1325 return SendOKResponse(); 1326 } 1327 1328 GDBRemoteCommunication::PacketResult 1329 GDBRemoteCommunicationServerLLGS::Handle_QSetWorkingDir( 1330 StringExtractorGDBRemote &packet) { 1331 packet.SetFilePos(::strlen("QSetWorkingDir:")); 1332 std::string path; 1333 packet.GetHexByteString(path); 1334 m_process_launch_info.SetWorkingDirectory(FileSpec(path)); 1335 return SendOKResponse(); 1336 } 1337 1338 GDBRemoteCommunication::PacketResult 1339 GDBRemoteCommunicationServerLLGS::Handle_qGetWorkingDir( 1340 StringExtractorGDBRemote &packet) { 1341 FileSpec working_dir{m_process_launch_info.GetWorkingDirectory()}; 1342 if (working_dir) { 1343 StreamString response; 1344 response.PutStringAsRawHex8(working_dir.GetCString()); 1345 return SendPacketNoLock(response.GetString()); 1346 } 1347 1348 return SendErrorResponse(14); 1349 } 1350 1351 GDBRemoteCommunication::PacketResult 1352 GDBRemoteCommunicationServerLLGS::Handle_C(StringExtractorGDBRemote &packet) { 1353 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_THREAD)); 1354 LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s called", __FUNCTION__); 1355 1356 // Ensure we have a native process. 1357 if (!m_debugged_process_up) { 1358 LLDB_LOGF(log, 1359 "GDBRemoteCommunicationServerLLGS::%s no debugged process " 1360 "shared pointer", 1361 __FUNCTION__); 1362 return SendErrorResponse(0x36); 1363 } 1364 1365 // Pull out the signal number. 1366 packet.SetFilePos(::strlen("C")); 1367 if (packet.GetBytesLeft() < 1) { 1368 // Shouldn't be using a C without a signal. 1369 return SendIllFormedResponse(packet, "C packet specified without signal."); 1370 } 1371 const uint32_t signo = 1372 packet.GetHexMaxU32(false, std::numeric_limits<uint32_t>::max()); 1373 if (signo == std::numeric_limits<uint32_t>::max()) 1374 return SendIllFormedResponse(packet, "failed to parse signal number"); 1375 1376 // Handle optional continue address. 1377 if (packet.GetBytesLeft() > 0) { 1378 // FIXME add continue at address support for $C{signo}[;{continue-address}]. 1379 if (*packet.Peek() == ';') 1380 return SendUnimplementedResponse(packet.GetStringRef().c_str()); 1381 else 1382 return SendIllFormedResponse( 1383 packet, "unexpected content after $C{signal-number}"); 1384 } 1385 1386 ResumeActionList resume_actions(StateType::eStateRunning, 0); 1387 Status error; 1388 1389 // We have two branches: what to do if a continue thread is specified (in 1390 // which case we target sending the signal to that thread), or when we don't 1391 // have a continue thread set (in which case we send a signal to the 1392 // process). 1393 1394 // TODO discuss with Greg Clayton, make sure this makes sense. 1395 1396 lldb::tid_t signal_tid = GetContinueThreadID(); 1397 if (signal_tid != LLDB_INVALID_THREAD_ID) { 1398 // The resume action for the continue thread (or all threads if a continue 1399 // thread is not set). 1400 ResumeAction action = {GetContinueThreadID(), StateType::eStateRunning, 1401 static_cast<int>(signo)}; 1402 1403 // Add the action for the continue thread (or all threads when the continue 1404 // thread isn't present). 1405 resume_actions.Append(action); 1406 } else { 1407 // Send the signal to the process since we weren't targeting a specific 1408 // continue thread with the signal. 1409 error = m_debugged_process_up->Signal(signo); 1410 if (error.Fail()) { 1411 LLDB_LOG(log, "failed to send signal for process {0}: {1}", 1412 m_debugged_process_up->GetID(), error); 1413 1414 return SendErrorResponse(0x52); 1415 } 1416 } 1417 1418 // Resume the threads. 1419 error = m_debugged_process_up->Resume(resume_actions); 1420 if (error.Fail()) { 1421 LLDB_LOG(log, "failed to resume threads for process {0}: {1}", 1422 m_debugged_process_up->GetID(), error); 1423 1424 return SendErrorResponse(0x38); 1425 } 1426 1427 // Don't send an "OK" packet; response is the stopped/exited message. 1428 return PacketResult::Success; 1429 } 1430 1431 GDBRemoteCommunication::PacketResult 1432 GDBRemoteCommunicationServerLLGS::Handle_c(StringExtractorGDBRemote &packet) { 1433 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_THREAD)); 1434 LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s called", __FUNCTION__); 1435 1436 packet.SetFilePos(packet.GetFilePos() + ::strlen("c")); 1437 1438 // For now just support all continue. 1439 const bool has_continue_address = (packet.GetBytesLeft() > 0); 1440 if (has_continue_address) { 1441 LLDB_LOG(log, "not implemented for c[address] variant [{0} remains]", 1442 packet.Peek()); 1443 return SendUnimplementedResponse(packet.GetStringRef().c_str()); 1444 } 1445 1446 // Ensure we have a native process. 1447 if (!m_debugged_process_up) { 1448 LLDB_LOGF(log, 1449 "GDBRemoteCommunicationServerLLGS::%s no debugged process " 1450 "shared pointer", 1451 __FUNCTION__); 1452 return SendErrorResponse(0x36); 1453 } 1454 1455 // Build the ResumeActionList 1456 ResumeActionList actions(StateType::eStateRunning, 0); 1457 1458 Status error = m_debugged_process_up->Resume(actions); 1459 if (error.Fail()) { 1460 LLDB_LOG(log, "c failed for process {0}: {1}", 1461 m_debugged_process_up->GetID(), error); 1462 return SendErrorResponse(GDBRemoteServerError::eErrorResume); 1463 } 1464 1465 LLDB_LOG(log, "continued process {0}", m_debugged_process_up->GetID()); 1466 // No response required from continue. 1467 return PacketResult::Success; 1468 } 1469 1470 GDBRemoteCommunication::PacketResult 1471 GDBRemoteCommunicationServerLLGS::Handle_vCont_actions( 1472 StringExtractorGDBRemote &packet) { 1473 StreamString response; 1474 response.Printf("vCont;c;C;s;S"); 1475 1476 return SendPacketNoLock(response.GetString()); 1477 } 1478 1479 GDBRemoteCommunication::PacketResult 1480 GDBRemoteCommunicationServerLLGS::Handle_vCont( 1481 StringExtractorGDBRemote &packet) { 1482 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 1483 LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s handling vCont packet", 1484 __FUNCTION__); 1485 1486 packet.SetFilePos(::strlen("vCont")); 1487 1488 if (packet.GetBytesLeft() == 0) { 1489 LLDB_LOGF(log, 1490 "GDBRemoteCommunicationServerLLGS::%s missing action from " 1491 "vCont package", 1492 __FUNCTION__); 1493 return SendIllFormedResponse(packet, "Missing action from vCont package"); 1494 } 1495 1496 // Check if this is all continue (no options or ";c"). 1497 if (::strcmp(packet.Peek(), ";c") == 0) { 1498 // Move past the ';', then do a simple 'c'. 1499 packet.SetFilePos(packet.GetFilePos() + 1); 1500 return Handle_c(packet); 1501 } else if (::strcmp(packet.Peek(), ";s") == 0) { 1502 // Move past the ';', then do a simple 's'. 1503 packet.SetFilePos(packet.GetFilePos() + 1); 1504 return Handle_s(packet); 1505 } 1506 1507 // Ensure we have a native process. 1508 if (!m_debugged_process_up) { 1509 LLDB_LOG(log, "no debugged process"); 1510 return SendErrorResponse(0x36); 1511 } 1512 1513 ResumeActionList thread_actions; 1514 1515 while (packet.GetBytesLeft() && *packet.Peek() == ';') { 1516 // Skip the semi-colon. 1517 packet.GetChar(); 1518 1519 // Build up the thread action. 1520 ResumeAction thread_action; 1521 thread_action.tid = LLDB_INVALID_THREAD_ID; 1522 thread_action.state = eStateInvalid; 1523 thread_action.signal = 0; 1524 1525 const char action = packet.GetChar(); 1526 switch (action) { 1527 case 'C': 1528 thread_action.signal = packet.GetHexMaxU32(false, 0); 1529 if (thread_action.signal == 0) 1530 return SendIllFormedResponse( 1531 packet, "Could not parse signal in vCont packet C action"); 1532 LLVM_FALLTHROUGH; 1533 1534 case 'c': 1535 // Continue 1536 thread_action.state = eStateRunning; 1537 break; 1538 1539 case 'S': 1540 thread_action.signal = packet.GetHexMaxU32(false, 0); 1541 if (thread_action.signal == 0) 1542 return SendIllFormedResponse( 1543 packet, "Could not parse signal in vCont packet S action"); 1544 LLVM_FALLTHROUGH; 1545 1546 case 's': 1547 // Step 1548 thread_action.state = eStateStepping; 1549 break; 1550 1551 default: 1552 return SendIllFormedResponse(packet, "Unsupported vCont action"); 1553 break; 1554 } 1555 1556 // Parse out optional :{thread-id} value. 1557 if (packet.GetBytesLeft() && (*packet.Peek() == ':')) { 1558 // Consume the separator. 1559 packet.GetChar(); 1560 1561 thread_action.tid = packet.GetHexMaxU32(false, LLDB_INVALID_THREAD_ID); 1562 if (thread_action.tid == LLDB_INVALID_THREAD_ID) 1563 return SendIllFormedResponse( 1564 packet, "Could not parse thread number in vCont packet"); 1565 } 1566 1567 thread_actions.Append(thread_action); 1568 } 1569 1570 Status error = m_debugged_process_up->Resume(thread_actions); 1571 if (error.Fail()) { 1572 LLDB_LOG(log, "vCont failed for process {0}: {1}", 1573 m_debugged_process_up->GetID(), error); 1574 return SendErrorResponse(GDBRemoteServerError::eErrorResume); 1575 } 1576 1577 LLDB_LOG(log, "continued process {0}", m_debugged_process_up->GetID()); 1578 // No response required from vCont. 1579 return PacketResult::Success; 1580 } 1581 1582 void GDBRemoteCommunicationServerLLGS::SetCurrentThreadID(lldb::tid_t tid) { 1583 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 1584 LLDB_LOG(log, "setting current thread id to {0}", tid); 1585 1586 m_current_tid = tid; 1587 if (m_debugged_process_up) 1588 m_debugged_process_up->SetCurrentThreadID(m_current_tid); 1589 } 1590 1591 void GDBRemoteCommunicationServerLLGS::SetContinueThreadID(lldb::tid_t tid) { 1592 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 1593 LLDB_LOG(log, "setting continue thread id to {0}", tid); 1594 1595 m_continue_tid = tid; 1596 } 1597 1598 GDBRemoteCommunication::PacketResult 1599 GDBRemoteCommunicationServerLLGS::Handle_stop_reason( 1600 StringExtractorGDBRemote &packet) { 1601 // Handle the $? gdbremote command. 1602 1603 // If no process, indicate error 1604 if (!m_debugged_process_up) 1605 return SendErrorResponse(02); 1606 1607 return SendStopReasonForState(m_debugged_process_up->GetState()); 1608 } 1609 1610 GDBRemoteCommunication::PacketResult 1611 GDBRemoteCommunicationServerLLGS::SendStopReasonForState( 1612 lldb::StateType process_state) { 1613 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 1614 1615 switch (process_state) { 1616 case eStateAttaching: 1617 case eStateLaunching: 1618 case eStateRunning: 1619 case eStateStepping: 1620 case eStateDetached: 1621 // NOTE: gdb protocol doc looks like it should return $OK 1622 // when everything is running (i.e. no stopped result). 1623 return PacketResult::Success; // Ignore 1624 1625 case eStateSuspended: 1626 case eStateStopped: 1627 case eStateCrashed: { 1628 lldb::tid_t tid = m_debugged_process_up->GetCurrentThreadID(); 1629 // Make sure we set the current thread so g and p packets return the data 1630 // the gdb will expect. 1631 SetCurrentThreadID(tid); 1632 return SendStopReplyPacketForThread(tid); 1633 } 1634 1635 case eStateInvalid: 1636 case eStateUnloaded: 1637 case eStateExited: 1638 return SendWResponse(m_debugged_process_up.get()); 1639 1640 default: 1641 LLDB_LOG(log, "pid {0}, current state reporting not handled: {1}", 1642 m_debugged_process_up->GetID(), process_state); 1643 break; 1644 } 1645 1646 return SendErrorResponse(0); 1647 } 1648 1649 GDBRemoteCommunication::PacketResult 1650 GDBRemoteCommunicationServerLLGS::Handle_qRegisterInfo( 1651 StringExtractorGDBRemote &packet) { 1652 // Fail if we don't have a current process. 1653 if (!m_debugged_process_up || 1654 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) 1655 return SendErrorResponse(68); 1656 1657 // Ensure we have a thread. 1658 NativeThreadProtocol *thread = m_debugged_process_up->GetThreadAtIndex(0); 1659 if (!thread) 1660 return SendErrorResponse(69); 1661 1662 // Get the register context for the first thread. 1663 NativeRegisterContext ®_context = thread->GetRegisterContext(); 1664 1665 // Parse out the register number from the request. 1666 packet.SetFilePos(strlen("qRegisterInfo")); 1667 const uint32_t reg_index = 1668 packet.GetHexMaxU32(false, std::numeric_limits<uint32_t>::max()); 1669 if (reg_index == std::numeric_limits<uint32_t>::max()) 1670 return SendErrorResponse(69); 1671 1672 // Return the end of registers response if we've iterated one past the end of 1673 // the register set. 1674 if (reg_index >= reg_context.GetUserRegisterCount()) 1675 return SendErrorResponse(69); 1676 1677 const RegisterInfo *reg_info = reg_context.GetRegisterInfoAtIndex(reg_index); 1678 if (!reg_info) 1679 return SendErrorResponse(69); 1680 1681 // Build the reginfos response. 1682 StreamGDBRemote response; 1683 1684 response.PutCString("name:"); 1685 response.PutCString(reg_info->name); 1686 response.PutChar(';'); 1687 1688 if (reg_info->alt_name && reg_info->alt_name[0]) { 1689 response.PutCString("alt-name:"); 1690 response.PutCString(reg_info->alt_name); 1691 response.PutChar(';'); 1692 } 1693 1694 response.Printf("bitsize:%" PRIu32 ";offset:%" PRIu32 ";", 1695 reg_info->byte_size * 8, reg_info->byte_offset); 1696 1697 switch (reg_info->encoding) { 1698 case eEncodingUint: 1699 response.PutCString("encoding:uint;"); 1700 break; 1701 case eEncodingSint: 1702 response.PutCString("encoding:sint;"); 1703 break; 1704 case eEncodingIEEE754: 1705 response.PutCString("encoding:ieee754;"); 1706 break; 1707 case eEncodingVector: 1708 response.PutCString("encoding:vector;"); 1709 break; 1710 default: 1711 break; 1712 } 1713 1714 switch (reg_info->format) { 1715 case eFormatBinary: 1716 response.PutCString("format:binary;"); 1717 break; 1718 case eFormatDecimal: 1719 response.PutCString("format:decimal;"); 1720 break; 1721 case eFormatHex: 1722 response.PutCString("format:hex;"); 1723 break; 1724 case eFormatFloat: 1725 response.PutCString("format:float;"); 1726 break; 1727 case eFormatVectorOfSInt8: 1728 response.PutCString("format:vector-sint8;"); 1729 break; 1730 case eFormatVectorOfUInt8: 1731 response.PutCString("format:vector-uint8;"); 1732 break; 1733 case eFormatVectorOfSInt16: 1734 response.PutCString("format:vector-sint16;"); 1735 break; 1736 case eFormatVectorOfUInt16: 1737 response.PutCString("format:vector-uint16;"); 1738 break; 1739 case eFormatVectorOfSInt32: 1740 response.PutCString("format:vector-sint32;"); 1741 break; 1742 case eFormatVectorOfUInt32: 1743 response.PutCString("format:vector-uint32;"); 1744 break; 1745 case eFormatVectorOfFloat32: 1746 response.PutCString("format:vector-float32;"); 1747 break; 1748 case eFormatVectorOfUInt64: 1749 response.PutCString("format:vector-uint64;"); 1750 break; 1751 case eFormatVectorOfUInt128: 1752 response.PutCString("format:vector-uint128;"); 1753 break; 1754 default: 1755 break; 1756 }; 1757 1758 const char *const register_set_name = 1759 reg_context.GetRegisterSetNameForRegisterAtIndex(reg_index); 1760 if (register_set_name) { 1761 response.PutCString("set:"); 1762 response.PutCString(register_set_name); 1763 response.PutChar(';'); 1764 } 1765 1766 if (reg_info->kinds[RegisterKind::eRegisterKindEHFrame] != 1767 LLDB_INVALID_REGNUM) 1768 response.Printf("ehframe:%" PRIu32 ";", 1769 reg_info->kinds[RegisterKind::eRegisterKindEHFrame]); 1770 1771 if (reg_info->kinds[RegisterKind::eRegisterKindDWARF] != LLDB_INVALID_REGNUM) 1772 response.Printf("dwarf:%" PRIu32 ";", 1773 reg_info->kinds[RegisterKind::eRegisterKindDWARF]); 1774 1775 switch (reg_info->kinds[RegisterKind::eRegisterKindGeneric]) { 1776 case LLDB_REGNUM_GENERIC_PC: 1777 response.PutCString("generic:pc;"); 1778 break; 1779 case LLDB_REGNUM_GENERIC_SP: 1780 response.PutCString("generic:sp;"); 1781 break; 1782 case LLDB_REGNUM_GENERIC_FP: 1783 response.PutCString("generic:fp;"); 1784 break; 1785 case LLDB_REGNUM_GENERIC_RA: 1786 response.PutCString("generic:ra;"); 1787 break; 1788 case LLDB_REGNUM_GENERIC_FLAGS: 1789 response.PutCString("generic:flags;"); 1790 break; 1791 case LLDB_REGNUM_GENERIC_ARG1: 1792 response.PutCString("generic:arg1;"); 1793 break; 1794 case LLDB_REGNUM_GENERIC_ARG2: 1795 response.PutCString("generic:arg2;"); 1796 break; 1797 case LLDB_REGNUM_GENERIC_ARG3: 1798 response.PutCString("generic:arg3;"); 1799 break; 1800 case LLDB_REGNUM_GENERIC_ARG4: 1801 response.PutCString("generic:arg4;"); 1802 break; 1803 case LLDB_REGNUM_GENERIC_ARG5: 1804 response.PutCString("generic:arg5;"); 1805 break; 1806 case LLDB_REGNUM_GENERIC_ARG6: 1807 response.PutCString("generic:arg6;"); 1808 break; 1809 case LLDB_REGNUM_GENERIC_ARG7: 1810 response.PutCString("generic:arg7;"); 1811 break; 1812 case LLDB_REGNUM_GENERIC_ARG8: 1813 response.PutCString("generic:arg8;"); 1814 break; 1815 default: 1816 break; 1817 } 1818 1819 if (reg_info->value_regs && reg_info->value_regs[0] != LLDB_INVALID_REGNUM) { 1820 response.PutCString("container-regs:"); 1821 int i = 0; 1822 for (const uint32_t *reg_num = reg_info->value_regs; 1823 *reg_num != LLDB_INVALID_REGNUM; ++reg_num, ++i) { 1824 if (i > 0) 1825 response.PutChar(','); 1826 response.Printf("%" PRIx32, *reg_num); 1827 } 1828 response.PutChar(';'); 1829 } 1830 1831 if (reg_info->invalidate_regs && reg_info->invalidate_regs[0]) { 1832 response.PutCString("invalidate-regs:"); 1833 int i = 0; 1834 for (const uint32_t *reg_num = reg_info->invalidate_regs; 1835 *reg_num != LLDB_INVALID_REGNUM; ++reg_num, ++i) { 1836 if (i > 0) 1837 response.PutChar(','); 1838 response.Printf("%" PRIx32, *reg_num); 1839 } 1840 response.PutChar(';'); 1841 } 1842 1843 if (reg_info->dynamic_size_dwarf_expr_bytes) { 1844 const size_t dwarf_opcode_len = reg_info->dynamic_size_dwarf_len; 1845 response.PutCString("dynamic_size_dwarf_expr_bytes:"); 1846 for (uint32_t i = 0; i < dwarf_opcode_len; ++i) 1847 response.PutHex8(reg_info->dynamic_size_dwarf_expr_bytes[i]); 1848 response.PutChar(';'); 1849 } 1850 return SendPacketNoLock(response.GetString()); 1851 } 1852 1853 GDBRemoteCommunication::PacketResult 1854 GDBRemoteCommunicationServerLLGS::Handle_qfThreadInfo( 1855 StringExtractorGDBRemote &packet) { 1856 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 1857 1858 // Fail if we don't have a current process. 1859 if (!m_debugged_process_up || 1860 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 1861 LLDB_LOG(log, "no process ({0}), returning OK", 1862 m_debugged_process_up ? "invalid process id" 1863 : "null m_debugged_process_up"); 1864 return SendOKResponse(); 1865 } 1866 1867 StreamGDBRemote response; 1868 response.PutChar('m'); 1869 1870 LLDB_LOG(log, "starting thread iteration"); 1871 NativeThreadProtocol *thread; 1872 uint32_t thread_index; 1873 for (thread_index = 0, 1874 thread = m_debugged_process_up->GetThreadAtIndex(thread_index); 1875 thread; ++thread_index, 1876 thread = m_debugged_process_up->GetThreadAtIndex(thread_index)) { 1877 LLDB_LOG(log, "iterated thread {0}(tid={2})", thread_index, 1878 thread->GetID()); 1879 if (thread_index > 0) 1880 response.PutChar(','); 1881 response.Printf("%" PRIx64, thread->GetID()); 1882 } 1883 1884 LLDB_LOG(log, "finished thread iteration"); 1885 return SendPacketNoLock(response.GetString()); 1886 } 1887 1888 GDBRemoteCommunication::PacketResult 1889 GDBRemoteCommunicationServerLLGS::Handle_qsThreadInfo( 1890 StringExtractorGDBRemote &packet) { 1891 // FIXME for now we return the full thread list in the initial packet and 1892 // always do nothing here. 1893 return SendPacketNoLock("l"); 1894 } 1895 1896 GDBRemoteCommunication::PacketResult 1897 GDBRemoteCommunicationServerLLGS::Handle_g(StringExtractorGDBRemote &packet) { 1898 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 1899 1900 // Move past packet name. 1901 packet.SetFilePos(strlen("g")); 1902 1903 // Get the thread to use. 1904 NativeThreadProtocol *thread = GetThreadFromSuffix(packet); 1905 if (!thread) { 1906 LLDB_LOG(log, "failed, no thread available"); 1907 return SendErrorResponse(0x15); 1908 } 1909 1910 // Get the thread's register context. 1911 NativeRegisterContext ®_ctx = thread->GetRegisterContext(); 1912 1913 std::vector<uint8_t> regs_buffer; 1914 for (uint32_t reg_num = 0; reg_num < reg_ctx.GetUserRegisterCount(); 1915 ++reg_num) { 1916 const RegisterInfo *reg_info = reg_ctx.GetRegisterInfoAtIndex(reg_num); 1917 1918 if (reg_info == nullptr) { 1919 LLDB_LOG(log, "failed to get register info for register index {0}", 1920 reg_num); 1921 return SendErrorResponse(0x15); 1922 } 1923 1924 if (reg_info->value_regs != nullptr) 1925 continue; // skip registers that are contained in other registers 1926 1927 RegisterValue reg_value; 1928 Status error = reg_ctx.ReadRegister(reg_info, reg_value); 1929 if (error.Fail()) { 1930 LLDB_LOG(log, "failed to read register at index {0}", reg_num); 1931 return SendErrorResponse(0x15); 1932 } 1933 1934 if (reg_info->byte_offset + reg_info->byte_size >= regs_buffer.size()) 1935 // Resize the buffer to guarantee it can store the register offsetted 1936 // data. 1937 regs_buffer.resize(reg_info->byte_offset + reg_info->byte_size); 1938 1939 // Copy the register offsetted data to the buffer. 1940 memcpy(regs_buffer.data() + reg_info->byte_offset, reg_value.GetBytes(), 1941 reg_info->byte_size); 1942 } 1943 1944 // Write the response. 1945 StreamGDBRemote response; 1946 response.PutBytesAsRawHex8(regs_buffer.data(), regs_buffer.size()); 1947 1948 return SendPacketNoLock(response.GetString()); 1949 } 1950 1951 GDBRemoteCommunication::PacketResult 1952 GDBRemoteCommunicationServerLLGS::Handle_p(StringExtractorGDBRemote &packet) { 1953 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 1954 1955 // Parse out the register number from the request. 1956 packet.SetFilePos(strlen("p")); 1957 const uint32_t reg_index = 1958 packet.GetHexMaxU32(false, std::numeric_limits<uint32_t>::max()); 1959 if (reg_index == std::numeric_limits<uint32_t>::max()) { 1960 LLDB_LOGF(log, 1961 "GDBRemoteCommunicationServerLLGS::%s failed, could not " 1962 "parse register number from request \"%s\"", 1963 __FUNCTION__, packet.GetStringRef().c_str()); 1964 return SendErrorResponse(0x15); 1965 } 1966 1967 // Get the thread to use. 1968 NativeThreadProtocol *thread = GetThreadFromSuffix(packet); 1969 if (!thread) { 1970 LLDB_LOG(log, "failed, no thread available"); 1971 return SendErrorResponse(0x15); 1972 } 1973 1974 // Get the thread's register context. 1975 NativeRegisterContext ®_context = thread->GetRegisterContext(); 1976 1977 // Return the end of registers response if we've iterated one past the end of 1978 // the register set. 1979 if (reg_index >= reg_context.GetUserRegisterCount()) { 1980 LLDB_LOGF(log, 1981 "GDBRemoteCommunicationServerLLGS::%s failed, requested " 1982 "register %" PRIu32 " beyond register count %" PRIu32, 1983 __FUNCTION__, reg_index, reg_context.GetUserRegisterCount()); 1984 return SendErrorResponse(0x15); 1985 } 1986 1987 const RegisterInfo *reg_info = reg_context.GetRegisterInfoAtIndex(reg_index); 1988 if (!reg_info) { 1989 LLDB_LOGF(log, 1990 "GDBRemoteCommunicationServerLLGS::%s failed, requested " 1991 "register %" PRIu32 " returned NULL", 1992 __FUNCTION__, reg_index); 1993 return SendErrorResponse(0x15); 1994 } 1995 1996 // Build the reginfos response. 1997 StreamGDBRemote response; 1998 1999 // Retrieve the value 2000 RegisterValue reg_value; 2001 Status error = reg_context.ReadRegister(reg_info, reg_value); 2002 if (error.Fail()) { 2003 LLDB_LOGF(log, 2004 "GDBRemoteCommunicationServerLLGS::%s failed, read of " 2005 "requested register %" PRIu32 " (%s) failed: %s", 2006 __FUNCTION__, reg_index, reg_info->name, error.AsCString()); 2007 return SendErrorResponse(0x15); 2008 } 2009 2010 const uint8_t *const data = 2011 reinterpret_cast<const uint8_t *>(reg_value.GetBytes()); 2012 if (!data) { 2013 LLDB_LOGF(log, 2014 "GDBRemoteCommunicationServerLLGS::%s failed to get data " 2015 "bytes from requested register %" PRIu32, 2016 __FUNCTION__, reg_index); 2017 return SendErrorResponse(0x15); 2018 } 2019 2020 // FIXME flip as needed to get data in big/little endian format for this host. 2021 for (uint32_t i = 0; i < reg_value.GetByteSize(); ++i) 2022 response.PutHex8(data[i]); 2023 2024 return SendPacketNoLock(response.GetString()); 2025 } 2026 2027 GDBRemoteCommunication::PacketResult 2028 GDBRemoteCommunicationServerLLGS::Handle_P(StringExtractorGDBRemote &packet) { 2029 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 2030 2031 // Ensure there is more content. 2032 if (packet.GetBytesLeft() < 1) 2033 return SendIllFormedResponse(packet, "Empty P packet"); 2034 2035 // Parse out the register number from the request. 2036 packet.SetFilePos(strlen("P")); 2037 const uint32_t reg_index = 2038 packet.GetHexMaxU32(false, std::numeric_limits<uint32_t>::max()); 2039 if (reg_index == std::numeric_limits<uint32_t>::max()) { 2040 LLDB_LOGF(log, 2041 "GDBRemoteCommunicationServerLLGS::%s failed, could not " 2042 "parse register number from request \"%s\"", 2043 __FUNCTION__, packet.GetStringRef().c_str()); 2044 return SendErrorResponse(0x29); 2045 } 2046 2047 // Note debugserver would send an E30 here. 2048 if ((packet.GetBytesLeft() < 1) || (packet.GetChar() != '=')) 2049 return SendIllFormedResponse( 2050 packet, "P packet missing '=' char after register number"); 2051 2052 // Parse out the value. 2053 uint8_t reg_bytes[32]; // big enough to support up to 256 bit ymmN register 2054 size_t reg_size = packet.GetHexBytesAvail(reg_bytes); 2055 2056 // Get the thread to use. 2057 NativeThreadProtocol *thread = GetThreadFromSuffix(packet); 2058 if (!thread) { 2059 LLDB_LOGF(log, 2060 "GDBRemoteCommunicationServerLLGS::%s failed, no thread " 2061 "available (thread index 0)", 2062 __FUNCTION__); 2063 return SendErrorResponse(0x28); 2064 } 2065 2066 // Get the thread's register context. 2067 NativeRegisterContext ®_context = thread->GetRegisterContext(); 2068 const RegisterInfo *reg_info = reg_context.GetRegisterInfoAtIndex(reg_index); 2069 if (!reg_info) { 2070 LLDB_LOGF(log, 2071 "GDBRemoteCommunicationServerLLGS::%s failed, requested " 2072 "register %" PRIu32 " returned NULL", 2073 __FUNCTION__, reg_index); 2074 return SendErrorResponse(0x48); 2075 } 2076 2077 // Return the end of registers response if we've iterated one past the end of 2078 // the register set. 2079 if (reg_index >= reg_context.GetUserRegisterCount()) { 2080 LLDB_LOGF(log, 2081 "GDBRemoteCommunicationServerLLGS::%s failed, requested " 2082 "register %" PRIu32 " beyond register count %" PRIu32, 2083 __FUNCTION__, reg_index, reg_context.GetUserRegisterCount()); 2084 return SendErrorResponse(0x47); 2085 } 2086 2087 // The dwarf expression are evaluate on host site which may cause register 2088 // size to change Hence the reg_size may not be same as reg_info->bytes_size 2089 if ((reg_size != reg_info->byte_size) && 2090 !(reg_info->dynamic_size_dwarf_expr_bytes)) { 2091 return SendIllFormedResponse(packet, "P packet register size is incorrect"); 2092 } 2093 2094 // Build the reginfos response. 2095 StreamGDBRemote response; 2096 2097 RegisterValue reg_value( 2098 reg_bytes, reg_size, 2099 m_debugged_process_up->GetArchitecture().GetByteOrder()); 2100 Status error = reg_context.WriteRegister(reg_info, reg_value); 2101 if (error.Fail()) { 2102 LLDB_LOGF(log, 2103 "GDBRemoteCommunicationServerLLGS::%s failed, write of " 2104 "requested register %" PRIu32 " (%s) failed: %s", 2105 __FUNCTION__, reg_index, reg_info->name, error.AsCString()); 2106 return SendErrorResponse(0x32); 2107 } 2108 2109 return SendOKResponse(); 2110 } 2111 2112 GDBRemoteCommunication::PacketResult 2113 GDBRemoteCommunicationServerLLGS::Handle_H(StringExtractorGDBRemote &packet) { 2114 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 2115 2116 // Fail if we don't have a current process. 2117 if (!m_debugged_process_up || 2118 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2119 LLDB_LOGF( 2120 log, 2121 "GDBRemoteCommunicationServerLLGS::%s failed, no process available", 2122 __FUNCTION__); 2123 return SendErrorResponse(0x15); 2124 } 2125 2126 // Parse out which variant of $H is requested. 2127 packet.SetFilePos(strlen("H")); 2128 if (packet.GetBytesLeft() < 1) { 2129 LLDB_LOGF(log, 2130 "GDBRemoteCommunicationServerLLGS::%s failed, H command " 2131 "missing {g,c} variant", 2132 __FUNCTION__); 2133 return SendIllFormedResponse(packet, "H command missing {g,c} variant"); 2134 } 2135 2136 const char h_variant = packet.GetChar(); 2137 switch (h_variant) { 2138 case 'g': 2139 break; 2140 2141 case 'c': 2142 break; 2143 2144 default: 2145 LLDB_LOGF( 2146 log, 2147 "GDBRemoteCommunicationServerLLGS::%s failed, invalid $H variant %c", 2148 __FUNCTION__, h_variant); 2149 return SendIllFormedResponse(packet, 2150 "H variant unsupported, should be c or g"); 2151 } 2152 2153 // Parse out the thread number. 2154 // FIXME return a parse success/fail value. All values are valid here. 2155 const lldb::tid_t tid = 2156 packet.GetHexMaxU64(false, std::numeric_limits<lldb::tid_t>::max()); 2157 2158 // Ensure we have the given thread when not specifying -1 (all threads) or 0 2159 // (any thread). 2160 if (tid != LLDB_INVALID_THREAD_ID && tid != 0) { 2161 NativeThreadProtocol *thread = m_debugged_process_up->GetThreadByID(tid); 2162 if (!thread) { 2163 LLDB_LOGF(log, 2164 "GDBRemoteCommunicationServerLLGS::%s failed, tid %" PRIu64 2165 " not found", 2166 __FUNCTION__, tid); 2167 return SendErrorResponse(0x15); 2168 } 2169 } 2170 2171 // Now switch the given thread type. 2172 switch (h_variant) { 2173 case 'g': 2174 SetCurrentThreadID(tid); 2175 break; 2176 2177 case 'c': 2178 SetContinueThreadID(tid); 2179 break; 2180 2181 default: 2182 assert(false && "unsupported $H variant - shouldn't get here"); 2183 return SendIllFormedResponse(packet, 2184 "H variant unsupported, should be c or g"); 2185 } 2186 2187 return SendOKResponse(); 2188 } 2189 2190 GDBRemoteCommunication::PacketResult 2191 GDBRemoteCommunicationServerLLGS::Handle_I(StringExtractorGDBRemote &packet) { 2192 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 2193 2194 // Fail if we don't have a current process. 2195 if (!m_debugged_process_up || 2196 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2197 LLDB_LOGF( 2198 log, 2199 "GDBRemoteCommunicationServerLLGS::%s failed, no process available", 2200 __FUNCTION__); 2201 return SendErrorResponse(0x15); 2202 } 2203 2204 packet.SetFilePos(::strlen("I")); 2205 uint8_t tmp[4096]; 2206 for (;;) { 2207 size_t read = packet.GetHexBytesAvail(tmp); 2208 if (read == 0) { 2209 break; 2210 } 2211 // write directly to stdin *this might block if stdin buffer is full* 2212 // TODO: enqueue this block in circular buffer and send window size to 2213 // remote host 2214 ConnectionStatus status; 2215 Status error; 2216 m_stdio_communication.Write(tmp, read, status, &error); 2217 if (error.Fail()) { 2218 return SendErrorResponse(0x15); 2219 } 2220 } 2221 2222 return SendOKResponse(); 2223 } 2224 2225 GDBRemoteCommunication::PacketResult 2226 GDBRemoteCommunicationServerLLGS::Handle_interrupt( 2227 StringExtractorGDBRemote &packet) { 2228 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_THREAD)); 2229 2230 // Fail if we don't have a current process. 2231 if (!m_debugged_process_up || 2232 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2233 LLDB_LOG(log, "failed, no process available"); 2234 return SendErrorResponse(0x15); 2235 } 2236 2237 // Interrupt the process. 2238 Status error = m_debugged_process_up->Interrupt(); 2239 if (error.Fail()) { 2240 LLDB_LOG(log, "failed for process {0}: {1}", m_debugged_process_up->GetID(), 2241 error); 2242 return SendErrorResponse(GDBRemoteServerError::eErrorResume); 2243 } 2244 2245 LLDB_LOG(log, "stopped process {0}", m_debugged_process_up->GetID()); 2246 2247 // No response required from stop all. 2248 return PacketResult::Success; 2249 } 2250 2251 GDBRemoteCommunication::PacketResult 2252 GDBRemoteCommunicationServerLLGS::Handle_memory_read( 2253 StringExtractorGDBRemote &packet) { 2254 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 2255 2256 if (!m_debugged_process_up || 2257 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2258 LLDB_LOGF( 2259 log, 2260 "GDBRemoteCommunicationServerLLGS::%s failed, no process available", 2261 __FUNCTION__); 2262 return SendErrorResponse(0x15); 2263 } 2264 2265 // Parse out the memory address. 2266 packet.SetFilePos(strlen("m")); 2267 if (packet.GetBytesLeft() < 1) 2268 return SendIllFormedResponse(packet, "Too short m packet"); 2269 2270 // Read the address. Punting on validation. 2271 // FIXME replace with Hex U64 read with no default value that fails on failed 2272 // read. 2273 const lldb::addr_t read_addr = packet.GetHexMaxU64(false, 0); 2274 2275 // Validate comma. 2276 if ((packet.GetBytesLeft() < 1) || (packet.GetChar() != ',')) 2277 return SendIllFormedResponse(packet, "Comma sep missing in m packet"); 2278 2279 // Get # bytes to read. 2280 if (packet.GetBytesLeft() < 1) 2281 return SendIllFormedResponse(packet, "Length missing in m packet"); 2282 2283 const uint64_t byte_count = packet.GetHexMaxU64(false, 0); 2284 if (byte_count == 0) { 2285 LLDB_LOGF(log, 2286 "GDBRemoteCommunicationServerLLGS::%s nothing to read: " 2287 "zero-length packet", 2288 __FUNCTION__); 2289 return SendOKResponse(); 2290 } 2291 2292 // Allocate the response buffer. 2293 std::string buf(byte_count, '\0'); 2294 if (buf.empty()) 2295 return SendErrorResponse(0x78); 2296 2297 // Retrieve the process memory. 2298 size_t bytes_read = 0; 2299 Status error = m_debugged_process_up->ReadMemoryWithoutTrap( 2300 read_addr, &buf[0], byte_count, bytes_read); 2301 if (error.Fail()) { 2302 LLDB_LOGF(log, 2303 "GDBRemoteCommunicationServerLLGS::%s pid %" PRIu64 2304 " mem 0x%" PRIx64 ": failed to read. Error: %s", 2305 __FUNCTION__, m_debugged_process_up->GetID(), read_addr, 2306 error.AsCString()); 2307 return SendErrorResponse(0x08); 2308 } 2309 2310 if (bytes_read == 0) { 2311 LLDB_LOGF(log, 2312 "GDBRemoteCommunicationServerLLGS::%s pid %" PRIu64 2313 " mem 0x%" PRIx64 ": read 0 of %" PRIu64 " requested bytes", 2314 __FUNCTION__, m_debugged_process_up->GetID(), read_addr, 2315 byte_count); 2316 return SendErrorResponse(0x08); 2317 } 2318 2319 StreamGDBRemote response; 2320 packet.SetFilePos(0); 2321 char kind = packet.GetChar('?'); 2322 if (kind == 'x') 2323 response.PutEscapedBytes(buf.data(), byte_count); 2324 else { 2325 assert(kind == 'm'); 2326 for (size_t i = 0; i < bytes_read; ++i) 2327 response.PutHex8(buf[i]); 2328 } 2329 2330 return SendPacketNoLock(response.GetString()); 2331 } 2332 2333 GDBRemoteCommunication::PacketResult 2334 GDBRemoteCommunicationServerLLGS::Handle_M(StringExtractorGDBRemote &packet) { 2335 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 2336 2337 if (!m_debugged_process_up || 2338 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2339 LLDB_LOGF( 2340 log, 2341 "GDBRemoteCommunicationServerLLGS::%s failed, no process available", 2342 __FUNCTION__); 2343 return SendErrorResponse(0x15); 2344 } 2345 2346 // Parse out the memory address. 2347 packet.SetFilePos(strlen("M")); 2348 if (packet.GetBytesLeft() < 1) 2349 return SendIllFormedResponse(packet, "Too short M packet"); 2350 2351 // Read the address. Punting on validation. 2352 // FIXME replace with Hex U64 read with no default value that fails on failed 2353 // read. 2354 const lldb::addr_t write_addr = packet.GetHexMaxU64(false, 0); 2355 2356 // Validate comma. 2357 if ((packet.GetBytesLeft() < 1) || (packet.GetChar() != ',')) 2358 return SendIllFormedResponse(packet, "Comma sep missing in M packet"); 2359 2360 // Get # bytes to read. 2361 if (packet.GetBytesLeft() < 1) 2362 return SendIllFormedResponse(packet, "Length missing in M packet"); 2363 2364 const uint64_t byte_count = packet.GetHexMaxU64(false, 0); 2365 if (byte_count == 0) { 2366 LLDB_LOG(log, "nothing to write: zero-length packet"); 2367 return PacketResult::Success; 2368 } 2369 2370 // Validate colon. 2371 if ((packet.GetBytesLeft() < 1) || (packet.GetChar() != ':')) 2372 return SendIllFormedResponse( 2373 packet, "Comma sep missing in M packet after byte length"); 2374 2375 // Allocate the conversion buffer. 2376 std::vector<uint8_t> buf(byte_count, 0); 2377 if (buf.empty()) 2378 return SendErrorResponse(0x78); 2379 2380 // Convert the hex memory write contents to bytes. 2381 StreamGDBRemote response; 2382 const uint64_t convert_count = packet.GetHexBytes(buf, 0); 2383 if (convert_count != byte_count) { 2384 LLDB_LOG(log, 2385 "pid {0} mem {1:x}: asked to write {2} bytes, but only found {3} " 2386 "to convert.", 2387 m_debugged_process_up->GetID(), write_addr, byte_count, 2388 convert_count); 2389 return SendIllFormedResponse(packet, "M content byte length specified did " 2390 "not match hex-encoded content " 2391 "length"); 2392 } 2393 2394 // Write the process memory. 2395 size_t bytes_written = 0; 2396 Status error = m_debugged_process_up->WriteMemory(write_addr, &buf[0], 2397 byte_count, bytes_written); 2398 if (error.Fail()) { 2399 LLDB_LOG(log, "pid {0} mem {1:x}: failed to write. Error: {2}", 2400 m_debugged_process_up->GetID(), write_addr, error); 2401 return SendErrorResponse(0x09); 2402 } 2403 2404 if (bytes_written == 0) { 2405 LLDB_LOG(log, "pid {0} mem {1:x}: wrote 0 of {2} requested bytes", 2406 m_debugged_process_up->GetID(), write_addr, byte_count); 2407 return SendErrorResponse(0x09); 2408 } 2409 2410 return SendOKResponse(); 2411 } 2412 2413 GDBRemoteCommunication::PacketResult 2414 GDBRemoteCommunicationServerLLGS::Handle_qMemoryRegionInfoSupported( 2415 StringExtractorGDBRemote &packet) { 2416 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 2417 2418 // Currently only the NativeProcessProtocol knows if it can handle a 2419 // qMemoryRegionInfoSupported request, but we're not guaranteed to be 2420 // attached to a process. For now we'll assume the client only asks this 2421 // when a process is being debugged. 2422 2423 // Ensure we have a process running; otherwise, we can't figure this out 2424 // since we won't have a NativeProcessProtocol. 2425 if (!m_debugged_process_up || 2426 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2427 LLDB_LOGF( 2428 log, 2429 "GDBRemoteCommunicationServerLLGS::%s failed, no process available", 2430 __FUNCTION__); 2431 return SendErrorResponse(0x15); 2432 } 2433 2434 // Test if we can get any region back when asking for the region around NULL. 2435 MemoryRegionInfo region_info; 2436 const Status error = 2437 m_debugged_process_up->GetMemoryRegionInfo(0, region_info); 2438 if (error.Fail()) { 2439 // We don't support memory region info collection for this 2440 // NativeProcessProtocol. 2441 return SendUnimplementedResponse(""); 2442 } 2443 2444 return SendOKResponse(); 2445 } 2446 2447 GDBRemoteCommunication::PacketResult 2448 GDBRemoteCommunicationServerLLGS::Handle_qMemoryRegionInfo( 2449 StringExtractorGDBRemote &packet) { 2450 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 2451 2452 // Ensure we have a process. 2453 if (!m_debugged_process_up || 2454 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2455 LLDB_LOGF( 2456 log, 2457 "GDBRemoteCommunicationServerLLGS::%s failed, no process available", 2458 __FUNCTION__); 2459 return SendErrorResponse(0x15); 2460 } 2461 2462 // Parse out the memory address. 2463 packet.SetFilePos(strlen("qMemoryRegionInfo:")); 2464 if (packet.GetBytesLeft() < 1) 2465 return SendIllFormedResponse(packet, "Too short qMemoryRegionInfo: packet"); 2466 2467 // Read the address. Punting on validation. 2468 const lldb::addr_t read_addr = packet.GetHexMaxU64(false, 0); 2469 2470 StreamGDBRemote response; 2471 2472 // Get the memory region info for the target address. 2473 MemoryRegionInfo region_info; 2474 const Status error = 2475 m_debugged_process_up->GetMemoryRegionInfo(read_addr, region_info); 2476 if (error.Fail()) { 2477 // Return the error message. 2478 2479 response.PutCString("error:"); 2480 response.PutStringAsRawHex8(error.AsCString()); 2481 response.PutChar(';'); 2482 } else { 2483 // Range start and size. 2484 response.Printf("start:%" PRIx64 ";size:%" PRIx64 ";", 2485 region_info.GetRange().GetRangeBase(), 2486 region_info.GetRange().GetByteSize()); 2487 2488 // Permissions. 2489 if (region_info.GetReadable() || region_info.GetWritable() || 2490 region_info.GetExecutable()) { 2491 // Write permissions info. 2492 response.PutCString("permissions:"); 2493 2494 if (region_info.GetReadable()) 2495 response.PutChar('r'); 2496 if (region_info.GetWritable()) 2497 response.PutChar('w'); 2498 if (region_info.GetExecutable()) 2499 response.PutChar('x'); 2500 2501 response.PutChar(';'); 2502 } 2503 2504 // Name 2505 ConstString name = region_info.GetName(); 2506 if (name) { 2507 response.PutCString("name:"); 2508 response.PutStringAsRawHex8(name.AsCString()); 2509 response.PutChar(';'); 2510 } 2511 } 2512 2513 return SendPacketNoLock(response.GetString()); 2514 } 2515 2516 GDBRemoteCommunication::PacketResult 2517 GDBRemoteCommunicationServerLLGS::Handle_Z(StringExtractorGDBRemote &packet) { 2518 // Ensure we have a process. 2519 if (!m_debugged_process_up || 2520 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2521 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 2522 LLDB_LOG(log, "failed, no process available"); 2523 return SendErrorResponse(0x15); 2524 } 2525 2526 // Parse out software or hardware breakpoint or watchpoint requested. 2527 packet.SetFilePos(strlen("Z")); 2528 if (packet.GetBytesLeft() < 1) 2529 return SendIllFormedResponse( 2530 packet, "Too short Z packet, missing software/hardware specifier"); 2531 2532 bool want_breakpoint = true; 2533 bool want_hardware = false; 2534 uint32_t watch_flags = 0; 2535 2536 const GDBStoppointType stoppoint_type = 2537 GDBStoppointType(packet.GetS32(eStoppointInvalid)); 2538 switch (stoppoint_type) { 2539 case eBreakpointSoftware: 2540 want_hardware = false; 2541 want_breakpoint = true; 2542 break; 2543 case eBreakpointHardware: 2544 want_hardware = true; 2545 want_breakpoint = true; 2546 break; 2547 case eWatchpointWrite: 2548 watch_flags = 1; 2549 want_hardware = true; 2550 want_breakpoint = false; 2551 break; 2552 case eWatchpointRead: 2553 watch_flags = 2; 2554 want_hardware = true; 2555 want_breakpoint = false; 2556 break; 2557 case eWatchpointReadWrite: 2558 watch_flags = 3; 2559 want_hardware = true; 2560 want_breakpoint = false; 2561 break; 2562 case eStoppointInvalid: 2563 return SendIllFormedResponse( 2564 packet, "Z packet had invalid software/hardware specifier"); 2565 } 2566 2567 if ((packet.GetBytesLeft() < 1) || packet.GetChar() != ',') 2568 return SendIllFormedResponse( 2569 packet, "Malformed Z packet, expecting comma after stoppoint type"); 2570 2571 // Parse out the stoppoint address. 2572 if (packet.GetBytesLeft() < 1) 2573 return SendIllFormedResponse(packet, "Too short Z packet, missing address"); 2574 const lldb::addr_t addr = packet.GetHexMaxU64(false, 0); 2575 2576 if ((packet.GetBytesLeft() < 1) || packet.GetChar() != ',') 2577 return SendIllFormedResponse( 2578 packet, "Malformed Z packet, expecting comma after address"); 2579 2580 // Parse out the stoppoint size (i.e. size hint for opcode size). 2581 const uint32_t size = 2582 packet.GetHexMaxU32(false, std::numeric_limits<uint32_t>::max()); 2583 if (size == std::numeric_limits<uint32_t>::max()) 2584 return SendIllFormedResponse( 2585 packet, "Malformed Z packet, failed to parse size argument"); 2586 2587 if (want_breakpoint) { 2588 // Try to set the breakpoint. 2589 const Status error = 2590 m_debugged_process_up->SetBreakpoint(addr, size, want_hardware); 2591 if (error.Success()) 2592 return SendOKResponse(); 2593 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_BREAKPOINTS)); 2594 LLDB_LOG(log, "pid {0} failed to set breakpoint: {1}", 2595 m_debugged_process_up->GetID(), error); 2596 return SendErrorResponse(0x09); 2597 } else { 2598 // Try to set the watchpoint. 2599 const Status error = m_debugged_process_up->SetWatchpoint( 2600 addr, size, watch_flags, want_hardware); 2601 if (error.Success()) 2602 return SendOKResponse(); 2603 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_WATCHPOINTS)); 2604 LLDB_LOG(log, "pid {0} failed to set watchpoint: {1}", 2605 m_debugged_process_up->GetID(), error); 2606 return SendErrorResponse(0x09); 2607 } 2608 } 2609 2610 GDBRemoteCommunication::PacketResult 2611 GDBRemoteCommunicationServerLLGS::Handle_z(StringExtractorGDBRemote &packet) { 2612 // Ensure we have a process. 2613 if (!m_debugged_process_up || 2614 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2615 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 2616 LLDB_LOG(log, "failed, no process available"); 2617 return SendErrorResponse(0x15); 2618 } 2619 2620 // Parse out software or hardware breakpoint or watchpoint requested. 2621 packet.SetFilePos(strlen("z")); 2622 if (packet.GetBytesLeft() < 1) 2623 return SendIllFormedResponse( 2624 packet, "Too short z packet, missing software/hardware specifier"); 2625 2626 bool want_breakpoint = true; 2627 bool want_hardware = false; 2628 2629 const GDBStoppointType stoppoint_type = 2630 GDBStoppointType(packet.GetS32(eStoppointInvalid)); 2631 switch (stoppoint_type) { 2632 case eBreakpointHardware: 2633 want_breakpoint = true; 2634 want_hardware = true; 2635 break; 2636 case eBreakpointSoftware: 2637 want_breakpoint = true; 2638 break; 2639 case eWatchpointWrite: 2640 want_breakpoint = false; 2641 break; 2642 case eWatchpointRead: 2643 want_breakpoint = false; 2644 break; 2645 case eWatchpointReadWrite: 2646 want_breakpoint = false; 2647 break; 2648 default: 2649 return SendIllFormedResponse( 2650 packet, "z packet had invalid software/hardware specifier"); 2651 } 2652 2653 if ((packet.GetBytesLeft() < 1) || packet.GetChar() != ',') 2654 return SendIllFormedResponse( 2655 packet, "Malformed z packet, expecting comma after stoppoint type"); 2656 2657 // Parse out the stoppoint address. 2658 if (packet.GetBytesLeft() < 1) 2659 return SendIllFormedResponse(packet, "Too short z packet, missing address"); 2660 const lldb::addr_t addr = packet.GetHexMaxU64(false, 0); 2661 2662 if ((packet.GetBytesLeft() < 1) || packet.GetChar() != ',') 2663 return SendIllFormedResponse( 2664 packet, "Malformed z packet, expecting comma after address"); 2665 2666 /* 2667 // Parse out the stoppoint size (i.e. size hint for opcode size). 2668 const uint32_t size = packet.GetHexMaxU32 (false, 2669 std::numeric_limits<uint32_t>::max ()); 2670 if (size == std::numeric_limits<uint32_t>::max ()) 2671 return SendIllFormedResponse(packet, "Malformed z packet, failed to parse 2672 size argument"); 2673 */ 2674 2675 if (want_breakpoint) { 2676 // Try to clear the breakpoint. 2677 const Status error = 2678 m_debugged_process_up->RemoveBreakpoint(addr, want_hardware); 2679 if (error.Success()) 2680 return SendOKResponse(); 2681 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_BREAKPOINTS)); 2682 LLDB_LOG(log, "pid {0} failed to remove breakpoint: {1}", 2683 m_debugged_process_up->GetID(), error); 2684 return SendErrorResponse(0x09); 2685 } else { 2686 // Try to clear the watchpoint. 2687 const Status error = m_debugged_process_up->RemoveWatchpoint(addr); 2688 if (error.Success()) 2689 return SendOKResponse(); 2690 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_WATCHPOINTS)); 2691 LLDB_LOG(log, "pid {0} failed to remove watchpoint: {1}", 2692 m_debugged_process_up->GetID(), error); 2693 return SendErrorResponse(0x09); 2694 } 2695 } 2696 2697 GDBRemoteCommunication::PacketResult 2698 GDBRemoteCommunicationServerLLGS::Handle_s(StringExtractorGDBRemote &packet) { 2699 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_THREAD)); 2700 2701 // Ensure we have a process. 2702 if (!m_debugged_process_up || 2703 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2704 LLDB_LOGF( 2705 log, 2706 "GDBRemoteCommunicationServerLLGS::%s failed, no process available", 2707 __FUNCTION__); 2708 return SendErrorResponse(0x32); 2709 } 2710 2711 // We first try to use a continue thread id. If any one or any all set, use 2712 // the current thread. Bail out if we don't have a thread id. 2713 lldb::tid_t tid = GetContinueThreadID(); 2714 if (tid == 0 || tid == LLDB_INVALID_THREAD_ID) 2715 tid = GetCurrentThreadID(); 2716 if (tid == LLDB_INVALID_THREAD_ID) 2717 return SendErrorResponse(0x33); 2718 2719 // Double check that we have such a thread. 2720 // TODO investigate: on MacOSX we might need to do an UpdateThreads () here. 2721 NativeThreadProtocol *thread = m_debugged_process_up->GetThreadByID(tid); 2722 if (!thread) 2723 return SendErrorResponse(0x33); 2724 2725 // Create the step action for the given thread. 2726 ResumeAction action = {tid, eStateStepping, 0}; 2727 2728 // Setup the actions list. 2729 ResumeActionList actions; 2730 actions.Append(action); 2731 2732 // All other threads stop while we're single stepping a thread. 2733 actions.SetDefaultThreadActionIfNeeded(eStateStopped, 0); 2734 Status error = m_debugged_process_up->Resume(actions); 2735 if (error.Fail()) { 2736 LLDB_LOGF(log, 2737 "GDBRemoteCommunicationServerLLGS::%s pid %" PRIu64 2738 " tid %" PRIu64 " Resume() failed with error: %s", 2739 __FUNCTION__, m_debugged_process_up->GetID(), tid, 2740 error.AsCString()); 2741 return SendErrorResponse(0x49); 2742 } 2743 2744 // No response here - the stop or exit will come from the resulting action. 2745 return PacketResult::Success; 2746 } 2747 2748 llvm::Expected<std::unique_ptr<llvm::MemoryBuffer>> 2749 GDBRemoteCommunicationServerLLGS::ReadXferObject(llvm::StringRef object, 2750 llvm::StringRef annex) { 2751 if (object == "auxv") { 2752 // Make sure we have a valid process. 2753 if (!m_debugged_process_up || 2754 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 2755 return llvm::createStringError(llvm::inconvertibleErrorCode(), 2756 "No process available"); 2757 } 2758 2759 // Grab the auxv data. 2760 auto buffer_or_error = m_debugged_process_up->GetAuxvData(); 2761 if (!buffer_or_error) 2762 return llvm::errorCodeToError(buffer_or_error.getError()); 2763 return std::move(*buffer_or_error); 2764 } 2765 2766 if (object == "libraries-svr4") { 2767 auto library_list = m_debugged_process_up->GetLoadedSVR4Libraries(); 2768 if (!library_list) 2769 return library_list.takeError(); 2770 2771 StreamString response; 2772 response.Printf("<library-list-svr4 version=\"1.0\">"); 2773 for (auto const &library : *library_list) { 2774 response.Printf("<library name=\"%s\" ", 2775 XMLEncodeAttributeValue(library.name.c_str()).c_str()); 2776 response.Printf("lm=\"0x%" PRIx64 "\" ", library.link_map); 2777 response.Printf("l_addr=\"0x%" PRIx64 "\" ", library.base_addr); 2778 response.Printf("l_ld=\"0x%" PRIx64 "\" />", library.ld_addr); 2779 } 2780 response.Printf("</library-list-svr4>"); 2781 return MemoryBuffer::getMemBufferCopy(response.GetString(), __FUNCTION__); 2782 } 2783 2784 return llvm::make_error<PacketUnimplementedError>( 2785 "Xfer object not supported"); 2786 } 2787 2788 GDBRemoteCommunication::PacketResult 2789 GDBRemoteCommunicationServerLLGS::Handle_qXfer( 2790 StringExtractorGDBRemote &packet) { 2791 SmallVector<StringRef, 5> fields; 2792 // The packet format is "qXfer:<object>:<action>:<annex>:offset,length" 2793 StringRef(packet.GetStringRef()).split(fields, ':', 4); 2794 if (fields.size() != 5) 2795 return SendIllFormedResponse(packet, "malformed qXfer packet"); 2796 StringRef &xfer_object = fields[1]; 2797 StringRef &xfer_action = fields[2]; 2798 StringRef &xfer_annex = fields[3]; 2799 StringExtractor offset_data(fields[4]); 2800 if (xfer_action != "read") 2801 return SendUnimplementedResponse("qXfer action not supported"); 2802 // Parse offset. 2803 const uint64_t xfer_offset = 2804 offset_data.GetHexMaxU64(false, std::numeric_limits<uint64_t>::max()); 2805 if (xfer_offset == std::numeric_limits<uint64_t>::max()) 2806 return SendIllFormedResponse(packet, "qXfer packet missing offset"); 2807 // Parse out comma. 2808 if (offset_data.GetChar() != ',') 2809 return SendIllFormedResponse(packet, 2810 "qXfer packet missing comma after offset"); 2811 // Parse out the length. 2812 const uint64_t xfer_length = 2813 offset_data.GetHexMaxU64(false, std::numeric_limits<uint64_t>::max()); 2814 if (xfer_length == std::numeric_limits<uint64_t>::max()) 2815 return SendIllFormedResponse(packet, "qXfer packet missing length"); 2816 2817 // Get a previously constructed buffer if it exists or create it now. 2818 std::string buffer_key = (xfer_object + xfer_action + xfer_annex).str(); 2819 auto buffer_it = m_xfer_buffer_map.find(buffer_key); 2820 if (buffer_it == m_xfer_buffer_map.end()) { 2821 auto buffer_up = ReadXferObject(xfer_object, xfer_annex); 2822 if (!buffer_up) 2823 return SendErrorResponse(buffer_up.takeError()); 2824 buffer_it = m_xfer_buffer_map 2825 .insert(std::make_pair(buffer_key, std::move(*buffer_up))) 2826 .first; 2827 } 2828 2829 // Send back the response 2830 StreamGDBRemote response; 2831 bool done_with_buffer = false; 2832 llvm::StringRef buffer = buffer_it->second->getBuffer(); 2833 if (xfer_offset >= buffer.size()) { 2834 // We have nothing left to send. Mark the buffer as complete. 2835 response.PutChar('l'); 2836 done_with_buffer = true; 2837 } else { 2838 // Figure out how many bytes are available starting at the given offset. 2839 buffer = buffer.drop_front(xfer_offset); 2840 // Mark the response type according to whether we're reading the remainder 2841 // of the data. 2842 if (xfer_length >= buffer.size()) { 2843 // There will be nothing left to read after this 2844 response.PutChar('l'); 2845 done_with_buffer = true; 2846 } else { 2847 // There will still be bytes to read after this request. 2848 response.PutChar('m'); 2849 buffer = buffer.take_front(xfer_length); 2850 } 2851 // Now write the data in encoded binary form. 2852 response.PutEscapedBytes(buffer.data(), buffer.size()); 2853 } 2854 2855 if (done_with_buffer) 2856 m_xfer_buffer_map.erase(buffer_it); 2857 2858 return SendPacketNoLock(response.GetString()); 2859 } 2860 2861 GDBRemoteCommunication::PacketResult 2862 GDBRemoteCommunicationServerLLGS::Handle_QSaveRegisterState( 2863 StringExtractorGDBRemote &packet) { 2864 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 2865 2866 // Move past packet name. 2867 packet.SetFilePos(strlen("QSaveRegisterState")); 2868 2869 // Get the thread to use. 2870 NativeThreadProtocol *thread = GetThreadFromSuffix(packet); 2871 if (!thread) { 2872 if (m_thread_suffix_supported) 2873 return SendIllFormedResponse( 2874 packet, "No thread specified in QSaveRegisterState packet"); 2875 else 2876 return SendIllFormedResponse(packet, 2877 "No thread was is set with the Hg packet"); 2878 } 2879 2880 // Grab the register context for the thread. 2881 NativeRegisterContext& reg_context = thread->GetRegisterContext(); 2882 2883 // Save registers to a buffer. 2884 DataBufferSP register_data_sp; 2885 Status error = reg_context.ReadAllRegisterValues(register_data_sp); 2886 if (error.Fail()) { 2887 LLDB_LOG(log, "pid {0} failed to save all register values: {1}", 2888 m_debugged_process_up->GetID(), error); 2889 return SendErrorResponse(0x75); 2890 } 2891 2892 // Allocate a new save id. 2893 const uint32_t save_id = GetNextSavedRegistersID(); 2894 assert((m_saved_registers_map.find(save_id) == m_saved_registers_map.end()) && 2895 "GetNextRegisterSaveID() returned an existing register save id"); 2896 2897 // Save the register data buffer under the save id. 2898 { 2899 std::lock_guard<std::mutex> guard(m_saved_registers_mutex); 2900 m_saved_registers_map[save_id] = register_data_sp; 2901 } 2902 2903 // Write the response. 2904 StreamGDBRemote response; 2905 response.Printf("%" PRIu32, save_id); 2906 return SendPacketNoLock(response.GetString()); 2907 } 2908 2909 GDBRemoteCommunication::PacketResult 2910 GDBRemoteCommunicationServerLLGS::Handle_QRestoreRegisterState( 2911 StringExtractorGDBRemote &packet) { 2912 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 2913 2914 // Parse out save id. 2915 packet.SetFilePos(strlen("QRestoreRegisterState:")); 2916 if (packet.GetBytesLeft() < 1) 2917 return SendIllFormedResponse( 2918 packet, "QRestoreRegisterState packet missing register save id"); 2919 2920 const uint32_t save_id = packet.GetU32(0); 2921 if (save_id == 0) { 2922 LLDB_LOG(log, "QRestoreRegisterState packet has malformed save id, " 2923 "expecting decimal uint32_t"); 2924 return SendErrorResponse(0x76); 2925 } 2926 2927 // Get the thread to use. 2928 NativeThreadProtocol *thread = GetThreadFromSuffix(packet); 2929 if (!thread) { 2930 if (m_thread_suffix_supported) 2931 return SendIllFormedResponse( 2932 packet, "No thread specified in QRestoreRegisterState packet"); 2933 else 2934 return SendIllFormedResponse(packet, 2935 "No thread was is set with the Hg packet"); 2936 } 2937 2938 // Grab the register context for the thread. 2939 NativeRegisterContext ®_context = thread->GetRegisterContext(); 2940 2941 // Retrieve register state buffer, then remove from the list. 2942 DataBufferSP register_data_sp; 2943 { 2944 std::lock_guard<std::mutex> guard(m_saved_registers_mutex); 2945 2946 // Find the register set buffer for the given save id. 2947 auto it = m_saved_registers_map.find(save_id); 2948 if (it == m_saved_registers_map.end()) { 2949 LLDB_LOG(log, 2950 "pid {0} does not have a register set save buffer for id {1}", 2951 m_debugged_process_up->GetID(), save_id); 2952 return SendErrorResponse(0x77); 2953 } 2954 register_data_sp = it->second; 2955 2956 // Remove it from the map. 2957 m_saved_registers_map.erase(it); 2958 } 2959 2960 Status error = reg_context.WriteAllRegisterValues(register_data_sp); 2961 if (error.Fail()) { 2962 LLDB_LOG(log, "pid {0} failed to restore all register values: {1}", 2963 m_debugged_process_up->GetID(), error); 2964 return SendErrorResponse(0x77); 2965 } 2966 2967 return SendOKResponse(); 2968 } 2969 2970 GDBRemoteCommunication::PacketResult 2971 GDBRemoteCommunicationServerLLGS::Handle_vAttach( 2972 StringExtractorGDBRemote &packet) { 2973 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 2974 2975 // Consume the ';' after vAttach. 2976 packet.SetFilePos(strlen("vAttach")); 2977 if (!packet.GetBytesLeft() || packet.GetChar() != ';') 2978 return SendIllFormedResponse(packet, "vAttach missing expected ';'"); 2979 2980 // Grab the PID to which we will attach (assume hex encoding). 2981 lldb::pid_t pid = packet.GetU32(LLDB_INVALID_PROCESS_ID, 16); 2982 if (pid == LLDB_INVALID_PROCESS_ID) 2983 return SendIllFormedResponse(packet, 2984 "vAttach failed to parse the process id"); 2985 2986 // Attempt to attach. 2987 LLDB_LOGF(log, 2988 "GDBRemoteCommunicationServerLLGS::%s attempting to attach to " 2989 "pid %" PRIu64, 2990 __FUNCTION__, pid); 2991 2992 Status error = AttachToProcess(pid); 2993 2994 if (error.Fail()) { 2995 LLDB_LOGF(log, 2996 "GDBRemoteCommunicationServerLLGS::%s failed to attach to " 2997 "pid %" PRIu64 ": %s\n", 2998 __FUNCTION__, pid, error.AsCString()); 2999 return SendErrorResponse(error); 3000 } 3001 3002 // Notify we attached by sending a stop packet. 3003 return SendStopReasonForState(m_debugged_process_up->GetState()); 3004 } 3005 3006 GDBRemoteCommunication::PacketResult 3007 GDBRemoteCommunicationServerLLGS::Handle_D(StringExtractorGDBRemote &packet) { 3008 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 3009 3010 StopSTDIOForwarding(); 3011 3012 // Fail if we don't have a current process. 3013 if (!m_debugged_process_up || 3014 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) { 3015 LLDB_LOGF( 3016 log, 3017 "GDBRemoteCommunicationServerLLGS::%s failed, no process available", 3018 __FUNCTION__); 3019 return SendErrorResponse(0x15); 3020 } 3021 3022 lldb::pid_t pid = LLDB_INVALID_PROCESS_ID; 3023 3024 // Consume the ';' after D. 3025 packet.SetFilePos(1); 3026 if (packet.GetBytesLeft()) { 3027 if (packet.GetChar() != ';') 3028 return SendIllFormedResponse(packet, "D missing expected ';'"); 3029 3030 // Grab the PID from which we will detach (assume hex encoding). 3031 pid = packet.GetU32(LLDB_INVALID_PROCESS_ID, 16); 3032 if (pid == LLDB_INVALID_PROCESS_ID) 3033 return SendIllFormedResponse(packet, "D failed to parse the process id"); 3034 } 3035 3036 if (pid != LLDB_INVALID_PROCESS_ID && m_debugged_process_up->GetID() != pid) { 3037 return SendIllFormedResponse(packet, "Invalid pid"); 3038 } 3039 3040 const Status error = m_debugged_process_up->Detach(); 3041 if (error.Fail()) { 3042 LLDB_LOGF(log, 3043 "GDBRemoteCommunicationServerLLGS::%s failed to detach from " 3044 "pid %" PRIu64 ": %s\n", 3045 __FUNCTION__, m_debugged_process_up->GetID(), error.AsCString()); 3046 return SendErrorResponse(0x01); 3047 } 3048 3049 return SendOKResponse(); 3050 } 3051 3052 GDBRemoteCommunication::PacketResult 3053 GDBRemoteCommunicationServerLLGS::Handle_qThreadStopInfo( 3054 StringExtractorGDBRemote &packet) { 3055 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 3056 3057 packet.SetFilePos(strlen("qThreadStopInfo")); 3058 const lldb::tid_t tid = packet.GetHexMaxU32(false, LLDB_INVALID_THREAD_ID); 3059 if (tid == LLDB_INVALID_THREAD_ID) { 3060 LLDB_LOGF(log, 3061 "GDBRemoteCommunicationServerLLGS::%s failed, could not " 3062 "parse thread id from request \"%s\"", 3063 __FUNCTION__, packet.GetStringRef().c_str()); 3064 return SendErrorResponse(0x15); 3065 } 3066 return SendStopReplyPacketForThread(tid); 3067 } 3068 3069 GDBRemoteCommunication::PacketResult 3070 GDBRemoteCommunicationServerLLGS::Handle_jThreadsInfo( 3071 StringExtractorGDBRemote &) { 3072 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_THREAD)); 3073 3074 // Ensure we have a debugged process. 3075 if (!m_debugged_process_up || 3076 (m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID)) 3077 return SendErrorResponse(50); 3078 LLDB_LOG(log, "preparing packet for pid {0}", m_debugged_process_up->GetID()); 3079 3080 StreamString response; 3081 const bool threads_with_valid_stop_info_only = false; 3082 JSONArray::SP threads_array_sp = GetJSONThreadsInfo( 3083 *m_debugged_process_up, threads_with_valid_stop_info_only); 3084 if (!threads_array_sp) { 3085 LLDB_LOG(log, "failed to prepare a packet for pid {0}", 3086 m_debugged_process_up->GetID()); 3087 return SendErrorResponse(52); 3088 } 3089 3090 threads_array_sp->Write(response); 3091 StreamGDBRemote escaped_response; 3092 escaped_response.PutEscapedBytes(response.GetData(), response.GetSize()); 3093 return SendPacketNoLock(escaped_response.GetString()); 3094 } 3095 3096 GDBRemoteCommunication::PacketResult 3097 GDBRemoteCommunicationServerLLGS::Handle_qWatchpointSupportInfo( 3098 StringExtractorGDBRemote &packet) { 3099 // Fail if we don't have a current process. 3100 if (!m_debugged_process_up || 3101 m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID) 3102 return SendErrorResponse(68); 3103 3104 packet.SetFilePos(strlen("qWatchpointSupportInfo")); 3105 if (packet.GetBytesLeft() == 0) 3106 return SendOKResponse(); 3107 if (packet.GetChar() != ':') 3108 return SendErrorResponse(67); 3109 3110 auto hw_debug_cap = m_debugged_process_up->GetHardwareDebugSupportInfo(); 3111 3112 StreamGDBRemote response; 3113 if (hw_debug_cap == llvm::None) 3114 response.Printf("num:0;"); 3115 else 3116 response.Printf("num:%d;", hw_debug_cap->second); 3117 3118 return SendPacketNoLock(response.GetString()); 3119 } 3120 3121 GDBRemoteCommunication::PacketResult 3122 GDBRemoteCommunicationServerLLGS::Handle_qFileLoadAddress( 3123 StringExtractorGDBRemote &packet) { 3124 // Fail if we don't have a current process. 3125 if (!m_debugged_process_up || 3126 m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID) 3127 return SendErrorResponse(67); 3128 3129 packet.SetFilePos(strlen("qFileLoadAddress:")); 3130 if (packet.GetBytesLeft() == 0) 3131 return SendErrorResponse(68); 3132 3133 std::string file_name; 3134 packet.GetHexByteString(file_name); 3135 3136 lldb::addr_t file_load_address = LLDB_INVALID_ADDRESS; 3137 Status error = 3138 m_debugged_process_up->GetFileLoadAddress(file_name, file_load_address); 3139 if (error.Fail()) 3140 return SendErrorResponse(69); 3141 3142 if (file_load_address == LLDB_INVALID_ADDRESS) 3143 return SendErrorResponse(1); // File not loaded 3144 3145 StreamGDBRemote response; 3146 response.PutHex64(file_load_address); 3147 return SendPacketNoLock(response.GetString()); 3148 } 3149 3150 GDBRemoteCommunication::PacketResult 3151 GDBRemoteCommunicationServerLLGS::Handle_QPassSignals( 3152 StringExtractorGDBRemote &packet) { 3153 std::vector<int> signals; 3154 packet.SetFilePos(strlen("QPassSignals:")); 3155 3156 // Read sequence of hex signal numbers divided by a semicolon and optionally 3157 // spaces. 3158 while (packet.GetBytesLeft() > 0) { 3159 int signal = packet.GetS32(-1, 16); 3160 if (signal < 0) 3161 return SendIllFormedResponse(packet, "Failed to parse signal number."); 3162 signals.push_back(signal); 3163 3164 packet.SkipSpaces(); 3165 char separator = packet.GetChar(); 3166 if (separator == '\0') 3167 break; // End of string 3168 if (separator != ';') 3169 return SendIllFormedResponse(packet, "Invalid separator," 3170 " expected semicolon."); 3171 } 3172 3173 // Fail if we don't have a current process. 3174 if (!m_debugged_process_up) 3175 return SendErrorResponse(68); 3176 3177 Status error = m_debugged_process_up->IgnoreSignals(signals); 3178 if (error.Fail()) 3179 return SendErrorResponse(69); 3180 3181 return SendOKResponse(); 3182 } 3183 3184 void GDBRemoteCommunicationServerLLGS::MaybeCloseInferiorTerminalConnection() { 3185 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 3186 3187 // Tell the stdio connection to shut down. 3188 if (m_stdio_communication.IsConnected()) { 3189 auto connection = m_stdio_communication.GetConnection(); 3190 if (connection) { 3191 Status error; 3192 connection->Disconnect(&error); 3193 3194 if (error.Success()) { 3195 LLDB_LOGF(log, 3196 "GDBRemoteCommunicationServerLLGS::%s disconnect process " 3197 "terminal stdio - SUCCESS", 3198 __FUNCTION__); 3199 } else { 3200 LLDB_LOGF(log, 3201 "GDBRemoteCommunicationServerLLGS::%s disconnect process " 3202 "terminal stdio - FAIL: %s", 3203 __FUNCTION__, error.AsCString()); 3204 } 3205 } 3206 } 3207 } 3208 3209 NativeThreadProtocol *GDBRemoteCommunicationServerLLGS::GetThreadFromSuffix( 3210 StringExtractorGDBRemote &packet) { 3211 // We have no thread if we don't have a process. 3212 if (!m_debugged_process_up || 3213 m_debugged_process_up->GetID() == LLDB_INVALID_PROCESS_ID) 3214 return nullptr; 3215 3216 // If the client hasn't asked for thread suffix support, there will not be a 3217 // thread suffix. Use the current thread in that case. 3218 if (!m_thread_suffix_supported) { 3219 const lldb::tid_t current_tid = GetCurrentThreadID(); 3220 if (current_tid == LLDB_INVALID_THREAD_ID) 3221 return nullptr; 3222 else if (current_tid == 0) { 3223 // Pick a thread. 3224 return m_debugged_process_up->GetThreadAtIndex(0); 3225 } else 3226 return m_debugged_process_up->GetThreadByID(current_tid); 3227 } 3228 3229 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_THREAD)); 3230 3231 // Parse out the ';'. 3232 if (packet.GetBytesLeft() < 1 || packet.GetChar() != ';') { 3233 LLDB_LOGF(log, 3234 "GDBRemoteCommunicationServerLLGS::%s gdb-remote parse " 3235 "error: expected ';' prior to start of thread suffix: packet " 3236 "contents = '%s'", 3237 __FUNCTION__, packet.GetStringRef().c_str()); 3238 return nullptr; 3239 } 3240 3241 if (!packet.GetBytesLeft()) 3242 return nullptr; 3243 3244 // Parse out thread: portion. 3245 if (strncmp(packet.Peek(), "thread:", strlen("thread:")) != 0) { 3246 LLDB_LOGF(log, 3247 "GDBRemoteCommunicationServerLLGS::%s gdb-remote parse " 3248 "error: expected 'thread:' but not found, packet contents = " 3249 "'%s'", 3250 __FUNCTION__, packet.GetStringRef().c_str()); 3251 return nullptr; 3252 } 3253 packet.SetFilePos(packet.GetFilePos() + strlen("thread:")); 3254 const lldb::tid_t tid = packet.GetHexMaxU64(false, 0); 3255 if (tid != 0) 3256 return m_debugged_process_up->GetThreadByID(tid); 3257 3258 return nullptr; 3259 } 3260 3261 lldb::tid_t GDBRemoteCommunicationServerLLGS::GetCurrentThreadID() const { 3262 if (m_current_tid == 0 || m_current_tid == LLDB_INVALID_THREAD_ID) { 3263 // Use whatever the debug process says is the current thread id since the 3264 // protocol either didn't specify or specified we want any/all threads 3265 // marked as the current thread. 3266 if (!m_debugged_process_up) 3267 return LLDB_INVALID_THREAD_ID; 3268 return m_debugged_process_up->GetCurrentThreadID(); 3269 } 3270 // Use the specific current thread id set by the gdb remote protocol. 3271 return m_current_tid; 3272 } 3273 3274 uint32_t GDBRemoteCommunicationServerLLGS::GetNextSavedRegistersID() { 3275 std::lock_guard<std::mutex> guard(m_saved_registers_mutex); 3276 return m_next_saved_registers_id++; 3277 } 3278 3279 void GDBRemoteCommunicationServerLLGS::ClearProcessSpecificData() { 3280 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS)); 3281 3282 LLDB_LOG(log, "clearing {0} xfer buffers", m_xfer_buffer_map.size()); 3283 m_xfer_buffer_map.clear(); 3284 } 3285 3286 FileSpec 3287 GDBRemoteCommunicationServerLLGS::FindModuleFile(const std::string &module_path, 3288 const ArchSpec &arch) { 3289 if (m_debugged_process_up) { 3290 FileSpec file_spec; 3291 if (m_debugged_process_up 3292 ->GetLoadedModuleFileSpec(module_path.c_str(), file_spec) 3293 .Success()) { 3294 if (FileSystem::Instance().Exists(file_spec)) 3295 return file_spec; 3296 } 3297 } 3298 3299 return GDBRemoteCommunicationServerCommon::FindModuleFile(module_path, arch); 3300 } 3301 3302 std::string GDBRemoteCommunicationServerLLGS::XMLEncodeAttributeValue( 3303 llvm::StringRef value) { 3304 std::string result; 3305 for (const char &c : value) { 3306 switch (c) { 3307 case '\'': 3308 result += "'"; 3309 break; 3310 case '"': 3311 result += """; 3312 break; 3313 case '<': 3314 result += "<"; 3315 break; 3316 case '>': 3317 result += ">"; 3318 break; 3319 default: 3320 result += c; 3321 break; 3322 } 3323 } 3324 return result; 3325 }