src/plugins/hs_apps/vcl/vcl_test_client.c

   1 /*
   2  * Copyright (c) 2017-2021 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <unistd.h>
  17 #include <errno.h>
  18 #include <stdlib.h>
  19 #include <ctype.h>
  20 #include <sys/types.h>
  21 #include <sys/socket.h>
  22 #include <stdio.h>
  23 #include <time.h>
  24 #include <arpa/inet.h>
  25 #include <hs_apps/vcl/vcl_test.h>
  26 #include <pthread.h>
  27 #include <signal.h>
  28
  29 typedef struct vtc_worker_ vcl_test_client_worker_t;
  30 typedef int (vtc_worker_run_fn) (vcl_test_client_worker_t *wrk);
  31
  32 struct vtc_worker_
  33 {
  34   vcl_test_session_t *sessions;
  35   vcl_test_session_t *qsessions;
  36   uint32_t n_sessions;
  37   uint32_t wrk_index;
  38   fd_set wr_fdset;
  39   fd_set rd_fdset;
  40   int max_fd_index;
  41   pthread_t thread_handle;
  42   vtc_worker_run_fn *wrk_run_fn;
  43   vcl_test_cfg_t cfg;
  44 };
  45
  46 typedef struct
  47 {
  48   vcl_test_client_worker_t *workers;
  49   vcl_test_session_t ctrl_session;
  50   vppcom_endpt_t server_endpt;
  51   uint32_t cfg_seq_num;
  52   uint8_t dump_cfg;
  53   vcl_test_t post_test;
  54   uint8_t proto;
  55   uint8_t incremental_stats;
  56   uint32_t n_workers;
  57   volatile int active_workers;
  58   volatile int test_running;
  59   union
  60   {
  61     struct in_addr v4;
  62     struct in6_addr v6;
  63   } server_addr;
  64 } vcl_test_client_main_t;
  65
  66 vcl_test_client_main_t vcl_client_main;
  67
  68 #define vtc_min(a, b) (a < b ? a : b)
  69 #define vtc_max(a, b) (a > b ? a : b)
  70
  71 vcl_test_main_t vcl_test_main;
  72
  73 static int
  74 vtc_cfg_sync (vcl_test_session_t * ts)
  75 {
  76   vcl_test_cfg_t *rx_cfg = (vcl_test_cfg_t *) ts->rxbuf;
  77   int rx_bytes, tx_bytes;
  78
  79   vt_atomic_add (&ts->cfg.seq_num, 1);
  80   if (ts->cfg.verbose)
  81     {
  82       vtinf ("(fd %d): Sending config to server.", ts->fd);
  83       vcl_test_cfg_dump (&ts->cfg, 1 /* is_client */ );
  84     }
  85   tx_bytes = ts->write (ts, &ts->cfg, sizeof (ts->cfg));
  86   if (tx_bytes < 0)
  87     {
  88       vtwrn ("(fd %d): write test cfg failed (%d)!", ts->fd, tx_bytes);
  89       return tx_bytes;
  90     }
  91
  92   rx_bytes = ts->read (ts, ts->rxbuf, sizeof (vcl_test_cfg_t));
  93   if (rx_bytes < 0)
  94     return rx_bytes;
  95
  96   if (rx_cfg->magic != VCL_TEST_CFG_CTRL_MAGIC)
  97     {
  98       vtwrn ("(fd %d): Bad server reply cfg -- aborting!", ts->fd);
  99       return -1;
 100     }
 101   if ((rx_bytes != sizeof (vcl_test_cfg_t))
 102       || !vcl_test_cfg_verify (rx_cfg, &ts->cfg))
 103     {
 104       vtwrn ("(fd %d): Invalid config received from server!", ts->fd);
 105       if (rx_bytes != sizeof (vcl_test_cfg_t))
 106         {
 107           vtinf ("\tRx bytes %d != cfg size %lu", rx_bytes,
 108                  sizeof (vcl_test_cfg_t));
 109         }
 110       else
 111         {
 112           vcl_test_cfg_dump (rx_cfg, 1 /* is_client */ );
 113           vtinf ("(fd %d): Valid config sent to server.", ts->fd);
 114           vcl_test_cfg_dump (&ts->cfg, 1 /* is_client */ );
 115         }
 116       return -1;
 117     }
 118   if (ts->cfg.verbose)
 119     {
 120       vtinf ("(fd %d): Got config back from server.", ts->fd);
 121       vcl_test_cfg_dump (rx_cfg, 1 /* is_client */ );
 122     }
 123
 124   return 0;
 125 }
 126
 127 static int
 128 vtc_worker_alloc_sessions (vcl_test_client_worker_t *wrk)
 129 {
 130   vcl_test_session_t *ts;
 131   uint32_t n_test_sessions;
 132   struct timespec now;
 133   int i, j;
 134
 135   n_test_sessions = wrk->cfg.num_test_sessions;
 136   if (n_test_sessions < 1)
 137     {
 138       errno = EINVAL;
 139       return -1;
 140     }
 141
 142   if (wrk->n_sessions >= n_test_sessions)
 143     goto done;
 144
 145   if (wrk->n_sessions)
 146     wrk->sessions = realloc (wrk->sessions,
 147                              n_test_sessions * sizeof (vcl_test_session_t));
 148   else
 149     wrk->sessions = calloc (n_test_sessions, sizeof (vcl_test_session_t));
 150
 151   if (!wrk->sessions)
 152     {
 153       vterr ("failed to alloc sessions", -errno);
 154       return errno;
 155     }
 156
 157   clock_gettime (CLOCK_REALTIME, &now);
 158
 159   for (i = 0; i < n_test_sessions; i++)
 160     {
 161       ts = &wrk->sessions[i];
 162       memset (ts, 0, sizeof (*ts));
 163       ts->session_index = i;
 164       ts->old_stats.stop = now;
 165       ts->cfg = wrk->cfg;
 166       vcl_test_session_buf_alloc (ts);
 167
 168       switch (ts->cfg.test)
 169         {
 170         case VCL_TEST_TYPE_UNI:
 171         case VCL_TEST_TYPE_BI:
 172           for (j = 0; j < ts->txbuf_size; j++)
 173             ts->txbuf[j] = j & 0xff;
 174           break;
 175         default:
 176           break;
 177         }
 178     }
 179   wrk->n_sessions = n_test_sessions;
 180
 181 done:
 182
 183   vtinf ("All test sessions (%d) initialized!", n_test_sessions);
 184
 185   return 0;
 186 }
 187
 188 static int
 189 vtc_worker_init (vcl_test_client_worker_t * wrk)
 190 {
 191   vcl_test_client_main_t *vcm = &vcl_client_main;
 192   int rv;
 193
 194   __wrk_index = wrk->wrk_index;
 195
 196   vtinf ("Initializing worker %u ...", wrk->wrk_index);
 197
 198   if (wrk->wrk_index)
 199     {
 200       if (vppcom_worker_register ())
 201         {
 202           vtwrn ("failed to register worker");
 203           return -1;
 204         }
 205       vt_atomic_add (&vcm->active_workers, 1);
 206     }
 207   rv = vtc_worker_alloc_sessions (wrk);
 208   if (rv)
 209     {
 210       vterr ("vtc_worker_alloc_sessions ()", rv);
 211       return rv;
 212     }
 213
 214   return 0;
 215 }
 216
 217 static int stats_lock = 0;
 218
 219 static void
 220 vtc_accumulate_stats (vcl_test_client_worker_t * wrk,
 221                       vcl_test_session_t * ctrl)
 222 {
 223   vcl_test_session_t *ts;
 224   static char buf[64];
 225   int i, show_rx = 0;
 226
 227   while (__sync_lock_test_and_set (&stats_lock, 1))
 228     ;
 229
 230   if (ctrl->cfg.test == VCL_TEST_TYPE_BI
 231       || ctrl->cfg.test == VCL_TEST_TYPE_ECHO)
 232     show_rx = 1;
 233
 234   for (i = 0; i < wrk->cfg.num_test_sessions; i++)
 235     {
 236       ts = &wrk->sessions[i];
 237       ts->stats.start = ctrl->stats.start;
 238
 239       if (ctrl->cfg.verbose > 1)
 240         {
 241           snprintf (buf, sizeof (buf), "CLIENT (fd %d) RESULTS", ts->fd);
 242           vcl_test_stats_dump (buf, &ts->stats, show_rx, 1 /* show tx */ ,
 243                                ctrl->cfg.verbose);
 244         }
 245
 246       vcl_test_stats_accumulate (&ctrl->stats, &ts->stats);
 247       if (vcl_comp_tspec (&ctrl->stats.stop, &ts->stats.stop) < 0)
 248         ctrl->stats.stop = ts->stats.stop;
 249     }
 250
 251   __sync_lock_release (&stats_lock);
 252 }
 253
 254 static void
 255 vtc_worker_sessions_exit (vcl_test_client_worker_t * wrk)
 256 {
 257   vcl_test_session_t *ts;
 258   int i;
 259
 260   for (i = 0; i < wrk->cfg.num_test_sessions; i++)
 261     {
 262       ts = &wrk->sessions[i];
 263       vppcom_session_close (ts->fd);
 264       vcl_test_session_buf_free (ts);
 265     }
 266
 267   wrk->n_sessions = 0;
 268 }
 269
 270 static void
 271 vtc_inc_stats_check (vcl_test_session_t *ts)
 272 {
 273   /* Avoid checking time too often because of syscall cost */
 274   if (ts->stats.tx_bytes - ts->old_stats.tx_bytes < 1 << 20)
 275     return;
 276
 277   clock_gettime (CLOCK_REALTIME, &ts->stats.stop);
 278   if (vcl_test_time_diff (&ts->old_stats.stop, &ts->stats.stop) > 1)
 279     {
 280       vcl_test_stats_dump_inc (ts, 0 /* is_rx */);
 281       ts->old_stats = ts->stats;
 282     }
 283 }
 284
 285 static void
 286 vtc_worker_start_transfer (vcl_test_client_worker_t *wrk)
 287 {
 288   vtinf ("Worker %u starting transfer ...", wrk->wrk_index);
 289
 290   if (wrk->wrk_index == 0)
 291     {
 292       vcl_test_client_main_t *vcm = &vcl_client_main;
 293       vcl_test_session_t *ctrl = &vcm->ctrl_session;
 294
 295       clock_gettime (CLOCK_REALTIME, &ctrl->stats.start);
 296     }
 297 }
 298
 299 static int
 300 vtc_worker_connect_sessions_select (vcl_test_client_worker_t *wrk)
 301 {
 302   vcl_test_client_main_t *vcm = &vcl_client_main;
 303   vcl_test_main_t *vt = &vcl_test_main;
 304   const vcl_test_proto_vft_t *tp;
 305   vcl_test_session_t *ts;
 306   uint32_t sidx;
 307   int i, rv;
 308
 309   tp = vt->protos[vcm->proto];
 310
 311   FD_ZERO (&wrk->wr_fdset);
 312   FD_ZERO (&wrk->rd_fdset);
 313
 314   for (i = 0; i < wrk->cfg.num_test_sessions; i++)
 315     {
 316       ts = &wrk->sessions[i];
 317
 318       rv = tp->open (&wrk->sessions[i], &vcm->server_endpt);
 319       if (rv < 0)
 320         return rv;
 321
 322       FD_SET (vppcom_session_index (ts->fd), &wrk->wr_fdset);
 323       FD_SET (vppcom_session_index (ts->fd), &wrk->rd_fdset);
 324       sidx = vppcom_session_index (ts->fd);
 325       wrk->max_fd_index = vtc_max (sidx, wrk->max_fd_index);
 326     }
 327   wrk->max_fd_index += 1;
 328
 329   vtinf ("All test sessions (%d) connected!", wrk->cfg.num_test_sessions);
 330
 331   return 0;
 332 }
 333
 334 static int
 335 vtc_worker_run_select (vcl_test_client_worker_t *wrk)
 336 {
 337   vcl_test_client_main_t *vcm = &vcl_client_main;
 338   fd_set _wfdset, *wfdset = &_wfdset;
 339   fd_set _rfdset, *rfdset = &_rfdset;
 340   uint32_t n_active_sessions;
 341   vcl_test_session_t *ts;
 342   int i, rv, check_rx = 0;
 343
 344   rv = vtc_worker_connect_sessions_select (wrk);
 345   if (rv)
 346     {
 347       vterr ("vtc_worker_connect_sessions()", rv);
 348       return rv;
 349     }
 350
 351   check_rx = wrk->cfg.test != VCL_TEST_TYPE_UNI;
 352   n_active_sessions = wrk->cfg.num_test_sessions;
 353
 354   vtc_worker_start_transfer (wrk);
 355
 356   while (n_active_sessions && vcm->test_running)
 357     {
 358       _wfdset = wrk->wr_fdset;
 359       _rfdset = wrk->rd_fdset;
 360
 361       rv = vppcom_select (wrk->max_fd_index, (unsigned long *) rfdset,
 362                           (unsigned long *) wfdset, NULL, 0);
 363       if (rv < 0)
 364         {
 365           vterr ("vppcom_select()", rv);
 366           break;
 367         }
 368       else if (rv == 0)
 369         continue;
 370
 371       for (i = 0; i < wrk->cfg.num_test_sessions; i++)
 372         {
 373           ts = &wrk->sessions[i];
 374           if (ts->is_done)
 375             continue;
 376
 377           if (FD_ISSET (vppcom_session_index (ts->fd), rfdset)
 378               && ts->stats.rx_bytes < ts->cfg.total_bytes)
 379             {
 380               rv = ts->read (ts, ts->rxbuf, ts->rxbuf_size);
 381               if (rv < 0)
 382                 break;
 383             }
 384
 385           if (FD_ISSET (vppcom_session_index (ts->fd), wfdset)
 386               && ts->stats.tx_bytes < ts->cfg.total_bytes)
 387             {
 388               rv = ts->write (ts, ts->txbuf, ts->cfg.txbuf_size);
 389               if (rv < 0)
 390                 {
 391                   vtwrn ("vppcom_test_write (%d) failed -- aborting test",
 392                          ts->fd);
 393                   break;
 394                 }
 395               if (vcm->incremental_stats)
 396                 vtc_inc_stats_check (ts);
 397             }
 398           if ((!check_rx && ts->stats.tx_bytes >= ts->cfg.total_bytes)
 399               || (check_rx && ts->stats.rx_bytes >= ts->cfg.total_bytes))
 400             {
 401               clock_gettime (CLOCK_REALTIME, &ts->stats.stop);
 402               ts->is_done = 1;
 403               n_active_sessions--;
 404             }
 405         }
 406     }
 407
 408   return 0;
 409 }
 410
 411 static inline int
 412 vtc_worker_run (vcl_test_client_worker_t *wrk)
 413 {
 414   int rv;
 415
 416   vtinf ("Worker %u starting test ...", wrk->wrk_index);
 417
 418   rv = wrk->wrk_run_fn (wrk);
 419
 420   vtinf ("Worker %d done ...", wrk->wrk_index);
 421
 422   return rv;
 423 }
 424
 425 static void *
 426 vtc_worker_loop (void *arg)
 427 {
 428   vcl_test_client_main_t *vcm = &vcl_client_main;
 429   vcl_test_session_t *ctrl = &vcm->ctrl_session;
 430   vcl_test_client_worker_t *wrk = arg;
 431
 432   if (vtc_worker_init (wrk))
 433     goto done;
 434
 435   if (vtc_worker_run (wrk))
 436     goto done;
 437
 438   vtc_accumulate_stats (wrk, ctrl);
 439   sleep (VCL_TEST_DELAY_DISCONNECT);
 440   vtc_worker_sessions_exit (wrk);
 441
 442 done:
 443
 444   if (wrk->wrk_index)
 445     vt_atomic_add (&vcm->active_workers, -1);
 446
 447   return 0;
 448 }
 449
 450 static void
 451 vtc_print_stats (vcl_test_session_t * ctrl)
 452 {
 453   int is_echo = ctrl->cfg.test == VCL_TEST_TYPE_ECHO;
 454   int show_rx = 0;
 455   char buf[64];
 456
 457   if (ctrl->cfg.test == VCL_TEST_TYPE_BI
 458       || ctrl->cfg.test == VCL_TEST_TYPE_ECHO)
 459     show_rx = 1;
 460
 461   vcl_test_stats_dump ("CLIENT RESULTS", &ctrl->stats,
 462                        show_rx, 1 /* show tx */ ,
 463                        ctrl->cfg.verbose);
 464   vcl_test_cfg_dump (&ctrl->cfg, 1 /* is_client */ );
 465
 466   if (ctrl->cfg.verbose)
 467     {
 468       vtinf ("  ctrl session info\n"
 469              VCL_TEST_SEPARATOR_STRING
 470              "          fd:  %d (0x%08x)\n"
 471              "       rxbuf:  %p\n"
 472              "  rxbuf size:  %u (0x%08x)\n"
 473              "       txbuf:  %p\n"
 474              "  txbuf size:  %u (0x%08x)\n"
 475              VCL_TEST_SEPARATOR_STRING,
 476              ctrl->fd, (uint32_t) ctrl->fd,
 477              ctrl->rxbuf, ctrl->rxbuf_size, ctrl->rxbuf_size,
 478              ctrl->txbuf, ctrl->txbuf_size, ctrl->txbuf_size);
 479     }
 480
 481   if (is_echo)
 482     snprintf (buf, sizeof (buf), "Echo");
 483   else
 484     snprintf (buf, sizeof (buf), "%s-directional Stream",
 485               ctrl->cfg.test == VCL_TEST_TYPE_BI ? "Bi" : "Uni");
 486 }
 487
 488 static void
 489 vtc_echo_client (vcl_test_client_main_t * vcm)
 490 {
 491   vcl_test_session_t *ctrl = &vcm->ctrl_session;
 492   vcl_test_cfg_t *cfg = &ctrl->cfg;
 493   int rv;
 494
 495   cfg->total_bytes = strlen (ctrl->txbuf) + 1;
 496   memset (&ctrl->stats, 0, sizeof (ctrl->stats));
 497
 498   rv = ctrl->write (ctrl, ctrl->txbuf, cfg->total_bytes);
 499   if (rv < 0)
 500     {
 501       vtwrn ("vppcom_test_write (%d) failed ", ctrl->fd);
 502       return;
 503     }
 504
 505   (void) ctrl->read (ctrl, ctrl->rxbuf, ctrl->rxbuf_size);
 506 }
 507
 508 static void
 509 vtc_stream_client (vcl_test_client_main_t * vcm)
 510 {
 511   vcl_test_session_t *ctrl = &vcm->ctrl_session;
 512   vcl_test_cfg_t *cfg = &ctrl->cfg;
 513   vcl_test_client_worker_t *wrk;
 514   uint32_t i, n_conn, n_conn_per_wrk;
 515
 516   vtinf ("%s-directional Stream Test Starting!",
 517          ctrl->cfg.test == VCL_TEST_TYPE_BI ? "Bi" : "Uni");
 518
 519   memset (&ctrl->stats, 0, sizeof (vcl_test_stats_t));
 520   cfg->total_bytes = cfg->num_writes * cfg->txbuf_size;
 521   cfg->ctrl_handle = ctrl->fd;
 522
 523   n_conn = cfg->num_test_sessions;
 524   n_conn_per_wrk = n_conn / vcm->n_workers;
 525   for (i = 0; i < vcm->n_workers; i++)
 526     {
 527       wrk = &vcm->workers[i];
 528       wrk->wrk_index = i;
 529       wrk->cfg = ctrl->cfg;
 530       wrk->cfg.num_test_sessions = vtc_min (n_conn_per_wrk, n_conn);
 531       n_conn -= wrk->cfg.num_test_sessions;
 532     }
 533
 534   vcm->test_running = 1;
 535   ctrl->cfg.cmd = VCL_TEST_CMD_START;
 536   if (vtc_cfg_sync (ctrl))
 537     {
 538       vtwrn ("test cfg sync failed -- aborting!");
 539       return;
 540     }
 541
 542   for (i = 1; i < vcm->n_workers; i++)
 543     {
 544       wrk = &vcm->workers[i];
 545       pthread_create (&wrk->thread_handle, NULL, vtc_worker_loop,
 546                       (void *) wrk);
 547     }
 548   vtc_worker_loop (&vcm->workers[0]);
 549
 550   while (vcm->active_workers > 0)
 551     ;
 552
 553   vtinf ("Sending config on ctrl session (fd %d) for stats...", ctrl->fd);
 554   ctrl->cfg.cmd = VCL_TEST_CMD_STOP;
 555   if (vtc_cfg_sync (ctrl))
 556     {
 557       vtwrn ("test cfg sync failed -- aborting!");
 558       return;
 559     }
 560
 561   vtc_print_stats (ctrl);
 562
 563   ctrl->cfg.cmd = VCL_TEST_CMD_SYNC;
 564   ctrl->cfg.test = VCL_TEST_TYPE_ECHO;
 565   ctrl->cfg.total_bytes = 0;
 566   if (vtc_cfg_sync (ctrl))
 567     vtwrn ("post-test cfg sync failed!");
 568 }
 569
 570 static void
 571 cfg_txbuf_size_set (void)
 572 {
 573   vcl_test_client_main_t *vcm = &vcl_client_main;
 574   vcl_test_session_t *ctrl = &vcm->ctrl_session;
 575   char *p = ctrl->txbuf + strlen (VCL_TEST_TOKEN_TXBUF_SIZE);
 576   uint64_t txbuf_size = strtoull ((const char *) p, NULL, 10);
 577
 578   if (txbuf_size >= VCL_TEST_CFG_BUF_SIZE_MIN)
 579     {
 580       ctrl->cfg.txbuf_size = txbuf_size;
 581       ctrl->cfg.total_bytes = ctrl->cfg.num_writes * ctrl->cfg.txbuf_size;
 582       vcl_test_buf_alloc (&ctrl->cfg, 0 /* is_rxbuf */ ,
 583                           (uint8_t **) & ctrl->txbuf, &ctrl->txbuf_size);
 584       vcl_test_cfg_dump (&ctrl->cfg, 1 /* is_client */ );
 585     }
 586   else
 587     vtwrn ("Invalid txbuf size (%lu) < minimum buf size (%u)!",
 588            txbuf_size, VCL_TEST_CFG_BUF_SIZE_MIN);
 589 }
 590
 591 static void
 592 cfg_num_writes_set (void)
 593 {
 594   vcl_test_client_main_t *vcm = &vcl_client_main;
 595   vcl_test_session_t *ctrl = &vcm->ctrl_session;
 596   char *p = ctrl->txbuf + strlen (VCL_TEST_TOKEN_NUM_WRITES);
 597   uint32_t num_writes = strtoul ((const char *) p, NULL, 10);
 598
 599   if (num_writes > 0)
 600     {
 601       ctrl->cfg.num_writes = num_writes;
 602       ctrl->cfg.total_bytes = ctrl->cfg.num_writes * ctrl->cfg.txbuf_size;
 603       vcl_test_cfg_dump (&ctrl->cfg, 1 /* is_client */ );
 604     }
 605   else
 606     {
 607       vtwrn ("invalid num writes: %u", num_writes);
 608     }
 609 }
 610
 611 static void
 612 cfg_num_test_sessions_set (void)
 613 {
 614   vcl_test_client_main_t *vcm = &vcl_client_main;
 615   vcl_test_session_t *ctrl = &vcm->ctrl_session;
 616   char *p = ctrl->txbuf + strlen (VCL_TEST_TOKEN_NUM_TEST_SESS);
 617   uint32_t num_test_sessions = strtoul ((const char *) p, NULL, 10);
 618
 619   if ((num_test_sessions > 0) &&
 620       (num_test_sessions <= VCL_TEST_CFG_MAX_TEST_SESS))
 621     {
 622       ctrl->cfg.num_test_sessions = num_test_sessions;
 623       vcl_test_cfg_dump (&ctrl->cfg, 1 /* is_client */ );
 624     }
 625   else
 626     {
 627       vtwrn ("invalid num test sessions: %u, (%d max)",
 628              num_test_sessions, VCL_TEST_CFG_MAX_TEST_SESS);
 629     }
 630 }
 631
 632 static void
 633 cfg_rxbuf_size_set (void)
 634 {
 635   vcl_test_client_main_t *vcm = &vcl_client_main;
 636   vcl_test_session_t *ctrl = &vcm->ctrl_session;
 637   char *p = ctrl->txbuf + strlen (VCL_TEST_TOKEN_RXBUF_SIZE);
 638   uint64_t rxbuf_size = strtoull ((const char *) p, NULL, 10);
 639
 640   if (rxbuf_size >= VCL_TEST_CFG_BUF_SIZE_MIN)
 641     {
 642       ctrl->cfg.rxbuf_size = rxbuf_size;
 643       vcl_test_buf_alloc (&ctrl->cfg, 1 /* is_rxbuf */ ,
 644                           (uint8_t **) & ctrl->rxbuf, &ctrl->rxbuf_size);
 645       vcl_test_cfg_dump (&ctrl->cfg, 1 /* is_client */ );
 646     }
 647   else
 648     vtwrn ("Invalid rxbuf size (%lu) < minimum buf size (%u)!",
 649            rxbuf_size, VCL_TEST_CFG_BUF_SIZE_MIN);
 650 }
 651
 652 static void
 653 cfg_verbose_toggle (void)
 654 {
 655   vcl_test_client_main_t *vcm = &vcl_client_main;
 656   vcl_test_session_t *ctrl = &vcm->ctrl_session;
 657
 658   ctrl->cfg.verbose = ctrl->cfg.verbose ? 0 : 1;
 659   vcl_test_cfg_dump (&ctrl->cfg, 1 /* is_client */ );
 660
 661 }
 662
 663 static vcl_test_t
 664 parse_input ()
 665 {
 666   vcl_test_client_main_t *vcm = &vcl_client_main;
 667   vcl_test_session_t *ctrl = &vcm->ctrl_session;
 668   vcl_test_t rv = VCL_TEST_TYPE_NONE;
 669
 670   if (!strncmp (VCL_TEST_TOKEN_EXIT, ctrl->txbuf,
 671                 strlen (VCL_TEST_TOKEN_EXIT)))
 672     rv = VCL_TEST_TYPE_EXIT;
 673
 674   else if (!strncmp (VCL_TEST_TOKEN_HELP, ctrl->txbuf,
 675                      strlen (VCL_TEST_TOKEN_HELP)))
 676     dump_help ();
 677
 678   else if (!strncmp (VCL_TEST_TOKEN_SHOW_CFG, ctrl->txbuf,
 679                      strlen (VCL_TEST_TOKEN_SHOW_CFG)))
 680     vcm->dump_cfg = 1;
 681
 682   else if (!strncmp (VCL_TEST_TOKEN_VERBOSE, ctrl->txbuf,
 683                      strlen (VCL_TEST_TOKEN_VERBOSE)))
 684     cfg_verbose_toggle ();
 685
 686   else if (!strncmp (VCL_TEST_TOKEN_TXBUF_SIZE, ctrl->txbuf,
 687                      strlen (VCL_TEST_TOKEN_TXBUF_SIZE)))
 688     cfg_txbuf_size_set ();
 689
 690   else if (!strncmp (VCL_TEST_TOKEN_NUM_TEST_SESS, ctrl->txbuf,
 691                      strlen (VCL_TEST_TOKEN_NUM_TEST_SESS)))
 692     cfg_num_test_sessions_set ();
 693
 694   else if (!strncmp (VCL_TEST_TOKEN_NUM_WRITES, ctrl->txbuf,
 695                      strlen (VCL_TEST_TOKEN_NUM_WRITES)))
 696     cfg_num_writes_set ();
 697
 698   else if (!strncmp (VCL_TEST_TOKEN_RXBUF_SIZE, ctrl->txbuf,
 699                      strlen (VCL_TEST_TOKEN_RXBUF_SIZE)))
 700     cfg_rxbuf_size_set ();
 701
 702   else if (!strncmp (VCL_TEST_TOKEN_RUN_UNI, ctrl->txbuf,
 703                      strlen (VCL_TEST_TOKEN_RUN_UNI)))
 704     rv = ctrl->cfg.test = VCL_TEST_TYPE_UNI;
 705
 706   else if (!strncmp (VCL_TEST_TOKEN_RUN_BI, ctrl->txbuf,
 707                      strlen (VCL_TEST_TOKEN_RUN_BI)))
 708     rv = ctrl->cfg.test = VCL_TEST_TYPE_BI;
 709
 710   else
 711     rv = VCL_TEST_TYPE_ECHO;
 712
 713   return rv;
 714 }
 715
 716 void
 717 print_usage_and_exit (void)
 718 {
 719   fprintf (
 720     stderr,
 721     "vcl_test_client [OPTIONS] <ipaddr> <port>\n"
 722     "  OPTIONS\n"
 723     "  -h               Print this message and exit.\n"
 724     "  -6               Use IPv6\n"
 725     "  -c               Print test config before test.\n"
 726     "  -w <dir>         Write test results to <dir>.\n"
 727     "  -X               Exit after running test.\n"
 728     "  -p <proto>       Use <proto> transport layer\n"
 729     "  -D               Use UDP transport layer\n"
 730     "  -L               Use TLS transport layer\n"
 731     "  -E               Run Echo test.\n"
 732     "  -N <num-writes>  Test Cfg: number of writes.\n"
 733     "  -R <rxbuf-size>  Test Cfg: rx buffer size.\n"
 734     "  -T <txbuf-size>  Test Cfg: tx buffer size.\n"
 735     "  -U               Run Uni-directional test.\n"
 736     "  -B               Run Bi-directional test.\n"
 737     "  -V               Verbose mode.\n"
 738     "  -I <N>           Use N sessions.\n"
 739     "  -s <N>           Use N sessions.\n"
 740     "  -S               Print incremental stats per session.\n"
 741     "  -q <n>           QUIC : use N Ssessions on top of n Qsessions\n");
 742   exit (1);
 743 }
 744
 745 static void
 746 vtc_process_opts (vcl_test_client_main_t * vcm, int argc, char **argv)
 747 {
 748   vcl_test_session_t *ctrl = &vcm->ctrl_session;
 749   int c, v;
 750
 751   opterr = 0;
 752   while ((c = getopt (argc, argv, "chnp:w:xXE:I:N:R:T:UBV6DLs:q:S")) != -1)
 753     switch (c)
 754       {
 755       case 'c':
 756         vcm->dump_cfg = 1;
 757         break;
 758
 759       case 'I':         /* deprecated */
 760       case 's':
 761         if (sscanf (optarg, "0x%x", &ctrl->cfg.num_test_sessions) != 1)
 762           if (sscanf (optarg, "%u", &ctrl->cfg.num_test_sessions) != 1)
 763             {
 764               vtwrn ("Invalid value for option -%c!", c);
 765               print_usage_and_exit ();
 766             }
 767         if (!ctrl->cfg.num_test_sessions ||
 768             (ctrl->cfg.num_test_sessions > VCL_TEST_CFG_MAX_TEST_SESS))
 769           {
 770             vtwrn ("Invalid number of sessions (%d) specified for option -%c!"
 771                    "\n       Valid range is 1 - %d",
 772                    ctrl->cfg.num_test_sessions, c,
 773                    VCL_TEST_CFG_MAX_TEST_SESS);
 774             print_usage_and_exit ();
 775           }
 776         break;
 777
 778       case 'q':
 779         if (sscanf (optarg, "0x%x", &ctrl->cfg.num_test_sessions_perq) != 1)
 780           if (sscanf (optarg, "%u", &ctrl->cfg.num_test_sessions_perq) != 1)
 781             {
 782               vtwrn ("Invalid value for option -%c!", c);
 783               print_usage_and_exit ();
 784             }
 785         if (!ctrl->cfg.num_test_sessions_perq ||
 786             (ctrl->cfg.num_test_sessions_perq > VCL_TEST_CFG_MAX_TEST_SESS))
 787           {
 788             vtwrn ("Invalid number of Stream sessions (%d) per Qsession"
 789                    "for option -%c!\nValid range is 1 - %d",
 790                    ctrl->cfg.num_test_sessions_perq, c,
 791                    VCL_TEST_CFG_MAX_TEST_SESS);
 792             print_usage_and_exit ();
 793           }
 794         break;
 795
 796       case 'w':
 797         if (sscanf (optarg, "%d", &v) != 1)
 798           {
 799             vtwrn ("Invalid value for option -%c!", c);
 800             print_usage_and_exit ();
 801           }
 802         if (v > 1)
 803           vcm->n_workers = v;
 804         break;
 805
 806       case 'X':
 807         vcm->post_test = VCL_TEST_TYPE_EXIT;
 808         break;
 809
 810       case 'x':
 811         vcm->post_test = VCL_TEST_TYPE_NONE;
 812         break;
 813
 814       case 'E':
 815         if (strlen (optarg) > ctrl->txbuf_size)
 816           {
 817             vtwrn ("Option -%c value larger than txbuf size (%d)!",
 818                    optopt, ctrl->txbuf_size);
 819             print_usage_and_exit ();
 820           }
 821         strncpy (ctrl->txbuf, optarg, ctrl->txbuf_size);
 822         ctrl->cfg.test = VCL_TEST_TYPE_ECHO;
 823         break;
 824
 825       case 'N':
 826         if (sscanf (optarg, "0x%lx", &ctrl->cfg.num_writes) != 1)
 827           if (sscanf (optarg, "%ld", &ctrl->cfg.num_writes) != 1)
 828             {
 829               vtwrn ("Invalid value for option -%c!", c);
 830               print_usage_and_exit ();
 831             }
 832         ctrl->cfg.total_bytes = ctrl->cfg.num_writes * ctrl->cfg.txbuf_size;
 833         break;
 834
 835       case 'R':
 836         if (sscanf (optarg, "0x%lx", &ctrl->cfg.rxbuf_size) != 1)
 837           if (sscanf (optarg, "%ld", &ctrl->cfg.rxbuf_size) != 1)
 838             {
 839               vtwrn ("Invalid value for option -%c!", c);
 840               print_usage_and_exit ();
 841             }
 842         if (ctrl->cfg.rxbuf_size >= VCL_TEST_CFG_BUF_SIZE_MIN)
 843           {
 844             ctrl->rxbuf_size = ctrl->cfg.rxbuf_size;
 845             vcl_test_buf_alloc (&ctrl->cfg, 1 /* is_rxbuf */ ,
 846                                 (uint8_t **) & ctrl->rxbuf,
 847                                 &ctrl->rxbuf_size);
 848           }
 849         else
 850           {
 851             vtwrn ("rxbuf size (%lu) less than minumum (%u)",
 852                    ctrl->cfg.rxbuf_size, VCL_TEST_CFG_BUF_SIZE_MIN);
 853             print_usage_and_exit ();
 854           }
 855
 856         break;
 857
 858       case 'T':
 859         if (sscanf (optarg, "0x%lx", &ctrl->cfg.txbuf_size) != 1)
 860           if (sscanf (optarg, "%ld", &ctrl->cfg.txbuf_size) != 1)
 861             {
 862               vtwrn ("Invalid value for option -%c!", c);
 863               print_usage_and_exit ();
 864             }
 865         if (ctrl->cfg.txbuf_size >= VCL_TEST_CFG_BUF_SIZE_MIN)
 866           {
 867             ctrl->txbuf_size = ctrl->cfg.txbuf_size;
 868             vcl_test_buf_alloc (&ctrl->cfg, 0 /* is_rxbuf */ ,
 869                                 (uint8_t **) & ctrl->txbuf,
 870                                 &ctrl->txbuf_size);
 871             ctrl->cfg.total_bytes =
 872               ctrl->cfg.num_writes * ctrl->cfg.txbuf_size;
 873           }
 874         else
 875           {
 876             vtwrn ("txbuf size (%lu) less than minumum (%u)!",
 877                    ctrl->cfg.txbuf_size, VCL_TEST_CFG_BUF_SIZE_MIN);
 878             print_usage_and_exit ();
 879           }
 880         break;
 881
 882       case 'U':
 883         ctrl->cfg.test = VCL_TEST_TYPE_UNI;
 884         break;
 885
 886       case 'B':
 887         ctrl->cfg.test = VCL_TEST_TYPE_BI;
 888         break;
 889
 890       case 'V':
 891         ctrl->cfg.verbose = 1;
 892         break;
 893
 894       case '6':
 895         ctrl->cfg.address_ip6 = 1;
 896         break;
 897
 898       case 'p':
 899         if (vppcom_unformat_proto (&vcm->proto, optarg))
 900           vtwrn ("Invalid vppcom protocol %s, defaulting to TCP", optarg);
 901         break;
 902
 903       case 'D':         /* deprecated */
 904         vcm->proto = VPPCOM_PROTO_UDP;
 905         break;
 906
 907       case 'L':         /* deprecated */
 908         vcm->proto = VPPCOM_PROTO_TLS;
 909         break;
 910
 911       case 'S':
 912         vcm->incremental_stats = 1;
 913         break;
 914
 915       case '?':
 916         switch (optopt)
 917           {
 918           case 'E':
 919           case 'I':             /* deprecated */
 920           case 'N':
 921           case 'R':
 922           case 'T':
 923           case 'w':
 924           case 'p':
 925           case 'q':
 926             vtwrn ("Option -%c requires an argument.", optopt);
 927             break;
 928
 929           default:
 930             if (isprint (optopt))
 931               vtwrn ("Unknown option `-%c'.", optopt);
 932             else
 933               vtwrn ("Unknown option character `\\x%x'.", optopt);
 934           }
 935         /* fall thru */
 936       case 'h':
 937       default:
 938         print_usage_and_exit ();
 939       }
 940
 941   if (argc > (optind + 2))
 942     {
 943       vtwrn ("Invalid number of arguments!");
 944       print_usage_and_exit ();
 945     }
 946
 947   ctrl->cfg.num_test_qsessions = vcm->proto != VPPCOM_PROTO_QUIC ? 0 :
 948     (ctrl->cfg.num_test_sessions + ctrl->cfg.num_test_sessions_perq - 1) /
 949     ctrl->cfg.num_test_sessions_perq;
 950
 951   memset (&vcm->server_addr, 0, sizeof (vcm->server_addr));
 952   if (ctrl->cfg.address_ip6)
 953     {
 954       struct in6_addr *in6 = &vcm->server_addr.v6;
 955       inet_pton (AF_INET6, argv[optind++], in6);
 956
 957       vcm->server_endpt.is_ip4 = 0;
 958       vcm->server_endpt.ip = (uint8_t *) in6;
 959     }
 960   else
 961     {
 962       struct in_addr *in4 = &vcm->server_addr.v4;
 963       inet_pton (AF_INET, argv[optind++], in4);
 964
 965       vcm->server_endpt.is_ip4 = 1;
 966       vcm->server_endpt.ip = (uint8_t *) in4;
 967     }
 968
 969   if (argc == optind + 1)
 970     vcm->server_endpt.port = htons (atoi (argv[optind]));
 971   else
 972     vcm->server_endpt.port = htons (VCL_TEST_SERVER_PORT);
 973 }
 974
 975 static void
 976 vtc_read_user_input (vcl_test_session_t * ctrl)
 977 {
 978   printf ("\nType some characters and hit <return>\n"
 979           "('" VCL_TEST_TOKEN_HELP "' for help): ");
 980
 981   if (fgets (ctrl->txbuf, ctrl->txbuf_size, stdin) != NULL)
 982     {
 983       if (strlen (ctrl->txbuf) == 1)
 984         {
 985           printf ("\nNothing to send!  Please try again...\n");
 986           return;
 987         }
 988       ctrl->txbuf[strlen (ctrl->txbuf) - 1] = 0;        // chomp the newline.
 989
 990       /* Parse input for keywords */
 991       ctrl->cfg.test = parse_input ();
 992     }
 993 }
 994
 995 static void
 996 vtc_ctrl_session_exit (void)
 997 {
 998   vcl_test_client_main_t *vcm = &vcl_client_main;
 999   vcl_test_session_t *ctrl = &vcm->ctrl_session;
1000   int verbose = ctrl->cfg.verbose;
1001
1002   /* Only clients exits, server can accept new connections */
1003   if (vcm->post_test == VCL_TEST_TYPE_EXIT_CLIENT)
1004     return;
1005
1006   ctrl->cfg.test = VCL_TEST_TYPE_EXIT;
1007   vtinf ("(fd %d): Sending exit cfg to server...", ctrl->fd);
1008   if (verbose)
1009     vcl_test_cfg_dump (&ctrl->cfg, 1 /* is_client */);
1010   (void) vcl_test_write (ctrl, (uint8_t *) &ctrl->cfg, sizeof (ctrl->cfg));
1011   sleep (1);
1012 }
1013
1014 static int
1015 vtc_ctrl_session_init (vcl_test_client_main_t *vcm, vcl_test_session_t *ctrl)
1016 {
1017   int rv;
1018
1019   ctrl->fd = vppcom_session_create (VPPCOM_PROTO_TCP, 0 /* is_nonblocking */);
1020   if (ctrl->fd < 0)
1021     {
1022       vterr ("vppcom_session_create()", ctrl->fd);
1023       return ctrl->fd;
1024     }
1025
1026   vtinf ("Connecting to server...");
1027   rv = vppcom_session_connect (ctrl->fd, &vcm->server_endpt);
1028   if (rv)
1029     {
1030       vterr ("vppcom_session_connect()", rv);
1031       return rv;
1032     }
1033   vtinf ("Control session (fd %d) connected.", ctrl->fd);
1034
1035   ctrl->read = vcl_test_read;
1036   ctrl->write = vcl_test_write;
1037
1038   ctrl->cfg.cmd = VCL_TEST_CMD_SYNC;
1039   rv = vtc_cfg_sync (ctrl);
1040   if (rv)
1041     {
1042       vterr ("vtc_cfg_sync()", rv);
1043       return rv;
1044     }
1045
1046   ctrl->cfg.ctrl_handle = ((vcl_test_cfg_t *) ctrl->rxbuf)->ctrl_handle;
1047   memset (&ctrl->stats, 0, sizeof (ctrl->stats));
1048
1049   return 0;
1050 }
1051
1052 static void
1053 vt_sigs_handler (int signum, siginfo_t *si, void *uc)
1054 {
1055   vcl_test_client_main_t *vcm = &vcl_client_main;
1056   vcl_test_session_t *ctrl = &vcm->ctrl_session;
1057
1058   vcm->test_running = 0;
1059   clock_gettime (CLOCK_REALTIME, &ctrl->stats.stop);
1060 }
1061
1062 static void
1063 vt_incercept_sigs (void)
1064 {
1065   struct sigaction sa;
1066
1067   memset (&sa, 0, sizeof (sa));
1068   sa.sa_sigaction = vt_sigs_handler;
1069   sa.sa_flags = SA_SIGINFO;
1070   if (sigaction (SIGINT, &sa, 0))
1071     {
1072       vtwrn ("couldn't intercept sigint");
1073       exit (-1);
1074     }
1075 }
1076
1077 static void
1078 vtc_alloc_workers (vcl_test_client_main_t *vcm)
1079 {
1080   vcm->workers = calloc (vcm->n_workers, sizeof (vcl_test_client_worker_t));
1081
1082   for (int i = 0; i < vcm->n_workers; i++)
1083     {
1084       vcm->workers[i].wrk_run_fn = vtc_worker_run_select;
1085     }
1086 }
1087
1088 int
1089 main (int argc, char **argv)
1090 {
1091   vcl_test_client_main_t *vcm = &vcl_client_main;
1092   vcl_test_session_t *ctrl = &vcm->ctrl_session;
1093   vcl_test_main_t *vt = &vcl_test_main;
1094   int rv;
1095
1096   vcm->n_workers = 1;
1097   vcm->post_test = VCL_TEST_TYPE_EXIT_CLIENT;
1098
1099   vcl_test_cfg_init (&ctrl->cfg);
1100   vt_incercept_sigs ();
1101   vcl_test_session_buf_alloc (ctrl);
1102   vtc_process_opts (vcm, argc, argv);
1103
1104   vtc_alloc_workers (vcm);
1105
1106   rv = vppcom_app_create ("vcl_test_client");
1107   if (rv < 0)
1108     vtfail ("vppcom_app_create()", rv);
1109
1110   /* Protos like tls/dtls/quic need init */
1111   if (vt->protos[vcm->proto]->init)
1112     {
1113       rv = vt->protos[vcm->proto]->init (&ctrl->cfg);
1114       if (rv)
1115         vtfail ("client init failed", rv);
1116     }
1117
1118   if ((rv = vtc_ctrl_session_init (vcm, ctrl)))
1119     vtfail ("vppcom_session_create() ctrl session", rv);
1120
1121   /* Update ctrl port to data port */
1122   vcm->server_endpt.port += 1;
1123
1124   while (ctrl->cfg.test != VCL_TEST_TYPE_EXIT)
1125     {
1126       if (vcm->dump_cfg)
1127         {
1128           vcl_test_cfg_dump (&ctrl->cfg, 1 /* is_client */ );
1129           vcm->dump_cfg = 0;
1130         }
1131
1132       switch (ctrl->cfg.test)
1133         {
1134         case VCL_TEST_TYPE_ECHO:
1135           vtc_echo_client (vcm);
1136           break;
1137
1138         case VCL_TEST_TYPE_UNI:
1139         case VCL_TEST_TYPE_BI:
1140           vtc_stream_client (vcm);
1141           break;
1142
1143         case VCL_TEST_TYPE_EXIT:
1144           continue;
1145
1146         case VCL_TEST_TYPE_NONE:
1147         default:
1148           break;
1149         }
1150       switch (vcm->post_test)
1151         {
1152         case VCL_TEST_TYPE_EXIT:
1153         case VCL_TEST_TYPE_EXIT_CLIENT:
1154           switch (ctrl->cfg.test)
1155             {
1156             case VCL_TEST_TYPE_EXIT:
1157             case VCL_TEST_TYPE_UNI:
1158             case VCL_TEST_TYPE_BI:
1159             case VCL_TEST_TYPE_ECHO:
1160               ctrl->cfg.test = VCL_TEST_TYPE_EXIT;
1161               continue;
1162
1163             case VCL_TEST_TYPE_NONE:
1164             default:
1165               break;
1166             }
1167           break;
1168
1169         case VCL_TEST_TYPE_NONE:
1170         case VCL_TEST_TYPE_ECHO:
1171         case VCL_TEST_TYPE_UNI:
1172         case VCL_TEST_TYPE_BI:
1173         default:
1174           break;
1175         }
1176
1177       memset (ctrl->txbuf, 0, ctrl->txbuf_size);
1178       memset (ctrl->rxbuf, 0, ctrl->rxbuf_size);
1179
1180       vtc_read_user_input (ctrl);
1181     }
1182
1183   vtc_ctrl_session_exit ();
1184   vppcom_app_destroy ();
1185   free (vcm->workers);
1186   return 0;
1187 }
1188
1189 /*
1190  * fd.io coding-style-patch-verification: ON
1191  *
1192  * Local Variables:
1193  * eval: (c-set-style "gnu")
1194  * End:
1195  */