2 * Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
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
10 #ifndef OSSL_QUIC_TXPIM_H
11 # define OSSL_QUIC_TXPIM_H
13 # include <openssl/ssl.h>
14 # include "internal/quic_types.h"
15 # include "internal/quic_cfq.h"
16 # include "internal/quic_ackm.h"
18 # ifndef OPENSSL_NO_QUIC
21 * QUIC Transmitted Packet Information Manager
22 * ===========================================
24 typedef struct quic_txpim_st QUIC_TXPIM;
25 typedef struct quic_fifd_st QUIC_FIFD;
27 typedef struct quic_txpim_pkt_st {
28 /* ACKM-specific data. Caller should fill this. */
29 OSSL_ACKM_TX_PKT ackm_pkt;
31 /* Linked list of CFQ items in this packet. */
32 QUIC_CFQ_ITEM *retx_head;
34 /* Reserved for FIFD use. */
37 /* Regenerate-strategy frames. */
38 unsigned int had_handshake_done_frame : 1;
39 unsigned int had_max_data_frame : 1;
40 unsigned int had_max_streams_bidi_frame : 1;
41 unsigned int had_max_streams_uni_frame : 1;
42 unsigned int had_ack_frame : 1;
44 /* Private data follows. */
47 /* Represents a range of bytes in an application or CRYPTO stream. */
48 typedef struct quic_txpim_chunk_st {
49 /* The stream ID, or UINT64_MAX for the CRYPTO stream. */
52 * The inclusive range of bytes in the stream. Exceptionally, if end <
53 * start, designates a frame of zero length (used for FIN-only frames). In
54 * this case end is the number of the final byte (i.e., one less than the
55 * final size of the stream).
59 * Whether a FIN was sent for this stream in the packet. Not valid for
62 unsigned int has_fin : 1;
64 * If set, a STOP_SENDING frame was sent for this stream ID. (If no data was
65 * sent for the stream, set end < start.)
67 unsigned int has_stop_sending : 1;
69 * If set, a RESET_STREAM frame was sent for this stream ID. (If no data was
70 * sent for the stream, set end < start.)
72 unsigned int has_reset_stream : 1;
75 QUIC_TXPIM *ossl_quic_txpim_new(void);
78 * Frees the TXPIM. All QUIC_TXPIM_PKTs which have been handed out by the TXPIM
79 * must be released via a call to ossl_quic_txpim_pkt_release() before calling
82 void ossl_quic_txpim_free(QUIC_TXPIM *txpim);
85 * Allocates a new QUIC_TXPIM_PKT structure from the pool. Returns NULL on
86 * failure. The returned structure is cleared of all data and is in a fresh
89 QUIC_TXPIM_PKT *ossl_quic_txpim_pkt_alloc(QUIC_TXPIM *txpim);
92 * Releases the TXPIM packet, returning it to the pool.
94 void ossl_quic_txpim_pkt_release(QUIC_TXPIM *txpim, QUIC_TXPIM_PKT *fpkt);
96 /* Clears the chunk list of the packet, removing all entries. */
97 void ossl_quic_txpim_pkt_clear_chunks(QUIC_TXPIM_PKT *fpkt);
99 /* Appends a chunk to the packet. The structure is copied. */
100 int ossl_quic_txpim_pkt_append_chunk(QUIC_TXPIM_PKT *fpkt,
101 const QUIC_TXPIM_CHUNK *chunk);
103 /* Adds a CFQ item to the packet by prepending it to the retx_head list. */
104 void ossl_quic_txpim_pkt_add_cfq_item(QUIC_TXPIM_PKT *fpkt,
105 QUIC_CFQ_ITEM *item);
108 * Returns a pointer to an array of stream chunk information structures for the
109 * given packet. The caller must call ossl_quic_txpim_pkt_get_num_chunks() to
110 * determine the length of this array. The returned pointer is invalidated
111 * if the chunk list is mutated, for example via a call to
112 * ossl_quic_txpim_pkt_append_chunk() or ossl_quic_txpim_pkt_clear_chunks().
114 * The chunks are sorted by (stream_id, start) in ascending order.
116 const QUIC_TXPIM_CHUNK *ossl_quic_txpim_pkt_get_chunks(const QUIC_TXPIM_PKT *fpkt);
119 * Returns the number of entries in the array returned by
120 * ossl_quic_txpim_pkt_get_chunks().
122 size_t ossl_quic_txpim_pkt_get_num_chunks(const QUIC_TXPIM_PKT *fpkt);
125 * Returns the number of QUIC_TXPIM_PKTs allocated by the given TXPIM that have
126 * yet to be returned to the TXPIM.
128 size_t ossl_quic_txpim_get_in_use(const QUIC_TXPIM *txpim);