lsquic_conn.h revision b1a7c3f9 
1/* Copyright (c) 2017 - 2020 LiteSpeed Technologies Inc.  See LICENSE. */
2/*
3 * lsquic_conn.h -- Connection interface
4 *
5 * There are two types of connections: full (lsquic_full_conn.h) and mini
6 * (lsquic_mini_conn.h).  The function pointers and struct in this header
7 * file provide a unified interface engine.c can use to interact with
8 * either of the connection types.  For this to work, struct lsquic_conn
9 * must be the first element of struct full_conn and struct mini_conn.
10 */
11#ifndef LSQUIC_CONN_H
12#define LSQUIC_CONN_H
13
14#include <sys/queue.h>
15#ifndef WIN32
16#include <sys/socket.h>
17#include <netinet/in.h>
18#else
19#include <ws2ipdef.h>
20#endif
21
22struct lsquic_conn;
23struct lsquic_engine_public;
24struct lsquic_packet_out;
25struct lsquic_packet_in;
26struct sockaddr;
27struct parse_funcs;
28struct attq_elem;
29#if LSQUIC_CONN_STATS
30struct conn_stats;
31#endif
32
33enum lsquic_conn_flags {
34    LSCONN_TICKED         = (1 << 0),
35    LSCONN_HAS_OUTGOING   = (1 << 1),
36    LSCONN_HASHED         = (1 << 2),
37    LSCONN_MINI           = (1 << 3),   /* This is a mini connection */
38    LSCONN_IMMED_CLOSE    = (1 << 4),
39    LSCONN_UNUSED_5       = (1 << 5),
40    LSCONN_HANDSHAKE_DONE = (1 << 6),
41    LSCONN_CLOSING        = (1 << 7),
42    LSCONN_PEER_GOING_AWAY= (1 << 8),
43    LSCONN_TCID0          = (1 << 9),
44    LSCONN_VER_SET        = (1 <<10),   /* cn_version is set */
45    LSCONN_EVANESCENT     = (1 <<11),   /* evanescent connection */
46    LSCONN_TICKABLE       = (1 <<12),   /* Connection is in the Tickable Queue */
47    LSCONN_COI_ACTIVE     = (1 <<13),
48    LSCONN_COI_INACTIVE   = (1 <<14),
49    LSCONN_SEND_BLOCKED   = (1 <<15),   /* Send connection blocked frame */
50    LSCONN_PROMOTED       = (1 <<16),   /* Promoted.  Only set if LSCONN_MINI is set */
51    LSCONN_NEVER_TICKABLE = (1 <<17),   /* Do not put onto the Tickable Queue */
52    LSCONN_UNUSED_18      = (1 <<18),
53    LSCONN_ATTQ           = (1 <<19),
54    LSCONN_SKIP_ON_PROC   = (1 <<20),
55    LSCONN_UNUSED_21      = (1 <<21),
56    LSCONN_SERVER         = (1 <<22),
57    LSCONN_IETF           = (1 <<23),
58    LSCONN_RETRY_CONN     = (1 <<24),   /* This is a retry connection */
59};
60
61/* A connection may have things to send and be closed at the same time.
62 */
63enum tick_st {
64    TICK_SEND    = (1 << 0),
65    TICK_CLOSE   = (1 << 1),
66    TICK_PROMOTE = (1 << 2), /* Promote mini connection to full connection */
67};
68
69#define TICK_QUIET 0
70
71struct network_path
72{
73    union {
74        unsigned char           buf[sizeof(struct sockaddr_in6)];
75        struct sockaddr         sockaddr;
76    }               np_local_addr_u;
77#define np_local_addr np_local_addr_u.buf
78    unsigned char   np_peer_addr[sizeof(struct sockaddr_in6)];
79    void           *np_peer_ctx;
80    lsquic_cid_t    np_dcid;
81    unsigned short  np_pack_size;
82    unsigned char   np_path_id;
83};
84
85#define NP_LOCAL_SA(path_) (&(path_)->np_local_addr_u.sockaddr)
86#define NP_PEER_SA(path_) ((struct sockaddr *) (path_)->np_peer_addr)
87#define NP_IS_IPv6(path_) (AF_INET6 == NP_LOCAL_SA(path_)->sa_family)
88
89struct ack_state
90{
91    uint32_t    arr[6];
92};
93
94struct to_coal
95{
96    const struct lsquic_packet_out  *prev_packet;
97    size_t                           prev_sz_sum;
98};
99
100struct conn_iface
101{
102    enum tick_st
103    (*ci_tick) (struct lsquic_conn *, lsquic_time_t now);
104
105    void
106    (*ci_packet_in) (struct lsquic_conn *, struct lsquic_packet_in *);
107
108    /* Note: all packets "checked out" by calling this method should be
109     * returned back to the connection via ci_packet_sent() or
110     * ci_packet_not_sent() calls before the connection is ticked next.
111     * The connection, in turn, should not perform any extra processing
112     * (especially schedule more packets) during any of these method
113     * calls.  This is because the checked out packets are not accounted
114     * for by the congestion controller.
115     */
116    struct lsquic_packet_out *
117    (*ci_next_packet_to_send) (struct lsquic_conn *, const struct to_coal *);
118
119    void
120    (*ci_packet_sent) (struct lsquic_conn *, struct lsquic_packet_out *);
121
122    void
123    (*ci_packet_not_sent) (struct lsquic_conn *, struct lsquic_packet_out *);
124
125    void
126    (*ci_packet_too_large) (struct lsquic_conn *, struct lsquic_packet_out *);
127
128    void
129    (*ci_hsk_done) (struct lsquic_conn *, enum lsquic_hsk_status);
130
131    void
132    (*ci_destroy) (struct lsquic_conn *);
133
134    int
135    (*ci_is_tickable) (struct lsquic_conn *);
136
137    lsquic_time_t
138    (*ci_next_tick_time) (struct lsquic_conn *, unsigned *why);
139
140    int
141    (*ci_can_write_ack) (struct lsquic_conn *);
142
143    /* No return status: best effort */
144    void
145    (*ci_write_ack) (struct lsquic_conn *, struct lsquic_packet_out *);
146
147#if LSQUIC_CONN_STATS
148    const struct conn_stats *
149    (*ci_get_stats) (struct lsquic_conn *);
150#endif
151
152    void
153    (*ci_client_call_on_new) (struct lsquic_conn *);
154
155    enum LSQUIC_CONN_STATUS
156    (*ci_status) (struct lsquic_conn *, char *errbuf, size_t bufsz);
157
158    unsigned
159    (*ci_n_avail_streams) (const struct lsquic_conn *);
160
161    unsigned
162    (*ci_n_pending_streams) (const struct lsquic_conn *);
163
164    unsigned
165    (*ci_cancel_pending_streams) (struct lsquic_conn *, unsigned n);
166
167    void
168    (*ci_going_away) (struct lsquic_conn *);
169
170    int
171    (*ci_is_push_enabled) (struct lsquic_conn *);
172
173    /* Optional: only used by gQUIC frames reader */
174    /* If stream is already closed, NULL is returned */
175    struct lsquic_stream *
176    (*ci_get_stream_by_id) (struct lsquic_conn *, lsquic_stream_id_t stream_id);
177
178    struct lsquic_engine *
179    (*ci_get_engine) (struct lsquic_conn *);
180
181    struct lsquic_conn_ctx *
182    (*ci_get_ctx) (const struct lsquic_conn *);
183
184    void
185    (*ci_set_ctx) (struct lsquic_conn *, struct lsquic_conn_ctx *);
186
187    void
188    (*ci_make_stream) (struct lsquic_conn *);
189
190    void
191    (*ci_abort) (struct lsquic_conn *);
192
193    void
194    (*ci_retire_cid) (struct lsquic_conn *);
195
196    void
197    (*ci_close) (struct lsquic_conn *);
198
199    void
200    (*ci_stateless_reset) (struct lsquic_conn *);
201
202    int
203    (*ci_crypto_keysize) (const struct lsquic_conn *);
204
205    int
206    (*ci_crypto_alg_keysize) (const struct lsquic_conn *);
207
208    enum lsquic_crypto_ver
209    (*ci_crypto_ver) (const struct lsquic_conn *);
210
211    const char *
212    (*ci_crypto_cipher) (const struct lsquic_conn *);
213
214    int
215    (*ci_push_stream) (struct lsquic_conn *, void *hset, struct lsquic_stream *,
216        const struct lsquic_http_headers *headers);
217
218    /* Use this to abort the connection when unlikely errors occur */
219    void
220    (*ci_internal_error) (struct lsquic_conn *, const char *format, ...)
221#if __GNUC__
222            __attribute__((format(printf, 2, 3)))
223#endif
224    ;
225
226    /* Abort connection with error */
227    void
228    (*ci_abort_error) (struct lsquic_conn *, int is_app, unsigned error_code,
229                                                        const char *format, ...)
230#if __GNUC__
231            __attribute__((format(printf, 4, 5)))
232#endif
233    ;
234
235    void
236    (*ci_tls_alert) (struct lsquic_conn *, uint8_t);
237
238    /* Returns 0 if connection is to be deleted immediately */
239    lsquic_time_t
240    (*ci_drain_time) (const struct lsquic_conn *);
241
242    /* Returns true if it's time to report the connection's CIDs' liveness */
243    int
244    (*ci_report_live) (struct lsquic_conn *, lsquic_time_t now);
245
246    /* If `local_sa' is NULL, return default path */
247    struct network_path *
248    (*ci_get_path) (struct lsquic_conn *, const struct sockaddr *local_sa);
249
250    unsigned char
251    (*ci_record_addrs) (struct lsquic_conn *, void *peer_ctx,
252        const struct sockaddr *local_sa, const struct sockaddr *peer_sa);
253
254    const lsquic_cid_t *
255    (*ci_get_log_cid) (const struct lsquic_conn *);
256
257    /* Optional method.  Only used by the IETF client code. */
258    void
259    (*ci_drop_crypto_streams) (struct lsquic_conn *);
260
261    /* Optional method.  Only used by IETF connections */
262    void
263    (*ci_count_garbage) (struct lsquic_conn *, size_t);
264
265    /* Optional method.  Must be implemented if connection sends MTU probes */
266    void
267    (*ci_mtu_probe_acked) (struct lsquic_conn *,
268                                            const struct lsquic_packet_out *);
269
270    /* Optional method.  It is called when RTO occurs. */
271    void
272    (*ci_retx_timeout) (struct lsquic_conn *);
273
274    void
275    (*ci_ack_snapshot) (struct lsquic_conn *, struct ack_state *);
276
277    void
278    (*ci_ack_rollback) (struct lsquic_conn *, struct ack_state *);
279
280    /* Optional method. */
281    int
282    (*ci_want_datagram_write) (struct lsquic_conn *, int);
283
284    /* Optional method */
285    int
286    (*ci_set_min_datagram_size) (struct lsquic_conn *, size_t);
287
288    /* Optional method */
289    size_t
290    (*ci_get_min_datagram_size) (struct lsquic_conn *);
291};
292
293#define LSCONN_CCE_BITS 3
294#define LSCONN_MAX_CCES (1 << LSCONN_CCE_BITS)
295
296struct conn_cid_elem
297{
298    struct lsquic_hash_elem     cce_hash_el;    /* Must be first element */
299    lsquic_cid_t                cce_cid;
300    union {
301        unsigned            seqno;
302        unsigned short      port;
303    }                           cce_u;
304#define cce_seqno cce_u.seqno
305#define cce_port cce_u.port
306    enum conn_cce_flags {
307        CCE_USED        = 1 << 0,       /* Connection ID has been used */
308        CCE_SEQNO       = 1 << 1,       /* cce_seqno is set (CIDs in Initial
309                                         * packets have no sequence number).
310                                         */
311        CCE_REG         = 1 << 2,       /* CID has been registered */
312        CCE_PORT        = 1 << 3,       /* It's not a CID element at all:
313                                         * cce_port is the hash value.
314                                         */
315    }                           cce_flags;
316};
317
318struct lsquic_conn
319{
320    void                        *cn_enc_session;
321    const struct enc_session_funcs_common
322                                *cn_esf_c;
323    union {
324        const struct enc_session_funcs_gquic   *g;
325        const struct enc_session_funcs_iquic   *i;
326    }                            cn_esf;
327#define cn_cid cn_cces[0].cce_cid
328    STAILQ_ENTRY(lsquic_conn)    cn_next_closed_conn;
329    /* This and cn_next_closed_conn could be made into a union, as new full
330     * connections are never closed.
331     */
332    STAILQ_ENTRY(lsquic_conn)    cn_next_new_full;
333    TAILQ_ENTRY(lsquic_conn)     cn_next_ticked;
334    TAILQ_ENTRY(lsquic_conn)     cn_next_out;
335    TAILQ_ENTRY(lsquic_conn)     cn_next_pr;
336    const struct conn_iface     *cn_if;
337    const struct parse_funcs    *cn_pf;
338    struct attq_elem            *cn_attq_elem;
339    lsquic_time_t                cn_last_sent;
340    lsquic_time_t                cn_last_ticked;
341    struct conn_cid_elem        *cn_cces;   /* At least one is available */
342    enum lsquic_conn_flags       cn_flags;
343    enum lsquic_version          cn_version:8;
344    unsigned char                cn_cces_mask;  /* Those that are set */
345    unsigned char                cn_n_cces; /* Number of CCEs in cn_cces */
346    unsigned char                cn_cur_cce_idx;
347#if LSQUIC_TEST
348    struct conn_cid_elem         cn_cces_buf[8];
349#define LSCONN_INITIALIZER_CID(lsconn_, cid_) { \
350                .cn_cces = (lsconn_).cn_cces_buf, \
351                .cn_cces_buf[0].cce_seqno = 0, \
352                .cn_cces_buf[0].cce_flags = CCE_SEQNO, \
353                .cn_cces_buf[0].cce_cid = (cid_), \
354                .cn_n_cces = 8, .cn_cces_mask = 1, }
355#define LSCONN_INITIALIZER_CIDLEN(lsconn_, len_) { \
356                .cn_cces = (lsconn_).cn_cces_buf, \
357                .cn_cces_buf[0].cce_seqno = 0, \
358                .cn_cces_buf[0].cce_flags = CCE_SEQNO, \
359                .cn_cces_buf[0].cce_cid = { .len = len_ }, \
360                .cn_n_cces = 8, .cn_cces_mask = 1, }
361#define LSCONN_INITIALIZE(lsconn_) do { \
362            (lsconn_)->cn_cces = (lsconn_)->cn_cces_buf; \
363            (lsconn_)->cn_n_cces = 8; (lsconn_)->cn_cces_mask = 1; } while (0)
364#endif
365};
366
367#define END_OF_CCES(conn) ((conn)->cn_cces + (conn)->cn_n_cces)
368
369#define CN_SCID(conn) (&(conn)->cn_cces[(conn)->cn_cur_cce_idx].cce_cid)
370
371unsigned char
372lsquic_conn_record_sockaddr (lsquic_conn_t *lconn, void *peer_ctx,
373            const struct sockaddr *local_sa, const struct sockaddr *peer_sa);
374
375int
376lsquic_conn_decrypt_packet (lsquic_conn_t *lconn,
377                    struct lsquic_engine_public *, struct lsquic_packet_in *);
378
379int
380lsquic_conn_copy_and_release_pi_data (const lsquic_conn_t *conn,
381                    struct lsquic_engine_public *, struct lsquic_packet_in *);
382
383void
384lsquic_generate_cid (lsquic_cid_t *cid, size_t len);
385
386void
387lsquic_generate_cid_gquic (lsquic_cid_t *cid);
388
389void
390lsquic_conn_retire_cid (lsquic_conn_t *lconn);
391
392#define lsquic_conn_adv_time(c) ((c)->cn_attq_elem->ae_adv_time)
393
394#if LSQUIC_CONN_STATS
395struct conn_stats {
396    /* All counters are of the same type, unsigned long, because we cast the
397     * struct to an array to update the aggregate.
398     */
399    unsigned long           n_ticks;            /* How many time connection was ticked */
400    struct {
401        unsigned long       stream_data_sz;     /* Sum of all STREAM frames payload */
402        unsigned long       stream_frames;      /* Number of STREAM frames */
403        unsigned long       packets,            /* Incoming packets */
404                            undec_packets,      /* Undecryptable packets */
405                            dup_packets,        /* Duplicate packets */
406                            err_packets;        /* Error packets(?) */
407        unsigned long       n_acks,
408                            n_acks_proc,
409                            n_acks_merged;
410        unsigned long       bytes;              /* Overall bytes in */
411        unsigned long       headers_uncomp;     /* Sum of uncompressed header bytes */
412        unsigned long       headers_comp;       /* Sum of compressed header bytes */
413    }                   in;
414    struct {
415        unsigned long       stream_data_sz;
416        unsigned long       stream_frames;
417        unsigned long       acks;
418        unsigned long       packets;            /* Number of sent packets */
419        unsigned long       acked_via_loss;     /* Number of packets acked via loss record */
420        unsigned long       retx_packets;       /* Number of retransmitted packets */
421        unsigned long       bytes;              /* Overall bytes out */
422        unsigned long       headers_uncomp;     /* Sum of uncompressed header bytes */
423        unsigned long       headers_comp;       /* Sum of compressed header bytes */
424    }                   out;
425};
426#endif
427
428#endif
429