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
  36 #define QUIC_DEFAULT_CA_CERT_PATH        "/etc/ssl/certs/ca-certificates.crt"
  37
  38 #define QUIC_TSTAMP_RESOLUTION  0.001   /* QUIC tick resolution (1ms) */
  39
  40
  41 #if QUIC_DEBUG
  42 #define QUIC_DBG(_lvl, _fmt, _args...)   \
  43   if (_lvl <= QUIC_DEBUG)                \
  44     clib_warning (_fmt, ##_args)
  45 #else
  46 #define QUIC_DBG(_lvl, _fmt, _args...)
  47 #endif
  48
  49 #define QUIC_CONN_STATE_OPENED    0
  50 #define QUIC_CONN_STATE_HANDSHAKE 1
  51 #define QUIC_CONN_STATE_READY     2
  52
  53 /* *INDENT-OFF* */
  54 typedef CLIB_PACKED (struct quic_ctx_id_
  55 {
  56   u32 parent_app_wrk_id;
  57   u32 parent_app_id;
  58   union {
  59     CLIB_PACKED (struct {
  60       session_handle_t udp_session_handle;
  61       quicly_conn_t *conn;
  62       u32 listener_ctx_id;
  63       u8 udp_is_ip4;
  64     });
  65     CLIB_PACKED (struct {
  66       quicly_stream_t *stream;
  67       u32 quic_connection_ctx_id;
  68     });
  69   };
  70   u8 is_stream;
  71 }) quic_ctx_id_t;
  72 /* *INDENT-ON* */
  73
  74 STATIC_ASSERT (sizeof (quic_ctx_id_t) <= 42, "ctx id must be less than 42");
  75
  76 /* This structure is used to implement the concept of VPP connection for QUIC.
  77  * We create one per connection and one per stream. */
  78 typedef struct quic_ctx_
  79 {
  80   union
  81   {
  82     transport_connection_t connection;
  83     quic_ctx_id_t c_quic_ctx_id;
  84   };
  85   u8 *srv_hostname;
  86   u32 client_opaque;
  87   u32 timer_handle;
  88   u8 conn_state;
  89   u8 is_listener;
  90 } quic_ctx_t;
  91
  92 typedef struct quic_stream_data_
  93 {
  94   u32 ctx_id;
  95   u32 thread_index;
  96   u32 app_rx_data_len;          /* bytes received, to be read by external app */
  97 } quic_stream_data_t;
  98
  99 typedef struct quic_worker_ctx_
 100 {
 101   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 102   int64_t time_now;                                /**< worker time */
 103   tw_timer_wheel_1t_3w_1024sl_ov_t timer_wheel;    /**< worker timer wheel */
 104   u32 *opening_ctx_pool;
 105 } quic_worker_ctx_t;
 106
 107 typedef struct quic_main_
 108 {
 109   u32 app_index;
 110   quic_ctx_t **ctx_pool;
 111   quic_worker_ctx_t *wrk_ctx;
 112   clib_bihash_16_8_t connection_hash;   /* quicly connection id -> conn handle */
 113   f64 tstamp_ticks_per_clock;
 114
 115   /*
 116    * Config
 117    */
 118   quicly_context_t quicly_ctx;
 119   ptls_handshake_properties_t hs_properties;
 120   quicly_cid_plaintext_t next_cid;
 121   u8 use_test_cert_in_ca;
 122   char *ca_cert_path;
 123 } quic_main_t;
 124
 125 #endif /* __included_quic_h__ */
 126
 127 /*
 128  * fd.io coding-style-patch-verification: ON
 129  *
 130  * Local Variables:
 131  * eval: (c-set-style "gnu")
 132  * End:
 133  */