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