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 Status InitializeConnection(std::unique_ptr<Connection> connection); 82 83 protected: 84 MainLoop &m_mainloop; 85 MainLoop::ReadHandleUP m_network_handle_up; 86 const NativeProcessProtocol::Factory &m_process_factory; 87 lldb::tid_t m_current_tid = LLDB_INVALID_THREAD_ID; 88 lldb::tid_t m_continue_tid = LLDB_INVALID_THREAD_ID; 89 std::recursive_mutex m_debugged_process_mutex; 90 std::unique_ptr<NativeProcessProtocol> m_debugged_process_up; 91 92 Communication m_stdio_communication; 93 MainLoop::ReadHandleUP m_stdio_handle_up; 94 95 lldb::StateType m_inferior_prev_state = lldb::StateType::eStateInvalid; 96 llvm::StringMap<std::unique_ptr<llvm::MemoryBuffer>> m_xfer_buffer_map; 97 std::mutex m_saved_registers_mutex; 98 std::unordered_map<uint32_t, lldb::DataBufferSP> m_saved_registers_map; 99 uint32_t m_next_saved_registers_id = 1; 100 bool m_handshake_completed = false; 101 102 PacketResult SendONotification(const char *buffer, uint32_t len); 103 104 PacketResult SendWResponse(NativeProcessProtocol *process); 105 106 PacketResult SendStopReplyPacketForThread(lldb::tid_t tid); 107 108 PacketResult SendStopReasonForState(lldb::StateType process_state); 109 110 PacketResult Handle_k(StringExtractorGDBRemote &packet); 111 112 PacketResult Handle_qProcessInfo(StringExtractorGDBRemote &packet); 113 114 PacketResult Handle_qC(StringExtractorGDBRemote &packet); 115 116 PacketResult Handle_QSetDisableASLR(StringExtractorGDBRemote &packet); 117 118 PacketResult Handle_QSetWorkingDir(StringExtractorGDBRemote &packet); 119 120 PacketResult Handle_qGetWorkingDir(StringExtractorGDBRemote &packet); 121 122 PacketResult Handle_C(StringExtractorGDBRemote &packet); 123 124 PacketResult Handle_c(StringExtractorGDBRemote &packet); 125 126 PacketResult Handle_vCont(StringExtractorGDBRemote &packet); 127 128 PacketResult Handle_vCont_actions(StringExtractorGDBRemote &packet); 129 130 PacketResult Handle_stop_reason(StringExtractorGDBRemote &packet); 131 132 PacketResult Handle_qRegisterInfo(StringExtractorGDBRemote &packet); 133 134 PacketResult Handle_qfThreadInfo(StringExtractorGDBRemote &packet); 135 136 PacketResult Handle_qsThreadInfo(StringExtractorGDBRemote &packet); 137 138 PacketResult Handle_p(StringExtractorGDBRemote &packet); 139 140 PacketResult Handle_P(StringExtractorGDBRemote &packet); 141 142 PacketResult Handle_H(StringExtractorGDBRemote &packet); 143 144 PacketResult Handle_I(StringExtractorGDBRemote &packet); 145 146 PacketResult Handle_interrupt(StringExtractorGDBRemote &packet); 147 148 // Handles $m and $x packets. 149 PacketResult Handle_memory_read(StringExtractorGDBRemote &packet); 150 151 PacketResult Handle_M(StringExtractorGDBRemote &packet); 152 PacketResult Handle__M(StringExtractorGDBRemote &packet); 153 PacketResult Handle__m(StringExtractorGDBRemote &packet); 154 155 PacketResult 156 Handle_qMemoryRegionInfoSupported(StringExtractorGDBRemote &packet); 157 158 PacketResult Handle_qMemoryRegionInfo(StringExtractorGDBRemote &packet); 159 160 PacketResult Handle_Z(StringExtractorGDBRemote &packet); 161 162 PacketResult Handle_z(StringExtractorGDBRemote &packet); 163 164 PacketResult Handle_s(StringExtractorGDBRemote &packet); 165 166 PacketResult Handle_qXfer(StringExtractorGDBRemote &packet); 167 168 PacketResult Handle_QSaveRegisterState(StringExtractorGDBRemote &packet); 169 170 PacketResult Handle_jTraceStart(StringExtractorGDBRemote &packet); 171 172 PacketResult Handle_jTraceRead(StringExtractorGDBRemote &packet); 173 174 PacketResult Handle_jTraceStop(StringExtractorGDBRemote &packet); 175 176 PacketResult Handle_jTraceConfigRead(StringExtractorGDBRemote &packet); 177 178 PacketResult Handle_jLLDBTraceSupportedType(StringExtractorGDBRemote &packet); 179 180 PacketResult Handle_QRestoreRegisterState(StringExtractorGDBRemote &packet); 181 182 PacketResult Handle_vAttach(StringExtractorGDBRemote &packet); 183 184 PacketResult Handle_vAttachWait(StringExtractorGDBRemote &packet); 185 186 PacketResult Handle_qVAttachOrWaitSupported(StringExtractorGDBRemote &packet); 187 188 PacketResult Handle_vAttachOrWait(StringExtractorGDBRemote &packet); 189 190 PacketResult Handle_D(StringExtractorGDBRemote &packet); 191 192 PacketResult Handle_qThreadStopInfo(StringExtractorGDBRemote &packet); 193 194 PacketResult Handle_jThreadsInfo(StringExtractorGDBRemote &packet); 195 196 PacketResult Handle_qWatchpointSupportInfo(StringExtractorGDBRemote &packet); 197 198 PacketResult Handle_qFileLoadAddress(StringExtractorGDBRemote &packet); 199 200 PacketResult Handle_QPassSignals(StringExtractorGDBRemote &packet); 201 202 PacketResult Handle_g(StringExtractorGDBRemote &packet); 203 204 void SetCurrentThreadID(lldb::tid_t tid); 205 206 lldb::tid_t GetCurrentThreadID() const; 207 208 void SetContinueThreadID(lldb::tid_t tid); 209 210 lldb::tid_t GetContinueThreadID() const { return m_continue_tid; } 211 212 Status SetSTDIOFileDescriptor(int fd); 213 214 FileSpec FindModuleFile(const std::string &module_path, 215 const ArchSpec &arch) override; 216 217 llvm::Expected<std::unique_ptr<llvm::MemoryBuffer>> 218 ReadXferObject(llvm::StringRef object, llvm::StringRef annex); 219 220 static std::string XMLEncodeAttributeValue(llvm::StringRef value); 221 222 private: 223 llvm::Expected<std::unique_ptr<llvm::MemoryBuffer>> BuildTargetXml(); 224 225 void HandleInferiorState_Exited(NativeProcessProtocol *process); 226 227 void HandleInferiorState_Stopped(NativeProcessProtocol *process); 228 229 NativeThreadProtocol *GetThreadFromSuffix(StringExtractorGDBRemote &packet); 230 231 uint32_t GetNextSavedRegistersID(); 232 233 void MaybeCloseInferiorTerminalConnection(); 234 235 void ClearProcessSpecificData(); 236 237 void RegisterPacketHandlers(); 238 239 void DataAvailableCallback(); 240 241 void SendProcessOutput(); 242 243 void StartSTDIOForwarding(); 244 245 void StopSTDIOForwarding(); 246 247 // For GDBRemoteCommunicationServerLLGS only 248 GDBRemoteCommunicationServerLLGS(const GDBRemoteCommunicationServerLLGS &) = 249 delete; 250 const GDBRemoteCommunicationServerLLGS & 251 operator=(const GDBRemoteCommunicationServerLLGS &) = delete; 252 }; 253 254 } // namespace process_gdb_remote 255 } // namespace lldb_private 256 257 #endif // LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_GDBREMOTECOMMUNICATIONSERVERLLGS_H 258