lsquic_engine_public.h revision 10c41073
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
1350aadb33SDmitri Tikhonovstruct lsquic_conn;
1450aadb33SDmitri Tikhonovstruct lsquic_engine;
157f2bd84cSDmitri Tikhonovstruct stack_st_X509;
165392f7a3SLiteSpeed Techstruct lsquic_hash;
175392f7a3SLiteSpeed Techstruct lsquic_stream_if;
185392f7a3SLiteSpeed Techstruct ssl_ctx_st;
1910c41073SDmitri Tikhonovstruct crand;
205392f7a3SLiteSpeed Tech
215392f7a3SLiteSpeed Techenum warning_type
225392f7a3SLiteSpeed Tech{
235392f7a3SLiteSpeed Tech    WT_ACKPARSE_MINI,
245392f7a3SLiteSpeed Tech    WT_ACKPARSE_FULL,
25de46bf2fSDmitri Tikhonov    WT_NO_POISON,
265392f7a3SLiteSpeed Tech    N_WARNING_TYPES,
275392f7a3SLiteSpeed Tech};
285392f7a3SLiteSpeed Tech
295392f7a3SLiteSpeed Tech#define WARNING_INTERVAL (24ULL * 3600ULL * 1000000ULL)
3050aadb33SDmitri Tikhonov
3150aadb33SDmitri Tikhonovstruct lsquic_engine_public {
3250aadb33SDmitri Tikhonov    struct lsquic_mm                enp_mm;
3350aadb33SDmitri Tikhonov    struct lsquic_engine_settings   enp_settings;
345392f7a3SLiteSpeed Tech    struct token_generator         *enp_tokgen;
355392f7a3SLiteSpeed Tech    lsquic_lookup_cert_f            enp_lookup_cert;
365392f7a3SLiteSpeed Tech    void                           *enp_cert_lu_ctx;
375392f7a3SLiteSpeed Tech    struct ssl_ctx_st *           (*enp_get_ssl_ctx)(void *peer_ctx);
385392f7a3SLiteSpeed Tech    const struct lsquic_shared_hash_if
395392f7a3SLiteSpeed Tech                                   *enp_shi;
405392f7a3SLiteSpeed Tech    void                           *enp_shi_ctx;
415392f7a3SLiteSpeed Tech    lsquic_time_t                   enp_last_warning[N_WARNING_TYPES];
425392f7a3SLiteSpeed Tech    const struct lsquic_stream_if  *enp_stream_if;
435392f7a3SLiteSpeed Tech    void                           *enp_stream_if_ctx;
443b55e6aeSDmitri Tikhonov    const struct lsquic_hset_if    *enp_hsi_if;
453b55e6aeSDmitri Tikhonov    void                           *enp_hsi_ctx;
467f2bd84cSDmitri Tikhonov    int                           (*enp_verify_cert)(void *verify_ctx,
477f2bd84cSDmitri Tikhonov                                            struct stack_st_X509 *chain);
487f2bd84cSDmitri Tikhonov    void                           *enp_verify_ctx;
4950aadb33SDmitri Tikhonov    const struct lsquic_packout_mem_if
5050aadb33SDmitri Tikhonov                                   *enp_pmi;
5150aadb33SDmitri Tikhonov    void                           *enp_pmi_ctx;
525392f7a3SLiteSpeed Tech    const struct lsquic_keylog_if  *enp_kli;
535392f7a3SLiteSpeed Tech    void                           *enp_kli_ctx;
5450aadb33SDmitri Tikhonov    struct lsquic_engine           *enp_engine;
555392f7a3SLiteSpeed Tech    struct lsquic_hash             *enp_srst_hash;
5650aadb33SDmitri Tikhonov    enum {
5750aadb33SDmitri Tikhonov        ENPUB_PROC  = (1 << 0), /* Being processed by one of the user-facing
5850aadb33SDmitri Tikhonov                                 * functions.
5950aadb33SDmitri Tikhonov                                 */
60c44946ecSDmitri Tikhonov        ENPUB_CAN_SEND = (1 << 1),
6150aadb33SDmitri Tikhonov    }                               enp_flags;
625392f7a3SLiteSpeed Tech    unsigned char                   enp_ver_tags_buf[ sizeof(lsquic_ver_tag_t) * N_LSQVER ];
635392f7a3SLiteSpeed Tech    unsigned                        enp_ver_tags_len;
6410c41073SDmitri Tikhonov    struct crand                   *enp_crand;
6550aadb33SDmitri Tikhonov};
6650aadb33SDmitri Tikhonov
67e8bd737dSDmitri Tikhonov/* Put connection onto the Tickable Queue if it is not already on it.  If
6850aadb33SDmitri Tikhonov * connection is being destroyed, this is a no-op.
6950aadb33SDmitri Tikhonov */
7050aadb33SDmitri Tikhonovvoid
71e8bd737dSDmitri Tikhonovlsquic_engine_add_conn_to_tickable (struct lsquic_engine_public *,
72e8bd737dSDmitri Tikhonov                                                        lsquic_conn_t *);
7350aadb33SDmitri Tikhonov
7450aadb33SDmitri Tikhonov/* Put connection onto Advisory Tick Time  Queue if it is not already on it.
7550aadb33SDmitri Tikhonov */
7650aadb33SDmitri Tikhonovvoid
7750aadb33SDmitri Tikhonovlsquic_engine_add_conn_to_attq (struct lsquic_engine_public *enpub,
780adf085aSDmitri Tikhonov                                lsquic_conn_t *, lsquic_time_t, unsigned why);
7950aadb33SDmitri Tikhonov
805392f7a3SLiteSpeed Techvoid
815392f7a3SLiteSpeed Techlsquic_engine_retire_cid (struct lsquic_engine_public *,
825392f7a3SLiteSpeed Tech              struct lsquic_conn *, unsigned cce_idx, lsquic_time_t now);
835392f7a3SLiteSpeed Tech
845392f7a3SLiteSpeed Techint
855392f7a3SLiteSpeed Techlsquic_engine_add_cid (struct lsquic_engine_public *,
865392f7a3SLiteSpeed Tech                              struct lsquic_conn *, unsigned cce_idx);
875392f7a3SLiteSpeed Tech
885392f7a3SLiteSpeed Techstruct lsquic_conn *
895392f7a3SLiteSpeed Techlsquic_engine_find_conn (const struct lsquic_engine_public *pub,
905392f7a3SLiteSpeed Tech                         const lsquic_cid_t *cid);
915392f7a3SLiteSpeed Tech
9250aadb33SDmitri Tikhonov#endif
93