]> git.ipfire.org Git - thirdparty/openssl.git/blob - test/quic_ackm_test.c
projects / thirdparty / openssl.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
QUIC ACK Manager, Statistics Manager and Congestion Control API
[thirdparty/openssl.git] / test / quic_ackm_test.c
1 /*
2 * Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
3 *
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
10 #include "testutil.h"
11 #include <openssl/ssl.h>
12 #include "internal/quic_ackm.h"
13 #include "internal/quic_cc.h"
14
15 static OSSL_TIME fake_time = 0;
16
17 #define TIME_BASE (123 * OSSL_TIME_SECOND)
18
19 static OSSL_TIME fake_now(void *arg)
20 {
21 return fake_time;
22 }
23
24 struct pkt_info {
25 OSSL_ACKM_TX_PKT *pkt;
26 int lost, acked, discarded;
27 };
28
29 static void on_lost(void *arg)
30 {
31 struct pkt_info *info = arg;
32 ++info->lost;
33 }
34
35 static void on_acked(void *arg)
36 {
37 struct pkt_info *info = arg;
38 ++info->acked;
39 }
40
41 static void on_discarded(void *arg)
42 {
43 struct pkt_info *info = arg;
44 ++info->discarded;
45 }
46
47 struct helper {
48 OSSL_ACKM *ackm;
49 struct pkt_info *pkts;
50 size_t num_pkts;
51 OSSL_CC_DATA *ccdata;
52 OSSL_STATM statm;
53 int have_statm;
54 };
55
56 static void helper_destroy(struct helper *h)
57 {
58 size_t i;
59
60 if (h->ackm != NULL) {
61 ossl_ackm_free(h->ackm);
62 h->ackm = NULL;
63 }
64
65 if (h->ccdata != NULL) {
66 ossl_cc_dummy_method.free(h->ccdata);
67 h->ccdata = NULL;
68 }
69
70 if (h->have_statm) {
71 ossl_statm_destroy(&h->statm);
72 h->have_statm = 0;
73 }
74
75 if (h->pkts != NULL) {
76 for (i = 0; i < h->num_pkts; ++i) {
77 OPENSSL_free(h->pkts[i].pkt);
78 h->pkts[i].pkt = NULL;
79 }
80
81 OPENSSL_free(h->pkts);
82 h->pkts = NULL;
83 }
84 }
85
86 static int helper_init(struct helper *h, size_t num_pkts)
87 {
88 int rc = 0;
89
90 memset(h, 0, sizeof(*h));
91
92 fake_time = TIME_BASE;
93
94 /* Initialise statistics tracker. */
95 if (!TEST_int_eq(ossl_statm_init(&h->statm), 1))
96 goto err;
97
98 h->have_statm = 1;
99
100 /* Initialise congestion controller. */
101 h->ccdata = ossl_cc_dummy_method.new(NULL, NULL, NULL);
102 if (!TEST_ptr(h->ccdata))
103 goto err;
104
105 /* Initialise ACK manager. */
106 h->ackm = ossl_ackm_new(fake_now, NULL, &h->statm,
107 &ossl_cc_dummy_method, h->ccdata);
108 if (!TEST_ptr(h->ackm))
109 goto err;
110
111 /* Allocate our array of packet information. */
112 h->num_pkts = num_pkts;
113 if (num_pkts > 0) {
114 h->pkts = OPENSSL_zalloc(sizeof(struct pkt_info) * num_pkts);
115 if (!TEST_ptr(h->pkts))
116 goto err;
117 } else {
118 h->pkts = NULL;
119 }
120
121 rc = 1;
122 err:
123 if (rc == 0)
124 helper_destroy(h);
125
126 return rc;
127 }
128
129 static const QUIC_PN linear_20[] = {
130 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19
131 };
132
133 static const QUIC_PN high_linear_20[] = {
134 1000, 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008,
135 1009, 1010, 1011, 1012, 1013, 1014, 1015, 1016, 1017,
136 1018, 1019
137 };
138
139 /*
140 * TX ACK (Packet Threshold) Test Cases
141 * ******************************************************************
142 */
143 struct tx_ack_test_case {
144 const QUIC_PN *pn_table;
145 size_t pn_table_len;
146 const OSSL_QUIC_ACK_RANGE *ack_ranges;
147 size_t num_ack_ranges;
148 const char *expect_ack; /* 1=ack, 2=lost, 4=discarded */
149 };
150
151 #define DEFINE_TX_ACK_CASE(n, pntable) \
152 static const struct tx_ack_test_case tx_ack_case_##n = { \
153 (pntable), OSSL_NELEM(pntable), \
154 tx_ack_range_##n, OSSL_NELEM(tx_ack_range_##n), \
155 tx_ack_expect_##n \
156 }
157
158 /* One range, partial coverage of space */
159 static const OSSL_QUIC_ACK_RANGE tx_ack_range_1[] = {
160 { 0, 10 },
161 };
162 static const char tx_ack_expect_1[] = {
163 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0
164 };
165 DEFINE_TX_ACK_CASE(1, linear_20);
166
167 /* Two ranges, partial coverage of space, overlapping by 1 */
168 static const OSSL_QUIC_ACK_RANGE tx_ack_range_2[] = {
169 { 5, 10 }, { 0, 5 }
170 };
171 static const char tx_ack_expect_2[] = {
172 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0
173 };
174 DEFINE_TX_ACK_CASE(2, linear_20);
175
176 /* Two ranges, partial coverage of space, together contiguous */
177 static const OSSL_QUIC_ACK_RANGE tx_ack_range_3[] = {
178 { 6, 10 }, { 0, 5 }
179 };
180 static const char tx_ack_expect_3[] = {
181 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0
182 };
183 DEFINE_TX_ACK_CASE(3, linear_20);
184
185 /*
186 * Two ranges, partial coverage of space, non-contiguous by 1
187 * Causes inferred loss due to packet threshold being exceeded.
188 */
189 static const OSSL_QUIC_ACK_RANGE tx_ack_range_4[] = {
190 { 7, 10 }, { 0, 5 }
191 };
192 static const char tx_ack_expect_4[] = {
193 1, 1, 1, 1, 1, 1, 2, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0
194 };
195 DEFINE_TX_ACK_CASE(4, linear_20);
196
197 /*
198 * Two ranges, partial coverage of space, non-contiguous by 2
199 * Causes inferred loss due to packet threshold being exceeded.
200 */
201 static const OSSL_QUIC_ACK_RANGE tx_ack_range_5[] = {
202 { 7, 10 }, { 0, 4 }
203 };
204 static const char tx_ack_expect_5[] = {
205 1, 1, 1, 1, 1, 2, 2, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0
206 };
207 DEFINE_TX_ACK_CASE(5, linear_20);
208
209 /* One range, covering entire space */
210 static const OSSL_QUIC_ACK_RANGE tx_ack_range_6[] = {
211 { 0, 20 },
212 };
213 static const char tx_ack_expect_6[] = {
214 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
215 };
216 DEFINE_TX_ACK_CASE(6, linear_20);
217
218 /* One range, covering more space than exists */
219 static const OSSL_QUIC_ACK_RANGE tx_ack_range_7[] = {
220 { 0, 30 },
221 };
222 static const char tx_ack_expect_7[] = {
223 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
224 };
225 DEFINE_TX_ACK_CASE(7, linear_20);
226
227 /* One range, covering nothing (too high) */
228 static const OSSL_QUIC_ACK_RANGE tx_ack_range_8[] = {
229 { 21, 30 },
230 };
231 static const char tx_ack_expect_8[] = {
232 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
233 };
234 DEFINE_TX_ACK_CASE(8, linear_20);
235
236 /* One range, covering nothing (too low) */
237 static const OSSL_QUIC_ACK_RANGE tx_ack_range_9[] = {
238 { 0, 999 },
239 };
240 static const char tx_ack_expect_9[] = {
241 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
242 };
243 DEFINE_TX_ACK_CASE(9, high_linear_20);
244
245 /* One single packet at start of PN set */
246 static const OSSL_QUIC_ACK_RANGE tx_ack_range_10[] = {
247 { 0, 0 },
248 };
249 static const char tx_ack_expect_10[] = {
250 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
251 };
252 DEFINE_TX_ACK_CASE(10, linear_20);
253
254 /*
255 * One single packet in middle of PN set
256 * Causes inferred loss of one packet due to packet threshold being exceeded,
257 * but several other previous packets survive as they are under the threshold.
258 */
259 static const OSSL_QUIC_ACK_RANGE tx_ack_range_11[] = {
260 { 3, 3 },
261 };
262 static const char tx_ack_expect_11[] = {
263 2, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
264 };
265 DEFINE_TX_ACK_CASE(11, linear_20);
266
267 /*
268 * One single packet at end of PN set
269 * Causes inferred loss due to packet threshold being exceeded.
270 */
271 static const OSSL_QUIC_ACK_RANGE tx_ack_range_12[] = {
272 { 19, 19 },
273 };
274 static const char tx_ack_expect_12[] = {
275 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 0, 0, 1
276 };
277 DEFINE_TX_ACK_CASE(12, linear_20);
278
279 /*
280 * Mixed straddling
281 * Causes inferred loss due to packet threshold being exceeded.
282 */
283 static const OSSL_QUIC_ACK_RANGE tx_ack_range_13[] = {
284 { 1008, 1008 }, { 1004, 1005 }, { 1001, 1002 }
285 };
286 static const char tx_ack_expect_13[] = {
287 2, 1, 1, 2, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
288 };
289 DEFINE_TX_ACK_CASE(13, high_linear_20);
290
291 static const struct tx_ack_test_case *const tx_ack_cases[] = {
292 &tx_ack_case_1,
293 &tx_ack_case_2,
294 &tx_ack_case_3,
295 &tx_ack_case_4,
296 &tx_ack_case_5,
297 &tx_ack_case_6,
298 &tx_ack_case_7,
299 &tx_ack_case_8,
300 &tx_ack_case_9,
301 &tx_ack_case_10,
302 &tx_ack_case_11,
303 &tx_ack_case_12,
304 &tx_ack_case_13,
305 };
306
307 enum {
308 MODE_ACK, MODE_DISCARD, MODE_PTO, MODE_NUM
309 };
310
311 static int test_probe_counts(const OSSL_ACKM_PROBE_INFO *p,
312 uint32_t handshake,
313 uint32_t padded_initial,
314 uint32_t pto_initial,
315 uint32_t pto_handshake,
316 uint32_t pto_app)
317 {
318 if (!TEST_uint_eq(p->handshake, handshake))
319 return 0;
320 if (!TEST_uint_eq(p->padded_initial, padded_initial))
321 return 0;
322 if (!TEST_uint_eq(p->pto[QUIC_PN_SPACE_INITIAL], pto_initial))
323 return 0;
324 if (!TEST_uint_eq(p->pto[QUIC_PN_SPACE_HANDSHAKE], pto_handshake))
325 return 0;
326 if (!TEST_uint_eq(p->pto[QUIC_PN_SPACE_APP], pto_app))
327 return 0;
328 return 1;
329 }
330
331 static void on_loss_detection_deadline_callback(OSSL_TIME deadline, void *arg)
332 {
333 *(OSSL_TIME *)arg = deadline;
334 }
335
336 static int test_tx_ack_case_actual(int tidx, int space, int mode)
337 {
338 int testresult = 0;
339 struct helper h;
340 size_t i;
341 OSSL_ACKM_TX_PKT *tx;
342 const struct tx_ack_test_case *c = tx_ack_cases[tidx];
343 OSSL_QUIC_FRAME_ACK ack = {0};
344 OSSL_TIME loss_detection_deadline = OSSL_TIME_ZERO;
345
346 /* Cannot discard app space, so skip this */
347 if (mode == MODE_DISCARD && space == QUIC_PN_SPACE_APP) {
348 TEST_skip("skipping test for app space");
349 return 1;
350 }
351
352 if (!TEST_int_eq(helper_init(&h, c->pn_table_len), 1))
353 goto err;
354
355 /* Arm callback. */
356 ossl_ackm_set_loss_detection_deadline_callback(h.ackm,
357 on_loss_detection_deadline_callback,
358 &loss_detection_deadline);
359
360 /* Allocate TX packet structures. */
361 for (i = 0; i < c->pn_table_len; ++i) {
362 h.pkts[i].pkt = tx = OPENSSL_zalloc(sizeof(*tx));
363 if (!TEST_ptr(tx))
364 goto err;
365
366 tx->pkt_num = c->pn_table[i];
367 tx->pkt_space = space;
368 tx->is_inflight = 1;
369 tx->is_ack_eliciting = 1;
370 tx->num_bytes = 123;
371 tx->largest_acked = QUIC_PN_INVALID;
372 tx->on_lost = on_lost;
373 tx->on_acked = on_acked;
374 tx->on_discarded = on_discarded;
375 tx->cb_arg = &h.pkts[i];
376
377 tx->time = fake_time;
378
379 if (!TEST_int_eq(ossl_ackm_on_tx_packet(h.ackm, tx), 1))
380 goto err;
381 }
382
383 if (mode == MODE_DISCARD) {
384 /* Try discarding. */
385 if (!TEST_int_eq(ossl_ackm_on_pkt_space_discarded(h.ackm, space), 1))
386 goto err;
387
388 /* Check all discard callbacks were called. */
389 for (i = 0; i < c->pn_table_len; ++i) {
390 if (!TEST_int_eq(h.pkts[i].acked, 0))
391 goto err;
392 if (!TEST_int_eq(h.pkts[i].lost, 0))
393 goto err;
394 if (!TEST_int_eq(h.pkts[i].discarded, 1))
395 goto err;
396 }
397 } else if (mode == MODE_ACK) {
398 /* Try acknowledging. */
399 ack.ack_ranges = (OSSL_QUIC_ACK_RANGE *)c->ack_ranges;
400 ack.num_ack_ranges = c->num_ack_ranges;
401 if (!TEST_int_eq(ossl_ackm_on_rx_ack_frame(h.ackm, &ack, space, fake_time), 1))
402 goto err;
403
404 /* Check correct ranges were acknowledged. */
405 for (i = 0; i < c->pn_table_len; ++i) {
406 if (!TEST_int_eq(h.pkts[i].acked,
407 (c->expect_ack[i] & 1) != 0 ? 1 : 0))
408 goto err;
409 if (!TEST_int_eq(h.pkts[i].lost,
410 (c->expect_ack[i] & 2) != 0 ? 1 : 0))
411 goto err;
412 if (!TEST_int_eq(h.pkts[i].discarded,
413 (c->expect_ack[i] & 4) != 0 ? 1 : 0))
414 goto err;
415 }
416 } else if (mode == MODE_PTO) {
417 OSSL_TIME deadline = ossl_ackm_get_loss_detection_deadline(h.ackm);
418 OSSL_ACKM_PROBE_INFO probe = {0};
419
420 if (!TEST_true(deadline == loss_detection_deadline))
421 goto err;
422
423 /* We should have a PTO deadline. */
424 if (!TEST_true(deadline > fake_time))
425 goto err;
426
427 /* Should not have any probe requests yet. */
428 if (!TEST_int_eq(ossl_ackm_get_probe_request(h.ackm, 0, &probe), 1))
429 goto err;
430
431 if (!TEST_int_eq(test_probe_counts(&probe, 0, 0, 0, 0, 0), 1))
432 goto err;
433
434 /*
435 * If in app space, confirm handshake, as this is necessary to enable
436 * app space PTO probe requests.
437 */
438 if (space == QUIC_PN_SPACE_APP)
439 if (!TEST_int_eq(ossl_ackm_on_handshake_confirmed(h.ackm), 1))
440 goto err;
441
442 /* Advance to the PTO deadline. */
443 fake_time = deadline + 1;
444
445 if (!TEST_int_eq(ossl_ackm_on_timeout(h.ackm), 1))
446 goto err;
447
448 /* Should have a probe request. Not cleared by first call. */
449 for (i = 0; i < 3; ++i) {
450 if (!TEST_int_eq(ossl_ackm_get_probe_request(h.ackm, i > 0, &probe), 1))
451 goto err;
452
453 if (i == 2) {
454 if (!TEST_int_eq(test_probe_counts(&probe, 0, 0, 0, 0, 0), 1))
455 goto err;
456 } else {
457 if (!TEST_int_eq(test_probe_counts(&probe, 0, 0,
458 space == QUIC_PN_SPACE_INITIAL,
459 space == QUIC_PN_SPACE_HANDSHAKE,
460 space == QUIC_PN_SPACE_APP), 1))
461 goto err;
462 }
463 }
464
465 } else
466 goto err;
467
468 testresult = 1;
469 err:
470 helper_destroy(&h);
471 return testresult;
472 }
473
474 /*
475 * TX ACK (Time Threshold) Test
476 * ******************************************************************
477 */
478 enum {
479 TX_ACK_TIME_OP_END,
480 TX_ACK_TIME_OP_PKT, /* TX packets */
481 TX_ACK_TIME_OP_ACK, /* Synthesise incoming ACK of single PN range */
482 TX_ACK_TIME_OP_EXPECT /* Ack/loss assertion */
483 };
484
485 struct tx_ack_time_op {
486 int kind;
487 OSSL_TIME time_advance; /* all ops */
488 QUIC_PN pn; /* PKT, ACK */
489 size_t num_pn; /* PKT, ACK */
490 const char *expect; /* 1=ack, 2=lost, 4=discarded */
491 };
492
493 #define TX_OP_PKT(advance, pn, num_pn) \
494 { TX_ACK_TIME_OP_PKT, (advance) * OSSL_TIME_MS, (pn), (num_pn), NULL },
495 #define TX_OP_ACK(advance, pn, num_pn) \
496 { TX_ACK_TIME_OP_ACK, (advance) * OSSL_TIME_MS, (pn), (num_pn), NULL },
497 #define TX_OP_EXPECT(expect) \
498 { TX_ACK_TIME_OP_EXPECT, 0, 0, 0, (expect) },
499 #define TX_OP_END { TX_ACK_TIME_OP_END }
500
501 static const char tx_ack_time_script_1_expect[] = {
502 2, 1
503 };
504
505 static const struct tx_ack_time_op tx_ack_time_script_1[] = {
506 TX_OP_PKT ( 0, 0, 1)
507 TX_OP_PKT (3600000, 1, 1)
508 TX_OP_ACK ( 1000, 1, 1)
509 TX_OP_EXPECT(tx_ack_time_script_1_expect)
510 TX_OP_END
511 };
512
513 static const struct tx_ack_time_op *const tx_ack_time_scripts[] = {
514 tx_ack_time_script_1,
515 };
516
517 static int test_tx_ack_time_script(int tidx)
518 {
519 int testresult = 0;
520 struct helper h;
521 OSSL_ACKM_TX_PKT *tx = NULL;
522 OSSL_QUIC_FRAME_ACK ack = {0};
523 OSSL_QUIC_ACK_RANGE ack_range = {0};
524 size_t i, num_pkts = 0, pkt_idx = 0;
525 const struct tx_ack_time_op *script = tx_ack_time_scripts[tidx], *s;
526
527 /* Calculate number of packets. */
528 for (s = script; s->kind != TX_ACK_TIME_OP_END; ++s)
529 if (s->kind == TX_ACK_TIME_OP_PKT)
530 num_pkts += s->num_pn;
531
532 /* Initialise ACK manager and packet structures. */
533 if (!TEST_int_eq(helper_init(&h, num_pkts), 1))
534 goto err;
535
536 for (i = 0; i < num_pkts; ++i) {
537 h.pkts[i].pkt = tx = OPENSSL_zalloc(sizeof(*tx));
538 if (!TEST_ptr(tx))
539 goto err;
540 }
541
542 /* Run script. */
543 for (s = script; s->kind != TX_ACK_TIME_OP_END; ++s)
544 switch (s->kind) {
545 case TX_ACK_TIME_OP_PKT:
546 for (i = 0; i < s->num_pn; ++i) {
547 tx = h.pkts[pkt_idx + i].pkt;
548
549 tx->pkt_num = s->pn + i;
550 tx->pkt_space = QUIC_PN_SPACE_INITIAL;
551 tx->num_bytes = 123;
552 tx->largest_acked = QUIC_PN_INVALID;
553 tx->is_inflight = 1;
554 tx->is_ack_eliciting = 1;
555 tx->on_lost = on_lost;
556 tx->on_acked = on_acked;
557 tx->on_discarded = on_discarded;
558 tx->cb_arg = &h.pkts[pkt_idx + i];
559
560 fake_time += s->time_advance;
561 tx->time = fake_time;
562
563 if (!TEST_int_eq(ossl_ackm_on_tx_packet(h.ackm, tx), 1))
564 goto err;
565 }
566
567 pkt_idx += s->num_pn;
568 break;
569
570 case TX_ACK_TIME_OP_ACK:
571 ack.ack_ranges = &ack_range;
572 ack.num_ack_ranges = 1;
573
574 ack_range.start = s->pn;
575 ack_range.end = s->pn + s->num_pn;
576
577 fake_time += s->time_advance;
578
579 if (!TEST_int_eq(ossl_ackm_on_rx_ack_frame(h.ackm, &ack,
580 QUIC_PN_SPACE_INITIAL,
581 fake_time), 1))
582 goto err;
583
584 break;
585
586 case TX_ACK_TIME_OP_EXPECT:
587 for (i = 0; i < num_pkts; ++i) {
588 if (!TEST_int_eq(h.pkts[i].acked,
589 (s->expect[i] & 1) != 0 ? 1 : 0))
590 goto err;
591 if (!TEST_int_eq(h.pkts[i].lost,
592 (s->expect[i] & 2) != 0 ? 1 : 0))
593 goto err;
594 if (!TEST_int_eq(h.pkts[i].discarded,
595 (s->expect[i] & 4) != 0 ? 1 : 0))
596 goto err;
597 }
598
599 break;
600 }
601
602 testresult = 1;
603 err:
604 helper_destroy(&h);
605 return testresult;
606 }
607
608 /*
609 * RX ACK Test
610 * ******************************************************************
611 */
612 enum {
613 RX_OPK_END,
614 RX_OPK_PKT, /* RX packet */
615 RX_OPK_CHECK_UNPROC, /* check PNs unprocessable */
616 RX_OPK_CHECK_PROC, /* check PNs processable */
617 RX_OPK_CHECK_STATE, /* check is_desired/deadline */
618 RX_OPK_CHECK_ACKS, /* check ACK ranges */
619 RX_OPK_TX, /* TX packet */
620 RX_OPK_RX_ACK /* RX ACK frame */
621 };
622
623 struct rx_test_op {
624 int kind;
625 OSSL_TIME time_advance;
626
627 QUIC_PN pn; /* PKT, CHECK_(UN)PROC, TX, RX_ACK */
628 size_t num_pn; /* PKT, CHECK_(UN)PROC, TX, RX_ACK */
629
630 char expect_desired; /* CHECK_STATE */
631 char expect_deadline; /* CHECK_STATE */
632
633 const OSSL_QUIC_ACK_RANGE *ack_ranges; /* CHECK_ACKS */
634 size_t num_ack_ranges; /* CHECK_ACKS */
635
636 QUIC_PN largest_acked; /* TX */
637 };
638
639 #define RX_OP_PKT(advance, pn, num_pn) \
640 { \
641 RX_OPK_PKT, (advance) * OSSL_TIME_MS, (pn), (num_pn), \
642 0, 0, NULL, 0, 0 \
643 },
644
645 #define RX_OP_CHECK_UNPROC(advance, pn, num_pn) \
646 { \
647 RX_OPK_CHECK_UNPROC, (advance) * OSSL_TIME_MS, (pn), (num_pn),\
648 0, 0, NULL, 0, 0 \
649 },
650
651 #define RX_OP_CHECK_PROC(advance, pn, num_pn) \
652 { \
653 RX_OPK_CHECK_PROC, (advance) * OSSL_TIME_MS, (pn), (num_pn), \
654 0, 0, NULL, 0, 0 \
655 },
656
657 #define RX_OP_CHECK_STATE(advance, expect_desired, expect_deadline) \
658 { \
659 RX_OPK_CHECK_STATE, (advance) * OSSL_TIME_MS, 0, 0, \
660 (expect_desired), (expect_deadline), NULL, 0, 0 \
661 },
662
663 #define RX_OP_CHECK_ACKS(advance, ack_ranges) \
664 { \
665 RX_OPK_CHECK_ACKS, (advance) * OSSL_TIME_MS, 0, 0, \
666 0, 0, (ack_ranges), OSSL_NELEM(ack_ranges), 0 \
667 },
668
669 #define RX_OP_CHECK_NO_ACKS(advance) \
670 { \
671 RX_OPK_CHECK_ACKS, (advance) * OSSL_TIME_MS, 0, 0, \
672 0, 0, NULL, 0, 0 \
673 },
674
675 #define RX_OP_TX(advance, pn, largest_acked) \
676 { \
677 RX_OPK_TX, (advance) * OSSL_TIME_MS, (pn), 1, \
678 0, 0, NULL, 0, (largest_acked) \
679 },
680
681 #define RX_OP_RX_ACK(advance, pn, num_pn) \
682 { \
683 RX_OPK_RX_ACK, (advance) * OSSL_TIME_MS, (pn), (num_pn), \
684 0, 0, NULL, 0, 0 \
685 },
686
687 #define RX_OP_END \
688 { RX_OPK_END }
689
690 /* RX 1. Simple Test with ACK Desired (Packet Threshold, Exactly) */
691 static const OSSL_QUIC_ACK_RANGE rx_ack_ranges_1a[] = {
692 { 0, 1 }
693 };
694
695 static const struct rx_test_op rx_script_1[] = {
696 RX_OP_CHECK_STATE (0, 0, 0) /* no threshold yet */
697 RX_OP_CHECK_PROC (0, 0, 3)
698
699 RX_OP_PKT (0, 0, 2) /* two packets, threshold */
700 RX_OP_CHECK_UNPROC (0, 0, 2)
701 RX_OP_CHECK_PROC (0, 2, 1)
702 RX_OP_CHECK_STATE (0, 1, 0) /* threshold met, immediate */
703 RX_OP_CHECK_ACKS (0, rx_ack_ranges_1a)
704
705 /* At this point we would generate e.g. a packet with an ACK. */
706 RX_OP_TX (0, 0, 1) /* ACKs both */
707 RX_OP_CHECK_ACKS (0, rx_ack_ranges_1a) /* not provably ACKed yet */
708 RX_OP_RX_ACK (0, 0, 1) /* TX'd packet is ACK'd */
709
710 RX_OP_CHECK_NO_ACKS (0) /* nothing more to ACK */
711 RX_OP_CHECK_UNPROC (0, 0, 2) /* still unprocessable */
712 RX_OP_CHECK_PROC (0, 2, 1) /* still processable */
713
714 RX_OP_END
715 };
716
717 /* RX 2. Simple Test with ACK Not Yet Desired (Packet Threshold) */
718 static const OSSL_QUIC_ACK_RANGE rx_ack_ranges_2a[] = {
719 { 0, 0 }
720 };
721
722 static const OSSL_QUIC_ACK_RANGE rx_ack_ranges_2b[] = {
723 { 0, 2 }
724 };
725
726 static const struct rx_test_op rx_script_2[] = {
727 RX_OP_CHECK_STATE (0, 0, 0) /* no threshold yet */
728 RX_OP_CHECK_PROC (0, 0, 3)
729
730 /* First packet always generates an ACK so get it out of the way. */
731 RX_OP_PKT (0, 0, 1)
732 RX_OP_CHECK_UNPROC (0, 0, 1)
733 RX_OP_CHECK_PROC (0, 1, 1)
734 RX_OP_CHECK_STATE (0, 1, 0) /* first packet always causes ACK */
735 RX_OP_CHECK_ACKS (0, rx_ack_ranges_2a) /* clears packet counter */
736 RX_OP_CHECK_STATE (0, 0, 0) /* desired state should have been cleared */
737
738 /* Second packet should not cause ACK-desired state */
739 RX_OP_PKT (0, 1, 1) /* just one packet, threshold is 2 */
740 RX_OP_CHECK_UNPROC (0, 0, 2)
741 RX_OP_CHECK_PROC (0, 2, 1)
742 RX_OP_CHECK_STATE (0, 0, 1) /* threshold not yet met, so deadline */
743 /* Don't check ACKs here, as it would reset our threshold counter. */
744
745 /* Now receive a second packet, triggering the threshold */
746 RX_OP_PKT (0, 2, 1) /* second packet meets threshold */
747 RX_OP_CHECK_UNPROC (0, 0, 3)
748 RX_OP_CHECK_PROC (0, 3, 1)
749 RX_OP_CHECK_STATE (0, 1, 0) /* desired immediately */
750 RX_OP_CHECK_ACKS (0, rx_ack_ranges_2b)
751
752 /* At this point we would generate e.g. a packet with an ACK. */
753 RX_OP_TX (0, 0, 2) /* ACKs all */
754 RX_OP_CHECK_ACKS (0, rx_ack_ranges_2b) /* not provably ACKed yet */
755 RX_OP_RX_ACK (0, 0, 1) /* TX'd packet is ACK'd */
756
757 RX_OP_CHECK_NO_ACKS (0) /* nothing more to ACK */
758 RX_OP_CHECK_UNPROC (0, 0, 3) /* still unprocessable */
759 RX_OP_CHECK_PROC (0, 3, 1) /* still processable */
760
761 RX_OP_END
762 };
763
764 /* RX 3. Simple Test with ACK Desired (Packet Threshold, Multiple Watermarks) */
765 static const OSSL_QUIC_ACK_RANGE rx_ack_ranges_3a[] = {
766 { 0, 0 }
767 };
768
769 static const OSSL_QUIC_ACK_RANGE rx_ack_ranges_3b[] = {
770 { 0, 10 }
771 };
772
773 static const OSSL_QUIC_ACK_RANGE rx_ack_ranges_3c[] = {
774 { 6, 10 }
775 };
776
777 static const struct rx_test_op rx_script_3[] = {
778 RX_OP_CHECK_STATE (0, 0, 0) /* no threshold yet */
779 RX_OP_CHECK_PROC (0, 0, 11)
780
781 /* First packet always generates an ACK so get it out of the way. */
782 RX_OP_PKT (0, 0, 1)
783 RX_OP_CHECK_UNPROC (0, 0, 1)
784 RX_OP_CHECK_PROC (0, 1, 1)
785 RX_OP_CHECK_STATE (0, 1, 0) /* first packet always causes ACK */
786 RX_OP_CHECK_ACKS (0, rx_ack_ranges_3a) /* clears packet counter */
787 RX_OP_CHECK_STATE (0, 0, 0) /* desired state should have been cleared */
788
789 /* Generate ten packets, exceeding the threshold. */
790 RX_OP_PKT (0, 1, 10) /* ten packets, threshold is 2 */
791 RX_OP_CHECK_UNPROC (0, 0, 11)
792 RX_OP_CHECK_PROC (0, 11, 1)
793 RX_OP_CHECK_STATE (0, 1, 0) /* threshold met, immediate */
794 RX_OP_CHECK_ACKS (0, rx_ack_ranges_3b)
795
796 /*
797 * Test TX'ing a packet which doesn't ACK anything.
798 */
799 RX_OP_TX (0, 0, QUIC_PN_INVALID)
800 RX_OP_RX_ACK (0, 0, 1)
801
802 /*
803 * At this point we would generate a packet with an ACK immediately.
804 * TX a packet which when ACKed makes [0,5] provably ACKed.
805 */
806 RX_OP_TX (0, 1, 5)
807 RX_OP_CHECK_ACKS (0, rx_ack_ranges_3b) /* not provably ACKed yet */
808 RX_OP_RX_ACK (0, 1, 1)
809
810 RX_OP_CHECK_ACKS (0, rx_ack_ranges_3c) /* provably ACKed now gone */
811 RX_OP_CHECK_UNPROC (0, 0, 11) /* still unprocessable */
812 RX_OP_CHECK_PROC (0, 11, 1) /* still processable */
813
814 /*
815 * Now TX another packet which provably ACKs the rest when ACKed.
816 */
817 RX_OP_TX (0, 2, 10)
818 RX_OP_CHECK_ACKS (0, rx_ack_ranges_3c) /* not provably ACKed yet */
819 RX_OP_RX_ACK (0, 2, 1)
820
821 RX_OP_CHECK_NO_ACKS (0) /* provably ACKed now gone */
822 RX_OP_CHECK_UNPROC (0, 0, 11) /* still unprocessable */
823 RX_OP_CHECK_PROC (0, 11, 1) /* still processable */
824
825 RX_OP_END
826 };
827
828 static const struct rx_test_op *const rx_test_scripts[] = {
829 rx_script_1,
830 rx_script_2,
831 rx_script_3
832 };
833
834 static void on_ack_deadline_callback(OSSL_TIME deadline,
835 int pkt_space, void *arg)
836 {
837 ((OSSL_TIME *)arg)[pkt_space] = deadline;
838 }
839
840 static int test_rx_ack_actual(int tidx, int space)
841 {
842 int testresult = 0;
843 struct helper h;
844 const struct rx_test_op *script = rx_test_scripts[tidx], *s;
845 size_t i, num_tx = 0, txi = 0;
846 const OSSL_QUIC_FRAME_ACK *ack;
847 OSSL_QUIC_FRAME_ACK rx_ack = {0};
848 OSSL_QUIC_ACK_RANGE rx_ack_range = {0};
849 struct pkt_info *pkts = NULL;
850 OSSL_ACKM_TX_PKT *txs = NULL, *tx;
851 OSSL_TIME ack_deadline[QUIC_PN_SPACE_NUM] = {
852 OSSL_TIME_INFINITY, OSSL_TIME_INFINITY, OSSL_TIME_INFINITY
853 };
854
855 /* Initialise ACK manager. */
856 if (!TEST_int_eq(helper_init(&h, 0), 1))
857 goto err;
858
859 /* Arm callback for testing. */
860 ossl_ackm_set_ack_deadline_callback(h.ackm, on_ack_deadline_callback,
861 ack_deadline);
862
863 /*
864 * Determine how many packets we are TXing, and therefore how many packet
865 * structures we need.
866 */
867 for (s = script; s->kind != RX_OPK_END; ++s)
868 if (s->kind == RX_OPK_TX)
869 num_tx += s->num_pn;
870
871 /* Allocate packet information structures. */
872 txs = OPENSSL_zalloc(sizeof(*txs) * num_tx);
873 if (!TEST_ptr(txs))
874 goto err;
875
876 pkts = OPENSSL_zalloc(sizeof(*pkts) * num_tx);
877 if (!TEST_ptr(pkts))
878 goto err;
879
880 /* Run script. */
881 for (s = script; s->kind != RX_OPK_END; ++s) {
882 fake_time += s->time_advance;
883 switch (s->kind) {
884 case RX_OPK_PKT:
885 for (i = 0; i < s->num_pn; ++i) {
886 OSSL_ACKM_RX_PKT pkt = {0};
887
888 pkt.pkt_num = s->pn + i;
889 pkt.time = fake_time;
890 pkt.pkt_space = space;
891 pkt.is_ack_eliciting = 1;
892
893 /* The packet should be processable before we feed it. */
894 if (!TEST_int_eq(ossl_ackm_is_rx_pn_processable(h.ackm,
895 pkt.pkt_num,
896 pkt.pkt_space), 1))
897 goto err;
898
899 if (!TEST_int_eq(ossl_ackm_on_rx_packet(h.ackm, &pkt), 1))
900 goto err;
901 }
902
903 break;
904
905 case RX_OPK_CHECK_UNPROC:
906 case RX_OPK_CHECK_PROC:
907 for (i = 0; i < s->num_pn; ++i)
908 if (!TEST_int_eq(ossl_ackm_is_rx_pn_processable(h.ackm,
909 s->pn + i, space),
910 (s->kind == RX_OPK_CHECK_PROC)))
911 goto err;
912
913 break;
914
915 case RX_OPK_CHECK_STATE:
916 if (!TEST_int_eq(ossl_ackm_is_ack_desired(h.ackm, space),
917 s->expect_desired))
918 goto err;
919
920 if (!TEST_int_eq(!ossl_time_is_infinity(ossl_ackm_get_ack_deadline(h.ackm, space))
921 && !ossl_time_is_zero(ossl_ackm_get_ack_deadline(h.ackm, space)),
922 s->expect_deadline))
923 goto err;
924
925 for (i = 0; i < QUIC_PN_SPACE_NUM; ++i) {
926 if (i != (size_t)space
927 && !TEST_true(ossl_ackm_get_ack_deadline(h.ackm, i)
928 == OSSL_TIME_INFINITY))
929 goto err;
930
931 if (!TEST_true(ossl_ackm_get_ack_deadline(h.ackm, i)
932 == ack_deadline[i]))
933 goto err;
934 }
935
936 break;
937
938 case RX_OPK_CHECK_ACKS:
939 ack = ossl_ackm_get_ack_frame(h.ackm, space);
940
941 /* Should always be able to get an ACK frame. */
942 if (!TEST_ptr(ack))
943 goto err;
944
945 if (!TEST_size_t_eq(ack->num_ack_ranges, s->num_ack_ranges))
946 goto err;
947
948 for (i = 0; i < ack->num_ack_ranges; ++i) {
949 if (!TEST_uint64_t_eq(ack->ack_ranges[i].start,
950 s->ack_ranges[i].start))
951 goto err;
952 if (!TEST_uint64_t_eq(ack->ack_ranges[i].end,
953 s->ack_ranges[i].end))
954 goto err;
955 }
956
957 break;
958
959 case RX_OPK_TX:
960 pkts[txi].pkt = tx = &txs[txi];
961
962 tx->pkt_num = s->pn;
963 tx->pkt_space = space;
964 tx->num_bytes = 123;
965 tx->largest_acked = s->largest_acked;
966 tx->is_inflight = 1;
967 tx->is_ack_eliciting = 1;
968 tx->on_lost = on_lost;
969 tx->on_acked = on_acked;
970 tx->on_discarded = on_discarded;
971 tx->cb_arg = &pkts[txi];
972 tx->time = fake_time;
973
974 if (!TEST_int_eq(ossl_ackm_on_tx_packet(h.ackm, tx), 1))
975 goto err;
976
977 ++txi;
978 break;
979
980 case RX_OPK_RX_ACK:
981 rx_ack.ack_ranges = &rx_ack_range;
982 rx_ack.num_ack_ranges = 1;
983
984 rx_ack_range.start = s->pn;
985 rx_ack_range.end = s->pn + s->num_pn - 1;
986
987 if (!TEST_int_eq(ossl_ackm_on_rx_ack_frame(h.ackm, &rx_ack,
988 space, fake_time), 1))
989 goto err;
990
991 break;
992
993 default:
994 goto err;
995 }
996 }
997
998 testresult = 1;
999 err:
1000 helper_destroy(&h);
1001 OPENSSL_free(pkts);
1002 OPENSSL_free(txs);
1003 return testresult;
1004 }
1005
1006 /*
1007 * Driver
1008 * ******************************************************************
1009 */
1010 static int test_tx_ack_case(int idx)
1011 {
1012 int tidx, space;
1013
1014 tidx = idx % OSSL_NELEM(tx_ack_cases);
1015 idx /= OSSL_NELEM(tx_ack_cases);
1016
1017 space = idx % QUIC_PN_SPACE_NUM;
1018 idx /= QUIC_PN_SPACE_NUM;
1019
1020 return test_tx_ack_case_actual(tidx, space, idx);
1021 }
1022
1023 static int test_rx_ack(int idx)
1024 {
1025 int tidx;
1026
1027 tidx = idx % OSSL_NELEM(rx_test_scripts);
1028 idx /= OSSL_NELEM(rx_test_scripts);
1029
1030 return test_rx_ack_actual(tidx, idx);
1031 }
1032
1033 int setup_tests(void)
1034 {
1035 ADD_ALL_TESTS(test_tx_ack_case,
1036 OSSL_NELEM(tx_ack_cases) * MODE_NUM * QUIC_PN_SPACE_NUM);
1037 ADD_ALL_TESTS(test_tx_ack_time_script, OSSL_NELEM(tx_ack_time_scripts));
1038 ADD_ALL_TESTS(test_rx_ack, OSSL_NELEM(rx_test_scripts) * QUIC_PN_SPACE_NUM);
1039 return 1;
1040 }
A mirror of the official openssl repository