1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/*
* Copyright (c) 2019 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __included_quic_h__
#define __included_quic_h__
#include <vnet/session/application_interface.h>
#include <vppinfra/lock.h>
#include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
#include <vppinfra/bihash_16_8.h>
#include <quicly.h>
/* QUIC log levels
* 1 - errors
* 2 - connection/stream events
* 3 - packet events
* 4 - timer events
**/
#define QUIC_DEBUG 0
#define QUIC_TSTAMP_RESOLUTION 0.001 /* QUIC tick resolution (1ms) */
#define QUIC_TIMER_HANDLE_INVALID ((u32) ~0)
#define QUIC_SESSION_INVALID ((u32) ~0 - 1)
#define QUIC_MAX_PACKET_SIZE 1280
#define QUIC_INT_MAX 0x3FFFFFFFFFFFFFFF
#define QUIC_DEFAULT_FIFO_SIZE (64 << 10)
#define QUIC_SEND_PACKET_VEC_SIZE 16
#define QUIC_SEND_MAX_BATCH_PACKETS 16
#define QUIC_RCV_MAX_BATCH_PACKETS 16
#define QUIC_DEFAULT_CONN_TIMEOUT (30 * 1000) /* 30 seconds */
/* Taken from quicly.c */
#define QUICLY_QUIC_BIT 0x40
#define QUICLY_PACKET_TYPE_INITIAL (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0)
#define QUICLY_PACKET_TYPE_0RTT (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0x10)
#define QUICLY_PACKET_TYPE_HANDSHAKE (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0x20)
#define QUICLY_PACKET_TYPE_RETRY (QUICLY_LONG_HEADER_BIT | QUICLY_QUIC_BIT | 0x30)
#define QUICLY_PACKET_TYPE_BITMASK 0xf0
/* error codes */
#define QUIC_ERROR_FULL_FIFO 0xff10
#define QUIC_APP_ERROR_CLOSE_NOTIFY QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0)
#define QUIC_APP_ALLOCATION_ERROR QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0x1)
#define QUIC_APP_ACCEPT_NOTIFY_ERROR QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0x2)
#define QUIC_APP_CONNECT_NOTIFY_ERROR QUICLY_ERROR_FROM_APPLICATION_ERROR_CODE(0x3)
#if QUIC_DEBUG
#define QUIC_DBG(_lvl, _fmt, _args...) \
if (_lvl <= QUIC_DEBUG) \
clib_warning (_fmt, ##_args)
#else
#define QUIC_DBG(_lvl, _fmt, _args...)
#endif
#define QUIC_ERR(_fmt, _args...) \
do { \
clib_warning ("QUIC-ERR: " _fmt, ##_args); \
} while (0)
extern vlib_node_registration_t quic_input_node;
typedef enum
{
#define quic_error(n,s) QUIC_ERROR_##n,
#include <plugins/quic/quic_error.def>
#undef quic_error
QUIC_N_ERROR,
} quic_error_t;
typedef enum quic_ctx_conn_state_
{
QUIC_CONN_STATE_OPENED,
QUIC_CONN_STATE_HANDSHAKE,
QUIC_CONN_STATE_READY,
QUIC_CONN_STATE_PASSIVE_CLOSING,
QUIC_CONN_STATE_PASSIVE_CLOSING_APP_CLOSED,
QUIC_CONN_STATE_PASSIVE_CLOSING_QUIC_CLOSED,
QUIC_CONN_STATE_ACTIVE_CLOSING,
} quic_ctx_conn_state_t;
typedef enum quic_packet_type_
{
QUIC_PACKET_TYPE_NONE,
QUIC_PACKET_TYPE_RECEIVE,
QUIC_PACKET_TYPE_MIGRATE,
QUIC_PACKET_TYPE_ACCEPT,
QUIC_PACKET_TYPE_RESET,
QUIC_PACKET_TYPE_DROP,
} quic_packet_type_t;
typedef enum quic_ctx_flags_
{
QUIC_F_IS_STREAM = (1 << 0),
QUIC_F_IS_LISTENER = (1 << 1),
} quic_ctx_flags_t;
/* This structure is used to implement the concept of VPP connection for QUIC.
* We create one per connection and one per stream. */
typedef struct quic_ctx_
{
union
{
transport_connection_t connection;
struct
{ /** QUIC ctx case */
quicly_conn_t *conn;
u32 listener_ctx_id;
u32 client_opaque;
u8 *srv_hostname;
u8 conn_state;
u8 udp_is_ip4;
u8 _qctx_end_marker; /* Leave this at the end */
};
struct
{ /** STREAM ctx case */
quicly_stream_t *stream;
u32 quic_connection_ctx_id;
u8 _sctx_end_marker; /* Leave this at the end */
};
};
session_handle_t udp_session_handle;
u32 timer_handle;
u32 parent_app_wrk_id;
u32 parent_app_id;
u32 ckpair_index;
quicly_context_t *quicly_ctx;
u8 flags;
} quic_ctx_t;
/* Make sure our custom fields don't overlap with the fields we use in
.connection
*/
STATIC_ASSERT (offsetof (quic_ctx_t, _qctx_end_marker) <=
TRANSPORT_CONN_ID_LEN,
"connection data must be less than TRANSPORT_CONN_ID_LEN bytes");
STATIC_ASSERT (offsetof (quic_ctx_t, _sctx_end_marker) <=
TRANSPORT_CONN_ID_LEN,
"connection data must be less than TRANSPORT_CONN_ID_LEN bytes");
/* single-entry session cache */
typedef struct quic_session_cache_
{
ptls_encrypt_ticket_t super;
uint8_t id[32];
ptls_iovec_t data;
} quic_session_cache_t;
typedef struct quic_stream_data_
{
u32 ctx_id;
u32 thread_index;
u32 app_rx_data_len; /**< bytes received, to be read by external app */
} quic_stream_data_t;
typedef struct quic_worker_ctx_
{
CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
int64_t time_now; /**< worker time */
tw_timer_wheel_1t_3w_1024sl_ov_t timer_wheel; /**< worker timer wheel */
} quic_worker_ctx_t;
typedef struct quic_rx_packet_ctx_
{
quicly_decoded_packet_t packet;
u8 data[QUIC_MAX_PACKET_SIZE];
u32 ctx_index;
u32 thread_index;
union
{
struct sockaddr sa;
struct sockaddr_in6 sa6;
};
socklen_t salen;
u8 ptype;
session_dgram_hdr_t ph;
} quic_rx_packet_ctx_t;
typedef struct quicly_ctx_data_
{
quicly_context_t quicly_ctx;
char cid_key[17];
ptls_context_t ptls_ctx;
} quicly_ctx_data_t;
typedef struct quic_main_
{
u32 app_index;
quic_ctx_t **ctx_pool;
quic_worker_ctx_t *wrk_ctx;
clib_bihash_16_8_t connection_hash; /**< quic connection id -> conn handle */
f64 tstamp_ticks_per_clock;
ptls_cipher_suite_t ***quic_ciphers; /**< available ciphers by crypto engine */
uword *available_crypto_engines; /**< Bitmap for registered engines */
u8 default_crypto_engine; /**< Used if you do connect with CRYPTO_ENGINE_NONE (0) */
ptls_handshake_properties_t hs_properties;
quicly_cid_plaintext_t next_cid;
quic_session_cache_t session_cache;
u32 udp_fifo_size;
u32 udp_fifo_prealloc;
u32 connection_timeout;
} quic_main_t;
#endif /* __included_quic_h__ */
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|
