lsquic_parse.h revision 03e6b668
1229fce07SDmitri Tikhonov/* Copyright (c) 2017 - 2019 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#define LSQUIC_PARSE_ACK_TIMESTAMPS 0
2150aadb33SDmitri Tikhonov
225392f7a3SLiteSpeed Techstruct ack_info
2350aadb33SDmitri Tikhonov{
245392f7a3SLiteSpeed Tech    enum packnum_space pns;
255392f7a3SLiteSpeed Tech    enum {
265392f7a3SLiteSpeed Tech        AI_ECN        = 1 << 0, /* ecn_counts[1,2,3] contain ECN counts */
275392f7a3SLiteSpeed Tech        AI_TRUNCATED  = 1 << 1, /* There were more ranges to parse, but we
285392f7a3SLiteSpeed Tech                                 * ran out of elements in `ranges'.
295392f7a3SLiteSpeed Tech                                 */
305392f7a3SLiteSpeed Tech    }               flags;
3150aadb33SDmitri Tikhonov    unsigned    n_timestamps;   /* 0 to 255 */
3250aadb33SDmitri Tikhonov    unsigned    n_ranges;       /* This is at least 1 */
3350aadb33SDmitri Tikhonov                                /* Largest acked is ack_info.ranges[0].high */
3450aadb33SDmitri Tikhonov    lsquic_time_t   lack_delta;
355392f7a3SLiteSpeed Tech    uint64_t        ecn_counts[4];
36bfc7bfd8SDmitri Tikhonov    struct lsquic_packno_range ranges[256];
3750aadb33SDmitri Tikhonov#if LSQUIC_PARSE_ACK_TIMESTAMPS
3850aadb33SDmitri Tikhonov    struct {
3950aadb33SDmitri Tikhonov        /* Currently we just read these timestamps in (assuming it is
4050aadb33SDmitri Tikhonov         * compiled in, of course), but do not do anything with them.
4150aadb33SDmitri Tikhonov         * When we do, the representation of these fields should be
4250aadb33SDmitri Tikhonov         * switched to whatever is most appropriate/efficient.
4350aadb33SDmitri Tikhonov         */
4450aadb33SDmitri Tikhonov        unsigned char   packet_delta;
4550aadb33SDmitri Tikhonov        uint64_t        delta_usec;
4650aadb33SDmitri Tikhonov    }           timestamps[255];
4750aadb33SDmitri Tikhonov#endif
485392f7a3SLiteSpeed Tech};
495392f7a3SLiteSpeed Tech
5050aadb33SDmitri Tikhonov
5116a9b66aSDmitri Tikhonovstruct short_ack_info
5216a9b66aSDmitri Tikhonov{
5316a9b66aSDmitri Tikhonov    unsigned                    sai_n_timestamps;
5416a9b66aSDmitri Tikhonov    lsquic_time_t               sai_lack_delta;
5516a9b66aSDmitri Tikhonov    struct lsquic_packno_range  sai_range;
5616a9b66aSDmitri Tikhonov};
5716a9b66aSDmitri Tikhonov
5850aadb33SDmitri Tikhonov#define largest_acked(acki) (+(acki)->ranges[0].high)
5950aadb33SDmitri Tikhonov
6050aadb33SDmitri Tikhonov#define smallest_acked(acki) (+(acki)->ranges[(acki)->n_ranges - 1].low)
6150aadb33SDmitri Tikhonov
625392f7a3SLiteSpeed Tech/* Chrome may send an empty ACK frame when it closes a connection.
635392f7a3SLiteSpeed Tech * We do not know why it occurs -- perhaps a bug in Chrome.
645392f7a3SLiteSpeed Tech */
655392f7a3SLiteSpeed Tech/* This macro cannot be used in IETF QUIC as zero is a valid packet number.
665392f7a3SLiteSpeed Tech * Hopefully the Chrome bug will have been fixed by then.
675392f7a3SLiteSpeed Tech */
685392f7a3SLiteSpeed Tech#define empty_ack_frame(acki) (largest_acked(acki) == 0)
695392f7a3SLiteSpeed Tech
7050aadb33SDmitri Tikhonov/* gaf_: generate ACK frame */
7150aadb33SDmitri Tikhonovstruct lsquic_packno_range;
7250aadb33SDmitri Tikhonovtypedef const struct lsquic_packno_range *
7350aadb33SDmitri Tikhonov    (*gaf_rechist_first_f)          (void *rechist);
7450aadb33SDmitri Tikhonovtypedef const struct lsquic_packno_range *
7550aadb33SDmitri Tikhonov    (*gaf_rechist_next_f)           (void *rechist);
7650aadb33SDmitri Tikhonovtypedef lsquic_time_t
7750aadb33SDmitri Tikhonov    (*gaf_rechist_largest_recv_f)   (void *rechist);
7850aadb33SDmitri Tikhonov
7950aadb33SDmitri Tikhonov/* gsf_: generate stream frame */
8050aadb33SDmitri Tikhonovtypedef size_t (*gsf_read_f) (void *stream, void *buf, size_t len, int *fin);
8150aadb33SDmitri Tikhonov
825392f7a3SLiteSpeed Tech/* gcf_: generate CRYPTO frame */
835392f7a3SLiteSpeed Techtypedef size_t (*gcf_read_f) (void *stream, void *buf, size_t len);
845392f7a3SLiteSpeed Tech
8550aadb33SDmitri Tikhonov/* This structure contains functions that parse and generate packets and
8650aadb33SDmitri Tikhonov * frames in version-specific manner.  To begin with, there is difference
8750aadb33SDmitri Tikhonov * between GQUIC's little-endian (Q038 and lower) and big-endian formats
885392f7a3SLiteSpeed Tech * (Q039 and higher).  Q046 and higher uses different format for packet headers.
8950aadb33SDmitri Tikhonov */
9050aadb33SDmitri Tikhonovstruct parse_funcs
9150aadb33SDmitri Tikhonov{
9250aadb33SDmitri Tikhonov    /* Return buf length */
9350aadb33SDmitri Tikhonov    int
949626cfc2SDmitri Tikhonov    (*pf_gen_reg_pkt_header) (const struct lsquic_conn *,
959626cfc2SDmitri Tikhonov                const struct lsquic_packet_out *, unsigned char *, size_t);
9650aadb33SDmitri Tikhonov    void
9750aadb33SDmitri Tikhonov    (*pf_parse_packet_in_finish) (struct lsquic_packet_in *packet_in,
9850aadb33SDmitri Tikhonov                                                struct packin_parse_state *);
996aba801dSDmitri Tikhonov    enum quic_frame_type
10050aadb33SDmitri Tikhonov    (*pf_parse_frame_type) (unsigned char);
10114e3680dSDmitri Tikhonov    /* Return used buffer length or a negative value if there was not enough
10214e3680dSDmitri Tikhonov     * room to write the stream frame.  In the latter case, the negative of
10314e3680dSDmitri Tikhonov     * the negative return value is the number of bytes required.  The
10414e3680dSDmitri Tikhonov     * exception is -1, which is a generic error code, as we always need
10514e3680dSDmitri Tikhonov     * more than 1 byte to write a STREAM frame.
10614e3680dSDmitri Tikhonov     */
10750aadb33SDmitri Tikhonov    int
10850aadb33SDmitri Tikhonov    (*pf_gen_stream_frame) (unsigned char *buf, size_t bufsz,
1095392f7a3SLiteSpeed Tech                            lsquic_stream_id_t stream_id, uint64_t offset,
110bfc7bfd8SDmitri Tikhonov                            int fin, size_t size, gsf_read_f, void *stream);
11150aadb33SDmitri Tikhonov    int
11250aadb33SDmitri Tikhonov    (*pf_parse_stream_frame) (const unsigned char *buf, size_t rem_packet_sz,
11350aadb33SDmitri Tikhonov                                                    struct stream_frame *);
11450aadb33SDmitri Tikhonov    int
1155392f7a3SLiteSpeed Tech    (*pf_parse_crypto_frame) (const unsigned char *buf, size_t rem_packet_sz,
1165392f7a3SLiteSpeed Tech                                                    struct stream_frame *);
1175392f7a3SLiteSpeed Tech    int
1185392f7a3SLiteSpeed Tech    (*pf_gen_crypto_frame) (unsigned char *buf, size_t bufsz, uint64_t offset,
1195392f7a3SLiteSpeed Tech                            size_t size, gcf_read_f, void *stream);
1205392f7a3SLiteSpeed Tech    int
12150aadb33SDmitri Tikhonov    (*pf_parse_ack_frame) (const unsigned char *buf, size_t buf_len,
1225392f7a3SLiteSpeed Tech                                    struct ack_info *ack_info, uint8_t exp);
12350aadb33SDmitri Tikhonov    int
12450aadb33SDmitri Tikhonov    (*pf_gen_ack_frame) (unsigned char *outbuf, size_t outbuf_sz,
12550aadb33SDmitri Tikhonov                gaf_rechist_first_f, gaf_rechist_next_f,
12650aadb33SDmitri Tikhonov                gaf_rechist_largest_recv_f, void *rechist, lsquic_time_t now,
1275392f7a3SLiteSpeed Tech                int *has_missing, lsquic_packno_t *largest_received,
1285392f7a3SLiteSpeed Tech                const uint64_t *ecn_counts);
12950aadb33SDmitri Tikhonov    int
13050aadb33SDmitri Tikhonov    (*pf_gen_stop_waiting_frame) (unsigned char *buf, size_t buf_len,
131c7d81ce1SDmitri Tikhonov                    lsquic_packno_t cur_packno, enum packno_bits,
13250aadb33SDmitri Tikhonov                    lsquic_packno_t least_unacked_packno);
13350aadb33SDmitri Tikhonov    int
13450aadb33SDmitri Tikhonov    (*pf_parse_stop_waiting_frame) (const unsigned char *buf, size_t buf_len,
135c7d81ce1SDmitri Tikhonov                     lsquic_packno_t cur_packno, enum packno_bits,
13650aadb33SDmitri Tikhonov                     lsquic_packno_t *least_unacked);
13750aadb33SDmitri Tikhonov    int
138c7d81ce1SDmitri Tikhonov    (*pf_skip_stop_waiting_frame) (size_t buf_len, enum packno_bits);
13950aadb33SDmitri Tikhonov    int
14050aadb33SDmitri Tikhonov    (*pf_gen_window_update_frame) (unsigned char *buf, int buf_len,
1415392f7a3SLiteSpeed Tech                                lsquic_stream_id_t stream_id, uint64_t offset);
14250aadb33SDmitri Tikhonov    int
14350aadb33SDmitri Tikhonov    (*pf_parse_window_update_frame) (const unsigned char *buf, size_t buf_len,
1445392f7a3SLiteSpeed Tech                              lsquic_stream_id_t *stream_id, uint64_t *offset);
1455392f7a3SLiteSpeed Tech    /* The third argument for pf_gen_blocked_frame() and pf_parse_blocked_frame()
1465392f7a3SLiteSpeed Tech     * is Stream ID for GQUIC and offset for IETF QUIC.  Since both of these are
1475392f7a3SLiteSpeed Tech     * uint64_t, we'll use the same function pointer.  Just have to be a little
1485392f7a3SLiteSpeed Tech     * careful here.
1495392f7a3SLiteSpeed Tech     */
15050aadb33SDmitri Tikhonov    int
15150aadb33SDmitri Tikhonov    (*pf_gen_blocked_frame) (unsigned char *buf, size_t buf_len,
1525392f7a3SLiteSpeed Tech                                                lsquic_stream_id_t stream_id);
15350aadb33SDmitri Tikhonov    int
15450aadb33SDmitri Tikhonov    (*pf_parse_blocked_frame) (const unsigned char *buf, size_t buf_len,
1555392f7a3SLiteSpeed Tech        /* TODO: rename third argument when dropping GQUIC */
1565392f7a3SLiteSpeed Tech                                                lsquic_stream_id_t *stream_id);
1575392f7a3SLiteSpeed Tech    unsigned
1585392f7a3SLiteSpeed Tech    (*pf_blocked_frame_size) (uint64_t);
1595392f7a3SLiteSpeed Tech    unsigned
1605392f7a3SLiteSpeed Tech    (*pf_rst_frame_size) (lsquic_stream_id_t stream_id, uint64_t final_size,
1615392f7a3SLiteSpeed Tech                                                        uint64_t error_code);
16250aadb33SDmitri Tikhonov    int
1635392f7a3SLiteSpeed Tech    (*pf_gen_rst_frame) (unsigned char *buf, size_t buf_len,
1645392f7a3SLiteSpeed Tech        lsquic_stream_id_t stream_id, uint64_t offset, uint64_t error_code);
16550aadb33SDmitri Tikhonov    int
16650aadb33SDmitri Tikhonov    (*pf_parse_rst_frame) (const unsigned char *buf, size_t buf_len,
1675392f7a3SLiteSpeed Tech        lsquic_stream_id_t *stream_id, uint64_t *offset, uint64_t *error_code);
1685392f7a3SLiteSpeed Tech    int
1695392f7a3SLiteSpeed Tech    (*pf_parse_stop_sending_frame) (const unsigned char *buf, size_t buf_len,
1705392f7a3SLiteSpeed Tech        lsquic_stream_id_t *stream_id, uint64_t *error_code);
1715392f7a3SLiteSpeed Tech    unsigned
1725392f7a3SLiteSpeed Tech    (*pf_stop_sending_frame_size) (lsquic_stream_id_t, uint64_t);
1735392f7a3SLiteSpeed Tech    int
1745392f7a3SLiteSpeed Tech    (*pf_gen_stop_sending_frame) (unsigned char *buf, size_t buf_len,
1755392f7a3SLiteSpeed Tech                                    lsquic_stream_id_t, uint64_t error_code);
17650aadb33SDmitri Tikhonov    int
1775392f7a3SLiteSpeed Tech    (*pf_gen_connect_close_frame) (unsigned char *buf, size_t buf_len,
1785392f7a3SLiteSpeed Tech        int app_error, unsigned error_code, const char *reason, int reason_len);
17950aadb33SDmitri Tikhonov    int
18050aadb33SDmitri Tikhonov    (*pf_parse_connect_close_frame) (const unsigned char *buf, size_t buf_len,
1815392f7a3SLiteSpeed Tech                int *app_error, uint64_t *error_code, uint16_t *reason_length,
18250aadb33SDmitri Tikhonov                uint8_t *reason_offset);
18350aadb33SDmitri Tikhonov    int
18450aadb33SDmitri Tikhonov    (*pf_gen_goaway_frame) (unsigned char *buf, size_t buf_len,
1855392f7a3SLiteSpeed Tech                uint32_t error_code, lsquic_stream_id_t last_good_stream_id,
18650aadb33SDmitri Tikhonov                const char *reason, size_t reason_len);
18750aadb33SDmitri Tikhonov    int
18850aadb33SDmitri Tikhonov    (*pf_parse_goaway_frame) (const unsigned char *buf, size_t buf_len,
1895392f7a3SLiteSpeed Tech                uint32_t *error_code, lsquic_stream_id_t *last_good_stream_id,
19050aadb33SDmitri Tikhonov                uint16_t *reason_length, const char **reason);
19150aadb33SDmitri Tikhonov    int
19250aadb33SDmitri Tikhonov    (*pf_gen_ping_frame) (unsigned char *buf, int buf_len);
1935392f7a3SLiteSpeed Tech    int
1945392f7a3SLiteSpeed Tech    (*pf_parse_path_chal_frame) (const unsigned char *buf, size_t,
1955392f7a3SLiteSpeed Tech                                                            uint64_t *chal);
1965392f7a3SLiteSpeed Tech    int
1975392f7a3SLiteSpeed Tech    (*pf_parse_path_resp_frame) (const unsigned char *buf, size_t,
1985392f7a3SLiteSpeed Tech                                                            uint64_t *resp);
199a4e24689SBob Perper#ifndef NDEBUG
20050aadb33SDmitri Tikhonov    /* These float reading and writing functions assume `mem' has at least
20150aadb33SDmitri Tikhonov     * 2 bytes.
20250aadb33SDmitri Tikhonov     */
20350aadb33SDmitri Tikhonov    void
20450aadb33SDmitri Tikhonov    (*pf_write_float_time16) (lsquic_time_t time_us, void *mem);
20550aadb33SDmitri Tikhonov    uint64_t
20650aadb33SDmitri Tikhonov    (*pf_read_float_time16) (const void *mem);
207a4e24689SBob Perper#endif
2085392f7a3SLiteSpeed Tech    ssize_t
2095392f7a3SLiteSpeed Tech    (*pf_generate_simple_prst) (const lsquic_cid_t *cid,
2105392f7a3SLiteSpeed Tech                                                    unsigned char *, size_t);
21150aadb33SDmitri Tikhonov    size_t
2125392f7a3SLiteSpeed Tech    (*pf_calc_stream_frame_header_sz) (lsquic_stream_id_t stream_id,
2135392f7a3SLiteSpeed Tech                                            uint64_t offset, unsigned data_sz);
2145392f7a3SLiteSpeed Tech    size_t
2155392f7a3SLiteSpeed Tech    (*pf_calc_crypto_frame_header_sz) (uint64_t offset);
216c51ce338SDmitri Tikhonov    void
217c51ce338SDmitri Tikhonov    (*pf_turn_on_fin) (unsigned char *);
2189626cfc2SDmitri Tikhonov
2199626cfc2SDmitri Tikhonov    size_t
2209626cfc2SDmitri Tikhonov    (*pf_packout_size) (const struct lsquic_conn *,
2219626cfc2SDmitri Tikhonov                                            const struct lsquic_packet_out *);
2229626cfc2SDmitri Tikhonov
2235392f7a3SLiteSpeed Tech    /* This returns the high estimate of the header size.  Note that it
2245392f7a3SLiteSpeed Tech     * cannot account for the size of the token in the IETF QUIC Initial
2255392f7a3SLiteSpeed Tech     * packets as it does not know it.
2265392f7a3SLiteSpeed Tech     */
2279626cfc2SDmitri Tikhonov    size_t
2285392f7a3SLiteSpeed Tech    (*pf_packout_max_header_size) (const struct lsquic_conn *,
2295392f7a3SLiteSpeed Tech                                    enum packet_out_flags, size_t dcid_len);
230c7d81ce1SDmitri Tikhonov
231c7d81ce1SDmitri Tikhonov    enum packno_bits
232c7d81ce1SDmitri Tikhonov    (*pf_calc_packno_bits) (lsquic_packno_t packno,
233c7d81ce1SDmitri Tikhonov                        lsquic_packno_t least_unacked, uint64_t n_in_flight);
234c7d81ce1SDmitri Tikhonov    unsigned
235c7d81ce1SDmitri Tikhonov    (*pf_packno_bits2len) (enum packno_bits);
2365392f7a3SLiteSpeed Tech
2375392f7a3SLiteSpeed Tech    /* Only used by IETF QUIC: */
2385392f7a3SLiteSpeed Tech    void
2395392f7a3SLiteSpeed Tech    (*pf_packno_info) (const struct lsquic_conn *,
2405392f7a3SLiteSpeed Tech        const struct lsquic_packet_out *, unsigned *packno_off,
2415392f7a3SLiteSpeed Tech        unsigned *packno_len);
2425392f7a3SLiteSpeed Tech    int
2435392f7a3SLiteSpeed Tech    (*pf_parse_max_data) (const unsigned char *, size_t, uint64_t *);
2445392f7a3SLiteSpeed Tech    int
2455392f7a3SLiteSpeed Tech    (*pf_gen_max_data_frame) (unsigned char *, size_t, uint64_t);
2465392f7a3SLiteSpeed Tech    unsigned
2475392f7a3SLiteSpeed Tech    (*pf_max_data_frame_size) (uint64_t);
24803e6b668SDmitri Tikhonov    /*
24903e6b668SDmitri Tikhonov     * Returns number of bytes parsed on success or negative value on error:
25003e6b668SDmitri Tikhonov     *  -1  Out of input buffer
25103e6b668SDmitri Tikhonov     *  -2  Invalid CID length value
25203e6b668SDmitri Tikhonov     */
2535392f7a3SLiteSpeed Tech    int
2545392f7a3SLiteSpeed Tech    (*pf_parse_new_conn_id) (const unsigned char *, size_t, uint64_t *,
2555392f7a3SLiteSpeed Tech                        uint64_t *, lsquic_cid_t *, const unsigned char **);
2565392f7a3SLiteSpeed Tech    unsigned
2575392f7a3SLiteSpeed Tech    (*pf_stream_blocked_frame_size) (lsquic_stream_id_t, uint64_t);
2585392f7a3SLiteSpeed Tech    int
2595392f7a3SLiteSpeed Tech    (*pf_gen_stream_blocked_frame) (unsigned char *buf, size_t,
2605392f7a3SLiteSpeed Tech                                                lsquic_stream_id_t, uint64_t);
2615392f7a3SLiteSpeed Tech    int
2625392f7a3SLiteSpeed Tech    (*pf_parse_stream_blocked_frame) (const unsigned char *buf, size_t,
2635392f7a3SLiteSpeed Tech                                            lsquic_stream_id_t *, uint64_t *);
2645392f7a3SLiteSpeed Tech    unsigned
2655392f7a3SLiteSpeed Tech    (*pf_max_stream_data_frame_size) (lsquic_stream_id_t, uint64_t);
2665392f7a3SLiteSpeed Tech    int
2675392f7a3SLiteSpeed Tech    (*pf_gen_max_stream_data_frame) (unsigned char *buf, size_t,
2685392f7a3SLiteSpeed Tech                                                lsquic_stream_id_t, uint64_t);
2695392f7a3SLiteSpeed Tech    int
2705392f7a3SLiteSpeed Tech    (*pf_parse_max_stream_data_frame) (const unsigned char *buf, size_t,
2715392f7a3SLiteSpeed Tech                                            lsquic_stream_id_t *, uint64_t *);
2725392f7a3SLiteSpeed Tech    int
2735392f7a3SLiteSpeed Tech    (*pf_parse_new_token_frame) (const unsigned char *buf, size_t,
2745392f7a3SLiteSpeed Tech                            const unsigned char **token, size_t *token_size);
2755392f7a3SLiteSpeed Tech    size_t
2765392f7a3SLiteSpeed Tech    (*pf_new_connection_id_frame_size) (unsigned seqno, unsigned cid_len);
2775392f7a3SLiteSpeed Tech    int
2785392f7a3SLiteSpeed Tech    (*pf_gen_new_connection_id_frame) (unsigned char *buf, size_t,
2795392f7a3SLiteSpeed Tech                unsigned seqno, const struct lsquic_cid *,
2805392f7a3SLiteSpeed Tech                const unsigned char *token, size_t);
2815392f7a3SLiteSpeed Tech    size_t
2825392f7a3SLiteSpeed Tech    (*pf_retire_cid_frame_size) (uint64_t);
2835392f7a3SLiteSpeed Tech    int
2845392f7a3SLiteSpeed Tech    (*pf_gen_retire_cid_frame) (unsigned char *buf, size_t, uint64_t);
2855392f7a3SLiteSpeed Tech    int
2865392f7a3SLiteSpeed Tech    (*pf_parse_retire_cid_frame) (const unsigned char *buf, size_t, uint64_t *);
2875392f7a3SLiteSpeed Tech    size_t
2885392f7a3SLiteSpeed Tech    (*pf_new_token_frame_size) (size_t);
2895392f7a3SLiteSpeed Tech    int
2905392f7a3SLiteSpeed Tech    (*pf_gen_new_token_frame) (unsigned char *buf, size_t,
2915392f7a3SLiteSpeed Tech                                        const unsigned char *token, size_t);
2925392f7a3SLiteSpeed Tech    int
2935392f7a3SLiteSpeed Tech    (*pf_gen_streams_blocked_frame) (unsigned char *buf, size_t buf_len,
2945392f7a3SLiteSpeed Tech                                        enum stream_dir, uint64_t);
2955392f7a3SLiteSpeed Tech    int
2965392f7a3SLiteSpeed Tech    (*pf_parse_streams_blocked_frame) (const unsigned char *buf, size_t buf_len,
2975392f7a3SLiteSpeed Tech                                        enum stream_dir *, uint64_t *);
2985392f7a3SLiteSpeed Tech    unsigned
2995392f7a3SLiteSpeed Tech    (*pf_streams_blocked_frame_size) (uint64_t);
3005392f7a3SLiteSpeed Tech    int
3015392f7a3SLiteSpeed Tech    (*pf_gen_max_streams_frame) (unsigned char *buf, size_t buf_len,
3025392f7a3SLiteSpeed Tech                                        enum stream_dir, uint64_t);
3035392f7a3SLiteSpeed Tech    int
3045392f7a3SLiteSpeed Tech    (*pf_parse_max_streams_frame) (const unsigned char *buf, size_t buf_len,
3055392f7a3SLiteSpeed Tech                                        enum stream_dir *, uint64_t *);
3065392f7a3SLiteSpeed Tech    unsigned
3075392f7a3SLiteSpeed Tech    (*pf_max_streams_frame_size) (uint64_t);
3085392f7a3SLiteSpeed Tech    unsigned
3095392f7a3SLiteSpeed Tech    (*pf_path_chal_frame_size) (void);
3105392f7a3SLiteSpeed Tech    int
3115392f7a3SLiteSpeed Tech    (*pf_gen_path_chal_frame) (unsigned char *, size_t, uint64_t chal);
3125392f7a3SLiteSpeed Tech    unsigned
3135392f7a3SLiteSpeed Tech    (*pf_path_resp_frame_size) (void);
3145392f7a3SLiteSpeed Tech    int
3155392f7a3SLiteSpeed Tech    (*pf_gen_path_resp_frame) (unsigned char *, size_t, uint64_t resp);
31650aadb33SDmitri Tikhonov};
31750aadb33SDmitri Tikhonov
3185392f7a3SLiteSpeed Tech
31950aadb33SDmitri Tikhonovextern const struct parse_funcs lsquic_parse_funcs_gquic_Q039;
320c7d81ce1SDmitri Tikhonovextern const struct parse_funcs lsquic_parse_funcs_gquic_Q046;
3215392f7a3SLiteSpeed Techextern const struct parse_funcs lsquic_parse_funcs_ietf_v1;
32250aadb33SDmitri Tikhonov
3235392f7a3SLiteSpeed Tech#define select_pf_by_ver(ver) (                                             \
3245392f7a3SLiteSpeed Tech    (1 << (ver)) & ((1 << LSQVER_039)|(1 << LSQVER_043)) ?                  \
3255392f7a3SLiteSpeed Tech                                         &lsquic_parse_funcs_gquic_Q039 :   \
3265392f7a3SLiteSpeed Tech    (1 << (ver)) & ((1 << LSQVER_046)|LSQUIC_EXPERIMENTAL_Q098) ?           \
3275392f7a3SLiteSpeed Tech                                         &lsquic_parse_funcs_gquic_Q046 :   \
3285392f7a3SLiteSpeed Tech    &lsquic_parse_funcs_ietf_v1)
32950aadb33SDmitri Tikhonov
3305392f7a3SLiteSpeed Tech/* This function is gQUIC-version independent */
33150aadb33SDmitri Tikhonovint
3329626cfc2SDmitri Tikhonovlsquic_gquic_parse_packet_in_begin (struct lsquic_packet_in *, size_t length,
3335392f7a3SLiteSpeed Tech                int is_server, unsigned cid_len, struct packin_parse_state *);
33450aadb33SDmitri Tikhonov
3359626cfc2SDmitri Tikhonovint
3365392f7a3SLiteSpeed Techlsquic_Q046_parse_packet_in_short_begin (struct lsquic_packet_in *, size_t length,
3375392f7a3SLiteSpeed Tech                int is_server, unsigned, struct packin_parse_state *);
3389626cfc2SDmitri Tikhonov
3399626cfc2SDmitri Tikhonovint
3405392f7a3SLiteSpeed Techlsquic_Q046_parse_packet_in_long_begin (struct lsquic_packet_in *, size_t length,
3415392f7a3SLiteSpeed Tech                int is_server, unsigned, struct packin_parse_state *);
3429626cfc2SDmitri Tikhonov
3436aba801dSDmitri Tikhonovenum quic_frame_type
34450aadb33SDmitri Tikhonovparse_frame_type_gquic_Q035_thru_Q039 (unsigned char first_byte);
34550aadb33SDmitri Tikhonov
3465392f7a3SLiteSpeed Techextern const enum quic_frame_type lsquic_iquic_byte2type[0x100];
3475392f7a3SLiteSpeed Tech
34850aadb33SDmitri Tikhonovsize_t
3495392f7a3SLiteSpeed Techcalc_stream_frame_header_sz_gquic (lsquic_stream_id_t stream_id,
3505392f7a3SLiteSpeed Tech                                                    uint64_t offset, unsigned);
35150aadb33SDmitri Tikhonov
3529626cfc2SDmitri Tikhonovsize_t
3539626cfc2SDmitri Tikhonovlsquic_gquic_packout_size (const struct lsquic_conn *,
3549626cfc2SDmitri Tikhonov                                            const struct lsquic_packet_out *);
3559626cfc2SDmitri Tikhonov
3569626cfc2SDmitri Tikhonovsize_t
3579626cfc2SDmitri Tikhonovlsquic_gquic_packout_header_size (const struct lsquic_conn *conn,
3585392f7a3SLiteSpeed Tech                                enum packet_out_flags flags, size_t unused);
3595392f7a3SLiteSpeed Tech
3605392f7a3SLiteSpeed Techsize_t
3615392f7a3SLiteSpeed Techlsquic_gquic_po_header_sz (enum packet_out_flags flags);
3625392f7a3SLiteSpeed Tech
3635392f7a3SLiteSpeed Techsize_t
3645392f7a3SLiteSpeed Techlsquic_gquic_packout_size (const struct lsquic_conn *,
3655392f7a3SLiteSpeed Tech                                            const struct lsquic_packet_out *);
3669626cfc2SDmitri Tikhonov
3679626cfc2SDmitri Tikhonovsize_t
3689626cfc2SDmitri Tikhonovlsquic_gquic_po_header_sz (enum packet_out_flags flags);
3699626cfc2SDmitri Tikhonov
37050aadb33SDmitri Tikhonov/* This maps two bits as follows:
37150aadb33SDmitri Tikhonov *  00  ->  1
37250aadb33SDmitri Tikhonov *  01  ->  2
37350aadb33SDmitri Tikhonov *  10  ->  4
37450aadb33SDmitri Tikhonov *  11  ->  6
37550aadb33SDmitri Tikhonov *
37650aadb33SDmitri Tikhonov * Assumes that only two low bits are set.
37750aadb33SDmitri Tikhonov */
37850aadb33SDmitri Tikhonov#define twobit_to_1246(bits) ((bits) * 2 + !(bits))
37950aadb33SDmitri Tikhonov
38050aadb33SDmitri Tikhonov/* This maps two bits as follows:
38150aadb33SDmitri Tikhonov *  00  ->  1
38250aadb33SDmitri Tikhonov *  01  ->  2
38350aadb33SDmitri Tikhonov *  10  ->  4
38450aadb33SDmitri Tikhonov *  11  ->  8
38550aadb33SDmitri Tikhonov *
38650aadb33SDmitri Tikhonov * Assumes that only two low bits are set.
38750aadb33SDmitri Tikhonov */
38850aadb33SDmitri Tikhonov#define twobit_to_1248(bits) (1 << (bits))
38950aadb33SDmitri Tikhonov
39050aadb33SDmitri Tikhonovchar *
39150aadb33SDmitri Tikhonovacki2str (const struct ack_info *acki, size_t *sz);
39250aadb33SDmitri Tikhonov
393c51ce338SDmitri Tikhonovvoid
394c51ce338SDmitri Tikhonovlsquic_turn_on_fin_Q035_thru_Q039 (unsigned char *);
395c51ce338SDmitri Tikhonov
396c7d81ce1SDmitri Tikhonovenum packno_bits
397c7d81ce1SDmitri Tikhonovlsquic_gquic_calc_packno_bits (lsquic_packno_t packno,
398c7d81ce1SDmitri Tikhonov                        lsquic_packno_t least_unacked, uint64_t n_in_flight);
399c7d81ce1SDmitri Tikhonov
400c7d81ce1SDmitri Tikhonovunsigned
401c7d81ce1SDmitri Tikhonovlsquic_gquic_packno_bits2len (enum packno_bits);
402c7d81ce1SDmitri Tikhonov
40350aadb33SDmitri Tikhonov#endif
404