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_TSTAMP_RESOLUTION  0.001   /* QUIC tick resolution (1ms) */
  36 #define QUIC_TIMER_HANDLE_INVALID ((u32) ~0)
  37 #define QUIC_SESSION_INVALID ((u32) ~0 - 1)
  38 #define QUIC_MAX_PACKET_SIZE 1280
  39
  40 #define QUIC_INT_MAX  0x3FFFFFFFFFFFFFFF
  41 #define QUIC_FIFO_SIZE (64 << 10)
  42 #define QUIC_SEND_PACKET_VEC_SIZE 16
  43
  44 /* Taken from quicly.c */
  45 #define QUICLY_QUIC_BIT 0x40
  46
  47 #define QUICLY_PACKET_TYPE_INITIAL (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0)
  48 #define QUICLY_PACKET_TYPE_0RTT (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0x10)
  49 #define QUICLY_PACKET_TYPE_HANDSHAKE (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0x20)
  50 #define QUICLY_PACKET_TYPE_RETRY (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0x30)
  51 #define QUICLY_PACKET_TYPE_BITMASK 0xf0
  52
  53 /* error codes */
  54 #define QUIC_ERROR_FULL_FIFO 0xff10
  55 #define QUIC_APP_ERROR_CLOSE_NOTIFY QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0)
  56 #define QUIC_APP_ALLOCATION_ERROR QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0x1)
  57 #define QUIC_APP_ACCEPT_NOTIFY_ERROR QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0x2)
  58 #define QUIC_APP_CONNECT_NOTIFY_ERROR QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0x3)
  59
  60 #if QUIC_DEBUG
  61 #define QUIC_DBG(_lvl, _fmt, _args...)   \
  62   if (_lvl <= QUIC_DEBUG)                \
  63     clib_warning (_fmt, ##_args)
  64 #else
  65 #define QUIC_DBG(_lvl, _fmt, _args...)
  66 #endif
  67
  68 typedef enum quic_ctx_conn_state_
  69 {
  70   QUIC_CONN_STATE_OPENED,
  71   QUIC_CONN_STATE_HANDSHAKE,
  72   QUIC_CONN_STATE_READY,
  73   QUIC_CONN_STATE_PASSIVE_CLOSING,
  74   QUIC_CONN_STATE_PASSIVE_CLOSING_APP_CLOSED,
  75   QUIC_CONN_STATE_PASSIVE_CLOSING_QUIC_CLOSED,
  76   QUIC_CONN_STATE_ACTIVE_CLOSING,
  77 } quic_ctx_conn_state_t;
  78
  79
  80 typedef enum quic_ctx_flags_
  81 {
  82   QUIC_F_IS_STREAM = (1 << 0),
  83   QUIC_F_IS_LISTENER = (1 << 1),
  84 } quic_ctx_flags_t;
  85
  86 /* *INDENT-OFF* */
  87 typedef struct quic_ctx_id_
  88 {
  89   union { /** QUIC ctx case */
  90     struct {
  91       quicly_conn_t *conn;
  92       u32 listener_ctx_id;
  93       u32 client_opaque;
  94       u8 *srv_hostname;
  95       u8 conn_state;
  96       u8 udp_is_ip4;
  97     };
  98     struct { /** STREAM ctx case */
  99       quicly_stream_t *stream;
 100       u32 quic_connection_ctx_id;
 101     };
 102   };
 103 } quic_ctx_id_t;
 104 /* *INDENT-ON* */
 105
 106 STATIC_ASSERT (sizeof (quic_ctx_id_t) <= 42, "ctx id must be less than 42");
 107
 108 /* This structure is used to implement the concept of VPP connection for QUIC.
 109  * We create one per connection and one per stream. */
 110 typedef struct quic_ctx_
 111 {
 112   union
 113   {
 114     transport_connection_t connection;
 115     quic_ctx_id_t c_quic_ctx_id;
 116   };
 117   session_handle_t udp_session_handle;
 118   u32 timer_handle;
 119   u32 parent_app_wrk_id;
 120   u32 parent_app_id;
 121   u8 flags;
 122 } quic_ctx_t;
 123
 124 typedef struct quic_stream_data_
 125 {
 126   u32 ctx_id;
 127   u32 thread_index;
 128   u32 app_rx_data_len;          /* bytes received, to be read by external app */
 129 } quic_stream_data_t;
 130
 131 typedef struct quic_worker_ctx_
 132 {
 133   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 134   int64_t time_now;                                /**< worker time */
 135   tw_timer_wheel_1t_3w_1024sl_ov_t timer_wheel;    /**< worker timer wheel */
 136   u32 *opening_ctx_pool;
 137 } quic_worker_ctx_t;
 138
 139 typedef struct quic_main_
 140 {
 141   u32 app_index;
 142   quic_ctx_t **ctx_pool;
 143   quic_worker_ctx_t *wrk_ctx;
 144   clib_bihash_16_8_t connection_hash;   /* quicly connection id -> conn handle */
 145   f64 tstamp_ticks_per_clock;
 146
 147   /*
 148    * Config
 149    */
 150   quicly_context_t quicly_ctx;
 151   ptls_handshake_properties_t hs_properties;
 152   quicly_cid_plaintext_t next_cid;
 153 } quic_main_t;
 154
 155 #endif /* __included_quic_h__ */
 156
 157 /*
 158  * fd.io coding-style-patch-verification: ON
 159  *
 160  * Local Variables:
 161  * eval: (c-set-style "gnu")
 162  * End:
 163  */