/src/openssl/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  | 0  | { | 
29  | 0  |     QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;  | 
30  |  | 
  | 
31  | 0  |     return ex->frame_type;  | 
32  | 0  | }  | 
33  |  |  | 
34  |  | const unsigned char *ossl_quic_cfq_item_get_encoded(const QUIC_CFQ_ITEM *item)  | 
35  | 0  | { | 
36  | 0  |     QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;  | 
37  |  | 
  | 
38  | 0  |     return ex->encoded;  | 
39  | 0  | }  | 
40  |  |  | 
41  |  | size_t ossl_quic_cfq_item_get_encoded_len(const QUIC_CFQ_ITEM *item)  | 
42  | 0  | { | 
43  | 0  |     QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;  | 
44  |  | 
  | 
45  | 0  |     return ex->encoded_len;  | 
46  | 0  | }  | 
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  | 0  | { | 
64  | 0  |     QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;  | 
65  |  | 
  | 
66  | 0  |     return (ex->flags & QUIC_CFQ_ITEM_FLAG_UNRELIABLE) != 0;  | 
67  | 0  | }  | 
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  | 0  | { | 
86  | 0  |     if (a->pn_space < b->pn_space)  | 
87  | 0  |         return -1;  | 
88  | 0  |     else if (a->pn_space > b->pn_space)  | 
89  | 0  |         return 1;  | 
90  |  |  | 
91  | 0  |     if (a->priority > b->priority)  | 
92  | 0  |         return -1;  | 
93  | 0  |     else if (a->priority < b->priority)  | 
94  | 0  |         return 1;  | 
95  |  |  | 
96  | 0  |     return 0;  | 
97  | 0  | }  | 
98  |  |  | 
99  |  | static void list_remove(QUIC_CFQ_ITEM_LIST *l, QUIC_CFQ_ITEM_EX *n)  | 
100  | 0  | { | 
101  | 0  |     if (l->head == n)  | 
102  | 0  |         l->head = n->next;  | 
103  | 0  |     if (l->tail == n)  | 
104  | 0  |         l->tail = n->prev;  | 
105  | 0  |     if (n->prev != NULL)  | 
106  | 0  |         n->prev->next = n->next;  | 
107  | 0  |     if (n->next != NULL)  | 
108  | 0  |         n->next->prev = n->prev;  | 
109  | 0  |     n->prev = n->next = NULL;  | 
110  | 0  | }  | 
111  |  |  | 
112  |  | static void list_insert_head(QUIC_CFQ_ITEM_LIST *l, QUIC_CFQ_ITEM_EX *n)  | 
113  | 0  | { | 
114  | 0  |     n->next = l->head;  | 
115  | 0  |     n->prev = NULL;  | 
116  | 0  |     l->head = n;  | 
117  | 0  |     if (n->next != NULL)  | 
118  | 0  |         n->next->prev = n;  | 
119  | 0  |     if (l->tail == NULL)  | 
120  | 0  |         l->tail = n;  | 
121  | 0  | }  | 
122  |  |  | 
123  |  | static void list_insert_tail(QUIC_CFQ_ITEM_LIST *l, QUIC_CFQ_ITEM_EX *n)  | 
124  | 0  | { | 
125  | 0  |     n->prev = l->tail;  | 
126  | 0  |     n->next = NULL;  | 
127  | 0  |     l->tail = n;  | 
128  | 0  |     if (n->prev != NULL)  | 
129  | 0  |         n->prev->next = n;  | 
130  | 0  |     if (l->head == NULL)  | 
131  | 0  |         l->head = n;  | 
132  | 0  | }  | 
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  | 0  | { | 
138  | 0  |     n->prev = ref;  | 
139  | 0  |     n->next = ref->next;  | 
140  | 0  |     if (ref->next != NULL)  | 
141  | 0  |         ref->next->prev = n;  | 
142  | 0  |     ref->next = n;  | 
143  | 0  |     if (l->tail == ref)  | 
144  | 0  |         l->tail = n;  | 
145  | 0  | }  | 
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  | 0  | { | 
151  | 0  |     QUIC_CFQ_ITEM_EX *p = l->head, *pprev = NULL;  | 
152  |  | 
  | 
153  | 0  |     if (p == NULL) { | 
154  | 0  |         l->head = l->tail = n;  | 
155  | 0  |         n->prev = n->next = NULL;  | 
156  | 0  |         return;  | 
157  | 0  |     }  | 
158  |  |  | 
159  | 0  |     for (; p != NULL && cmp(p, n) < 0; pprev = p, p = p->next);  | 
160  |  | 
  | 
161  | 0  |     if (p == NULL)  | 
162  | 0  |         list_insert_tail(l, n);  | 
163  | 0  |     else if (pprev == NULL)  | 
164  | 0  |         list_insert_head(l, n);  | 
165  | 0  |     else  | 
166  | 0  |         list_insert_after(l, pprev, n);  | 
167  | 0  | }  | 
168  |  |  | 
169  |  | QUIC_CFQ *ossl_quic_cfq_new(void)  | 
170  | 0  | { | 
171  | 0  |     QUIC_CFQ *cfq = OPENSSL_zalloc(sizeof(*cfq));  | 
172  |  | 
  | 
173  | 0  |     if (cfq == NULL)  | 
174  | 0  |         return NULL;  | 
175  |  |  | 
176  | 0  |     return cfq;  | 
177  | 0  | }  | 
178  |  |  | 
179  |  | static void clear_item(QUIC_CFQ_ITEM_EX *item)  | 
180  | 0  | { | 
181  | 0  |     if (item->free_cb != NULL) { | 
182  | 0  |         item->free_cb(item->encoded, item->encoded_len, item->free_cb_arg);  | 
183  |  | 
  | 
184  | 0  |         item->free_cb       = NULL;  | 
185  | 0  |         item->encoded       = NULL;  | 
186  | 0  |         item->encoded_len   = 0;  | 
187  | 0  |     }  | 
188  |  | 
  | 
189  | 0  |     item->state = -1;  | 
190  | 0  | }  | 
191  |  |  | 
192  |  | static void free_list_items(QUIC_CFQ_ITEM_LIST *l)  | 
193  | 0  | { | 
194  | 0  |     QUIC_CFQ_ITEM_EX *p, *pnext;  | 
195  |  | 
  | 
196  | 0  |     for (p = l->head; p != NULL; p = pnext) { | 
197  | 0  |         pnext = p->next;  | 
198  | 0  |         clear_item(p);  | 
199  | 0  |         OPENSSL_free(p);  | 
200  | 0  |     }  | 
201  | 0  | }  | 
202  |  |  | 
203  |  | void ossl_quic_cfq_free(QUIC_CFQ *cfq)  | 
204  | 0  | { | 
205  | 0  |     if (cfq == NULL)  | 
206  | 0  |         return;  | 
207  |  |  | 
208  | 0  |     free_list_items(&cfq->new_list);  | 
209  | 0  |     free_list_items(&cfq->tx_list);  | 
210  | 0  |     free_list_items(&cfq->free_list);  | 
211  | 0  |     OPENSSL_free(cfq);  | 
212  | 0  | }  | 
213  |  |  | 
214  |  | static QUIC_CFQ_ITEM_EX *cfq_get_free(QUIC_CFQ *cfq)  | 
215  | 0  | { | 
216  | 0  |     QUIC_CFQ_ITEM_EX *item = cfq->free_list.head;  | 
217  |  | 
  | 
218  | 0  |     if (item != NULL)  | 
219  | 0  |         return item;  | 
220  |  |  | 
221  | 0  |     item = OPENSSL_zalloc(sizeof(*item));  | 
222  | 0  |     if (item == NULL)  | 
223  | 0  |         return NULL;  | 
224  |  |  | 
225  | 0  |     item->state = -1;  | 
226  | 0  |     list_insert_tail(&cfq->free_list, item);  | 
227  | 0  |     return item;  | 
228  | 0  | }  | 
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  | 0  | { | 
240  | 0  |     QUIC_CFQ_ITEM_EX *item = cfq_get_free(cfq);  | 
241  |  | 
  | 
242  | 0  |     if (item == NULL)  | 
243  | 0  |         return NULL;  | 
244  |  |  | 
245  | 0  |     item->priority      = priority;  | 
246  | 0  |     item->frame_type    = frame_type;  | 
247  | 0  |     item->pn_space      = pn_space;  | 
248  | 0  |     item->encoded       = (unsigned char *)encoded;  | 
249  | 0  |     item->encoded_len   = encoded_len;  | 
250  | 0  |     item->free_cb       = free_cb;  | 
251  | 0  |     item->free_cb_arg   = free_cb_arg;  | 
252  |  | 
  | 
253  | 0  |     item->state = QUIC_CFQ_STATE_NEW;  | 
254  | 0  |     item->flags = flags;  | 
255  | 0  |     list_remove(&cfq->free_list, item);  | 
256  | 0  |     list_insert_sorted(&cfq->new_list, item, compare);  | 
257  | 0  |     return &item->public;  | 
258  | 0  | }  | 
259  |  |  | 
260  |  | void ossl_quic_cfq_mark_tx(QUIC_CFQ *cfq, QUIC_CFQ_ITEM *item)  | 
261  | 0  | { | 
262  | 0  |     QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;  | 
263  |  | 
  | 
264  | 0  |     switch (ex->state) { | 
265  | 0  |     case QUIC_CFQ_STATE_NEW:  | 
266  | 0  |         list_remove(&cfq->new_list, ex);  | 
267  | 0  |         list_insert_tail(&cfq->tx_list, ex);  | 
268  | 0  |         ex->state = QUIC_CFQ_STATE_TX;  | 
269  | 0  |         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  | 0  |     }  | 
276  | 0  | }  | 
277  |  |  | 
278  |  | void ossl_quic_cfq_mark_lost(QUIC_CFQ *cfq, QUIC_CFQ_ITEM *item,  | 
279  |  |                              uint32_t priority)  | 
280  | 0  | { | 
281  | 0  |     QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;  | 
282  |  | 
  | 
283  | 0  |     if (ossl_quic_cfq_item_is_unreliable(item)) { | 
284  | 0  |         ossl_quic_cfq_release(cfq, item);  | 
285  | 0  |         return;  | 
286  | 0  |     }  | 
287  |  |  | 
288  | 0  |     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  | 0  |     case QUIC_CFQ_STATE_TX:  | 
297  | 0  |         if (priority != UINT32_MAX)  | 
298  | 0  |             ex->priority = priority;  | 
299  | 0  |         list_remove(&cfq->tx_list, ex);  | 
300  | 0  |         list_insert_sorted(&cfq->new_list, ex, compare);  | 
301  | 0  |         ex->state = QUIC_CFQ_STATE_NEW;  | 
302  | 0  |         break;  | 
303  | 0  |     default:  | 
304  | 0  |         assert(0); /* invalid state (e.g. in free state) */  | 
305  | 0  |         break;  | 
306  | 0  |     }  | 
307  | 0  | }  | 
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  | 0  | { | 
315  | 0  |     QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;  | 
316  |  | 
  | 
317  | 0  |     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  | 0  |     case QUIC_CFQ_STATE_TX:  | 
324  | 0  |         list_remove(&cfq->tx_list, ex);  | 
325  | 0  |         list_insert_tail(&cfq->free_list, ex);  | 
326  | 0  |         clear_item(ex);  | 
327  | 0  |         break;  | 
328  | 0  |     default:  | 
329  | 0  |         assert(0); /* invalid state (e.g. in free state) */  | 
330  | 0  |         break;  | 
331  | 0  |     }  | 
332  | 0  | }  | 
333  |  |  | 
334  |  | QUIC_CFQ_ITEM *ossl_quic_cfq_get_priority_head(const QUIC_CFQ *cfq,  | 
335  |  |                                                uint32_t pn_space)  | 
336  | 0  | { | 
337  | 0  |     QUIC_CFQ_ITEM_EX *item = cfq->new_list.head;  | 
338  |  | 
  | 
339  | 0  |     for (; item != NULL && item->pn_space != pn_space; item = item->next);  | 
340  |  | 
  | 
341  | 0  |     if (item == NULL)  | 
342  | 0  |         return NULL;  | 
343  |  |  | 
344  | 0  |     return &item->public;  | 
345  | 0  | }  | 
346  |  |  | 
347  |  | QUIC_CFQ_ITEM *ossl_quic_cfq_item_get_priority_next(const QUIC_CFQ_ITEM *item,  | 
348  |  |                                                     uint32_t pn_space)  | 
349  | 0  | { | 
350  | 0  |     QUIC_CFQ_ITEM_EX *ex = (QUIC_CFQ_ITEM_EX *)item;  | 
351  |  | 
  | 
352  | 0  |     if (ex == NULL)  | 
353  | 0  |         return NULL;  | 
354  |  |  | 
355  | 0  |      ex = ex->next;  | 
356  |  | 
  | 
357  | 0  |      for (; ex != NULL && ex->pn_space != pn_space; ex = ex->next);  | 
358  |  | 
  | 
359  | 0  |      if (ex == NULL)  | 
360  | 0  |          return NULL; /* ubsan */  | 
361  |  |  | 
362  | 0  |      return &ex->public;  | 
363  | 0  | }  |