src/plugins/hs_apps/sapi/vpp_echo.c

   1 /*
   2  * Copyright (c) 2019 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 <stdio.h>
  17 #include <signal.h>
  18
  19 #include <vlibmemory/api.h>
  20 #include <svm/fifo_segment.h>
  21
  22 #include <hs_apps/sapi/vpp_echo_common.h>
  23
  24 echo_main_t echo_main;
  25
  26 static void
  27 echo_session_prealloc (echo_main_t * em)
  28 {
  29   /* We need to prealloc to avoid vec resize in threads */
  30   echo_session_t *session;
  31   int i;
  32   for (i = 0; i < em->n_sessions; i++)
  33     {
  34       pool_get (em->sessions, session);
  35       clib_memset (session, 0, sizeof (*session));
  36       session->session_index = session - em->sessions;
  37       session->listener_index = SESSION_INVALID_INDEX;
  38       session->session_state = ECHO_SESSION_STATE_INITIAL;
  39     }
  40 }
  41
  42 static void
  43 echo_assert_test_suceeded (echo_main_t * em)
  44 {
  45   if (em->rx_results_diff)
  46     CHECK_DIFF (ECHO_FAIL_TEST_ASSERT_RX_TOTAL, em->stats.rx_expected,
  47                 em->stats.rx_total, "Invalid amount of data received");
  48   else
  49     CHECK_SAME (ECHO_FAIL_TEST_ASSERT_RX_TOTAL, em->stats.rx_expected,
  50                 em->stats.rx_total, "Invalid amount of data received");
  51
  52   if (em->tx_results_diff)
  53     CHECK_DIFF (ECHO_FAIL_TEST_ASSERT_TX_TOTAL, em->stats.tx_expected,
  54                 em->stats.tx_total, "Invalid amount of data sent");
  55   else
  56     CHECK_SAME (ECHO_FAIL_TEST_ASSERT_TX_TOTAL, em->stats.tx_expected,
  57                 em->stats.tx_total, "Invalid amount of data sent");
  58
  59   clib_spinlock_lock (&em->sid_vpp_handles_lock);
  60   CHECK_SAME (ECHO_FAIL_TEST_ASSERT_ALL_SESSIONS_CLOSED,
  61               0, hash_elts (em->session_index_by_vpp_handles),
  62               "Some sessions are still open");
  63   clib_spinlock_unlock (&em->sid_vpp_handles_lock);
  64 }
  65
  66 always_inline void
  67 echo_session_dequeue_notify (echo_session_t * s)
  68 {
  69   int rv;
  70   if (!svm_fifo_set_event (s->rx_fifo))
  71     return;
  72   if ((rv = app_send_io_evt_to_vpp (s->vpp_evt_q,
  73                                     s->rx_fifo->shr->master_session_index,
  74                                     SESSION_IO_EVT_RX, SVM_Q_WAIT)))
  75     ECHO_FAIL (ECHO_FAIL_SEND_IO_EVT, "app_send_io_evt_to_vpp errored %d",
  76                rv);
  77   svm_fifo_clear_deq_ntf (s->rx_fifo);
  78 }
  79
  80 static void
  81 stop_signal (int signum)
  82 {
  83   echo_main_t *em = &echo_main;
  84   em->time_to_stop = 1;
  85 }
  86
  87 static int
  88 connect_to_vpp (echo_main_t *em)
  89 {
  90   api_main_t *am = vlibapi_get_main ();
  91
  92   if (em->use_app_socket_api)
  93     return echo_api_connect_app_socket (em);
  94
  95   if (em->use_sock_api)
  96     {
  97       if (vl_socket_client_connect ((char *) em->socket_name,
  98                                     (char *) em->app_name,
  99                                     0 /* default rx, tx buffer */))
 100         {
 101           ECHO_FAIL (ECHO_FAIL_SOCKET_CONNECT, "socket connect failed");
 102           return -1;
 103         }
 104
 105       if (vl_socket_client_init_shm (0, 1 /* want_pthread */ ))
 106         {
 107           ECHO_FAIL (ECHO_FAIL_INIT_SHM_API, "init shm api failed");
 108           return -1;
 109         }
 110     }
 111   else
 112     {
 113       if (vl_client_connect_to_vlib ("/vpe-api", (char *) em->app_name, 32) <
 114           0)
 115         {
 116           ECHO_FAIL (ECHO_FAIL_SHMEM_CONNECT, "shmem connect failed");
 117           return -1;
 118         }
 119     }
 120   em->vl_input_queue = am->shmem_hdr->vl_input_queue;
 121   em->my_client_index = am->my_client_index;
 122   return 0;
 123 }
 124
 125 static void
 126 print_global_json_stats (echo_main_t * em)
 127 {
 128   u8 *start_evt =
 129     format (0, "%U", echo_format_timing_event, em->timing.start_event);
 130   u8 *end_evt =
 131     format (0, "%U", echo_format_timing_event, em->timing.end_event);
 132   u8 start_evt_missing = !(em->timing.events_sent & em->timing.start_event);
 133   u8 end_evt_missing = (em->rx_results_diff || em->tx_results_diff) ? 0 :
 134     !(em->timing.events_sent & em->timing.end_event);
 135   f64 deltat = start_evt_missing || end_evt_missing ? 0 :
 136     em->timing.end_time - em->timing.start_time;
 137
 138   if (start_evt_missing)
 139     ECHO_FAIL (ECHO_FAIL_MISSING_START_EVENT,
 140                "Expected event %v to happen, but it did not!", start_evt);
 141
 142   if (end_evt_missing)
 143     ECHO_FAIL (ECHO_FAIL_MISSING_END_EVENT,
 144                "Expected event %v to happen, but it did not!", end_evt);
 145
 146   fformat (stdout, "vpp_echo JSON stats:\n{\n");
 147   fformat (stdout, "  \"role\": \"%s\",\n",
 148            em->i_am_master ? "server" : "client");
 149   fformat (stdout, "  \"time\": \"%.9f\",\n", deltat);
 150   fformat (stdout, "  \"start_evt\": \"%v\",\n", start_evt);
 151   fformat (stdout, "  \"start_evt_missing\": \"%s\",\n",
 152            start_evt_missing ? "True" : "False");
 153   fformat (stdout, "  \"end_evt\": \"%v\",\n", end_evt);
 154   fformat (stdout, "  \"end_evt_missing\": \"%s\",\n",
 155            end_evt_missing ? "True" : "False");
 156   fformat (stdout, "  \"rx_data\": %lld,\n", em->stats.rx_total);
 157   fformat (stdout, "  \"tx_data\": %lld,\n", em->stats.tx_total);
 158   fformat (stdout, "  \"rx_bits_per_second\": %.1f,\n",
 159            em->stats.rx_total * 8 / deltat);
 160   fformat (stdout, "  \"tx_bits_per_second\": %.1f,\n",
 161            em->stats.tx_total * 8 / deltat);
 162   fformat (stdout, "  \"closing\": {\n");
 163   fformat (stdout, "    \"reset\": { \"q\": %d, \"s\": %d },\n",
 164            em->stats.reset_count.q, em->stats.reset_count.s);
 165   fformat (stdout, "    \"recv evt\": { \"q\": %d, \"s\": %d },\n",
 166            em->stats.close_count.q, em->stats.close_count.s);
 167   fformat (stdout, "    \"send evt\": { \"q\": %d, \"s\": %d },\n",
 168            em->stats.active_count.q, em->stats.active_count.s);
 169   fformat (stdout, "    \"clean\": { \"q\": %d, \"s\": %d },\n",
 170            em->stats.clean_count.q, em->stats.clean_count.s);
 171   fformat (stdout, "    \"accepted\": { \"q\": %d, \"s\": %d },\n",
 172            em->stats.accepted_count.q, em->stats.accepted_count.s);
 173   fformat (stdout, "    \"connected\": { \"q\": %d, \"s\": %d }\n",
 174            em->stats.connected_count.q, em->stats.connected_count.s);
 175   fformat (stdout, "  },\n");
 176   fformat (stdout, "  \"results\": {\n");
 177   fformat (stdout, "    \"has_failed\": \"%d\",\n", em->has_failed);
 178   fformat (stdout, "    \"fail_descr\": \"%v\"\n", em->fail_descr);
 179   fformat (stdout, "  }\n");
 180   fformat (stdout, "}\n");
 181   fflush (stdout);
 182   vec_free (start_evt);
 183   vec_free (end_evt);
 184 }
 185
 186 static void
 187 print_global_stats (echo_main_t * em)
 188 {
 189   u8 *start_evt =
 190     format (0, "%U", echo_format_timing_event, em->timing.start_event);
 191   u8 *end_evt =
 192     format (0, "%U", echo_format_timing_event, em->timing.end_event);
 193   u8 start_evt_missing = !(em->timing.events_sent & em->timing.start_event);
 194   u8 end_evt_missing = (em->rx_results_diff || em->tx_results_diff) ? 0 :
 195     !(em->timing.events_sent & em->timing.end_event);
 196   f64 deltat = start_evt_missing || end_evt_missing ? 0 :
 197     em->timing.end_time - em->timing.start_time;
 198
 199   if (start_evt_missing)
 200     ECHO_FAIL (ECHO_FAIL_MISSING_START_EVENT,
 201                "Expected event %v to happen, but it did not!", start_evt);
 202
 203   if (end_evt_missing)
 204     ECHO_FAIL (ECHO_FAIL_MISSING_END_EVENT,
 205                "Expected event %v to happen, but it did not!", end_evt);
 206
 207   fformat (stdout, "Timing %v:%v\n", start_evt, end_evt);
 208   if (start_evt_missing)
 209     fformat (stdout, "Missing Start Timing Event (%v)!\n", start_evt);
 210   if (end_evt_missing)
 211     fformat (stdout, "Missing End Timing Event (%v)!\n", end_evt);
 212   fformat (stdout, "-------- TX --------\n");
 213   fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
 214            em->stats.tx_total, em->stats.tx_total / (1ULL << 20),
 215            em->stats.tx_total / (1ULL << 30), deltat);
 216   if (deltat)
 217     fformat (stdout, "%.4f Gbit/second\n",
 218              (em->stats.tx_total * 8.0) / deltat / 1e9);
 219   fformat (stdout, "-------- RX --------\n");
 220   fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
 221            em->stats.rx_total, em->stats.rx_total / (1ULL << 20),
 222            em->stats.rx_total / (1ULL << 30), deltat);
 223   if (deltat)
 224     fformat (stdout, "%.4f Gbit/second\n",
 225              (em->stats.rx_total * 8.0) / deltat / 1e9);
 226   fformat (stdout, "--------------------\n");
 227   fformat (stdout, "Received close on %d streams (and %d Quic conn)\n",
 228            em->stats.close_count.s, em->stats.close_count.q);
 229   fformat (stdout, "Received reset on %d streams (and %d Quic conn)\n",
 230            em->stats.reset_count.s, em->stats.reset_count.q);
 231   fformat (stdout, "Sent close on     %d streams (and %d Quic conn)\n",
 232            em->stats.active_count.s, em->stats.active_count.q);
 233   fformat (stdout, "Discarded         %d streams (and %d Quic conn)\n",
 234            em->stats.clean_count.s, em->stats.clean_count.q);
 235   fformat (stdout, "--------------------\n");
 236   fformat (stdout, "Got accept on     %d streams (and %d Quic conn)\n",
 237            em->stats.accepted_count.s, em->stats.accepted_count.q);
 238   fformat (stdout, "Got connected on  %d streams (and %d Quic conn)\n",
 239            em->stats.connected_count.s, em->stats.connected_count.q);
 240   if (em->has_failed)
 241     fformat (stdout, "\nFailure Return Status: %d\n%v", em->has_failed,
 242              em->fail_descr);
 243   vec_free (start_evt);
 244   vec_free (end_evt);
 245 }
 246
 247 void
 248 echo_update_count_on_session_close (echo_main_t * em, echo_session_t * s)
 249 {
 250
 251   ECHO_LOG (2, "[%lu/%lu] -> %U -> [%lu/%lu]",
 252             s->bytes_received, s->bytes_received + s->bytes_to_receive,
 253             echo_format_session, s, s->bytes_sent,
 254             s->bytes_sent + s->bytes_to_send);
 255
 256   if (PREDICT_FALSE
 257       ((em->stats.rx_total == em->stats.rx_expected)
 258        && (em->stats.tx_total == em->stats.tx_expected)))
 259     echo_notify_event (em, ECHO_EVT_LAST_BYTE);
 260 }
 261
 262 static void
 263 echo_session_detach_fifos (echo_session_t *s)
 264 {
 265   echo_main_t *em = &echo_main;
 266   fifo_segment_t *fs;
 267
 268   if (!s->rx_fifo)
 269     return;
 270
 271   clib_spinlock_lock (&em->segment_handles_lock);
 272
 273   fs = fifo_segment_get_segment_if_valid (&em->segment_main,
 274                                           s->rx_fifo->segment_index);
 275
 276   if (!fs)
 277     goto done;
 278
 279   fifo_segment_free_client_fifo (fs, s->rx_fifo);
 280   fifo_segment_free_client_fifo (fs, s->tx_fifo);
 281
 282 done:
 283   clib_spinlock_unlock (&em->segment_handles_lock);
 284 }
 285
 286 static void
 287 echo_free_sessions (echo_main_t * em)
 288 {
 289   /* Free marked sessions */
 290   echo_session_t *s;
 291   u32 *session_indexes = 0, *session_index;
 292
 293   pool_foreach (s, em->sessions)
 294    {
 295     if (s->session_state == ECHO_SESSION_STATE_CLOSED)
 296       vec_add1 (session_indexes, s->session_index);
 297    }
 298   vec_foreach (session_index, session_indexes)
 299   {
 300     /* Free session */
 301     s = pool_elt_at_index (em->sessions, *session_index);
 302     echo_session_detach_fifos (s);
 303     echo_session_handle_add_del (em, s->vpp_session_handle,
 304                                  SESSION_INVALID_INDEX);
 305     clib_memset (s, 0xfe, sizeof (*s));
 306     pool_put (em->sessions, s);
 307   }
 308 }
 309
 310 static void
 311 test_recv_bytes (echo_main_t * em, echo_session_t * s, u8 * rx_buf,
 312                  u32 n_read)
 313 {
 314   u32 i;
 315   u8 expected;
 316   for (i = 0; i < n_read; i++)
 317     {
 318       expected = (s->bytes_received + i) & 0xff;
 319       if (rx_buf[i] == expected || em->max_test_msg > 0)
 320         continue;
 321       ECHO_LOG (1, "Session 0x%lx byte %lld was 0x%x expected 0x%x",
 322                 s->vpp_session_handle, s->bytes_received + i, rx_buf[i],
 323                 expected);
 324       em->max_test_msg--;
 325       if (em->max_test_msg == 0)
 326         ECHO_LOG (1, "Too many errors, hiding next ones");
 327       if (em->test_return_packets == RETURN_PACKETS_ASSERT)
 328         ECHO_FAIL (ECHO_FAIL_TEST_BYTES_ERR, "test-bytes errored");
 329     }
 330 }
 331
 332 static int
 333 recv_data_chunk (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
 334 {
 335   int n_read;
 336   n_read = app_recv ((app_session_t *) s, rx_buf, vec_len (rx_buf));
 337   if (n_read <= 0)
 338     return 0;
 339   if (svm_fifo_needs_deq_ntf (s->rx_fifo, n_read))
 340     echo_session_dequeue_notify (s);
 341
 342   if (em->test_return_packets)
 343     test_recv_bytes (em, s, rx_buf, n_read);
 344
 345   s->bytes_received += n_read;
 346   s->bytes_to_receive -= n_read;
 347   clib_atomic_fetch_add (&em->stats.rx_total, n_read);
 348   return n_read;
 349 }
 350
 351 static int
 352 send_data_chunk (echo_session_t * s, u8 * tx_buf, int offset, int len)
 353 {
 354   int n_sent;
 355   int bytes_this_chunk = clib_min (s->bytes_to_send, len - offset);
 356   echo_main_t *em = &echo_main;
 357
 358   if (!bytes_this_chunk)
 359     return 0;
 360   n_sent = app_send ((app_session_t *) s, tx_buf + offset,
 361                      bytes_this_chunk, SVM_Q_WAIT);
 362   if (n_sent < 0)
 363     return 0;
 364   s->bytes_to_send -= n_sent;
 365   s->bytes_sent += n_sent;
 366   clib_atomic_fetch_add (&em->stats.tx_total, n_sent);
 367   return n_sent;
 368 }
 369
 370 static int
 371 mirror_data_chunk (echo_main_t * em, echo_session_t * s, u8 * tx_buf, u64 len)
 372 {
 373   u64 n_sent = 0;
 374   while (n_sent < len && !em->time_to_stop)
 375     n_sent += send_data_chunk (s, tx_buf, n_sent, len);
 376   return n_sent;
 377 }
 378
 379 static inline void
 380 echo_check_closed_listener (echo_main_t * em, echo_session_t * s)
 381 {
 382   echo_session_t *ls;
 383   /* if parent has died, terminate gracefully */
 384   if (s->listener_index == SESSION_INVALID_INDEX)
 385     {
 386       ECHO_LOG (3, "%U: listener_index == SESSION_INVALID_INDEX",
 387                 echo_format_session, s);
 388       return;
 389     }
 390   ls = pool_elt_at_index (em->sessions, s->listener_index);
 391   if (ls->session_state < ECHO_SESSION_STATE_CLOSING)
 392     {
 393       ECHO_LOG (3, "%U: ls->session_state (%d) < "
 394                 "ECHO_SESSION_STATE_CLOSING (%d)",
 395                 echo_format_session, ls, ls->session_state,
 396                 ECHO_SESSION_STATE_CLOSING);
 397       return;
 398     }
 399
 400   ECHO_LOG (3, "%U died, close child %U", echo_format_session, ls,
 401             echo_format_session, s);
 402   echo_update_count_on_session_close (em, s);
 403   em->proto_cb_vft->cleanup_cb (s, 1 /* parent_died */ );
 404 }
 405
 406 /*
 407  * Rx/Tx polling thread per connection
 408  */
 409 static void
 410 echo_handle_data (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
 411 {
 412   int n_read, n_sent = 0;
 413
 414   n_read = recv_data_chunk (em, s, rx_buf);
 415   if ((em->data_source == ECHO_TEST_DATA_SOURCE) && s->bytes_to_send)
 416     n_sent = send_data_chunk (s, em->connect_test_data,
 417                               s->bytes_sent % em->tx_buf_size,
 418                               em->tx_buf_size);
 419   else if (em->data_source == ECHO_RX_DATA_SOURCE)
 420     n_sent = mirror_data_chunk (em, s, rx_buf, n_read);
 421   if (!s->bytes_to_send && !s->bytes_to_receive)
 422     {
 423       /* Session is done, need to close */
 424       if (s->session_state == ECHO_SESSION_STATE_AWAIT_DATA)
 425         s->session_state = ECHO_SESSION_STATE_CLOSING;
 426       else
 427         {
 428           s->session_state = ECHO_SESSION_STATE_AWAIT_CLOSING;
 429           if (em->send_stream_disconnects == ECHO_CLOSE_F_ACTIVE)
 430             {
 431               echo_send_rpc (em, echo_send_disconnect_session,
 432                              (echo_rpc_args_t *) & s->vpp_session_handle);
 433               clib_atomic_fetch_add (&em->stats.active_count.s, 1);
 434             }
 435           else if (em->send_stream_disconnects == ECHO_CLOSE_F_NONE)
 436             {
 437               s->session_state = ECHO_SESSION_STATE_CLOSING;
 438               clib_atomic_fetch_add (&em->stats.clean_count.s, 1);
 439             }
 440         }
 441       ECHO_LOG (3, "%U: %U", echo_format_session, s,
 442                 echo_format_session_state, s->session_state);
 443       return;
 444     }
 445
 446   /* Check for idle clients */
 447   if (em->log_lvl > 1)
 448     {
 449       if (n_sent || n_read)
 450         s->idle_cycles = 0;
 451       else if (s->idle_cycles++ == LOG_EVERY_N_IDLE_CYCLES)
 452         {
 453           s->idle_cycles = 0;
 454           ECHO_LOG (2, "Idle client TX:%dB RX:%dB", s->bytes_to_send,
 455                     s->bytes_to_receive);
 456           ECHO_LOG (2, "Idle FIFOs TX:%dB RX:%dB",
 457                     svm_fifo_max_dequeue (s->tx_fifo),
 458                     svm_fifo_max_dequeue (s->rx_fifo));
 459           ECHO_LOG (2, "Session 0x%lx state %U", s->vpp_session_handle,
 460                     echo_format_session_state, s->session_state);
 461         }
 462     }
 463 }
 464
 465 static void *
 466 echo_data_thread_fn (void *arg)
 467 {
 468   clib_mem_set_thread_index (); /* First thing to do in client thread */
 469   echo_main_t *em = &echo_main;
 470   u32 N = em->n_clients;
 471   u32 n = (N + em->n_rx_threads - 1) / em->n_rx_threads;
 472   u32 idx = (u64) arg;
 473   if (n * idx >= N)
 474     {
 475       ECHO_LOG (2, "Thread %u exiting, no sessions to care for", idx);
 476       pthread_exit (0);
 477     }
 478   u32 thread_n_sessions = clib_min (n, N - n * idx);
 479
 480   u32 i = 0;
 481   u32 n_closed_sessions = 0;
 482   u32 session_index;
 483   u8 *rx_buf = 0;
 484   echo_session_t *s;
 485   vec_validate (rx_buf, em->rx_buf_size);
 486
 487   for (i = 0; !em->time_to_stop; i = (i + 1) % thread_n_sessions)
 488     {
 489       n_closed_sessions = i == 0 ? 0 : n_closed_sessions;
 490       session_index = em->data_thread_args[n * idx + i];
 491       if (session_index == SESSION_INVALID_INDEX)
 492         continue;
 493       s = pool_elt_at_index (em->sessions, session_index);
 494       switch (s->session_state)
 495         {
 496         case ECHO_SESSION_STATE_READY:
 497         case ECHO_SESSION_STATE_AWAIT_DATA:
 498           echo_handle_data (em, s, rx_buf);
 499           echo_check_closed_listener (em, s);
 500           break;
 501         case ECHO_SESSION_STATE_AWAIT_CLOSING:
 502           ECHO_LOG (3, "%U: %U", echo_format_session, s,
 503                     echo_format_session_state, s->session_state);
 504           echo_check_closed_listener (em, s);
 505           break;
 506         case ECHO_SESSION_STATE_CLOSING:
 507           ECHO_LOG (3, "%U: %U", echo_format_session, s,
 508                     echo_format_session_state, s->session_state);
 509           echo_update_count_on_session_close (em, s);
 510           em->proto_cb_vft->cleanup_cb (s, 0 /* parent_died */ );
 511           break;
 512         case ECHO_SESSION_STATE_CLOSED:
 513           ECHO_LOG (3, "%U: %U", echo_format_session, s,
 514                     echo_format_session_state, s->session_state);
 515           n_closed_sessions++;
 516           break;
 517         }
 518       if (n_closed_sessions == thread_n_sessions)
 519         break;
 520     }
 521   ECHO_LOG (2, "Mission accomplished!");
 522   pthread_exit (0);
 523 }
 524
 525 static void
 526 session_unlisten_handler (session_unlisten_reply_msg_t * mp)
 527 {
 528   echo_session_t *ls;
 529   echo_main_t *em = &echo_main;
 530
 531   ls = echo_get_session_from_handle (em, mp->handle);
 532   if (!ls)
 533     return;
 534   em->proto_cb_vft->cleanup_cb (ls, 0 /* parent_died */ );
 535   ls->session_state = ECHO_SESSION_STATE_CLOSED;
 536   if (--em->listen_session_cnt == 0)
 537     em->state = STATE_DISCONNECTED;
 538 }
 539
 540 static void
 541 session_bound_handler (session_bound_msg_t * mp)
 542 {
 543   echo_main_t *em = &echo_main;
 544   echo_session_t *listen_session;
 545   if (mp->retval)
 546     {
 547       ECHO_FAIL (ECHO_FAIL_BIND, "bind failed: %U", format_api_error,
 548                  clib_net_to_host_u32 (mp->retval));
 549       return;
 550     }
 551   ECHO_LOG (1, "listening on %U:%u", format_ip46_address, mp->lcl_ip,
 552             mp->lcl_is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
 553             clib_net_to_host_u16 (mp->lcl_port));
 554
 555   /* Allocate local session and set it up */
 556   listen_session = echo_session_new (em);
 557   listen_session->session_type = ECHO_SESSION_TYPE_LISTEN;
 558   listen_session->vpp_session_handle = mp->handle;
 559   echo_session_handle_add_del (em, mp->handle, listen_session->session_index);
 560   vec_add1 (em->listen_session_indexes, listen_session->session_index);
 561   if (++em->listen_session_cnt == em->n_uris)
 562     em->state = STATE_LISTEN;
 563   if (em->proto_cb_vft->bound_uri_cb)
 564     em->proto_cb_vft->bound_uri_cb (mp, listen_session);
 565 }
 566
 567 static void
 568 session_accepted_handler (session_accepted_msg_t * mp)
 569 {
 570   app_session_evt_t _app_evt, *app_evt = &_app_evt;
 571   session_accepted_reply_msg_t *rmp;
 572   echo_main_t *em = &echo_main;
 573   echo_session_t *session, *ls;
 574
 575   if (!(ls = echo_get_session_from_handle (em, mp->listener_handle)))
 576     {
 577       ECHO_FAIL (ECHO_FAIL_SESSION_ACCEPTED_BAD_LISTENER,
 578                  "Unknown listener handle 0x%lx", mp->listener_handle);
 579       return;
 580     }
 581
 582   /* Allocate local session and set it up */
 583   session = echo_session_new (em);
 584
 585   if (echo_attach_session (mp->segment_handle, mp->server_rx_fifo,
 586                            mp->server_tx_fifo, mp->vpp_event_queue_address,
 587                            session))
 588     {
 589       ECHO_FAIL (ECHO_FAIL_ACCEPTED_WAIT_FOR_SEG_ALLOC,
 590                  "accepted wait_for_segment_allocation errored");
 591       return;
 592     }
 593
 594   session->vpp_session_handle = mp->handle;
 595
 596   /* session->transport needed by app_send_dgram */
 597   clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
 598                     sizeof (ip46_address_t));
 599   session->transport.is_ip4 = mp->rmt.is_ip4;
 600   session->transport.rmt_port = mp->rmt.port;
 601   clib_memcpy_fast (&session->transport.lcl_ip, &em->uri_elts.ip,
 602                     sizeof (ip46_address_t));
 603   session->transport.lcl_port = em->uri_elts.port;
 604
 605   session->vpp_session_handle = mp->handle;
 606   session->listener_index = ls->session_index;
 607   session->start = clib_time_now (&em->clib_time);
 608
 609   /* Add it to lookup table */
 610   ECHO_LOG (2, "Accepted session 0x%lx S[%u] -> 0x%lx S[%u]",
 611             mp->handle, session->session_index,
 612             mp->listener_handle, session->listener_index);
 613   echo_session_handle_add_del (em, mp->handle, session->session_index);
 614
 615   app_alloc_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt,
 616                              SESSION_CTRL_EVT_ACCEPTED_REPLY);
 617   rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
 618   rmp->handle = mp->handle;
 619   rmp->context = mp->context;
 620   app_send_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt);
 621   em->proto_cb_vft->accepted_cb (mp, session);
 622 }
 623
 624 static void
 625 session_connected_handler (session_connected_msg_t * mp)
 626 {
 627   echo_main_t *em = &echo_main;
 628   echo_session_t *session;
 629   u32 listener_index = htonl (mp->context);
 630
 631   clib_atomic_add_fetch (&em->max_sim_connects, 1);
 632
 633   if (mp->retval)
 634     {
 635       if (em->proto_cb_vft->connected_cb)
 636         em->
 637           proto_cb_vft->connected_cb ((session_connected_bundled_msg_t *) mp,
 638                                       listener_index, 1 /* is_failed */ );
 639       return;
 640     }
 641
 642   session = echo_session_new (em);
 643
 644   if (echo_attach_session (mp->segment_handle, mp->server_rx_fifo,
 645                            mp->server_tx_fifo, mp->vpp_event_queue_address,
 646                            session))
 647     {
 648       ECHO_FAIL (ECHO_FAIL_CONNECTED_WAIT_FOR_SEG_ALLOC,
 649                  "connected wait_for_segment_allocation errored");
 650       return;
 651     }
 652
 653   session->vpp_session_handle = mp->handle;
 654   session->start = clib_time_now (&em->clib_time);
 655   session->listener_index = listener_index;
 656   /* session->transport needed by app_send_dgram */
 657   clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
 658                     sizeof (ip46_address_t));
 659   session->transport.is_ip4 = mp->lcl.is_ip4;
 660   session->transport.lcl_port = mp->lcl.port;
 661   clib_memcpy_fast (&session->transport.rmt_ip, &em->uri_elts.ip,
 662                     sizeof (ip46_address_t));
 663   session->transport.rmt_port = em->uri_elts.port;
 664
 665   echo_session_handle_add_del (em, mp->handle, session->session_index);
 666   em->proto_cb_vft->connected_cb ((session_connected_bundled_msg_t *) mp,
 667                                   session->session_index, 0 /* is_failed */ );
 668 }
 669
 670 /*
 671  *
 672  *  End of ECHO callback definitions
 673  *
 674  */
 675
 676 static void
 677 session_disconnected_handler (session_disconnected_msg_t * mp)
 678 {
 679   app_session_evt_t _app_evt, *app_evt = &_app_evt;
 680   session_disconnected_reply_msg_t *rmp;
 681   echo_main_t *em = &echo_main;
 682   echo_session_t *s;
 683   if (!(s = echo_get_session_from_handle (em, mp->handle)))
 684     {
 685       ECHO_LOG (1, "Invalid vpp_session_handle: 0x%lx", mp->handle);
 686       return;
 687     }
 688   if (s->session_state == ECHO_SESSION_STATE_CLOSED)
 689     {
 690       ECHO_LOG (2, "%U: already in ECHO_SESSION_STATE_CLOSED",
 691                 echo_format_session, s);
 692     }
 693   else
 694     {
 695       ECHO_LOG (2, "%U: passive close", echo_format_session, s);
 696       em->proto_cb_vft->disconnected_cb (mp, s);
 697     }
 698   app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
 699                              SESSION_CTRL_EVT_DISCONNECTED_REPLY);
 700   rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
 701   rmp->retval = 0;
 702   rmp->handle = mp->handle;
 703   rmp->context = mp->context;
 704   app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
 705 }
 706
 707 static void
 708 session_reset_handler (session_reset_msg_t * mp)
 709 {
 710   app_session_evt_t _app_evt, *app_evt = &_app_evt;
 711   echo_main_t *em = &echo_main;
 712   session_reset_reply_msg_t *rmp;
 713   echo_session_t *s = 0;
 714   if (!(s = echo_get_session_from_handle (em, mp->handle)))
 715     {
 716       ECHO_LOG (1, "Invalid vpp_session_handle: 0x%lx", mp->handle);
 717       return;
 718     }
 719   ECHO_LOG (2, "%U: session reset", echo_format_session, s);
 720   em->proto_cb_vft->reset_cb (mp, s);
 721
 722   app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
 723                              SESSION_CTRL_EVT_RESET_REPLY);
 724   rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
 725   rmp->retval = 0;
 726   rmp->handle = mp->handle;
 727   app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
 728 }
 729
 730 static int
 731 echo_recv_fd (echo_main_t *em, int *fds, int n_fds)
 732 {
 733   if (em->use_app_socket_api)
 734     return echo_sapi_recv_fd (em, fds, n_fds);
 735   return echo_bapi_recv_fd (em, fds, n_fds);
 736 }
 737
 738 static void
 739 add_segment_handler (session_app_add_segment_msg_t * mp)
 740 {
 741   echo_main_t *em = &echo_main;
 742   fifo_segment_main_t *sm = &echo_main.segment_main;
 743   fifo_segment_create_args_t _a, *a = &_a;
 744   int *fds = 0, i;
 745   char *seg_name = (char *) mp->segment_name;
 746   u64 segment_handle = mp->segment_handle;
 747
 748   if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
 749     {
 750       vec_validate (fds, 1);
 751       if (echo_recv_fd (em, fds, 1))
 752         {
 753           ECHO_LOG (0, "echo_recv_fd failed");
 754           em->time_to_stop = 1;
 755           goto failed;
 756         }
 757
 758       if (echo_segment_attach (segment_handle, seg_name, SSVM_SEGMENT_MEMFD,
 759                                fds[0]))
 760         {
 761           ECHO_FAIL (ECHO_FAIL_VL_API_SVM_FIFO_SEG_ATTACH,
 762                      "svm_fifo_segment_attach ('%s') "
 763                      "failed on SSVM_SEGMENT_MEMFD", seg_name);
 764           goto failed;
 765         }
 766       vec_free (fds);
 767     }
 768   else
 769     {
 770       clib_memset (a, 0, sizeof (*a));
 771       a->segment_name = seg_name;
 772       a->segment_size = mp->segment_size;
 773       /* Attach to the segment vpp created */
 774       if (fifo_segment_attach (sm, a))
 775         {
 776           ECHO_FAIL (ECHO_FAIL_VL_API_FIFO_SEG_ATTACH,
 777                      "fifo_segment_attach ('%s') failed", seg_name);
 778           goto failed;
 779         }
 780     }
 781   ECHO_LOG (2, "Mapped segment 0x%lx", segment_handle);
 782   return;
 783
 784 failed:
 785   for (i = 0; i < vec_len (fds); i++)
 786     close (fds[i]);
 787   vec_free (fds);
 788 }
 789
 790 static void
 791 del_segment_handler (session_app_del_segment_msg_t * mp)
 792 {
 793   echo_segment_detach (mp->segment_handle);
 794   ECHO_LOG (2, "Unmaped segment 0x%lx", mp->segment_handle);
 795 }
 796
 797 static void
 798 cleanup_handler (session_cleanup_msg_t * mp)
 799 {
 800   ECHO_LOG (1, "Cleanup confirmed for 0x%lx", mp->handle);
 801 }
 802
 803 static void
 804 handle_mq_event (session_event_t * e)
 805 {
 806   switch (e->event_type)
 807     {
 808     case SESSION_CTRL_EVT_BOUND:
 809       return session_bound_handler ((session_bound_msg_t *) e->data);
 810     case SESSION_CTRL_EVT_ACCEPTED:
 811       return session_accepted_handler ((session_accepted_msg_t *) e->data);
 812     case SESSION_CTRL_EVT_CONNECTED:
 813       return session_connected_handler ((session_connected_msg_t *) e->data);
 814     case SESSION_CTRL_EVT_DISCONNECTED:
 815       return session_disconnected_handler ((session_disconnected_msg_t *)
 816                                            e->data);
 817     case SESSION_CTRL_EVT_RESET:
 818       return session_reset_handler ((session_reset_msg_t *) e->data);
 819     case SESSION_CTRL_EVT_UNLISTEN_REPLY:
 820       return session_unlisten_handler ((session_unlisten_reply_msg_t *)
 821                                        e->data);
 822     case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
 823       add_segment_handler ((session_app_add_segment_msg_t *) e->data);
 824       break;
 825     case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
 826       del_segment_handler ((session_app_del_segment_msg_t *) e->data);
 827       break;
 828     case SESSION_CTRL_EVT_CLEANUP:
 829       cleanup_handler ((session_cleanup_msg_t *) e->data);
 830       break;
 831     case SESSION_IO_EVT_RX:
 832       break;
 833     default:
 834       ECHO_LOG (1, "unhandled event %u", e->event_type);
 835     }
 836 }
 837
 838 static void
 839 echo_process_rpcs (echo_main_t * em)
 840 {
 841   echo_rpc_msg_t *rpc;
 842   svm_msg_q_msg_t msg;
 843   svm_msg_q_t *mq = &em->rpc_msq_queue;
 844
 845   while (em->state < STATE_DATA_DONE && !em->time_to_stop)
 846     {
 847       if (svm_msg_q_is_empty (mq) && svm_msg_q_timedwait (mq, 1))
 848         {
 849           continue;
 850         }
 851       svm_msg_q_sub_raw (mq, &msg);
 852       rpc = svm_msg_q_msg_data (mq, &msg);
 853       ((echo_rpc_t) rpc->fp) (em, &rpc->args);
 854       svm_msg_q_free_msg (mq, &msg);
 855     }
 856 }
 857
 858 static inline void
 859 echo_print_periodic_stats (echo_main_t * em)
 860 {
 861   f64 delta, now = clib_time_now (&em->clib_time);
 862   echo_stats_t _st, *st = &_st;
 863   echo_stats_t *lst = &em->last_stat_sampling;
 864   delta = now - em->last_stat_sampling_ts;
 865   if (delta < em->periodic_stats_delta)
 866     return;
 867
 868   clib_memcpy_fast (st, &em->stats, sizeof (*st));
 869   if (st->rx_total - lst->rx_total)
 870     clib_warning ("RX: %U", echo_format_bytes_per_sec,
 871                   (st->rx_total - lst->rx_total) / delta);
 872   if (st->tx_total - lst->tx_total)
 873     clib_warning ("TX: %U", echo_format_bytes_per_sec,
 874                   (st->tx_total - lst->tx_total) / delta);
 875   if (st->connected_count.q - lst->connected_count.q)
 876     clib_warning ("conn: %d/s",
 877                   st->connected_count.q - lst->connected_count.q);
 878   if (st->accepted_count.q - lst->accepted_count.q)
 879     clib_warning ("accept: %d/s",
 880                   st->accepted_count.q - lst->accepted_count.q);
 881
 882   clib_memcpy_fast (lst, st, sizeof (*st));
 883   em->last_stat_sampling_ts = now;
 884 }
 885
 886 static void *
 887 echo_mq_thread_fn (void *arg)
 888 {
 889   clib_mem_set_thread_index (); /* First thing to do in client thread */
 890   svm_msg_q_msg_t *msg_vec = 0;
 891   echo_main_t *em = &echo_main;
 892   session_event_t *e;
 893   svm_msg_q_msg_t *msg;
 894   svm_msg_q_t *mq;
 895   int i;
 896
 897   vec_validate (msg_vec, em->evt_q_size);
 898   vec_reset_length (msg_vec);
 899   wait_for_state_change (em, STATE_ATTACHED, 0);
 900   mq = em->app_mq;
 901   if (em->state < STATE_ATTACHED || !mq)
 902     {
 903       ECHO_FAIL (ECHO_FAIL_APP_ATTACH, "Application failed to attach");
 904       pthread_exit (0);
 905     }
 906
 907   while (em->state < STATE_DETACHED && !em->time_to_stop)
 908     {
 909       if (em->periodic_stats_delta)
 910         echo_print_periodic_stats (em);
 911
 912       if (svm_msg_q_is_empty (mq) && svm_msg_q_timedwait (mq, 1))
 913         {
 914           continue;
 915         }
 916       for (i = 0; i < svm_msg_q_size (mq); i++)
 917         {
 918           vec_add2 (msg_vec, msg, 1);
 919           svm_msg_q_sub_raw (mq, msg);
 920         }
 921
 922       for (i = 0; i < vec_len (msg_vec); i++)
 923         {
 924           msg = vec_elt_at_index (msg_vec, i);
 925           e = svm_msg_q_msg_data (mq, msg);
 926           handle_mq_event (e);
 927           svm_msg_q_free_msg (mq, msg); /* No lock, single thread dequeuing */
 928         }
 929       vec_reset_length (msg_vec);
 930     }
 931   vec_free (msg_vec);
 932   pthread_exit (0);
 933 }
 934
 935 static inline void
 936 echo_cycle_ip (echo_main_t * em, ip46_address_t * ip, ip46_address_t * src_ip,
 937                u32 i)
 938 {
 939   u8 *ipu8;
 940   u8 l;
 941   if (i % em->n_uris == 0)
 942     {
 943       clib_memcpy_fast (ip, src_ip, sizeof (*ip));
 944       return;
 945     }
 946   l = em->uri_elts.is_ip4 ? 3 : 15;
 947   ipu8 = em->uri_elts.is_ip4 ? ip->ip4.as_u8 : ip->ip6.as_u8;
 948   while (ipu8[l] == 0xf)
 949     ipu8[l--] = 0;
 950   if (l)
 951     ipu8[l]++;
 952 }
 953
 954 static void
 955 clients_run (echo_main_t * em)
 956 {
 957   echo_connect_args_t _a, *a = &_a;
 958   u64 i;
 959
 960   a->context = SESSION_INVALID_INDEX;
 961   a->parent_session_handle = SESSION_INVALID_HANDLE;
 962   clib_memset (&a->lcl_ip, 0, sizeof (a->lcl_ip));
 963
 964   echo_notify_event (em, ECHO_EVT_FIRST_QCONNECT);
 965   for (i = 0; i < em->n_connects; i++)
 966     {
 967       echo_cycle_ip (em, &a->ip, &em->uri_elts.ip, i);
 968       if (em->lcl_ip_set)
 969         echo_cycle_ip (em, &a->lcl_ip, &em->lcl_ip, i);
 970       echo_send_connect (em, a);
 971     }
 972   wait_for_state_change (em, STATE_READY, 0);
 973   ECHO_LOG (2, "App is ready");
 974   echo_process_rpcs (em);
 975 }
 976
 977 static void
 978 server_run (echo_main_t * em)
 979 {
 980   echo_session_t *ls;
 981   ip46_address_t _ip, *ip = &_ip;
 982   u32 *listen_session_index;
 983   u32 i;
 984
 985   for (i = 0; i < em->n_uris; i++)
 986     {
 987       echo_cycle_ip (em, ip, &em->uri_elts.ip, i);
 988       echo_send_listen (em, ip);
 989     }
 990   wait_for_state_change (em, STATE_READY, 0);
 991   ECHO_LOG (2, "App is ready");
 992   echo_process_rpcs (em);
 993   /* Cleanup */
 994   vec_foreach (listen_session_index, em->listen_session_indexes)
 995   {
 996     ECHO_LOG (2, "Unbind listen port %d", em->listen_session_cnt);
 997     ls = pool_elt_at_index (em->sessions, *listen_session_index);
 998     echo_send_unbind (em, ls);
 999   }
1000   if (wait_for_state_change (em, STATE_DISCONNECTED, TIMEOUT))
1001     {
1002       ECHO_FAIL (ECHO_FAIL_SERVER_DISCONNECT_TIMEOUT,
1003                  "Timeout waiting for state disconnected");
1004       return;
1005     }
1006 }
1007
1008 static void
1009 print_usage_and_exit (void)
1010 {
1011   echo_main_t *em = &echo_main;
1012   int i;
1013   fprintf (stderr,
1014            "Usage: vpp_echo [socket-name SOCKET] [client|server] [uri URI] [OPTIONS]\n"
1015            "Generates traffic and assert correct teardown of the hoststack\n"
1016            "\n"
1017            "  socket-name PATH    Specify the binary socket path to connect to VPP\n"
1018            "  use-svm-api         Use SVM API to connect to VPP\n"
1019            "  test-bytes[:assert] Check data correctness when receiving (assert fails on first error)\n"
1020            "  fifo-size N[K|M|G]  Use N[K|M|G] fifos\n"
1021            "  mq-size N           Use mq with N slots for [vpp_echo->vpp] communication\n"
1022            "  max-sim-connects N  Do not allow more than N mq events inflight\n"
1023            "  rx-buf N[K|M|G]     Use N[Kb|Mb|GB] RX buffer\n"
1024            "  tx-buf N[K|M|G]     Use N[Kb|Mb|GB] TX test buffer\n"
1025            "  appns NAMESPACE     Use the namespace NAMESPACE\n"
1026            "  all-scope           all-scope option\n"
1027            "  local-scope         local-scope option\n"
1028            "  global-scope        global-scope option\n"
1029            "  secret SECRET       set namespace secret\n"
1030            "  chroot prefix PATH  Use PATH as memory root path\n"
1031            "  sclose=[Y|N|W]      When stream is done, send[Y]|nop[N]|wait[W] for close\n"
1032            "  nuris N             Cycle through N consecutive (src&dst) ips when creating connections\n"
1033            "  lcl IP              Set the local ip to use as a client (use with nuris to set first src ip)\n"
1034            "\n"
1035            "  time START:END      Time between evts START & END, events being :\n"
1036            "                       start - Start of the app\n"
1037            "                       qconnect    - first Connection connect sent\n"
1038            "                       qconnected  - last Connection connected\n"
1039            "                       sconnect    - first Stream connect sent\n"
1040            "                       sconnected  - last Stream got connected\n"
1041            "                       lastbyte    - Last expected byte received\n"
1042            "                       exit        - Exiting of the app\n"
1043            "  rx-results-diff     Rx results different to pass test\n"
1044            "  tx-results-diff     Tx results different to pass test\n"
1045            "  json                Output global stats in json\n"
1046            "  stats N             Output stats evry N secs\n"
1047            "  log=N               Set the log level to [0: no output, 1:errors, 2:log]\n"
1048            "  crypto [engine]     Set the crypto engine [openssl, vpp, picotls, mbedtls]\n"
1049            "\n"
1050            "  nclients N          Open N clients sending data\n"
1051            "  nthreads N          Use N busy loop threads for data [in addition to main & msg queue]\n"
1052            "  TX=1337[K|M|G]|RX   Send 1337 [K|M|G]bytes, use TX=RX to reflect the data\n"
1053            "  RX=1337[K|M|G]      Expect 1337 [K|M|G]bytes\n" "\n");
1054   for (i = 0; i < vec_len (em->available_proto_cb_vft); i++)
1055     {
1056       echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
1057       if (vft && vft->print_usage_cb)
1058         vft->print_usage_cb ();
1059     }
1060   fprintf (stderr, "\nDefault configuration is :\n"
1061            " server nclients 1 [quic-streams 1] RX=64Kb TX=RX\n"
1062            " client nclients 1 [quic-streams 1] RX=64Kb TX=64Kb\n");
1063   exit (ECHO_FAIL_USAGE);
1064 }
1065
1066 static int
1067 echo_process_each_proto_opts (unformat_input_t * a)
1068 {
1069   echo_main_t *em = &echo_main;
1070   int i, rv;
1071   for (i = 0; i < vec_len (em->available_proto_cb_vft); i++)
1072     {
1073       echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
1074       if (vft && vft->process_opts_cb)
1075         if ((rv = vft->process_opts_cb (a)))
1076           return rv;
1077     }
1078   return 0;
1079 }
1080
1081 static void
1082 echo_set_each_proto_defaults_before_opts (echo_main_t * em)
1083 {
1084   int i;
1085   for (i = 0; i < vec_len (em->available_proto_cb_vft); i++)
1086     {
1087       echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
1088       if (vft && vft->set_defaults_before_opts_cb)
1089         vft->set_defaults_before_opts_cb ();
1090     }
1091 }
1092
1093 void
1094 echo_process_opts (int argc, char **argv)
1095 {
1096   echo_main_t *em = &echo_main;
1097   unformat_input_t _argv, *a = &_argv;
1098   u8 *chroot_prefix;
1099   u8 *uri = 0;
1100   u8 default_f_active;
1101   uword tmp;
1102
1103   unformat_init_command_line (a, argv);
1104   while (unformat_check_input (a) != UNFORMAT_END_OF_INPUT)
1105     {
1106       if (echo_process_each_proto_opts (a))
1107         ;
1108       else if (unformat (a, "chroot prefix %s", &chroot_prefix))
1109         vl_set_memory_root_path ((char *) chroot_prefix);
1110       else if (unformat (a, "uri %s", &uri))
1111         em->uri = format (0, "%s%c", uri, 0);
1112       else if (unformat (a, "lcl %U", unformat_ip46_address, &em->lcl_ip))
1113         em->lcl_ip_set = 1;
1114       else if (unformat (a, "nuris %u", &em->n_uris))
1115         em->n_sessions = em->n_clients + em->n_uris;
1116       else if (unformat (a, "server"))
1117         em->i_am_master = 1;
1118       else if (unformat (a, "client"))
1119         em->i_am_master = 0;
1120       else if (unformat (a, "test-bytes:assert"))
1121         em->test_return_packets = RETURN_PACKETS_ASSERT;
1122       else if (unformat (a, "test-bytes"))
1123         em->test_return_packets = RETURN_PACKETS_LOG_WRONG;
1124       else if (unformat (a, "socket-name %s", &em->socket_name))
1125         ;
1126       else if (unformat (a, "use-app-socket-api"))
1127         em->use_app_socket_api = 1;
1128       else if (unformat (a, "use-svm-api"))
1129         em->use_sock_api = 0;
1130       else if (unformat (a, "fifo-size %U", unformat_memory_size, &tmp))
1131         {
1132           if (tmp >= 0x100000000ULL)
1133             {
1134               fprintf (stderr,
1135                        "ERROR: fifo-size %ld (0x%lx) too large\n", tmp, tmp);
1136               print_usage_and_exit ();
1137             }
1138           em->fifo_size = tmp;
1139         }
1140       else if (unformat (a, "prealloc-fifos %u", &em->prealloc_fifo_pairs))
1141         ;
1142       else
1143         if (unformat (a, "rx-buf %U", unformat_data_size, &em->rx_buf_size))
1144         ;
1145       else
1146         if (unformat (a, "tx-buf %U", unformat_data_size, &em->tx_buf_size))
1147         ;
1148       else if (unformat (a, "mq-size %d", &em->evt_q_size))
1149         ;
1150       else if (unformat (a, "nclients %d", &em->n_clients))
1151         {
1152           em->n_sessions = em->n_clients + em->n_uris;
1153           em->n_connects = em->n_clients;
1154         }
1155       else if (unformat (a, "nthreads %d", &em->n_rx_threads))
1156         ;
1157       else if (unformat (a, "crypto %U", echo_unformat_crypto_engine, &tmp))
1158         em->crypto_engine = tmp;
1159       else if (unformat (a, "appns %_%v%_", &em->appns_id))
1160         ;
1161       else if (unformat (a, "all-scope"))
1162         em->appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
1163                             | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
1164       else if (unformat (a, "local-scope"))
1165         em->appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1166       else if (unformat (a, "global-scope"))
1167         em->appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1168       else if (unformat (a, "secret %lu", &em->appns_secret))
1169         ;
1170       else if (unformat (a, "TX=RX"))
1171         em->data_source = ECHO_RX_DATA_SOURCE;
1172       else if (unformat (a, "TX=%U", unformat_data_size, &em->bytes_to_send))
1173         ;
1174       else if (unformat (a, "RX=%U", unformat_data_size,
1175                          &em->bytes_to_receive))
1176         ;
1177       else if (unformat (a, "rx-results-diff"))
1178         em->rx_results_diff = 1;
1179       else if (unformat (a, "tx-results-diff"))
1180         em->tx_results_diff = 1;
1181       else if (unformat (a, "json"))
1182         em->output_json = 1;
1183       else if (unformat (a, "stats %d", &em->periodic_stats_delta))
1184         ;
1185       else if (unformat (a, "wait-for-gdb"))
1186         em->wait_for_gdb = 1;
1187       else if (unformat (a, "log=%d", &em->log_lvl))
1188         ;
1189       else if (unformat (a, "sclose=%U",
1190                          echo_unformat_close, &em->send_stream_disconnects))
1191         ;
1192       else if (unformat (a, "time %U:%U",
1193                          echo_unformat_timing_event, &em->timing.start_event,
1194                          echo_unformat_timing_event, &em->timing.end_event))
1195         ;
1196       else if (unformat (a, "max-sim-connects %d", &em->max_sim_connects))
1197         ;
1198       else
1199         print_usage_and_exit ();
1200     }
1201
1202   /* setting default for unset values
1203    *
1204    * bytes_to_send / bytes_to_receive & data_source  */
1205   if (em->bytes_to_receive == (u64) ~ 0)
1206     em->bytes_to_receive = 64 << 10;    /* default */
1207   if (em->bytes_to_send == (u64) ~ 0)
1208     em->bytes_to_send = 64 << 10;       /* default */
1209   else if (em->bytes_to_send == 0)
1210     em->data_source = ECHO_NO_DATA_SOURCE;
1211   else
1212     em->data_source = ECHO_TEST_DATA_SOURCE;
1213
1214   if (em->data_source == ECHO_INVALID_DATA_SOURCE)
1215     em->data_source =
1216       em->i_am_master ? ECHO_RX_DATA_SOURCE : ECHO_TEST_DATA_SOURCE;
1217   if (em->data_source == ECHO_RX_DATA_SOURCE)
1218     em->bytes_to_send = em->bytes_to_receive;
1219
1220   /* disconnect flags  */
1221   if (em->i_am_master)
1222     default_f_active =
1223       em->bytes_to_send == 0 ? ECHO_CLOSE_F_ACTIVE : ECHO_CLOSE_F_PASSIVE;
1224   else
1225     default_f_active =
1226       em->bytes_to_receive == 0 ? ECHO_CLOSE_F_PASSIVE : ECHO_CLOSE_F_ACTIVE;
1227   if (em->send_stream_disconnects == ECHO_CLOSE_F_INVALID)
1228     em->send_stream_disconnects = default_f_active;
1229
1230   if (em->max_sim_connects == 0)
1231     em->max_sim_connects = em->evt_q_size >> 1;
1232
1233   if (em->wait_for_gdb)
1234     {
1235       volatile u64 nop = 0;
1236
1237       clib_warning ("Waiting for gdb...");
1238       while (em->wait_for_gdb)
1239         nop++;
1240       clib_warning ("Resuming execution (%llu)!", nop);
1241     }
1242 }
1243
1244 static int
1245 echo_needs_crypto (echo_main_t *em)
1246 {
1247   u8 tr = em->uri_elts.transport_proto;
1248   if (tr == TRANSPORT_PROTO_QUIC || tr == TRANSPORT_PROTO_TLS)
1249     return 1;
1250   return 0;
1251 }
1252
1253 void
1254 echo_process_uri (echo_main_t * em)
1255 {
1256   unformat_input_t _input, *input = &_input;
1257   u32 port;
1258   unformat_init_string (input, (char *) em->uri, strlen ((char *) em->uri));
1259   if (unformat
1260       (input, "%U://%U/%d", unformat_transport_proto,
1261        &em->uri_elts.transport_proto, unformat_ip4_address,
1262        &em->uri_elts.ip.ip4, &port))
1263     em->uri_elts.is_ip4 = 1;
1264   else
1265     if (unformat
1266         (input, "%U://%U/%d", unformat_transport_proto,
1267          &em->uri_elts.transport_proto, unformat_ip6_address,
1268          &em->uri_elts.ip.ip6, &port))
1269     em->uri_elts.is_ip4 = 0;
1270   else
1271     ECHO_FAIL (ECHO_FAIL_INVALID_URI, "Unable to process uri");
1272   em->uri_elts.port = clib_host_to_net_u16 (port);
1273   unformat_free (input);
1274 }
1275
1276 static void __clib_constructor
1277 vpp_echo_init ()
1278 {
1279   /* init memory before proto register themselves */
1280   echo_main_t *em = &echo_main;
1281   clib_mem_init_thread_safe (0, 256 << 20);
1282   clib_memset (em, 0, sizeof (*em));
1283 }
1284
1285 static int
1286 echo_detach (echo_main_t *em)
1287 {
1288   if (em->use_app_socket_api)
1289     return echo_sapi_detach (em);
1290
1291   echo_send_detach (em);
1292   if (wait_for_state_change (em, STATE_DETACHED, TIMEOUT))
1293     {
1294       ECHO_FAIL (ECHO_FAIL_DETACH, "Couldn't detach from vpp");
1295       return -1;
1296     }
1297   return 0;
1298 }
1299
1300 static void
1301 echo_add_cert_key (echo_main_t *em)
1302 {
1303   if (em->use_app_socket_api)
1304     echo_sapi_add_cert_key (em);
1305   else
1306     {
1307       echo_send_add_cert_key (em);
1308       if (wait_for_state_change (em, STATE_ATTACHED, TIMEOUT))
1309         {
1310           ECHO_FAIL (ECHO_FAIL_APP_ATTACH,
1311                      "Couldn't add crypto context to vpp\n");
1312           exit (1);
1313         }
1314     }
1315 }
1316
1317 static int
1318 echo_del_cert_key (echo_main_t *em)
1319 {
1320   if (em->use_app_socket_api)
1321     return echo_sapi_del_cert_key (em);
1322
1323   echo_send_del_cert_key (em);
1324   if (wait_for_state_change (em, STATE_CLEANED_CERT_KEY, TIMEOUT))
1325     {
1326       ECHO_FAIL (ECHO_FAIL_DEL_CERT_KEY, "Couldn't cleanup cert and key");
1327       return -1;
1328     }
1329   return 0;
1330 }
1331
1332 static void
1333 echo_disconnect (echo_main_t *em)
1334 {
1335   if (em->use_app_socket_api)
1336     return;
1337
1338   if (em->use_sock_api)
1339     vl_socket_client_disconnect ();
1340   else
1341     vl_client_disconnect_from_vlib ();
1342 }
1343
1344 static int
1345 echo_attach (echo_main_t *em)
1346 {
1347   if (em->use_app_socket_api)
1348     return echo_sapi_attach (em);
1349   else
1350     {
1351       echo_api_hookup (em);
1352       echo_send_attach (em);
1353       if (wait_for_state_change (em, STATE_ATTACHED_NO_CERT, TIMEOUT))
1354         {
1355           ECHO_FAIL (ECHO_FAIL_ATTACH_TO_VPP,
1356                      "Couldn't attach to vpp, did you run <session enable> ?");
1357           return -1;
1358         }
1359     }
1360   return 0;
1361 }
1362
1363 int
1364 main (int argc, char **argv)
1365 {
1366   echo_main_t *em = &echo_main;
1367   fifo_segment_main_t *sm = &em->segment_main;
1368   u64 i;
1369   int *rv;
1370   svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1371   u32 rpc_queue_size = 256 << 10;
1372
1373   em->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
1374   clib_spinlock_init (&em->sid_vpp_handles_lock);
1375   em->shared_segment_handles = hash_create (0, sizeof (uword));
1376   clib_spinlock_init (&em->segment_handles_lock);
1377   em->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
1378   em->use_sock_api = 1;
1379   em->fifo_size = 64 << 10;
1380   em->prealloc_fifo_pairs = 16;
1381   em->n_clients = 1;
1382   em->n_connects = 1;
1383   em->n_sessions = 2;
1384   em->max_test_msg = 50;
1385   em->time_to_stop = 0;
1386   em->i_am_master = 1;
1387   em->n_rx_threads = 4;
1388   em->evt_q_size = 256;
1389   em->lcl_ip_set = 0;
1390   clib_memset (&em->lcl_ip, 0, sizeof (em->lcl_ip));
1391   em->test_return_packets = RETURN_PACKETS_NOTEST;
1392   em->timing.start_event = ECHO_EVT_FIRST_QCONNECT;
1393   em->timing.end_event = ECHO_EVT_LAST_BYTE;
1394   em->bytes_to_receive = ~0;    /* defaulted when we know if server/client */
1395   em->bytes_to_send = ~0;       /* defaulted when we know if server/client */
1396   em->rx_buf_size = 1 << 20;
1397   em->tx_buf_size = 1 << 20;
1398   em->data_source = ECHO_INVALID_DATA_SOURCE;
1399   em->uri = format (0, "%s%c", "tcp://0.0.0.0/1234", 0);
1400   em->n_uris = 1;
1401   em->max_sim_connects = 0;
1402   em->listen_session_cnt = 0;
1403   em->crypto_engine = CRYPTO_ENGINE_NONE;
1404   echo_set_each_proto_defaults_before_opts (em);
1405   echo_process_opts (argc, argv);
1406   echo_process_uri (em);
1407   em->proto_cb_vft = em->available_proto_cb_vft[em->uri_elts.transport_proto];
1408   if (!em->proto_cb_vft)
1409     {
1410       ECHO_FAIL (ECHO_FAIL_PROTOCOL_NOT_SUPPORTED,
1411                  "Protocol %U is not supported",
1412                  format_transport_proto, em->uri_elts.transport_proto);
1413       goto exit_on_error;
1414     }
1415   if (em->proto_cb_vft->set_defaults_after_opts_cb)
1416     em->proto_cb_vft->set_defaults_after_opts_cb ();
1417
1418   em->stats.rx_expected = em->bytes_to_receive * em->n_clients;
1419   em->stats.tx_expected = em->bytes_to_send * em->n_clients;
1420
1421   vec_validate (em->data_thread_handles, em->n_rx_threads);
1422   vec_validate (em->data_thread_args, em->n_clients);
1423   for (i = 0; i < em->n_clients; i++)
1424     em->data_thread_args[i] = SESSION_INVALID_INDEX;
1425   clib_time_init (&em->clib_time);
1426   init_error_string_table ();
1427   fifo_segment_main_init (sm, HIGH_SEGMENT_BASEVA, 20);
1428   vec_validate (em->connect_test_data, em->tx_buf_size);
1429   for (i = 0; i < em->tx_buf_size; i++)
1430     em->connect_test_data[i] = i & 0xff;
1431
1432   svm_msg_q_ring_cfg_t rc[1] = {
1433     {rpc_queue_size, sizeof (echo_rpc_msg_t), 0},
1434   };
1435   cfg->consumer_pid = getpid ();
1436   cfg->n_rings = 1;
1437   cfg->q_nitems = rpc_queue_size;
1438   cfg->ring_cfgs = rc;
1439   svm_msg_q_attach (&em->rpc_msq_queue, svm_msg_q_alloc (cfg));
1440
1441   signal (SIGINT, stop_signal);
1442   signal (SIGQUIT, stop_signal);
1443   signal (SIGTERM, stop_signal);
1444
1445   em->app_name =
1446     format (0, "%s%c", em->i_am_master ? "echo_server" : "echo_client", 0);
1447
1448   if (connect_to_vpp (em))
1449     {
1450       svm_region_exit ();
1451       ECHO_FAIL (ECHO_FAIL_CONNECT_TO_VPP, "Couldn't connect to vpp");
1452       goto exit_on_error;
1453     }
1454
1455   echo_session_prealloc (em);
1456   echo_notify_event (em, ECHO_EVT_START);
1457
1458   if (echo_attach (em))
1459     goto exit_on_error;
1460
1461   if (echo_needs_crypto (em))
1462     {
1463       ECHO_LOG (2, "Adding crypto context %U", echo_format_crypto_engine,
1464                 em->crypto_engine);
1465       echo_add_cert_key (em);
1466     }
1467   else
1468     {
1469       em->state = STATE_ATTACHED;
1470     }
1471
1472   if (pthread_create (&em->mq_thread_handle, NULL /*attr */, echo_mq_thread_fn,
1473                       0))
1474     {
1475       ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE, "pthread create errored");
1476       goto exit_on_error;
1477     }
1478
1479   for (i = 0; i < em->n_rx_threads; i++)
1480     if (pthread_create (&em->data_thread_handles[i],
1481                         NULL /*attr */ , echo_data_thread_fn, (void *) i))
1482       {
1483         ECHO_FAIL (ECHO_FAIL_PTHREAD_CREATE,
1484                    "pthread create errored (index %d)", i);
1485         goto exit_on_error;
1486       }
1487   if (em->i_am_master)
1488     server_run (em);
1489   else
1490     clients_run (em);
1491   echo_notify_event (em, ECHO_EVT_EXIT);
1492   echo_free_sessions (em);
1493   if (echo_needs_crypto (em))
1494     {
1495       if (echo_del_cert_key (em))
1496         goto exit_on_error;
1497     }
1498
1499   if (echo_detach (em))
1500     goto exit_on_error;
1501
1502   pthread_join (em->mq_thread_handle, (void **) &rv);
1503   if (rv)
1504     {
1505       ECHO_FAIL (ECHO_FAIL_MQ_PTHREAD, "mq pthread errored %d", rv);
1506       goto exit_on_error;
1507     }
1508   echo_disconnect (em);
1509   echo_assert_test_suceeded (em);
1510 exit_on_error:
1511   ECHO_LOG (1, "Test complete !\n");
1512   if (em->output_json)
1513     print_global_json_stats (em);
1514   else
1515     print_global_stats (em);
1516   vec_free (em->fail_descr);
1517   vec_free (em->available_proto_cb_vft);
1518   exit (em->has_failed);
1519 }
1520
1521 /*
1522  * fd.io coding-style-patch-verification: ON
1523  *
1524  * Local Variables:
1525  * eval: (c-set-style "gnu")
1526  * End:
1527  */