lsquic_engine_public.h revision 06b2a236 
1/* Copyright (c) 2017 - 2021 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)(struct lsquic_conn *,
52                                            struct lsquic_cid *, unsigned);
53    int                           (*enp_verify_cert)(void *verify_ctx,
54                                            struct stack_st_X509 *chain);
55    void                           *enp_verify_ctx;
56    const struct lsquic_packout_mem_if
57                                   *enp_pmi;
58    void                           *enp_pmi_ctx;
59    struct lsquic_engine           *enp_engine;
60    struct lsquic_hash             *enp_srst_hash;
61    enum {
62        ENPUB_PROC  = (1 << 0), /* Being processed by one of the user-facing
63                                 * functions.
64                                 */
65        ENPUB_CAN_SEND = (1 << 1),
66        ENPUB_HTTP  = (1 << 2), /* Engine in HTTP mode */
67    }                               enp_flags;
68    unsigned char                   enp_ver_tags_buf[ sizeof(lsquic_ver_tag_t) * N_LSQVER ];
69    unsigned                        enp_ver_tags_len;
70    struct crand                   *enp_crand;
71    struct evp_aead_ctx_st         *enp_retry_aead_ctx;
72    unsigned char                  *enp_alpn;   /* May be set if not HTTP */
73    /* es_noprogress_timeout converted to microseconds for speed */
74    lsquic_time_t                   enp_noprog_timeout;
75    lsquic_time_t                   enp_mtu_probe_timer;
76    /* Certs used by gQUIC server: */
77    struct lsquic_hash             *enp_compressed_server_certs;
78    struct lsquic_hash             *enp_server_certs;
79    /* gQUIC server configuration: */
80    struct lsquic_server_config    *enp_server_config;
81    /* Serialized subset of server engine transport parameters that is used
82     * as SSL QUIC context.  0 is for version <= LSQVER_ID27, 1 is for others.
83     */
84    unsigned char                   enp_quic_ctx_buf[2][200];
85    unsigned                        enp_quic_ctx_sz[2];
86#if LSQUIC_CONN_STATS
87    struct batch_size_stats {
88        unsigned    min, max,   /* Minimum and maximum batch sizes */
89                    count;      /* Number of batches sent */
90        float       avg;        /* Average batch size */
91    }                               enp_batch_size_stats;
92#endif
93};
94
95/* Put connection onto the Tickable Queue if it is not already on it.  If
96 * connection is being destroyed, this is a no-op.
97 */
98void
99lsquic_engine_add_conn_to_tickable (struct lsquic_engine_public *,
100                                                        lsquic_conn_t *);
101
102/* Put connection onto Advisory Tick Time  Queue if it is not already on it.
103 */
104void
105lsquic_engine_add_conn_to_attq (struct lsquic_engine_public *enpub,
106                                lsquic_conn_t *, lsquic_time_t, unsigned why);
107
108void
109lsquic_engine_retire_cid (struct lsquic_engine_public *,
110    struct lsquic_conn *, unsigned cce_idx, lsquic_time_t now,
111    lsquic_time_t drain_time);
112
113int
114lsquic_engine_add_cid (struct lsquic_engine_public *,
115                              struct lsquic_conn *, unsigned cce_idx);
116
117struct lsquic_conn *
118lsquic_engine_find_conn (const struct lsquic_engine_public *pub,
119                         const lsquic_cid_t *cid);
120
121#endif
122