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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef __included_quic_h__
17 #define __included_quic_h__
19 #include <vnet/session/application_interface.h>
21 #include <vppinfra/lock.h>
22 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
23 #include <vppinfra/bihash_16_8.h>
29 * 2 - connection/stream events
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
40 #define QUIC_INT_MAX 0x3FFFFFFFFFFFFFFF
41 #define QUIC_FIFO_SIZE (64 << 10)
42 #define QUIC_SEND_PACKET_VEC_SIZE 16
44 /* Taken from quicly.c */
45 #define QUICLY_QUIC_BIT 0x40
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
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)
61 #define QUIC_DBG(_lvl, _fmt, _args...) \
62 if (_lvl <= QUIC_DEBUG) \
63 clib_warning (_fmt, ##_args)
65 #define QUIC_DBG(_lvl, _fmt, _args...)
68 typedef enum quic_ctx_conn_state_
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;
80 typedef enum quic_ctx_flags_
82 QUIC_F_IS_STREAM = (1 << 0),
83 QUIC_F_IS_LISTENER = (1 << 1),
86 /* This structure is used to implement the concept of VPP connection for QUIC.
87 * We create one per connection and one per stream. */
88 typedef struct quic_ctx_
92 transport_connection_t connection;
94 { /** QUIC ctx case */
101 u8 _qctx_end_marker; /* Leave this at the end */
104 { /** STREAM ctx case */
105 quicly_stream_t *stream;
106 u32 quic_connection_ctx_id;
107 u8 _sctx_end_marker; /* Leave this at the end */
110 session_handle_t udp_session_handle;
112 u32 parent_app_wrk_id;
117 /* Make sure our custom fields don't overlap with the fields we use in
120 STATIC_ASSERT (offsetof (quic_ctx_t, _qctx_end_marker) <=
121 TRANSPORT_CONN_ID_LEN,
122 "connection data must be less than TRANSPORT_CONN_ID_LEN bytes");
123 STATIC_ASSERT (offsetof (quic_ctx_t, _sctx_end_marker) <=
124 TRANSPORT_CONN_ID_LEN,
125 "connection data must be less than TRANSPORT_CONN_ID_LEN bytes");
127 typedef enum quic_crypto_engine_
130 CRYPTO_ENGINE_PICOTLS,
131 } quic_crypto_engine_t;
133 /* single-entry session cache */
134 typedef struct quic_session_cache_
136 ptls_encrypt_ticket_t super;
139 } quic_session_cache_t;
141 typedef struct quic_stream_data_
145 u32 app_rx_data_len; /* bytes received, to be read by external app */
146 } quic_stream_data_t;
148 typedef struct quic_worker_ctx_
150 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
151 int64_t time_now; /**< worker time */
152 tw_timer_wheel_1t_3w_1024sl_ov_t timer_wheel; /**< worker timer wheel */
153 u32 *opening_ctx_pool;
156 typedef struct quic_main_
159 quic_ctx_t **ctx_pool;
160 quic_worker_ctx_t *wrk_ctx;
161 clib_bihash_16_8_t connection_hash; /* quicly connection id -> conn handle */
162 f64 tstamp_ticks_per_clock;
164 ptls_cipher_suite_t ***quic_ciphers; /* available ciphers by crypto engine */
166 quic_session_cache_t session_cache;
171 quicly_context_t quicly_ctx;
172 ptls_handshake_properties_t hs_properties;
173 quicly_cid_plaintext_t next_cid;
176 #endif /* __included_quic_h__ */
179 * fd.io coding-style-patch-verification: ON
182 * eval: (c-set-style "gnu")