lsquic_engine_public.h revision a74702c6 
1/* Copyright (c) 2017 - 2022 LiteSpeed Technologies Inc.  See LICENSE. */
2/*
3 * lsquic_engine_public.h -- Engine's "public interface"
4 *
5 * This structure is used to bundle things in engine that connections
6 * need.  This way, the space per mini connection is one pointer instead
7 * of several.
8 */
9
10#ifndef LSQUIC_ENGINE_PUBLIC_H
11#define LSQUIC_ENGINE_PUBLIC_H 1
12
13struct lsquic_cid;
14struct lsquic_conn;
15struct lsquic_engine;
16struct stack_st_X509;
17struct lsquic_hash;
18struct lsquic_stream_if;
19struct ssl_ctx_st;
20struct crand;
21struct evp_aead_ctx_st;
22struct lsquic_server_config;
23struct sockaddr;
24
25enum warning_type
26{
27    WT_ACKPARSE_MINI,
28    WT_ACKPARSE_FULL,
29    WT_NO_POISON,
30    N_WARNING_TYPES,
31};
32
33#define WARNING_INTERVAL (24ULL * 3600ULL * 1000000ULL)
34
35struct lsquic_engine_public {
36    struct lsquic_mm                enp_mm;
37    struct lsquic_engine_settings   enp_settings;
38    struct token_generator         *enp_tokgen;
39    lsquic_lookup_cert_f            enp_lookup_cert;
40    void                           *enp_cert_lu_ctx;
41    struct ssl_ctx_st *           (*enp_get_ssl_ctx)(void *peer_ctx,
42                                                     const struct sockaddr *);
43    const struct lsquic_shared_hash_if
44                                   *enp_shi;
45    void                           *enp_shi_ctx;
46    lsquic_time_t                   enp_last_warning[N_WARNING_TYPES];
47    const struct lsquic_stream_if  *enp_stream_if;
48    void                           *enp_stream_if_ctx;
49    const struct lsquic_hset_if    *enp_hsi_if;
50    void                           *enp_hsi_ctx;
51    void                          (*enp_generate_scid)(void *,
52                        struct lsquic_conn *, struct lsquic_cid *, unsigned);
53    void                           *enp_gen_scid_ctx;
54    int                           (*enp_verify_cert)(void *verify_ctx,
55                                            struct stack_st_X509 *chain);
56    void                           *enp_verify_ctx;
57    const struct lsquic_packout_mem_if
58                                   *enp_pmi;
59    void                           *enp_pmi_ctx;
60    struct lsquic_engine           *enp_engine;
61    struct lsquic_hash             *enp_srst_hash;
62    enum {
63        ENPUB_PROC  = (1 << 0), /* Being processed by one of the user-facing
64                                 * functions.
65                                 */
66        ENPUB_CAN_SEND = (1 << 1),
67        ENPUB_HTTP  = (1 << 2), /* Engine in HTTP mode */
68    }                               enp_flags;
69    unsigned char                   enp_ver_tags_buf[ sizeof(lsquic_ver_tag_t) * N_LSQVER ];
70    unsigned                        enp_ver_tags_len;
71    struct crand                   *enp_crand;
72    struct evp_aead_ctx_st         *enp_retry_aead_ctx;
73    unsigned char                  *enp_alpn;   /* May be set if not HTTP */
74    /* es_noprogress_timeout converted to microseconds for speed */
75    lsquic_time_t                   enp_noprog_timeout;
76    lsquic_time_t                   enp_mtu_probe_timer;
77    /* Certs used by gQUIC server: */
78    struct lsquic_hash             *enp_compressed_server_certs;
79    struct lsquic_hash             *enp_server_certs;
80    /* gQUIC server configuration: */
81    struct lsquic_server_config    *enp_server_config;
82    /* Serialized subset of server engine transport parameters that is used
83     * as SSL QUIC context.  0 is for version <= LSQVER_ID27, 1 is for others.
84     */
85    unsigned char                   enp_quic_ctx_buf[2][200];
86    unsigned                        enp_quic_ctx_sz[2];
87#if LSQUIC_CONN_STATS
88    struct batch_size_stats {
89        unsigned    min, max,   /* Minimum and maximum batch sizes */
90                    count;      /* Number of batches sent */
91        float       avg;        /* Average batch size */
92    }                               enp_batch_size_stats;
93#endif
94};
95
96/* Put connection onto the Tickable Queue if it is not already on it.  If
97 * connection is being destroyed, this is a no-op.
98 */
99void
100lsquic_engine_add_conn_to_tickable (struct lsquic_engine_public *,
101                                                        lsquic_conn_t *);
102
103/* Put connection onto Advisory Tick Time  Queue if it is not already on it.
104 */
105void
106lsquic_engine_add_conn_to_attq (struct lsquic_engine_public *enpub,
107                                lsquic_conn_t *, lsquic_time_t, unsigned why);
108
109void
110lsquic_engine_retire_cid (struct lsquic_engine_public *,
111    struct lsquic_conn *, unsigned cce_idx, lsquic_time_t now,
112    lsquic_time_t drain_time);
113
114int
115lsquic_engine_add_cid (struct lsquic_engine_public *,
116                              struct lsquic_conn *, unsigned cce_idx);
117
118struct lsquic_conn *
119lsquic_engine_find_conn (const struct lsquic_engine_public *pub,
120                         const lsquic_cid_t *cid);
121
122#endif
123