lsquic_parse.h revision afe3d363
17d09751dSDmitri Tikhonov/* Copyright (c) 2017 - 2020 LiteSpeed Technologies Inc.  See LICENSE. */
250aadb33SDmitri Tikhonov#ifndef LSQUIC_PARSE_H
350aadb33SDmitri Tikhonov#define LSQUIC_PARSE_H 1
450aadb33SDmitri Tikhonov
550aadb33SDmitri Tikhonov#include <stdint.h>
650aadb33SDmitri Tikhonov
750aadb33SDmitri Tikhonov#include "lsquic_packet_common.h"
85392f7a3SLiteSpeed Tech#include "lsquic_packet_gquic.h"
950aadb33SDmitri Tikhonov
105392f7a3SLiteSpeed Techstruct lsquic_conn;
1150aadb33SDmitri Tikhonovstruct lsquic_packet_in;
129626cfc2SDmitri Tikhonovstruct lsquic_packet_out;
139626cfc2SDmitri Tikhonovstruct packin_parse_state;
1450aadb33SDmitri Tikhonovstruct stream_frame;
155392f7a3SLiteSpeed Techstruct lsquic_cid;
169626cfc2SDmitri Tikhonovenum packet_out_flags;
175392f7a3SLiteSpeed Techenum lsquic_version;
185392f7a3SLiteSpeed Techenum stream_dir;
1950aadb33SDmitri Tikhonov
2050aadb33SDmitri Tikhonov
215392f7a3SLiteSpeed Techstruct ack_info
2250aadb33SDmitri Tikhonov{
235392f7a3SLiteSpeed Tech    enum packnum_space pns;
245392f7a3SLiteSpeed Tech    enum {
255392f7a3SLiteSpeed Tech        AI_ECN        = 1 << 0, /* ecn_counts[1,2,3] contain ECN counts */
265392f7a3SLiteSpeed Tech        AI_TRUNCATED  = 1 << 1, /* There were more ranges to parse, but we
275392f7a3SLiteSpeed Tech                                 * ran out of elements in `ranges'.
285392f7a3SLiteSpeed Tech                                 */
295392f7a3SLiteSpeed Tech    }               flags;
3050aadb33SDmitri Tikhonov    unsigned    n_ranges;       /* This is at least 1 */
3150aadb33SDmitri Tikhonov                                /* Largest acked is ack_info.ranges[0].high */
3250aadb33SDmitri Tikhonov    lsquic_time_t   lack_delta;
335392f7a3SLiteSpeed Tech    uint64_t        ecn_counts[4];
34bfc7bfd8SDmitri Tikhonov    struct lsquic_packno_range ranges[256];
3516a9b66aSDmitri Tikhonov};
3616a9b66aSDmitri Tikhonov
3750aadb33SDmitri Tikhonov#define largest_acked(acki) (+(acki)->ranges[0].high)
3850aadb33SDmitri Tikhonov
3950aadb33SDmitri Tikhonov#define smallest_acked(acki) (+(acki)->ranges[(acki)->n_ranges - 1].low)
4050aadb33SDmitri Tikhonov
415392f7a3SLiteSpeed Tech/* Chrome may send an empty ACK frame when it closes a connection.
425392f7a3SLiteSpeed Tech * We do not know why it occurs -- perhaps a bug in Chrome.
435392f7a3SLiteSpeed Tech */
445392f7a3SLiteSpeed Tech/* This macro cannot be used in IETF QUIC as zero is a valid packet number.
455392f7a3SLiteSpeed Tech * Hopefully the Chrome bug will have been fixed by then.
465392f7a3SLiteSpeed Tech */
475392f7a3SLiteSpeed Tech#define empty_ack_frame(acki) (largest_acked(acki) == 0)
485392f7a3SLiteSpeed Tech
4950aadb33SDmitri Tikhonov/* gaf_: generate ACK frame */
5050aadb33SDmitri Tikhonovstruct lsquic_packno_range;
5150aadb33SDmitri Tikhonovtypedef const struct lsquic_packno_range *
5250aadb33SDmitri Tikhonov    (*gaf_rechist_first_f)          (void *rechist);
5350aadb33SDmitri Tikhonovtypedef const struct lsquic_packno_range *
5450aadb33SDmitri Tikhonov    (*gaf_rechist_next_f)           (void *rechist);
5550aadb33SDmitri Tikhonovtypedef lsquic_time_t
5650aadb33SDmitri Tikhonov    (*gaf_rechist_largest_recv_f)   (void *rechist);
5750aadb33SDmitri Tikhonov
5850aadb33SDmitri Tikhonov/* gsf_: generate stream frame */
5950aadb33SDmitri Tikhonovtypedef size_t (*gsf_read_f) (void *stream, void *buf, size_t len, int *fin);
6050aadb33SDmitri Tikhonov
615392f7a3SLiteSpeed Tech/* gcf_: generate CRYPTO frame */
625392f7a3SLiteSpeed Techtypedef size_t (*gcf_read_f) (void *stream, void *buf, size_t len);
635392f7a3SLiteSpeed Tech
6450aadb33SDmitri Tikhonov/* This structure contains functions that parse and generate packets and
6550aadb33SDmitri Tikhonov * frames in version-specific manner.  To begin with, there is difference
6650aadb33SDmitri Tikhonov * between GQUIC's little-endian (Q038 and lower) and big-endian formats
675392f7a3SLiteSpeed Tech * (Q039 and higher).  Q046 and higher uses different format for packet headers.
6850aadb33SDmitri Tikhonov */
6950aadb33SDmitri Tikhonovstruct parse_funcs
7050aadb33SDmitri Tikhonov{
7150aadb33SDmitri Tikhonov    /* Return buf length */
7250aadb33SDmitri Tikhonov    int
739626cfc2SDmitri Tikhonov    (*pf_gen_reg_pkt_header) (const struct lsquic_conn *,
749626cfc2SDmitri Tikhonov                const struct lsquic_packet_out *, unsigned char *, size_t);
7550aadb33SDmitri Tikhonov    void
7650aadb33SDmitri Tikhonov    (*pf_parse_packet_in_finish) (struct lsquic_packet_in *packet_in,
7750aadb33SDmitri Tikhonov                                                struct packin_parse_state *);
786aba801dSDmitri Tikhonov    enum quic_frame_type
79feca77f5SDmitri Tikhonov    (*pf_parse_frame_type) (const unsigned char *, size_t);
8014e3680dSDmitri Tikhonov    /* Return used buffer length or a negative value if there was not enough
8114e3680dSDmitri Tikhonov     * room to write the stream frame.  In the latter case, the negative of
8214e3680dSDmitri Tikhonov     * the negative return value is the number of bytes required.  The
8314e3680dSDmitri Tikhonov     * exception is -1, which is a generic error code, as we always need
8414e3680dSDmitri Tikhonov     * more than 1 byte to write a STREAM frame.
8514e3680dSDmitri Tikhonov     */
8650aadb33SDmitri Tikhonov    int
8750aadb33SDmitri Tikhonov    (*pf_gen_stream_frame) (unsigned char *buf, size_t bufsz,
885392f7a3SLiteSpeed Tech                            lsquic_stream_id_t stream_id, uint64_t offset,
89bfc7bfd8SDmitri Tikhonov                            int fin, size_t size, gsf_read_f, void *stream);
9050aadb33SDmitri Tikhonov    int
9150aadb33SDmitri Tikhonov    (*pf_parse_stream_frame) (const unsigned char *buf, size_t rem_packet_sz,
9250aadb33SDmitri Tikhonov                                                    struct stream_frame *);
9350aadb33SDmitri Tikhonov    int
945392f7a3SLiteSpeed Tech    (*pf_parse_crypto_frame) (const unsigned char *buf, size_t rem_packet_sz,
955392f7a3SLiteSpeed Tech                                                    struct stream_frame *);
965392f7a3SLiteSpeed Tech    int
975392f7a3SLiteSpeed Tech    (*pf_gen_crypto_frame) (unsigned char *buf, size_t bufsz, uint64_t offset,
985392f7a3SLiteSpeed Tech                            size_t size, gcf_read_f, void *stream);
995392f7a3SLiteSpeed Tech    int
10050aadb33SDmitri Tikhonov    (*pf_parse_ack_frame) (const unsigned char *buf, size_t buf_len,
1015392f7a3SLiteSpeed Tech                                    struct ack_info *ack_info, uint8_t exp);
10250aadb33SDmitri Tikhonov    int
10350aadb33SDmitri Tikhonov    (*pf_gen_ack_frame) (unsigned char *outbuf, size_t outbuf_sz,
10450aadb33SDmitri Tikhonov                gaf_rechist_first_f, gaf_rechist_next_f,
10550aadb33SDmitri Tikhonov                gaf_rechist_largest_recv_f, void *rechist, lsquic_time_t now,
1065392f7a3SLiteSpeed Tech                int *has_missing, lsquic_packno_t *largest_received,
1075392f7a3SLiteSpeed Tech                const uint64_t *ecn_counts);
10850aadb33SDmitri Tikhonov    int
10950aadb33SDmitri Tikhonov    (*pf_gen_stop_waiting_frame) (unsigned char *buf, size_t buf_len,
110c7d81ce1SDmitri Tikhonov                    lsquic_packno_t cur_packno, enum packno_bits,
11150aadb33SDmitri Tikhonov                    lsquic_packno_t least_unacked_packno);
11250aadb33SDmitri Tikhonov    int
11350aadb33SDmitri Tikhonov    (*pf_parse_stop_waiting_frame) (const unsigned char *buf, size_t buf_len,
114c7d81ce1SDmitri Tikhonov                     lsquic_packno_t cur_packno, enum packno_bits,
11550aadb33SDmitri Tikhonov                     lsquic_packno_t *least_unacked);
11650aadb33SDmitri Tikhonov    int
117c7d81ce1SDmitri Tikhonov    (*pf_skip_stop_waiting_frame) (size_t buf_len, enum packno_bits);
11850aadb33SDmitri Tikhonov    int
11950aadb33SDmitri Tikhonov    (*pf_gen_window_update_frame) (unsigned char *buf, int buf_len,
1205392f7a3SLiteSpeed Tech                                lsquic_stream_id_t stream_id, uint64_t offset);
12150aadb33SDmitri Tikhonov    int
12250aadb33SDmitri Tikhonov    (*pf_parse_window_update_frame) (const unsigned char *buf, size_t buf_len,
1235392f7a3SLiteSpeed Tech                              lsquic_stream_id_t *stream_id, uint64_t *offset);
1245392f7a3SLiteSpeed Tech    /* The third argument for pf_gen_blocked_frame() and pf_parse_blocked_frame()
1255392f7a3SLiteSpeed Tech     * is Stream ID for GQUIC and offset for IETF QUIC.  Since both of these are
1265392f7a3SLiteSpeed Tech     * uint64_t, we'll use the same function pointer.  Just have to be a little
1275392f7a3SLiteSpeed Tech     * careful here.
1285392f7a3SLiteSpeed Tech     */
12950aadb33SDmitri Tikhonov    int
13050aadb33SDmitri Tikhonov    (*pf_gen_blocked_frame) (unsigned char *buf, size_t buf_len,
1315392f7a3SLiteSpeed Tech                                                lsquic_stream_id_t stream_id);
13250aadb33SDmitri Tikhonov    int
13350aadb33SDmitri Tikhonov    (*pf_parse_blocked_frame) (const unsigned char *buf, size_t buf_len,
1345392f7a3SLiteSpeed Tech        /* TODO: rename third argument when dropping GQUIC */
1355392f7a3SLiteSpeed Tech                                                lsquic_stream_id_t *stream_id);
1365392f7a3SLiteSpeed Tech    unsigned
1375392f7a3SLiteSpeed Tech    (*pf_blocked_frame_size) (uint64_t);
1385392f7a3SLiteSpeed Tech    unsigned
1395392f7a3SLiteSpeed Tech    (*pf_rst_frame_size) (lsquic_stream_id_t stream_id, uint64_t final_size,
1405392f7a3SLiteSpeed Tech                                                        uint64_t error_code);
14150aadb33SDmitri Tikhonov    int
1425392f7a3SLiteSpeed Tech    (*pf_gen_rst_frame) (unsigned char *buf, size_t buf_len,
1435392f7a3SLiteSpeed Tech        lsquic_stream_id_t stream_id, uint64_t offset, uint64_t error_code);
14450aadb33SDmitri Tikhonov    int
14550aadb33SDmitri Tikhonov    (*pf_parse_rst_frame) (const unsigned char *buf, size_t buf_len,
1465392f7a3SLiteSpeed Tech        lsquic_stream_id_t *stream_id, uint64_t *offset, uint64_t *error_code);
1475392f7a3SLiteSpeed Tech    int
1485392f7a3SLiteSpeed Tech    (*pf_parse_stop_sending_frame) (const unsigned char *buf, size_t buf_len,
1495392f7a3SLiteSpeed Tech        lsquic_stream_id_t *stream_id, uint64_t *error_code);
1505392f7a3SLiteSpeed Tech    unsigned
1515392f7a3SLiteSpeed Tech    (*pf_stop_sending_frame_size) (lsquic_stream_id_t, uint64_t);
1525392f7a3SLiteSpeed Tech    int
1535392f7a3SLiteSpeed Tech    (*pf_gen_stop_sending_frame) (unsigned char *buf, size_t buf_len,
1545392f7a3SLiteSpeed Tech                                    lsquic_stream_id_t, uint64_t error_code);
1557d09751dSDmitri Tikhonov    size_t
1567d09751dSDmitri Tikhonov    (*pf_connect_close_frame_size) (int app_error, unsigned error_code,
1577d09751dSDmitri Tikhonov                                unsigned frame_type, size_t reason_len);
15850aadb33SDmitri Tikhonov    int
1595392f7a3SLiteSpeed Tech    (*pf_gen_connect_close_frame) (unsigned char *buf, size_t buf_len,
1605392f7a3SLiteSpeed Tech        int app_error, unsigned error_code, const char *reason, int reason_len);
16150aadb33SDmitri Tikhonov    int
16250aadb33SDmitri Tikhonov    (*pf_parse_connect_close_frame) (const unsigned char *buf, size_t buf_len,
1635392f7a3SLiteSpeed Tech                int *app_error, uint64_t *error_code, uint16_t *reason_length,
16450aadb33SDmitri Tikhonov                uint8_t *reason_offset);
16550aadb33SDmitri Tikhonov    int
16650aadb33SDmitri Tikhonov    (*pf_gen_goaway_frame) (unsigned char *buf, size_t buf_len,
1675392f7a3SLiteSpeed Tech                uint32_t error_code, lsquic_stream_id_t last_good_stream_id,
16850aadb33SDmitri Tikhonov                const char *reason, size_t reason_len);
16950aadb33SDmitri Tikhonov    int
17050aadb33SDmitri Tikhonov    (*pf_parse_goaway_frame) (const unsigned char *buf, size_t buf_len,
1715392f7a3SLiteSpeed Tech                uint32_t *error_code, lsquic_stream_id_t *last_good_stream_id,
17250aadb33SDmitri Tikhonov                uint16_t *reason_length, const char **reason);
17350aadb33SDmitri Tikhonov    int
17450aadb33SDmitri Tikhonov    (*pf_gen_ping_frame) (unsigned char *buf, int buf_len);
1755392f7a3SLiteSpeed Tech    int
1765392f7a3SLiteSpeed Tech    (*pf_parse_path_chal_frame) (const unsigned char *buf, size_t,
1775392f7a3SLiteSpeed Tech                                                            uint64_t *chal);
1785392f7a3SLiteSpeed Tech    int
1795392f7a3SLiteSpeed Tech    (*pf_parse_path_resp_frame) (const unsigned char *buf, size_t,
1805392f7a3SLiteSpeed Tech                                                            uint64_t *resp);
181a4e24689SBob Perper#ifndef NDEBUG
18250aadb33SDmitri Tikhonov    /* These float reading and writing functions assume `mem' has at least
18350aadb33SDmitri Tikhonov     * 2 bytes.
18450aadb33SDmitri Tikhonov     */
18550aadb33SDmitri Tikhonov    void
18650aadb33SDmitri Tikhonov    (*pf_write_float_time16) (lsquic_time_t time_us, void *mem);
18750aadb33SDmitri Tikhonov    uint64_t
18850aadb33SDmitri Tikhonov    (*pf_read_float_time16) (const void *mem);
189a4e24689SBob Perper#endif
1905392f7a3SLiteSpeed Tech    ssize_t
1915392f7a3SLiteSpeed Tech    (*pf_generate_simple_prst) (const lsquic_cid_t *cid,
1925392f7a3SLiteSpeed Tech                                                    unsigned char *, size_t);
19350aadb33SDmitri Tikhonov    size_t
1945392f7a3SLiteSpeed Tech    (*pf_calc_stream_frame_header_sz) (lsquic_stream_id_t stream_id,
1955392f7a3SLiteSpeed Tech                                            uint64_t offset, unsigned data_sz);
1965392f7a3SLiteSpeed Tech    size_t
1977a8b2eceSDmitri Tikhonov    (*pf_calc_crypto_frame_header_sz) (uint64_t offset, unsigned data_sz);
198c51ce338SDmitri Tikhonov    void
199c51ce338SDmitri Tikhonov    (*pf_turn_on_fin) (unsigned char *);
2009626cfc2SDmitri Tikhonov
2019626cfc2SDmitri Tikhonov    size_t
2029626cfc2SDmitri Tikhonov    (*pf_packout_size) (const struct lsquic_conn *,
2039626cfc2SDmitri Tikhonov                                            const struct lsquic_packet_out *);
2049626cfc2SDmitri Tikhonov
2055392f7a3SLiteSpeed Tech    /* This returns the high estimate of the header size.  Note that it
2065392f7a3SLiteSpeed Tech     * cannot account for the size of the token in the IETF QUIC Initial
2075392f7a3SLiteSpeed Tech     * packets as it does not know it.
2085392f7a3SLiteSpeed Tech     */
2099626cfc2SDmitri Tikhonov    size_t
2105392f7a3SLiteSpeed Tech    (*pf_packout_max_header_size) (const struct lsquic_conn *,
2115392f7a3SLiteSpeed Tech                                    enum packet_out_flags, size_t dcid_len);
212c7d81ce1SDmitri Tikhonov
213c7d81ce1SDmitri Tikhonov    enum packno_bits
214c7d81ce1SDmitri Tikhonov    (*pf_calc_packno_bits) (lsquic_packno_t packno,
215c7d81ce1SDmitri Tikhonov                        lsquic_packno_t least_unacked, uint64_t n_in_flight);
216c7d81ce1SDmitri Tikhonov    unsigned
217c7d81ce1SDmitri Tikhonov    (*pf_packno_bits2len) (enum packno_bits);
2185392f7a3SLiteSpeed Tech
2197a8b2eceSDmitri Tikhonov    /* Used by IETF QUIC and gQUIC >= Q050 */
2205392f7a3SLiteSpeed Tech    void
2215392f7a3SLiteSpeed Tech    (*pf_packno_info) (const struct lsquic_conn *,
2225392f7a3SLiteSpeed Tech        const struct lsquic_packet_out *, unsigned *packno_off,
2235392f7a3SLiteSpeed Tech        unsigned *packno_len);
2245392f7a3SLiteSpeed Tech    int
2255392f7a3SLiteSpeed Tech    (*pf_parse_max_data) (const unsigned char *, size_t, uint64_t *);
2265392f7a3SLiteSpeed Tech    int
2275392f7a3SLiteSpeed Tech    (*pf_gen_max_data_frame) (unsigned char *, size_t, uint64_t);
2285392f7a3SLiteSpeed Tech    unsigned
2295392f7a3SLiteSpeed Tech    (*pf_max_data_frame_size) (uint64_t);
23003e6b668SDmitri Tikhonov    /*
23103e6b668SDmitri Tikhonov     * Returns number of bytes parsed on success or negative value on error:
23203e6b668SDmitri Tikhonov     *  -1  Out of input buffer
23303e6b668SDmitri Tikhonov     *  -2  Invalid CID length value
23403e6b668SDmitri Tikhonov     */
2355392f7a3SLiteSpeed Tech    int
2365392f7a3SLiteSpeed Tech    (*pf_parse_new_conn_id) (const unsigned char *, size_t, uint64_t *,
2375392f7a3SLiteSpeed Tech                        uint64_t *, lsquic_cid_t *, const unsigned char **);
2385392f7a3SLiteSpeed Tech    unsigned
2395392f7a3SLiteSpeed Tech    (*pf_stream_blocked_frame_size) (lsquic_stream_id_t, uint64_t);
2405392f7a3SLiteSpeed Tech    int
2415392f7a3SLiteSpeed Tech    (*pf_gen_stream_blocked_frame) (unsigned char *buf, size_t,
2425392f7a3SLiteSpeed Tech                                                lsquic_stream_id_t, uint64_t);
2435392f7a3SLiteSpeed Tech    int
2445392f7a3SLiteSpeed Tech    (*pf_parse_stream_blocked_frame) (const unsigned char *buf, size_t,
2455392f7a3SLiteSpeed Tech                                            lsquic_stream_id_t *, uint64_t *);
2465392f7a3SLiteSpeed Tech    unsigned
2475392f7a3SLiteSpeed Tech    (*pf_max_stream_data_frame_size) (lsquic_stream_id_t, uint64_t);
2485392f7a3SLiteSpeed Tech    int
2495392f7a3SLiteSpeed Tech    (*pf_gen_max_stream_data_frame) (unsigned char *buf, size_t,
2505392f7a3SLiteSpeed Tech                                                lsquic_stream_id_t, uint64_t);
2515392f7a3SLiteSpeed Tech    int
2525392f7a3SLiteSpeed Tech    (*pf_parse_max_stream_data_frame) (const unsigned char *buf, size_t,
2535392f7a3SLiteSpeed Tech                                            lsquic_stream_id_t *, uint64_t *);
2545392f7a3SLiteSpeed Tech    int
2555392f7a3SLiteSpeed Tech    (*pf_parse_new_token_frame) (const unsigned char *buf, size_t,
2565392f7a3SLiteSpeed Tech                            const unsigned char **token, size_t *token_size);
2575392f7a3SLiteSpeed Tech    size_t
2585392f7a3SLiteSpeed Tech    (*pf_new_connection_id_frame_size) (unsigned seqno, unsigned cid_len);
2595392f7a3SLiteSpeed Tech    int
2605392f7a3SLiteSpeed Tech    (*pf_gen_new_connection_id_frame) (unsigned char *buf, size_t,
2615392f7a3SLiteSpeed Tech                unsigned seqno, const struct lsquic_cid *,
2625392f7a3SLiteSpeed Tech                const unsigned char *token, size_t);
2635392f7a3SLiteSpeed Tech    size_t
2645392f7a3SLiteSpeed Tech    (*pf_retire_cid_frame_size) (uint64_t);
2655392f7a3SLiteSpeed Tech    int
2665392f7a3SLiteSpeed Tech    (*pf_gen_retire_cid_frame) (unsigned char *buf, size_t, uint64_t);
2675392f7a3SLiteSpeed Tech    int
2685392f7a3SLiteSpeed Tech    (*pf_parse_retire_cid_frame) (const unsigned char *buf, size_t, uint64_t *);
2695392f7a3SLiteSpeed Tech    size_t
2705392f7a3SLiteSpeed Tech    (*pf_new_token_frame_size) (size_t);
2715392f7a3SLiteSpeed Tech    int
2725392f7a3SLiteSpeed Tech    (*pf_gen_new_token_frame) (unsigned char *buf, size_t,
2735392f7a3SLiteSpeed Tech                                        const unsigned char *token, size_t);
2745392f7a3SLiteSpeed Tech    int
2755392f7a3SLiteSpeed Tech    (*pf_gen_streams_blocked_frame) (unsigned char *buf, size_t buf_len,
2765392f7a3SLiteSpeed Tech                                        enum stream_dir, uint64_t);
2775392f7a3SLiteSpeed Tech    int
2785392f7a3SLiteSpeed Tech    (*pf_parse_streams_blocked_frame) (const unsigned char *buf, size_t buf_len,
2795392f7a3SLiteSpeed Tech                                        enum stream_dir *, uint64_t *);
2805392f7a3SLiteSpeed Tech    unsigned
2815392f7a3SLiteSpeed Tech    (*pf_streams_blocked_frame_size) (uint64_t);
2825392f7a3SLiteSpeed Tech    int
2835392f7a3SLiteSpeed Tech    (*pf_gen_max_streams_frame) (unsigned char *buf, size_t buf_len,
2845392f7a3SLiteSpeed Tech                                        enum stream_dir, uint64_t);
2855392f7a3SLiteSpeed Tech    int
2865392f7a3SLiteSpeed Tech    (*pf_parse_max_streams_frame) (const unsigned char *buf, size_t buf_len,
2875392f7a3SLiteSpeed Tech                                        enum stream_dir *, uint64_t *);
2885392f7a3SLiteSpeed Tech    unsigned
2895392f7a3SLiteSpeed Tech    (*pf_max_streams_frame_size) (uint64_t);
2905392f7a3SLiteSpeed Tech    unsigned
2915392f7a3SLiteSpeed Tech    (*pf_path_chal_frame_size) (void);
2925392f7a3SLiteSpeed Tech    int
2935392f7a3SLiteSpeed Tech    (*pf_gen_path_chal_frame) (unsigned char *, size_t, uint64_t chal);
2945392f7a3SLiteSpeed Tech    unsigned
2955392f7a3SLiteSpeed Tech    (*pf_path_resp_frame_size) (void);
2965392f7a3SLiteSpeed Tech    int
2975392f7a3SLiteSpeed Tech    (*pf_gen_path_resp_frame) (unsigned char *, size_t, uint64_t resp);
2989fc12041SDmitri Tikhonov    int
2999fc12041SDmitri Tikhonov    (*pf_gen_handshake_done_frame) (unsigned char *buf, size_t buf_len);
3009fc12041SDmitri Tikhonov    int
3019fc12041SDmitri Tikhonov    (*pf_parse_handshake_done_frame) (const unsigned char *buf, size_t buf_len);
3029fc12041SDmitri Tikhonov    unsigned
3039fc12041SDmitri Tikhonov    (*pf_handshake_done_frame_size) (void);
304feca77f5SDmitri Tikhonov    int
305feca77f5SDmitri Tikhonov    (*pf_gen_ack_frequency_frame) (unsigned char *buf, size_t buf_len,
306feca77f5SDmitri Tikhonov        uint64_t seqno, uint64_t pack_tol, uint64_t upd_mad);
307feca77f5SDmitri Tikhonov    int
308feca77f5SDmitri Tikhonov    (*pf_parse_ack_frequency_frame) (const unsigned char *buf, size_t buf_len,
309feca77f5SDmitri Tikhonov        uint64_t *seqno, uint64_t *pack_tol, uint64_t *upd_mad);
310feca77f5SDmitri Tikhonov    unsigned
311feca77f5SDmitri Tikhonov    (*pf_ack_frequency_frame_size) (uint64_t seqno, uint64_t pack_tol,
312feca77f5SDmitri Tikhonov        uint64_t upd_mad);
313afe3d363SDmitri Tikhonov    int
314afe3d363SDmitri Tikhonov    (*pf_gen_timestamp_frame) (unsigned char *buf, size_t buf_len, uint64_t);
315afe3d363SDmitri Tikhonov    int
316afe3d363SDmitri Tikhonov    (*pf_parse_timestamp_frame) (const unsigned char *buf, size_t, uint64_t *);
31750aadb33SDmitri Tikhonov};
31850aadb33SDmitri Tikhonov
3195392f7a3SLiteSpeed Tech
320fb96f4ddSDmitri Tikhonovextern const struct parse_funcs lsquic_parse_funcs_gquic_Q043;
321c7d81ce1SDmitri Tikhonovextern const struct parse_funcs lsquic_parse_funcs_gquic_Q046;
3227a8b2eceSDmitri Tikhonovextern const struct parse_funcs lsquic_parse_funcs_gquic_Q050;
3235392f7a3SLiteSpeed Techextern const struct parse_funcs lsquic_parse_funcs_ietf_v1;
32450aadb33SDmitri Tikhonov
3255392f7a3SLiteSpeed Tech#define select_pf_by_ver(ver) (                                             \
326fb96f4ddSDmitri Tikhonov    (1 << (ver)) & (1 << LSQVER_043)                     ?                  \
327fb96f4ddSDmitri Tikhonov                                         &lsquic_parse_funcs_gquic_Q043 :   \
3287a8b2eceSDmitri Tikhonov    (1 << (ver)) & (1 << LSQVER_046)                            ?           \
3295392f7a3SLiteSpeed Tech                                         &lsquic_parse_funcs_gquic_Q046 :   \
3307a8b2eceSDmitri Tikhonov    (1 << (ver)) & ((1 << LSQVER_050)|LSQUIC_EXPERIMENTAL_Q098) ?           \
3317a8b2eceSDmitri Tikhonov                                         &lsquic_parse_funcs_gquic_Q050 :   \
3325392f7a3SLiteSpeed Tech    &lsquic_parse_funcs_ietf_v1)
33350aadb33SDmitri Tikhonov
3345392f7a3SLiteSpeed Tech/* This function is gQUIC-version independent */
33550aadb33SDmitri Tikhonovint
3369626cfc2SDmitri Tikhonovlsquic_gquic_parse_packet_in_begin (struct lsquic_packet_in *, size_t length,
3375392f7a3SLiteSpeed Tech                int is_server, unsigned cid_len, struct packin_parse_state *);
33850aadb33SDmitri Tikhonov
3399626cfc2SDmitri Tikhonovint
3405392f7a3SLiteSpeed Techlsquic_Q046_parse_packet_in_short_begin (struct lsquic_packet_in *, size_t length,
3415392f7a3SLiteSpeed Tech                int is_server, unsigned, struct packin_parse_state *);
3429626cfc2SDmitri Tikhonov
3439626cfc2SDmitri Tikhonovint
3445392f7a3SLiteSpeed Techlsquic_Q046_parse_packet_in_long_begin (struct lsquic_packet_in *, size_t length,
3455392f7a3SLiteSpeed Tech                int is_server, unsigned, struct packin_parse_state *);
3469626cfc2SDmitri Tikhonov
3477a8b2eceSDmitri Tikhonovint
3487a8b2eceSDmitri Tikhonovlsquic_Q050_parse_packet_in_long_begin (struct lsquic_packet_in *, size_t length,
3497a8b2eceSDmitri Tikhonov                int is_server, unsigned, struct packin_parse_state *);
3507a8b2eceSDmitri Tikhonov
3516aba801dSDmitri Tikhonovenum quic_frame_type
352feca77f5SDmitri Tikhonovlsquic_parse_frame_type_gquic_Q035_thru_Q046 (const unsigned char *, size_t);
35350aadb33SDmitri Tikhonov
354feca77f5SDmitri Tikhonovextern const enum quic_frame_type lsquic_iquic_byte2type[0x40];
3555392f7a3SLiteSpeed Tech
35650aadb33SDmitri Tikhonovsize_t
3575392f7a3SLiteSpeed Techcalc_stream_frame_header_sz_gquic (lsquic_stream_id_t stream_id,
3585392f7a3SLiteSpeed Tech                                                    uint64_t offset, unsigned);
35950aadb33SDmitri Tikhonov
3609626cfc2SDmitri Tikhonovsize_t
3619626cfc2SDmitri Tikhonovlsquic_gquic_packout_size (const struct lsquic_conn *,
3629626cfc2SDmitri Tikhonov                                            const struct lsquic_packet_out *);
3639626cfc2SDmitri Tikhonov
3649626cfc2SDmitri Tikhonovsize_t
3659626cfc2SDmitri Tikhonovlsquic_gquic_packout_header_size (const struct lsquic_conn *conn,
3665392f7a3SLiteSpeed Tech                                enum packet_out_flags flags, size_t unused);
3675392f7a3SLiteSpeed Tech
3685392f7a3SLiteSpeed Techsize_t
3695392f7a3SLiteSpeed Techlsquic_gquic_po_header_sz (enum packet_out_flags flags);
3705392f7a3SLiteSpeed Tech
3715392f7a3SLiteSpeed Techsize_t
3725392f7a3SLiteSpeed Techlsquic_gquic_packout_size (const struct lsquic_conn *,
3735392f7a3SLiteSpeed Tech                                            const struct lsquic_packet_out *);
3749626cfc2SDmitri Tikhonov
3759626cfc2SDmitri Tikhonovsize_t
3769626cfc2SDmitri Tikhonovlsquic_gquic_po_header_sz (enum packet_out_flags flags);
3779626cfc2SDmitri Tikhonov
37850aadb33SDmitri Tikhonov/* This maps two bits as follows:
37950aadb33SDmitri Tikhonov *  00  ->  1
38050aadb33SDmitri Tikhonov *  01  ->  2
38150aadb33SDmitri Tikhonov *  10  ->  4
38250aadb33SDmitri Tikhonov *  11  ->  6
38350aadb33SDmitri Tikhonov *
38450aadb33SDmitri Tikhonov * Assumes that only two low bits are set.
38550aadb33SDmitri Tikhonov */
38650aadb33SDmitri Tikhonov#define twobit_to_1246(bits) ((bits) * 2 + !(bits))
38750aadb33SDmitri Tikhonov
38850aadb33SDmitri Tikhonov/* This maps two bits as follows:
38950aadb33SDmitri Tikhonov *  00  ->  1
39050aadb33SDmitri Tikhonov *  01  ->  2
39150aadb33SDmitri Tikhonov *  10  ->  4
39250aadb33SDmitri Tikhonov *  11  ->  8
39350aadb33SDmitri Tikhonov *
39450aadb33SDmitri Tikhonov * Assumes that only two low bits are set.
39550aadb33SDmitri Tikhonov */
39650aadb33SDmitri Tikhonov#define twobit_to_1248(bits) (1 << (bits))
39750aadb33SDmitri Tikhonov
398de46bf2fSDmitri Tikhonov#define ECN_COUNTS_STR  " ECT(0): 01234567879012345678790;" \
399de46bf2fSDmitri Tikhonov                        " ECT(1): 01234567879012345678790;" \
400de46bf2fSDmitri Tikhonov                        " CE: 01234567879012345678790"
401de46bf2fSDmitri Tikhonov#define RANGES_TRUNCATED_STR " ranges truncated! "
402de46bf2fSDmitri Tikhonov
403de46bf2fSDmitri Tikhonov#define MAX_ACKI_STR_SZ (256 * (3 /* [-] */ + 20 /* ~0ULL */ * 2) \
404de46bf2fSDmitri Tikhonov                    + sizeof(ECN_COUNTS_STR) + sizeof(RANGES_TRUNCATED_STR))
405de46bf2fSDmitri Tikhonov
406de46bf2fSDmitri Tikhonovvoid
407de46bf2fSDmitri Tikhonovlsquic_acki2str (const struct ack_info *acki, char *, size_t);
40850aadb33SDmitri Tikhonov
409c51ce338SDmitri Tikhonovvoid
4107a8b2eceSDmitri Tikhonovlsquic_turn_on_fin_Q035_thru_Q046 (unsigned char *);
411c51ce338SDmitri Tikhonov
412c7d81ce1SDmitri Tikhonovenum packno_bits
413c7d81ce1SDmitri Tikhonovlsquic_gquic_calc_packno_bits (lsquic_packno_t packno,
414c7d81ce1SDmitri Tikhonov                        lsquic_packno_t least_unacked, uint64_t n_in_flight);
415c7d81ce1SDmitri Tikhonov
416c7d81ce1SDmitri Tikhonovunsigned
417c7d81ce1SDmitri Tikhonovlsquic_gquic_packno_bits2len (enum packno_bits);
418c7d81ce1SDmitri Tikhonov
419de46bf2fSDmitri Tikhonovint
420de46bf2fSDmitri Tikhonovlsquic_merge_acks (struct ack_info *dst, const struct ack_info *src);
421de46bf2fSDmitri Tikhonov
42250aadb33SDmitri Tikhonov#endif
423