src/vnet/session/application.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/session/application.h>
  17 #include <vnet/session/application_interface.h>
  18 #include <vnet/session/application_namespace.h>
  19 #include <vnet/session/application_local.h>
  20 #include <vnet/session/session.h>
  21
  22 static app_main_t app_main;
  23
  24 #define app_interface_check_thread_and_barrier(_fn, _arg)               \
  25   if (PREDICT_FALSE (!vlib_thread_is_main_w_barrier ()))                \
  26     {                                                                   \
  27       vlib_rpc_call_main_thread (_fn, (u8 *) _arg, sizeof(*_arg));      \
  28       return 0;                                                         \
  29     }
  30
  31 static app_listener_t *
  32 app_listener_alloc (application_t * app)
  33 {
  34   app_listener_t *app_listener;
  35   pool_get (app->listeners, app_listener);
  36   clib_memset (app_listener, 0, sizeof (*app_listener));
  37   app_listener->al_index = app_listener - app->listeners;
  38   app_listener->app_index = app->app_index;
  39   app_listener->session_index = SESSION_INVALID_INDEX;
  40   app_listener->local_index = SESSION_INVALID_INDEX;
  41   app_listener->ls_handle = SESSION_INVALID_HANDLE;
  42   return app_listener;
  43 }
  44
  45 app_listener_t *
  46 app_listener_get (application_t * app, u32 app_listener_index)
  47 {
  48   return pool_elt_at_index (app->listeners, app_listener_index);
  49 }
  50
  51 static void
  52 app_listener_free (application_t * app, app_listener_t * app_listener)
  53 {
  54   clib_bitmap_free (app_listener->workers);
  55   if (CLIB_DEBUG)
  56     clib_memset (app_listener, 0xfa, sizeof (*app_listener));
  57   pool_put (app->listeners, app_listener);
  58 }
  59
  60 session_handle_t
  61 app_listener_handle (app_listener_t * al)
  62 {
  63   return al->ls_handle;
  64 }
  65
  66 app_listener_t *
  67 app_listener_get_w_session (session_t * ls)
  68 {
  69   application_t *app;
  70
  71   app = application_get_if_valid (ls->app_index);
  72   if (!app)
  73     return 0;
  74   return app_listener_get (app, ls->al_index);
  75 }
  76
  77 session_handle_t
  78 app_listen_session_handle (session_t * ls)
  79 {
  80   app_listener_t *al;
  81   al = app_listener_get_w_session (ls);
  82   if (!al)
  83     return listen_session_get_handle (ls);
  84   return al->ls_handle;
  85 }
  86
  87 app_listener_t *
  88 app_listener_get_w_handle (session_handle_t handle)
  89 {
  90   session_t *ls;
  91   ls = session_get_from_handle_if_valid (handle);
  92   if (!ls)
  93     return 0;
  94   return app_listener_get_w_session (ls);
  95 }
  96
  97 app_listener_t *
  98 app_listener_lookup (application_t * app, session_endpoint_cfg_t * sep_ext)
  99 {
 100   u32 table_index, fib_proto;
 101   session_endpoint_t *sep;
 102   session_handle_t handle;
 103   session_t *ls;
 104
 105   sep = (session_endpoint_t *) sep_ext;
 106   if (application_has_local_scope (app) && session_endpoint_is_local (sep))
 107     {
 108       table_index = application_local_session_table (app);
 109       handle = session_lookup_endpoint_listener (table_index, sep, 1);
 110       if (handle != SESSION_INVALID_HANDLE)
 111         {
 112           ls = listen_session_get_from_handle (handle);
 113           return app_listener_get_w_session (ls);
 114         }
 115     }
 116
 117   fib_proto = session_endpoint_fib_proto (sep);
 118   table_index = application_session_table (app, fib_proto);
 119   handle = session_lookup_endpoint_listener (table_index, sep, 1);
 120   if (handle != SESSION_INVALID_HANDLE)
 121     {
 122       ls = listen_session_get_from_handle (handle);
 123       return app_listener_get_w_session ((session_t *) ls);
 124     }
 125
 126   return 0;
 127 }
 128
 129 int
 130 app_listener_alloc_and_init (application_t * app,
 131                              session_endpoint_cfg_t * sep,
 132                              app_listener_t ** listener)
 133 {
 134   app_listener_t *app_listener;
 135   transport_connection_t *tc;
 136   session_handle_t lh;
 137   session_type_t st;
 138   session_t *ls = 0;
 139   u32 al_index;
 140   int rv;
 141
 142   app_listener = app_listener_alloc (app);
 143   al_index = app_listener->al_index;
 144   st = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
 145
 146   /*
 147    * Add session endpoint to local session table. Only binds to "inaddr_any"
 148    * (i.e., zero address) are added to local scope table.
 149    */
 150   if (application_has_local_scope (app)
 151       && session_endpoint_is_local ((session_endpoint_t *) sep))
 152     {
 153       session_type_t local_st;
 154       u32 table_index;
 155
 156       local_st = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
 157                                                  sep->is_ip4);
 158       ls = listen_session_alloc (0, local_st);
 159       ls->app_index = app->app_index;
 160       ls->app_wrk_index = sep->app_wrk_index;
 161       lh = session_handle (ls);
 162
 163       if ((rv = session_listen (ls, sep)))
 164         {
 165           ls = session_get_from_handle (lh);
 166           session_free (ls);
 167           return rv;
 168         }
 169
 170       ls = session_get_from_handle (lh);
 171       app_listener = app_listener_get (app, al_index);
 172       app_listener->local_index = ls->session_index;
 173       app_listener->ls_handle = lh;
 174       ls->al_index = al_index;
 175
 176       table_index = application_local_session_table (app);
 177       session_lookup_add_session_endpoint (table_index,
 178                                            (session_endpoint_t *) sep, lh);
 179     }
 180
 181   if (application_has_global_scope (app))
 182     {
 183       /*
 184        * Start listening on local endpoint for requested transport and scope.
 185        * Creates a stream session with state LISTENING to be used in session
 186        * lookups, prior to establishing connection. Requests transport to
 187        * build it's own specific listening connection.
 188        */
 189       ls = listen_session_alloc (0, st);
 190       ls->app_index = app->app_index;
 191       ls->app_wrk_index = sep->app_wrk_index;
 192
 193       /* Listen pool can be reallocated if the transport is
 194        * recursive (tls) */
 195       lh = listen_session_get_handle (ls);
 196
 197       if ((rv = session_listen (ls, sep)))
 198         {
 199           ls = listen_session_get_from_handle (lh);
 200           session_free (ls);
 201           return rv;
 202         }
 203       ls = listen_session_get_from_handle (lh);
 204       app_listener = app_listener_get (app, al_index);
 205       app_listener->session_index = ls->session_index;
 206       app_listener->ls_handle = lh;
 207       ls->al_index = al_index;
 208
 209       /* Add to the global lookup table after transport was initialized.
 210        * Lookup table needs to be populated only now because sessions
 211        * with cut-through transport are are added to app local tables that
 212        * are not related to network fibs, i.e., cannot be added as
 213        * connections */
 214       tc = session_get_transport (ls);
 215       if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
 216         session_lookup_add_connection (tc, lh);
 217     }
 218
 219   if (!ls)
 220     {
 221       app_listener_free (app, app_listener);
 222       return -1;
 223     }
 224
 225   *listener = app_listener;
 226   return 0;
 227 }
 228
 229 void
 230 app_listener_cleanup (app_listener_t * al)
 231 {
 232   application_t *app = application_get (al->app_index);
 233   session_t *ls;
 234
 235   if (al->session_index != SESSION_INVALID_INDEX)
 236     {
 237       ls = session_get (al->session_index, 0);
 238       session_stop_listen (ls);
 239       listen_session_free (ls);
 240     }
 241   if (al->local_index != SESSION_INVALID_INDEX)
 242     {
 243       session_endpoint_t sep = SESSION_ENDPOINT_NULL;
 244       u32 table_index;
 245
 246       table_index = application_local_session_table (app);
 247       ls = listen_session_get (al->local_index);
 248       ct_session_endpoint (ls, &sep);
 249       session_lookup_del_session_endpoint (table_index, &sep);
 250       session_stop_listen (ls);
 251       listen_session_free (ls);
 252     }
 253   app_listener_free (app, al);
 254 }
 255
 256 static app_worker_t *
 257 app_listener_select_worker (application_t * app, app_listener_t * al)
 258 {
 259   u32 wrk_index;
 260
 261   app = application_get (al->app_index);
 262   wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
 263   if (wrk_index == ~0)
 264     wrk_index = clib_bitmap_first_set (al->workers);
 265
 266   ASSERT (wrk_index != ~0);
 267   al->accept_rotor = wrk_index;
 268   return application_get_worker (app, wrk_index);
 269 }
 270
 271 session_t *
 272 app_listener_get_session (app_listener_t * al)
 273 {
 274   if (al->session_index == SESSION_INVALID_INDEX)
 275     return 0;
 276
 277   return listen_session_get (al->session_index);
 278 }
 279
 280 session_t *
 281 app_listener_get_local_session (app_listener_t * al)
 282 {
 283   if (al->local_index == SESSION_INVALID_INDEX)
 284     return 0;
 285   return listen_session_get (al->local_index);
 286 }
 287
 288 static app_worker_map_t *
 289 app_worker_map_alloc (application_t * app)
 290 {
 291   app_worker_map_t *map;
 292   pool_get (app->worker_maps, map);
 293   clib_memset (map, 0, sizeof (*map));
 294   return map;
 295 }
 296
 297 static u32
 298 app_worker_map_index (application_t * app, app_worker_map_t * map)
 299 {
 300   return (map - app->worker_maps);
 301 }
 302
 303 static void
 304 app_worker_map_free (application_t * app, app_worker_map_t * map)
 305 {
 306   pool_put (app->worker_maps, map);
 307 }
 308
 309 static app_worker_map_t *
 310 app_worker_map_get (application_t * app, u32 map_index)
 311 {
 312   if (pool_is_free_index (app->worker_maps, map_index))
 313     return 0;
 314   return pool_elt_at_index (app->worker_maps, map_index);
 315 }
 316
 317 static const u8 *
 318 app_get_name (application_t * app)
 319 {
 320   return app->name;
 321 }
 322
 323 u32
 324 application_session_table (application_t * app, u8 fib_proto)
 325 {
 326   app_namespace_t *app_ns;
 327   app_ns = app_namespace_get (app->ns_index);
 328   if (!application_has_global_scope (app))
 329     return APP_INVALID_INDEX;
 330   if (fib_proto == FIB_PROTOCOL_IP4)
 331     return session_lookup_get_index_for_fib (fib_proto,
 332                                              app_ns->ip4_fib_index);
 333   else
 334     return session_lookup_get_index_for_fib (fib_proto,
 335                                              app_ns->ip6_fib_index);
 336 }
 337
 338 u32
 339 application_local_session_table (application_t * app)
 340 {
 341   app_namespace_t *app_ns;
 342   if (!application_has_local_scope (app))
 343     return APP_INVALID_INDEX;
 344   app_ns = app_namespace_get (app->ns_index);
 345   return app_ns->local_table_index;
 346 }
 347
 348 /**
 349  * Returns app name for app-index
 350  */
 351 const u8 *
 352 application_name_from_index (u32 app_index)
 353 {
 354   application_t *app = application_get (app_index);
 355   if (!app)
 356     return 0;
 357   return app_get_name (app);
 358 }
 359
 360 static void
 361 application_api_table_add (u32 app_index, u32 api_client_index)
 362 {
 363   if (api_client_index != APP_INVALID_INDEX)
 364     hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
 365 }
 366
 367 static void
 368 application_api_table_del (u32 api_client_index)
 369 {
 370   hash_unset (app_main.app_by_api_client_index, api_client_index);
 371 }
 372
 373 static void
 374 application_name_table_add (application_t * app)
 375 {
 376   hash_set_mem (app_main.app_by_name, app->name, app->app_index);
 377 }
 378
 379 static void
 380 application_name_table_del (application_t * app)
 381 {
 382   hash_unset_mem (app_main.app_by_name, app->name);
 383 }
 384
 385 application_t *
 386 application_lookup (u32 api_client_index)
 387 {
 388   uword *p;
 389   p = hash_get (app_main.app_by_api_client_index, api_client_index);
 390   if (p)
 391     return application_get_if_valid (p[0]);
 392
 393   return 0;
 394 }
 395
 396 application_t *
 397 application_lookup_name (const u8 * name)
 398 {
 399   uword *p;
 400   p = hash_get_mem (app_main.app_by_name, name);
 401   if (p)
 402     return application_get (p[0]);
 403
 404   return 0;
 405 }
 406
 407 static application_t *
 408 application_alloc (void)
 409 {
 410   application_t *app;
 411   pool_get (app_main.app_pool, app);
 412   clib_memset (app, 0, sizeof (*app));
 413   app->app_index = app - app_main.app_pool;
 414   return app;
 415 }
 416
 417 application_t *
 418 application_get (u32 app_index)
 419 {
 420   if (app_index == APP_INVALID_INDEX)
 421     return 0;
 422   return pool_elt_at_index (app_main.app_pool, app_index);
 423 }
 424
 425 application_t *
 426 application_get_if_valid (u32 app_index)
 427 {
 428   if (pool_is_free_index (app_main.app_pool, app_index))
 429     return 0;
 430
 431   return pool_elt_at_index (app_main.app_pool, app_index);
 432 }
 433
 434 static void
 435 application_verify_cb_fns (session_cb_vft_t * cb_fns)
 436 {
 437   if (cb_fns->session_accept_callback == 0)
 438     clib_warning ("No accept callback function provided");
 439   if (cb_fns->session_connected_callback == 0)
 440     clib_warning ("No session connected callback function provided");
 441   if (cb_fns->session_disconnect_callback == 0)
 442     clib_warning ("No session disconnect callback function provided");
 443   if (cb_fns->session_reset_callback == 0)
 444     clib_warning ("No session reset callback function provided");
 445 }
 446
 447 /**
 448  * Check app config for given segment type
 449  *
 450  * Returns 1 on success and 0 otherwise
 451  */
 452 static u8
 453 application_verify_cfg (ssvm_segment_type_t st)
 454 {
 455   u8 is_valid;
 456   if (st == SSVM_SEGMENT_MEMFD)
 457     {
 458       is_valid = (session_main_get_evt_q_segment () != 0);
 459       if (!is_valid)
 460         clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
 461       return is_valid;
 462     }
 463   else if (st == SSVM_SEGMENT_SHM)
 464     {
 465       is_valid = (session_main_get_evt_q_segment () == 0);
 466       if (!is_valid)
 467         clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
 468       return is_valid;
 469     }
 470   else
 471     return 1;
 472 }
 473
 474 static int
 475 application_alloc_and_init (app_init_args_t * a)
 476 {
 477   ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
 478   segment_manager_props_t *props;
 479   vl_api_registration_t *reg;
 480   application_t *app;
 481   u64 *options;
 482
 483   app = application_alloc ();
 484   options = a->options;
 485   /*
 486    * Make sure we support the requested configuration
 487    */
 488   if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
 489     {
 490       reg = vl_api_client_index_to_registration (a->api_client_index);
 491       if (!reg)
 492         return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 493       if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
 494         seg_type = SSVM_SEGMENT_SHM;
 495     }
 496   else
 497     {
 498       seg_type = SSVM_SEGMENT_PRIVATE;
 499     }
 500
 501   if ((options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
 502       && seg_type != SSVM_SEGMENT_MEMFD)
 503     {
 504       clib_warning ("mq eventfds can only be used if socket transport is "
 505                     "used for binary api");
 506       return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 507     }
 508
 509   if (!application_verify_cfg (seg_type))
 510     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 511
 512   /* Check that the obvious things are properly set up */
 513   application_verify_cb_fns (a->session_cb_vft);
 514
 515   app->flags = options[APP_OPTIONS_FLAGS];
 516   app->cb_fns = *a->session_cb_vft;
 517   app->ns_index = options[APP_OPTIONS_NAMESPACE];
 518   app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
 519   app->name = vec_dup (a->name);
 520
 521   /* If no scope enabled, default to global */
 522   if (!application_has_global_scope (app)
 523       && !application_has_local_scope (app))
 524     app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 525
 526   props = application_segment_manager_properties (app);
 527   segment_manager_props_init (props);
 528   props->segment_size = options[APP_OPTIONS_SEGMENT_SIZE];
 529   props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
 530   if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
 531     {
 532       props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
 533       props->add_segment = 1;
 534     }
 535   if (options[APP_OPTIONS_RX_FIFO_SIZE])
 536     props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
 537   if (options[APP_OPTIONS_TX_FIFO_SIZE])
 538     props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
 539   if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
 540     props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
 541   if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
 542     props->use_mq_eventfd = 1;
 543   if (options[APP_OPTIONS_TLS_ENGINE])
 544     app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
 545   props->segment_type = seg_type;
 546
 547   /* Add app to lookup by api_client_index table */
 548   if (!application_is_builtin (app))
 549     application_api_table_add (app->app_index, a->api_client_index);
 550   else
 551     application_name_table_add (app);
 552
 553   a->app_index = app->app_index;
 554
 555   APP_DBG ("New app name: %v api index: %u index %u", app->name,
 556            a->api_client_index, app->app_index);
 557
 558   return 0;
 559 }
 560
 561 static void
 562 application_free (application_t * app)
 563 {
 564   app_worker_map_t *wrk_map;
 565   app_worker_t *app_wrk;
 566
 567   /*
 568    * The app event queue allocated in first segment is cleared with
 569    * the segment manager. No need to explicitly free it.
 570    */
 571   APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
 572
 573   if (application_is_proxy (app))
 574     application_remove_proxy (app);
 575
 576   /*
 577    * Free workers
 578    */
 579
 580   /* *INDENT-OFF* */
 581   pool_flush (wrk_map, app->worker_maps, ({
 582     app_wrk = app_worker_get (wrk_map->wrk_index);
 583     app_worker_free (app_wrk);
 584   }));
 585   /* *INDENT-ON* */
 586   pool_free (app->worker_maps);
 587
 588   /*
 589    * Cleanup remaining state
 590    */
 591   if (application_is_builtin (app))
 592     application_name_table_del (app);
 593   vec_free (app->name);
 594   vec_free (app->tls_cert);
 595   vec_free (app->tls_key);
 596   pool_put (app_main.app_pool, app);
 597 }
 598
 599 static void
 600 application_detach_process (application_t * app, u32 api_client_index)
 601 {
 602   vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
 603   app_worker_map_t *wrk_map;
 604   u32 *wrks = 0, *wrk_index;
 605   app_worker_t *app_wrk;
 606
 607   if (api_client_index == ~0)
 608     {
 609       application_free (app);
 610       return;
 611     }
 612
 613   APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
 614            app->app_index, api_client_index);
 615
 616   /* *INDENT-OFF* */
 617   pool_foreach (wrk_map, app->worker_maps, ({
 618     app_wrk = app_worker_get (wrk_map->wrk_index);
 619     if (app_wrk->api_client_index == api_client_index)
 620       vec_add1 (wrks, app_wrk->wrk_index);
 621   }));
 622   /* *INDENT-ON* */
 623
 624   if (!vec_len (wrks))
 625     {
 626       clib_warning ("no workers for app %u api_index %u", app->app_index,
 627                     api_client_index);
 628       return;
 629     }
 630
 631   args->app_index = app->app_index;
 632   args->api_client_index = api_client_index;
 633   vec_foreach (wrk_index, wrks)
 634   {
 635     app_wrk = app_worker_get (wrk_index[0]);
 636     args->wrk_map_index = app_wrk->wrk_map_index;
 637     args->is_add = 0;
 638     vnet_app_worker_add_del (args);
 639   }
 640   vec_free (wrks);
 641 }
 642
 643 app_worker_t *
 644 application_get_worker (application_t * app, u32 wrk_map_index)
 645 {
 646   app_worker_map_t *map;
 647   map = app_worker_map_get (app, wrk_map_index);
 648   if (!map)
 649     return 0;
 650   return app_worker_get (map->wrk_index);
 651 }
 652
 653 app_worker_t *
 654 application_get_default_worker (application_t * app)
 655 {
 656   return application_get_worker (app, 0);
 657 }
 658
 659 u32
 660 application_n_workers (application_t * app)
 661 {
 662   return pool_elts (app->worker_maps);
 663 }
 664
 665 app_worker_t *
 666 application_listener_select_worker (session_t * ls)
 667 {
 668   application_t *app;
 669   app_listener_t *al;
 670
 671   app = application_get (ls->app_index);
 672   al = app_listener_get (app, ls->al_index);
 673   return app_listener_select_worker (app, al);
 674 }
 675
 676 int
 677 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
 678 {
 679   app_worker_map_t *wrk_map;
 680   app_worker_t *app_wrk;
 681   segment_manager_t *sm;
 682   int rv;
 683
 684   app_wrk = app_worker_alloc (app);
 685   wrk_map = app_worker_map_alloc (app);
 686   wrk_map->wrk_index = app_wrk->wrk_index;
 687   app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
 688
 689   /*
 690    * Setup first segment manager
 691    */
 692   sm = segment_manager_alloc ();
 693   sm->app_wrk_index = app_wrk->wrk_index;
 694
 695   if ((rv = segment_manager_init (sm, app->sm_properties.segment_size,
 696                                   app->sm_properties.prealloc_fifos)))
 697     {
 698       app_worker_free (app_wrk);
 699       return rv;
 700     }
 701   sm->first_is_protected = 1;
 702
 703   /*
 704    * Setup app worker
 705    */
 706   app_wrk->first_segment_manager = segment_manager_index (sm);
 707   app_wrk->listeners_table = hash_create (0, sizeof (u64));
 708   app_wrk->event_queue = segment_manager_event_queue (sm);
 709   app_wrk->app_is_builtin = application_is_builtin (app);
 710
 711   *wrk = app_wrk;
 712
 713   return 0;
 714 }
 715
 716 int
 717 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
 718 {
 719   fifo_segment_t *fs;
 720   app_worker_map_t *wrk_map;
 721   app_worker_t *app_wrk;
 722   segment_manager_t *sm;
 723   application_t *app;
 724   int rv;
 725
 726   app = application_get (a->app_index);
 727   if (!app)
 728     return VNET_API_ERROR_INVALID_VALUE;
 729
 730   if (a->is_add)
 731     {
 732       if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
 733         return rv;
 734
 735       /* Map worker api index to the app */
 736       app_wrk->api_client_index = a->api_client_index;
 737       application_api_table_add (app->app_index, a->api_client_index);
 738
 739       sm = segment_manager_get (app_wrk->first_segment_manager);
 740       fs = segment_manager_get_segment_w_lock (sm, 0);
 741       a->segment = &fs->ssvm;
 742       a->segment_handle = segment_manager_segment_handle (sm, fs);
 743       segment_manager_segment_reader_unlock (sm);
 744       a->evt_q = app_wrk->event_queue;
 745       a->wrk_map_index = app_wrk->wrk_map_index;
 746     }
 747   else
 748     {
 749       wrk_map = app_worker_map_get (app, a->wrk_map_index);
 750       if (!wrk_map)
 751         return VNET_API_ERROR_INVALID_VALUE;
 752
 753       app_wrk = app_worker_get (wrk_map->wrk_index);
 754       if (!app_wrk)
 755         return VNET_API_ERROR_INVALID_VALUE;
 756
 757       application_api_table_del (app_wrk->api_client_index);
 758       app_worker_free (app_wrk);
 759       app_worker_map_free (app, wrk_map);
 760       if (application_n_workers (app) == 0)
 761         application_free (app);
 762     }
 763   return 0;
 764 }
 765
 766 static int
 767 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
 768 {
 769   app_namespace_t *app_ns;
 770   if (vec_len (namespace_id) == 0)
 771     {
 772       /* Use default namespace */
 773       *app_ns_index = 0;
 774       return 0;
 775     }
 776
 777   *app_ns_index = app_namespace_index_from_id (namespace_id);
 778   if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
 779     return VNET_API_ERROR_APP_INVALID_NS;
 780   app_ns = app_namespace_get (*app_ns_index);
 781   if (!app_ns)
 782     return VNET_API_ERROR_APP_INVALID_NS;
 783   if (app_ns->ns_secret != secret)
 784     return VNET_API_ERROR_APP_WRONG_NS_SECRET;
 785   return 0;
 786 }
 787
 788 static u8 *
 789 app_name_from_api_index (u32 api_client_index)
 790 {
 791   vl_api_registration_t *regp;
 792   regp = vl_api_client_index_to_registration (api_client_index);
 793   if (regp)
 794     return format (0, "%s", regp->name);
 795
 796   clib_warning ("api client index %u does not have an api registration!",
 797                 api_client_index);
 798   return format (0, "unknown");
 799 }
 800
 801 /**
 802  * Attach application to vpp
 803  *
 804  * Allocates a vpp app, i.e., a structure that keeps back pointers
 805  * to external app and a segment manager for shared memory fifo based
 806  * communication with the external app.
 807  */
 808 int
 809 vnet_application_attach (vnet_app_attach_args_t * a)
 810 {
 811   fifo_segment_t *fs;
 812   application_t *app = 0;
 813   app_worker_t *app_wrk;
 814   segment_manager_t *sm;
 815   u32 app_ns_index = 0;
 816   u8 *app_name = 0;
 817   u64 secret;
 818   int rv;
 819
 820   if (a->api_client_index != APP_INVALID_INDEX)
 821     app = application_lookup (a->api_client_index);
 822   else if (a->name)
 823     app = application_lookup_name (a->name);
 824   else
 825     return VNET_API_ERROR_INVALID_VALUE;
 826
 827   if (app)
 828     return VNET_API_ERROR_APP_ALREADY_ATTACHED;
 829
 830   if (a->api_client_index != APP_INVALID_INDEX)
 831     {
 832       app_name = app_name_from_api_index (a->api_client_index);
 833       a->name = app_name;
 834     }
 835
 836   secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
 837   if ((rv = app_validate_namespace (a->namespace_id, secret, &app_ns_index)))
 838     return rv;
 839   a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
 840
 841   if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
 842     return rv;
 843
 844   app = application_get (a->app_index);
 845   if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
 846     return rv;
 847
 848   a->app_evt_q = app_wrk->event_queue;
 849   app_wrk->api_client_index = a->api_client_index;
 850   sm = segment_manager_get (app_wrk->first_segment_manager);
 851   fs = segment_manager_get_segment_w_lock (sm, 0);
 852
 853   if (application_is_proxy (app))
 854     application_setup_proxy (app);
 855
 856   ASSERT (vec_len (fs->ssvm.name) <= 128);
 857   a->segment = &fs->ssvm;
 858   a->segment_handle = segment_manager_segment_handle (sm, fs);
 859
 860   segment_manager_segment_reader_unlock (sm);
 861   vec_free (app_name);
 862   return 0;
 863 }
 864
 865 /**
 866  * Detach application from vpp
 867  */
 868 int
 869 vnet_application_detach (vnet_app_detach_args_t * a)
 870 {
 871   application_t *app;
 872
 873   app = application_get_if_valid (a->app_index);
 874   if (!app)
 875     {
 876       clib_warning ("app not attached");
 877       return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
 878     }
 879
 880   app_interface_check_thread_and_barrier (vnet_application_detach, a);
 881   application_detach_process (app, a->api_client_index);
 882   return 0;
 883 }
 884
 885
 886 static u8
 887 session_endpoint_in_ns (session_endpoint_t * sep)
 888 {
 889   u8 is_lep = session_endpoint_is_local (sep);
 890   if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
 891       && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
 892     {
 893       clib_warning ("sw_if_index %u not configured with ip %U",
 894                     sep->sw_if_index, format_ip46_address, &sep->ip,
 895                     sep->is_ip4);
 896       return 0;
 897     }
 898   return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
 899 }
 900
 901 static void
 902 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
 903                                  application_t * app, u8 is_connect)
 904 {
 905   app_namespace_t *app_ns;
 906   u32 ns_index, fib_index;
 907
 908   ns_index = app->ns_index;
 909
 910   /* App is a transport proto, so fetch the calling app's ns */
 911   if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
 912     ns_index = sep->ns_index;
 913
 914   app_ns = app_namespace_get (ns_index);
 915   if (!app_ns)
 916     return;
 917
 918   /* Ask transport and network to bind to/connect using local interface
 919    * that "supports" app's namespace. This will fix our local connection
 920    * endpoint.
 921    */
 922
 923   /* If in default namespace and user requested a fib index use it */
 924   if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
 925     fib_index = sep->fib_index;
 926   else
 927     fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
 928   sep->peer.fib_index = fib_index;
 929   sep->fib_index = fib_index;
 930
 931   if (!is_connect)
 932     {
 933       sep->sw_if_index = app_ns->sw_if_index;
 934     }
 935   else
 936     {
 937       if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
 938           && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
 939           && sep->peer.sw_if_index != app_ns->sw_if_index)
 940         clib_warning ("Local sw_if_index different from app ns sw_if_index");
 941
 942       sep->peer.sw_if_index = app_ns->sw_if_index;
 943     }
 944 }
 945
 946 int
 947 vnet_listen (vnet_listen_args_t * a)
 948 {
 949   app_listener_t *app_listener;
 950   app_worker_t *app_wrk;
 951   application_t *app;
 952   int rv;
 953
 954   ASSERT (vlib_thread_is_main_w_barrier ());
 955
 956   app = application_get_if_valid (a->app_index);
 957   if (!app)
 958     return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
 959
 960   app_wrk = application_get_worker (app, a->wrk_map_index);
 961   if (!app_wrk)
 962     return VNET_API_ERROR_INVALID_VALUE;
 963
 964   a->sep_ext.app_wrk_index = app_wrk->wrk_index;
 965
 966   session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
 967   if (!session_endpoint_in_ns (&a->sep))
 968     return VNET_API_ERROR_INVALID_VALUE_2;
 969
 970   /*
 971    * Check if we already have an app listener
 972    */
 973   app_listener = app_listener_lookup (app, &a->sep_ext);
 974   if (app_listener)
 975     {
 976       if (app_listener->app_index != app->app_index)
 977         return VNET_API_ERROR_ADDRESS_IN_USE;
 978       if (app_worker_start_listen (app_wrk, app_listener))
 979         return -1;
 980       a->handle = app_listener_handle (app_listener);
 981       return 0;
 982     }
 983
 984   /*
 985    * Create new app listener
 986    */
 987   if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
 988     return rv;
 989
 990   if ((rv = app_worker_start_listen (app_wrk, app_listener)))
 991     {
 992       app_listener_cleanup (app_listener);
 993       return rv;
 994     }
 995
 996   a->handle = app_listener_handle (app_listener);
 997   return 0;
 998 }
 999
1000 int
1001 vnet_connect (vnet_connect_args_t * a)
1002 {
1003   app_worker_t *client_wrk;
1004   application_t *client;
1005
1006   ASSERT (vlib_thread_is_main_w_barrier ());
1007
1008   if (session_endpoint_is_zero (&a->sep))
1009     return VNET_API_ERROR_INVALID_VALUE;
1010
1011   client = application_get (a->app_index);
1012   session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1013   client_wrk = application_get_worker (client, a->wrk_map_index);
1014
1015   /*
1016    * First check the local scope for locally attached destinations.
1017    * If we have local scope, we pass *all* connects through it since we may
1018    * have special policy rules even for non-local destinations, think proxy.
1019    */
1020   if (application_has_local_scope (client))
1021     {
1022       int rv;
1023
1024       a->sep_ext.original_tp = a->sep_ext.transport_proto;
1025       a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1026       rv = app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1027       if (rv <= 0)
1028         return rv;
1029     }
1030   /*
1031    * Not connecting to a local server, propagate to transport
1032    */
1033   if (app_worker_connect_session (client_wrk, &a->sep, a->api_context))
1034     return VNET_API_ERROR_SESSION_CONNECT;
1035   return 0;
1036 }
1037
1038 int
1039 vnet_unlisten (vnet_unlisten_args_t * a)
1040 {
1041   app_worker_t *app_wrk;
1042   app_listener_t *al;
1043   application_t *app;
1044
1045   ASSERT (vlib_thread_is_main_w_barrier ());
1046
1047   if (!(app = application_get_if_valid (a->app_index)))
1048     return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1049
1050   if (!(al = app_listener_get_w_handle (a->handle)))
1051     return -1;
1052
1053   if (al->app_index != app->app_index)
1054     {
1055       clib_warning ("app doesn't own handle %llu!", a->handle);
1056       return -1;
1057     }
1058
1059   app_wrk = application_get_worker (app, a->wrk_map_index);
1060   if (!app_wrk)
1061     {
1062       clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1063       return -1;
1064     }
1065
1066   return app_worker_stop_listen (app_wrk, al);
1067 }
1068
1069 int
1070 vnet_disconnect_session (vnet_disconnect_args_t * a)
1071 {
1072   app_worker_t *app_wrk;
1073   session_t *s;
1074
1075   s = session_get_from_handle_if_valid (a->handle);
1076   if (!s)
1077     return VNET_API_ERROR_INVALID_VALUE;
1078   app_wrk = app_worker_get (s->app_wrk_index);
1079   if (app_wrk->app_index != a->app_index)
1080     return VNET_API_ERROR_INVALID_VALUE;
1081
1082   /* We're peeking into another's thread pool. Make sure */
1083   ASSERT (s->session_index == session_index_from_handle (a->handle));
1084
1085   session_close (s);
1086   return 0;
1087 }
1088
1089 int
1090 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1091 {
1092   app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1093   app_listener_t *app_listener;
1094   application_t *app;
1095
1096   if (!old_wrk)
1097     return -1;
1098
1099   hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1100   if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1101       && s->rx_fifo)
1102     segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1103
1104   app = application_get (old_wrk->app_index);
1105   if (!app)
1106     return -1;
1107
1108   app_listener = app_listener_get (app, s->al_index);
1109
1110   /* Only remove from lb for now */
1111   app_listener->workers = clib_bitmap_set (app_listener->workers,
1112                                            old_wrk->wrk_map_index, 0);
1113
1114   if (app_worker_start_listen (app_wrk, app_listener))
1115     return -1;
1116
1117   s->app_wrk_index = app_wrk->wrk_index;
1118
1119   return 0;
1120 }
1121
1122 int
1123 application_is_proxy (application_t * app)
1124 {
1125   return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1126 }
1127
1128 int
1129 application_is_builtin (application_t * app)
1130 {
1131   return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1132 }
1133
1134 int
1135 application_is_builtin_proxy (application_t * app)
1136 {
1137   return (application_is_proxy (app) && application_is_builtin (app));
1138 }
1139
1140 u8
1141 application_has_local_scope (application_t * app)
1142 {
1143   return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1144 }
1145
1146 u8
1147 application_has_global_scope (application_t * app)
1148 {
1149   return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1150 }
1151
1152 static clib_error_t *
1153 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1154                                         u8 transport_proto, u8 is_start)
1155 {
1156   app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1157   u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1158   session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1159   transport_connection_t *tc;
1160   app_worker_t *app_wrk;
1161   app_listener_t *al;
1162   session_t *s;
1163   u32 flags;
1164
1165   /* TODO decide if we want proxy to be enabled for all workers */
1166   app_wrk = application_get_default_worker (app);
1167   if (is_start)
1168     {
1169       s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1170       if (!s)
1171         {
1172           sep.is_ip4 = is_ip4;
1173           sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1174           sep.sw_if_index = app_ns->sw_if_index;
1175           sep.transport_proto = transport_proto;
1176           sep.app_wrk_index = app_wrk->wrk_index;       /* only default */
1177
1178           /* force global scope listener */
1179           flags = app->flags;
1180           app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1181           app_listener_alloc_and_init (app, &sep, &al);
1182           app->flags = flags;
1183
1184           app_worker_start_listen (app_wrk, al);
1185           s = listen_session_get (al->session_index);
1186           s->flags |= SESSION_F_PROXY;
1187         }
1188     }
1189   else
1190     {
1191       s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1192       ASSERT (s);
1193     }
1194
1195   tc = listen_session_get_transport (s);
1196
1197   if (!ip_is_zero (&tc->lcl_ip, 1))
1198     {
1199       u32 sti;
1200       sep.is_ip4 = is_ip4;
1201       sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1202       sep.transport_proto = transport_proto;
1203       sep.port = 0;
1204       sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1205       if (is_start)
1206         session_lookup_add_session_endpoint (sti,
1207                                              (session_endpoint_t *) & sep,
1208                                              s->session_index);
1209       else
1210         session_lookup_del_session_endpoint (sti,
1211                                              (session_endpoint_t *) & sep);
1212     }
1213
1214   return 0;
1215 }
1216
1217 static void
1218 application_start_stop_proxy_local_scope (application_t * app,
1219                                           u8 transport_proto, u8 is_start)
1220 {
1221   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1222   app_namespace_t *app_ns;
1223   app_ns = app_namespace_get (app->ns_index);
1224   sep.is_ip4 = 1;
1225   sep.transport_proto = transport_proto;
1226   sep.port = 0;
1227
1228   if (is_start)
1229     {
1230       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1231                                            app->app_index);
1232       sep.is_ip4 = 0;
1233       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1234                                            app->app_index);
1235     }
1236   else
1237     {
1238       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1239       sep.is_ip4 = 0;
1240       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1241     }
1242 }
1243
1244 void
1245 application_start_stop_proxy (application_t * app,
1246                               transport_proto_t transport_proto, u8 is_start)
1247 {
1248   if (application_has_local_scope (app))
1249     application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1250
1251   if (application_has_global_scope (app))
1252     {
1253       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1254                                               transport_proto, is_start);
1255       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1256                                               transport_proto, is_start);
1257     }
1258 }
1259
1260 void
1261 application_setup_proxy (application_t * app)
1262 {
1263   u16 transports = app->proxied_transports;
1264   transport_proto_t tp;
1265
1266   ASSERT (application_is_proxy (app));
1267
1268   /* *INDENT-OFF* */
1269   transport_proto_foreach (tp, ({
1270     if (transports & (1 << tp))
1271       application_start_stop_proxy (app, tp, 1);
1272   }));
1273   /* *INDENT-ON* */
1274 }
1275
1276 void
1277 application_remove_proxy (application_t * app)
1278 {
1279   u16 transports = app->proxied_transports;
1280   transport_proto_t tp;
1281
1282   ASSERT (application_is_proxy (app));
1283
1284   /* *INDENT-OFF* */
1285   transport_proto_foreach (tp, ({
1286     if (transports & (1 << tp))
1287       application_start_stop_proxy (app, tp, 0);
1288   }));
1289   /* *INDENT-ON* */
1290 }
1291
1292 segment_manager_props_t *
1293 application_segment_manager_properties (application_t * app)
1294 {
1295   return &app->sm_properties;
1296 }
1297
1298 segment_manager_props_t *
1299 application_get_segment_manager_properties (u32 app_index)
1300 {
1301   application_t *app = application_get (app_index);
1302   return &app->sm_properties;
1303 }
1304
1305 clib_error_t *
1306 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1307 {
1308   application_t *app;
1309   app = application_get (a->app_index);
1310   if (!app)
1311     return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1312                                    0, "app %u doesn't exist", a->app_index);
1313   app->tls_cert = vec_dup (a->cert);
1314   return 0;
1315 }
1316
1317 clib_error_t *
1318 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1319 {
1320   application_t *app;
1321   app = application_get (a->app_index);
1322   if (!app)
1323     return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1324                                    0, "app %u doesn't exist", a->app_index);
1325   app->tls_key = vec_dup (a->key);
1326   return 0;
1327 }
1328
1329 static void
1330 application_format_listeners (application_t * app, int verbose)
1331 {
1332   vlib_main_t *vm = vlib_get_main ();
1333   app_worker_map_t *wrk_map;
1334   app_worker_t *app_wrk;
1335   u32 sm_index;
1336   u64 handle;
1337
1338   if (!app)
1339     {
1340       vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1341                        0, 0, verbose);
1342       return;
1343     }
1344
1345   /* *INDENT-OFF* */
1346   pool_foreach (wrk_map, app->worker_maps, ({
1347     app_wrk = app_worker_get (wrk_map->wrk_index);
1348     if (hash_elts (app_wrk->listeners_table) == 0)
1349       continue;
1350     hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1351       vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1352                        handle, sm_index, verbose);
1353     }));
1354   }));
1355   /* *INDENT-ON* */
1356 }
1357
1358 static void
1359 application_format_connects (application_t * app, int verbose)
1360 {
1361   app_worker_map_t *wrk_map;
1362   app_worker_t *app_wrk;
1363
1364   if (!app)
1365     {
1366       app_worker_format_connects (0, verbose);
1367       return;
1368     }
1369
1370   /* *INDENT-OFF* */
1371   pool_foreach (wrk_map, app->worker_maps, ({
1372     app_wrk = app_worker_get (wrk_map->wrk_index);
1373     app_worker_format_connects (app_wrk, verbose);
1374   }));
1375   /* *INDENT-ON* */
1376 }
1377
1378 u8 *
1379 format_application (u8 * s, va_list * args)
1380 {
1381   application_t *app = va_arg (*args, application_t *);
1382   CLIB_UNUSED (int verbose) = va_arg (*args, int);
1383   segment_manager_props_t *props;
1384   const u8 *app_ns_name, *app_name;
1385   app_worker_map_t *wrk_map;
1386   app_worker_t *app_wrk;
1387
1388   if (app == 0)
1389     {
1390       if (!verbose)
1391         s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1392       return s;
1393     }
1394
1395   app_name = app_get_name (app);
1396   app_ns_name = app_namespace_id_from_index (app->ns_index);
1397   props = application_segment_manager_properties (app);
1398   if (!verbose)
1399     {
1400       s = format (s, "%-10u%-20v%-40s", app->app_index, app_name,
1401                   app_ns_name);
1402       return s;
1403     }
1404
1405   s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1406               app_name, app->app_index, app->ns_index,
1407               format_memory_size, props->add_segment_size);
1408   s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1409               format_memory_size, props->rx_fifo_size,
1410               format_memory_size, props->tx_fifo_size);
1411
1412   /* *INDENT-OFF* */
1413   pool_foreach (wrk_map, app->worker_maps, ({
1414       app_wrk = app_worker_get (wrk_map->wrk_index);
1415       s = format (s, "%U", format_app_worker, app_wrk);
1416   }));
1417   /* *INDENT-ON* */
1418
1419   return s;
1420 }
1421
1422 void
1423 application_format_all_listeners (vlib_main_t * vm, int verbose)
1424 {
1425   application_t *app;
1426
1427   if (!pool_elts (app_main.app_pool))
1428     {
1429       vlib_cli_output (vm, "No active server bindings");
1430       return;
1431     }
1432
1433   application_format_listeners (0, verbose);
1434
1435   /* *INDENT-OFF* */
1436   pool_foreach (app, app_main.app_pool, ({
1437     application_format_listeners (app, verbose);
1438   }));
1439   /* *INDENT-ON* */
1440 }
1441
1442 void
1443 application_format_all_clients (vlib_main_t * vm, int verbose)
1444 {
1445   application_t *app;
1446
1447   if (!pool_elts (app_main.app_pool))
1448     {
1449       vlib_cli_output (vm, "No active apps");
1450       return;
1451     }
1452
1453   application_format_connects (0, verbose);
1454
1455   /* *INDENT-OFF* */
1456   pool_foreach (app, app_main.app_pool, ({
1457     application_format_connects (app, verbose);
1458   }));
1459   /* *INDENT-ON* */
1460 }
1461
1462 static clib_error_t *
1463 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1464                      vlib_cli_command_t * cmd)
1465 {
1466   int do_server = 0, do_client = 0;
1467   application_t *app;
1468   u32 app_index = ~0;
1469   int verbose = 0;
1470
1471   session_cli_return_if_not_enabled ();
1472
1473   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1474     {
1475       if (unformat (input, "server"))
1476         do_server = 1;
1477       else if (unformat (input, "client"))
1478         do_client = 1;
1479       else if (unformat (input, "%u", &app_index))
1480         ;
1481       else if (unformat (input, "verbose"))
1482         verbose = 1;
1483       else
1484         return clib_error_return (0, "unknown input `%U'",
1485                                   format_unformat_error, input);
1486     }
1487
1488   if (do_server)
1489     {
1490       application_format_all_listeners (vm, verbose);
1491       return 0;
1492     }
1493
1494   if (do_client)
1495     {
1496       application_format_all_clients (vm, verbose);
1497       return 0;
1498     }
1499
1500   if (app_index != ~0)
1501     {
1502       app = application_get_if_valid (app_index);
1503       if (!app)
1504         return clib_error_return (0, "No app with index %u", app_index);
1505
1506       vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1507       return 0;
1508     }
1509
1510   /* Print app related info */
1511   if (!do_server && !do_client)
1512     {
1513       vlib_cli_output (vm, "%U", format_application, 0, 0);
1514       /* *INDENT-OFF* */
1515       pool_foreach (app, app_main.app_pool, ({
1516         vlib_cli_output (vm, "%U", format_application, app, 0);
1517       }));
1518       /* *INDENT-ON* */
1519     }
1520
1521   return 0;
1522 }
1523
1524 /* *INDENT-OFF* */
1525 VLIB_CLI_COMMAND (show_app_command, static) =
1526 {
1527   .path = "show app",
1528   .short_help = "show app [server|client] [verbose]",
1529   .function = show_app_command_fn,
1530 };
1531 /* *INDENT-ON* */
1532
1533 /*
1534  * fd.io coding-style-patch-verification: ON
1535  *
1536  * Local Variables:
1537  * eval: (c-set-style "gnu")
1538  * End:
1539  */