aboutsummaryrefslogtreecommitdiff
path: root/src/tests/core/internal_network/socket_proxy.cpp
blob: 26fc65a2602dc77971f812feed05b154713cea5a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
// SPDX-FileCopyrightText: Copyright 2026 Eden Emulator Project
// SPDX-License-Identifier: GPL-3.0-or-later

#include <array>
#include <chrono>
#include <thread>

#include <catch2/catch_test_macros.hpp>

#include "common/socket_types.h"
#include "core/internal_network/socket_proxy.h"

namespace {

void BindSocket(Network::ProxySocket& socket, Network::Protocol protocol) {
    const auto type =
        protocol == Network::Protocol::TCP ? Network::Type::STREAM : Network::Type::DGRAM;
    REQUIRE(socket.Initialize(Network::Domain::INET, type, protocol) == Network::Errno::SUCCESS);
    REQUIRE(socket.Bind({.family = Network::Domain::INET,
                         .ip = {192, 168, 1, 1},
                         .portno = 35000}) == Network::Errno::SUCCESS);
}

Network::ProxyPacket MakePacket(Network::Protocol protocol) {
    Network::ProxyPacket packet{};
    packet.local_endpoint = {.family = Network::Domain::INET,
                             .ip = {192, 168, 1, 2},
                             .portno = 35000};
    packet.remote_endpoint = {.family = Network::Domain::INET,
                              .ip = {192, 168, 1, 1},
                              .portno = 35000};
    packet.protocol = protocol;
    return packet;
}

template <std::size_t N>
void QueuePacket(Network::ProxySocket& socket, Network::Protocol protocol,
                 const std::array<u8, N>& payload) {
    Network::ProxyPacket packet = MakePacket(protocol);
    packet.data.assign(payload.begin(), payload.end());
    socket.HandleProxyPacket(packet);
}

} // namespace

TEST_CASE("Room UDP sockets receive queued datagrams with recv", "[core][sockets]") {
    Network::ProxySocket socket;
    BindSocket(socket, Network::Protocol::UDP);
    REQUIRE(socket.SetNonBlock(true) == Network::Errno::SUCCESS);

    const std::array<u8, 4> payload{1, 2, 3, 4};
    QueuePacket(socket, Network::Protocol::UDP, payload);

    std::array<u8, 4> received{};
    const auto [count, error] = socket.Recv(0, received);
    REQUIRE(error == Network::Errno::SUCCESS);
    REQUIRE(count == static_cast<int>(payload.size()));
    REQUIRE(received == payload);

    const auto [empty_count, empty_error] = socket.Recv(0, received);
    REQUIRE(empty_count == -1);
    REQUIRE(empty_error == Network::Errno::AGAIN);
}

TEST_CASE("Room sockets peek without consuming", "[core][sockets]") {
    Network::ProxySocket socket;
    BindSocket(socket, Network::Protocol::UDP);
    REQUIRE(socket.SetNonBlock(true) == Network::Errno::SUCCESS);

    const std::array<u8, 4> payload{1, 2, 3, 4};
    QueuePacket(socket, Network::Protocol::UDP, payload);

    std::array<u8, 4> received{};
    REQUIRE(socket.Recv(Network::FLAG_MSG_PEEK, received) ==
            std::pair<s32, Network::Errno>{4, Network::Errno::SUCCESS});
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{4, Network::Errno::SUCCESS});
    REQUIRE(received == payload);
    REQUIRE(socket.Recv(0, received).second == Network::Errno::AGAIN);
}

TEST_CASE("Room UDP sockets truncate oversized datagrams", "[core][sockets]") {
    Network::ProxySocket socket;
    BindSocket(socket, Network::Protocol::UDP);
    REQUIRE(socket.SetNonBlock(true) == Network::Errno::SUCCESS);

    QueuePacket(socket, Network::Protocol::UDP, std::array<u8, 4>{1, 2, 3, 4});

    std::array<u8, 2> received{};
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{2, Network::Errno::SUCCESS});
    REQUIRE(received == std::array<u8, 2>{1, 2});
    REQUIRE(socket.Recv(0, received).second == Network::Errno::AGAIN);
}

TEST_CASE("Room TCP sockets keep the unread part of a packet", "[core][sockets]") {
    Network::ProxySocket socket;
    BindSocket(socket, Network::Protocol::TCP);
    REQUIRE(socket.SetNonBlock(true) == Network::Errno::SUCCESS);

    QueuePacket(socket, Network::Protocol::TCP, std::array<u8, 6>{1, 2, 3, 4, 5, 6});

    std::array<u8, 4> received{};
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{4, Network::Errno::SUCCESS});
    REQUIRE(received == std::array<u8, 4>{1, 2, 3, 4});
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{2, Network::Errno::SUCCESS});
    REQUIRE(received[0] == 5);
    REQUIRE(received[1] == 6);
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{0, Network::Errno::SUCCESS});
}

TEST_CASE("Room TCP sockets read a packet in small parts and peek at the unread part",
          "[core][sockets]") {
    Network::ProxySocket socket;
    BindSocket(socket, Network::Protocol::TCP);
    REQUIRE(socket.SetNonBlock(true) == Network::Errno::SUCCESS);

    QueuePacket(socket, Network::Protocol::TCP, std::array<u8, 5>{1, 2, 3, 4, 5});
    QueuePacket(socket, Network::Protocol::TCP, std::array<u8, 2>{6, 7});

    std::array<u8, 2> received{};
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{2, Network::Errno::SUCCESS});
    REQUIRE(received == std::array<u8, 2>{1, 2});
    REQUIRE(socket.Recv(Network::FLAG_MSG_PEEK, received) ==
            std::pair<s32, Network::Errno>{2, Network::Errno::SUCCESS});
    REQUIRE(received == std::array<u8, 2>{3, 4});
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{2, Network::Errno::SUCCESS});
    REQUIRE(received == std::array<u8, 2>{3, 4});
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{1, Network::Errno::SUCCESS});
    REQUIRE(received[0] == 5);
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{2, Network::Errno::SUCCESS});
    REQUIRE(received == std::array<u8, 2>{6, 7});
}

TEST_CASE("Room TCP sockets report an empty queue as end of stream", "[core][sockets]") {
    Network::ProxySocket socket;
    BindSocket(socket, Network::Protocol::TCP);

    std::array<u8, 4> received{};
    const auto start = std::chrono::steady_clock::now();
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{0, Network::Errno::SUCCESS});
    REQUIRE(std::chrono::steady_clock::now() - start < std::chrono::seconds{1});
}

TEST_CASE("Blocking room sockets wait for packets and time out with EAGAIN", "[core][sockets]") {
    Network::ProxySocket socket;
    BindSocket(socket, Network::Protocol::UDP);
    REQUIRE(socket.SetRcvTimeo(50) == Network::Errno::SUCCESS);

    std::array<u8, 4> received{};
    const auto start = std::chrono::steady_clock::now();
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{-1, Network::Errno::AGAIN});
    REQUIRE(std::chrono::steady_clock::now() - start >= std::chrono::milliseconds{50});

    REQUIRE(socket.SetRcvTimeo(5000) == Network::Errno::SUCCESS);
    const std::array<u8, 4> payload{1, 2, 3, 4};
    std::jthread sender([&socket, &payload] {
        std::this_thread::sleep_for(std::chrono::milliseconds{20});
        QueuePacket(socket, Network::Protocol::UDP, payload);
    });
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{4, Network::Errno::SUCCESS});
    REQUIRE(received == payload);
}

TEST_CASE("Closing a room socket wakes a blocked recv and drops queued packets", "[core][sockets]") {
    Network::ProxySocket socket;
    BindSocket(socket, Network::Protocol::UDP);
    REQUIRE(socket.SetRcvTimeo(5000) == Network::Errno::SUCCESS);

    std::array<u8, 4> received{};
    const auto start = std::chrono::steady_clock::now();
    std::jthread closer([&socket] {
        std::this_thread::sleep_for(std::chrono::milliseconds{20});
        socket.Close();
    });
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{-1, Network::Errno::BADF});
    REQUIRE(std::chrono::steady_clock::now() - start < std::chrono::seconds{1});
    closer.join();

    Network::ProxySocket queued;
    BindSocket(queued, Network::Protocol::UDP);
    QueuePacket(queued, Network::Protocol::UDP, std::array<u8, 4>{1, 2, 3, 4});
    REQUIRE(queued.Close() == Network::Errno::SUCCESS);
    QueuePacket(queued, Network::Protocol::UDP, std::array<u8, 4>{5, 6, 7, 8});
    REQUIRE(queued.Recv(0, received) == std::pair<s32, Network::Errno>{-1, Network::Errno::BADF});
}

TEST_CASE("Room stream sockets with the default protocol keep stream behavior", "[core][sockets]") {
    // socket(AF_INET, SOCK_STREAM, 0) leaves the protocol unspecified
    Network::ProxySocket socket;
    REQUIRE(socket.Initialize(Network::Domain::INET, Network::Type::STREAM,
                              Network::Protocol::Unspecified) == Network::Errno::SUCCESS);
    REQUIRE(socket.Bind({.family = Network::Domain::INET,
                         .ip = {192, 168, 1, 1},
                         .portno = 35000}) == Network::Errno::SUCCESS);
    REQUIRE(socket.SetRcvTimeo(1000) == Network::Errno::SUCCESS);

    std::array<u8, 2> received{};
    const auto start = std::chrono::steady_clock::now();
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{0, Network::Errno::SUCCESS});
    REQUIRE(std::chrono::steady_clock::now() - start < std::chrono::milliseconds{500});

    QueuePacket(socket, Network::Protocol::Unspecified, std::array<u8, 4>{1, 2, 3, 4});
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{2, Network::Errno::SUCCESS});
    REQUIRE(received == std::array<u8, 2>{1, 2});
    REQUIRE(socket.Recv(0, received) == std::pair<s32, Network::Errno>{2, Network::Errno::SUCCESS});
    REQUIRE(received == std::array<u8, 2>{3, 4});
}

TEST_CASE("One room packet wakes every blocked peek reader", "[core][sockets]") {
    Network::ProxySocket socket;
    BindSocket(socket, Network::Protocol::UDP);
    REQUIRE(socket.SetRcvTimeo(2000) == Network::Errno::SUCCESS);

    // Catch2 assertions are not thread-safe here, so the readers only record their results
    std::array<std::pair<s32, Network::Errno>, 2> results{};
    std::array<std::chrono::steady_clock::time_point, 2> finished{};
    std::chrono::steady_clock::time_point queued{};
    {
        std::array<std::jthread, 2> readers;
        for (std::size_t i = 0; i < readers.size(); ++i) {
            readers[i] = std::jthread([&socket, &results, &finished, i] {
                std::array<u8, 4> peeked{};
                results[i] = socket.Recv(Network::FLAG_MSG_PEEK, peeked);
                finished[i] = std::chrono::steady_clock::now();
            });
        }
        std::this_thread::sleep_for(std::chrono::milliseconds{50});
        queued = std::chrono::steady_clock::now();
        QueuePacket(socket, Network::Protocol::UDP, std::array<u8, 4>{1, 2, 3, 4});
    }

    for (std::size_t i = 0; i < results.size(); ++i) {
        REQUIRE(results[i] == std::pair<s32, Network::Errno>{4, Network::Errno::SUCCESS});
        REQUIRE(finished[i] - queued < std::chrono::milliseconds{1000});
    }
}

TEST_CASE("Room sockets accept only packets for their port and protocol", "[core][sockets]") {
    Network::ProxySocket socket;
    BindSocket(socket, Network::Protocol::UDP);

    REQUIRE(socket.AcceptsProxyPacket(MakePacket(Network::Protocol::UDP)));
    REQUIRE_FALSE(socket.AcceptsProxyPacket(MakePacket(Network::Protocol::TCP)));

    Network::ProxyPacket other_port = MakePacket(Network::Protocol::UDP);
    other_port.remote_endpoint.portno = 35001;
    REQUIRE_FALSE(socket.AcceptsProxyPacket(other_port));

    Network::ProxyPacket broadcast = MakePacket(Network::Protocol::UDP);
    broadcast.broadcast = true;
    REQUIRE_FALSE(socket.AcceptsProxyPacket(broadcast));
    REQUIRE(socket.SetBroadcast(true) == Network::Errno::SUCCESS);
    REQUIRE(socket.AcceptsProxyPacket(broadcast));

    REQUIRE(socket.Close() == Network::Errno::SUCCESS);
    REQUIRE_FALSE(socket.AcceptsProxyPacket(MakePacket(Network::Protocol::UDP)));
}

TEST_CASE("Native sockets accept no room packets", "[core][sockets]") {
    Network::Socket socket;
    REQUIRE_FALSE(socket.AcceptsProxyPacket(MakePacket(Network::Protocol::UDP)));
}