File: bwcontroller_test.cc

package info (click to toggle)
libtoxcore 0.2.22-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,992 kB
  • sloc: ansic: 70,235; cpp: 14,770; sh: 1,576; python: 649; makefile: 255; perl: 39
file content (378 lines) | stat: -rw-r--r-- 10,145 bytes parent folder | download
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
#include "bwcontroller.h"

#include <gtest/gtest.h>

#include <cmath>
#include <cstddef>
#include <cstdint>
#include <vector>

#include "../toxcore/attributes.h"
#include "../toxcore/logger.h"
#include "../toxcore/mono_time.h"
#include "../toxcore/network.h"
#include "../toxcore/os_memory.h"

namespace {

struct BwcTimeMock {
    std::uint64_t t;
};

std::uint64_t bwc_mock_time_cb(void *ud) { return static_cast<BwcTimeMock *>(ud)->t; }

struct MockBwcData {
    std::vector<std::vector<std::uint8_t>> sent_packets;
    std::vector<float> reported_losses;
    std::uint32_t friend_number = 0;

    static int send_packet(
        void *_Nullable user_data, const std::uint8_t *_Nonnull data, std::uint16_t length)
    {
        auto *sd = static_cast<MockBwcData *>(user_data);
        if (sd->fail_send) {
            return -1;
        }
        sd->sent_packets.emplace_back(data, data + length);
        return 0;
    }

    static void loss_report(BWController *_Nonnull /*bwc*/, std::uint32_t friend_number, float loss,
        void *_Nullable user_data)
    {
        auto *sd = static_cast<MockBwcData *>(user_data);
        sd->friend_number = friend_number;
        sd->reported_losses.push_back(loss);
    }

    bool fail_send = false;
};

class BwcTest : public ::testing::Test {
protected:
    void SetUp() override
    {
        const Memory *mem = os_memory();
        log = logger_new(mem);
        tm.t = 1000;
        mono_time = mono_time_new(mem, bwc_mock_time_cb, &tm);
        mono_time_update(mono_time);
    }

    void TearDown() override
    {
        const Memory *_Nonnull mem = os_memory();
        mono_time_free(mem, mono_time);
        logger_kill(log);
    }

    Logger *_Nullable log;
    Mono_Time *_Nullable mono_time;
    BwcTimeMock tm;
};

TEST_F(BwcTest, BasicNewKill)
{
    MockBwcData sd;
    BWController *bwc = bwc_new(
        log, 123, MockBwcData::loss_report, &sd, MockBwcData::send_packet, &sd, mono_time);
    ASSERT_NE(bwc, nullptr);
    bwc_kill(bwc);
}

TEST_F(BwcTest, SendUpdate)
{
    MockBwcData sd;
    std::uint32_t friend_number = 123;
    BWController *bwc = bwc_new(log, friend_number, MockBwcData::loss_report, &sd,
        MockBwcData::send_packet, &sd, mono_time);
    ASSERT_NE(bwc, nullptr);

    // BWC_AVG_LOSS_OVER_CYCLES_COUNT is 30
    // BWC_SEND_INTERVAL_MS is 950

    // Add some received and lost bytes
    for (int i = 0; i < 30; ++i) {
        bwc_add_recv(bwc, 1000);
    }
    bwc_add_lost(bwc, 500);

    // Should not have sent anything yet because interval not reached
    EXPECT_EQ(sd.sent_packets.size(), 0);

    // Advance time
    tm.t += 1000;
    mono_time_update(mono_time);

    // Trigger another update
    bwc_add_recv(bwc, 1000);

    ASSERT_EQ(sd.sent_packets.size(), 1);
    EXPECT_EQ(sd.sent_packets[0][0], BWC_PACKET_ID);

    // Packet contains lost (4 bytes) and recv (4 bytes)
    std::uint32_t lost, recv;
    net_unpack_u32(sd.sent_packets[0].data() + 1, &lost);
    net_unpack_u32(sd.sent_packets[0].data() + 5, &recv);

    EXPECT_EQ(lost, 500);
    EXPECT_EQ(recv, 30 * 1000 + 1000);

    bwc_kill(bwc);
}

TEST_F(BwcTest, HandlePacket)
{
    MockBwcData sd;
    std::uint32_t friend_number = 123;
    BWController *bwc = bwc_new(log, friend_number, MockBwcData::loss_report, &sd,
        MockBwcData::send_packet, &sd, mono_time);
    ASSERT_NE(bwc, nullptr);

    std::uint8_t packet[9];
    packet[0] = BWC_PACKET_ID;
    net_pack_u32(packet + 1, 100);  // lost
    net_pack_u32(packet + 5, 900);  // recv

    bwc_handle_packet(bwc, packet, sizeof(packet));

    ASSERT_EQ(sd.reported_losses.size(), 1);
    EXPECT_EQ(sd.friend_number, friend_number);
    EXPECT_FLOAT_EQ(sd.reported_losses[0], 100.0f / (100.0f + 900.0f));

    // Try sending another update too soon
    bwc_handle_packet(bwc, packet, sizeof(packet));
    EXPECT_EQ(sd.reported_losses.size(), 1);

    // Advance time
    tm.t += 1000;
    mono_time_update(mono_time);

    bwc_handle_packet(bwc, packet, sizeof(packet));
    EXPECT_EQ(sd.reported_losses.size(), 2);

    bwc_kill(bwc);
}

TEST_F(BwcTest, InvalidPacketSize)
{
    MockBwcData sd;
    BWController *bwc = bwc_new(
        log, 123, MockBwcData::loss_report, &sd, MockBwcData::send_packet, &sd, mono_time);
    std::uint8_t packet[10] = {0};

    // Correct size is 9
    bwc_handle_packet(bwc, packet, 8);
    bwc_handle_packet(bwc, packet, 10);
    EXPECT_EQ(sd.reported_losses.size(), 0);

    bwc_kill(bwc);
}

TEST_F(BwcTest, SendFailure)
{
    MockBwcData sd;
    sd.fail_send = true;
    BWController *bwc = bwc_new(
        log, 123, MockBwcData::loss_report, &sd, MockBwcData::send_packet, &sd, mono_time);

    for (int i = 0; i < 31; ++i) {
        bwc_add_recv(bwc, 1000);
    }
    bwc_add_lost(bwc, 500);
    tm.t += 1000;
    mono_time_update(mono_time);
    bwc_add_recv(bwc, 1000);

    // Send should have failed (logged, but doesn't crash)
    EXPECT_EQ(sd.sent_packets.size(), 0);

    bwc_kill(bwc);
}

TEST_F(BwcTest, NullCallback)
{
    MockBwcData sd;
    // Pass NULL for the loss report callback
    BWController *bwc
        = bwc_new(log, 123, nullptr, nullptr, MockBwcData::send_packet, &sd, mono_time);

    std::uint8_t packet[9];
    packet[0] = BWC_PACKET_ID;
    net_pack_u32(packet + 1, 100);  // lost
    net_pack_u32(packet + 5, 900);  // recv

    bwc_handle_packet(bwc, packet, sizeof(packet));

    // Should not crash, and no loss should be reported
    EXPECT_EQ(sd.reported_losses.size(), 0);

    bwc_kill(bwc);
}

TEST_F(BwcTest, ZeroLoss)
{
    MockBwcData sd;
    BWController *bwc = bwc_new(
        log, 123, MockBwcData::loss_report, &sd, MockBwcData::send_packet, &sd, mono_time);

    // 1. Peer sends update with zero loss
    std::uint8_t packet[9];
    packet[0] = BWC_PACKET_ID;
    net_pack_u32(packet + 1, 0);  // lost
    net_pack_u32(packet + 5, 1000);  // recv

    bwc_handle_packet(bwc, packet, sizeof(packet));
    EXPECT_EQ(sd.reported_losses.size(), 0);

    // 2. We have zero loss to report
    for (int i = 0; i < 31; ++i) {
        bwc_add_recv(bwc, 1000);
    }
    // No bwc_add_lost called
    tm.t += 1000;
    mono_time_update(mono_time);
    bwc_add_recv(bwc, 1000);

    // Should NOT send update if loss is 0
    EXPECT_EQ(sd.sent_packets.size(), 0);

    bwc_kill(bwc);
}

TEST_F(BwcTest, Overflow)
{
    MockBwcData sd;
    BWController *bwc = bwc_new(
        log, 123, MockBwcData::loss_report, &sd, MockBwcData::send_packet, &sd, mono_time);

    // Set lost/recv to near max to check for overflow (though they are just added)
    bwc_add_lost(bwc, 0xFFFFFFFF);
    bwc_add_recv(bwc, 0xFFFFFFFF);

    // Trigger update
    for (int i = 0; i < 32; ++i) {
        bwc_add_recv(bwc, 1);
    }
    tm.t += 1000;
    mono_time_update(mono_time);
    bwc_add_recv(bwc, 1);

    ASSERT_EQ(sd.sent_packets.size(), 1);
    std::uint32_t lost, recv;
    net_unpack_u32(sd.sent_packets[0].data() + 1, &lost);
    net_unpack_u32(sd.sent_packets[0].data() + 5, &recv);

    // 0xFFFFFFFF + 32 + 1 should wrap to 32
    EXPECT_EQ(lost, 0xFFFFFFFF);
    EXPECT_EQ(recv, 32);

    bwc_kill(bwc);
}

TEST_F(BwcTest, CycleCountThreshold)
{
    MockBwcData sd;
    BWController *bwc = bwc_new(
        log, 123, MockBwcData::loss_report, &sd, MockBwcData::send_packet, &sd, mono_time);

    // BWC_AVG_LOSS_OVER_CYCLES_COUNT is 30.
    // We need more than 30 cycles AND the time interval to pass.

    tm.t += 2000;  // Time is sufficient
    mono_time_update(mono_time);

    for (int i = 0; i < 30; ++i) {
        bwc_add_recv(bwc, 100);
        bwc_add_lost(bwc, 1);
        ASSERT_EQ(sd.sent_packets.size(), 0) << "Should not send at cycle " << i;
    }

    // 31st call to bwc_add_recv (or bwc_add_lost)
    bwc_add_recv(bwc, 100);
    EXPECT_EQ(sd.sent_packets.size(), 1);

    bwc_kill(bwc);
}

TEST_F(BwcTest, TimeIntervalStrict)
{
    MockBwcData sd;
    BWController *bwc = bwc_new(
        log, 123, MockBwcData::loss_report, &sd, MockBwcData::send_packet, &sd, mono_time);

    // Enough cycles
    for (int i = 0; i < 40; ++i) {
        bwc_add_recv(bwc, 100);
    }
    bwc_add_lost(bwc, 10);
    EXPECT_EQ(sd.sent_packets.size(), 0);  // Time not advanced

    // Advance just below 950ms
    tm.t += 949;
    mono_time_update(mono_time);
    bwc_add_recv(bwc, 100);
    EXPECT_EQ(sd.sent_packets.size(), 0);

    // Advance to 951ms (Total > 950)
    tm.t += 2;
    mono_time_update(mono_time);
    bwc_add_recv(bwc, 100);
    EXPECT_EQ(sd.sent_packets.size(), 1);

    bwc_kill(bwc);
}

TEST_F(BwcTest, RecvPlusLostOverflowBug)
{
    MockBwcData sd;
    BWController *bwc = bwc_new(
        log, 123, MockBwcData::loss_report, &sd, MockBwcData::send_packet, &sd, mono_time);
    std::uint8_t packet[9];
    packet[0] = BWC_PACKET_ID;
    net_pack_u32(packet + 1, 1);
    net_pack_u32(packet + 5, 0xFFFFFFFF);
    bwc_handle_packet(bwc, packet, sizeof(packet));
    ASSERT_EQ(sd.reported_losses.size(), 1);
    // Loss should be very small, but if it's inf or > 1.0, it's a bug
    EXPECT_LE(sd.reported_losses[0], 1.0f);
    bwc_kill(bwc);
}

TEST_F(BwcTest, RateLimitBypassBug)
{
    MockBwcData sd;
    BWController *bwc = bwc_new(
        log, 123, MockBwcData::loss_report, &sd, MockBwcData::send_packet, &sd, mono_time);
    tm.t = 0xFFFFFFF0;
    mono_time_update(mono_time);
    std::uint8_t packet[9];
    packet[0] = BWC_PACKET_ID;
    net_pack_u32(packet + 1, 1);
    net_pack_u32(packet + 5, 100);
    bwc_handle_packet(bwc, packet, sizeof(packet));
    EXPECT_EQ(sd.reported_losses.size(), 1);

    // Only 5ms passed, should be rejected
    tm.t = 0xFFFFFFF5;
    mono_time_update(mono_time);
    bwc_handle_packet(bwc, packet, sizeof(packet));
    EXPECT_EQ(sd.reported_losses.size(), 1);
    bwc_kill(bwc);
}

TEST_F(BwcTest, NoCrashOnNullSendPacket)
{
    BWController *bwc = bwc_new(log, 123, nullptr, nullptr, nullptr, nullptr, mono_time);
    for (int i = 0; i < 31; ++i) {
        bwc_add_recv(bwc, 100);
    }
    bwc_add_lost(bwc, 10);
    tm.t += 1000;
    mono_time_update(mono_time);
    // This should no longer crash
    bwc_add_recv(bwc, 100);
    bwc_kill(bwc);
}

}  // namespace