src/plugins/quic/quic.h

   1 /*
   2  * Copyright (c) 2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef __included_quic_h__
  17 #define __included_quic_h__
  18
  19 #include <vnet/session/application_interface.h>
  20
  21 #include <vppinfra/lock.h>
  22 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
  23 #include <vppinfra/bihash_16_8.h>
  24
  25 #include <quicly.h>
  26
  27 /* QUIC log levels
  28  * 1 - errors
  29  * 2 - connection/stream events
  30  * 3 - packet events
  31  * 4 - timer events
  32  **/
  33
  34 #define QUIC_DEBUG               0
  35 #define QUIC_DEBUG_LEVEL_CLIENT  0
  36 #define QUIC_DEBUG_LEVEL_SERVER  0
  37
  38 #define QUIC_DEFAULT_CA_CERT_PATH        "/etc/ssl/certs/ca-certificates.crt"
  39
  40 #define QUIC_TSTAMP_RESOLUTION  0.001   /* QUIC tick resolution (1ms) */
  41
  42
  43 #if QUIC_DEBUG
  44 #define QUIC_DBG(_lvl, _fmt, _args...)   \
  45   if (_lvl <= QUIC_DEBUG)                \
  46     clib_warning (_fmt, ##_args)
  47 #else
  48 #define QUIC_DBG(_lvl, _fmt, _args...)
  49 #endif
  50
  51 #define QUIC_CONN_STATE_OPENED    0
  52 #define QUIC_CONN_STATE_HANDSHAKE 1
  53 #define QUIC_CONN_STATE_READY     2
  54
  55 /* *INDENT-OFF* */
  56 typedef CLIB_PACKED (struct quic_ctx_id_
  57 {
  58   u32 parent_app_wrk_id;
  59   u32 parent_app_id;
  60   union {
  61     CLIB_PACKED (struct {
  62       session_handle_t udp_session_handle;
  63       quicly_conn_t *conn;
  64       u32 listener_ctx_id;
  65       u8 udp_is_ip4;
  66     });
  67     CLIB_PACKED (struct {
  68       quicly_stream_t *stream;
  69       u32 quic_connection_ctx_id;
  70     });
  71   };
  72   u8 is_stream;
  73 }) quic_ctx_id_t;
  74 /* *INDENT-ON* */
  75
  76 STATIC_ASSERT (sizeof (quic_ctx_id_t) <= 42, "ctx id must be less than 42");
  77
  78 /* This structure is used to implement the concept of VPP connection for QUIC.
  79  * We create one per connection and one per stream. */
  80 typedef struct quic_ctx_
  81 {
  82   union
  83   {
  84     transport_connection_t connection;
  85     quic_ctx_id_t c_quic_ctx_id;
  86   };
  87   u8 *srv_hostname;
  88   u32 client_opaque;
  89   u32 timer_handle;
  90   u8 conn_state;
  91   u8 is_listener;
  92 } quic_ctx_t;
  93
  94 typedef struct quic_stream_data_
  95 {
  96   u32 ctx_id;
  97   u32 thread_index;
  98 } quic_stream_data_t;
  99
 100 typedef struct quic_worker_ctx_
 101 {
 102   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 103   int64_t time_now;                                /**< worker time */
 104   tw_timer_wheel_1t_3w_1024sl_ov_t timer_wheel;    /**< worker timer wheel */
 105   u32 *opening_ctx_pool;
 106 } quic_worker_ctx_t;
 107
 108 typedef struct quic_main_
 109 {
 110   u32 app_index;
 111   quic_ctx_t **ctx_pool;
 112   quic_worker_ctx_t *wrk_ctx;
 113   clib_bihash_16_8_t connection_hash;   /* quicly connection id -> conn handle */
 114   f64 tstamp_ticks_per_clock;
 115
 116   /*
 117    * Config
 118    */
 119   quicly_context_t quicly_ctx;
 120   ptls_handshake_properties_t hs_properties;
 121   quicly_cid_plaintext_t next_cid;
 122   u8 use_test_cert_in_ca;
 123   char *ca_cert_path;
 124 } quic_main_t;
 125
 126 #endif /* __included_quic_h__ */
 127
 128 /*
 129  * fd.io coding-style-patch-verification: ON
 130  *
 131  * Local Variables:
 132  * eval: (c-set-style "gnu")
 133  * End:
 134  */