//===-- GDBRemoteCommunicationServerLLGS.cpp ------------------------------===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// #include #include "lldb/Host/Config.h" #include #include #include #include #include #include "GDBRemoteCommunicationServerLLGS.h" #include "lldb/Host/ConnectionFileDescriptor.h" #include "lldb/Host/Debug.h" #include "lldb/Host/File.h" #include "lldb/Host/FileAction.h" #include "lldb/Host/FileSystem.h" #include "lldb/Host/Host.h" #include "lldb/Host/HostInfo.h" #include "lldb/Host/PosixApi.h" #include "lldb/Host/Socket.h" #include "lldb/Host/common/NativeProcessProtocol.h" #include "lldb/Host/common/NativeRegisterContext.h" #include "lldb/Host/common/NativeThreadProtocol.h" #include "lldb/Target/MemoryRegionInfo.h" #include "lldb/Utility/Args.h" #include "lldb/Utility/DataBuffer.h" #include "lldb/Utility/Endian.h" #include "lldb/Utility/GDBRemote.h" #include "lldb/Utility/LLDBAssert.h" #include "lldb/Utility/LLDBLog.h" #include "lldb/Utility/Log.h" #include "lldb/Utility/State.h" #include "lldb/Utility/StreamString.h" #include "lldb/Utility/UnimplementedError.h" #include "lldb/Utility/UriParser.h" #include "llvm/Support/JSON.h" #include "llvm/Support/ScopedPrinter.h" #include "llvm/TargetParser/Triple.h" #include "ProcessGDBRemote.h" #include "ProcessGDBRemoteLog.h" #include "lldb/Utility/StringExtractorGDBRemote.h" using namespace lldb; using namespace lldb_private; using namespace lldb_private::process_gdb_remote; using namespace llvm; // GDBRemote Errors namespace { enum GDBRemoteServerError { // Set to the first unused error number in literal form below eErrorFirst = 29, eErrorNoProcess = eErrorFirst, eErrorResume, eErrorExitStatus }; } // GDBRemoteCommunicationServerLLGS constructor GDBRemoteCommunicationServerLLGS::GDBRemoteCommunicationServerLLGS( MainLoop &mainloop, NativeProcessProtocol::Manager &process_manager) : GDBRemoteCommunicationServerCommon(), m_mainloop(mainloop), m_process_manager(process_manager), m_current_process(nullptr), m_continue_process(nullptr), m_stdio_communication() { RegisterPacketHandlers(); } void GDBRemoteCommunicationServerLLGS::RegisterPacketHandlers() { RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_C, &GDBRemoteCommunicationServerLLGS::Handle_C); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_c, &GDBRemoteCommunicationServerLLGS::Handle_c); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_D, &GDBRemoteCommunicationServerLLGS::Handle_D); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_H, &GDBRemoteCommunicationServerLLGS::Handle_H); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_I, &GDBRemoteCommunicationServerLLGS::Handle_I); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_interrupt, &GDBRemoteCommunicationServerLLGS::Handle_interrupt); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_m, &GDBRemoteCommunicationServerLLGS::Handle_memory_read); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_M, &GDBRemoteCommunicationServerLLGS::Handle_M); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType__M, &GDBRemoteCommunicationServerLLGS::Handle__M); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType__m, &GDBRemoteCommunicationServerLLGS::Handle__m); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_p, &GDBRemoteCommunicationServerLLGS::Handle_p); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_P, &GDBRemoteCommunicationServerLLGS::Handle_P); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_qC, &GDBRemoteCommunicationServerLLGS::Handle_qC); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_T, &GDBRemoteCommunicationServerLLGS::Handle_T); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qfThreadInfo, &GDBRemoteCommunicationServerLLGS::Handle_qfThreadInfo); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qFileLoadAddress, &GDBRemoteCommunicationServerLLGS::Handle_qFileLoadAddress); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qGetWorkingDir, &GDBRemoteCommunicationServerLLGS::Handle_qGetWorkingDir); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_QThreadSuffixSupported, &GDBRemoteCommunicationServerLLGS::Handle_QThreadSuffixSupported); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_QListThreadsInStopReply, &GDBRemoteCommunicationServerLLGS::Handle_QListThreadsInStopReply); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qMemoryRegionInfo, &GDBRemoteCommunicationServerLLGS::Handle_qMemoryRegionInfo); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qMemoryRegionInfoSupported, &GDBRemoteCommunicationServerLLGS::Handle_qMemoryRegionInfoSupported); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qProcessInfo, &GDBRemoteCommunicationServerLLGS::Handle_qProcessInfo); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qRegisterInfo, &GDBRemoteCommunicationServerLLGS::Handle_qRegisterInfo); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_QRestoreRegisterState, &GDBRemoteCommunicationServerLLGS::Handle_QRestoreRegisterState); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_QSaveRegisterState, &GDBRemoteCommunicationServerLLGS::Handle_QSaveRegisterState); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_QSetDisableASLR, &GDBRemoteCommunicationServerLLGS::Handle_QSetDisableASLR); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_QSetWorkingDir, &GDBRemoteCommunicationServerLLGS::Handle_QSetWorkingDir); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qsThreadInfo, &GDBRemoteCommunicationServerLLGS::Handle_qsThreadInfo); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qThreadStopInfo, &GDBRemoteCommunicationServerLLGS::Handle_qThreadStopInfo); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_jThreadsInfo, &GDBRemoteCommunicationServerLLGS::Handle_jThreadsInfo); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qWatchpointSupportInfo, &GDBRemoteCommunicationServerLLGS::Handle_qWatchpointSupportInfo); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qXfer, &GDBRemoteCommunicationServerLLGS::Handle_qXfer); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_s, &GDBRemoteCommunicationServerLLGS::Handle_s); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_stop_reason, &GDBRemoteCommunicationServerLLGS::Handle_stop_reason); // ? RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_vAttach, &GDBRemoteCommunicationServerLLGS::Handle_vAttach); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_vAttachWait, &GDBRemoteCommunicationServerLLGS::Handle_vAttachWait); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qVAttachOrWaitSupported, &GDBRemoteCommunicationServerLLGS::Handle_qVAttachOrWaitSupported); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_vAttachOrWait, &GDBRemoteCommunicationServerLLGS::Handle_vAttachOrWait); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_vCont, &GDBRemoteCommunicationServerLLGS::Handle_vCont); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_vCont_actions, &GDBRemoteCommunicationServerLLGS::Handle_vCont_actions); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_vRun, &GDBRemoteCommunicationServerLLGS::Handle_vRun); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_x, &GDBRemoteCommunicationServerLLGS::Handle_memory_read); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_Z, &GDBRemoteCommunicationServerLLGS::Handle_Z); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_z, &GDBRemoteCommunicationServerLLGS::Handle_z); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_QPassSignals, &GDBRemoteCommunicationServerLLGS::Handle_QPassSignals); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_jLLDBTraceSupported, &GDBRemoteCommunicationServerLLGS::Handle_jLLDBTraceSupported); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_jLLDBTraceStart, &GDBRemoteCommunicationServerLLGS::Handle_jLLDBTraceStart); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_jLLDBTraceStop, &GDBRemoteCommunicationServerLLGS::Handle_jLLDBTraceStop); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_jLLDBTraceGetState, &GDBRemoteCommunicationServerLLGS::Handle_jLLDBTraceGetState); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_jLLDBTraceGetBinaryData, &GDBRemoteCommunicationServerLLGS::Handle_jLLDBTraceGetBinaryData); RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_g, &GDBRemoteCommunicationServerLLGS::Handle_g); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qMemTags, &GDBRemoteCommunicationServerLLGS::Handle_qMemTags); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_QMemTags, &GDBRemoteCommunicationServerLLGS::Handle_QMemTags); RegisterPacketHandler(StringExtractorGDBRemote::eServerPacketType_k, [this](StringExtractorGDBRemote packet, Status &error, bool &interrupt, bool &quit) { quit = true; return this->Handle_k(packet); }); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_vKill, &GDBRemoteCommunicationServerLLGS::Handle_vKill); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_qLLDBSaveCore, &GDBRemoteCommunicationServerLLGS::Handle_qSaveCore); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_QNonStop, &GDBRemoteCommunicationServerLLGS::Handle_QNonStop); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_vStdio, &GDBRemoteCommunicationServerLLGS::Handle_vStdio); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_vStopped, &GDBRemoteCommunicationServerLLGS::Handle_vStopped); RegisterMemberFunctionHandler( StringExtractorGDBRemote::eServerPacketType_vCtrlC, &GDBRemoteCommunicationServerLLGS::Handle_vCtrlC); } void GDBRemoteCommunicationServerLLGS::SetLaunchInfo(const ProcessLaunchInfo &info) { m_process_launch_info = info; } Status GDBRemoteCommunicationServerLLGS::LaunchProcess() { Log *log = GetLog(LLDBLog::Process); if (!m_process_launch_info.GetArguments().GetArgumentCount()) return Status("%s: no process command line specified to launch", __FUNCTION__); const bool should_forward_stdio = m_process_launch_info.GetFileActionForFD(STDIN_FILENO) == nullptr || m_process_launch_info.GetFileActionForFD(STDOUT_FILENO) == nullptr || m_process_launch_info.GetFileActionForFD(STDERR_FILENO) == nullptr; m_process_launch_info.SetLaunchInSeparateProcessGroup(true); m_process_launch_info.GetFlags().Set(eLaunchFlagDebug); if (should_forward_stdio) { // Temporarily relax the following for Windows until we can take advantage // of the recently added pty support. This doesn't really affect the use of // lldb-server on Windows. #if !defined(_WIN32) if (llvm::Error Err = m_process_launch_info.SetUpPtyRedirection()) return Status(std::move(Err)); #endif } { std::lock_guard guard(m_debugged_process_mutex); assert(m_debugged_processes.empty() && "lldb-server creating debugged " "process but one already exists"); auto process_or = m_process_manager.Launch(m_process_launch_info, *this); if (!process_or) return Status(process_or.takeError()); m_continue_process = m_current_process = process_or->get(); m_debugged_processes.emplace( m_current_process->GetID(), DebuggedProcess{std::move(*process_or), DebuggedProcess::Flag{}}); } SetEnabledExtensions(*m_current_process); // Handle mirroring of inferior stdout/stderr over the gdb-remote protocol as // needed. llgs local-process debugging may specify PTY paths, which will // make these file actions non-null process launch -i/e/o will also make // these file actions non-null nullptr means that the traffic is expected to // flow over gdb-remote protocol if (should_forward_stdio) { // nullptr means it's not redirected to file or pty (in case of LLGS local) // at least one of stdio will be transferred pty<->gdb-remote we need to // give the pty primary handle to this object to read and/or write LLDB_LOG(log, "pid = {0}: setting up stdout/stderr redirection via $O " "gdb-remote commands", m_current_process->GetID()); // Setup stdout/stderr mapping from inferior to $O auto terminal_fd = m_current_process->GetTerminalFileDescriptor(); if (terminal_fd >= 0) { LLDB_LOGF(log, "ProcessGDBRemoteCommunicationServerLLGS::%s setting " "inferior STDIO fd to %d", __FUNCTION__, terminal_fd); Status status = SetSTDIOFileDescriptor(terminal_fd); if (status.Fail()) return status; } else { LLDB_LOGF(log, "ProcessGDBRemoteCommunicationServerLLGS::%s ignoring " "inferior STDIO since terminal fd reported as %d", __FUNCTION__, terminal_fd); } } else { LLDB_LOG(log, "pid = {0} skipping stdout/stderr redirection via $O: inferior " "will communicate over client-provided file descriptors", m_current_process->GetID()); } printf("Launched '%s' as process %" PRIu64 "...\n", m_process_launch_info.GetArguments().GetArgumentAtIndex(0), m_current_process->GetID()); return Status(); } Status GDBRemoteCommunicationServerLLGS::AttachToProcess(lldb::pid_t pid) { Log *log = GetLog(LLDBLog::Process); LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s pid %" PRIu64, __FUNCTION__, pid); // Before we try to attach, make sure we aren't already monitoring something // else. if (!m_debugged_processes.empty()) return Status("cannot attach to process %" PRIu64 " when another process with pid %" PRIu64 " is being debugged.", pid, m_current_process->GetID()); // Try to attach. auto process_or = m_process_manager.Attach(pid, *this); if (!process_or) { Status status(process_or.takeError()); llvm::errs() << llvm::formatv("failed to attach to process {0}: {1}\n", pid, status); return status; } m_continue_process = m_current_process = process_or->get(); m_debugged_processes.emplace( m_current_process->GetID(), DebuggedProcess{std::move(*process_or), DebuggedProcess::Flag{}}); SetEnabledExtensions(*m_current_process); // Setup stdout/stderr mapping from inferior. auto terminal_fd = m_current_process->GetTerminalFileDescriptor(); if (terminal_fd >= 0) { LLDB_LOGF(log, "ProcessGDBRemoteCommunicationServerLLGS::%s setting " "inferior STDIO fd to %d", __FUNCTION__, terminal_fd); Status status = SetSTDIOFileDescriptor(terminal_fd); if (status.Fail()) return status; } else { LLDB_LOGF(log, "ProcessGDBRemoteCommunicationServerLLGS::%s ignoring " "inferior STDIO since terminal fd reported as %d", __FUNCTION__, terminal_fd); } printf("Attached to process %" PRIu64 "...\n", pid); return Status(); } Status GDBRemoteCommunicationServerLLGS::AttachWaitProcess( llvm::StringRef process_name, bool include_existing) { Log *log = GetLog(LLDBLog::Process); std::chrono::milliseconds polling_interval = std::chrono::milliseconds(1); // Create the matcher used to search the process list. ProcessInstanceInfoList exclusion_list; ProcessInstanceInfoMatch match_info; match_info.GetProcessInfo().GetExecutableFile().SetFile( process_name, llvm::sys::path::Style::native); match_info.SetNameMatchType(NameMatch::Equals); if (include_existing) { LLDB_LOG(log, "including existing processes in search"); } else { // Create the excluded process list before polling begins. Host::FindProcesses(match_info, exclusion_list); LLDB_LOG(log, "placed '{0}' processes in the exclusion list.", exclusion_list.size()); } LLDB_LOG(log, "waiting for '{0}' to appear", process_name); auto is_in_exclusion_list = [&exclusion_list](const ProcessInstanceInfo &info) { for (auto &excluded : exclusion_list) { if (excluded.GetProcessID() == info.GetProcessID()) return true; } return false; }; ProcessInstanceInfoList loop_process_list; while (true) { loop_process_list.clear(); if (Host::FindProcesses(match_info, loop_process_list)) { // Remove all the elements that are in the exclusion list. llvm::erase_if(loop_process_list, is_in_exclusion_list); // One match! We found the desired process. if (loop_process_list.size() == 1) { auto matching_process_pid = loop_process_list[0].GetProcessID(); LLDB_LOG(log, "found pid {0}", matching_process_pid); return AttachToProcess(matching_process_pid); } // Multiple matches! Return an error reporting the PIDs we found. if (loop_process_list.size() > 1) { StreamString error_stream; error_stream.Format( "Multiple executables with name: '{0}' found. Pids: ", process_name); for (size_t i = 0; i < loop_process_list.size() - 1; ++i) { error_stream.Format("{0}, ", loop_process_list[i].GetProcessID()); } error_stream.Format("{0}.", loop_process_list.back().GetProcessID()); Status error; error.SetErrorString(error_stream.GetString()); return error; } } // No matches, we have not found the process. Sleep until next poll. LLDB_LOG(log, "sleep {0} seconds", polling_interval); std::this_thread::sleep_for(polling_interval); } } void GDBRemoteCommunicationServerLLGS::InitializeDelegate( NativeProcessProtocol *process) { assert(process && "process cannot be NULL"); Log *log = GetLog(LLDBLog::Process); if (log) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s called with " "NativeProcessProtocol pid %" PRIu64 ", current state: %s", __FUNCTION__, process->GetID(), StateAsCString(process->GetState())); } } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::SendWResponse( NativeProcessProtocol *process) { assert(process && "process cannot be NULL"); Log *log = GetLog(LLDBLog::Process); // send W notification auto wait_status = process->GetExitStatus(); if (!wait_status) { LLDB_LOG(log, "pid = {0}, failed to retrieve process exit status", process->GetID()); StreamGDBRemote response; response.PutChar('E'); response.PutHex8(GDBRemoteServerError::eErrorExitStatus); return SendPacketNoLock(response.GetString()); } LLDB_LOG(log, "pid = {0}, returning exit type {1}", process->GetID(), *wait_status); // If the process was killed through vKill, return "OK". if (bool(m_debugged_processes.at(process->GetID()).flags & DebuggedProcess::Flag::vkilled)) return SendOKResponse(); StreamGDBRemote response; response.Format("{0:g}", *wait_status); if (bool(m_extensions_supported & NativeProcessProtocol::Extension::multiprocess)) response.Format(";process:{0:x-}", process->GetID()); if (m_non_stop) return SendNotificationPacketNoLock("Stop", m_stop_notification_queue, response.GetString()); return SendPacketNoLock(response.GetString()); } static void AppendHexValue(StreamString &response, const uint8_t *buf, uint32_t buf_size, bool swap) { int64_t i; if (swap) { for (i = buf_size - 1; i >= 0; i--) response.PutHex8(buf[i]); } else { for (i = 0; i < buf_size; i++) response.PutHex8(buf[i]); } } static llvm::StringRef GetEncodingNameOrEmpty(const RegisterInfo ®_info) { switch (reg_info.encoding) { case eEncodingUint: return "uint"; case eEncodingSint: return "sint"; case eEncodingIEEE754: return "ieee754"; case eEncodingVector: return "vector"; default: return ""; } } static llvm::StringRef GetFormatNameOrEmpty(const RegisterInfo ®_info) { switch (reg_info.format) { case eFormatBinary: return "binary"; case eFormatDecimal: return "decimal"; case eFormatHex: return "hex"; case eFormatFloat: return "float"; case eFormatVectorOfSInt8: return "vector-sint8"; case eFormatVectorOfUInt8: return "vector-uint8"; case eFormatVectorOfSInt16: return "vector-sint16"; case eFormatVectorOfUInt16: return "vector-uint16"; case eFormatVectorOfSInt32: return "vector-sint32"; case eFormatVectorOfUInt32: return "vector-uint32"; case eFormatVectorOfFloat32: return "vector-float32"; case eFormatVectorOfUInt64: return "vector-uint64"; case eFormatVectorOfUInt128: return "vector-uint128"; default: return ""; }; } static llvm::StringRef GetKindGenericOrEmpty(const RegisterInfo ®_info) { switch (reg_info.kinds[RegisterKind::eRegisterKindGeneric]) { case LLDB_REGNUM_GENERIC_PC: return "pc"; case LLDB_REGNUM_GENERIC_SP: return "sp"; case LLDB_REGNUM_GENERIC_FP: return "fp"; case LLDB_REGNUM_GENERIC_RA: return "ra"; case LLDB_REGNUM_GENERIC_FLAGS: return "flags"; case LLDB_REGNUM_GENERIC_ARG1: return "arg1"; case LLDB_REGNUM_GENERIC_ARG2: return "arg2"; case LLDB_REGNUM_GENERIC_ARG3: return "arg3"; case LLDB_REGNUM_GENERIC_ARG4: return "arg4"; case LLDB_REGNUM_GENERIC_ARG5: return "arg5"; case LLDB_REGNUM_GENERIC_ARG6: return "arg6"; case LLDB_REGNUM_GENERIC_ARG7: return "arg7"; case LLDB_REGNUM_GENERIC_ARG8: return "arg8"; case LLDB_REGNUM_GENERIC_TP: return "tp"; default: return ""; } } static void CollectRegNums(const uint32_t *reg_num, StreamString &response, bool usehex) { for (int i = 0; *reg_num != LLDB_INVALID_REGNUM; ++reg_num, ++i) { if (i > 0) response.PutChar(','); if (usehex) response.Printf("%" PRIx32, *reg_num); else response.Printf("%" PRIu32, *reg_num); } } static void WriteRegisterValueInHexFixedWidth( StreamString &response, NativeRegisterContext ®_ctx, const RegisterInfo ®_info, const RegisterValue *reg_value_p, lldb::ByteOrder byte_order) { RegisterValue reg_value; if (!reg_value_p) { Status error = reg_ctx.ReadRegister(®_info, reg_value); if (error.Success()) reg_value_p = ®_value; // else log. } if (reg_value_p) { AppendHexValue(response, (const uint8_t *)reg_value_p->GetBytes(), reg_value_p->GetByteSize(), byte_order == lldb::eByteOrderLittle); } else { // Zero-out any unreadable values. if (reg_info.byte_size > 0) { std::vector zeros(reg_info.byte_size, '\0'); AppendHexValue(response, zeros.data(), zeros.size(), false); } } } static std::optional GetRegistersAsJSON(NativeThreadProtocol &thread) { Log *log = GetLog(LLDBLog::Thread); NativeRegisterContext& reg_ctx = thread.GetRegisterContext(); json::Object register_object; #ifdef LLDB_JTHREADSINFO_FULL_REGISTER_SET const auto expedited_regs = reg_ctx.GetExpeditedRegisters(ExpeditedRegs::Full); #else const auto expedited_regs = reg_ctx.GetExpeditedRegisters(ExpeditedRegs::Minimal); #endif if (expedited_regs.empty()) return std::nullopt; for (auto ®_num : expedited_regs) { const RegisterInfo *const reg_info_p = reg_ctx.GetRegisterInfoAtIndex(reg_num); if (reg_info_p == nullptr) { LLDB_LOGF(log, "%s failed to get register info for register index %" PRIu32, __FUNCTION__, reg_num); continue; } if (reg_info_p->value_regs != nullptr) continue; // Only expedite registers that are not contained in other // registers. RegisterValue reg_value; Status error = reg_ctx.ReadRegister(reg_info_p, reg_value); if (error.Fail()) { LLDB_LOGF(log, "%s failed to read register '%s' index %" PRIu32 ": %s", __FUNCTION__, reg_info_p->name ? reg_info_p->name : "", reg_num, error.AsCString()); continue; } StreamString stream; WriteRegisterValueInHexFixedWidth(stream, reg_ctx, *reg_info_p, ®_value, lldb::eByteOrderBig); register_object.try_emplace(llvm::to_string(reg_num), stream.GetString().str()); } return register_object; } static const char *GetStopReasonString(StopReason stop_reason) { switch (stop_reason) { case eStopReasonTrace: return "trace"; case eStopReasonBreakpoint: return "breakpoint"; case eStopReasonWatchpoint: return "watchpoint"; case eStopReasonSignal: return "signal"; case eStopReasonException: return "exception"; case eStopReasonExec: return "exec"; case eStopReasonProcessorTrace: return "processor trace"; case eStopReasonFork: return "fork"; case eStopReasonVFork: return "vfork"; case eStopReasonVForkDone: return "vforkdone"; case eStopReasonInstrumentation: case eStopReasonInvalid: case eStopReasonPlanComplete: case eStopReasonThreadExiting: case eStopReasonNone: break; // ignored } return nullptr; } static llvm::Expected GetJSONThreadsInfo(NativeProcessProtocol &process, bool abridged) { Log *log = GetLog(LLDBLog::Process | LLDBLog::Thread); json::Array threads_array; // Ensure we can get info on the given thread. for (NativeThreadProtocol &thread : process.Threads()) { lldb::tid_t tid = thread.GetID(); // Grab the reason this thread stopped. struct ThreadStopInfo tid_stop_info; std::string description; if (!thread.GetStopReason(tid_stop_info, description)) return llvm::make_error( "failed to get stop reason", llvm::inconvertibleErrorCode()); const int signum = tid_stop_info.signo; if (log) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s pid %" PRIu64 " tid %" PRIu64 " got signal signo = %d, reason = %d, exc_type = %" PRIu64, __FUNCTION__, process.GetID(), tid, signum, tid_stop_info.reason, tid_stop_info.details.exception.type); } json::Object thread_obj; if (!abridged) { if (std::optional registers = GetRegistersAsJSON(thread)) thread_obj.try_emplace("registers", std::move(*registers)); } thread_obj.try_emplace("tid", static_cast(tid)); if (signum != 0) thread_obj.try_emplace("signal", signum); const std::string thread_name = thread.GetName(); if (!thread_name.empty()) thread_obj.try_emplace("name", thread_name); const char *stop_reason = GetStopReasonString(tid_stop_info.reason); if (stop_reason) thread_obj.try_emplace("reason", stop_reason); if (!description.empty()) thread_obj.try_emplace("description", description); if ((tid_stop_info.reason == eStopReasonException) && tid_stop_info.details.exception.type) { thread_obj.try_emplace( "metype", static_cast(tid_stop_info.details.exception.type)); json::Array medata_array; for (uint32_t i = 0; i < tid_stop_info.details.exception.data_count; ++i) { medata_array.push_back( static_cast(tid_stop_info.details.exception.data[i])); } thread_obj.try_emplace("medata", std::move(medata_array)); } threads_array.push_back(std::move(thread_obj)); } return threads_array; } StreamString GDBRemoteCommunicationServerLLGS::PrepareStopReplyPacketForThread( NativeThreadProtocol &thread) { Log *log = GetLog(LLDBLog::Process | LLDBLog::Thread); NativeProcessProtocol &process = thread.GetProcess(); LLDB_LOG(log, "preparing packet for pid {0} tid {1}", process.GetID(), thread.GetID()); // Grab the reason this thread stopped. StreamString response; struct ThreadStopInfo tid_stop_info; std::string description; if (!thread.GetStopReason(tid_stop_info, description)) return response; // FIXME implement register handling for exec'd inferiors. // if (tid_stop_info.reason == eStopReasonExec) { // const bool force = true; // InitializeRegisters(force); // } // Output the T packet with the thread response.PutChar('T'); int signum = tid_stop_info.signo; LLDB_LOG( log, "pid {0}, tid {1}, got signal signo = {2}, reason = {3}, exc_type = {4}", process.GetID(), thread.GetID(), signum, int(tid_stop_info.reason), tid_stop_info.details.exception.type); // Print the signal number. response.PutHex8(signum & 0xff); // Include the (pid and) tid. response.PutCString("thread:"); AppendThreadIDToResponse(response, process.GetID(), thread.GetID()); response.PutChar(';'); // Include the thread name if there is one. const std::string thread_name = thread.GetName(); if (!thread_name.empty()) { size_t thread_name_len = thread_name.length(); if (::strcspn(thread_name.c_str(), "$#+-;:") == thread_name_len) { response.PutCString("name:"); response.PutCString(thread_name); } else { // The thread name contains special chars, send as hex bytes. response.PutCString("hexname:"); response.PutStringAsRawHex8(thread_name); } response.PutChar(';'); } // If a 'QListThreadsInStopReply' was sent to enable this feature, we will // send all thread IDs back in the "threads" key whose value is a list of hex // thread IDs separated by commas: // "threads:10a,10b,10c;" // This will save the debugger from having to send a pair of qfThreadInfo and // qsThreadInfo packets, but it also might take a lot of room in the stop // reply packet, so it must be enabled only on systems where there are no // limits on packet lengths. if (m_list_threads_in_stop_reply) { response.PutCString("threads:"); uint32_t thread_num = 0; for (NativeThreadProtocol &listed_thread : process.Threads()) { if (thread_num > 0) response.PutChar(','); response.Printf("%" PRIx64, listed_thread.GetID()); ++thread_num; } response.PutChar(';'); // Include JSON info that describes the stop reason for any threads that // actually have stop reasons. We use the new "jstopinfo" key whose values // is hex ascii JSON that contains the thread IDs thread stop info only for // threads that have stop reasons. Only send this if we have more than one // thread otherwise this packet has all the info it needs. if (thread_num > 1) { const bool threads_with_valid_stop_info_only = true; llvm::Expected threads_info = GetJSONThreadsInfo( *m_current_process, threads_with_valid_stop_info_only); if (threads_info) { response.PutCString("jstopinfo:"); StreamString unescaped_response; unescaped_response.AsRawOstream() << std::move(*threads_info); response.PutStringAsRawHex8(unescaped_response.GetData()); response.PutChar(';'); } else { LLDB_LOG_ERROR(log, threads_info.takeError(), "failed to prepare a jstopinfo field for pid {1}: {0}", process.GetID()); } } response.PutCString("thread-pcs"); char delimiter = ':'; for (NativeThreadProtocol &thread : process.Threads()) { NativeRegisterContext ®_ctx = thread.GetRegisterContext(); uint32_t reg_to_read = reg_ctx.ConvertRegisterKindToRegisterNumber( eRegisterKindGeneric, LLDB_REGNUM_GENERIC_PC); const RegisterInfo *const reg_info_p = reg_ctx.GetRegisterInfoAtIndex(reg_to_read); RegisterValue reg_value; Status error = reg_ctx.ReadRegister(reg_info_p, reg_value); if (error.Fail()) { LLDB_LOGF(log, "%s failed to read register '%s' index %" PRIu32 ": %s", __FUNCTION__, reg_info_p->name ? reg_info_p->name : "", reg_to_read, error.AsCString()); continue; } response.PutChar(delimiter); delimiter = ','; WriteRegisterValueInHexFixedWidth(response, reg_ctx, *reg_info_p, ®_value, endian::InlHostByteOrder()); } response.PutChar(';'); } // // Expedite registers. // // Grab the register context. NativeRegisterContext ®_ctx = thread.GetRegisterContext(); const auto expedited_regs = reg_ctx.GetExpeditedRegisters(ExpeditedRegs::Full); for (auto ®_num : expedited_regs) { const RegisterInfo *const reg_info_p = reg_ctx.GetRegisterInfoAtIndex(reg_num); // Only expediate registers that are not contained in other registers. if (reg_info_p != nullptr && reg_info_p->value_regs == nullptr) { RegisterValue reg_value; Status error = reg_ctx.ReadRegister(reg_info_p, reg_value); if (error.Success()) { response.Printf("%.02x:", reg_num); WriteRegisterValueInHexFixedWidth(response, reg_ctx, *reg_info_p, ®_value, lldb::eByteOrderBig); response.PutChar(';'); } else { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed to read " "register '%s' index %" PRIu32 ": %s", __FUNCTION__, reg_info_p->name ? reg_info_p->name : "", reg_num, error.AsCString()); } } } const char *reason_str = GetStopReasonString(tid_stop_info.reason); if (reason_str != nullptr) { response.Printf("reason:%s;", reason_str); } if (!description.empty()) { // Description may contains special chars, send as hex bytes. response.PutCString("description:"); response.PutStringAsRawHex8(description); response.PutChar(';'); } else if ((tid_stop_info.reason == eStopReasonException) && tid_stop_info.details.exception.type) { response.PutCString("metype:"); response.PutHex64(tid_stop_info.details.exception.type); response.PutCString(";mecount:"); response.PutHex32(tid_stop_info.details.exception.data_count); response.PutChar(';'); for (uint32_t i = 0; i < tid_stop_info.details.exception.data_count; ++i) { response.PutCString("medata:"); response.PutHex64(tid_stop_info.details.exception.data[i]); response.PutChar(';'); } } // Include child process PID/TID for forks. if (tid_stop_info.reason == eStopReasonFork || tid_stop_info.reason == eStopReasonVFork) { assert(bool(m_extensions_supported & NativeProcessProtocol::Extension::multiprocess)); if (tid_stop_info.reason == eStopReasonFork) assert(bool(m_extensions_supported & NativeProcessProtocol::Extension::fork)); if (tid_stop_info.reason == eStopReasonVFork) assert(bool(m_extensions_supported & NativeProcessProtocol::Extension::vfork)); response.Printf("%s:p%" PRIx64 ".%" PRIx64 ";", reason_str, tid_stop_info.details.fork.child_pid, tid_stop_info.details.fork.child_tid); } return response; } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::SendStopReplyPacketForThread( NativeProcessProtocol &process, lldb::tid_t tid, bool force_synchronous) { // Ensure we can get info on the given thread. NativeThreadProtocol *thread = process.GetThreadByID(tid); if (!thread) return SendErrorResponse(51); StreamString response = PrepareStopReplyPacketForThread(*thread); if (response.Empty()) return SendErrorResponse(42); if (m_non_stop && !force_synchronous) { PacketResult ret = SendNotificationPacketNoLock( "Stop", m_stop_notification_queue, response.GetString()); // Queue notification events for the remaining threads. EnqueueStopReplyPackets(tid); return ret; } return SendPacketNoLock(response.GetString()); } void GDBRemoteCommunicationServerLLGS::EnqueueStopReplyPackets( lldb::tid_t thread_to_skip) { if (!m_non_stop) return; for (NativeThreadProtocol &listed_thread : m_current_process->Threads()) { if (listed_thread.GetID() != thread_to_skip) { StreamString stop_reply = PrepareStopReplyPacketForThread(listed_thread); if (!stop_reply.Empty()) m_stop_notification_queue.push_back(stop_reply.GetString().str()); } } } void GDBRemoteCommunicationServerLLGS::HandleInferiorState_Exited( NativeProcessProtocol *process) { assert(process && "process cannot be NULL"); Log *log = GetLog(LLDBLog::Process); LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s called", __FUNCTION__); PacketResult result = SendStopReasonForState( *process, StateType::eStateExited, /*force_synchronous=*/false); if (result != PacketResult::Success) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed to send stop " "notification for PID %" PRIu64 ", state: eStateExited", __FUNCTION__, process->GetID()); } if (m_current_process == process) m_current_process = nullptr; if (m_continue_process == process) m_continue_process = nullptr; lldb::pid_t pid = process->GetID(); m_mainloop.AddPendingCallback([this, pid](MainLoopBase &loop) { auto find_it = m_debugged_processes.find(pid); assert(find_it != m_debugged_processes.end()); bool vkilled = bool(find_it->second.flags & DebuggedProcess::Flag::vkilled); m_debugged_processes.erase(find_it); // Terminate the main loop only if vKill has not been used. // When running in non-stop mode, wait for the vStopped to clear // the notification queue. if (m_debugged_processes.empty() && !m_non_stop && !vkilled) { // Close the pipe to the inferior terminal i/o if we launched it and set // one up. MaybeCloseInferiorTerminalConnection(); // We are ready to exit the debug monitor. m_exit_now = true; loop.RequestTermination(); } }); } void GDBRemoteCommunicationServerLLGS::HandleInferiorState_Stopped( NativeProcessProtocol *process) { assert(process && "process cannot be NULL"); Log *log = GetLog(LLDBLog::Process); LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s called", __FUNCTION__); PacketResult result = SendStopReasonForState( *process, StateType::eStateStopped, /*force_synchronous=*/false); if (result != PacketResult::Success) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed to send stop " "notification for PID %" PRIu64 ", state: eStateExited", __FUNCTION__, process->GetID()); } } void GDBRemoteCommunicationServerLLGS::ProcessStateChanged( NativeProcessProtocol *process, lldb::StateType state) { assert(process && "process cannot be NULL"); Log *log = GetLog(LLDBLog::Process); if (log) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s called with " "NativeProcessProtocol pid %" PRIu64 ", state: %s", __FUNCTION__, process->GetID(), StateAsCString(state)); } switch (state) { case StateType::eStateRunning: break; case StateType::eStateStopped: // Make sure we get all of the pending stdout/stderr from the inferior and // send it to the lldb host before we send the state change notification SendProcessOutput(); // Then stop the forwarding, so that any late output (see llvm.org/pr25652) // does not interfere with our protocol. if (!m_non_stop) StopSTDIOForwarding(); HandleInferiorState_Stopped(process); break; case StateType::eStateExited: // Same as above SendProcessOutput(); if (!m_non_stop) StopSTDIOForwarding(); HandleInferiorState_Exited(process); break; default: if (log) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s didn't handle state " "change for pid %" PRIu64 ", new state: %s", __FUNCTION__, process->GetID(), StateAsCString(state)); } break; } } void GDBRemoteCommunicationServerLLGS::DidExec(NativeProcessProtocol *process) { ClearProcessSpecificData(); } void GDBRemoteCommunicationServerLLGS::NewSubprocess( NativeProcessProtocol *parent_process, std::unique_ptr child_process) { lldb::pid_t child_pid = child_process->GetID(); assert(child_pid != LLDB_INVALID_PROCESS_ID); assert(m_debugged_processes.find(child_pid) == m_debugged_processes.end()); m_debugged_processes.emplace( child_pid, DebuggedProcess{std::move(child_process), DebuggedProcess::Flag{}}); } void GDBRemoteCommunicationServerLLGS::DataAvailableCallback() { Log *log = GetLog(GDBRLog::Comm); bool interrupt = false; bool done = false; Status error; while (true) { const PacketResult result = GetPacketAndSendResponse( std::chrono::microseconds(0), error, interrupt, done); if (result == PacketResult::ErrorReplyTimeout) break; // No more packets in the queue if ((result != PacketResult::Success)) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s processing a packet " "failed: %s", __FUNCTION__, error.AsCString()); m_mainloop.RequestTermination(); break; } } } Status GDBRemoteCommunicationServerLLGS::InitializeConnection( std::unique_ptr connection) { IOObjectSP read_object_sp = connection->GetReadObject(); GDBRemoteCommunicationServer::SetConnection(std::move(connection)); Status error; m_network_handle_up = m_mainloop.RegisterReadObject( read_object_sp, [this](MainLoopBase &) { DataAvailableCallback(); }, error); return error; } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::SendONotification(const char *buffer, uint32_t len) { if ((buffer == nullptr) || (len == 0)) { // Nothing to send. return PacketResult::Success; } StreamString response; response.PutChar('O'); response.PutBytesAsRawHex8(buffer, len); if (m_non_stop) return SendNotificationPacketNoLock("Stdio", m_stdio_notification_queue, response.GetString()); return SendPacketNoLock(response.GetString()); } Status GDBRemoteCommunicationServerLLGS::SetSTDIOFileDescriptor(int fd) { Status error; // Set up the reading/handling of process I/O std::unique_ptr conn_up( new ConnectionFileDescriptor(fd, true)); if (!conn_up) { error.SetErrorString("failed to create ConnectionFileDescriptor"); return error; } m_stdio_communication.SetCloseOnEOF(false); m_stdio_communication.SetConnection(std::move(conn_up)); if (!m_stdio_communication.IsConnected()) { error.SetErrorString( "failed to set connection for inferior I/O communication"); return error; } return Status(); } void GDBRemoteCommunicationServerLLGS::StartSTDIOForwarding() { // Don't forward if not connected (e.g. when attaching). if (!m_stdio_communication.IsConnected()) return; Status error; assert(!m_stdio_handle_up); m_stdio_handle_up = m_mainloop.RegisterReadObject( m_stdio_communication.GetConnection()->GetReadObject(), [this](MainLoopBase &) { SendProcessOutput(); }, error); if (!m_stdio_handle_up) { // Not much we can do about the failure. Log it and continue without // forwarding. if (Log *log = GetLog(LLDBLog::Process)) LLDB_LOG(log, "Failed to set up stdio forwarding: {0}", error); } } void GDBRemoteCommunicationServerLLGS::StopSTDIOForwarding() { m_stdio_handle_up.reset(); } void GDBRemoteCommunicationServerLLGS::SendProcessOutput() { char buffer[1024]; ConnectionStatus status; Status error; while (true) { size_t bytes_read = m_stdio_communication.Read( buffer, sizeof buffer, std::chrono::microseconds(0), status, &error); switch (status) { case eConnectionStatusSuccess: SendONotification(buffer, bytes_read); break; case eConnectionStatusLostConnection: case eConnectionStatusEndOfFile: case eConnectionStatusError: case eConnectionStatusNoConnection: if (Log *log = GetLog(LLDBLog::Process)) LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s Stopping stdio " "forwarding as communication returned status %d (error: " "%s)", __FUNCTION__, status, error.AsCString()); m_stdio_handle_up.reset(); return; case eConnectionStatusInterrupted: case eConnectionStatusTimedOut: return; } } } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_jLLDBTraceSupported( StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(Status("Process not running.")); return SendJSONResponse(m_current_process->TraceSupported()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_jLLDBTraceStop( StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(Status("Process not running.")); packet.ConsumeFront("jLLDBTraceStop:"); Expected stop_request = json::parse(packet.Peek(), "TraceStopRequest"); if (!stop_request) return SendErrorResponse(stop_request.takeError()); if (Error err = m_current_process->TraceStop(*stop_request)) return SendErrorResponse(std::move(err)); return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_jLLDBTraceStart( StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(Status("Process not running.")); packet.ConsumeFront("jLLDBTraceStart:"); Expected request = json::parse(packet.Peek(), "TraceStartRequest"); if (!request) return SendErrorResponse(request.takeError()); if (Error err = m_current_process->TraceStart(packet.Peek(), request->type)) return SendErrorResponse(std::move(err)); return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_jLLDBTraceGetState( StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(Status("Process not running.")); packet.ConsumeFront("jLLDBTraceGetState:"); Expected request = json::parse(packet.Peek(), "TraceGetStateRequest"); if (!request) return SendErrorResponse(request.takeError()); return SendJSONResponse(m_current_process->TraceGetState(request->type)); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_jLLDBTraceGetBinaryData( StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(Status("Process not running.")); packet.ConsumeFront("jLLDBTraceGetBinaryData:"); llvm::Expected request = llvm::json::parse(packet.Peek(), "TraceGetBinaryDataRequest"); if (!request) return SendErrorResponse(Status(request.takeError())); if (Expected> bytes = m_current_process->TraceGetBinaryData(*request)) { StreamGDBRemote response; response.PutEscapedBytes(bytes->data(), bytes->size()); return SendPacketNoLock(response.GetString()); } else return SendErrorResponse(bytes.takeError()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qProcessInfo( StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(68); lldb::pid_t pid = m_current_process->GetID(); if (pid == LLDB_INVALID_PROCESS_ID) return SendErrorResponse(1); ProcessInstanceInfo proc_info; if (!Host::GetProcessInfo(pid, proc_info)) return SendErrorResponse(1); StreamString response; CreateProcessInfoResponse_DebugServerStyle(proc_info, response); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qC(StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(68); // Make sure we set the current thread so g and p packets return the data the // gdb will expect. lldb::tid_t tid = m_current_process->GetCurrentThreadID(); SetCurrentThreadID(tid); NativeThreadProtocol *thread = m_current_process->GetCurrentThread(); if (!thread) return SendErrorResponse(69); StreamString response; response.PutCString("QC"); AppendThreadIDToResponse(response, m_current_process->GetID(), thread->GetID()); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_k(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); if (!m_non_stop) StopSTDIOForwarding(); if (m_debugged_processes.empty()) { LLDB_LOG(log, "No debugged process found."); return PacketResult::Success; } for (auto it = m_debugged_processes.begin(); it != m_debugged_processes.end(); ++it) { LLDB_LOG(log, "Killing process {0}", it->first); Status error = it->second.process_up->Kill(); if (error.Fail()) LLDB_LOG(log, "Failed to kill debugged process {0}: {1}", it->first, error); } // The response to kill packet is undefined per the spec. LLDB // follows the same rules as for continue packets, i.e. no response // in all-stop mode, and "OK" in non-stop mode; in both cases this // is followed by the actual stop reason. return SendContinueSuccessResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_vKill( StringExtractorGDBRemote &packet) { if (!m_non_stop) StopSTDIOForwarding(); packet.SetFilePos(6); // vKill; uint32_t pid = packet.GetU32(LLDB_INVALID_PROCESS_ID, 16); if (pid == LLDB_INVALID_PROCESS_ID) return SendIllFormedResponse(packet, "vKill failed to parse the process id"); auto it = m_debugged_processes.find(pid); if (it == m_debugged_processes.end()) return SendErrorResponse(42); Status error = it->second.process_up->Kill(); if (error.Fail()) return SendErrorResponse(error.ToError()); // OK response is sent when the process dies. it->second.flags |= DebuggedProcess::Flag::vkilled; return PacketResult::Success; } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_QSetDisableASLR( StringExtractorGDBRemote &packet) { packet.SetFilePos(::strlen("QSetDisableASLR:")); if (packet.GetU32(0)) m_process_launch_info.GetFlags().Set(eLaunchFlagDisableASLR); else m_process_launch_info.GetFlags().Clear(eLaunchFlagDisableASLR); return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_QSetWorkingDir( StringExtractorGDBRemote &packet) { packet.SetFilePos(::strlen("QSetWorkingDir:")); std::string path; packet.GetHexByteString(path); m_process_launch_info.SetWorkingDirectory(FileSpec(path)); return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qGetWorkingDir( StringExtractorGDBRemote &packet) { FileSpec working_dir{m_process_launch_info.GetWorkingDirectory()}; if (working_dir) { StreamString response; response.PutStringAsRawHex8(working_dir.GetPath().c_str()); return SendPacketNoLock(response.GetString()); } return SendErrorResponse(14); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_QThreadSuffixSupported( StringExtractorGDBRemote &packet) { m_thread_suffix_supported = true; return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_QListThreadsInStopReply( StringExtractorGDBRemote &packet) { m_list_threads_in_stop_reply = true; return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::ResumeProcess( NativeProcessProtocol &process, const ResumeActionList &actions) { Log *log = GetLog(LLDBLog::Process | LLDBLog::Thread); // In non-stop protocol mode, the process could be running already. // We do not support resuming threads independently, so just error out. if (!process.CanResume()) { LLDB_LOG(log, "process {0} cannot be resumed (state={1})", process.GetID(), process.GetState()); return SendErrorResponse(0x37); } Status error = process.Resume(actions); if (error.Fail()) { LLDB_LOG(log, "process {0} failed to resume: {1}", process.GetID(), error); return SendErrorResponse(GDBRemoteServerError::eErrorResume); } LLDB_LOG(log, "process {0} resumed", process.GetID()); return PacketResult::Success; } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_C(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process | LLDBLog::Thread); LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s called", __FUNCTION__); // Ensure we have a native process. if (!m_continue_process) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s no debugged process " "shared pointer", __FUNCTION__); return SendErrorResponse(0x36); } // Pull out the signal number. packet.SetFilePos(::strlen("C")); if (packet.GetBytesLeft() < 1) { // Shouldn't be using a C without a signal. return SendIllFormedResponse(packet, "C packet specified without signal."); } const uint32_t signo = packet.GetHexMaxU32(false, std::numeric_limits::max()); if (signo == std::numeric_limits::max()) return SendIllFormedResponse(packet, "failed to parse signal number"); // Handle optional continue address. if (packet.GetBytesLeft() > 0) { // FIXME add continue at address support for $C{signo}[;{continue-address}]. if (*packet.Peek() == ';') return SendUnimplementedResponse(packet.GetStringRef().data()); else return SendIllFormedResponse( packet, "unexpected content after $C{signal-number}"); } // In non-stop protocol mode, the process could be running already. // We do not support resuming threads independently, so just error out. if (!m_continue_process->CanResume()) { LLDB_LOG(log, "process cannot be resumed (state={0})", m_continue_process->GetState()); return SendErrorResponse(0x37); } ResumeActionList resume_actions(StateType::eStateRunning, LLDB_INVALID_SIGNAL_NUMBER); Status error; // We have two branches: what to do if a continue thread is specified (in // which case we target sending the signal to that thread), or when we don't // have a continue thread set (in which case we send a signal to the // process). // TODO discuss with Greg Clayton, make sure this makes sense. lldb::tid_t signal_tid = GetContinueThreadID(); if (signal_tid != LLDB_INVALID_THREAD_ID) { // The resume action for the continue thread (or all threads if a continue // thread is not set). ResumeAction action = {GetContinueThreadID(), StateType::eStateRunning, static_cast(signo)}; // Add the action for the continue thread (or all threads when the continue // thread isn't present). resume_actions.Append(action); } else { // Send the signal to the process since we weren't targeting a specific // continue thread with the signal. error = m_continue_process->Signal(signo); if (error.Fail()) { LLDB_LOG(log, "failed to send signal for process {0}: {1}", m_continue_process->GetID(), error); return SendErrorResponse(0x52); } } // NB: this checks CanResume() twice but using a single code path for // resuming still seems worth it. PacketResult resume_res = ResumeProcess(*m_continue_process, resume_actions); if (resume_res != PacketResult::Success) return resume_res; // Don't send an "OK" packet, except in non-stop mode; // otherwise, the response is the stopped/exited message. return SendContinueSuccessResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_c(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process | LLDBLog::Thread); LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s called", __FUNCTION__); packet.SetFilePos(packet.GetFilePos() + ::strlen("c")); // For now just support all continue. const bool has_continue_address = (packet.GetBytesLeft() > 0); if (has_continue_address) { LLDB_LOG(log, "not implemented for c[address] variant [{0} remains]", packet.Peek()); return SendUnimplementedResponse(packet.GetStringRef().data()); } // Ensure we have a native process. if (!m_continue_process) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s no debugged process " "shared pointer", __FUNCTION__); return SendErrorResponse(0x36); } // Build the ResumeActionList ResumeActionList actions(StateType::eStateRunning, LLDB_INVALID_SIGNAL_NUMBER); PacketResult resume_res = ResumeProcess(*m_continue_process, actions); if (resume_res != PacketResult::Success) return resume_res; return SendContinueSuccessResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_vCont_actions( StringExtractorGDBRemote &packet) { StreamString response; response.Printf("vCont;c;C;s;S;t"); return SendPacketNoLock(response.GetString()); } static bool ResumeActionListStopsAllThreads(ResumeActionList &actions) { // We're doing a stop-all if and only if our only action is a "t" for all // threads. if (const ResumeAction *default_action = actions.GetActionForThread(LLDB_INVALID_THREAD_ID, false)) { if (default_action->state == eStateSuspended && actions.GetSize() == 1) return true; } return false; } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_vCont( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s handling vCont packet", __FUNCTION__); packet.SetFilePos(::strlen("vCont")); if (packet.GetBytesLeft() == 0) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s missing action from " "vCont package", __FUNCTION__); return SendIllFormedResponse(packet, "Missing action from vCont package"); } if (::strcmp(packet.Peek(), ";s") == 0) { // Move past the ';', then do a simple 's'. packet.SetFilePos(packet.GetFilePos() + 1); return Handle_s(packet); } std::unordered_map thread_actions; while (packet.GetBytesLeft() && *packet.Peek() == ';') { // Skip the semi-colon. packet.GetChar(); // Build up the thread action. ResumeAction thread_action; thread_action.tid = LLDB_INVALID_THREAD_ID; thread_action.state = eStateInvalid; thread_action.signal = LLDB_INVALID_SIGNAL_NUMBER; const char action = packet.GetChar(); switch (action) { case 'C': thread_action.signal = packet.GetHexMaxU32(false, 0); if (thread_action.signal == 0) return SendIllFormedResponse( packet, "Could not parse signal in vCont packet C action"); [[fallthrough]]; case 'c': // Continue thread_action.state = eStateRunning; break; case 'S': thread_action.signal = packet.GetHexMaxU32(false, 0); if (thread_action.signal == 0) return SendIllFormedResponse( packet, "Could not parse signal in vCont packet S action"); [[fallthrough]]; case 's': // Step thread_action.state = eStateStepping; break; case 't': // Stop thread_action.state = eStateSuspended; break; default: return SendIllFormedResponse(packet, "Unsupported vCont action"); break; } // If there's no thread-id (e.g. "vCont;c"), it's "p-1.-1". lldb::pid_t pid = StringExtractorGDBRemote::AllProcesses; lldb::tid_t tid = StringExtractorGDBRemote::AllThreads; // Parse out optional :{thread-id} value. if (packet.GetBytesLeft() && (*packet.Peek() == ':')) { // Consume the separator. packet.GetChar(); auto pid_tid = packet.GetPidTid(LLDB_INVALID_PROCESS_ID); if (!pid_tid) return SendIllFormedResponse(packet, "Malformed thread-id"); pid = pid_tid->first; tid = pid_tid->second; } if (thread_action.state == eStateSuspended && tid != StringExtractorGDBRemote::AllThreads) { return SendIllFormedResponse( packet, "'t' action not supported for individual threads"); } // If we get TID without PID, it's the current process. if (pid == LLDB_INVALID_PROCESS_ID) { if (!m_continue_process) { LLDB_LOG(log, "no process selected via Hc"); return SendErrorResponse(0x36); } pid = m_continue_process->GetID(); } assert(pid != LLDB_INVALID_PROCESS_ID); if (tid == StringExtractorGDBRemote::AllThreads) tid = LLDB_INVALID_THREAD_ID; thread_action.tid = tid; if (pid == StringExtractorGDBRemote::AllProcesses) { if (tid != LLDB_INVALID_THREAD_ID) return SendIllFormedResponse( packet, "vCont: p-1 is not valid with a specific tid"); for (auto &process_it : m_debugged_processes) thread_actions[process_it.first].Append(thread_action); } else thread_actions[pid].Append(thread_action); } assert(thread_actions.size() >= 1); if (thread_actions.size() > 1 && !m_non_stop) return SendIllFormedResponse( packet, "Resuming multiple processes is supported in non-stop mode only"); for (std::pair x : thread_actions) { auto process_it = m_debugged_processes.find(x.first); if (process_it == m_debugged_processes.end()) { LLDB_LOG(log, "vCont failed for process {0}: process not debugged", x.first); return SendErrorResponse(GDBRemoteServerError::eErrorResume); } // There are four possible scenarios here. These are: // 1. vCont on a stopped process that resumes at least one thread. // In this case, we call Resume(). // 2. vCont on a stopped process that leaves all threads suspended. // A no-op. // 3. vCont on a running process that requests suspending all // running threads. In this case, we call Interrupt(). // 4. vCont on a running process that requests suspending a subset // of running threads or resuming a subset of suspended threads. // Since we do not support full nonstop mode, this is unsupported // and we return an error. assert(process_it->second.process_up); if (ResumeActionListStopsAllThreads(x.second)) { if (process_it->second.process_up->IsRunning()) { assert(m_non_stop); Status error = process_it->second.process_up->Interrupt(); if (error.Fail()) { LLDB_LOG(log, "vCont failed to halt process {0}: {1}", x.first, error); return SendErrorResponse(GDBRemoteServerError::eErrorResume); } LLDB_LOG(log, "halted process {0}", x.first); // hack to avoid enabling stdio forwarding after stop // TODO: remove this when we improve stdio forwarding for nonstop assert(thread_actions.size() == 1); return SendOKResponse(); } } else { PacketResult resume_res = ResumeProcess(*process_it->second.process_up, x.second); if (resume_res != PacketResult::Success) return resume_res; } } return SendContinueSuccessResponse(); } void GDBRemoteCommunicationServerLLGS::SetCurrentThreadID(lldb::tid_t tid) { Log *log = GetLog(LLDBLog::Thread); LLDB_LOG(log, "setting current thread id to {0}", tid); m_current_tid = tid; if (m_current_process) m_current_process->SetCurrentThreadID(m_current_tid); } void GDBRemoteCommunicationServerLLGS::SetContinueThreadID(lldb::tid_t tid) { Log *log = GetLog(LLDBLog::Thread); LLDB_LOG(log, "setting continue thread id to {0}", tid); m_continue_tid = tid; } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_stop_reason( StringExtractorGDBRemote &packet) { // Handle the $? gdbremote command. if (m_non_stop) { // Clear the notification queue first, except for pending exit // notifications. llvm::erase_if(m_stop_notification_queue, [](const std::string &x) { return x.front() != 'W' && x.front() != 'X'; }); if (m_current_process) { // Queue stop reply packets for all active threads. Start with // the current thread (for clients that don't actually support multiple // stop reasons). NativeThreadProtocol *thread = m_current_process->GetCurrentThread(); if (thread) { StreamString stop_reply = PrepareStopReplyPacketForThread(*thread); if (!stop_reply.Empty()) m_stop_notification_queue.push_back(stop_reply.GetString().str()); } EnqueueStopReplyPackets(thread ? thread->GetID() : LLDB_INVALID_THREAD_ID); } // If the notification queue is empty (i.e. everything is running), send OK. if (m_stop_notification_queue.empty()) return SendOKResponse(); // Send the first item from the new notification queue synchronously. return SendPacketNoLock(m_stop_notification_queue.front()); } // If no process, indicate error if (!m_current_process) return SendErrorResponse(02); return SendStopReasonForState(*m_current_process, m_current_process->GetState(), /*force_synchronous=*/true); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::SendStopReasonForState( NativeProcessProtocol &process, lldb::StateType process_state, bool force_synchronous) { Log *log = GetLog(LLDBLog::Process); if (m_disabling_non_stop) { // Check if we are waiting for any more processes to stop. If we are, // do not send the OK response yet. for (const auto &it : m_debugged_processes) { if (it.second.process_up->IsRunning()) return PacketResult::Success; } // If all expected processes were stopped after a QNonStop:0 request, // send the OK response. m_disabling_non_stop = false; return SendOKResponse(); } switch (process_state) { case eStateAttaching: case eStateLaunching: case eStateRunning: case eStateStepping: case eStateDetached: // NOTE: gdb protocol doc looks like it should return $OK // when everything is running (i.e. no stopped result). return PacketResult::Success; // Ignore case eStateSuspended: case eStateStopped: case eStateCrashed: { lldb::tid_t tid = process.GetCurrentThreadID(); // Make sure we set the current thread so g and p packets return the data // the gdb will expect. SetCurrentThreadID(tid); return SendStopReplyPacketForThread(process, tid, force_synchronous); } case eStateInvalid: case eStateUnloaded: case eStateExited: return SendWResponse(&process); default: LLDB_LOG(log, "pid {0}, current state reporting not handled: {1}", process.GetID(), process_state); break; } return SendErrorResponse(0); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qRegisterInfo( StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(68); // Ensure we have a thread. NativeThreadProtocol *thread = m_current_process->GetThreadAtIndex(0); if (!thread) return SendErrorResponse(69); // Get the register context for the first thread. NativeRegisterContext ®_context = thread->GetRegisterContext(); // Parse out the register number from the request. packet.SetFilePos(strlen("qRegisterInfo")); const uint32_t reg_index = packet.GetHexMaxU32(false, std::numeric_limits::max()); if (reg_index == std::numeric_limits::max()) return SendErrorResponse(69); // Return the end of registers response if we've iterated one past the end of // the register set. if (reg_index >= reg_context.GetUserRegisterCount()) return SendErrorResponse(69); const RegisterInfo *reg_info = reg_context.GetRegisterInfoAtIndex(reg_index); if (!reg_info) return SendErrorResponse(69); // Build the reginfos response. StreamGDBRemote response; response.PutCString("name:"); response.PutCString(reg_info->name); response.PutChar(';'); if (reg_info->alt_name && reg_info->alt_name[0]) { response.PutCString("alt-name:"); response.PutCString(reg_info->alt_name); response.PutChar(';'); } response.Printf("bitsize:%" PRIu32 ";", reg_info->byte_size * 8); if (!reg_context.RegisterOffsetIsDynamic()) response.Printf("offset:%" PRIu32 ";", reg_info->byte_offset); llvm::StringRef encoding = GetEncodingNameOrEmpty(*reg_info); if (!encoding.empty()) response << "encoding:" << encoding << ';'; llvm::StringRef format = GetFormatNameOrEmpty(*reg_info); if (!format.empty()) response << "format:" << format << ';'; const char *const register_set_name = reg_context.GetRegisterSetNameForRegisterAtIndex(reg_index); if (register_set_name) response << "set:" << register_set_name << ';'; if (reg_info->kinds[RegisterKind::eRegisterKindEHFrame] != LLDB_INVALID_REGNUM) response.Printf("ehframe:%" PRIu32 ";", reg_info->kinds[RegisterKind::eRegisterKindEHFrame]); if (reg_info->kinds[RegisterKind::eRegisterKindDWARF] != LLDB_INVALID_REGNUM) response.Printf("dwarf:%" PRIu32 ";", reg_info->kinds[RegisterKind::eRegisterKindDWARF]); llvm::StringRef kind_generic = GetKindGenericOrEmpty(*reg_info); if (!kind_generic.empty()) response << "generic:" << kind_generic << ';'; if (reg_info->value_regs && reg_info->value_regs[0] != LLDB_INVALID_REGNUM) { response.PutCString("container-regs:"); CollectRegNums(reg_info->value_regs, response, true); response.PutChar(';'); } if (reg_info->invalidate_regs && reg_info->invalidate_regs[0]) { response.PutCString("invalidate-regs:"); CollectRegNums(reg_info->invalidate_regs, response, true); response.PutChar(';'); } return SendPacketNoLock(response.GetString()); } void GDBRemoteCommunicationServerLLGS::AddProcessThreads( StreamGDBRemote &response, NativeProcessProtocol &process, bool &had_any) { Log *log = GetLog(LLDBLog::Thread); lldb::pid_t pid = process.GetID(); if (pid == LLDB_INVALID_PROCESS_ID) return; LLDB_LOG(log, "iterating over threads of process {0}", process.GetID()); for (NativeThreadProtocol &thread : process.Threads()) { LLDB_LOG(log, "iterated thread tid={0}", thread.GetID()); response.PutChar(had_any ? ',' : 'm'); AppendThreadIDToResponse(response, pid, thread.GetID()); had_any = true; } } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qfThreadInfo( StringExtractorGDBRemote &packet) { assert(m_debugged_processes.size() <= 1 || bool(m_extensions_supported & NativeProcessProtocol::Extension::multiprocess)); bool had_any = false; StreamGDBRemote response; for (auto &pid_ptr : m_debugged_processes) AddProcessThreads(response, *pid_ptr.second.process_up, had_any); if (!had_any) return SendOKResponse(); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qsThreadInfo( StringExtractorGDBRemote &packet) { // FIXME for now we return the full thread list in the initial packet and // always do nothing here. return SendPacketNoLock("l"); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_g(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Thread); // Move past packet name. packet.SetFilePos(strlen("g")); // Get the thread to use. NativeThreadProtocol *thread = GetThreadFromSuffix(packet); if (!thread) { LLDB_LOG(log, "failed, no thread available"); return SendErrorResponse(0x15); } // Get the thread's register context. NativeRegisterContext ®_ctx = thread->GetRegisterContext(); std::vector regs_buffer; for (uint32_t reg_num = 0; reg_num < reg_ctx.GetUserRegisterCount(); ++reg_num) { const RegisterInfo *reg_info = reg_ctx.GetRegisterInfoAtIndex(reg_num); if (reg_info == nullptr) { LLDB_LOG(log, "failed to get register info for register index {0}", reg_num); return SendErrorResponse(0x15); } if (reg_info->value_regs != nullptr) continue; // skip registers that are contained in other registers RegisterValue reg_value; Status error = reg_ctx.ReadRegister(reg_info, reg_value); if (error.Fail()) { LLDB_LOG(log, "failed to read register at index {0}", reg_num); return SendErrorResponse(0x15); } if (reg_info->byte_offset + reg_info->byte_size >= regs_buffer.size()) // Resize the buffer to guarantee it can store the register offsetted // data. regs_buffer.resize(reg_info->byte_offset + reg_info->byte_size); // Copy the register offsetted data to the buffer. memcpy(regs_buffer.data() + reg_info->byte_offset, reg_value.GetBytes(), reg_info->byte_size); } // Write the response. StreamGDBRemote response; response.PutBytesAsRawHex8(regs_buffer.data(), regs_buffer.size()); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_p(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Thread); // Parse out the register number from the request. packet.SetFilePos(strlen("p")); const uint32_t reg_index = packet.GetHexMaxU32(false, std::numeric_limits::max()); if (reg_index == std::numeric_limits::max()) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, could not " "parse register number from request \"%s\"", __FUNCTION__, packet.GetStringRef().data()); return SendErrorResponse(0x15); } // Get the thread to use. NativeThreadProtocol *thread = GetThreadFromSuffix(packet); if (!thread) { LLDB_LOG(log, "failed, no thread available"); return SendErrorResponse(0x15); } // Get the thread's register context. NativeRegisterContext ®_context = thread->GetRegisterContext(); // Return the end of registers response if we've iterated one past the end of // the register set. if (reg_index >= reg_context.GetUserRegisterCount()) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, requested " "register %" PRIu32 " beyond register count %" PRIu32, __FUNCTION__, reg_index, reg_context.GetUserRegisterCount()); return SendErrorResponse(0x15); } const RegisterInfo *reg_info = reg_context.GetRegisterInfoAtIndex(reg_index); if (!reg_info) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, requested " "register %" PRIu32 " returned NULL", __FUNCTION__, reg_index); return SendErrorResponse(0x15); } // Build the reginfos response. StreamGDBRemote response; // Retrieve the value RegisterValue reg_value; Status error = reg_context.ReadRegister(reg_info, reg_value); if (error.Fail()) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, read of " "requested register %" PRIu32 " (%s) failed: %s", __FUNCTION__, reg_index, reg_info->name, error.AsCString()); return SendErrorResponse(0x15); } const uint8_t *const data = static_cast(reg_value.GetBytes()); if (!data) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed to get data " "bytes from requested register %" PRIu32, __FUNCTION__, reg_index); return SendErrorResponse(0x15); } // FIXME flip as needed to get data in big/little endian format for this host. for (uint32_t i = 0; i < reg_value.GetByteSize(); ++i) response.PutHex8(data[i]); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_P(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Thread); // Ensure there is more content. if (packet.GetBytesLeft() < 1) return SendIllFormedResponse(packet, "Empty P packet"); // Parse out the register number from the request. packet.SetFilePos(strlen("P")); const uint32_t reg_index = packet.GetHexMaxU32(false, std::numeric_limits::max()); if (reg_index == std::numeric_limits::max()) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, could not " "parse register number from request \"%s\"", __FUNCTION__, packet.GetStringRef().data()); return SendErrorResponse(0x29); } // Note debugserver would send an E30 here. if ((packet.GetBytesLeft() < 1) || (packet.GetChar() != '=')) return SendIllFormedResponse( packet, "P packet missing '=' char after register number"); // Parse out the value. size_t reg_size = packet.GetHexBytesAvail(m_reg_bytes); // Get the thread to use. NativeThreadProtocol *thread = GetThreadFromSuffix(packet); if (!thread) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, no thread " "available (thread index 0)", __FUNCTION__); return SendErrorResponse(0x28); } // Get the thread's register context. NativeRegisterContext ®_context = thread->GetRegisterContext(); const RegisterInfo *reg_info = reg_context.GetRegisterInfoAtIndex(reg_index); if (!reg_info) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, requested " "register %" PRIu32 " returned NULL", __FUNCTION__, reg_index); return SendErrorResponse(0x48); } // Return the end of registers response if we've iterated one past the end of // the register set. if (reg_index >= reg_context.GetUserRegisterCount()) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, requested " "register %" PRIu32 " beyond register count %" PRIu32, __FUNCTION__, reg_index, reg_context.GetUserRegisterCount()); return SendErrorResponse(0x47); } if (reg_size != reg_info->byte_size) return SendIllFormedResponse(packet, "P packet register size is incorrect"); // Build the reginfos response. StreamGDBRemote response; RegisterValue reg_value(ArrayRef(m_reg_bytes, reg_size), m_current_process->GetArchitecture().GetByteOrder()); Status error = reg_context.WriteRegister(reg_info, reg_value); if (error.Fail()) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, write of " "requested register %" PRIu32 " (%s) failed: %s", __FUNCTION__, reg_index, reg_info->name, error.AsCString()); return SendErrorResponse(0x32); } return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_H(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Thread); // Parse out which variant of $H is requested. packet.SetFilePos(strlen("H")); if (packet.GetBytesLeft() < 1) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, H command " "missing {g,c} variant", __FUNCTION__); return SendIllFormedResponse(packet, "H command missing {g,c} variant"); } const char h_variant = packet.GetChar(); NativeProcessProtocol *default_process; switch (h_variant) { case 'g': default_process = m_current_process; break; case 'c': default_process = m_continue_process; break; default: LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, invalid $H variant %c", __FUNCTION__, h_variant); return SendIllFormedResponse(packet, "H variant unsupported, should be c or g"); } // Parse out the thread number. auto pid_tid = packet.GetPidTid(default_process ? default_process->GetID() : LLDB_INVALID_PROCESS_ID); if (!pid_tid) return SendErrorResponse(llvm::make_error( inconvertibleErrorCode(), "Malformed thread-id")); lldb::pid_t pid = pid_tid->first; lldb::tid_t tid = pid_tid->second; if (pid == StringExtractorGDBRemote::AllProcesses) return SendUnimplementedResponse("Selecting all processes not supported"); if (pid == LLDB_INVALID_PROCESS_ID) return SendErrorResponse(llvm::make_error( inconvertibleErrorCode(), "No current process and no PID provided")); // Check the process ID and find respective process instance. auto new_process_it = m_debugged_processes.find(pid); if (new_process_it == m_debugged_processes.end()) return SendErrorResponse(llvm::make_error( inconvertibleErrorCode(), llvm::formatv("No process with PID {0} debugged", pid))); // Ensure we have the given thread when not specifying -1 (all threads) or 0 // (any thread). if (tid != LLDB_INVALID_THREAD_ID && tid != 0) { NativeThreadProtocol *thread = new_process_it->second.process_up->GetThreadByID(tid); if (!thread) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, tid %" PRIu64 " not found", __FUNCTION__, tid); return SendErrorResponse(0x15); } } // Now switch the given process and thread type. switch (h_variant) { case 'g': m_current_process = new_process_it->second.process_up.get(); SetCurrentThreadID(tid); break; case 'c': m_continue_process = new_process_it->second.process_up.get(); SetContinueThreadID(tid); break; default: assert(false && "unsupported $H variant - shouldn't get here"); return SendIllFormedResponse(packet, "H variant unsupported, should be c or g"); } return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_I(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Thread); // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, no process available", __FUNCTION__); return SendErrorResponse(0x15); } packet.SetFilePos(::strlen("I")); uint8_t tmp[4096]; for (;;) { size_t read = packet.GetHexBytesAvail(tmp); if (read == 0) { break; } // write directly to stdin *this might block if stdin buffer is full* // TODO: enqueue this block in circular buffer and send window size to // remote host ConnectionStatus status; Status error; m_stdio_communication.WriteAll(tmp, read, status, &error); if (error.Fail()) { return SendErrorResponse(0x15); } } return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_interrupt( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process | LLDBLog::Thread); // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOG(log, "failed, no process available"); return SendErrorResponse(0x15); } // Interrupt the process. Status error = m_current_process->Interrupt(); if (error.Fail()) { LLDB_LOG(log, "failed for process {0}: {1}", m_current_process->GetID(), error); return SendErrorResponse(GDBRemoteServerError::eErrorResume); } LLDB_LOG(log, "stopped process {0}", m_current_process->GetID()); // No response required from stop all. return PacketResult::Success; } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_memory_read( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, no process available", __FUNCTION__); return SendErrorResponse(0x15); } // Parse out the memory address. packet.SetFilePos(strlen("m")); if (packet.GetBytesLeft() < 1) return SendIllFormedResponse(packet, "Too short m packet"); // Read the address. Punting on validation. // FIXME replace with Hex U64 read with no default value that fails on failed // read. const lldb::addr_t read_addr = packet.GetHexMaxU64(false, 0); // Validate comma. if ((packet.GetBytesLeft() < 1) || (packet.GetChar() != ',')) return SendIllFormedResponse(packet, "Comma sep missing in m packet"); // Get # bytes to read. if (packet.GetBytesLeft() < 1) return SendIllFormedResponse(packet, "Length missing in m packet"); const uint64_t byte_count = packet.GetHexMaxU64(false, 0); if (byte_count == 0) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s nothing to read: " "zero-length packet", __FUNCTION__); return SendOKResponse(); } // Allocate the response buffer. std::string buf(byte_count, '\0'); if (buf.empty()) return SendErrorResponse(0x78); // Retrieve the process memory. size_t bytes_read = 0; Status error = m_current_process->ReadMemoryWithoutTrap( read_addr, &buf[0], byte_count, bytes_read); if (error.Fail()) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s pid %" PRIu64 " mem 0x%" PRIx64 ": failed to read. Error: %s", __FUNCTION__, m_current_process->GetID(), read_addr, error.AsCString()); return SendErrorResponse(0x08); } if (bytes_read == 0) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s pid %" PRIu64 " mem 0x%" PRIx64 ": read 0 of %" PRIu64 " requested bytes", __FUNCTION__, m_current_process->GetID(), read_addr, byte_count); return SendErrorResponse(0x08); } StreamGDBRemote response; packet.SetFilePos(0); char kind = packet.GetChar('?'); if (kind == 'x') response.PutEscapedBytes(buf.data(), byte_count); else { assert(kind == 'm'); for (size_t i = 0; i < bytes_read; ++i) response.PutHex8(buf[i]); } return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle__M(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, no process available", __FUNCTION__); return SendErrorResponse(0x15); } // Parse out the memory address. packet.SetFilePos(strlen("_M")); if (packet.GetBytesLeft() < 1) return SendIllFormedResponse(packet, "Too short _M packet"); const lldb::addr_t size = packet.GetHexMaxU64(false, LLDB_INVALID_ADDRESS); if (size == LLDB_INVALID_ADDRESS) return SendIllFormedResponse(packet, "Address not valid"); if (packet.GetChar() != ',') return SendIllFormedResponse(packet, "Bad packet"); Permissions perms = {}; while (packet.GetBytesLeft() > 0) { switch (packet.GetChar()) { case 'r': perms |= ePermissionsReadable; break; case 'w': perms |= ePermissionsWritable; break; case 'x': perms |= ePermissionsExecutable; break; default: return SendIllFormedResponse(packet, "Bad permissions"); } } llvm::Expected addr = m_current_process->AllocateMemory(size, perms); if (!addr) return SendErrorResponse(addr.takeError()); StreamGDBRemote response; response.PutHex64(*addr); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle__m(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, no process available", __FUNCTION__); return SendErrorResponse(0x15); } // Parse out the memory address. packet.SetFilePos(strlen("_m")); if (packet.GetBytesLeft() < 1) return SendIllFormedResponse(packet, "Too short m packet"); const lldb::addr_t addr = packet.GetHexMaxU64(false, LLDB_INVALID_ADDRESS); if (addr == LLDB_INVALID_ADDRESS) return SendIllFormedResponse(packet, "Address not valid"); if (llvm::Error Err = m_current_process->DeallocateMemory(addr)) return SendErrorResponse(std::move(Err)); return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_M(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, no process available", __FUNCTION__); return SendErrorResponse(0x15); } // Parse out the memory address. packet.SetFilePos(strlen("M")); if (packet.GetBytesLeft() < 1) return SendIllFormedResponse(packet, "Too short M packet"); // Read the address. Punting on validation. // FIXME replace with Hex U64 read with no default value that fails on failed // read. const lldb::addr_t write_addr = packet.GetHexMaxU64(false, 0); // Validate comma. if ((packet.GetBytesLeft() < 1) || (packet.GetChar() != ',')) return SendIllFormedResponse(packet, "Comma sep missing in M packet"); // Get # bytes to read. if (packet.GetBytesLeft() < 1) return SendIllFormedResponse(packet, "Length missing in M packet"); const uint64_t byte_count = packet.GetHexMaxU64(false, 0); if (byte_count == 0) { LLDB_LOG(log, "nothing to write: zero-length packet"); return PacketResult::Success; } // Validate colon. if ((packet.GetBytesLeft() < 1) || (packet.GetChar() != ':')) return SendIllFormedResponse( packet, "Comma sep missing in M packet after byte length"); // Allocate the conversion buffer. std::vector buf(byte_count, 0); if (buf.empty()) return SendErrorResponse(0x78); // Convert the hex memory write contents to bytes. StreamGDBRemote response; const uint64_t convert_count = packet.GetHexBytes(buf, 0); if (convert_count != byte_count) { LLDB_LOG(log, "pid {0} mem {1:x}: asked to write {2} bytes, but only found {3} " "to convert.", m_current_process->GetID(), write_addr, byte_count, convert_count); return SendIllFormedResponse(packet, "M content byte length specified did " "not match hex-encoded content " "length"); } // Write the process memory. size_t bytes_written = 0; Status error = m_current_process->WriteMemory(write_addr, &buf[0], byte_count, bytes_written); if (error.Fail()) { LLDB_LOG(log, "pid {0} mem {1:x}: failed to write. Error: {2}", m_current_process->GetID(), write_addr, error); return SendErrorResponse(0x09); } if (bytes_written == 0) { LLDB_LOG(log, "pid {0} mem {1:x}: wrote 0 of {2} requested bytes", m_current_process->GetID(), write_addr, byte_count); return SendErrorResponse(0x09); } return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qMemoryRegionInfoSupported( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); // Currently only the NativeProcessProtocol knows if it can handle a // qMemoryRegionInfoSupported request, but we're not guaranteed to be // attached to a process. For now we'll assume the client only asks this // when a process is being debugged. // Ensure we have a process running; otherwise, we can't figure this out // since we won't have a NativeProcessProtocol. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, no process available", __FUNCTION__); return SendErrorResponse(0x15); } // Test if we can get any region back when asking for the region around NULL. MemoryRegionInfo region_info; const Status error = m_current_process->GetMemoryRegionInfo(0, region_info); if (error.Fail()) { // We don't support memory region info collection for this // NativeProcessProtocol. return SendUnimplementedResponse(""); } return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qMemoryRegionInfo( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); // Ensure we have a process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, no process available", __FUNCTION__); return SendErrorResponse(0x15); } // Parse out the memory address. packet.SetFilePos(strlen("qMemoryRegionInfo:")); if (packet.GetBytesLeft() < 1) return SendIllFormedResponse(packet, "Too short qMemoryRegionInfo: packet"); // Read the address. Punting on validation. const lldb::addr_t read_addr = packet.GetHexMaxU64(false, 0); StreamGDBRemote response; // Get the memory region info for the target address. MemoryRegionInfo region_info; const Status error = m_current_process->GetMemoryRegionInfo(read_addr, region_info); if (error.Fail()) { // Return the error message. response.PutCString("error:"); response.PutStringAsRawHex8(error.AsCString()); response.PutChar(';'); } else { // Range start and size. response.Printf("start:%" PRIx64 ";size:%" PRIx64 ";", region_info.GetRange().GetRangeBase(), region_info.GetRange().GetByteSize()); // Permissions. if (region_info.GetReadable() || region_info.GetWritable() || region_info.GetExecutable()) { // Write permissions info. response.PutCString("permissions:"); if (region_info.GetReadable()) response.PutChar('r'); if (region_info.GetWritable()) response.PutChar('w'); if (region_info.GetExecutable()) response.PutChar('x'); response.PutChar(';'); } // Flags MemoryRegionInfo::OptionalBool memory_tagged = region_info.GetMemoryTagged(); if (memory_tagged != MemoryRegionInfo::eDontKnow) { response.PutCString("flags:"); if (memory_tagged == MemoryRegionInfo::eYes) { response.PutCString("mt"); } response.PutChar(';'); } // Name ConstString name = region_info.GetName(); if (name) { response.PutCString("name:"); response.PutStringAsRawHex8(name.GetStringRef()); response.PutChar(';'); } } return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_Z(StringExtractorGDBRemote &packet) { // Ensure we have a process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { Log *log = GetLog(LLDBLog::Process); LLDB_LOG(log, "failed, no process available"); return SendErrorResponse(0x15); } // Parse out software or hardware breakpoint or watchpoint requested. packet.SetFilePos(strlen("Z")); if (packet.GetBytesLeft() < 1) return SendIllFormedResponse( packet, "Too short Z packet, missing software/hardware specifier"); bool want_breakpoint = true; bool want_hardware = false; uint32_t watch_flags = 0; const GDBStoppointType stoppoint_type = GDBStoppointType(packet.GetS32(eStoppointInvalid)); switch (stoppoint_type) { case eBreakpointSoftware: want_hardware = false; want_breakpoint = true; break; case eBreakpointHardware: want_hardware = true; want_breakpoint = true; break; case eWatchpointWrite: watch_flags = 1; want_hardware = true; want_breakpoint = false; break; case eWatchpointRead: watch_flags = 2; want_hardware = true; want_breakpoint = false; break; case eWatchpointReadWrite: watch_flags = 3; want_hardware = true; want_breakpoint = false; break; case eStoppointInvalid: return SendIllFormedResponse( packet, "Z packet had invalid software/hardware specifier"); } if ((packet.GetBytesLeft() < 1) || packet.GetChar() != ',') return SendIllFormedResponse( packet, "Malformed Z packet, expecting comma after stoppoint type"); // Parse out the stoppoint address. if (packet.GetBytesLeft() < 1) return SendIllFormedResponse(packet, "Too short Z packet, missing address"); const lldb::addr_t addr = packet.GetHexMaxU64(false, 0); if ((packet.GetBytesLeft() < 1) || packet.GetChar() != ',') return SendIllFormedResponse( packet, "Malformed Z packet, expecting comma after address"); // Parse out the stoppoint size (i.e. size hint for opcode size). const uint32_t size = packet.GetHexMaxU32(false, std::numeric_limits::max()); if (size == std::numeric_limits::max()) return SendIllFormedResponse( packet, "Malformed Z packet, failed to parse size argument"); if (want_breakpoint) { // Try to set the breakpoint. const Status error = m_current_process->SetBreakpoint(addr, size, want_hardware); if (error.Success()) return SendOKResponse(); Log *log = GetLog(LLDBLog::Breakpoints); LLDB_LOG(log, "pid {0} failed to set breakpoint: {1}", m_current_process->GetID(), error); return SendErrorResponse(0x09); } else { // Try to set the watchpoint. const Status error = m_current_process->SetWatchpoint( addr, size, watch_flags, want_hardware); if (error.Success()) return SendOKResponse(); Log *log = GetLog(LLDBLog::Watchpoints); LLDB_LOG(log, "pid {0} failed to set watchpoint: {1}", m_current_process->GetID(), error); return SendErrorResponse(0x09); } } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_z(StringExtractorGDBRemote &packet) { // Ensure we have a process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { Log *log = GetLog(LLDBLog::Process); LLDB_LOG(log, "failed, no process available"); return SendErrorResponse(0x15); } // Parse out software or hardware breakpoint or watchpoint requested. packet.SetFilePos(strlen("z")); if (packet.GetBytesLeft() < 1) return SendIllFormedResponse( packet, "Too short z packet, missing software/hardware specifier"); bool want_breakpoint = true; bool want_hardware = false; const GDBStoppointType stoppoint_type = GDBStoppointType(packet.GetS32(eStoppointInvalid)); switch (stoppoint_type) { case eBreakpointHardware: want_breakpoint = true; want_hardware = true; break; case eBreakpointSoftware: want_breakpoint = true; break; case eWatchpointWrite: want_breakpoint = false; break; case eWatchpointRead: want_breakpoint = false; break; case eWatchpointReadWrite: want_breakpoint = false; break; default: return SendIllFormedResponse( packet, "z packet had invalid software/hardware specifier"); } if ((packet.GetBytesLeft() < 1) || packet.GetChar() != ',') return SendIllFormedResponse( packet, "Malformed z packet, expecting comma after stoppoint type"); // Parse out the stoppoint address. if (packet.GetBytesLeft() < 1) return SendIllFormedResponse(packet, "Too short z packet, missing address"); const lldb::addr_t addr = packet.GetHexMaxU64(false, 0); if ((packet.GetBytesLeft() < 1) || packet.GetChar() != ',') return SendIllFormedResponse( packet, "Malformed z packet, expecting comma after address"); /* // Parse out the stoppoint size (i.e. size hint for opcode size). const uint32_t size = packet.GetHexMaxU32 (false, std::numeric_limits::max ()); if (size == std::numeric_limits::max ()) return SendIllFormedResponse(packet, "Malformed z packet, failed to parse size argument"); */ if (want_breakpoint) { // Try to clear the breakpoint. const Status error = m_current_process->RemoveBreakpoint(addr, want_hardware); if (error.Success()) return SendOKResponse(); Log *log = GetLog(LLDBLog::Breakpoints); LLDB_LOG(log, "pid {0} failed to remove breakpoint: {1}", m_current_process->GetID(), error); return SendErrorResponse(0x09); } else { // Try to clear the watchpoint. const Status error = m_current_process->RemoveWatchpoint(addr); if (error.Success()) return SendOKResponse(); Log *log = GetLog(LLDBLog::Watchpoints); LLDB_LOG(log, "pid {0} failed to remove watchpoint: {1}", m_current_process->GetID(), error); return SendErrorResponse(0x09); } } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_s(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process | LLDBLog::Thread); // Ensure we have a process. if (!m_continue_process || (m_continue_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, no process available", __FUNCTION__); return SendErrorResponse(0x32); } // We first try to use a continue thread id. If any one or any all set, use // the current thread. Bail out if we don't have a thread id. lldb::tid_t tid = GetContinueThreadID(); if (tid == 0 || tid == LLDB_INVALID_THREAD_ID) tid = GetCurrentThreadID(); if (tid == LLDB_INVALID_THREAD_ID) return SendErrorResponse(0x33); // Double check that we have such a thread. // TODO investigate: on MacOSX we might need to do an UpdateThreads () here. NativeThreadProtocol *thread = m_continue_process->GetThreadByID(tid); if (!thread) return SendErrorResponse(0x33); // Create the step action for the given thread. ResumeAction action = {tid, eStateStepping, LLDB_INVALID_SIGNAL_NUMBER}; // Setup the actions list. ResumeActionList actions; actions.Append(action); // All other threads stop while we're single stepping a thread. actions.SetDefaultThreadActionIfNeeded(eStateStopped, 0); PacketResult resume_res = ResumeProcess(*m_continue_process, actions); if (resume_res != PacketResult::Success) return resume_res; // No response here, unless in non-stop mode. // Otherwise, the stop or exit will come from the resulting action. return SendContinueSuccessResponse(); } llvm::Expected> GDBRemoteCommunicationServerLLGS::BuildTargetXml() { // Ensure we have a thread. NativeThreadProtocol *thread = m_current_process->GetThreadAtIndex(0); if (!thread) return llvm::createStringError(llvm::inconvertibleErrorCode(), "No thread available"); Log *log = GetLog(LLDBLog::Process | LLDBLog::Thread); // Get the register context for the first thread. NativeRegisterContext ®_context = thread->GetRegisterContext(); StreamString response; response.Printf("\n"); response.Printf("\n"); response.IndentMore(); response.Indent(); response.Printf("%s\n", m_current_process->GetArchitecture() .GetTriple() .getArchName() .str() .c_str()); response.Indent("\n"); const int registers_count = reg_context.GetUserRegisterCount(); if (registers_count) response.IndentMore(); llvm::StringSet<> field_enums_seen; for (int reg_index = 0; reg_index < registers_count; reg_index++) { const RegisterInfo *reg_info = reg_context.GetRegisterInfoAtIndex(reg_index); if (!reg_info) { LLDB_LOGF(log, "%s failed to get register info for register index %" PRIu32, "target.xml", reg_index); continue; } if (reg_info->flags_type) { response.IndentMore(); reg_info->flags_type->EnumsToXML(response, field_enums_seen); reg_info->flags_type->ToXML(response); response.IndentLess(); } response.Indent(); response.Printf("name, reg_info->byte_size * 8, reg_index); if (!reg_context.RegisterOffsetIsDynamic()) response.Printf("offset=\"%" PRIu32 "\" ", reg_info->byte_offset); if (reg_info->alt_name && reg_info->alt_name[0]) response.Printf("altname=\"%s\" ", reg_info->alt_name); llvm::StringRef encoding = GetEncodingNameOrEmpty(*reg_info); if (!encoding.empty()) response << "encoding=\"" << encoding << "\" "; llvm::StringRef format = GetFormatNameOrEmpty(*reg_info); if (!format.empty()) response << "format=\"" << format << "\" "; if (reg_info->flags_type) response << "type=\"" << reg_info->flags_type->GetID() << "\" "; const char *const register_set_name = reg_context.GetRegisterSetNameForRegisterAtIndex(reg_index); if (register_set_name) response << "group=\"" << register_set_name << "\" "; if (reg_info->kinds[RegisterKind::eRegisterKindEHFrame] != LLDB_INVALID_REGNUM) response.Printf("ehframe_regnum=\"%" PRIu32 "\" ", reg_info->kinds[RegisterKind::eRegisterKindEHFrame]); if (reg_info->kinds[RegisterKind::eRegisterKindDWARF] != LLDB_INVALID_REGNUM) response.Printf("dwarf_regnum=\"%" PRIu32 "\" ", reg_info->kinds[RegisterKind::eRegisterKindDWARF]); llvm::StringRef kind_generic = GetKindGenericOrEmpty(*reg_info); if (!kind_generic.empty()) response << "generic=\"" << kind_generic << "\" "; if (reg_info->value_regs && reg_info->value_regs[0] != LLDB_INVALID_REGNUM) { response.PutCString("value_regnums=\""); CollectRegNums(reg_info->value_regs, response, false); response.Printf("\" "); } if (reg_info->invalidate_regs && reg_info->invalidate_regs[0]) { response.PutCString("invalidate_regnums=\""); CollectRegNums(reg_info->invalidate_regs, response, false); response.Printf("\" "); } response.Printf("/>\n"); } if (registers_count) response.IndentLess(); response.Indent("\n"); response.IndentLess(); response.Indent("\n"); return MemoryBuffer::getMemBufferCopy(response.GetString(), "target.xml"); } llvm::Expected> GDBRemoteCommunicationServerLLGS::ReadXferObject(llvm::StringRef object, llvm::StringRef annex) { // Make sure we have a valid process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { return llvm::createStringError(llvm::inconvertibleErrorCode(), "No process available"); } if (object == "auxv") { // Grab the auxv data. auto buffer_or_error = m_current_process->GetAuxvData(); if (!buffer_or_error) return llvm::errorCodeToError(buffer_or_error.getError()); return std::move(*buffer_or_error); } if (object == "siginfo") { NativeThreadProtocol *thread = m_current_process->GetCurrentThread(); if (!thread) return llvm::createStringError(llvm::inconvertibleErrorCode(), "no current thread"); auto buffer_or_error = thread->GetSiginfo(); if (!buffer_or_error) return buffer_or_error.takeError(); return std::move(*buffer_or_error); } if (object == "libraries-svr4") { auto library_list = m_current_process->GetLoadedSVR4Libraries(); if (!library_list) return library_list.takeError(); StreamString response; response.Printf(""); for (auto const &library : *library_list) { response.Printf("", library.ld_addr); } response.Printf(""); return MemoryBuffer::getMemBufferCopy(response.GetString(), __FUNCTION__); } if (object == "features" && annex == "target.xml") return BuildTargetXml(); return llvm::make_error(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qXfer( StringExtractorGDBRemote &packet) { SmallVector fields; // The packet format is "qXfer::::offset,length" StringRef(packet.GetStringRef()).split(fields, ':', 4); if (fields.size() != 5) return SendIllFormedResponse(packet, "malformed qXfer packet"); StringRef &xfer_object = fields[1]; StringRef &xfer_action = fields[2]; StringRef &xfer_annex = fields[3]; StringExtractor offset_data(fields[4]); if (xfer_action != "read") return SendUnimplementedResponse("qXfer action not supported"); // Parse offset. const uint64_t xfer_offset = offset_data.GetHexMaxU64(false, std::numeric_limits::max()); if (xfer_offset == std::numeric_limits::max()) return SendIllFormedResponse(packet, "qXfer packet missing offset"); // Parse out comma. if (offset_data.GetChar() != ',') return SendIllFormedResponse(packet, "qXfer packet missing comma after offset"); // Parse out the length. const uint64_t xfer_length = offset_data.GetHexMaxU64(false, std::numeric_limits::max()); if (xfer_length == std::numeric_limits::max()) return SendIllFormedResponse(packet, "qXfer packet missing length"); // Get a previously constructed buffer if it exists or create it now. std::string buffer_key = (xfer_object + xfer_action + xfer_annex).str(); auto buffer_it = m_xfer_buffer_map.find(buffer_key); if (buffer_it == m_xfer_buffer_map.end()) { auto buffer_up = ReadXferObject(xfer_object, xfer_annex); if (!buffer_up) return SendErrorResponse(buffer_up.takeError()); buffer_it = m_xfer_buffer_map .insert(std::make_pair(buffer_key, std::move(*buffer_up))) .first; } // Send back the response StreamGDBRemote response; bool done_with_buffer = false; llvm::StringRef buffer = buffer_it->second->getBuffer(); if (xfer_offset >= buffer.size()) { // We have nothing left to send. Mark the buffer as complete. response.PutChar('l'); done_with_buffer = true; } else { // Figure out how many bytes are available starting at the given offset. buffer = buffer.drop_front(xfer_offset); // Mark the response type according to whether we're reading the remainder // of the data. if (xfer_length >= buffer.size()) { // There will be nothing left to read after this response.PutChar('l'); done_with_buffer = true; } else { // There will still be bytes to read after this request. response.PutChar('m'); buffer = buffer.take_front(xfer_length); } // Now write the data in encoded binary form. response.PutEscapedBytes(buffer.data(), buffer.size()); } if (done_with_buffer) m_xfer_buffer_map.erase(buffer_it); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_QSaveRegisterState( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Thread); // Move past packet name. packet.SetFilePos(strlen("QSaveRegisterState")); // Get the thread to use. NativeThreadProtocol *thread = GetThreadFromSuffix(packet); if (!thread) { if (m_thread_suffix_supported) return SendIllFormedResponse( packet, "No thread specified in QSaveRegisterState packet"); else return SendIllFormedResponse(packet, "No thread was is set with the Hg packet"); } // Grab the register context for the thread. NativeRegisterContext& reg_context = thread->GetRegisterContext(); // Save registers to a buffer. WritableDataBufferSP register_data_sp; Status error = reg_context.ReadAllRegisterValues(register_data_sp); if (error.Fail()) { LLDB_LOG(log, "pid {0} failed to save all register values: {1}", m_current_process->GetID(), error); return SendErrorResponse(0x75); } // Allocate a new save id. const uint32_t save_id = GetNextSavedRegistersID(); assert((m_saved_registers_map.find(save_id) == m_saved_registers_map.end()) && "GetNextRegisterSaveID() returned an existing register save id"); // Save the register data buffer under the save id. { std::lock_guard guard(m_saved_registers_mutex); m_saved_registers_map[save_id] = register_data_sp; } // Write the response. StreamGDBRemote response; response.Printf("%" PRIu32, save_id); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_QRestoreRegisterState( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Thread); // Parse out save id. packet.SetFilePos(strlen("QRestoreRegisterState:")); if (packet.GetBytesLeft() < 1) return SendIllFormedResponse( packet, "QRestoreRegisterState packet missing register save id"); const uint32_t save_id = packet.GetU32(0); if (save_id == 0) { LLDB_LOG(log, "QRestoreRegisterState packet has malformed save id, " "expecting decimal uint32_t"); return SendErrorResponse(0x76); } // Get the thread to use. NativeThreadProtocol *thread = GetThreadFromSuffix(packet); if (!thread) { if (m_thread_suffix_supported) return SendIllFormedResponse( packet, "No thread specified in QRestoreRegisterState packet"); else return SendIllFormedResponse(packet, "No thread was is set with the Hg packet"); } // Grab the register context for the thread. NativeRegisterContext ®_context = thread->GetRegisterContext(); // Retrieve register state buffer, then remove from the list. DataBufferSP register_data_sp; { std::lock_guard guard(m_saved_registers_mutex); // Find the register set buffer for the given save id. auto it = m_saved_registers_map.find(save_id); if (it == m_saved_registers_map.end()) { LLDB_LOG(log, "pid {0} does not have a register set save buffer for id {1}", m_current_process->GetID(), save_id); return SendErrorResponse(0x77); } register_data_sp = it->second; // Remove it from the map. m_saved_registers_map.erase(it); } Status error = reg_context.WriteAllRegisterValues(register_data_sp); if (error.Fail()) { LLDB_LOG(log, "pid {0} failed to restore all register values: {1}", m_current_process->GetID(), error); return SendErrorResponse(0x77); } return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_vAttach( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); // Consume the ';' after vAttach. packet.SetFilePos(strlen("vAttach")); if (!packet.GetBytesLeft() || packet.GetChar() != ';') return SendIllFormedResponse(packet, "vAttach missing expected ';'"); // Grab the PID to which we will attach (assume hex encoding). lldb::pid_t pid = packet.GetU32(LLDB_INVALID_PROCESS_ID, 16); if (pid == LLDB_INVALID_PROCESS_ID) return SendIllFormedResponse(packet, "vAttach failed to parse the process id"); // Attempt to attach. LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s attempting to attach to " "pid %" PRIu64, __FUNCTION__, pid); Status error = AttachToProcess(pid); if (error.Fail()) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed to attach to " "pid %" PRIu64 ": %s\n", __FUNCTION__, pid, error.AsCString()); return SendErrorResponse(error); } // Notify we attached by sending a stop packet. assert(m_current_process); return SendStopReasonForState(*m_current_process, m_current_process->GetState(), /*force_synchronous=*/false); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_vAttachWait( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); // Consume the ';' after the identifier. packet.SetFilePos(strlen("vAttachWait")); if (!packet.GetBytesLeft() || packet.GetChar() != ';') return SendIllFormedResponse(packet, "vAttachWait missing expected ';'"); // Allocate the buffer for the process name from vAttachWait. std::string process_name; if (!packet.GetHexByteString(process_name)) return SendIllFormedResponse(packet, "vAttachWait failed to parse process name"); LLDB_LOG(log, "attempting to attach to process named '{0}'", process_name); Status error = AttachWaitProcess(process_name, false); if (error.Fail()) { LLDB_LOG(log, "failed to attach to process named '{0}': {1}", process_name, error); return SendErrorResponse(error); } // Notify we attached by sending a stop packet. assert(m_current_process); return SendStopReasonForState(*m_current_process, m_current_process->GetState(), /*force_synchronous=*/false); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qVAttachOrWaitSupported( StringExtractorGDBRemote &packet) { return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_vAttachOrWait( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); // Consume the ';' after the identifier. packet.SetFilePos(strlen("vAttachOrWait")); if (!packet.GetBytesLeft() || packet.GetChar() != ';') return SendIllFormedResponse(packet, "vAttachOrWait missing expected ';'"); // Allocate the buffer for the process name from vAttachWait. std::string process_name; if (!packet.GetHexByteString(process_name)) return SendIllFormedResponse(packet, "vAttachOrWait failed to parse process name"); LLDB_LOG(log, "attempting to attach to process named '{0}'", process_name); Status error = AttachWaitProcess(process_name, true); if (error.Fail()) { LLDB_LOG(log, "failed to attach to process named '{0}': {1}", process_name, error); return SendErrorResponse(error); } // Notify we attached by sending a stop packet. assert(m_current_process); return SendStopReasonForState(*m_current_process, m_current_process->GetState(), /*force_synchronous=*/false); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_vRun( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); llvm::StringRef s = packet.GetStringRef(); if (!s.consume_front("vRun;")) return SendErrorResponse(8); llvm::SmallVector argv; s.split(argv, ';'); for (llvm::StringRef hex_arg : argv) { StringExtractor arg_ext{hex_arg}; std::string arg; arg_ext.GetHexByteString(arg); m_process_launch_info.GetArguments().AppendArgument(arg); LLDB_LOGF(log, "LLGSPacketHandler::%s added arg: \"%s\"", __FUNCTION__, arg.c_str()); } if (argv.empty()) return SendErrorResponse(Status("No arguments")); m_process_launch_info.GetExecutableFile().SetFile( m_process_launch_info.GetArguments()[0].ref(), FileSpec::Style::native); m_process_launch_error = LaunchProcess(); if (m_process_launch_error.Fail()) return SendErrorResponse(m_process_launch_error); assert(m_current_process); return SendStopReasonForState(*m_current_process, m_current_process->GetState(), /*force_synchronous=*/true); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_D(StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); if (!m_non_stop) StopSTDIOForwarding(); lldb::pid_t pid = LLDB_INVALID_PROCESS_ID; // Consume the ';' after D. packet.SetFilePos(1); if (packet.GetBytesLeft()) { if (packet.GetChar() != ';') return SendIllFormedResponse(packet, "D missing expected ';'"); // Grab the PID from which we will detach (assume hex encoding). pid = packet.GetU32(LLDB_INVALID_PROCESS_ID, 16); if (pid == LLDB_INVALID_PROCESS_ID) return SendIllFormedResponse(packet, "D failed to parse the process id"); } // Detach forked children if their PID was specified *or* no PID was requested // (i.e. detach-all packet). llvm::Error detach_error = llvm::Error::success(); bool detached = false; for (auto it = m_debugged_processes.begin(); it != m_debugged_processes.end();) { if (pid == LLDB_INVALID_PROCESS_ID || pid == it->first) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s detaching %" PRId64, __FUNCTION__, it->first); if (llvm::Error e = it->second.process_up->Detach().ToError()) detach_error = llvm::joinErrors(std::move(detach_error), std::move(e)); else { if (it->second.process_up.get() == m_current_process) m_current_process = nullptr; if (it->second.process_up.get() == m_continue_process) m_continue_process = nullptr; it = m_debugged_processes.erase(it); detached = true; continue; } } ++it; } if (detach_error) return SendErrorResponse(std::move(detach_error)); if (!detached) return SendErrorResponse(Status("PID %" PRIu64 " not traced", pid)); return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qThreadStopInfo( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Thread); if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(50); packet.SetFilePos(strlen("qThreadStopInfo")); const lldb::tid_t tid = packet.GetHexMaxU64(false, LLDB_INVALID_THREAD_ID); if (tid == LLDB_INVALID_THREAD_ID) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s failed, could not " "parse thread id from request \"%s\"", __FUNCTION__, packet.GetStringRef().data()); return SendErrorResponse(0x15); } return SendStopReplyPacketForThread(*m_current_process, tid, /*force_synchronous=*/true); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_jThreadsInfo( StringExtractorGDBRemote &) { Log *log = GetLog(LLDBLog::Process | LLDBLog::Thread); // Ensure we have a debugged process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(50); LLDB_LOG(log, "preparing packet for pid {0}", m_current_process->GetID()); StreamString response; const bool threads_with_valid_stop_info_only = false; llvm::Expected threads_info = GetJSONThreadsInfo(*m_current_process, threads_with_valid_stop_info_only); if (!threads_info) { LLDB_LOG_ERROR(log, threads_info.takeError(), "failed to prepare a packet for pid {1}: {0}", m_current_process->GetID()); return SendErrorResponse(52); } response.AsRawOstream() << *threads_info; StreamGDBRemote escaped_response; escaped_response.PutEscapedBytes(response.GetData(), response.GetSize()); return SendPacketNoLock(escaped_response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qWatchpointSupportInfo( StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || m_current_process->GetID() == LLDB_INVALID_PROCESS_ID) return SendErrorResponse(68); packet.SetFilePos(strlen("qWatchpointSupportInfo")); if (packet.GetBytesLeft() == 0) return SendOKResponse(); if (packet.GetChar() != ':') return SendErrorResponse(67); auto hw_debug_cap = m_current_process->GetHardwareDebugSupportInfo(); StreamGDBRemote response; if (hw_debug_cap == std::nullopt) response.Printf("num:0;"); else response.Printf("num:%d;", hw_debug_cap->second); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qFileLoadAddress( StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || m_current_process->GetID() == LLDB_INVALID_PROCESS_ID) return SendErrorResponse(67); packet.SetFilePos(strlen("qFileLoadAddress:")); if (packet.GetBytesLeft() == 0) return SendErrorResponse(68); std::string file_name; packet.GetHexByteString(file_name); lldb::addr_t file_load_address = LLDB_INVALID_ADDRESS; Status error = m_current_process->GetFileLoadAddress(file_name, file_load_address); if (error.Fail()) return SendErrorResponse(69); if (file_load_address == LLDB_INVALID_ADDRESS) return SendErrorResponse(1); // File not loaded StreamGDBRemote response; response.PutHex64(file_load_address); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_QPassSignals( StringExtractorGDBRemote &packet) { std::vector signals; packet.SetFilePos(strlen("QPassSignals:")); // Read sequence of hex signal numbers divided by a semicolon and optionally // spaces. while (packet.GetBytesLeft() > 0) { int signal = packet.GetS32(-1, 16); if (signal < 0) return SendIllFormedResponse(packet, "Failed to parse signal number."); signals.push_back(signal); packet.SkipSpaces(); char separator = packet.GetChar(); if (separator == '\0') break; // End of string if (separator != ';') return SendIllFormedResponse(packet, "Invalid separator," " expected semicolon."); } // Fail if we don't have a current process. if (!m_current_process) return SendErrorResponse(68); Status error = m_current_process->IgnoreSignals(signals); if (error.Fail()) return SendErrorResponse(69); return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qMemTags( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); // Ensure we have a process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, no process available", __FUNCTION__); return SendErrorResponse(1); } // We are expecting // qMemTags:,: // Address packet.SetFilePos(strlen("qMemTags:")); const char *current_char = packet.Peek(); if (!current_char || *current_char == ',') return SendIllFormedResponse(packet, "Missing address in qMemTags packet"); const lldb::addr_t addr = packet.GetHexMaxU64(/*little_endian=*/false, 0); // Length char previous_char = packet.GetChar(); current_char = packet.Peek(); // If we don't have a separator or the length field is empty if (previous_char != ',' || (current_char && *current_char == ':')) return SendIllFormedResponse(packet, "Invalid addr,length pair in qMemTags packet"); if (packet.GetBytesLeft() < 1) return SendIllFormedResponse( packet, "Too short qMemtags: packet (looking for length)"); const size_t length = packet.GetHexMaxU64(/*little_endian=*/false, 0); // Type const char *invalid_type_err = "Invalid type field in qMemTags: packet"; if (packet.GetBytesLeft() < 1 || packet.GetChar() != ':') return SendIllFormedResponse(packet, invalid_type_err); // Type is a signed integer but packed into the packet as its raw bytes. // However, our GetU64 uses strtoull which allows +/-. We do not want this. const char *first_type_char = packet.Peek(); if (first_type_char && (*first_type_char == '+' || *first_type_char == '-')) return SendIllFormedResponse(packet, invalid_type_err); // Extract type as unsigned then cast to signed. // Using a uint64_t here so that we have some value outside of the 32 bit // range to use as the invalid return value. uint64_t raw_type = packet.GetU64(std::numeric_limits::max(), /*base=*/16); if ( // Make sure the cast below would be valid raw_type > std::numeric_limits::max() || // To catch inputs like "123aardvark" that will parse but clearly aren't // valid in this case. packet.GetBytesLeft()) { return SendIllFormedResponse(packet, invalid_type_err); } // First narrow to 32 bits otherwise the copy into type would take // the wrong 4 bytes on big endian. uint32_t raw_type_32 = raw_type; int32_t type = reinterpret_cast(raw_type_32); StreamGDBRemote response; std::vector tags; Status error = m_current_process->ReadMemoryTags(type, addr, length, tags); if (error.Fail()) return SendErrorResponse(1); // This m is here in case we want to support multi part replies in the future. // In the same manner as qfThreadInfo/qsThreadInfo. response.PutChar('m'); response.PutBytesAsRawHex8(tags.data(), tags.size()); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_QMemTags( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); // Ensure we have a process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) { LLDB_LOGF( log, "GDBRemoteCommunicationServerLLGS::%s failed, no process available", __FUNCTION__); return SendErrorResponse(1); } // We are expecting // QMemTags:,:: // Address packet.SetFilePos(strlen("QMemTags:")); const char *current_char = packet.Peek(); if (!current_char || *current_char == ',') return SendIllFormedResponse(packet, "Missing address in QMemTags packet"); const lldb::addr_t addr = packet.GetHexMaxU64(/*little_endian=*/false, 0); // Length char previous_char = packet.GetChar(); current_char = packet.Peek(); // If we don't have a separator or the length field is empty if (previous_char != ',' || (current_char && *current_char == ':')) return SendIllFormedResponse(packet, "Invalid addr,length pair in QMemTags packet"); if (packet.GetBytesLeft() < 1) return SendIllFormedResponse( packet, "Too short QMemtags: packet (looking for length)"); const size_t length = packet.GetHexMaxU64(/*little_endian=*/false, 0); // Type const char *invalid_type_err = "Invalid type field in QMemTags: packet"; if (packet.GetBytesLeft() < 1 || packet.GetChar() != ':') return SendIllFormedResponse(packet, invalid_type_err); // Our GetU64 uses strtoull which allows leading +/-, we don't want that. const char *first_type_char = packet.Peek(); if (first_type_char && (*first_type_char == '+' || *first_type_char == '-')) return SendIllFormedResponse(packet, invalid_type_err); // The type is a signed integer but is in the packet as its raw bytes. // So parse first as unsigned then cast to signed later. // We extract to 64 bit, even though we only expect 32, so that we've // got some invalid value we can check for. uint64_t raw_type = packet.GetU64(std::numeric_limits::max(), /*base=*/16); if (raw_type > std::numeric_limits::max()) return SendIllFormedResponse(packet, invalid_type_err); // First narrow to 32 bits. Otherwise the copy below would get the wrong // 4 bytes on big endian. uint32_t raw_type_32 = raw_type; int32_t type = reinterpret_cast(raw_type_32); // Tag data if (packet.GetBytesLeft() < 1 || packet.GetChar() != ':') return SendIllFormedResponse(packet, "Missing tag data in QMemTags: packet"); // Must be 2 chars per byte const char *invalid_data_err = "Invalid tag data in QMemTags: packet"; if (packet.GetBytesLeft() % 2) return SendIllFormedResponse(packet, invalid_data_err); // This is bytes here and is unpacked into target specific tags later // We cannot assume that number of bytes == length here because the server // can repeat tags to fill a given range. std::vector tag_data; // Zero length writes will not have any tag data // (but we pass them on because it will still check that tagging is enabled) if (packet.GetBytesLeft()) { size_t byte_count = packet.GetBytesLeft() / 2; tag_data.resize(byte_count); size_t converted_bytes = packet.GetHexBytes(tag_data, 0); if (converted_bytes != byte_count) { return SendIllFormedResponse(packet, invalid_data_err); } } Status status = m_current_process->WriteMemoryTags(type, addr, length, tag_data); return status.Success() ? SendOKResponse() : SendErrorResponse(1); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_qSaveCore( StringExtractorGDBRemote &packet) { // Fail if we don't have a current process. if (!m_current_process || (m_current_process->GetID() == LLDB_INVALID_PROCESS_ID)) return SendErrorResponse(Status("Process not running.")); std::string path_hint; StringRef packet_str{packet.GetStringRef()}; assert(packet_str.starts_with("qSaveCore")); if (packet_str.consume_front("qSaveCore;")) { for (auto x : llvm::split(packet_str, ';')) { if (x.consume_front("path-hint:")) StringExtractor(x).GetHexByteString(path_hint); else return SendErrorResponse(Status("Unsupported qSaveCore option")); } } llvm::Expected ret = m_current_process->SaveCore(path_hint); if (!ret) return SendErrorResponse(ret.takeError()); StreamString response; response.PutCString("core-path:"); response.PutStringAsRawHex8(ret.get()); return SendPacketNoLock(response.GetString()); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_QNonStop( StringExtractorGDBRemote &packet) { Log *log = GetLog(LLDBLog::Process); StringRef packet_str{packet.GetStringRef()}; assert(packet_str.starts_with("QNonStop:")); packet_str.consume_front("QNonStop:"); if (packet_str == "0") { if (m_non_stop) StopSTDIOForwarding(); for (auto &process_it : m_debugged_processes) { if (process_it.second.process_up->IsRunning()) { assert(m_non_stop); Status error = process_it.second.process_up->Interrupt(); if (error.Fail()) { LLDB_LOG(log, "while disabling nonstop, failed to halt process {0}: {1}", process_it.first, error); return SendErrorResponse(0x41); } // we must not send stop reasons after QNonStop m_disabling_non_stop = true; } } m_stdio_notification_queue.clear(); m_stop_notification_queue.clear(); m_non_stop = false; // If we are stopping anything, defer sending the OK response until we're // done. if (m_disabling_non_stop) return PacketResult::Success; } else if (packet_str == "1") { if (!m_non_stop) StartSTDIOForwarding(); m_non_stop = true; } else return SendErrorResponse(Status("Invalid QNonStop packet")); return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::HandleNotificationAck( std::deque &queue) { // Per the protocol, the first message put into the queue is sent // immediately. However, it remains the queue until the client ACKs it -- // then we pop it and send the next message. The process repeats until // the last message in the queue is ACK-ed, in which case the packet sends // an OK response. if (queue.empty()) return SendErrorResponse(Status("No pending notification to ack")); queue.pop_front(); if (!queue.empty()) return SendPacketNoLock(queue.front()); return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_vStdio( StringExtractorGDBRemote &packet) { return HandleNotificationAck(m_stdio_notification_queue); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_vStopped( StringExtractorGDBRemote &packet) { PacketResult ret = HandleNotificationAck(m_stop_notification_queue); // If this was the last notification and all the processes exited, // terminate the server. if (m_stop_notification_queue.empty() && m_debugged_processes.empty()) { m_exit_now = true; m_mainloop.RequestTermination(); } return ret; } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_vCtrlC( StringExtractorGDBRemote &packet) { if (!m_non_stop) return SendErrorResponse(Status("vCtrl is only valid in non-stop mode")); PacketResult interrupt_res = Handle_interrupt(packet); // If interrupting the process failed, pass the result through. if (interrupt_res != PacketResult::Success) return interrupt_res; // Otherwise, vCtrlC should issue an OK response (normal interrupts do not). return SendOKResponse(); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::Handle_T(StringExtractorGDBRemote &packet) { packet.SetFilePos(strlen("T")); auto pid_tid = packet.GetPidTid(m_current_process ? m_current_process->GetID() : LLDB_INVALID_PROCESS_ID); if (!pid_tid) return SendErrorResponse(llvm::make_error( inconvertibleErrorCode(), "Malformed thread-id")); lldb::pid_t pid = pid_tid->first; lldb::tid_t tid = pid_tid->second; // Technically, this would also be caught by the PID check but let's be more // explicit about the error. if (pid == LLDB_INVALID_PROCESS_ID) return SendErrorResponse(llvm::make_error( inconvertibleErrorCode(), "No current process and no PID provided")); // Check the process ID and find respective process instance. auto new_process_it = m_debugged_processes.find(pid); if (new_process_it == m_debugged_processes.end()) return SendErrorResponse(1); // Check the thread ID if (!new_process_it->second.process_up->GetThreadByID(tid)) return SendErrorResponse(2); return SendOKResponse(); } void GDBRemoteCommunicationServerLLGS::MaybeCloseInferiorTerminalConnection() { Log *log = GetLog(LLDBLog::Process); // Tell the stdio connection to shut down. if (m_stdio_communication.IsConnected()) { auto connection = m_stdio_communication.GetConnection(); if (connection) { Status error; connection->Disconnect(&error); if (error.Success()) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s disconnect process " "terminal stdio - SUCCESS", __FUNCTION__); } else { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s disconnect process " "terminal stdio - FAIL: %s", __FUNCTION__, error.AsCString()); } } } } NativeThreadProtocol *GDBRemoteCommunicationServerLLGS::GetThreadFromSuffix( StringExtractorGDBRemote &packet) { // We have no thread if we don't have a process. if (!m_current_process || m_current_process->GetID() == LLDB_INVALID_PROCESS_ID) return nullptr; // If the client hasn't asked for thread suffix support, there will not be a // thread suffix. Use the current thread in that case. if (!m_thread_suffix_supported) { const lldb::tid_t current_tid = GetCurrentThreadID(); if (current_tid == LLDB_INVALID_THREAD_ID) return nullptr; else if (current_tid == 0) { // Pick a thread. return m_current_process->GetThreadAtIndex(0); } else return m_current_process->GetThreadByID(current_tid); } Log *log = GetLog(LLDBLog::Thread); // Parse out the ';'. if (packet.GetBytesLeft() < 1 || packet.GetChar() != ';') { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s gdb-remote parse " "error: expected ';' prior to start of thread suffix: packet " "contents = '%s'", __FUNCTION__, packet.GetStringRef().data()); return nullptr; } if (!packet.GetBytesLeft()) return nullptr; // Parse out thread: portion. if (strncmp(packet.Peek(), "thread:", strlen("thread:")) != 0) { LLDB_LOGF(log, "GDBRemoteCommunicationServerLLGS::%s gdb-remote parse " "error: expected 'thread:' but not found, packet contents = " "'%s'", __FUNCTION__, packet.GetStringRef().data()); return nullptr; } packet.SetFilePos(packet.GetFilePos() + strlen("thread:")); const lldb::tid_t tid = packet.GetHexMaxU64(false, 0); if (tid != 0) return m_current_process->GetThreadByID(tid); return nullptr; } lldb::tid_t GDBRemoteCommunicationServerLLGS::GetCurrentThreadID() const { if (m_current_tid == 0 || m_current_tid == LLDB_INVALID_THREAD_ID) { // Use whatever the debug process says is the current thread id since the // protocol either didn't specify or specified we want any/all threads // marked as the current thread. if (!m_current_process) return LLDB_INVALID_THREAD_ID; return m_current_process->GetCurrentThreadID(); } // Use the specific current thread id set by the gdb remote protocol. return m_current_tid; } uint32_t GDBRemoteCommunicationServerLLGS::GetNextSavedRegistersID() { std::lock_guard guard(m_saved_registers_mutex); return m_next_saved_registers_id++; } void GDBRemoteCommunicationServerLLGS::ClearProcessSpecificData() { Log *log = GetLog(LLDBLog::Process); LLDB_LOG(log, "clearing {0} xfer buffers", m_xfer_buffer_map.size()); m_xfer_buffer_map.clear(); } FileSpec GDBRemoteCommunicationServerLLGS::FindModuleFile(const std::string &module_path, const ArchSpec &arch) { if (m_current_process) { FileSpec file_spec; if (m_current_process ->GetLoadedModuleFileSpec(module_path.c_str(), file_spec) .Success()) { if (FileSystem::Instance().Exists(file_spec)) return file_spec; } } return GDBRemoteCommunicationServerCommon::FindModuleFile(module_path, arch); } std::string GDBRemoteCommunicationServerLLGS::XMLEncodeAttributeValue( llvm::StringRef value) { std::string result; for (const char &c : value) { switch (c) { case '\'': result += "'"; break; case '"': result += """; break; case '<': result += "<"; break; case '>': result += ">"; break; default: result += c; break; } } return result; } std::vector GDBRemoteCommunicationServerLLGS::HandleFeatures( const llvm::ArrayRef client_features) { std::vector ret = GDBRemoteCommunicationServerCommon::HandleFeatures(client_features); ret.insert(ret.end(), { "QThreadSuffixSupported+", "QListThreadsInStopReply+", "qXfer:features:read+", "QNonStop+", }); // report server-only features using Extension = NativeProcessProtocol::Extension; Extension plugin_features = m_process_manager.GetSupportedExtensions(); if (bool(plugin_features & Extension::pass_signals)) ret.push_back("QPassSignals+"); if (bool(plugin_features & Extension::auxv)) ret.push_back("qXfer:auxv:read+"); if (bool(plugin_features & Extension::libraries_svr4)) ret.push_back("qXfer:libraries-svr4:read+"); if (bool(plugin_features & Extension::siginfo_read)) ret.push_back("qXfer:siginfo:read+"); if (bool(plugin_features & Extension::memory_tagging)) ret.push_back("memory-tagging+"); if (bool(plugin_features & Extension::savecore)) ret.push_back("qSaveCore+"); // check for client features m_extensions_supported = {}; for (llvm::StringRef x : client_features) m_extensions_supported |= llvm::StringSwitch(x) .Case("multiprocess+", Extension::multiprocess) .Case("fork-events+", Extension::fork) .Case("vfork-events+", Extension::vfork) .Default({}); m_extensions_supported &= plugin_features; // fork & vfork require multiprocess if (!bool(m_extensions_supported & Extension::multiprocess)) m_extensions_supported &= ~(Extension::fork | Extension::vfork); // report only if actually supported if (bool(m_extensions_supported & Extension::multiprocess)) ret.push_back("multiprocess+"); if (bool(m_extensions_supported & Extension::fork)) ret.push_back("fork-events+"); if (bool(m_extensions_supported & Extension::vfork)) ret.push_back("vfork-events+"); for (auto &x : m_debugged_processes) SetEnabledExtensions(*x.second.process_up); return ret; } void GDBRemoteCommunicationServerLLGS::SetEnabledExtensions( NativeProcessProtocol &process) { NativeProcessProtocol::Extension flags = m_extensions_supported; assert(!bool(flags & ~m_process_manager.GetSupportedExtensions())); process.SetEnabledExtensions(flags); } GDBRemoteCommunication::PacketResult GDBRemoteCommunicationServerLLGS::SendContinueSuccessResponse() { if (m_non_stop) return SendOKResponse(); StartSTDIOForwarding(); return PacketResult::Success; } void GDBRemoteCommunicationServerLLGS::AppendThreadIDToResponse( Stream &response, lldb::pid_t pid, lldb::tid_t tid) { if (bool(m_extensions_supported & NativeProcessProtocol::Extension::multiprocess)) response.Format("p{0:x-}.", pid); response.Format("{0:x-}", tid); } std::string lldb_private::process_gdb_remote::LLGSArgToURL(llvm::StringRef url_arg, bool reverse_connect) { // Try parsing the argument as URL. if (std::optional url = URI::Parse(url_arg)) { if (reverse_connect) return url_arg.str(); // Translate the scheme from LLGS notation to ConnectionFileDescriptor. // If the scheme doesn't match any, pass it through to support using CFD // schemes directly. std::string new_url = llvm::StringSwitch(url->scheme) .Case("tcp", "listen") .Case("unix", "unix-accept") .Case("unix-abstract", "unix-abstract-accept") .Default(url->scheme.str()); llvm::append_range(new_url, url_arg.substr(url->scheme.size())); return new_url; } std::string host_port = url_arg.str(); // If host_and_port starts with ':', default the host to be "localhost" and // expect the remainder to be the port. if (url_arg.starts_with(":")) host_port.insert(0, "localhost"); // Try parsing the (preprocessed) argument as host:port pair. if (!llvm::errorToBool(Socket::DecodeHostAndPort(host_port).takeError())) return (reverse_connect ? "connect://" : "listen://") + host_port; // If none of the above applied, interpret the argument as UNIX socket path. return (reverse_connect ? "unix-connect://" : "unix-accept://") + url_arg.str(); }