include/internal/quic_txpim.h

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