src/vnet/session-apps/echo_client.c

   1 /*
   2  * echo_client.c - vpp built-in echo client code
   3  *
   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:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17
  18 #include <vnet/vnet.h>
  19 #include <vlibapi/api.h>
  20 #include <vlibmemory/api.h>
  21 #include <vnet/session-apps/echo_client.h>
  22
  23 echo_client_main_t echo_client_main;
  24
  25 #define ECHO_CLIENT_DBG (0)
  26
  27 static void
  28 signal_evt_to_cli_i (int *code)
  29 {
  30   echo_client_main_t *ecm = &echo_client_main;
  31   ASSERT (vlib_get_thread_index () == 0);
  32   vlib_process_signal_event (ecm->vlib_main, ecm->cli_node_index, *code, 0);
  33 }
  34
  35 static void
  36 signal_evt_to_cli (int code)
  37 {
  38   if (vlib_get_thread_index () != 0)
  39     vl_api_rpc_call_main_thread (signal_evt_to_cli_i, (u8 *) & code,
  40                                  sizeof (code));
  41   else
  42     signal_evt_to_cli_i (&code);
  43 }
  44
  45 static void
  46 send_data_chunk (echo_client_main_t * ecm, eclient_session_t * s)
  47 {
  48   u8 *test_data = ecm->connect_test_data;
  49   int test_buf_len, test_buf_offset, rv;
  50   u32 bytes_this_chunk;
  51
  52   test_buf_len = vec_len (test_data);
  53   ASSERT (test_buf_len > 0);
  54   test_buf_offset = s->bytes_sent % test_buf_len;
  55   bytes_this_chunk = clib_min (test_buf_len - test_buf_offset,
  56                                s->bytes_to_send);
  57
  58   if (!ecm->is_dgram)
  59     {
  60       if (ecm->no_copy)
  61         {
  62           svm_fifo_t *f = s->data.tx_fifo;
  63           rv = clib_min (svm_fifo_max_enqueue (f), bytes_this_chunk);
  64           svm_fifo_enqueue_nocopy (f, rv);
  65           if (svm_fifo_set_event (f))
  66             {
  67               session_fifo_event_t evt;
  68               evt.fifo = f;
  69               evt.event_type = FIFO_EVENT_APP_TX;
  70               svm_queue_add (s->data.vpp_evt_q, (u8 *) & evt, 0);
  71             }
  72         }
  73       else
  74         rv = app_send_stream (&s->data, test_data + test_buf_offset,
  75                               bytes_this_chunk, 0);
  76     }
  77   else
  78     {
  79       if (ecm->no_copy)
  80         {
  81           session_dgram_hdr_t hdr;
  82           svm_fifo_t *f = s->data.tx_fifo;
  83           app_session_transport_t *at = &s->data.transport;
  84           u32 max_enqueue = svm_fifo_max_enqueue (f);
  85
  86           if (max_enqueue <= sizeof (session_dgram_hdr_t))
  87             return;
  88
  89           max_enqueue -= sizeof (session_dgram_hdr_t);
  90           rv = clib_min (max_enqueue, bytes_this_chunk);
  91
  92           hdr.data_length = rv;
  93           hdr.data_offset = 0;
  94           clib_memcpy (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
  95           hdr.is_ip4 = at->is_ip4;
  96           hdr.rmt_port = at->rmt_port;
  97           clib_memcpy (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
  98           hdr.lcl_port = at->lcl_port;
  99           svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
 100           svm_fifo_enqueue_nocopy (f, rv);
 101           if (svm_fifo_set_event (f))
 102             {
 103               session_fifo_event_t evt;
 104               evt.fifo = f;
 105               evt.event_type = FIFO_EVENT_APP_TX;
 106               svm_queue_add (s->data.vpp_evt_q, (u8 *) & evt, 0);
 107             }
 108         }
 109       else
 110         rv = app_send_dgram (&s->data, test_data + test_buf_offset,
 111                              bytes_this_chunk, 0);
 112     }
 113
 114   /* If we managed to enqueue data... */
 115   if (rv > 0)
 116     {
 117       /* Account for it... */
 118       s->bytes_to_send -= rv;
 119       s->bytes_sent += rv;
 120
 121       if (ECHO_CLIENT_DBG)
 122         {
 123           /* *INDENT-OFF* */
 124           ELOG_TYPE_DECLARE (e) =
 125             {
 126               .format = "tx-enq: xfer %d bytes, sent %u remain %u",
 127               .format_args = "i4i4i4",
 128             };
 129           /* *INDENT-ON* */
 130           struct
 131           {
 132             u32 data[3];
 133           } *ed;
 134           ed = ELOG_DATA (&vlib_global_main.elog_main, e);
 135           ed->data[0] = rv;
 136           ed->data[1] = s->bytes_sent;
 137           ed->data[2] = s->bytes_to_send;
 138         }
 139     }
 140 }
 141
 142 static void
 143 receive_data_chunk (echo_client_main_t * ecm, eclient_session_t * s)
 144 {
 145   svm_fifo_t *rx_fifo = s->data.rx_fifo;
 146   u32 thread_index = vlib_get_thread_index ();
 147   int n_read, i;
 148
 149   if (ecm->test_bytes)
 150     {
 151       if (!ecm->is_dgram)
 152         n_read = app_recv_stream (&s->data, ecm->rx_buf[thread_index],
 153                                   vec_len (ecm->rx_buf[thread_index]));
 154       else
 155         n_read = app_recv_dgram (&s->data, ecm->rx_buf[thread_index],
 156                                  vec_len (ecm->rx_buf[thread_index]));
 157     }
 158   else
 159     {
 160       n_read = svm_fifo_max_dequeue (rx_fifo);
 161       svm_fifo_dequeue_drop (rx_fifo, n_read);
 162     }
 163
 164   if (n_read > 0)
 165     {
 166       if (ECHO_CLIENT_DBG)
 167         {
 168           /* *INDENT-OFF* */
 169           ELOG_TYPE_DECLARE (e) =
 170             {
 171               .format = "rx-deq: %d bytes",
 172               .format_args = "i4",
 173             };
 174           /* *INDENT-ON* */
 175           struct
 176           {
 177             u32 data[1];
 178           } *ed;
 179           ed = ELOG_DATA (&vlib_global_main.elog_main, e);
 180           ed->data[0] = n_read;
 181         }
 182
 183       if (ecm->test_bytes)
 184         {
 185           for (i = 0; i < n_read; i++)
 186             {
 187               if (ecm->rx_buf[thread_index][i]
 188                   != ((s->bytes_received + i) & 0xff))
 189                 {
 190                   clib_warning ("read %d error at byte %lld, 0x%x not 0x%x",
 191                                 n_read, s->bytes_received + i,
 192                                 ecm->rx_buf[thread_index][i],
 193                                 ((s->bytes_received + i) & 0xff));
 194                   ecm->test_failed = 1;
 195                 }
 196             }
 197         }
 198       ASSERT (n_read <= s->bytes_to_receive);
 199       s->bytes_to_receive -= n_read;
 200       s->bytes_received += n_read;
 201     }
 202 }
 203
 204 static uword
 205 echo_client_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
 206                      vlib_frame_t * frame)
 207 {
 208   echo_client_main_t *ecm = &echo_client_main;
 209   int my_thread_index = vlib_get_thread_index ();
 210   eclient_session_t *sp;
 211   int i;
 212   int delete_session;
 213   u32 *connection_indices;
 214   u32 *connections_this_batch;
 215   u32 nconnections_this_batch;
 216
 217   connection_indices = ecm->connection_index_by_thread[my_thread_index];
 218   connections_this_batch =
 219     ecm->connections_this_batch_by_thread[my_thread_index];
 220
 221   if ((ecm->run_test == 0) ||
 222       ((vec_len (connection_indices) == 0)
 223        && vec_len (connections_this_batch) == 0))
 224     return 0;
 225
 226   /* Grab another pile of connections */
 227   if (PREDICT_FALSE (vec_len (connections_this_batch) == 0))
 228     {
 229       nconnections_this_batch =
 230         clib_min (ecm->connections_per_batch, vec_len (connection_indices));
 231
 232       ASSERT (nconnections_this_batch > 0);
 233       vec_validate (connections_this_batch, nconnections_this_batch - 1);
 234       clib_memcpy (connections_this_batch,
 235                    connection_indices + vec_len (connection_indices)
 236                    - nconnections_this_batch,
 237                    nconnections_this_batch * sizeof (u32));
 238       _vec_len (connection_indices) -= nconnections_this_batch;
 239     }
 240
 241   if (PREDICT_FALSE (ecm->prev_conns != ecm->connections_per_batch
 242                      && ecm->prev_conns == vec_len (connections_this_batch)))
 243     {
 244       ecm->repeats++;
 245       ecm->prev_conns = vec_len (connections_this_batch);
 246       if (ecm->repeats == 500000)
 247         {
 248           clib_warning ("stuck clients");
 249         }
 250     }
 251   else
 252     {
 253       ecm->prev_conns = vec_len (connections_this_batch);
 254       ecm->repeats = 0;
 255     }
 256
 257   for (i = 0; i < vec_len (connections_this_batch); i++)
 258     {
 259       delete_session = 1;
 260
 261       sp = pool_elt_at_index (ecm->sessions, connections_this_batch[i]);
 262
 263       if (sp->bytes_to_send > 0)
 264         {
 265           send_data_chunk (ecm, sp);
 266           delete_session = 0;
 267         }
 268       if (sp->bytes_to_receive > 0)
 269         {
 270           delete_session = 0;
 271         }
 272       if (PREDICT_FALSE (delete_session == 1))
 273         {
 274           stream_session_t *s;
 275
 276           __sync_fetch_and_add (&ecm->tx_total, sp->bytes_sent);
 277           __sync_fetch_and_add (&ecm->rx_total, sp->bytes_received);
 278           s = session_get_from_handle_if_valid (sp->vpp_session_handle);
 279
 280           if (s)
 281             {
 282               vnet_disconnect_args_t _a, *a = &_a;
 283               a->handle = session_handle (s);
 284               a->app_index = ecm->app_index;
 285               vnet_disconnect_session (a);
 286
 287               vec_delete (connections_this_batch, 1, i);
 288               i--;
 289               __sync_fetch_and_add (&ecm->ready_connections, -1);
 290             }
 291           else
 292             {
 293               clib_warning ("session AWOL?");
 294               vec_delete (connections_this_batch, 1, i);
 295             }
 296
 297           /* Kick the debug CLI process */
 298           if (ecm->ready_connections == 0)
 299             {
 300               signal_evt_to_cli (2);
 301             }
 302         }
 303     }
 304
 305   ecm->connection_index_by_thread[my_thread_index] = connection_indices;
 306   ecm->connections_this_batch_by_thread[my_thread_index] =
 307     connections_this_batch;
 308   return 0;
 309 }
 310
 311 /* *INDENT-OFF* */
 312 VLIB_REGISTER_NODE (echo_clients_node) =
 313 {
 314   .function = echo_client_node_fn,
 315   .name = "echo-clients",
 316   .type = VLIB_NODE_TYPE_INPUT,
 317   .state = VLIB_NODE_STATE_DISABLED,
 318 };
 319 /* *INDENT-ON* */
 320
 321 static int
 322 create_api_loopback (echo_client_main_t * ecm)
 323 {
 324   api_main_t *am = &api_main;
 325   vl_shmem_hdr_t *shmem_hdr;
 326
 327   shmem_hdr = am->shmem_hdr;
 328   ecm->vl_input_queue = shmem_hdr->vl_input_queue;
 329   ecm->my_client_index = vl_api_memclnt_create_internal ("echo_client",
 330                                                          ecm->vl_input_queue);
 331   return 0;
 332 }
 333
 334 static int
 335 echo_clients_init (vlib_main_t * vm)
 336 {
 337   echo_client_main_t *ecm = &echo_client_main;
 338   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 339   u32 num_threads;
 340   int i;
 341
 342   if (create_api_loopback (ecm))
 343     return -1;
 344
 345   num_threads = 1 /* main thread */  + vtm->n_threads;
 346
 347   /* Init test data. Big buffer */
 348   vec_validate (ecm->connect_test_data, 4 * 1024 * 1024 - 1);
 349   for (i = 0; i < vec_len (ecm->connect_test_data); i++)
 350     ecm->connect_test_data[i] = i & 0xff;
 351
 352   vec_validate (ecm->rx_buf, num_threads - 1);
 353   for (i = 0; i < num_threads; i++)
 354     vec_validate (ecm->rx_buf[i], vec_len (ecm->connect_test_data) - 1);
 355
 356   ecm->is_init = 1;
 357
 358   vec_validate (ecm->connection_index_by_thread, vtm->n_vlib_mains);
 359   vec_validate (ecm->connections_this_batch_by_thread, vtm->n_vlib_mains);
 360   vec_validate (ecm->vpp_event_queue, vtm->n_vlib_mains);
 361
 362   return 0;
 363 }
 364
 365 static int
 366 echo_clients_session_connected_callback (u32 app_index, u32 api_context,
 367                                          stream_session_t * s, u8 is_fail)
 368 {
 369   echo_client_main_t *ecm = &echo_client_main;
 370   eclient_session_t *session;
 371   u32 session_index;
 372   u8 thread_index = vlib_get_thread_index ();
 373
 374   if (is_fail)
 375     {
 376       clib_warning ("connection %d failed!", api_context);
 377       signal_evt_to_cli (-1);
 378       return 0;
 379     }
 380
 381   ASSERT (s->thread_index == thread_index);
 382
 383   if (!ecm->vpp_event_queue[thread_index])
 384     ecm->vpp_event_queue[thread_index] =
 385       session_manager_get_vpp_event_queue (thread_index);
 386
 387   /*
 388    * Setup session
 389    */
 390   clib_spinlock_lock_if_init (&ecm->sessions_lock);
 391   pool_get (ecm->sessions, session);
 392   clib_spinlock_unlock_if_init (&ecm->sessions_lock);
 393
 394   memset (session, 0, sizeof (*session));
 395   session_index = session - ecm->sessions;
 396   session->bytes_to_send = ecm->bytes_to_send;
 397   session->bytes_to_receive = ecm->no_return ? 0ULL : ecm->bytes_to_send;
 398   session->data.rx_fifo = s->server_rx_fifo;
 399   session->data.rx_fifo->client_session_index = session_index;
 400   session->data.tx_fifo = s->server_tx_fifo;
 401   session->data.tx_fifo->client_session_index = session_index;
 402   session->data.vpp_evt_q = ecm->vpp_event_queue[thread_index];
 403   session->vpp_session_handle = session_handle (s);
 404
 405   if (ecm->is_dgram)
 406     {
 407       transport_connection_t *tc;
 408       tc = session_get_transport (s);
 409       clib_memcpy (&session->data.transport, tc,
 410                    sizeof (session->data.transport));
 411       session->data.is_dgram = 1;
 412     }
 413
 414   vec_add1 (ecm->connection_index_by_thread[thread_index], session_index);
 415   __sync_fetch_and_add (&ecm->ready_connections, 1);
 416   if (ecm->ready_connections == ecm->expected_connections)
 417     {
 418       ecm->run_test = 1;
 419       /* Signal the CLI process that the action is starting... */
 420       signal_evt_to_cli (1);
 421     }
 422
 423   return 0;
 424 }
 425
 426 static void
 427 echo_clients_session_reset_callback (stream_session_t * s)
 428 {
 429   if (s->session_state == SESSION_STATE_READY)
 430     clib_warning ("Reset active connection %U", format_stream_session, s, 2);
 431   stream_session_cleanup (s);
 432   return;
 433 }
 434
 435 static int
 436 echo_clients_session_create_callback (stream_session_t * s)
 437 {
 438   return 0;
 439 }
 440
 441 static void
 442 echo_clients_session_disconnect_callback (stream_session_t * s)
 443 {
 444   echo_client_main_t *ecm = &echo_client_main;
 445   vnet_disconnect_args_t _a, *a = &_a;
 446   a->handle = session_handle (s);
 447   a->app_index = ecm->app_index;
 448   vnet_disconnect_session (a);
 449   return;
 450 }
 451
 452 static int
 453 echo_clients_rx_callback (stream_session_t * s)
 454 {
 455   echo_client_main_t *ecm = &echo_client_main;
 456   eclient_session_t *sp;
 457
 458   sp = pool_elt_at_index (ecm->sessions,
 459                           s->server_rx_fifo->client_session_index);
 460   receive_data_chunk (ecm, sp);
 461
 462   if (svm_fifo_max_dequeue (s->server_rx_fifo))
 463     {
 464       session_fifo_event_t evt;
 465       svm_queue_t *q;
 466       if (svm_fifo_set_event (s->server_rx_fifo))
 467         {
 468           evt.fifo = s->server_rx_fifo;
 469           evt.event_type = FIFO_EVENT_BUILTIN_RX;
 470           q = session_manager_get_vpp_event_queue (s->thread_index);
 471           if (PREDICT_FALSE (q->cursize == q->maxsize))
 472             clib_warning ("out of event queue space");
 473           else if (svm_queue_add (q, (u8 *) & evt, 0))
 474             clib_warning ("failed to enqueue self-tap");
 475         }
 476     }
 477   return 0;
 478 }
 479
 480 int
 481 echo_client_add_segment_callback (u32 client_index, const ssvm_private_t * sp)
 482 {
 483   /* New heaps may be added */
 484   return 0;
 485 }
 486
 487 /* *INDENT-OFF* */
 488 static session_cb_vft_t echo_clients = {
 489   .session_reset_callback = echo_clients_session_reset_callback,
 490   .session_connected_callback = echo_clients_session_connected_callback,
 491   .session_accept_callback = echo_clients_session_create_callback,
 492   .session_disconnect_callback = echo_clients_session_disconnect_callback,
 493   .builtin_app_rx_callback = echo_clients_rx_callback,
 494   .add_segment_callback = echo_client_add_segment_callback
 495 };
 496 /* *INDENT-ON* */
 497
 498 static clib_error_t *
 499 echo_clients_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
 500 {
 501   u32 prealloc_fifos, segment_size = 256 << 20;
 502   echo_client_main_t *ecm = &echo_client_main;
 503   vnet_app_attach_args_t _a, *a = &_a;
 504   u64 options[16];
 505   clib_error_t *error = 0;
 506
 507   memset (a, 0, sizeof (*a));
 508   memset (options, 0, sizeof (options));
 509
 510   a->api_client_index = ecm->my_client_index;
 511   a->session_cb_vft = &echo_clients;
 512
 513   prealloc_fifos = ecm->prealloc_fifos ? ecm->expected_connections : 1;
 514
 515   if (ecm->private_segment_size)
 516     segment_size = ecm->private_segment_size;
 517
 518   options[APP_OPTIONS_ACCEPT_COOKIE] = 0x12345678;
 519   options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
 520   options[APP_OPTIONS_ADD_SEGMENT_SIZE] = segment_size;
 521   options[APP_OPTIONS_RX_FIFO_SIZE] = ecm->fifo_size;
 522   options[APP_OPTIONS_TX_FIFO_SIZE] = ecm->fifo_size;
 523   options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = ecm->private_segment_count;
 524   options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = prealloc_fifos;
 525   options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
 526   options[APP_OPTIONS_TLS_ENGINE] = ecm->tls_engine;
 527   if (appns_id)
 528     {
 529       options[APP_OPTIONS_FLAGS] |= appns_flags;
 530       options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
 531     }
 532   a->options = options;
 533   a->namespace_id = appns_id;
 534
 535   if ((error = vnet_application_attach (a)))
 536     return error;
 537
 538   ecm->app_index = a->app_index;
 539   return 0;
 540 }
 541
 542 static int
 543 echo_clients_detach ()
 544 {
 545   echo_client_main_t *ecm = &echo_client_main;
 546   vnet_app_detach_args_t _da, *da = &_da;
 547   int rv;
 548
 549   da->app_index = ecm->app_index;
 550   rv = vnet_application_detach (da);
 551   ecm->test_client_attached = 0;
 552   ecm->app_index = ~0;
 553   return rv;
 554 }
 555
 556 static void *
 557 echo_client_thread_fn (void *arg)
 558 {
 559   return 0;
 560 }
 561
 562 /** Start a transmit thread */
 563 int
 564 echo_clients_start_tx_pthread (echo_client_main_t * ecm)
 565 {
 566   if (ecm->client_thread_handle == 0)
 567     {
 568       int rv = pthread_create (&ecm->client_thread_handle,
 569                                NULL /*attr */ ,
 570                                echo_client_thread_fn, 0);
 571       if (rv)
 572         {
 573           ecm->client_thread_handle = 0;
 574           return -1;
 575         }
 576     }
 577   return 0;
 578 }
 579
 580 clib_error_t *
 581 echo_clients_connect (vlib_main_t * vm, u32 n_clients)
 582 {
 583   echo_client_main_t *ecm = &echo_client_main;
 584   vnet_connect_args_t _a, *a = &_a;
 585   clib_error_t *error = 0;
 586   int i;
 587
 588   memset (a, 0, sizeof (*a));
 589   for (i = 0; i < n_clients; i++)
 590     {
 591       a->uri = (char *) ecm->connect_uri;
 592       a->api_context = i;
 593       a->app_index = ecm->app_index;
 594
 595       if ((error = vnet_connect_uri (a)))
 596         return error;
 597
 598       /* Crude pacing for call setups  */
 599       if ((i % 4) == 0)
 600         vlib_process_suspend (vm, 10e-6);
 601       ASSERT (i + 1 >= ecm->ready_connections);
 602       while (i + 1 - ecm->ready_connections > 1000)
 603         {
 604           vlib_process_suspend (vm, 100e-6);
 605         }
 606     }
 607   return 0;
 608 }
 609
 610 #define ec_cli_output(_fmt, _args...)                   \
 611   if (!ecm->no_output)                                  \
 612     vlib_cli_output(vm, _fmt, ##_args)
 613
 614 static clib_error_t *
 615 echo_clients_command_fn (vlib_main_t * vm,
 616                          unformat_input_t * input, vlib_cli_command_t * cmd)
 617 {
 618   echo_client_main_t *ecm = &echo_client_main;
 619   vlib_thread_main_t *thread_main = vlib_get_thread_main ();
 620   u64 tmp, total_bytes, appns_flags = 0, appns_secret = 0;
 621   f64 test_timeout = 20.0, syn_timeout = 20.0, delta;
 622   char *default_uri = "tcp://6.0.1.1/1234";
 623   uword *event_data = 0, event_type;
 624   f64 time_before_connects;
 625   u32 n_clients = 1;
 626   int preallocate_sessions = 0;
 627   char *transfer_type;
 628   clib_error_t *error = 0;
 629   u8 *appns_id = 0;
 630   int i;
 631
 632   ecm->bytes_to_send = 8192;
 633   ecm->no_return = 0;
 634   ecm->fifo_size = 64 << 10;
 635   ecm->connections_per_batch = 1000;
 636   ecm->private_segment_count = 0;
 637   ecm->private_segment_size = 0;
 638   ecm->no_output = 0;
 639   ecm->test_bytes = 0;
 640   ecm->test_failed = 0;
 641   ecm->vlib_main = vm;
 642   ecm->tls_engine = TLS_ENGINE_OPENSSL;
 643   ecm->no_copy = 0;
 644
 645   if (thread_main->n_vlib_mains > 1)
 646     clib_spinlock_init (&ecm->sessions_lock);
 647   vec_free (ecm->connect_uri);
 648
 649   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 650     {
 651       if (unformat (input, "uri %s", &ecm->connect_uri))
 652         ;
 653       else if (unformat (input, "nclients %d", &n_clients))
 654         ;
 655       else if (unformat (input, "mbytes %lld", &tmp))
 656         ecm->bytes_to_send = tmp << 20;
 657       else if (unformat (input, "gbytes %lld", &tmp))
 658         ecm->bytes_to_send = tmp << 30;
 659       else if (unformat (input, "bytes %lld", &ecm->bytes_to_send))
 660         ;
 661       else if (unformat (input, "test-timeout %f", &test_timeout))
 662         ;
 663       else if (unformat (input, "syn-timeout %f", &syn_timeout))
 664         ;
 665       else if (unformat (input, "no-return"))
 666         ecm->no_return = 1;
 667       else if (unformat (input, "fifo-size %d", &ecm->fifo_size))
 668         ecm->fifo_size <<= 10;
 669       else if (unformat (input, "private-segment-count %d",
 670                          &ecm->private_segment_count))
 671         ;
 672       else if (unformat (input, "private-segment-size %U",
 673                          unformat_memory_size, &tmp))
 674         {
 675           if (tmp >= 0x100000000ULL)
 676             return clib_error_return
 677               (0, "private segment size %lld (%llu) too large", tmp, tmp);
 678           ecm->private_segment_size = tmp;
 679         }
 680       else if (unformat (input, "preallocate-fifos"))
 681         ecm->prealloc_fifos = 1;
 682       else if (unformat (input, "preallocate-sessions"))
 683         preallocate_sessions = 1;
 684       else
 685         if (unformat (input, "client-batch %d", &ecm->connections_per_batch))
 686         ;
 687       else if (unformat (input, "appns %_%v%_", &appns_id))
 688         ;
 689       else if (unformat (input, "all-scope"))
 690         appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
 691                         | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
 692       else if (unformat (input, "local-scope"))
 693         appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
 694       else if (unformat (input, "global-scope"))
 695         appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 696       else if (unformat (input, "secret %lu", &appns_secret))
 697         ;
 698       else if (unformat (input, "no-output"))
 699         ecm->no_output = 1;
 700       else if (unformat (input, "test-bytes"))
 701         ecm->test_bytes = 1;
 702       else if (unformat (input, "tls-engine %d", &ecm->tls_engine))
 703         ;
 704       else
 705         return clib_error_return (0, "failed: unknown input `%U'",
 706                                   format_unformat_error, input);
 707     }
 708
 709   /* Store cli process node index for signalling */
 710   ecm->cli_node_index =
 711     vlib_get_current_process (vm)->node_runtime.node_index;
 712
 713   if (ecm->is_init == 0)
 714     {
 715       if (echo_clients_init (vm))
 716         return clib_error_return (0, "failed init");
 717     }
 718
 719
 720   ecm->ready_connections = 0;
 721   ecm->expected_connections = n_clients;
 722   ecm->rx_total = 0;
 723   ecm->tx_total = 0;
 724
 725   if (!ecm->connect_uri)
 726     {
 727       clib_warning ("No uri provided. Using default: %s", default_uri);
 728       ecm->connect_uri = format (0, "%s%c", default_uri, 0);
 729     }
 730
 731   if (ecm->connect_uri[0] == 'u' && ecm->connect_uri[3] != 'c')
 732     ecm->is_dgram = 1;
 733
 734 #if ECHO_CLIENT_PTHREAD
 735   echo_clients_start_tx_pthread ();
 736 #endif
 737
 738   vlib_worker_thread_barrier_sync (vm);
 739   vnet_session_enable_disable (vm, 1 /* turn on session and transports */ );
 740   vlib_worker_thread_barrier_release (vm);
 741
 742   if (ecm->test_client_attached == 0)
 743     {
 744       if ((error = echo_clients_attach (appns_id, appns_flags, appns_secret)))
 745         {
 746           vec_free (appns_id);
 747           clib_error_report (error);
 748           return error;
 749         }
 750       vec_free (appns_id);
 751     }
 752   ecm->test_client_attached = 1;
 753
 754   /* Turn on the builtin client input nodes */
 755   for (i = 0; i < thread_main->n_vlib_mains; i++)
 756     vlib_node_set_state (vlib_mains[i], echo_clients_node.index,
 757                          VLIB_NODE_STATE_POLLING);
 758
 759   if (preallocate_sessions)
 760     pool_init_fixed (ecm->sessions, 1.1 * n_clients);
 761
 762   /* Fire off connect requests */
 763   time_before_connects = vlib_time_now (vm);
 764   if ((error = echo_clients_connect (vm, n_clients)))
 765     return error;
 766
 767   /* Park until the sessions come up, or ten seconds elapse... */
 768   vlib_process_wait_for_event_or_clock (vm, syn_timeout);
 769   event_type = vlib_process_get_events (vm, &event_data);
 770   switch (event_type)
 771     {
 772     case ~0:
 773       ec_cli_output ("Timeout with only %d sessions active...",
 774                      ecm->ready_connections);
 775       error = clib_error_return (0, "failed: syn timeout with %d sessions",
 776                                  ecm->ready_connections);
 777       goto cleanup;
 778
 779     case 1:
 780       delta = vlib_time_now (vm) - time_before_connects;
 781       if (delta != 0.0)
 782         ec_cli_output ("%d three-way handshakes in %.2f seconds %.2f/s",
 783                        n_clients, delta, ((f64) n_clients) / delta);
 784
 785       ecm->test_start_time = vlib_time_now (ecm->vlib_main);
 786       ec_cli_output ("Test started at %.6f", ecm->test_start_time);
 787       break;
 788
 789     default:
 790       ec_cli_output ("unexpected event(1): %d", event_type);
 791       error = clib_error_return (0, "failed: unexpected event(1): %d",
 792                                  event_type);
 793       goto cleanup;
 794     }
 795
 796   /* Now wait for the sessions to finish... */
 797   vlib_process_wait_for_event_or_clock (vm, test_timeout);
 798   event_type = vlib_process_get_events (vm, &event_data);
 799   switch (event_type)
 800     {
 801     case ~0:
 802       ec_cli_output ("Timeout with %d sessions still active...",
 803                      ecm->ready_connections);
 804       error = clib_error_return (0, "failed: timeout with %d sessions",
 805                                  ecm->ready_connections);
 806       goto cleanup;
 807
 808     case 2:
 809       ecm->test_end_time = vlib_time_now (vm);
 810       ec_cli_output ("Test finished at %.6f", ecm->test_end_time);
 811       break;
 812
 813     default:
 814       ec_cli_output ("unexpected event(2): %d", event_type);
 815       error = clib_error_return (0, "failed: unexpected event(2): %d",
 816                                  event_type);
 817       goto cleanup;
 818     }
 819
 820   delta = ecm->test_end_time - ecm->test_start_time;
 821   if (delta != 0.0)
 822     {
 823       total_bytes = (ecm->no_return ? ecm->tx_total : ecm->rx_total);
 824       transfer_type = ecm->no_return ? "half-duplex" : "full-duplex";
 825       ec_cli_output ("%lld bytes (%lld mbytes, %lld gbytes) in %.2f seconds",
 826                      total_bytes, total_bytes / (1ULL << 20),
 827                      total_bytes / (1ULL << 30), delta);
 828       ec_cli_output ("%.2f bytes/second %s", ((f64) total_bytes) / (delta),
 829                      transfer_type);
 830       ec_cli_output ("%.4f gbit/second %s",
 831                      (((f64) total_bytes * 8.0) / delta / 1e9),
 832                      transfer_type);
 833     }
 834   else
 835     {
 836       ec_cli_output ("zero delta-t?");
 837       error = clib_error_return (0, "failed: zero delta-t");
 838       goto cleanup;
 839     }
 840
 841   if (ecm->test_bytes && ecm->test_failed)
 842     error = clib_error_return (0, "failed: test bytes");
 843
 844 cleanup:
 845   ecm->run_test = 0;
 846   for (i = 0; i < vec_len (ecm->connection_index_by_thread); i++)
 847     {
 848       vec_reset_length (ecm->connection_index_by_thread[i]);
 849       vec_reset_length (ecm->connections_this_batch_by_thread[i]);
 850     }
 851
 852   pool_free (ecm->sessions);
 853
 854   /* Detach the application, so we can use different fifo sizes next time */
 855   if (ecm->test_client_attached)
 856     {
 857       if (echo_clients_detach ())
 858         {
 859           error = clib_error_return (0, "failed: app detach");
 860           ec_cli_output ("WARNING: app detach failed...");
 861         }
 862     }
 863   if (error)
 864     ec_cli_output ("test failed");
 865   vec_free (ecm->connect_uri);
 866   return error;
 867 }
 868
 869 /* *INDENT-OFF* */
 870 VLIB_CLI_COMMAND (echo_clients_command, static) =
 871 {
 872   .path = "test echo clients",
 873   .short_help = "test echo clients [nclients %d][[m|g]bytes <bytes>]"
 874       "[test-timeout <time>][syn-timeout <time>][no-return][fifo-size <size>]"
 875       "[private-segment-count <count>][private-segment-size <bytes>[m|g]]"
 876       "[preallocate-fifos][preallocate-sessions][client-batch <batch-size>]"
 877       "[uri <tcp://ip/port>][test-bytes][no-output]",
 878   .function = echo_clients_command_fn,
 879   .is_mp_safe = 1,
 880 };
 881 /* *INDENT-ON* */
 882
 883 clib_error_t *
 884 echo_clients_main_init (vlib_main_t * vm)
 885 {
 886   echo_client_main_t *ecm = &echo_client_main;
 887   ecm->is_init = 0;
 888   return 0;
 889 }
 890
 891 VLIB_INIT_FUNCTION (echo_clients_main_init);
 892
 893 /*
 894  * fd.io coding-style-patch-verification: ON
 895  *
 896  * Local Variables:
 897  * eval: (c-set-style "gnu")
 898  * End:
 899  */