[lldb/platform-gdb] Do not assume a persistent connection (#131736)

After https://reviews.llvm.org/D116539, when `m_gdb_client_up` in
`PlatformRemoteGDBServer` is not null, the connection to a server is
expected to exist. However,
`PlatformRemoteGDBServer::DisconnectRemote()` is not the only way to
close the connection;
`GDBRemoteCommunication::WaitForPacketNoLock()` can disconnect if the
server stops responding, and in this case `m_gdb_client_up` is not
cleared. The patch removes this assumption and checks the connection
status directly.
This commit is contained in:
Igor Kudrin 2025-03-18 09:25:35 -07:00 committed by GitHub
parent 33e5d013b7
commit 6542cf1973
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 77 additions and 5 deletions

View File

@ -206,11 +206,7 @@ bool PlatformRemoteGDBServer::SetRemoteWorkingDirectory(
}
bool PlatformRemoteGDBServer::IsConnected() const {
if (m_gdb_client_up) {
assert(m_gdb_client_up->IsConnected());
return true;
}
return false;
return m_gdb_client_up && m_gdb_client_up->IsConnected();
}
Status PlatformRemoteGDBServer::ConnectRemote(Args &args) {

View File

@ -15,3 +15,4 @@ add_lldb_unittest(LLDBPlatformTests
)
add_subdirectory(Android)
add_subdirectory(gdb-server)

View File

@ -0,0 +1,7 @@
add_lldb_unittest(PlatformGdbRemoteTests
PlatformRemoteGDBServerTest.cpp
LINK_LIBS
lldbPluginPlatformGDB
LLVMTestingSupport
)

View File

@ -0,0 +1,68 @@
//===-- PlatformRemoteGDBServerTest.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 "Plugins/Platform/gdb-server/PlatformRemoteGDBServer.h"
#include "lldb/Utility/Connection.h"
#include "gmock/gmock.h"
using namespace lldb;
using namespace lldb_private;
using namespace lldb_private::platform_gdb_server;
using namespace lldb_private::process_gdb_remote;
using namespace testing;
namespace {
class PlatformRemoteGDBServerHack : public PlatformRemoteGDBServer {
public:
void
SetGDBClient(std::unique_ptr<GDBRemoteCommunicationClient> gdb_client_up) {
m_gdb_client_up = std::move(gdb_client_up);
}
};
class MockConnection : public lldb_private::Connection {
public:
MOCK_METHOD(lldb::ConnectionStatus, Connect,
(llvm::StringRef url, Status *error_ptr), (override));
MOCK_METHOD(lldb::ConnectionStatus, Disconnect, (Status * error_ptr),
(override));
MOCK_METHOD(bool, IsConnected, (), (const, override));
MOCK_METHOD(size_t, Read,
(void *dst, size_t dst_len, const Timeout<std::micro> &timeout,
lldb::ConnectionStatus &status, Status *error_ptr),
(override));
MOCK_METHOD(size_t, Write,
(const void *dst, size_t dst_len, lldb::ConnectionStatus &status,
Status *error_ptr),
(override));
MOCK_METHOD(std::string, GetURI, (), (override));
MOCK_METHOD(bool, InterruptRead, (), (override));
};
} // namespace
TEST(PlatformRemoteGDBServerTest, IsConnected) {
bool is_connected = true;
auto connection = std::make_unique<NiceMock<MockConnection>>();
ON_CALL(*connection, IsConnected())
.WillByDefault(ReturnPointee(&is_connected));
auto client = std::make_unique<GDBRemoteCommunicationClient>();
client->SetConnection(std::move(connection));
PlatformRemoteGDBServerHack server;
EXPECT_FALSE(server.IsConnected());
server.SetGDBClient(std::move(client));
EXPECT_TRUE(server.IsConnected());
is_connected = false;
EXPECT_FALSE(server.IsConnected());
}