diff --git a/lldb/include/lldb/Host/Socket.h b/lldb/include/lldb/Host/Socket.h index c313aa4f6d26..89953ee7fd5b 100644 --- a/lldb/include/lldb/Host/Socket.h +++ b/lldb/include/lldb/Host/Socket.h @@ -106,6 +106,10 @@ public: static std::unique_ptr Create(const SocketProtocol protocol, Status &error); + using Pair = std::pair, std::unique_ptr>; + static llvm::Expected + CreatePair(std::optional protocol = std::nullopt); + virtual Status Connect(llvm::StringRef name) = 0; virtual Status Listen(llvm::StringRef name, int backlog) = 0; diff --git a/lldb/include/lldb/Host/common/TCPSocket.h b/lldb/include/lldb/Host/common/TCPSocket.h index cb950c0015ea..353e538d0552 100644 --- a/lldb/include/lldb/Host/common/TCPSocket.h +++ b/lldb/include/lldb/Host/common/TCPSocket.h @@ -23,6 +23,10 @@ public: TCPSocket(NativeSocket socket, bool should_close); ~TCPSocket() override; + using Pair = + std::pair, std::unique_ptr>; + static llvm::Expected CreatePair(); + // returns port number or 0 if error uint16_t GetLocalPortNumber() const; diff --git a/lldb/include/lldb/Host/posix/DomainSocket.h b/lldb/include/lldb/Host/posix/DomainSocket.h index a840d474429e..cfb31922367c 100644 --- a/lldb/include/lldb/Host/posix/DomainSocket.h +++ b/lldb/include/lldb/Host/posix/DomainSocket.h @@ -19,6 +19,10 @@ public: DomainSocket(NativeSocket socket, bool should_close); explicit DomainSocket(bool should_close); + using Pair = + std::pair, std::unique_ptr>; + static llvm::Expected CreatePair(); + Status Connect(llvm::StringRef name) override; Status Listen(llvm::StringRef name, int backlog) override; diff --git a/lldb/source/Host/common/Socket.cpp b/lldb/source/Host/common/Socket.cpp index 5c5cd653c3d9..2b23fd1e6e57 100644 --- a/lldb/source/Host/common/Socket.cpp +++ b/lldb/source/Host/common/Socket.cpp @@ -234,6 +234,23 @@ std::unique_ptr Socket::Create(const SocketProtocol protocol, return socket_up; } +llvm::Expected +Socket::CreatePair(std::optional protocol) { + constexpr SocketProtocol kBestProtocol = + LLDB_ENABLE_POSIX ? ProtocolUnixDomain : ProtocolTcp; + switch (protocol.value_or(kBestProtocol)) { + case ProtocolTcp: + return TCPSocket::CreatePair(); +#if LLDB_ENABLE_POSIX + case ProtocolUnixDomain: + case ProtocolUnixAbstract: + return DomainSocket::CreatePair(); +#endif + default: + return llvm::createStringError("Unsupported protocol"); + } +} + llvm::Expected> Socket::TcpConnect(llvm::StringRef host_and_port) { Log *log = GetLog(LLDBLog::Connection); diff --git a/lldb/source/Host/common/TCPSocket.cpp b/lldb/source/Host/common/TCPSocket.cpp index 3d0dea1c61dd..c144f3c501d7 100644 --- a/lldb/source/Host/common/TCPSocket.cpp +++ b/lldb/source/Host/common/TCPSocket.cpp @@ -52,6 +52,32 @@ TCPSocket::TCPSocket(NativeSocket socket, bool should_close) TCPSocket::~TCPSocket() { CloseListenSockets(); } +llvm::Expected TCPSocket::CreatePair() { + auto listen_socket_up = std::make_unique(true); + if (Status error = listen_socket_up->Listen("localhost:0", 5); error.Fail()) + return error.takeError(); + + std::string connect_address = + llvm::StringRef(listen_socket_up->GetListeningConnectionURI()[0]) + .split("://") + .second.str(); + + auto connect_socket_up = std::make_unique(true); + if (Status error = connect_socket_up->Connect(connect_address); error.Fail()) + return error.takeError(); + + // Connection has already been made above, so a short timeout is sufficient. + Socket *accept_socket; + if (Status error = + listen_socket_up->Accept(std::chrono::seconds(1), accept_socket); + error.Fail()) + return error.takeError(); + + return Pair( + std::move(connect_socket_up), + std::unique_ptr(static_cast(accept_socket))); +} + bool TCPSocket::IsValid() const { return m_socket != kInvalidSocketValue || m_listen_sockets.size() != 0; } diff --git a/lldb/source/Host/posix/DomainSocket.cpp b/lldb/source/Host/posix/DomainSocket.cpp index 4f76e0c16d4c..6a730324a1ea 100644 --- a/lldb/source/Host/posix/DomainSocket.cpp +++ b/lldb/source/Host/posix/DomainSocket.cpp @@ -13,9 +13,11 @@ #endif #include "llvm/Support/Errno.h" +#include "llvm/Support/Error.h" #include "llvm/Support/FileSystem.h" #include +#include #include #include #include @@ -76,6 +78,31 @@ DomainSocket::DomainSocket(SocketProtocol protocol, NativeSocket socket, m_socket = socket; } +llvm::Expected DomainSocket::CreatePair() { + int sockets[2]; + int type = SOCK_STREAM; +#ifdef SOCK_CLOEXEC + type |= SOCK_CLOEXEC; +#endif + if (socketpair(AF_UNIX, type, 0, sockets) == -1) + return llvm::errorCodeToError(llvm::errnoAsErrorCode()); + +#ifndef SOCK_CLOEXEC + for (int s : sockets) { + int r = fcntl(s, F_SETFD, FD_CLOEXEC | fcntl(s, F_GETFD)); + assert(r == 0); + (void)r; + } +#endif + + return Pair(std::unique_ptr( + new DomainSocket(ProtocolUnixDomain, sockets[0], + /*should_close=*/true)), + std::unique_ptr( + new DomainSocket(ProtocolUnixDomain, sockets[1], + /*should_close=*/true))); +} + Status DomainSocket::Connect(llvm::StringRef name) { sockaddr_un saddr_un; socklen_t saddr_un_len; diff --git a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunication.cpp b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunication.cpp index 2aea7c6b781d..d1f57cc22d8b 100644 --- a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunication.cpp +++ b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunication.cpp @@ -1141,34 +1141,14 @@ void GDBRemoteCommunication::DumpHistory(Stream &strm) { m_history.Dump(strm); } llvm::Error GDBRemoteCommunication::ConnectLocally(GDBRemoteCommunication &client, GDBRemoteCommunication &server) { - const int backlog = 5; - TCPSocket listen_socket(true); - if (llvm::Error error = - listen_socket.Listen("localhost:0", backlog).ToError()) - return error; + llvm::Expected pair = Socket::CreatePair(); + if (!pair) + return pair.takeError(); - llvm::SmallString<32> remote_addr; - llvm::raw_svector_ostream(remote_addr) - << "connect://localhost:" << listen_socket.GetLocalPortNumber(); - - std::unique_ptr conn_up( - new ConnectionFileDescriptor()); - Status status; - if (conn_up->Connect(remote_addr, &status) != lldb::eConnectionStatusSuccess) - return llvm::createStringError(llvm::inconvertibleErrorCode(), - "Unable to connect: %s", status.AsCString()); - - // The connection was already established above, so a short timeout is - // sufficient. - Socket *accept_socket = nullptr; - if (Status accept_status = - listen_socket.Accept(std::chrono::seconds(1), accept_socket); - accept_status.Fail()) - return accept_status.takeError(); - - client.SetConnection(std::move(conn_up)); + client.SetConnection( + std::make_unique(pair->first.release())); server.SetConnection( - std::make_unique(accept_socket)); + std::make_unique(pair->second.release())); return llvm::Error::success(); } diff --git a/lldb/unittests/Core/CommunicationTest.cpp b/lldb/unittests/Core/CommunicationTest.cpp index df9ff089a0d7..fd07b4da9f8c 100644 --- a/lldb/unittests/Core/CommunicationTest.cpp +++ b/lldb/unittests/Core/CommunicationTest.cpp @@ -7,14 +7,14 @@ //===----------------------------------------------------------------------===// #include "lldb/Core/Communication.h" +#include "TestingSupport/SubsystemRAII.h" #include "lldb/Core/ThreadedCommunication.h" #include "lldb/Host/Config.h" #include "lldb/Host/ConnectionFileDescriptor.h" #include "lldb/Host/Pipe.h" +#include "lldb/Host/Socket.h" #include "llvm/Testing/Support/Error.h" #include "gtest/gtest.h" -#include "TestingSupport/Host/SocketTestUtilities.h" -#include "TestingSupport/SubsystemRAII.h" #include #include @@ -31,15 +31,17 @@ private: }; static void CommunicationReadTest(bool use_read_thread) { - std::unique_ptr a, b; - ASSERT_TRUE(CreateTCPConnectedSockets("localhost", &a, &b)); + llvm::Expected pair = Socket::CreatePair(); + ASSERT_THAT_EXPECTED(pair, llvm::Succeeded()); + Socket &a = *pair->first; size_t num_bytes = 4; - ASSERT_THAT_ERROR(a->Write("test", num_bytes).ToError(), llvm::Succeeded()); + ASSERT_THAT_ERROR(a.Write("test", num_bytes).ToError(), llvm::Succeeded()); ASSERT_EQ(num_bytes, 4U); ThreadedCommunication comm("test"); - comm.SetConnection(std::make_unique(b.release())); + comm.SetConnection( + std::make_unique(pair->second.release())); comm.SetCloseOnEOF(true); if (use_read_thread) { @@ -73,7 +75,7 @@ static void CommunicationReadTest(bool use_read_thread) { EXPECT_THAT_ERROR(error.ToError(), llvm::Failed()); // This read should return EOF. - ASSERT_THAT_ERROR(a->Close().ToError(), llvm::Succeeded()); + ASSERT_THAT_ERROR(a.Close().ToError(), llvm::Succeeded()); error.Clear(); EXPECT_EQ( comm.Read(buf, sizeof(buf), std::chrono::seconds(5), status, &error), 0U); @@ -118,17 +120,19 @@ TEST_F(CommunicationTest, ReadThread) { } TEST_F(CommunicationTest, SynchronizeWhileClosing) { - std::unique_ptr a, b; - ASSERT_TRUE(CreateTCPConnectedSockets("localhost", &a, &b)); + llvm::Expected pair = Socket::CreatePair(); + ASSERT_THAT_EXPECTED(pair, llvm::Succeeded()); + Socket &a = *pair->first; ThreadedCommunication comm("test"); - comm.SetConnection(std::make_unique(b.release())); + comm.SetConnection( + std::make_unique(pair->second.release())); comm.SetCloseOnEOF(true); ASSERT_TRUE(comm.StartReadThread()); // Ensure that we can safely synchronize with the read thread while it is // closing the read end (in response to us closing the write end). - ASSERT_THAT_ERROR(a->Close().ToError(), llvm::Succeeded()); + ASSERT_THAT_ERROR(a.Close().ToError(), llvm::Succeeded()); comm.SynchronizeWithReadThread(); ASSERT_TRUE(comm.StopReadThread()); diff --git a/lldb/unittests/Host/SocketTest.cpp b/lldb/unittests/Host/SocketTest.cpp index 77366593f05f..3630b6324270 100644 --- a/lldb/unittests/Host/SocketTest.cpp +++ b/lldb/unittests/Host/SocketTest.cpp @@ -74,6 +74,41 @@ TEST_F(SocketTest, DecodeHostAndPort) { llvm::HasValue(Socket::HostAndPort{"abcd:12fg:AF58::1", 12345})); } +TEST_F(SocketTest, CreatePair) { + std::vector> functional_protocols = { + std::nullopt, + Socket::ProtocolTcp, +#if LLDB_ENABLE_POSIX + Socket::ProtocolUnixDomain, + Socket::ProtocolUnixAbstract, +#endif + }; + for (auto p : functional_protocols) { + auto expected_socket_pair = Socket::CreatePair(p); + ASSERT_THAT_EXPECTED(expected_socket_pair, llvm::Succeeded()); + Socket &a = *expected_socket_pair->first; + Socket &b = *expected_socket_pair->second; + size_t num_bytes = 1; + ASSERT_THAT_ERROR(a.Write("a", num_bytes).takeError(), llvm::Succeeded()); + ASSERT_EQ(num_bytes, 1); + char c; + ASSERT_THAT_ERROR(b.Read(&c, num_bytes).takeError(), llvm::Succeeded()); + ASSERT_EQ(num_bytes, 1); + ASSERT_EQ(c, 'a'); + } + + std::vector erroring_protocols = { +#if !LLDB_ENABLE_POSIX + Socket::ProtocolUnixDomain, + Socket::ProtocolUnixAbstract, +#endif + }; + for (auto p : erroring_protocols) { + ASSERT_THAT_EXPECTED(Socket::CreatePair(p), + llvm::FailedWithMessage("Unsupported protocol")); + } +} + #if LLDB_ENABLE_POSIX TEST_F(SocketTest, DomainListenConnectAccept) { llvm::SmallString<64> Path;