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