lsquic_packet_in.h revision 461e84d8 
1/* Copyright (c) 2017 LiteSpeed Technologies Inc.  See LICENSE. */
2/*
3 * lsquic_packet_in.h
4 */
5
6#ifndef LSQUIC_PACKET_IN_H
7#define LSQUIC_PACKET_IN_H 1
8
9
10struct lsquic_packet_in;
11
12struct data_frame
13{
14    const unsigned char *df_data;       /* Pointer to data */
15    uint64_t             df_offset;     /* Stream offset */
16    uint16_t             df_read_off;   /* Read offset */
17    uint16_t             df_size;       /* Size of df_data */
18    signed char          df_fin;        /* FIN? */
19};
20
21typedef struct stream_frame
22{
23    /* Stream frames are stored in a list inside stream. */
24    TAILQ_ENTRY(stream_frame)       next_frame;
25
26    /* `data' points somewhere into the packet payload.  The packet object
27     * is reference-counted.  When the frame is freed, the packet is released
28     * via lsquic_packet_put().  If data_length is zero, the frame does not
29     * keep a reference to the incoming packet and this pointer is not set.
30     */
31    struct lsquic_packet_in        *packet_in;
32
33    struct data_frame               data_frame;
34
35    uint32_t stream_id;     /* Parsed from packet */
36} stream_frame_t;
37
38typedef struct lsquic_packet_in
39{
40    TAILQ_ENTRY(lsquic_packet_in)   pi_next;
41    lsquic_time_t                   pi_received;   /* Time received */
42    lsquic_cid_t                    pi_conn_id;
43    lsquic_packno_t                 pi_packno;
44    unsigned short                  pi_header_sz;  /* Points to payload */
45    unsigned short                  pi_data_sz;    /* Data plus header */
46    /* A packet may be referred to by one or more frames and packets_in
47     * list.
48     */
49    unsigned short                  pi_refcnt;
50    enum quic_ft_bit                pi_frame_types:16;
51    unsigned short                  pi_hsk_stream; /* Offset to handshake stream
52                                                    * frame, only valid if
53                                                    * PI_HSK_STREAM is set.
54                                                    */
55    unsigned char                   pi_quic_ver;   /* Offset to QUIC version */
56    unsigned char                   pi_nonce;      /* Offset to nonce */
57    enum {
58        PI_DECRYPTED    = (1 << 0),
59        PI_OWN_DATA     = (1 << 1),                /* We own pi_data */
60        PI_CONN_ID      = (1 << 2),                /* pi_conn_id is set */
61#define PIBIT_ENC_LEV_SHIFT 5
62        PI_ENC_LEV_BIT_0= (1 << 5),                /* Encodes encryption level */
63        PI_ENC_LEV_BIT_1= (1 << 6),                /*  (see enum enc_level). */
64    }                               pi_flags:8;
65    /* If PI_OWN_DATA flag is not set, `pi_data' points to user-supplied
66     * packet data, which is NOT TO BE MODIFIED.
67     */
68    unsigned char                  *pi_data;
69} lsquic_packet_in_t;
70
71#define lsquic_packet_in_public_flags(p) ((p)->pi_data[0])
72
73#define lsquic_packet_in_is_prst(p) \
74    (lsquic_packet_in_public_flags(p) & PACKET_PUBLIC_FLAGS_RST)
75
76#define lsquic_packet_in_packno_bits(p) \
77                    ((lsquic_packet_in_public_flags(p) >> 4) & 3)
78
79#define lsquic_packet_in_upref(p) (++(p)->pi_refcnt)
80
81#define lsquic_packet_in_get(p) (lsquic_packet_in_upref(p), (p))
82
83#define lsquic_packet_in_nonce(p) \
84                    ((p)->pi_nonce ? (p)->pi_data + (p)->pi_nonce : NULL)
85
86#define lsquic_packet_in_enc_level(p) \
87    (((p)->pi_flags >> PIBIT_ENC_LEV_SHIFT) & 0x3)
88
89/* The version iterator is used on a version negotiation packet only.
90 * The iterator functions return 1 when next version is returned and
91 * 0 when there are no more versions.
92 */
93struct ver_iter
94{
95    const struct lsquic_packet_in  *packet_in;
96    unsigned                        off;
97};
98
99int
100packet_in_ver_first (const lsquic_packet_in_t *packet_in, struct ver_iter *,
101                     lsquic_ver_tag_t *ver_tag);
102
103int
104packet_in_ver_next (struct ver_iter *, lsquic_ver_tag_t *ver_tag);
105
106size_t
107lsquic_packet_in_mem_used (const struct lsquic_packet_in *);
108
109#endif
110