lsquic_engine_public.h revision 4580fab7
17d09751dSDmitri Tikhonov/* Copyright (c) 2017 - 2020 LiteSpeed Technologies Inc. See LICENSE. */ 250aadb33SDmitri Tikhonov/* 350aadb33SDmitri Tikhonov * lsquic_engine_public.h -- Engine's "public interface" 450aadb33SDmitri Tikhonov * 55392f7a3SLiteSpeed Tech * This structure is used to bundle things in engine that connections 65392f7a3SLiteSpeed Tech * need. This way, the space per mini connection is one pointer instead 75392f7a3SLiteSpeed Tech * of several. 850aadb33SDmitri Tikhonov */ 950aadb33SDmitri Tikhonov 1050aadb33SDmitri Tikhonov#ifndef LSQUIC_ENGINE_PUBLIC_H 1150aadb33SDmitri Tikhonov#define LSQUIC_ENGINE_PUBLIC_H 1 1250aadb33SDmitri Tikhonov 13b62ec17fSDmitri Tikhonovstruct lsquic_cid; 1450aadb33SDmitri Tikhonovstruct lsquic_conn; 1550aadb33SDmitri Tikhonovstruct lsquic_engine; 167f2bd84cSDmitri Tikhonovstruct stack_st_X509; 175392f7a3SLiteSpeed Techstruct lsquic_hash; 185392f7a3SLiteSpeed Techstruct lsquic_stream_if; 195392f7a3SLiteSpeed Techstruct ssl_ctx_st; 2010c41073SDmitri Tikhonovstruct crand; 219fc12041SDmitri Tikhonovstruct evp_aead_ctx_st; 222f4629f2SDmitri Tikhonovstruct lsquic_server_config; 235392f7a3SLiteSpeed Tech 245392f7a3SLiteSpeed Techenum warning_type 255392f7a3SLiteSpeed Tech{ 265392f7a3SLiteSpeed Tech WT_ACKPARSE_MINI, 275392f7a3SLiteSpeed Tech WT_ACKPARSE_FULL, 28de46bf2fSDmitri Tikhonov WT_NO_POISON, 295392f7a3SLiteSpeed Tech N_WARNING_TYPES, 305392f7a3SLiteSpeed Tech}; 315392f7a3SLiteSpeed Tech 325392f7a3SLiteSpeed Tech#define WARNING_INTERVAL (24ULL * 3600ULL * 1000000ULL) 3350aadb33SDmitri Tikhonov 3450aadb33SDmitri Tikhonovstruct lsquic_engine_public { 3550aadb33SDmitri Tikhonov struct lsquic_mm enp_mm; 3650aadb33SDmitri Tikhonov struct lsquic_engine_settings enp_settings; 375392f7a3SLiteSpeed Tech struct token_generator *enp_tokgen; 385392f7a3SLiteSpeed Tech lsquic_lookup_cert_f enp_lookup_cert; 395392f7a3SLiteSpeed Tech void *enp_cert_lu_ctx; 405392f7a3SLiteSpeed Tech struct ssl_ctx_st * (*enp_get_ssl_ctx)(void *peer_ctx); 415392f7a3SLiteSpeed Tech const struct lsquic_shared_hash_if 425392f7a3SLiteSpeed Tech *enp_shi; 435392f7a3SLiteSpeed Tech void *enp_shi_ctx; 445392f7a3SLiteSpeed Tech lsquic_time_t enp_last_warning[N_WARNING_TYPES]; 455392f7a3SLiteSpeed Tech const struct lsquic_stream_if *enp_stream_if; 465392f7a3SLiteSpeed Tech void *enp_stream_if_ctx; 473b55e6aeSDmitri Tikhonov const struct lsquic_hset_if *enp_hsi_if; 483b55e6aeSDmitri Tikhonov void *enp_hsi_ctx; 49b62ec17fSDmitri Tikhonov void (*enp_generate_scid)(struct lsquic_conn *, 50b62ec17fSDmitri Tikhonov struct lsquic_cid *, unsigned); 517f2bd84cSDmitri Tikhonov int (*enp_verify_cert)(void *verify_ctx, 527f2bd84cSDmitri Tikhonov struct stack_st_X509 *chain); 537f2bd84cSDmitri Tikhonov void *enp_verify_ctx; 5450aadb33SDmitri Tikhonov const struct lsquic_packout_mem_if 5550aadb33SDmitri Tikhonov *enp_pmi; 5650aadb33SDmitri Tikhonov void *enp_pmi_ctx; 575392f7a3SLiteSpeed Tech const struct lsquic_keylog_if *enp_kli; 585392f7a3SLiteSpeed Tech void *enp_kli_ctx; 5950aadb33SDmitri Tikhonov struct lsquic_engine *enp_engine; 605392f7a3SLiteSpeed Tech struct lsquic_hash *enp_srst_hash; 6150aadb33SDmitri Tikhonov enum { 6250aadb33SDmitri Tikhonov ENPUB_PROC = (1 << 0), /* Being processed by one of the user-facing 6350aadb33SDmitri Tikhonov * functions. 6450aadb33SDmitri Tikhonov */ 65c44946ecSDmitri Tikhonov ENPUB_CAN_SEND = (1 << 1), 66fa4561dcSDmitri Tikhonov ENPUB_HTTP = (1 << 2), /* Engine in HTTP mode */ 6750aadb33SDmitri Tikhonov } enp_flags; 685392f7a3SLiteSpeed Tech unsigned char enp_ver_tags_buf[ sizeof(lsquic_ver_tag_t) * N_LSQVER ]; 695392f7a3SLiteSpeed Tech unsigned enp_ver_tags_len; 7010c41073SDmitri Tikhonov struct crand *enp_crand; 719fc12041SDmitri Tikhonov struct evp_aead_ctx_st *enp_retry_aead_ctx; 72fa4561dcSDmitri Tikhonov unsigned char *enp_alpn; /* May be set if not HTTP */ 738ae5ecb4SDmitri Tikhonov /* es_noprogress_timeout converted to microseconds for speed */ 748ae5ecb4SDmitri Tikhonov lsquic_time_t enp_noprog_timeout; 75b8fa6195SDmitri Tikhonov lsquic_time_t enp_mtu_probe_timer; 762f4629f2SDmitri Tikhonov /* Certs used by gQUIC server: */ 772f4629f2SDmitri Tikhonov struct lsquic_hash *enp_compressed_server_certs; 782f4629f2SDmitri Tikhonov struct lsquic_hash *enp_server_certs; 792f4629f2SDmitri Tikhonov /* gQUIC server configuration: */ 802f4629f2SDmitri Tikhonov struct lsquic_server_config *enp_server_config; 8104f8f447SDmitri Tikhonov /* Serialized subset of server engine transport parameters that is used 8204f8f447SDmitri Tikhonov * as SSL QUIC context. 0 is for version <= LSQVER_ID27, 1 is for others. 8304f8f447SDmitri Tikhonov */ 8404f8f447SDmitri Tikhonov unsigned char enp_quic_ctx_buf[2][200]; 8504f8f447SDmitri Tikhonov unsigned enp_quic_ctx_sz[2]; 86758aff32SDmitri Tikhonov#if LSQUIC_CONN_STATS 87758aff32SDmitri Tikhonov struct batch_size_stats { 88758aff32SDmitri Tikhonov unsigned min, max, /* Minimum and maximum batch sizes */ 89758aff32SDmitri Tikhonov count; /* Number of batches sent */ 90758aff32SDmitri Tikhonov float avg; /* Average batch size */ 91758aff32SDmitri Tikhonov } enp_batch_size_stats; 92758aff32SDmitri Tikhonov#endif 9350aadb33SDmitri Tikhonov}; 9450aadb33SDmitri Tikhonov 95e8bd737dSDmitri Tikhonov/* Put connection onto the Tickable Queue if it is not already on it. If 9650aadb33SDmitri Tikhonov * connection is being destroyed, this is a no-op. 9750aadb33SDmitri Tikhonov */ 9850aadb33SDmitri Tikhonovvoid 99e8bd737dSDmitri Tikhonovlsquic_engine_add_conn_to_tickable (struct lsquic_engine_public *, 100e8bd737dSDmitri Tikhonov lsquic_conn_t *); 10150aadb33SDmitri Tikhonov 10250aadb33SDmitri Tikhonov/* Put connection onto Advisory Tick Time Queue if it is not already on it. 10350aadb33SDmitri Tikhonov */ 10450aadb33SDmitri Tikhonovvoid 10550aadb33SDmitri Tikhonovlsquic_engine_add_conn_to_attq (struct lsquic_engine_public *enpub, 1060adf085aSDmitri Tikhonov lsquic_conn_t *, lsquic_time_t, unsigned why); 10750aadb33SDmitri Tikhonov 1085392f7a3SLiteSpeed Techvoid 1095392f7a3SLiteSpeed Techlsquic_engine_retire_cid (struct lsquic_engine_public *, 1104580fab7SDmitri Tikhonov struct lsquic_conn *, unsigned cce_idx, lsquic_time_t now, 1114580fab7SDmitri Tikhonov lsquic_time_t drain_time); 1125392f7a3SLiteSpeed Tech 1135392f7a3SLiteSpeed Techint 1145392f7a3SLiteSpeed Techlsquic_engine_add_cid (struct lsquic_engine_public *, 1155392f7a3SLiteSpeed Tech struct lsquic_conn *, unsigned cce_idx); 1165392f7a3SLiteSpeed Tech 1175392f7a3SLiteSpeed Techstruct lsquic_conn * 1185392f7a3SLiteSpeed Techlsquic_engine_find_conn (const struct lsquic_engine_public *pub, 1195392f7a3SLiteSpeed Tech const lsquic_cid_t *cid); 1205392f7a3SLiteSpeed Tech 12150aadb33SDmitri Tikhonov#endif 122