Coverage Report

Created: 2025-11-16 06:40

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl34/ssl/quic/quic_cfq.c
Line
Count
Source
1
/*
2
 * Copyright 2022-2024 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_cfq.h"
11
#include "internal/numbers.h"
12
13
typedef struct quic_cfq_item_ex_st QUIC_CFQ_ITEM_EX;
14
15
struct quic_cfq_item_ex_st {
16
    QUIC_CFQ_ITEM           public;
17
    QUIC_CFQ_ITEM_EX       *prev, *next;
18
    unsigned char          *encoded;
19
    cfq_free_cb            *free_cb;
20
    void                   *free_cb_arg;
21
    uint64_t                frame_type;
22
    size_t                  encoded_len;
23
    uint32_t                priority, pn_space, flags;
24
    int                     state;
25
};
26
27
uint64_t ossl_quic_cfq_item_get_frame_type(const QUIC_CFQ_ITEM *item)
28
186M
{
29
186M
    QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;
30
31
186M
    return ex->frame_type;
32
186M
}
33
34
const unsigned char *ossl_quic_cfq_item_get_encoded(const QUIC_CFQ_ITEM *item)
35
179M
{
36
179M
    QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;
37
38
179M
    return ex->encoded;
39
179M
}
40
41
size_t ossl_quic_cfq_item_get_encoded_len(const QUIC_CFQ_ITEM *item)
42
179M
{
43
179M
    QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;
44
45
179M
    return ex->encoded_len;
46
179M
}
47
48
int ossl_quic_cfq_item_get_state(const QUIC_CFQ_ITEM *item)
49
0
{
50
0
    QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;
51
52
0
    return ex->state;
53
0
}
54
55
uint32_t ossl_quic_cfq_item_get_pn_space(const QUIC_CFQ_ITEM *item)
56
0
{
57
0
    QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;
58
59
0
    return ex->pn_space;
60
0
}
61
62
int ossl_quic_cfq_item_is_unreliable(const QUIC_CFQ_ITEM *item)
63
52.4k
{
64
52.4k
    QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;
65
66
52.4k
    return (ex->flags & QUIC_CFQ_ITEM_FLAG_UNRELIABLE) != 0;
67
52.4k
}
68
69
typedef struct quic_cfq_item_list_st {
70
    QUIC_CFQ_ITEM_EX *head, *tail;
71
} QUIC_CFQ_ITEM_LIST;
72
73
struct quic_cfq_st {
74
    /*
75
     * Invariant: A CFQ item is always in exactly one of these lists, never more
76
     * or less than one.
77
     *
78
     * Invariant: The list the CFQ item is determined exactly by the state field
79
     * of the item.
80
     */
81
    QUIC_CFQ_ITEM_LIST                      new_list, tx_list, free_list;
82
};
83
84
static int compare(const QUIC_CFQ_ITEM_EX *a, const QUIC_CFQ_ITEM_EX *b)
85
454k
{
86
454k
    if (a->pn_space < b->pn_space)
87
0
        return -1;
88
454k
    else if (a->pn_space > b->pn_space)
89
0
        return 1;
90
91
454k
    if (a->priority > b->priority)
92
200k
        return -1;
93
253k
    else if (a->priority < b->priority)
94
1.67k
        return 1;
95
96
251k
    return 0;
97
454k
}
98
99
static void list_remove(QUIC_CFQ_ITEM_LIST *l, QUIC_CFQ_ITEM_EX *n)
100
745k
{
101
745k
    if (l->head == n)
102
505k
        l->head = n->next;
103
745k
    if (l->tail == n)
104
400k
        l->tail = n->prev;
105
745k
    if (n->prev != NULL)
106
239k
        n->prev->next = n->next;
107
745k
    if (n->next != NULL)
108
344k
        n->next->prev = n->prev;
109
745k
    n->prev = n->next = NULL;
110
745k
}
111
112
static void list_insert_head(QUIC_CFQ_ITEM_LIST *l, QUIC_CFQ_ITEM_EX *n)
113
165k
{
114
165k
    n->next = l->head;
115
165k
    n->prev = NULL;
116
165k
    l->head = n;
117
165k
    if (n->next != NULL)
118
165k
        n->next->prev = n;
119
165k
    if (l->tail == NULL)
120
0
        l->tail = n;
121
165k
}
122
123
static void list_insert_tail(QUIC_CFQ_ITEM_LIST *l, QUIC_CFQ_ITEM_EX *n)
124
721k
{
125
721k
    n->prev = l->tail;
126
721k
    n->next = NULL;
127
721k
    l->tail = n;
128
721k
    if (n->prev != NULL)
129
468k
        n->prev->next = n;
130
721k
    if (l->head == NULL)
131
252k
        l->head = n;
132
721k
}
133
134
static void list_insert_after(QUIC_CFQ_ITEM_LIST *l,
135
                              QUIC_CFQ_ITEM_EX *ref,
136
                              QUIC_CFQ_ITEM_EX *n)
137
88.2k
{
138
88.2k
    n->prev = ref;
139
88.2k
    n->next = ref->next;
140
88.2k
    if (ref->next != NULL)
141
88.2k
        ref->next->prev = n;
142
88.2k
    ref->next = n;
143
88.2k
    if (l->tail == ref)
144
0
        l->tail = n;
145
88.2k
}
146
147
static void list_insert_sorted(QUIC_CFQ_ITEM_LIST *l, QUIC_CFQ_ITEM_EX *n,
148
                               int (*cmp)(const QUIC_CFQ_ITEM_EX *a,
149
                                          const QUIC_CFQ_ITEM_EX *b))
150
266k
{
151
266k
    QUIC_CFQ_ITEM_EX *p = l->head, *pprev = NULL;
152
153
266k
    if (p == NULL) {
154
10.6k
        l->head = l->tail = n;
155
10.6k
        n->prev = n->next = NULL;
156
10.6k
        return;
157
10.6k
    }
158
159
456k
    for (; p != NULL && cmp(p, n) < 0; pprev = p, p = p->next);
160
161
255k
    if (p == NULL)
162
2.08k
        list_insert_tail(l, n);
163
253k
    else if (pprev == NULL)
164
165k
        list_insert_head(l, n);
165
88.2k
    else
166
88.2k
        list_insert_after(l, pprev, n);
167
255k
}
168
169
QUIC_CFQ *ossl_quic_cfq_new(void)
170
49.9k
{
171
49.9k
    QUIC_CFQ *cfq = OPENSSL_zalloc(sizeof(*cfq));
172
173
49.9k
    if (cfq == NULL)
174
0
        return NULL;
175
176
49.9k
    return cfq;
177
49.9k
}
178
179
static void clear_item(QUIC_CFQ_ITEM_EX *item)
180
476k
{
181
476k
    if (item->free_cb != NULL) {
182
260k
        item->free_cb(item->encoded, item->encoded_len, item->free_cb_arg);
183
184
260k
        item->free_cb       = NULL;
185
260k
        item->encoded       = NULL;
186
260k
        item->encoded_len   = 0;
187
260k
    }
188
189
476k
    item->state = -1;
190
476k
}
191
192
static void free_list_items(QUIC_CFQ_ITEM_LIST *l)
193
149k
{
194
149k
    QUIC_CFQ_ITEM_EX *p, *pnext;
195
196
389k
    for (p = l->head; p != NULL; p = pnext) {
197
240k
        pnext = p->next;
198
240k
        clear_item(p);
199
240k
        OPENSSL_free(p);
200
240k
    }
201
149k
}
202
203
void ossl_quic_cfq_free(QUIC_CFQ *cfq)
204
49.9k
{
205
49.9k
    if (cfq == NULL)
206
0
        return;
207
208
49.9k
    free_list_items(&cfq->new_list);
209
49.9k
    free_list_items(&cfq->tx_list);
210
49.9k
    free_list_items(&cfq->free_list);
211
49.9k
    OPENSSL_free(cfq);
212
49.9k
}
213
214
static QUIC_CFQ_ITEM_EX *cfq_get_free(QUIC_CFQ *cfq)
215
260k
{
216
260k
    QUIC_CFQ_ITEM_EX *item = cfq->free_list.head;
217
218
260k
    if (item != NULL)
219
20.3k
        return item;
220
221
240k
    item = OPENSSL_zalloc(sizeof(*item));
222
240k
    if (item == NULL)
223
0
        return NULL;
224
225
240k
    item->state = -1;
226
240k
    list_insert_tail(&cfq->free_list, item);
227
240k
    return item;
228
240k
}
229
230
QUIC_CFQ_ITEM *ossl_quic_cfq_add_frame(QUIC_CFQ            *cfq,
231
                                       uint32_t             priority,
232
                                       uint32_t             pn_space,
233
                                       uint64_t             frame_type,
234
                                       uint32_t             flags,
235
                                       const unsigned char *encoded,
236
                                       size_t               encoded_len,
237
                                       cfq_free_cb         *free_cb,
238
                                       void                *free_cb_arg)
239
260k
{
240
260k
    QUIC_CFQ_ITEM_EX *item = cfq_get_free(cfq);
241
242
260k
    if (item == NULL)
243
0
        return NULL;
244
245
260k
    item->priority      = priority;
246
260k
    item->frame_type    = frame_type;
247
260k
    item->pn_space      = pn_space;
248
260k
    item->encoded       = (unsigned char *)encoded;
249
260k
    item->encoded_len   = encoded_len;
250
260k
    item->free_cb       = free_cb;
251
260k
    item->free_cb_arg   = free_cb_arg;
252
253
260k
    item->state = QUIC_CFQ_STATE_NEW;
254
260k
    item->flags = flags;
255
260k
    list_remove(&cfq->free_list, item);
256
260k
    list_insert_sorted(&cfq->new_list, item, compare);
257
260k
    return &item->public;
258
260k
}
259
260
void ossl_quic_cfq_mark_tx(QUIC_CFQ *cfq, QUIC_CFQ_ITEM *item)
261
242k
{
262
242k
    QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;
263
264
242k
    switch (ex->state) {
265
242k
    case QUIC_CFQ_STATE_NEW:
266
242k
        list_remove(&cfq->new_list, ex);
267
242k
        list_insert_tail(&cfq->tx_list, ex);
268
242k
        ex->state = QUIC_CFQ_STATE_TX;
269
242k
        break;
270
0
    case QUIC_CFQ_STATE_TX:
271
0
        break; /* nothing to do */
272
0
    default:
273
0
        assert(0); /* invalid state (e.g. in free state) */
274
0
        break;
275
242k
    }
276
242k
}
277
278
void ossl_quic_cfq_mark_lost(QUIC_CFQ *cfq, QUIC_CFQ_ITEM *item,
279
                             uint32_t priority)
280
52.4k
{
281
52.4k
    QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;
282
283
52.4k
    if (ossl_quic_cfq_item_is_unreliable(item)) {
284
46.6k
        ossl_quic_cfq_release(cfq, item);
285
46.6k
        return;
286
46.6k
    }
287
288
5.80k
    switch (ex->state) {
289
0
    case QUIC_CFQ_STATE_NEW:
290
0
        if (priority != UINT32_MAX && priority != ex->priority) {
291
0
            list_remove(&cfq->new_list, ex);
292
0
            ex->priority = priority;
293
0
            list_insert_sorted(&cfq->new_list, ex, compare);
294
0
        }
295
0
        break; /* nothing to do */
296
5.80k
    case QUIC_CFQ_STATE_TX:
297
5.80k
        if (priority != UINT32_MAX)
298
0
            ex->priority = priority;
299
5.80k
        list_remove(&cfq->tx_list, ex);
300
5.80k
        list_insert_sorted(&cfq->new_list, ex, compare);
301
5.80k
        ex->state = QUIC_CFQ_STATE_NEW;
302
5.80k
        break;
303
0
    default:
304
0
        assert(0); /* invalid state (e.g. in free state) */
305
0
        break;
306
5.80k
    }
307
5.80k
}
308
309
/*
310
 * Releases a CFQ item. The item may be in either state (NEW or TX) prior to the
311
 * call. The QUIC_CFQ_ITEM pointer must not be used following this call.
312
 */
313
void ossl_quic_cfq_release(QUIC_CFQ *cfq, QUIC_CFQ_ITEM *item)
314
236k
{
315
236k
    QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;
316
317
236k
    switch (ex->state) {
318
0
    case QUIC_CFQ_STATE_NEW:
319
0
        list_remove(&cfq->new_list, ex);
320
0
        list_insert_tail(&cfq->free_list, ex);
321
0
        clear_item(ex);
322
0
        break;
323
236k
    case QUIC_CFQ_STATE_TX:
324
236k
        list_remove(&cfq->tx_list, ex);
325
236k
        list_insert_tail(&cfq->free_list, ex);
326
236k
        clear_item(ex);
327
236k
        break;
328
0
    default:
329
0
        assert(0); /* invalid state (e.g. in free state) */
330
0
        break;
331
236k
    }
332
236k
}
333
334
QUIC_CFQ_ITEM *ossl_quic_cfq_get_priority_head(const QUIC_CFQ *cfq,
335
                                               uint32_t pn_space)
336
88.7M
{
337
88.7M
    QUIC_CFQ_ITEM_EX *item = cfq->new_list.head;
338
339
176M
    for (; item != NULL && item->pn_space != pn_space; item = item->next);
340
341
88.7M
    if (item == NULL)
342
86.3M
        return NULL;
343
344
2.36M
    return &item->public;
345
88.7M
}
346
347
QUIC_CFQ_ITEM *ossl_quic_cfq_item_get_priority_next(const QUIC_CFQ_ITEM *item,
348
                                                    uint32_t pn_space)
349
186M
{
350
186M
    QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;
351
352
186M
    if (ex == NULL)
353
0
        return NULL;
354
355
186M
     ex = ex->next;
356
357
186M
     for (; ex != NULL && ex->pn_space != pn_space; ex = ex->next);
358
359
186M
     if (ex == NULL)
360
2.36M
         return NULL; /* ubsan */
361
362
183M
     return &ex->public;
363
186M
}