src/vnet/tcp/builtin_server.c

   1 /*
   2 * Copyright (c) 2015-2017 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
  21 typedef struct
  22 {
  23   /*
  24    * Server app parameters
  25    */
  26   svm_queue_t **vpp_queue;
  27   svm_queue_t *vl_input_queue;  /**< Sever's event queue */
  28
  29   u32 app_index;                /**< Server app index */
  30   u32 my_client_index;          /**< API client handle */
  31   u32 node_index;               /**< process node index for evnt scheduling */
  32
  33   /*
  34    * Config params
  35    */
  36   u8 no_echo;                   /**< Don't echo traffic */
  37   u32 fifo_size;                        /**< Fifo size */
  38   u32 rcv_buffer_size;          /**< Rcv buffer size */
  39   u32 prealloc_fifos;           /**< Preallocate fifos */
  40   u32 private_segment_count;    /**< Number of private segments  */
  41   u32 private_segment_size;     /**< Size of private segments  */
  42   char *server_uri;             /**< Server URI */
  43
  44   /*
  45    * Test state
  46    */
  47   u8 **rx_buf;                  /**< Per-thread RX buffer */
  48   u64 byte_index;
  49   u32 **rx_retries;
  50
  51   vlib_main_t *vlib_main;
  52 } builtin_server_main_t;
  53
  54 builtin_server_main_t builtin_server_main;
  55
  56 int
  57 builtin_session_accept_callback (stream_session_t * s)
  58 {
  59   builtin_server_main_t *bsm = &builtin_server_main;
  60
  61   bsm->vpp_queue[s->thread_index] =
  62     session_manager_get_vpp_event_queue (s->thread_index);
  63   s->session_state = SESSION_STATE_READY;
  64   bsm->byte_index = 0;
  65   vec_validate (bsm->rx_retries[s->thread_index], s->session_index);
  66   bsm->rx_retries[s->thread_index][s->session_index] = 0;
  67   return 0;
  68 }
  69
  70 void
  71 builtin_session_disconnect_callback (stream_session_t * s)
  72 {
  73   builtin_server_main_t *bsm = &builtin_server_main;
  74   vnet_disconnect_args_t _a, *a = &_a;
  75
  76   a->handle = session_handle (s);
  77   a->app_index = bsm->app_index;
  78   vnet_disconnect_session (a);
  79 }
  80
  81 void
  82 builtin_session_reset_callback (stream_session_t * s)
  83 {
  84   clib_warning ("Reset session %U", format_stream_session, s, 2);
  85   stream_session_cleanup (s);
  86 }
  87
  88
  89 int
  90 builtin_session_connected_callback (u32 app_index, u32 api_context,
  91                                     stream_session_t * s, u8 is_fail)
  92 {
  93   clib_warning ("called...");
  94   return -1;
  95 }
  96
  97 int
  98 builtin_add_segment_callback (u32 client_index, const ssvm_private_t * sp)
  99 {
 100   clib_warning ("called...");
 101   return -1;
 102 }
 103
 104 int
 105 builtin_redirect_connect_callback (u32 client_index, void *mp)
 106 {
 107   clib_warning ("called...");
 108   return -1;
 109 }
 110
 111 void
 112 test_bytes (builtin_server_main_t * bsm, int actual_transfer)
 113 {
 114   int i;
 115   u32 my_thread_id = vlib_get_thread_index ();
 116
 117   for (i = 0; i < actual_transfer; i++)
 118     {
 119       if (bsm->rx_buf[my_thread_id][i] != ((bsm->byte_index + i) & 0xff))
 120         {
 121           clib_warning ("at %lld expected %d got %d", bsm->byte_index + i,
 122                         (bsm->byte_index + i) & 0xff,
 123                         bsm->rx_buf[my_thread_id][i]);
 124         }
 125     }
 126   bsm->byte_index += actual_transfer;
 127 }
 128
 129 /*
 130  * If no-echo, just read the data and be done with it
 131  */
 132 int
 133 builtin_server_rx_callback_no_echo (stream_session_t * s)
 134 {
 135   builtin_server_main_t *bsm = &builtin_server_main;
 136   u32 my_thread_id = vlib_get_thread_index ();
 137   int actual_transfer;
 138   svm_fifo_t *rx_fifo;
 139
 140   rx_fifo = s->server_rx_fifo;
 141
 142   do
 143     {
 144       actual_transfer =
 145         svm_fifo_dequeue_nowait (rx_fifo, bsm->rcv_buffer_size,
 146                                  bsm->rx_buf[my_thread_id]);
 147     }
 148   while (actual_transfer > 0);
 149   return 0;
 150 }
 151
 152 int
 153 builtin_server_rx_callback (stream_session_t * s)
 154 {
 155   u32 n_written, max_dequeue, max_enqueue, max_transfer;
 156   int actual_transfer;
 157   svm_fifo_t *tx_fifo, *rx_fifo;
 158   builtin_server_main_t *bsm = &builtin_server_main;
 159   session_fifo_event_t evt;
 160   u32 thread_index = vlib_get_thread_index ();
 161
 162   ASSERT (s->thread_index == thread_index);
 163
 164   rx_fifo = s->server_rx_fifo;
 165   tx_fifo = s->server_tx_fifo;
 166
 167   ASSERT (rx_fifo->master_thread_index == thread_index);
 168   ASSERT (tx_fifo->master_thread_index == thread_index);
 169
 170   max_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
 171   max_enqueue = svm_fifo_max_enqueue (s->server_tx_fifo);
 172
 173   if (PREDICT_FALSE (max_dequeue == 0))
 174     return 0;
 175
 176   /* Number of bytes we're going to copy */
 177   max_transfer = (max_dequeue < max_enqueue) ? max_dequeue : max_enqueue;
 178
 179   /* No space in tx fifo */
 180   if (PREDICT_FALSE (max_transfer == 0))
 181     {
 182       /* XXX timeout for session that are stuck */
 183
 184     rx_event:
 185       /* Program self-tap to retry */
 186       if (svm_fifo_set_event (rx_fifo))
 187         {
 188           svm_queue_t *q;
 189           evt.fifo = rx_fifo;
 190           evt.event_type = FIFO_EVENT_BUILTIN_RX;
 191
 192           q = bsm->vpp_queue[thread_index];
 193           if (PREDICT_FALSE (q->cursize == q->maxsize))
 194             clib_warning ("out of event queue space");
 195           else if (svm_queue_add (q, (u8 *) & evt, 0))
 196             clib_warning ("failed to enqueue self-tap");
 197
 198           if (bsm->rx_retries[thread_index][s->session_index] == 500000)
 199             {
 200               clib_warning ("session stuck: %U", format_stream_session, s, 2);
 201             }
 202           if (bsm->rx_retries[thread_index][s->session_index] < 500001)
 203             bsm->rx_retries[thread_index][s->session_index]++;
 204         }
 205
 206       return 0;
 207     }
 208
 209   _vec_len (bsm->rx_buf[thread_index]) = max_transfer;
 210
 211   actual_transfer = svm_fifo_dequeue_nowait (rx_fifo, max_transfer,
 212                                              bsm->rx_buf[thread_index]);
 213   ASSERT (actual_transfer == max_transfer);
 214
 215 //  test_bytes (bsm, actual_transfer);
 216
 217   /*
 218    * Echo back
 219    */
 220
 221   n_written = svm_fifo_enqueue_nowait (tx_fifo, actual_transfer,
 222                                        bsm->rx_buf[thread_index]);
 223
 224   if (n_written != max_transfer)
 225     clib_warning ("short trout!");
 226
 227   if (svm_fifo_set_event (tx_fifo))
 228     {
 229       /* Fabricate TX event, send to vpp */
 230       evt.fifo = tx_fifo;
 231       evt.event_type = FIFO_EVENT_APP_TX;
 232
 233       if (svm_queue_add (bsm->vpp_queue[s->thread_index],
 234                          (u8 *) & evt, 0 /* do wait for mutex */ ))
 235         clib_warning ("failed to enqueue tx evt");
 236     }
 237
 238   if (PREDICT_FALSE (n_written < max_dequeue))
 239     goto rx_event;
 240
 241   return 0;
 242 }
 243
 244 static session_cb_vft_t builtin_session_cb_vft = {
 245   .session_accept_callback = builtin_session_accept_callback,
 246   .session_disconnect_callback = builtin_session_disconnect_callback,
 247   .session_connected_callback = builtin_session_connected_callback,
 248   .add_segment_callback = builtin_add_segment_callback,
 249   .redirect_connect_callback = builtin_redirect_connect_callback,
 250   .builtin_server_rx_callback = builtin_server_rx_callback,
 251   .session_reset_callback = builtin_session_reset_callback
 252 };
 253
 254 /* Abuse VPP's input queue */
 255 static int
 256 create_api_loopback (vlib_main_t * vm)
 257 {
 258   builtin_server_main_t *bsm = &builtin_server_main;
 259   api_main_t *am = &api_main;
 260   vl_shmem_hdr_t *shmem_hdr;
 261
 262   shmem_hdr = am->shmem_hdr;
 263   bsm->vl_input_queue = shmem_hdr->vl_input_queue;
 264   bsm->my_client_index =
 265     vl_api_memclnt_create_internal ("tcp_test_server", bsm->vl_input_queue);
 266   return 0;
 267 }
 268
 269 static int
 270 server_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
 271 {
 272   builtin_server_main_t *bsm = &builtin_server_main;
 273   u64 options[APP_OPTIONS_N_OPTIONS];
 274   vnet_app_attach_args_t _a, *a = &_a;
 275   u32 segment_size = 512 << 20;
 276
 277   memset (a, 0, sizeof (*a));
 278   memset (options, 0, sizeof (options));
 279
 280   if (bsm->no_echo)
 281     builtin_session_cb_vft.builtin_server_rx_callback =
 282       builtin_server_rx_callback_no_echo;
 283   else
 284     builtin_session_cb_vft.builtin_server_rx_callback =
 285       builtin_server_rx_callback;
 286
 287   if (bsm->private_segment_size)
 288     segment_size = bsm->private_segment_size;
 289
 290   a->api_client_index = bsm->my_client_index;
 291   a->session_cb_vft = &builtin_session_cb_vft;
 292   a->options = options;
 293   a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
 294   a->options[APP_OPTIONS_RX_FIFO_SIZE] = bsm->fifo_size;
 295   a->options[APP_OPTIONS_TX_FIFO_SIZE] = bsm->fifo_size;
 296   a->options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = bsm->private_segment_count;
 297   a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
 298     bsm->prealloc_fifos ? bsm->prealloc_fifos : 1;
 299
 300   a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
 301   if (appns_id)
 302     {
 303       a->namespace_id = appns_id;
 304       a->options[APP_OPTIONS_FLAGS] |= appns_flags;
 305       a->options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
 306     }
 307
 308   if (vnet_application_attach (a))
 309     {
 310       clib_warning ("failed to attach server");
 311       return -1;
 312     }
 313   bsm->app_index = a->app_index;
 314   return 0;
 315 }
 316
 317 static int
 318 server_listen ()
 319 {
 320   builtin_server_main_t *bsm = &builtin_server_main;
 321   vnet_bind_args_t _a, *a = &_a;
 322   memset (a, 0, sizeof (*a));
 323   a->app_index = bsm->app_index;
 324   a->uri = bsm->server_uri;
 325   return vnet_bind_uri (a);
 326 }
 327
 328 static int
 329 server_create (vlib_main_t * vm, u8 * appns_id, u64 appns_flags,
 330                u64 appns_secret)
 331 {
 332   builtin_server_main_t *bsm = &builtin_server_main;
 333   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 334   u32 num_threads;
 335   int i;
 336
 337   if (bsm->my_client_index == (u32) ~ 0)
 338     {
 339       if (create_api_loopback (vm))
 340         {
 341           clib_warning ("failed to create api loopback");
 342           return -1;
 343         }
 344     }
 345
 346   num_threads = 1 /* main thread */  + vtm->n_threads;
 347   vec_validate (builtin_server_main.vpp_queue, num_threads - 1);
 348   vec_validate (bsm->rx_buf, num_threads - 1);
 349   vec_validate (bsm->rx_retries, num_threads - 1);
 350
 351   for (i = 0; i < num_threads; i++)
 352     vec_validate (bsm->rx_buf[i], bsm->rcv_buffer_size);
 353
 354   if (server_attach (appns_id, appns_flags, appns_secret))
 355     {
 356       clib_warning ("failed to attach server");
 357       return -1;
 358     }
 359   if (server_listen ())
 360     {
 361       clib_warning ("failed to start listening");
 362       return -1;
 363     }
 364   return 0;
 365 }
 366
 367 static clib_error_t *
 368 server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
 369                           vlib_cli_command_t * cmd)
 370 {
 371   builtin_server_main_t *bsm = &builtin_server_main;
 372   u8 server_uri_set = 0, *appns_id = 0;
 373   u64 tmp, appns_flags = 0, appns_secret = 0;
 374   int rv;
 375
 376   bsm->no_echo = 0;
 377   bsm->fifo_size = 64 << 10;
 378   bsm->rcv_buffer_size = 128 << 10;
 379   bsm->prealloc_fifos = 0;
 380   bsm->private_segment_count = 0;
 381   bsm->private_segment_size = 0;
 382   vec_free (bsm->server_uri);
 383
 384   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 385     {
 386       if (unformat (input, "no-echo"))
 387         bsm->no_echo = 1;
 388       else if (unformat (input, "fifo-size %d", &bsm->fifo_size))
 389         bsm->fifo_size <<= 10;
 390       else if (unformat (input, "rcv-buf-size %d", &bsm->rcv_buffer_size))
 391         ;
 392       else if (unformat (input, "prealloc-fifos %d", &bsm->prealloc_fifos))
 393         ;
 394       else if (unformat (input, "private-segment-count %d",
 395                          &bsm->private_segment_count))
 396         ;
 397       else if (unformat (input, "private-segment-size %U",
 398                          unformat_memory_size, &tmp))
 399         {
 400           if (tmp >= 0x100000000ULL)
 401             return clib_error_return
 402               (0, "private segment size %lld (%llu) too large", tmp, tmp);
 403           bsm->private_segment_size = tmp;
 404         }
 405       else if (unformat (input, "uri %s", &bsm->server_uri))
 406         server_uri_set = 1;
 407       else if (unformat (input, "appns %_%v%_", &appns_id))
 408         ;
 409       else if (unformat (input, "all-scope"))
 410         appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
 411                         | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
 412       else if (unformat (input, "local-scope"))
 413         appns_flags |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
 414       else if (unformat (input, "global-scope"))
 415         appns_flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 416       else if (unformat (input, "secret %lu", &appns_secret))
 417         ;
 418       else
 419         return clib_error_return (0, "unknown input `%U'",
 420                                   format_unformat_error, input);
 421     }
 422
 423   vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
 424
 425   if (!server_uri_set)
 426     bsm->server_uri = (char *) format (0, "tcp://0.0.0.0/1234%c", 0);
 427
 428   rv = server_create (vm, appns_id, appns_flags, appns_secret);
 429   vec_free (appns_id);
 430   switch (rv)
 431     {
 432     case 0:
 433       break;
 434     default:
 435       return clib_error_return (0, "server_create returned %d", rv);
 436     }
 437
 438   return 0;
 439 }
 440
 441 /* *INDENT-OFF* */
 442 VLIB_CLI_COMMAND (server_create_command, static) =
 443 {
 444   .path = "test tcp server",
 445   .short_help = "test tcp server [no echo][fifo-size <mbytes>] "
 446       "[rcv-buf-size <bytes>][prealloc-fifos <count>]"
 447       "[private-segment-count <count>][private-segment-size <bytes[m|g]>]"
 448       "[uri <tcp://ip/port>]",
 449   .function = server_create_command_fn,
 450 };
 451 /* *INDENT-ON* */
 452
 453 clib_error_t *
 454 builtin_tcp_server_main_init (vlib_main_t * vm)
 455 {
 456   builtin_server_main_t *bsm = &builtin_server_main;
 457   bsm->my_client_index = ~0;
 458   return 0;
 459 }
 460
 461 VLIB_INIT_FUNCTION (builtin_tcp_server_main_init);
 462
 463 /*
 464 * fd.io coding-style-patch-verification: ON
 465 *
 466 * Local Variables:
 467 * eval: (c-set-style "gnu")
 468 * End:
 469 */