src/vnet/session/application.c

   1 /*
   2  * Copyright (c) 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/session/application.h>
  17 #include <vnet/session/application_interface.h>
  18 #include <vnet/session/session.h>
  19
  20 /**
  21  * Pool from which we allocate all applications
  22  */
  23 static application_t *app_pool;
  24
  25 /**
  26  * Hash table of apps by api client index
  27  */
  28 static uword *app_by_api_client_index;
  29
  30 /**
  31  * Default application event queue size
  32  */
  33 static u32 default_app_evt_queue_size = 128;
  34
  35 int
  36 application_api_queue_is_full (application_t * app)
  37 {
  38   unix_shared_memory_queue_t *q;
  39
  40   /* builtin servers are always OK */
  41   if (app->api_client_index == ~0)
  42     return 0;
  43
  44   q = vl_api_client_index_to_input_queue (app->api_client_index);
  45   if (!q)
  46     return 1;
  47
  48   if (q->cursize == q->maxsize)
  49     return 1;
  50   return 0;
  51 }
  52
  53 static void
  54 application_table_add (application_t * app)
  55 {
  56   hash_set (app_by_api_client_index, app->api_client_index, app->index);
  57 }
  58
  59 static void
  60 application_table_del (application_t * app)
  61 {
  62   hash_unset (app_by_api_client_index, app->api_client_index);
  63 }
  64
  65 application_t *
  66 application_lookup (u32 api_client_index)
  67 {
  68   uword *p;
  69   p = hash_get (app_by_api_client_index, api_client_index);
  70   if (p)
  71     return application_get (p[0]);
  72
  73   return 0;
  74 }
  75
  76 application_t *
  77 application_new ()
  78 {
  79   application_t *app;
  80   pool_get (app_pool, app);
  81   memset (app, 0, sizeof (*app));
  82   app->index = application_get_index (app);
  83   app->connects_seg_manager = ~0;
  84   app->first_segment_manager = ~0;
  85   if (CLIB_DEBUG > 1)
  86     clib_warning ("[%d] New app (%d)", getpid (), app->index);
  87   return app;
  88 }
  89
  90 void
  91 application_del (application_t * app)
  92 {
  93   segment_manager_t *sm;
  94   u64 handle;
  95   u32 index, *handles = 0;
  96   int i;
  97   vnet_unbind_args_t _a, *a = &_a;
  98
  99   /*
 100    * The app event queue allocated in first segment is cleared with
 101    * the segment manager. No need to explicitly free it.
 102    */
 103   if (CLIB_DEBUG > 1)
 104     clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
 105
 106   /*
 107    * Cleanup segment managers
 108    */
 109   if ((app->connects_seg_manager != (u32) ~ 0) &&
 110       (app->connects_seg_manager != app->first_segment_manager))
 111     {
 112       sm = segment_manager_get (app->connects_seg_manager);
 113       segment_manager_del (sm);
 114     }
 115
 116   /* *INDENT-OFF* */
 117   hash_foreach (handle, index, app->listeners_table,
 118   ({
 119     vec_add1 (handles, handle);
 120   }));
 121   /* *INDENT-ON* */
 122
 123   /* Actual listener cleanup */
 124   for (i = 0; i < vec_len (handles); i++)
 125     {
 126       a->app_index = app->index;
 127       a->handle = handles[i];
 128       /* seg manager is removed when unbind completes */
 129       vnet_unbind (a);
 130     }
 131
 132   if (app->first_segment_manager != ~0)
 133     {
 134       sm = segment_manager_get (app->first_segment_manager);
 135       segment_manager_first_segment_maybe_del (sm);
 136     }
 137
 138   application_table_del (app);
 139   pool_put (app_pool, app);
 140 }
 141
 142 static void
 143 application_verify_cb_fns (session_cb_vft_t * cb_fns)
 144 {
 145   if (cb_fns->session_accept_callback == 0)
 146     clib_warning ("No accept callback function provided");
 147   if (cb_fns->session_connected_callback == 0)
 148     clib_warning ("No session connected callback function provided");
 149   if (cb_fns->session_disconnect_callback == 0)
 150     clib_warning ("No session disconnect callback function provided");
 151   if (cb_fns->session_reset_callback == 0)
 152     clib_warning ("No session reset callback function provided");
 153 }
 154
 155 int
 156 application_init (application_t * app, u32 api_client_index, u64 * options,
 157                   session_cb_vft_t * cb_fns)
 158 {
 159   segment_manager_t *sm;
 160   segment_manager_properties_t *props;
 161   u32 app_evt_queue_size, first_seg_size;
 162   int rv;
 163
 164   app_evt_queue_size = options[APP_EVT_QUEUE_SIZE] > 0 ?
 165     options[APP_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
 166
 167   /* Setup segment manager */
 168   sm = segment_manager_new ();
 169   sm->app_index = app->index;
 170   props = &app->sm_properties;
 171   props->add_segment_size = options[SESSION_OPTIONS_ADD_SEGMENT_SIZE];
 172   props->rx_fifo_size = options[SESSION_OPTIONS_RX_FIFO_SIZE];
 173   props->tx_fifo_size = options[SESSION_OPTIONS_TX_FIFO_SIZE];
 174   props->add_segment = props->add_segment_size != 0;
 175   props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
 176   props->use_private_segment = options[APP_OPTIONS_FLAGS]
 177     & APP_OPTIONS_FLAGS_BUILTIN_APP;
 178   props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
 179   props->private_segment_size = options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE];
 180
 181   first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
 182   if ((rv = segment_manager_init (sm, props, first_seg_size)))
 183     return rv;
 184
 185   app->first_segment_manager = segment_manager_index (sm);
 186   app->api_client_index = api_client_index;
 187   app->flags = options[APP_OPTIONS_FLAGS];
 188   app->cb_fns = *cb_fns;
 189
 190   /* Allocate app event queue in the first shared-memory segment */
 191   app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
 192
 193   /* Check that the obvious things are properly set up */
 194   application_verify_cb_fns (cb_fns);
 195
 196   /* Add app to lookup by api_client_index table */
 197   application_table_add (app);
 198
 199   return 0;
 200 }
 201
 202 application_t *
 203 application_get (u32 index)
 204 {
 205   return pool_elt_at_index (app_pool, index);
 206 }
 207
 208 application_t *
 209 application_get_if_valid (u32 index)
 210 {
 211   if (pool_is_free_index (app_pool, index))
 212     return 0;
 213
 214   return pool_elt_at_index (app_pool, index);
 215 }
 216
 217 u32
 218 application_get_index (application_t * app)
 219 {
 220   return app - app_pool;
 221 }
 222
 223 static segment_manager_t *
 224 application_alloc_segment_manager (application_t * app)
 225 {
 226   segment_manager_t *sm = 0;
 227
 228   if (app->first_segment_manager != (u32) ~ 0)
 229     {
 230       sm = segment_manager_get (app->first_segment_manager);
 231       return sm;
 232     }
 233
 234   sm = segment_manager_new ();
 235   if (segment_manager_init (sm, &app->sm_properties, 0))
 236     return 0;
 237   return sm;
 238 }
 239
 240 /**
 241  * Start listening local transport endpoint for requested transport.
 242  *
 243  * Creates a 'dummy' stream session with state LISTENING to be used in session
 244  * lookups, prior to establishing connection. Requests transport to build
 245  * it's own specific listening connection.
 246  */
 247 int
 248 application_start_listen (application_t * srv, session_type_t session_type,
 249                           transport_endpoint_t * tep, u64 * res)
 250 {
 251   segment_manager_t *sm;
 252   stream_session_t *s;
 253   u64 handle;
 254
 255   s = listen_session_new (session_type);
 256   s->app_index = srv->index;
 257
 258   if (stream_session_listen (s, tep))
 259     goto err;
 260
 261   /* Allocate segment manager. All sessions derived out of a listen session
 262    * have fifos allocated by the same segment manager. */
 263   sm = application_alloc_segment_manager (srv);
 264   if (sm == 0)
 265     goto err;
 266
 267   /* Add to app's listener table. Useful to find all child listeners
 268    * when app goes down, although, just for unbinding this is not needed */
 269   handle = listen_session_get_handle (s);
 270   hash_set (srv->listeners_table, handle, segment_manager_index (sm));
 271
 272   *res = handle;
 273   return 0;
 274
 275 err:
 276   listen_session_del (s);
 277   return -1;
 278 }
 279
 280 /**
 281  * Stop listening on session associated to handle
 282  */
 283 int
 284 application_stop_listen (application_t * srv, u64 handle)
 285 {
 286   stream_session_t *listener;
 287   uword *indexp;
 288   segment_manager_t *sm;
 289
 290   if (srv && hash_get (srv->listeners_table, handle) == 0)
 291     {
 292       clib_warning ("app doesn't own handle %llu!", handle);
 293       return -1;
 294     }
 295
 296   listener = listen_session_get_from_handle (handle);
 297   stream_session_stop_listen (listener);
 298
 299   indexp = hash_get (srv->listeners_table, handle);
 300   ASSERT (indexp);
 301
 302   sm = segment_manager_get (*indexp);
 303   segment_manager_del (sm);
 304   srv->first_segment_manager = ~0;
 305   hash_unset (srv->listeners_table, handle);
 306   listen_session_del (listener);
 307
 308   return 0;
 309 }
 310
 311 int
 312 application_open_session (application_t * app, session_type_t sst,
 313                           transport_endpoint_t * tep, u32 api_context)
 314 {
 315   segment_manager_t *sm;
 316   transport_connection_t *tc = 0;
 317   int rv;
 318
 319   /* Make sure we have a segment manager for connects */
 320   if (app->connects_seg_manager == (u32) ~ 0)
 321     {
 322       sm = application_alloc_segment_manager (app);
 323       if (sm == 0)
 324         return -1;
 325       app->connects_seg_manager = segment_manager_index (sm);
 326     }
 327
 328   if ((rv = stream_session_open (app->index, sst, tep, &tc)))
 329     return rv;
 330
 331   /* Store api_context for when the reply comes. Not the nicest thing
 332    * but better than allocating a separate half-open pool. */
 333   tc->s_index = api_context;
 334
 335   return 0;
 336 }
 337
 338 segment_manager_t *
 339 application_get_connect_segment_manager (application_t * app)
 340 {
 341   ASSERT (app->connects_seg_manager != (u32) ~ 0);
 342   return segment_manager_get (app->connects_seg_manager);
 343 }
 344
 345 segment_manager_t *
 346 application_get_listen_segment_manager (application_t * app,
 347                                         stream_session_t * s)
 348 {
 349   uword *smp;
 350   smp = hash_get (app->listeners_table, listen_session_get_handle (s));
 351   ASSERT (smp != 0);
 352   return segment_manager_get (*smp);
 353 }
 354
 355 static u8 *
 356 app_get_name_from_reg_index (application_t * app)
 357 {
 358   u8 *app_name;
 359
 360   vl_api_registration_t *regp;
 361   regp = vl_api_client_index_to_registration (app->api_client_index);
 362   if (!regp)
 363     app_name = format (0, "builtin-%d%c", app->index, 0);
 364   else
 365     app_name = format (0, "%s%c", regp->name, 0);
 366
 367   return app_name;
 368 }
 369
 370 int
 371 application_is_proxy (application_t * app)
 372 {
 373   return !(app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
 374 }
 375
 376 u8 *
 377 format_application_listener (u8 * s, va_list * args)
 378 {
 379   application_t *app = va_arg (*args, application_t *);
 380   u64 handle = va_arg (*args, u64);
 381   u32 index = va_arg (*args, u32);
 382   int verbose = va_arg (*args, int);
 383   stream_session_t *listener;
 384   u8 *app_name, *str;
 385
 386   if (app == 0)
 387     {
 388       if (verbose)
 389         s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
 390                     "API Client", "ListenerID", "SegManager");
 391       else
 392         s = format (s, "%-40s%-20s", "Connection", "App");
 393
 394       return s;
 395     }
 396
 397   app_name = app_get_name_from_reg_index (app);
 398   listener = listen_session_get_from_handle (handle);
 399   str = format (0, "%U", format_stream_session, listener, verbose);
 400
 401   if (verbose)
 402     {
 403       s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
 404                   app->api_client_index, handle, index);
 405     }
 406   else
 407     s = format (s, "%-40s%-20s", str, app_name);
 408
 409   vec_free (app_name);
 410   return s;
 411 }
 412
 413 void
 414 application_format_connects (application_t * app, int verbose)
 415 {
 416   vlib_main_t *vm = vlib_get_main ();
 417   segment_manager_t *sm;
 418   u8 *app_name, *s = 0;
 419   int j;
 420
 421   /* Header */
 422   if (app == 0)
 423     {
 424       if (verbose)
 425         vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
 426                          "API Client", "SegManager");
 427       else
 428         vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
 429       return;
 430     }
 431
 432   /* make sure */
 433   if (app->connects_seg_manager == (u32) ~ 0)
 434     return;
 435
 436   app_name = app_get_name_from_reg_index (app);
 437
 438   /* Across all fifo segments */
 439   sm = segment_manager_get (app->connects_seg_manager);
 440   for (j = 0; j < vec_len (sm->segment_indices); j++)
 441     {
 442       svm_fifo_segment_private_t *fifo_segment;
 443       svm_fifo_t *fifo;
 444       u8 *str;
 445
 446       fifo_segment = svm_fifo_get_segment (sm->segment_indices[j]);
 447       fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
 448       while (fifo)
 449         {
 450           u32 session_index, thread_index;
 451           stream_session_t *session;
 452
 453           session_index = fifo->master_session_index;
 454           thread_index = fifo->master_thread_index;
 455
 456           session = stream_session_get (session_index, thread_index);
 457           str = format (0, "%U", format_stream_session, session, verbose);
 458
 459           if (verbose)
 460             s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
 461                         app->api_client_index, app->connects_seg_manager);
 462           else
 463             s = format (s, "%-40s%-20s", str, app_name);
 464
 465           vlib_cli_output (vm, "%v", s);
 466           vec_reset_length (s);
 467           vec_free (str);
 468
 469           fifo = fifo->next;
 470         }
 471       vec_free (s);
 472     }
 473
 474   vec_free (app_name);
 475 }
 476
 477 u8 *
 478 format_application (u8 * s, va_list * args)
 479 {
 480   application_t *app = va_arg (*args, application_t *);
 481   CLIB_UNUSED (int verbose) = va_arg (*args, int);
 482   u8 *app_name;
 483
 484   if (app == 0)
 485     {
 486       if (verbose)
 487         s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s", "Index", "Name",
 488                     "API Client", "Add seg size", "Rx fifo size",
 489                     "Tx fifo size");
 490       else
 491         s = format (s, "%-10s%-20s%-20s", "Index", "Name", "API Client");
 492       return s;
 493     }
 494
 495   app_name = app_get_name_from_reg_index (app);
 496   if (verbose)
 497     s = format (s, "%-10d%-20s%-15d%-15d%-15d%-15d", app->index, app_name,
 498                 app->api_client_index, app->sm_properties.add_segment_size,
 499                 app->sm_properties.rx_fifo_size,
 500                 app->sm_properties.tx_fifo_size);
 501   else
 502     s = format (s, "%-10d%-20s%-20d", app->index, app_name,
 503                 app->api_client_index);
 504   return s;
 505 }
 506
 507 static clib_error_t *
 508 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
 509                      vlib_cli_command_t * cmd)
 510 {
 511   application_t *app;
 512   int do_server = 0;
 513   int do_client = 0;
 514   int verbose = 0;
 515
 516   if (!session_manager_is_enabled ())
 517     {
 518       clib_error_return (0, "session layer is not enabled");
 519     }
 520
 521   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 522     {
 523       if (unformat (input, "server"))
 524         do_server = 1;
 525       else if (unformat (input, "client"))
 526         do_client = 1;
 527       else if (unformat (input, "verbose"))
 528         verbose = 1;
 529       else
 530         break;
 531     }
 532
 533   if (do_server)
 534     {
 535       u64 handle;
 536       u32 index;
 537       if (pool_elts (app_pool))
 538         {
 539           vlib_cli_output (vm, "%U", format_application_listener,
 540                            0 /* header */ , 0, 0,
 541                            verbose);
 542           /* *INDENT-OFF* */
 543           pool_foreach (app, app_pool,
 544           ({
 545             /* App's listener sessions */
 546             if (hash_elts (app->listeners_table) == 0)
 547               continue;
 548             hash_foreach (handle, index, app->listeners_table,
 549             ({
 550               vlib_cli_output (vm, "%U", format_application_listener, app,
 551                                        handle, index, verbose);
 552             }));
 553           }));
 554           /* *INDENT-ON* */
 555         }
 556       else
 557         vlib_cli_output (vm, "No active server bindings");
 558     }
 559
 560   if (do_client)
 561     {
 562       if (pool_elts (app_pool))
 563         {
 564           application_format_connects (0, verbose);
 565
 566           /* *INDENT-OFF* */
 567           pool_foreach (app, app_pool,
 568           ({
 569             if (app->connects_seg_manager == (u32)~0)
 570               continue;
 571             application_format_connects (app, verbose);
 572           }));
 573           /* *INDENT-ON* */
 574         }
 575       else
 576         vlib_cli_output (vm, "No active client bindings");
 577     }
 578
 579   /* Print app related info */
 580   if (!do_server && !do_client)
 581     {
 582       vlib_cli_output (vm, "%U", format_application, 0, verbose);
 583       pool_foreach (app, app_pool, (
 584                                      {
 585                                      vlib_cli_output (vm, "%U",
 586                                                       format_application, app,
 587                                                       verbose);
 588                                      }
 589                     ));
 590     }
 591
 592   return 0;
 593 }
 594
 595 /* *INDENT-OFF* */
 596 VLIB_CLI_COMMAND (show_app_command, static) =
 597 {
 598   .path = "show app",
 599   .short_help = "show app [server|client] [verbose]",
 600   .function = show_app_command_fn,
 601 };
 602 /* *INDENT-ON* */
 603
 604 /*
 605  * fd.io coding-style-patch-verification: ON
 606  *
 607  * Local Variables:
 608  * eval: (c-set-style "gnu")
 609  * End:
 610  */