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   CHECK (em->n_clients * em->bytes_to_receive,
  46          em->stats.rx_total, "Not enough data received");
  47   CHECK (em->n_clients * em->bytes_to_send,
  48          em->stats.tx_total, "Not enough data sent");
  49   clib_spinlock_lock (&em->sid_vpp_handles_lock);
  50   CHECK (0, hash_elts (em->session_index_by_vpp_handles),
  51          "Some sessions are still open");
  52   clib_spinlock_unlock (&em->sid_vpp_handles_lock);
  53 }
  54
  55 always_inline void
  56 echo_session_dequeue_notify (echo_session_t * s)
  57 {
  58   int rv;
  59   if (!svm_fifo_set_event (s->rx_fifo))
  60     return;
  61   if ((rv =
  62        app_send_io_evt_to_vpp (s->vpp_evt_q, s->rx_fifo->master_session_index,
  63                                SESSION_IO_EVT_RX, SVM_Q_WAIT)))
  64     ECHO_FAIL ("app_send_io_evt_to_vpp errored %d", rv);
  65   svm_fifo_clear_deq_ntf (s->rx_fifo);
  66 }
  67
  68 static void
  69 stop_signal (int signum)
  70 {
  71   echo_main_t *em = &echo_main;
  72   em->time_to_stop = 1;
  73 }
  74
  75 int
  76 connect_to_vpp (char *name)
  77 {
  78   echo_main_t *em = &echo_main;
  79   api_main_t *am = &api_main;
  80
  81   if (em->use_sock_api)
  82     {
  83       if (vl_socket_client_connect ((char *) em->socket_name, name,
  84                                     0 /* default rx, tx buffer */ ))
  85         {
  86           ECHO_FAIL ("socket connect failed");
  87           return -1;
  88         }
  89
  90       if (vl_socket_client_init_shm (0, 1 /* want_pthread */ ))
  91         {
  92           ECHO_FAIL ("init shm api failed");
  93           return -1;
  94         }
  95     }
  96   else
  97     {
  98       if (vl_client_connect_to_vlib ("/vpe-api", name, 32) < 0)
  99         {
 100           ECHO_FAIL ("shmem connect failed");
 101           return -1;
 102         }
 103     }
 104   em->vl_input_queue = am->shmem_hdr->vl_input_queue;
 105   em->my_client_index = am->my_client_index;
 106   return 0;
 107 }
 108
 109 static void
 110 echo_event_didnt_happen (u8 e)
 111 {
 112   echo_main_t *em = &echo_main;
 113   u8 *s = format (0, "%U", echo_format_timing_event, e);
 114   ECHO_LOG (0, "Expected event %s to happend, which did not", s);
 115   em->has_failed = 1;
 116 }
 117
 118 static void
 119 print_global_json_stats (echo_main_t * em)
 120 {
 121   if (!(em->timing.events_sent & em->timing.start_event))
 122     return echo_event_didnt_happen (em->timing.start_event);
 123   if (!(em->timing.events_sent & em->timing.end_event))
 124     return echo_event_didnt_happen (em->timing.end_event);
 125   f64 deltat = em->timing.end_time - em->timing.start_time;
 126   u8 *start_evt =
 127     format (0, "%U", echo_format_timing_event, em->timing.start_event);
 128   u8 *end_evt =
 129     format (0, "%U", echo_format_timing_event, em->timing.end_event);
 130   fformat (stdout, "{\n");
 131   fformat (stdout, "\"time\": \"%.9f\",\n", deltat);
 132   fformat (stdout, "\"start_evt\": \"%s\",\n", start_evt);
 133   fformat (stdout, "\"end_evt\": \"%s\",\n", end_evt);
 134   fformat (stdout, "\"rx_data\": %lld,\n", em->stats.rx_total);
 135   fformat (stdout, "\"tx_rx\": %lld,\n", em->stats.tx_total);
 136   fformat (stdout, "\"closing\": {\n");
 137   fformat (stdout, "  \"reset\": { \"q\": %d, \"s\": %d },\n",
 138            em->stats.reset_count.q, em->stats.reset_count.s);
 139   fformat (stdout, "  \"close\": { \"q\": %d, \"s\": %d },\n",
 140            em->stats.close_count.q, em->stats.close_count.s);
 141   fformat (stdout, "  \"active\": { \"q\": %d, \"s\": %d },\n",
 142            em->stats.active_count.q, em->stats.active_count.s);
 143   fformat (stdout, "  \"clean\": { \"q\": %d, \"s\": %d }\n",
 144            em->stats.clean_count.q, em->stats.clean_count.s);
 145   fformat (stdout, "}\n");
 146   fformat (stdout, "}\n");
 147 }
 148
 149 static void
 150 print_global_stats (echo_main_t * em)
 151 {
 152   u8 *s;
 153   if (!(em->timing.events_sent & em->timing.start_event))
 154     return echo_event_didnt_happen (em->timing.start_event);
 155   if (!(em->timing.events_sent & em->timing.end_event))
 156     return echo_event_didnt_happen (em->timing.end_event);
 157   f64 deltat = em->timing.end_time - em->timing.start_time;
 158   s = format (0, "%U:%U",
 159               echo_format_timing_event, em->timing.start_event,
 160               echo_format_timing_event, em->timing.end_event);
 161   fformat (stdout, "Timing %s\n", s);
 162   fformat (stdout, "-------- TX --------\n");
 163   fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
 164            em->stats.tx_total, em->stats.tx_total / (1ULL << 20),
 165            em->stats.tx_total / (1ULL << 30), deltat);
 166   fformat (stdout, "%.4f Gbit/second\n",
 167            (em->stats.tx_total * 8.0) / deltat / 1e9);
 168   fformat (stdout, "-------- RX --------\n");
 169   fformat (stdout, "%lld bytes (%lld mbytes, %lld gbytes) in %.6f seconds\n",
 170            em->stats.rx_total, em->stats.rx_total / (1ULL << 20),
 171            em->stats.rx_total / (1ULL << 30), deltat);
 172   fformat (stdout, "%.4f Gbit/second\n",
 173            (em->stats.rx_total * 8.0) / deltat / 1e9);
 174   fformat (stdout, "--------------------\n");
 175   fformat (stdout, "Received close on %d streams (and %d Quic conn)\n",
 176            em->stats.close_count.s, em->stats.close_count.q);
 177   fformat (stdout, "Received reset on %d streams (and %d Quic conn)\n",
 178            em->stats.reset_count.s, em->stats.reset_count.q);
 179   fformat (stdout, "Sent close on     %d streams (and %d Quic conn)\n",
 180            em->stats.active_count.s, em->stats.active_count.q);
 181   fformat (stdout, "Discarded         %d streams (and %d Quic conn)\n",
 182            em->stats.clean_count.s, em->stats.clean_count.q);
 183 }
 184
 185 void
 186 echo_update_count_on_session_close (echo_main_t * em, echo_session_t * s)
 187 {
 188
 189   ECHO_LOG (1, "[%lu/%lu] -> S(%x) -> [%lu/%lu]",
 190             s->bytes_received, s->bytes_received + s->bytes_to_receive,
 191             s->session_index, s->bytes_sent,
 192             s->bytes_sent + s->bytes_to_send);
 193   clib_atomic_fetch_add (&em->stats.tx_total, s->bytes_sent);
 194   clib_atomic_fetch_add (&em->stats.rx_total, s->bytes_received);
 195
 196   if (PREDICT_FALSE (em->stats.rx_total ==
 197                      em->n_clients * em->bytes_to_receive))
 198     echo_notify_event (em, ECHO_EVT_LAST_BYTE);
 199 }
 200
 201 static void
 202 echo_free_sessions (echo_main_t * em)
 203 {
 204   /* Free marked sessions */
 205   echo_session_t *s;
 206   u32 *session_indexes = 0, *session_index;
 207
 208   /* *INDENT-OFF* */
 209   pool_foreach (s, em->sessions,
 210   ({
 211     if (s->session_state == ECHO_SESSION_STATE_CLOSED)
 212       vec_add1 (session_indexes, s->session_index);}
 213   ));
 214   /* *INDENT-ON* */
 215   vec_foreach (session_index, session_indexes)
 216   {
 217     /* Free session */
 218     s = pool_elt_at_index (em->sessions, *session_index);
 219     echo_session_handle_add_del (em, s->vpp_session_handle,
 220                                  SESSION_INVALID_INDEX);
 221     pool_put (em->sessions, s);
 222     clib_memset (s, 0xfe, sizeof (*s));
 223   }
 224 }
 225
 226 static void
 227 test_recv_bytes (echo_main_t * em, echo_session_t * s, u8 * rx_buf,
 228                  u32 n_read)
 229 {
 230   u32 i;
 231   u8 expected;
 232   for (i = 0; i < n_read; i++)
 233     {
 234       expected = (s->bytes_received + i) & 0xff;
 235       if (rx_buf[i] == expected || em->max_test_msg > 0)
 236         continue;
 237       ECHO_LOG (0, "Session 0x%lx byte %lld was 0x%x expected 0x%x",
 238                 s->vpp_session_handle, s->bytes_received + i, rx_buf[i],
 239                 expected);
 240       em->max_test_msg--;
 241       if (em->max_test_msg == 0)
 242         ECHO_LOG (0, "Too many errors, hiding next ones");
 243       if (em->test_return_packets == RETURN_PACKETS_ASSERT)
 244         ECHO_FAIL ("test-bytes errored");
 245     }
 246 }
 247
 248 static int
 249 recv_data_chunk (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
 250 {
 251   int n_read;
 252   n_read = app_recv ((app_session_t *) s, rx_buf, vec_len (rx_buf));
 253   if (n_read <= 0)
 254     return 0;
 255   if (svm_fifo_needs_deq_ntf (s->rx_fifo, n_read))
 256     echo_session_dequeue_notify (s);
 257
 258   if (em->test_return_packets)
 259     test_recv_bytes (em, s, rx_buf, n_read);
 260
 261   s->bytes_received += n_read;
 262   s->bytes_to_receive -= n_read;
 263   return n_read;
 264 }
 265
 266 static int
 267 send_data_chunk (echo_session_t * s, u8 * tx_buf, int offset, int len)
 268 {
 269   int n_sent;
 270   int bytes_this_chunk = clib_min (s->bytes_to_send, len - offset);
 271   if (!bytes_this_chunk)
 272     return 0;
 273   n_sent = app_send ((app_session_t *) s, tx_buf + offset,
 274                      bytes_this_chunk, SVM_Q_WAIT);
 275   if (n_sent < 0)
 276     return 0;
 277   s->bytes_to_send -= n_sent;
 278   s->bytes_sent += n_sent;
 279   return n_sent;
 280 }
 281
 282 static int
 283 mirror_data_chunk (echo_main_t * em, echo_session_t * s, u8 * tx_buf, u64 len)
 284 {
 285   u64 n_sent = 0;
 286   while (n_sent < len && !em->time_to_stop)
 287     n_sent += send_data_chunk (s, tx_buf, n_sent, len);
 288   return n_sent;
 289 }
 290
 291 static inline void
 292 echo_check_closed_listener (echo_main_t * em, echo_session_t * s)
 293 {
 294   echo_session_t *ls;
 295   /* if parent has died, terminate gracefully */
 296   if (s->listener_index == SESSION_INVALID_INDEX)
 297     return;
 298   ls = pool_elt_at_index (em->sessions, s->listener_index);
 299   if (ls->session_state < ECHO_SESSION_STATE_CLOSING)
 300     return;
 301   ECHO_LOG (2, "Session 0%lx died, close child 0x%lx", ls->vpp_session_handle,
 302             s->vpp_session_handle);
 303   echo_update_count_on_session_close (em, s);
 304   em->proto_cb_vft->cleanup_cb (s, 1 /* parent_died */ );
 305 }
 306
 307 /*
 308  * Rx/Tx polling thread per connection
 309  */
 310 static void
 311 echo_handle_data (echo_main_t * em, echo_session_t * s, u8 * rx_buf)
 312 {
 313   int n_read, n_sent = 0;
 314
 315   n_read = recv_data_chunk (em, s, rx_buf);
 316   if (em->data_source == ECHO_TEST_DATA_SOURCE)
 317     n_sent = send_data_chunk (s, em->connect_test_data,
 318                               s->bytes_sent % em->tx_buf_size,
 319                               em->tx_buf_size);
 320   else if (em->data_source == ECHO_RX_DATA_SOURCE)
 321     n_sent = mirror_data_chunk (em, s, rx_buf, n_read);
 322   if (!s->bytes_to_send && !s->bytes_to_receive)
 323     {
 324       /* Session is done, need to close */
 325       if (s->session_state == ECHO_SESSION_STATE_AWAIT_DATA)
 326         s->session_state = ECHO_SESSION_STATE_CLOSING;
 327       else
 328         {
 329           s->session_state = ECHO_SESSION_STATE_AWAIT_CLOSING;
 330           if (em->send_stream_disconnects == ECHO_CLOSE_F_ACTIVE)
 331             {
 332               echo_send_rpc (em, echo_send_disconnect_session,
 333                              (void *) s->vpp_session_handle, 0);
 334               clib_atomic_fetch_add (&em->stats.active_count.s, 1);
 335             }
 336           else if (em->send_stream_disconnects == ECHO_CLOSE_F_NONE)
 337             {
 338               s->session_state = ECHO_SESSION_STATE_CLOSING;
 339               clib_atomic_fetch_add (&em->stats.clean_count.s, 1);
 340             }
 341         }
 342       return;
 343     }
 344
 345   /* Check for idle clients */
 346   if (em->log_lvl > 1)
 347     {
 348       if (n_sent || n_read)
 349         s->idle_cycles = 0;
 350       else if (s->idle_cycles++ == 1e7)
 351         {
 352           s->idle_cycles = 0;
 353           ECHO_LOG (1, "Idle client TX:%dB RX:%dB", s->bytes_to_send,
 354                     s->bytes_to_receive);
 355           ECHO_LOG (1, "Idle FIFOs TX:%dB RX:%dB",
 356                     svm_fifo_max_dequeue (s->tx_fifo),
 357                     svm_fifo_max_dequeue (s->rx_fifo));
 358           ECHO_LOG (1, "Session 0x%lx state %u", s->vpp_session_handle,
 359                     s->session_state);
 360         }
 361     }
 362 }
 363
 364 static void *
 365 echo_data_thread_fn (void *arg)
 366 {
 367   clib_mem_set_thread_index ();
 368   echo_main_t *em = &echo_main;
 369   u32 N = em->n_clients;
 370   u32 n = (N + em->n_rx_threads - 1) / em->n_rx_threads;
 371   u32 idx = (u64) arg;
 372   if (n * idx >= N)
 373     {
 374       ECHO_LOG (1, "Thread %u exiting, no sessions to care for", idx);
 375       pthread_exit (0);
 376     }
 377   u32 thread_n_sessions = clib_min (n, N - n * idx);
 378
 379   u32 i = 0;
 380   u32 n_closed_sessions = 0;
 381   u32 session_index;
 382   u8 *rx_buf = 0;
 383   echo_session_t *s;
 384   vec_validate (rx_buf, em->rx_buf_size);
 385
 386   for (i = 0; !em->time_to_stop; i = (i + 1) % thread_n_sessions)
 387     {
 388       n_closed_sessions = i == 0 ? 0 : n_closed_sessions;
 389       session_index = em->data_thread_args[n * idx + i];
 390       if (session_index == SESSION_INVALID_INDEX)
 391         continue;
 392       s = pool_elt_at_index (em->sessions, session_index);
 393       switch (s->session_state)
 394         {
 395         case ECHO_SESSION_STATE_READY:
 396         case ECHO_SESSION_STATE_AWAIT_DATA:
 397           echo_handle_data (em, s, rx_buf);
 398           echo_check_closed_listener (em, s);
 399           break;
 400         case ECHO_SESSION_STATE_AWAIT_CLOSING:
 401           echo_check_closed_listener (em, s);
 402           break;
 403         case ECHO_SESSION_STATE_CLOSING:
 404           echo_update_count_on_session_close (em, s);
 405           em->proto_cb_vft->cleanup_cb (s, 0 /* parent_died */ );
 406           break;
 407         case ECHO_SESSION_STATE_CLOSED:
 408           n_closed_sessions++;
 409           break;
 410         }
 411       if (n_closed_sessions == thread_n_sessions)
 412         break;
 413     }
 414   pthread_exit (0);
 415 }
 416
 417 static void
 418 session_bound_handler (session_bound_msg_t * mp)
 419 {
 420   echo_main_t *em = &echo_main;
 421   echo_session_t *listen_session;
 422   if (mp->retval)
 423     {
 424       ECHO_FAIL ("bind failed: %U", format_api_error,
 425                  clib_net_to_host_u32 (mp->retval));
 426       return;
 427     }
 428   ECHO_LOG (0, "listening on %U:%u", format_ip46_address, mp->lcl_ip,
 429             mp->lcl_is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
 430             clib_net_to_host_u16 (mp->lcl_port));
 431
 432   /* Allocate local session and set it up */
 433   listen_session = echo_session_new (em);
 434   listen_session->session_type = ECHO_SESSION_TYPE_LISTEN;
 435   echo_session_handle_add_del (em, mp->handle, listen_session->session_index);
 436   em->state = STATE_LISTEN;
 437   em->listen_session_index = listen_session->session_index;
 438   if (em->proto_cb_vft->bound_uri_cb)
 439     em->proto_cb_vft->bound_uri_cb (mp, listen_session);
 440 }
 441
 442 static void
 443 session_accepted_handler (session_accepted_msg_t * mp)
 444 {
 445   app_session_evt_t _app_evt, *app_evt = &_app_evt;
 446   session_accepted_reply_msg_t *rmp;
 447   svm_fifo_t *rx_fifo, *tx_fifo;
 448   echo_main_t *em = &echo_main;
 449   echo_session_t *session, *ls;
 450   /* Allocate local session and set it up */
 451   session = echo_session_new (em);
 452
 453   if (wait_for_segment_allocation (mp->segment_handle))
 454     {
 455       ECHO_FAIL ("wait_for_segment_allocation errored");
 456       return;
 457     }
 458
 459   rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
 460   rx_fifo->client_session_index = session->session_index;
 461   tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
 462   tx_fifo->client_session_index = session->session_index;
 463
 464   session->rx_fifo = rx_fifo;
 465   session->tx_fifo = tx_fifo;
 466
 467   /* session->transport needed by app_send_dgram */
 468   clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
 469                     sizeof (ip46_address_t));
 470   session->transport.is_ip4 = mp->rmt.is_ip4;
 471   session->transport.rmt_port = mp->rmt.port;
 472   clib_memcpy_fast (&session->transport.lcl_ip, &em->uri_elts.ip,
 473                     sizeof (ip46_address_t));
 474   session->transport.lcl_port = em->uri_elts.port;
 475
 476   session->vpp_session_handle = mp->handle;
 477   session->start = clib_time_now (&em->clib_time);
 478   session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
 479                                          svm_msg_q_t *);
 480   if (!(ls = echo_get_session_from_handle (em, mp->listener_handle)))
 481     return;
 482   session->listener_index = ls->session_index;
 483
 484   /* Add it to lookup table */
 485   ECHO_LOG (1, "Accepted session 0x%lx -> 0x%lx", mp->handle,
 486             mp->listener_handle);
 487   echo_session_handle_add_del (em, mp->handle, session->session_index);
 488
 489   app_alloc_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt,
 490                              SESSION_CTRL_EVT_ACCEPTED_REPLY);
 491   rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
 492   rmp->handle = mp->handle;
 493   rmp->context = mp->context;
 494   app_send_ctrl_evt_to_vpp (session->vpp_evt_q, app_evt);
 495   em->proto_cb_vft->accepted_cb (mp, session);
 496 }
 497
 498 static void
 499 session_connected_handler (session_connected_msg_t * mp)
 500 {
 501   echo_main_t *em = &echo_main;
 502   echo_session_t *session;
 503   u32 listener_index = htonl (mp->context);
 504   svm_fifo_t *rx_fifo, *tx_fifo;
 505
 506   if (mp->retval)
 507     {
 508       ECHO_FAIL ("connection failed with code: %U", format_api_error,
 509                  clib_net_to_host_u32 (mp->retval));
 510       return;
 511     }
 512
 513   session = echo_session_new (em);
 514   if (wait_for_segment_allocation (mp->segment_handle))
 515     {
 516       ECHO_FAIL ("wait_for_segment_allocation errored");
 517       return;
 518     }
 519
 520   rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
 521   rx_fifo->client_session_index = session->session_index;
 522   tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
 523   tx_fifo->client_session_index = session->session_index;
 524
 525   session->rx_fifo = rx_fifo;
 526   session->tx_fifo = tx_fifo;
 527   session->vpp_session_handle = mp->handle;
 528   session->start = clib_time_now (&em->clib_time);
 529   session->vpp_evt_q = uword_to_pointer (mp->vpp_event_queue_address,
 530                                          svm_msg_q_t *);
 531   session->listener_index = listener_index;
 532   /* session->transport needed by app_send_dgram */
 533   clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
 534                     sizeof (ip46_address_t));
 535   session->transport.is_ip4 = mp->lcl.is_ip4;
 536   session->transport.lcl_port = mp->lcl.port;
 537   clib_memcpy_fast (&session->transport.rmt_ip, &em->uri_elts.ip,
 538                     sizeof (ip46_address_t));
 539   session->transport.rmt_port = em->uri_elts.port;
 540
 541   echo_session_handle_add_del (em, mp->handle, session->session_index);
 542   em->proto_cb_vft->connected_cb ((session_connected_bundled_msg_t *) mp,
 543                                   session->session_index, 0 /* is_failed */ );
 544 }
 545
 546 /*
 547  *
 548  *  End of ECHO callback definitions
 549  *
 550  */
 551
 552 static void
 553 session_disconnected_handler (session_disconnected_msg_t * mp)
 554 {
 555   app_session_evt_t _app_evt, *app_evt = &_app_evt;
 556   session_disconnected_reply_msg_t *rmp;
 557   echo_main_t *em = &echo_main;
 558   echo_session_t *s;
 559   ECHO_LOG (1, "passive close session 0x%lx", mp->handle);
 560   if (!(s = echo_get_session_from_handle (em, mp->handle)))
 561     return;
 562   em->proto_cb_vft->disconnected_cb (mp, s);
 563
 564   app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
 565                              SESSION_CTRL_EVT_DISCONNECTED_REPLY);
 566   rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
 567   rmp->retval = 0;
 568   rmp->handle = mp->handle;
 569   rmp->context = mp->context;
 570   app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
 571 }
 572
 573 static void
 574 session_reset_handler (session_reset_msg_t * mp)
 575 {
 576   app_session_evt_t _app_evt, *app_evt = &_app_evt;
 577   echo_main_t *em = &echo_main;
 578   session_reset_reply_msg_t *rmp;
 579   echo_session_t *s = 0;
 580   ECHO_LOG (1, "Reset session 0x%lx", mp->handle);
 581   if (!(s = echo_get_session_from_handle (em, mp->handle)))
 582     return;
 583   em->proto_cb_vft->reset_cb (mp, s);
 584
 585   app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
 586                              SESSION_CTRL_EVT_RESET_REPLY);
 587   rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
 588   rmp->retval = 0;
 589   rmp->handle = mp->handle;
 590   app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
 591 }
 592
 593 static void
 594 handle_mq_event (session_event_t * e)
 595 {
 596   switch (e->event_type)
 597     {
 598     case SESSION_CTRL_EVT_BOUND:
 599       session_bound_handler ((session_bound_msg_t *) e->data);
 600       break;
 601     case SESSION_CTRL_EVT_ACCEPTED:
 602       session_accepted_handler ((session_accepted_msg_t *) e->data);
 603       break;
 604     case SESSION_CTRL_EVT_CONNECTED:
 605       session_connected_handler ((session_connected_msg_t *) e->data);
 606       break;
 607     case SESSION_CTRL_EVT_DISCONNECTED:
 608       session_disconnected_handler ((session_disconnected_msg_t *) e->data);
 609       break;
 610     case SESSION_CTRL_EVT_RESET:
 611       session_reset_handler ((session_reset_msg_t *) e->data);
 612       break;
 613     case SESSION_IO_EVT_RX:
 614       break;
 615     default:
 616       ECHO_LOG (0, "unhandled event %u", e->event_type);
 617     }
 618 }
 619
 620 static void
 621 echo_process_rpcs (echo_main_t * em)
 622 {
 623   echo_rpc_msg_t *rpc;
 624   svm_msg_q_msg_t msg;
 625   while (em->state < STATE_DATA_DONE && !em->time_to_stop)
 626     {
 627       if (svm_msg_q_sub (em->rpc_msq_queue, &msg, SVM_Q_TIMEDWAIT, 1))
 628         continue;
 629       rpc = svm_msg_q_msg_data (em->rpc_msq_queue, &msg);
 630       ((echo_rpc_t) rpc->fp) (rpc->arg, rpc->opaque);
 631       svm_msg_q_free_msg (em->rpc_msq_queue, &msg);
 632     }
 633 }
 634
 635 static void *
 636 echo_mq_thread_fn (void *arg)
 637 {
 638   clib_mem_set_thread_index ();
 639   echo_main_t *em = &echo_main;
 640   session_event_t *e;
 641   svm_msg_q_msg_t msg;
 642   int rv;
 643   wait_for_state_change (em, STATE_ATTACHED, 0);
 644   if (em->state < STATE_ATTACHED || !em->our_event_queue)
 645     {
 646       ECHO_FAIL ("Application failed to attach");
 647       pthread_exit (0);
 648     }
 649
 650   while (1)
 651     {
 652       if (!(rv = svm_msg_q_sub (em->our_event_queue,
 653                                 &msg, SVM_Q_TIMEDWAIT, 1)))
 654         {
 655           e = svm_msg_q_msg_data (em->our_event_queue, &msg);
 656           handle_mq_event (e);
 657           svm_msg_q_free_msg (em->our_event_queue, &msg);
 658         }
 659       if (rv == ETIMEDOUT
 660           && (em->time_to_stop || em->state == STATE_DETACHED))
 661         break;
 662     }
 663   pthread_exit (0);
 664 }
 665
 666 static void
 667 clients_run (echo_main_t * em)
 668 {
 669   u64 i;
 670   echo_notify_event (em, ECHO_EVT_FIRST_QCONNECT);
 671   for (i = 0; i < em->n_connects; i++)
 672     echo_send_connect (em->uri, SESSION_INVALID_INDEX);
 673   wait_for_state_change (em, STATE_READY, 0);
 674   ECHO_LOG (1, "App is ready");
 675   echo_process_rpcs (em);
 676 }
 677
 678 static void
 679 server_run (echo_main_t * em)
 680 {
 681   echo_send_listen (em);
 682   wait_for_state_change (em, STATE_READY, 0);
 683   ECHO_LOG (1, "App is ready");
 684   echo_process_rpcs (em);
 685   /* Cleanup */
 686   echo_send_unbind (em);
 687   if (wait_for_state_change (em, STATE_DISCONNECTED, TIMEOUT))
 688     {
 689       ECHO_FAIL ("Timeout waiting for state disconnected");
 690       return;
 691     }
 692 }
 693
 694 static void
 695 print_usage_and_exit (void)
 696 {
 697   echo_main_t *em = &echo_main;
 698   int i;
 699   fprintf (stderr,
 700            "Usage: vpp_echo [socket-name SOCKET] [client|server] [uri URI] [OPTIONS]\n"
 701            "Generates traffic and assert correct teardown of the QUIC hoststack\n"
 702            "\n"
 703            "  socket-name PATH    Specify the binary socket path to connect to VPP\n"
 704            "  use-svm-api         Use SVM API to connect to VPP\n"
 705            "  test-bytes[:assert] Check data correctness when receiving (assert fails on first error)\n"
 706            "  fifo-size N         Use N Kb fifos\n"
 707            "  rx-buf N            Use N Kb RX buffer\n"
 708            "  tx-buf N            Use N Kb TX test buffer\n"
 709            "  appns NAMESPACE     Use the namespace NAMESPACE\n"
 710            "  all-scope           all-scope option\n"
 711            "  local-scope         local-scope option\n"
 712            "  global-scope        global-scope option\n"
 713            "  secret SECRET       set namespace secret\n"
 714            "  chroot prefix PATH  Use PATH as memory root path\n"
 715            "  sclose=[Y|N|W]      When a stream is done,    pass[N] send[Y] or wait[W] for close\n"
 716            "\n"
 717            "  time START:END      Time between evts START & END, events being :\n"
 718            "                       start - Start of the app\n"
 719            "                       qconnect    - first Connection connect sent\n"
 720            "                       qconnected  - last Connection connected\n"
 721            "                       sconnect    - first Stream connect sent\n"
 722            "                       sconnected  - last Stream got connected\n"
 723            "                       lastbyte    - Last expected byte received\n"
 724            "                       exit        - Exiting of the app\n"
 725            "  json                Output global stats in json\n"
 726            "  log=N               Set the log level to [0: no output, 1:errors, 2:log]\n"
 727            "\n"
 728            "  nclients N          Open N clients sending data\n"
 729            "  nthreads N          Use N busy loop threads for data [in addition to main & msg queue]\n"
 730            "  TX=1337[Kb|Mb|GB]   Send 1337 [K|M|G]bytes, use TX=RX to reflect the data\n"
 731            "  RX=1337[Kb|Mb|GB]   Expect 1337 [K|M|G]bytes\n" "\n");
 732   for (i = 0; i < TRANSPORT_N_PROTO; i++)
 733     {
 734       echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
 735       if (vft && vft->print_usage_cb)
 736         vft->print_usage_cb ();
 737     }
 738   fprintf (stderr, "\nDefault configuration is :\n"
 739            " server nclients 1/1 RX=64Kb TX=RX\n"
 740            " client nclients 1/1 RX=64Kb TX=64Kb\n");
 741   exit (1);
 742 }
 743
 744 static int
 745 echo_process_each_proto_opts (unformat_input_t * a)
 746 {
 747   echo_main_t *em = &echo_main;
 748   int i, rv;
 749   for (i = 0; i < TRANSPORT_N_PROTO; i++)
 750     {
 751       echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
 752       if (vft && vft->process_opts_cb)
 753         if ((rv = vft->process_opts_cb (a)))
 754           return rv;
 755     }
 756   return 0;
 757 }
 758
 759 static void
 760 echo_set_each_proto_defaults_before_opts (echo_main_t * em)
 761 {
 762   int i;
 763   for (i = 0; i < TRANSPORT_N_PROTO; i++)
 764     {
 765       echo_proto_cb_vft_t *vft = em->available_proto_cb_vft[i];
 766       if (vft && vft->set_defaults_before_opts_cb)
 767         vft->set_defaults_before_opts_cb ();
 768     }
 769 }
 770
 771 void
 772 echo_process_opts (int argc, char **argv)
 773 {
 774   echo_main_t *em = &echo_main;
 775   unformat_input_t _argv, *a = &_argv;
 776   u32 tmp;
 777   u8 *chroot_prefix;
 778   u8 *uri = 0;
 779   u8 default_f_active;
 780
 781   unformat_init_command_line (a, argv);
 782   while (unformat_check_input (a) != UNFORMAT_END_OF_INPUT)
 783     {
 784       if (echo_process_each_proto_opts (a))
 785         ;
 786       else if (unformat (a, "chroot prefix %s", &chroot_prefix))
 787         vl_set_memory_root_path ((char *) chroot_prefix);
 788       else if (unformat (a, "uri %s", &uri))
 789         em->uri = format (0, "%s%c", uri, 0);
 790       else if (unformat (a, "server"))
 791         em->i_am_master = 1;
 792       else if (unformat (a, "client"))
 793         em->i_am_master = 0;
 794       else if (unformat (a, "test-bytes:assert"))
 795         em->test_return_packets = RETURN_PACKETS_ASSERT;
 796       else if (unformat (a, "test-bytes"))
 797         em->test_return_packets = RETURN_PACKETS_LOG_WRONG;
 798       else if (unformat (a, "socket-name %s", &em->socket_name))
 799         ;
 800       else if (unformat (a, "use-svm-api"))
 801         em->use_sock_api = 0;
 802       else if (unformat (a, "fifo-size %d", &tmp))
 803         em->fifo_size = tmp << 10;
 804       else if (unformat (a, "rx-buf %d", &tmp))
 805         em->rx_buf_size = tmp << 10;
 806       else if (unformat (a, "tx-buf %d", &tmp))
 807         em->rx_buf_size = tmp << 10;
 808       else if (unformat (a, "nclients %d", &em->n_clients))
 809         {
 810           em->n_sessions = em->n_clients + 1;
 811           em->n_connects = em->n_clients;
 812         }
 813       else if (unformat (a, "nthreads %d", &em->n_rx_threads))
 814         ;
 815       else if (unformat (a, "appns %_%v%_", &em->appns_id))
 816         ;
 817       else if (unformat (a, "all-scope"))
 818         em->appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
 819                             | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
 820       else if (unformat (a, "local-scope"))
 821         em->appns_flags = APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
 822       else if (unformat (a, "global-scope"))
 823         em->appns_flags = APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 824       else if (unformat (a, "secret %lu", &em->appns_secret))
 825         ;
 826       else if (unformat (a, "TX=RX"))
 827         em->data_source = ECHO_RX_DATA_SOURCE;
 828       else if (unformat (a, "TX=%U", unformat_data, &em->bytes_to_send))
 829         ;
 830       else if (unformat (a, "RX=%U", unformat_data, &em->bytes_to_receive))
 831         ;
 832       else if (unformat (a, "json"))
 833         em->output_json = 1;
 834       else if (unformat (a, "log=%d", &em->log_lvl))
 835         ;
 836       else if (unformat (a, "sclose=%U",
 837                          echo_unformat_close, &em->send_stream_disconnects))
 838         ;
 839       else if (unformat (a, "time %U:%U",
 840                          echo_unformat_timing_event, &em->timing.start_event,
 841                          echo_unformat_timing_event, &em->timing.end_event))
 842         ;
 843       else
 844         print_usage_and_exit ();
 845     }
 846
 847   /* setting default for unset values
 848    *
 849    * bytes_to_send / bytes_to_receive & data_source  */
 850   if (em->bytes_to_receive == (u64) ~ 0)
 851     em->bytes_to_receive = 64 << 10;    /* default */
 852   if (em->bytes_to_send == (u64) ~ 0)
 853     em->bytes_to_send = 64 << 10;       /* default */
 854   else if (em->bytes_to_send == 0)
 855     em->data_source = ECHO_NO_DATA_SOURCE;
 856   else
 857     em->data_source = ECHO_TEST_DATA_SOURCE;
 858
 859   if (em->data_source == ECHO_INVALID_DATA_SOURCE)
 860     em->data_source =
 861       em->i_am_master ? ECHO_RX_DATA_SOURCE : ECHO_TEST_DATA_SOURCE;
 862   if (em->data_source == ECHO_RX_DATA_SOURCE)
 863     em->bytes_to_send = em->bytes_to_receive;
 864
 865   /* disconnect flags  */
 866   if (em->i_am_master)
 867     default_f_active =
 868       em->bytes_to_send == 0 ? ECHO_CLOSE_F_ACTIVE : ECHO_CLOSE_F_PASSIVE;
 869   else
 870     default_f_active =
 871       em->bytes_to_receive == 0 ? ECHO_CLOSE_F_PASSIVE : ECHO_CLOSE_F_ACTIVE;
 872   if (em->send_stream_disconnects == ECHO_CLOSE_F_INVALID)
 873     em->send_stream_disconnects = default_f_active;
 874 }
 875
 876 void
 877 echo_process_uri (echo_main_t * em)
 878 {
 879   unformat_input_t _input, *input = &_input;
 880   u32 port;
 881   unformat_init_string (input, (char *) em->uri, strlen ((char *) em->uri));
 882   if (unformat
 883       (input, "%U://%U/%d", unformat_transport_proto,
 884        &em->uri_elts.transport_proto, unformat_ip4_address,
 885        &em->uri_elts.ip.ip4, &port))
 886     em->uri_elts.is_ip4 = 1;
 887   else
 888     if (unformat
 889         (input, "%U://%U/%d", unformat_transport_proto,
 890          &em->uri_elts.transport_proto, unformat_ip6_address,
 891          &em->uri_elts.ip.ip6, &port))
 892     em->uri_elts.is_ip4 = 0;
 893   else
 894     ECHO_FAIL ("Unable to process uri");
 895   em->uri_elts.port = clib_host_to_net_u16 (port);
 896   unformat_free (input);
 897 }
 898
 899 static void __clib_constructor
 900 vpp_echo_init ()
 901 {
 902   /* init memory before proto register themselves */
 903   echo_main_t *em = &echo_main;
 904   clib_mem_init_thread_safe (0, 256 << 20);
 905   clib_memset (em, 0, sizeof (*em));
 906 }
 907
 908 int
 909 main (int argc, char **argv)
 910 {
 911   echo_main_t *em = &echo_main;
 912   fifo_segment_main_t *sm = &em->segment_main;
 913   char *app_name;
 914   u64 i;
 915   svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
 916   u32 rpc_queue_size = 64 << 10;
 917
 918   em->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
 919   clib_spinlock_init (&em->sid_vpp_handles_lock);
 920   em->shared_segment_handles = hash_create (0, sizeof (uword));
 921   clib_spinlock_init (&em->segment_handles_lock);
 922   em->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
 923   em->use_sock_api = 1;
 924   em->fifo_size = 64 << 10;
 925   em->n_clients = 1;
 926   em->n_connects = 1;
 927   em->n_sessions = 2;
 928   em->max_test_msg = 50;
 929   em->time_to_stop = 0;
 930   em->i_am_master = 1;
 931   em->n_rx_threads = 4;
 932   em->test_return_packets = RETURN_PACKETS_NOTEST;
 933   em->timing.start_event = ECHO_EVT_FIRST_QCONNECT;
 934   em->timing.end_event = ECHO_EVT_LAST_BYTE;
 935   em->bytes_to_receive = ~0;    /* defaulted when we know if server/client */
 936   em->bytes_to_send = ~0;       /* defaulted when we know if server/client */
 937   em->rx_buf_size = 1 << 20;
 938   em->tx_buf_size = 1 << 20;
 939   em->data_source = ECHO_INVALID_DATA_SOURCE;
 940   em->uri = format (0, "%s%c", "tcp://0.0.0.0/1234", 0);
 941   echo_set_each_proto_defaults_before_opts (em);
 942   echo_process_opts (argc, argv);
 943   echo_process_uri (em);
 944   em->proto_cb_vft = em->available_proto_cb_vft[em->uri_elts.transport_proto];
 945   if (!em->proto_cb_vft)
 946     {
 947       ECHO_FAIL ("Protocol %U is not supported",
 948                  format_transport_proto, em->uri_elts.transport_proto);
 949       exit (1);
 950     }
 951   if (em->proto_cb_vft->set_defaults_after_opts_cb)
 952     em->proto_cb_vft->set_defaults_after_opts_cb ();
 953
 954   vec_validate (em->data_thread_handles, em->n_rx_threads);
 955   vec_validate (em->data_thread_args, em->n_clients);
 956   for (i = 0; i < em->n_clients; i++)
 957     em->data_thread_args[i] = SESSION_INVALID_INDEX;
 958   clib_time_init (&em->clib_time);
 959   init_error_string_table ();
 960   fifo_segment_main_init (sm, HIGH_SEGMENT_BASEVA, 20);
 961   vec_validate (em->connect_test_data, em->tx_buf_size);
 962   for (i = 0; i < em->tx_buf_size; i++)
 963     em->connect_test_data[i] = i & 0xff;
 964
 965   /* *INDENT-OFF* */
 966   svm_msg_q_ring_cfg_t rc[1] = {
 967     {rpc_queue_size, sizeof (echo_rpc_msg_t), 0},
 968   };
 969   /* *INDENT-ON* */
 970   cfg->consumer_pid = getpid ();
 971   cfg->n_rings = 1;
 972   cfg->q_nitems = rpc_queue_size;
 973   cfg->ring_cfgs = rc;
 974   em->rpc_msq_queue = svm_msg_q_alloc (cfg);
 975
 976   signal (SIGINT, stop_signal);
 977   signal (SIGQUIT, stop_signal);
 978   signal (SIGTERM, stop_signal);
 979   echo_api_hookup (em);
 980
 981   app_name = em->i_am_master ? "echo_server" : "echo_client";
 982   if (connect_to_vpp (app_name))
 983     {
 984       svm_region_exit ();
 985       ECHO_FAIL ("Couldn't connect to vpe, exiting...\n");
 986       exit (1);
 987     }
 988
 989   echo_session_prealloc (em);
 990   echo_notify_event (em, ECHO_EVT_START);
 991
 992   echo_send_attach (em);
 993   if (wait_for_state_change (em, STATE_ATTACHED, TIMEOUT))
 994     {
 995       ECHO_FAIL ("Couldn't attach to vpp, did you run <session enable> ?\n");
 996       exit (1);
 997     }
 998   if (pthread_create (&em->mq_thread_handle,
 999                       NULL /*attr */ , echo_mq_thread_fn, 0))
1000     {
1001       ECHO_FAIL ("pthread create errored\n");
1002       exit (1);
1003     }
1004   for (i = 0; i < em->n_rx_threads; i++)
1005     if (pthread_create (&em->data_thread_handles[i],
1006                         NULL /*attr */ , echo_data_thread_fn, (void *) i))
1007       {
1008         ECHO_FAIL ("pthread create errored\n");
1009         exit (1);
1010       }
1011   if (em->i_am_master)
1012     server_run (em);
1013   else
1014     clients_run (em);
1015   echo_notify_event (em, ECHO_EVT_EXIT);
1016   if (em->output_json)
1017     print_global_json_stats (em);
1018   else
1019     print_global_stats (em);
1020   echo_free_sessions (em);
1021   echo_assert_test_suceeded (em);
1022   echo_send_detach (em);
1023   if (wait_for_state_change (em, STATE_DETACHED, TIMEOUT))
1024     {
1025       ECHO_FAIL ("ECHO-ERROR: Couldn't detach from vpp, exiting...\n");
1026       exit (1);
1027     }
1028   int *rv;
1029   pthread_join (em->mq_thread_handle, (void **) &rv);
1030   if (rv)
1031     {
1032       ECHO_FAIL ("mq pthread errored %d", rv);
1033       exit (1);
1034     }
1035   if (em->use_sock_api)
1036     vl_socket_client_disconnect ();
1037   else
1038     vl_client_disconnect_from_vlib ();
1039   ECHO_LOG (0, "Test complete !\n");
1040   exit (em->has_failed);
1041 }
1042
1043 /*
1044  * fd.io coding-style-patch-verification: ON
1045  *
1046  * Local Variables:
1047  * eval: (c-set-style "gnu")
1048  * End:
1049  */