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:
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 #include <sys/socket.h>
18 #include <vnet/session/application.h>
19 #include <vnet/session/transport.h>
20 #include <vnet/session/session.h>
21 #include <vlib/unix/plugin.h>
22 #include <vpp/app/version.h>
24 #include <vppinfra/lock.h>
26 #include <quic/quic.h>
27 #include <quic/certs.h>
28 #include <quic/error.h>
30 #include <quicly/constants.h>
31 #include <quicly/defaults.h>
34 #include <quic/quic_crypto.h>
36 extern quicly_crypto_engine_t quic_crypto_engine;
38 static char *quic_error_strings[] = {
39 #define quic_error(n,s) s,
40 #include <quic/quic_error.def>
44 #define DEFAULT_MAX_PACKETS_PER_KEY 16777216
46 quic_main_t quic_main;
47 static void quic_update_timer (quic_ctx_t * ctx);
48 static void quic_check_quic_session_connected (quic_ctx_t * ctx);
49 static int quic_reset_connection (u64 udp_session_handle,
50 quic_rx_packet_ctx_t * pctx);
51 static void quic_proto_on_close (u32 ctx_index, u32 thread_index);
53 static quicly_stream_open_t on_stream_open;
54 static quicly_closed_by_remote_t on_closed_by_remote;
55 static quicly_now_t quicly_vpp_now_cb;
60 quic_crypto_context_make_key_from_ctx (clib_bihash_kv_24_8_t * kv,
63 application_t *app = application_get (ctx->parent_app_id);
64 kv->key[0] = ((u64) ctx->ckpair_index) << 32 | (u64) ctx->crypto_engine;
65 kv->key[1] = app->sm_properties.rx_fifo_size - 1;
66 kv->key[2] = app->sm_properties.tx_fifo_size - 1;
70 quic_crypto_context_make_key_from_crctx (clib_bihash_kv_24_8_t * kv,
71 crypto_context_t * crctx)
73 quic_crypto_context_data_t *data =
74 (quic_crypto_context_data_t *) crctx->data;
75 kv->key[0] = ((u64) crctx->ckpair_index) << 32 | (u64) crctx->crypto_engine;
76 kv->key[1] = data->quicly_ctx.transport_params.max_stream_data.bidi_local;
77 kv->key[2] = data->quicly_ctx.transport_params.max_stream_data.bidi_remote;
81 quic_crypto_context_free_if_needed (crypto_context_t * crctx, u8 thread_index)
83 quic_main_t *qm = &quic_main;
84 clib_bihash_kv_24_8_t kv;
85 if (crctx->n_subscribers)
87 quic_crypto_context_make_key_from_crctx (&kv, crctx);
88 clib_bihash_add_del_24_8 (&qm->wrk_ctx[thread_index].crypto_context_hash,
89 &kv, 0 /* is_add */ );
90 clib_mem_free (crctx->data);
91 pool_put (qm->wrk_ctx[thread_index].crypto_ctx_pool, crctx);
95 quic_app_cert_key_pair_delete_callback (app_cert_key_pair_t * ckpair)
97 quic_main_t *qm = &quic_main;
98 crypto_context_t *crctx;
99 clib_bihash_kv_24_8_t kv;
100 vlib_thread_main_t *vtm = vlib_get_thread_main ();
101 int num_threads = 1 /* main thread */ + vtm->n_threads;
104 for (i = 0; i < num_threads; i++)
107 pool_foreach (crctx, qm->wrk_ctx[i].crypto_ctx_pool) {
108 if (crctx->ckpair_index == ckpair->cert_key_index)
110 quic_crypto_context_make_key_from_crctx (&kv, crctx);
111 clib_bihash_add_del_24_8 (&qm->wrk_ctx[i].crypto_context_hash, &kv, 0 /* is_add */ );
119 static crypto_context_t *
120 quic_crypto_context_alloc (u8 thread_index)
122 quic_main_t *qm = &quic_main;
123 crypto_context_t *crctx;
126 pool_get (qm->wrk_ctx[thread_index].crypto_ctx_pool, crctx);
127 clib_memset (crctx, 0, sizeof (*crctx));
128 idx = (crctx - qm->wrk_ctx[thread_index].crypto_ctx_pool);
129 crctx->ctx_index = ((u32) thread_index) << 24 | idx;
134 static crypto_context_t *
135 quic_crypto_context_get (u32 cr_index, u32 thread_index)
137 quic_main_t *qm = &quic_main;
138 ASSERT (cr_index >> 24 == thread_index);
139 return pool_elt_at_index (qm->wrk_ctx[thread_index].crypto_ctx_pool,
140 cr_index & 0x00ffffff);
143 static clib_error_t *
144 quic_list_crypto_context_command_fn (vlib_main_t * vm,
145 unformat_input_t * input,
146 vlib_cli_command_t * cmd)
148 quic_main_t *qm = &quic_main;
149 crypto_context_t *crctx;
150 vlib_thread_main_t *vtm = vlib_get_thread_main ();
151 int i, num_threads = 1 /* main thread */ + vtm->n_threads;
152 for (i = 0; i < num_threads; i++)
155 pool_foreach (crctx, qm->wrk_ctx[i].crypto_ctx_pool) {
156 vlib_cli_output (vm, "[%d][Q]%U", i, format_crypto_context, crctx);
163 static clib_error_t *
164 quic_set_max_packets_per_key_fn (vlib_main_t * vm,
165 unformat_input_t * input,
166 vlib_cli_command_t * cmd)
168 quic_main_t *qm = &quic_main;
169 unformat_input_t _line_input, *line_input = &_line_input;
172 if (!unformat_user (input, unformat_line_input, line_input))
175 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
177 if (unformat (line_input, "%U", unformat_memory_size, &tmp))
179 qm->max_packets_per_key = tmp;
182 return clib_error_return (0, "unknown input '%U'",
183 format_unformat_error, line_input);
189 static clib_error_t *
190 quic_set_cc_fn (vlib_main_t *vm, unformat_input_t *input,
191 vlib_cli_command_t *cmd)
193 unformat_input_t _line_input, *line_input = &_line_input;
194 quic_main_t *qm = &quic_main;
197 if (!unformat_user (input, unformat_line_input, line_input))
200 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
202 if (unformat (line_input, "reno"))
203 qm->default_quic_cc = QUIC_CC_RENO;
204 else if (unformat (line_input, "cubic"))
205 qm->default_quic_cc = QUIC_CC_CUBIC;
208 e = clib_error_return (0, "unknown input '%U'",
209 format_unformat_error, line_input);
214 unformat_free (line_input);
219 quic_release_crypto_context (u32 crypto_context_index, u8 thread_index)
221 crypto_context_t *crctx;
222 crctx = quic_crypto_context_get (crypto_context_index, thread_index);
223 crctx->n_subscribers--;
224 quic_crypto_context_free_if_needed (crctx, thread_index);
228 quic_init_crypto_context (crypto_context_t * crctx, quic_ctx_t * ctx)
230 quic_main_t *qm = &quic_main;
231 quicly_context_t *quicly_ctx;
232 ptls_iovec_t key_vec;
233 app_cert_key_pair_t *ckpair;
235 quic_crypto_context_data_t *data;
236 ptls_context_t *ptls_ctx;
238 QUIC_DBG (2, "Init quic crctx %d thread %d", crctx->ctx_index,
239 ctx->c_thread_index);
241 data = clib_mem_alloc (sizeof (*data));
242 /* picotls depends on data being zeroed */
243 clib_memset (data, 0, sizeof (*data));
244 crctx->data = (void *) data;
245 quicly_ctx = &data->quicly_ctx;
246 ptls_ctx = &data->ptls_ctx;
248 ptls_ctx->random_bytes = ptls_openssl_random_bytes;
249 ptls_ctx->get_time = &ptls_get_time;
250 ptls_ctx->key_exchanges = ptls_openssl_key_exchanges;
251 ptls_ctx->cipher_suites = qm->quic_ciphers[ctx->crypto_engine];
252 ptls_ctx->certificates.list = NULL;
253 ptls_ctx->certificates.count = 0;
254 ptls_ctx->esni = NULL;
255 ptls_ctx->on_client_hello = NULL;
256 ptls_ctx->emit_certificate = NULL;
257 ptls_ctx->sign_certificate = NULL;
258 ptls_ctx->verify_certificate = NULL;
259 ptls_ctx->ticket_lifetime = 86400;
260 ptls_ctx->max_early_data_size = 8192;
261 ptls_ctx->hkdf_label_prefix__obsolete = NULL;
262 ptls_ctx->require_dhe_on_psk = 1;
263 ptls_ctx->encrypt_ticket = &qm->session_cache.super;
264 clib_memcpy (quicly_ctx, &quicly_spec_context, sizeof (quicly_context_t));
266 quicly_ctx->max_packets_per_key = qm->max_packets_per_key;
267 quicly_ctx->tls = ptls_ctx;
268 quicly_ctx->stream_open = &on_stream_open;
269 quicly_ctx->closed_by_remote = &on_closed_by_remote;
270 quicly_ctx->now = &quicly_vpp_now_cb;
271 quicly_amend_ptls_context (quicly_ctx->tls);
273 if (qm->vnet_crypto_enabled &&
274 qm->default_crypto_engine == CRYPTO_ENGINE_VPP)
275 quicly_ctx->crypto_engine = &quic_crypto_engine;
277 quicly_ctx->crypto_engine = &quicly_default_crypto_engine;
279 quicly_ctx->transport_params.max_data = QUIC_INT_MAX;
280 quicly_ctx->transport_params.max_streams_uni = (uint64_t) 1 << 60;
281 quicly_ctx->transport_params.max_streams_bidi = (uint64_t) 1 << 60;
282 quicly_ctx->transport_params.max_idle_timeout = qm->connection_timeout;
284 if (qm->default_quic_cc == QUIC_CC_CUBIC)
285 quicly_ctx->init_cc = &quicly_cc_cubic_init;
286 else if (qm->default_quic_cc == QUIC_CC_RENO)
287 quicly_ctx->init_cc = &quicly_cc_reno_init;
289 app = application_get (ctx->parent_app_id);
290 quicly_ctx->transport_params.max_stream_data.bidi_local =
291 app->sm_properties.rx_fifo_size - 1;
292 quicly_ctx->transport_params.max_stream_data.bidi_remote =
293 app->sm_properties.tx_fifo_size - 1;
294 quicly_ctx->transport_params.max_stream_data.uni = QUIC_INT_MAX;
296 quicly_ctx->transport_params.max_udp_payload_size = QUIC_MAX_PACKET_SIZE;
297 if (!app->quic_iv_set)
299 ptls_openssl_random_bytes (app->quic_iv, QUIC_IV_LEN - 1);
300 app->quic_iv[QUIC_IV_LEN - 1] = 0;
301 app->quic_iv_set = 1;
304 clib_memcpy (data->cid_key, app->quic_iv, QUIC_IV_LEN);
305 key_vec = ptls_iovec_init (data->cid_key, QUIC_IV_LEN);
306 quicly_ctx->cid_encryptor =
307 quicly_new_default_cid_encryptor (&ptls_openssl_bfecb,
308 &ptls_openssl_aes128ecb,
309 &ptls_openssl_sha256, key_vec);
311 ckpair = app_cert_key_pair_get_if_valid (crctx->ckpair_index);
312 if (!ckpair || !ckpair->key || !ckpair->cert)
314 QUIC_DBG (1, "Wrong ckpair id %d\n", crctx->ckpair_index);
317 if (load_bio_private_key (quicly_ctx->tls, (char *) ckpair->key))
319 QUIC_DBG (1, "failed to read private key from app configuration\n");
322 if (load_bio_certificate_chain (quicly_ctx->tls, (char *) ckpair->cert))
324 QUIC_DBG (1, "failed to load certificate\n");
332 quic_acquire_crypto_context (quic_ctx_t * ctx)
334 quic_main_t *qm = &quic_main;
335 crypto_context_t *crctx;
336 clib_bihash_kv_24_8_t kv;
338 if (ctx->crypto_engine == CRYPTO_ENGINE_NONE)
340 QUIC_DBG (2, "No crypto engine specified, using %d",
341 qm->default_crypto_engine);
342 ctx->crypto_engine = qm->default_crypto_engine;
344 if (!clib_bitmap_get (qm->available_crypto_engines, ctx->crypto_engine))
346 QUIC_DBG (1, "Quic does not support crypto engine %d",
348 return SESSION_E_NOCRYPTOENG;
351 /* Check for exisiting crypto ctx */
352 quic_crypto_context_make_key_from_ctx (&kv, ctx);
353 if (clib_bihash_search_24_8
354 (&qm->wrk_ctx[ctx->c_thread_index].crypto_context_hash, &kv, &kv) == 0)
356 crctx = quic_crypto_context_get (kv.value, ctx->c_thread_index);
357 QUIC_DBG (2, "Found exisiting crypto context %d", kv.value);
358 ctx->crypto_context_index = kv.value;
359 crctx->n_subscribers++;
363 crctx = quic_crypto_context_alloc (ctx->c_thread_index);
364 ctx->crypto_context_index = crctx->ctx_index;
365 kv.value = crctx->ctx_index;
366 crctx->crypto_engine = ctx->crypto_engine;
367 crctx->ckpair_index = ctx->ckpair_index;
368 if (quic_init_crypto_context (crctx, ctx))
370 if (vnet_app_add_cert_key_interest (ctx->ckpair_index, qm->app_index))
372 crctx->n_subscribers++;
373 clib_bihash_add_del_24_8 (&qm->
374 wrk_ctx[ctx->c_thread_index].crypto_context_hash,
375 &kv, 1 /* is_add */ );
379 quic_crypto_context_free_if_needed (crctx, ctx->c_thread_index);
380 return SESSION_E_NOCRYPTOCKP;
383 /* Helper functions */
386 quic_ctx_alloc (u32 thread_index)
388 quic_main_t *qm = &quic_main;
391 pool_get (qm->ctx_pool[thread_index], ctx);
393 clib_memset (ctx, 0, sizeof (quic_ctx_t));
394 ctx->c_thread_index = thread_index;
395 ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
396 QUIC_DBG (3, "Allocated quic_ctx %u on thread %u",
397 ctx - qm->ctx_pool[thread_index], thread_index);
398 return ctx - qm->ctx_pool[thread_index];
402 quic_ctx_free (quic_ctx_t * ctx)
404 QUIC_DBG (2, "Free ctx %u %x", ctx->c_thread_index, ctx->c_c_index);
405 u32 thread_index = ctx->c_thread_index;
406 QUIC_ASSERT (ctx->timer_handle == QUIC_TIMER_HANDLE_INVALID);
408 clib_memset (ctx, 0xfb, sizeof (*ctx));
409 pool_put (quic_main.ctx_pool[thread_index], ctx);
413 quic_ctx_get (u32 ctx_index, u32 thread_index)
415 return pool_elt_at_index (quic_main.ctx_pool[thread_index], ctx_index);
419 quic_ctx_get_if_valid (u32 ctx_index, u32 thread_index)
421 if (pool_is_free_index (quic_main.ctx_pool[thread_index], ctx_index))
423 return pool_elt_at_index (quic_main.ctx_pool[thread_index], ctx_index);
427 quic_get_conn_ctx (quicly_conn_t * conn)
430 conn_data = (u64) * quicly_get_data (conn);
431 return quic_ctx_get (conn_data & UINT32_MAX, conn_data >> 32);
435 quic_store_conn_ctx (quicly_conn_t * conn, quic_ctx_t * ctx)
437 *quicly_get_data (conn) =
438 (void *) (((u64) ctx->c_thread_index) << 32 | (u64) ctx->c_c_index);
442 quic_ctx_is_stream (quic_ctx_t * ctx)
444 return (ctx->flags & QUIC_F_IS_STREAM);
448 quic_ctx_is_listener (quic_ctx_t * ctx)
450 return (ctx->flags & QUIC_F_IS_LISTENER);
454 quic_ctx_is_conn (quic_ctx_t * ctx)
456 return !(quic_ctx_is_listener (ctx) || quic_ctx_is_stream (ctx));
459 static inline session_t *
460 get_stream_session_and_ctx_from_stream (quicly_stream_t * stream,
463 quic_stream_data_t *stream_data;
465 stream_data = (quic_stream_data_t *) stream->data;
466 *ctx = quic_ctx_get (stream_data->ctx_id, stream_data->thread_index);
467 return session_get ((*ctx)->c_s_index, stream_data->thread_index);
471 quic_make_connection_key (clib_bihash_kv_16_8_t * kv,
472 const quicly_cid_plaintext_t * id)
474 kv->key[0] = ((u64) id->master_id) << 32 | (u64) id->thread_id;
475 kv->key[1] = id->node_id;
479 quic_sendable_packet_count (session_t * udp_session)
482 u32 packet_size = QUIC_MAX_PACKET_SIZE + SESSION_CONN_HDR_LEN;
483 max_enqueue = svm_fifo_max_enqueue (udp_session->tx_fifo);
484 return clib_min (max_enqueue / packet_size, QUIC_SEND_PACKET_VEC_SIZE);
487 static quicly_context_t *
488 quic_get_quicly_ctx_from_ctx (quic_ctx_t * ctx)
490 crypto_context_t *crctx =
491 quic_crypto_context_get (ctx->crypto_context_index, ctx->c_thread_index);
492 quic_crypto_context_data_t *data =
493 (quic_crypto_context_data_t *) crctx->data;
494 return &data->quicly_ctx;
497 static quicly_context_t *
498 quic_get_quicly_ctx_from_udp (u64 udp_session_handle)
500 session_t *udp_session = session_get_from_handle (udp_session_handle);
502 quic_ctx_get (udp_session->opaque, udp_session->thread_index);
503 return quic_get_quicly_ctx_from_ctx (ctx);
507 quic_set_udp_tx_evt (session_t * udp_session)
510 if (svm_fifo_set_event (udp_session->tx_fifo))
511 rv = session_send_io_evt_to_thread (udp_session->tx_fifo,
513 if (PREDICT_FALSE (rv))
514 clib_warning ("Event enqueue errored %d", rv);
518 quic_stop_ctx_timer (quic_ctx_t * ctx)
520 tw_timer_wheel_1t_3w_1024sl_ov_t *tw;
521 if (ctx->timer_handle == QUIC_TIMER_HANDLE_INVALID)
523 tw = &quic_main.wrk_ctx[ctx->c_thread_index].timer_wheel;
524 tw_timer_stop_1t_3w_1024sl_ov (tw, ctx->timer_handle);
525 ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
526 QUIC_DBG (4, "Stopping timer for ctx %u", ctx->c_c_index);
529 /* QUIC protocol actions */
532 quic_ack_rx_data (session_t * stream_session)
537 quicly_stream_t *stream;
538 quic_stream_data_t *stream_data;
540 sctx = quic_ctx_get (stream_session->connection_index,
541 stream_session->thread_index);
542 QUIC_ASSERT (quic_ctx_is_stream (sctx));
543 stream = sctx->stream;
544 stream_data = (quic_stream_data_t *) stream->data;
546 f = stream_session->rx_fifo;
547 max_deq = svm_fifo_max_dequeue (f);
549 QUIC_ASSERT (stream_data->app_rx_data_len >= max_deq);
550 quicly_stream_sync_recvbuf (stream, stream_data->app_rx_data_len - max_deq);
551 QUIC_DBG (3, "Acking %u bytes", stream_data->app_rx_data_len - max_deq);
552 stream_data->app_rx_data_len = max_deq;
556 quic_disconnect_transport (quic_ctx_t * ctx)
558 QUIC_DBG (2, "Disconnecting transport 0x%lx", ctx->udp_session_handle);
559 vnet_disconnect_args_t a = {
560 .handle = ctx->udp_session_handle,
561 .app_index = quic_main.app_index,
564 if (vnet_disconnect_session (&a))
565 clib_warning ("UDP session 0x%lx disconnect errored",
566 ctx->udp_session_handle);
570 quic_connection_delete (quic_ctx_t * ctx)
572 clib_bihash_kv_16_8_t kv;
575 QUIC_DBG (2, "Deleting connection %u", ctx->c_c_index);
577 QUIC_ASSERT (!quic_ctx_is_stream (ctx));
578 quic_stop_ctx_timer (ctx);
580 /* Delete the connection from the connection map */
583 quic_make_connection_key (&kv, quicly_get_master_id (conn));
584 QUIC_DBG (2, "Deleting conn with id %lu %lu from map", kv.key[0],
586 clib_bihash_add_del_16_8 (&quic_main.connection_hash, &kv, 0 /* is_add */ );
588 quic_disconnect_transport (ctx);
591 quicly_free (ctx->conn);
592 session_transport_delete_notify (&ctx->connection);
596 quic_increment_counter (u8 evt, u8 val)
598 vlib_main_t *vm = vlib_get_main ();
599 vlib_node_increment_counter (vm, quic_input_node.index, evt, val);
603 * Called when quicly return an error
604 * This function interacts tightly with quic_proto_on_close
607 quic_connection_closed (quic_ctx_t * ctx)
609 QUIC_DBG (2, "QUIC connection %u/%u closed", ctx->c_thread_index,
612 /* TODO if connection is not established, just delete the session? */
613 /* Actually should send connect or accept error */
615 switch (ctx->conn_state)
617 case QUIC_CONN_STATE_READY:
618 /* Error on an opened connection (timeout...)
619 This puts the session in closing state, we should receive a notification
620 when the app has closed its session */
621 session_transport_reset_notify (&ctx->connection);
622 /* This ensures we delete the connection when the app confirms the close */
623 ctx->conn_state = QUIC_CONN_STATE_PASSIVE_CLOSING_QUIC_CLOSED;
625 case QUIC_CONN_STATE_PASSIVE_CLOSING:
626 ctx->conn_state = QUIC_CONN_STATE_PASSIVE_CLOSING_QUIC_CLOSED;
627 /* quic_proto_on_close will eventually be called when the app confirms the close
628 , we delete the connection at that point */
630 case QUIC_CONN_STATE_PASSIVE_CLOSING_APP_CLOSED:
631 /* App already confirmed close, we can delete the connection */
632 quic_connection_delete (ctx);
634 case QUIC_CONN_STATE_OPENED:
635 case QUIC_CONN_STATE_HANDSHAKE:
636 case QUIC_CONN_STATE_ACTIVE_CLOSING:
637 quic_connection_delete (ctx);
640 QUIC_DBG (0, "BUG %d", ctx->conn_state);
646 quic_send_datagram (session_t *udp_session, struct iovec *packet,
647 quicly_address_t *dest, quicly_address_t *src)
650 session_dgram_hdr_t hdr;
653 transport_connection_t *tc;
655 len = packet->iov_len;
656 f = udp_session->tx_fifo;
657 tc = session_get_transport (udp_session);
658 max_enqueue = svm_fifo_max_enqueue (f);
659 if (max_enqueue < SESSION_CONN_HDR_LEN + len)
661 QUIC_ERR ("Too much data to send, max_enqueue %u, len %u",
662 max_enqueue, len + SESSION_CONN_HDR_LEN);
663 return QUIC_ERROR_FULL_FIFO;
666 /* Build packet header for fifo */
667 hdr.data_length = len;
669 hdr.is_ip4 = tc->is_ip4;
670 clib_memcpy (&hdr.lcl_ip, &tc->lcl_ip, sizeof (ip46_address_t));
671 hdr.lcl_port = tc->lcl_port;
673 /* Read dest address from quicly-provided sockaddr */
676 QUIC_ASSERT (dest->sa.sa_family == AF_INET);
677 struct sockaddr_in *sa4 = (struct sockaddr_in *) &dest->sa;
678 hdr.rmt_port = sa4->sin_port;
679 hdr.rmt_ip.ip4.as_u32 = sa4->sin_addr.s_addr;
683 QUIC_ASSERT (dest->sa.sa_family == AF_INET6);
684 struct sockaddr_in6 *sa6 = (struct sockaddr_in6 *) &dest->sa;
685 hdr.rmt_port = sa6->sin6_port;
686 clib_memcpy (&hdr.rmt_ip.ip6, &sa6->sin6_addr, 16);
689 ret = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
690 if (ret != sizeof (hdr))
692 QUIC_ERR ("Not enough space to enqueue header");
693 return QUIC_ERROR_FULL_FIFO;
695 ret = svm_fifo_enqueue (f, len, packet->iov_base);
698 QUIC_ERR ("Not enough space to enqueue payload");
699 return QUIC_ERROR_FULL_FIFO;
702 quic_increment_counter (QUIC_ERROR_TX_PACKETS, 1);
708 quic_send_packets (quic_ctx_t * ctx)
710 struct iovec packets[QUIC_SEND_PACKET_VEC_SIZE];
712 buf[QUIC_SEND_PACKET_VEC_SIZE * quic_get_quicly_ctx_from_ctx (ctx)
713 ->transport_params.max_udp_payload_size];
714 session_t *udp_session;
716 size_t num_packets, i, max_packets;
717 quicly_address_t dest, src;
721 /* We have sctx, get qctx */
722 if (quic_ctx_is_stream (ctx))
723 ctx = quic_ctx_get (ctx->quic_connection_ctx_id, ctx->c_thread_index);
725 QUIC_ASSERT (!quic_ctx_is_stream (ctx));
727 udp_session = session_get_from_handle_if_valid (ctx->udp_session_handle);
737 /* TODO : quicly can assert it can send min_packets up to 2 */
738 max_packets = quic_sendable_packet_count (udp_session);
742 num_packets = max_packets;
743 if ((err = quicly_send (conn, &dest, &src, packets, &num_packets, buf,
747 for (i = 0; i != num_packets; ++i)
751 quic_send_datagram (udp_session, &packets[i], &dest, &src)))
755 n_sent += num_packets;
757 while (num_packets > 0 && num_packets == max_packets);
759 quic_set_udp_tx_evt (udp_session);
761 QUIC_DBG (3, "%u[TX] %u[RX]", svm_fifo_max_dequeue (udp_session->tx_fifo),
762 svm_fifo_max_dequeue (udp_session->rx_fifo));
763 quic_update_timer (ctx);
767 if (err && err != QUICLY_ERROR_PACKET_IGNORED
768 && err != QUICLY_ERROR_FREE_CONNECTION)
769 clib_warning ("Quic error '%U'.", quic_format_err, err);
770 quic_connection_closed (ctx);
774 /* Quicly callbacks */
777 quic_on_stream_destroy (quicly_stream_t * stream, int err)
779 quic_stream_data_t *stream_data = (quic_stream_data_t *) stream->data;
780 quic_ctx_t *sctx = quic_ctx_get (stream_data->ctx_id,
781 stream_data->thread_index);
782 session_t *stream_session = session_get (sctx->c_s_index,
783 sctx->c_thread_index);
784 QUIC_DBG (2, "DESTROYED_STREAM: session 0x%lx (%U)",
785 session_handle (stream_session), quic_format_err, err);
787 stream_session->session_state = SESSION_STATE_CLOSED;
788 session_transport_delete_notify (&sctx->connection);
790 quic_increment_counter (QUIC_ERROR_CLOSED_STREAM, 1);
791 quic_ctx_free (sctx);
792 clib_mem_free (stream->data);
796 quic_on_stop_sending (quicly_stream_t * stream, int err)
799 quic_stream_data_t *stream_data = (quic_stream_data_t *) stream->data;
800 quic_ctx_t *sctx = quic_ctx_get (stream_data->ctx_id,
801 stream_data->thread_index);
802 session_t *stream_session = session_get (sctx->c_s_index,
803 sctx->c_thread_index);
804 clib_warning ("(NOT IMPLEMENTD) STOP_SENDING: session 0x%lx (%U)",
805 session_handle (stream_session), quic_format_err, err);
807 /* TODO : handle STOP_SENDING */
811 quic_on_receive_reset (quicly_stream_t * stream, int err)
813 quic_stream_data_t *stream_data = (quic_stream_data_t *) stream->data;
814 quic_ctx_t *sctx = quic_ctx_get (stream_data->ctx_id,
815 stream_data->thread_index);
817 session_t *stream_session = session_get (sctx->c_s_index,
818 sctx->c_thread_index);
819 clib_warning ("RESET_STREAM: session 0x%lx (%U)",
820 session_handle (stream_session), quic_format_err, err);
822 session_transport_closing_notify (&sctx->connection);
826 quic_on_receive (quicly_stream_t * stream, size_t off, const void *src,
829 QUIC_DBG (3, "received data: %lu bytes, offset %lu", len, off);
830 u32 max_enq, rlen, rv;
832 session_t *stream_session;
833 app_worker_t *app_wrk;
835 quic_stream_data_t *stream_data;
840 stream_data = (quic_stream_data_t *) stream->data;
841 sctx = quic_ctx_get (stream_data->ctx_id, stream_data->thread_index);
842 stream_session = session_get (sctx->c_s_index, stream_data->thread_index);
843 f = stream_session->rx_fifo;
845 max_enq = svm_fifo_max_enqueue_prod (f);
846 QUIC_DBG (3, "Enqueuing %u at off %u in %u space", len, off, max_enq);
847 /* Handle duplicate packet/chunk from quicly */
848 if (off < stream_data->app_rx_data_len)
850 QUIC_DBG (3, "Session [idx %u, app_wrk %u, thread %u, rx-fifo 0x%llx]: "
851 "DUPLICATE PACKET (max_enq %u, len %u, "
852 "app_rx_data_len %u, off %u, ToBeNQ %u)",
853 stream_session->session_index,
854 stream_session->app_wrk_index,
855 stream_session->thread_index, f,
856 max_enq, len, stream_data->app_rx_data_len, off,
857 off - stream_data->app_rx_data_len + len);
860 if (PREDICT_FALSE ((off - stream_data->app_rx_data_len + len) > max_enq))
862 QUIC_ERR ("Session [idx %u, app_wrk %u, thread %u, rx-fifo 0x%llx]: "
863 "RX FIFO IS FULL (max_enq %u, len %u, "
864 "app_rx_data_len %u, off %u, ToBeNQ %u)",
865 stream_session->session_index,
866 stream_session->app_wrk_index,
867 stream_session->thread_index, f,
868 max_enq, len, stream_data->app_rx_data_len, off,
869 off - stream_data->app_rx_data_len + len);
870 return; /* This shouldn't happen */
872 if (off == stream_data->app_rx_data_len)
874 /* Streams live on the same thread so (f, stream_data) should stay consistent */
875 rlen = svm_fifo_enqueue (f, len, (u8 *) src);
876 QUIC_DBG (3, "Session [idx %u, app_wrk %u, ti %u, rx-fifo 0x%llx]: "
877 "Enqueuing %u (rlen %u) at off %u in %u space, ",
878 stream_session->session_index,
879 stream_session->app_wrk_index,
880 stream_session->thread_index, f, len, rlen, off, max_enq);
881 stream_data->app_rx_data_len += rlen;
882 QUIC_ASSERT (rlen >= len);
883 app_wrk = app_worker_get_if_valid (stream_session->app_wrk_index);
884 if (PREDICT_TRUE (app_wrk != 0))
886 rv = app_worker_lock_and_send_event (app_wrk, stream_session,
889 QUIC_ERR ("Failed to ping app for RX");
891 quic_ack_rx_data (stream_session);
895 rlen = svm_fifo_enqueue_with_offset (f,
896 off - stream_data->app_rx_data_len,
898 QUIC_ASSERT (rlen == 0);
904 quic_fifo_egress_shift (quicly_stream_t * stream, size_t delta)
906 quic_stream_data_t *stream_data;
907 session_t *stream_session;
912 stream_data = (quic_stream_data_t *) stream->data;
913 stream_session = get_stream_session_and_ctx_from_stream (stream, &ctx);
914 f = stream_session->tx_fifo;
916 QUIC_ASSERT (stream_data->app_tx_data_len >= delta);
917 stream_data->app_tx_data_len -= delta;
918 ctx->bytes_written += delta;
919 rv = svm_fifo_dequeue_drop (f, delta);
920 QUIC_ASSERT (rv == delta);
922 rv = quicly_stream_sync_sendbuf (stream, 0);
927 quic_fifo_egress_emit (quicly_stream_t * stream, size_t off, void *dst,
928 size_t * len, int *wrote_all)
930 quic_stream_data_t *stream_data;
932 session_t *stream_session;
936 stream_data = (quic_stream_data_t *) stream->data;
937 stream_session = get_stream_session_and_ctx_from_stream (stream, &ctx);
938 f = stream_session->tx_fifo;
940 QUIC_DBG (3, "Emitting %u, offset %u", *len, off);
942 deq_max = svm_fifo_max_dequeue_cons (f);
943 QUIC_ASSERT (off <= deq_max);
944 if (off + *len < deq_max)
951 *len = deq_max - off;
953 QUIC_ASSERT (*len > 0);
955 if (off + *len > stream_data->app_tx_data_len)
956 stream_data->app_tx_data_len = off + *len;
958 svm_fifo_peek (f, off, *len, dst);
961 static const quicly_stream_callbacks_t quic_stream_callbacks = {
962 .on_destroy = quic_on_stream_destroy,
963 .on_send_shift = quic_fifo_egress_shift,
964 .on_send_emit = quic_fifo_egress_emit,
965 .on_send_stop = quic_on_stop_sending,
966 .on_receive = quic_on_receive,
967 .on_receive_reset = quic_on_receive_reset
971 quic_on_stream_open (quicly_stream_open_t * self, quicly_stream_t * stream)
973 /* Return code for this function ends either
974 * - in quicly_receive : if not QUICLY_ERROR_PACKET_IGNORED, will close connection
975 * - in quicly_open_stream, returned directly
978 session_t *stream_session, *quic_session;
979 quic_stream_data_t *stream_data;
980 app_worker_t *app_wrk;
981 quic_ctx_t *qctx, *sctx;
985 QUIC_DBG (2, "on_stream_open called");
986 stream->data = clib_mem_alloc (sizeof (quic_stream_data_t));
987 stream->callbacks = &quic_stream_callbacks;
988 /* Notify accept on parent qsession, but only if this is not a locally
989 * initiated stream */
990 if (quicly_stream_is_self_initiated (stream))
993 sctx_id = quic_ctx_alloc (vlib_get_thread_index ());
994 qctx = quic_get_conn_ctx (stream->conn);
996 /* Might need to signal that the connection is ready if the first thing the
997 * server does is open a stream */
998 quic_check_quic_session_connected (qctx);
999 /* ctx might be invalidated */
1000 qctx = quic_get_conn_ctx (stream->conn);
1002 stream_session = session_alloc (qctx->c_thread_index);
1003 QUIC_DBG (2, "ACCEPTED stream_session 0x%lx ctx %u",
1004 session_handle (stream_session), sctx_id);
1005 sctx = quic_ctx_get (sctx_id, qctx->c_thread_index);
1006 sctx->parent_app_wrk_id = qctx->parent_app_wrk_id;
1007 sctx->parent_app_id = qctx->parent_app_id;
1008 sctx->quic_connection_ctx_id = qctx->c_c_index;
1009 sctx->c_c_index = sctx_id;
1010 sctx->c_s_index = stream_session->session_index;
1011 sctx->stream = stream;
1012 sctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1013 sctx->flags |= QUIC_F_IS_STREAM;
1014 if (quicly_stream_is_unidirectional (stream->stream_id))
1015 stream_session->flags |= SESSION_F_UNIDIRECTIONAL;
1017 stream_data = (quic_stream_data_t *) stream->data;
1018 stream_data->ctx_id = sctx_id;
1019 stream_data->thread_index = sctx->c_thread_index;
1020 stream_data->app_rx_data_len = 0;
1021 stream_data->app_tx_data_len = 0;
1023 sctx->c_s_index = stream_session->session_index;
1024 stream_session->session_state = SESSION_STATE_CREATED;
1025 stream_session->app_wrk_index = sctx->parent_app_wrk_id;
1026 stream_session->connection_index = sctx->c_c_index;
1027 stream_session->session_type =
1028 session_type_from_proto_and_ip (TRANSPORT_PROTO_QUIC, qctx->udp_is_ip4);
1029 quic_session = session_get (qctx->c_s_index, qctx->c_thread_index);
1030 stream_session->listener_handle = listen_session_get_handle (quic_session);
1032 app_wrk = app_worker_get (stream_session->app_wrk_index);
1033 if ((rv = app_worker_init_connected (app_wrk, stream_session)))
1035 QUIC_ERR ("failed to allocate fifos");
1036 quicly_reset_stream (stream, QUIC_APP_ALLOCATION_ERROR);
1037 return 0; /* Frame is still valid */
1039 svm_fifo_add_want_deq_ntf (stream_session->rx_fifo,
1040 SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL |
1041 SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY);
1043 if ((rv = app_worker_accept_notify (app_wrk, stream_session)))
1045 QUIC_ERR ("failed to notify accept worker app");
1046 quicly_reset_stream (stream, QUIC_APP_ACCEPT_NOTIFY_ERROR);
1047 return 0; /* Frame is still valid */
1054 quic_on_closed_by_remote (quicly_closed_by_remote_t *self, quicly_conn_t *conn,
1055 int code, uint64_t frame_type, const char *reason,
1058 quic_ctx_t *ctx = quic_get_conn_ctx (conn);
1060 session_t *quic_session = session_get (ctx->c_s_index, ctx->c_thread_index);
1061 clib_warning ("Session 0x%lx closed by peer (%U) %.*s ",
1062 session_handle (quic_session), quic_format_err, code,
1063 reason_len, reason);
1065 ctx->conn_state = QUIC_CONN_STATE_PASSIVE_CLOSING;
1066 session_transport_closing_notify (&ctx->connection);
1069 /* Timer handling */
1072 quic_get_thread_time (u8 thread_index)
1074 return quic_main.wrk_ctx[thread_index].time_now;
1078 quic_get_time (quicly_now_t * self)
1080 u8 thread_index = vlib_get_thread_index ();
1081 return quic_get_thread_time (thread_index);
1085 quic_set_time_now (u32 thread_index)
1087 vlib_main_t *vlib_main = vlib_get_main ();
1088 f64 time = vlib_time_now (vlib_main);
1089 quic_main.wrk_ctx[thread_index].time_now = (int64_t) (time * 1000.f);
1090 return quic_main.wrk_ctx[thread_index].time_now;
1093 /* Transport proto callback */
1095 quic_update_time (f64 now, u8 thread_index)
1097 tw_timer_wheel_1t_3w_1024sl_ov_t *tw;
1099 tw = &quic_main.wrk_ctx[thread_index].timer_wheel;
1100 quic_set_time_now (thread_index);
1101 tw_timer_expire_timers_1t_3w_1024sl_ov (tw, now);
1105 quic_timer_expired (u32 conn_index)
1108 QUIC_DBG (4, "Timer expired for conn %u at %ld", conn_index,
1109 quic_get_time (NULL));
1110 ctx = quic_ctx_get (conn_index, vlib_get_thread_index ());
1111 ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
1112 quic_send_packets (ctx);
1116 quic_update_timer (quic_ctx_t * ctx)
1118 tw_timer_wheel_1t_3w_1024sl_ov_t *tw;
1119 int64_t next_timeout, next_interval;
1120 session_t *quic_session;
1123 /* This timeout is in ms which is the unit of our timer */
1124 next_timeout = quicly_get_first_timeout (ctx->conn);
1125 next_interval = next_timeout - quic_get_time (NULL);
1127 if (next_timeout == 0 || next_interval <= 0)
1129 if (ctx->c_s_index == QUIC_SESSION_INVALID)
1135 quic_session = session_get (ctx->c_s_index, ctx->c_thread_index);
1136 if (svm_fifo_set_event (quic_session->tx_fifo))
1138 rv = session_send_io_evt_to_thread_custom (quic_session,
1139 quic_session->thread_index,
1140 SESSION_IO_EVT_BUILTIN_TX);
1141 if (PREDICT_FALSE (rv))
1142 QUIC_ERR ("Failed to enqueue builtin_tx %d", rv);
1148 tw = &quic_main.wrk_ctx[vlib_get_thread_index ()].timer_wheel;
1150 QUIC_DBG (4, "Timer set to %ld (int %ld) for ctx %u", next_timeout,
1151 next_interval, ctx->c_c_index);
1153 if (ctx->timer_handle == QUIC_TIMER_HANDLE_INVALID)
1155 if (next_timeout == INT64_MAX)
1157 QUIC_DBG (4, "timer for ctx %u already stopped", ctx->c_c_index);
1160 ctx->timer_handle = tw_timer_start_1t_3w_1024sl_ov (tw, ctx->c_c_index,
1165 if (next_timeout == INT64_MAX)
1167 quic_stop_ctx_timer (ctx);
1170 tw_timer_update_1t_3w_1024sl_ov (tw, ctx->timer_handle,
1177 quic_expired_timers_dispatch (u32 * expired_timers)
1181 for (i = 0; i < vec_len (expired_timers); i++)
1183 quic_timer_expired (expired_timers[i]);
1187 /* Transport proto functions */
1189 quic_connect_stream (session_t * quic_session, session_endpoint_cfg_t * sep)
1191 uint64_t quic_session_handle;
1192 session_t *stream_session;
1193 quic_stream_data_t *stream_data;
1194 quicly_stream_t *stream;
1195 quicly_conn_t *conn;
1196 app_worker_t *app_wrk;
1197 quic_ctx_t *qctx, *sctx;
1202 /* Find base session to which the user want to attach a stream */
1203 quic_session_handle = session_handle (quic_session);
1204 QUIC_DBG (2, "Opening new stream (qsession %u)", quic_session_handle);
1206 if (session_type_transport_proto (quic_session->session_type) !=
1207 TRANSPORT_PROTO_QUIC)
1209 QUIC_ERR ("received incompatible session");
1213 app_wrk = app_worker_get_if_valid (quic_session->app_wrk_index);
1216 QUIC_ERR ("Invalid app worker :(");
1220 sctx_index = quic_ctx_alloc (quic_session->thread_index); /* Allocate before we get pointers */
1221 sctx = quic_ctx_get (sctx_index, quic_session->thread_index);
1222 qctx = quic_ctx_get (quic_session->connection_index,
1223 quic_session->thread_index);
1224 if (quic_ctx_is_stream (qctx))
1226 QUIC_ERR ("session is a stream");
1227 quic_ctx_free (sctx);
1231 sctx->parent_app_wrk_id = qctx->parent_app_wrk_id;
1232 sctx->parent_app_id = qctx->parent_app_id;
1233 sctx->quic_connection_ctx_id = qctx->c_c_index;
1234 sctx->c_c_index = sctx_index;
1235 sctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1236 sctx->flags |= QUIC_F_IS_STREAM;
1240 if (!conn || !quicly_connection_is_ready (conn))
1243 is_unidir = sep->transport_flags & TRANSPORT_CFG_F_UNIDIRECTIONAL;
1244 if ((rv = quicly_open_stream (conn, &stream, is_unidir)))
1246 QUIC_DBG (2, "Stream open failed with %d", rv);
1249 quic_increment_counter (QUIC_ERROR_OPENED_STREAM, 1);
1251 sctx->stream = stream;
1253 QUIC_DBG (2, "Opened stream %d, creating session", stream->stream_id);
1255 stream_session = session_alloc (qctx->c_thread_index);
1256 QUIC_DBG (2, "Allocated stream_session 0x%lx ctx %u",
1257 session_handle (stream_session), sctx_index);
1258 stream_session->app_wrk_index = app_wrk->wrk_index;
1259 stream_session->connection_index = sctx_index;
1260 stream_session->listener_handle = quic_session_handle;
1261 stream_session->session_type =
1262 session_type_from_proto_and_ip (TRANSPORT_PROTO_QUIC, qctx->udp_is_ip4);
1264 stream_session->flags |= SESSION_F_UNIDIRECTIONAL;
1266 sctx->c_s_index = stream_session->session_index;
1267 stream_data = (quic_stream_data_t *) stream->data;
1268 stream_data->ctx_id = sctx->c_c_index;
1269 stream_data->thread_index = sctx->c_thread_index;
1270 stream_data->app_rx_data_len = 0;
1271 stream_data->app_tx_data_len = 0;
1272 stream_session->session_state = SESSION_STATE_READY;
1274 /* For now we only reset streams. Cleanup will be triggered by timers */
1275 if ((rv = app_worker_init_connected (app_wrk, stream_session)))
1277 QUIC_ERR ("failed to app_worker_init_connected");
1278 quicly_reset_stream (stream, QUIC_APP_CONNECT_NOTIFY_ERROR);
1279 return app_worker_connect_notify (app_wrk, NULL, rv, sep->opaque);
1282 svm_fifo_add_want_deq_ntf (stream_session->rx_fifo,
1283 SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL |
1284 SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY);
1286 if (app_worker_connect_notify (app_wrk, stream_session, SESSION_E_NONE,
1289 QUIC_ERR ("failed to notify app");
1290 quic_increment_counter (QUIC_ERROR_CLOSED_STREAM, 1);
1291 quicly_reset_stream (stream, QUIC_APP_CONNECT_NOTIFY_ERROR);
1299 quic_connect_connection (session_endpoint_cfg_t * sep)
1301 vnet_connect_args_t _cargs, *cargs = &_cargs;
1302 transport_endpt_crypto_cfg_t *ccfg;
1303 quic_main_t *qm = &quic_main;
1305 app_worker_t *app_wrk;
1308 u32 thread_index = vlib_get_thread_index ();
1312 return SESSION_E_NOEXTCFG;
1314 ccfg = &sep->ext_cfg->crypto;
1316 clib_memset (cargs, 0, sizeof (*cargs));
1317 ctx_index = quic_ctx_alloc (thread_index);
1318 ctx = quic_ctx_get (ctx_index, thread_index);
1319 ctx->parent_app_wrk_id = sep->app_wrk_index;
1320 ctx->c_s_index = QUIC_SESSION_INVALID;
1321 ctx->c_c_index = ctx_index;
1322 ctx->udp_is_ip4 = sep->is_ip4;
1323 ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
1324 ctx->conn_state = QUIC_CONN_STATE_HANDSHAKE;
1325 ctx->client_opaque = sep->opaque;
1326 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1327 if (ccfg->hostname[0])
1328 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1330 /* needed by quic for crypto + determining client / server */
1331 ctx->srv_hostname = format (0, "%U", format_ip46_address,
1332 &sep->ip, sep->is_ip4);
1333 vec_terminate_c_string (ctx->srv_hostname);
1335 clib_memcpy (&cargs->sep_ext, sep, sizeof (session_endpoint_cfg_t));
1336 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1337 cargs->app_index = qm->app_index;
1338 cargs->api_context = ctx_index;
1340 app_wrk = app_worker_get (sep->app_wrk_index);
1341 app = application_get (app_wrk->app_index);
1342 ctx->parent_app_id = app_wrk->app_index;
1343 cargs->sep_ext.ns_index = app->ns_index;
1344 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1346 ctx->crypto_engine = ccfg->crypto_engine;
1347 ctx->ckpair_index = ccfg->ckpair_index;
1348 if ((error = quic_acquire_crypto_context (ctx)))
1351 if ((error = vnet_connect (cargs)))
1358 quic_connect (transport_endpoint_cfg_t * tep)
1360 QUIC_DBG (2, "Called quic_connect");
1361 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) tep;
1362 session_t *quic_session;
1363 sep = (session_endpoint_cfg_t *) tep;
1365 quic_session = session_get_from_handle_if_valid (sep->parent_handle);
1367 return quic_connect_stream (quic_session, sep);
1369 return quic_connect_connection (sep);
1373 quic_proto_on_close (u32 ctx_index, u32 thread_index)
1376 quic_ctx_t *ctx = quic_ctx_get_if_valid (ctx_index, thread_index);
1379 session_t *stream_session = session_get (ctx->c_s_index,
1380 ctx->c_thread_index);
1382 clib_warning ("Closing session 0x%lx", session_handle (stream_session));
1384 if (quic_ctx_is_stream (ctx))
1386 quicly_stream_t *stream = ctx->stream;
1387 if (!quicly_stream_has_send_side (quicly_is_client (stream->conn),
1390 quicly_sendstate_shutdown (&stream->sendstate, ctx->bytes_written +
1391 svm_fifo_max_dequeue
1392 (stream_session->tx_fifo));
1393 err = quicly_stream_sync_sendbuf (stream, 1);
1396 QUIC_DBG (1, "sendstate_shutdown failed for stream session %lu",
1397 session_handle (stream_session));
1398 quicly_reset_stream (stream, QUIC_APP_ERROR_CLOSE_NOTIFY);
1400 quic_send_packets (ctx);
1404 switch (ctx->conn_state)
1406 case QUIC_CONN_STATE_OPENED:
1407 case QUIC_CONN_STATE_HANDSHAKE:
1408 case QUIC_CONN_STATE_READY:
1409 ctx->conn_state = QUIC_CONN_STATE_ACTIVE_CLOSING;
1410 quicly_conn_t *conn = ctx->conn;
1411 /* Start connection closing. Keep sending packets until quicly_send
1412 returns QUICLY_ERROR_FREE_CONNECTION */
1414 quic_increment_counter (QUIC_ERROR_CLOSED_CONNECTION, 1);
1415 quicly_close (conn, QUIC_APP_ERROR_CLOSE_NOTIFY, "Closed by peer");
1416 /* This also causes all streams to be closed (and the cb called) */
1417 quic_send_packets (ctx);
1419 case QUIC_CONN_STATE_PASSIVE_CLOSING:
1420 ctx->conn_state = QUIC_CONN_STATE_PASSIVE_CLOSING_APP_CLOSED;
1421 /* send_packets will eventually return an error, we delete the conn at
1424 case QUIC_CONN_STATE_PASSIVE_CLOSING_QUIC_CLOSED:
1425 quic_connection_delete (ctx);
1427 case QUIC_CONN_STATE_ACTIVE_CLOSING:
1430 QUIC_ERR ("Trying to close conn in state %d", ctx->conn_state);
1436 quic_start_listen (u32 quic_listen_session_index, transport_endpoint_t * tep)
1438 vnet_listen_args_t _bargs, *args = &_bargs;
1439 transport_endpt_crypto_cfg_t *ccfg;
1440 quic_main_t *qm = &quic_main;
1441 session_handle_t udp_handle;
1442 session_endpoint_cfg_t *sep;
1443 session_t *udp_listen_session;
1444 app_worker_t *app_wrk;
1448 app_listener_t *app_listener;
1451 sep = (session_endpoint_cfg_t *) tep;
1453 return SESSION_E_NOEXTCFG;
1455 ccfg = &sep->ext_cfg->crypto;
1456 app_wrk = app_worker_get (sep->app_wrk_index);
1457 /* We need to call this because we call app_worker_init_connected in
1458 * quic_accept_stream, which assumes the connect segment manager exists */
1459 app_worker_alloc_connects_segment_manager (app_wrk);
1460 app = application_get (app_wrk->app_index);
1461 QUIC_DBG (2, "Called quic_start_listen for app %d", app_wrk->app_index);
1463 clib_memset (args, 0, sizeof (*args));
1464 args->app_index = qm->app_index;
1465 args->sep_ext = *sep;
1466 args->sep_ext.ns_index = app->ns_index;
1467 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
1468 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1469 if ((rv = vnet_listen (args)))
1472 lctx_index = quic_ctx_alloc (0);
1473 udp_handle = args->handle;
1474 app_listener = app_listener_get_w_handle (udp_handle);
1475 udp_listen_session = app_listener_get_session (app_listener);
1476 udp_listen_session->opaque = lctx_index;
1478 lctx = quic_ctx_get (lctx_index, 0);
1479 lctx->flags |= QUIC_F_IS_LISTENER;
1481 clib_memcpy (&lctx->c_rmt_ip, &args->sep.peer.ip, sizeof (ip46_address_t));
1482 clib_memcpy (&lctx->c_lcl_ip, &args->sep.ip, sizeof (ip46_address_t));
1483 lctx->c_rmt_port = args->sep.peer.port;
1484 lctx->c_lcl_port = args->sep.port;
1485 lctx->c_is_ip4 = args->sep.is_ip4;
1486 lctx->c_fib_index = args->sep.fib_index;
1487 lctx->c_proto = TRANSPORT_PROTO_QUIC;
1488 lctx->parent_app_wrk_id = sep->app_wrk_index;
1489 lctx->parent_app_id = app_wrk->app_index;
1490 lctx->udp_session_handle = udp_handle;
1491 lctx->c_s_index = quic_listen_session_index;
1492 lctx->crypto_engine = ccfg->crypto_engine;
1493 lctx->ckpair_index = ccfg->ckpair_index;
1494 if ((rv = quic_acquire_crypto_context (lctx)))
1497 QUIC_DBG (2, "Listening UDP session 0x%lx",
1498 session_handle (udp_listen_session));
1499 QUIC_DBG (2, "Listening QUIC session 0x%lx", quic_listen_session_index);
1504 quic_stop_listen (u32 lctx_index)
1506 QUIC_DBG (2, "Called quic_stop_listen");
1508 lctx = quic_ctx_get (lctx_index, 0);
1509 QUIC_ASSERT (quic_ctx_is_listener (lctx));
1510 vnet_unlisten_args_t a = {
1511 .handle = lctx->udp_session_handle,
1512 .app_index = quic_main.app_index,
1513 .wrk_map_index = 0 /* default wrk */
1515 if (vnet_unlisten (&a))
1516 clib_warning ("unlisten errored");
1518 quic_release_crypto_context (lctx->crypto_context_index,
1519 0 /* thread_index */ );
1520 quic_ctx_free (lctx);
1524 static transport_connection_t *
1525 quic_connection_get (u32 ctx_index, u32 thread_index)
1528 ctx = quic_ctx_get (ctx_index, thread_index);
1529 return &ctx->connection;
1532 static transport_connection_t *
1533 quic_listener_get (u32 listener_index)
1535 QUIC_DBG (2, "Called quic_listener_get");
1537 ctx = quic_ctx_get (listener_index, 0);
1538 return &ctx->connection;
1542 format_quic_ctx (u8 * s, va_list * args)
1544 quic_ctx_t *ctx = va_arg (*args, quic_ctx_t *);
1545 u32 verbose = va_arg (*args, u32);
1550 str = format (str, "[#%d][Q] ", ctx->c_thread_index);
1552 if (quic_ctx_is_listener (ctx))
1553 str = format (str, "Listener, UDP %ld", ctx->udp_session_handle);
1554 else if (quic_ctx_is_stream (ctx))
1555 str = format (str, "Stream %ld conn %d",
1556 ctx->stream->stream_id, ctx->quic_connection_ctx_id);
1557 else /* connection */
1558 str = format (str, "Conn %d UDP %d", ctx->c_c_index,
1559 ctx->udp_session_handle);
1561 str = format (str, " app %d wrk %d", ctx->parent_app_id,
1562 ctx->parent_app_wrk_id);
1565 s = format (s, "%-" SESSION_CLI_ID_LEN "s%-" SESSION_CLI_STATE_LEN "d",
1566 str, ctx->conn_state);
1568 s = format (s, "%s\n", str);
1574 format_quic_connection (u8 * s, va_list * args)
1576 u32 qc_index = va_arg (*args, u32);
1577 u32 thread_index = va_arg (*args, u32);
1578 u32 verbose = va_arg (*args, u32);
1579 quic_ctx_t *ctx = quic_ctx_get (qc_index, thread_index);
1580 s = format (s, "%U", format_quic_ctx, ctx, verbose);
1585 format_quic_half_open (u8 * s, va_list * args)
1587 u32 qc_index = va_arg (*args, u32);
1588 u32 thread_index = va_arg (*args, u32);
1589 quic_ctx_t *ctx = quic_ctx_get (qc_index, thread_index);
1590 s = format (s, "[#%d][Q] half-open app %u", thread_index,
1591 ctx->parent_app_id);
1597 format_quic_listener (u8 * s, va_list * args)
1599 u32 tci = va_arg (*args, u32);
1600 u32 thread_index = va_arg (*args, u32);
1601 u32 verbose = va_arg (*args, u32);
1602 quic_ctx_t *ctx = quic_ctx_get (tci, thread_index);
1603 s = format (s, "%U", format_quic_ctx, ctx, verbose);
1607 /* Session layer callbacks */
1610 quic_build_sockaddr (struct sockaddr *sa, socklen_t * salen,
1611 ip46_address_t * addr, u16 port, u8 is_ip4)
1615 struct sockaddr_in *sa4 = (struct sockaddr_in *) sa;
1616 sa4->sin_family = AF_INET;
1617 sa4->sin_port = port;
1618 sa4->sin_addr.s_addr = addr->ip4.as_u32;
1619 *salen = sizeof (struct sockaddr_in);
1623 struct sockaddr_in6 *sa6 = (struct sockaddr_in6 *) sa;
1624 sa6->sin6_family = AF_INET6;
1625 sa6->sin6_port = port;
1626 clib_memcpy (&sa6->sin6_addr, &addr->ip6, 16);
1627 *salen = sizeof (struct sockaddr_in6);
1632 quic_on_quic_session_connected (quic_ctx_t * ctx)
1634 session_t *quic_session;
1635 app_worker_t *app_wrk;
1636 u32 ctx_id = ctx->c_c_index;
1637 u32 thread_index = ctx->c_thread_index;
1640 quic_session = session_alloc (thread_index);
1642 QUIC_DBG (2, "Allocated quic session 0x%lx", session_handle (quic_session));
1643 ctx->c_s_index = quic_session->session_index;
1644 quic_session->app_wrk_index = ctx->parent_app_wrk_id;
1645 quic_session->connection_index = ctx->c_c_index;
1646 quic_session->listener_handle = SESSION_INVALID_HANDLE;
1647 quic_session->session_type =
1648 session_type_from_proto_and_ip (TRANSPORT_PROTO_QUIC, ctx->udp_is_ip4);
1650 /* If quic session connected fails, immediatly close connection */
1651 app_wrk = app_worker_get (ctx->parent_app_wrk_id);
1652 if ((rv = app_worker_init_connected (app_wrk, quic_session)))
1654 QUIC_ERR ("failed to app_worker_init_connected");
1655 quic_proto_on_close (ctx_id, thread_index);
1656 app_worker_connect_notify (app_wrk, NULL, rv, ctx->client_opaque);
1660 quic_session->session_state = SESSION_STATE_CONNECTING;
1661 if ((rv = app_worker_connect_notify (app_wrk, quic_session,
1662 SESSION_E_NONE, ctx->client_opaque)))
1664 QUIC_ERR ("failed to notify app %d", rv);
1665 quic_proto_on_close (ctx_id, thread_index);
1669 /* If the app opens a stream in its callback it may invalidate ctx */
1670 ctx = quic_ctx_get (ctx_id, thread_index);
1672 * app_worker_connect_notify() might have reallocated pool, reload
1673 * quic_session pointer
1675 quic_session = session_get (ctx->c_s_index, thread_index);
1676 quic_session->session_state = SESSION_STATE_LISTENING;
1680 quic_check_quic_session_connected (quic_ctx_t * ctx)
1682 /* Called when we need to trigger quic session connected
1683 * we may call this function on the server side / at
1686 /* Conn may be set to null if the connection is terminated */
1687 if (!ctx->conn || ctx->conn_state != QUIC_CONN_STATE_HANDSHAKE)
1689 if (!quicly_connection_is_ready (ctx->conn))
1691 ctx->conn_state = QUIC_CONN_STATE_READY;
1692 if (!quicly_is_client (ctx->conn))
1694 quic_on_quic_session_connected (ctx);
1698 quic_update_conn_ctx (quicly_conn_t * conn, quicly_context_t * quicly_context)
1700 /* we need to update the quicly_conn on migrate
1701 * as it contains a pointer to the crypto context */
1702 ptls_context_t **tls;
1703 quicly_context_t **_quicly_context;
1704 _quicly_context = (quicly_context_t **) conn;
1705 *_quicly_context = quicly_context;
1706 tls = (ptls_context_t **) quicly_get_tls (conn);
1707 *tls = quicly_context->tls;
1711 quic_receive_connection (void *arg)
1713 u32 new_ctx_id, thread_index = vlib_get_thread_index ();
1714 quic_ctx_t *temp_ctx, *new_ctx;
1715 clib_bihash_kv_16_8_t kv;
1716 quicly_conn_t *conn;
1717 quicly_context_t *quicly_context;
1718 session_t *udp_session;
1721 new_ctx_id = quic_ctx_alloc (thread_index);
1722 new_ctx = quic_ctx_get (new_ctx_id, thread_index);
1724 QUIC_DBG (2, "Received conn %u (now %u)", temp_ctx->c_thread_index,
1727 clib_memcpy (new_ctx, temp_ctx, sizeof (quic_ctx_t));
1728 clib_mem_free (temp_ctx);
1730 new_ctx->c_thread_index = thread_index;
1731 new_ctx->c_c_index = new_ctx_id;
1732 quic_acquire_crypto_context (new_ctx);
1734 conn = new_ctx->conn;
1735 quicly_context = quic_get_quicly_ctx_from_ctx (new_ctx);
1736 quic_update_conn_ctx (conn, quicly_context);
1738 quic_store_conn_ctx (conn, new_ctx);
1739 quic_make_connection_key (&kv, quicly_get_master_id (conn));
1740 kv.value = ((u64) thread_index) << 32 | (u64) new_ctx_id;
1741 QUIC_DBG (2, "Registering conn with id %lu %lu", kv.key[0], kv.key[1]);
1742 clib_bihash_add_del_16_8 (&quic_main.connection_hash, &kv, 1 /* is_add */ );
1743 new_ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
1744 quic_update_timer (new_ctx);
1746 /* Trigger write on this connection if necessary */
1747 udp_session = session_get_from_handle (new_ctx->udp_session_handle);
1748 udp_session->opaque = new_ctx_id;
1749 udp_session->flags &= ~SESSION_F_IS_MIGRATING;
1750 if (svm_fifo_max_dequeue (udp_session->tx_fifo))
1751 quic_set_udp_tx_evt (udp_session);
1755 quic_transfer_connection (u32 ctx_index, u32 dest_thread)
1757 quic_ctx_t *ctx, *temp_ctx;
1758 u32 thread_index = vlib_get_thread_index ();
1760 QUIC_DBG (2, "Transferring conn %u to thread %u", ctx_index, dest_thread);
1762 temp_ctx = clib_mem_alloc (sizeof (quic_ctx_t));
1763 QUIC_ASSERT (temp_ctx != NULL);
1764 ctx = quic_ctx_get (ctx_index, thread_index);
1766 clib_memcpy (temp_ctx, ctx, sizeof (quic_ctx_t));
1768 quic_stop_ctx_timer (ctx);
1769 quic_release_crypto_context (ctx->crypto_context_index, thread_index);
1770 quic_ctx_free (ctx);
1772 /* Send connection to destination thread */
1773 session_send_rpc_evt_to_thread (dest_thread, quic_receive_connection,
1778 quic_udp_session_connected_callback (u32 quic_app_index, u32 ctx_index,
1779 session_t * udp_session,
1780 session_error_t err)
1782 QUIC_DBG (2, "UDP Session is now connected (id %u)",
1783 udp_session->session_index);
1784 /* This should always be called before quic_connect returns since UDP always
1785 * connects instantly. */
1786 clib_bihash_kv_16_8_t kv;
1787 struct sockaddr_in6 sa6;
1788 struct sockaddr *sa = (struct sockaddr *) &sa6;
1790 transport_connection_t *tc;
1791 app_worker_t *app_wrk;
1792 quicly_conn_t *conn;
1794 u32 thread_index = vlib_get_thread_index ();
1796 quicly_context_t *quicly_ctx;
1799 ctx = quic_ctx_get (ctx_index, thread_index);
1803 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_id);
1806 api_context = ctx->c_s_index;
1807 app_worker_connect_notify (app_wrk, 0, SESSION_E_NONE, api_context);
1812 ctx->c_thread_index = thread_index;
1813 ctx->c_c_index = ctx_index;
1815 QUIC_DBG (2, "New ctx [%u]%x", thread_index, (ctx) ? ctx_index : ~0);
1817 ctx->udp_session_handle = session_handle (udp_session);
1818 udp_session->opaque = ctx_index;
1820 /* Init QUIC lib connection
1821 * Generate required sockaddr & salen */
1822 tc = session_get_transport (udp_session);
1823 quic_build_sockaddr (sa, &salen, &tc->rmt_ip, tc->rmt_port, tc->is_ip4);
1825 quicly_ctx = quic_get_quicly_ctx_from_ctx (ctx);
1826 ret = quicly_connect (&ctx->conn, quicly_ctx, (char *) ctx->srv_hostname,
1827 sa, NULL, &quic_main.wrk_ctx[thread_index].next_cid,
1828 ptls_iovec_init (NULL, 0), &quic_main.hs_properties,
1830 ++quic_main.wrk_ctx[thread_index].next_cid.master_id;
1831 /* Save context handle in quicly connection */
1832 quic_store_conn_ctx (ctx->conn, ctx);
1835 /* Register connection in connections map */
1837 quic_make_connection_key (&kv, quicly_get_master_id (conn));
1838 kv.value = ((u64) thread_index) << 32 | (u64) ctx_index;
1839 QUIC_DBG (2, "Registering conn with id %lu %lu", kv.key[0], kv.key[1]);
1840 clib_bihash_add_del_16_8 (&quic_main.connection_hash, &kv, 1 /* is_add */ );
1842 /* UDP stack quirk? preemptively transfer connection if that happens */
1843 if (udp_session->thread_index != thread_index)
1844 quic_transfer_connection (ctx_index, udp_session->thread_index);
1846 quic_send_packets (ctx);
1852 quic_udp_session_disconnect_callback (session_t * s)
1854 clib_warning ("UDP session disconnected???");
1858 quic_udp_session_cleanup_callback (session_t * udp_session,
1859 session_cleanup_ntf_t ntf)
1863 if (ntf != SESSION_CLEANUP_SESSION)
1866 ctx = quic_ctx_get (udp_session->opaque, udp_session->thread_index);
1867 quic_stop_ctx_timer (ctx);
1868 quic_release_crypto_context (ctx->crypto_context_index,
1869 ctx->c_thread_index);
1870 quic_ctx_free (ctx);
1874 quic_udp_session_reset_callback (session_t * s)
1876 clib_warning ("UDP session reset???");
1880 quic_udp_session_migrate_callback (session_t * s, session_handle_t new_sh)
1882 u32 new_thread = session_thread_from_handle (new_sh);
1885 QUIC_DBG (2, "Session %x migrated to %lx", s->session_index, new_sh);
1886 QUIC_ASSERT (vlib_get_thread_index () == s->thread_index);
1887 ctx = quic_ctx_get (s->opaque, s->thread_index);
1888 QUIC_ASSERT (ctx->udp_session_handle == session_handle (s));
1890 ctx->udp_session_handle = new_sh;
1892 s->opaque = 0xfeedface;
1894 quic_transfer_connection (ctx->c_c_index, new_thread);
1898 quic_udp_session_accepted_callback (session_t * udp_session)
1900 /* New UDP connection, try to accept it */
1902 quic_ctx_t *ctx, *lctx;
1903 session_t *udp_listen_session;
1904 u32 thread_index = vlib_get_thread_index ();
1906 udp_listen_session =
1907 listen_session_get_from_handle (udp_session->listener_handle);
1909 ctx_index = quic_ctx_alloc (thread_index);
1910 ctx = quic_ctx_get (ctx_index, thread_index);
1911 ctx->c_thread_index = udp_session->thread_index;
1912 ctx->c_c_index = ctx_index;
1913 ctx->c_s_index = QUIC_SESSION_INVALID;
1914 ctx->udp_session_handle = session_handle (udp_session);
1915 QUIC_DBG (2, "ACCEPTED UDP 0x%lx", ctx->udp_session_handle);
1916 ctx->listener_ctx_id = udp_listen_session->opaque;
1917 lctx = quic_ctx_get (udp_listen_session->opaque,
1918 udp_listen_session->thread_index);
1919 ctx->udp_is_ip4 = lctx->c_is_ip4;
1920 ctx->parent_app_id = lctx->parent_app_id;
1921 ctx->parent_app_wrk_id = lctx->parent_app_wrk_id;
1922 ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
1923 ctx->conn_state = QUIC_CONN_STATE_OPENED;
1924 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1926 ctx->crypto_engine = lctx->crypto_engine;
1927 ctx->ckpair_index = lctx->ckpair_index;
1928 quic_acquire_crypto_context (ctx);
1929 udp_session->opaque = ctx_index;
1931 /* TODO timeout to delete these if they never connect */
1936 quic_add_segment_callback (u32 client_index, u64 seg_handle)
1938 /* No-op for builtin */
1943 quic_del_segment_callback (u32 client_index, u64 seg_handle)
1945 /* No-op for builtin */
1950 quic_custom_app_rx_callback (transport_connection_t * tc)
1953 session_t *stream_session = session_get (tc->s_index, tc->thread_index);
1954 QUIC_DBG (3, "Received app READ notification");
1955 quic_ack_rx_data (stream_session);
1956 svm_fifo_reset_has_deq_ntf (stream_session->rx_fifo);
1958 /* Need to send packets (acks may never be sent otherwise) */
1959 ctx = quic_ctx_get (stream_session->connection_index,
1960 stream_session->thread_index);
1961 quic_send_packets (ctx);
1966 quic_custom_tx_callback (void *s, transport_send_params_t * sp)
1968 session_t *stream_session = (session_t *) s;
1969 quic_stream_data_t *stream_data;
1970 quicly_stream_t *stream;
1976 (stream_session->session_state >= SESSION_STATE_TRANSPORT_CLOSING))
1978 ctx = quic_ctx_get (stream_session->connection_index,
1979 stream_session->thread_index);
1980 if (PREDICT_FALSE (!quic_ctx_is_stream (ctx)))
1982 goto tx_end; /* Most probably a reschedule */
1985 QUIC_DBG (3, "Stream TX event");
1986 quic_ack_rx_data (stream_session);
1987 stream = ctx->stream;
1988 if (!quicly_sendstate_is_open (&stream->sendstate))
1990 QUIC_ERR ("Warning: tried to send on closed stream");
1994 stream_data = (quic_stream_data_t *) stream->data;
1995 max_deq = svm_fifo_max_dequeue (stream_session->tx_fifo);
1996 QUIC_ASSERT (max_deq >= stream_data->app_tx_data_len);
1997 if (max_deq == stream_data->app_tx_data_len)
1999 QUIC_DBG (3, "TX but no data %d / %d", max_deq,
2000 stream_data->app_tx_data_len);
2003 stream_data->app_tx_data_len = max_deq;
2004 rv = quicly_stream_sync_sendbuf (stream, 1);
2008 return quic_send_packets (ctx);
2012 * Returns 0 if a matching connection is found and is on the right thread.
2013 * Otherwise returns -1.
2014 * If a connection is found, even on the wrong thread, ctx_thread and ctx_index
2018 quic_find_packet_ctx (quic_rx_packet_ctx_t * pctx, u32 caller_thread_index)
2020 clib_bihash_kv_16_8_t kv;
2021 clib_bihash_16_8_t *h;
2023 u32 index, thread_id;
2025 h = &quic_main.connection_hash;
2026 quic_make_connection_key (&kv, &pctx->packet.cid.dest.plaintext);
2027 QUIC_DBG (3, "Searching conn with id %lu %lu", kv.key[0], kv.key[1]);
2029 if (clib_bihash_search_16_8 (h, &kv, &kv))
2031 QUIC_DBG (3, "connection not found");
2032 return QUIC_PACKET_TYPE_NONE;
2035 index = kv.value & UINT32_MAX;
2036 thread_id = kv.value >> 32;
2037 /* Check if this connection belongs to this thread, otherwise
2038 * ask for it to be moved */
2039 if (thread_id != caller_thread_index)
2041 QUIC_DBG (2, "Connection is on wrong thread");
2042 /* Cannot make full check with quicly_is_destination... */
2043 pctx->ctx_index = index;
2044 pctx->thread_index = thread_id;
2045 return QUIC_PACKET_TYPE_MIGRATE;
2047 ctx = quic_ctx_get (index, vlib_get_thread_index ());
2050 QUIC_ERR ("ctx has no conn");
2051 return QUIC_PACKET_TYPE_NONE;
2053 if (!quicly_is_destination (ctx->conn, NULL, &pctx->sa, &pctx->packet))
2054 return QUIC_PACKET_TYPE_NONE;
2056 QUIC_DBG (3, "Connection found");
2057 pctx->ctx_index = index;
2058 pctx->thread_index = thread_id;
2059 return QUIC_PACKET_TYPE_RECEIVE;
2063 quic_accept_connection (quic_rx_packet_ctx_t * pctx)
2065 quicly_context_t *quicly_ctx;
2066 session_t *quic_session;
2067 clib_bihash_kv_16_8_t kv;
2068 app_worker_t *app_wrk;
2069 quicly_conn_t *conn;
2074 /* new connection, accept and create context if packet is valid
2075 * TODO: check if socket is actually listening? */
2076 ctx = quic_ctx_get (pctx->ctx_index, pctx->thread_index);
2077 if (ctx->c_s_index != QUIC_SESSION_INVALID)
2079 QUIC_DBG (2, "already accepted ctx 0x%x", ctx->c_s_index);
2083 quicly_ctx = quic_get_quicly_ctx_from_ctx (ctx);
2084 if ((rv = quicly_accept (&conn, quicly_ctx, NULL, &pctx->sa,
2085 &pctx->packet, NULL,
2086 &quic_main.wrk_ctx[pctx->thread_index].next_cid,
2089 /* Invalid packet, pass */
2090 assert (conn == NULL);
2091 QUIC_ERR ("Accept failed with %U", quic_format_err, rv);
2092 /* TODO: cleanup created quic ctx and UDP session */
2095 assert (conn != NULL);
2097 ++quic_main.wrk_ctx[pctx->thread_index].next_cid.master_id;
2098 /* Save ctx handle in quicly connection */
2099 quic_store_conn_ctx (conn, ctx);
2102 quic_session = session_alloc (ctx->c_thread_index);
2103 QUIC_DBG (2, "Allocated quic_session, 0x%lx ctx %u",
2104 session_handle (quic_session), ctx->c_c_index);
2105 quic_session->session_state = SESSION_STATE_LISTENING;
2106 ctx->c_s_index = quic_session->session_index;
2108 lctx = quic_ctx_get (ctx->listener_ctx_id, 0);
2110 quic_session->app_wrk_index = lctx->parent_app_wrk_id;
2111 quic_session->connection_index = ctx->c_c_index;
2112 quic_session->session_type =
2113 session_type_from_proto_and_ip (TRANSPORT_PROTO_QUIC, ctx->udp_is_ip4);
2114 quic_session->listener_handle = lctx->c_s_index;
2116 /* Register connection in connections map */
2117 quic_make_connection_key (&kv, quicly_get_master_id (conn));
2118 kv.value = ((u64) pctx->thread_index) << 32 | (u64) pctx->ctx_index;
2119 clib_bihash_add_del_16_8 (&quic_main.connection_hash, &kv, 1 /* is_add */ );
2120 QUIC_DBG (2, "Registering conn with id %lu %lu", kv.key[0], kv.key[1]);
2122 /* If notify fails, reset connection immediatly */
2123 if ((rv = app_worker_init_accepted (quic_session)))
2125 QUIC_ERR ("failed to allocate fifos");
2126 quic_proto_on_close (pctx->ctx_index, pctx->thread_index);
2130 app_wrk = app_worker_get (quic_session->app_wrk_index);
2131 if ((rv = app_worker_accept_notify (app_wrk, quic_session)))
2133 QUIC_ERR ("failed to notify accept worker app");
2134 quic_proto_on_close (pctx->ctx_index, pctx->thread_index);
2138 ctx->conn_state = QUIC_CONN_STATE_READY;
2142 quic_reset_connection (u64 udp_session_handle, quic_rx_packet_ctx_t * pctx)
2144 /* short header packet; potentially a dead connection. No need to check the
2145 * length of the incoming packet, because loop is prevented by authenticating
2146 * the CID (by checking node_id and thread_id). If the peer is also sending a
2147 * reset, then the next CID is highly likely to contain a non-authenticating
2149 QUIC_DBG (2, "Sending stateless reset");
2151 session_t *udp_session;
2152 quicly_context_t *quicly_ctx;
2153 if (pctx->packet.cid.dest.plaintext.node_id != 0
2154 || pctx->packet.cid.dest.plaintext.thread_id != 0)
2156 quicly_ctx = quic_get_quicly_ctx_from_udp (udp_session_handle);
2157 quic_ctx_t *qctx = quic_ctx_get (pctx->ctx_index, pctx->thread_index);
2159 quicly_address_t src;
2160 uint8_t payload[quicly_ctx->transport_params.max_udp_payload_size];
2161 size_t payload_len =
2162 quicly_send_stateless_reset (quicly_ctx, &src.sa, payload);
2163 if (payload_len == 0)
2166 struct iovec packet;
2167 packet.iov_len = payload_len;
2168 packet.iov_base = payload;
2170 struct _st_quicly_conn_public_t *conn =
2171 (struct _st_quicly_conn_public_t *) qctx->conn;
2173 udp_session = session_get_from_handle (udp_session_handle);
2174 rv = quic_send_datagram (udp_session, &packet, &conn->remote.address,
2175 &conn->local.address);
2176 quic_set_udp_tx_evt (udp_session);
2181 quic_process_one_rx_packet (u64 udp_session_handle, svm_fifo_t * f,
2182 u32 fifo_offset, quic_rx_packet_ctx_t * pctx)
2186 u32 thread_index = vlib_get_thread_index ();
2187 u32 cur_deq = svm_fifo_max_dequeue (f) - fifo_offset;
2188 quicly_context_t *quicly_ctx;
2189 session_t *udp_session;
2192 ret = svm_fifo_peek (f, fifo_offset,
2193 SESSION_CONN_HDR_LEN, (u8 *) & pctx->ph);
2194 QUIC_ASSERT (ret == SESSION_CONN_HDR_LEN);
2195 QUIC_ASSERT (pctx->ph.data_offset == 0);
2196 full_len = pctx->ph.data_length + SESSION_CONN_HDR_LEN;
2197 if (full_len > cur_deq)
2199 QUIC_ERR ("Not enough data in fifo RX");
2203 /* Quicly can read len bytes from the fifo at offset:
2204 * ph.data_offset + SESSION_CONN_HDR_LEN */
2205 ret = svm_fifo_peek (f, SESSION_CONN_HDR_LEN + fifo_offset,
2206 pctx->ph.data_length, pctx->data);
2207 if (ret != pctx->ph.data_length)
2209 QUIC_ERR ("Not enough data peeked in RX");
2213 quic_increment_counter (QUIC_ERROR_RX_PACKETS, 1);
2214 quic_build_sockaddr (&pctx->sa, &pctx->salen, &pctx->ph.rmt_ip,
2215 pctx->ph.rmt_port, pctx->ph.is_ip4);
2216 quicly_ctx = quic_get_quicly_ctx_from_udp (udp_session_handle);
2219 plen = quicly_decode_packet (quicly_ctx, &pctx->packet, pctx->data,
2220 pctx->ph.data_length, &off);
2222 if (plen == SIZE_MAX)
2227 rv = quic_find_packet_ctx (pctx, thread_index);
2228 if (rv == QUIC_PACKET_TYPE_RECEIVE)
2230 pctx->ptype = QUIC_PACKET_TYPE_RECEIVE;
2232 if (quic_main.vnet_crypto_enabled &&
2233 quic_main.default_crypto_engine == CRYPTO_ENGINE_VPP)
2235 quic_ctx_t *qctx = quic_ctx_get (pctx->ctx_index, thread_index);
2236 quic_crypto_decrypt_packet (qctx, pctx);
2240 else if (rv == QUIC_PACKET_TYPE_MIGRATE)
2242 pctx->ptype = QUIC_PACKET_TYPE_MIGRATE;
2243 /* Connection found but on wrong thread, ask move */
2245 else if (QUICLY_PACKET_IS_LONG_HEADER (pctx->packet.octets.base[0]))
2247 pctx->ptype = QUIC_PACKET_TYPE_ACCEPT;
2248 udp_session = session_get_from_handle (udp_session_handle);
2249 pctx->ctx_index = udp_session->opaque;
2250 pctx->thread_index = thread_index;
2254 pctx->ptype = QUIC_PACKET_TYPE_RESET;
2260 quic_udp_session_rx_callback (session_t * udp_session)
2262 /* Read data from UDP rx_fifo and pass it to the quicly conn. */
2263 quic_ctx_t *ctx = NULL, *prev_ctx = NULL;
2264 svm_fifo_t *f = udp_session->rx_fifo;
2266 u64 udp_session_handle = session_handle (udp_session);
2268 u32 thread_index = vlib_get_thread_index ();
2269 u32 cur_deq, fifo_offset, max_packets, i;
2271 quic_rx_packet_ctx_t packets_ctx[QUIC_RCV_MAX_PACKETS];
2273 if (udp_session->flags & SESSION_F_IS_MIGRATING)
2275 QUIC_DBG (3, "RX on migrating udp session");
2280 max_deq = svm_fifo_max_dequeue (f);
2285 max_packets = QUIC_RCV_MAX_PACKETS;
2288 clib_memset (packets_ctx, 0xfa,
2289 QUIC_RCV_MAX_PACKETS * sizeof (quic_rx_packet_ctx_t));
2291 for (i = 0; i < max_packets; i++)
2293 packets_ctx[i].thread_index = UINT32_MAX;
2294 packets_ctx[i].ctx_index = UINT32_MAX;
2295 packets_ctx[i].ptype = QUIC_PACKET_TYPE_DROP;
2297 cur_deq = max_deq - fifo_offset;
2300 max_packets = i + 1;
2303 if (cur_deq < SESSION_CONN_HDR_LEN)
2305 fifo_offset = max_deq;
2306 max_packets = i + 1;
2307 QUIC_ERR ("Fifo %d < header size in RX", cur_deq);
2310 rv = quic_process_one_rx_packet (udp_session_handle, f,
2311 fifo_offset, &packets_ctx[i]);
2312 if (packets_ctx[i].ptype != QUIC_PACKET_TYPE_MIGRATE)
2313 fifo_offset += SESSION_CONN_HDR_LEN + packets_ctx[i].ph.data_length;
2316 max_packets = i + 1;
2321 for (i = 0; i < max_packets; i++)
2323 switch (packets_ctx[i].ptype)
2325 case QUIC_PACKET_TYPE_RECEIVE:
2326 ctx = quic_ctx_get (packets_ctx[i].ctx_index, thread_index);
2327 rv = quicly_receive (ctx->conn, NULL, &packets_ctx[i].sa,
2328 &packets_ctx[i].packet);
2329 if (rv && rv != QUICLY_ERROR_PACKET_IGNORED)
2331 QUIC_ERR ("quicly_receive return error %U",
2332 quic_format_err, rv);
2335 case QUIC_PACKET_TYPE_ACCEPT:
2336 quic_accept_connection (&packets_ctx[i]);
2338 case QUIC_PACKET_TYPE_RESET:
2339 quic_reset_connection (udp_session_handle, &packets_ctx[i]);
2343 ctx = prev_ctx = NULL;
2344 for (i = 0; i < max_packets; i++)
2347 switch (packets_ctx[i].ptype)
2349 case QUIC_PACKET_TYPE_RECEIVE:
2350 ctx = quic_ctx_get (packets_ctx[i].ctx_index,
2351 packets_ctx[i].thread_index);
2352 quic_check_quic_session_connected (ctx);
2353 ctx = quic_ctx_get (packets_ctx[i].ctx_index,
2354 packets_ctx[i].thread_index);
2356 case QUIC_PACKET_TYPE_ACCEPT:
2357 ctx = quic_ctx_get (packets_ctx[i].ctx_index,
2358 packets_ctx[i].thread_index);
2361 continue; /* this exits the for loop since other packet types are
2362 necessarily the last in the batch */
2364 if (ctx != prev_ctx)
2365 quic_send_packets (ctx);
2368 udp_session = session_get_from_handle (udp_session_handle); /* session alloc might have happened */
2369 f = udp_session->rx_fifo;
2370 svm_fifo_dequeue_drop (f, fifo_offset);
2372 if (svm_fifo_max_dequeue (f))
2379 quic_common_get_transport_endpoint (quic_ctx_t * ctx,
2380 transport_endpoint_t * tep, u8 is_lcl)
2382 session_t *udp_session;
2383 if (!quic_ctx_is_stream (ctx))
2385 udp_session = session_get_from_handle (ctx->udp_session_handle);
2386 session_get_endpoint (udp_session, tep, is_lcl);
2391 quic_get_transport_listener_endpoint (u32 listener_index,
2392 transport_endpoint_t * tep, u8 is_lcl)
2395 app_listener_t *app_listener;
2396 session_t *udp_listen_session;
2397 ctx = quic_ctx_get (listener_index, vlib_get_thread_index ());
2398 if (quic_ctx_is_listener (ctx))
2400 app_listener = app_listener_get_w_handle (ctx->udp_session_handle);
2401 udp_listen_session = app_listener_get_session (app_listener);
2402 return session_get_endpoint (udp_listen_session, tep, is_lcl);
2404 quic_common_get_transport_endpoint (ctx, tep, is_lcl);
2408 quic_get_transport_endpoint (u32 ctx_index, u32 thread_index,
2409 transport_endpoint_t * tep, u8 is_lcl)
2412 ctx = quic_ctx_get (ctx_index, thread_index);
2413 quic_common_get_transport_endpoint (ctx, tep, is_lcl);
2417 static session_cb_vft_t quic_app_cb_vft = {
2418 .session_accept_callback = quic_udp_session_accepted_callback,
2419 .session_disconnect_callback = quic_udp_session_disconnect_callback,
2420 .session_connected_callback = quic_udp_session_connected_callback,
2421 .session_reset_callback = quic_udp_session_reset_callback,
2422 .session_migrate_callback = quic_udp_session_migrate_callback,
2423 .add_segment_callback = quic_add_segment_callback,
2424 .del_segment_callback = quic_del_segment_callback,
2425 .builtin_app_rx_callback = quic_udp_session_rx_callback,
2426 .session_cleanup_callback = quic_udp_session_cleanup_callback,
2427 .app_cert_key_pair_delete_callback = quic_app_cert_key_pair_delete_callback,
2430 static const transport_proto_vft_t quic_proto = {
2431 .connect = quic_connect,
2432 .close = quic_proto_on_close,
2433 .start_listen = quic_start_listen,
2434 .stop_listen = quic_stop_listen,
2435 .get_connection = quic_connection_get,
2436 .get_listener = quic_listener_get,
2437 .update_time = quic_update_time,
2438 .app_rx_evt = quic_custom_app_rx_callback,
2439 .custom_tx = quic_custom_tx_callback,
2440 .format_connection = format_quic_connection,
2441 .format_half_open = format_quic_half_open,
2442 .format_listener = format_quic_listener,
2443 .get_transport_endpoint = quic_get_transport_endpoint,
2444 .get_transport_listener_endpoint = quic_get_transport_listener_endpoint,
2445 .transport_options = {
2448 .tx_type = TRANSPORT_TX_INTERNAL,
2449 .service_type = TRANSPORT_SERVICE_APP,
2454 static quicly_stream_open_t on_stream_open = { quic_on_stream_open };
2455 static quicly_closed_by_remote_t on_closed_by_remote = {
2456 quic_on_closed_by_remote
2458 static quicly_now_t quicly_vpp_now_cb = { quic_get_time };
2461 quic_register_cipher_suite (crypto_engine_type_t type,
2462 ptls_cipher_suite_t ** ciphers)
2464 quic_main_t *qm = &quic_main;
2465 vec_validate (qm->quic_ciphers, type);
2466 clib_bitmap_set (qm->available_crypto_engines, type, 1);
2467 qm->quic_ciphers[type] = ciphers;
2471 quic_update_fifo_size ()
2473 quic_main_t *qm = &quic_main;
2474 segment_manager_props_t *seg_mgr_props =
2475 application_get_segment_manager_properties (qm->app_index);
2480 ("error while getting segment_manager_props_t, can't update fifo-size");
2484 seg_mgr_props->tx_fifo_size = qm->udp_fifo_size;
2485 seg_mgr_props->rx_fifo_size = qm->udp_fifo_size;
2488 static clib_error_t *
2489 quic_init (vlib_main_t * vm)
2491 u32 segment_size = 256 << 20;
2492 vlib_thread_main_t *vtm = vlib_get_thread_main ();
2493 tw_timer_wheel_1t_3w_1024sl_ov_t *tw;
2494 vnet_app_attach_args_t _a, *a = &_a;
2495 u64 options[APP_OPTIONS_N_OPTIONS];
2496 quic_main_t *qm = &quic_main;
2499 num_threads = 1 /* main thread */ + vtm->n_threads;
2501 clib_memset (a, 0, sizeof (*a));
2502 clib_memset (options, 0, sizeof (options));
2504 a->session_cb_vft = &quic_app_cb_vft;
2505 a->api_client_index = APP_INVALID_INDEX;
2506 a->options = options;
2507 a->name = format (0, "quic");
2508 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
2509 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = segment_size;
2510 a->options[APP_OPTIONS_RX_FIFO_SIZE] = qm->udp_fifo_size;
2511 a->options[APP_OPTIONS_TX_FIFO_SIZE] = qm->udp_fifo_size;
2512 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = qm->udp_fifo_prealloc;
2513 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
2514 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
2515 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
2517 if (vnet_application_attach (a))
2519 clib_warning ("failed to attach quic app");
2520 return clib_error_return (0, "failed to attach quic app");
2523 vec_validate (qm->ctx_pool, num_threads - 1);
2524 vec_validate (qm->wrk_ctx, num_threads - 1);
2526 for (i = 0; i < num_threads; i++)
2528 qm->wrk_ctx[i].next_cid.thread_id = i;
2529 tw = &qm->wrk_ctx[i].timer_wheel;
2530 tw_timer_wheel_init_1t_3w_1024sl_ov (tw, quic_expired_timers_dispatch,
2531 1e-3 /* timer period 1ms */ , ~0);
2532 tw->last_run_time = vlib_time_now (vlib_get_main ());
2533 clib_bihash_init_24_8 (&qm->wrk_ctx[i].crypto_context_hash,
2534 "quic crypto contexts", 64, 128 << 10);
2537 clib_bihash_init_16_8 (&qm->connection_hash, "quic connections", 1024,
2540 qm->app_index = a->app_index;
2541 qm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
2542 / QUIC_TSTAMP_RESOLUTION;
2543 qm->session_cache.super.cb = quic_encrypt_ticket_cb;
2545 transport_register_protocol (TRANSPORT_PROTO_QUIC, &quic_proto,
2546 FIB_PROTOCOL_IP4, ~0);
2547 transport_register_protocol (TRANSPORT_PROTO_QUIC, &quic_proto,
2548 FIB_PROTOCOL_IP6, ~0);
2550 clib_bitmap_alloc (qm->available_crypto_engines,
2551 app_crypto_engine_n_types ());
2552 quic_register_cipher_suite (CRYPTO_ENGINE_PICOTLS,
2553 ptls_openssl_cipher_suites);
2554 qm->default_crypto_engine = CRYPTO_ENGINE_PICOTLS;
2556 vnet_crypto_main_t *cm = &crypto_main;
2557 if (vec_len (cm->engines) == 0)
2558 qm->vnet_crypto_enabled = 0;
2560 qm->vnet_crypto_enabled = 1;
2561 if (qm->vnet_crypto_enabled == 1)
2563 quic_register_cipher_suite (CRYPTO_ENGINE_VPP,
2564 quic_crypto_cipher_suites);
2565 qm->default_crypto_engine = CRYPTO_ENGINE_VPP;
2568 qm->max_packets_per_key = DEFAULT_MAX_PACKETS_PER_KEY;
2569 clib_rwlock_init (&qm->crypto_keys_quic_rw_lock);
2571 qm->default_quic_cc = QUIC_CC_RENO;
2577 VLIB_INIT_FUNCTION (quic_init);
2579 static clib_error_t *
2580 quic_plugin_crypto_command_fn (vlib_main_t * vm,
2581 unformat_input_t * input,
2582 vlib_cli_command_t * cmd)
2584 unformat_input_t _line_input, *line_input = &_line_input;
2585 quic_main_t *qm = &quic_main;
2586 clib_error_t *e = 0;
2588 if (!unformat_user (input, unformat_line_input, line_input))
2591 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2593 if (unformat (line_input, "vpp"))
2594 qm->default_crypto_engine = CRYPTO_ENGINE_VPP;
2595 else if (unformat (line_input, "picotls"))
2596 qm->default_crypto_engine = CRYPTO_ENGINE_PICOTLS;
2599 e = clib_error_return (0, "unknown input '%U'",
2600 format_unformat_error, line_input);
2605 unformat_free (line_input);
2609 u64 quic_fifosize = 0;
2610 static clib_error_t *
2611 quic_plugin_set_fifo_size_command_fn (vlib_main_t * vm,
2612 unformat_input_t * input,
2613 vlib_cli_command_t * cmd)
2615 quic_main_t *qm = &quic_main;
2616 unformat_input_t _line_input, *line_input = &_line_input;
2619 if (!unformat_user (input, unformat_line_input, line_input))
2622 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2624 if (unformat (line_input, "%U", unformat_memory_size, &tmp))
2626 if (tmp >= 0x100000000ULL)
2628 return clib_error_return
2629 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
2631 qm->udp_fifo_size = tmp;
2632 quic_update_fifo_size ();
2635 return clib_error_return (0, "unknown input '%U'",
2636 format_unformat_error, line_input);
2643 quic_get_counter_value (u32 event_code)
2647 vlib_error_main_t *em;
2653 vm = vlib_get_main ();
2654 em = &vm->error_main;
2655 n = vlib_get_node (vm, quic_input_node.index);
2657 foreach_vlib_main ()
2659 em = &this_vlib_main->error_main;
2660 i = n->error_heap_index + code;
2661 c = em->counters[i];
2663 if (i < vec_len (em->counters_last_clear))
2664 c -= em->counters_last_clear[i];
2672 quic_show_aggregated_stats (vlib_main_t * vm)
2674 u32 num_workers = vlib_num_workers ();
2675 quic_main_t *qm = &quic_main;
2676 quic_ctx_t *ctx = NULL;
2677 quicly_stats_t st, agg_stats;
2678 u32 i, nconn = 0, nstream = 0;
2680 clib_memset (&agg_stats, 0, sizeof (agg_stats));
2681 for (i = 0; i < num_workers + 1; i++)
2684 pool_foreach (ctx, qm->ctx_pool[i])
2686 if (quic_ctx_is_conn (ctx) && ctx->conn)
2688 quicly_get_stats (ctx->conn, &st);
2689 agg_stats.rtt.smoothed += st.rtt.smoothed;
2690 agg_stats.rtt.minimum += st.rtt.minimum;
2691 agg_stats.rtt.variance += st.rtt.variance;
2692 agg_stats.num_packets.received += st.num_packets.received;
2693 agg_stats.num_packets.sent += st.num_packets.sent;
2694 agg_stats.num_packets.lost += st.num_packets.lost;
2695 agg_stats.num_packets.ack_received += st.num_packets.ack_received;
2696 agg_stats.num_bytes.received += st.num_bytes.received;
2697 agg_stats.num_bytes.sent += st.num_bytes.sent;
2700 else if (quic_ctx_is_stream (ctx))
2705 vlib_cli_output (vm, "-------- Connections --------");
2706 vlib_cli_output (vm, "Current: %u", nconn);
2707 vlib_cli_output (vm, "Opened: %d",
2708 quic_get_counter_value (QUIC_ERROR_OPENED_CONNECTION));
2709 vlib_cli_output (vm, "Closed: %d",
2710 quic_get_counter_value (QUIC_ERROR_CLOSED_CONNECTION));
2711 vlib_cli_output (vm, "---------- Streams ----------");
2712 vlib_cli_output (vm, "Current: %u", nstream);
2713 vlib_cli_output (vm, "Opened: %d",
2714 quic_get_counter_value (QUIC_ERROR_OPENED_STREAM));
2715 vlib_cli_output (vm, "Closed: %d",
2716 quic_get_counter_value (QUIC_ERROR_CLOSED_STREAM));
2717 vlib_cli_output (vm, "---------- Packets ----------");
2718 vlib_cli_output (vm, "RX Total: %d",
2719 quic_get_counter_value (QUIC_ERROR_RX_PACKETS));
2720 vlib_cli_output (vm, "RX 0RTT: %d",
2721 quic_get_counter_value (QUIC_ERROR_ZERO_RTT_RX_PACKETS));
2722 vlib_cli_output (vm, "RX 1RTT: %d",
2723 quic_get_counter_value (QUIC_ERROR_ONE_RTT_RX_PACKETS));
2724 vlib_cli_output (vm, "TX Total: %d",
2725 quic_get_counter_value (QUIC_ERROR_TX_PACKETS));
2726 vlib_cli_output (vm, "----------- Stats -----------");
2727 vlib_cli_output (vm, "Min RTT %f",
2728 nconn > 0 ? agg_stats.rtt.minimum / nconn : 0);
2729 vlib_cli_output (vm, "Smoothed RTT %f",
2730 nconn > 0 ? agg_stats.rtt.smoothed / nconn : 0);
2731 vlib_cli_output (vm, "Variance on RTT %f",
2732 nconn > 0 ? agg_stats.rtt.variance / nconn : 0);
2733 vlib_cli_output (vm, "Packets Received %lu",
2734 agg_stats.num_packets.received);
2735 vlib_cli_output (vm, "Packets Sent %lu", agg_stats.num_packets.sent);
2736 vlib_cli_output (vm, "Packets Lost %lu", agg_stats.num_packets.lost);
2737 vlib_cli_output (vm, "Packets Acks %lu",
2738 agg_stats.num_packets.ack_received);
2739 vlib_cli_output (vm, "RX bytes %lu", agg_stats.num_bytes.received);
2740 vlib_cli_output (vm, "TX bytes %lu", agg_stats.num_bytes.sent);
2744 quic_format_quicly_conn_id (u8 * s, va_list * args)
2746 quicly_cid_plaintext_t *mid = va_arg (*args, quicly_cid_plaintext_t *);
2747 s = format (s, "C%x_%x", mid->master_id, mid->thread_id);
2752 quic_format_quicly_stream_id (u8 * s, va_list * args)
2754 quicly_stream_t *stream = va_arg (*args, quicly_stream_t *);
2756 format (s, "%U S%lx", quic_format_quicly_conn_id,
2757 quicly_get_master_id (stream->conn), stream->stream_id);
2762 quic_format_listener_ctx (u8 * s, va_list * args)
2764 quic_ctx_t *ctx = va_arg (*args, quic_ctx_t *);
2765 s = format (s, "[#%d][%x][Listener]", ctx->c_thread_index, ctx->c_c_index);
2770 quic_format_connection_ctx (u8 * s, va_list * args)
2772 quic_ctx_t *ctx = va_arg (*args, quic_ctx_t *);
2773 quicly_stats_t quicly_stats;
2775 s = format (s, "[#%d][%x]", ctx->c_thread_index, ctx->c_c_index);
2779 s = format (s, "- no conn -\n");
2782 s = format (s, "[%U]",
2783 quic_format_quicly_conn_id, quicly_get_master_id (ctx->conn));
2784 quicly_get_stats (ctx->conn, &quicly_stats);
2786 s = format (s, "[RTT >%3d, ~%3d, V%3d, last %3d]",
2787 quicly_stats.rtt.minimum, quicly_stats.rtt.smoothed,
2788 quicly_stats.rtt.variance, quicly_stats.rtt.latest);
2789 s = format (s, " TX:%d RX:%d loss:%d ack:%d",
2790 quicly_stats.num_packets.sent,
2791 quicly_stats.num_packets.received,
2792 quicly_stats.num_packets.lost,
2793 quicly_stats.num_packets.ack_received);
2795 format (s, "\ncwnd:%u ssthresh:%u recovery_end:%lu", quicly_stats.cc.cwnd,
2796 quicly_stats.cc.ssthresh, quicly_stats.cc.recovery_end);
2798 quicly_context_t *quicly_ctx = quic_get_quicly_ctx_from_ctx (ctx);
2799 if (quicly_ctx->init_cc == &quicly_cc_cubic_init)
2803 "\nk:%d w_max:%u w_last_max:%u avoidance_start:%ld last_sent_time:%ld",
2804 quicly_stats.cc.state.cubic.k, quicly_stats.cc.state.cubic.w_max,
2805 quicly_stats.cc.state.cubic.w_last_max,
2806 quicly_stats.cc.state.cubic.avoidance_start,
2807 quicly_stats.cc.state.cubic.last_sent_time);
2809 else if (quicly_ctx->init_cc == &quicly_cc_reno_init)
2811 s = format (s, " stash:%u", quicly_stats.cc.state.reno.stash);
2818 quic_format_stream_ctx (u8 * s, va_list * args)
2820 quic_ctx_t *ctx = va_arg (*args, quic_ctx_t *);
2821 session_t *stream_session;
2822 quicly_stream_t *stream = ctx->stream;
2825 s = format (s, "[#%d][%x]", ctx->c_thread_index, ctx->c_c_index);
2826 s = format (s, "[%U]", quic_format_quicly_stream_id, stream);
2828 stream_session = session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
2829 if (!stream_session)
2831 s = format (s, "- no session -\n");
2834 txs = svm_fifo_max_dequeue (stream_session->tx_fifo);
2835 rxs = svm_fifo_max_dequeue (stream_session->rx_fifo);
2836 s = format (s, "[rx %d tx %d]\n", rxs, txs);
2840 static clib_error_t *
2841 quic_show_connections_command_fn (vlib_main_t * vm,
2842 unformat_input_t * input,
2843 vlib_cli_command_t * cmd)
2845 unformat_input_t _line_input, *line_input = &_line_input;
2846 u8 show_listeners = 0, show_conn = 0, show_stream = 0;
2847 u32 num_workers = vlib_num_workers ();
2848 quic_main_t *qm = &quic_main;
2849 clib_error_t *error = 0;
2850 quic_ctx_t *ctx = NULL;
2852 session_cli_return_if_not_enabled ();
2854 if (!unformat_user (input, unformat_line_input, line_input))
2856 quic_show_aggregated_stats (vm);
2860 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2862 if (unformat (line_input, "listener"))
2864 else if (unformat (line_input, "conn"))
2866 else if (unformat (line_input, "stream"))
2870 error = clib_error_return (0, "unknown input `%U'",
2871 format_unformat_error, line_input);
2876 for (int i = 0; i < num_workers + 1; i++)
2879 pool_foreach (ctx, qm->ctx_pool[i])
2881 if (quic_ctx_is_stream (ctx) && show_stream)
2882 vlib_cli_output (vm, "%U", quic_format_stream_ctx, ctx);
2883 else if (quic_ctx_is_listener (ctx) && show_listeners)
2884 vlib_cli_output (vm, "%U", quic_format_listener_ctx, ctx);
2885 else if (quic_ctx_is_conn (ctx) && show_conn)
2886 vlib_cli_output (vm, "%U", quic_format_connection_ctx, ctx);
2892 unformat_free (line_input);
2897 VLIB_CLI_COMMAND (quic_plugin_crypto_command, static) = {
2898 .path = "quic set crypto api",
2899 .short_help = "quic set crypto api [picotls|vpp]",
2900 .function = quic_plugin_crypto_command_fn,
2902 VLIB_CLI_COMMAND(quic_plugin_set_fifo_size_command, static)=
2904 .path = "quic set fifo-size",
2905 .short_help = "quic set fifo-size N[K|M|G] (default 64K)",
2906 .function = quic_plugin_set_fifo_size_command_fn,
2908 VLIB_CLI_COMMAND(quic_show_ctx_command, static)=
2910 .path = "show quic",
2911 .short_help = "show quic",
2912 .function = quic_show_connections_command_fn,
2914 VLIB_CLI_COMMAND (quic_list_crypto_context_command, static) =
2916 .path = "show quic crypto context",
2917 .short_help = "list quic crypto contextes",
2918 .function = quic_list_crypto_context_command_fn,
2920 VLIB_CLI_COMMAND (quic_set_max_packets_per_key, static) =
2922 .path = "set quic max_packets_per_key",
2923 .short_help = "set quic max_packets_per_key 16777216",
2924 .function = quic_set_max_packets_per_key_fn,
2926 VLIB_CLI_COMMAND (quic_set_cc, static) = {
2927 .path = "set quic cc",
2928 .short_help = "set quic cc [reno|cubic]",
2929 .function = quic_set_cc_fn,
2931 VLIB_PLUGIN_REGISTER () =
2933 .version = VPP_BUILD_VER,
2934 .description = "Quic transport protocol",
2935 .default_disabled = 1,
2939 static clib_error_t *
2940 quic_config_fn (vlib_main_t * vm, unformat_input_t * input)
2942 unformat_input_t _line_input, *line_input = &_line_input;
2943 quic_main_t *qm = &quic_main;
2944 clib_error_t *error = 0;
2948 qm->udp_fifo_size = QUIC_DEFAULT_FIFO_SIZE;
2949 qm->udp_fifo_prealloc = 0;
2950 qm->connection_timeout = QUIC_DEFAULT_CONN_TIMEOUT;
2952 if (!unformat_user (input, unformat_line_input, line_input))
2955 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2957 if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
2959 if (tmp >= 0x100000000ULL)
2961 error = clib_error_return (0,
2962 "fifo-size %llu (0x%llx) too large",
2966 qm->udp_fifo_size = tmp;
2968 else if (unformat (input, "conn-timeout %u", &i))
2969 qm->connection_timeout = i;
2970 else if (unformat (input, "fifo-prealloc %u", &i))
2971 qm->udp_fifo_prealloc = i;
2974 error = clib_error_return (0, "unknown input '%U'",
2975 format_unformat_error, line_input);
2980 unformat_free (line_input);
2984 VLIB_EARLY_CONFIG_FUNCTION (quic_config_fn, "quic");
2987 quic_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
2988 vlib_frame_t * frame)
2994 VLIB_REGISTER_NODE (quic_input_node) =
2996 .function = quic_node_fn,
2997 .name = "quic-input",
2998 .vector_size = sizeof (u32),
2999 .type = VLIB_NODE_TYPE_INTERNAL,
3000 .n_errors = ARRAY_LEN (quic_error_strings),
3001 .error_strings = quic_error_strings,
3006 * fd.io coding-style-patch-verification: ON
3009 * eval: (c-set-style "gnu")