lsquic_conn.h revision b78e44ee
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; /* Used for logging */ 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 conn_iface 90{ 91 enum tick_st 92 (*ci_tick) (struct lsquic_conn *, lsquic_time_t now); 93 94 void 95 (*ci_packet_in) (struct lsquic_conn *, struct lsquic_packet_in *); 96 97 /* Note: all packets "checked out" by calling this method should be 98 * returned back to the connection via ci_packet_sent() or 99 * ci_packet_not_sent() calls before the connection is ticked next. 100 * The connection, in turn, should not perform any extra processing 101 * (especially schedule more packets) during any of these method 102 * calls. This is because the checked out packets are not accounted 103 * for by the congestion controller. 104 */ 105 struct lsquic_packet_out * 106 (*ci_next_packet_to_send) (struct lsquic_conn *, size_t); 107 108 void 109 (*ci_packet_sent) (struct lsquic_conn *, struct lsquic_packet_out *); 110 111 void 112 (*ci_packet_not_sent) (struct lsquic_conn *, struct lsquic_packet_out *); 113 114 void 115 (*ci_hsk_done) (struct lsquic_conn *, enum lsquic_hsk_status); 116 117 void 118 (*ci_destroy) (struct lsquic_conn *); 119 120 int 121 (*ci_is_tickable) (struct lsquic_conn *); 122 123 lsquic_time_t 124 (*ci_next_tick_time) (struct lsquic_conn *, unsigned *why); 125 126 int 127 (*ci_can_write_ack) (struct lsquic_conn *); 128 129 /* No return status: best effort */ 130 void 131 (*ci_write_ack) (struct lsquic_conn *, struct lsquic_packet_out *); 132 133#if LSQUIC_CONN_STATS 134 const struct conn_stats * 135 (*ci_get_stats) (struct lsquic_conn *); 136#endif 137 138 void 139 (*ci_client_call_on_new) (struct lsquic_conn *); 140 141 enum LSQUIC_CONN_STATUS 142 (*ci_status) (struct lsquic_conn *, char *errbuf, size_t bufsz); 143 144 unsigned 145 (*ci_n_avail_streams) (const struct lsquic_conn *); 146 147 unsigned 148 (*ci_n_pending_streams) (const struct lsquic_conn *); 149 150 unsigned 151 (*ci_cancel_pending_streams) (struct lsquic_conn *, unsigned n); 152 153 void 154 (*ci_going_away) (struct lsquic_conn *); 155 156 int 157 (*ci_is_push_enabled) (struct lsquic_conn *); 158 159 /* Optional: only used by gQUIC frames reader */ 160 /* If stream is already closed, NULL is returned */ 161 struct lsquic_stream * 162 (*ci_get_stream_by_id) (struct lsquic_conn *, lsquic_stream_id_t stream_id); 163 164 struct lsquic_engine * 165 (*ci_get_engine) (struct lsquic_conn *); 166 167 struct lsquic_conn_ctx * 168 (*ci_get_ctx) (const struct lsquic_conn *); 169 170 void 171 (*ci_set_ctx) (struct lsquic_conn *, struct lsquic_conn_ctx *); 172 173 void 174 (*ci_make_stream) (struct lsquic_conn *); 175 176 void 177 (*ci_abort) (struct lsquic_conn *); 178 179 void 180 (*ci_retire_cid) (struct lsquic_conn *); 181 182 void 183 (*ci_close) (struct lsquic_conn *); 184 185 void 186 (*ci_stateless_reset) (struct lsquic_conn *); 187 188 int 189 (*ci_crypto_keysize) (const struct lsquic_conn *); 190 191 int 192 (*ci_crypto_alg_keysize) (const struct lsquic_conn *); 193 194 enum lsquic_crypto_ver 195 (*ci_crypto_ver) (const struct lsquic_conn *); 196 197 const char * 198 (*ci_crypto_cipher) (const struct lsquic_conn *); 199 200 int 201 (*ci_push_stream) (struct lsquic_conn *, void *hset, struct lsquic_stream *, 202 const struct lsquic_http_headers *headers); 203 204 /* Use this to abort the connection when unlikely errors occur */ 205 void 206 (*ci_internal_error) (struct lsquic_conn *, const char *format, ...) 207#if __GNUC__ 208 __attribute__((format(printf, 2, 3))) 209#endif 210 ; 211 212 /* Abort connection with error */ 213 void 214 (*ci_abort_error) (struct lsquic_conn *, int is_app, unsigned error_code, 215 const char *format, ...) 216#if __GNUC__ 217 __attribute__((format(printf, 4, 5))) 218#endif 219 ; 220 221 void 222 (*ci_tls_alert) (struct lsquic_conn *, uint8_t); 223 224 /* Returns 0 if connection is to be deleted immediately */ 225 lsquic_time_t 226 (*ci_drain_time) (const struct lsquic_conn *); 227 228 /* Returns true if it's time to report the connection's CIDs' liveness */ 229 int 230 (*ci_report_live) (struct lsquic_conn *, lsquic_time_t now); 231 232 /* If `local_sa' is NULL, return default path */ 233 struct network_path * 234 (*ci_get_path) (struct lsquic_conn *, const struct sockaddr *local_sa); 235 236 unsigned char 237 (*ci_record_addrs) (struct lsquic_conn *, void *peer_ctx, 238 const struct sockaddr *local_sa, const struct sockaddr *peer_sa); 239 240 const lsquic_cid_t * 241 (*ci_get_log_cid) (const struct lsquic_conn *); 242 243 /* Optional method. Only used by the IETF client code. */ 244 void 245 (*ci_drop_crypto_streams) (struct lsquic_conn *); 246}; 247 248#define LSCONN_CCE_BITS 3 249#define LSCONN_MAX_CCES (1 << LSCONN_CCE_BITS) 250 251struct conn_cid_elem 252{ 253 struct lsquic_hash_elem cce_hash_el; /* Must be first element */ 254 lsquic_cid_t cce_cid; 255 union { 256 unsigned seqno; 257 unsigned short port; 258 } cce_u; 259#define cce_seqno cce_u.seqno 260#define cce_port cce_u.port 261 enum conn_cce_flags { 262 CCE_USED = 1 << 0, /* Connection ID has been used */ 263 CCE_SEQNO = 1 << 1, /* cce_seqno is set (CIDs in Initial 264 * packets have no sequence number). 265 */ 266 CCE_REG = 1 << 2, /* CID has been registered */ 267 CCE_PORT = 1 << 3, /* It's not a CID element at all: 268 * cce_port is the hash value. 269 */ 270 } cce_flags; 271}; 272 273struct lsquic_conn 274{ 275 void *cn_enc_session; 276 const struct enc_session_funcs_common 277 *cn_esf_c; 278 union { 279 const struct enc_session_funcs_gquic *g; 280 const struct enc_session_funcs_iquic *i; 281 } cn_esf; 282#define cn_cid cn_cces[0].cce_cid 283 STAILQ_ENTRY(lsquic_conn) cn_next_closed_conn; 284 /* This and cn_next_closed_conn could be made into a union, as new full 285 * connections are never closed. 286 */ 287 STAILQ_ENTRY(lsquic_conn) cn_next_new_full; 288 TAILQ_ENTRY(lsquic_conn) cn_next_ticked; 289 TAILQ_ENTRY(lsquic_conn) cn_next_out; 290 TAILQ_ENTRY(lsquic_conn) cn_next_pr; 291 const struct conn_iface *cn_if; 292 const struct parse_funcs *cn_pf; 293 struct attq_elem *cn_attq_elem; 294 lsquic_time_t cn_last_sent; 295 lsquic_time_t cn_last_ticked; 296 struct conn_cid_elem *cn_cces; /* At least one is available */ 297 enum lsquic_conn_flags cn_flags; 298 enum lsquic_version cn_version:8; 299 unsigned char cn_cces_mask; /* Those that are set */ 300 unsigned char cn_n_cces; /* Number of CCEs in cn_cces */ 301 unsigned char cn_cur_cce_idx; 302#if LSQUIC_TEST 303 struct conn_cid_elem cn_cces_buf[8]; 304#define LSCONN_INITIALIZER_CID(lsconn_, cid_) { \ 305 .cn_cces = (lsconn_).cn_cces_buf, \ 306 .cn_cces_buf[0].cce_seqno = 0, \ 307 .cn_cces_buf[0].cce_flags = CCE_SEQNO, \ 308 .cn_cces_buf[0].cce_cid = (cid_), \ 309 .cn_n_cces = 8, .cn_cces_mask = 1, } 310#define LSCONN_INITIALIZER_CIDLEN(lsconn_, len_) { \ 311 .cn_cces = (lsconn_).cn_cces_buf, \ 312 .cn_cces_buf[0].cce_seqno = 0, \ 313 .cn_cces_buf[0].cce_flags = CCE_SEQNO, \ 314 .cn_cces_buf[0].cce_cid = { .len = len_ }, \ 315 .cn_n_cces = 8, .cn_cces_mask = 1, } 316#define LSCONN_INITIALIZE(lsconn_) do { \ 317 (lsconn_)->cn_cces = (lsconn_)->cn_cces_buf; \ 318 (lsconn_)->cn_n_cces = 8; (lsconn_)->cn_cces_mask = 1; } while (0) 319#endif 320}; 321 322#define END_OF_CCES(conn) ((conn)->cn_cces + (conn)->cn_n_cces) 323 324#define CN_SCID(conn) (&(conn)->cn_cces[(conn)->cn_cur_cce_idx].cce_cid) 325 326unsigned char 327lsquic_conn_record_sockaddr (lsquic_conn_t *lconn, void *peer_ctx, 328 const struct sockaddr *local_sa, const struct sockaddr *peer_sa); 329 330int 331lsquic_conn_decrypt_packet (lsquic_conn_t *lconn, 332 struct lsquic_engine_public *, struct lsquic_packet_in *); 333 334int 335lsquic_conn_copy_and_release_pi_data (const lsquic_conn_t *conn, 336 struct lsquic_engine_public *, struct lsquic_packet_in *); 337 338void 339lsquic_generate_cid (lsquic_cid_t *cid, size_t len); 340 341void 342lsquic_generate_cid_gquic (lsquic_cid_t *cid); 343 344void 345lsquic_conn_retire_cid (lsquic_conn_t *lconn); 346 347#define lsquic_conn_adv_time(c) ((c)->cn_attq_elem->ae_adv_time) 348 349#if LSQUIC_CONN_STATS 350struct conn_stats { 351 /* All counters are of the same type, unsigned long, because we cast the 352 * struct to an array to update the aggregate. 353 */ 354 unsigned long n_ticks; /* How many time connection was ticked */ 355 struct { 356 unsigned long stream_data_sz; /* Sum of all STREAM frames payload */ 357 unsigned long stream_frames; /* Number of STREAM frames */ 358 unsigned long packets, /* Incoming packets */ 359 undec_packets, /* Undecryptable packets */ 360 dup_packets, /* Duplicate packets */ 361 err_packets; /* Error packets(?) */ 362 unsigned long n_acks, 363 n_acks_proc, 364 n_acks_merged; 365 unsigned long bytes; /* Overall bytes in */ 366 unsigned long headers_uncomp; /* Sum of uncompressed header bytes */ 367 unsigned long headers_comp; /* Sum of compressed header bytes */ 368 } in; 369 struct { 370 unsigned long stream_data_sz; 371 unsigned long stream_frames; 372 unsigned long acks; 373 unsigned long packets; /* Number of sent packets */ 374 unsigned long acked_via_loss; /* Number of packets acked via loss record */ 375 unsigned long retx_packets; /* Number of retransmitted packets */ 376 unsigned long bytes; /* Overall bytes out */ 377 unsigned long headers_uncomp; /* Sum of uncompressed header bytes */ 378 unsigned long headers_comp; /* Sum of compressed header bytes */ 379 } out; 380}; 381#endif 382 383#endif 384