2 * Copyright (c) 2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #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>
29 #include <quic/quic_crypto.h>
31 #include <quicly/defaults.h>
33 static char *quic_error_strings[] = {
34 #define quic_error(n,s) s,
35 #include "quic_error.def"
39 static quic_main_t quic_main;
40 static void quic_update_timer (quic_ctx_t * ctx);
41 static int quic_on_client_connected (quic_ctx_t * ctx);
44 quic_ctx_alloc (u32 thread_index)
46 quic_main_t *qm = &quic_main;
49 pool_get (qm->ctx_pool[thread_index], ctx);
51 memset (ctx, 0, sizeof (quic_ctx_t));
52 ctx->c_thread_index = thread_index;
53 QUIC_DBG (3, "Allocated quic_ctx %u on thread %u",
54 ctx - qm->ctx_pool[thread_index], thread_index);
55 return ctx - qm->ctx_pool[thread_index];
59 quic_ctx_free (quic_ctx_t * ctx)
61 QUIC_DBG (2, "Free ctx %u", ctx->c_c_index);
62 u32 thread_index = ctx->c_thread_index;
64 memset (ctx, 0xfb, sizeof (*ctx));
65 pool_put (quic_main.ctx_pool[thread_index], ctx);
69 quic_ctx_get (u32 ctx_index, u32 thread_index)
71 return pool_elt_at_index (quic_main.ctx_pool[thread_index], ctx_index);
75 quic_ctx_get_if_valid (u32 ctx_index, u32 thread_index)
77 if (pool_is_free_index (quic_main.ctx_pool[thread_index], ctx_index))
79 return pool_elt_at_index (quic_main.ctx_pool[thread_index], ctx_index);
83 quic_get_conn_ctx (quicly_conn_t * conn)
86 conn_data = (u64) * quicly_get_data (conn);
87 return quic_ctx_get (conn_data & UINT32_MAX, conn_data >> 32);
91 quic_store_conn_ctx (quicly_conn_t * conn, quic_ctx_t * ctx)
93 *quicly_get_data (conn) =
94 (void *) (((u64) ctx->c_thread_index) << 32 | (u64) ctx->c_c_index);
98 quic_ctx_is_stream (quic_ctx_t * ctx)
100 return (ctx->flags & QUIC_F_IS_STREAM);
104 quic_ctx_is_listener (quic_ctx_t * ctx)
106 return (ctx->flags & QUIC_F_IS_LISTENER);
110 get_stream_session_from_stream (quicly_stream_t * stream)
113 quic_stream_data_t *stream_data;
115 stream_data = (quic_stream_data_t *) stream->data;
116 ctx = quic_ctx_get (stream_data->ctx_id, stream_data->thread_index);
117 return session_get (ctx->c_s_index, stream_data->thread_index);
121 quic_make_connection_key (clib_bihash_kv_16_8_t * kv,
122 const quicly_cid_plaintext_t * id)
124 kv->key[0] = ((u64) id->master_id) << 32 | (u64) id->thread_id;
125 kv->key[1] = id->node_id;
129 quic_sendable_packet_count (session_t * udp_session)
132 u32 packet_size = QUIC_MAX_PACKET_SIZE + SESSION_CONN_HDR_LEN;
133 max_enqueue = svm_fifo_max_enqueue (udp_session->tx_fifo);
134 return clib_min (max_enqueue / packet_size, QUIC_SEND_PACKET_VEC_SIZE);
137 static quicly_context_t *
138 quic_get_quicly_ctx_from_ctx (quic_ctx_t * ctx)
140 app_worker_t *app_wrk;
142 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_id);
145 app = application_get (app_wrk->app_index);
146 return (quicly_context_t *) app->quicly_ctx;
149 static quicly_context_t *
150 quic_get_quicly_ctx_from_udp (u64 udp_session_handle)
152 session_t *udp_session;
154 udp_session = session_get_from_handle (udp_session_handle);
155 app = application_get (udp_session->opaque);
156 return (quicly_context_t *) app->quicly_ctx;
160 quic_ack_rx_data (session_t * stream_session)
165 quicly_stream_t *stream;
166 quic_stream_data_t *stream_data;
169 quic_ctx_get (stream_session->connection_index,
170 stream_session->thread_index);
171 ASSERT (quic_ctx_is_stream (sctx));
172 stream = sctx->stream;
173 stream_data = (quic_stream_data_t *) stream->data;
175 f = stream_session->rx_fifo;
176 max_deq = svm_fifo_max_dequeue (f);
178 ASSERT (stream_data->app_rx_data_len >= max_deq);
179 quicly_stream_sync_recvbuf (stream, stream_data->app_rx_data_len - max_deq);
180 QUIC_DBG (3, "Acking %u bytes", stream_data->app_rx_data_len - max_deq);
181 stream_data->app_rx_data_len = max_deq;
185 quic_disconnect_transport (quic_ctx_t * ctx)
187 QUIC_DBG (2, "Disconnecting transport 0x%lx", ctx->udp_session_handle);
188 vnet_disconnect_args_t a = {
189 .handle = ctx->udp_session_handle,
190 .app_index = quic_main.app_index,
193 if (vnet_disconnect_session (&a))
194 clib_warning ("UDP session 0x%lx disconnect errored",
195 ctx->udp_session_handle);
199 quic_connection_delete (quic_ctx_t * ctx)
201 tw_timer_wheel_1t_3w_1024sl_ov_t *tw;
202 clib_bihash_kv_16_8_t kv;
205 QUIC_DBG (2, "Deleting connection %u", ctx->c_c_index);
207 ASSERT (!quic_ctx_is_stream (ctx));
210 if (ctx->timer_handle != QUIC_TIMER_HANDLE_INVALID)
212 tw = &quic_main.wrk_ctx[ctx->c_thread_index].timer_wheel;
213 tw_timer_stop_1t_3w_1024sl_ov (tw, ctx->timer_handle);
216 /* Delete the connection from the connection map */
218 quic_make_connection_key (&kv, quicly_get_master_id (conn));
219 QUIC_DBG (2, "Deleting conn with id %lu %lu from map", kv.key[0],
221 clib_bihash_add_del_16_8 (&quic_main.connection_hash, &kv, 0 /* is_add */ );
223 quic_disconnect_transport (ctx);
226 quicly_free (ctx->conn);
229 session_transport_delete_notify (&ctx->connection);
234 quic_increment_counter (u8 evt, u8 val)
236 vlib_main_t *vm = vlib_get_main ();
237 vlib_node_increment_counter (vm, quic_input_node.index, evt, val);
243 * Called when quicly return an error
244 * This function interacts tightly with quic_proto_on_close
247 quic_connection_closed (quic_ctx_t * ctx)
249 QUIC_DBG (2, "QUIC connection %u/%u closed", ctx->c_thread_index,
252 /* TODO if connection is not established, just delete the session? */
253 /* Actually should send connect or accept error */
255 switch (ctx->conn_state)
257 case QUIC_CONN_STATE_READY:
258 /* Error on an opened connection (timeout...)
259 This puts the session in closing state, we should receive a notification
260 when the app has closed its session */
261 session_transport_reset_notify (&ctx->connection);
262 /* This ensures we delete the connection when the app confirms the close */
263 ctx->conn_state = QUIC_CONN_STATE_PASSIVE_CLOSING_QUIC_CLOSED;
265 case QUIC_CONN_STATE_PASSIVE_CLOSING:
266 ctx->conn_state = QUIC_CONN_STATE_PASSIVE_CLOSING_QUIC_CLOSED;
267 /* quic_proto_on_close will eventually be called when the app confirms the close
268 , we delete the connection at that point */
270 case QUIC_CONN_STATE_PASSIVE_CLOSING_APP_CLOSED:
271 /* App already confirmed close, we can delete the connection */
272 session_transport_delete_notify (&ctx->connection);
273 quic_connection_delete (ctx);
275 case QUIC_CONN_STATE_PASSIVE_CLOSING_QUIC_CLOSED:
278 case QUIC_CONN_STATE_ACTIVE_CLOSING:
279 session_transport_delete_notify (&ctx->connection);
280 quic_connection_delete (ctx);
289 quic_send_datagram (session_t * udp_session, quicly_datagram_t * packet)
292 session_dgram_hdr_t hdr;
295 transport_connection_t *tc;
297 len = packet->data.len;
298 f = udp_session->tx_fifo;
299 tc = session_get_transport (udp_session);
300 max_enqueue = svm_fifo_max_enqueue (f);
301 if (max_enqueue < SESSION_CONN_HDR_LEN + len)
303 QUIC_DBG (1, "Too much data to send, max_enqueue %u, len %u",
304 max_enqueue, len + SESSION_CONN_HDR_LEN);
305 return QUIC_ERROR_FULL_FIFO;
308 /* Build packet header for fifo */
309 hdr.data_length = len;
311 hdr.is_ip4 = tc->is_ip4;
312 clib_memcpy (&hdr.lcl_ip, &tc->lcl_ip, sizeof (ip46_address_t));
313 hdr.lcl_port = tc->lcl_port;
315 /* Read dest address from quicly-provided sockaddr */
318 ASSERT (packet->dest.sa.sa_family == AF_INET);
319 struct sockaddr_in *sa4 = (struct sockaddr_in *) &packet->dest.sa;
320 hdr.rmt_port = sa4->sin_port;
321 hdr.rmt_ip.ip4.as_u32 = sa4->sin_addr.s_addr;
325 ASSERT (packet->dest.sa.sa_family == AF_INET6);
326 struct sockaddr_in6 *sa6 = (struct sockaddr_in6 *) &packet->dest.sa;
327 hdr.rmt_port = sa6->sin6_port;
328 clib_memcpy (&hdr.rmt_ip.ip6, &sa6->sin6_addr, 16);
331 ret = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
332 if (ret != sizeof (hdr))
334 QUIC_DBG (1, "Not enough space to enqueue header");
335 return QUIC_ERROR_FULL_FIFO;
337 ret = svm_fifo_enqueue (f, len, packet->data.base);
340 QUIC_DBG (1, "Not enough space to enqueue payload");
341 return QUIC_ERROR_FULL_FIFO;
344 quic_increment_counter (QUIC_ERROR_TX_PACKETS, 1);
350 quic_send_packets (quic_ctx_t * ctx)
352 quicly_datagram_t *packets[QUIC_SEND_PACKET_VEC_SIZE];
353 session_t *udp_session;
355 size_t num_packets, i, max_packets;
356 quicly_packet_allocator_t *pa;
357 quicly_context_t *quicly_context;
360 /* We have sctx, get qctx */
361 if (quic_ctx_is_stream (ctx))
362 ctx = quic_ctx_get (ctx->quic_connection_ctx_id, ctx->c_thread_index);
364 ASSERT (!quic_ctx_is_stream (ctx));
366 udp_session = session_get_from_handle_if_valid (ctx->udp_session_handle);
375 /* TODO : quicly can assert it can send min_packets up to 2 */
376 if (quic_sendable_packet_count (udp_session) < 2)
379 quicly_context = quic_get_quicly_ctx_from_ctx (ctx);
382 clib_warning ("Tried to send packets on non existing app worker %u",
383 ctx->parent_app_wrk_id);
384 quic_connection_delete (ctx);
387 pa = quicly_context->packet_allocator;
390 max_packets = quic_sendable_packet_count (udp_session);
393 num_packets = max_packets;
394 if ((err = quicly_send (conn, packets, &num_packets)))
397 for (i = 0; i != num_packets; ++i)
399 if ((err = quic_send_datagram (udp_session, packets[i])))
402 pa->free_packet (pa, packets[i]);
405 while (num_packets > 0 && num_packets == max_packets);
408 if (svm_fifo_set_event (udp_session->tx_fifo))
410 session_send_io_evt_to_thread (udp_session->tx_fifo,
412 clib_warning ("Event enqueue errored %d", err);
414 QUIC_DBG (3, "%u[TX] %u[RX]", svm_fifo_max_dequeue (udp_session->tx_fifo),
415 svm_fifo_max_dequeue (udp_session->rx_fifo));
416 quic_update_timer (ctx);
420 if (err && err != QUICLY_ERROR_PACKET_IGNORED
421 && err != QUICLY_ERROR_FREE_CONNECTION)
422 clib_warning ("Quic error '%U'.", quic_format_err, err);
423 quic_connection_closed (ctx);
427 /*****************************************************************************
429 * START QUICLY CALLBACKS
430 * Called from QUIC lib
432 *****************************************************************************/
435 quic_on_stream_destroy (quicly_stream_t * stream, int err)
437 quic_stream_data_t *stream_data = (quic_stream_data_t *) stream->data;
439 quic_ctx_get (stream_data->ctx_id, stream_data->thread_index);
440 session_t *stream_session =
441 session_get (sctx->c_s_index, sctx->c_thread_index);
442 QUIC_DBG (2, "DESTROYED_STREAM: session 0x%lx (%U)",
443 session_handle (stream_session), quic_format_err, err);
445 stream_session->session_state = SESSION_STATE_CLOSED;
446 session_transport_delete_notify (&sctx->connection);
448 quic_ctx_free (sctx);
453 quic_on_stop_sending (quicly_stream_t * stream, int err)
456 quic_stream_data_t *stream_data = (quic_stream_data_t *) stream->data;
458 quic_ctx_get (stream_data->ctx_id, stream_data->thread_index);
459 session_t *stream_session =
460 session_get (sctx->c_s_index, sctx->c_thread_index);
461 clib_warning ("(NOT IMPLEMENTD) STOP_SENDING: session 0x%lx (%U)",
462 session_handle (stream_session), quic_format_err, err);
464 /* TODO : handle STOP_SENDING */
469 quic_on_receive_reset (quicly_stream_t * stream, int err)
471 quic_stream_data_t *stream_data = (quic_stream_data_t *) stream->data;
473 quic_ctx_get (stream_data->ctx_id, stream_data->thread_index);
475 session_t *stream_session =
476 session_get (sctx->c_s_index, sctx->c_thread_index);
477 clib_warning ("RESET_STREAM: session 0x%lx (%U)",
478 session_handle (stream_session), quic_format_err, err);
480 session_transport_closing_notify (&sctx->connection);
485 quic_on_receive (quicly_stream_t * stream, size_t off, const void *src,
488 QUIC_DBG (3, "received data: %lu bytes, offset %lu", len, off);
491 session_t *stream_session;
492 app_worker_t *app_wrk;
494 quic_stream_data_t *stream_data;
497 stream_data = (quic_stream_data_t *) stream->data;
498 sctx = quic_ctx_get (stream_data->ctx_id, stream_data->thread_index);
499 stream_session = session_get (sctx->c_s_index, stream_data->thread_index);
500 f = stream_session->rx_fifo;
502 max_enq = svm_fifo_max_enqueue_prod (f);
503 QUIC_DBG (3, "Enqueuing %u at off %u in %u space", len, off, max_enq);
504 if (off - stream_data->app_rx_data_len + len > max_enq)
506 QUIC_DBG (1, "Error RX fifo is full");
509 if (off == stream_data->app_rx_data_len)
511 /* Streams live on the same thread so (f, stream_data) should stay consistent */
512 rlen = svm_fifo_enqueue (f, len, (u8 *) src);
513 stream_data->app_rx_data_len += rlen;
514 ASSERT (rlen >= len);
515 app_wrk = app_worker_get_if_valid (stream_session->app_wrk_index);
516 if (PREDICT_TRUE (app_wrk != 0))
517 app_worker_lock_and_send_event (app_wrk, stream_session,
519 quic_ack_rx_data (stream_session);
524 svm_fifo_enqueue_with_offset (f, off - stream_data->app_rx_data_len,
532 quic_fifo_egress_shift (quicly_stream_t * stream, size_t delta)
534 session_t *stream_session;
538 stream_session = get_stream_session_from_stream (stream);
539 f = stream_session->tx_fifo;
541 rv = svm_fifo_dequeue_drop (f, delta);
542 ASSERT (rv == delta);
543 quicly_stream_sync_sendbuf (stream, 0);
547 quic_fifo_egress_emit (quicly_stream_t * stream, size_t off, void *dst,
548 size_t * len, int *wrote_all)
550 session_t *stream_session;
552 u32 deq_max, first_deq, max_rd_chunk, rem_offset;
554 stream_session = get_stream_session_from_stream (stream);
555 f = stream_session->tx_fifo;
557 QUIC_DBG (3, "Emitting %u, offset %u", *len, off);
559 deq_max = svm_fifo_max_dequeue_cons (f);
560 ASSERT (off <= deq_max);
561 if (off + *len < deq_max)
568 *len = deq_max - off;
569 QUIC_DBG (3, "Wrote ALL, %u", *len);
572 /* TODO, use something like : return svm_fifo_peek (f, off, *len, dst); */
573 max_rd_chunk = svm_fifo_max_read_chunk (f);
576 if (off < max_rd_chunk)
578 first_deq = clib_min (*len, max_rd_chunk - off);
579 clib_memcpy_fast (dst, svm_fifo_head (f) + off, first_deq);
582 if (max_rd_chunk < off + *len)
584 rem_offset = max_rd_chunk < off ? off - max_rd_chunk : 0;
585 clib_memcpy_fast (dst + first_deq, f->head_chunk->data + rem_offset,
592 static const quicly_stream_callbacks_t quic_stream_callbacks = {
593 .on_destroy = quic_on_stream_destroy,
594 .on_send_shift = quic_fifo_egress_shift,
595 .on_send_emit = quic_fifo_egress_emit,
596 .on_send_stop = quic_on_stop_sending,
597 .on_receive = quic_on_receive,
598 .on_receive_reset = quic_on_receive_reset
602 quic_accept_stream (void *s)
604 quicly_stream_t *stream = (quicly_stream_t *) s;
605 session_t *stream_session, *quic_session;
606 quic_stream_data_t *stream_data;
607 app_worker_t *app_wrk;
608 quic_ctx_t *qctx, *sctx;
612 sctx_id = quic_ctx_alloc (vlib_get_thread_index ());
614 qctx = quic_get_conn_ctx (stream->conn);
616 /* Might need to signal that the connection is ready if the first thing the
617 * server does is open a stream */
618 if (qctx->conn_state == QUIC_CONN_STATE_HANDSHAKE)
620 if (quicly_connection_is_ready (qctx->conn))
622 qctx->conn_state = QUIC_CONN_STATE_READY;
623 if (quicly_is_client (qctx->conn))
625 quic_on_client_connected (qctx);
626 /* ctx might be invalidated */
627 qctx = quic_get_conn_ctx (stream->conn);
632 stream_session = session_alloc (qctx->c_thread_index);
633 QUIC_DBG (2, "ACCEPTED stream_session 0x%lx ctx %u",
634 session_handle (stream_session), sctx_id);
635 sctx = quic_ctx_get (sctx_id, qctx->c_thread_index);
636 sctx->parent_app_wrk_id = qctx->parent_app_wrk_id;
637 sctx->parent_app_id = qctx->parent_app_id;
638 sctx->quic_connection_ctx_id = qctx->c_c_index;
639 sctx->c_c_index = sctx_id;
640 sctx->c_s_index = stream_session->session_index;
641 sctx->stream = stream;
642 sctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
643 sctx->flags |= QUIC_F_IS_STREAM;
645 stream_data = (quic_stream_data_t *) stream->data;
646 stream_data->ctx_id = sctx_id;
647 stream_data->thread_index = sctx->c_thread_index;
648 stream_data->app_rx_data_len = 0;
650 sctx->c_s_index = stream_session->session_index;
651 stream_session->session_state = SESSION_STATE_CREATED;
652 stream_session->app_wrk_index = sctx->parent_app_wrk_id;
653 stream_session->connection_index = sctx->c_c_index;
654 stream_session->session_type =
655 session_type_from_proto_and_ip (TRANSPORT_PROTO_QUIC, qctx->udp_is_ip4);
656 quic_session = session_get (qctx->c_s_index, qctx->c_thread_index);
657 stream_session->listener_handle = listen_session_get_handle (quic_session);
659 app_wrk = app_worker_get (stream_session->app_wrk_index);
660 if ((rv = app_worker_init_connected (app_wrk, stream_session)))
662 QUIC_DBG (1, "failed to allocate fifos");
663 session_free (stream_session);
664 quicly_reset_stream (stream, QUIC_APP_ALLOCATION_ERROR);
667 svm_fifo_add_want_deq_ntf (stream_session->rx_fifo,
668 SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL |
669 SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY);
671 if ((rv = app_worker_accept_notify (app_wrk, stream_session)))
673 QUIC_DBG (1, "failed to notify accept worker app");
674 session_free_w_fifos (stream_session);
675 quicly_reset_stream (stream, QUIC_APP_ACCEPT_NOTIFY_ERROR);
681 quic_on_stream_open (quicly_stream_open_t * self, quicly_stream_t * stream)
683 QUIC_DBG (2, "on_stream_open called");
684 stream->data = malloc (sizeof (quic_stream_data_t));
685 stream->callbacks = &quic_stream_callbacks;
686 /* Notify accept on parent qsession, but only if this is not a locally
687 * initiated stream */
688 if (!quicly_stream_is_self_initiated (stream))
689 quic_accept_stream (stream);
694 quic_on_closed_by_peer (quicly_closed_by_peer_t * self, quicly_conn_t * conn,
695 int code, uint64_t frame_type,
696 const char *reason, size_t reason_len)
698 quic_ctx_t *ctx = quic_get_conn_ctx (conn);
700 session_t *quic_session = session_get (ctx->c_s_index, ctx->c_thread_index);
701 clib_warning ("Session 0x%lx closed by peer (%U) %.*s ",
702 session_handle (quic_session), quic_format_err, code,
705 ctx->conn_state = QUIC_CONN_STATE_PASSIVE_CLOSING;
706 session_transport_closing_notify (&ctx->connection);
709 static quicly_stream_open_t on_stream_open = { &quic_on_stream_open };
710 static quicly_closed_by_peer_t on_closed_by_peer =
711 { &quic_on_closed_by_peer };
714 /*****************************************************************************
716 * END QUICLY CALLBACKS
718 *****************************************************************************/
720 /*****************************************************************************
722 * BEGIN TIMERS HANDLING
724 *****************************************************************************/
727 quic_get_thread_time (u8 thread_index)
729 return quic_main.wrk_ctx[thread_index].time_now;
733 quic_get_time (quicly_now_t * self)
735 u8 thread_index = vlib_get_thread_index ();
736 return quic_get_thread_time (thread_index);
739 static quicly_now_t quicly_vpp_now_cb = { quic_get_time };
742 quic_set_time_now (u32 thread_index)
744 vlib_main_t *vlib_main = vlib_get_main ();
745 f64 time = vlib_time_now (vlib_main);
746 quic_main.wrk_ctx[thread_index].time_now = (int64_t) (time * 1000.f);
747 return quic_main.wrk_ctx[thread_index].time_now;
750 /* Transport proto callback */
752 quic_update_time (f64 now, u8 thread_index)
754 tw_timer_wheel_1t_3w_1024sl_ov_t *tw;
756 tw = &quic_main.wrk_ctx[thread_index].timer_wheel;
757 quic_set_time_now (thread_index);
758 tw_timer_expire_timers_1t_3w_1024sl_ov (tw, now);
762 quic_timer_expired (u32 conn_index)
765 QUIC_DBG (4, "Timer expired for conn %u at %ld", conn_index,
766 quic_get_time (NULL));
767 ctx = quic_ctx_get (conn_index, vlib_get_thread_index ());
768 ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
769 quic_send_packets (ctx);
773 quic_update_timer (quic_ctx_t * ctx)
775 tw_timer_wheel_1t_3w_1024sl_ov_t *tw;
776 int64_t next_timeout, next_interval;
777 session_t *quic_session;
779 /* This timeout is in ms which is the unit of our timer */
780 next_timeout = quicly_get_first_timeout (ctx->conn);
781 next_interval = next_timeout - quic_get_time (NULL);
783 if (next_timeout == 0 || next_interval <= 0)
785 if (ctx->c_s_index == QUIC_SESSION_INVALID)
791 quic_session = session_get (ctx->c_s_index, ctx->c_thread_index);
792 if (svm_fifo_set_event (quic_session->tx_fifo))
793 session_send_io_evt_to_thread_custom (quic_session,
794 quic_session->thread_index,
795 SESSION_IO_EVT_BUILTIN_TX);
800 tw = &quic_main.wrk_ctx[vlib_get_thread_index ()].timer_wheel;
802 QUIC_DBG (4, "Timer set to %ld (int %ld) for ctx %u", next_timeout,
803 next_interval, ctx->c_c_index);
805 if (ctx->timer_handle == QUIC_TIMER_HANDLE_INVALID)
807 if (next_timeout == INT64_MAX)
809 QUIC_DBG (4, "timer for ctx %u already stopped", ctx->c_c_index);
813 tw_timer_start_1t_3w_1024sl_ov (tw, ctx->c_c_index, 0, next_interval);
817 if (next_timeout == INT64_MAX)
819 tw_timer_stop_1t_3w_1024sl_ov (tw, ctx->timer_handle);
820 ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
821 QUIC_DBG (4, "Stopping timer for ctx %u", ctx->c_c_index);
824 tw_timer_update_1t_3w_1024sl_ov (tw, ctx->timer_handle,
831 quic_expired_timers_dispatch (u32 * expired_timers)
835 for (i = 0; i < vec_len (expired_timers); i++)
837 quic_timer_expired (expired_timers[i]);
841 /*****************************************************************************
843 * END TIMERS HANDLING
845 *****************************************************************************/
848 quic_encrypt_ticket_cb (ptls_encrypt_ticket_t * _self, ptls_t * tls,
849 int is_encrypt, ptls_buffer_t * dst, ptls_iovec_t src)
851 quic_session_cache_t *self = (void *) _self;
857 /* replace the cached entry along with a newly generated session id */
858 free (self->data.base);
859 if ((self->data.base = malloc (src.len)) == NULL)
860 return PTLS_ERROR_NO_MEMORY;
862 ptls_get_context (tls)->random_bytes (self->id, sizeof (self->id));
863 memcpy (self->data.base, src.base, src.len);
864 self->data.len = src.len;
866 /* store the session id in buffer */
867 if ((ret = ptls_buffer_reserve (dst, sizeof (self->id))) != 0)
869 memcpy (dst->base + dst->off, self->id, sizeof (self->id));
870 dst->off += sizeof (self->id);
876 /* check if session id is the one stored in cache */
877 if (src.len != sizeof (self->id))
878 return PTLS_ERROR_SESSION_NOT_FOUND;
879 if (memcmp (self->id, src.base, sizeof (self->id)) != 0)
880 return PTLS_ERROR_SESSION_NOT_FOUND;
882 /* return the cached value */
883 if ((ret = ptls_buffer_reserve (dst, self->data.len)) != 0)
885 memcpy (dst->base + dst->off, self->data.base, self->data.len);
886 dst->off += self->data.len;
892 typedef struct quicly_ctx_data_
894 quicly_context_t quicly_ctx;
896 ptls_context_t ptls_ctx;
900 quic_store_quicly_ctx (application_t * app, u8 is_client)
902 quic_main_t *qm = &quic_main;
903 quicly_context_t *quicly_ctx;
904 ptls_iovec_t key_vec;
908 quicly_ctx_data_t *quicly_ctx_data =
909 clib_mem_alloc (sizeof (quicly_ctx_data_t));
910 clib_memset (quicly_ctx_data, 0, sizeof (*quicly_ctx_data)); /* picotls depends on this */
911 quicly_ctx = &quicly_ctx_data->quicly_ctx;
912 ptls_context_t *ptls_ctx = &quicly_ctx_data->ptls_ctx;
913 ptls_ctx->random_bytes = ptls_openssl_random_bytes;
914 ptls_ctx->get_time = &ptls_get_time;
915 ptls_ctx->key_exchanges = ptls_openssl_key_exchanges;
916 ptls_ctx->cipher_suites = qm->quic_ciphers[qm->default_cipher];
917 ptls_ctx->certificates.list = NULL;
918 ptls_ctx->certificates.count = 0;
919 ptls_ctx->esni = NULL;
920 ptls_ctx->on_client_hello = NULL;
921 ptls_ctx->emit_certificate = NULL;
922 ptls_ctx->sign_certificate = NULL;
923 ptls_ctx->verify_certificate = NULL;
924 ptls_ctx->ticket_lifetime = 86400;
925 ptls_ctx->max_early_data_size = 8192;
926 ptls_ctx->hkdf_label_prefix__obsolete = NULL;
927 ptls_ctx->require_dhe_on_psk = 1;
928 ptls_ctx->encrypt_ticket = &qm->session_cache.super;
930 app->quicly_ctx = (u64 *) quicly_ctx;
931 memcpy (quicly_ctx, &quicly_spec_context, sizeof (quicly_context_t));
933 quicly_ctx->max_packet_size = QUIC_MAX_PACKET_SIZE;
934 quicly_ctx->tls = ptls_ctx;
935 quicly_ctx->stream_open = &on_stream_open;
936 quicly_ctx->closed_by_peer = &on_closed_by_peer;
937 quicly_ctx->now = &quicly_vpp_now_cb;
938 quicly_amend_ptls_context (quicly_ctx->tls);
940 quicly_ctx->transport_params.max_data = QUIC_INT_MAX;
941 quicly_ctx->transport_params.max_streams_uni = (uint64_t) 1 << 60;
942 quicly_ctx->transport_params.max_streams_bidi = (uint64_t) 1 << 60;
943 quicly_ctx->transport_params.max_stream_data.bidi_local = (qm->udp_fifo_size - 1); /* max_enq is SIZE - 1 */
944 quicly_ctx->transport_params.max_stream_data.bidi_remote = (qm->udp_fifo_size - 1); /* max_enq is SIZE - 1 */
945 quicly_ctx->transport_params.max_stream_data.uni = QUIC_INT_MAX;
947 quicly_ctx->tls->random_bytes (quicly_ctx_data->cid_key, 16);
948 quicly_ctx_data->cid_key[16] = 0;
950 ptls_iovec_init (quicly_ctx_data->cid_key,
951 strlen (quicly_ctx_data->cid_key));
952 quicly_ctx->cid_encryptor =
953 quicly_new_default_cid_encryptor (&ptls_openssl_bfecb,
954 &ptls_openssl_aes128ecb,
955 &ptls_openssl_sha256, key_vec);
958 if (app->tls_key != NULL && app->tls_cert != NULL)
960 if (load_bio_private_key (quicly_ctx->tls, (char *) app->tls_key))
962 QUIC_DBG (1, "failed to read private key from app configuration\n");
964 if (load_bio_certificate_chain (quicly_ctx->tls,
965 (char *) app->tls_cert))
967 QUIC_DBG (1, "failed to load certificate\n");
972 /*****************************************************************************
974 * BEGIN TRANSPORT PROTO FUNCTIONS
976 *****************************************************************************/
979 quic_connect_new_stream (session_t * quic_session, u32 opaque)
981 uint64_t quic_session_handle;
982 session_t *stream_session;
983 quic_stream_data_t *stream_data;
984 quicly_stream_t *stream;
986 app_worker_t *app_wrk;
987 quic_ctx_t *qctx, *sctx;
991 /* Find base session to which the user want to attach a stream */
992 quic_session_handle = session_handle (quic_session);
993 QUIC_DBG (2, "Opening new stream (qsession %u)", quic_session_handle);
995 if (session_type_transport_proto (quic_session->session_type) !=
996 TRANSPORT_PROTO_QUIC)
998 QUIC_DBG (1, "received incompatible session");
1002 app_wrk = app_worker_get_if_valid (quic_session->app_wrk_index);
1005 QUIC_DBG (1, "Invalid app worker :(");
1009 sctx_index = quic_ctx_alloc (quic_session->thread_index); /* Allocate before we get pointers */
1010 sctx = quic_ctx_get (sctx_index, quic_session->thread_index);
1012 quic_ctx_get (quic_session->connection_index, quic_session->thread_index);
1013 if (quic_ctx_is_stream (qctx))
1015 QUIC_DBG (1, "session is a stream");
1016 quic_ctx_free (sctx);
1020 sctx->parent_app_wrk_id = qctx->parent_app_wrk_id;
1021 sctx->parent_app_id = qctx->parent_app_id;
1022 sctx->quic_connection_ctx_id = qctx->c_c_index;
1023 sctx->c_c_index = sctx_index;
1024 sctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1025 sctx->flags |= QUIC_F_IS_STREAM;
1029 if (!conn || !quicly_connection_is_ready (conn))
1032 if ((rv = quicly_open_stream (conn, &stream, 0 /* uni */ )))
1034 QUIC_DBG (2, "Stream open failed with %d", rv);
1037 sctx->stream = stream;
1039 QUIC_DBG (2, "Opened stream %d, creating session", stream->stream_id);
1041 stream_session = session_alloc (qctx->c_thread_index);
1042 QUIC_DBG (2, "Allocated stream_session 0x%lx ctx %u",
1043 session_handle (stream_session), sctx_index);
1044 stream_session->app_wrk_index = app_wrk->wrk_index;
1045 stream_session->connection_index = sctx_index;
1046 stream_session->listener_handle = quic_session_handle;
1047 stream_session->session_type =
1048 session_type_from_proto_and_ip (TRANSPORT_PROTO_QUIC, qctx->udp_is_ip4);
1050 sctx->c_s_index = stream_session->session_index;
1052 if (app_worker_init_connected (app_wrk, stream_session))
1054 QUIC_DBG (1, "failed to app_worker_init_connected");
1055 quicly_reset_stream (stream, QUIC_APP_ALLOCATION_ERROR);
1056 session_free_w_fifos (stream_session);
1057 quic_ctx_free (sctx);
1058 return app_worker_connect_notify (app_wrk, NULL, opaque);
1061 svm_fifo_add_want_deq_ntf (stream_session->rx_fifo,
1062 SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL |
1063 SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY);
1065 stream_session->session_state = SESSION_STATE_READY;
1066 if (app_worker_connect_notify (app_wrk, stream_session, opaque))
1068 QUIC_DBG (1, "failed to notify app");
1069 quicly_reset_stream (stream, QUIC_APP_CONNECT_NOTIFY_ERROR);
1070 session_free_w_fifos (stream_session);
1071 quic_ctx_free (sctx);
1074 stream_data = (quic_stream_data_t *) stream->data;
1075 stream_data->ctx_id = sctx->c_c_index;
1076 stream_data->thread_index = sctx->c_thread_index;
1077 stream_data->app_rx_data_len = 0;
1082 quic_connect_new_connection (session_endpoint_cfg_t * sep)
1084 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1085 quic_main_t *qm = &quic_main;
1087 app_worker_t *app_wrk;
1092 ctx_index = quic_ctx_alloc (vlib_get_thread_index ());
1093 ctx = quic_ctx_get (ctx_index, vlib_get_thread_index ());
1094 ctx->parent_app_wrk_id = sep->app_wrk_index;
1095 ctx->c_s_index = QUIC_SESSION_INVALID;
1096 ctx->c_c_index = ctx_index;
1097 ctx->udp_is_ip4 = sep->is_ip4;
1098 ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
1099 ctx->conn_state = QUIC_CONN_STATE_HANDSHAKE;
1100 ctx->client_opaque = sep->opaque;
1101 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1103 ctx->srv_hostname = format (0, "%v", sep->hostname);
1105 /* needed by quic for crypto + determining client / server */
1107 format (0, "%U", format_ip46_address, &sep->ip, sep->is_ip4);
1108 vec_terminate_c_string (ctx->srv_hostname);
1110 clib_memcpy (&cargs->sep, sep, sizeof (session_endpoint_cfg_t));
1111 cargs->sep.transport_proto = TRANSPORT_PROTO_UDPC;
1112 cargs->app_index = qm->app_index;
1113 cargs->api_context = ctx_index;
1115 app_wrk = app_worker_get (sep->app_wrk_index);
1116 app = application_get (app_wrk->app_index);
1117 ctx->parent_app_id = app_wrk->app_index;
1118 cargs->sep_ext.ns_index = app->ns_index;
1120 quic_store_quicly_ctx (app, 1 /* is client */ );
1122 if ((error = vnet_connect (cargs)))
1129 quic_connect (transport_endpoint_cfg_t * tep)
1131 QUIC_DBG (2, "Called quic_connect");
1132 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) tep;
1133 session_t *quic_session;
1134 sep = (session_endpoint_cfg_t *) tep;
1136 quic_session = session_get_from_handle_if_valid (sep->parent_handle);
1138 return quic_connect_new_stream (quic_session, sep->opaque);
1140 return quic_connect_new_connection (sep);
1144 quic_proto_on_close (u32 ctx_index, u32 thread_index)
1146 quic_ctx_t *ctx = quic_ctx_get_if_valid (ctx_index, thread_index);
1150 session_t *stream_session =
1151 session_get (ctx->c_s_index, ctx->c_thread_index);
1152 clib_warning ("Closing session 0x%lx", session_handle (stream_session));
1154 if (quic_ctx_is_stream (ctx))
1156 quicly_stream_t *stream = ctx->stream;
1157 quicly_reset_stream (stream, QUIC_APP_ERROR_CLOSE_NOTIFY);
1158 quic_send_packets (ctx);
1162 switch (ctx->conn_state)
1164 case QUIC_CONN_STATE_READY:
1165 ctx->conn_state = QUIC_CONN_STATE_ACTIVE_CLOSING;
1166 quicly_conn_t *conn = ctx->conn;
1167 /* Start connection closing. Keep sending packets until quicly_send
1168 returns QUICLY_ERROR_FREE_CONNECTION */
1169 quicly_close (conn, QUIC_APP_ERROR_CLOSE_NOTIFY, "Closed by peer");
1170 /* This also causes all streams to be closed (and the cb called) */
1171 quic_send_packets (ctx);
1173 case QUIC_CONN_STATE_PASSIVE_CLOSING:
1174 ctx->conn_state = QUIC_CONN_STATE_PASSIVE_CLOSING_APP_CLOSED;
1175 /* send_packets will eventually return an error, we delete the conn at
1178 case QUIC_CONN_STATE_PASSIVE_CLOSING_QUIC_CLOSED:
1179 quic_connection_delete (ctx);
1182 QUIC_DBG (0, "BUG");
1188 quic_start_listen (u32 quic_listen_session_index, transport_endpoint_t * tep)
1190 vnet_listen_args_t _bargs, *args = &_bargs;
1191 quic_main_t *qm = &quic_main;
1192 session_handle_t udp_handle;
1193 session_endpoint_cfg_t *sep;
1194 session_t *udp_listen_session;
1195 app_worker_t *app_wrk;
1199 app_listener_t *app_listener;
1201 sep = (session_endpoint_cfg_t *) tep;
1202 app_wrk = app_worker_get (sep->app_wrk_index);
1203 /* We need to call this because we call app_worker_init_connected in
1204 * quic_accept_stream, which assumes the connect segment manager exists */
1205 app_worker_alloc_connects_segment_manager (app_wrk);
1206 app = application_get (app_wrk->app_index);
1207 QUIC_DBG (2, "Called quic_start_listen for app %d", app_wrk->app_index);
1209 quic_store_quicly_ctx (app, 0 /* is_client */ );
1211 sep->transport_proto = TRANSPORT_PROTO_UDPC;
1212 memset (args, 0, sizeof (*args));
1213 args->app_index = qm->app_index;
1214 args->sep_ext = *sep;
1215 args->sep_ext.ns_index = app->ns_index;
1216 if (vnet_listen (args))
1219 lctx_index = quic_ctx_alloc (0);
1220 udp_handle = args->handle;
1221 app_listener = app_listener_get_w_handle (udp_handle);
1222 udp_listen_session = app_listener_get_session (app_listener);
1223 udp_listen_session->opaque = lctx_index;
1225 lctx = quic_ctx_get (lctx_index, 0);
1226 lctx->flags |= QUIC_F_IS_LISTENER;
1228 clib_memcpy (&lctx->c_rmt_ip, &args->sep.peer.ip, sizeof (ip46_address_t));
1229 clib_memcpy (&lctx->c_lcl_ip, &args->sep.ip, sizeof (ip46_address_t));
1230 lctx->c_rmt_port = args->sep.peer.port;
1231 lctx->c_lcl_port = args->sep.port;
1232 lctx->c_is_ip4 = args->sep.is_ip4;
1233 lctx->c_fib_index = args->sep.fib_index;
1234 lctx->c_proto = TRANSPORT_PROTO_QUIC;
1235 lctx->parent_app_wrk_id = sep->app_wrk_index;
1236 lctx->parent_app_id = app_wrk->app_index;
1237 lctx->udp_session_handle = udp_handle;
1238 lctx->c_s_index = quic_listen_session_index;
1240 QUIC_DBG (2, "Listening UDP session 0x%lx",
1241 session_handle (udp_listen_session));
1242 QUIC_DBG (2, "Listening QUIC session 0x%lx", quic_listen_session_index);
1247 quic_stop_listen (u32 lctx_index)
1249 QUIC_DBG (2, "Called quic_stop_listen");
1251 lctx = quic_ctx_get (lctx_index, 0);
1252 ASSERT (quic_ctx_is_listener (lctx));
1253 vnet_unlisten_args_t a = {
1254 .handle = lctx->udp_session_handle,
1255 .app_index = quic_main.app_index,
1256 .wrk_map_index = 0 /* default wrk */
1258 if (vnet_unlisten (&a))
1259 clib_warning ("unlisten errored");
1261 /* TODO: crypto state cleanup */
1263 quic_ctx_free (lctx);
1267 static transport_connection_t *
1268 quic_connection_get (u32 ctx_index, u32 thread_index)
1271 ctx = quic_ctx_get (ctx_index, thread_index);
1272 return &ctx->connection;
1275 static transport_connection_t *
1276 quic_listener_get (u32 listener_index)
1278 QUIC_DBG (2, "Called quic_listener_get");
1280 ctx = quic_ctx_get (listener_index, 0);
1281 return &ctx->connection;
1285 format_quic_ctx (u8 * s, va_list * args)
1287 quic_ctx_t *ctx = va_arg (*args, quic_ctx_t *);
1288 u32 verbose = va_arg (*args, u32);
1293 str = format (str, "[#%d][Q] ", ctx->c_thread_index);
1295 if (quic_ctx_is_listener (ctx))
1296 str = format (str, "Listener, UDP %ld", ctx->udp_session_handle);
1297 else if (quic_ctx_is_stream (ctx))
1298 str = format (str, "Stream %ld conn %d",
1299 ctx->stream->stream_id, ctx->quic_connection_ctx_id);
1300 else /* connection */
1301 str = format (str, "Conn %d UDP %d", ctx->c_c_index,
1302 ctx->udp_session_handle);
1304 str = format (str, " app %d wrk %d", ctx->parent_app_id,
1305 ctx->parent_app_wrk_id);
1308 s = format (s, "%-50s%-15d", str, ctx->conn_state);
1310 s = format (s, "%s\n", str);
1316 format_quic_connection (u8 * s, va_list * args)
1318 u32 qc_index = va_arg (*args, u32);
1319 u32 thread_index = va_arg (*args, u32);
1320 u32 verbose = va_arg (*args, u32);
1321 quic_ctx_t *ctx = quic_ctx_get (qc_index, thread_index);
1322 s = format (s, "%U", format_quic_ctx, ctx, verbose);
1327 format_quic_half_open (u8 * s, va_list * args)
1329 u32 qc_index = va_arg (*args, u32);
1330 u32 thread_index = va_arg (*args, u32);
1331 quic_ctx_t *ctx = quic_ctx_get (qc_index, thread_index);
1333 format (s, "[#%d][Q] half-open app %u", thread_index, ctx->parent_app_id);
1339 format_quic_listener (u8 * s, va_list * args)
1341 u32 tci = va_arg (*args, u32);
1342 u32 thread_index = va_arg (*args, u32);
1343 u32 verbose = va_arg (*args, u32);
1344 quic_ctx_t *ctx = quic_ctx_get (tci, thread_index);
1345 s = format (s, "%U", format_quic_ctx, ctx, verbose);
1349 /*****************************************************************************
1350 * END TRANSPORT PROTO FUNCTIONS
1352 * START SESSION CALLBACKS
1353 * Called from UDP layer
1354 *****************************************************************************/
1357 quic_build_sockaddr (struct sockaddr *sa, socklen_t * salen,
1358 ip46_address_t * addr, u16 port, u8 is_ip4)
1362 struct sockaddr_in *sa4 = (struct sockaddr_in *) sa;
1363 sa4->sin_family = AF_INET;
1364 sa4->sin_port = port;
1365 sa4->sin_addr.s_addr = addr->ip4.as_u32;
1366 *salen = sizeof (struct sockaddr_in);
1370 struct sockaddr_in6 *sa6 = (struct sockaddr_in6 *) sa;
1371 sa6->sin6_family = AF_INET6;
1372 sa6->sin6_port = port;
1373 clib_memcpy (&sa6->sin6_addr, &addr->ip6, 16);
1374 *salen = sizeof (struct sockaddr_in6);
1379 quic_on_client_connected (quic_ctx_t * ctx)
1381 session_t *quic_session;
1382 app_worker_t *app_wrk;
1383 u32 ctx_id = ctx->c_c_index;
1384 u32 thread_index = ctx->c_thread_index;
1387 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_id);
1390 quic_disconnect_transport (ctx);
1394 quic_session = session_alloc (thread_index);
1396 QUIC_DBG (2, "Allocated quic session 0x%lx", session_handle (quic_session));
1397 ctx->c_s_index = quic_session->session_index;
1398 quic_session->app_wrk_index = ctx->parent_app_wrk_id;
1399 quic_session->connection_index = ctx->c_c_index;
1400 quic_session->listener_handle = SESSION_INVALID_HANDLE;
1401 quic_session->session_type =
1402 session_type_from_proto_and_ip (TRANSPORT_PROTO_QUIC, ctx->udp_is_ip4);
1404 if (app_worker_init_connected (app_wrk, quic_session))
1406 QUIC_DBG (1, "failed to app_worker_init_connected");
1407 quic_proto_on_close (ctx_id, thread_index);
1408 return app_worker_connect_notify (app_wrk, NULL, ctx->client_opaque);
1411 quic_session->session_state = SESSION_STATE_CONNECTING;
1412 if ((rv = app_worker_connect_notify (app_wrk, quic_session,
1413 ctx->client_opaque)))
1415 QUIC_DBG (1, "failed to notify app %d", rv);
1416 quic_proto_on_close (ctx_id, thread_index);
1420 /* If the app opens a stream in its callback it may invalidate ctx */
1421 ctx = quic_ctx_get (ctx_id, thread_index);
1423 * app_worker_connect_notify() might have reallocated pool, reload
1424 * quic_session pointer
1426 quic_session = session_get (ctx->c_s_index, thread_index);
1427 quic_session->session_state = SESSION_STATE_LISTENING;
1433 quic_receive_connection (void *arg)
1435 u32 new_ctx_id, thread_index = vlib_get_thread_index ();
1436 quic_ctx_t *temp_ctx, *new_ctx;
1437 clib_bihash_kv_16_8_t kv;
1438 quicly_conn_t *conn;
1439 session_t *udp_session;
1442 new_ctx_id = quic_ctx_alloc (thread_index);
1443 new_ctx = quic_ctx_get (new_ctx_id, thread_index);
1445 QUIC_DBG (2, "Received conn %u (now %u)", temp_ctx->c_thread_index,
1449 memcpy (new_ctx, temp_ctx, sizeof (quic_ctx_t));
1450 clib_mem_free (temp_ctx);
1452 new_ctx->c_thread_index = thread_index;
1453 new_ctx->c_c_index = new_ctx_id;
1455 conn = new_ctx->conn;
1456 quic_store_conn_ctx (conn, new_ctx);
1457 quic_make_connection_key (&kv, quicly_get_master_id (conn));
1458 kv.value = ((u64) thread_index) << 32 | (u64) new_ctx_id;
1459 QUIC_DBG (2, "Registering conn with id %lu %lu", kv.key[0], kv.key[1]);
1460 clib_bihash_add_del_16_8 (&quic_main.connection_hash, &kv, 1 /* is_add */ );
1461 new_ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
1462 quic_update_timer (new_ctx);
1464 /* Trigger write on this connection if necessary */
1465 udp_session = session_get_from_handle (new_ctx->udp_session_handle);
1466 if (svm_fifo_max_dequeue (udp_session->tx_fifo))
1467 if (session_send_io_evt_to_thread (udp_session->tx_fifo,
1469 QUIC_DBG (4, "Cannot send TX event");
1473 quic_transfer_connection (u32 ctx_index, u32 dest_thread)
1475 tw_timer_wheel_1t_3w_1024sl_ov_t *tw;
1476 quic_ctx_t *ctx, *temp_ctx;
1477 u32 thread_index = vlib_get_thread_index ();
1479 QUIC_DBG (2, "Transferring conn %u to thread %u", ctx_index, dest_thread);
1481 temp_ctx = clib_mem_alloc (sizeof (quic_ctx_t));
1483 ctx = quic_ctx_get (ctx_index, thread_index);
1485 memcpy (temp_ctx, ctx, sizeof (quic_ctx_t));
1487 /* Remove from timer wheel and thread-local pool */
1488 if (ctx->timer_handle != QUIC_TIMER_HANDLE_INVALID)
1490 tw = &quic_main.wrk_ctx[thread_index].timer_wheel;
1491 tw_timer_stop_1t_3w_1024sl_ov (tw, ctx->timer_handle);
1493 quic_ctx_free (ctx);
1495 /* Send connection to destination thread */
1496 session_send_rpc_evt_to_thread (dest_thread, quic_receive_connection,
1501 quic_session_connected_callback (u32 quic_app_index, u32 ctx_index,
1502 session_t * udp_session, u8 is_fail)
1504 QUIC_DBG (2, "QSession is now connected (id %u)",
1505 udp_session->session_index);
1506 /* This should always be called before quic_connect returns since UDP always
1507 * connects instantly. */
1508 clib_bihash_kv_16_8_t kv;
1509 struct sockaddr_in6 sa6;
1510 struct sockaddr *sa = (struct sockaddr *) &sa6;
1512 transport_connection_t *tc;
1513 app_worker_t *app_wrk;
1514 quicly_conn_t *conn;
1516 u32 thread_index = vlib_get_thread_index ();
1518 quicly_context_t *quicly_ctx;
1521 ctx = quic_ctx_get (ctx_index, thread_index);
1525 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_id);
1528 api_context = ctx->c_s_index;
1529 app_worker_connect_notify (app_wrk, 0, api_context);
1534 ctx->c_thread_index = thread_index;
1535 ctx->c_c_index = ctx_index;
1537 QUIC_DBG (2, "Quic connect returned %u. New ctx [%u]%x",
1538 is_fail, thread_index, (ctx) ? ctx_index : ~0);
1540 ctx->udp_session_handle = session_handle (udp_session);
1541 udp_session->opaque = ctx->parent_app_id;
1543 /* Init QUIC lib connection
1544 * Generate required sockaddr & salen */
1545 tc = session_get_transport (udp_session);
1546 quic_build_sockaddr (sa, &salen, &tc->rmt_ip, tc->rmt_port, tc->is_ip4);
1548 quicly_ctx = quic_get_quicly_ctx_from_ctx (ctx);
1549 ret = quicly_connect (&ctx->conn, quicly_ctx, (char *) ctx->srv_hostname,
1550 sa, NULL, &quic_main.next_cid, ptls_iovec_init (NULL,
1552 &quic_main.hs_properties, NULL);
1553 ++quic_main.next_cid.master_id;
1554 /* Save context handle in quicly connection */
1555 quic_store_conn_ctx (ctx->conn, ctx);
1558 /* Register connection in connections map */
1560 quic_make_connection_key (&kv, quicly_get_master_id (conn));
1561 kv.value = ((u64) thread_index) << 32 | (u64) ctx_index;
1562 QUIC_DBG (2, "Registering conn with id %lu %lu", kv.key[0], kv.key[1]);
1563 clib_bihash_add_del_16_8 (&quic_main.connection_hash, &kv, 1 /* is_add */ );
1565 /* UDP stack quirk? preemptively transfer connection if that happens */
1566 if (udp_session->thread_index != thread_index)
1567 quic_transfer_connection (ctx_index, udp_session->thread_index);
1569 quic_send_packets (ctx);
1575 quic_session_disconnect_callback (session_t * s)
1577 clib_warning ("UDP session disconnected???");
1581 quic_session_reset_callback (session_t * s)
1583 clib_warning ("UDP session reset???");
1587 quic_session_migrate_callback (session_t * s, session_handle_t new_sh)
1590 * TODO we need better way to get the connection from the session
1591 * This will become possible once we stop storing the app id in the UDP
1594 u32 thread_index = vlib_get_thread_index ();
1595 u64 old_session_handle = session_handle (s);
1596 u32 new_thread = session_thread_from_handle (new_sh);
1599 QUIC_DBG (1, "Session %x migrated to %lx", s->session_index, new_sh);
1601 pool_foreach (ctx, quic_main.ctx_pool[thread_index],
1603 if (ctx->udp_session_handle == old_session_handle)
1605 /* Right ctx found, move associated conn */
1606 QUIC_DBG (5, "Found right ctx: %x", ctx->c_c_index);
1607 ctx->udp_session_handle = new_sh;
1608 quic_transfer_connection (ctx->c_c_index, new_thread);
1613 QUIC_DBG (0, "BUG: Connection to migrate not found");
1617 quic_session_accepted_callback (session_t * udp_session)
1619 /* New UDP connection, try to accept it */
1622 quic_ctx_t *ctx, *lctx;
1623 session_t *udp_listen_session;
1624 u32 thread_index = vlib_get_thread_index ();
1626 udp_listen_session =
1627 listen_session_get_from_handle (udp_session->listener_handle);
1629 ctx_index = quic_ctx_alloc (thread_index);
1630 ctx = quic_ctx_get (ctx_index, thread_index);
1631 ctx->c_thread_index = udp_session->thread_index;
1632 ctx->c_c_index = ctx_index;
1633 ctx->c_s_index = QUIC_SESSION_INVALID;
1634 ctx->udp_session_handle = session_handle (udp_session);
1635 QUIC_DBG (2, "ACCEPTED UDP 0x%lx", ctx->udp_session_handle);
1636 ctx->listener_ctx_id = udp_listen_session->opaque;
1637 lctx = quic_ctx_get (udp_listen_session->opaque,
1638 udp_listen_session->thread_index);
1639 ctx->udp_is_ip4 = lctx->c_is_ip4;
1640 ctx->parent_app_id = lctx->parent_app_id;
1641 ctx->parent_app_wrk_id = lctx->parent_app_wrk_id;
1642 ctx->timer_handle = QUIC_TIMER_HANDLE_INVALID;
1643 ctx->conn_state = QUIC_CONN_STATE_OPENED;
1644 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1646 udp_session->opaque = ctx->parent_app_id;
1648 /* Put this ctx in the "opening" pool */
1649 pool_get (quic_main.wrk_ctx[ctx->c_thread_index].opening_ctx_pool,
1651 *pool_index = ctx_index;
1653 /* TODO timeout to delete these if they never connect */
1658 quic_add_segment_callback (u32 client_index, u64 seg_handle)
1660 QUIC_DBG (2, "Called quic_add_segment_callback");
1661 QUIC_DBG (2, "NOT IMPLEMENTED");
1662 /* No-op for builtin */
1667 quic_del_segment_callback (u32 client_index, u64 seg_handle)
1669 QUIC_DBG (2, "Called quic_del_segment_callback");
1670 QUIC_DBG (2, "NOT IMPLEMENTED");
1671 /* No-op for builtin */
1676 quic_custom_app_rx_callback (transport_connection_t * tc)
1679 session_t *stream_session = session_get (tc->s_index, tc->thread_index);
1680 QUIC_DBG (3, "Received app READ notification");
1681 quic_ack_rx_data (stream_session);
1682 svm_fifo_reset_has_deq_ntf (stream_session->rx_fifo);
1684 /* Need to send packets (acks may never be sent otherwise) */
1685 ctx = quic_ctx_get (stream_session->connection_index,
1686 stream_session->thread_index);
1687 quic_send_packets (ctx);
1692 quic_custom_tx_callback (void *s, u32 max_burst_size)
1694 session_t *stream_session = (session_t *) s;
1695 quicly_stream_t *stream;
1700 (stream_session->session_state >= SESSION_STATE_TRANSPORT_CLOSING))
1703 quic_ctx_get (stream_session->connection_index,
1704 stream_session->thread_index);
1705 if (PREDICT_FALSE (!quic_ctx_is_stream (ctx)))
1707 goto tx_end; /* Most probably a reschedule */
1710 QUIC_DBG (3, "Stream TX event");
1711 quic_ack_rx_data (stream_session);
1712 if (!svm_fifo_max_dequeue (stream_session->tx_fifo))
1715 stream = ctx->stream;
1716 if (!quicly_sendstate_is_open (&stream->sendstate))
1718 QUIC_DBG (1, "Warning: tried to send on closed stream");
1722 if ((rv = quicly_stream_sync_sendbuf (stream, 1)) != 0)
1726 quic_send_packets (ctx);
1732 * Returns 0 if a matching connection is found and is on the right thread.
1733 * Otherwise returns -1.
1734 * If a connection is found, even on the wrong thread, ctx_thread and ctx_index
1738 quic_find_packet_ctx (u32 * ctx_thread, u32 * ctx_index,
1739 struct sockaddr *sa, socklen_t salen,
1740 quicly_decoded_packet_t * packet,
1741 u32 caller_thread_index)
1744 quicly_conn_t *conn_;
1745 clib_bihash_kv_16_8_t kv;
1746 clib_bihash_16_8_t *h;
1748 h = &quic_main.connection_hash;
1749 quic_make_connection_key (&kv, &packet->cid.dest.plaintext);
1750 QUIC_DBG (3, "Searching conn with id %lu %lu", kv.key[0], kv.key[1]);
1752 if (clib_bihash_search_16_8 (h, &kv, &kv) == 0)
1754 u32 index = kv.value & UINT32_MAX;
1755 u32 thread_id = kv.value >> 32;
1756 /* Check if this connection belongs to this thread, otherwise
1757 * ask for it to be moved */
1758 if (thread_id != caller_thread_index)
1760 QUIC_DBG (2, "Connection is on wrong thread");
1761 /* Cannot make full check with quicly_is_destination... */
1763 *ctx_thread = thread_id;
1766 ctx_ = quic_ctx_get (index, vlib_get_thread_index ());
1768 if (conn_ && quicly_is_destination (conn_, NULL, sa, packet))
1770 QUIC_DBG (3, "Connection found");
1772 *ctx_thread = thread_id;
1776 QUIC_DBG (3, "connection not found");
1781 quic_create_quic_session (quic_ctx_t * ctx)
1783 session_t *quic_session;
1784 app_worker_t *app_wrk;
1788 quic_session = session_alloc (ctx->c_thread_index);
1789 QUIC_DBG (2, "Allocated quic_session, 0x%lx ctx %u",
1790 session_handle (quic_session), ctx->c_c_index);
1791 quic_session->session_state = SESSION_STATE_LISTENING;
1792 ctx->c_s_index = quic_session->session_index;
1794 lctx = quic_ctx_get (ctx->listener_ctx_id, 0);
1796 quic_session->app_wrk_index = lctx->parent_app_wrk_id;
1797 quic_session->connection_index = ctx->c_c_index;
1798 quic_session->session_type =
1799 session_type_from_proto_and_ip (TRANSPORT_PROTO_QUIC, ctx->udp_is_ip4);
1800 quic_session->listener_handle = lctx->c_s_index;
1802 /* TODO: don't alloc fifos when we don't transfer data on this session
1803 * but we still need fifos for the events? */
1804 if ((rv = app_worker_init_accepted (quic_session)))
1806 QUIC_DBG (1, "failed to allocate fifos");
1807 session_free (quic_session);
1810 app_wrk = app_worker_get (quic_session->app_wrk_index);
1811 if ((rv = app_worker_accept_notify (app_wrk, quic_session)))
1813 QUIC_DBG (1, "failed to notify accept worker app");
1820 quic_create_connection (u32 ctx_index, struct sockaddr *sa,
1821 socklen_t salen, quicly_decoded_packet_t packet)
1823 clib_bihash_kv_16_8_t kv;
1825 quicly_conn_t *conn;
1826 u32 thread_index = vlib_get_thread_index ();
1827 quicly_context_t *quicly_ctx;
1830 /* new connection, accept and create context if packet is valid
1831 * TODO: check if socket is actually listening? */
1832 ctx = quic_ctx_get (ctx_index, thread_index);
1833 quicly_ctx = quic_get_quicly_ctx_from_ctx (ctx);
1834 if ((rv = quicly_accept (&conn, quicly_ctx, NULL, sa,
1835 &packet, NULL, &quic_main.next_cid, NULL)))
1837 /* Invalid packet, pass */
1838 assert (conn == NULL);
1839 QUIC_DBG (1, "Accept failed with %d", rv);
1840 /* TODO: cleanup created quic ctx and UDP session */
1843 assert (conn != NULL);
1845 ++quic_main.next_cid.master_id;
1846 /* Save ctx handle in quicly connection */
1847 quic_store_conn_ctx (conn, ctx);
1849 ctx->conn_state = QUIC_CONN_STATE_HANDSHAKE;
1851 quic_create_quic_session (ctx);
1853 /* Register connection in connections map */
1854 quic_make_connection_key (&kv, quicly_get_master_id (conn));
1855 kv.value = ((u64) thread_index) << 32 | (u64) ctx_index;
1856 clib_bihash_add_del_16_8 (&quic_main.connection_hash, &kv, 1 /* is_add */ );
1857 QUIC_DBG (2, "Registering conn with id %lu %lu", kv.key[0], kv.key[1]);
1859 return quic_send_packets (ctx);
1863 quic_reset_connection (u64 udp_session_handle,
1864 struct sockaddr *sa, socklen_t salen,
1865 quicly_decoded_packet_t packet)
1867 /* short header packet; potentially a dead connection. No need to check the
1868 * length of the incoming packet, because loop is prevented by authenticating
1869 * the CID (by checking node_id and thread_id). If the peer is also sending a
1870 * reset, then the next CID is highly likely to contain a non-authenticating
1872 QUIC_DBG (2, "Sending stateless reset");
1874 quicly_datagram_t *dgram;
1875 session_t *udp_session;
1876 quicly_context_t *quicly_ctx;
1877 if (packet.cid.dest.plaintext.node_id != 0
1878 || packet.cid.dest.plaintext.thread_id != 0)
1880 quicly_ctx = quic_get_quicly_ctx_from_udp (udp_session_handle);
1881 dgram = quicly_send_stateless_reset (quicly_ctx, sa, NULL,
1882 &packet.cid.dest.plaintext);
1885 udp_session = session_get_from_handle (udp_session_handle);
1886 rv = quic_send_datagram (udp_session, dgram);
1887 if (svm_fifo_set_event (udp_session->tx_fifo))
1888 session_send_io_evt_to_thread (udp_session->tx_fifo, SESSION_IO_EVT_TX);
1892 typedef struct quic_rx_packet_ctx_
1894 quicly_decoded_packet_t packet;
1895 u8 data[QUIC_MAX_PACKET_SIZE];
1898 } quic_rx_packet_ctx_t;
1901 check_quic_client_connected (struct quic_rx_packet_ctx_ *quic_rx_ctx)
1903 /* ctx pointer may change if a new stream is opened */
1904 quic_ctx_t *ctx = quic_ctx_get (quic_rx_ctx->ctx_index,
1905 quic_rx_ctx->thread_index);
1906 /* Conn may be set to null if the connection is terminated */
1907 if (ctx->conn && ctx->conn_state == QUIC_CONN_STATE_HANDSHAKE)
1909 if (quicly_connection_is_ready (ctx->conn))
1911 ctx->conn_state = QUIC_CONN_STATE_READY;
1912 if (quicly_is_client (ctx->conn))
1914 quic_on_client_connected (ctx);
1922 quic_process_one_rx_packet (u64 udp_session_handle,
1923 quicly_context_t * quicly_ctx, svm_fifo_t * f,
1924 u32 * fifo_offset, u32 * max_packet, u32 packet_n,
1925 quic_rx_packet_ctx_t * packet_ctx)
1927 session_dgram_hdr_t ph;
1928 quic_ctx_t *ctx = NULL;
1930 struct sockaddr_in6 sa6;
1931 struct sockaddr *sa = (struct sockaddr *) &sa6;
1935 packet_ctx->thread_index = UINT32_MAX;
1936 packet_ctx->ctx_index = UINT32_MAX;
1937 u32 thread_index = vlib_get_thread_index ();
1938 u32 *opening_ctx_pool, *ctx_index_ptr;
1939 u32 cur_deq = svm_fifo_max_dequeue (f) - *fifo_offset;
1943 *max_packet = packet_n + 1;
1947 if (cur_deq < SESSION_CONN_HDR_LEN)
1949 QUIC_DBG (1, "Not enough data for even a header in RX");
1952 ret = svm_fifo_peek (f, *fifo_offset, SESSION_CONN_HDR_LEN, (u8 *) & ph);
1953 if (ret != SESSION_CONN_HDR_LEN)
1955 QUIC_DBG (1, "Not enough data for header in RX");
1958 ASSERT (ph.data_offset == 0);
1959 full_len = ph.data_length + SESSION_CONN_HDR_LEN;
1960 if (full_len > cur_deq)
1962 QUIC_DBG (1, "Not enough data in fifo RX");
1966 /* Quicly can read len bytes from the fifo at offset:
1967 * ph.data_offset + SESSION_CONN_HDR_LEN */
1969 svm_fifo_peek (f, SESSION_CONN_HDR_LEN + *fifo_offset, ph.data_length,
1971 if (ret != ph.data_length)
1973 QUIC_DBG (1, "Not enough data peeked in RX");
1977 quic_increment_counter (QUIC_ERROR_RX_PACKETS, 1);
1979 quic_build_sockaddr (sa, &salen, &ph.rmt_ip, ph.rmt_port, ph.is_ip4);
1980 quicly_ctx = quic_get_quicly_ctx_from_udp (udp_session_handle);
1982 quicly_decode_packet (quicly_ctx, &packet_ctx->packet, packet_ctx->data,
1985 if (plen == SIZE_MAX)
1987 *fifo_offset += SESSION_CONN_HDR_LEN + ph.data_length;
1992 quic_find_packet_ctx (&packet_ctx->thread_index, &packet_ctx->ctx_index,
1993 sa, salen, &packet_ctx->packet, thread_index);
1996 ctx = quic_ctx_get (packet_ctx->ctx_index, thread_index);
1997 rv = quicly_receive (ctx->conn, NULL, sa, &packet_ctx->packet);
1999 QUIC_DBG (1, "quicly_receive return error %d", rv);
2001 else if (packet_ctx->ctx_index != UINT32_MAX)
2003 /* Connection found but on wrong thread, ask move */
2004 *max_packet = packet_n + 1;
2007 else if ((packet_ctx->packet.octets.base[0] & QUICLY_PACKET_TYPE_BITMASK) ==
2008 QUICLY_PACKET_TYPE_INITIAL)
2010 /* Try to find matching "opening" ctx */
2011 opening_ctx_pool = quic_main.wrk_ctx[thread_index].opening_ctx_pool;
2014 pool_foreach (ctx_index_ptr, opening_ctx_pool,
2016 ctx = quic_ctx_get (*ctx_index_ptr, thread_index);
2017 if (ctx->udp_session_handle == udp_session_handle)
2019 /* Right ctx found, create conn & remove from pool */
2020 quic_create_connection(*ctx_index_ptr, sa, salen, packet_ctx->packet);
2021 *max_packet = packet_n + 1;
2022 packet_ctx->thread_index = thread_index;
2023 packet_ctx->ctx_index = *ctx_index_ptr;
2024 pool_put (opening_ctx_pool, ctx_index_ptr);
2032 quic_reset_connection (udp_session_handle, sa, salen,
2033 packet_ctx->packet);
2037 *fifo_offset += SESSION_CONN_HDR_LEN + ph.data_length;
2042 quic_app_rx_callback (session_t * udp_session)
2044 /* Read data from UDP rx_fifo and pass it to the quicly conn. */
2046 quic_ctx_t *ctx = NULL;
2049 u32 app_index = udp_session->opaque;
2050 u64 udp_session_handle = session_handle (udp_session);
2052 app = application_get_if_valid (app_index);
2053 u32 thread_index = vlib_get_thread_index ();
2054 quic_rx_packet_ctx_t packets_ctx[16];
2058 QUIC_DBG (1, "Got RX on detached app");
2059 /* TODO: close this session, cleanup state? */
2065 udp_session = session_get_from_handle (udp_session_handle); /* session alloc might have happened */
2066 f = udp_session->rx_fifo;
2067 max_deq = svm_fifo_max_dequeue (f);
2073 u32 fifo_offset = 0;
2074 u32 max_packets = 16;
2075 for (int i = 0; i < max_packets; i++)
2077 quic_process_one_rx_packet (udp_session_handle,
2078 (quicly_context_t *) app->quicly_ctx, f,
2079 &fifo_offset, &max_packets, i,
2083 for (int i = 0; i < max_packets; i++)
2085 if (packets_ctx[i].thread_index != thread_index)
2088 check_quic_client_connected (&packets_ctx[i]);
2090 quic_ctx_get (packets_ctx[i].ctx_index,
2091 packets_ctx[i].thread_index);
2092 quic_send_packets (ctx);
2094 svm_fifo_dequeue_drop (f, fifo_offset);
2101 quic_common_get_transport_endpoint (quic_ctx_t * ctx,
2102 transport_endpoint_t * tep, u8 is_lcl)
2104 session_t *udp_session;
2105 if (!quic_ctx_is_stream (ctx))
2107 udp_session = session_get_from_handle (ctx->udp_session_handle);
2108 session_get_endpoint (udp_session, tep, is_lcl);
2113 quic_get_transport_listener_endpoint (u32 listener_index,
2114 transport_endpoint_t * tep, u8 is_lcl)
2117 app_listener_t *app_listener;
2118 session_t *udp_listen_session;
2119 ctx = quic_ctx_get (listener_index, vlib_get_thread_index ());
2120 if (quic_ctx_is_listener (ctx))
2122 app_listener = app_listener_get_w_handle (ctx->udp_session_handle);
2123 udp_listen_session = app_listener_get_session (app_listener);
2124 return session_get_endpoint (udp_listen_session, tep, is_lcl);
2126 quic_common_get_transport_endpoint (ctx, tep, is_lcl);
2130 quic_get_transport_endpoint (u32 ctx_index, u32 thread_index,
2131 transport_endpoint_t * tep, u8 is_lcl)
2134 ctx = quic_ctx_get (ctx_index, thread_index);
2135 quic_common_get_transport_endpoint (ctx, tep, is_lcl);
2138 /*****************************************************************************
2139 * END TRANSPORT PROTO FUNCTIONS
2140 *****************************************************************************/
2143 static session_cb_vft_t quic_app_cb_vft = {
2144 .session_accept_callback = quic_session_accepted_callback,
2145 .session_disconnect_callback = quic_session_disconnect_callback,
2146 .session_connected_callback = quic_session_connected_callback,
2147 .session_reset_callback = quic_session_reset_callback,
2148 .session_migrate_callback = quic_session_migrate_callback,
2149 .add_segment_callback = quic_add_segment_callback,
2150 .del_segment_callback = quic_del_segment_callback,
2151 .builtin_app_rx_callback = quic_app_rx_callback,
2154 static const transport_proto_vft_t quic_proto = {
2155 .connect = quic_connect,
2156 .close = quic_proto_on_close,
2157 .start_listen = quic_start_listen,
2158 .stop_listen = quic_stop_listen,
2159 .get_connection = quic_connection_get,
2160 .get_listener = quic_listener_get,
2161 .update_time = quic_update_time,
2162 .app_rx_evt = quic_custom_app_rx_callback,
2163 .custom_tx = quic_custom_tx_callback,
2164 .format_connection = format_quic_connection,
2165 .format_half_open = format_quic_half_open,
2166 .format_listener = format_quic_listener,
2167 .get_transport_endpoint = quic_get_transport_endpoint,
2168 .get_transport_listener_endpoint = quic_get_transport_listener_endpoint,
2169 .transport_options = {
2170 .tx_type = TRANSPORT_TX_INTERNAL,
2171 .service_type = TRANSPORT_SERVICE_APP,
2177 quic_register_cipher_suite (quic_crypto_engine_t type,
2178 ptls_cipher_suite_t ** ciphers)
2180 quic_main_t *qm = &quic_main;
2181 vec_validate (qm->quic_ciphers, type);
2182 qm->quic_ciphers[type] = ciphers;
2186 quic_update_fifo_size ()
2188 quic_main_t *qm = &quic_main;
2189 segment_manager_props_t *seg_mgr_props =
2190 application_get_segment_manager_properties (qm->app_index);
2195 ("error while getting segment_manager_props_t, can't update fifo-size");
2199 seg_mgr_props->tx_fifo_size = qm->udp_fifo_size;
2200 seg_mgr_props->rx_fifo_size = qm->udp_fifo_size;
2203 static clib_error_t *
2204 quic_init (vlib_main_t * vm)
2206 u32 segment_size = 256 << 20;
2207 vlib_thread_main_t *vtm = vlib_get_thread_main ();
2208 tw_timer_wheel_1t_3w_1024sl_ov_t *tw;
2209 vnet_app_attach_args_t _a, *a = &_a;
2210 u64 options[APP_OPTIONS_N_OPTIONS];
2211 quic_main_t *qm = &quic_main;
2214 num_threads = 1 /* main thread */ + vtm->n_threads;
2216 memset (a, 0, sizeof (*a));
2217 memset (options, 0, sizeof (options));
2219 a->session_cb_vft = &quic_app_cb_vft;
2220 a->api_client_index = APP_INVALID_INDEX;
2221 a->options = options;
2222 a->name = format (0, "quic");
2223 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
2224 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = segment_size;
2225 a->options[APP_OPTIONS_RX_FIFO_SIZE] = qm->udp_fifo_size;
2226 a->options[APP_OPTIONS_TX_FIFO_SIZE] = qm->udp_fifo_size;
2227 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = qm->udp_fifo_prealloc;
2228 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
2229 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
2230 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
2232 if (vnet_application_attach (a))
2234 clib_warning ("failed to attach quic app");
2235 return clib_error_return (0, "failed to attach quic app");
2238 vec_validate (qm->ctx_pool, num_threads - 1);
2239 vec_validate (qm->wrk_ctx, num_threads - 1);
2240 /* Timer wheels, one per thread. */
2241 for (i = 0; i < num_threads; i++)
2243 tw = &qm->wrk_ctx[i].timer_wheel;
2244 tw_timer_wheel_init_1t_3w_1024sl_ov (tw, quic_expired_timers_dispatch,
2245 1e-3 /* timer period 1ms */ , ~0);
2246 tw->last_run_time = vlib_time_now (vlib_get_main ());
2249 clib_bihash_init_16_8 (&qm->connection_hash, "quic connections", 1024,
2253 qm->app_index = a->app_index;
2254 qm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
2255 / QUIC_TSTAMP_RESOLUTION;
2256 qm->session_cache.super.cb = quic_encrypt_ticket_cb;
2258 transport_register_protocol (TRANSPORT_PROTO_QUIC, &quic_proto,
2259 FIB_PROTOCOL_IP4, ~0);
2260 transport_register_protocol (TRANSPORT_PROTO_QUIC, &quic_proto,
2261 FIB_PROTOCOL_IP6, ~0);
2263 quic_register_cipher_suite (CRYPTO_ENGINE_VPP, quic_crypto_cipher_suites);
2264 quic_register_cipher_suite (CRYPTO_ENGINE_PICOTLS,
2265 ptls_openssl_cipher_suites);
2266 qm->default_cipher = CRYPTO_ENGINE_PICOTLS;
2271 VLIB_INIT_FUNCTION (quic_init);
2273 static clib_error_t *
2274 quic_plugin_crypto_command_fn (vlib_main_t * vm,
2275 unformat_input_t * input,
2276 vlib_cli_command_t * cmd)
2278 quic_main_t *qm = &quic_main;
2279 if (unformat_check_input (input) == UNFORMAT_END_OF_INPUT)
2280 return clib_error_return (0, "unknown input '%U'",
2281 format_unformat_error, input);
2282 if (unformat (input, "vpp"))
2283 qm->default_cipher = CRYPTO_ENGINE_VPP;
2284 else if (unformat (input, "picotls"))
2285 qm->default_cipher = CRYPTO_ENGINE_PICOTLS;
2287 return clib_error_return (0, "unknown input '%U'",
2288 format_unformat_error, input);
2292 u64 quic_fifosize = 0;
2293 static clib_error_t *
2294 quic_plugin_set_fifo_size_command_fn (vlib_main_t * vm,
2295 unformat_input_t * input,
2296 vlib_cli_command_t * cmd)
2298 unformat_input_t _line_input, *line_input = &_line_input;
2299 if (!unformat_user (input, unformat_line_input, line_input))
2302 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2305 (line_input, "%U", unformat_data_size, &quic_main.udp_fifo_size))
2306 quic_update_fifo_size ();
2308 return clib_error_return (0, "unknown input '%U'",
2309 format_unformat_error, line_input);
2316 quic_format_ctx_stat (u8 * s, va_list * args)
2318 quic_ctx_t *ctx = va_arg (*args, quic_ctx_t *);
2319 quicly_stats_t quicly_stats;
2321 quicly_get_stats (ctx->conn, &quicly_stats);
2323 s = format (s, "\n\rQUIC conn stats \n\r");
2326 format (s, "RTT: min:%d, smoothed:%d, variance:%d, latest:%d \n\r",
2327 quicly_stats.rtt.minimum, quicly_stats.rtt.smoothed,
2328 quicly_stats.rtt.variance, quicly_stats.rtt.latest);
2329 s = format (s, "Packet loss:%d \n\r", quicly_stats.num_packets.lost);
2334 static clib_error_t *
2335 quic_plugin_showstats_command_fn (vlib_main_t * vm,
2336 unformat_input_t * input,
2337 vlib_cli_command_t * cmd)
2339 quic_main_t *qm = &quic_main;
2340 quic_ctx_t *ctx = NULL;
2341 u32 num_workers = vlib_num_workers ();
2343 for (int i = 0; i < num_workers + 1; i++)
2346 pool_foreach (ctx, qm->ctx_pool[i],
2348 if(!(ctx->flags & QUIC_F_IS_LISTENER) && !(ctx->flags & QUIC_F_IS_STREAM))
2349 vlib_cli_output (vm, "%U", quic_format_ctx_stat, ctx);
2357 VLIB_CLI_COMMAND(quic_plugin_crypto_command, static)=
2359 .path = "quic set crypto api",
2360 .short_help = "quic set crypto api [picotls, vpp]",
2361 .function = quic_plugin_crypto_command_fn,
2363 VLIB_CLI_COMMAND(quic_plugin_set_fifo_size_command, static)=
2365 .path = "quic set fifo-size",
2366 .short_help = "quic set fifo-size N[Kb|Mb|GB] (default 64K)",
2367 .function = quic_plugin_set_fifo_size_command_fn,
2369 VLIB_CLI_COMMAND(quic_plugin_stats_command, static)=
2371 .path = "show quic stats",
2372 .short_help = "show quic stats",
2373 .function = quic_plugin_showstats_command_fn,
2375 VLIB_PLUGIN_REGISTER () =
2377 .version = VPP_BUILD_VER,
2378 .description = "Quic transport protocol",
2379 .default_disabled = 1,
2383 static clib_error_t *
2384 quic_config_fn (vlib_main_t * vm, unformat_input_t * input)
2386 quic_main.udp_fifo_size = QUIC_DEFAULT_FIFO_SIZE;
2387 quic_main.udp_fifo_prealloc = 0;
2389 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2392 (input, "fifo-size %U", unformat_data_size,
2393 &quic_main.udp_fifo_size))
2397 (input, "fifo-prealloc %u", &quic_main.udp_fifo_prealloc))
2400 return clib_error_return (0, "unknown input '%U'",
2401 format_unformat_error, input);
2407 VLIB_EARLY_CONFIG_FUNCTION (quic_config_fn, "quic");
2410 quic_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
2411 vlib_frame_t * frame)
2417 VLIB_REGISTER_NODE (quic_input_node) =
2419 .function = quic_node_fn,
2420 .name = "quic-input",
2421 .vector_size = sizeof (u32),
2422 .type = VLIB_NODE_TYPE_INTERNAL,
2423 .n_errors = ARRAY_LEN (quic_error_strings),
2424 .error_strings = quic_error_strings,
2429 * fd.io coding-style-patch-verification: ON
2432 * eval: (c-set-style "gnu")