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/application_namespace.h>
  19 #include <vnet/session/session.h>
  20
  21 /**
  22  * Pool from which we allocate all applications
  23  */
  24 static application_t *app_pool;
  25
  26 /**
  27  * Hash table of apps by api client index
  28  */
  29 static uword *app_by_api_client_index;
  30
  31 /**
  32  * Default application event queue size
  33  */
  34 static u32 default_app_evt_queue_size = 128;
  35
  36 static u8 *
  37 app_get_name_from_reg_index (application_t * app)
  38 {
  39   u8 *app_name;
  40
  41   vl_api_registration_t *regp;
  42   regp = vl_api_client_index_to_registration (app->api_client_index);
  43   if (!regp)
  44     app_name = format (0, "builtin-%d%c", app->index, 0);
  45   else
  46     app_name = format (0, "%s%c", regp->name, 0);
  47
  48   return app_name;
  49 }
  50
  51 u32
  52 application_session_table (application_t * app, u8 fib_proto)
  53 {
  54   app_namespace_t *app_ns;
  55   app_ns = app_namespace_get (app->ns_index);
  56   if (!application_has_global_scope (app))
  57     return APP_INVALID_INDEX;
  58   if (fib_proto == FIB_PROTOCOL_IP4)
  59     return session_lookup_get_index_for_fib (fib_proto,
  60                                              app_ns->ip4_fib_index);
  61   else
  62     return session_lookup_get_index_for_fib (fib_proto,
  63                                              app_ns->ip6_fib_index);
  64 }
  65
  66 u32
  67 application_local_session_table (application_t * app)
  68 {
  69   app_namespace_t *app_ns;
  70   if (!application_has_local_scope (app))
  71     return APP_INVALID_INDEX;
  72   app_ns = app_namespace_get (app->ns_index);
  73   return app_ns->local_table_index;
  74 }
  75
  76 int
  77 application_api_queue_is_full (application_t * app)
  78 {
  79   svm_queue_t *q;
  80
  81   /* builtin servers are always OK */
  82   if (app->api_client_index == ~0)
  83     return 0;
  84
  85   q = vl_api_client_index_to_input_queue (app->api_client_index);
  86   if (!q)
  87     return 1;
  88
  89   if (q->cursize == q->maxsize)
  90     return 1;
  91   return 0;
  92 }
  93
  94 /**
  95  * Returns app name
  96  *
  97  * Since the name is not stored per app, we generate it on the fly. It is
  98  * the caller's responsibility to free the vector
  99  */
 100 u8 *
 101 application_name_from_index (u32 app_index)
 102 {
 103   application_t *app = application_get (app_index);
 104   if (!app)
 105     return 0;
 106   return app_get_name_from_reg_index (app);
 107 }
 108
 109 static void
 110 application_table_add (application_t * app)
 111 {
 112   hash_set (app_by_api_client_index, app->api_client_index, app->index);
 113 }
 114
 115 static void
 116 application_table_del (application_t * app)
 117 {
 118   hash_unset (app_by_api_client_index, app->api_client_index);
 119 }
 120
 121 application_t *
 122 application_lookup (u32 api_client_index)
 123 {
 124   uword *p;
 125   p = hash_get (app_by_api_client_index, api_client_index);
 126   if (p)
 127     return application_get (p[0]);
 128
 129   return 0;
 130 }
 131
 132 application_t *
 133 application_new ()
 134 {
 135   application_t *app;
 136   pool_get (app_pool, app);
 137   memset (app, 0, sizeof (*app));
 138   app->index = application_get_index (app);
 139   app->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
 140   app->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
 141   if (CLIB_DEBUG > 1)
 142     clib_warning ("[%d] New app (%d)", getpid (), app->index);
 143   return app;
 144 }
 145
 146 void
 147 application_del (application_t * app)
 148 {
 149   segment_manager_properties_t *props;
 150   vnet_unbind_args_t _a, *a = &_a;
 151   segment_manager_t *sm;
 152   u64 handle, *handles = 0;
 153   u32 index;
 154   int i;
 155
 156   /*
 157    * The app event queue allocated in first segment is cleared with
 158    * the segment manager. No need to explicitly free it.
 159    */
 160   if (CLIB_DEBUG > 1)
 161     clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
 162
 163   if (application_is_proxy (app))
 164     application_remove_proxy (app);
 165
 166   /*
 167    *  Listener cleanup
 168    */
 169
 170   /* *INDENT-OFF* */
 171   hash_foreach (handle, index, app->listeners_table,
 172   ({
 173     vec_add1 (handles, handle);
 174     sm = segment_manager_get (index);
 175     sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
 176   }));
 177   /* *INDENT-ON* */
 178
 179   for (i = 0; i < vec_len (handles); i++)
 180     {
 181       a->app_index = app->index;
 182       a->handle = handles[i];
 183       /* seg manager is removed when unbind completes */
 184       vnet_unbind (a);
 185     }
 186
 187   /*
 188    * Connects segment manager cleanup
 189    */
 190
 191   if (app->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
 192     {
 193       sm = segment_manager_get (app->connects_seg_manager);
 194       sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
 195       segment_manager_init_del (sm);
 196     }
 197
 198   /* If first segment manager is used by a listener */
 199   if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
 200       && app->first_segment_manager != app->connects_seg_manager)
 201     {
 202       sm = segment_manager_get (app->first_segment_manager);
 203       /* .. and has no fifos, e.g. it might be used for redirected sessions,
 204        * remove it */
 205       if (!segment_manager_has_fifos (sm))
 206         {
 207           sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
 208           segment_manager_del (sm);
 209         }
 210     }
 211   props = segment_manager_properties_get (app->sm_properties);
 212   segment_manager_properties_free (props);
 213   application_table_del (app);
 214   pool_put (app_pool, app);
 215 }
 216
 217 static void
 218 application_verify_cb_fns (session_cb_vft_t * cb_fns)
 219 {
 220   if (cb_fns->session_accept_callback == 0)
 221     clib_warning ("No accept callback function provided");
 222   if (cb_fns->session_connected_callback == 0)
 223     clib_warning ("No session connected callback function provided");
 224   if (cb_fns->session_disconnect_callback == 0)
 225     clib_warning ("No session disconnect callback function provided");
 226   if (cb_fns->session_reset_callback == 0)
 227     clib_warning ("No session reset callback function provided");
 228 }
 229
 230 /**
 231  * Check app config for given segment type
 232  *
 233  * Returns 1 on success and 0 otherwise
 234  */
 235 static u8
 236 application_verify_cfg (ssvm_segment_type_t st)
 237 {
 238   u8 is_valid;
 239   if (st == SSVM_SEGMENT_MEMFD)
 240     {
 241       is_valid = (session_manager_get_evt_q_segment () != 0);
 242       if (!is_valid)
 243         clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
 244       return is_valid;
 245     }
 246   else if (st == SSVM_SEGMENT_SHM)
 247     {
 248       is_valid = (session_manager_get_evt_q_segment () == 0);
 249       if (!is_valid)
 250         clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
 251       return is_valid;
 252     }
 253   else
 254     return 1;
 255 }
 256
 257 int
 258 application_init (application_t * app, u32 api_client_index, u64 * options,
 259                   session_cb_vft_t * cb_fns)
 260 {
 261   ssvm_segment_type_t st = SSVM_SEGMENT_MEMFD;
 262   u32 app_evt_queue_size, first_seg_size;
 263   segment_manager_properties_t *props;
 264   vl_api_registration_t *reg;
 265   segment_manager_t *sm;
 266   int rv;
 267
 268   /*
 269    * Make sure we support the requested configuration
 270    */
 271   reg = vl_api_client_index_to_registration (api_client_index);
 272   if (!reg)
 273     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 274
 275   if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN)
 276     st = SSVM_N_SEGMENT_TYPES;
 277   else if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
 278     st = SSVM_SEGMENT_SHM;
 279
 280   if (!application_verify_cfg (st))
 281     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 282
 283   /*
 284    * Setup segment manager
 285    */
 286   sm = segment_manager_new ();
 287   sm->app_index = app->index;
 288   props = segment_manager_properties_alloc ();
 289   app->sm_properties = segment_manager_properties_index (props);
 290   if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
 291     {
 292       props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
 293       props->add_segment = 1;
 294     }
 295   if (options[APP_OPTIONS_RX_FIFO_SIZE])
 296     props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
 297   if (options[APP_OPTIONS_TX_FIFO_SIZE])
 298     props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
 299   props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
 300   props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
 301   if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN)
 302     props->segment_type = SSVM_N_SEGMENT_TYPES;
 303   else
 304     props->segment_type = st;
 305
 306   app_evt_queue_size = options[APP_OPTIONS_EVT_QUEUE_SIZE] > 0 ?
 307     options[APP_OPTIONS_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
 308   first_seg_size = options[APP_OPTIONS_SEGMENT_SIZE];
 309   if ((rv = segment_manager_init (sm, app->sm_properties, first_seg_size,
 310                                   app_evt_queue_size)))
 311     return rv;
 312   sm->first_is_protected = 1;
 313
 314   /*
 315    * Setup application
 316    */
 317   app->first_segment_manager = segment_manager_index (sm);
 318   app->api_client_index = api_client_index;
 319   app->flags = options[APP_OPTIONS_FLAGS];
 320   app->cb_fns = *cb_fns;
 321   app->ns_index = options[APP_OPTIONS_NAMESPACE];
 322   app->listeners_table = hash_create (0, sizeof (u64));
 323   app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
 324
 325   /* If no scope enabled, default to global */
 326   if (!application_has_global_scope (app)
 327       && !application_has_local_scope (app))
 328     app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 329
 330   /* Allocate app event queue in the first shared-memory segment */
 331   app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
 332
 333   /* Check that the obvious things are properly set up */
 334   application_verify_cb_fns (cb_fns);
 335
 336   /* Add app to lookup by api_client_index table */
 337   application_table_add (app);
 338
 339   return 0;
 340 }
 341
 342 application_t *
 343 application_get (u32 index)
 344 {
 345   if (index == APP_INVALID_INDEX)
 346     return 0;
 347   return pool_elt_at_index (app_pool, index);
 348 }
 349
 350 application_t *
 351 application_get_if_valid (u32 index)
 352 {
 353   if (pool_is_free_index (app_pool, index))
 354     return 0;
 355
 356   return pool_elt_at_index (app_pool, index);
 357 }
 358
 359 u32
 360 application_get_index (application_t * app)
 361 {
 362   return app - app_pool;
 363 }
 364
 365 static segment_manager_t *
 366 application_alloc_segment_manager (application_t * app)
 367 {
 368   segment_manager_t *sm = 0;
 369
 370   /* If the first segment manager is not in use, don't allocate a new one */
 371   if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
 372       && app->first_segment_manager_in_use == 0)
 373     {
 374       sm = segment_manager_get (app->first_segment_manager);
 375       app->first_segment_manager_in_use = 1;
 376       return sm;
 377     }
 378
 379   sm = segment_manager_new ();
 380   sm->properties_index = app->sm_properties;
 381
 382   return sm;
 383 }
 384
 385 /**
 386  * Start listening local transport endpoint for requested transport.
 387  *
 388  * Creates a 'dummy' stream session with state LISTENING to be used in session
 389  * lookups, prior to establishing connection. Requests transport to build
 390  * it's own specific listening connection.
 391  */
 392 int
 393 application_start_listen (application_t * srv, session_endpoint_t * sep,
 394                           u64 * res)
 395 {
 396   segment_manager_t *sm;
 397   stream_session_t *s;
 398   u64 handle;
 399   session_type_t sst;
 400
 401   sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
 402   s = listen_session_new (sst);
 403   s->app_index = srv->index;
 404
 405   if (stream_session_listen (s, sep))
 406     goto err;
 407
 408   /* Allocate segment manager. All sessions derived out of a listen session
 409    * have fifos allocated by the same segment manager. */
 410   sm = application_alloc_segment_manager (srv);
 411   if (sm == 0)
 412     goto err;
 413
 414   /* Add to app's listener table. Useful to find all child listeners
 415    * when app goes down, although, just for unbinding this is not needed */
 416   handle = listen_session_get_handle (s);
 417   hash_set (srv->listeners_table, handle, segment_manager_index (sm));
 418
 419   *res = handle;
 420   return 0;
 421
 422 err:
 423   listen_session_del (s);
 424   return -1;
 425 }
 426
 427 /**
 428  * Stop listening on session associated to handle
 429  */
 430 int
 431 application_stop_listen (application_t * srv, u64 handle)
 432 {
 433   stream_session_t *listener;
 434   uword *indexp;
 435   segment_manager_t *sm;
 436
 437   if (srv && hash_get (srv->listeners_table, handle) == 0)
 438     {
 439       clib_warning ("app doesn't own handle %llu!", handle);
 440       return -1;
 441     }
 442
 443   listener = listen_session_get_from_handle (handle);
 444   stream_session_stop_listen (listener);
 445
 446   indexp = hash_get (srv->listeners_table, handle);
 447   ASSERT (indexp);
 448
 449   sm = segment_manager_get (*indexp);
 450   if (srv->first_segment_manager == *indexp)
 451     {
 452       /* Delete sessions but don't remove segment manager */
 453       srv->first_segment_manager_in_use = 0;
 454       segment_manager_del_sessions (sm);
 455     }
 456   else
 457     {
 458       segment_manager_init_del (sm);
 459     }
 460   hash_unset (srv->listeners_table, handle);
 461   listen_session_del (listener);
 462
 463   return 0;
 464 }
 465
 466 int
 467 application_open_session (application_t * app, session_endpoint_t * sep,
 468                           u32 api_context)
 469 {
 470   segment_manager_t *sm;
 471   int rv;
 472
 473   /* Make sure we have a segment manager for connects */
 474   if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
 475     {
 476       sm = application_alloc_segment_manager (app);
 477       if (sm == 0)
 478         return -1;
 479       app->connects_seg_manager = segment_manager_index (sm);
 480     }
 481
 482   if ((rv = session_open (app->index, sep, api_context)))
 483     return rv;
 484
 485   return 0;
 486 }
 487
 488 segment_manager_t *
 489 application_get_connect_segment_manager (application_t * app)
 490 {
 491   ASSERT (app->connects_seg_manager != (u32) ~ 0);
 492   return segment_manager_get (app->connects_seg_manager);
 493 }
 494
 495 segment_manager_t *
 496 application_get_listen_segment_manager (application_t * app,
 497                                         stream_session_t * s)
 498 {
 499   uword *smp;
 500   smp = hash_get (app->listeners_table, listen_session_get_handle (s));
 501   ASSERT (smp != 0);
 502   return segment_manager_get (*smp);
 503 }
 504
 505 int
 506 application_is_proxy (application_t * app)
 507 {
 508   return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
 509 }
 510
 511 int
 512 application_is_builtin (application_t * app)
 513 {
 514   return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
 515 }
 516
 517 int
 518 application_is_builtin_proxy (application_t * app)
 519 {
 520   return (application_is_proxy (app) && application_is_builtin (app));
 521 }
 522
 523 int
 524 application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
 525 {
 526   application_t *app = application_get (app_index);
 527   svm_fifo_segment_private_t *fs;
 528
 529   /* Send an API message to the external app, to map new segment */
 530   ASSERT (app->cb_fns.add_segment_callback);
 531
 532   fs = segment_manager_get_segment (fifo_segment_index);
 533   return app->cb_fns.add_segment_callback (app->api_client_index, &fs->ssvm);
 534 }
 535
 536 u8
 537 application_has_local_scope (application_t * app)
 538 {
 539   return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
 540 }
 541
 542 u8
 543 application_has_global_scope (application_t * app)
 544 {
 545   return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 546 }
 547
 548 u32
 549 application_n_listeners (application_t * app)
 550 {
 551   return hash_elts (app->listeners_table);
 552 }
 553
 554 stream_session_t *
 555 application_first_listener (application_t * app, u8 fib_proto,
 556                             u8 transport_proto)
 557 {
 558   stream_session_t *listener;
 559   u64 handle;
 560   u32 sm_index;
 561   u8 sst;
 562
 563   sst = session_type_from_proto_and_ip (transport_proto,
 564                                         fib_proto == FIB_PROTOCOL_IP4);
 565
 566   /* *INDENT-OFF* */
 567    hash_foreach (handle, sm_index, app->listeners_table, ({
 568      listener = listen_session_get_from_handle (handle);
 569      if (listener->session_type == sst
 570          && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
 571        return listener;
 572    }));
 573   /* *INDENT-ON* */
 574
 575   return 0;
 576 }
 577
 578 stream_session_t *
 579 application_proxy_listener (application_t * app, u8 fib_proto,
 580                             u8 transport_proto)
 581 {
 582   stream_session_t *listener;
 583   u64 handle;
 584   u32 sm_index;
 585   u8 sst;
 586
 587   sst = session_type_from_proto_and_ip (transport_proto,
 588                                         fib_proto == FIB_PROTOCOL_IP4);
 589
 590   /* *INDENT-OFF* */
 591    hash_foreach (handle, sm_index, app->listeners_table, ({
 592      listener = listen_session_get_from_handle (handle);
 593      if (listener->session_type == sst
 594          && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
 595        return listener;
 596    }));
 597   /* *INDENT-ON* */
 598
 599   return 0;
 600 }
 601
 602 static clib_error_t *
 603 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
 604                                         u8 transport_proto, u8 is_start)
 605 {
 606   app_namespace_t *app_ns = app_namespace_get (app->ns_index);
 607   u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
 608   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
 609   transport_connection_t *tc;
 610   stream_session_t *s;
 611   u64 handle;
 612
 613   if (is_start)
 614     {
 615       s = application_first_listener (app, fib_proto, transport_proto);
 616       if (!s)
 617         {
 618           sep.is_ip4 = is_ip4;
 619           sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
 620           sep.sw_if_index = app_ns->sw_if_index;
 621           sep.transport_proto = transport_proto;
 622           application_start_listen (app, &sep, &handle);
 623           s = listen_session_get_from_handle (handle);
 624           s->listener_index = SESSION_PROXY_LISTENER_INDEX;
 625         }
 626     }
 627   else
 628     {
 629       s = application_proxy_listener (app, fib_proto, transport_proto);
 630       ASSERT (s);
 631     }
 632
 633   tc = listen_session_get_transport (s);
 634
 635   if (!ip_is_zero (&tc->lcl_ip, 1))
 636     {
 637       u32 sti;
 638       sep.is_ip4 = is_ip4;
 639       sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
 640       sep.transport_proto = transport_proto;
 641       sep.port = 0;
 642       sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
 643       if (is_start)
 644         session_lookup_add_session_endpoint (sti, &sep, s->session_index);
 645       else
 646         session_lookup_del_session_endpoint (sti, &sep);
 647     }
 648
 649   return 0;
 650 }
 651
 652 static void
 653 application_start_stop_proxy_local_scope (application_t * app,
 654                                           u8 transport_proto, u8 is_start)
 655 {
 656   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
 657   app_namespace_t *app_ns;
 658   app_ns = app_namespace_get (app->ns_index);
 659   sep.is_ip4 = 1;
 660   sep.transport_proto = transport_proto;
 661   sep.port = 0;
 662
 663   if (is_start)
 664     {
 665       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
 666                                            app->index);
 667       sep.is_ip4 = 0;
 668       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
 669                                            app->index);
 670     }
 671   else
 672     {
 673       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
 674       sep.is_ip4 = 0;
 675       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
 676     }
 677 }
 678
 679 void
 680 application_start_stop_proxy (application_t * app,
 681                               transport_proto_t transport_proto, u8 is_start)
 682 {
 683   if (application_has_local_scope (app))
 684     application_start_stop_proxy_local_scope (app, transport_proto, is_start);
 685
 686   if (application_has_global_scope (app))
 687     {
 688       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
 689                                               transport_proto, is_start);
 690       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
 691                                               transport_proto, is_start);
 692     }
 693 }
 694
 695 void
 696 application_setup_proxy (application_t * app)
 697 {
 698   u16 transports = app->proxied_transports;
 699   transport_proto_t tp;
 700
 701   ASSERT (application_is_proxy (app));
 702   if (application_is_builtin (app))
 703     return;
 704
 705   /* *INDENT-OFF* */
 706   transport_proto_foreach (tp, ({
 707     if (transports & (1 << tp))
 708       application_start_stop_proxy (app, tp, 1);
 709   }));
 710   /* *INDENT-ON* */
 711 }
 712
 713 void
 714 application_remove_proxy (application_t * app)
 715 {
 716   u16 transports = app->proxied_transports;
 717   transport_proto_t tp;
 718
 719   ASSERT (application_is_proxy (app));
 720
 721   /* *INDENT-OFF* */
 722   transport_proto_foreach (tp, ({
 723     if (transports & (1 << tp))
 724       application_start_stop_proxy (app, tp, 0);
 725   }));
 726   /* *INDENT-ON* */
 727 }
 728
 729 u8 *
 730 format_application_listener (u8 * s, va_list * args)
 731 {
 732   application_t *app = va_arg (*args, application_t *);
 733   u64 handle = va_arg (*args, u64);
 734   u32 index = va_arg (*args, u32);
 735   int verbose = va_arg (*args, int);
 736   stream_session_t *listener;
 737   u8 *app_name, *str;
 738
 739   if (app == 0)
 740     {
 741       if (verbose)
 742         s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
 743                     "API Client", "ListenerID", "SegManager");
 744       else
 745         s = format (s, "%-40s%-20s", "Connection", "App");
 746
 747       return s;
 748     }
 749
 750   app_name = app_get_name_from_reg_index (app);
 751   listener = listen_session_get_from_handle (handle);
 752   str = format (0, "%U", format_stream_session, listener, verbose);
 753
 754   if (verbose)
 755     {
 756       s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
 757                   app->api_client_index, handle, index);
 758     }
 759   else
 760     s = format (s, "%-40s%-20s", str, app_name);
 761
 762   vec_free (app_name);
 763   return s;
 764 }
 765
 766 void
 767 application_format_connects (application_t * app, int verbose)
 768 {
 769   vlib_main_t *vm = vlib_get_main ();
 770   segment_manager_t *sm;
 771   u8 *app_name, *s = 0;
 772   int j;
 773
 774   /* Header */
 775   if (app == 0)
 776     {
 777       if (verbose)
 778         vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
 779                          "API Client", "SegManager");
 780       else
 781         vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
 782       return;
 783     }
 784
 785   /* make sure */
 786   if (app->connects_seg_manager == (u32) ~ 0)
 787     return;
 788
 789   app_name = app_get_name_from_reg_index (app);
 790
 791   /* Across all fifo segments */
 792   sm = segment_manager_get (app->connects_seg_manager);
 793   for (j = 0; j < vec_len (sm->segment_indices); j++)
 794     {
 795       svm_fifo_segment_private_t *fifo_segment;
 796       svm_fifo_t *fifo;
 797       u8 *str;
 798
 799       fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
 800       fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
 801       while (fifo)
 802         {
 803           u32 session_index, thread_index;
 804           stream_session_t *session;
 805
 806           session_index = fifo->master_session_index;
 807           thread_index = fifo->master_thread_index;
 808
 809           session = session_get (session_index, thread_index);
 810           str = format (0, "%U", format_stream_session, session, verbose);
 811
 812           if (verbose)
 813             s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
 814                         app->api_client_index, app->connects_seg_manager);
 815           else
 816             s = format (s, "%-40s%-20s", str, app_name);
 817
 818           vlib_cli_output (vm, "%v", s);
 819           vec_reset_length (s);
 820           vec_free (str);
 821
 822           fifo = fifo->next;
 823         }
 824       vec_free (s);
 825     }
 826
 827   vec_free (app_name);
 828 }
 829
 830 u8 *
 831 format_application (u8 * s, va_list * args)
 832 {
 833   application_t *app = va_arg (*args, application_t *);
 834   CLIB_UNUSED (int verbose) = va_arg (*args, int);
 835   segment_manager_properties_t *props;
 836   const u8 *app_ns_name;
 837   u8 *app_name;
 838
 839   if (app == 0)
 840     {
 841       if (verbose)
 842         s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
 843                     "API Client", "Namespace", "Add seg size", "Rx fifo size",
 844                     "Tx fifo size");
 845       else
 846         s =
 847           format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
 848                   "Namespace");
 849       return s;
 850     }
 851
 852   app_name = app_get_name_from_reg_index (app);
 853   app_ns_name = app_namespace_id_from_index (app->ns_index);
 854   props = segment_manager_properties_get (app->sm_properties);
 855   if (verbose)
 856     s =
 857       format (s, "%-10d%-20s%-15d%-15d%-15d%-15d%-15d", app->index, app_name,
 858               app->api_client_index, app->ns_index,
 859               props->add_segment_size,
 860               props->rx_fifo_size, props->tx_fifo_size);
 861   else
 862     s = format (s, "%-10d%-20s%-15d%-40s", app->index, app_name,
 863                 app->api_client_index, app_ns_name);
 864   return s;
 865 }
 866
 867 static clib_error_t *
 868 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
 869                      vlib_cli_command_t * cmd)
 870 {
 871   application_t *app;
 872   int do_server = 0;
 873   int do_client = 0;
 874   int verbose = 0;
 875
 876   session_cli_return_if_not_enabled ();
 877
 878   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 879     {
 880       if (unformat (input, "server"))
 881         do_server = 1;
 882       else if (unformat (input, "client"))
 883         do_client = 1;
 884       else if (unformat (input, "verbose"))
 885         verbose = 1;
 886       else
 887         break;
 888     }
 889
 890   if (do_server)
 891     {
 892       u64 handle;
 893       u32 index;
 894       if (pool_elts (app_pool))
 895         {
 896           vlib_cli_output (vm, "%U", format_application_listener,
 897                            0 /* header */ , 0, 0,
 898                            verbose);
 899           /* *INDENT-OFF* */
 900           pool_foreach (app, app_pool,
 901           ({
 902             /* App's listener sessions */
 903             if (hash_elts (app->listeners_table) == 0)
 904               continue;
 905             hash_foreach (handle, index, app->listeners_table,
 906             ({
 907               vlib_cli_output (vm, "%U", format_application_listener, app,
 908                                        handle, index, verbose);
 909             }));
 910           }));
 911           /* *INDENT-ON* */
 912         }
 913       else
 914         vlib_cli_output (vm, "No active server bindings");
 915     }
 916
 917   if (do_client)
 918     {
 919       if (pool_elts (app_pool))
 920         {
 921           application_format_connects (0, verbose);
 922
 923           /* *INDENT-OFF* */
 924           pool_foreach (app, app_pool,
 925           ({
 926             if (app->connects_seg_manager == (u32)~0)
 927               continue;
 928             application_format_connects (app, verbose);
 929           }));
 930           /* *INDENT-ON* */
 931         }
 932       else
 933         vlib_cli_output (vm, "No active client bindings");
 934     }
 935
 936   /* Print app related info */
 937   if (!do_server && !do_client)
 938     {
 939       vlib_cli_output (vm, "%U", format_application, 0, verbose);
 940       /* *INDENT-OFF* */
 941       pool_foreach (app, app_pool, ({
 942         vlib_cli_output (vm, "%U", format_application, app, verbose);
 943       }));
 944       /* *INDENT-ON* */
 945     }
 946
 947   return 0;
 948 }
 949
 950 /* *INDENT-OFF* */
 951 VLIB_CLI_COMMAND (show_app_command, static) =
 952 {
 953   .path = "show app",
 954   .short_help = "show app [server|client] [verbose]",
 955   .function = show_app_command_fn,
 956 };
 957 /* *INDENT-ON* */
 958
 959 /*
 960  * fd.io coding-style-patch-verification: ON
 961  *
 962  * Local Variables:
 963  * eval: (c-set-style "gnu")
 964  * End:
 965  */