src/plugins/hs_apps/echo_server.c

   1 /*
   2 * Copyright (c) 2017-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 <vnet/vnet.h>
  17 #include <vlibmemory/api.h>
  18 #include <vnet/session/application.h>
  19 #include <vnet/session/application_interface.h>
  20 #include <vnet/session/session.h>
  21
  22 #define ECHO_SERVER_DBG (0)
  23 #define DBG(_fmt, _args...)                     \
  24     if (ECHO_SERVER_DBG)                                \
  25       clib_warning (_fmt, ##_args)
  26
  27 typedef struct
  28 {
  29   /*
  30    * Server app parameters
  31    */
  32   svm_msg_q_t **vpp_queue;
  33   svm_queue_t *vl_input_queue;  /**< Sever's event queue */
  34
  35   u32 app_index;                /**< Server app index */
  36   u32 my_client_index;          /**< API client handle */
  37   u32 node_index;               /**< process node index for event scheduling */
  38
  39   /*
  40    * Config params
  41    */
  42   u8 no_echo;                   /**< Don't echo traffic */
  43   u32 fifo_size;                /**< Fifo size */
  44   u32 rcv_buffer_size;          /**< Rcv buffer size */
  45   u32 prealloc_fifos;           /**< Preallocate fifos */
  46   u32 private_segment_count;    /**< Number of private segments  */
  47   u32 private_segment_size;     /**< Size of private segments  */
  48   char *server_uri;             /**< Server URI */
  49   u32 tls_engine;               /**< TLS engine: mbedtls/openssl */
  50   u8 is_dgram;                  /**< set if transport is dgram */
  51   /*
  52    * Test state
  53    */
  54   u8 **rx_buf;                  /**< Per-thread RX buffer */
  55   u64 byte_index;
  56   u32 **rx_retries;
  57   u8 transport_proto;
  58   u64 listener_handle;          /**< Session handle of the root listener */
  59
  60   vlib_main_t *vlib_main;
  61 } echo_server_main_t;
  62
  63 echo_server_main_t echo_server_main;
  64
  65 int
  66 quic_echo_server_qsession_accept_callback (session_t * s)
  67 {
  68   DBG ("QSession %u accept w/opaque %d", s->session_index, s->opaque);
  69   return 0;
  70 }
  71
  72 int
  73 quic_echo_server_session_accept_callback (session_t * s)
  74 {
  75   echo_server_main_t *esm = &echo_server_main;
  76   if (s->listener_handle == esm->listener_handle)
  77     return quic_echo_server_qsession_accept_callback (s);
  78   DBG ("SSESSION %u accept w/opaque %d", s->session_index, s->opaque);
  79
  80   esm->vpp_queue[s->thread_index] =
  81     session_main_get_vpp_event_queue (s->thread_index);
  82   s->session_state = SESSION_STATE_READY;
  83   esm->byte_index = 0;
  84   ASSERT (vec_len (esm->rx_retries) > s->thread_index);
  85   vec_validate (esm->rx_retries[s->thread_index], s->session_index);
  86   esm->rx_retries[s->thread_index][s->session_index] = 0;
  87   return 0;
  88 }
  89
  90 int
  91 echo_server_session_accept_callback (session_t * s)
  92 {
  93   echo_server_main_t *esm = &echo_server_main;
  94   esm->vpp_queue[s->thread_index] =
  95     session_main_get_vpp_event_queue (s->thread_index);
  96   s->session_state = SESSION_STATE_READY;
  97   esm->byte_index = 0;
  98   ASSERT (vec_len (esm->rx_retries) > s->thread_index);
  99   vec_validate (esm->rx_retries[s->thread_index], s->session_index);
 100   esm->rx_retries[s->thread_index][s->session_index] = 0;
 101   return 0;
 102 }
 103
 104 void
 105 echo_server_session_disconnect_callback (session_t * s)
 106 {
 107   echo_server_main_t *esm = &echo_server_main;
 108   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
 109
 110   a->handle = session_handle (s);
 111   a->app_index = esm->app_index;
 112   vnet_disconnect_session (a);
 113 }
 114
 115 void
 116 echo_server_session_reset_callback (session_t * s)
 117 {
 118   echo_server_main_t *esm = &echo_server_main;
 119   vnet_disconnect_args_t _a = { 0 }, *a = &_a;
 120   clib_warning ("Reset session %U", format_session, s, 2);
 121   a->handle = session_handle (s);
 122   a->app_index = esm->app_index;
 123   vnet_disconnect_session (a);
 124 }
 125
 126 int
 127 echo_server_session_connected_callback (u32 app_index, u32 api_context,
 128                                         session_t * s, session_error_t err)
 129 {
 130   clib_warning ("called...");
 131   return -1;
 132 }
 133
 134 int
 135 echo_server_add_segment_callback (u32 client_index, u64 segment_handle)
 136 {
 137   /* New heaps may be added */
 138   return 0;
 139 }
 140
 141 int
 142 echo_server_redirect_connect_callback (u32 client_index, void *mp)
 143 {
 144   clib_warning ("called...");
 145   return -1;
 146 }
 147
 148 void
 149 test_bytes (echo_server_main_t * esm, int actual_transfer)
 150 {
 151   int i;
 152   u32 my_thread_id = vlib_get_thread_index ();
 153
 154   for (i = 0; i < actual_transfer; i++)
 155     {
 156       if (esm->rx_buf[my_thread_id][i] != ((esm->byte_index + i) & 0xff))
 157         {
 158           clib_warning ("at %lld expected %d got %d", esm->byte_index + i,
 159                         (esm->byte_index + i) & 0xff,
 160                         esm->rx_buf[my_thread_id][i]);
 161         }
 162     }
 163   esm->byte_index += actual_transfer;
 164 }
 165
 166 /*
 167  * If no-echo, just drop the data and be done with it.
 168  */
 169 int
 170 echo_server_builtin_server_rx_callback_no_echo (session_t * s)
 171 {
 172   svm_fifo_t *rx_fifo = s->rx_fifo;
 173   svm_fifo_dequeue_drop (rx_fifo, svm_fifo_max_dequeue_cons (rx_fifo));
 174   return 0;
 175 }
 176
 177 int
 178 echo_server_rx_callback (session_t * s)
 179 {
 180   u32 n_written, max_dequeue, max_enqueue, max_transfer;
 181   int actual_transfer;
 182   svm_fifo_t *tx_fifo, *rx_fifo;
 183   echo_server_main_t *esm = &echo_server_main;
 184   u32 thread_index = vlib_get_thread_index ();
 185   app_session_transport_t at;
 186
 187   ASSERT (s->thread_index == thread_index);
 188
 189   rx_fifo = s->rx_fifo;
 190   tx_fifo = s->tx_fifo;
 191
 192   ASSERT (rx_fifo->master_thread_index == thread_index);
 193   ASSERT (tx_fifo->master_thread_index == thread_index);
 194
 195   max_enqueue = svm_fifo_max_enqueue_prod (tx_fifo);
 196   if (!esm->is_dgram)
 197     {
 198       max_dequeue = svm_fifo_max_dequeue_cons (rx_fifo);
 199     }
 200   else
 201     {
 202       session_dgram_pre_hdr_t ph;
 203       svm_fifo_peek (rx_fifo, 0, sizeof (ph), (u8 *) & ph);
 204       max_dequeue = ph.data_length - ph.data_offset;
 205       if (!esm->vpp_queue[s->thread_index])
 206         {
 207           svm_msg_q_t *mq;
 208           mq = session_main_get_vpp_event_queue (s->thread_index);
 209           esm->vpp_queue[s->thread_index] = mq;
 210         }
 211       max_enqueue -= sizeof (session_dgram_hdr_t);
 212     }
 213
 214   if (PREDICT_FALSE (max_dequeue == 0))
 215     return 0;
 216
 217   /* Number of bytes we're going to copy */
 218   max_transfer = clib_min (max_dequeue, max_enqueue);
 219
 220   /* No space in tx fifo */
 221   if (PREDICT_FALSE (max_transfer == 0))
 222     {
 223       /* XXX timeout for session that are stuck */
 224
 225     rx_event:
 226       /* Program self-tap to retry */
 227       if (svm_fifo_set_event (rx_fifo))
 228         {
 229           if (session_send_io_evt_to_thread (rx_fifo,
 230                                              SESSION_IO_EVT_BUILTIN_RX))
 231             clib_warning ("failed to enqueue self-tap");
 232
 233           vec_validate (esm->rx_retries[s->thread_index], s->session_index);
 234           if (esm->rx_retries[thread_index][s->session_index] == 500000)
 235             {
 236               clib_warning ("session stuck: %U", format_session, s, 2);
 237             }
 238           if (esm->rx_retries[thread_index][s->session_index] < 500001)
 239             esm->rx_retries[thread_index][s->session_index]++;
 240         }
 241
 242       return 0;
 243     }
 244
 245   vec_validate (esm->rx_buf[thread_index], max_transfer);
 246   if (!esm->is_dgram)
 247     {
 248       actual_transfer = app_recv_stream_raw (rx_fifo,
 249                                              esm->rx_buf[thread_index],
 250                                              max_transfer,
 251                                              0 /* don't clear event */ ,
 252                                              0 /* peek */ );
 253     }
 254   else
 255     {
 256       actual_transfer = app_recv_dgram_raw (rx_fifo,
 257                                             esm->rx_buf[thread_index],
 258                                             max_transfer, &at,
 259                                             0 /* don't clear event */ ,
 260                                             0 /* peek */ );
 261     }
 262   ASSERT (actual_transfer == max_transfer);
 263   /* test_bytes (esm, actual_transfer); */
 264
 265   /*
 266    * Echo back
 267    */
 268
 269   if (!esm->is_dgram)
 270     {
 271       n_written = app_send_stream_raw (tx_fifo,
 272                                        esm->vpp_queue[thread_index],
 273                                        esm->rx_buf[thread_index],
 274                                        actual_transfer, SESSION_IO_EVT_TX,
 275                                        1 /* do_evt */ , 0);
 276     }
 277   else
 278     {
 279       n_written = app_send_dgram_raw (tx_fifo, &at,
 280                                       esm->vpp_queue[s->thread_index],
 281                                       esm->rx_buf[thread_index],
 282                                       actual_transfer, SESSION_IO_EVT_TX,
 283                                       1 /* do_evt */ , 0);
 284     }
 285
 286   if (n_written != max_transfer)
 287     clib_warning ("short trout! written %u read %u", n_written, max_transfer);
 288
 289   if (PREDICT_FALSE (svm_fifo_max_dequeue_cons (rx_fifo)))
 290     goto rx_event;
 291
 292   return 0;
 293 }
 294
 295 static session_cb_vft_t echo_server_session_cb_vft = {
 296   .session_accept_callback = echo_server_session_accept_callback,
 297   .session_disconnect_callback = echo_server_session_disconnect_callback,
 298   .session_connected_callback = echo_server_session_connected_callback,
 299   .add_segment_callback = echo_server_add_segment_callback,
 300   .builtin_app_rx_callback = echo_server_rx_callback,
 301   .session_reset_callback = echo_server_session_reset_callback
 302 };
 303
 304 static int
 305 echo_server_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
 306 {
 307   vnet_app_add_tls_cert_args_t _a_cert, *a_cert = &_a_cert;
 308   vnet_app_add_tls_key_args_t _a_key, *a_key = &_a_key;
 309   echo_server_main_t *esm = &echo_server_main;
 310   vnet_app_attach_args_t _a, *a = &_a;
 311   u64 options[APP_OPTIONS_N_OPTIONS];
 312   u32 segment_size = 512 << 20;
 313
 314   clib_memset (a, 0, sizeof (*a));
 315   clib_memset (options, 0, sizeof (options));
 316
 317   if (esm->no_echo)
 318     echo_server_session_cb_vft.builtin_app_rx_callback =
 319       echo_server_builtin_server_rx_callback_no_echo;
 320   else
 321     echo_server_session_cb_vft.builtin_app_rx_callback =
 322       echo_server_rx_callback;
 323   if (esm->transport_proto == TRANSPORT_PROTO_QUIC)
 324     echo_server_session_cb_vft.session_accept_callback =
 325       quic_echo_server_session_accept_callback;
 326
 327   if (esm->private_segment_size)
 328     segment_size = esm->private_segment_size;
 329
 330   a->api_client_index = ~0;
 331   a->name = format (0, "echo_server");
 332   a->session_cb_vft = &echo_server_session_cb_vft;
 333   a->options = options;
 334   a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
 335   a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = segment_size;
 336   a->options[APP_OPTIONS_RX_FIFO_SIZE] = esm->fifo_size;
 337   a->options[APP_OPTIONS_TX_FIFO_SIZE] = esm->fifo_size;
 338   a->options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = esm->private_segment_count;
 339   a->options[APP_OPTIONS_TLS_ENGINE] = esm->tls_engine;
 340   a->options[APP_OPTIONS_PCT_FIRST_ALLOC] = 100;
 341   a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
 342     esm->prealloc_fifos ? esm->prealloc_fifos : 1;
 343
 344   a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
 345   if (appns_id)
 346     {
 347       a->namespace_id = appns_id;
 348       a->options[APP_OPTIONS_FLAGS] |= appns_flags;
 349       a->options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
 350     }
 351
 352   if (vnet_application_attach (a))
 353     {
 354       clib_warning ("failed to attach server");
 355       return -1;
 356     }
 357   esm->app_index = a->app_index;
 358   vec_free (a->name);
 359
 360   clib_memset (a_cert, 0, sizeof (*a_cert));
 361   a_cert->app_index = a->app_index;
 362   vec_validate (a_cert->cert, test_srv_crt_rsa_len);
 363   clib_memcpy_fast (a_cert->cert, test_srv_crt_rsa, test_srv_crt_rsa_len);
 364   vnet_app_add_tls_cert (a_cert);
 365
 366   clib_memset (a_key, 0, sizeof (*a_key));
 367   a_key->app_index = a->app_index;
 368   vec_validate (a_key->key, test_srv_key_rsa_len);
 369   clib_memcpy_fast (a_key->key, test_srv_key_rsa, test_srv_key_rsa_len);
 370   vnet_app_add_tls_key (a_key);
 371   return 0;
 372 }
 373
 374 static int
 375 echo_server_detach (void)
 376 {
 377   echo_server_main_t *esm = &echo_server_main;
 378   vnet_app_detach_args_t _da, *da = &_da;
 379   int rv;
 380
 381   da->app_index = esm->app_index;
 382   rv = vnet_application_detach (da);
 383   esm->app_index = ~0;
 384   return rv;
 385 }
 386
 387 static int
 388 echo_server_listen ()
 389 {
 390   i32 rv;
 391   echo_server_main_t *esm = &echo_server_main;
 392   vnet_listen_args_t _args = {
 393     .app_index = esm->app_index,
 394     .sep_ext = {
 395                 .app_wrk_index = 0,
 396                 }
 397   }, *args = &_args;
 398
 399   if ((rv = parse_uri (esm->server_uri, &args->sep_ext)))
 400     {
 401       return -1;
 402     }
 403
 404   if (args->sep_ext.transport_proto == TRANSPORT_PROTO_UDP)
 405     {
 406       args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
 407     }
 408
 409   rv = vnet_listen (args);
 410   esm->listener_handle = args->handle;
 411   return rv;
 412 }
 413
 414 static int
 415 echo_server_create (vlib_main_t * vm, u8 * appns_id, u64 appns_flags,
 416                     u64 appns_secret)
 417 {
 418   echo_server_main_t *esm = &echo_server_main;
 419   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 420   u32 num_threads;
 421   int i;
 422
 423   num_threads = 1 /* main thread */  + vtm->n_threads;
 424   vec_validate (echo_server_main.vpp_queue, num_threads - 1);
 425   vec_validate (esm->rx_buf, num_threads - 1);
 426   vec_validate (esm->rx_retries, num_threads - 1);
 427   for (i = 0; i < vec_len (esm->rx_retries); i++)
 428     vec_validate (esm->rx_retries[i],
 429                   pool_elts (session_main.wrk[i].sessions));
 430   esm->rcv_buffer_size = clib_max (esm->rcv_buffer_size, esm->fifo_size);
 431   for (i = 0; i < num_threads; i++)
 432     vec_validate (esm->rx_buf[i], esm->rcv_buffer_size);
 433
 434   if (echo_server_attach (appns_id, appns_flags, appns_secret))
 435     {
 436       clib_warning ("failed to attach server");
 437       return -1;
 438     }
 439   if (echo_server_listen ())
 440     {
 441       clib_warning ("failed to start listening");
 442       if (echo_server_detach ())
 443         clib_warning ("failed to detach");
 444       return -1;
 445     }
 446   return 0;
 447 }
 448
 449 static clib_error_t *
 450 echo_server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
 451                                vlib_cli_command_t * cmd)
 452 {
 453   echo_server_main_t *esm = &echo_server_main;
 454   u8 server_uri_set = 0, *appns_id = 0;
 455   u64 tmp, appns_flags = 0, appns_secret = 0;
 456   char *default_uri = "tcp://0.0.0.0/1234";
 457   int rv, is_stop = 0;
 458   session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
 459
 460   esm->no_echo = 0;
 461   esm->fifo_size = 64 << 10;
 462   esm->rcv_buffer_size = 128 << 10;
 463   esm->prealloc_fifos = 0;
 464   esm->private_segment_count = 0;
 465   esm->private_segment_size = 0;
 466   esm->tls_engine = CRYPTO_ENGINE_OPENSSL;
 467   vec_free (esm->server_uri);
 468
 469   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 470     {
 471       if (unformat (input, "uri %s", &esm->server_uri))
 472         server_uri_set = 1;
 473       else if (unformat (input, "no-echo"))
 474         esm->no_echo = 1;
 475       else if (unformat (input, "fifo-size %d", &esm->fifo_size))
 476         esm->fifo_size <<= 10;
 477       else if (unformat (input, "rcv-buf-size %d", &esm->rcv_buffer_size))
 478         ;
 479       else if (unformat (input, "prealloc-fifos %d", &esm->prealloc_fifos))
 480         ;
 481       else if (unformat (input, "private-segment-count %d",
 482                          &esm->private_segment_count))
 483         ;
 484       else if (unformat (input, "private-segment-size %U",
 485                          unformat_memory_size, &tmp))
 486         {
 487           if (tmp >= 0x100000000ULL)
 488             return clib_error_return
 489               (0, "private segment size %lld (%llu) too large", tmp, tmp);
 490           esm->private_segment_size = tmp;
 491         }
 492       else if (unformat (input, "appns %_%v%_", &appns_id))
 493         ;
 494       else if (unformat (input, "all-scope"))
 495         appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
 496                         | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
 497       else if (unformat (input, "local-scope"))
 498         appns_flags |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
 499       else if (unformat (input, "global-scope"))
 500         appns_flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 501       else if (unformat (input, "secret %lu", &appns_secret))
 502         ;
 503       else if (unformat (input, "stop"))
 504         is_stop = 1;
 505       else if (unformat (input, "tls-engine %d", &esm->tls_engine))
 506         ;
 507       else
 508         return clib_error_return (0, "failed: unknown input `%U'",
 509                                   format_unformat_error, input);
 510     }
 511
 512   if (is_stop)
 513     {
 514       if (esm->app_index == (u32) ~ 0)
 515         {
 516           clib_warning ("server not running");
 517           return clib_error_return (0, "failed: server not running");
 518         }
 519       rv = echo_server_detach ();
 520       if (rv)
 521         {
 522           clib_warning ("failed: detach");
 523           return clib_error_return (0, "failed: server detach %d", rv);
 524         }
 525       return 0;
 526     }
 527
 528   vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
 529
 530   if (!server_uri_set)
 531     {
 532       clib_warning ("No uri provided! Using default: %s", default_uri);
 533       esm->server_uri = (char *) format (0, "%s%c", default_uri, 0);
 534     }
 535
 536   if ((rv = parse_uri ((char *) esm->server_uri, &sep)))
 537     return clib_error_return (0, "Uri parse error: %d", rv);
 538   esm->transport_proto = sep.transport_proto;
 539   esm->is_dgram = (sep.transport_proto == TRANSPORT_PROTO_UDP);
 540
 541   rv = echo_server_create (vm, appns_id, appns_flags, appns_secret);
 542   vec_free (appns_id);
 543   if (rv)
 544     {
 545       vec_free (esm->server_uri);
 546       return clib_error_return (0, "failed: server_create returned %d", rv);
 547     }
 548
 549   return 0;
 550 }
 551
 552 /* *INDENT-OFF* */
 553 VLIB_CLI_COMMAND (echo_server_create_command, static) =
 554 {
 555   .path = "test echo server",
 556   .short_help = "test echo server proto <proto> [no echo][fifo-size <mbytes>]"
 557       "[rcv-buf-size <bytes>][prealloc-fifos <count>]"
 558       "[private-segment-count <count>][private-segment-size <bytes[m|g]>]"
 559       "[uri <tcp://ip/port>]",
 560   .function = echo_server_create_command_fn,
 561 };
 562 /* *INDENT-ON* */
 563
 564 clib_error_t *
 565 echo_server_main_init (vlib_main_t * vm)
 566 {
 567   echo_server_main_t *esm = &echo_server_main;
 568   esm->my_client_index = ~0;
 569   return 0;
 570 }
 571
 572 VLIB_INIT_FUNCTION (echo_server_main_init);
 573
 574 /*
 575 * fd.io coding-style-patch-verification: ON
 576 *
 577 * Local Variables:
 578 * eval: (c-set-style "gnu")
 579 * End:
 580 */