xref: /freebsd/crypto/openssl/include/internal/quic_strm_reas.h (revision f9bc005b8ef3b507a5ecbc2d7fe4411ef70eff38)

/*
 * Copyright 2022-2026 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#ifndef OSSL_QUIC_STRM_REAS_H
#define OSSL_QUIC_STRM_REAS_H

#include "internal/common.h"
#include "internal/uint_set.h"
#include "internal/quic_record_rx.h"

#ifndef OPENSSL_NO_QUIC
#include "internal/ossl_rbtree.h"

typedef struct sframe_set_t {
    OSSL_RBT_HEAD(srange, sframe_set_t)
    ranges;
    /* Is the tail frame final. */
    unsigned int fin;
    uint64_t fin_off;
    /* Number of stream frames in the list. */
    size_t stream_ranges;
    size_t stream_chunks;
    /* Offset of data not yet dropped */
    uint64_t offset;
    /* Cleanse data on release? */
    int cleanse;
    int move_buffers;
    QUIC_RSTREAM_QPARM *rsqp;
} SFRAME_SET;

/*
 * Initializes the stream frame list fs.
 */
void ossl_sframe_set_init(SFRAME_SET *fs, QUIC_RSTREAM_QPARM *rsqp);

/*
 * Destroys the stream frame list fs releasing any data
 * still present inside it.
 */
void ossl_sframe_set_destroy_ranges(SFRAME_SET *fs);

/*
 * Insert a stream frame data into the list.
 * The data covers an offset range (range.start is inclusive,
 * range.end is exclusive).
 * fin should be set if this is the final frame of the stream.
 * Returns an error if a frame cannot be inserted - due to
 * STREAM_FRAME allocation error, or in case of erroneous
 * fin flag.
 */
int ossl_sframe_set_insert(SFRAME_SET *fs, UINT_RANGE *range,
    OSSL_QRX_PKT *pkt,
    const unsigned char *data, int fin);

/*
 * Iterator to peek at the contiguous frames at the beginning
 * of the frame set (the first stream range).
 * The *data covers an offset range (range.start is inclusive,
 * range.end is exclusive).
 * *fin is set if this is the final frame of the stream.
 * Opaque iterator *iter can be used to peek at the subsequent
 * frame if there is any without any gap before it.
 * Returns 1 on success.
 * Returns 0 if there is no further contiguous frame. In that
 * case *fin is set, if the end of the stream is reached.
 */
int ossl_sframe_set_peek(SFRAME_SET *fs, void **iter,
    UINT_RANGE *range, const unsigned char **data,
    int *fin);

/*
 * moves reading offset to new position, discarding all consumed
 * chunks (which end offset is less than offset).
 */
int ossl_sframe_set_move_offset(SFRAME_SET *fs, uint64_t offset);

/*
 * returns how many bytes is available to read from stream.
 */
int ossl_sframe_set_avail(SFRAME_SET *fs, uint64_t *avail, int *fin);

#endif

#endif