LCOV - code coverage report
Current view: top level - src/test - sock_tests.cpp (source / functions) Coverage Total Hit
Test: total_coverage.info Lines: 100.0 % 103 103
Test Date: 2026-03-16 05:20:51 Functions: 100.0 % 18 18
Branches: 49.0 % 572 280

             Branch data     Line data    Source code
       1                 :             : // Copyright (c) 2021-present The Bitcoin Core developers
       2                 :             : // Distributed under the MIT software license, see the accompanying
       3                 :             : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
       4                 :             : 
       5                 :             : #include <common/system.h>
       6                 :             : #include <compat/compat.h>
       7                 :             : #include <test/util/common.h>
       8                 :             : #include <test/util/setup_common.h>
       9                 :             : #include <util/sock.h>
      10                 :             : #include <util/threadinterrupt.h>
      11                 :             : 
      12                 :             : #include <boost/test/unit_test.hpp>
      13                 :             : 
      14                 :             : #include <cassert>
      15                 :             : #include <thread>
      16                 :             : 
      17                 :             : using namespace std::chrono_literals;
      18                 :             : 
      19                 :             : BOOST_FIXTURE_TEST_SUITE(sock_tests, BasicTestingSetup)
      20                 :             : 
      21                 :          14 : static bool SocketIsClosed(const SOCKET& s)
      22                 :             : {
      23                 :             :     // Notice that if another thread is running and creates its own socket after `s` has been
      24                 :             :     // closed, it may be assigned the same file descriptor number. In this case, our test will
      25                 :             :     // wrongly pretend that the socket is not closed.
      26                 :          14 :     int type;
      27                 :          14 :     socklen_t len = sizeof(type);
      28                 :          14 :     return getsockopt(s, SOL_SOCKET, SO_TYPE, reinterpret_cast<char*>(&type), &len) == SOCKET_ERROR;
      29                 :             : }
      30                 :             : 
      31                 :           4 : static SOCKET CreateSocket()
      32                 :             : {
      33                 :           4 :     const SOCKET s = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
      34         [ +  - ]:           8 :     BOOST_REQUIRE(s != static_cast<SOCKET>(SOCKET_ERROR));
      35                 :           4 :     return s;
      36                 :             : }
      37                 :             : 
      38   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(constructor_and_destructor)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
      39                 :             : {
      40                 :           1 :     const SOCKET s = CreateSocket();
      41         [ +  - ]:           1 :     Sock* sock = new Sock(s);
      42   [ +  -  +  - ]:           2 :     BOOST_CHECK(*sock == s);
      43   [ +  -  +  - ]:           2 :     BOOST_CHECK(!SocketIsClosed(s));
      44         [ +  - ]:           1 :     delete sock;
      45         [ +  - ]:           2 :     BOOST_CHECK(SocketIsClosed(s));
      46                 :           1 : }
      47                 :             : 
      48   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(move_constructor)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
      49                 :             : {
      50                 :           1 :     const SOCKET s = CreateSocket();
      51         [ +  - ]:           1 :     Sock* sock1 = new Sock(s);
      52         [ +  - ]:           1 :     Sock* sock2 = new Sock(std::move(*sock1));
      53         [ +  - ]:           1 :     delete sock1;
      54         [ +  - ]:           2 :     BOOST_CHECK(!SocketIsClosed(s));
      55   [ +  -  +  -  :           2 :     BOOST_CHECK(*sock2 == s);
                   +  - ]
      56         [ +  - ]:           1 :     delete sock2;
      57         [ +  - ]:           2 :     BOOST_CHECK(SocketIsClosed(s));
      58                 :           1 : }
      59                 :             : 
      60   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(move_assignment)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
      61                 :             : {
      62                 :           1 :     const SOCKET s1 = CreateSocket();
      63                 :           1 :     const SOCKET s2 = CreateSocket();
      64         [ +  - ]:           1 :     Sock* sock1 = new Sock(s1);
      65         [ +  - ]:           1 :     Sock* sock2 = new Sock(s2);
      66                 :             : 
      67         [ +  - ]:           2 :     BOOST_CHECK(!SocketIsClosed(s1));
      68         [ +  - ]:           2 :     BOOST_CHECK(!SocketIsClosed(s2));
      69                 :             : 
      70                 :           1 :     *sock2 = std::move(*sock1);
      71         [ +  - ]:           2 :     BOOST_CHECK(!SocketIsClosed(s1));
      72         [ +  - ]:           2 :     BOOST_CHECK(SocketIsClosed(s2));
      73   [ +  -  +  -  :           2 :     BOOST_CHECK(*sock2 == s1);
                   +  - ]
      74                 :             : 
      75         [ +  - ]:           1 :     delete sock1;
      76         [ +  - ]:           2 :     BOOST_CHECK(!SocketIsClosed(s1));
      77         [ +  - ]:           2 :     BOOST_CHECK(SocketIsClosed(s2));
      78   [ +  -  +  -  :           2 :     BOOST_CHECK(*sock2 == s1);
                   +  - ]
      79                 :             : 
      80         [ +  - ]:           1 :     delete sock2;
      81         [ +  - ]:           2 :     BOOST_CHECK(SocketIsClosed(s1));
      82         [ +  - ]:           2 :     BOOST_CHECK(SocketIsClosed(s2));
      83                 :           1 : }
      84                 :             : 
      85                 :             : #ifndef WIN32 // Windows does not have socketpair(2).
      86                 :             : 
      87                 :           3 : static void CreateSocketPair(int s[2])
      88                 :             : {
      89         [ +  - ]:           3 :     BOOST_REQUIRE_EQUAL(socketpair(AF_UNIX, SOCK_STREAM, 0, s), 0);
      90                 :           3 : }
      91                 :             : 
      92                 :           2 : static void SendAndRecvMessage(const Sock& sender, const Sock& receiver)
      93                 :             : {
      94                 :           2 :     const char* msg = "abcd";
      95                 :           2 :     constexpr ssize_t msg_len = 4;
      96                 :           2 :     char recv_buf[10];
      97                 :             : 
      98         [ +  - ]:           2 :     BOOST_CHECK_EQUAL(sender.Send(msg, msg_len, 0), msg_len);
      99         [ +  - ]:           2 :     BOOST_CHECK_EQUAL(receiver.Recv(recv_buf, sizeof(recv_buf), 0), msg_len);
     100         [ +  - ]:           2 :     BOOST_CHECK_EQUAL(strncmp(msg, recv_buf, msg_len), 0);
     101                 :           2 : }
     102                 :             : 
     103   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(send_and_receive)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     104                 :             : {
     105                 :           1 :     int s[2];
     106                 :           1 :     CreateSocketPair(s);
     107                 :             : 
     108         [ +  - ]:           1 :     Sock* sock0 = new Sock(s[0]);
     109         [ +  - ]:           1 :     Sock* sock1 = new Sock(s[1]);
     110                 :             : 
     111                 :           1 :     SendAndRecvMessage(*sock0, *sock1);
     112                 :             : 
     113         [ +  - ]:           1 :     Sock* sock0moved = new Sock(std::move(*sock0));
     114         [ +  - ]:           1 :     Sock* sock1moved = new Sock(INVALID_SOCKET);
     115                 :           1 :     *sock1moved = std::move(*sock1);
     116                 :             : 
     117         [ +  - ]:           1 :     delete sock0;
     118         [ +  - ]:           1 :     delete sock1;
     119                 :             : 
     120                 :           1 :     SendAndRecvMessage(*sock1moved, *sock0moved);
     121                 :             : 
     122         [ +  - ]:           1 :     delete sock0moved;
     123         [ +  - ]:           1 :     delete sock1moved;
     124                 :             : 
     125         [ +  - ]:           2 :     BOOST_CHECK(SocketIsClosed(s[0]));
     126         [ +  - ]:           2 :     BOOST_CHECK(SocketIsClosed(s[1]));
     127                 :           1 : }
     128                 :             : 
     129   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(wait)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     130                 :             : {
     131                 :           1 :     int s[2];
     132                 :           1 :     CreateSocketPair(s);
     133                 :             : 
     134                 :           1 :     Sock sock0(s[0]);
     135         [ +  - ]:           1 :     Sock sock1(s[1]);
     136                 :             : 
     137         [ +  - ]:           2 :     std::thread waiter([&sock0]() { (void)sock0.Wait(24h, Sock::RECV); });
     138                 :             : 
     139   [ +  -  +  -  :           1 :     BOOST_REQUIRE_EQUAL(sock1.Send("a", 1, 0), 1);
                   +  - ]
     140                 :             : 
     141         [ +  - ]:           1 :     waiter.join();
     142                 :           1 : }
     143                 :             : 
     144   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(recv_until_terminator_limit)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     145                 :             : {
     146                 :           1 :     constexpr auto timeout = 1min; // High enough so that it is never hit.
     147                 :           1 :     CThreadInterrupt interrupt;
     148                 :           1 :     int s[2];
     149         [ +  - ]:           1 :     CreateSocketPair(s);
     150                 :             : 
     151         [ +  - ]:           1 :     Sock sock_send(s[0]);
     152         [ +  - ]:           1 :     Sock sock_recv(s[1]);
     153                 :             : 
     154                 :           2 :     std::thread receiver([&sock_recv, &timeout, &interrupt]() {
     155                 :           1 :         constexpr size_t max_data{10};
     156                 :           1 :         bool threw_as_expected{false};
     157                 :             :         // BOOST_CHECK_EXCEPTION() writes to some variables shared with the main thread which
     158                 :             :         // creates a data race. So mimic it manually.
     159                 :           1 :         try {
     160         [ -  + ]:           1 :             (void)sock_recv.RecvUntilTerminator('\n', timeout, interrupt, max_data);
     161         [ -  + ]:           1 :         } catch (const std::runtime_error& e) {
     162         [ +  - ]:           1 :             threw_as_expected = HasReason("too many bytes without a terminator")(e);
     163                 :           1 :         }
     164         [ -  + ]:           1 :         assert(threw_as_expected);
     165         [ +  - ]:           2 :     });
     166                 :             : 
     167   [ +  -  +  -  :           2 :     BOOST_REQUIRE_NO_THROW(sock_send.SendComplete("1234567", timeout, interrupt));
          +  -  -  -  -  
                -  -  - ]
     168   [ +  -  +  -  :           2 :     BOOST_REQUIRE_NO_THROW(sock_send.SendComplete("89a\n", timeout, interrupt));
          +  -  -  -  -  
                -  -  - ]
     169                 :             : 
     170         [ +  - ]:           1 :     receiver.join();
     171                 :           1 : }
     172                 :             : 
     173                 :             : #endif /* WIN32 */
     174                 :             : 
     175                 :             : BOOST_AUTO_TEST_SUITE_END()
        

Generated by: LCOV version 2.0-1