2 * builtin_client.c - vpp built-in tcp client/connect code
4 * Copyright (c) 2017 by Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vnet/vnet.h>
19 #include <vnet/plugin/plugin.h>
20 #include <vnet/tcp/builtin_client.h>
22 #include <vlibapi/api.h>
23 #include <vlibmemory/api.h>
24 #include <vpp/app/version.h>
26 #define TCP_BUILTIN_CLIENT_DBG (0)
29 signal_evt_to_cli_i (int *code)
31 tclient_main_t *tm = &tclient_main;
32 ASSERT (vlib_get_thread_index () == 0);
33 vlib_process_signal_event (tm->vlib_main, tm->cli_node_index, *code, 0);
37 signal_evt_to_cli (int code)
39 if (vlib_get_thread_index () != 0)
40 vl_api_rpc_call_main_thread (signal_evt_to_cli_i, (u8 *) & code,
43 signal_evt_to_cli_i (&code);
47 send_test_chunk (tclient_main_t * tm, session_t * s)
49 u8 *test_data = tm->connect_test_data;
52 session_fifo_event_t evt;
56 ASSERT (vec_len (test_data) > 0);
58 test_buf_offset = s->bytes_sent % vec_len (test_data);
59 bytes_this_chunk = vec_len (test_data) - test_buf_offset;
61 bytes_this_chunk = bytes_this_chunk < s->bytes_to_send
62 ? bytes_this_chunk : s->bytes_to_send;
64 txf = s->server_tx_fifo;
65 rv = svm_fifo_enqueue_nowait (txf, bytes_this_chunk,
66 test_data + test_buf_offset);
68 /* If we managed to enqueue data... */
71 /* Account for it... */
72 s->bytes_to_send -= rv;
75 if (TCP_BUILTIN_CLIENT_DBG)
78 ELOG_TYPE_DECLARE (e) =
80 .format = "tx-enq: xfer %d bytes, sent %u remain %u",
81 .format_args = "i4i4i4",
88 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
90 ed->data[1] = s->bytes_sent;
91 ed->data[2] = s->bytes_to_send;
94 /* Poke the session layer */
95 if (svm_fifo_set_event (txf))
97 /* Fabricate TX event, send to vpp */
99 evt.event_type = FIFO_EVENT_APP_TX;
101 if (unix_shared_memory_queue_add
102 (tm->vpp_event_queue[txf->master_thread_index], (u8 *) & evt,
103 0 /* do wait for mutex */ ))
104 clib_warning ("could not enqueue event");
110 receive_test_chunk (tclient_main_t * tm, session_t * s)
112 svm_fifo_t *rx_fifo = s->server_rx_fifo;
113 int n_read, test_bytes = 0;
114 u32 my_thread_index = vlib_get_thread_index ();
116 /* Allow enqueuing of new event */
117 // svm_fifo_unset_event (rx_fifo);
121 n_read = svm_fifo_dequeue_nowait (rx_fifo,
122 vec_len (tm->rx_buf[my_thread_index]),
123 tm->rx_buf[my_thread_index]);
127 n_read = svm_fifo_max_dequeue (rx_fifo);
128 svm_fifo_dequeue_drop (rx_fifo, n_read);
133 if (TCP_BUILTIN_CLIENT_DBG)
136 ELOG_TYPE_DECLARE (e) =
138 .format = "rx-deq: %d bytes",
146 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
147 ed->data[0] = n_read;
153 for (i = 0; i < n_read; i++)
155 if (tm->rx_buf[my_thread_index][i]
156 != ((s->bytes_received + i) & 0xff))
158 clib_warning ("read %d error at byte %lld, 0x%x not 0x%x",
159 n_read, s->bytes_received + i,
160 tm->rx_buf[my_thread_index][i],
161 ((s->bytes_received + i) & 0xff));
165 s->bytes_to_receive -= n_read;
166 s->bytes_received += n_read;
171 builtin_client_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
172 vlib_frame_t * frame)
174 tclient_main_t *tm = &tclient_main;
175 int my_thread_index = vlib_get_thread_index ();
179 u32 *connection_indices;
180 u32 *connections_this_batch;
181 u32 nconnections_this_batch;
183 connection_indices = tm->connection_index_by_thread[my_thread_index];
184 connections_this_batch =
185 tm->connections_this_batch_by_thread[my_thread_index];
187 if ((tm->run_test == 0) ||
188 ((vec_len (connection_indices) == 0)
189 && vec_len (connections_this_batch) == 0))
192 /* Grab another pile of connections */
193 if (PREDICT_FALSE (vec_len (connections_this_batch) == 0))
195 nconnections_this_batch =
196 clib_min (tm->connections_per_batch, vec_len (connection_indices));
198 ASSERT (nconnections_this_batch > 0);
199 vec_validate (connections_this_batch, nconnections_this_batch - 1);
200 clib_memcpy (connections_this_batch,
201 connection_indices + vec_len (connection_indices)
202 - nconnections_this_batch,
203 nconnections_this_batch * sizeof (u32));
204 _vec_len (connection_indices) -= nconnections_this_batch;
207 if (PREDICT_FALSE (tm->prev_conns != tm->connections_per_batch
208 && tm->prev_conns == vec_len (connections_this_batch)))
211 tm->prev_conns = vec_len (connections_this_batch);
212 if (tm->repeats == 500000)
214 clib_warning ("stuck clients");
219 tm->prev_conns = vec_len (connections_this_batch);
223 for (i = 0; i < vec_len (connections_this_batch); i++)
227 sp = pool_elt_at_index (tm->sessions, connections_this_batch[i]);
229 if (sp->bytes_to_send > 0)
231 send_test_chunk (tm, sp);
234 if (sp->bytes_to_receive > 0)
236 receive_test_chunk (tm, sp);
239 if (PREDICT_FALSE (delete_session == 1))
241 u32 index, thread_index;
244 __sync_fetch_and_add (&tm->tx_total, sp->bytes_sent);
245 __sync_fetch_and_add (&tm->rx_total, sp->bytes_received);
247 session_parse_handle (sp->vpp_session_handle,
248 &index, &thread_index);
249 s = session_get_if_valid (index, thread_index);
253 vnet_disconnect_args_t _a, *a = &_a;
254 a->handle = session_handle (s);
255 a->app_index = tm->app_index;
256 vnet_disconnect_session (a);
258 vec_delete (connections_this_batch, 1, i);
260 __sync_fetch_and_add (&tm->ready_connections, -1);
263 clib_warning ("session AWOL?");
265 /* Kick the debug CLI process */
266 if (tm->ready_connections == 0)
268 signal_evt_to_cli (2);
273 tm->connection_index_by_thread[my_thread_index] = connection_indices;
274 tm->connections_this_batch_by_thread[my_thread_index] =
275 connections_this_batch;
280 VLIB_REGISTER_NODE (builtin_client_node) =
282 .function = builtin_client_node_fn,
283 .name = "builtin-tcp-client",
284 .type = VLIB_NODE_TYPE_INPUT,
285 .state = VLIB_NODE_STATE_DISABLED,
290 create_api_loopback (tclient_main_t * tm)
292 api_main_t *am = &api_main;
293 vl_shmem_hdr_t *shmem_hdr;
295 shmem_hdr = am->shmem_hdr;
296 tm->vl_input_queue = shmem_hdr->vl_input_queue;
297 tm->my_client_index =
298 vl_api_memclnt_create_internal ("tcp_test_client", tm->vl_input_queue);
303 tcp_test_clients_init (vlib_main_t * vm)
305 tclient_main_t *tm = &tclient_main;
306 vlib_thread_main_t *vtm = vlib_get_thread_main ();
310 if (create_api_loopback (tm))
313 num_threads = 1 /* main thread */ + vtm->n_threads;
315 /* Init test data. Big buffer */
316 vec_validate (tm->connect_test_data, 1024 * 1024 - 1);
317 for (i = 0; i < vec_len (tm->connect_test_data); i++)
318 tm->connect_test_data[i] = i & 0xff;
320 vec_validate (tm->rx_buf, num_threads - 1);
321 for (i = 0; i < num_threads; i++)
322 vec_validate (tm->rx_buf[i], vec_len (tm->connect_test_data) - 1);
326 vec_validate (tm->connection_index_by_thread, vtm->n_vlib_mains);
327 vec_validate (tm->connections_this_batch_by_thread, vtm->n_vlib_mains);
328 vec_validate (tm->vpp_event_queue, vtm->n_vlib_mains);
334 builtin_session_connected_callback (u32 app_index, u32 api_context,
335 stream_session_t * s, u8 is_fail)
337 tclient_main_t *tm = &tclient_main;
340 u8 thread_index = vlib_get_thread_index ();
344 clib_warning ("connection %d failed!", api_context);
345 signal_evt_to_cli (-1);
349 ASSERT (s->thread_index == thread_index);
351 if (!tm->vpp_event_queue[thread_index])
352 tm->vpp_event_queue[thread_index] =
353 session_manager_get_vpp_event_queue (thread_index);
358 clib_spinlock_lock_if_init (&tm->sessions_lock);
359 pool_get (tm->sessions, session);
360 clib_spinlock_unlock_if_init (&tm->sessions_lock);
362 memset (session, 0, sizeof (*session));
363 session_index = session - tm->sessions;
364 session->bytes_to_send = tm->bytes_to_send;
365 session->bytes_to_receive = tm->no_return ? 0ULL : tm->bytes_to_send;
366 session->server_rx_fifo = s->server_rx_fifo;
367 session->server_rx_fifo->client_session_index = session_index;
368 session->server_tx_fifo = s->server_tx_fifo;
369 session->server_tx_fifo->client_session_index = session_index;
370 session->vpp_session_handle = session_handle (s);
372 vec_add1 (tm->connection_index_by_thread[thread_index], session_index);
373 __sync_fetch_and_add (&tm->ready_connections, 1);
374 if (tm->ready_connections == tm->expected_connections)
377 /* Signal the CLI process that the action is starting... */
378 signal_evt_to_cli (1);
385 builtin_session_reset_callback (stream_session_t * s)
387 if (s->session_state == SESSION_STATE_READY)
388 clib_warning ("Reset active connection %U", format_stream_session, s, 2);
389 stream_session_cleanup (s);
394 builtin_session_create_callback (stream_session_t * s)
400 builtin_session_disconnect_callback (stream_session_t * s)
402 tclient_main_t *tm = &tclient_main;
403 vnet_disconnect_args_t _a, *a = &_a;
404 a->handle = session_handle (s);
405 a->app_index = tm->app_index;
406 vnet_disconnect_session (a);
411 builtin_server_rx_callback (stream_session_t * s)
417 static session_cb_vft_t builtin_clients = {
418 .session_reset_callback = builtin_session_reset_callback,
419 .session_connected_callback = builtin_session_connected_callback,
420 .session_accept_callback = builtin_session_create_callback,
421 .session_disconnect_callback = builtin_session_disconnect_callback,
422 .builtin_server_rx_callback = builtin_server_rx_callback
426 static clib_error_t *
427 attach_builtin_test_clients_app (u8 * appns_id, u64 appns_flags,
430 tclient_main_t *tm = &tclient_main;
431 vnet_app_attach_args_t _a, *a = &_a;
432 u8 segment_name[128];
433 u32 segment_name_length, prealloc_fifos;
435 clib_error_t *error = 0;
437 segment_name_length = ARRAY_LEN (segment_name);
439 memset (a, 0, sizeof (*a));
440 memset (options, 0, sizeof (options));
442 a->api_client_index = tm->my_client_index;
443 a->segment_name = segment_name;
444 a->segment_name_length = segment_name_length;
445 a->session_cb_vft = &builtin_clients;
447 prealloc_fifos = tm->prealloc_fifos ? tm->expected_connections : 1;
449 options[SESSION_OPTIONS_ACCEPT_COOKIE] = 0x12345678;
450 options[SESSION_OPTIONS_SEGMENT_SIZE] = (2ULL << 32);
451 options[SESSION_OPTIONS_RX_FIFO_SIZE] = tm->fifo_size;
452 options[SESSION_OPTIONS_TX_FIFO_SIZE] = tm->fifo_size;
453 options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = tm->private_segment_count;
454 options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE] = tm->private_segment_size;
455 options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = prealloc_fifos;
457 options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_BUILTIN_APP;
460 options[APP_OPTIONS_FLAGS] |= appns_flags;
461 options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
463 a->options = options;
464 a->namespace_id = appns_id;
466 if ((error = vnet_application_attach (a)))
469 tm->app_index = a->app_index;
474 tclient_thread_fn (void *arg)
479 /** Start a transmit thread */
481 start_tx_pthread (tclient_main_t * tm)
483 if (tm->client_thread_handle == 0)
485 int rv = pthread_create (&tm->client_thread_handle,
487 tclient_thread_fn, 0);
490 tm->client_thread_handle = 0;
498 clients_connect (vlib_main_t * vm, u8 * uri, u32 n_clients)
500 tclient_main_t *tm = &tclient_main;
501 vnet_connect_args_t _a, *a = &_a;
502 clib_error_t *error = 0;
504 for (i = 0; i < n_clients; i++)
506 memset (a, 0, sizeof (*a));
508 a->uri = (char *) uri;
510 a->app_index = tm->app_index;
513 if ((error = vnet_connect_uri (a)))
517 /* Crude pacing for call setups */
519 vlib_process_suspend (vm, 10e-6);
520 ASSERT (i + 1 >= tm->ready_connections);
521 while (i + 1 - tm->ready_connections > 1000)
523 vlib_process_suspend (vm, 100e-6);
529 static clib_error_t *
530 test_tcp_clients_command_fn (vlib_main_t * vm,
531 unformat_input_t * input,
532 vlib_cli_command_t * cmd)
534 tclient_main_t *tm = &tclient_main;
535 vlib_thread_main_t *thread_main = vlib_get_thread_main ();
536 uword *event_data = 0, event_type;
537 u8 *default_connect_uri = (u8 *) "tcp://6.0.1.1/1234", *uri, *appns_id;
538 u64 tmp, total_bytes, appns_flags = 0, appns_secret = 0;
539 f64 test_timeout = 20.0, syn_timeout = 20.0, delta;
540 f64 time_before_connects;
542 int preallocate_sessions = 0;
544 clib_error_t *error = 0;
547 tm->bytes_to_send = 8192;
549 tm->fifo_size = 64 << 10;
550 tm->connections_per_batch = 1000;
551 tm->private_segment_count = 0;
552 tm->private_segment_size = 0;
554 if (thread_main->n_vlib_mains > 1)
555 clib_spinlock_init (&tm->sessions_lock);
556 vec_free (tm->connect_uri);
558 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
560 if (unformat (input, "nclients %d", &n_clients))
562 else if (unformat (input, "mbytes %lld", &tmp))
563 tm->bytes_to_send = tmp << 20;
564 else if (unformat (input, "gbytes %lld", &tmp))
565 tm->bytes_to_send = tmp << 30;
566 else if (unformat (input, "bytes %lld", &tm->bytes_to_send))
568 else if (unformat (input, "uri %s", &tm->connect_uri))
570 else if (unformat (input, "test-timeout %f", &test_timeout))
572 else if (unformat (input, "syn-timeout %f", &syn_timeout))
574 else if (unformat (input, "no-return"))
576 else if (unformat (input, "fifo-size %d", &tm->fifo_size))
577 tm->fifo_size <<= 10;
578 else if (unformat (input, "private-segment-count %d",
579 &tm->private_segment_count))
581 else if (unformat (input, "private-segment-size %U",
582 unformat_memory_size, &tmp))
584 if (tmp >= 0x100000000ULL)
585 return clib_error_return
586 (0, "private segment size %lld (%llu) too large", tmp, tmp);
587 tm->private_segment_size = tmp;
589 else if (unformat (input, "preallocate-fifos"))
590 tm->prealloc_fifos = 1;
591 else if (unformat (input, "preallocate-sessions"))
592 preallocate_sessions = 1;
594 if (unformat (input, "client-batch %d", &tm->connections_per_batch))
596 else if (unformat (input, "appns %_%v%_", &appns_id))
598 else if (unformat (input, "all-scope"))
599 appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
600 | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
601 else if (unformat (input, "local-scope"))
602 appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
603 else if (unformat (input, "global-scope"))
604 appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
605 else if (unformat (input, "secret %lu", &appns_secret))
608 return clib_error_return (0, "unknown input `%U'",
609 format_unformat_error, input);
612 /* Store cli process node index for signalling */
613 tm->cli_node_index = vlib_get_current_process (vm)->node_runtime.node_index;
615 if (tm->is_init == 0)
617 if (tcp_test_clients_init (vm))
618 return clib_error_return (0, "failed init");
622 tm->ready_connections = 0;
623 tm->expected_connections = n_clients;
627 uri = default_connect_uri;
629 uri = tm->connect_uri;
631 #if TCP_BUILTIN_CLIENT_PTHREAD
635 vlib_worker_thread_barrier_sync (vm);
636 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
637 vlib_worker_thread_barrier_release (vm);
639 if (tm->test_client_attached == 0)
641 if ((error = attach_builtin_test_clients_app (appns_id, appns_flags,
645 clib_error_report (error);
650 tm->test_client_attached = 1;
652 /* Turn on the builtin client input nodes */
653 for (i = 0; i < thread_main->n_vlib_mains; i++)
654 vlib_node_set_state (vlib_mains[i], builtin_client_node.index,
655 VLIB_NODE_STATE_POLLING);
657 if (preallocate_sessions)
659 session_t *sp __attribute__ ((unused));
660 for (i = 0; i < n_clients; i++)
661 pool_get (tm->sessions, sp);
662 for (i = 0; i < n_clients; i++)
663 pool_put_index (tm->sessions, i);
666 /* Fire off connect requests */
667 time_before_connects = vlib_time_now (vm);
668 if ((error = clients_connect (vm, uri, n_clients)))
671 /* Park until the sessions come up, or ten seconds elapse... */
672 vlib_process_wait_for_event_or_clock (vm, syn_timeout);
673 event_type = vlib_process_get_events (vm, &event_data);
677 vlib_cli_output (vm, "Timeout with only %d sessions active...",
678 tm->ready_connections);
682 delta = vlib_time_now (vm) - time_before_connects;
687 (vm, "%d three-way handshakes in %.2f seconds, %.2f/sec",
688 n_clients, delta, ((f64) n_clients) / delta);
691 tm->test_start_time = vlib_time_now (tm->vlib_main);
692 vlib_cli_output (vm, "Test started at %.6f", tm->test_start_time);
696 vlib_cli_output (vm, "unexpected event(1): %d", event_type);
700 /* Now wait for the sessions to finish... */
701 vlib_process_wait_for_event_or_clock (vm, test_timeout);
702 event_type = vlib_process_get_events (vm, &event_data);
706 vlib_cli_output (vm, "Timeout with %d sessions still active...",
707 tm->ready_connections);
711 tm->test_end_time = vlib_time_now (vm);
712 vlib_cli_output (vm, "Test finished at %.6f", tm->test_end_time);
716 vlib_cli_output (vm, "unexpected event(2): %d", event_type);
720 delta = tm->test_end_time - tm->test_start_time;
724 total_bytes = (tm->no_return ? tm->tx_total : tm->rx_total);
725 transfer_type = tm->no_return ? "half-duplex" : "full-duplex";
727 "%lld bytes (%lld mbytes, %lld gbytes) in %.2f seconds",
728 total_bytes, total_bytes / (1ULL << 20),
729 total_bytes / (1ULL << 30), delta);
730 vlib_cli_output (vm, "%.2f bytes/second %s",
731 ((f64) total_bytes) / (delta), transfer_type);
732 vlib_cli_output (vm, "%.4f gbit/second %s",
733 (((f64) total_bytes * 8.0) / delta / 1e9),
737 vlib_cli_output (vm, "zero delta-t?");
741 for (i = 0; i < vec_len (tm->connection_index_by_thread); i++)
743 vec_reset_length (tm->connection_index_by_thread[i]);
744 vec_reset_length (tm->connections_this_batch_by_thread[i]);
747 pool_free (tm->sessions);
749 /* Detach the application, so we can use different fifo sizes next time */
750 if (tm->test_client_attached)
752 vnet_app_detach_args_t _da, *da = &_da;
755 da->app_index = tm->app_index;
757 rv = vnet_application_detach (da);
759 vlib_cli_output (vm, "WARNING: app detach failed...");
760 tm->test_client_attached = 0;
767 VLIB_CLI_COMMAND (test_clients_command, static) =
769 .path = "test tcp clients",
770 .short_help = "test tcp clients [nclients %d] [[m|g]bytes <bytes>] "
771 "[test-timeout <time>][syn-timeout <time>][no-return][fifo-size <size>]"
772 "[private-segment-count <count>][private-segment-size <bytes>[m|g]]"
773 "[preallocate-fifos][preallocate-sessions][client-batch <batch-size>]"
774 "[uri <tcp://ip/port>]",
775 .function = test_tcp_clients_command_fn,
781 tcp_test_clients_main_init (vlib_main_t * vm)
783 tclient_main_t *tm = &tclient_main;
788 VLIB_INIT_FUNCTION (tcp_test_clients_main_init);
791 * fd.io coding-style-patch-verification: ON
794 * eval: (c-set-style "gnu")