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.
19 #include <vlibmemory/api.h>
21 #include <vpp/api/vpe_msg_enum.h>
22 #include <svm/fifo_segment.h>
23 #include <hs_apps/sapi/quic_echo.h>
24 #include <hs_apps/sapi/echo_common.c>
26 echo_main_t echo_main;
35 format_quic_echo_state (u8 * s, va_list * args)
37 u32 state = va_arg (*args, u32);
38 if (state == STATE_START)
39 return format (s, "STATE_START");
40 if (state == STATE_ATTACHED)
41 return format (s, "STATE_ATTACHED");
42 if (state == STATE_LISTEN)
43 return format (s, "STATE_LISTEN");
44 if (state == STATE_READY)
45 return format (s, "STATE_READY");
46 if (state == STATE_DATA_DONE)
47 return format (s, "STATE_DATA_DONE");
48 if (state == STATE_DISCONNECTED)
49 return format (s, "STATE_DISCONNECTED");
50 if (state == STATE_DETACHED)
51 return format (s, "STATE_DETACHED");
53 return format (s, "unknown state");
57 unformat_close (unformat_input_t * input, va_list * args)
59 u8 *a = va_arg (*args, u8 *);
60 if (unformat (input, "Y"))
61 *a = ECHO_CLOSE_F_ACTIVE;
62 else if (unformat (input, "N"))
63 *a = ECHO_CLOSE_F_NONE;
64 else if (unformat (input, "W"))
65 *a = ECHO_CLOSE_F_PASSIVE;
72 echo_unformat_timing_event (unformat_input_t * input, va_list * args)
74 u8 *a = va_arg (*args, u8 *);
75 if (unformat (input, "start"))
77 else if (unformat (input, "qconnected"))
78 *a = ECHO_EVT_LAST_QCONNECTED;
79 else if (unformat (input, "qconnect"))
80 *a = ECHO_EVT_FIRST_QCONNECT;
81 else if (unformat (input, "sconnected"))
82 *a = ECHO_EVT_LAST_SCONNECTED;
83 else if (unformat (input, "sconnect"))
84 *a = ECHO_EVT_FIRST_SCONNECT;
85 else if (unformat (input, "lastbyte"))
86 *a = ECHO_EVT_LAST_BYTE;
87 else if (unformat (input, "exit"))
95 echo_format_timing_event (u8 * s, va_list * args)
97 u32 timing_event = va_arg (*args, u32);
98 if (timing_event == ECHO_EVT_START)
99 return format (s, "start");
100 if (timing_event == ECHO_EVT_FIRST_QCONNECT)
101 return format (s, "qconnect");
102 if (timing_event == ECHO_EVT_LAST_QCONNECTED)
103 return format (s, "qconnected");
104 if (timing_event == ECHO_EVT_FIRST_SCONNECT)
105 return format (s, "sconnect");
106 if (timing_event == ECHO_EVT_LAST_SCONNECTED)
107 return format (s, "sconnected");
108 if (timing_event == ECHO_EVT_LAST_BYTE)
109 return format (s, "lastbyte");
110 if (timing_event == ECHO_EVT_EXIT)
111 return format (s, "exit");
113 return format (s, "unknown timing event");
118 * End of format functions
123 echo_session_prealloc (echo_main_t * em)
125 /* We need to prealloc to avoid vec resize in threads */
126 echo_session_t *session;
127 int n_sessions = em->n_clients * (em->n_stream_clients + 1)
130 for (i = 0; i < n_sessions; i++)
132 pool_get (em->sessions, session);
133 clib_memset (session, 0, sizeof (*session));
134 session->session_index = session - em->sessions;
135 session->listener_index = SESSION_INVALID_INDEX;
136 session->session_state = QUIC_SESSION_STATE_INITIAL;
140 static echo_session_t *
141 echo_session_new (echo_main_t * em)
143 /* thread safe new prealloced session */
144 return pool_elt_at_index (em->sessions,
145 clib_atomic_fetch_add (&em->nxt_available_sidx,
151 echo_send_rpc (echo_main_t * em, void *fp, void *arg, u32 opaque)
155 if (PREDICT_FALSE (svm_msg_q_lock (em->rpc_msq_queue)))
157 ECHO_LOG (1, "RPC lock failed");
160 if (PREDICT_FALSE (svm_msg_q_ring_is_full (em->rpc_msq_queue, 0)))
162 svm_msg_q_unlock (em->rpc_msq_queue);
163 ECHO_LOG (1, "RPC ring is full");
166 msg = svm_msg_q_alloc_msg_w_ring (em->rpc_msq_queue, 0);
167 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
169 ECHO_LOG (1, "RPC msg is invalid");
170 svm_msg_q_unlock (em->rpc_msq_queue);
173 evt = (echo_rpc_msg_t *) svm_msg_q_msg_data (em->rpc_msq_queue, &msg);
175 evt->opaque = opaque;
178 svm_msg_q_add_and_unlock (em->rpc_msq_queue, &msg);
183 echo_segment_handle_add_del (echo_main_t * em, u64 segment_handle, u8 add)
185 clib_spinlock_lock (&em->segment_handles_lock);
187 hash_set (em->shared_segment_handles, segment_handle, 1);
189 hash_unset (em->shared_segment_handles, segment_handle);
190 clib_spinlock_unlock (&em->segment_handles_lock);
194 echo_session_handle_add_del (echo_main_t * em, u64 handle, u32 sid)
196 clib_spinlock_lock (&em->sid_vpp_handles_lock);
197 if (sid == SESSION_INVALID_INDEX)
198 hash_unset (em->session_index_by_vpp_handles, handle);
200 hash_set (em->session_index_by_vpp_handles, handle, sid);
201 clib_spinlock_unlock (&em->sid_vpp_handles_lock);
204 static inline echo_session_t *
205 echo_get_session_from_handle (echo_main_t * em, u64 handle)
208 clib_spinlock_lock (&em->sid_vpp_handles_lock);
209 p = hash_get (em->session_index_by_vpp_handles, handle);
210 clib_spinlock_unlock (&em->sid_vpp_handles_lock);
213 ECHO_FAIL ("unknown handle 0x%lx", handle);
216 return pool_elt_at_index (em->sessions, p[0]);
226 application_send_attach (echo_main_t * em)
228 vl_api_application_attach_t *bmp;
229 vl_api_application_tls_cert_add_t *cert_mp;
230 vl_api_application_tls_key_add_t *key_mp;
232 bmp = vl_msg_api_alloc (sizeof (*bmp));
233 clib_memset (bmp, 0, sizeof (*bmp));
235 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_ATTACH);
236 bmp->client_index = em->my_client_index;
237 bmp->context = ntohl (0xfeedface);
238 bmp->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_ACCEPT_REDIRECT;
239 bmp->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_ADD_SEGMENT;
240 bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = 16;
241 bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = em->fifo_size;
242 bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = em->fifo_size;
243 bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = 128 << 20;
244 bmp->options[APP_OPTIONS_SEGMENT_SIZE] = 256 << 20;
245 bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = 256;
248 bmp->namespace_id_len = vec_len (em->appns_id);
249 clib_memcpy_fast (bmp->namespace_id, em->appns_id,
250 bmp->namespace_id_len);
251 bmp->options[APP_OPTIONS_FLAGS] |= em->appns_flags;
252 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = em->appns_secret;
254 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & bmp);
256 cert_mp = vl_msg_api_alloc (sizeof (*cert_mp) + test_srv_crt_rsa_len);
257 clib_memset (cert_mp, 0, sizeof (*cert_mp));
258 cert_mp->_vl_msg_id = ntohs (VL_API_APPLICATION_TLS_CERT_ADD);
259 cert_mp->client_index = em->my_client_index;
260 cert_mp->context = ntohl (0xfeedface);
261 cert_mp->cert_len = clib_host_to_net_u16 (test_srv_crt_rsa_len);
262 clib_memcpy_fast (cert_mp->cert, test_srv_crt_rsa, test_srv_crt_rsa_len);
263 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & cert_mp);
265 key_mp = vl_msg_api_alloc (sizeof (*key_mp) + test_srv_key_rsa_len);
266 clib_memset (key_mp, 0, sizeof (*key_mp) + test_srv_key_rsa_len);
267 key_mp->_vl_msg_id = ntohs (VL_API_APPLICATION_TLS_KEY_ADD);
268 key_mp->client_index = em->my_client_index;
269 key_mp->context = ntohl (0xfeedface);
270 key_mp->key_len = clib_host_to_net_u16 (test_srv_key_rsa_len);
271 clib_memcpy_fast (key_mp->key, test_srv_key_rsa, test_srv_key_rsa_len);
272 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & key_mp);
276 application_detach (echo_main_t * em)
278 vl_api_application_detach_t *bmp;
279 bmp = vl_msg_api_alloc (sizeof (*bmp));
280 clib_memset (bmp, 0, sizeof (*bmp));
282 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
283 bmp->client_index = em->my_client_index;
284 bmp->context = ntohl (0xfeedface);
285 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & bmp);
289 server_send_listen (echo_main_t * em)
291 vl_api_bind_uri_t *bmp;
292 bmp = vl_msg_api_alloc (sizeof (*bmp));
293 clib_memset (bmp, 0, sizeof (*bmp));
295 bmp->_vl_msg_id = ntohs (VL_API_BIND_URI);
296 bmp->client_index = em->my_client_index;
297 bmp->context = ntohl (0xfeedface);
298 memcpy (bmp->uri, em->uri, vec_len (em->uri));
299 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & bmp);
303 server_send_unbind (echo_main_t * em)
305 vl_api_unbind_uri_t *ump;
307 ump = vl_msg_api_alloc (sizeof (*ump));
308 clib_memset (ump, 0, sizeof (*ump));
310 ump->_vl_msg_id = ntohs (VL_API_UNBIND_URI);
311 ump->client_index = em->my_client_index;
312 memcpy (ump->uri, em->uri, vec_len (em->uri));
313 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & ump);
317 echo_send_connect (u8 * uri, u32 opaque)
319 echo_main_t *em = &echo_main;
320 vl_api_connect_uri_t *cmp;
321 cmp = vl_msg_api_alloc (sizeof (*cmp));
322 clib_memset (cmp, 0, sizeof (*cmp));
323 cmp->_vl_msg_id = ntohs (VL_API_CONNECT_URI);
324 cmp->client_index = em->my_client_index;
325 cmp->context = ntohl (opaque);
326 memcpy (cmp->uri, uri, vec_len (uri));
327 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & cmp);
331 echo_disconnect_session (echo_session_t * s, u32 opaque)
333 echo_main_t *em = &echo_main;
334 vl_api_disconnect_session_t *dmp;
335 dmp = vl_msg_api_alloc (sizeof (*dmp));
336 clib_memset (dmp, 0, sizeof (*dmp));
337 dmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION);
338 dmp->client_index = em->my_client_index;
339 dmp->handle = s->vpp_session_handle;
340 ECHO_LOG (1, "Disconnect session 0x%lx", dmp->handle);
341 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & dmp);
346 * End Session API Calls
351 wait_for_segment_allocation (u64 segment_handle)
353 echo_main_t *em = &echo_main;
355 timeout = clib_time_now (&em->clib_time) + TIMEOUT;
356 uword *segment_present;
357 ECHO_LOG (1, "Waiting for segment 0x%lx...", segment_handle);
358 while (clib_time_now (&em->clib_time) < timeout)
360 clib_spinlock_lock (&em->segment_handles_lock);
361 segment_present = hash_get (em->shared_segment_handles, segment_handle);
362 clib_spinlock_unlock (&em->segment_handles_lock);
363 if (segment_present != 0)
365 if (em->time_to_stop == 1)
368 ECHO_LOG (1, "timeout wait_for_segment_allocation (0x%lx)", segment_handle);
373 quic_echo_notify_event (echo_main_t * em, echo_test_evt_t e)
375 if (em->timing.events_sent & e)
377 if (em->timing.start_event == e)
378 em->timing.start_time = clib_time_now (&em->clib_time);
379 else if (em->timing.end_event == e)
380 em->timing.end_time = clib_time_now (&em->clib_time);
381 em->timing.events_sent |= e;
385 echo_assert_test_suceeded (echo_main_t * em)
387 CHECK (em->n_stream_clients * em->n_clients * em->bytes_to_receive,
388 em->stats.rx_total, "Not enough data received");
389 CHECK (em->n_stream_clients * em->n_clients * em->bytes_to_send,
390 em->stats.tx_total, "Not enough data sent");
391 clib_spinlock_lock (&em->sid_vpp_handles_lock);
392 CHECK (0, hash_elts (em->session_index_by_vpp_handles),
393 "Some sessions are still open");
394 clib_spinlock_unlock (&em->sid_vpp_handles_lock);
398 echo_session_dequeue_notify (echo_session_t * s)
401 if (!svm_fifo_set_event (s->rx_fifo))
404 app_send_io_evt_to_vpp (s->vpp_evt_q, s->rx_fifo->master_session_index,
405 SESSION_IO_EVT_RX, SVM_Q_WAIT)))
406 ECHO_FAIL ("app_send_io_evt_to_vpp errored %d", rv);
407 svm_fifo_clear_deq_ntf (s->rx_fifo);
411 ssvm_segment_attach (char *name, ssvm_segment_type_t type, int fd)
413 fifo_segment_create_args_t _a, *a = &_a;
414 fifo_segment_main_t *sm = &echo_main.segment_main;
417 clib_memset (a, 0, sizeof (*a));
418 a->segment_name = (char *) name;
419 a->segment_type = type;
421 if (type == SSVM_SEGMENT_MEMFD)
424 if ((rv = fifo_segment_attach (sm, a)))
426 vec_reset_length (a->new_segment_indices);
431 stop_signal (int signum)
433 echo_main_t *em = &echo_main;
434 em->time_to_stop = 1;
438 connect_to_vpp (char *name)
440 echo_main_t *em = &echo_main;
441 api_main_t *am = &api_main;
443 if (em->use_sock_api)
445 if (vl_socket_client_connect ((char *) em->socket_name, name,
446 0 /* default rx, tx buffer */ ))
448 ECHO_FAIL ("socket connect failed");
452 if (vl_socket_client_init_shm (0, 1 /* want_pthread */ ))
454 ECHO_FAIL ("init shm api failed");
460 if (vl_client_connect_to_vlib ("/vpe-api", name, 32) < 0)
462 ECHO_FAIL ("shmem connect failed");
466 em->vl_input_queue = am->shmem_hdr->vl_input_queue;
467 em->my_client_index = am->my_client_index;
472 session_print_stats (echo_main_t * em, echo_session_t * session)
474 f64 deltat = clib_time_now (&em->clib_time) - session->start;
475 ECHO_LOG (0, "Session 0x%x done in %.6fs RX[%.4f] TX[%.4f] Gbit/s\n",
476 session->vpp_session_handle, deltat,
477 (session->bytes_received * 8.0) / deltat / 1e9,
478 (session->bytes_sent * 8.0) / deltat / 1e9);
482 echo_event_didnt_happen (u8 e)
484 echo_main_t *em = &echo_main;
485 u8 *s = format (0, "%U", echo_format_timing_event, e);
486 ECHO_LOG (0, "Expected event %s to happend, which did not", s);
491 print_global_json_stats (echo_main_t * em)
493 if (!(em->timing.events_sent & em->timing.start_event))
494 return echo_event_didnt_happen (em->timing.start_event);
495 if (!(em->timing.events_sent & em->timing.end_event))
496 return echo_event_didnt_happen (em->timing.end_event);
497 f64 deltat = em->timing.end_time - em->timing.start_time;
499 format (0, "%U", echo_format_timing_event, em->timing.start_event);
501 format (0, "%U", echo_format_timing_event, em->timing.end_event);
502 fformat (stdout, "{\n");
503 fformat (stdout, "\"time\": \"%.9f\",\n", deltat);
504 fformat (stdout, "\"start_evt\": \"%s\",\n", start_evt);
505 fformat (stdout, "\"end_evt\": \"%s\",\n", end_evt);
506 fformat (stdout, "\"rx_data\": %lld,\n", em->stats.rx_total);
507 fformat (stdout, "\"tx_rx\": %lld,\n", em->stats.tx_total);
508 fformat (stdout, "\"closing\": {\n");
509 fformat (stdout, " \"reset\": { \"q\": %d, \"s\": %d },\n",
510 em->stats.reset_count.q, em->stats.reset_count.s);
511 fformat (stdout, " \"close\": { \"q\": %d, \"s\": %d },\n",
512 em->stats.close_count.q, em->stats.close_count.s);
513 fformat (stdout, " \"active\": { \"q\": %d, \"s\": %d },\n",
514 em->stats.active_count.q, em->stats.active_count.s);
515 fformat (stdout, " \"clean\": { \"q\": %d, \"s\": %d }\n",
516 em->stats.clean_count.q, em->stats.clean_count.s);
517 fformat (stdout, "}\n");
518 fformat (stdout, "}\n");
522 print_global_stats (echo_main_t * em)
525 if (!(em->timing.events_sent & em->timing.start_event))
526 return echo_event_didnt_happen (em->timing.start_event);
527 if (!(em->timing.events_sent & em->timing.end_event))
528 return echo_event_didnt_happen (em->timing.end_event);
529 f64 deltat = em->timing.end_time - em->timing.start_time;
530 s = format (0, "%U:%U",
531 echo_format_timing_event, em->timing.start_event,
532 echo_format_timing_event, em->timing.end_event);
533 fformat (stdout, "Timing %s\n", s);
534 fformat (stdout, "-------- TX --------\n");
535 fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
536 em->stats.tx_total, em->stats.tx_total / (1ULL << 20),
537 em->stats.tx_total / (1ULL << 30), deltat);
538 fformat (stdout, "%.4f Gbit/second\n",
539 (em->stats.tx_total * 8.0) / deltat / 1e9);
540 fformat (stdout, "-------- RX --------\n");
541 fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
542 em->stats.rx_total, em->stats.rx_total / (1ULL << 20),
543 em->stats.rx_total / (1ULL << 30), deltat);
544 fformat (stdout, "%.4f Gbit/second\n",
545 (em->stats.rx_total * 8.0) / deltat / 1e9);
546 fformat (stdout, "--------------------\n");
547 fformat (stdout, "Received close on %dQ %dS\n", em->stats.close_count.q,
548 em->stats.close_count.s);
549 fformat (stdout, "Received reset on %dQ %dS\n", em->stats.reset_count.q,
550 em->stats.reset_count.s);
551 fformat (stdout, "Sent close on %dQ %dS\n", em->stats.active_count.q,
552 em->stats.active_count.s);
553 fformat (stdout, "Discarded %dQ %dS\n", em->stats.clean_count.q,
554 em->stats.clean_count.s);
558 echo_free_sessions (echo_main_t * em)
560 /* Free marked sessions */
562 u32 *session_indexes = 0, *session_index;
565 pool_foreach (s, em->sessions,
567 if (s->session_state == QUIC_SESSION_STATE_CLOSED)
568 vec_add1 (session_indexes, s->session_index);}
571 vec_foreach (session_index, session_indexes)
574 s = pool_elt_at_index (em->sessions, *session_index);
575 echo_session_handle_add_del (em, s->vpp_session_handle,
576 SESSION_INVALID_INDEX);
577 pool_put (em->sessions, s);
578 clib_memset (s, 0xfe, sizeof (*s));
583 echo_cleanup_session (echo_main_t * em, echo_session_t * s)
586 ASSERT (s->session_state < QUIC_SESSION_STATE_CLOSED);
587 if (s->session_type == QUIC_SESSION_TYPE_QUIC)
589 clib_atomic_sub_fetch (&em->n_quic_clients_connected, 1);
591 else if (s->session_type == QUIC_SESSION_TYPE_STREAM)
593 ls = pool_elt_at_index (em->sessions, s->listener_index);
594 ASSERT (ls->session_type == QUIC_SESSION_TYPE_QUIC);
595 if (!clib_atomic_sub_fetch (&ls->accepted_session_count, 1))
597 if (em->send_quic_disconnects == ECHO_CLOSE_F_ACTIVE)
599 echo_send_rpc (em, echo_disconnect_session, (void *) ls, 0);
600 em->stats.active_count.q++;
602 else if (em->send_quic_disconnects == ECHO_CLOSE_F_NONE)
604 echo_cleanup_session (em, ls);
605 em->stats.clean_count.q++;
608 clib_atomic_sub_fetch (&em->n_clients_connected, 1);
610 ECHO_LOG (1, "Cleanup sessions (still %uQ %uS)",
611 em->n_quic_clients_connected, em->n_clients_connected);
612 s->session_state = QUIC_SESSION_STATE_CLOSED;
616 echo_initiate_qsession_close_no_stream (echo_main_t * em)
618 ECHO_LOG (1, "Closing Qsessions");
619 /* Close Quic session without streams */
623 pool_foreach (s, em->sessions,
625 if (s->session_type == QUIC_SESSION_TYPE_QUIC)
627 ECHO_LOG (1,"ACTIVE close 0x%lx", s->vpp_session_handle);
628 if (em->send_quic_disconnects == ECHO_CLOSE_F_ACTIVE)
630 echo_send_rpc (em, echo_disconnect_session, (void *) s, 0);
631 em->stats.active_count.q++;
633 else if (em->send_quic_disconnects == ECHO_CLOSE_F_NONE)
635 echo_cleanup_session (em, s);
636 em->stats.clean_count.q++;
641 em->state = STATE_DATA_DONE;
645 test_recv_bytes (echo_main_t * em, echo_session_t * s, u8 * rx_buf,
650 for (i = 0; i < n_read; i++)
652 expected = (s->bytes_received + i) & 0xff;
653 if (rx_buf[i] == expected || em->max_test_msg > 0)
655 ECHO_LOG (0, "Session 0x%lx byte %lld was 0x%x expected 0x%x",
656 s->vpp_session_handle, s->bytes_received + i, rx_buf[i],
659 if (em->max_test_msg == 0)
660 ECHO_LOG (0, "Too many errors, hiding next ones");
661 if (em->test_return_packets == RETURN_PACKETS_ASSERT)
662 ECHO_FAIL ("test-bytes errored");
667 recv_data_chunk (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
670 n_read = app_recv_stream ((app_session_t *) s, rx_buf, vec_len (rx_buf));
673 if (svm_fifo_needs_deq_ntf (s->rx_fifo, n_read))
674 echo_session_dequeue_notify (s);
676 if (em->test_return_packets)
677 test_recv_bytes (em, s, rx_buf, n_read);
679 s->bytes_received += n_read;
680 s->bytes_to_receive -= n_read;
685 send_data_chunk (echo_session_t * s, u8 * tx_buf, int offset, int len)
688 int bytes_this_chunk = clib_min (s->bytes_to_send, len - offset);
689 if (!bytes_this_chunk)
691 n_sent = app_send_stream ((app_session_t *) s, tx_buf + offset,
692 bytes_this_chunk, 0);
695 s->bytes_to_send -= n_sent;
696 s->bytes_sent += n_sent;
701 mirror_data_chunk (echo_main_t * em, echo_session_t * s, u8 * tx_buf, u64 len)
704 while (n_sent < len && !em->time_to_stop)
705 n_sent += send_data_chunk (s, tx_buf, n_sent, len);
710 echo_update_count_on_session_close (echo_main_t * em, echo_session_t * s)
713 ECHO_LOG (1, "[%lu/%lu] -> S(%x) -> [%lu/%lu]",
714 s->bytes_received, s->bytes_received + s->bytes_to_receive,
715 s->session_index, s->bytes_sent,
716 s->bytes_sent + s->bytes_to_send);
717 clib_atomic_fetch_add (&em->stats.tx_total, s->bytes_sent);
718 clib_atomic_fetch_add (&em->stats.rx_total, s->bytes_received);
720 if (PREDICT_FALSE (em->stats.rx_total ==
721 em->n_clients * em->n_stream_clients *
722 em->bytes_to_receive))
723 quic_echo_notify_event (em, ECHO_EVT_LAST_BYTE);
727 echo_check_closed_listener (echo_main_t * em, echo_session_t * s)
730 /* if parent has died, terminate gracefully */
731 ls = pool_elt_at_index (em->sessions, s->listener_index);
732 if (ls->session_state < QUIC_SESSION_STATE_CLOSING)
734 ECHO_LOG (2, "Session 0%lx died, close child 0x%lx", ls->vpp_session_handle,
735 s->vpp_session_handle);
736 clib_atomic_sub_fetch (&em->n_clients_connected, 1);
737 em->stats.clean_count.s++;
738 echo_update_count_on_session_close (em, s);
739 s->session_state = QUIC_SESSION_STATE_CLOSED;
743 * Rx/Tx polling thread per connection
746 echo_handle_data (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
748 int n_read, n_sent = 0;
750 n_read = recv_data_chunk (em, s, rx_buf);
751 if (em->data_source == ECHO_TEST_DATA_SOURCE)
752 n_sent = send_data_chunk (s, em->connect_test_data,
753 s->bytes_sent % em->tx_buf_size,
755 else if (em->data_source == ECHO_RX_DATA_SOURCE)
756 n_sent = mirror_data_chunk (em, s, rx_buf, n_read);
757 if (!s->bytes_to_send && !s->bytes_to_receive)
759 /* Session is done, need to close */
760 if (s->session_state == QUIC_SESSION_STATE_AWAIT_DATA)
761 s->session_state = QUIC_SESSION_STATE_CLOSING;
764 s->session_state = QUIC_SESSION_STATE_AWAIT_CLOSING;
765 if (em->send_stream_disconnects == ECHO_CLOSE_F_ACTIVE)
767 echo_send_rpc (em, echo_disconnect_session, (void *) s, 0);
768 em->stats.close_count.s++;
770 else if (em->send_stream_disconnects == ECHO_CLOSE_F_NONE)
772 s->session_state = QUIC_SESSION_STATE_CLOSING;
773 em->stats.clean_count.s++;
779 /* Check for idle clients */
782 if (n_sent || n_read)
784 else if (s->idle_cycles++ == 1e7)
787 ECHO_LOG (1, "Idle client TX:%dB RX:%dB", s->bytes_to_send,
788 s->bytes_to_receive);
789 ECHO_LOG (1, "Idle FIFOs TX:%dB RX:%dB",
790 svm_fifo_max_dequeue (s->tx_fifo),
791 svm_fifo_max_dequeue (s->rx_fifo));
792 ECHO_LOG (1, "Session 0x%lx state %u", s->vpp_session_handle,
799 echo_data_thread_fn (void *arg)
801 clib_mem_set_thread_index ();
802 echo_main_t *em = &echo_main;
803 u32 N = em->n_clients * em->n_stream_clients;
804 u32 n = (N + em->n_rx_threads - 1) / em->n_rx_threads;
806 u32 thread_n_sessions = clib_min (n, N - n * idx);
809 u32 n_closed_sessions = 0;
813 vec_validate (rx_buf, em->rx_buf_size);
815 for (i = 0; !em->time_to_stop; i = (i + 1) % thread_n_sessions)
817 n_closed_sessions = i == 0 ? 0 : n_closed_sessions;
818 session_index = em->data_thread_args[n * idx + i];
819 if (session_index == SESSION_INVALID_INDEX)
821 s = pool_elt_at_index (em->sessions, session_index);
822 switch (s->session_state)
824 case QUIC_SESSION_STATE_READY:
825 case QUIC_SESSION_STATE_AWAIT_DATA:
826 echo_handle_data (em, s, rx_buf);
827 echo_check_closed_listener (em, s);
829 case QUIC_SESSION_STATE_AWAIT_CLOSING:
830 echo_check_closed_listener (em, s);
832 case QUIC_SESSION_STATE_CLOSING:
833 echo_update_count_on_session_close (em, s);
834 echo_cleanup_session (em, s);
836 case QUIC_SESSION_STATE_CLOSED:
840 if (n_closed_sessions == thread_n_sessions)
847 session_bound_handler (session_bound_msg_t * mp)
849 echo_main_t *em = &echo_main;
850 echo_session_t *listen_session;
853 ECHO_FAIL ("bind failed: %U", format_api_error,
854 clib_net_to_host_u32 (mp->retval));
857 ECHO_LOG (0, "listening on %U:%u", format_ip46_address, mp->lcl_ip,
858 mp->lcl_is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
859 clib_net_to_host_u16 (mp->lcl_port));
861 /* Allocate local session and set it up */
862 listen_session = echo_session_new (em);
863 listen_session->session_type = QUIC_SESSION_TYPE_LISTEN;
864 echo_session_handle_add_del (em, mp->handle, listen_session->session_index);
865 em->state = STATE_LISTEN;
866 em->listen_session_index = listen_session->session_index;
870 session_accepted_handler (session_accepted_msg_t * mp)
872 app_session_evt_t _app_evt, *app_evt = &_app_evt;
873 session_accepted_reply_msg_t *rmp;
874 svm_fifo_t *rx_fifo, *tx_fifo;
875 echo_main_t *em = &echo_main;
876 echo_session_t *session, *ls;
877 /* Allocate local session and set it up */
878 session = echo_session_new (em);
880 if (wait_for_segment_allocation (mp->segment_handle))
882 ECHO_FAIL ("wait_for_segment_allocation errored");
886 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
887 rx_fifo->client_session_index = session->session_index;
888 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
889 tx_fifo->client_session_index = session->session_index;
891 session->rx_fifo = rx_fifo;
892 session->tx_fifo = tx_fifo;
893 session->vpp_session_handle = mp->handle;
894 session->start = clib_time_now (&em->clib_time);
895 session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
897 if (!(ls = echo_get_session_from_handle (em, mp->listener_handle)))
899 session->listener_index = ls->session_index;
901 /* Add it to lookup table */
902 ECHO_LOG (1, "Accepted session 0x%lx -> 0x%lx", mp->handle,
903 mp->listener_handle);
904 echo_session_handle_add_del (em, mp->handle, session->session_index);
906 app_alloc_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt,
907 SESSION_CTRL_EVT_ACCEPTED_REPLY);
908 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
909 rmp->handle = mp->handle;
910 rmp->context = mp->context;
911 app_send_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt);
913 if (ls->session_type == QUIC_SESSION_TYPE_LISTEN)
915 quic_echo_notify_event (em, ECHO_EVT_FIRST_QCONNECT);
916 session->session_type = QUIC_SESSION_TYPE_QUIC;
917 session->accepted_session_count = 0;
918 if (em->cb_vft.quic_accepted_cb)
919 em->cb_vft.quic_accepted_cb (mp, session->session_index);
920 clib_atomic_fetch_add (&em->n_quic_clients_connected, 1);
924 session->session_type = QUIC_SESSION_TYPE_STREAM;
925 quic_echo_notify_event (em, ECHO_EVT_FIRST_SCONNECT);
926 clib_atomic_fetch_add (&ls->accepted_session_count, 1);
927 if (em->i_am_master && em->cb_vft.server_stream_accepted_cb)
928 em->cb_vft.server_stream_accepted_cb (mp, session->session_index);
929 if (!em->i_am_master && em->cb_vft.client_stream_accepted_cb)
930 em->cb_vft.client_stream_accepted_cb (mp, session->session_index);
931 clib_atomic_fetch_add (&em->n_clients_connected, 1);
934 if (em->n_clients_connected == em->n_clients * em->n_stream_clients
935 && em->n_clients_connected != 0)
936 quic_echo_notify_event (em, ECHO_EVT_LAST_SCONNECTED);
937 if (em->n_quic_clients_connected == em->n_clients
938 && em->state < STATE_READY)
940 quic_echo_notify_event (em, ECHO_EVT_LAST_QCONNECTED);
941 em->state = STATE_READY;
942 if (em->n_stream_clients == 0)
943 echo_initiate_qsession_close_no_stream (em);
948 session_connected_handler (session_connected_msg_t * mp)
950 echo_main_t *em = &echo_main;
951 echo_session_t *session, *listen_session;
952 u32 listener_index = htonl (mp->context);
953 svm_fifo_t *rx_fifo, *tx_fifo;
957 ECHO_FAIL ("connection failed with code: %U", format_api_error,
958 clib_net_to_host_u32 (mp->retval));
962 session = echo_session_new (em);
963 if (wait_for_segment_allocation (mp->segment_handle))
965 ECHO_FAIL ("wait_for_segment_allocation errored");
969 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
970 rx_fifo->client_session_index = session->session_index;
971 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
972 tx_fifo->client_session_index = session->session_index;
974 session->rx_fifo = rx_fifo;
975 session->tx_fifo = tx_fifo;
976 session->vpp_session_handle = mp->handle;
977 session->start = clib_time_now (&em->clib_time);
978 session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
981 echo_session_handle_add_del (em, mp->handle, session->session_index);
983 if (listener_index == SESSION_INVALID_INDEX)
985 ECHO_LOG (1, "Connected session 0x%lx -> URI", mp->handle);
986 session->session_type = QUIC_SESSION_TYPE_QUIC;
987 session->accepted_session_count = 0;
988 if (em->cb_vft.quic_connected_cb)
989 em->cb_vft.quic_connected_cb (mp, session->session_index);
990 clib_atomic_fetch_add (&em->n_quic_clients_connected, 1);
994 listen_session = pool_elt_at_index (em->sessions, listener_index);
995 session->listener_index = listener_index;
996 ECHO_LOG (1, "Connected session 0x%lx -> 0x%lx", mp->handle,
997 listen_session->vpp_session_handle);
998 session->session_type = QUIC_SESSION_TYPE_STREAM;
999 clib_atomic_fetch_add (&listen_session->accepted_session_count, 1);
1000 if (em->i_am_master && em->cb_vft.server_stream_connected_cb)
1001 em->cb_vft.server_stream_connected_cb (mp, session->session_index);
1002 if (!em->i_am_master && em->cb_vft.client_stream_connected_cb)
1003 em->cb_vft.client_stream_connected_cb (mp, session->session_index);
1004 clib_atomic_fetch_add (&em->n_clients_connected, 1);
1007 if (em->n_clients_connected == em->n_clients * em->n_stream_clients
1008 && em->n_clients_connected != 0)
1009 quic_echo_notify_event (em, ECHO_EVT_LAST_SCONNECTED);
1010 if (em->n_quic_clients_connected == em->n_clients
1011 && em->state < STATE_READY)
1013 quic_echo_notify_event (em, ECHO_EVT_LAST_QCONNECTED);
1014 em->state = STATE_READY;
1015 if (em->n_stream_clients == 0)
1016 echo_initiate_qsession_close_no_stream (em);
1022 * ECHO Callback definitions
1028 echo_on_connected_connect (session_connected_msg_t * mp, u32 session_index)
1030 echo_main_t *em = &echo_main;
1031 u8 *uri = format (0, "QUIC://session/%lu", mp->handle);
1034 quic_echo_notify_event (em, ECHO_EVT_FIRST_SCONNECT);
1035 for (i = 0; i < em->n_stream_clients; i++)
1036 echo_send_rpc (em, echo_send_connect, (void *) uri, session_index);
1038 ECHO_LOG (0, "Qsession 0x%llx connected to %U:%d",
1039 mp->handle, format_ip46_address, &mp->lcl.ip,
1040 mp->lcl.is_ip4, clib_net_to_host_u16 (mp->lcl.port));
1044 echo_on_connected_send (session_connected_msg_t * mp, u32 session_index)
1046 echo_main_t *em = &echo_main;
1047 echo_session_t *session;
1049 session = pool_elt_at_index (em->sessions, session_index);
1050 session->bytes_to_send = em->bytes_to_send;
1051 session->bytes_to_receive = em->bytes_to_receive;
1052 session->session_state = QUIC_SESSION_STATE_READY;
1053 em->data_thread_args[em->n_clients_connected] = session->session_index;
1057 echo_on_connected_error (session_connected_msg_t * mp, u32 session_index)
1059 ECHO_FAIL ("Got a wrong connected on session %u [%lx]", session_index,
1064 echo_on_accept_recv (session_accepted_msg_t * mp, u32 session_index)
1066 echo_main_t *em = &echo_main;
1067 echo_session_t *session;
1069 session = pool_elt_at_index (em->sessions, session_index);
1070 session->bytes_to_send = em->bytes_to_send;
1071 session->bytes_to_receive = em->bytes_to_receive;
1072 em->data_thread_args[em->n_clients_connected] = session->session_index;
1073 session->session_state = QUIC_SESSION_STATE_READY;
1077 echo_on_accept_connect (session_accepted_msg_t * mp, u32 session_index)
1079 echo_main_t *em = &echo_main;
1080 ECHO_LOG (1, "Accept on QSession 0x%lx %u", mp->handle);
1081 u8 *uri = format (0, "QUIC://session/%lu", mp->handle);
1084 quic_echo_notify_event (em, ECHO_EVT_FIRST_SCONNECT);
1085 for (i = 0; i < em->n_stream_clients; i++)
1086 echo_send_rpc (em, echo_send_connect, (void *) uri, session_index);
1090 echo_on_accept_error (session_accepted_msg_t * mp, u32 session_index)
1092 ECHO_FAIL ("Got a wrong accept on session %u [%lx]", session_index,
1097 echo_on_accept_log_ip (session_accepted_msg_t * mp, u32 session_index)
1100 ip_str = format (0, "%U", format_ip46_address, &mp->rmt.ip, mp->rmt.is_ip4);
1101 ECHO_LOG (0, "Accepted session from: %s:%d", ip_str,
1102 clib_net_to_host_u16 (mp->rmt.port));
1106 static const quic_echo_cb_vft_t default_cb_vft = {
1108 .quic_accepted_cb = echo_on_accept_log_ip,
1109 .quic_connected_cb = echo_on_connected_connect,
1110 /* client initiated streams */
1111 .server_stream_accepted_cb = echo_on_accept_recv,
1112 .client_stream_connected_cb = echo_on_connected_send,
1113 /* server initiated streams */
1114 .client_stream_accepted_cb = echo_on_accept_error,
1115 .server_stream_connected_cb = echo_on_connected_error,
1118 static const quic_echo_cb_vft_t server_stream_cb_vft = {
1120 .quic_accepted_cb = echo_on_accept_connect,
1121 .quic_connected_cb = NULL,
1122 /* client initiated streams */
1123 .server_stream_accepted_cb = echo_on_accept_error,
1124 .client_stream_connected_cb = echo_on_connected_error,
1125 /* server initiated streams */
1126 .client_stream_accepted_cb = echo_on_accept_recv,
1127 .server_stream_connected_cb = echo_on_connected_send,
1131 echo_unformat_quic_setup_vft (unformat_input_t * input, va_list * args)
1133 echo_main_t *em = &echo_main;
1134 if (unformat (input, "serverstream"))
1135 em->cb_vft = server_stream_cb_vft;
1136 else if (unformat (input, "default"))
1145 * End of ECHO callback definitions
1150 session_disconnected_handler (session_disconnected_msg_t * mp)
1152 app_session_evt_t _app_evt, *app_evt = &_app_evt;
1153 session_disconnected_reply_msg_t *rmp;
1154 echo_main_t *em = &echo_main;
1157 ECHO_LOG (1, "passive close session 0x%lx", mp->handle);
1158 if (!(s = echo_get_session_from_handle (em, mp->handle)))
1161 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
1162 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
1163 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
1165 rmp->handle = mp->handle;
1166 rmp->context = mp->context;
1167 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
1169 if (s->session_type == QUIC_SESSION_TYPE_STREAM)
1171 session_print_stats (em, s);
1172 if (s->bytes_to_receive || s->bytes_to_send)
1173 s->session_state = QUIC_SESSION_STATE_AWAIT_DATA;
1175 s->session_state = QUIC_SESSION_STATE_CLOSING;
1176 em->stats.close_count.s++;
1180 echo_cleanup_session (em, s); /* We can clean Q/Lsessions right away */
1181 em->stats.close_count.q++;
1186 session_reset_handler (session_reset_msg_t * mp)
1188 app_session_evt_t _app_evt, *app_evt = &_app_evt;
1189 echo_main_t *em = &echo_main;
1190 session_reset_reply_msg_t *rmp;
1191 echo_session_t *s = 0;
1194 ECHO_LOG (1, "Reset session 0x%lx", mp->handle);
1195 if (!(s = echo_get_session_from_handle (em, mp->handle)))
1197 if (s->session_type == QUIC_SESSION_TYPE_STREAM)
1199 em->stats.reset_count.s++;
1200 s->session_state = QUIC_SESSION_STATE_CLOSING;
1204 em->stats.reset_count.q++;
1205 echo_cleanup_session (em, s); /* We can clean Q/Lsessions right away */
1208 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
1209 SESSION_CTRL_EVT_RESET_REPLY);
1210 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
1212 rmp->handle = mp->handle;
1213 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
1217 handle_mq_event (session_event_t * e)
1219 switch (e->event_type)
1221 case SESSION_CTRL_EVT_BOUND:
1222 session_bound_handler ((session_bound_msg_t *) e->data);
1224 case SESSION_CTRL_EVT_ACCEPTED:
1225 session_accepted_handler ((session_accepted_msg_t *) e->data);
1227 case SESSION_CTRL_EVT_CONNECTED:
1228 session_connected_handler ((session_connected_msg_t *) e->data);
1230 case SESSION_CTRL_EVT_DISCONNECTED:
1231 session_disconnected_handler ((session_disconnected_msg_t *) e->data);
1233 case SESSION_CTRL_EVT_RESET:
1234 session_reset_handler ((session_reset_msg_t *) e->data);
1236 case SESSION_IO_EVT_RX:
1239 ECHO_LOG (0, "unhandled event %u", e->event_type);
1244 wait_for_state_change (echo_main_t * em, connection_state_t state,
1247 f64 end_time = clib_time_now (&em->clib_time) + timeout;
1248 while (!timeout || clib_time_now (&em->clib_time) < end_time)
1250 if (em->state == state)
1252 if (em->time_to_stop)
1255 ECHO_LOG (1, "timeout waiting for %U", format_quic_echo_state, state);
1260 echo_process_rpcs (echo_main_t * em)
1262 echo_rpc_msg_t *rpc;
1263 svm_msg_q_msg_t msg;
1264 while (em->state < STATE_DATA_DONE && !em->time_to_stop)
1266 if (svm_msg_q_sub (em->rpc_msq_queue, &msg, SVM_Q_TIMEDWAIT, 1))
1268 rpc = svm_msg_q_msg_data (em->rpc_msq_queue, &msg);
1269 ((echo_rpc_t) rpc->fp) (rpc->arg, rpc->opaque);
1270 svm_msg_q_free_msg (em->rpc_msq_queue, &msg);
1275 echo_mq_thread_fn (void *arg)
1277 clib_mem_set_thread_index ();
1278 echo_main_t *em = &echo_main;
1280 svm_msg_q_msg_t msg;
1282 wait_for_state_change (em, STATE_ATTACHED, 0);
1283 if (em->state < STATE_ATTACHED || !em->our_event_queue)
1285 ECHO_FAIL ("Application failed to attach");
1289 ECHO_LOG (1, "Waiting for data on %u clients", em->n_clients_connected);
1292 if (!(rv = svm_msg_q_sub (em->our_event_queue,
1293 &msg, SVM_Q_TIMEDWAIT, 1)))
1295 e = svm_msg_q_msg_data (em->our_event_queue, &msg);
1296 handle_mq_event (e);
1297 svm_msg_q_free_msg (em->our_event_queue, &msg);
1300 && (em->time_to_stop || em->state == STATE_DETACHED))
1302 if (!em->n_clients_connected && !em->n_quic_clients_connected &&
1303 em->state == STATE_READY)
1305 em->state = STATE_DATA_DONE;
1312 clients_run (echo_main_t * em)
1315 quic_echo_notify_event (em, ECHO_EVT_FIRST_QCONNECT);
1316 for (i = 0; i < em->n_clients; i++)
1317 echo_send_connect (em->uri, SESSION_INVALID_INDEX);
1318 wait_for_state_change (em, STATE_READY, 0);
1319 ECHO_LOG (1, "App is ready");
1320 echo_process_rpcs (em);
1324 server_run (echo_main_t * em)
1326 server_send_listen (em);
1327 wait_for_state_change (em, STATE_READY, 0);
1328 ECHO_LOG (1, "App is ready");
1329 echo_process_rpcs (em);
1331 server_send_unbind (em);
1332 if (wait_for_state_change (em, STATE_DISCONNECTED, TIMEOUT))
1334 ECHO_FAIL ("Timeout waiting for state disconnected");
1341 * Session API handlers
1346 vl_api_application_attach_reply_t_handler (vl_api_application_attach_reply_t *
1349 echo_main_t *em = &echo_main;
1353 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
1354 ECHO_LOG (1, "Attached returned app %u", htons (mp->app_index));
1358 ECHO_FAIL ("attach failed: %U", format_api_error,
1359 clib_net_to_host_u32 (mp->retval));
1363 if (mp->segment_name_length == 0)
1365 ECHO_FAIL ("segment_name_length zero");
1369 ASSERT (mp->app_event_queue_address);
1370 em->our_event_queue = uword_to_pointer (mp->app_event_queue_address,
1375 vec_validate (fds, mp->n_fds);
1376 if (vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5))
1378 ECHO_FAIL ("vl_socket_client_recv_fd_msg failed");
1382 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
1383 if (ssvm_segment_attach (0, SSVM_SEGMENT_MEMFD, fds[n_fds++]))
1385 ECHO_FAIL ("svm_fifo_segment_attach failed");
1389 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
1390 if (ssvm_segment_attach ((char *) mp->segment_name,
1391 SSVM_SEGMENT_MEMFD, fds[n_fds++]))
1393 ECHO_FAIL ("svm_fifo_segment_attach ('%s') failed",
1397 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
1398 svm_msg_q_set_consumer_eventfd (em->our_event_queue, fds[n_fds++]);
1404 if (ssvm_segment_attach ((char *) mp->segment_name, SSVM_SEGMENT_SHM,
1407 ECHO_FAIL ("svm_fifo_segment_attach ('%s') failed",
1412 echo_segment_handle_add_del (em, segment_handle, 1 /* add */ );
1413 ECHO_LOG (1, "Mapped segment 0x%lx", segment_handle);
1415 em->state = STATE_ATTACHED;
1418 for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
1424 vl_api_application_detach_reply_t_handler (vl_api_application_detach_reply_t *
1429 ECHO_FAIL ("detach returned with err: %d", mp->retval);
1432 echo_main.state = STATE_DETACHED;
1437 vl_api_unmap_segment_t_handler (vl_api_unmap_segment_t * mp)
1439 echo_main_t *em = &echo_main;
1440 u64 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
1441 echo_segment_handle_add_del (em, segment_handle, 0 /* add */ );
1442 ECHO_LOG (1, "Unmaped segment 0x%lx", segment_handle);
1446 vl_api_map_another_segment_t_handler (vl_api_map_another_segment_t * mp)
1448 fifo_segment_main_t *sm = &echo_main.segment_main;
1449 fifo_segment_create_args_t _a, *a = &_a;
1450 echo_main_t *em = &echo_main;
1452 char *seg_name = (char *) mp->segment_name;
1453 u64 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
1455 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
1457 vec_validate (fds, 1);
1458 if (vl_socket_client_recv_fd_msg (fds, 1, 5))
1460 ECHO_FAIL ("vl_socket_client_recv_fd_msg failed");
1464 if (ssvm_segment_attach (seg_name, SSVM_SEGMENT_MEMFD, fds[0]))
1466 ECHO_FAIL ("svm_fifo_segment_attach ('%s')"
1467 "failed on SSVM_SEGMENT_MEMFD", seg_name);
1474 clib_memset (a, 0, sizeof (*a));
1475 a->segment_name = seg_name;
1476 a->segment_size = mp->segment_size;
1477 /* Attach to the segment vpp created */
1478 if (fifo_segment_attach (sm, a))
1480 ECHO_FAIL ("svm_fifo_segment_attach ('%s') failed", seg_name);
1484 echo_segment_handle_add_del (em, segment_handle, 1 /* add */ );
1485 ECHO_LOG (1, "Mapped segment 0x%lx", segment_handle);
1489 for (i = 0; i < vec_len (fds); i++)
1495 vl_api_bind_uri_reply_t_handler (vl_api_bind_uri_reply_t * mp)
1497 echo_main_t *em = &echo_main;
1500 ECHO_FAIL ("bind failed: %U", format_api_error,
1501 clib_net_to_host_u32 (mp->retval));
1505 em->state = STATE_LISTEN;
1509 vl_api_unbind_uri_reply_t_handler (vl_api_unbind_uri_reply_t * mp)
1511 echo_session_t *listen_session;
1512 echo_main_t *em = &echo_main;
1513 if (mp->retval != 0)
1515 ECHO_FAIL ("returned %d", ntohl (mp->retval));
1518 em->state = STATE_DISCONNECTED;
1519 listen_session = pool_elt_at_index (em->sessions, em->listen_session_index);
1520 echo_cleanup_session (em, listen_session);
1524 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
1527 echo_main_t *em = &echo_main;
1532 ECHO_FAIL ("vpp complained about disconnect: %d", ntohl (mp->retval));
1536 ECHO_LOG (1, "Got disonnected reply for session 0x%lx", mp->handle);
1537 if (!(s = echo_get_session_from_handle (em, mp->handle)))
1539 if (s->session_type == QUIC_SESSION_TYPE_STREAM)
1540 s->session_state = QUIC_SESSION_STATE_CLOSING;
1542 echo_cleanup_session (em, s); /* We can clean Q/Lsessions right away */
1546 vl_api_application_tls_cert_add_reply_t_handler
1547 (vl_api_application_tls_cert_add_reply_t * mp)
1550 ECHO_FAIL ("failed to add tls cert");
1554 vl_api_application_tls_key_add_reply_t_handler
1555 (vl_api_application_tls_key_add_reply_t * mp)
1558 ECHO_FAIL ("failed to add tls key");
1562 vl_api_connect_uri_reply_t_handler (vl_api_connect_uri_reply_t * mp)
1564 echo_session_t *session;
1565 echo_main_t *em = &echo_main;
1570 if (mp->context == SESSION_INVALID_INDEX)
1572 ECHO_LOG (1, "Retrying connect %s", em->uri);
1573 echo_send_rpc (em, echo_send_connect, (void *) em->uri,
1574 SESSION_INVALID_INDEX);
1578 session = pool_elt_at_index (em->sessions, mp->context);
1579 uri = format (0, "QUIC://session/%lu", session->vpp_session_handle);
1580 ECHO_LOG (1, "Retrying connect %s", uri);
1581 echo_send_rpc (em, echo_send_connect, (void *) uri, mp->context);
1586 #define foreach_quic_echo_msg \
1587 _(BIND_URI_REPLY, bind_uri_reply) \
1588 _(UNBIND_URI_REPLY, unbind_uri_reply) \
1589 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
1590 _(APPLICATION_ATTACH_REPLY, application_attach_reply) \
1591 _(APPLICATION_DETACH_REPLY, application_detach_reply) \
1592 _(MAP_ANOTHER_SEGMENT, map_another_segment) \
1593 _(UNMAP_SEGMENT, unmap_segment) \
1594 _(APPLICATION_TLS_CERT_ADD_REPLY, application_tls_cert_add_reply) \
1595 _(APPLICATION_TLS_KEY_ADD_REPLY, application_tls_key_add_reply) \
1596 _(CONNECT_URI_REPLY, connect_uri_reply) \
1599 quic_echo_api_hookup (echo_main_t * em)
1602 vl_msg_api_set_handlers(VL_API_##N, #n, \
1603 vl_api_##n##_t_handler, \
1605 vl_api_##n##_t_endian, \
1606 vl_api_##n##_t_print, \
1607 sizeof(vl_api_##n##_t), 1);
1608 foreach_quic_echo_msg;
1614 * End Session API handlers
1619 print_usage_and_exit (void)
1622 "Usage: quic_echo [socket-name SOCKET] [client|server] [uri URI] [OPTIONS]\n"
1623 "Generates traffic and assert correct teardown of the QUIC hoststack\n"
1625 " socket-name PATH Specify the binary socket path to connect to VPP\n"
1626 " use-svm-api Use SVM API to connect to VPP\n"
1627 " test-bytes[:assert] Check data correctness when receiving (assert fails on first error)\n"
1628 " fifo-size N Use N Kb fifos\n"
1629 " rx-buf N Use N Kb RX buffer\n"
1630 " tx-buf N Use N Kb TX test buffer\n"
1631 " appns NAMESPACE Use the namespace NAMESPACE\n"
1632 " all-scope all-scope option\n"
1633 " local-scope local-scope option\n"
1634 " global-scope global-scope option\n"
1635 " secret SECRET set namespace secret\n"
1636 " chroot prefix PATH Use PATH as memory root path\n"
1637 " quic-setup OPT OPT=serverstream : Client open N connections. \n"
1638 " On each one server opens M streams\n"
1639 " OPT=default : Client open N connections.\n"
1640 " On each one client opens M streams\n"
1641 " sclose=[Y|N|W] When a stream is done, pass[N] send[Y] or wait[W] for close\n"
1642 " qclose=[Y|N|W] When a connection is done pass[N] send[Y] or wait[W] for close\n"
1644 " time START:END Time between evts START & END, events being :\n"
1645 " start - Start of the app\n"
1646 " qconnect - first Connection connect sent\n"
1647 " qconnected - last Connection connected\n"
1648 " sconnect - first Stream connect sent\n"
1649 " sconnected - last Stream got connected\n"
1650 " lastbyte - Last expected byte received\n"
1651 " exit - Exiting of the app\n"
1652 " json Output global stats in json\n"
1653 " log=N Set the log level to [0: no output, 1:errors, 2:log]\n"
1654 " max-connects=N Don't do more than N parallel connect_uri\n"
1656 " nclients N[/M] Open N QUIC connections, each one with M streams (M defaults to 1)\n"
1657 " nthreads N Use N busy loop threads for data [in addition to main & msg queue]\n"
1658 " TX=1337[Kb|Mb|GB] Send 1337 [K|M|G]bytes, use TX=RX to reflect the data\n"
1659 " RX=1337[Kb|Mb|GB] Expect 1337 [K|M|G]bytes\n"
1661 "Default configuration is :\n"
1662 " server nclients 1/1 RX=64Kb TX=RX\n"
1663 " client nclients 1/1 RX=64Kb TX=64Kb\n");
1669 quic_echo_process_opts (int argc, char **argv)
1671 echo_main_t *em = &echo_main;
1672 unformat_input_t _argv, *a = &_argv;
1676 u8 default_f_active;
1678 unformat_init_command_line (a, argv);
1679 while (unformat_check_input (a) != UNFORMAT_END_OF_INPUT)
1681 if (unformat (a, "chroot prefix %s", &chroot_prefix))
1683 vl_set_memory_root_path ((char *) chroot_prefix);
1685 else if (unformat (a, "uri %s", &uri))
1686 em->uri = format (0, "%s%c", uri, 0);
1687 else if (unformat (a, "server"))
1688 em->i_am_master = 1;
1689 else if (unformat (a, "client"))
1690 em->i_am_master = 0;
1691 else if (unformat (a, "test-bytes:assert"))
1692 em->test_return_packets = RETURN_PACKETS_ASSERT;
1693 else if (unformat (a, "test-bytes"))
1694 em->test_return_packets = RETURN_PACKETS_LOG_WRONG;
1695 else if (unformat (a, "socket-name %s", &em->socket_name))
1697 else if (unformat (a, "use-svm-api"))
1698 em->use_sock_api = 0;
1699 else if (unformat (a, "fifo-size %d", &tmp))
1700 em->fifo_size = tmp << 10;
1701 else if (unformat (a, "rx-buf %d", &tmp))
1702 em->rx_buf_size = tmp << 10;
1703 else if (unformat (a, "tx-buf %d", &tmp))
1704 em->rx_buf_size = tmp << 10;
1707 (a, "nclients %d/%d", &em->n_clients, &em->n_stream_clients))
1709 else if (unformat (a, "nclients %d", &em->n_clients))
1711 else if (unformat (a, "nthreads %d", &em->n_rx_threads))
1713 else if (unformat (a, "appns %_%v%_", &em->appns_id))
1715 else if (unformat (a, "all-scope"))
1716 em->appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
1717 | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
1718 else if (unformat (a, "local-scope"))
1719 em->appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1720 else if (unformat (a, "global-scope"))
1721 em->appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1722 else if (unformat (a, "secret %lu", &em->appns_secret))
1724 else if (unformat (a, "quic-setup %U", echo_unformat_quic_setup_vft))
1726 else if (unformat (a, "TX=RX"))
1727 em->data_source = ECHO_RX_DATA_SOURCE;
1728 else if (unformat (a, "TX=%U", unformat_data, &em->bytes_to_send))
1730 else if (unformat (a, "RX=%U", unformat_data, &em->bytes_to_receive))
1732 else if (unformat (a, "json"))
1733 em->output_json = 1;
1734 else if (unformat (a, "log=%d", &em->log_lvl))
1738 (a, "sclose=%U", unformat_close, &em->send_stream_disconnects))
1742 (a, "qclose=%U", unformat_close, &em->send_quic_disconnects))
1744 else if (unformat (a, "time %U:%U",
1745 echo_unformat_timing_event, &em->timing.start_event,
1746 echo_unformat_timing_event, &em->timing.end_event))
1749 print_usage_and_exit ();
1752 /* setting default for unset values
1754 * bytes_to_send / bytes_to_receive & data_source */
1755 if (em->bytes_to_receive == (u64) ~ 0)
1756 em->bytes_to_receive = 64 << 10; /* default */
1757 if (em->bytes_to_send == (u64) ~ 0)
1758 em->bytes_to_send = 64 << 10; /* default */
1759 else if (em->bytes_to_send == 0)
1760 em->data_source = ECHO_NO_DATA_SOURCE;
1762 em->data_source = ECHO_TEST_DATA_SOURCE;
1764 if (em->data_source == ECHO_INVALID_DATA_SOURCE)
1766 em->i_am_master ? ECHO_RX_DATA_SOURCE : ECHO_TEST_DATA_SOURCE;
1767 if (em->data_source == ECHO_RX_DATA_SOURCE)
1768 em->bytes_to_send = em->bytes_to_receive;
1770 /* disconnect flags */
1771 if (em->i_am_master)
1773 em->bytes_to_send == 0 ? ECHO_CLOSE_F_ACTIVE : ECHO_CLOSE_F_PASSIVE;
1776 em->bytes_to_receive == 0 ? ECHO_CLOSE_F_PASSIVE : ECHO_CLOSE_F_ACTIVE;
1777 if (em->send_stream_disconnects == ECHO_CLOSE_F_INVALID)
1778 em->send_stream_disconnects = default_f_active;
1779 if (em->send_quic_disconnects == ECHO_CLOSE_F_INVALID)
1780 em->send_quic_disconnects = default_f_active;
1784 main (int argc, char **argv)
1786 echo_main_t *em = &echo_main;
1787 fifo_segment_main_t *sm = &em->segment_main;
1790 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1791 u32 rpc_queue_size = 64 << 10;
1793 clib_mem_init_thread_safe (0, 256 << 20);
1794 clib_memset (em, 0, sizeof (*em));
1795 em->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
1796 clib_spinlock_init (&em->sid_vpp_handles_lock);
1797 em->shared_segment_handles = hash_create (0, sizeof (uword));
1798 clib_spinlock_init (&em->segment_handles_lock);
1799 em->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
1800 em->use_sock_api = 1;
1801 em->fifo_size = 64 << 10;
1803 em->n_stream_clients = 1;
1804 em->max_test_msg = 50;
1805 em->time_to_stop = 0;
1806 em->i_am_master = 1;
1807 em->n_rx_threads = 4;
1808 em->test_return_packets = RETURN_PACKETS_NOTEST;
1809 em->timing.start_event = ECHO_EVT_FIRST_QCONNECT;
1810 em->timing.end_event = ECHO_EVT_LAST_BYTE;
1811 em->bytes_to_receive = ~0; /* defaulted when we know if server/client */
1812 em->bytes_to_send = ~0; /* defaulted when we know if server/client */
1813 em->rx_buf_size = 1 << 20;
1814 em->tx_buf_size = 1 << 20;
1815 em->data_source = ECHO_INVALID_DATA_SOURCE;
1816 em->uri = format (0, "%s%c", "quic://0.0.0.0/1234", 0);
1817 em->cb_vft = default_cb_vft;
1818 quic_echo_process_opts (argc, argv);
1820 n_clients = em->n_clients * em->n_stream_clients;
1821 vec_validate (em->data_thread_handles, em->n_rx_threads - 1);
1822 vec_validate (em->data_thread_args, n_clients - 1);
1823 for (i = 0; i < n_clients; i++)
1824 em->data_thread_args[i] = SESSION_INVALID_INDEX;
1825 clib_time_init (&em->clib_time);
1826 init_error_string_table ();
1827 fifo_segment_main_init (sm, HIGH_SEGMENT_BASEVA, 20);
1828 vec_validate (em->connect_test_data, em->tx_buf_size);
1829 for (i = 0; i < em->tx_buf_size; i++)
1830 em->connect_test_data[i] = i & 0xff;
1833 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1834 {rpc_queue_size, sizeof (echo_rpc_msg_t), 0},
1837 cfg->consumer_pid = getpid ();
1839 cfg->q_nitems = rpc_queue_size;
1840 cfg->ring_cfgs = rc;
1841 em->rpc_msq_queue = svm_msg_q_alloc (cfg);
1843 signal (SIGINT, stop_signal);
1844 signal (SIGQUIT, stop_signal);
1845 signal (SIGTERM, stop_signal);
1846 quic_echo_api_hookup (em);
1848 app_name = em->i_am_master ? "quic_echo_server" : "quic_echo_client";
1849 if (connect_to_vpp (app_name) < 0)
1852 ECHO_FAIL ("Couldn't connect to vpe, exiting...\n");
1856 echo_session_prealloc (em);
1857 quic_echo_notify_event (em, ECHO_EVT_START);
1859 application_send_attach (em);
1860 if (wait_for_state_change (em, STATE_ATTACHED, TIMEOUT))
1862 ECHO_FAIL ("Couldn't attach to vpp, did you run <session enable> ?\n");
1865 if (pthread_create (&em->mq_thread_handle,
1866 NULL /*attr */ , echo_mq_thread_fn, 0))
1868 ECHO_FAIL ("pthread create errored\n");
1871 for (i = 0; i < em->n_rx_threads; i++)
1872 if (pthread_create (&em->data_thread_handles[i],
1873 NULL /*attr */ , echo_data_thread_fn, (void *) i))
1875 ECHO_FAIL ("pthread create errored\n");
1878 if (em->i_am_master)
1882 quic_echo_notify_event (em, ECHO_EVT_EXIT);
1883 if (em->output_json)
1884 print_global_json_stats (em);
1886 print_global_stats (em);
1887 echo_free_sessions (em);
1888 echo_assert_test_suceeded (em);
1889 application_detach (em);
1890 if (wait_for_state_change (em, STATE_DETACHED, TIMEOUT))
1892 ECHO_FAIL ("ECHO-ERROR: Couldn't detach from vpp, exiting...\n");
1896 pthread_join (em->mq_thread_handle, (void **) &rv);
1899 ECHO_FAIL ("mq pthread errored %d", rv);
1902 if (em->use_sock_api)
1903 vl_socket_client_disconnect ();
1905 vl_client_disconnect_from_vlib ();
1906 ECHO_LOG (0, "Test complete !\n");
1907 exit (em->has_failed);
1911 * fd.io coding-style-patch-verification: ON
1914 * eval: (c-set-style "gnu")