| //===-- SocketTest.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 "TestingSupport/Host/SocketTestUtilities.h" |
| #include "TestingSupport/SubsystemRAII.h" |
| #include "lldb/Host/Config.h" |
| #include "lldb/Host/MainLoop.h" |
| #include "lldb/Utility/UriParser.h" |
| #include "llvm/Testing/Support/Error.h" |
| #include "gmock/gmock.h" |
| #include "gtest/gtest.h" |
| #include <chrono> |
| #if __linux__ |
| #include <lldb/Host/linux/AbstractSocket.h> |
| #endif |
| |
| using namespace lldb_private; |
| |
| struct SocketTestParams { |
| bool is_ipv6; |
| std::string localhost_ip; |
| }; |
| |
| class SocketTest : public testing::TestWithParam<SocketTestParams> { |
| public: |
| SubsystemRAII<Socket> subsystems; |
| |
| protected: |
| bool HostSupportsProtocol() const { |
| if (GetParam().is_ipv6) |
| return HostSupportsIPv6(); |
| return HostSupportsIPv4(); |
| } |
| }; |
| |
| TEST_F(SocketTest, DecodeHostAndPort) { |
| EXPECT_THAT_EXPECTED(Socket::DecodeHostAndPort("localhost:1138"), |
| llvm::HasValue(Socket::HostAndPort{"localhost", 1138})); |
| |
| EXPECT_THAT_EXPECTED( |
| Socket::DecodeHostAndPort("google.com:65536"), |
| llvm::FailedWithMessage( |
| "invalid host:port specification: 'google.com:65536'")); |
| |
| EXPECT_THAT_EXPECTED( |
| Socket::DecodeHostAndPort("google.com:-1138"), |
| llvm::FailedWithMessage( |
| "invalid host:port specification: 'google.com:-1138'")); |
| |
| EXPECT_THAT_EXPECTED( |
| Socket::DecodeHostAndPort("google.com:65536"), |
| llvm::FailedWithMessage( |
| "invalid host:port specification: 'google.com:65536'")); |
| |
| EXPECT_THAT_EXPECTED(Socket::DecodeHostAndPort("12345"), |
| llvm::HasValue(Socket::HostAndPort{"", 12345})); |
| |
| EXPECT_THAT_EXPECTED(Socket::DecodeHostAndPort("*:0"), |
| llvm::HasValue(Socket::HostAndPort{"*", 0})); |
| |
| EXPECT_THAT_EXPECTED(Socket::DecodeHostAndPort("*:65535"), |
| llvm::HasValue(Socket::HostAndPort{"*", 65535})); |
| |
| EXPECT_THAT_EXPECTED(Socket::DecodeHostAndPort("[::1]:12345"), |
| llvm::HasValue(Socket::HostAndPort{"::1", 12345})); |
| |
| EXPECT_THAT_EXPECTED( |
| Socket::DecodeHostAndPort("[abcd:12fg:AF58::1]:12345"), |
| llvm::HasValue(Socket::HostAndPort{"abcd:12fg:AF58::1", 12345})); |
| } |
| |
| #if LLDB_ENABLE_POSIX |
| TEST_F(SocketTest, DomainListenConnectAccept) { |
| llvm::SmallString<64> Path; |
| std::error_code EC = |
| llvm::sys::fs::createUniqueDirectory("DomainListenConnectAccept", Path); |
| ASSERT_FALSE(EC); |
| llvm::sys::path::append(Path, "test"); |
| |
| // Skip the test if the $TMPDIR is too long to hold a domain socket. |
| if (Path.size() > 107u) |
| return; |
| |
| std::unique_ptr<DomainSocket> socket_a_up; |
| std::unique_ptr<DomainSocket> socket_b_up; |
| CreateDomainConnectedSockets(Path, &socket_a_up, &socket_b_up); |
| } |
| |
| TEST_F(SocketTest, DomainListenGetListeningConnectionURI) { |
| llvm::SmallString<64> Path; |
| std::error_code EC = |
| llvm::sys::fs::createUniqueDirectory("DomainListenConnectAccept", Path); |
| ASSERT_FALSE(EC); |
| llvm::sys::path::append(Path, "test"); |
| |
| // Skip the test if the $TMPDIR is too long to hold a domain socket. |
| if (Path.size() > 107u) |
| return; |
| |
| auto listen_socket_up = std::make_unique<DomainSocket>( |
| /*should_close=*/true); |
| Status error = listen_socket_up->Listen(Path, 5); |
| ASSERT_THAT_ERROR(error.ToError(), llvm::Succeeded()); |
| ASSERT_TRUE(listen_socket_up->IsValid()); |
| |
| ASSERT_THAT( |
| listen_socket_up->GetListeningConnectionURI(), |
| testing::ElementsAre(llvm::formatv("unix-connect://{0}", Path).str())); |
| } |
| |
| TEST_F(SocketTest, DomainMainLoopAccept) { |
| llvm::SmallString<64> Path; |
| std::error_code EC = |
| llvm::sys::fs::createUniqueDirectory("DomainListenConnectAccept", Path); |
| ASSERT_FALSE(EC); |
| llvm::sys::path::append(Path, "test"); |
| |
| // Skip the test if the $TMPDIR is too long to hold a domain socket. |
| if (Path.size() > 107u) |
| return; |
| |
| auto listen_socket_up = std::make_unique<DomainSocket>( |
| /*should_close=*/true); |
| Status error = listen_socket_up->Listen(Path, 5); |
| ASSERT_THAT_ERROR(error.ToError(), llvm::Succeeded()); |
| ASSERT_TRUE(listen_socket_up->IsValid()); |
| |
| MainLoop loop; |
| std::unique_ptr<Socket> accepted_socket_up; |
| auto expected_handles = listen_socket_up->Accept( |
| loop, [&accepted_socket_up, &loop](std::unique_ptr<Socket> sock_up) { |
| accepted_socket_up = std::move(sock_up); |
| loop.RequestTermination(); |
| }); |
| ASSERT_THAT_EXPECTED(expected_handles, llvm::Succeeded()); |
| |
| auto connect_socket_up = std::make_unique<DomainSocket>( |
| /*should_close=*/true); |
| ASSERT_THAT_ERROR(connect_socket_up->Connect(Path).ToError(), |
| llvm::Succeeded()); |
| ASSERT_TRUE(connect_socket_up->IsValid()); |
| |
| loop.Run(); |
| ASSERT_TRUE(accepted_socket_up); |
| ASSERT_TRUE(accepted_socket_up->IsValid()); |
| } |
| #endif |
| |
| TEST_P(SocketTest, TCPListen0ConnectAccept) { |
| if (!HostSupportsProtocol()) |
| return; |
| std::unique_ptr<TCPSocket> socket_a_up; |
| std::unique_ptr<TCPSocket> socket_b_up; |
| CreateTCPConnectedSockets(GetParam().localhost_ip, &socket_a_up, |
| &socket_b_up); |
| } |
| |
| TEST_P(SocketTest, TCPAcceptTimeout) { |
| if (!HostSupportsProtocol()) |
| return; |
| |
| const bool child_processes_inherit = false; |
| auto listen_socket_up = |
| std::make_unique<TCPSocket>(true, child_processes_inherit); |
| Status error = listen_socket_up->Listen( |
| llvm::formatv("[{0}]:0", GetParam().localhost_ip).str(), 5); |
| ASSERT_THAT_ERROR(error.ToError(), llvm::Succeeded()); |
| ASSERT_TRUE(listen_socket_up->IsValid()); |
| |
| Socket *socket; |
| ASSERT_THAT_ERROR( |
| listen_socket_up->Accept(std::chrono::milliseconds(10), socket) |
| .takeError(), |
| llvm::Failed<llvm::ErrorInfoBase>( |
| testing::Property(&llvm::ErrorInfoBase::convertToErrorCode, |
| std::make_error_code(std::errc::timed_out)))); |
| } |
| |
| TEST_P(SocketTest, TCPMainLoopAccept) { |
| if (!HostSupportsProtocol()) |
| return; |
| |
| auto listen_socket_up = std::make_unique<TCPSocket>(true); |
| Status error = listen_socket_up->Listen( |
| llvm::formatv("[{0}]:0", GetParam().localhost_ip).str(), 5); |
| ASSERT_THAT_ERROR(error.ToError(), llvm::Succeeded()); |
| ASSERT_TRUE(listen_socket_up->IsValid()); |
| |
| MainLoop loop; |
| std::unique_ptr<Socket> accepted_socket_up; |
| auto expected_handles = listen_socket_up->Accept( |
| loop, [&accepted_socket_up, &loop](std::unique_ptr<Socket> sock_up) { |
| accepted_socket_up = std::move(sock_up); |
| loop.RequestTermination(); |
| }); |
| ASSERT_THAT_EXPECTED(expected_handles, llvm::Succeeded()); |
| |
| auto connect_socket_up = std::make_unique<TCPSocket>(true); |
| ASSERT_THAT_ERROR( |
| connect_socket_up |
| ->Connect(llvm::formatv("[{0}]:{1}", GetParam().localhost_ip, |
| listen_socket_up->GetLocalPortNumber()) |
| .str()) |
| .ToError(), |
| llvm::Succeeded()); |
| ASSERT_TRUE(connect_socket_up->IsValid()); |
| |
| loop.Run(); |
| ASSERT_TRUE(accepted_socket_up); |
| ASSERT_TRUE(accepted_socket_up->IsValid()); |
| } |
| |
| TEST_P(SocketTest, TCPGetAddress) { |
| std::unique_ptr<TCPSocket> socket_a_up; |
| std::unique_ptr<TCPSocket> socket_b_up; |
| if (!HostSupportsProtocol()) |
| return; |
| CreateTCPConnectedSockets(GetParam().localhost_ip, &socket_a_up, |
| &socket_b_up); |
| |
| EXPECT_EQ(socket_a_up->GetLocalPortNumber(), |
| socket_b_up->GetRemotePortNumber()); |
| EXPECT_EQ(socket_b_up->GetLocalPortNumber(), |
| socket_a_up->GetRemotePortNumber()); |
| EXPECT_NE(socket_a_up->GetLocalPortNumber(), |
| socket_b_up->GetLocalPortNumber()); |
| EXPECT_STREQ(GetParam().localhost_ip.c_str(), |
| socket_a_up->GetRemoteIPAddress().c_str()); |
| EXPECT_STREQ(GetParam().localhost_ip.c_str(), |
| socket_b_up->GetRemoteIPAddress().c_str()); |
| } |
| |
| TEST_P(SocketTest, UDPConnect) { |
| // UDPSocket::Connect() creates sockets with AF_INET (IPv4). |
| if (!HostSupportsIPv4()) |
| return; |
| llvm::Expected<std::unique_ptr<UDPSocket>> socket = |
| UDPSocket::CreateConnected("127.0.0.1:0"); |
| |
| ASSERT_THAT_EXPECTED(socket, llvm::Succeeded()); |
| EXPECT_TRUE(socket.get()->IsValid()); |
| } |
| |
| TEST_P(SocketTest, TCPListen0GetPort) { |
| if (!HostSupportsIPv4()) |
| return; |
| llvm::Expected<std::unique_ptr<TCPSocket>> sock = |
| Socket::TcpListen("10.10.12.3:0", 5); |
| ASSERT_THAT_EXPECTED(sock, llvm::Succeeded()); |
| ASSERT_TRUE(sock.get()->IsValid()); |
| EXPECT_NE(sock.get()->GetLocalPortNumber(), 0); |
| } |
| |
| TEST_P(SocketTest, TCPListen0GetListeningConnectionURI) { |
| if (!HostSupportsProtocol()) |
| return; |
| |
| std::string addr = llvm::formatv("[{0}]:0", GetParam().localhost_ip).str(); |
| llvm::Expected<std::unique_ptr<TCPSocket>> sock = Socket::TcpListen(addr); |
| ASSERT_THAT_EXPECTED(sock, llvm::Succeeded()); |
| ASSERT_TRUE(sock.get()->IsValid()); |
| |
| EXPECT_THAT( |
| sock.get()->GetListeningConnectionURI(), |
| testing::ElementsAre(llvm::formatv("connection://[{0}]:{1}", |
| GetParam().localhost_ip, |
| sock->get()->GetLocalPortNumber()) |
| .str())); |
| } |
| |
| TEST_F(SocketTest, TCPListen0MultiListenerGetListeningConnectionURI) { |
| if (!HostSupportsLocalhostToIPv4() || !HostSupportsLocalhostToIPv6()) |
| return; |
| |
| llvm::Expected<std::unique_ptr<TCPSocket>> sock = |
| Socket::TcpListen("localhost:0", 5); |
| ASSERT_THAT_EXPECTED(sock, llvm::Succeeded()); |
| ASSERT_TRUE(sock.get()->IsValid()); |
| |
| EXPECT_THAT(sock.get()->GetListeningConnectionURI(), |
| testing::UnorderedElementsAre( |
| llvm::formatv("connection://[::1]:{0}", |
| sock->get()->GetLocalPortNumber()) |
| .str(), |
| llvm::formatv("connection://[127.0.0.1]:{0}", |
| sock->get()->GetLocalPortNumber()) |
| .str())); |
| } |
| |
| TEST_P(SocketTest, TCPGetConnectURI) { |
| std::unique_ptr<TCPSocket> socket_a_up; |
| std::unique_ptr<TCPSocket> socket_b_up; |
| if (!HostSupportsProtocol()) |
| return; |
| CreateTCPConnectedSockets(GetParam().localhost_ip, &socket_a_up, |
| &socket_b_up); |
| |
| std::string uri(socket_a_up->GetRemoteConnectionURI()); |
| EXPECT_EQ((URI{"connect", GetParam().localhost_ip, |
| socket_a_up->GetRemotePortNumber(), "/"}), |
| URI::Parse(uri)); |
| } |
| |
| TEST_P(SocketTest, UDPGetConnectURI) { |
| // UDPSocket::Connect() creates sockets with AF_INET (IPv4). |
| if (!HostSupportsIPv4()) |
| return; |
| llvm::Expected<std::unique_ptr<UDPSocket>> socket = |
| UDPSocket::CreateConnected("127.0.0.1:0"); |
| ASSERT_THAT_EXPECTED(socket, llvm::Succeeded()); |
| |
| std::string uri = socket.get()->GetRemoteConnectionURI(); |
| EXPECT_EQ((URI{"udp", "127.0.0.1", 0, "/"}), URI::Parse(uri)); |
| } |
| |
| #if LLDB_ENABLE_POSIX |
| TEST_F(SocketTest, DomainGetConnectURI) { |
| llvm::SmallString<64> domain_path; |
| std::error_code EC = llvm::sys::fs::createUniqueDirectory( |
| "DomainListenConnectAccept", domain_path); |
| ASSERT_FALSE(EC); |
| llvm::sys::path::append(domain_path, "test"); |
| |
| // Skip the test if the $TMPDIR is too long to hold a domain socket. |
| if (domain_path.size() > 107u) |
| return; |
| |
| std::unique_ptr<DomainSocket> socket_a_up; |
| std::unique_ptr<DomainSocket> socket_b_up; |
| CreateDomainConnectedSockets(domain_path, &socket_a_up, &socket_b_up); |
| |
| std::string uri(socket_a_up->GetRemoteConnectionURI()); |
| EXPECT_EQ((URI{"unix-connect", "", std::nullopt, domain_path}), |
| URI::Parse(uri)); |
| |
| EXPECT_EQ(socket_b_up->GetRemoteConnectionURI(), ""); |
| } |
| |
| TEST_F(SocketTest, DomainSocketFromBoundNativeSocket) { |
| // Generate a name for the domain socket. |
| llvm::SmallString<64> name; |
| std::error_code EC = llvm::sys::fs::createUniqueDirectory( |
| "DomainSocketFromBoundNativeSocket", name); |
| ASSERT_FALSE(EC); |
| llvm::sys::path::append(name, "test"); |
| |
| // Skip the test if the $TMPDIR is too long to hold a domain socket. |
| if (name.size() > 107u) |
| GTEST_SKIP() << "$TMPDIR is too long to hold a domain socket"; |
| |
| DomainSocket socket(true); |
| Status error = socket.Listen(name, /*backlog=*/10); |
| ASSERT_THAT_ERROR(error.takeError(), llvm::Succeeded()); |
| NativeSocket native_socket = socket.GetNativeSocket(); |
| |
| llvm::Expected<std::unique_ptr<DomainSocket>> sock = |
| DomainSocket::FromBoundNativeSocket(native_socket, |
| /*should_close=*/false); |
| ASSERT_THAT_EXPECTED(sock, llvm::Succeeded()); |
| ASSERT_EQ(Socket::ProtocolUnixDomain, sock->get()->GetSocketProtocol()); |
| } |
| #endif |
| |
| #if __linux__ |
| TEST_F(SocketTest, AbstractSocketFromBoundNativeSocket) { |
| // Generate a name for the abstract socket. |
| llvm::SmallString<100> name; |
| llvm::sys::fs::createUniquePath("AbstractSocketFromBoundNativeSocket", name, |
| true); |
| llvm::sys::path::append(name, "test"); |
| |
| // Skip the test if the $TMPDIR is too long to hold a domain socket. |
| if (name.size() > 107u) |
| GTEST_SKIP() << "$TMPDIR is too long to hold a domain socket"; |
| |
| AbstractSocket socket; |
| Status error = socket.Listen(name, /*backlog=*/10); |
| ASSERT_THAT_ERROR(error.takeError(), llvm::Succeeded()); |
| NativeSocket native_socket = socket.GetNativeSocket(); |
| |
| llvm::Expected<std::unique_ptr<DomainSocket>> sock = |
| DomainSocket::FromBoundNativeSocket(native_socket, |
| /*should_close=*/false); |
| ASSERT_THAT_EXPECTED(sock, llvm::Succeeded()); |
| ASSERT_EQ(Socket::ProtocolUnixAbstract, sock->get()->GetSocketProtocol()); |
| } |
| #endif |
| |
| INSTANTIATE_TEST_SUITE_P( |
| SocketTests, SocketTest, |
| testing::Values(SocketTestParams{/*is_ipv6=*/false, |
| /*localhost_ip=*/"127.0.0.1"}, |
| SocketTestParams{/*is_ipv6=*/true, /*localhost_ip=*/"::1"}), |
| // Prints "SocketTests/SocketTest.TCPGetAddress/ipv4" etc. in test logs. |
| [](const testing::TestParamInfo<SocketTestParams> &info) { |
| return info.param.is_ipv6 ? "ipv6" : "ipv4"; |
| }); |