]>
Commit | Line | Data |
---|---|---|
a73078b7 HL |
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 "internal/quic_txp.h" | |
11 | #include "internal/quic_fifd.h" | |
12 | #include "internal/quic_stream_map.h" | |
96fa10f3 | 13 | #include "internal/quic_error.h" |
a73078b7 HL |
14 | #include "internal/common.h" |
15 | #include <openssl/err.h> | |
16 | ||
17 | #define MIN_CRYPTO_HDR_SIZE 3 | |
18 | ||
19 | #define MIN_FRAME_SIZE_HANDSHAKE_DONE 1 | |
20 | #define MIN_FRAME_SIZE_MAX_DATA 2 | |
21 | #define MIN_FRAME_SIZE_ACK 5 | |
22 | #define MIN_FRAME_SIZE_CRYPTO (MIN_CRYPTO_HDR_SIZE + 1) | |
23 | #define MIN_FRAME_SIZE_STREAM 3 /* minimum useful size (for non-FIN) */ | |
24 | #define MIN_FRAME_SIZE_MAX_STREAMS_BIDI 2 | |
25 | #define MIN_FRAME_SIZE_MAX_STREAMS_UNI 2 | |
26 | ||
faebafda HL |
27 | /* |
28 | * Packet Archetypes | |
29 | * ================= | |
30 | */ | |
31 | ||
32 | /* Generate normal packets containing most frame types, subject to EL. */ | |
33 | #define TX_PACKETISER_ARCHETYPE_NORMAL 0 | |
34 | ||
35 | /* | |
36 | * A probe packet is different in that: | |
37 | * - It bypasses CC, but *is* counted as in flight for purposes of CC; | |
38 | * - It must be ACK-eliciting. | |
39 | */ | |
40 | #define TX_PACKETISER_ARCHETYPE_PROBE 1 | |
41 | ||
42 | /* | |
43 | * An ACK-only packet is different in that: | |
44 | * - It bypasses CC, and is considered a 'non-inflight' packet; | |
45 | * - It may not contain anything other than an ACK frame, not even padding. | |
46 | */ | |
47 | #define TX_PACKETISER_ARCHETYPE_ACK_ONLY 2 | |
48 | ||
49 | #define TX_PACKETISER_ARCHETYPE_NUM 3 | |
50 | ||
a73078b7 HL |
51 | struct ossl_quic_tx_packetiser_st { |
52 | OSSL_QUIC_TX_PACKETISER_ARGS args; | |
53 | ||
54 | /* | |
55 | * Opaque initial token blob provided by caller. TXP frees using the | |
56 | * callback when it is no longer needed. | |
57 | */ | |
58 | const unsigned char *initial_token; | |
59 | size_t initial_token_len; | |
60 | ossl_quic_initial_token_free_fn *initial_token_free_cb; | |
61 | void *initial_token_free_cb_arg; | |
62 | ||
63 | /* Subcomponents of the TXP that we own. */ | |
64 | QUIC_FIFD fifd; /* QUIC Frame-in-Flight Dispatcher */ | |
65 | ||
66 | /* Internal state. */ | |
67 | uint64_t next_pn[QUIC_PN_SPACE_NUM]; /* Next PN to use in given PN space. */ | |
68 | OSSL_TIME last_tx_time; /* Last time a packet was generated, or 0. */ | |
69 | ||
70 | /* Internal state - frame (re)generation flags. */ | |
71 | unsigned int want_handshake_done : 1; | |
72 | unsigned int want_max_data : 1; | |
73 | unsigned int want_max_streams_bidi : 1; | |
74 | unsigned int want_max_streams_uni : 1; | |
75 | ||
76 | /* Internal state - frame (re)generation flags - per PN space. */ | |
77 | unsigned int want_ack : QUIC_PN_SPACE_NUM; | |
78 | unsigned int force_ack_eliciting : QUIC_PN_SPACE_NUM; | |
79 | ||
80 | /* | |
81 | * Internal state - connection close terminal state. | |
82 | * Once this is set, it is not unset unlike other want_ flags - we keep | |
83 | * sending it in every packet. | |
84 | */ | |
85 | unsigned int want_conn_close : 1; | |
86 | ||
cda88baf HL |
87 | /* Has the handshake been completed? */ |
88 | unsigned int handshake_complete : 1; | |
89 | ||
a73078b7 HL |
90 | OSSL_QUIC_FRAME_CONN_CLOSE conn_close_frame; |
91 | ||
50e76846 P |
92 | /* |
93 | * Counts of the number of bytes received and sent while in the closing | |
94 | * state. | |
95 | */ | |
96 | uint64_t closing_bytes_recv; | |
97 | uint64_t closing_bytes_xmit; | |
98 | ||
a73078b7 | 99 | /* Internal state - packet assembly. */ |
faebafda HL |
100 | struct txp_el { |
101 | unsigned char *scratch; /* scratch buffer for packet assembly */ | |
102 | size_t scratch_len; /* number of bytes allocated for scratch */ | |
103 | OSSL_QTX_IOVEC *iovec; /* scratch iovec array for use with QTX */ | |
104 | size_t alloc_iovec; /* size of iovec array */ | |
105 | } el[QUIC_ENC_LEVEL_NUM]; | |
5cf99b40 MC |
106 | |
107 | /* Message callback related arguments */ | |
108 | ossl_msg_cb msg_callback; | |
109 | void *msg_callback_arg; | |
c2786c8e | 110 | SSL *msg_callback_ssl; |
5cf99b40 | 111 | |
8f9c9213 HL |
112 | /* Callbacks. */ |
113 | void (*ack_tx_cb)(const OSSL_QUIC_FRAME_ACK *ack, | |
114 | uint32_t pn_space, | |
115 | void *arg); | |
116 | void *ack_tx_cb_arg; | |
a73078b7 HL |
117 | }; |
118 | ||
119 | /* | |
120 | * The TX helper records state used while generating frames into packets. It | |
121 | * enables serialization into the packet to be done "transactionally" where | |
122 | * serialization of a frame can be rolled back if it fails midway (e.g. if it | |
123 | * does not fit). | |
124 | */ | |
125 | struct tx_helper { | |
126 | OSSL_QUIC_TX_PACKETISER *txp; | |
127 | /* | |
128 | * The Maximum Packet Payload Length in bytes. This is the amount of | |
129 | * space we have to generate frames into. | |
130 | */ | |
131 | size_t max_ppl; | |
132 | /* | |
133 | * Number of bytes we have generated so far. | |
134 | */ | |
135 | size_t bytes_appended; | |
136 | /* | |
137 | * Number of scratch bytes in txp->scratch we have used so far. Some iovecs | |
138 | * will reference this scratch buffer. When we need to use more of it (e.g. | |
139 | * when we need to put frame headers somewhere), we append to the scratch | |
140 | * buffer, resizing if necessary, and increase this accordingly. | |
141 | */ | |
142 | size_t scratch_bytes; | |
143 | /* | |
144 | * Bytes reserved in the MaxPPL budget. We keep this number of bytes spare | |
145 | * until reserve_allowed is set to 1. Currently this is always at most 1, as | |
146 | * a PING frame takes up one byte and this mechanism is only used to ensure | |
147 | * we can encode a PING frame if we have been asked to ensure a packet is | |
148 | * ACK-eliciting and we are unusure if we are going to add any other | |
149 | * ACK-eliciting frames before we reach our MaxPPL budget. | |
150 | */ | |
151 | size_t reserve; | |
152 | /* | |
153 | * Number of iovecs we have currently appended. This is the number of | |
154 | * entries valid in txp->iovec. | |
155 | */ | |
156 | size_t num_iovec; | |
faebafda HL |
157 | /* The EL this TX helper is being used for. */ |
158 | uint32_t enc_level; | |
a73078b7 HL |
159 | /* |
160 | * Whether we are allowed to make use of the reserve bytes in our MaxPPL | |
161 | * budget. This is used to ensure we have room to append a PING frame later | |
162 | * if we need to. Once we know we will not need to append a PING frame, this | |
163 | * is set to 1. | |
164 | */ | |
165 | unsigned int reserve_allowed : 1; | |
166 | /* | |
167 | * Set to 1 if we have appended a STREAM frame with an implicit length. If | |
168 | * this happens we should never append another frame after that frame as it | |
169 | * cannot be validly encoded. This is just a safety check. | |
170 | */ | |
171 | unsigned int done_implicit : 1; | |
172 | struct { | |
173 | /* | |
174 | * The fields in this structure are valid if active is set, which means | |
175 | * that a serialization transaction is currently in progress. | |
176 | */ | |
177 | unsigned char *data; | |
178 | WPACKET wpkt; | |
179 | unsigned int active : 1; | |
180 | } txn; | |
181 | }; | |
182 | ||
183 | static void tx_helper_rollback(struct tx_helper *h); | |
faebafda | 184 | static int txp_el_ensure_iovec(struct txp_el *el, size_t num); |
a73078b7 HL |
185 | |
186 | /* Initialises the TX helper. */ | |
187 | static int tx_helper_init(struct tx_helper *h, OSSL_QUIC_TX_PACKETISER *txp, | |
faebafda | 188 | uint32_t enc_level, size_t max_ppl, size_t reserve) |
a73078b7 HL |
189 | { |
190 | if (reserve > max_ppl) | |
191 | return 0; | |
192 | ||
193 | h->txp = txp; | |
faebafda | 194 | h->enc_level = enc_level; |
a73078b7 HL |
195 | h->max_ppl = max_ppl; |
196 | h->reserve = reserve; | |
197 | h->num_iovec = 0; | |
198 | h->bytes_appended = 0; | |
199 | h->scratch_bytes = 0; | |
200 | h->reserve_allowed = 0; | |
201 | h->done_implicit = 0; | |
202 | h->txn.data = NULL; | |
203 | h->txn.active = 0; | |
204 | ||
faebafda | 205 | if (max_ppl > h->txp->el[enc_level].scratch_len) { |
a73078b7 HL |
206 | unsigned char *scratch; |
207 | ||
faebafda | 208 | scratch = OPENSSL_realloc(h->txp->el[enc_level].scratch, max_ppl); |
a73078b7 HL |
209 | if (scratch == NULL) |
210 | return 0; | |
211 | ||
faebafda HL |
212 | h->txp->el[enc_level].scratch = scratch; |
213 | h->txp->el[enc_level].scratch_len = max_ppl; | |
a73078b7 HL |
214 | } |
215 | ||
216 | return 1; | |
217 | } | |
218 | ||
219 | static void tx_helper_cleanup(struct tx_helper *h) | |
220 | { | |
221 | if (h->txn.active) | |
222 | tx_helper_rollback(h); | |
223 | ||
224 | h->txp = NULL; | |
225 | } | |
226 | ||
227 | static void tx_helper_unrestrict(struct tx_helper *h) | |
228 | { | |
229 | h->reserve_allowed = 1; | |
230 | } | |
231 | ||
232 | /* | |
233 | * Append an extent of memory to the iovec list. The memory must remain | |
234 | * allocated until we finish generating the packet and call the QTX. | |
235 | * | |
236 | * In general, the buffers passed to this function will be from one of two | |
237 | * ranges: | |
238 | * | |
239 | * - Application data contained in stream buffers managed elsewhere | |
240 | * in the QUIC stack; or | |
241 | * | |
242 | * - Control frame data appended into txp->scratch using tx_helper_begin and | |
243 | * tx_helper_commit. | |
244 | * | |
245 | */ | |
246 | static int tx_helper_append_iovec(struct tx_helper *h, | |
247 | const unsigned char *buf, | |
248 | size_t buf_len) | |
249 | { | |
faebafda HL |
250 | struct txp_el *el = &h->txp->el[h->enc_level]; |
251 | ||
a73078b7 HL |
252 | if (buf_len == 0) |
253 | return 1; | |
254 | ||
255 | if (!ossl_assert(!h->done_implicit)) | |
256 | return 0; | |
257 | ||
faebafda | 258 | if (!txp_el_ensure_iovec(el, h->num_iovec + 1)) |
a73078b7 HL |
259 | return 0; |
260 | ||
faebafda HL |
261 | el->iovec[h->num_iovec].buf = buf; |
262 | el->iovec[h->num_iovec].buf_len = buf_len; | |
a73078b7 HL |
263 | |
264 | ++h->num_iovec; | |
265 | h->bytes_appended += buf_len; | |
266 | return 1; | |
267 | } | |
268 | ||
269 | /* | |
270 | * How many more bytes of space do we have left in our plaintext packet payload? | |
271 | */ | |
272 | static size_t tx_helper_get_space_left(struct tx_helper *h) | |
273 | { | |
274 | return h->max_ppl | |
275 | - (h->reserve_allowed ? 0 : h->reserve) - h->bytes_appended; | |
276 | } | |
277 | ||
278 | /* | |
279 | * Begin a control frame serialization transaction. This allows the | |
280 | * serialization of the control frame to be backed out if it turns out it won't | |
281 | * fit. Write the control frame to the returned WPACKET. Ensure you always | |
282 | * call tx_helper_rollback or tx_helper_commit (or tx_helper_cleanup). Returns | |
283 | * NULL on failure. | |
284 | */ | |
285 | static WPACKET *tx_helper_begin(struct tx_helper *h) | |
286 | { | |
287 | size_t space_left, len; | |
288 | unsigned char *data; | |
faebafda | 289 | struct txp_el *el = &h->txp->el[h->enc_level]; |
a73078b7 HL |
290 | |
291 | if (!ossl_assert(!h->txn.active)) | |
292 | return NULL; | |
293 | ||
294 | if (!ossl_assert(!h->done_implicit)) | |
295 | return NULL; | |
296 | ||
faebafda HL |
297 | data = (unsigned char *)el->scratch + h->scratch_bytes; |
298 | len = el->scratch_len - h->scratch_bytes; | |
a73078b7 HL |
299 | |
300 | space_left = tx_helper_get_space_left(h); | |
301 | if (!ossl_assert(space_left <= len)) | |
302 | return NULL; | |
303 | ||
304 | if (!WPACKET_init_static_len(&h->txn.wpkt, data, len, 0)) | |
305 | return NULL; | |
306 | ||
307 | if (!WPACKET_set_max_size(&h->txn.wpkt, space_left)) { | |
308 | WPACKET_cleanup(&h->txn.wpkt); | |
309 | return NULL; | |
310 | } | |
311 | ||
312 | h->txn.data = data; | |
313 | h->txn.active = 1; | |
314 | return &h->txn.wpkt; | |
315 | } | |
316 | ||
317 | static void tx_helper_end(struct tx_helper *h, int success) | |
318 | { | |
319 | if (success) | |
320 | WPACKET_finish(&h->txn.wpkt); | |
321 | else | |
322 | WPACKET_cleanup(&h->txn.wpkt); | |
323 | ||
324 | h->txn.active = 0; | |
325 | h->txn.data = NULL; | |
326 | } | |
327 | ||
328 | /* Abort a control frame serialization transaction. */ | |
329 | static void tx_helper_rollback(struct tx_helper *h) | |
330 | { | |
331 | if (!h->txn.active) | |
332 | return; | |
333 | ||
334 | tx_helper_end(h, 0); | |
335 | } | |
336 | ||
337 | /* Commit a control frame. */ | |
338 | static int tx_helper_commit(struct tx_helper *h) | |
339 | { | |
340 | size_t l = 0; | |
341 | ||
342 | if (!h->txn.active) | |
343 | return 0; | |
344 | ||
345 | if (!WPACKET_get_total_written(&h->txn.wpkt, &l)) { | |
346 | tx_helper_end(h, 0); | |
347 | return 0; | |
348 | } | |
349 | ||
350 | if (!tx_helper_append_iovec(h, h->txn.data, l)) { | |
351 | tx_helper_end(h, 0); | |
352 | return 0; | |
353 | } | |
354 | ||
5cf99b40 | 355 | if (h->txp->msg_callback != NULL && l > 0) { |
45454ccc MC |
356 | uint64_t ftype; |
357 | int ctype = SSL3_RT_QUIC_FRAME_FULL; | |
358 | PACKET pkt; | |
359 | ||
360 | if (!PACKET_buf_init(&pkt, h->txn.data, l) | |
6c1d0e28 | 361 | || !ossl_quic_wire_peek_frame_header(&pkt, &ftype, NULL)) { |
45454ccc MC |
362 | tx_helper_end(h, 0); |
363 | return 0; | |
364 | } | |
365 | ||
366 | if (ftype == OSSL_QUIC_FRAME_TYPE_PADDING) | |
367 | ctype = SSL3_RT_QUIC_FRAME_PADDING; | |
368 | else if (OSSL_QUIC_FRAME_TYPE_IS_STREAM(ftype) | |
369 | || ftype == OSSL_QUIC_FRAME_TYPE_CRYPTO) | |
370 | ctype = SSL3_RT_QUIC_FRAME_HEADER; | |
371 | ||
5cf99b40 | 372 | h->txp->msg_callback(1, OSSL_QUIC1_VERSION, ctype, h->txn.data, l, |
c2786c8e | 373 | h->txp->msg_callback_ssl, |
5cf99b40 | 374 | h->txp->msg_callback_arg); |
45454ccc MC |
375 | } |
376 | ||
a73078b7 HL |
377 | h->scratch_bytes += l; |
378 | tx_helper_end(h, 1); | |
379 | return 1; | |
380 | } | |
381 | ||
faebafda HL |
382 | struct archetype_data { |
383 | unsigned int allow_ack : 1; | |
384 | unsigned int allow_ping : 1; | |
385 | unsigned int allow_crypto : 1; | |
386 | unsigned int allow_handshake_done : 1; | |
387 | unsigned int allow_path_challenge : 1; | |
388 | unsigned int allow_path_response : 1; | |
389 | unsigned int allow_new_conn_id : 1; | |
390 | unsigned int allow_retire_conn_id : 1; | |
391 | unsigned int allow_stream_rel : 1; | |
392 | unsigned int allow_conn_fc : 1; | |
393 | unsigned int allow_conn_close : 1; | |
394 | unsigned int allow_cfq_other : 1; | |
395 | unsigned int allow_new_token : 1; | |
396 | unsigned int allow_force_ack_eliciting : 1; | |
397 | unsigned int allow_padding : 1; | |
398 | unsigned int require_ack_eliciting : 1; | |
399 | unsigned int bypass_cc : 1; | |
400 | }; | |
401 | ||
402 | struct txp_pkt_geom { | |
403 | size_t cmpl, cmppl, hwm, pkt_overhead; | |
404 | uint32_t archetype; | |
405 | struct archetype_data adata; | |
406 | }; | |
407 | ||
408 | struct txp_pkt { | |
409 | struct tx_helper h; | |
410 | int h_valid; | |
411 | QUIC_TXPIM_PKT *tpkt; | |
412 | QUIC_STREAM *stream_head; | |
413 | QUIC_PKT_HDR phdr; | |
414 | struct txp_pkt_geom geom; | |
c5cb85b6 | 415 | int force_pad; |
faebafda HL |
416 | }; |
417 | ||
a73078b7 HL |
418 | static QUIC_SSTREAM *get_sstream_by_id(uint64_t stream_id, uint32_t pn_space, |
419 | void *arg); | |
420 | static void on_regen_notify(uint64_t frame_type, uint64_t stream_id, | |
421 | QUIC_TXPIM_PKT *pkt, void *arg); | |
9cacba43 HL |
422 | static void on_confirm_notify(uint64_t frame_type, uint64_t stream_id, |
423 | QUIC_TXPIM_PKT *pkt, void *arg); | |
5d27e7e9 | 424 | static void on_sstream_updated(uint64_t stream_id, void *arg); |
a73078b7 | 425 | static int sstream_is_pending(QUIC_SSTREAM *sstream); |
faebafda HL |
426 | static int txp_should_try_staging(OSSL_QUIC_TX_PACKETISER *txp, |
427 | uint32_t enc_level, | |
428 | uint32_t archetype, | |
429 | uint64_t cc_limit, | |
430 | uint32_t *conn_close_enc_level); | |
a73078b7 HL |
431 | static size_t txp_determine_pn_len(OSSL_QUIC_TX_PACKETISER *txp); |
432 | static int txp_determine_ppl_from_pl(OSSL_QUIC_TX_PACKETISER *txp, | |
433 | size_t pl, | |
434 | uint32_t enc_level, | |
435 | size_t hdr_len, | |
436 | size_t *r); | |
437 | static size_t txp_get_mdpl(OSSL_QUIC_TX_PACKETISER *txp); | |
faebafda HL |
438 | static int txp_generate_for_el(OSSL_QUIC_TX_PACKETISER *txp, |
439 | struct txp_pkt *pkt, | |
440 | int chosen_for_conn_close); | |
441 | static int txp_pkt_init(struct txp_pkt *pkt, OSSL_QUIC_TX_PACKETISER *txp, | |
442 | uint32_t enc_level, uint32_t archetype, | |
443 | size_t running_total); | |
444 | static void txp_pkt_cleanup(struct txp_pkt *pkt, OSSL_QUIC_TX_PACKETISER *txp); | |
445 | static int txp_pkt_postgen_update_pkt_overhead(struct txp_pkt *pkt, | |
446 | OSSL_QUIC_TX_PACKETISER *txp); | |
447 | static int txp_pkt_append_padding(struct txp_pkt *pkt, | |
448 | OSSL_QUIC_TX_PACKETISER *txp, size_t num_bytes); | |
449 | static int txp_pkt_commit(OSSL_QUIC_TX_PACKETISER *txp, struct txp_pkt *pkt, | |
6a2b70e2 | 450 | uint32_t archetype, int *txpim_pkt_reffed); |
c206f2aa HL |
451 | static uint32_t txp_determine_archetype(OSSL_QUIC_TX_PACKETISER *txp, |
452 | uint64_t cc_limit); | |
a73078b7 HL |
453 | |
454 | OSSL_QUIC_TX_PACKETISER *ossl_quic_tx_packetiser_new(const OSSL_QUIC_TX_PACKETISER_ARGS *args) | |
455 | { | |
456 | OSSL_QUIC_TX_PACKETISER *txp; | |
457 | ||
458 | if (args == NULL | |
459 | || args->qtx == NULL | |
460 | || args->txpim == NULL | |
461 | || args->cfq == NULL | |
462 | || args->ackm == NULL | |
463 | || args->qsm == NULL | |
464 | || args->conn_txfc == NULL | |
a6b6ea17 HL |
465 | || args->conn_rxfc == NULL |
466 | || args->max_streams_bidi_rxfc == NULL | |
467 | || args->max_streams_uni_rxfc == NULL) { | |
a73078b7 HL |
468 | ERR_raise(ERR_LIB_SSL, ERR_R_PASSED_NULL_PARAMETER); |
469 | return NULL; | |
470 | } | |
471 | ||
472 | txp = OPENSSL_zalloc(sizeof(*txp)); | |
473 | if (txp == NULL) | |
474 | return NULL; | |
475 | ||
476 | txp->args = *args; | |
477 | txp->last_tx_time = ossl_time_zero(); | |
478 | ||
479 | if (!ossl_quic_fifd_init(&txp->fifd, | |
480 | txp->args.cfq, txp->args.ackm, txp->args.txpim, | |
481 | get_sstream_by_id, txp, | |
5d27e7e9 | 482 | on_regen_notify, txp, |
9cacba43 | 483 | on_confirm_notify, txp, |
5d27e7e9 | 484 | on_sstream_updated, txp)) { |
a73078b7 HL |
485 | OPENSSL_free(txp); |
486 | return NULL; | |
487 | } | |
488 | ||
489 | return txp; | |
490 | } | |
491 | ||
492 | void ossl_quic_tx_packetiser_free(OSSL_QUIC_TX_PACKETISER *txp) | |
493 | { | |
faebafda HL |
494 | uint32_t enc_level; |
495 | ||
a73078b7 HL |
496 | if (txp == NULL) |
497 | return; | |
498 | ||
499 | ossl_quic_tx_packetiser_set_initial_token(txp, NULL, 0, NULL, NULL); | |
500 | ossl_quic_fifd_cleanup(&txp->fifd); | |
a73078b7 | 501 | OPENSSL_free(txp->conn_close_frame.reason); |
faebafda HL |
502 | |
503 | for (enc_level = QUIC_ENC_LEVEL_INITIAL; | |
504 | enc_level < QUIC_ENC_LEVEL_NUM; | |
505 | ++enc_level) { | |
506 | OPENSSL_free(txp->el[enc_level].iovec); | |
507 | OPENSSL_free(txp->el[enc_level].scratch); | |
508 | } | |
509 | ||
a73078b7 HL |
510 | OPENSSL_free(txp); |
511 | } | |
512 | ||
513 | void ossl_quic_tx_packetiser_set_initial_token(OSSL_QUIC_TX_PACKETISER *txp, | |
514 | const unsigned char *token, | |
515 | size_t token_len, | |
516 | ossl_quic_initial_token_free_fn *free_cb, | |
517 | void *free_cb_arg) | |
518 | { | |
519 | if (txp->initial_token != NULL && txp->initial_token_free_cb != NULL) | |
520 | txp->initial_token_free_cb(txp->initial_token, txp->initial_token_len, | |
521 | txp->initial_token_free_cb_arg); | |
522 | ||
523 | txp->initial_token = token; | |
524 | txp->initial_token_len = token_len; | |
525 | txp->initial_token_free_cb = free_cb; | |
526 | txp->initial_token_free_cb_arg = free_cb_arg; | |
527 | } | |
528 | ||
529 | int ossl_quic_tx_packetiser_set_cur_dcid(OSSL_QUIC_TX_PACKETISER *txp, | |
530 | const QUIC_CONN_ID *dcid) | |
531 | { | |
532 | if (dcid == NULL) { | |
533 | ERR_raise(ERR_LIB_SSL, ERR_R_PASSED_NULL_PARAMETER); | |
534 | return 0; | |
535 | } | |
536 | ||
537 | txp->args.cur_dcid = *dcid; | |
538 | return 1; | |
539 | } | |
540 | ||
541 | int ossl_quic_tx_packetiser_set_cur_scid(OSSL_QUIC_TX_PACKETISER *txp, | |
542 | const QUIC_CONN_ID *scid) | |
543 | { | |
544 | if (scid == NULL) { | |
545 | ERR_raise(ERR_LIB_SSL, ERR_R_PASSED_NULL_PARAMETER); | |
546 | return 0; | |
547 | } | |
548 | ||
549 | txp->args.cur_scid = *scid; | |
550 | return 1; | |
551 | } | |
552 | ||
553 | /* Change the destination L4 address the TXP uses to send datagrams. */ | |
554 | int ossl_quic_tx_packetiser_set_peer(OSSL_QUIC_TX_PACKETISER *txp, | |
555 | const BIO_ADDR *peer) | |
556 | { | |
557 | if (peer == NULL) { | |
558 | ERR_raise(ERR_LIB_SSL, ERR_R_PASSED_NULL_PARAMETER); | |
559 | return 0; | |
560 | } | |
561 | ||
562 | txp->args.peer = *peer; | |
563 | return 1; | |
564 | } | |
565 | ||
8f9c9213 HL |
566 | void ossl_quic_tx_packetiser_set_ack_tx_cb(OSSL_QUIC_TX_PACKETISER *txp, |
567 | void (*cb)(const OSSL_QUIC_FRAME_ACK *ack, | |
568 | uint32_t pn_space, | |
569 | void *arg), | |
570 | void *cb_arg) | |
571 | { | |
572 | txp->ack_tx_cb = cb; | |
573 | txp->ack_tx_cb_arg = cb_arg; | |
574 | } | |
575 | ||
a73078b7 HL |
576 | int ossl_quic_tx_packetiser_discard_enc_level(OSSL_QUIC_TX_PACKETISER *txp, |
577 | uint32_t enc_level) | |
578 | { | |
579 | if (enc_level >= QUIC_ENC_LEVEL_NUM) { | |
580 | ERR_raise(ERR_LIB_SSL, ERR_R_PASSED_INVALID_ARGUMENT); | |
581 | return 0; | |
582 | } | |
583 | ||
584 | if (enc_level != QUIC_ENC_LEVEL_0RTT) | |
585 | txp->args.crypto[ossl_quic_enc_level_to_pn_space(enc_level)] = NULL; | |
586 | ||
a73078b7 HL |
587 | return 1; |
588 | } | |
589 | ||
cda88baf HL |
590 | void ossl_quic_tx_packetiser_notify_handshake_complete(OSSL_QUIC_TX_PACKETISER *txp) |
591 | { | |
592 | txp->handshake_complete = 1; | |
593 | } | |
594 | ||
a73078b7 HL |
595 | void ossl_quic_tx_packetiser_schedule_handshake_done(OSSL_QUIC_TX_PACKETISER *txp) |
596 | { | |
597 | txp->want_handshake_done = 1; | |
598 | } | |
599 | ||
600 | void ossl_quic_tx_packetiser_schedule_ack_eliciting(OSSL_QUIC_TX_PACKETISER *txp, | |
601 | uint32_t pn_space) | |
602 | { | |
603 | txp->force_ack_eliciting |= (1UL << pn_space); | |
604 | } | |
605 | ||
37ba2bc7 HL |
606 | void ossl_quic_tx_packetiser_schedule_ack(OSSL_QUIC_TX_PACKETISER *txp, |
607 | uint32_t pn_space) | |
608 | { | |
609 | txp->want_ack |= (1UL << pn_space); | |
610 | } | |
611 | ||
a73078b7 HL |
612 | #define TXP_ERR_INTERNAL 0 /* Internal (e.g. alloc) error */ |
613 | #define TXP_ERR_SUCCESS 1 /* Success */ | |
614 | #define TXP_ERR_SPACE 2 /* Not enough room for another packet */ | |
615 | #define TXP_ERR_INPUT 3 /* Invalid/malformed input */ | |
616 | ||
617 | /* | |
618 | * Generates a datagram by polling the various ELs to determine if they want to | |
619 | * generate any frames, and generating a datagram which coalesces packets for | |
620 | * any ELs which do. | |
621 | */ | |
622 | int ossl_quic_tx_packetiser_generate(OSSL_QUIC_TX_PACKETISER *txp, | |
a3a51d6e | 623 | QUIC_TXP_STATUS *status) |
a73078b7 | 624 | { |
fee8f48e | 625 | /* |
faebafda HL |
626 | * Called to generate one or more datagrams, each containing one or more |
627 | * packets. | |
628 | * | |
629 | * There are some tricky things to note here: | |
630 | * | |
631 | * - The TXP is only concerned with generating encrypted packets; | |
632 | * other packets use a different path. | |
633 | * | |
634 | * - Any datagram containing an Initial packet must have a payload length | |
635 | * (DPL) of at least 1200 bytes. This padding need not necessarily be | |
636 | * found in the Initial packet. | |
637 | * | |
638 | * - It is desirable to be able to coalesce an Initial packet | |
639 | * with a Handshake packet. Since, before generating the Handshake | |
640 | * packet, we do not know how long it will be, we cannot know the | |
641 | * correct amount of padding to ensure a DPL of at least 1200 bytes. | |
642 | * Thus this padding must added to the Handshake packet (or whatever | |
643 | * packet is the last in the datagram). | |
644 | * | |
645 | * - However, at the time that we generate the Initial packet, | |
646 | * we do not actually know for sure that we will be followed | |
647 | * in the datagram by another packet. For example, suppose we have | |
648 | * some queued data (e.g. crypto stream data for the HANDSHAKE EL) | |
649 | * it looks like we will want to send on the HANDSHAKE EL. | |
650 | * We could assume padding will be placed in the Handshake packet | |
651 | * subsequently and avoid adding any padding to the Initial packet | |
652 | * (which would leave no room for the Handshake packet in the | |
653 | * datagram). | |
654 | * | |
655 | * However, this is not actually a safe assumption. Suppose that we | |
656 | * are using a link with a MDPL of 1200 bytes, the minimum allowed by | |
657 | * QUIC. Suppose that the Initial packet consumes 1195 bytes in total. | |
658 | * Since it is not possible to fit a Handshake packet in just 5 bytes, | |
659 | * upon trying to add a Handshake packet after generating the Initial | |
660 | * packet, we will discover we have no room to fit it! This is not a | |
661 | * problem in itself as another datagram can be sent subsequently, but | |
662 | * it is a problem because we were counting to use that packet to hold | |
663 | * the essential padding. But if we have already finished encrypting | |
664 | * the Initial packet, we cannot go and add padding to it anymore. | |
665 | * This leaves us stuck. | |
666 | * | |
667 | * Because of this, we have to plan multiple packets simultaneously, such | |
668 | * that we can start generating a Handshake (or 0-RTT or 1-RTT, or so on) | |
669 | * packet while still having the option to go back and add padding to the | |
670 | * Initial packet if it turns out to be needed. | |
671 | * | |
672 | * Trying to predict ahead of time (e.g. during Initial packet generation) | |
673 | * whether we will successfully generate a subsequent packet is fraught with | |
674 | * error as it relies on a large number of variables: | |
675 | * | |
676 | * - Do we have room to fit a packet header? (Consider that due to | |
677 | * variable-length integer encoding this is highly variable and can even | |
678 | * depend on payload length due to a variable-length Length field.) | |
679 | * | |
680 | * - Can we fit even a single one of the frames we want to put in this | |
681 | * packet in the packet? (Each frame type has a bespoke encoding. While | |
682 | * our encodings of some frame types are adaptive based on the available | |
683 | * room - e.g. STREAM frames - ultimately all frame types have some | |
684 | * absolute minimum number of bytes to be successfully encoded. For | |
685 | * example, if after an Initial packet there is enough room to encode | |
686 | * only one byte of frame data, it is quite likely we can't send any of | |
687 | * the frames we wanted to send.) While this is not strictly a problem | |
688 | * because we could just fill the packet with padding frames, this is a | |
689 | * pointless packet and is wasteful. | |
690 | * | |
691 | * Thus we adopt a multi-phase architecture: | |
692 | * | |
693 | * 1. Archetype Selection: Determine desired packet archetype. | |
694 | * | |
695 | * 2. Packet Staging: Generation of packet information and packet payload | |
696 | * data (frame data) into staging areas. | |
697 | * | |
698 | * 3. Packet Adjustment: Adjustment of staged packets, adding padding to | |
699 | * the staged packets if needed. | |
700 | * | |
701 | * 4. Commit: The packets are sent to the QTX and recorded as having been | |
702 | * sent to the FIFM. | |
703 | * | |
fee8f48e | 704 | */ |
64fd6991 | 705 | int res = 0, rc; |
faebafda HL |
706 | uint32_t archetype, enc_level; |
707 | uint32_t conn_close_enc_level = QUIC_ENC_LEVEL_NUM; | |
708 | struct txp_pkt pkt[QUIC_ENC_LEVEL_NUM]; | |
709 | size_t pkts_done = 0; | |
710 | uint64_t cc_limit = txp->args.cc_method->get_tx_allowance(txp->args.cc_data); | |
6a2b70e2 | 711 | int need_padding = 0, txpim_pkt_reffed; |
a73078b7 HL |
712 | |
713 | for (enc_level = QUIC_ENC_LEVEL_INITIAL; | |
714 | enc_level < QUIC_ENC_LEVEL_NUM; | |
faebafda HL |
715 | ++enc_level) |
716 | pkt[enc_level].h_valid = 0; | |
a73078b7 | 717 | |
64fd6991 TM |
718 | memset(status, 0, sizeof(*status)); |
719 | ||
a73078b7 HL |
720 | /* |
721 | * Should not be needed, but a sanity check in case anyone else has been | |
722 | * using the QTX. | |
723 | */ | |
724 | ossl_qtx_finish_dgram(txp->args.qtx); | |
725 | ||
faebafda | 726 | /* 1. Archetype Selection */ |
c206f2aa | 727 | archetype = txp_determine_archetype(txp, cc_limit); |
faebafda HL |
728 | |
729 | /* 2. Packet Staging */ | |
a73078b7 HL |
730 | for (enc_level = QUIC_ENC_LEVEL_INITIAL; |
731 | enc_level < QUIC_ENC_LEVEL_NUM; | |
732 | ++enc_level) { | |
faebafda HL |
733 | size_t running_total = (enc_level > QUIC_ENC_LEVEL_INITIAL) |
734 | ? pkt[enc_level - 1].geom.hwm : 0; | |
a73078b7 | 735 | |
faebafda | 736 | pkt[enc_level].geom.hwm = running_total; |
a73078b7 | 737 | |
faebafda HL |
738 | if (!txp_should_try_staging(txp, enc_level, archetype, cc_limit, |
739 | &conn_close_enc_level)) | |
740 | continue; | |
741 | ||
742 | if (!txp_pkt_init(&pkt[enc_level], txp, enc_level, archetype, | |
743 | running_total)) | |
a73078b7 | 744 | /* |
faebafda HL |
745 | * If this fails this is not a fatal error - it means the geometry |
746 | * planning determined there was not enough space for another | |
747 | * packet. So just proceed with what we've already planned for. | |
a73078b7 | 748 | */ |
faebafda HL |
749 | break; |
750 | ||
751 | rc = txp_generate_for_el(txp, &pkt[enc_level], | |
752 | conn_close_enc_level == enc_level); | |
753 | if (rc != TXP_ERR_SUCCESS) | |
754 | goto out; | |
755 | ||
c5cb85b6 HL |
756 | if (pkt[enc_level].force_pad) |
757 | /* | |
758 | * txp_generate_for_el emitted a frame which forces packet padding. | |
759 | */ | |
760 | need_padding = 1; | |
761 | ||
faebafda HL |
762 | pkt[enc_level].geom.hwm = running_total |
763 | + pkt[enc_level].h.bytes_appended | |
764 | + pkt[enc_level].geom.pkt_overhead; | |
765 | } | |
766 | ||
767 | /* 3. Packet Adjustment */ | |
768 | if (pkt[QUIC_ENC_LEVEL_INITIAL].h_valid | |
c5cb85b6 | 769 | && pkt[QUIC_ENC_LEVEL_INITIAL].h.bytes_appended > 0) |
faebafda HL |
770 | /* |
771 | * We have an Initial packet in this datagram, so we need to make sure | |
772 | * the total size of the datagram is adequate. | |
773 | */ | |
c5cb85b6 HL |
774 | need_padding = 1; |
775 | ||
776 | if (need_padding) { | |
faebafda HL |
777 | size_t total_dgram_size = 0; |
778 | const size_t min_dpl = QUIC_MIN_INITIAL_DGRAM_LEN; | |
c5cb85b6 | 779 | uint32_t first_el = QUIC_ENC_LEVEL_NUM; |
faebafda HL |
780 | |
781 | for (enc_level = QUIC_ENC_LEVEL_INITIAL; | |
782 | enc_level < QUIC_ENC_LEVEL_NUM; | |
783 | ++enc_level) | |
784 | if (pkt[enc_level].h_valid && pkt[enc_level].h.bytes_appended > 0) { | |
c5cb85b6 HL |
785 | if (first_el == QUIC_ENC_LEVEL_NUM) |
786 | first_el = enc_level; | |
787 | ||
faebafda HL |
788 | txp_pkt_postgen_update_pkt_overhead(&pkt[enc_level], txp); |
789 | total_dgram_size += pkt[enc_level].geom.pkt_overhead | |
790 | + pkt[enc_level].h.bytes_appended; | |
791 | } | |
792 | ||
c5cb85b6 HL |
793 | if (first_el != QUIC_ENC_LEVEL_NUM |
794 | && total_dgram_size < min_dpl) { | |
faebafda HL |
795 | size_t deficit = min_dpl - total_dgram_size; |
796 | ||
c5cb85b6 | 797 | if (!txp_pkt_append_padding(&pkt[first_el], txp, deficit)) |
faebafda | 798 | goto out; |
a73078b7 | 799 | } |
faebafda HL |
800 | } |
801 | ||
802 | /* 4. Commit */ | |
faebafda HL |
803 | for (enc_level = QUIC_ENC_LEVEL_INITIAL; |
804 | enc_level < QUIC_ENC_LEVEL_NUM; | |
805 | ++enc_level) { | |
806 | ||
807 | if (!pkt[enc_level].h_valid) | |
808 | /* Did not attempt to generate a packet for this EL. */ | |
809 | continue; | |
810 | ||
811 | if (pkt[enc_level].h.bytes_appended == 0) | |
812 | /* Nothing was generated for this EL, so skip. */ | |
813 | continue; | |
814 | ||
6a2b70e2 HL |
815 | rc = txp_pkt_commit(txp, &pkt[enc_level], archetype, |
816 | &txpim_pkt_reffed); | |
817 | if (rc) | |
818 | status->sent_ack_eliciting | |
819 | = status->sent_ack_eliciting | |
820 | || pkt[enc_level].tpkt->ackm_pkt.is_ack_eliciting; | |
821 | ||
822 | if (txpim_pkt_reffed) | |
823 | pkt[enc_level].tpkt = NULL; /* don't free */ | |
faebafda | 824 | |
6a2b70e2 HL |
825 | if (!rc) |
826 | goto out; | |
faebafda | 827 | |
a73078b7 HL |
828 | ++pkts_done; |
829 | } | |
830 | ||
3eb0f9a7 HL |
831 | status->sent_handshake |
832 | = (pkt[QUIC_ENC_LEVEL_HANDSHAKE].h_valid | |
833 | && pkt[QUIC_ENC_LEVEL_HANDSHAKE].h.bytes_appended > 0); | |
834 | ||
faebafda | 835 | /* Flush & Cleanup */ |
64fd6991 | 836 | res = 1; |
faebafda | 837 | out: |
a73078b7 | 838 | ossl_qtx_finish_dgram(txp->args.qtx); |
a73078b7 | 839 | |
faebafda HL |
840 | for (enc_level = QUIC_ENC_LEVEL_INITIAL; |
841 | enc_level < QUIC_ENC_LEVEL_NUM; | |
842 | ++enc_level) | |
843 | txp_pkt_cleanup(&pkt[enc_level], txp); | |
844 | ||
64fd6991 TM |
845 | status->sent_pkt = pkts_done; |
846 | ||
96014840 | 847 | return res; |
faebafda | 848 | } |
a73078b7 HL |
849 | |
850 | static const struct archetype_data archetypes[QUIC_ENC_LEVEL_NUM][TX_PACKETISER_ARCHETYPE_NUM] = { | |
851 | /* EL 0(INITIAL) */ | |
852 | { | |
853 | /* EL 0(INITIAL) - Archetype 0(NORMAL) */ | |
854 | { | |
855 | /*allow_ack =*/ 1, | |
856 | /*allow_ping =*/ 1, | |
857 | /*allow_crypto =*/ 1, | |
858 | /*allow_handshake_done =*/ 0, | |
859 | /*allow_path_challenge =*/ 0, | |
860 | /*allow_path_response =*/ 0, | |
861 | /*allow_new_conn_id =*/ 0, | |
862 | /*allow_retire_conn_id =*/ 0, | |
863 | /*allow_stream_rel =*/ 0, | |
864 | /*allow_conn_fc =*/ 0, | |
865 | /*allow_conn_close =*/ 1, | |
8d2e353d | 866 | /*allow_cfq_other =*/ 0, |
a73078b7 HL |
867 | /*allow_new_token =*/ 0, |
868 | /*allow_force_ack_eliciting =*/ 1, | |
faebafda HL |
869 | /*allow_padding =*/ 1, |
870 | /*require_ack_eliciting =*/ 0, | |
871 | /*bypass_cc =*/ 0, | |
a73078b7 | 872 | }, |
faebafda | 873 | /* EL 0(INITIAL) - Archetype 1(PROBE) */ |
a73078b7 HL |
874 | { |
875 | /*allow_ack =*/ 1, | |
d56b564b | 876 | /*allow_ping =*/ 1, |
faebafda HL |
877 | /*allow_crypto =*/ 1, |
878 | /*allow_handshake_done =*/ 0, | |
879 | /*allow_path_challenge =*/ 0, | |
880 | /*allow_path_response =*/ 0, | |
881 | /*allow_new_conn_id =*/ 0, | |
882 | /*allow_retire_conn_id =*/ 0, | |
883 | /*allow_stream_rel =*/ 0, | |
884 | /*allow_conn_fc =*/ 0, | |
885 | /*allow_conn_close =*/ 1, | |
886 | /*allow_cfq_other =*/ 0, | |
887 | /*allow_new_token =*/ 0, | |
888 | /*allow_force_ack_eliciting =*/ 1, | |
889 | /*allow_padding =*/ 1, | |
890 | /*require_ack_eliciting =*/ 1, | |
891 | /*bypass_cc =*/ 1, | |
892 | }, | |
893 | /* EL 0(INITIAL) - Archetype 2(ACK_ONLY) */ | |
894 | { | |
895 | /*allow_ack =*/ 1, | |
896 | /*allow_ping =*/ 0, | |
a73078b7 HL |
897 | /*allow_crypto =*/ 0, |
898 | /*allow_handshake_done =*/ 0, | |
899 | /*allow_path_challenge =*/ 0, | |
900 | /*allow_path_response =*/ 0, | |
901 | /*allow_new_conn_id =*/ 0, | |
902 | /*allow_retire_conn_id =*/ 0, | |
903 | /*allow_stream_rel =*/ 0, | |
904 | /*allow_conn_fc =*/ 0, | |
905 | /*allow_conn_close =*/ 0, | |
906 | /*allow_cfq_other =*/ 0, | |
907 | /*allow_new_token =*/ 0, | |
908 | /*allow_force_ack_eliciting =*/ 1, | |
faebafda HL |
909 | /*allow_padding =*/ 0, |
910 | /*require_ack_eliciting =*/ 0, | |
911 | /*bypass_cc =*/ 1, | |
a73078b7 HL |
912 | }, |
913 | }, | |
914 | /* EL 1(HANDSHAKE) */ | |
915 | { | |
916 | /* EL 1(HANDSHAKE) - Archetype 0(NORMAL) */ | |
917 | { | |
918 | /*allow_ack =*/ 1, | |
919 | /*allow_ping =*/ 1, | |
920 | /*allow_crypto =*/ 1, | |
921 | /*allow_handshake_done =*/ 0, | |
922 | /*allow_path_challenge =*/ 0, | |
923 | /*allow_path_response =*/ 0, | |
924 | /*allow_new_conn_id =*/ 0, | |
925 | /*allow_retire_conn_id =*/ 0, | |
926 | /*allow_stream_rel =*/ 0, | |
927 | /*allow_conn_fc =*/ 0, | |
928 | /*allow_conn_close =*/ 1, | |
8d2e353d | 929 | /*allow_cfq_other =*/ 0, |
a73078b7 HL |
930 | /*allow_new_token =*/ 0, |
931 | /*allow_force_ack_eliciting =*/ 1, | |
faebafda HL |
932 | /*allow_padding =*/ 1, |
933 | /*require_ack_eliciting =*/ 0, | |
934 | /*bypass_cc =*/ 0, | |
a73078b7 | 935 | }, |
faebafda | 936 | /* EL 1(HANDSHAKE) - Archetype 1(PROBE) */ |
a73078b7 HL |
937 | { |
938 | /*allow_ack =*/ 1, | |
d56b564b | 939 | /*allow_ping =*/ 1, |
faebafda HL |
940 | /*allow_crypto =*/ 1, |
941 | /*allow_handshake_done =*/ 0, | |
942 | /*allow_path_challenge =*/ 0, | |
943 | /*allow_path_response =*/ 0, | |
944 | /*allow_new_conn_id =*/ 0, | |
945 | /*allow_retire_conn_id =*/ 0, | |
946 | /*allow_stream_rel =*/ 0, | |
947 | /*allow_conn_fc =*/ 0, | |
948 | /*allow_conn_close =*/ 1, | |
949 | /*allow_cfq_other =*/ 0, | |
950 | /*allow_new_token =*/ 0, | |
951 | /*allow_force_ack_eliciting =*/ 1, | |
952 | /*allow_padding =*/ 1, | |
953 | /*require_ack_eliciting =*/ 1, | |
954 | /*bypass_cc =*/ 1, | |
955 | }, | |
956 | /* EL 1(HANDSHAKE) - Archetype 2(ACK_ONLY) */ | |
957 | { | |
958 | /*allow_ack =*/ 1, | |
959 | /*allow_ping =*/ 0, | |
a73078b7 HL |
960 | /*allow_crypto =*/ 0, |
961 | /*allow_handshake_done =*/ 0, | |
962 | /*allow_path_challenge =*/ 0, | |
963 | /*allow_path_response =*/ 0, | |
964 | /*allow_new_conn_id =*/ 0, | |
965 | /*allow_retire_conn_id =*/ 0, | |
966 | /*allow_stream_rel =*/ 0, | |
967 | /*allow_conn_fc =*/ 0, | |
968 | /*allow_conn_close =*/ 0, | |
969 | /*allow_cfq_other =*/ 0, | |
970 | /*allow_new_token =*/ 0, | |
971 | /*allow_force_ack_eliciting =*/ 1, | |
faebafda HL |
972 | /*allow_padding =*/ 0, |
973 | /*require_ack_eliciting =*/ 0, | |
974 | /*bypass_cc =*/ 1, | |
a73078b7 HL |
975 | }, |
976 | }, | |
977 | /* EL 2(0RTT) */ | |
978 | { | |
979 | /* EL 2(0RTT) - Archetype 0(NORMAL) */ | |
980 | { | |
981 | /*allow_ack =*/ 0, | |
982 | /*allow_ping =*/ 1, | |
983 | /*allow_crypto =*/ 0, | |
984 | /*allow_handshake_done =*/ 0, | |
985 | /*allow_path_challenge =*/ 0, | |
986 | /*allow_path_response =*/ 0, | |
987 | /*allow_new_conn_id =*/ 1, | |
988 | /*allow_retire_conn_id =*/ 1, | |
989 | /*allow_stream_rel =*/ 1, | |
990 | /*allow_conn_fc =*/ 1, | |
991 | /*allow_conn_close =*/ 1, | |
992 | /*allow_cfq_other =*/ 0, | |
993 | /*allow_new_token =*/ 0, | |
994 | /*allow_force_ack_eliciting =*/ 0, | |
faebafda HL |
995 | /*allow_padding =*/ 1, |
996 | /*require_ack_eliciting =*/ 0, | |
997 | /*bypass_cc =*/ 0, | |
a73078b7 | 998 | }, |
faebafda | 999 | /* EL 2(0RTT) - Archetype 1(PROBE) */ |
a73078b7 HL |
1000 | { |
1001 | /*allow_ack =*/ 0, | |
d56b564b | 1002 | /*allow_ping =*/ 1, |
a73078b7 HL |
1003 | /*allow_crypto =*/ 0, |
1004 | /*allow_handshake_done =*/ 0, | |
1005 | /*allow_path_challenge =*/ 0, | |
1006 | /*allow_path_response =*/ 0, | |
faebafda HL |
1007 | /*allow_new_conn_id =*/ 1, |
1008 | /*allow_retire_conn_id =*/ 1, | |
1009 | /*allow_stream_rel =*/ 1, | |
1010 | /*allow_conn_fc =*/ 1, | |
1011 | /*allow_conn_close =*/ 1, | |
1012 | /*allow_cfq_other =*/ 0, | |
1013 | /*allow_new_token =*/ 0, | |
1014 | /*allow_force_ack_eliciting =*/ 0, | |
1015 | /*allow_padding =*/ 1, | |
1016 | /*require_ack_eliciting =*/ 1, | |
1017 | /*bypass_cc =*/ 1, | |
1018 | }, | |
1019 | /* EL 2(0RTT) - Archetype 2(ACK_ONLY) */ | |
1020 | { | |
1021 | /*allow_ack =*/ 0, | |
1022 | /*allow_ping =*/ 0, | |
1023 | /*allow_crypto =*/ 0, | |
1024 | /*allow_handshake_done =*/ 0, | |
1025 | /*allow_path_challenge =*/ 0, | |
1026 | /*allow_path_response =*/ 0, | |
a73078b7 HL |
1027 | /*allow_new_conn_id =*/ 0, |
1028 | /*allow_retire_conn_id =*/ 0, | |
1029 | /*allow_stream_rel =*/ 0, | |
1030 | /*allow_conn_fc =*/ 0, | |
1031 | /*allow_conn_close =*/ 0, | |
1032 | /*allow_cfq_other =*/ 0, | |
1033 | /*allow_new_token =*/ 0, | |
1034 | /*allow_force_ack_eliciting =*/ 0, | |
faebafda HL |
1035 | /*allow_padding =*/ 0, |
1036 | /*require_ack_eliciting =*/ 0, | |
1037 | /*bypass_cc =*/ 1, | |
a73078b7 HL |
1038 | }, |
1039 | }, | |
1040 | /* EL 3(1RTT) */ | |
1041 | { | |
1042 | /* EL 3(1RTT) - Archetype 0(NORMAL) */ | |
1043 | { | |
1044 | /*allow_ack =*/ 1, | |
1045 | /*allow_ping =*/ 1, | |
1046 | /*allow_crypto =*/ 1, | |
1047 | /*allow_handshake_done =*/ 1, | |
1048 | /*allow_path_challenge =*/ 0, | |
7eb330ff | 1049 | /*allow_path_response =*/ 1, |
a73078b7 HL |
1050 | /*allow_new_conn_id =*/ 1, |
1051 | /*allow_retire_conn_id =*/ 1, | |
1052 | /*allow_stream_rel =*/ 1, | |
1053 | /*allow_conn_fc =*/ 1, | |
1054 | /*allow_conn_close =*/ 1, | |
1055 | /*allow_cfq_other =*/ 1, | |
1056 | /*allow_new_token =*/ 1, | |
1057 | /*allow_force_ack_eliciting =*/ 1, | |
faebafda HL |
1058 | /*allow_padding =*/ 1, |
1059 | /*require_ack_eliciting =*/ 0, | |
1060 | /*bypass_cc =*/ 0, | |
a73078b7 | 1061 | }, |
faebafda | 1062 | /* EL 3(1RTT) - Archetype 1(PROBE) */ |
a73078b7 HL |
1063 | { |
1064 | /*allow_ack =*/ 1, | |
d56b564b | 1065 | /*allow_ping =*/ 1, |
faebafda HL |
1066 | /*allow_crypto =*/ 1, |
1067 | /*allow_handshake_done =*/ 1, | |
1068 | /*allow_path_challenge =*/ 0, | |
7eb330ff | 1069 | /*allow_path_response =*/ 1, |
faebafda HL |
1070 | /*allow_new_conn_id =*/ 1, |
1071 | /*allow_retire_conn_id =*/ 1, | |
1072 | /*allow_stream_rel =*/ 1, | |
1073 | /*allow_conn_fc =*/ 1, | |
1074 | /*allow_conn_close =*/ 1, | |
1075 | /*allow_cfq_other =*/ 1, | |
1076 | /*allow_new_token =*/ 1, | |
1077 | /*allow_force_ack_eliciting =*/ 1, | |
1078 | /*allow_padding =*/ 1, | |
1079 | /*require_ack_eliciting =*/ 1, | |
1080 | /*bypass_cc =*/ 1, | |
1081 | }, | |
1082 | /* EL 3(1RTT) - Archetype 2(ACK_ONLY) */ | |
1083 | { | |
1084 | /*allow_ack =*/ 1, | |
1085 | /*allow_ping =*/ 0, | |
a73078b7 HL |
1086 | /*allow_crypto =*/ 0, |
1087 | /*allow_handshake_done =*/ 0, | |
1088 | /*allow_path_challenge =*/ 0, | |
1089 | /*allow_path_response =*/ 0, | |
1090 | /*allow_new_conn_id =*/ 0, | |
1091 | /*allow_retire_conn_id =*/ 0, | |
1092 | /*allow_stream_rel =*/ 0, | |
1093 | /*allow_conn_fc =*/ 0, | |
1094 | /*allow_conn_close =*/ 0, | |
1095 | /*allow_cfq_other =*/ 0, | |
1096 | /*allow_new_token =*/ 0, | |
1097 | /*allow_force_ack_eliciting =*/ 1, | |
faebafda HL |
1098 | /*allow_padding =*/ 0, |
1099 | /*require_ack_eliciting =*/ 0, | |
1100 | /*bypass_cc =*/ 1, | |
a73078b7 HL |
1101 | } |
1102 | } | |
1103 | }; | |
1104 | ||
1105 | static int txp_get_archetype_data(uint32_t enc_level, | |
1106 | uint32_t archetype, | |
1107 | struct archetype_data *a) | |
1108 | { | |
1109 | if (enc_level >= QUIC_ENC_LEVEL_NUM | |
1110 | || archetype >= TX_PACKETISER_ARCHETYPE_NUM) | |
1111 | return 0; | |
1112 | ||
1113 | /* No need to avoid copying this as it should not exceed one int in size. */ | |
1114 | *a = archetypes[enc_level][archetype]; | |
1115 | return 1; | |
1116 | } | |
1117 | ||
faebafda HL |
1118 | static int txp_determine_geometry(OSSL_QUIC_TX_PACKETISER *txp, |
1119 | uint32_t archetype, | |
1120 | uint32_t enc_level, | |
1121 | size_t running_total, | |
1122 | QUIC_PKT_HDR *phdr, | |
1123 | struct txp_pkt_geom *geom) | |
1124 | { | |
1125 | size_t mdpl, cmpl, hdr_len; | |
1126 | ||
1127 | /* Get information about packet archetype. */ | |
1128 | if (!txp_get_archetype_data(enc_level, archetype, &geom->adata)) | |
1129 | return 0; | |
1130 | ||
1131 | /* Assemble packet header. */ | |
1132 | phdr->type = ossl_quic_enc_level_to_pkt_type(enc_level); | |
1133 | phdr->spin_bit = 0; | |
1134 | phdr->pn_len = txp_determine_pn_len(txp); | |
1135 | phdr->partial = 0; | |
1136 | phdr->fixed = 1; | |
1137 | phdr->reserved = 0; | |
1138 | phdr->version = QUIC_VERSION_1; | |
1139 | phdr->dst_conn_id = txp->args.cur_dcid; | |
1140 | phdr->src_conn_id = txp->args.cur_scid; | |
1141 | ||
1142 | /* | |
1143 | * We need to know the length of the payload to get an accurate header | |
1144 | * length for non-1RTT packets, because the Length field found in | |
1145 | * Initial/Handshake/0-RTT packets uses a variable-length encoding. However, | |
1146 | * we don't have a good idea of the length of our payload, because the | |
1147 | * length of the payload depends on the room in the datagram after fitting | |
1148 | * the header, which depends on the size of the header. | |
1149 | * | |
1150 | * In general, it does not matter if a packet is slightly shorter (because | |
1151 | * e.g. we predicted use of a 2-byte length field, but ended up only needing | |
1152 | * a 1-byte length field). However this does matter for Initial packets | |
1153 | * which must be at least 1200 bytes, which is also the assumed default MTU; | |
1154 | * therefore in many cases Initial packets will be padded to 1200 bytes, | |
1155 | * which means if we overestimated the header size, we will be short by a | |
1156 | * few bytes and the server will ignore the packet for being too short. In | |
1157 | * this case, however, such packets always *will* be padded to meet 1200 | |
1158 | * bytes, which requires a 2-byte length field, so we don't actually need to | |
1159 | * worry about this. Thus we estimate the header length assuming a 2-byte | |
1160 | * length field here, which should in practice work well in all cases. | |
1161 | */ | |
1162 | phdr->len = OSSL_QUIC_VLINT_2B_MAX - phdr->pn_len; | |
1163 | ||
1164 | if (enc_level == QUIC_ENC_LEVEL_INITIAL) { | |
1165 | phdr->token = txp->initial_token; | |
1166 | phdr->token_len = txp->initial_token_len; | |
1167 | } else { | |
1168 | phdr->token = NULL; | |
1169 | phdr->token_len = 0; | |
1170 | } | |
1171 | ||
1172 | hdr_len = ossl_quic_wire_get_encoded_pkt_hdr_len(phdr->dst_conn_id.id_len, | |
1173 | phdr); | |
1174 | if (hdr_len == 0) | |
1175 | return 0; | |
1176 | ||
1177 | /* MDPL: Maximum datagram payload length. */ | |
1178 | mdpl = txp_get_mdpl(txp); | |
1179 | ||
1180 | /* | |
1181 | * CMPL: Maximum encoded packet size we can put into this datagram given any | |
1182 | * previous packets coalesced into it. | |
1183 | */ | |
1184 | if (running_total > mdpl) | |
1185 | /* Should not be possible, but if it happens: */ | |
1186 | cmpl = 0; | |
1187 | else | |
1188 | cmpl = mdpl - running_total; | |
1189 | ||
1190 | /* CMPPL: Maximum amount we can put into the current packet payload */ | |
1191 | if (!txp_determine_ppl_from_pl(txp, cmpl, enc_level, hdr_len, &geom->cmppl)) | |
1192 | return 0; | |
1193 | ||
1194 | geom->cmpl = cmpl; | |
1195 | geom->pkt_overhead = cmpl - geom->cmppl; | |
1196 | geom->archetype = archetype; | |
1197 | return 1; | |
1198 | } | |
1199 | ||
c206f2aa HL |
1200 | static uint32_t txp_determine_archetype(OSSL_QUIC_TX_PACKETISER *txp, |
1201 | uint64_t cc_limit) | |
faebafda HL |
1202 | { |
1203 | OSSL_ACKM_PROBE_INFO *probe_info | |
1204 | = ossl_ackm_get0_probe_request(txp->args.ackm); | |
faebafda HL |
1205 | uint32_t pn_space; |
1206 | ||
1207 | /* | |
1208 | * If ACKM has requested probe generation (e.g. due to PTO), we generate a | |
1209 | * Probe-archetype packet. Actually, we determine archetype on a | |
1210 | * per-datagram basis, so if any EL wants a probe, do a pass in which | |
1211 | * we try and generate a probe (if needed) for all ELs. | |
1212 | */ | |
1213 | if (probe_info->anti_deadlock_initial > 0 | |
1214 | || probe_info->anti_deadlock_handshake > 0) | |
1215 | return TX_PACKETISER_ARCHETYPE_PROBE; | |
1216 | ||
1217 | for (pn_space = QUIC_PN_SPACE_INITIAL; | |
1218 | pn_space < QUIC_PN_SPACE_NUM; | |
1219 | ++pn_space) | |
1220 | if (probe_info->pto[pn_space] > 0) | |
1221 | return TX_PACKETISER_ARCHETYPE_PROBE; | |
1222 | ||
1223 | /* | |
1224 | * If we are out of CC budget, we cannot send a normal packet, | |
1225 | * but we can do an ACK-only packet (potentially, if we | |
1226 | * want to send an ACK). | |
1227 | */ | |
1228 | if (cc_limit == 0) | |
1229 | return TX_PACKETISER_ARCHETYPE_ACK_ONLY; | |
1230 | ||
1231 | /* All other packets. */ | |
1232 | return TX_PACKETISER_ARCHETYPE_NORMAL; | |
1233 | } | |
1234 | ||
1235 | static int txp_should_try_staging(OSSL_QUIC_TX_PACKETISER *txp, | |
1236 | uint32_t enc_level, | |
1237 | uint32_t archetype, | |
1238 | uint64_t cc_limit, | |
1239 | uint32_t *conn_close_enc_level) | |
a73078b7 HL |
1240 | { |
1241 | struct archetype_data a; | |
1242 | uint32_t pn_space = ossl_quic_enc_level_to_pn_space(enc_level); | |
1243 | QUIC_CFQ_ITEM *cfq_item; | |
1244 | ||
1245 | if (!ossl_qtx_is_enc_level_provisioned(txp->args.qtx, enc_level)) | |
1246 | return 0; | |
1247 | ||
faebafda HL |
1248 | if (!txp_get_archetype_data(enc_level, archetype, &a)) |
1249 | return 0; | |
1250 | ||
1251 | if (!a.bypass_cc && cc_limit == 0) | |
1252 | /* CC not allowing us to send. */ | |
1253 | return 0; | |
1254 | ||
96fa10f3 HL |
1255 | /* |
1256 | * We can produce CONNECTION_CLOSE frames on any EL in principle, which | |
1257 | * means we need to choose which EL we would prefer to use. After a | |
1258 | * connection is fully established we have only one provisioned EL and this | |
1259 | * is a non-issue. Where multiple ELs are provisioned, it is possible the | |
1260 | * peer does not have the keys for the EL yet, which suggests in general it | |
1261 | * is preferable to use the lowest EL which is still provisioned. | |
1262 | * | |
d15d5ea6 P |
1263 | * However (RFC 9000 s. 10.2.3 & 12.5) we are also required to not send |
1264 | * application CONNECTION_CLOSE frames in non-1-RTT ELs, so as to not | |
1265 | * potentially leak application data on a connection which has yet to be | |
1266 | * authenticated. Thus when we have an application CONNECTION_CLOSE frame | |
1267 | * queued and need to send it on a non-1-RTT EL, we have to convert it | |
1268 | * into a transport CONNECTION_CLOSE frame which contains no application | |
1269 | * data. Since this loses information, it suggests we should use the 1-RTT | |
1270 | * EL to avoid this if possible, even if a lower EL is also available. | |
96fa10f3 HL |
1271 | * |
1272 | * At the same time, just because we have the 1-RTT EL provisioned locally | |
1273 | * does not necessarily mean the peer does, for example if a handshake | |
1274 | * CRYPTO frame has been lost. It is fairly important that CONNECTION_CLOSE | |
1275 | * is signalled in a way we know our peer can decrypt, as we stop processing | |
1276 | * connection retransmission logic for real after connection close and | |
1277 | * simply 'blindly' retransmit the same CONNECTION_CLOSE frame. | |
1278 | * | |
1279 | * This is not a major concern for clients, since if a client has a 1-RTT EL | |
1280 | * provisioned the server is guaranteed to also have a 1-RTT EL provisioned. | |
1281 | * | |
44cb36d0 | 1282 | * TODO(QUIC SERVER): Revisit this when server support is added. |
96fa10f3 HL |
1283 | */ |
1284 | if (*conn_close_enc_level > enc_level | |
1285 | && *conn_close_enc_level != QUIC_ENC_LEVEL_1RTT) | |
7f9d1249 HL |
1286 | *conn_close_enc_level = enc_level; |
1287 | ||
fee8f48e HL |
1288 | /* Do we need to send a PTO probe? */ |
1289 | if (a.allow_force_ack_eliciting) { | |
1290 | OSSL_ACKM_PROBE_INFO *probe_info | |
2477e99f | 1291 | = ossl_ackm_get0_probe_request(txp->args.ackm); |
fee8f48e HL |
1292 | |
1293 | if ((enc_level == QUIC_ENC_LEVEL_INITIAL | |
1294 | && probe_info->anti_deadlock_initial > 0) | |
1295 | || (enc_level == QUIC_ENC_LEVEL_HANDSHAKE | |
1296 | && probe_info->anti_deadlock_handshake > 0) | |
1297 | || probe_info->pto[pn_space] > 0) | |
1298 | return 1; | |
1299 | } | |
1300 | ||
a73078b7 HL |
1301 | /* Does the crypto stream for this EL want to produce anything? */ |
1302 | if (a.allow_crypto && sstream_is_pending(txp->args.crypto[pn_space])) | |
1303 | return 1; | |
1304 | ||
1305 | /* Does the ACKM for this PN space want to produce anything? */ | |
1306 | if (a.allow_ack && (ossl_ackm_is_ack_desired(txp->args.ackm, pn_space) | |
1307 | || (txp->want_ack & (1UL << pn_space)) != 0)) | |
1308 | return 1; | |
1309 | ||
1310 | /* Do we need to force emission of an ACK-eliciting packet? */ | |
1311 | if (a.allow_force_ack_eliciting | |
1312 | && (txp->force_ack_eliciting & (1UL << pn_space)) != 0) | |
1313 | return 1; | |
1314 | ||
1315 | /* Does the connection-level RXFC want to produce a frame? */ | |
1316 | if (a.allow_conn_fc && (txp->want_max_data | |
1317 | || ossl_quic_rxfc_has_cwm_changed(txp->args.conn_rxfc, 0))) | |
1318 | return 1; | |
1319 | ||
1320 | /* Do we want to produce a MAX_STREAMS frame? */ | |
a6b6ea17 HL |
1321 | if (a.allow_conn_fc |
1322 | && (txp->want_max_streams_bidi | |
1323 | || ossl_quic_rxfc_has_cwm_changed(txp->args.max_streams_bidi_rxfc, | |
1324 | 0) | |
1325 | || txp->want_max_streams_uni | |
1326 | || ossl_quic_rxfc_has_cwm_changed(txp->args.max_streams_uni_rxfc, | |
1327 | 0))) | |
a73078b7 HL |
1328 | return 1; |
1329 | ||
1330 | /* Do we want to produce a HANDSHAKE_DONE frame? */ | |
1331 | if (a.allow_handshake_done && txp->want_handshake_done) | |
1332 | return 1; | |
1333 | ||
1334 | /* Do we want to produce a CONNECTION_CLOSE frame? */ | |
7f9d1249 HL |
1335 | if (a.allow_conn_close && txp->want_conn_close && |
1336 | *conn_close_enc_level == enc_level) | |
1337 | /* | |
1338 | * This is a bit of a special case since CONNECTION_CLOSE can appear in | |
1339 | * most packet types, and when we decide we want to send it this status | |
1340 | * isn't tied to a specific EL. So if we want to send it, we send it | |
1341 | * only on the lowest non-dropped EL. | |
1342 | */ | |
a73078b7 HL |
1343 | return 1; |
1344 | ||
1345 | /* Does the CFQ have any frames queued for this PN space? */ | |
1346 | if (enc_level != QUIC_ENC_LEVEL_0RTT) | |
1347 | for (cfq_item = ossl_quic_cfq_get_priority_head(txp->args.cfq, pn_space); | |
1348 | cfq_item != NULL; | |
1349 | cfq_item = ossl_quic_cfq_item_get_priority_next(cfq_item, pn_space)) { | |
1350 | uint64_t frame_type = ossl_quic_cfq_item_get_frame_type(cfq_item); | |
1351 | ||
1352 | switch (frame_type) { | |
1353 | case OSSL_QUIC_FRAME_TYPE_NEW_CONN_ID: | |
1354 | if (a.allow_new_conn_id) | |
1355 | return 1; | |
1356 | break; | |
1357 | case OSSL_QUIC_FRAME_TYPE_RETIRE_CONN_ID: | |
1358 | if (a.allow_retire_conn_id) | |
1359 | return 1; | |
1360 | break; | |
1361 | case OSSL_QUIC_FRAME_TYPE_NEW_TOKEN: | |
1362 | if (a.allow_new_token) | |
1363 | return 1; | |
1364 | break; | |
7eb330ff HL |
1365 | case OSSL_QUIC_FRAME_TYPE_PATH_RESPONSE: |
1366 | if (a.allow_path_response) | |
1367 | return 1; | |
1368 | break; | |
a73078b7 HL |
1369 | default: |
1370 | if (a.allow_cfq_other) | |
1371 | return 1; | |
1372 | break; | |
1373 | } | |
1374 | } | |
1375 | ||
cda88baf | 1376 | if (a.allow_stream_rel && txp->handshake_complete) { |
a73078b7 HL |
1377 | QUIC_STREAM_ITER it; |
1378 | ||
1379 | /* If there are any active streams, 0/1-RTT wants to produce a packet. | |
1380 | * Whether a stream is on the active list is required to be precise | |
1381 | * (i.e., a stream is never on the active list if we cannot produce a | |
1382 | * frame for it), and all stream-related frames are governed by | |
1383 | * a.allow_stream_rel (i.e., if we can send one type of stream-related | |
1384 | * frame, we can send any of them), so we don't need to inspect | |
1385 | * individual streams on the active list, just confirm that the active | |
1386 | * list is non-empty. | |
1387 | */ | |
1388 | ossl_quic_stream_iter_init(&it, txp->args.qsm, 0); | |
1389 | if (it.stream != NULL) | |
1390 | return 1; | |
1391 | } | |
1392 | ||
1393 | return 0; | |
1394 | } | |
1395 | ||
1396 | static int sstream_is_pending(QUIC_SSTREAM *sstream) | |
1397 | { | |
1398 | OSSL_QUIC_FRAME_STREAM hdr; | |
1399 | OSSL_QTX_IOVEC iov[2]; | |
1400 | size_t num_iov = OSSL_NELEM(iov); | |
1401 | ||
1402 | return ossl_quic_sstream_get_stream_frame(sstream, 0, &hdr, iov, &num_iov); | |
1403 | } | |
1404 | ||
a73078b7 HL |
1405 | /* Determine how many bytes we should use for the encoded PN. */ |
1406 | static size_t txp_determine_pn_len(OSSL_QUIC_TX_PACKETISER *txp) | |
1407 | { | |
44cb36d0 | 1408 | return 4; /* TODO(QUIC FUTURE) */ |
a73078b7 HL |
1409 | } |
1410 | ||
1411 | /* Determine plaintext packet payload length from payload length. */ | |
1412 | static int txp_determine_ppl_from_pl(OSSL_QUIC_TX_PACKETISER *txp, | |
1413 | size_t pl, | |
1414 | uint32_t enc_level, | |
1415 | size_t hdr_len, | |
1416 | size_t *r) | |
1417 | { | |
1418 | if (pl < hdr_len) | |
1419 | return 0; | |
1420 | ||
1421 | pl -= hdr_len; | |
1422 | ||
1423 | if (!ossl_qtx_calculate_plaintext_payload_len(txp->args.qtx, enc_level, | |
1424 | pl, &pl)) | |
1425 | return 0; | |
1426 | ||
1427 | *r = pl; | |
1428 | return 1; | |
1429 | } | |
1430 | ||
1431 | static size_t txp_get_mdpl(OSSL_QUIC_TX_PACKETISER *txp) | |
1432 | { | |
1433 | return ossl_qtx_get_mdpl(txp->args.qtx); | |
1434 | } | |
1435 | ||
1436 | static QUIC_SSTREAM *get_sstream_by_id(uint64_t stream_id, uint32_t pn_space, | |
1437 | void *arg) | |
1438 | { | |
1439 | OSSL_QUIC_TX_PACKETISER *txp = arg; | |
1440 | QUIC_STREAM *s; | |
1441 | ||
1442 | if (stream_id == UINT64_MAX) | |
1443 | return txp->args.crypto[pn_space]; | |
1444 | ||
1445 | s = ossl_quic_stream_map_get_by_id(txp->args.qsm, stream_id); | |
1446 | if (s == NULL) | |
1447 | return NULL; | |
1448 | ||
1449 | return s->sstream; | |
1450 | } | |
1451 | ||
1452 | static void on_regen_notify(uint64_t frame_type, uint64_t stream_id, | |
1453 | QUIC_TXPIM_PKT *pkt, void *arg) | |
1454 | { | |
1455 | OSSL_QUIC_TX_PACKETISER *txp = arg; | |
1456 | ||
1457 | switch (frame_type) { | |
1458 | case OSSL_QUIC_FRAME_TYPE_HANDSHAKE_DONE: | |
1459 | txp->want_handshake_done = 1; | |
1460 | break; | |
1461 | case OSSL_QUIC_FRAME_TYPE_MAX_DATA: | |
1462 | txp->want_max_data = 1; | |
1463 | break; | |
1464 | case OSSL_QUIC_FRAME_TYPE_MAX_STREAMS_BIDI: | |
1465 | txp->want_max_streams_bidi = 1; | |
1466 | break; | |
1467 | case OSSL_QUIC_FRAME_TYPE_MAX_STREAMS_UNI: | |
1468 | txp->want_max_streams_uni = 1; | |
1469 | break; | |
1470 | case OSSL_QUIC_FRAME_TYPE_ACK_WITH_ECN: | |
1471 | txp->want_ack |= (1UL << pkt->ackm_pkt.pkt_space); | |
1472 | break; | |
1473 | case OSSL_QUIC_FRAME_TYPE_MAX_STREAM_DATA: | |
1474 | { | |
1475 | QUIC_STREAM *s | |
1476 | = ossl_quic_stream_map_get_by_id(txp->args.qsm, stream_id); | |
1477 | ||
1478 | if (s == NULL) | |
1479 | return; | |
1480 | ||
1481 | s->want_max_stream_data = 1; | |
1482 | ossl_quic_stream_map_update_state(txp->args.qsm, s); | |
1483 | } | |
1484 | break; | |
1485 | case OSSL_QUIC_FRAME_TYPE_STOP_SENDING: | |
1486 | { | |
1487 | QUIC_STREAM *s | |
1488 | = ossl_quic_stream_map_get_by_id(txp->args.qsm, stream_id); | |
1489 | ||
1490 | if (s == NULL) | |
1491 | return; | |
1492 | ||
418e122c | 1493 | ossl_quic_stream_map_schedule_stop_sending(txp->args.qsm, s); |
a73078b7 HL |
1494 | } |
1495 | break; | |
1496 | case OSSL_QUIC_FRAME_TYPE_RESET_STREAM: | |
1497 | { | |
1498 | QUIC_STREAM *s | |
1499 | = ossl_quic_stream_map_get_by_id(txp->args.qsm, stream_id); | |
1500 | ||
1501 | if (s == NULL) | |
1502 | return; | |
1503 | ||
1504 | s->want_reset_stream = 1; | |
1505 | ossl_quic_stream_map_update_state(txp->args.qsm, s); | |
1506 | } | |
1507 | break; | |
1508 | default: | |
1509 | assert(0); | |
1510 | break; | |
1511 | } | |
1512 | } | |
1513 | ||
faebafda HL |
1514 | static int txp_pkt_init(struct txp_pkt *pkt, OSSL_QUIC_TX_PACKETISER *txp, |
1515 | uint32_t enc_level, uint32_t archetype, | |
1516 | size_t running_total) | |
1517 | { | |
1518 | if (!txp_determine_geometry(txp, archetype, enc_level, | |
1519 | running_total, &pkt->phdr, &pkt->geom)) | |
1520 | return 0; | |
1521 | ||
1522 | /* | |
1523 | * Initialise TX helper. If we must be ACK eliciting, reserve 1 byte for | |
1524 | * PING. | |
1525 | */ | |
1526 | if (!tx_helper_init(&pkt->h, txp, enc_level, | |
1527 | pkt->geom.cmppl, | |
1528 | pkt->geom.adata.require_ack_eliciting ? 1 : 0)) | |
1529 | return 0; | |
1530 | ||
1531 | pkt->h_valid = 1; | |
1532 | pkt->tpkt = NULL; | |
1533 | pkt->stream_head = NULL; | |
c5cb85b6 | 1534 | pkt->force_pad = 0; |
faebafda HL |
1535 | return 1; |
1536 | } | |
1537 | ||
1538 | static void txp_pkt_cleanup(struct txp_pkt *pkt, OSSL_QUIC_TX_PACKETISER *txp) | |
1539 | { | |
1540 | if (!pkt->h_valid) | |
1541 | return; | |
1542 | ||
1543 | tx_helper_cleanup(&pkt->h); | |
1544 | pkt->h_valid = 0; | |
1545 | ||
1546 | if (pkt->tpkt != NULL) { | |
1547 | ossl_quic_txpim_pkt_release(txp->args.txpim, pkt->tpkt); | |
1548 | pkt->tpkt = NULL; | |
1549 | } | |
1550 | } | |
1551 | ||
1552 | static int txp_pkt_postgen_update_pkt_overhead(struct txp_pkt *pkt, | |
1553 | OSSL_QUIC_TX_PACKETISER *txp) | |
1554 | { | |
1555 | /* | |
1556 | * After we have staged and generated our packets, but before we commit | |
1557 | * them, it is possible for the estimated packet overhead (packet header + | |
1558 | * AEAD tag size) to shrink slightly because we generated a short packet | |
1559 | * whose which can be represented in fewer bytes as a variable-length | |
1560 | * integer than we were (pessimistically) budgeting for. We need to account | |
1561 | * for this to ensure that we get our padding calculation exactly right. | |
1562 | * | |
1563 | * Update pkt_overhead to be accurate now that we know how much data is | |
1564 | * going in a packet. | |
1565 | */ | |
1566 | size_t hdr_len, ciphertext_len; | |
1567 | ||
1568 | if (pkt->h.enc_level == QUIC_ENC_LEVEL_INITIAL) | |
1569 | /* | |
1570 | * Don't update overheads for the INITIAL EL - we have not finished | |
1571 | * appending padding to it and would potentially miscalculate the | |
1572 | * correct padding if we now update the pkt_overhead field to switch to | |
1573 | * e.g. a 1-byte length field in the packet header. Since we are padding | |
1574 | * to QUIC_MIN_INITIAL_DGRAM_LEN which requires a 2-byte length field, | |
1575 | * this is guaranteed to be moot anyway. See comment in | |
1576 | * txp_determine_geometry for more information. | |
1577 | */ | |
1578 | return 1; | |
1579 | ||
1580 | if (!ossl_qtx_calculate_ciphertext_payload_len(txp->args.qtx, pkt->h.enc_level, | |
1581 | pkt->h.bytes_appended, | |
1582 | &ciphertext_len)) | |
1583 | return 0; | |
1584 | ||
1585 | pkt->phdr.len = ciphertext_len; | |
1586 | ||
1587 | hdr_len = ossl_quic_wire_get_encoded_pkt_hdr_len(pkt->phdr.dst_conn_id.id_len, | |
1588 | &pkt->phdr); | |
1589 | ||
1590 | pkt->geom.pkt_overhead = hdr_len + ciphertext_len - pkt->h.bytes_appended; | |
1591 | return 1; | |
1592 | } | |
1593 | ||
9cacba43 HL |
1594 | static void on_confirm_notify(uint64_t frame_type, uint64_t stream_id, |
1595 | QUIC_TXPIM_PKT *pkt, void *arg) | |
1596 | { | |
1597 | OSSL_QUIC_TX_PACKETISER *txp = arg; | |
1598 | ||
1599 | switch (frame_type) { | |
1600 | case OSSL_QUIC_FRAME_TYPE_STOP_SENDING: | |
1601 | { | |
1602 | QUIC_STREAM *s | |
1603 | = ossl_quic_stream_map_get_by_id(txp->args.qsm, stream_id); | |
1604 | ||
1605 | if (s == NULL) | |
1606 | return; | |
1607 | ||
1608 | s->acked_stop_sending = 1; | |
1609 | ossl_quic_stream_map_update_state(txp->args.qsm, s); | |
1610 | } | |
1611 | break; | |
1612 | case OSSL_QUIC_FRAME_TYPE_RESET_STREAM: | |
1613 | { | |
1614 | QUIC_STREAM *s | |
1615 | = ossl_quic_stream_map_get_by_id(txp->args.qsm, stream_id); | |
1616 | ||
1617 | if (s == NULL) | |
1618 | return; | |
1619 | ||
2f018d14 HL |
1620 | /* |
1621 | * We must already be in RESET_SENT or RESET_RECVD if we are | |
1622 | * here, so we don't need to check state here. | |
1623 | */ | |
1624 | ossl_quic_stream_map_notify_reset_stream_acked(txp->args.qsm, s); | |
9cacba43 HL |
1625 | ossl_quic_stream_map_update_state(txp->args.qsm, s); |
1626 | } | |
1627 | break; | |
1628 | default: | |
1629 | assert(0); | |
1630 | break; | |
1631 | } | |
1632 | } | |
1633 | ||
faebafda HL |
1634 | static int txp_pkt_append_padding(struct txp_pkt *pkt, |
1635 | OSSL_QUIC_TX_PACKETISER *txp, size_t num_bytes) | |
1636 | { | |
1637 | WPACKET *wpkt; | |
1638 | ||
1639 | if (num_bytes == 0) | |
1640 | return 1; | |
1641 | ||
1642 | if (!ossl_assert(pkt->h_valid)) | |
1643 | return 0; | |
1644 | ||
1645 | if (!ossl_assert(pkt->tpkt != NULL)) | |
1646 | return 0; | |
1647 | ||
1648 | wpkt = tx_helper_begin(&pkt->h); | |
1649 | if (wpkt == NULL) | |
1650 | return 0; | |
1651 | ||
1652 | if (!ossl_quic_wire_encode_padding(wpkt, num_bytes)) { | |
1653 | tx_helper_rollback(&pkt->h); | |
1654 | return 0; | |
1655 | } | |
1656 | ||
1657 | if (!tx_helper_commit(&pkt->h)) | |
1658 | return 0; | |
1659 | ||
1660 | pkt->tpkt->ackm_pkt.num_bytes += num_bytes; | |
1661 | /* Cannot be non-inflight if we have a PADDING frame */ | |
1662 | pkt->tpkt->ackm_pkt.is_inflight = 1; | |
1663 | return 1; | |
1664 | } | |
1665 | ||
5d27e7e9 HL |
1666 | static void on_sstream_updated(uint64_t stream_id, void *arg) |
1667 | { | |
1668 | OSSL_QUIC_TX_PACKETISER *txp = arg; | |
1669 | QUIC_STREAM *s; | |
1670 | ||
1671 | s = ossl_quic_stream_map_get_by_id(txp->args.qsm, stream_id); | |
1672 | if (s == NULL) | |
1673 | return; | |
1674 | ||
1675 | ossl_quic_stream_map_update_state(txp->args.qsm, s); | |
1676 | } | |
1677 | ||
50e76846 P |
1678 | /* |
1679 | * Returns 1 if we can send that many bytes in closing state, 0 otherwise. | |
1680 | * Also maintains the bytes sent state if it returns a success. | |
1681 | */ | |
1682 | static int try_commit_conn_close(OSSL_QUIC_TX_PACKETISER *txp, size_t n) | |
1683 | { | |
1684 | int res; | |
1685 | ||
1686 | /* We can always send the first connection close frame */ | |
1687 | if (txp->closing_bytes_recv == 0) | |
1688 | return 1; | |
1689 | ||
1690 | /* | |
1691 | * RFC 9000 s. 10.2.1 Closing Connection State: | |
1692 | * To avoid being used for an amplification attack, such | |
1693 | * endpoints MUST limit the cumulative size of packets it sends | |
1694 | * to three times the cumulative size of the packets that are | |
1695 | * received and attributed to the connection. | |
1696 | * and: | |
1697 | * An endpoint in the closing state MUST either discard packets | |
1698 | * received from an unvalidated address or limit the cumulative | |
1699 | * size of packets it sends to an unvalidated address to three | |
1700 | * times the size of packets it receives from that address. | |
1701 | */ | |
1702 | res = txp->closing_bytes_xmit + n <= txp->closing_bytes_recv * 3; | |
1703 | ||
1704 | /* | |
1705 | * Attribute the bytes to the connection, if we are allowed to send them | |
1706 | * and this isn't the first closing frame. | |
1707 | */ | |
1708 | if (res && txp->closing_bytes_recv != 0) | |
1709 | txp->closing_bytes_xmit += n; | |
1710 | return res; | |
1711 | } | |
1712 | ||
1713 | void ossl_quic_tx_packetiser_record_received_closing_bytes( | |
1714 | OSSL_QUIC_TX_PACKETISER *txp, size_t n) | |
1715 | { | |
1716 | txp->closing_bytes_recv += n; | |
1717 | } | |
1718 | ||
a73078b7 | 1719 | static int txp_generate_pre_token(OSSL_QUIC_TX_PACKETISER *txp, |
faebafda | 1720 | struct txp_pkt *pkt, |
178c104d HL |
1721 | int chosen_for_conn_close, |
1722 | int *can_be_non_inflight) | |
a73078b7 | 1723 | { |
faebafda HL |
1724 | const uint32_t enc_level = pkt->h.enc_level; |
1725 | const uint32_t pn_space = ossl_quic_enc_level_to_pn_space(enc_level); | |
1726 | const struct archetype_data *a = &pkt->geom.adata; | |
1727 | QUIC_TXPIM_PKT *tpkt = pkt->tpkt; | |
1728 | struct tx_helper *h = &pkt->h; | |
a73078b7 HL |
1729 | const OSSL_QUIC_FRAME_ACK *ack; |
1730 | OSSL_QUIC_FRAME_ACK ack2; | |
1731 | ||
1732 | tpkt->ackm_pkt.largest_acked = QUIC_PN_INVALID; | |
1733 | ||
1734 | /* ACK Frames (Regenerate) */ | |
1735 | if (a->allow_ack | |
1736 | && tx_helper_get_space_left(h) >= MIN_FRAME_SIZE_ACK | |
1737 | && (txp->want_ack | |
1738 | || ossl_ackm_is_ack_desired(txp->args.ackm, pn_space)) | |
1739 | && (ack = ossl_ackm_get_ack_frame(txp->args.ackm, pn_space)) != NULL) { | |
1740 | WPACKET *wpkt = tx_helper_begin(h); | |
1741 | ||
1742 | if (wpkt == NULL) | |
1743 | return 0; | |
1744 | ||
1745 | /* We do not currently support ECN */ | |
1746 | ack2 = *ack; | |
1747 | ack2.ecn_present = 0; | |
1748 | ||
1749 | if (ossl_quic_wire_encode_frame_ack(wpkt, | |
1750 | txp->args.ack_delay_exponent, | |
1751 | &ack2)) { | |
1752 | if (!tx_helper_commit(h)) | |
1753 | return 0; | |
1754 | ||
1755 | tpkt->had_ack_frame = 1; | |
1756 | ||
1757 | if (ack->num_ack_ranges > 0) | |
1758 | tpkt->ackm_pkt.largest_acked = ack->ack_ranges[0].end; | |
8f9c9213 HL |
1759 | |
1760 | if (txp->ack_tx_cb != NULL) | |
1761 | txp->ack_tx_cb(&ack2, pn_space, txp->ack_tx_cb_arg); | |
a73078b7 HL |
1762 | } else { |
1763 | tx_helper_rollback(h); | |
1764 | } | |
1765 | } | |
1766 | ||
1767 | /* CONNECTION_CLOSE Frames (Regenerate) */ | |
7f9d1249 | 1768 | if (a->allow_conn_close && txp->want_conn_close && chosen_for_conn_close) { |
a73078b7 | 1769 | WPACKET *wpkt = tx_helper_begin(h); |
96fa10f3 | 1770 | OSSL_QUIC_FRAME_CONN_CLOSE f, *pf = &txp->conn_close_frame; |
50e76846 | 1771 | size_t l; |
a73078b7 HL |
1772 | |
1773 | if (wpkt == NULL) | |
1774 | return 0; | |
1775 | ||
96fa10f3 HL |
1776 | /* |
1777 | * Application CONNECTION_CLOSE frames may only be sent in the | |
1778 | * Application PN space, as otherwise they may be sent before a | |
1779 | * connection is authenticated and leak application data. Therefore, if | |
1780 | * we need to send a CONNECTION_CLOSE frame in another PN space and were | |
1781 | * given an application CONNECTION_CLOSE frame, convert it into a | |
1782 | * transport CONNECTION_CLOSE frame, removing any sensitive application | |
1783 | * data. | |
1784 | * | |
1785 | * RFC 9000 s. 10.2.3: "A CONNECTION_CLOSE of type 0x1d MUST be replaced | |
1786 | * by a CONNECTION_CLOSE of type 0x1c when sending the frame in Initial | |
1787 | * or Handshake packets. Otherwise, information about the application | |
1788 | * state might be revealed. Endpoints MUST clear the value of the Reason | |
1789 | * Phrase field and SHOULD use the APPLICATION_ERROR code when | |
1790 | * converting to a CONNECTION_CLOSE of type 0x1c." | |
1791 | */ | |
1792 | if (pn_space != QUIC_PN_SPACE_APP && pf->is_app) { | |
1793 | pf = &f; | |
1794 | pf->is_app = 0; | |
1795 | pf->frame_type = 0; | |
1796 | pf->error_code = QUIC_ERR_APPLICATION_ERROR; | |
1797 | pf->reason = NULL; | |
1798 | pf->reason_len = 0; | |
1799 | } | |
1800 | ||
50e76846 P |
1801 | if (ossl_quic_wire_encode_frame_conn_close(wpkt, pf) |
1802 | && WPACKET_get_total_written(wpkt, &l) | |
1803 | && try_commit_conn_close(txp, l)) { | |
a73078b7 HL |
1804 | if (!tx_helper_commit(h)) |
1805 | return 0; | |
178c104d HL |
1806 | |
1807 | *can_be_non_inflight = 0; | |
a73078b7 HL |
1808 | } else { |
1809 | tx_helper_rollback(h); | |
1810 | } | |
1811 | } | |
1812 | ||
1813 | return 1; | |
1814 | } | |
1815 | ||
1816 | static int try_len(size_t space_left, size_t orig_len, | |
1817 | size_t base_hdr_len, size_t lenbytes, | |
1818 | uint64_t maxn, size_t *hdr_len, size_t *payload_len) | |
1819 | { | |
1820 | size_t n; | |
1821 | size_t maxn_ = maxn > SIZE_MAX ? SIZE_MAX : (size_t)maxn; | |
1822 | ||
1823 | *hdr_len = base_hdr_len + lenbytes; | |
1824 | ||
cf06f347 HL |
1825 | if (orig_len == 0 && space_left >= *hdr_len) { |
1826 | *payload_len = 0; | |
1827 | return 1; | |
1828 | } | |
1829 | ||
a73078b7 HL |
1830 | n = orig_len; |
1831 | if (n > maxn_) | |
1832 | n = maxn_; | |
1833 | if (n + *hdr_len > space_left) | |
1834 | n = (space_left >= *hdr_len) ? space_left - *hdr_len : 0; | |
1835 | ||
1836 | *payload_len = n; | |
1837 | return n > 0; | |
1838 | } | |
1839 | ||
cf06f347 HL |
1840 | static int determine_len(size_t space_left, size_t orig_len, |
1841 | size_t base_hdr_len, | |
1842 | uint64_t *hlen, uint64_t *len) | |
a73078b7 | 1843 | { |
cf06f347 | 1844 | int ok = 0; |
a73078b7 HL |
1845 | size_t chosen_payload_len = 0; |
1846 | size_t chosen_hdr_len = 0; | |
1847 | size_t payload_len[4], hdr_len[4]; | |
1848 | int i, valid[4] = {0}; | |
1849 | ||
1850 | valid[0] = try_len(space_left, orig_len, base_hdr_len, | |
1851 | 1, OSSL_QUIC_VLINT_1B_MAX, | |
1852 | &hdr_len[0], &payload_len[0]); | |
1853 | valid[1] = try_len(space_left, orig_len, base_hdr_len, | |
1854 | 2, OSSL_QUIC_VLINT_2B_MAX, | |
1855 | &hdr_len[1], &payload_len[1]); | |
1856 | valid[2] = try_len(space_left, orig_len, base_hdr_len, | |
1857 | 4, OSSL_QUIC_VLINT_4B_MAX, | |
1858 | &hdr_len[2], &payload_len[2]); | |
1859 | valid[3] = try_len(space_left, orig_len, base_hdr_len, | |
1860 | 8, OSSL_QUIC_VLINT_8B_MAX, | |
1861 | &hdr_len[3], &payload_len[3]); | |
1862 | ||
1863 | for (i = OSSL_NELEM(valid) - 1; i >= 0; --i) | |
1864 | if (valid[i] && payload_len[i] >= chosen_payload_len) { | |
1865 | chosen_payload_len = payload_len[i]; | |
1866 | chosen_hdr_len = hdr_len[i]; | |
cf06f347 | 1867 | ok = 1; |
a73078b7 HL |
1868 | } |
1869 | ||
1870 | *hlen = chosen_hdr_len; | |
1871 | *len = chosen_payload_len; | |
cf06f347 | 1872 | return ok; |
a73078b7 HL |
1873 | } |
1874 | ||
1875 | /* | |
1876 | * Given a CRYPTO frame header with accurate chdr->len and a budget | |
1877 | * (space_left), try to find the optimal value of chdr->len to fill as much of | |
1878 | * the budget as possible. This is slightly hairy because larger values of | |
1879 | * chdr->len cause larger encoded sizes of the length field of the frame, which | |
1880 | * in turn mean less space available for payload data. We check all possible | |
1881 | * encodings and choose the optimal encoding. | |
1882 | */ | |
1883 | static int determine_crypto_len(struct tx_helper *h, | |
1884 | OSSL_QUIC_FRAME_CRYPTO *chdr, | |
1885 | size_t space_left, | |
1886 | uint64_t *hlen, | |
1887 | uint64_t *len) | |
1888 | { | |
1889 | size_t orig_len; | |
1890 | size_t base_hdr_len; /* CRYPTO header length without length field */ | |
1891 | ||
1892 | if (chdr->len > SIZE_MAX) | |
1893 | return 0; | |
1894 | ||
1895 | orig_len = (size_t)chdr->len; | |
1896 | ||
1897 | chdr->len = 0; | |
1898 | base_hdr_len = ossl_quic_wire_get_encoded_frame_len_crypto_hdr(chdr); | |
1899 | chdr->len = orig_len; | |
1900 | if (base_hdr_len == 0) | |
1901 | return 0; | |
1902 | ||
1903 | --base_hdr_len; | |
1904 | ||
cf06f347 | 1905 | return determine_len(space_left, orig_len, base_hdr_len, hlen, len); |
a73078b7 HL |
1906 | } |
1907 | ||
1908 | static int determine_stream_len(struct tx_helper *h, | |
1909 | OSSL_QUIC_FRAME_STREAM *shdr, | |
1910 | size_t space_left, | |
1911 | uint64_t *hlen, | |
1912 | uint64_t *len) | |
1913 | { | |
1914 | size_t orig_len; | |
1915 | size_t base_hdr_len; /* STREAM header length without length field */ | |
1916 | ||
1917 | if (shdr->len > SIZE_MAX) | |
1918 | return 0; | |
1919 | ||
1920 | orig_len = (size_t)shdr->len; | |
1921 | ||
1922 | shdr->len = 0; | |
1923 | base_hdr_len = ossl_quic_wire_get_encoded_frame_len_stream_hdr(shdr); | |
1924 | shdr->len = orig_len; | |
1925 | if (base_hdr_len == 0) | |
1926 | return 0; | |
1927 | ||
1928 | if (shdr->has_explicit_len) | |
1929 | --base_hdr_len; | |
1930 | ||
cf06f347 | 1931 | return determine_len(space_left, orig_len, base_hdr_len, hlen, len); |
a73078b7 HL |
1932 | } |
1933 | ||
1934 | static int txp_generate_crypto_frames(OSSL_QUIC_TX_PACKETISER *txp, | |
faebafda | 1935 | struct txp_pkt *pkt, |
091f532e | 1936 | int *have_ack_eliciting) |
a73078b7 | 1937 | { |
faebafda HL |
1938 | const uint32_t enc_level = pkt->h.enc_level; |
1939 | const uint32_t pn_space = ossl_quic_enc_level_to_pn_space(enc_level); | |
1940 | QUIC_TXPIM_PKT *tpkt = pkt->tpkt; | |
1941 | struct tx_helper *h = &pkt->h; | |
a73078b7 HL |
1942 | size_t num_stream_iovec; |
1943 | OSSL_QUIC_FRAME_STREAM shdr = {0}; | |
1944 | OSSL_QUIC_FRAME_CRYPTO chdr = {0}; | |
1945 | OSSL_QTX_IOVEC iov[2]; | |
1946 | uint64_t hdr_bytes; | |
1947 | WPACKET *wpkt; | |
24c1be5c | 1948 | QUIC_TXPIM_CHUNK chunk = {0}; |
a73078b7 HL |
1949 | size_t i, space_left; |
1950 | ||
1951 | for (i = 0;; ++i) { | |
1952 | space_left = tx_helper_get_space_left(h); | |
1953 | ||
1954 | if (space_left < MIN_FRAME_SIZE_CRYPTO) | |
1955 | return 1; /* no point trying */ | |
1956 | ||
1957 | /* Do we have any CRYPTO data waiting? */ | |
1958 | num_stream_iovec = OSSL_NELEM(iov); | |
1959 | if (!ossl_quic_sstream_get_stream_frame(txp->args.crypto[pn_space], | |
1960 | i, &shdr, iov, | |
1961 | &num_stream_iovec)) | |
1962 | return 1; /* nothing to do */ | |
1963 | ||
1964 | /* Convert STREAM frame header to CRYPTO frame header */ | |
1965 | chdr.offset = shdr.offset; | |
1966 | chdr.len = shdr.len; | |
1967 | ||
1968 | if (chdr.len == 0) | |
1969 | return 1; /* nothing to do */ | |
1970 | ||
1971 | /* Find best fit (header length, payload length) combination. */ | |
1972 | if (!determine_crypto_len(h, &chdr, space_left, &hdr_bytes, | |
cf06f347 | 1973 | &chdr.len)) |
a73078b7 | 1974 | return 1; /* can't fit anything */ |
a73078b7 HL |
1975 | |
1976 | /* | |
1977 | * Truncate IOVs to match our chosen length. | |
1978 | * | |
1979 | * The length cannot be more than SIZE_MAX because this length comes | |
1980 | * from our send stream buffer. | |
1981 | */ | |
1982 | ossl_quic_sstream_adjust_iov((size_t)chdr.len, iov, num_stream_iovec); | |
1983 | ||
1984 | /* | |
1985 | * Ensure we have enough iovecs allocated (1 for the header, up to 2 for | |
1986 | * the the stream data.) | |
1987 | */ | |
faebafda | 1988 | if (!txp_el_ensure_iovec(&txp->el[enc_level], h->num_iovec + 3)) |
a73078b7 HL |
1989 | return 0; /* alloc error */ |
1990 | ||
1991 | /* Encode the header. */ | |
1992 | wpkt = tx_helper_begin(h); | |
1993 | if (wpkt == NULL) | |
1994 | return 0; /* alloc error */ | |
1995 | ||
1996 | if (!ossl_quic_wire_encode_frame_crypto_hdr(wpkt, &chdr)) { | |
1997 | tx_helper_rollback(h); | |
1998 | return 1; /* can't fit */ | |
1999 | } | |
2000 | ||
2001 | if (!tx_helper_commit(h)) | |
2002 | return 0; /* alloc error */ | |
2003 | ||
2004 | /* Add payload iovecs to the helper (infallible). */ | |
2005 | for (i = 0; i < num_stream_iovec; ++i) | |
2006 | tx_helper_append_iovec(h, iov[i].buf, iov[i].buf_len); | |
2007 | ||
2008 | *have_ack_eliciting = 1; | |
2009 | tx_helper_unrestrict(h); /* no longer need PING */ | |
2010 | ||
2011 | /* Log chunk to TXPIM. */ | |
2012 | chunk.stream_id = UINT64_MAX; /* crypto stream */ | |
2013 | chunk.start = chdr.offset; | |
2014 | chunk.end = chdr.offset + chdr.len - 1; | |
2015 | chunk.has_fin = 0; /* Crypto stream never ends */ | |
2016 | if (!ossl_quic_txpim_pkt_append_chunk(tpkt, &chunk)) | |
2017 | return 0; /* alloc error */ | |
2018 | } | |
2019 | } | |
2020 | ||
2021 | struct chunk_info { | |
2022 | OSSL_QUIC_FRAME_STREAM shdr; | |
2023 | OSSL_QTX_IOVEC iov[2]; | |
2024 | size_t num_stream_iovec; | |
091f532e | 2025 | int valid; |
a73078b7 HL |
2026 | }; |
2027 | ||
2028 | static int txp_plan_stream_chunk(OSSL_QUIC_TX_PACKETISER *txp, | |
2029 | struct tx_helper *h, | |
2030 | QUIC_SSTREAM *sstream, | |
2031 | QUIC_TXFC *stream_txfc, | |
2032 | size_t skip, | |
2033 | struct chunk_info *chunk) | |
2034 | { | |
2035 | uint64_t fc_credit, fc_swm, fc_limit; | |
2036 | ||
2037 | chunk->num_stream_iovec = OSSL_NELEM(chunk->iov); | |
2038 | chunk->valid = ossl_quic_sstream_get_stream_frame(sstream, skip, | |
2039 | &chunk->shdr, | |
2040 | chunk->iov, | |
2041 | &chunk->num_stream_iovec); | |
2042 | if (!chunk->valid) | |
2043 | return 1; | |
2044 | ||
2045 | if (!ossl_assert(chunk->shdr.len > 0 || chunk->shdr.is_fin)) | |
2046 | /* Should only have 0-length chunk if FIN */ | |
2047 | return 0; | |
2048 | ||
2049 | /* Clamp according to connection and stream-level TXFC. */ | |
2050 | fc_credit = ossl_quic_txfc_get_credit(stream_txfc); | |
2051 | fc_swm = ossl_quic_txfc_get_swm(stream_txfc); | |
2052 | fc_limit = fc_swm + fc_credit; | |
2053 | ||
2054 | if (chunk->shdr.len > 0 && chunk->shdr.offset + chunk->shdr.len > fc_limit) { | |
2055 | chunk->shdr.len = (fc_limit <= chunk->shdr.offset) | |
2056 | ? 0 : fc_limit - chunk->shdr.offset; | |
2057 | chunk->shdr.is_fin = 0; | |
2058 | } | |
2059 | ||
2060 | if (chunk->shdr.len == 0 && !chunk->shdr.is_fin) { | |
2061 | /* | |
2062 | * Nothing to do due to TXFC. Since SSTREAM returns chunks in ascending | |
2063 | * order of offset we don't need to check any later chunks, so stop | |
2064 | * iterating here. | |
2065 | */ | |
2066 | chunk->valid = 0; | |
2067 | return 1; | |
2068 | } | |
2069 | ||
2070 | return 1; | |
2071 | } | |
2072 | ||
2073 | /* | |
2074 | * Returns 0 on fatal error (e.g. allocation failure), 1 on success. | |
2075 | * *packet_full is set to 1 if there is no longer enough room for another STREAM | |
2076 | * frame, and *stream_drained is set to 1 if all stream buffers have now been | |
2077 | * sent. | |
2078 | */ | |
2079 | static int txp_generate_stream_frames(OSSL_QUIC_TX_PACKETISER *txp, | |
faebafda | 2080 | struct txp_pkt *pkt, |
a73078b7 HL |
2081 | uint64_t id, |
2082 | QUIC_SSTREAM *sstream, | |
2083 | QUIC_TXFC *stream_txfc, | |
2084 | QUIC_STREAM *next_stream, | |
2085 | size_t min_ppl, | |
091f532e HL |
2086 | int *have_ack_eliciting, |
2087 | int *packet_full, | |
2088 | int *stream_drained, | |
a73078b7 HL |
2089 | uint64_t *new_credit_consumed) |
2090 | { | |
2091 | int rc = 0; | |
2092 | struct chunk_info chunks[2] = {0}; | |
faebafda HL |
2093 | const uint32_t enc_level = pkt->h.enc_level; |
2094 | QUIC_TXPIM_PKT *tpkt = pkt->tpkt; | |
2095 | struct tx_helper *h = &pkt->h; | |
a73078b7 HL |
2096 | OSSL_QUIC_FRAME_STREAM *shdr; |
2097 | WPACKET *wpkt; | |
2098 | QUIC_TXPIM_CHUNK chunk; | |
2099 | size_t i, j, space_left; | |
2100 | int needs_padding_if_implicit, can_fill_payload, use_explicit_len; | |
2101 | int could_have_following_chunk; | |
05f97354 | 2102 | uint64_t orig_len; |
a73078b7 HL |
2103 | uint64_t hdr_len_implicit, payload_len_implicit; |
2104 | uint64_t hdr_len_explicit, payload_len_explicit; | |
2105 | uint64_t fc_swm, fc_new_hwm; | |
2106 | ||
2107 | fc_swm = ossl_quic_txfc_get_swm(stream_txfc); | |
2108 | fc_new_hwm = fc_swm; | |
2109 | ||
2110 | /* | |
2111 | * Load the first two chunks if any offered by the send stream. We retrieve | |
2112 | * the next chunk in advance so we can determine if we need to send any more | |
2113 | * chunks from the same stream after this one, which is needed when | |
2114 | * determining when we can use an implicit length in a STREAM frame. | |
2115 | */ | |
2116 | for (i = 0; i < 2; ++i) { | |
2117 | if (!txp_plan_stream_chunk(txp, h, sstream, stream_txfc, i, &chunks[i])) | |
2118 | goto err; | |
2119 | ||
2120 | if (i == 0 && !chunks[i].valid) { | |
2121 | /* No chunks, nothing to do. */ | |
2122 | *stream_drained = 1; | |
2123 | rc = 1; | |
2124 | goto err; | |
2125 | } | |
2126 | } | |
2127 | ||
2128 | for (i = 0;; ++i) { | |
2129 | space_left = tx_helper_get_space_left(h); | |
2130 | ||
cf06f347 HL |
2131 | if (!chunks[i % 2].valid) { |
2132 | /* Out of chunks; we're done. */ | |
2133 | *stream_drained = 1; | |
a73078b7 HL |
2134 | rc = 1; |
2135 | goto err; | |
2136 | } | |
2137 | ||
cf06f347 HL |
2138 | if (space_left < MIN_FRAME_SIZE_STREAM) { |
2139 | *packet_full = 1; | |
a73078b7 HL |
2140 | rc = 1; |
2141 | goto err; | |
2142 | } | |
2143 | ||
2144 | if (!ossl_assert(!h->done_implicit)) | |
2145 | /* | |
2146 | * Logic below should have ensured we didn't append an | |
2147 | * implicit-length unless we filled the packet or didn't have | |
2148 | * another stream to handle, so this should not be possible. | |
2149 | */ | |
2150 | goto err; | |
2151 | ||
2152 | shdr = &chunks[i % 2].shdr; | |
05f97354 | 2153 | orig_len = shdr->len; |
a73078b7 HL |
2154 | if (i > 0) |
2155 | /* Load next chunk for lookahead. */ | |
2156 | if (!txp_plan_stream_chunk(txp, h, sstream, stream_txfc, i + 1, | |
2157 | &chunks[(i + 1) % 2])) | |
2158 | goto err; | |
2159 | ||
2160 | /* | |
2161 | * Find best fit (header length, payload length) combination for if we | |
2162 | * use an implicit length. | |
2163 | */ | |
2164 | shdr->has_explicit_len = 0; | |
2165 | hdr_len_implicit = payload_len_implicit = 0; | |
2166 | if (!determine_stream_len(h, shdr, space_left, | |
cf06f347 | 2167 | &hdr_len_implicit, &payload_len_implicit)) { |
a73078b7 HL |
2168 | *packet_full = 1; |
2169 | rc = 1; | |
2170 | goto err; /* can't fit anything */ | |
2171 | } | |
2172 | ||
2173 | /* | |
2174 | * If using the implicit-length representation would need padding, we | |
2175 | * can't use it. | |
2176 | */ | |
2177 | needs_padding_if_implicit = (h->bytes_appended + hdr_len_implicit | |
2178 | + payload_len_implicit < min_ppl); | |
2179 | ||
2180 | /* | |
2181 | * If there is a next stream, we don't use the implicit length so we can | |
2182 | * add more STREAM frames after this one, unless there is enough data | |
2183 | * for this STREAM frame to fill the packet. | |
2184 | */ | |
2185 | can_fill_payload = (hdr_len_implicit + payload_len_implicit | |
2186 | >= space_left); | |
2187 | ||
2188 | /* | |
2189 | * Is there is a stream after this one, or another chunk pending | |
2190 | * transmission in this stream? | |
2191 | */ | |
2192 | could_have_following_chunk | |
2193 | = (next_stream != NULL || chunks[(i + 1) % 2].valid); | |
2194 | ||
2195 | /* Choose between explicit or implicit length representations. */ | |
2196 | use_explicit_len = !((can_fill_payload || !could_have_following_chunk) | |
2197 | && !needs_padding_if_implicit); | |
2198 | ||
2199 | if (use_explicit_len) { | |
2200 | /* | |
2201 | * Find best fit (header length, payload length) combination for if | |
2202 | * we use an explicit length. | |
2203 | */ | |
2204 | shdr->has_explicit_len = 1; | |
2205 | hdr_len_explicit = payload_len_explicit = 0; | |
2206 | if (!determine_stream_len(h, shdr, space_left, | |
cf06f347 | 2207 | &hdr_len_explicit, &payload_len_explicit)) { |
a73078b7 HL |
2208 | *packet_full = 1; |
2209 | rc = 1; | |
2210 | goto err; /* can't fit anything */ | |
2211 | } | |
2212 | ||
2213 | shdr->len = payload_len_explicit; | |
2214 | } else { | |
2215 | shdr->has_explicit_len = 0; | |
2216 | shdr->len = payload_len_implicit; | |
2217 | } | |
2218 | ||
cf06f347 HL |
2219 | /* If this is a FIN, don't keep filling the packet with more FINs. */ |
2220 | if (shdr->is_fin) | |
2221 | chunks[(i + 1) % 2].valid = 0; | |
2222 | ||
553122cd HL |
2223 | /* |
2224 | * We are now committed to our length (shdr->len can't change). | |
2225 | * If we truncated the chunk, clear the FIN bit. | |
2226 | */ | |
2227 | if (shdr->len < orig_len) | |
2228 | shdr->is_fin = 0; | |
2229 | ||
a73078b7 HL |
2230 | /* Truncate IOVs to match our chosen length. */ |
2231 | ossl_quic_sstream_adjust_iov((size_t)shdr->len, chunks[i % 2].iov, | |
2232 | chunks[i % 2].num_stream_iovec); | |
2233 | ||
2234 | /* | |
2235 | * Ensure we have enough iovecs allocated (1 for the header, up to 2 for | |
2236 | * the the stream data.) | |
2237 | */ | |
faebafda | 2238 | if (!txp_el_ensure_iovec(&txp->el[enc_level], h->num_iovec + 3)) |
a73078b7 HL |
2239 | goto err; /* alloc error */ |
2240 | ||
2241 | /* Encode the header. */ | |
2242 | wpkt = tx_helper_begin(h); | |
2243 | if (wpkt == NULL) | |
2244 | goto err; /* alloc error */ | |
2245 | ||
2246 | shdr->stream_id = id; | |
2247 | if (!ossl_assert(ossl_quic_wire_encode_frame_stream_hdr(wpkt, shdr))) { | |
2248 | /* (Should not be possible.) */ | |
2249 | tx_helper_rollback(h); | |
2250 | *packet_full = 1; | |
2251 | rc = 1; | |
2252 | goto err; /* can't fit */ | |
2253 | } | |
2254 | ||
2255 | if (!tx_helper_commit(h)) | |
2256 | goto err; /* alloc error */ | |
2257 | ||
2258 | /* Add payload iovecs to the helper (infallible). */ | |
2259 | for (j = 0; j < chunks[i % 2].num_stream_iovec; ++j) | |
2260 | tx_helper_append_iovec(h, chunks[i % 2].iov[j].buf, | |
2261 | chunks[i % 2].iov[j].buf_len); | |
2262 | ||
2263 | *have_ack_eliciting = 1; | |
2264 | tx_helper_unrestrict(h); /* no longer need PING */ | |
2265 | if (!shdr->has_explicit_len) | |
2266 | h->done_implicit = 1; | |
2267 | ||
2268 | /* Log new TXFC credit which was consumed. */ | |
2269 | if (shdr->len > 0 && shdr->offset + shdr->len > fc_new_hwm) | |
2270 | fc_new_hwm = shdr->offset + shdr->len; | |
2271 | ||
2272 | /* Log chunk to TXPIM. */ | |
2273 | chunk.stream_id = shdr->stream_id; | |
2274 | chunk.start = shdr->offset; | |
2275 | chunk.end = shdr->offset + shdr->len - 1; | |
2276 | chunk.has_fin = shdr->is_fin; | |
2277 | chunk.has_stop_sending = 0; | |
2278 | chunk.has_reset_stream = 0; | |
2279 | if (!ossl_quic_txpim_pkt_append_chunk(tpkt, &chunk)) | |
2280 | goto err; /* alloc error */ | |
05f97354 HL |
2281 | |
2282 | if (shdr->len < orig_len) { | |
2283 | /* | |
2284 | * If we did not serialize all of this chunk we definitely do not | |
2285 | * want to try the next chunk (and we must not mark the stream | |
2286 | * as drained). | |
2287 | */ | |
2288 | rc = 1; | |
2289 | goto err; | |
2290 | } | |
a73078b7 HL |
2291 | } |
2292 | ||
2293 | err: | |
2294 | *new_credit_consumed = fc_new_hwm - fc_swm; | |
2295 | return rc; | |
2296 | } | |
2297 | ||
2298 | static void txp_enlink_tmp(QUIC_STREAM **tmp_head, QUIC_STREAM *stream) | |
2299 | { | |
2300 | stream->txp_next = *tmp_head; | |
2301 | *tmp_head = stream; | |
2302 | } | |
2303 | ||
2304 | static int txp_generate_stream_related(OSSL_QUIC_TX_PACKETISER *txp, | |
faebafda | 2305 | struct txp_pkt *pkt, |
a73078b7 | 2306 | size_t min_ppl, |
091f532e | 2307 | int *have_ack_eliciting, |
a73078b7 HL |
2308 | QUIC_STREAM **tmp_head) |
2309 | { | |
2310 | QUIC_STREAM_ITER it; | |
a73078b7 HL |
2311 | WPACKET *wpkt; |
2312 | uint64_t cwm; | |
2313 | QUIC_STREAM *stream, *snext; | |
faebafda | 2314 | struct tx_helper *h = &pkt->h; |
a73078b7 HL |
2315 | |
2316 | for (ossl_quic_stream_iter_init(&it, txp->args.qsm, 1); | |
2317 | it.stream != NULL;) { | |
2318 | ||
2319 | stream = it.stream; | |
2320 | ossl_quic_stream_iter_next(&it); | |
2321 | snext = it.stream; | |
2322 | ||
2323 | stream->txp_sent_fc = 0; | |
2324 | stream->txp_sent_stop_sending = 0; | |
2325 | stream->txp_sent_reset_stream = 0; | |
2326 | stream->txp_drained = 0; | |
2327 | stream->txp_blocked = 0; | |
2328 | stream->txp_txfc_new_credit_consumed = 0; | |
2329 | ||
a73078b7 HL |
2330 | /* Stream Abort Frames (STOP_SENDING, RESET_STREAM) */ |
2331 | if (stream->want_stop_sending) { | |
2332 | OSSL_QUIC_FRAME_STOP_SENDING f; | |
2333 | ||
2334 | wpkt = tx_helper_begin(h); | |
2335 | if (wpkt == NULL) | |
2336 | return 0; /* alloc error */ | |
2337 | ||
2338 | f.stream_id = stream->id; | |
2339 | f.app_error_code = stream->stop_sending_aec; | |
2340 | if (!ossl_quic_wire_encode_frame_stop_sending(wpkt, &f)) { | |
2341 | tx_helper_rollback(h); /* can't fit */ | |
2342 | txp_enlink_tmp(tmp_head, stream); | |
2343 | break; | |
2344 | } | |
2345 | ||
2346 | if (!tx_helper_commit(h)) | |
2347 | return 0; /* alloc error */ | |
2348 | ||
2349 | *have_ack_eliciting = 1; | |
2350 | tx_helper_unrestrict(h); /* no longer need PING */ | |
2351 | stream->txp_sent_stop_sending = 1; | |
2352 | } | |
2353 | ||
2354 | if (stream->want_reset_stream) { | |
2355 | OSSL_QUIC_FRAME_RESET_STREAM f; | |
2356 | ||
96b7df60 HL |
2357 | if (!ossl_assert(stream->send_state == QUIC_SSTREAM_STATE_RESET_SENT)) |
2358 | return 0; | |
01715f2b | 2359 | |
a73078b7 HL |
2360 | wpkt = tx_helper_begin(h); |
2361 | if (wpkt == NULL) | |
2362 | return 0; /* alloc error */ | |
2363 | ||
2364 | f.stream_id = stream->id; | |
2365 | f.app_error_code = stream->reset_stream_aec; | |
28d0e35c HL |
2366 | if (!ossl_quic_stream_send_get_final_size(stream, &f.final_size)) |
2367 | return 0; /* should not be possible */ | |
2368 | ||
a73078b7 HL |
2369 | if (!ossl_quic_wire_encode_frame_reset_stream(wpkt, &f)) { |
2370 | tx_helper_rollback(h); /* can't fit */ | |
2371 | txp_enlink_tmp(tmp_head, stream); | |
2372 | break; | |
2373 | } | |
2374 | ||
2375 | if (!tx_helper_commit(h)) | |
2376 | return 0; /* alloc error */ | |
2377 | ||
2378 | *have_ack_eliciting = 1; | |
2379 | tx_helper_unrestrict(h); /* no longer need PING */ | |
2380 | stream->txp_sent_reset_stream = 1; | |
7e3fa44f HL |
2381 | |
2382 | /* | |
2383 | * The final size of the stream as indicated by RESET_STREAM is used | |
2384 | * to ensure a consistent view of flow control state by both | |
2385 | * parties; if we happen to send a RESET_STREAM that consumes more | |
2386 | * flow control credit, make sure we account for that. | |
2387 | */ | |
96b7df60 HL |
2388 | if (!ossl_assert(f.final_size <= ossl_quic_txfc_get_swm(&stream->txfc))) |
2389 | return 0; | |
7e3fa44f HL |
2390 | |
2391 | stream->txp_txfc_new_credit_consumed | |
2392 | = f.final_size - ossl_quic_txfc_get_swm(&stream->txfc); | |
a73078b7 HL |
2393 | } |
2394 | ||
22f21fbd HL |
2395 | /* |
2396 | * Stream Flow Control Frames (MAX_STREAM_DATA) | |
2397 | * | |
2398 | * RFC 9000 s. 13.3: "An endpoint SHOULD stop sending MAX_STREAM_DATA | |
2399 | * frames when the receiving part of the stream enters a "Size Known" or | |
2400 | * "Reset Recvd" state." -- In practice, RECV is the only state | |
2401 | * in which it makes sense to generate more MAX_STREAM_DATA frames. | |
2402 | */ | |
2403 | if (stream->recv_state == QUIC_RSTREAM_STATE_RECV | |
a73078b7 HL |
2404 | && (stream->want_max_stream_data |
2405 | || ossl_quic_rxfc_has_cwm_changed(&stream->rxfc, 0))) { | |
2406 | ||
2407 | wpkt = tx_helper_begin(h); | |
2408 | if (wpkt == NULL) | |
2409 | return 0; /* alloc error */ | |
2410 | ||
2411 | cwm = ossl_quic_rxfc_get_cwm(&stream->rxfc); | |
2412 | ||
2413 | if (!ossl_quic_wire_encode_frame_max_stream_data(wpkt, stream->id, | |
2414 | cwm)) { | |
2415 | tx_helper_rollback(h); /* can't fit */ | |
2416 | txp_enlink_tmp(tmp_head, stream); | |
2417 | break; | |
2418 | } | |
2419 | ||
2420 | if (!tx_helper_commit(h)) | |
2421 | return 0; /* alloc error */ | |
2422 | ||
2423 | *have_ack_eliciting = 1; | |
2424 | tx_helper_unrestrict(h); /* no longer need PING */ | |
2425 | stream->txp_sent_fc = 1; | |
2426 | } | |
2427 | ||
01715f2b HL |
2428 | /* |
2429 | * Stream Data Frames (STREAM) | |
2430 | * | |
2431 | * RFC 9000 s. 3.3: A sender MUST NOT send a STREAM [...] frame for a | |
2432 | * stream in the "Reset Sent" state [or any terminal state]. We don't | |
1d547f8f | 2433 | * send any more STREAM frames if we are sending, have sent, or are |
01715f2b HL |
2434 | * planning to send, RESET_STREAM. The other terminal state is Data |
2435 | * Recvd, but txp_generate_stream_frames() is guaranteed to generate | |
2436 | * nothing in this case. | |
2437 | */ | |
2438 | if (ossl_quic_stream_has_send_buffer(stream) | |
2439 | && !ossl_quic_stream_send_is_reset(stream)) { | |
091f532e | 2440 | int packet_full = 0, stream_drained = 0; |
a73078b7 | 2441 | |
96b7df60 HL |
2442 | if (!ossl_assert(!stream->want_reset_stream)) |
2443 | return 0; | |
7e3fa44f | 2444 | |
faebafda | 2445 | if (!txp_generate_stream_frames(txp, pkt, |
a73078b7 HL |
2446 | stream->id, stream->sstream, |
2447 | &stream->txfc, | |
2448 | snext, min_ppl, | |
2449 | have_ack_eliciting, | |
2450 | &packet_full, | |
2451 | &stream_drained, | |
2452 | &stream->txp_txfc_new_credit_consumed)) { | |
2453 | /* Fatal error (allocation, etc.) */ | |
2454 | txp_enlink_tmp(tmp_head, stream); | |
2455 | return 0; | |
2456 | } | |
2457 | ||
2458 | if (stream_drained) | |
2459 | stream->txp_drained = 1; | |
2460 | ||
2461 | if (packet_full) { | |
2462 | txp_enlink_tmp(tmp_head, stream); | |
2463 | break; | |
2464 | } | |
2465 | } | |
2466 | ||
2467 | txp_enlink_tmp(tmp_head, stream); | |
2468 | } | |
2469 | ||
2470 | return 1; | |
2471 | } | |
2472 | ||
faebafda HL |
2473 | static int txp_generate_for_el(OSSL_QUIC_TX_PACKETISER *txp, |
2474 | struct txp_pkt *pkt, | |
2475 | int chosen_for_conn_close) | |
a73078b7 HL |
2476 | { |
2477 | int rc = TXP_ERR_SUCCESS; | |
faebafda HL |
2478 | const uint32_t enc_level = pkt->h.enc_level; |
2479 | const uint32_t pn_space = ossl_quic_enc_level_to_pn_space(enc_level); | |
2480 | int have_ack_eliciting = 0, done_pre_token = 0; | |
2481 | const struct archetype_data a = pkt->geom.adata; | |
178c104d HL |
2482 | /* |
2483 | * Cleared if we encode any non-ACK-eliciting frame type which rules out the | |
2484 | * packet being a non-inflight frame. This means any non-ACK ACK-eliciting | |
2485 | * frame, even PADDING frames. ACK eliciting frames always cause a packet to | |
2486 | * become ineligible for non-inflight treatment so it is not necessary to | |
2487 | * clear this in cases where have_ack_eliciting is set, as it is ignored in | |
2488 | * that case. | |
2489 | */ | |
2490 | int can_be_non_inflight = 1; | |
a73078b7 HL |
2491 | QUIC_CFQ_ITEM *cfq_item; |
2492 | QUIC_TXPIM_PKT *tpkt = NULL; | |
faebafda HL |
2493 | struct tx_helper *h = &pkt->h; |
2494 | size_t min_ppl = 0; | |
a73078b7 HL |
2495 | |
2496 | /* Maximum PN reached? */ | |
b65b0d4e | 2497 | if (!ossl_quic_pn_valid(txp->next_pn[pn_space])) |
a73078b7 HL |
2498 | goto fatal_err; |
2499 | ||
faebafda | 2500 | if (!ossl_assert(pkt->tpkt == NULL)) |
a73078b7 HL |
2501 | goto fatal_err; |
2502 | ||
faebafda | 2503 | if ((pkt->tpkt = tpkt = ossl_quic_txpim_pkt_alloc(txp->args.txpim)) == NULL) |
a73078b7 HL |
2504 | goto fatal_err; |
2505 | ||
a73078b7 HL |
2506 | /* |
2507 | * Frame Serialization | |
2508 | * =================== | |
2509 | * | |
2510 | * We now serialize frames into the packet in descending order of priority. | |
2511 | */ | |
2512 | ||
2513 | /* HANDSHAKE_DONE (Regenerate) */ | |
2514 | if (a.allow_handshake_done && txp->want_handshake_done | |
faebafda HL |
2515 | && tx_helper_get_space_left(h) >= MIN_FRAME_SIZE_HANDSHAKE_DONE) { |
2516 | WPACKET *wpkt = tx_helper_begin(h); | |
a73078b7 HL |
2517 | |
2518 | if (wpkt == NULL) | |
2519 | goto fatal_err; | |
2520 | ||
2521 | if (ossl_quic_wire_encode_frame_handshake_done(wpkt)) { | |
2522 | tpkt->had_handshake_done_frame = 1; | |
2523 | have_ack_eliciting = 1; | |
2524 | ||
faebafda | 2525 | if (!tx_helper_commit(h)) |
a73078b7 HL |
2526 | goto fatal_err; |
2527 | ||
faebafda | 2528 | tx_helper_unrestrict(h); /* no longer need PING */ |
a73078b7 | 2529 | } else { |
faebafda | 2530 | tx_helper_rollback(h); |
a73078b7 HL |
2531 | } |
2532 | } | |
2533 | ||
2534 | /* MAX_DATA (Regenerate) */ | |
2535 | if (a.allow_conn_fc | |
2536 | && (txp->want_max_data | |
2537 | || ossl_quic_rxfc_has_cwm_changed(txp->args.conn_rxfc, 0)) | |
faebafda HL |
2538 | && tx_helper_get_space_left(h) >= MIN_FRAME_SIZE_MAX_DATA) { |
2539 | WPACKET *wpkt = tx_helper_begin(h); | |
a73078b7 HL |
2540 | uint64_t cwm = ossl_quic_rxfc_get_cwm(txp->args.conn_rxfc); |
2541 | ||
2542 | if (wpkt == NULL) | |
2543 | goto fatal_err; | |
2544 | ||
2545 | if (ossl_quic_wire_encode_frame_max_data(wpkt, cwm)) { | |
2546 | tpkt->had_max_data_frame = 1; | |
2547 | have_ack_eliciting = 1; | |
2548 | ||
faebafda | 2549 | if (!tx_helper_commit(h)) |
a73078b7 HL |
2550 | goto fatal_err; |
2551 | ||
faebafda | 2552 | tx_helper_unrestrict(h); /* no longer need PING */ |
a73078b7 | 2553 | } else { |
faebafda | 2554 | tx_helper_rollback(h); |
a73078b7 HL |
2555 | } |
2556 | } | |
2557 | ||
2558 | /* MAX_STREAMS_BIDI (Regenerate) */ | |
a73078b7 | 2559 | if (a.allow_conn_fc |
a6b6ea17 HL |
2560 | && (txp->want_max_streams_bidi |
2561 | || ossl_quic_rxfc_has_cwm_changed(txp->args.max_streams_bidi_rxfc, 0)) | |
faebafda HL |
2562 | && tx_helper_get_space_left(h) >= MIN_FRAME_SIZE_MAX_STREAMS_BIDI) { |
2563 | WPACKET *wpkt = tx_helper_begin(h); | |
a6b6ea17 HL |
2564 | uint64_t max_streams |
2565 | = ossl_quic_rxfc_get_cwm(txp->args.max_streams_bidi_rxfc); | |
a73078b7 HL |
2566 | |
2567 | if (wpkt == NULL) | |
2568 | goto fatal_err; | |
2569 | ||
2570 | if (ossl_quic_wire_encode_frame_max_streams(wpkt, /*is_uni=*/0, | |
2571 | max_streams)) { | |
2572 | tpkt->had_max_streams_bidi_frame = 1; | |
2573 | have_ack_eliciting = 1; | |
2574 | ||
faebafda | 2575 | if (!tx_helper_commit(h)) |
a73078b7 HL |
2576 | goto fatal_err; |
2577 | ||
faebafda | 2578 | tx_helper_unrestrict(h); /* no longer need PING */ |
a73078b7 | 2579 | } else { |
faebafda | 2580 | tx_helper_rollback(h); |
a73078b7 HL |
2581 | } |
2582 | } | |
2583 | ||
2584 | /* MAX_STREAMS_UNI (Regenerate) */ | |
2585 | if (a.allow_conn_fc | |
a6b6ea17 HL |
2586 | && (txp->want_max_streams_uni |
2587 | || ossl_quic_rxfc_has_cwm_changed(txp->args.max_streams_uni_rxfc, 0)) | |
faebafda HL |
2588 | && tx_helper_get_space_left(h) >= MIN_FRAME_SIZE_MAX_STREAMS_UNI) { |
2589 | WPACKET *wpkt = tx_helper_begin(h); | |
a6b6ea17 HL |
2590 | uint64_t max_streams |
2591 | = ossl_quic_rxfc_get_cwm(txp->args.max_streams_uni_rxfc); | |
a73078b7 HL |
2592 | |
2593 | if (wpkt == NULL) | |
2594 | goto fatal_err; | |
2595 | ||
2596 | if (ossl_quic_wire_encode_frame_max_streams(wpkt, /*is_uni=*/1, | |
2597 | max_streams)) { | |
2598 | tpkt->had_max_streams_uni_frame = 1; | |
2599 | have_ack_eliciting = 1; | |
2600 | ||
faebafda | 2601 | if (!tx_helper_commit(h)) |
a73078b7 HL |
2602 | goto fatal_err; |
2603 | ||
faebafda | 2604 | tx_helper_unrestrict(h); /* no longer need PING */ |
a73078b7 | 2605 | } else { |
faebafda | 2606 | tx_helper_rollback(h); |
a73078b7 HL |
2607 | } |
2608 | } | |
2609 | ||
2610 | /* GCR Frames */ | |
2611 | for (cfq_item = ossl_quic_cfq_get_priority_head(txp->args.cfq, pn_space); | |
2612 | cfq_item != NULL; | |
2613 | cfq_item = ossl_quic_cfq_item_get_priority_next(cfq_item, pn_space)) { | |
2614 | uint64_t frame_type = ossl_quic_cfq_item_get_frame_type(cfq_item); | |
2615 | const unsigned char *encoded = ossl_quic_cfq_item_get_encoded(cfq_item); | |
2616 | size_t encoded_len = ossl_quic_cfq_item_get_encoded_len(cfq_item); | |
2617 | ||
2618 | switch (frame_type) { | |
2619 | case OSSL_QUIC_FRAME_TYPE_NEW_CONN_ID: | |
2620 | if (!a.allow_new_conn_id) | |
2621 | continue; | |
2622 | break; | |
2623 | case OSSL_QUIC_FRAME_TYPE_RETIRE_CONN_ID: | |
2624 | if (!a.allow_retire_conn_id) | |
2625 | continue; | |
2626 | break; | |
2627 | case OSSL_QUIC_FRAME_TYPE_NEW_TOKEN: | |
2628 | if (!a.allow_new_token) | |
2629 | continue; | |
2630 | ||
2631 | /* | |
2632 | * NEW_TOKEN frames are handled via GCR, but some | |
2633 | * Regenerate-strategy frames should come before them (namely | |
2634 | * ACK, CONNECTION_CLOSE, PATH_CHALLENGE and PATH_RESPONSE). If | |
2635 | * we find a NEW_TOKEN frame, do these now. If there are no | |
2636 | * NEW_TOKEN frames in the GCR queue we will handle these below. | |
2637 | */ | |
2638 | if (!done_pre_token) | |
faebafda | 2639 | if (txp_generate_pre_token(txp, pkt, |
178c104d HL |
2640 | chosen_for_conn_close, |
2641 | &can_be_non_inflight)) | |
a73078b7 HL |
2642 | done_pre_token = 1; |
2643 | ||
c5cb85b6 HL |
2644 | break; |
2645 | case OSSL_QUIC_FRAME_TYPE_PATH_RESPONSE: | |
2646 | if (!a.allow_path_response) | |
2647 | continue; | |
2648 | ||
2649 | /* | |
2650 | * RFC 9000 s. 8.2.2: An endpoint MUST expand datagrams that | |
2651 | * contain a PATH_RESPONSE frame to at least the smallest | |
2652 | * allowed maximum datagram size of 1200 bytes. | |
2653 | */ | |
2654 | pkt->force_pad = 1; | |
a73078b7 HL |
2655 | break; |
2656 | default: | |
2657 | if (!a.allow_cfq_other) | |
2658 | continue; | |
2659 | break; | |
2660 | } | |
2661 | ||
2662 | /* | |
2663 | * If the frame is too big, don't try to schedule any more GCR frames in | |
2664 | * this packet rather than sending subsequent ones out of order. | |
2665 | */ | |
faebafda | 2666 | if (encoded_len > tx_helper_get_space_left(h)) |
a73078b7 HL |
2667 | break; |
2668 | ||
faebafda | 2669 | if (!tx_helper_append_iovec(h, encoded, encoded_len)) |
a73078b7 HL |
2670 | goto fatal_err; |
2671 | ||
2672 | ossl_quic_txpim_pkt_add_cfq_item(tpkt, cfq_item); | |
2673 | ||
2674 | if (ossl_quic_frame_type_is_ack_eliciting(frame_type)) { | |
2675 | have_ack_eliciting = 1; | |
faebafda | 2676 | tx_helper_unrestrict(h); /* no longer need PING */ |
a73078b7 HL |
2677 | } |
2678 | } | |
2679 | ||
2680 | /* | |
2681 | * If we didn't generate ACK, CONNECTION_CLOSE, PATH_CHALLENGE or | |
2682 | * PATH_RESPONSE (as desired) before, do so now. | |
2683 | */ | |
2684 | if (!done_pre_token) | |
faebafda | 2685 | if (txp_generate_pre_token(txp, pkt, |
178c104d HL |
2686 | chosen_for_conn_close, |
2687 | &can_be_non_inflight)) | |
a73078b7 HL |
2688 | done_pre_token = 1; |
2689 | ||
2690 | /* CRYPTO Frames */ | |
2691 | if (a.allow_crypto) | |
faebafda | 2692 | if (!txp_generate_crypto_frames(txp, pkt, &have_ack_eliciting)) |
a73078b7 HL |
2693 | goto fatal_err; |
2694 | ||
2695 | /* Stream-specific frames */ | |
cda88baf | 2696 | if (a.allow_stream_rel && txp->handshake_complete) |
faebafda | 2697 | if (!txp_generate_stream_related(txp, pkt, min_ppl, |
a73078b7 | 2698 | &have_ack_eliciting, |
faebafda | 2699 | &pkt->stream_head)) |
a73078b7 HL |
2700 | goto fatal_err; |
2701 | ||
2702 | /* PING */ | |
faebafda | 2703 | tx_helper_unrestrict(h); |
a73078b7 | 2704 | |
1e2e683a HL |
2705 | if ((a.require_ack_eliciting |
2706 | || (txp->force_ack_eliciting & (1UL << pn_space)) != 0) | |
2707 | && !have_ack_eliciting && a.allow_ping) { | |
a73078b7 HL |
2708 | WPACKET *wpkt; |
2709 | ||
faebafda | 2710 | wpkt = tx_helper_begin(h); |
a73078b7 HL |
2711 | if (wpkt == NULL) |
2712 | goto fatal_err; | |
2713 | ||
2714 | if (!ossl_quic_wire_encode_frame_ping(wpkt) | |
faebafda | 2715 | || !tx_helper_commit(h)) |
a73078b7 HL |
2716 | /* |
2717 | * We treat a request to be ACK-eliciting as a requirement, so this | |
2718 | * is an error. | |
2719 | */ | |
2720 | goto fatal_err; | |
2721 | ||
2722 | have_ack_eliciting = 1; | |
2723 | } | |
2724 | ||
2725 | /* PADDING */ | |
faebafda HL |
2726 | if (a.allow_padding && h->bytes_appended < min_ppl) { |
2727 | WPACKET *wpkt = tx_helper_begin(h); | |
a73078b7 HL |
2728 | if (wpkt == NULL) |
2729 | goto fatal_err; | |
2730 | ||
faebafda HL |
2731 | if (!ossl_quic_wire_encode_padding(wpkt, min_ppl - h->bytes_appended) |
2732 | || !tx_helper_commit(h)) | |
a73078b7 | 2733 | goto fatal_err; |
178c104d HL |
2734 | |
2735 | can_be_non_inflight = 0; | |
a73078b7 HL |
2736 | } |
2737 | ||
2738 | /* | |
faebafda HL |
2739 | * ACKM Data |
2740 | * ========= | |
a73078b7 | 2741 | */ |
178c104d HL |
2742 | if (have_ack_eliciting) |
2743 | can_be_non_inflight = 0; | |
2744 | ||
a73078b7 | 2745 | /* ACKM Data */ |
faebafda | 2746 | tpkt->ackm_pkt.num_bytes = h->bytes_appended + pkt->geom.pkt_overhead; |
a73078b7 HL |
2747 | tpkt->ackm_pkt.pkt_num = txp->next_pn[pn_space]; |
2748 | /* largest_acked is set in txp_generate_pre_token */ | |
2749 | tpkt->ackm_pkt.pkt_space = pn_space; | |
178c104d | 2750 | tpkt->ackm_pkt.is_inflight = !can_be_non_inflight; |
a73078b7 HL |
2751 | tpkt->ackm_pkt.is_ack_eliciting = have_ack_eliciting; |
2752 | tpkt->ackm_pkt.is_pto_probe = 0; | |
2753 | tpkt->ackm_pkt.is_mtu_probe = 0; | |
b98c38d4 | 2754 | tpkt->ackm_pkt.time = txp->args.now(txp->args.now_arg); |
a73078b7 | 2755 | |
faebafda HL |
2756 | /* Done. */ |
2757 | return rc; | |
2758 | ||
2759 | fatal_err: | |
2760 | /* | |
2761 | * Handler for fatal errors, i.e. errors causing us to abort the entire | |
2762 | * packet rather than just one frame. Examples of such errors include | |
2763 | * allocation errors. | |
2764 | */ | |
2765 | if (tpkt != NULL) { | |
2766 | ossl_quic_txpim_pkt_release(txp->args.txpim, tpkt); | |
2767 | pkt->tpkt = NULL; | |
2768 | } | |
2769 | return TXP_ERR_INTERNAL; | |
2770 | } | |
2771 | ||
2772 | /* | |
2773 | * Commits and queues a packet for transmission. There is no backing out after | |
2774 | * this. | |
2775 | * | |
2776 | * This: | |
2777 | * | |
2778 | * - Sends the packet to the QTX for encryption and transmission; | |
2779 | * | |
2780 | * - Records the packet as having been transmitted in FIFM. ACKM is informed, | |
2781 | * etc. and the TXPIM record is filed. | |
2782 | * | |
2783 | * - Informs various subsystems of frames that were sent and clears frame | |
2784 | * wanted flags so that we do not generate the same frames again. | |
2785 | * | |
2786 | * Assumptions: | |
2787 | * | |
2788 | * - pkt is a txp_pkt for the correct EL; | |
2789 | * | |
2790 | * - pkt->tpkt is valid; | |
2791 | * | |
2792 | * - pkt->tpkt->ackm_pkt has been fully filled in; | |
2793 | * | |
2794 | * - Stream chunk records have been appended to pkt->tpkt for STREAM and | |
2795 | * CRYPTO frames, but not for RESET_STREAM or STOP_SENDING frames; | |
2796 | * | |
2797 | * - The chosen stream list for the packet can be fully walked from | |
2798 | * pkt->stream_head using stream->txp_next; | |
2799 | * | |
2800 | * - pkt->has_ack_eliciting is set correctly. | |
2801 | * | |
2802 | */ | |
2803 | static int txp_pkt_commit(OSSL_QUIC_TX_PACKETISER *txp, | |
2804 | struct txp_pkt *pkt, | |
6a2b70e2 HL |
2805 | uint32_t archetype, |
2806 | int *txpim_pkt_reffed) | |
faebafda HL |
2807 | { |
2808 | int rc = 1; | |
2809 | uint32_t enc_level = pkt->h.enc_level; | |
2810 | uint32_t pn_space = ossl_quic_enc_level_to_pn_space(enc_level); | |
2811 | QUIC_TXPIM_PKT *tpkt = pkt->tpkt; | |
2812 | QUIC_STREAM *stream; | |
2813 | OSSL_QTX_PKT txpkt; | |
2814 | struct archetype_data a; | |
2815 | ||
6a2b70e2 HL |
2816 | *txpim_pkt_reffed = 0; |
2817 | ||
faebafda HL |
2818 | /* Cannot send a packet with an empty payload. */ |
2819 | if (pkt->h.bytes_appended == 0) | |
2820 | return 0; | |
2821 | ||
2822 | if (!txp_get_archetype_data(enc_level, archetype, &a)) | |
2823 | return 0; | |
2824 | ||
a73078b7 | 2825 | /* Packet Information for QTX */ |
faebafda HL |
2826 | txpkt.hdr = &pkt->phdr; |
2827 | txpkt.iovec = txp->el[enc_level].iovec; | |
2828 | txpkt.num_iovec = pkt->h.num_iovec; | |
2829 | txpkt.local = NULL; | |
2830 | txpkt.peer = BIO_ADDR_family(&txp->args.peer) == AF_UNSPEC | |
a73078b7 | 2831 | ? NULL : &txp->args.peer; |
faebafda HL |
2832 | txpkt.pn = txp->next_pn[pn_space]; |
2833 | txpkt.flags = OSSL_QTX_PKT_FLAG_COALESCE; /* always try to coalesce */ | |
a73078b7 HL |
2834 | |
2835 | /* Generate TXPIM chunks representing STOP_SENDING and RESET_STREAM frames. */ | |
faebafda | 2836 | for (stream = pkt->stream_head; stream != NULL; stream = stream->txp_next) |
a73078b7 | 2837 | if (stream->txp_sent_stop_sending || stream->txp_sent_reset_stream) { |
faebafda | 2838 | /* Log STOP_SENDING/RESET_STREAM chunk to TXPIM. */ |
a73078b7 HL |
2839 | QUIC_TXPIM_CHUNK chunk; |
2840 | ||
2841 | chunk.stream_id = stream->id; | |
2842 | chunk.start = UINT64_MAX; | |
2843 | chunk.end = 0; | |
2844 | chunk.has_fin = 0; | |
2845 | chunk.has_stop_sending = stream->txp_sent_stop_sending; | |
2846 | chunk.has_reset_stream = stream->txp_sent_reset_stream; | |
2847 | if (!ossl_quic_txpim_pkt_append_chunk(tpkt, &chunk)) | |
2848 | return 0; /* alloc error */ | |
2849 | } | |
2850 | ||
2851 | /* Dispatch to FIFD. */ | |
2852 | if (!ossl_quic_fifd_pkt_commit(&txp->fifd, tpkt)) | |
faebafda | 2853 | return 0; |
a73078b7 | 2854 | |
faebafda | 2855 | /* |
ed75eb32 HL |
2856 | * Transmission and Post-Packet Generation Bookkeeping |
2857 | * =================================================== | |
faebafda | 2858 | * |
ed75eb32 HL |
2859 | * No backing out anymore - at this point the ACKM has recorded the packet |
2860 | * as having been sent, so we need to increment our next PN counter, or | |
2861 | * the ACKM will complain when we try to record a duplicate packet with | |
2862 | * the same PN later. At this point actually sending the packet may still | |
2863 | * fail. In this unlikely event it will simply be handled as though it | |
2864 | * were a lost packet. | |
faebafda | 2865 | */ |
a73078b7 | 2866 | ++txp->next_pn[pn_space]; |
6a2b70e2 | 2867 | *txpim_pkt_reffed = 1; |
a73078b7 | 2868 | |
ed75eb32 HL |
2869 | /* Send the packet. */ |
2870 | if (!ossl_qtx_write_pkt(txp->args.qtx, &txpkt)) | |
2871 | return 0; | |
2872 | ||
a73078b7 HL |
2873 | /* |
2874 | * Record FC and stream abort frames as sent; deactivate streams which no | |
2875 | * longer have anything to do. | |
2876 | */ | |
faebafda | 2877 | for (stream = pkt->stream_head; stream != NULL; stream = stream->txp_next) { |
a73078b7 HL |
2878 | if (stream->txp_sent_fc) { |
2879 | stream->want_max_stream_data = 0; | |
2880 | ossl_quic_rxfc_has_cwm_changed(&stream->rxfc, 1); | |
2881 | } | |
2882 | ||
2883 | if (stream->txp_sent_stop_sending) | |
2884 | stream->want_stop_sending = 0; | |
2885 | ||
2886 | if (stream->txp_sent_reset_stream) | |
2887 | stream->want_reset_stream = 0; | |
2888 | ||
2889 | if (stream->txp_txfc_new_credit_consumed > 0) { | |
2890 | if (!ossl_assert(ossl_quic_txfc_consume_credit(&stream->txfc, | |
2891 | stream->txp_txfc_new_credit_consumed))) | |
2892 | /* | |
2893 | * Should not be possible, but we should continue with our | |
2894 | * bookkeeping as we have already committed the packet to the | |
2895 | * FIFD. Just change the value we return. | |
2896 | */ | |
faebafda | 2897 | rc = 0; |
a73078b7 HL |
2898 | |
2899 | stream->txp_txfc_new_credit_consumed = 0; | |
2900 | } | |
2901 | ||
2902 | /* | |
2903 | * If we no longer need to generate any flow control (MAX_STREAM_DATA), | |
2904 | * STOP_SENDING or RESET_STREAM frames, nor any STREAM frames (because | |
2905 | * the stream is drained of data or TXFC-blocked), we can mark the | |
2906 | * stream as inactive. | |
2907 | */ | |
2908 | ossl_quic_stream_map_update_state(txp->args.qsm, stream); | |
2909 | ||
c068f4d1 | 2910 | if (stream->txp_drained) { |
05f97354 | 2911 | assert(!ossl_quic_sstream_has_pending(stream->sstream)); |
c068f4d1 HL |
2912 | |
2913 | /* | |
2914 | * Transition to DATA_SENT if stream has a final size and we have | |
2915 | * sent all data. | |
2916 | */ | |
2917 | if (ossl_quic_sstream_get_final_size(stream->sstream, NULL)) | |
2918 | ossl_quic_stream_map_notify_all_data_sent(txp->args.qsm, stream); | |
2919 | } | |
a73078b7 HL |
2920 | } |
2921 | ||
2922 | /* We have now sent the packet, so update state accordingly. */ | |
faebafda | 2923 | if (tpkt->ackm_pkt.is_ack_eliciting) |
a73078b7 HL |
2924 | txp->force_ack_eliciting &= ~(1UL << pn_space); |
2925 | ||
2926 | if (tpkt->had_handshake_done_frame) | |
2927 | txp->want_handshake_done = 0; | |
2928 | ||
2929 | if (tpkt->had_max_data_frame) { | |
2930 | txp->want_max_data = 0; | |
2931 | ossl_quic_rxfc_has_cwm_changed(txp->args.conn_rxfc, 1); | |
2932 | } | |
2933 | ||
a6b6ea17 | 2934 | if (tpkt->had_max_streams_bidi_frame) { |
a73078b7 | 2935 | txp->want_max_streams_bidi = 0; |
a6b6ea17 HL |
2936 | ossl_quic_rxfc_has_cwm_changed(txp->args.max_streams_bidi_rxfc, 1); |
2937 | } | |
a73078b7 | 2938 | |
a6b6ea17 | 2939 | if (tpkt->had_max_streams_uni_frame) { |
a73078b7 | 2940 | txp->want_max_streams_uni = 0; |
a6b6ea17 HL |
2941 | ossl_quic_rxfc_has_cwm_changed(txp->args.max_streams_uni_rxfc, 1); |
2942 | } | |
a73078b7 HL |
2943 | |
2944 | if (tpkt->had_ack_frame) | |
2945 | txp->want_ack &= ~(1UL << pn_space); | |
2946 | ||
fee8f48e HL |
2947 | /* |
2948 | * Decrement probe request counts if we have sent a packet that meets | |
2949 | * the requirement of a probe, namely being ACK-eliciting. | |
2950 | */ | |
faebafda HL |
2951 | if (tpkt->ackm_pkt.is_ack_eliciting) { |
2952 | OSSL_ACKM_PROBE_INFO *probe_info | |
2953 | = ossl_ackm_get0_probe_request(txp->args.ackm); | |
2954 | ||
fee8f48e HL |
2955 | if (enc_level == QUIC_ENC_LEVEL_INITIAL |
2956 | && probe_info->anti_deadlock_initial > 0) | |
2957 | --probe_info->anti_deadlock_initial; | |
2958 | ||
2959 | if (enc_level == QUIC_ENC_LEVEL_HANDSHAKE | |
2960 | && probe_info->anti_deadlock_handshake > 0) | |
2961 | --probe_info->anti_deadlock_handshake; | |
2962 | ||
2963 | if (a.allow_force_ack_eliciting /* (i.e., not for 0-RTT) */ | |
2964 | && probe_info->pto[pn_space] > 0) | |
2965 | --probe_info->pto[pn_space]; | |
2966 | } | |
2967 | ||
a73078b7 | 2968 | return rc; |
a73078b7 HL |
2969 | } |
2970 | ||
2971 | /* Ensure the iovec array is at least num elements long. */ | |
faebafda | 2972 | static int txp_el_ensure_iovec(struct txp_el *el, size_t num) |
a73078b7 HL |
2973 | { |
2974 | OSSL_QTX_IOVEC *iovec; | |
2975 | ||
faebafda | 2976 | if (el->alloc_iovec >= num) |
a73078b7 HL |
2977 | return 1; |
2978 | ||
faebafda | 2979 | num = el->alloc_iovec != 0 ? el->alloc_iovec * 2 : 8; |
a73078b7 | 2980 | |
faebafda | 2981 | iovec = OPENSSL_realloc(el->iovec, sizeof(OSSL_QTX_IOVEC) * num); |
a73078b7 HL |
2982 | if (iovec == NULL) |
2983 | return 0; | |
2984 | ||
faebafda HL |
2985 | el->iovec = iovec; |
2986 | el->alloc_iovec = num; | |
a73078b7 HL |
2987 | return 1; |
2988 | } | |
2989 | ||
2990 | int ossl_quic_tx_packetiser_schedule_conn_close(OSSL_QUIC_TX_PACKETISER *txp, | |
2991 | const OSSL_QUIC_FRAME_CONN_CLOSE *f) | |
2992 | { | |
2993 | char *reason = NULL; | |
2994 | size_t reason_len = f->reason_len; | |
2995 | size_t max_reason_len = txp_get_mdpl(txp) / 2; | |
2996 | ||
2997 | if (txp->want_conn_close) | |
2998 | return 0; | |
2999 | ||
3000 | /* | |
3001 | * Arbitrarily limit the length of the reason length string to half of the | |
3002 | * MDPL. | |
3003 | */ | |
3004 | if (reason_len > max_reason_len) | |
3005 | reason_len = max_reason_len; | |
3006 | ||
3007 | if (reason_len > 0) { | |
3008 | reason = OPENSSL_memdup(f->reason, reason_len); | |
3009 | if (reason == NULL) | |
3010 | return 0; | |
3011 | } | |
3012 | ||
3013 | txp->conn_close_frame = *f; | |
3014 | txp->conn_close_frame.reason = reason; | |
3015 | txp->conn_close_frame.reason_len = reason_len; | |
3016 | txp->want_conn_close = 1; | |
3017 | return 1; | |
3018 | } | |
5cf99b40 MC |
3019 | |
3020 | void ossl_quic_tx_packetiser_set_msg_callback(OSSL_QUIC_TX_PACKETISER *txp, | |
3021 | ossl_msg_cb msg_callback, | |
c2786c8e | 3022 | SSL *msg_callback_ssl) |
5cf99b40 MC |
3023 | { |
3024 | txp->msg_callback = msg_callback; | |
c2786c8e | 3025 | txp->msg_callback_ssl = msg_callback_ssl; |
5cf99b40 MC |
3026 | } |
3027 | ||
3028 | void ossl_quic_tx_packetiser_set_msg_callback_arg(OSSL_QUIC_TX_PACKETISER *txp, | |
3029 | void *msg_callback_arg) | |
3030 | { | |
3031 | txp->msg_callback_arg = msg_callback_arg; | |
3032 | } | |
007f9e99 HL |
3033 | |
3034 | QUIC_PN ossl_quic_tx_packetiser_get_next_pn(OSSL_QUIC_TX_PACKETISER *txp, | |
3035 | uint32_t pn_space) | |
3036 | { | |
3037 | if (pn_space >= QUIC_PN_SPACE_NUM) | |
3038 | return UINT64_MAX; | |
3039 | ||
3040 | return txp->next_pn[pn_space]; | |
3041 | } | |
c206f2aa HL |
3042 | |
3043 | OSSL_TIME ossl_quic_tx_packetiser_get_deadline(OSSL_QUIC_TX_PACKETISER *txp) | |
3044 | { | |
3045 | /* | |
3046 | * TXP-specific deadline computations which rely on TXP innards. This is in | |
3047 | * turn relied on by the QUIC_CHANNEL code to determine the channel event | |
3048 | * handling deadline. | |
3049 | */ | |
3050 | OSSL_TIME deadline = ossl_time_infinite(); | |
3051 | uint32_t enc_level, pn_space; | |
3052 | ||
3053 | /* | |
3054 | * ACK generation is not CC-gated - packets containing only ACKs are allowed | |
3055 | * to bypass CC. We want to generate ACK frames even if we are currently | |
3056 | * restricted by CC so the peer knows we have received data. The generate | |
3057 | * call will take care of selecting the correct packet archetype. | |
3058 | */ | |
3059 | for (enc_level = QUIC_ENC_LEVEL_INITIAL; | |
3060 | enc_level < QUIC_ENC_LEVEL_NUM; | |
3061 | ++enc_level) | |
3062 | if (ossl_qtx_is_enc_level_provisioned(txp->args.qtx, enc_level)) { | |
3063 | pn_space = ossl_quic_enc_level_to_pn_space(enc_level); | |
3064 | deadline = ossl_time_min(deadline, | |
3065 | ossl_ackm_get_ack_deadline(txp->args.ackm, pn_space)); | |
3066 | } | |
3067 | ||
3068 | /* When will CC let us send more? */ | |
63fac76c HL |
3069 | if (txp->args.cc_method->get_tx_allowance(txp->args.cc_data) == 0) |
3070 | deadline = ossl_time_min(deadline, | |
3071 | txp->args.cc_method->get_wakeup_deadline(txp->args.cc_data)); | |
c206f2aa HL |
3072 | |
3073 | return deadline; | |
3074 | } |