Coverage Report

Created: 2026-05-24 07:14

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl35/ssl/quic/quic_stream_map.c
Line
Count
Source
1
/*
2
 * Copyright 2022-2026 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 "internal/quic_stream_map.h"
11
#include "internal/nelem.h"
12
13
/*
14
 * QUIC Stream Map
15
 * ===============
16
 */
17
DEFINE_LHASH_OF_EX(QUIC_STREAM);
18
19
static void shutdown_flush_done(QUIC_STREAM_MAP *qsm, QUIC_STREAM *qs);
20
21
/* Circular list management. */
22
static void list_insert_tail(QUIC_STREAM_LIST_NODE *l,
23
    QUIC_STREAM_LIST_NODE *n)
24
172k
{
25
    /* Must not be in list. */
26
172k
    assert(n->prev == NULL && n->next == NULL
27
172k
        && l->prev != NULL && l->next != NULL);
28
29
172k
    n->prev = l->prev;
30
172k
    n->prev->next = n;
31
172k
    l->prev = n;
32
172k
    n->next = l;
33
172k
}
34
35
static void list_remove(QUIC_STREAM_LIST_NODE *l,
36
    QUIC_STREAM_LIST_NODE *n)
37
172k
{
38
172k
    assert(n->prev != NULL && n->next != NULL
39
172k
        && n->prev != n && n->next != n);
40
41
172k
    n->prev->next = n->next;
42
172k
    n->next->prev = n->prev;
43
172k
    n->next = n->prev = NULL;
44
172k
}
45
46
static QUIC_STREAM *list_next(QUIC_STREAM_LIST_NODE *l, QUIC_STREAM_LIST_NODE *n,
47
    size_t off)
48
78.8M
{
49
78.8M
    assert(n->prev != NULL && n->next != NULL
50
78.8M
        && (n == l || (n->prev != n && n->next != n))
51
78.8M
        && l->prev != NULL && l->next != NULL);
52
53
78.8M
    n = n->next;
54
55
78.8M
    if (n == l)
56
78.8M
        n = n->next;
57
78.8M
    if (n == l)
58
78.8M
        return NULL;
59
60
78.8M
    assert(n != NULL);
61
62
43.7k
    return (QUIC_STREAM *)(((char *)n) - off);
63
43.7k
}
64
65
43.2k
#define active_next(l, s) list_next((l), &(s)->active_node, \
66
43.2k
    offsetof(QUIC_STREAM, active_node))
67
#define accept_next(l, s) list_next((l), &(s)->accept_node, \
68
    offsetof(QUIC_STREAM, accept_node))
69
504
#define accept_head(l) list_next((l), (l), \
70
504
    offsetof(QUIC_STREAM, accept_node))
71
78.8M
#define ready_for_gc_head(l) list_next((l), (l), \
72
78.8M
    offsetof(QUIC_STREAM, ready_for_gc_node))
73
74
static unsigned long hash_stream(const QUIC_STREAM *s)
75
15.7M
{
76
15.7M
    return (unsigned long)s->id;
77
15.7M
}
78
79
static int cmp_stream(const QUIC_STREAM *a, const QUIC_STREAM *b)
80
349k
{
81
349k
    if (a->id < b->id)
82
0
        return -1;
83
349k
    if (a->id > b->id)
84
0
        return 1;
85
349k
    return 0;
86
349k
}
87
88
int ossl_quic_stream_map_init(QUIC_STREAM_MAP *qsm,
89
    uint64_t (*get_stream_limit_cb)(int uni, void *arg),
90
    void *get_stream_limit_cb_arg,
91
    QUIC_RXFC *max_streams_bidi_rxfc,
92
    QUIC_RXFC *max_streams_uni_rxfc,
93
    int is_server)
94
42.4k
{
95
42.4k
    qsm->map = lh_QUIC_STREAM_new(hash_stream, cmp_stream);
96
42.4k
    qsm->active_list.prev = qsm->active_list.next = &qsm->active_list;
97
42.4k
    qsm->accept_list.prev = qsm->accept_list.next = &qsm->accept_list;
98
42.4k
    qsm->ready_for_gc_list.prev = qsm->ready_for_gc_list.next
99
42.4k
        = &qsm->ready_for_gc_list;
100
42.4k
    qsm->rr_stepping = 1;
101
42.4k
    qsm->rr_counter = 0;
102
42.4k
    qsm->rr_cur = NULL;
103
104
42.4k
    qsm->num_accept_bidi = 0;
105
42.4k
    qsm->num_accept_uni = 0;
106
42.4k
    qsm->num_shutdown_flush = 0;
107
108
42.4k
    qsm->get_stream_limit_cb = get_stream_limit_cb;
109
42.4k
    qsm->get_stream_limit_cb_arg = get_stream_limit_cb_arg;
110
42.4k
    qsm->max_streams_bidi_rxfc = max_streams_bidi_rxfc;
111
42.4k
    qsm->max_streams_uni_rxfc = max_streams_uni_rxfc;
112
42.4k
    qsm->is_server = is_server;
113
42.4k
    return 1;
114
42.4k
}
115
116
static void release_each(QUIC_STREAM *stream, void *arg)
117
153k
{
118
153k
    QUIC_STREAM_MAP *qsm = arg;
119
120
153k
    ossl_quic_stream_map_release(qsm, stream);
121
153k
}
122
123
void ossl_quic_stream_map_cleanup(QUIC_STREAM_MAP *qsm)
124
42.4k
{
125
42.4k
    lh_QUIC_STREAM_set_down_load(qsm->map, 0);
126
42.4k
    ossl_quic_stream_map_visit(qsm, release_each, qsm);
127
128
42.4k
    lh_QUIC_STREAM_free(qsm->map);
129
42.4k
    qsm->map = NULL;
130
42.4k
}
131
132
void ossl_quic_stream_map_visit(QUIC_STREAM_MAP *qsm,
133
    void (*visit_cb)(QUIC_STREAM *stream, void *arg),
134
    void *visit_cb_arg)
135
213k
{
136
213k
    lh_QUIC_STREAM_doall_arg(qsm->map, visit_cb, visit_cb_arg);
137
213k
}
138
139
QUIC_STREAM *ossl_quic_stream_map_alloc(QUIC_STREAM_MAP *qsm,
140
    uint64_t stream_id,
141
    int type)
142
153k
{
143
153k
    QUIC_STREAM *s;
144
153k
    QUIC_STREAM key;
145
146
153k
    key.id = stream_id;
147
148
153k
    s = lh_QUIC_STREAM_retrieve(qsm->map, &key);
149
153k
    if (s != NULL)
150
0
        return NULL;
151
152
153k
    s = OPENSSL_zalloc(sizeof(*s));
153
153k
    if (s == NULL)
154
0
        return NULL;
155
156
153k
    s->id = stream_id;
157
153k
    s->type = type;
158
153k
    s->as_server = qsm->is_server;
159
153k
    s->send_state = (ossl_quic_stream_is_local_init(s)
160
148k
                        || ossl_quic_stream_is_bidi(s))
161
153k
        ? QUIC_SSTREAM_STATE_READY
162
153k
        : QUIC_SSTREAM_STATE_NONE;
163
153k
    s->recv_state = (!ossl_quic_stream_is_local_init(s)
164
5.11k
                        || ossl_quic_stream_is_bidi(s))
165
153k
        ? QUIC_RSTREAM_STATE_RECV
166
153k
        : QUIC_RSTREAM_STATE_NONE;
167
168
153k
    s->send_final_size = UINT64_MAX;
169
170
153k
    lh_QUIC_STREAM_insert(qsm->map, s);
171
153k
    return s;
172
153k
}
173
174
void ossl_quic_stream_map_release(QUIC_STREAM_MAP *qsm, QUIC_STREAM *stream)
175
160k
{
176
160k
    if (stream == NULL)
177
7.06k
        return;
178
179
153k
    if (stream->active_node.next != NULL)
180
12.8k
        list_remove(&qsm->active_list, &stream->active_node);
181
153k
    if (stream->accept_node.next != NULL)
182
140k
        list_remove(&qsm->accept_list, &stream->accept_node);
183
153k
    if (stream->ready_for_gc_node.next != NULL)
184
0
        list_remove(&qsm->ready_for_gc_list, &stream->ready_for_gc_node);
185
186
153k
    ossl_quic_sstream_free(stream->sstream);
187
153k
    stream->sstream = NULL;
188
189
153k
    ossl_quic_rstream_free(stream->rstream);
190
153k
    stream->rstream = NULL;
191
192
153k
    lh_QUIC_STREAM_delete(qsm->map, stream);
193
153k
    OPENSSL_free(stream);
194
153k
}
195
196
QUIC_STREAM *ossl_quic_stream_map_get_by_id(QUIC_STREAM_MAP *qsm,
197
    uint64_t stream_id)
198
15.2M
{
199
15.2M
    QUIC_STREAM key;
200
201
15.2M
    key.id = stream_id;
202
203
15.2M
    return lh_QUIC_STREAM_retrieve(qsm->map, &key);
204
15.2M
}
205
206
static void stream_map_mark_active(QUIC_STREAM_MAP *qsm, QUIC_STREAM *s)
207
99.6k
{
208
99.6k
    if (s->active)
209
75.0k
        return;
210
211
24.5k
    list_insert_tail(&qsm->active_list, &s->active_node);
212
213
24.5k
    if (qsm->rr_cur == NULL)
214
18.0k
        qsm->rr_cur = s;
215
216
24.5k
    s->active = 1;
217
24.5k
}
218
219
static void stream_map_mark_inactive(QUIC_STREAM_MAP *qsm, QUIC_STREAM *s)
220
1.12M
{
221
1.12M
    if (!s->active)
222
1.11M
        return;
223
224
11.7k
    if (qsm->rr_cur == s)
225
10.4k
        qsm->rr_cur = active_next(&qsm->active_list, s);
226
11.7k
    if (qsm->rr_cur == s)
227
9.02k
        qsm->rr_cur = NULL;
228
229
11.7k
    list_remove(&qsm->active_list, &s->active_node);
230
231
11.7k
    s->active = 0;
232
11.7k
}
233
234
void ossl_quic_stream_map_set_rr_stepping(QUIC_STREAM_MAP *qsm, size_t stepping)
235
0
{
236
0
    qsm->rr_stepping = stepping;
237
0
    qsm->rr_counter = 0;
238
0
}
239
240
static int stream_has_data_to_send(QUIC_STREAM *s)
241
1.13M
{
242
1.13M
    OSSL_QUIC_FRAME_STREAM shdr;
243
1.13M
    OSSL_QTX_IOVEC iov[2];
244
1.13M
    size_t num_iov;
245
1.13M
    uint64_t fc_credit, fc_swm, fc_limit;
246
247
1.13M
    switch (s->send_state) {
248
102k
    case QUIC_SSTREAM_STATE_READY:
249
149k
    case QUIC_SSTREAM_STATE_SEND:
250
149k
    case QUIC_SSTREAM_STATE_DATA_SENT:
251
        /*
252
         * We can still have data to send in DATA_SENT due to retransmissions,
253
         * etc.
254
         */
255
149k
        break;
256
983k
    default:
257
983k
        return 0; /* Nothing to send. */
258
1.13M
    }
259
260
    /*
261
     * We cannot determine if we have data to send simply by checking if
262
     * ossl_quic_txfc_get_credit() is zero, because we may also have older
263
     * stream data we need to retransmit. The SSTREAM returns older data first,
264
     * so we do a simple comparison of the next chunk the SSTREAM wants to send
265
     * against the TXFC CWM.
266
     */
267
149k
    num_iov = OSSL_NELEM(iov);
268
149k
    if (!ossl_quic_sstream_get_stream_frame(s->sstream, 0, &shdr, iov,
269
149k
            &num_iov))
270
113k
        return 0;
271
272
36.2k
    fc_credit = ossl_quic_txfc_get_credit(&s->txfc, 0);
273
36.2k
    fc_swm = ossl_quic_txfc_get_swm(&s->txfc);
274
36.2k
    fc_limit = fc_swm + fc_credit;
275
276
36.2k
    return (shdr.is_fin && shdr.len == 0) || shdr.offset < fc_limit;
277
149k
}
278
279
static ossl_unused int qsm_send_part_permits_gc(const QUIC_STREAM *qs)
280
0
{
281
0
    switch (qs->send_state) {
282
0
    case QUIC_SSTREAM_STATE_NONE:
283
0
    case QUIC_SSTREAM_STATE_DATA_RECVD:
284
0
    case QUIC_SSTREAM_STATE_RESET_RECVD:
285
0
        return 1;
286
0
    default:
287
0
        return 0;
288
0
    }
289
0
}
290
291
static int qsm_ready_for_gc(QUIC_STREAM_MAP *qsm, QUIC_STREAM *qs)
292
1.22M
{
293
1.22M
    int recv_stream_fully_drained = 0; /* TODO(QUIC FUTURE): Optimisation */
294
295
    /*
296
     * If sstream has no FIN, we auto-reset it at marked-for-deletion time, so
297
     * we don't need to worry about that here.
298
     */
299
1.22M
    assert(!qs->deleted
300
1.22M
        || !ossl_quic_stream_has_send(qs)
301
1.22M
        || ossl_quic_stream_send_is_reset(qs)
302
1.22M
        || ossl_quic_stream_send_get_final_size(qs, NULL));
303
304
1.22M
    return qs->deleted
305
12.6k
        && (!ossl_quic_stream_has_recv(qs)
306
12.6k
            || recv_stream_fully_drained
307
12.6k
            || qs->acked_stop_sending)
308
0
        && (!ossl_quic_stream_has_send(qs)
309
0
            || qs->send_state == QUIC_SSTREAM_STATE_DATA_RECVD
310
0
            || qs->send_state == QUIC_SSTREAM_STATE_RESET_RECVD);
311
1.22M
}
312
313
int ossl_quic_stream_map_is_local_allowed_by_stream_limit(QUIC_STREAM_MAP *qsm,
314
    uint64_t stream_ordinal,
315
    int is_uni)
316
74.7k
{
317
74.7k
    uint64_t stream_limit;
318
319
74.7k
    if (qsm->get_stream_limit_cb == NULL)
320
0
        return 1;
321
322
74.7k
    stream_limit = qsm->get_stream_limit_cb(is_uni, qsm->get_stream_limit_cb_arg);
323
74.7k
    return stream_ordinal < stream_limit;
324
74.7k
}
325
326
void ossl_quic_stream_map_update_state(QUIC_STREAM_MAP *qsm, QUIC_STREAM *s)
327
1.22M
{
328
1.22M
    int should_be_active, allowed_by_stream_limit = 1;
329
330
1.22M
    if (ossl_quic_stream_is_server_init(s) == qsm->is_server) {
331
66.2k
        int is_uni = !ossl_quic_stream_is_bidi(s);
332
66.2k
        uint64_t stream_ordinal = s->id >> 2;
333
334
66.2k
        allowed_by_stream_limit
335
66.2k
            = ossl_quic_stream_map_is_local_allowed_by_stream_limit(qsm,
336
66.2k
                stream_ordinal,
337
66.2k
                is_uni);
338
66.2k
    }
339
340
1.22M
    if (s->send_state == QUIC_SSTREAM_STATE_DATA_SENT
341
0
        && ossl_quic_sstream_is_totally_acked(s->sstream))
342
0
        ossl_quic_stream_map_notify_totally_acked(qsm, s);
343
1.22M
    else if (s->shutdown_flush
344
0
        && s->send_state == QUIC_SSTREAM_STATE_SEND
345
0
        && ossl_quic_sstream_is_totally_acked(s->sstream))
346
0
        shutdown_flush_done(qsm, s);
347
348
1.22M
    if (!s->ready_for_gc) {
349
1.22M
        s->ready_for_gc = qsm_ready_for_gc(qsm, s);
350
1.22M
        if (s->ready_for_gc)
351
0
            list_insert_tail(&qsm->ready_for_gc_list, &s->ready_for_gc_node);
352
1.22M
    }
353
354
1.22M
    should_be_active
355
1.22M
        = allowed_by_stream_limit
356
1.22M
        && !s->ready_for_gc
357
1.22M
        && ((ossl_quic_stream_has_recv(s)
358
1.22M
                && !ossl_quic_stream_recv_is_reset(s)
359
1.19M
                && (s->recv_state == QUIC_RSTREAM_STATE_RECV
360
1.12M
                    && (s->want_max_stream_data
361
1.11M
                        || ossl_quic_rxfc_has_cwm_changed(&s->rxfc, 0))))
362
1.21M
            || s->want_stop_sending
363
1.19M
            || s->want_reset_stream
364
1.15M
            || (!s->peer_stop_sending && stream_has_data_to_send(s)));
365
366
1.22M
    if (should_be_active)
367
99.6k
        stream_map_mark_active(qsm, s);
368
1.12M
    else
369
1.12M
        stream_map_mark_inactive(qsm, s);
370
1.22M
}
371
372
/*
373
 * Stream Send Part State Management
374
 * =================================
375
 */
376
377
int ossl_quic_stream_map_ensure_send_part_id(QUIC_STREAM_MAP *qsm,
378
    QUIC_STREAM *qs)
379
18.0k
{
380
18.0k
    switch (qs->send_state) {
381
0
    case QUIC_SSTREAM_STATE_NONE:
382
        /* Stream without send part - caller error. */
383
0
        return 0;
384
385
18.0k
    case QUIC_SSTREAM_STATE_READY:
386
        /*
387
         * We always allocate a stream ID upfront, so we don't need to do it
388
         * here.
389
         */
390
18.0k
        qs->send_state = QUIC_SSTREAM_STATE_SEND;
391
18.0k
        return 1;
392
393
0
    default:
394
        /* Nothing to do. */
395
0
        return 1;
396
18.0k
    }
397
18.0k
}
398
399
int ossl_quic_stream_map_notify_all_data_sent(QUIC_STREAM_MAP *qsm,
400
    QUIC_STREAM *qs)
401
0
{
402
0
    switch (qs->send_state) {
403
0
    default:
404
        /* Wrong state - caller error. */
405
0
    case QUIC_SSTREAM_STATE_NONE:
406
        /* Stream without send part - caller error. */
407
0
        return 0;
408
409
0
    case QUIC_SSTREAM_STATE_SEND:
410
0
        if (!ossl_quic_sstream_get_final_size(qs->sstream, &qs->send_final_size))
411
0
            return 0;
412
413
0
        qs->send_state = QUIC_SSTREAM_STATE_DATA_SENT;
414
0
        return 1;
415
0
    }
416
0
}
417
418
static void shutdown_flush_done(QUIC_STREAM_MAP *qsm, QUIC_STREAM *qs)
419
11.4k
{
420
11.4k
    if (!qs->shutdown_flush)
421
11.4k
        return;
422
423
11.4k
    assert(qsm->num_shutdown_flush > 0);
424
0
    qs->shutdown_flush = 0;
425
0
    --qsm->num_shutdown_flush;
426
0
}
427
428
int ossl_quic_stream_map_notify_totally_acked(QUIC_STREAM_MAP *qsm,
429
    QUIC_STREAM *qs)
430
0
{
431
0
    switch (qs->send_state) {
432
0
    default:
433
        /* Wrong state - caller error. */
434
0
    case QUIC_SSTREAM_STATE_NONE:
435
        /* Stream without send part - caller error. */
436
0
        return 0;
437
438
0
    case QUIC_SSTREAM_STATE_DATA_SENT:
439
0
        qs->send_state = QUIC_SSTREAM_STATE_DATA_RECVD;
440
        /*
441
         * Remember final size in case  SSL_get_stream_write_state()
442
         * gets called.
443
         */
444
0
        qs->have_final_size = ossl_quic_sstream_get_final_size(qs->sstream,
445
0
            NULL);
446
447
        /* We no longer need a QUIC_SSTREAM in this state. */
448
0
        ossl_quic_sstream_free(qs->sstream);
449
0
        qs->sstream = NULL;
450
451
0
        shutdown_flush_done(qsm, qs);
452
0
        return 1;
453
0
    }
454
0
}
455
456
int ossl_quic_stream_map_reset_stream_send_part(QUIC_STREAM_MAP *qsm,
457
    QUIC_STREAM *qs,
458
    uint64_t aec)
459
104k
{
460
104k
    switch (qs->send_state) {
461
0
    default:
462
0
    case QUIC_SSTREAM_STATE_NONE:
463
        /*
464
         * RESET_STREAM pertains to sending part only, so we cannot reset a
465
         * receive-only stream.
466
         */
467
0
    case QUIC_SSTREAM_STATE_DATA_RECVD:
468
        /*
469
         * RFC 9000 s. 3.3: A sender MUST NOT [...] send RESET_STREAM from a
470
         * terminal state. If the stream has already finished normally and the
471
         * peer has acknowledged this, we cannot reset it.
472
         */
473
0
        return 0;
474
475
14.6k
    case QUIC_SSTREAM_STATE_READY:
476
14.6k
        if (!ossl_quic_stream_map_ensure_send_part_id(qsm, qs))
477
0
            return 0;
478
479
        /* FALLTHROUGH */
480
18.0k
    case QUIC_SSTREAM_STATE_SEND:
481
        /*
482
         * If we already have a final size (e.g. because we are coming from
483
         * DATA_SENT), we have to be consistent with that, so don't change it.
484
         * If we don't already have a final size, determine a final size value.
485
         * This is the value which we will end up using for a RESET_STREAM frame
486
         * for flow control purposes. We could send the stream size (total
487
         * number of bytes appended to QUIC_SSTREAM by the application), but it
488
         * is in our interest to exclude any bytes we have not actually
489
         * transmitted yet, to avoid unnecessarily consuming flow control
490
         * credit. We can get this from the TXFC.
491
         */
492
18.0k
        qs->send_final_size = ossl_quic_txfc_get_swm(&qs->txfc);
493
494
        /* FALLTHROUGH */
495
18.0k
    case QUIC_SSTREAM_STATE_DATA_SENT:
496
18.0k
        qs->reset_stream_aec = aec;
497
18.0k
        qs->want_reset_stream = 1;
498
18.0k
        qs->send_state = QUIC_SSTREAM_STATE_RESET_SENT;
499
500
18.0k
        ossl_quic_sstream_free(qs->sstream);
501
18.0k
        qs->sstream = NULL;
502
503
18.0k
        shutdown_flush_done(qsm, qs);
504
18.0k
        ossl_quic_stream_map_update_state(qsm, qs);
505
18.0k
        return 1;
506
507
86.2k
    case QUIC_SSTREAM_STATE_RESET_SENT:
508
86.2k
    case QUIC_SSTREAM_STATE_RESET_RECVD:
509
        /*
510
         * Idempotent - no-op. In any case, do not send RESET_STREAM again - as
511
         * mentioned, we must not send it from a terminal state.
512
         */
513
86.2k
        return 1;
514
104k
    }
515
104k
}
516
517
int ossl_quic_stream_map_notify_reset_stream_acked(QUIC_STREAM_MAP *qsm,
518
    QUIC_STREAM *qs)
519
0
{
520
0
    switch (qs->send_state) {
521
0
    default:
522
        /* Wrong state - caller error. */
523
0
    case QUIC_SSTREAM_STATE_NONE:
524
        /* Stream without send part - caller error. */
525
0
        return 0;
526
527
0
    case QUIC_SSTREAM_STATE_RESET_SENT:
528
0
        qs->send_state = QUIC_SSTREAM_STATE_RESET_RECVD;
529
0
        return 1;
530
531
0
    case QUIC_SSTREAM_STATE_RESET_RECVD:
532
        /* Already in the correct state. */
533
0
        return 1;
534
0
    }
535
0
}
536
537
/*
538
 * Stream Receive Part State Management
539
 * ====================================
540
 */
541
542
int ossl_quic_stream_map_notify_size_known_recv_part(QUIC_STREAM_MAP *qsm,
543
    QUIC_STREAM *qs,
544
    uint64_t final_size)
545
8.29k
{
546
8.29k
    switch (qs->recv_state) {
547
0
    default:
548
        /* Wrong state - caller error. */
549
0
    case QUIC_RSTREAM_STATE_NONE:
550
        /* Stream without receive part - caller error. */
551
0
        return 0;
552
553
8.29k
    case QUIC_RSTREAM_STATE_RECV:
554
8.29k
        qs->recv_state = QUIC_RSTREAM_STATE_SIZE_KNOWN;
555
8.29k
        return 1;
556
8.29k
    }
557
8.29k
}
558
559
int ossl_quic_stream_map_notify_totally_received(QUIC_STREAM_MAP *qsm,
560
    QUIC_STREAM *qs)
561
3.22k
{
562
3.22k
    switch (qs->recv_state) {
563
0
    default:
564
        /* Wrong state - caller error. */
565
0
    case QUIC_RSTREAM_STATE_NONE:
566
        /* Stream without receive part - caller error. */
567
0
        return 0;
568
569
3.22k
    case QUIC_RSTREAM_STATE_SIZE_KNOWN:
570
3.22k
        qs->recv_state = QUIC_RSTREAM_STATE_DATA_RECVD;
571
3.22k
        qs->want_stop_sending = 0;
572
3.22k
        return 1;
573
3.22k
    }
574
3.22k
}
575
576
int ossl_quic_stream_map_notify_totally_read(QUIC_STREAM_MAP *qsm,
577
    QUIC_STREAM *qs)
578
676
{
579
676
    switch (qs->recv_state) {
580
0
    default:
581
        /* Wrong state - caller error. */
582
0
    case QUIC_RSTREAM_STATE_NONE:
583
        /* Stream without receive part - caller error. */
584
0
        return 0;
585
586
676
    case QUIC_RSTREAM_STATE_DATA_RECVD:
587
676
        qs->recv_state = QUIC_RSTREAM_STATE_DATA_READ;
588
589
        /* QUIC_RSTREAM is no longer needed */
590
676
        ossl_quic_rstream_free(qs->rstream);
591
676
        qs->rstream = NULL;
592
676
        return 1;
593
676
    }
594
676
}
595
596
int ossl_quic_stream_map_notify_reset_recv_part(QUIC_STREAM_MAP *qsm,
597
    QUIC_STREAM *qs,
598
    uint64_t app_error_code,
599
    uint64_t final_size)
600
7.68k
{
601
7.68k
    uint64_t prev_final_size;
602
603
7.68k
    switch (qs->recv_state) {
604
0
    default:
605
0
    case QUIC_RSTREAM_STATE_NONE:
606
        /* Stream without receive part - caller error. */
607
0
        return 0;
608
609
1.93k
    case QUIC_RSTREAM_STATE_RECV:
610
1.94k
    case QUIC_RSTREAM_STATE_SIZE_KNOWN:
611
1.95k
    case QUIC_RSTREAM_STATE_DATA_RECVD:
612
1.95k
        if (ossl_quic_stream_recv_get_final_size(qs, &prev_final_size)
613
22
            && prev_final_size != final_size)
614
            /* Cannot change previous final size. */
615
0
            return 0;
616
617
1.95k
        qs->recv_state = QUIC_RSTREAM_STATE_RESET_RECVD;
618
1.95k
        qs->peer_reset_stream_aec = app_error_code;
619
620
        /* RFC 9000 s. 3.3: No point sending STOP_SENDING if already reset. */
621
1.95k
        qs->want_stop_sending = 0;
622
623
        /* QUIC_RSTREAM is no longer needed */
624
1.95k
        ossl_quic_rstream_free(qs->rstream);
625
1.95k
        qs->rstream = NULL;
626
627
1.95k
        ossl_quic_stream_map_update_state(qsm, qs);
628
1.95k
        return 1;
629
630
0
    case QUIC_RSTREAM_STATE_DATA_READ:
631
        /*
632
         * If we already retired the FIN to the application this is moot
633
         * - just ignore.
634
         */
635
5.72k
    case QUIC_RSTREAM_STATE_RESET_RECVD:
636
5.72k
    case QUIC_RSTREAM_STATE_RESET_READ:
637
        /* Could be a reordered/retransmitted frame - just ignore. */
638
5.72k
        return 1;
639
7.68k
    }
640
7.68k
}
641
642
int ossl_quic_stream_map_notify_app_read_reset_recv_part(QUIC_STREAM_MAP *qsm,
643
    QUIC_STREAM *qs)
644
194
{
645
194
    switch (qs->recv_state) {
646
0
    default:
647
        /* Wrong state - caller error. */
648
0
    case QUIC_RSTREAM_STATE_NONE:
649
        /* Stream without receive part - caller error. */
650
0
        return 0;
651
652
194
    case QUIC_RSTREAM_STATE_RESET_RECVD:
653
194
        qs->recv_state = QUIC_RSTREAM_STATE_RESET_READ;
654
194
        return 1;
655
194
    }
656
194
}
657
658
int ossl_quic_stream_map_stop_sending_recv_part(QUIC_STREAM_MAP *qsm,
659
    QUIC_STREAM *qs,
660
    uint64_t aec)
661
11.5k
{
662
11.5k
    if (qs->stop_sending)
663
0
        return 0;
664
665
11.5k
    switch (qs->recv_state) {
666
0
    default:
667
0
    case QUIC_RSTREAM_STATE_NONE:
668
        /* Send-only stream, so this makes no sense. */
669
0
    case QUIC_RSTREAM_STATE_DATA_RECVD:
670
0
    case QUIC_RSTREAM_STATE_DATA_READ:
671
        /*
672
         * Not really any point in STOP_SENDING if we already received all data.
673
         */
674
0
    case QUIC_RSTREAM_STATE_RESET_RECVD:
675
0
    case QUIC_RSTREAM_STATE_RESET_READ:
676
        /*
677
         * RFC 9000 s. 3.5: "STOP_SENDING SHOULD only be sent for a stream that
678
         * has not been reset by the peer."
679
         *
680
         * No point in STOP_SENDING if the peer already reset their send part.
681
         */
682
0
        return 0;
683
684
9.65k
    case QUIC_RSTREAM_STATE_RECV:
685
11.5k
    case QUIC_RSTREAM_STATE_SIZE_KNOWN:
686
        /*
687
         * RFC 9000 s. 3.5: "If the stream is in the Recv or Size Known state,
688
         * the transport SHOULD signal this by sending a STOP_SENDING frame to
689
         * prompt closure of the stream in the opposite direction."
690
         *
691
         * Note that it does make sense to send STOP_SENDING for a receive part
692
         * of a stream which has a known size (because we have received a FIN)
693
         * but which still has other (previous) stream data yet to be received.
694
         */
695
11.5k
        break;
696
11.5k
    }
697
698
11.5k
    qs->stop_sending = 1;
699
11.5k
    qs->stop_sending_aec = aec;
700
11.5k
    return ossl_quic_stream_map_schedule_stop_sending(qsm, qs);
701
11.5k
}
702
703
/* Called to mark STOP_SENDING for generation, or regeneration after loss. */
704
int ossl_quic_stream_map_schedule_stop_sending(QUIC_STREAM_MAP *qsm, QUIC_STREAM *qs)
705
11.5k
{
706
11.5k
    if (!qs->stop_sending)
707
0
        return 0;
708
709
    /*
710
     * Ignore the call as a no-op if already scheduled, or in a state
711
     * where it makes no sense to send STOP_SENDING.
712
     */
713
11.5k
    if (qs->want_stop_sending)
714
0
        return 1;
715
716
11.5k
    switch (qs->recv_state) {
717
0
    default:
718
0
        return 1; /* ignore */
719
9.65k
    case QUIC_RSTREAM_STATE_RECV:
720
11.5k
    case QUIC_RSTREAM_STATE_SIZE_KNOWN:
721
        /*
722
         * RFC 9000 s. 3.5: "An endpoint is expected to send another
723
         * STOP_SENDING frame if a packet containing a previous STOP_SENDING is
724
         * lost. However, once either all stream data or a RESET_STREAM frame
725
         * has been received for the stream -- that is, the stream is in any
726
         * state other than "Recv" or "Size Known" -- sending a STOP_SENDING
727
         * frame is unnecessary."
728
         */
729
11.5k
        break;
730
11.5k
    }
731
732
11.5k
    qs->want_stop_sending = 1;
733
11.5k
    ossl_quic_stream_map_update_state(qsm, qs);
734
11.5k
    return 1;
735
11.5k
}
736
737
QUIC_STREAM *ossl_quic_stream_map_peek_accept_queue(QUIC_STREAM_MAP *qsm)
738
504
{
739
504
    return accept_head(&qsm->accept_list);
740
504
}
741
742
void ossl_quic_stream_map_push_accept_queue(QUIC_STREAM_MAP *qsm,
743
    QUIC_STREAM *s)
744
148k
{
745
148k
    list_insert_tail(&qsm->accept_list, &s->accept_node);
746
148k
    if (ossl_quic_stream_is_bidi(s))
747
40.1k
        ++qsm->num_accept_bidi;
748
107k
    else
749
107k
        ++qsm->num_accept_uni;
750
148k
}
751
752
static QUIC_RXFC *qsm_get_max_streams_rxfc(QUIC_STREAM_MAP *qsm, QUIC_STREAM *s)
753
7.53k
{
754
7.53k
    return ossl_quic_stream_is_bidi(s)
755
7.53k
        ? qsm->max_streams_bidi_rxfc
756
7.53k
        : qsm->max_streams_uni_rxfc;
757
7.53k
}
758
759
void ossl_quic_stream_map_remove_from_accept_queue(QUIC_STREAM_MAP *qsm,
760
    QUIC_STREAM *s,
761
    OSSL_TIME rtt)
762
7.53k
{
763
7.53k
    QUIC_RXFC *max_streams_rxfc;
764
765
7.53k
    list_remove(&qsm->accept_list, &s->accept_node);
766
7.53k
    if (ossl_quic_stream_is_bidi(s))
767
6.86k
        --qsm->num_accept_bidi;
768
671
    else
769
671
        --qsm->num_accept_uni;
770
771
7.53k
    if ((max_streams_rxfc = qsm_get_max_streams_rxfc(qsm, s)) != NULL)
772
7.53k
        (void)ossl_quic_rxfc_on_retire(max_streams_rxfc, 1, rtt);
773
7.53k
}
774
775
size_t ossl_quic_stream_map_get_accept_queue_len(QUIC_STREAM_MAP *qsm, int is_uni)
776
22.7k
{
777
22.7k
    return is_uni ? qsm->num_accept_uni : qsm->num_accept_bidi;
778
22.7k
}
779
780
size_t ossl_quic_stream_map_get_total_accept_queue_len(QUIC_STREAM_MAP *qsm)
781
11.3k
{
782
11.3k
    return ossl_quic_stream_map_get_accept_queue_len(qsm, /*is_uni=*/0)
783
11.3k
        + ossl_quic_stream_map_get_accept_queue_len(qsm, /*is_uni=*/1);
784
11.3k
}
785
786
void ossl_quic_stream_map_gc(QUIC_STREAM_MAP *qsm)
787
78.8M
{
788
78.8M
    QUIC_STREAM *qs;
789
790
78.8M
    while ((qs = ready_for_gc_head(&qsm->ready_for_gc_list)) != NULL) {
791
0
        ossl_quic_stream_map_release(qsm, qs);
792
0
    }
793
78.8M
}
794
795
static int eligible_for_shutdown_flush(QUIC_STREAM *qs)
796
0
{
797
    /*
798
     * We only care about servicing the send part of a stream (if any) during
799
     * shutdown flush. We make sure we flush a stream if it is either
800
     * non-terminated or was terminated normally such as via
801
     * SSL_stream_conclude. A stream which was terminated via a reset is not
802
     * flushed, and we will have thrown away the send buffer in that case
803
     * anyway.
804
     */
805
0
    switch (qs->send_state) {
806
0
    case QUIC_SSTREAM_STATE_SEND:
807
0
    case QUIC_SSTREAM_STATE_DATA_SENT:
808
0
        return !ossl_quic_sstream_is_totally_acked(qs->sstream);
809
0
    default:
810
0
        return 0;
811
0
    }
812
0
}
813
814
static void begin_shutdown_flush_each(QUIC_STREAM *qs, void *arg)
815
0
{
816
0
    QUIC_STREAM_MAP *qsm = arg;
817
818
0
    if (!eligible_for_shutdown_flush(qs) || qs->shutdown_flush)
819
0
        return;
820
821
0
    qs->shutdown_flush = 1;
822
0
    ++qsm->num_shutdown_flush;
823
0
}
824
825
void ossl_quic_stream_map_begin_shutdown_flush(QUIC_STREAM_MAP *qsm)
826
0
{
827
0
    qsm->num_shutdown_flush = 0;
828
829
0
    ossl_quic_stream_map_visit(qsm, begin_shutdown_flush_each, qsm);
830
0
}
831
832
int ossl_quic_stream_map_is_shutdown_flush_finished(QUIC_STREAM_MAP *qsm)
833
0
{
834
0
    return qsm->num_shutdown_flush == 0;
835
0
}
836
837
/*
838
 * QUIC Stream Iterator
839
 * ====================
840
 */
841
void ossl_quic_stream_iter_init(QUIC_STREAM_ITER *it, QUIC_STREAM_MAP *qsm,
842
    int advance_rr)
843
8.81M
{
844
8.81M
    it->qsm = qsm;
845
8.81M
    it->stream = it->first_stream = qsm->rr_cur;
846
8.81M
    if (advance_rr && it->stream != NULL
847
14.5k
        && ++qsm->rr_counter >= qsm->rr_stepping) {
848
14.5k
        qsm->rr_counter = 0;
849
14.5k
        qsm->rr_cur = active_next(&qsm->active_list, qsm->rr_cur);
850
14.5k
    }
851
8.81M
}
852
853
void ossl_quic_stream_iter_next(QUIC_STREAM_ITER *it)
854
18.1k
{
855
18.1k
    if (it->stream == NULL)
856
0
        return;
857
858
18.1k
    it->stream = active_next(&it->qsm->active_list, it->stream);
859
18.1k
    if (it->stream == it->first_stream)
860
14.3k
        it->stream = NULL;
861
18.1k
}