xref: /lsquic/src/liblsquic/lsquic_parse_gquic_be.h

/* Copyright (c) 2017 - 2022 LiteSpeed Technologies Inc.  See LICENSE. */
#ifndef LSQUIC_PARSE_GQUIC_BE_H
#define LSQUIC_PARSE_GQUIC_BE_H

/* Header file to make it easy to reference gQUIC parsing functions.  This
 * is only meant to be used internally.  The alternative would be to place
 * all gQUIC-big-endian functions -- from all versions -- in a single file,
 * and that would be a mess.
 */

#define CHECK_SPACE(need, pstart, pend)  \
    do { if ((intptr_t) (need) > ((pend) - (pstart))) { return -1; } } while (0)

uint64_t
lsquic_gquic_be_read_float_time16 (const void *mem);

void
lsquic_gquic_be_write_float_time16 (lsquic_time_t time_us, void *mem);

void
lsquic_gquic_be_parse_packet_in_finish (lsquic_packet_in_t *packet_in,
                                            struct packin_parse_state *state);

int
lsquic_gquic_be_gen_ver_nego_pkt (unsigned char *buf, size_t bufsz,
                    const lsquic_cid_t *, unsigned version_bitmask);

int
lsquic_gquic_be_gen_stream_frame (unsigned char *buf, size_t buf_len,
    lsquic_stream_id_t stream_id, uint64_t offset, int fin, size_t size,
    gsf_read_f gsf_read, void *stream);

int
lsquic_gquic_be_parse_stream_frame (const unsigned char *buf, size_t rem_packet_sz,
                       stream_frame_t *stream_frame);

lsquic_packno_t
lsquic_gquic_be_parse_ack_high (const unsigned char *buf, size_t buf_len);

int
lsquic_gquic_be_parse_ack_frame (const unsigned char *buf, size_t buf_len,
                                                struct ack_info *, uint8_t);

int
lsquic_gquic_be_gen_stop_waiting_frame(unsigned char *buf, size_t buf_len,
                lsquic_packno_t cur_packno, enum packno_bits bits,
                lsquic_packno_t least_unacked_packno);

int
lsquic_gquic_be_parse_stop_waiting_frame (const unsigned char *buf, size_t buf_len,
                 lsquic_packno_t cur_packno, enum packno_bits bits,
                 lsquic_packno_t *least_unacked);

int
lsquic_gquic_be_skip_stop_waiting_frame (size_t buf_len, enum packno_bits bits);

int
lsquic_gquic_be_gen_window_update_frame (unsigned char *buf, int buf_len,
                            lsquic_stream_id_t stream_id, uint64_t offset);

int
lsquic_gquic_be_parse_window_update_frame (const unsigned char *buf, size_t buf_len,
                              lsquic_stream_id_t *stream_id, uint64_t *offset);

int
lsquic_gquic_be_gen_blocked_frame (unsigned char *buf, size_t buf_len,
                            lsquic_stream_id_t stream_id);

int
lsquic_gquic_be_parse_blocked_frame (const unsigned char *buf, size_t buf_len,
                                                lsquic_stream_id_t *stream_id);

int
lsquic_gquic_be_gen_rst_frame (unsigned char *buf, size_t buf_len,
        lsquic_stream_id_t stream_id, uint64_t offset, uint64_t error_code);

int
lsquic_gquic_be_parse_rst_frame (const unsigned char *buf, size_t buf_len,
    lsquic_stream_id_t *stream_id, uint64_t *offset, uint64_t *error_code);

int
lsquic_gquic_be_gen_ping_frame (unsigned char *buf, int buf_len);

size_t
lsquic_gquic_be_connect_close_frame_size (int app_error, unsigned error_code,
                                unsigned frame_type, size_t reason_len);

int
lsquic_gquic_be_gen_connect_close_frame (unsigned char *buf, size_t buf_len,
    int app_error, unsigned error_code, const char *reason, int reason_len);

int
lsquic_gquic_be_parse_connect_close_frame (const unsigned char *buf, size_t buf_len,
        int *app_error, uint64_t *error_code,
        uint16_t *reason_len, uint8_t *reason_offset);

int
lsquic_gquic_be_gen_goaway_frame(unsigned char *buf, size_t buf_len, uint32_t error_code,
                     lsquic_stream_id_t last_good_stream_id, const char *reason,
                     size_t reason_len);

int
lsquic_gquic_be_parse_goaway_frame (const unsigned char *buf, size_t buf_len,
               uint32_t *error_code, lsquic_stream_id_t *last_good_stream_id,
                       uint16_t *reason_length, const char **reason);

int
lsquic_gquic_be_gen_ack_frame (unsigned char *outbuf, size_t outbuf_sz,
        gaf_rechist_first_f rechist_first, gaf_rechist_next_f rechist_next,
        gaf_rechist_largest_recv_f rechist_largest_recv,
        void *rechist, lsquic_time_t now, int *has_missing, lsquic_packno_t *,
        const uint64_t *);

int
lsquic_gquic_be_dec_stream_frame_size (unsigned char *buf, size_t new_size);

#endif