1 //===-- GDBRemoteClientBase.h -----------------------------------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
9 #ifndef liblldb_GDBRemoteClientBase_h_
10 #define liblldb_GDBRemoteClientBase_h_
12 #include "GDBRemoteCommunication.h"
14 #include <condition_variable>
16 namespace lldb_private {
17 namespace process_gdb_remote {
19 class GDBRemoteClientBase : public GDBRemoteCommunication {
21 struct ContinueDelegate {
22 virtual ~ContinueDelegate();
23 virtual void HandleAsyncStdout(llvm::StringRef out) = 0;
24 virtual void HandleAsyncMisc(llvm::StringRef data) = 0;
25 virtual void HandleStopReply() = 0;
27 // =========================================================================
28 /// Process asynchronously-received structured data.
31 /// The complete data packet, expected to start with JSON-async.
32 // =========================================================================
33 virtual void HandleAsyncStructuredDataPacket(llvm::StringRef data) = 0;
36 GDBRemoteClientBase(const char *comm_name, const char *listener_name);
38 bool SendAsyncSignal(int signo);
42 lldb::StateType SendContinuePacketAndWaitForResponse(
43 ContinueDelegate &delegate, const UnixSignals &signals,
44 llvm::StringRef payload, StringExtractorGDBRemote &response);
46 PacketResult SendPacketAndWaitForResponse(llvm::StringRef payload,
47 StringExtractorGDBRemote &response,
50 PacketResult SendPacketAndReceiveResponseWithOutputSupport(
51 llvm::StringRef payload, StringExtractorGDBRemote &response,
53 llvm::function_ref<void(llvm::StringRef)> output_callback);
55 bool SendvContPacket(llvm::StringRef payload,
56 StringExtractorGDBRemote &response);
60 Lock(GDBRemoteClientBase &comm, bool interrupt);
63 explicit operator bool() { return m_acquired; }
65 // Whether we had to interrupt the continue thread to acquire the
67 bool DidInterrupt() const { return m_did_interrupt; }
70 std::unique_lock<std::recursive_mutex> m_async_lock;
71 GDBRemoteClientBase &m_comm;
75 void SyncWithContinueThread(bool interrupt);
80 SendPacketAndWaitForResponseNoLock(llvm::StringRef payload,
81 StringExtractorGDBRemote &response);
83 virtual void OnRunPacketSent(bool first);
86 // Variables handling synchronization between the Continue thread and any
88 // wishing to send packets over the connection. Either the continue thread has
90 // the connection (m_is_running == true) or the connection is free for an
91 // arbitrary number of
92 // other senders to take which indicate their interest by incrementing
94 // Semantics of individual states:
95 // - m_continue_packet == false, m_async_count == 0: connection is free
96 // - m_continue_packet == true, m_async_count == 0: only continue thread is
98 // - m_continue_packet == true, m_async_count > 0: continue thread has
99 // control, async threads
100 // should interrupt it and wait for it to set m_continue_packet to false
101 // - m_continue_packet == false, m_async_count > 0: async threads have
103 // thread needs to wait for them to finish (m_async_count goes down to 0).
105 std::condition_variable m_cv;
106 // Packet with which to resume after an async interrupt. Can be changed by an
108 // e.g. to inject a signal.
109 std::string m_continue_packet;
110 // When was the interrupt packet sent. Used to make sure we time out if the
112 // respond to interrupt requests.
113 std::chrono::time_point<std::chrono::steady_clock> m_interrupt_time;
114 uint32_t m_async_count;
116 bool m_should_stop; // Whether we should resume after a stop.
117 // end of continue thread synchronization block
119 // This handles the synchronization between individual async threads. For now
122 std::recursive_mutex m_async_mutex;
124 bool ShouldStop(const UnixSignals &signals,
125 StringExtractorGDBRemote &response);
129 enum class LockResult { Success, Cancelled, Failed };
131 explicit ContinueLock(GDBRemoteClientBase &comm);
133 explicit operator bool() { return m_acquired; }
140 GDBRemoteClientBase &m_comm;
145 } // namespace process_gdb_remote
146 } // namespace lldb_private
148 #endif // liblldb_GDBRemoteCommunicationClient_h_