src/plugins/hs_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 <hs_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 (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 = vlibapi_get_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,
 366                                                session_error_t err)
 367 {
 368   echo_client_main_t *ecm = &echo_client_main;
 369   vnet_connect_args_t *a = 0;
 370   int rv;
 371   u8 thread_index = vlib_get_thread_index ();
 372   session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
 373   u32 stream_n;
 374   session_handle_t handle;
 375
 376   DBG ("QUIC Connection handle %d", session_handle (s));
 377
 378   vec_validate (a, 1);
 379   a->uri = (char *) ecm->connect_uri;
 380   if (parse_uri (a->uri, &sep))
 381     return -1;
 382   sep.parent_handle = handle = session_handle (s);
 383
 384   for (stream_n = 0; stream_n < ecm->quic_streams; stream_n++)
 385     {
 386       clib_memset (a, 0, sizeof (*a));
 387       a->app_index = ecm->app_index;
 388       a->api_context = -1 - api_context;
 389       clib_memcpy (&a->sep_ext, &sep, sizeof (sep));
 390
 391       DBG ("QUIC opening stream %d", stream_n);
 392       if ((rv = vnet_connect (a)))
 393         {
 394           clib_error ("Stream session %d opening failed: %d", stream_n, rv);
 395           return -1;
 396         }
 397       DBG ("QUIC stream %d connected", stream_n);
 398     }
 399   /*
 400    * 's' is no longer valid, its underlying pool could have been moved in
 401    * vnet_connect()
 402    */
 403   vec_add1 (ecm->quic_session_index_by_thread[thread_index], handle);
 404   vec_free (a);
 405   return 0;
 406 }
 407
 408 static int
 409 quic_echo_clients_session_connected_callback (u32 app_index, u32 api_context,
 410                                               session_t * s,
 411                                               session_error_t err)
 412 {
 413   echo_client_main_t *ecm = &echo_client_main;
 414   eclient_session_t *session;
 415   u32 session_index;
 416   u8 thread_index;
 417
 418   if (PREDICT_FALSE (ecm->run_test != ECHO_CLIENTS_STARTING))
 419     return -1;
 420
 421   if (err)
 422     {
 423       clib_warning ("connection %d failed!", api_context);
 424       ecm->run_test = ECHO_CLIENTS_EXITING;
 425       signal_evt_to_cli (-1);
 426       return 0;
 427     }
 428
 429   if (s->listener_handle == SESSION_INVALID_HANDLE)
 430     return quic_echo_clients_qsession_connected_callback (app_index,
 431                                                           api_context, s,
 432                                                           err);
 433   DBG ("STREAM Connection callback %d", api_context);
 434
 435   thread_index = s->thread_index;
 436   ASSERT (thread_index == vlib_get_thread_index ()
 437           || session_transport_service_type (s) == TRANSPORT_SERVICE_CL);
 438
 439   if (!ecm->vpp_event_queue[thread_index])
 440     ecm->vpp_event_queue[thread_index] =
 441       session_main_get_vpp_event_queue (thread_index);
 442
 443   /*
 444    * Setup session
 445    */
 446   clib_spinlock_lock_if_init (&ecm->sessions_lock);
 447   pool_get (ecm->sessions, session);
 448   clib_spinlock_unlock_if_init (&ecm->sessions_lock);
 449
 450   clib_memset (session, 0, sizeof (*session));
 451   session_index = session - ecm->sessions;
 452   session->bytes_to_send = ecm->bytes_to_send;
 453   session->bytes_to_receive = ecm->no_return ? 0ULL : ecm->bytes_to_send;
 454   session->data.rx_fifo = s->rx_fifo;
 455   session->data.rx_fifo->client_session_index = session_index;
 456   session->data.tx_fifo = s->tx_fifo;
 457   session->data.tx_fifo->client_session_index = session_index;
 458   session->data.vpp_evt_q = ecm->vpp_event_queue[thread_index];
 459   session->vpp_session_handle = session_handle (s);
 460
 461   if (ecm->is_dgram)
 462     {
 463       transport_connection_t *tc;
 464       tc = session_get_transport (s);
 465       clib_memcpy_fast (&session->data.transport, tc,
 466                         sizeof (session->data.transport));
 467       session->data.is_dgram = 1;
 468     }
 469
 470   vec_add1 (ecm->connection_index_by_thread[thread_index], session_index);
 471   clib_atomic_fetch_add (&ecm->ready_connections, 1);
 472   if (ecm->ready_connections == ecm->expected_connections)
 473     {
 474       ecm->run_test = ECHO_CLIENTS_RUNNING;
 475       /* Signal the CLI process that the action is starting... */
 476       signal_evt_to_cli (1);
 477     }
 478
 479   return 0;
 480 }
 481
 482 static int
 483 echo_clients_session_connected_callback (u32 app_index, u32 api_context,
 484                                          session_t * s, session_error_t err)
 485 {
 486   echo_client_main_t *ecm = &echo_client_main;
 487   eclient_session_t *session;
 488   u32 session_index;
 489   u8 thread_index;
 490
 491   if (PREDICT_FALSE (ecm->run_test != ECHO_CLIENTS_STARTING))
 492     return -1;
 493
 494   if (err)
 495     {
 496       clib_warning ("connection %d failed!", api_context);
 497       ecm->run_test = ECHO_CLIENTS_EXITING;
 498       signal_evt_to_cli (-1);
 499       return 0;
 500     }
 501
 502   thread_index = s->thread_index;
 503   ASSERT (thread_index == vlib_get_thread_index ()
 504           || session_transport_service_type (s) == TRANSPORT_SERVICE_CL);
 505
 506   if (!ecm->vpp_event_queue[thread_index])
 507     ecm->vpp_event_queue[thread_index] =
 508       session_main_get_vpp_event_queue (thread_index);
 509
 510   /*
 511    * Setup session
 512    */
 513   clib_spinlock_lock_if_init (&ecm->sessions_lock);
 514   pool_get (ecm->sessions, session);
 515   clib_spinlock_unlock_if_init (&ecm->sessions_lock);
 516
 517   clib_memset (session, 0, sizeof (*session));
 518   session_index = session - ecm->sessions;
 519   session->bytes_to_send = ecm->bytes_to_send;
 520   session->bytes_to_receive = ecm->no_return ? 0ULL : ecm->bytes_to_send;
 521   session->data.rx_fifo = s->rx_fifo;
 522   session->data.rx_fifo->client_session_index = session_index;
 523   session->data.tx_fifo = s->tx_fifo;
 524   session->data.tx_fifo->client_session_index = session_index;
 525   session->data.vpp_evt_q = ecm->vpp_event_queue[thread_index];
 526   session->vpp_session_handle = session_handle (s);
 527
 528   if (ecm->is_dgram)
 529     {
 530       transport_connection_t *tc;
 531       tc = session_get_transport (s);
 532       clib_memcpy_fast (&session->data.transport, tc,
 533                         sizeof (session->data.transport));
 534       session->data.is_dgram = 1;
 535     }
 536
 537   vec_add1 (ecm->connection_index_by_thread[thread_index], session_index);
 538   clib_atomic_fetch_add (&ecm->ready_connections, 1);
 539   if (ecm->ready_connections == ecm->expected_connections)
 540     {
 541       ecm->run_test = ECHO_CLIENTS_RUNNING;
 542       /* Signal the CLI process that the action is starting... */
 543       signal_evt_to_cli (1);
 544     }
 545
 546   return 0;
 547 }
 548
 549 static void
 550 echo_clients_session_reset_callback (session_t * s)
 551 {
 552   echo_client_main_t *ecm = &echo_client_main;
 553   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
 554
 555   if (s->session_state == SESSION_STATE_READY)
 556     clib_warning ("Reset active connection %U", format_session, s, 2);
 557
 558   a->handle = session_handle (s);
 559   a->app_index = ecm->app_index;
 560   vnet_disconnect_session (a);
 561   return;
 562 }
 563
 564 static int
 565 echo_clients_session_create_callback (session_t * s)
 566 {
 567   return 0;
 568 }
 569
 570 static void
 571 echo_clients_session_disconnect_callback (session_t * s)
 572 {
 573   echo_client_main_t *ecm = &echo_client_main;
 574   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
 575   a->handle = session_handle (s);
 576   a->app_index = ecm->app_index;
 577   vnet_disconnect_session (a);
 578   return;
 579 }
 580
 581 void
 582 echo_clients_session_disconnect (session_t * s)
 583 {
 584   echo_client_main_t *ecm = &echo_client_main;
 585   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
 586   a->handle = session_handle (s);
 587   a->app_index = ecm->app_index;
 588   vnet_disconnect_session (a);
 589 }
 590
 591 static int
 592 echo_clients_rx_callback (session_t * s)
 593 {
 594   echo_client_main_t *ecm = &echo_client_main;
 595   eclient_session_t *sp;
 596
 597   if (PREDICT_FALSE (ecm->run_test != ECHO_CLIENTS_RUNNING))
 598     {
 599       echo_clients_session_disconnect (s);
 600       return -1;
 601     }
 602
 603   sp = pool_elt_at_index (ecm->sessions, s->rx_fifo->client_session_index);
 604   receive_data_chunk (ecm, sp);
 605
 606   if (svm_fifo_max_dequeue_cons (s->rx_fifo))
 607     {
 608       if (svm_fifo_set_event (s->rx_fifo))
 609         session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_BUILTIN_RX);
 610     }
 611   return 0;
 612 }
 613
 614 int
 615 echo_client_add_segment_callback (u32 client_index, u64 segment_handle)
 616 {
 617   /* New heaps may be added */
 618   return 0;
 619 }
 620
 621 /* *INDENT-OFF* */
 622 static session_cb_vft_t echo_clients = {
 623   .session_reset_callback = echo_clients_session_reset_callback,
 624   .session_connected_callback = echo_clients_session_connected_callback,
 625   .session_accept_callback = echo_clients_session_create_callback,
 626   .session_disconnect_callback = echo_clients_session_disconnect_callback,
 627   .builtin_app_rx_callback = echo_clients_rx_callback,
 628   .add_segment_callback = echo_client_add_segment_callback
 629 };
 630 /* *INDENT-ON* */
 631
 632 static clib_error_t *
 633 echo_clients_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
 634 {
 635   vnet_app_add_tls_cert_args_t _a_cert, *a_cert = &_a_cert;
 636   vnet_app_add_tls_key_args_t _a_key, *a_key = &_a_key;
 637   u32 prealloc_fifos, segment_size = 256 << 20;
 638   echo_client_main_t *ecm = &echo_client_main;
 639   vnet_app_attach_args_t _a, *a = &_a;
 640   u64 options[17];
 641   int rv;
 642
 643   clib_memset (a, 0, sizeof (*a));
 644   clib_memset (options, 0, sizeof (options));
 645
 646   a->api_client_index = ecm->my_client_index;
 647   if (ecm->transport_proto == TRANSPORT_PROTO_QUIC)
 648     echo_clients.session_connected_callback =
 649       quic_echo_clients_session_connected_callback;
 650   a->session_cb_vft = &echo_clients;
 651
 652   prealloc_fifos = ecm->prealloc_fifos ? ecm->expected_connections : 1;
 653
 654   if (ecm->private_segment_size)
 655     segment_size = ecm->private_segment_size;
 656
 657   options[APP_OPTIONS_ACCEPT_COOKIE] = 0x12345678;
 658   options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
 659   options[APP_OPTIONS_ADD_SEGMENT_SIZE] = segment_size;
 660   options[APP_OPTIONS_RX_FIFO_SIZE] = ecm->fifo_size;
 661   options[APP_OPTIONS_TX_FIFO_SIZE] = ecm->fifo_size;
 662   options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = ecm->private_segment_count;
 663   options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = prealloc_fifos;
 664   options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
 665   options[APP_OPTIONS_TLS_ENGINE] = ecm->tls_engine;
 666   options[APP_OPTIONS_PCT_FIRST_ALLOC] = 100;
 667   if (appns_id)
 668     {
 669       options[APP_OPTIONS_FLAGS] |= appns_flags;
 670       options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
 671     }
 672   a->options = options;
 673   a->namespace_id = appns_id;
 674
 675   if ((rv = vnet_application_attach (a)))
 676     return clib_error_return (0, "attach returned %d", rv);
 677
 678   ecm->app_index = a->app_index;
 679
 680   clib_memset (a_cert, 0, sizeof (*a_cert));
 681   a_cert->app_index = a->app_index;
 682   vec_validate (a_cert->cert, test_srv_crt_rsa_len);
 683   clib_memcpy_fast (a_cert->cert, test_srv_crt_rsa, test_srv_crt_rsa_len);
 684   vnet_app_add_tls_cert (a_cert);
 685
 686   clib_memset (a_key, 0, sizeof (*a_key));
 687   a_key->app_index = a->app_index;
 688   vec_validate (a_key->key, test_srv_key_rsa_len);
 689   clib_memcpy_fast (a_key->key, test_srv_key_rsa, test_srv_key_rsa_len);
 690   vnet_app_add_tls_key (a_key);
 691   return 0;
 692 }
 693
 694 static int
 695 echo_clients_detach ()
 696 {
 697   echo_client_main_t *ecm = &echo_client_main;
 698   vnet_app_detach_args_t _da, *da = &_da;
 699   int rv;
 700
 701   da->app_index = ecm->app_index;
 702   da->api_client_index = ~0;
 703   rv = vnet_application_detach (da);
 704   ecm->test_client_attached = 0;
 705   ecm->app_index = ~0;
 706   return rv;
 707 }
 708
 709 static void *
 710 echo_client_thread_fn (void *arg)
 711 {
 712   return 0;
 713 }
 714
 715 /** Start a transmit thread */
 716 int
 717 echo_clients_start_tx_pthread (echo_client_main_t * ecm)
 718 {
 719   if (ecm->client_thread_handle == 0)
 720     {
 721       int rv = pthread_create (&ecm->client_thread_handle,
 722                                NULL /*attr */ ,
 723                                echo_client_thread_fn, 0);
 724       if (rv)
 725         {
 726           ecm->client_thread_handle = 0;
 727           return -1;
 728         }
 729     }
 730   return 0;
 731 }
 732
 733 clib_error_t *
 734 echo_clients_connect (vlib_main_t * vm, u32 n_clients)
 735 {
 736   echo_client_main_t *ecm = &echo_client_main;
 737   vnet_connect_args_t _a, *a = &_a;
 738   int i, rv;
 739
 740   clib_memset (a, 0, sizeof (*a));
 741
 742   for (i = 0; i < n_clients; i++)
 743     {
 744       a->uri = (char *) ecm->connect_uri;
 745       a->api_context = i;
 746       a->app_index = ecm->app_index;
 747
 748       vlib_worker_thread_barrier_sync (vm);
 749       if ((rv = vnet_connect_uri (a)))
 750         {
 751           vlib_worker_thread_barrier_release (vm);
 752           return clib_error_return (0, "connect returned: %d", rv);
 753         }
 754       vlib_worker_thread_barrier_release (vm);
 755
 756       /* Crude pacing for call setups  */
 757       if ((i % 16) == 0)
 758         vlib_process_suspend (vm, 100e-6);
 759       ASSERT (i + 1 >= ecm->ready_connections);
 760       while (i + 1 - ecm->ready_connections > 128)
 761         vlib_process_suspend (vm, 1e-3);
 762     }
 763   return 0;
 764 }
 765
 766 #define ec_cli_output(_fmt, _args...)                   \
 767   if (!ecm->no_output)                                  \
 768     vlib_cli_output(vm, _fmt, ##_args)
 769
 770 static clib_error_t *
 771 echo_clients_command_fn (vlib_main_t * vm,
 772                          unformat_input_t * input, vlib_cli_command_t * cmd)
 773 {
 774   echo_client_main_t *ecm = &echo_client_main;
 775   vlib_thread_main_t *thread_main = vlib_get_thread_main ();
 776   u64 tmp, total_bytes, appns_flags = 0, appns_secret = 0;
 777   f64 test_timeout = 20.0, syn_timeout = 20.0, delta;
 778   char *default_uri = "tcp://6.0.1.1/1234";
 779   uword *event_data = 0, event_type;
 780   f64 time_before_connects;
 781   u32 n_clients = 1;
 782   int preallocate_sessions = 0;
 783   char *transfer_type;
 784   clib_error_t *error = 0;
 785   u8 *appns_id = 0;
 786   int i;
 787   session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
 788   int rv;
 789
 790   ecm->quic_streams = 1;
 791   ecm->bytes_to_send = 8192;
 792   ecm->no_return = 0;
 793   ecm->fifo_size = 64 << 10;
 794   ecm->connections_per_batch = 1000;
 795   ecm->private_segment_count = 0;
 796   ecm->private_segment_size = 0;
 797   ecm->no_output = 0;
 798   ecm->test_bytes = 0;
 799   ecm->test_failed = 0;
 800   ecm->vlib_main = vm;
 801   ecm->tls_engine = CRYPTO_ENGINE_OPENSSL;
 802   ecm->no_copy = 0;
 803   ecm->run_test = ECHO_CLIENTS_STARTING;
 804
 805   if (thread_main->n_vlib_mains > 1)
 806     clib_spinlock_init (&ecm->sessions_lock);
 807   vec_free (ecm->connect_uri);
 808
 809   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 810     {
 811       if (unformat (input, "uri %s", &ecm->connect_uri))
 812         ;
 813       else if (unformat (input, "nclients %d", &n_clients))
 814         ;
 815       else if (unformat (input, "quic-streams %d", &ecm->quic_streams))
 816         ;
 817       else if (unformat (input, "mbytes %lld", &tmp))
 818         ecm->bytes_to_send = tmp << 20;
 819       else if (unformat (input, "gbytes %lld", &tmp))
 820         ecm->bytes_to_send = tmp << 30;
 821       else if (unformat (input, "bytes %lld", &ecm->bytes_to_send))
 822         ;
 823       else if (unformat (input, "test-timeout %f", &test_timeout))
 824         ;
 825       else if (unformat (input, "syn-timeout %f", &syn_timeout))
 826         ;
 827       else if (unformat (input, "no-return"))
 828         ecm->no_return = 1;
 829       else if (unformat (input, "fifo-size %d", &ecm->fifo_size))
 830         ecm->fifo_size <<= 10;
 831       else if (unformat (input, "private-segment-count %d",
 832                          &ecm->private_segment_count))
 833         ;
 834       else if (unformat (input, "private-segment-size %U",
 835                          unformat_memory_size, &tmp))
 836         {
 837           if (tmp >= 0x100000000ULL)
 838             return clib_error_return
 839               (0, "private segment size %lld (%llu) too large", tmp, tmp);
 840           ecm->private_segment_size = tmp;
 841         }
 842       else if (unformat (input, "preallocate-fifos"))
 843         ecm->prealloc_fifos = 1;
 844       else if (unformat (input, "preallocate-sessions"))
 845         preallocate_sessions = 1;
 846       else
 847         if (unformat (input, "client-batch %d", &ecm->connections_per_batch))
 848         ;
 849       else if (unformat (input, "appns %_%v%_", &appns_id))
 850         ;
 851       else if (unformat (input, "all-scope"))
 852         appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
 853                         | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
 854       else if (unformat (input, "local-scope"))
 855         appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
 856       else if (unformat (input, "global-scope"))
 857         appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 858       else if (unformat (input, "secret %lu", &appns_secret))
 859         ;
 860       else if (unformat (input, "no-output"))
 861         ecm->no_output = 1;
 862       else if (unformat (input, "test-bytes"))
 863         ecm->test_bytes = 1;
 864       else if (unformat (input, "tls-engine %d", &ecm->tls_engine))
 865         ;
 866       else
 867         return clib_error_return (0, "failed: unknown input `%U'",
 868                                   format_unformat_error, input);
 869     }
 870
 871   /* Store cli process node index for signalling */
 872   ecm->cli_node_index =
 873     vlib_get_current_process (vm)->node_runtime.node_index;
 874
 875   if (ecm->is_init == 0)
 876     {
 877       if (echo_clients_init (vm))
 878         return clib_error_return (0, "failed init");
 879     }
 880
 881
 882   ecm->ready_connections = 0;
 883   ecm->expected_connections = n_clients * ecm->quic_streams;
 884   ecm->rx_total = 0;
 885   ecm->tx_total = 0;
 886
 887   if (!ecm->connect_uri)
 888     {
 889       clib_warning ("No uri provided. Using default: %s", default_uri);
 890       ecm->connect_uri = format (0, "%s%c", default_uri, 0);
 891     }
 892
 893   if ((rv = parse_uri ((char *) ecm->connect_uri, &sep)))
 894     return clib_error_return (0, "Uri parse error: %d", rv);
 895   ecm->transport_proto = sep.transport_proto;
 896   ecm->is_dgram = (sep.transport_proto == TRANSPORT_PROTO_UDP
 897                    || sep.transport_proto == TRANSPORT_PROTO_UDPC);
 898
 899 #if ECHO_CLIENT_PTHREAD
 900   echo_clients_start_tx_pthread ();
 901 #endif
 902
 903   vlib_worker_thread_barrier_sync (vm);
 904   vnet_session_enable_disable (vm, 1 /* turn on session and transports */ );
 905   vlib_worker_thread_barrier_release (vm);
 906
 907   if (ecm->test_client_attached == 0)
 908     {
 909       if ((error = echo_clients_attach (appns_id, appns_flags, appns_secret)))
 910         {
 911           vec_free (appns_id);
 912           clib_error_report (error);
 913           return error;
 914         }
 915       vec_free (appns_id);
 916     }
 917   ecm->test_client_attached = 1;
 918
 919   /* Turn on the builtin client input nodes */
 920   for (i = 0; i < thread_main->n_vlib_mains; i++)
 921     vlib_node_set_state (vlib_mains[i], echo_clients_node.index,
 922                          VLIB_NODE_STATE_POLLING);
 923
 924   if (preallocate_sessions)
 925     pool_init_fixed (ecm->sessions, 1.1 * n_clients);
 926
 927   /* Fire off connect requests */
 928   time_before_connects = vlib_time_now (vm);
 929   if ((error = echo_clients_connect (vm, n_clients)))
 930     {
 931       goto cleanup;
 932     }
 933
 934   /* Park until the sessions come up, or ten seconds elapse... */
 935   vlib_process_wait_for_event_or_clock (vm, syn_timeout);
 936   event_type = vlib_process_get_events (vm, &event_data);
 937   switch (event_type)
 938     {
 939     case ~0:
 940       ec_cli_output ("Timeout with only %d sessions active...",
 941                      ecm->ready_connections);
 942       error = clib_error_return (0, "failed: syn timeout with %d sessions",
 943                                  ecm->ready_connections);
 944       goto cleanup;
 945
 946     case 1:
 947       delta = vlib_time_now (vm) - time_before_connects;
 948       if (delta != 0.0)
 949         ec_cli_output ("%d three-way handshakes in %.2f seconds %.2f/s",
 950                        n_clients, delta, ((f64) n_clients) / delta);
 951
 952       ecm->test_start_time = vlib_time_now (ecm->vlib_main);
 953       ec_cli_output ("Test started at %.6f", ecm->test_start_time);
 954       break;
 955
 956     default:
 957       ec_cli_output ("unexpected event(1): %d", event_type);
 958       error = clib_error_return (0, "failed: unexpected event(1): %d",
 959                                  event_type);
 960       goto cleanup;
 961     }
 962
 963   /* Now wait for the sessions to finish... */
 964   vlib_process_wait_for_event_or_clock (vm, test_timeout);
 965   event_type = vlib_process_get_events (vm, &event_data);
 966   switch (event_type)
 967     {
 968     case ~0:
 969       ec_cli_output ("Timeout with %d sessions still active...",
 970                      ecm->ready_connections);
 971       error = clib_error_return (0, "failed: timeout with %d sessions",
 972                                  ecm->ready_connections);
 973       goto cleanup;
 974
 975     case 2:
 976       ecm->test_end_time = vlib_time_now (vm);
 977       ec_cli_output ("Test finished at %.6f", ecm->test_end_time);
 978       break;
 979
 980     default:
 981       ec_cli_output ("unexpected event(2): %d", event_type);
 982       error = clib_error_return (0, "failed: unexpected event(2): %d",
 983                                  event_type);
 984       goto cleanup;
 985     }
 986
 987   delta = ecm->test_end_time - ecm->test_start_time;
 988   if (delta != 0.0)
 989     {
 990       total_bytes = (ecm->no_return ? ecm->tx_total : ecm->rx_total);
 991       transfer_type = ecm->no_return ? "half-duplex" : "full-duplex";
 992       ec_cli_output ("%lld bytes (%lld mbytes, %lld gbytes) in %.2f seconds",
 993                      total_bytes, total_bytes / (1ULL << 20),
 994                      total_bytes / (1ULL << 30), delta);
 995       ec_cli_output ("%.2f bytes/second %s", ((f64) total_bytes) / (delta),
 996                      transfer_type);
 997       ec_cli_output ("%.4f gbit/second %s",
 998                      (((f64) total_bytes * 8.0) / delta / 1e9),
 999                      transfer_type);
1000     }
1001   else
1002     {
1003       ec_cli_output ("zero delta-t?");
1004       error = clib_error_return (0, "failed: zero delta-t");
1005       goto cleanup;
1006     }
1007
1008   if (ecm->test_bytes && ecm->test_failed)
1009     error = clib_error_return (0, "failed: test bytes");
1010
1011 cleanup:
1012   ecm->run_test = ECHO_CLIENTS_EXITING;
1013   vlib_process_wait_for_event_or_clock (vm, 10e-3);
1014   for (i = 0; i < vec_len (ecm->connection_index_by_thread); i++)
1015     {
1016       vec_reset_length (ecm->connection_index_by_thread[i]);
1017       vec_reset_length (ecm->connections_this_batch_by_thread[i]);
1018       vec_reset_length (ecm->quic_session_index_by_thread[i]);
1019     }
1020
1021   pool_free (ecm->sessions);
1022
1023   /* Detach the application, so we can use different fifo sizes next time */
1024   if (ecm->test_client_attached)
1025     {
1026       if (echo_clients_detach ())
1027         {
1028           error = clib_error_return (0, "failed: app detach");
1029           ec_cli_output ("WARNING: app detach failed...");
1030         }
1031     }
1032   if (error)
1033     ec_cli_output ("test failed");
1034   vec_free (ecm->connect_uri);
1035   return error;
1036 }
1037
1038 /* *INDENT-OFF* */
1039 VLIB_CLI_COMMAND (echo_clients_command, static) =
1040 {
1041   .path = "test echo clients",
1042   .short_help = "test echo clients [nclients %d][[m|g]bytes <bytes>]"
1043       "[test-timeout <time>][syn-timeout <time>][no-return][fifo-size <size>]"
1044       "[private-segment-count <count>][private-segment-size <bytes>[m|g]]"
1045       "[preallocate-fifos][preallocate-sessions][client-batch <batch-size>]"
1046       "[uri <tcp://ip/port>][test-bytes][no-output]",
1047   .function = echo_clients_command_fn,
1048   .is_mp_safe = 1,
1049 };
1050 /* *INDENT-ON* */
1051
1052 clib_error_t *
1053 echo_clients_main_init (vlib_main_t * vm)
1054 {
1055   echo_client_main_t *ecm = &echo_client_main;
1056   ecm->is_init = 0;
1057   return 0;
1058 }
1059
1060 VLIB_INIT_FUNCTION (echo_clients_main_init);
1061
1062 /*
1063  * fd.io coding-style-patch-verification: ON
1064  *
1065  * Local Variables:
1066  * eval: (c-set-style "gnu")
1067  * End:
1068  */