lsquic_engine_public.h revision 2f4629f2
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;
8150aadb33SDmitri Tikhonov};
8250aadb33SDmitri Tikhonov
83e8bd737dSDmitri Tikhonov/* Put connection onto the Tickable Queue if it is not already on it.  If
8450aadb33SDmitri Tikhonov * connection is being destroyed, this is a no-op.
8550aadb33SDmitri Tikhonov */
8650aadb33SDmitri Tikhonovvoid
87e8bd737dSDmitri Tikhonovlsquic_engine_add_conn_to_tickable (struct lsquic_engine_public *,
88e8bd737dSDmitri Tikhonov                                                        lsquic_conn_t *);
8950aadb33SDmitri Tikhonov
9050aadb33SDmitri Tikhonov/* Put connection onto Advisory Tick Time  Queue if it is not already on it.
9150aadb33SDmitri Tikhonov */
9250aadb33SDmitri Tikhonovvoid
9350aadb33SDmitri Tikhonovlsquic_engine_add_conn_to_attq (struct lsquic_engine_public *enpub,
940adf085aSDmitri Tikhonov                                lsquic_conn_t *, lsquic_time_t, unsigned why);
9550aadb33SDmitri Tikhonov
965392f7a3SLiteSpeed Techvoid
975392f7a3SLiteSpeed Techlsquic_engine_retire_cid (struct lsquic_engine_public *,
985392f7a3SLiteSpeed Tech              struct lsquic_conn *, unsigned cce_idx, lsquic_time_t now);
995392f7a3SLiteSpeed Tech
1005392f7a3SLiteSpeed Techint
1015392f7a3SLiteSpeed Techlsquic_engine_add_cid (struct lsquic_engine_public *,
1025392f7a3SLiteSpeed Tech                              struct lsquic_conn *, unsigned cce_idx);
1035392f7a3SLiteSpeed Tech
1045392f7a3SLiteSpeed Techstruct lsquic_conn *
1055392f7a3SLiteSpeed Techlsquic_engine_find_conn (const struct lsquic_engine_public *pub,
1065392f7a3SLiteSpeed Tech                         const lsquic_cid_t *cid);
1075392f7a3SLiteSpeed Tech
10850aadb33SDmitri Tikhonov#endif
109