src/plugins/quic/quic.h

   1 /*
   2  * Copyright (c) 2021 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 #include <vnet/crypto/crypto.h>
  28 #include <vppinfra/lock.h>
  29
  30 /* QUIC log levels
  31  * 1 - errors
  32  * 2 - connection/stream events
  33  * 3 - packet events
  34  * 4 - timer events
  35  **/
  36
  37 #define QUIC_DEBUG               0
  38 #define QUIC_TSTAMP_RESOLUTION  0.001   /* QUIC tick resolution (1ms) */
  39 #define QUIC_TIMER_HANDLE_INVALID ((u32) ~0)
  40 #define QUIC_SESSION_INVALID ((u32) ~0 - 1)
  41 #define QUIC_MAX_PACKET_SIZE 1280
  42
  43 #define QUIC_INT_MAX  0x3FFFFFFFFFFFFFFF
  44 #define QUIC_DEFAULT_FIFO_SIZE (64 << 10)
  45 #define QUIC_SEND_PACKET_VEC_SIZE 16
  46 #define QUIC_IV_LEN 17
  47
  48 #define QUIC_MAX_COALESCED_PACKET 4
  49
  50 #define QUIC_RCV_MAX_PACKETS 16
  51
  52 #define QUIC_DEFAULT_CONN_TIMEOUT (30 * 1000)   /* 30 seconds */
  53
  54 /* Taken from quicly.c */
  55 #define QUICLY_QUIC_BIT 0x40
  56
  57 #define QUICLY_PACKET_TYPE_INITIAL (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0)
  58 #define QUICLY_PACKET_TYPE_0RTT (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0x10)
  59 #define QUICLY_PACKET_TYPE_HANDSHAKE (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0x20)
  60 #define QUICLY_PACKET_TYPE_RETRY (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0x30)
  61 #define QUICLY_PACKET_TYPE_BITMASK 0xf0
  62
  63 /* error codes */
  64 #define QUIC_ERROR_FULL_FIFO 0xff10
  65 #define QUIC_APP_ERROR_CLOSE_NOTIFY QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0)
  66 #define QUIC_APP_ALLOCATION_ERROR QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0x1)
  67 #define QUIC_APP_ACCEPT_NOTIFY_ERROR QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0x2)
  68 #define QUIC_APP_CONNECT_NOTIFY_ERROR QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0x3)
  69
  70 #define QUIC_DECRYPT_PACKET_OK 0
  71 #define QUIC_DECRYPT_PACKET_NOTOFFLOADED 1
  72 #define QUIC_DECRYPT_PACKET_ERROR 2
  73
  74 #if QUIC_DEBUG
  75 #define QUIC_DBG(_lvl, _fmt, _args...)   \
  76   if (_lvl <= QUIC_DEBUG)                \
  77     clib_warning (_fmt, ##_args)
  78 #else
  79 #define QUIC_DBG(_lvl, _fmt, _args...)
  80 #endif
  81
  82 #if CLIB_ASSERT_ENABLE
  83 #define QUIC_ASSERT(truth) ASSERT (truth)
  84 #else
  85 #define QUIC_ASSERT(truth)                        \
  86   do {                                            \
  87     if (PREDICT_FALSE (! (truth)))                \
  88       QUIC_ERR ("ASSERT(%s) failed", # truth);    \
  89   } while (0)
  90 #endif
  91
  92 #define QUIC_ERR(_fmt, _args...)                \
  93   do {                                          \
  94     clib_warning ("QUIC-ERR: " _fmt, ##_args);  \
  95   } while (0)
  96
  97
  98
  99 extern vlib_node_registration_t quic_input_node;
 100
 101 typedef enum
 102 {
 103 #define quic_error(n,s) QUIC_ERROR_##n,
 104 #include <plugins/quic/quic_error.def>
 105 #undef quic_error
 106   QUIC_N_ERROR,
 107 } quic_error_t;
 108
 109 typedef enum quic_ctx_conn_state_
 110 {
 111   QUIC_CONN_STATE_OPENED,
 112   QUIC_CONN_STATE_HANDSHAKE,
 113   QUIC_CONN_STATE_READY,
 114   QUIC_CONN_STATE_PASSIVE_CLOSING,
 115   QUIC_CONN_STATE_PASSIVE_CLOSING_APP_CLOSED,
 116   QUIC_CONN_STATE_PASSIVE_CLOSING_QUIC_CLOSED,
 117   QUIC_CONN_STATE_ACTIVE_CLOSING,
 118 } quic_ctx_conn_state_t;
 119
 120 typedef enum quic_packet_type_
 121 {
 122   QUIC_PACKET_TYPE_NONE,
 123   QUIC_PACKET_TYPE_RECEIVE,
 124   QUIC_PACKET_TYPE_MIGRATE,
 125   QUIC_PACKET_TYPE_ACCEPT,
 126   QUIC_PACKET_TYPE_RESET,
 127   QUIC_PACKET_TYPE_DROP,
 128 } quic_packet_type_t;
 129
 130 typedef enum quic_ctx_flags_
 131 {
 132   QUIC_F_IS_STREAM = (1 << 0),
 133   QUIC_F_IS_LISTENER = (1 << 1),
 134 } quic_ctx_flags_t;
 135
 136 typedef enum quic_cc_type
 137 {
 138   QUIC_CC_RENO,
 139   QUIC_CC_CUBIC,
 140 } quic_cc_type_t;
 141
 142 /* This structure is used to implement the concept of VPP connection for QUIC.
 143  * We create one per connection and one per stream. */
 144 typedef struct quic_ctx_
 145 {
 146   union
 147   {
 148     transport_connection_t connection;
 149     struct
 150     {         /** QUIC ctx case */
 151       quicly_conn_t *conn;
 152       u32 listener_ctx_id;
 153       u32 client_opaque;
 154       u8 *srv_hostname;
 155       u8 conn_state;
 156       u8 udp_is_ip4;
 157       u8 _qctx_end_marker;      /* Leave this at the end */
 158     };
 159     struct
 160     {         /** STREAM ctx case */
 161       quicly_stream_t *stream;
 162       u64 bytes_written;
 163       u32 quic_connection_ctx_id;
 164       u8 _sctx_end_marker;      /* Leave this at the end */
 165     };
 166   };
 167   session_handle_t udp_session_handle;
 168   u32 timer_handle;
 169   u32 parent_app_wrk_id;
 170   u32 parent_app_id;
 171   u32 ckpair_index;
 172   u32 crypto_engine;
 173   u32 crypto_context_index;
 174   u8 flags;
 175
 176   struct
 177   {
 178     ptls_cipher_context_t *hp_ctx;
 179     ptls_aead_context_t *aead_ctx;
 180   } ingress_keys;
 181   int key_phase_ingress;
 182
 183 } quic_ctx_t;
 184
 185 /* Make sure our custom fields don't overlap with the fields we use in
 186    .connection
 187 */
 188 STATIC_ASSERT (offsetof (quic_ctx_t, _qctx_end_marker) <=
 189                TRANSPORT_CONN_ID_LEN,
 190                "connection data must be less than TRANSPORT_CONN_ID_LEN bytes");
 191 STATIC_ASSERT (offsetof (quic_ctx_t, _sctx_end_marker) <=
 192                TRANSPORT_CONN_ID_LEN,
 193                "connection data must be less than TRANSPORT_CONN_ID_LEN bytes");
 194
 195 /* single-entry session cache */
 196 typedef struct quic_session_cache_
 197 {
 198   ptls_encrypt_ticket_t super;
 199   uint8_t id[32];
 200   ptls_iovec_t data;
 201 } quic_session_cache_t;
 202
 203 typedef struct quic_stream_data_
 204 {
 205   u32 ctx_id;
 206   u32 thread_index;
 207   u32 app_rx_data_len;          /**< bytes received, to be read by external app */
 208   u32 app_tx_data_len;          /**< bytes sent */
 209 } quic_stream_data_t;
 210
 211 typedef struct quic_crypto_context_data_
 212 {
 213   quicly_context_t quicly_ctx;
 214   char cid_key[QUIC_IV_LEN];
 215   ptls_context_t ptls_ctx;
 216 } quic_crypto_context_data_t;
 217
 218 typedef struct quic_worker_ctx_
 219 {
 220   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 221   int64_t time_now;                                /**< worker time */
 222   tw_timer_wheel_1t_3w_1024sl_ov_t timer_wheel;    /**< worker timer wheel */
 223   quicly_cid_plaintext_t next_cid;
 224   crypto_context_t *crypto_ctx_pool;            /**< per thread pool of crypto contexes */
 225   clib_bihash_24_8_t crypto_context_hash;       /**< per thread [params:crypto_ctx_index] hash */
 226 } quic_worker_ctx_t;
 227
 228 typedef struct quic_rx_packet_ctx_
 229 {
 230   quicly_decoded_packet_t packet;
 231   u8 data[QUIC_MAX_PACKET_SIZE];
 232   u32 ctx_index;
 233   u32 thread_index;
 234   union
 235   {
 236     struct sockaddr sa;
 237     struct sockaddr_in6 sa6;
 238   };
 239   socklen_t salen;
 240   u8 ptype;
 241   session_dgram_hdr_t ph;
 242 } quic_rx_packet_ctx_t;
 243
 244 typedef struct quic_main_
 245 {
 246   u32 app_index;
 247   quic_ctx_t **ctx_pool;
 248   quic_worker_ctx_t *wrk_ctx;
 249   clib_bihash_16_8_t connection_hash;   /**< quic connection id -> conn handle */
 250   f64 tstamp_ticks_per_clock;
 251
 252   ptls_cipher_suite_t ***quic_ciphers;  /**< available ciphers by crypto engine */
 253   uword *available_crypto_engines;      /**< Bitmap for registered engines */
 254   u8 default_crypto_engine;             /**< Used if you do connect with CRYPTO_ENGINE_NONE (0) */
 255   u64 max_packets_per_key;              /**< number of packets that can be sent without a key update */
 256   u8 default_quic_cc;
 257
 258   ptls_handshake_properties_t hs_properties;
 259   quic_session_cache_t session_cache;
 260
 261   u32 udp_fifo_size;
 262   u32 udp_fifo_prealloc;
 263   u32 connection_timeout;
 264
 265   u8 vnet_crypto_enabled;
 266
 267   clib_rwlock_t crypto_keys_quic_rw_lock;
 268 } quic_main_t;
 269
 270 #endif /* __included_quic_h__ */
 271
 272 /*
 273  * fd.io coding-style-patch-verification: ON
 274  *
 275  * Local Variables:
 276  * eval: (c-set-style "gnu")
 277  * End:
 278  */