src/vnet/session-apps/echo_client.c

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