1 //===-- GDBRemoteCommunicationServerLLGS.h ----------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #ifndef LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_GDBREMOTECOMMUNICATIONSERVERLLGS_H 10 #define LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_GDBREMOTECOMMUNICATIONSERVERLLGS_H 11 12 #include <mutex> 13 #include <unordered_map> 14 #include <unordered_set> 15 16 #include "lldb/Core/Communication.h" 17 #include "lldb/Host/MainLoop.h" 18 #include "lldb/Host/common/NativeProcessProtocol.h" 19 #include "lldb/lldb-private-forward.h" 20 21 #include "GDBRemoteCommunicationServerCommon.h" 22 23 class StringExtractorGDBRemote; 24 25 namespace lldb_private { 26 27 namespace process_gdb_remote { 28 29 class ProcessGDBRemote; 30 31 class GDBRemoteCommunicationServerLLGS 32 : public GDBRemoteCommunicationServerCommon, 33 public NativeProcessProtocol::NativeDelegate { 34 public: 35 // Constructors and Destructors 36 GDBRemoteCommunicationServerLLGS( 37 MainLoop &mainloop, 38 const NativeProcessProtocol::Factory &process_factory); 39 40 void SetLaunchInfo(const ProcessLaunchInfo &info); 41 42 /// Launch a process with the current launch settings. 43 /// 44 /// This method supports running an lldb-gdbserver or similar 45 /// server in a situation where the startup code has been provided 46 /// with all the information for a child process to be launched. 47 /// 48 /// \return 49 /// An Status object indicating the success or failure of the 50 /// launch. 51 Status LaunchProcess() override; 52 53 /// Attach to a process. 54 /// 55 /// This method supports attaching llgs to a process accessible via the 56 /// configured Platform. 57 /// 58 /// \return 59 /// An Status object indicating the success or failure of the 60 /// attach operation. 61 Status AttachToProcess(lldb::pid_t pid); 62 63 /// Wait to attach to a process with a given name. 64 /// 65 /// This method supports waiting for the next instance of a process 66 /// with a given name and attaching llgs to that via the configured 67 /// Platform. 68 /// 69 /// \return 70 /// An Status object indicating the success or failure of the 71 /// attach operation. 72 Status AttachWaitProcess(llvm::StringRef process_name, bool include_existing); 73 74 // NativeProcessProtocol::NativeDelegate overrides 75 void InitializeDelegate(NativeProcessProtocol *process) override; 76 77 void ProcessStateChanged(NativeProcessProtocol *process, 78 lldb::StateType state) override; 79 80 void DidExec(NativeProcessProtocol *process) override; 81 82 void 83 NewSubprocess(NativeProcessProtocol *parent_process, 84 std::unique_ptr<NativeProcessProtocol> child_process) override; 85 86 Status InitializeConnection(std::unique_ptr<Connection> connection); 87 88 protected: 89 MainLoop &m_mainloop; 90 MainLoop::ReadHandleUP m_network_handle_up; 91 const NativeProcessProtocol::Factory &m_process_factory; 92 lldb::tid_t m_current_tid = LLDB_INVALID_THREAD_ID; 93 lldb::tid_t m_continue_tid = LLDB_INVALID_THREAD_ID; 94 NativeProcessProtocol *m_current_process; 95 NativeProcessProtocol *m_continue_process; 96 std::recursive_mutex m_debugged_process_mutex; 97 std::unordered_map<lldb::pid_t, std::unique_ptr<NativeProcessProtocol>> 98 m_debugged_processes; 99 std::unordered_set<lldb::pid_t> m_vkilled_processes; 100 101 Communication m_stdio_communication; 102 MainLoop::ReadHandleUP m_stdio_handle_up; 103 104 lldb::StateType m_inferior_prev_state = lldb::StateType::eStateInvalid; 105 llvm::StringMap<std::unique_ptr<llvm::MemoryBuffer>> m_xfer_buffer_map; 106 std::mutex m_saved_registers_mutex; 107 std::unordered_map<uint32_t, lldb::DataBufferSP> m_saved_registers_map; 108 uint32_t m_next_saved_registers_id = 1; 109 bool m_thread_suffix_supported = false; 110 bool m_list_threads_in_stop_reply = false; 111 bool m_non_stop = false; 112 std::deque<std::string> m_stop_notification_queue; 113 114 NativeProcessProtocol::Extension m_extensions_supported = {}; 115 116 PacketResult SendONotification(const char *buffer, uint32_t len); 117 118 PacketResult SendWResponse(NativeProcessProtocol *process); 119 120 StreamString PrepareStopReplyPacketForThread(NativeThreadProtocol &thread); 121 122 PacketResult SendStopReplyPacketForThread(NativeProcessProtocol &process, 123 lldb::tid_t tid, 124 bool force_synchronous); 125 126 PacketResult SendStopReasonForState(NativeProcessProtocol &process, 127 lldb::StateType process_state, 128 bool force_synchronous); 129 130 void EnqueueStopReplyPackets(lldb::tid_t thread_to_skip); 131 132 PacketResult Handle_k(StringExtractorGDBRemote &packet); 133 134 PacketResult Handle_vKill(StringExtractorGDBRemote &packet); 135 136 PacketResult Handle_qProcessInfo(StringExtractorGDBRemote &packet); 137 138 PacketResult Handle_qC(StringExtractorGDBRemote &packet); 139 140 PacketResult Handle_QSetDisableASLR(StringExtractorGDBRemote &packet); 141 142 PacketResult Handle_QSetWorkingDir(StringExtractorGDBRemote &packet); 143 144 PacketResult Handle_qGetWorkingDir(StringExtractorGDBRemote &packet); 145 146 PacketResult Handle_QThreadSuffixSupported(StringExtractorGDBRemote &packet); 147 148 PacketResult Handle_QListThreadsInStopReply(StringExtractorGDBRemote &packet); 149 150 PacketResult Handle_C(StringExtractorGDBRemote &packet); 151 152 PacketResult Handle_c(StringExtractorGDBRemote &packet); 153 154 PacketResult Handle_vCont(StringExtractorGDBRemote &packet); 155 156 PacketResult Handle_vCont_actions(StringExtractorGDBRemote &packet); 157 158 PacketResult Handle_stop_reason(StringExtractorGDBRemote &packet); 159 160 PacketResult Handle_qRegisterInfo(StringExtractorGDBRemote &packet); 161 162 void AddProcessThreads(StreamGDBRemote &response, 163 NativeProcessProtocol &process, bool &had_any); 164 165 PacketResult Handle_qfThreadInfo(StringExtractorGDBRemote &packet); 166 167 PacketResult Handle_qsThreadInfo(StringExtractorGDBRemote &packet); 168 169 PacketResult Handle_p(StringExtractorGDBRemote &packet); 170 171 PacketResult Handle_P(StringExtractorGDBRemote &packet); 172 173 PacketResult Handle_H(StringExtractorGDBRemote &packet); 174 175 PacketResult Handle_I(StringExtractorGDBRemote &packet); 176 177 PacketResult Handle_interrupt(StringExtractorGDBRemote &packet); 178 179 // Handles $m and $x packets. 180 PacketResult Handle_memory_read(StringExtractorGDBRemote &packet); 181 182 PacketResult Handle_M(StringExtractorGDBRemote &packet); 183 PacketResult Handle__M(StringExtractorGDBRemote &packet); 184 PacketResult Handle__m(StringExtractorGDBRemote &packet); 185 186 PacketResult 187 Handle_qMemoryRegionInfoSupported(StringExtractorGDBRemote &packet); 188 189 PacketResult Handle_qMemoryRegionInfo(StringExtractorGDBRemote &packet); 190 191 PacketResult Handle_Z(StringExtractorGDBRemote &packet); 192 193 PacketResult Handle_z(StringExtractorGDBRemote &packet); 194 195 PacketResult Handle_s(StringExtractorGDBRemote &packet); 196 197 PacketResult Handle_qXfer(StringExtractorGDBRemote &packet); 198 199 PacketResult Handle_QSaveRegisterState(StringExtractorGDBRemote &packet); 200 201 PacketResult Handle_jLLDBTraceSupported(StringExtractorGDBRemote &packet); 202 203 PacketResult Handle_jLLDBTraceStart(StringExtractorGDBRemote &packet); 204 205 PacketResult Handle_jLLDBTraceStop(StringExtractorGDBRemote &packet); 206 207 PacketResult Handle_jLLDBTraceGetState(StringExtractorGDBRemote &packet); 208 209 PacketResult Handle_jLLDBTraceGetBinaryData(StringExtractorGDBRemote &packet); 210 211 PacketResult Handle_QRestoreRegisterState(StringExtractorGDBRemote &packet); 212 213 PacketResult Handle_vAttach(StringExtractorGDBRemote &packet); 214 215 PacketResult Handle_vAttachWait(StringExtractorGDBRemote &packet); 216 217 PacketResult Handle_qVAttachOrWaitSupported(StringExtractorGDBRemote &packet); 218 219 PacketResult Handle_vAttachOrWait(StringExtractorGDBRemote &packet); 220 221 PacketResult Handle_vRun(StringExtractorGDBRemote &packet); 222 223 PacketResult Handle_D(StringExtractorGDBRemote &packet); 224 225 PacketResult Handle_qThreadStopInfo(StringExtractorGDBRemote &packet); 226 227 PacketResult Handle_jThreadsInfo(StringExtractorGDBRemote &packet); 228 229 PacketResult Handle_qWatchpointSupportInfo(StringExtractorGDBRemote &packet); 230 231 PacketResult Handle_qFileLoadAddress(StringExtractorGDBRemote &packet); 232 233 PacketResult Handle_QPassSignals(StringExtractorGDBRemote &packet); 234 235 PacketResult Handle_qSaveCore(StringExtractorGDBRemote &packet); 236 237 PacketResult Handle_QNonStop(StringExtractorGDBRemote &packet); 238 239 PacketResult Handle_vStopped(StringExtractorGDBRemote &packet); 240 241 PacketResult Handle_vCtrlC(StringExtractorGDBRemote &packet); 242 243 PacketResult Handle_g(StringExtractorGDBRemote &packet); 244 245 PacketResult Handle_qMemTags(StringExtractorGDBRemote &packet); 246 247 PacketResult Handle_QMemTags(StringExtractorGDBRemote &packet); 248 249 PacketResult Handle_T(StringExtractorGDBRemote &packet); 250 251 void SetCurrentThreadID(lldb::tid_t tid); 252 253 lldb::tid_t GetCurrentThreadID() const; 254 255 void SetContinueThreadID(lldb::tid_t tid); 256 257 lldb::tid_t GetContinueThreadID() const { return m_continue_tid; } 258 259 Status SetSTDIOFileDescriptor(int fd); 260 261 FileSpec FindModuleFile(const std::string &module_path, 262 const ArchSpec &arch) override; 263 264 llvm::Expected<std::unique_ptr<llvm::MemoryBuffer>> 265 ReadXferObject(llvm::StringRef object, llvm::StringRef annex); 266 267 static std::string XMLEncodeAttributeValue(llvm::StringRef value); 268 269 std::vector<std::string> HandleFeatures( 270 const llvm::ArrayRef<llvm::StringRef> client_features) override; 271 272 // Provide a response for successful continue action, i.e. send "OK" 273 // in non-stop mode, no response otherwise. 274 PacketResult SendContinueSuccessResponse(); 275 276 void AppendThreadIDToResponse(Stream &response, lldb::pid_t pid, 277 lldb::tid_t tid); 278 279 private: 280 llvm::Expected<std::unique_ptr<llvm::MemoryBuffer>> BuildTargetXml(); 281 282 void HandleInferiorState_Exited(NativeProcessProtocol *process); 283 284 void HandleInferiorState_Stopped(NativeProcessProtocol *process); 285 286 NativeThreadProtocol *GetThreadFromSuffix(StringExtractorGDBRemote &packet); 287 288 uint32_t GetNextSavedRegistersID(); 289 290 void MaybeCloseInferiorTerminalConnection(); 291 292 void ClearProcessSpecificData(); 293 294 void RegisterPacketHandlers(); 295 296 void DataAvailableCallback(); 297 298 void SendProcessOutput(); 299 300 void StartSTDIOForwarding(); 301 302 void StopSTDIOForwarding(); 303 304 // Call SetEnabledExtensions() with appropriate flags on the process. 305 void SetEnabledExtensions(NativeProcessProtocol &process); 306 307 // For GDBRemoteCommunicationServerLLGS only 308 GDBRemoteCommunicationServerLLGS(const GDBRemoteCommunicationServerLLGS &) = 309 delete; 310 const GDBRemoteCommunicationServerLLGS & 311 operator=(const GDBRemoteCommunicationServerLLGS &) = delete; 312 }; 313 314 std::string LLGSArgToURL(llvm::StringRef url_arg, bool reverse_connect); 315 316 } // namespace process_gdb_remote 317 } // namespace lldb_private 318 319 #endif // LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_GDBREMOTECOMMUNICATIONSERVERLLGS_H 320