2 * Copyright (c) 2017-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 <hs_apps/hs_test.h>
17 #include <vnet/vnet.h>
18 #include <vlibmemory/api.h>
19 #include <vnet/session/application.h>
20 #include <vnet/session/application_interface.h>
21 #include <vnet/session/session.h>
23 static void es_set_echo_rx_callbacks (u8 no_echo);
27 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
29 u64 vpp_session_handle;
30 u32 vpp_session_index;
37 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
38 es_session_t *sessions;
39 u8 *rx_buf; /**< Per-thread RX buffer */
40 svm_msg_q_t *vpp_event_queue;
46 u32 app_index; /**< Server app index */
52 u32 fifo_size; /**< Fifo size */
53 u32 rcv_buffer_size; /**< Rcv buffer size */
54 u32 prealloc_fifos; /**< Preallocate fifos */
55 u32 private_segment_count; /**< Number of private segments */
56 u64 private_segment_size; /**< Size of private segments */
57 char *server_uri; /**< Server URI */
58 u32 tls_engine; /**< TLS engine: mbedtls/openssl */
59 u32 ckpair_index; /**< Cert and key for tls/quic */
60 u8 is_dgram; /**< set if transport is dgram */
66 int (*rx_callback) (session_t *session);
68 u64 listener_handle; /**< Session handle of the root listener */
69 u64 ctrl_listener_handle;
71 vlib_main_t *vlib_main;
74 echo_server_main_t echo_server_main;
76 #define es_err(_fmt, _args...) clib_warning (_fmt, ##_args);
78 #define es_dbg(_fmt, _args...) \
81 if (PREDICT_FALSE (echo_server_main.cfg.verbose)) \
82 es_err (_fmt, ##_args); \
86 #define es_cli(_fmt, _args...) vlib_cli_output (vm, _fmt, ##_args)
88 static inline es_worker_t *
89 es_worker_get (u32 thread_index)
91 return vec_elt_at_index (echo_server_main.wrk, thread_index);
94 static inline es_session_t *
95 es_session_alloc (es_worker_t *wrk)
99 pool_get_zero (wrk->sessions, es);
100 es->session_index = es - wrk->sessions;
104 static inline es_session_t *
105 es_session_get (es_worker_t *wrk, u32 es_index)
107 return pool_elt_at_index (wrk->sessions, es_index);
111 quic_echo_server_qsession_accept_callback (session_t * s)
113 es_dbg ("QSession %u accept w/opaque %d", s->session_index, s->opaque);
118 echo_server_ctrl_session_accept_callback (session_t *s)
120 s->session_state = SESSION_STATE_READY;
125 es_session_alloc_and_init (session_t *s)
128 es_worker_t *wrk = es_worker_get (s->thread_index);
130 es = es_session_alloc (wrk);
131 es->vpp_session_index = s->session_index;
132 es->vpp_session_handle = session_handle (s);
133 s->opaque = es->session_index;
137 quic_echo_server_session_accept_callback (session_t * s)
139 echo_server_main_t *esm = &echo_server_main;
141 if (PREDICT_FALSE (esm->ctrl_listener_handle == s->listener_handle))
142 return echo_server_ctrl_session_accept_callback (s);
144 if (s->listener_handle == esm->listener_handle)
145 return quic_echo_server_qsession_accept_callback (s);
147 es_dbg ("SSESSION %u accept w/opaque %d", s->session_index, s->opaque);
149 s->session_state = SESSION_STATE_READY;
150 es_session_alloc_and_init (s);
155 echo_server_session_accept_callback (session_t * s)
157 echo_server_main_t *esm = &echo_server_main;
159 if (PREDICT_FALSE (esm->ctrl_listener_handle == s->listener_handle))
160 return echo_server_ctrl_session_accept_callback (s);
162 s->session_state = SESSION_STATE_READY;
163 es_session_alloc_and_init (s);
168 echo_server_session_disconnect_callback (session_t * s)
170 echo_server_main_t *esm = &echo_server_main;
171 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
173 a->handle = session_handle (s);
174 a->app_index = esm->app_index;
175 vnet_disconnect_session (a);
179 echo_server_session_reset_callback (session_t * s)
181 echo_server_main_t *esm = &echo_server_main;
182 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
183 es_dbg ("Reset session %U", format_session, s, 2);
184 a->handle = session_handle (s);
185 a->app_index = esm->app_index;
186 vnet_disconnect_session (a);
190 echo_server_session_connected_callback (u32 app_index, u32 api_context,
191 session_t * s, session_error_t err)
193 es_err ("called...");
198 echo_server_add_segment_callback (u32 client_index, u64 segment_handle)
200 /* New heaps may be added */
205 echo_server_redirect_connect_callback (u32 client_index, void *mp)
207 es_err ("called...");
212 es_foreach_thread (void *fp)
214 echo_server_main_t *esm = &echo_server_main;
216 for (thread_index = 0; thread_index < vec_len (esm->wrk); thread_index++)
218 session_send_rpc_evt_to_thread (thread_index, fp,
219 uword_to_pointer (thread_index, void *));
224 es_wrk_prealloc_sessions (void *args)
226 echo_server_main_t *esm = &echo_server_main;
227 u32 sessions_per_wrk, n_wrks, thread_index;
229 thread_index = pointer_to_uword (args);
230 es_worker_t *wrk = es_worker_get (thread_index);
231 n_wrks = vlib_num_workers () ? vlib_num_workers () : 1;
232 sessions_per_wrk = esm->cfg.num_test_sessions / n_wrks;
233 pool_alloc (wrk->sessions, 1.1 * sessions_per_wrk);
238 echo_server_setup_test (hs_test_cfg_t *c)
240 if (c->test == HS_TEST_TYPE_UNI)
241 es_set_echo_rx_callbacks (1 /* no echo */);
243 es_set_echo_rx_callbacks (0 /* no echo */);
245 es_foreach_thread (es_wrk_prealloc_sessions);
250 echo_server_ctrl_reply (session_t *s)
252 echo_server_main_t *esm = &echo_server_main;
255 rv = svm_fifo_enqueue (s->tx_fifo, sizeof (esm->cfg), (u8 *) &esm->cfg);
256 ASSERT (rv == sizeof (esm->cfg));
257 session_send_io_evt_to_thread_custom (&s->session_index, s->thread_index,
262 es_test_cmd_sync (echo_server_main_t *esm, session_t *s)
266 rv = echo_server_setup_test (&esm->cfg);
268 es_err ("setup test error!");
270 echo_server_ctrl_reply (s);
275 es_wrk_cleanup_sessions (void *args)
277 echo_server_main_t *esm = &echo_server_main;
278 vnet_disconnect_args_t _a = {}, *a = &_a;
279 u32 thread_index = pointer_to_uword (args);
283 wrk = es_worker_get (thread_index);
284 a->app_index = esm->app_index;
286 pool_foreach (es, wrk->sessions)
288 a->handle = es->vpp_session_handle;
289 vnet_disconnect_session (a);
291 pool_free (wrk->sessions);
297 echo_server_rx_ctrl_callback (session_t *s)
299 echo_server_main_t *esm = &echo_server_main;
302 rv = svm_fifo_dequeue (s->rx_fifo, sizeof (esm->cfg), (u8 *) &esm->cfg);
303 ASSERT (rv == sizeof (esm->cfg));
305 es_dbg ("control message received:");
306 if (esm->cfg.verbose)
307 hs_test_cfg_dump (&esm->cfg, 0);
309 switch (esm->cfg.cmd)
311 case HS_TEST_CMD_SYNC:
312 switch (esm->cfg.test)
314 case HS_TEST_TYPE_ECHO:
315 case HS_TEST_TYPE_NONE:
316 es_foreach_thread (es_wrk_cleanup_sessions);
317 echo_server_ctrl_reply (s);
319 case HS_TEST_TYPE_UNI:
320 case HS_TEST_TYPE_BI:
321 return es_test_cmd_sync (esm, s);
324 es_err ("unknown command type! %d", esm->cfg.cmd);
327 case HS_TEST_CMD_START:
328 case HS_TEST_CMD_STOP:
329 echo_server_ctrl_reply (s);
332 es_err ("unknown command! %d", esm->cfg.cmd);
339 * If no-echo, just drop the data and be done with it.
342 echo_server_builtin_server_rx_callback_no_echo (session_t * s)
344 echo_server_main_t *esm = &echo_server_main;
345 if (PREDICT_FALSE (esm->ctrl_listener_handle == s->listener_handle))
346 return echo_server_rx_ctrl_callback (s);
348 svm_fifo_t *rx_fifo = s->rx_fifo;
349 svm_fifo_dequeue_drop (rx_fifo, svm_fifo_max_dequeue_cons (rx_fifo));
354 es_test_bytes (es_worker_t *wrk, es_session_t *es, int actual_transfer)
357 for (i = 0; i < actual_transfer; i++)
359 if (wrk->rx_buf[i] != ((es->byte_index + i) & 0xff))
361 es_err ("at %lld expected %d got %d", es->byte_index + i,
362 (es->byte_index + i) & 0xff, wrk->rx_buf[i]);
365 es->byte_index += actual_transfer;
369 echo_server_rx_callback (session_t * s)
371 u32 n_written, max_dequeue, max_enqueue, max_transfer;
373 svm_fifo_t *tx_fifo, *rx_fifo;
374 echo_server_main_t *esm = &echo_server_main;
375 u32 thread_index = vlib_get_thread_index ();
376 app_session_transport_t at;
380 ASSERT (s->thread_index == thread_index);
382 rx_fifo = s->rx_fifo;
383 tx_fifo = s->tx_fifo;
385 ASSERT (rx_fifo->master_thread_index == thread_index);
386 ASSERT (tx_fifo->master_thread_index == thread_index);
388 if (PREDICT_FALSE (esm->ctrl_listener_handle == s->listener_handle))
389 return echo_server_rx_ctrl_callback (s);
391 wrk = es_worker_get (thread_index);
392 max_enqueue = svm_fifo_max_enqueue_prod (tx_fifo);
396 max_dequeue = svm_fifo_max_dequeue_cons (rx_fifo);
400 session_dgram_pre_hdr_t ph;
401 svm_fifo_peek (rx_fifo, 0, sizeof (ph), (u8 *) & ph);
402 max_dequeue = ph.data_length - ph.data_offset;
403 ASSERT (wrk->vpp_event_queue);
404 max_enqueue -= sizeof (session_dgram_hdr_t);
407 if (PREDICT_FALSE (max_dequeue == 0))
410 es = es_session_get (wrk, s->opaque);
412 /* Number of bytes we're going to copy */
413 max_transfer = clib_min (max_dequeue, max_enqueue);
415 /* No space in tx fifo */
416 if (PREDICT_FALSE (max_transfer == 0))
418 /* XXX timeout for session that are stuck */
421 /* Program self-tap to retry */
422 if (svm_fifo_set_event (rx_fifo))
424 /* TODO should be session_enqueue_notify(s) but quic tests seem
425 * to fail if that's the case */
426 if (session_send_io_evt_to_thread (rx_fifo,
427 SESSION_IO_EVT_BUILTIN_RX))
428 es_err ("failed to enqueue self-tap");
430 if (es->rx_retries == 500000)
432 es_err ("session stuck: %U", format_session, s, 2);
434 if (es->rx_retries < 500001)
441 vec_validate (wrk->rx_buf, max_transfer);
445 app_recv_stream_raw (rx_fifo, wrk->rx_buf, max_transfer,
446 0 /* don't clear event */, 0 /* peek */);
451 app_recv_dgram_raw (rx_fifo, wrk->rx_buf, max_transfer, &at,
452 0 /* don't clear event */, 0 /* peek */);
454 ASSERT (actual_transfer == max_transfer);
456 if (esm->cfg.test_bytes)
458 es_test_bytes (wrk, es, actual_transfer);
467 n_written = app_send_stream_raw (tx_fifo, wrk->vpp_event_queue,
468 wrk->rx_buf, actual_transfer,
469 SESSION_IO_EVT_TX, 1 /* do_evt */, 0);
473 n_written = app_send_dgram_raw (tx_fifo, &at, wrk->vpp_event_queue,
474 wrk->rx_buf, actual_transfer,
475 SESSION_IO_EVT_TX, 1 /* do_evt */, 0);
478 if (n_written != max_transfer)
479 es_err ("short trout! written %u read %u", n_written, max_transfer);
481 if (PREDICT_FALSE (svm_fifo_max_dequeue_cons (rx_fifo)))
488 echo_server_rx_callback_common (session_t *s)
490 echo_server_main_t *esm = &echo_server_main;
491 return esm->rx_callback (s);
494 static session_cb_vft_t echo_server_session_cb_vft = {
495 .session_accept_callback = echo_server_session_accept_callback,
496 .session_disconnect_callback = echo_server_session_disconnect_callback,
497 .session_connected_callback = echo_server_session_connected_callback,
498 .add_segment_callback = echo_server_add_segment_callback,
499 .builtin_app_rx_callback = echo_server_rx_callback_common,
500 .session_reset_callback = echo_server_session_reset_callback
504 es_set_echo_rx_callbacks (u8 no_echo)
506 echo_server_main_t *esm = &echo_server_main;
508 esm->rx_callback = echo_server_builtin_server_rx_callback_no_echo;
510 esm->rx_callback = echo_server_rx_callback;
514 echo_server_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
516 vnet_app_add_cert_key_pair_args_t _ck_pair, *ck_pair = &_ck_pair;
517 echo_server_main_t *esm = &echo_server_main;
518 vnet_app_attach_args_t _a, *a = &_a;
519 u64 options[APP_OPTIONS_N_OPTIONS];
521 clib_memset (a, 0, sizeof (*a));
522 clib_memset (options, 0, sizeof (options));
524 esm->rx_callback = echo_server_rx_callback;
526 if (esm->transport_proto == TRANSPORT_PROTO_QUIC)
527 echo_server_session_cb_vft.session_accept_callback =
528 quic_echo_server_session_accept_callback;
530 a->api_client_index = ~0;
531 a->name = format (0, "echo_server");
532 a->session_cb_vft = &echo_server_session_cb_vft;
533 a->options = options;
534 a->options[APP_OPTIONS_SEGMENT_SIZE] = esm->private_segment_size;
535 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = esm->private_segment_size;
536 a->options[APP_OPTIONS_RX_FIFO_SIZE] = esm->fifo_size;
537 a->options[APP_OPTIONS_TX_FIFO_SIZE] = esm->fifo_size;
538 a->options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = esm->private_segment_count;
539 a->options[APP_OPTIONS_TLS_ENGINE] = esm->tls_engine;
540 a->options[APP_OPTIONS_PCT_FIRST_ALLOC] = 100;
541 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
542 esm->prealloc_fifos ? esm->prealloc_fifos : 1;
544 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
547 a->namespace_id = appns_id;
548 a->options[APP_OPTIONS_FLAGS] |= appns_flags;
549 a->options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
552 if (vnet_application_attach (a))
554 es_err ("failed to attach server");
557 esm->app_index = a->app_index;
560 clib_memset (ck_pair, 0, sizeof (*ck_pair));
561 ck_pair->cert = (u8 *) test_srv_crt_rsa;
562 ck_pair->key = (u8 *) test_srv_key_rsa;
563 ck_pair->cert_len = test_srv_crt_rsa_len;
564 ck_pair->key_len = test_srv_key_rsa_len;
565 vnet_app_add_cert_key_pair (ck_pair);
566 esm->ckpair_index = ck_pair->index;
572 echo_server_detach (void)
574 echo_server_main_t *esm = &echo_server_main;
575 vnet_app_detach_args_t _da, *da = &_da;
578 da->app_index = esm->app_index;
579 da->api_client_index = ~0;
580 rv = vnet_application_detach (da);
582 vnet_app_del_cert_key_pair (esm->ckpair_index);
587 echo_client_transport_needs_crypto (transport_proto_t proto)
589 return proto == TRANSPORT_PROTO_TLS || proto == TRANSPORT_PROTO_DTLS ||
590 proto == TRANSPORT_PROTO_QUIC;
594 echo_server_listen_ctrl ()
596 echo_server_main_t *esm = &echo_server_main;
597 vnet_listen_args_t _args = {}, *args = &_args;
600 if ((rv = parse_uri (esm->server_uri, &args->sep_ext)))
602 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
603 args->app_index = esm->app_index;
605 rv = vnet_listen (args);
606 esm->ctrl_listener_handle = args->handle;
611 echo_server_listen ()
614 echo_server_main_t *esm = &echo_server_main;
615 vnet_listen_args_t _args = {}, *args = &_args;
617 if ((rv = parse_uri (esm->server_uri, &args->sep_ext)))
621 args->app_index = esm->app_index;
622 args->sep_ext.port = hs_make_data_port (args->sep_ext.port);
623 if (echo_client_transport_needs_crypto (args->sep_ext.transport_proto))
625 session_endpoint_alloc_ext_cfg (&args->sep_ext,
626 TRANSPORT_ENDPT_EXT_CFG_CRYPTO);
627 args->sep_ext.ext_cfg->crypto.ckpair_index = esm->ckpair_index;
630 if (args->sep_ext.transport_proto == TRANSPORT_PROTO_UDP)
632 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
635 rv = vnet_listen (args);
636 esm->listener_handle = args->handle;
637 if (args->sep_ext.ext_cfg)
638 clib_mem_free (args->sep_ext.ext_cfg);
643 echo_server_create (vlib_main_t * vm, u8 * appns_id, u64 appns_flags,
646 echo_server_main_t *esm = &echo_server_main;
647 vlib_thread_main_t *vtm = vlib_get_thread_main ();
650 esm->rcv_buffer_size = clib_max (esm->rcv_buffer_size, esm->fifo_size);
651 vec_validate (esm->wrk, vtm->n_threads);
653 vec_foreach (wrk, esm->wrk)
655 wrk->thread_index = wrk - esm->wrk;
656 vec_validate (wrk->rx_buf, esm->rcv_buffer_size);
657 wrk->vpp_event_queue =
658 session_main_get_vpp_event_queue (wrk->thread_index);
661 if (echo_server_attach (appns_id, appns_flags, appns_secret))
663 es_err ("failed to attach server");
666 if (echo_server_listen_ctrl ())
668 es_err ("failed to start listening on ctrl session");
669 if (echo_server_detach ())
670 es_err ("failed to detach");
673 if (echo_server_listen ())
675 es_err ("failed to start listening");
676 if (echo_server_detach ())
677 es_err ("failed to detach");
683 static clib_error_t *
684 echo_server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
685 vlib_cli_command_t * cmd)
687 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
688 echo_server_main_t *esm = &echo_server_main;
689 u8 server_uri_set = 0, *appns_id = 0;
690 u64 appns_flags = 0, appns_secret = 0;
691 char *default_uri = "tcp://0.0.0.0/1234";
693 clib_error_t *error = 0;
695 esm->fifo_size = 64 << 10;
696 esm->rcv_buffer_size = 128 << 10;
697 esm->prealloc_fifos = 0;
698 esm->private_segment_count = 0;
699 esm->private_segment_size = 512 << 20;
700 esm->tls_engine = CRYPTO_ENGINE_OPENSSL;
701 vec_free (esm->server_uri);
703 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
705 if (unformat (input, "uri %s", &esm->server_uri))
707 else if (unformat (input, "fifo-size %U", unformat_memory_size,
710 else if (unformat (input, "rcv-buf-size %d", &esm->rcv_buffer_size))
712 else if (unformat (input, "prealloc-fifos %d", &esm->prealloc_fifos))
714 else if (unformat (input, "private-segment-count %d",
715 &esm->private_segment_count))
717 else if (unformat (input, "private-segment-size %U",
718 unformat_memory_size, &esm->private_segment_size))
720 else if (unformat (input, "appns %_%v%_", &appns_id))
722 else if (unformat (input, "all-scope"))
723 appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
724 | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
725 else if (unformat (input, "local-scope"))
726 appns_flags |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
727 else if (unformat (input, "global-scope"))
728 appns_flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
729 else if (unformat (input, "secret %lu", &appns_secret))
731 else if (unformat (input, "stop"))
733 else if (unformat (input, "tls-engine %d", &esm->tls_engine))
737 error = clib_error_return (0, "failed: unknown input `%U'",
738 format_unformat_error, input);
745 if (esm->app_index == (u32) ~ 0)
747 es_cli ("server not running");
748 error = clib_error_return (0, "failed: server not running");
751 rv = echo_server_detach ();
754 es_cli ("failed: detach");
755 error = clib_error_return (0, "failed: server detach %d", rv);
761 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
765 es_cli ("No uri provided! Using default: %s", default_uri);
766 esm->server_uri = (char *) format (0, "%s%c", default_uri, 0);
769 if ((rv = parse_uri ((char *) esm->server_uri, &sep)))
771 error = clib_error_return (0, "Uri parse error: %d", rv);
774 esm->transport_proto = sep.transport_proto;
775 esm->is_dgram = (sep.transport_proto == TRANSPORT_PROTO_UDP);
777 rv = echo_server_create (vm, appns_id, appns_flags, appns_secret);
780 vec_free (esm->server_uri);
781 error = clib_error_return (0, "failed: server_create returned %d", rv);
792 VLIB_CLI_COMMAND (echo_server_create_command, static) = {
793 .path = "test echo server",
795 "test echo server proto <proto> [fifo-size <mbytes>]"
796 "[rcv-buf-size <bytes>][prealloc-fifos <count>]"
797 "[private-segment-count <count>][private-segment-size <bytes[m|g]>]"
798 "[uri <tcp://ip/port>]",
799 .function = echo_server_create_command_fn,
804 echo_server_main_init (vlib_main_t * vm)
809 VLIB_INIT_FUNCTION (echo_server_main_init);
812 * fd.io coding-style-patch-verification: ON
815 * eval: (c-set-style "gnu")